From 51d8892c57705f4d8631df6dea08fcbf6db6b7d9 Mon Sep 17 00:00:00 2001 From: zman-ms <99997769+zman-ms@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:00:09 -0800 Subject: [PATCH] Zman/fix conflicts dev aks fleet 2024 02 02 preview (#27815) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Adding New GA Version (#26953) * adding new version * Typspec versioning * adding in examples * fixing examples * formatting * formatting * updating deprecated operations * formatting fixes * removing breaking changes * modify image upload body and docs * fix example * fixing example * adding Location to 202 responses * tsv formatting changes * removing unnecessary model * commiting changes * [TypeSpec Requirement] Handle specs with variable path depths (#27324) - Fixes #27319 * [TypeSpec-Requirement] Fix typo in github URL to check * Update readme.python.md (#27330) * Update readme.python.md * Update readme.python.md * Use property name `list` instead of `values` in some models for Python (#27336) * Johnkoh msft azuredatatransfer microsoft.azure data transfer 2023 10 11 preview (#26576) * Generate new Service for azuredatatransfer * Adds base for updating Microsoft.AzureDataTransfer from version private repo version stable/2023-06-28 to public repo version 2023-10-11-preview * Move Microsoft.AzureDataTransfer to public repo with new api-version * Add openapi-subtype * Fix LintDiff errors * Fix examples validation errors * Add Data flow type * Remove additionalProperties * Rename to performRequest * Update result and code * Remove action endpoint, add listApprovedSchemas and validateSchema endpoints * Minor Fixes of TypeSpec for AOAI On Your Data 2023-12-01-preview /extensions/chat/completions (#27271) * auth * restore * vector db * fix examples * fix * matrix * fix cosmosdb * fix pinecone description * generated --------- Co-authored-by: Yuantao Wang * Update SparkFrontend_SparkBatch_Create.json (#27077) * [TypeSpec Validation] add support for node 21 and drop 16 (#27247) * tsv node 21 * parameter * package logck * tsv path error message (#27248) * Correct the version # in the primary tag in the readme (Azure Maps) (#27295) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * updated version and added exclude-file * reverted changes from preious commit and changed stable version date. * Changed which data v2 swagger file is being pointed to. * Added '- Microsoft.Maps/Data/preview/1.0/data.json' to the deprecated tag. * [TypeSpec Validation] remove job name for pipelines (#27338) * remove job name * Update eng/pipelines/typespec-validation.yml Co-authored-by: Mike Harder * Update eng/tools/typespec-validation/ci.yml Co-authored-by: Mike Harder * Update eng/pipelines/typespec-validation-all.yml Co-authored-by: Mike Harder --------- Co-authored-by: Mike Harder * Update readme.python.md (#27344) * Updated examples for public documentation (#27273) Co-authored-by: Sushil Upadhyay * Azure Language add scriptCode, and enums for script Language Detection Results (#26777) * add scriptCode, and enums for script * update name for sciptcode * fixed policheck and spelling issue * Add new words to custom-words.txt and update Bengala enum * Fix broken links in Creator (#27343) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * fixed broken links in Creator. * [ImageAnalysis] Fix auth implementation (#27361) * fix auth implementation * format * suppress auth warning * clean up after team discussion * Update readme.python.md (#27365) * Update readme.python.md (#27366) * References to the data service are changed to reference the data registry service. (#27340) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * Changed references to the data service to the new data registry service. * Changed full-URL links to be site-relative links. * Added words to the override list in cspell.json and ran Prettier check. * Abaranwal ms edgeorder microsoft.edge order 2024 02 01 (#27145) * Adds base for updating Microsoft.EdgeOrder from version preview/2022-05-01-preview to version 2024-02-01 * Updates readme * Updates API version in new specs and examples * Made with changes on top of 2023 preview swagger * saving examples * minor: spelling * replace sub Id with guid * mark provisionig state readonly * fix prov details and site details to correct place in hierarchy * orderItem delete remove 200 code * Minor - fix model validation * add suppression * remove 202 from address delete * mark as sync * remove suppression if not needed * keep address asynch * changes as per review * camelCase * making contact details fields not required * add address classification field * rename state to NotInitiated * remove the save-inputs in jobrouters (#27371) * Update readme.python.md (#27374) * Add snowflake v2 linkedService (#26336) * Add snowflake v2 linkedService * fix prettier * update snowflakeV2 linkedService * fix prettier * Add snowflake v2 copysource and dataset * Fix prettier * Add swagger changes for synapse * fix prettier * remove AAD auth * Update synapse linkedService * Fix prettier * snowflakeV2 add service principal auth * remove dfe-string * fix prettier check issue * Minor fix the missing parameters for ingestion API (#27364) * miss * chunk size --------- Co-authored-by: Yuantao Wang * Azure Maps - Data service documentation updates to improve the overview pages. (#27370) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * moved retirement note so it does not appear is the overview page. Corrected broken links to data and data v2 API. * Added suppression to readme for RESPONSE_SCHEMA_NOT_IN_SPEC. reason: false positive from oav is breaking our example validation. See azure/oav#1021. * fixed links * Fix broken links in user docs (description fields) (#27149) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * Fixed broken links that appear in the REST API docs. * Added suppression RESPONSE_SCHEMA_NOT_IN_SPEC. reason: false positive from oav is breaking our example validation. See azure/oav#1021. * Added suppression RESPONSE_SCHEMA_NOT_IN_SPEC. * [TypeSpec Requirement] Improve check if OpenAPI cannot be parsed as JSON (#27341) - Fixes #27325 * Update readme.python.md (#27411) * Fix headers and schema definition (#27180) Co-authored-by: Bo Wang * [Hub Generated] Review request for Microsoft.ContainerService/aks to add version stable/2023-11-01 (#27026) * Add nodeSoakDurationInMinutes (#26762) * update duration properties with "x-ms-format" : "duration-constant" (#27337) * update duration properties with format * Documentation fixes for a preview API (#27350) * Update examples * [Hub Generated] Publish private branch 'feature/DP-workspace-key' (#27238) * Use the previous version as the base * Add auth header * fix typo * Add a description * fix reference error * remove fake uri --------- Co-authored-by: Yi Gu * [DocumentIntelligence] Update tsp config for Python (#27423) * [ChangedFiles-Functions.ps1] Remove unnecessary parenthesis in function call (#27425) * [Hub Generated] Publish private branch 'feature/RP-workspace-key' (#26968) * Add new APIs * update api key names * add enableAPIkey to workspace property * Fixed link text for 'pricing tiers' in Azure Maps swagger files. (#27424) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * Fixed link text for 'pricing tiers' in Azure Maps swagger files. * Update ARM review guidance in control_plane_template.md (#27406) * Update pull_request_assignment.yml: remove rkmanda from assignees (#26918) * Update pull_request_assignment.yml: remove rkmanda from assignees Contributes to: - https://github.com/Azure/azure-sdk-tools/issues/7368 * Update pull_request_assignment.yml --------- Co-authored-by: Wes Haggard * Remove spatial (#27209) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * Removing spatial from the Creator swagger files. It is not used and does not belong there. * Update readme.python.md (#27454) * Update readme.python.md * Update readme.python.md * Update readme.python.md * Update description of Custom Voice API swagger. (#27438) * Update description of Custom Voice API swagger. Add more description about Azure blob URL with SAS. * Update description of Custom Voice API swagger Change filter description from HTML to mark down. * remove en-US in Azure doc link. --------- Co-authored-by: Jun-wei Gan * Added optional deliveryReportTimeoutInSeconds to smsSendOptions. (#27067) * Added optional validityPeriodSeconds to smsSendOptions. * Added new api version 2024-02-05 for validityPeriodSeconds. * Added package-sms-2024-02-05 to readme.md * Moved to Preview. * Change name to deliveryReportTimeoutInSeconds. Fixed Swagger Validation Report errors. * Fix broken links for Azure Maps API resulting from TOC changes. (#27443) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * updated URLs to Azure Maps and Azure Maps Creator REST API. * updated URLs from 'search-v2' to 'search'. * updated URLs to Azure Maps Creator REST API. * updated URL to Azure Maps Creator REST API. * Added 'geocodingresponse' to cspell.json. Also added the 'INVALID_TYPE' Suppression to the Creator Readme (also added in PR27357). * [Hub Generated] Publish private branch 'gachauhan-iprangenew' (#27329) * Microsoft.databoxedge 2023-12-01-preview * Remove "Swagger" from the PR template (#27466) * disable model flatten for new service (#27380) * [Hub Generated] Review request for Microsoft.HealthcareApis to add version stable/2023-12-01 (#26852) * Adds base for updating Microsoft.HealthcareApis from version stable/2023-11-01 to version 2023-12-01 * Updates readme * Updates API version in new specs and examples * Added SMART Identity Providers to API version 2023-12-01 * Remove deprecated 'services' related paths, definitions, and examples * Revert "Remove deprecated 'services' related paths, definitions, and examples" This reverts commit 45b12eae86fd8a93bac0e79c46e3dcfbeb96d78f. * Updated SMART identity provider configurations to remove 'additionalProperties' * Addressed linting error missing x-ms-identifiers * Limit SmartDataActions to read only --------- Co-authored-by: Nate Malubay * Search preview version 2024-03-01-preview (#27235) * baseline for preview search 2024-03-01-preview * Updating the error response * Update readme.md with new preview version * Support narrow data types * vectors add stored property * SpellCheck override for rerank * Update Support narrow data types * update descriptions * Update SpellCheck override * Swagger PrettierCheck * api review feedback * update samples * update float16 -> half * Update examples with renamed properties * Use ErrorResponse from common-types * Fix the Tag: package-2024-03 in readme * Address comments --------- Co-authored-by: Zeeshan Sayyed Co-authored-by: Robert Lee * Various improvements to `ci-fix.md` (#27484) * to support SDK auto generation (#27464) Co-authored-by: Yi Gu * Improve Salesforce V2 properties (#27412) * Route v2 toc (#27500) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * Added route v2 preview. * Creator api summary (#27357) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * Removed 'Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK.' paragraph. * Added suppression RESPONSE_SCHEMA_NOT_IN_SPEC. * Added suppression RESPONSE_SCHEMA_NOT_IN_SPEC. * re-did a bunch of stuff due to unknown errors * Add simple script to create new API versions (#27266) * [tsconfig.json] Revert accidental changes (#27489) - Revert changes accidentally merged in #26358 * java, offazurespringboot, update title use singlar App (#27494) * Rheajain paloaltonetworks palo alto networks.cloudngfw 2024 01 19 preview (#27460) * Adds base for updating PaloAltoNetworks.Cloudngfw from version preview/2023-10-10-preview to version 2024-01-19-preview * Updates readme * Updates API version in new specs and examples * Add SCM changes * Change api version in examples * Change response of List of cloud manager tenants * Add pagination to List SCM tenants API * Remove skip and top tokens * Fix property name * Add skip and top parameters * Remove SCM related APIs * change package tag * Update Custom Voice API swagger. (#27512) Fix description format issue. Co-authored-by: Jun-wei Gan * Release keyvault microsoft.key vault 7.5 (#27422) * Adds base for updating Microsoft.KeyVault from version preview/7.5-preview.1 to version 7.5 * Updates readme * Updates API version in new specs and examples * Adding 2023 09 01 for nginx (#27231) * Added version of 2023-09-01 for nginx * Update readme.python.md (#27520) * disable model flatten (#27511) * Adding new preview api version for new field (#27382) * Adding existing files from the latest api version * adding the new api version under databox.json * Modified examples * readme files changes * fix - path change in read me file * poli check fix * resolving PR comments --------- Co-authored-by: Govardhana D K * hardwaresecuritymodules readme.go.md add directive (#27525) * Naming tweaks for ImageAnalysis (#27296) * Move TypeScript client into @azure-rest namespace. Change API name from Buffer to ImageData * Use property name 'list' instead of 'values' for Python * Update swagger example * Fix previous commit Individual mono-repros have green builds with pending PR's based on this change. --------- Co-authored-by: Darren Cohen <39422044+dargilco@users.noreply.github.com> * Update Route Directions API (#27492) * firt commit * update --------- Co-authored-by: Will Huang * Added comment 'Maximum number of categorySet values supported per request is 10', and fixed links to search v1 swagger/API docs. (#27507) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * Added comment 'Maximum number of categorySet values supported per request is 10', and fixed links to search v1 swagger/API docs. * Fixed links. * URL fixes * Added words from search v1 to cSpell.json * C:/Program Files/Git/ * Alec baird desktopvirtualization microsoft.desktop virtualization 2024 01 16 preview (#27396) * Adds base for updating Microsoft.DesktopVirtualization from version preview/2023-11-01-preview to version 2024-01-16-preview * Updates readme * Updates API version in new specs and examples * Added 4 UDP properties to Hostpool * Updated examples with new properties * Spelling * Removed hostpool from naming convention * Added UDP properties to hostpool PATCH * Added suppressions that will be fixed prior to next stable, ran prettier * Ran prettier on examples * Remove issue and pull request assignment files (#27481) * turn the MRW feature off explicitly for communication jobrouter (#27539) * [TypeSpec] Upgrade to 0.52.0 (#27541) * [docs] Add to "Swagger LintDiff for TypeSpec" (#27451) * Cognitive Services 2023-10-01-preview update (#26892) * Fix some typos * address comments * address LintDiff * [TypeSpec] Upgrade http to 0.52.1 (#27548) * System component added as azure arc profile. (#27519) * System component added as arc profile * fixing the lint issues * api update in examples * fixing the type * swagger validation * pretty fixes * prettier * Keeping the default same stable * Fixed invalid type errors in bbox examples (#27516) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * fixed invalid type errors in bbox examples. * fixed invalid type errors in bbox examples. * reverted changes * enable mrw for jobrouter again (#27543) * making product description optional in new API version (#27534) * [OpenAI] Fix ChatCompletionsNamedFunctionToolSelection (#27487) * [TypeSpec] Upgrade typespec-apiview to 0.4.5 (#27562) - Support SyntaxKind.TemplateArgument * Add Token authentication for Single document translator API (#27546) Co-authored-by: Vikas Palaskar * add stable API 2024-02-01 for GA (#27360) * add stable API 2024-02-01 for GA * update to remove customization * fix spelling and refrence * take out internal api * fix Swagger Avocado check --------- Co-authored-by: Jyoti Lama * remove placeholder file (#27569) * [TypeSpec] Upgrade autorest to 0.38.1 (#27568) * update readme to adapt new autorest (#27571) Co-authored-by: Yi Gu * OpenAI: TypeSpec project for Assistants (#27076) * Initial public commit for OpenAI Assistants spec * small typo correction for 'interpeter' -- thank you, spellcheck! * rename list type for generation clarity; recompile * client.tsp: suppress visibility of 'list' methods to facilitate plumbing of a common list representation * Client visibility pass for more nested objects * include omitted ../data-plane items * tools pass: model name updates and client.tsp clarification * very small update: explicit import inclusion for java diagnosis * Update specification/ai/OpenAI.Assistants/runs/routes.tsp Co-authored-by: Shawn Fang <45607042+mssfang@users.noreply.github.com> * Update specification/ai/OpenAI.Assistants/runs/routes.tsp * substantial feedback incorporation, version realignment, removal of interface use * distinct ThreadInitializationMessage model for one-shot thread/message * Update specification/ai/OpenAI.Assistants/client.tsp * [OpenAI-Assistant] Rename some method and model names. (#27456) * rename some method and model names * Correct ServiceApiVersion value * some PR feedback + tsp compile clean * PR feedback: address needed split of required_action and run_step tool call info * PR feedback: address newer additional_instructions, model refactor and nullability * access/visibility updates (mainly C#); fix optionality of additional_instructions * move @path parameter into UpdateAssistantOptions model * PR feedback: remove defunct suppression from much older version of deletionstatus * merge, PR feedback for v2 core update, regen yaml (no downstream impact) --------- Co-authored-by: Jose Alvarez Co-authored-by: Shawn Fang <45607042+mssfang@users.noreply.github.com> * Add new events for Storage - StorageTasks (#26887) * Add new events for Storage StorageTasks * Create storage_task_queued.json * Create storage_task_completed.json * Add files via upload * Add files via upload * Update storage_task_queued.json * Update storage_task_completed.json * Update Storage.json * Update Storage.json * Update Storage.json * Update specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> * Update example ref * Create storage_task_assignment_queued.json * Create storage_task_assignment_completed.json * Create storage_task_assignment_queued.json * Create storage_task_assignment_completed.json * Update Storage.json * Update Storage.json * Update Storage.json --------- Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> * Update ci-fix.md: mention Teams channel for help with TypeSpec (#27588) * Add API version 2023-10-01-preview [Import] (#27385) * Base version 2023-06-06 * 2023-10-01-preview version changes * 2023-10-01-preview version changes - generate max set examples * Change provisioning state because of cross-version breaking change * Fix prettier checks * Generate max set examples * Fix prettier checks * Add min set examples * Regenerate examples * Update readme * remove min set examples and change provisioning state * revert provisioning state change * Update readme for SDK generation * Mjmadhu playwrighttesting microsoft.azure playwright service 2023 10 01 preview new (#27132) * First commit with existing version files in new version folder * Added new ARM stable api-version for GA * Readme changes * Addressed review comments * Changed data type to float as discussed in the comments * Added suppression rules for SwaggerLintDiff as per review comment * Added suppression rules for SwaggerLintDiff as per review comment * Fix for suppressions not working * Modified suppression syntax to the new one as per TSG. * Added paths in suppressions * Rectifying path for ResourceNameRestriction Suppression * Paths not working correctly with ResourceNameRestriction suppression * HDInsight: onboard new apiversion 2023-11-01-preview (#27306) * onboard new apiversion 2023-11-01-preview * Adds base for updating Microsoft.HDInsight/HDInsightOnAks from version preview/2023-06-01-preview to version 2023-11-01-preview * Updates readme * Updates API version in new specs and examples * move changes from rpaasmaster branch * fix comment * fix comment * fix comment * fix comment * fix comment * fix comment * fix comment * fix comment * fix comment * Update specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/hdinsight.json Co-authored-by: Cunfeng <106650702+Cunfeng@users.noreply.github.com> * update examples (#27495) Co-authored-by: Long Ding (from Dev Box) * fix comment * fix comment * fix comment * fix comment * fix comment * fix comment --------- Co-authored-by: Wei Dong Co-authored-by: Cunfeng <106650702+Cunfeng@users.noreply.github.com> Co-authored-by: LDD Co-authored-by: Long Ding (from Dev Box) * [Azure AI - Health Insights] - Typespec revision for Health Insights API Version 2 (#27223) * Health Insights API Version 2 * add custom_words * update radiology insights doc descriptions * misspell * add java service-name option to emit the service name * update openAPI spec. misspell * model is Element instead of extends element * Fhir.R4 namespace as PascalCase * Fix: workaround - force order resolution * fix: suppression to get additionalProperties. DomainResource is Resource * suppress in patient timeline to get additionalProperties * [Health Insights] Project structure updates (#27545) * move main files under service dir * regen openapi + move examples * update client.tsp files * tsp format * update tspconfig.yaml * use clientName decorator to decorate Fhir_R4 models * Operation types as camelCase * replace projectedName with clientName * model extends Element - same as FHIR spec * move clientName to client.tsp * fix: clientName - typename * fix: token-expected: ';' * remove import, typespec-client-generator-core * tsp format * fix: LRO response schema to include result * add @clientName to all models * replace decimal with decimal128, add RI sample * replace decimal128 with float64 * tsp format * suppress AvoidAnonymousTypes * comment clientName decorators * comment clientName decorators * comment clientName decorator for RI client.tsp * Add projectedName * move projectedName to client.tsp * fix: projectedName on client * updat tspconfig.yaml * move service.tsp * update ref * revert structure changes * move examples * tspconfig --------- Co-authored-by: catalinaperalta * [ci-fix.md] Add known issues to "Swagger LintDiff for TypeSpec" (#27573) * Adding new version 2024-01-01-preview for updating monitor Properties (#27462) * Base API commit * Changing version to new 2024-01-01-preview * Adding additional parameters to MonitorProperties and updating example * Updating readme.md * [Hub Generated] Review request for Microsoft.ContainerService/aks to add version preview/2023-11-02-preview (#27431) * Adds base for updating Microsoft.ContainerService/aks from version preview/2023-10-02-preview to version 2023-11-02-preview * Updates readme * Updates API version in new specs and examples * update readme (#26753) * Add Trusted Launch fields to AgentPoolSecurityProfile (#26850) * add trusted launch fields to AgentPoolSecurityProfile * fix link to docs * add new words to cspell.json * fix links to docs again --------- Co-authored-by: Lily Pan * Replace "GuardrailsProfile" with "SafeguardsProfile", add ListSafeguardsVersions entities (#26798) * Update readme.md Reverting global tag to stable GA version for SDK release * Change guardrails to safeguards * clean up remaining references * fix casing * Add back guardrailsVersions * Fix typos --------- Co-authored-by: Jooneil Ahn * Add scheduled events data object. (#26774) * Add eventDetails to ScheduledEventProperties. --------- Co-authored-by: lilypan26 Co-authored-by: Lily Pan Co-authored-by: Nick Keller Co-authored-by: Jooneil Ahn Co-authored-by: Jun Sun <33297523+JunSun17@users.noreply.github.com> Co-authored-by: Jun Sun * Add AppPlatform 2024-01-01-preview (#27113) * Adds base for updating Microsoft.AppPlatform from version preview/2023-11-01-preview to version 2024-01-01-preview * Updates readme * Updates API version in new specs and examples * add cspell exclusion (#26987) * Add option for Application Configuration Service refresh interval (#26943) * add the option for acs refresh interval * refine description and complete examples * feat: Add Java 21 (#26946) * add buildpacks version (#26933) * Update appplatform.json * Update BuildServiceBuilder_Get.json * Update BuildServiceBuilder_List.json * Update BuildServiceBuilder_CreateOrUpdate.json * Update language specific readme.md for 2024-01-01-preview api version (#27041) * Cherry latest stable branch change to preview API version (#27063) * e94094bf12e543d04e6d90efabcd5d00e872a12e * 4a35b74f7b7ba2ef67f63f4c3389fc47a8f4b0e0 * f3e4338a5c5702982a0ca0e82f7bfeb0745d00a1 * 4a35b74f7b7ba2ef67f63f4c3389fc47a8f4b0e0 * a92c321d8a5fc30820f0f7741e8becc631b5d3bb * 9a93245d7a8827bc6aeebd2a94e76c92df6bae55 * a693dc6e0df2cabd0815df21a3ab1fa5e6529c7a * fix lint * fix lint * add buildpacks version (#27061) * Update appplatform.json * Update BuildServiceBuilder_Get.json * Update BuildServiceBuilder_List.json * Update BuildServiceBuilder_CreateOrUpdate.json * Update BuildService_GetSupportedBuildpack.json * Update readme.md (#27095) * Short lived app support (#26958) * Short lived app support * Rename type to kind * add cancelled (#1) * Add testEndpointAuthState to AppResourceProperties (#26938) * add disable test endpoint auth to AppResourceProperties * Update Apps_CreateOrUpdate_VNetInjection.json * Update Apps_CreateOrUpdate.json * Update Apps_Get.json * Update Apps_Get_VNetInjection.json * Update Apps_List.json * Update Apps_List_VNetInjection.json * Update Apps_SetActiveDeployments.json * Update Apps_Update.json * Update Apps_Update_VNetInjection.json * use enum for test endpoint auth * remove api version from readme.python.md * revert short lived app API (#27196) * adding version for python sdk temporarily for python sdk generation --------- Co-authored-by: Jeff <1830237+domainname@users.noreply.github.com> Co-authored-by: Qingyi Liu <34502364+smile37773@users.noreply.github.com> Co-authored-by: Yuwei Zhou Co-authored-by: ninpan-ms <71061174+ninpan-ms@users.noreply.github.com> Co-authored-by: Sandy Cai * Azure Deployment Manager is being decommissioned. Deleting the Rest API Specs related to ADM (#26818) * updating preview tag (#27555) * adding preview to 2023-11 tag * update tag * update tag in yaml * Patch Common-Types/Private Links V6 with Pageable Options (#27620) * adding paggable options for privatelinks common types * prettier * Adding new stable version "2024-01-01" (#27627) * New stable version 2024-01-01 * ReadMe changes * first commit (#27598) Co-authored-by: Will Huang * Update comment.yml: get rid of CI-MissingBaseCommit (#27622) * OpenAI Assistants: fix required_action function representation (#27638) * OpenAI Assistants: fix required_action function representation, clarify models * PR feedback: incorporate doc mention of argument JSON format * add round trip rules (#27623) * Mobile packet core service (#27517) * Mobile packet core service * Update the list by XXX descriptions * Xuhumsft securityinsights microsoft.security insights 2023 12 01 preview (#27214) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-10-01-preview to version 2023-12-01-preview * Updates readme * Updates API version in new specs and examples * [SupportSubTechniques] - Add sub techniques to swagger. * apply changes of 11-01-stable version to the 12-01-preview * resolve breaking changes * healthinsights, fix tspconfig on java emitter options (#27646) * [astro] disable flatten (#27649) * Create readme.python.md * Update readme.python.md * Update readme.md * update the basic version and add typescript.md * Update specification/liftrastronomer/resource-manager/readme.typescript.md Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> --------- Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> * [Hub Generated] Review request for Microsoft.Migrate/AssessmentProjects to add version preview/2023-04-01-preview (#26489) * Adds base for updating Microsoft.Migrate/AssessmentProjects from version stable/2023-03-15 to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * 1. Microsoft.Migrate 2023-04-01-preview swagger - Initial commit * 1. Added Business case examples * 1. Prettier check on examples * 1. Swagger json Prettier fix * 1. Added WebAppV2 examples * 1. Renaming Web App file names * 1. Adding examples for WebAppV2 and AKS * 1. Fixed swagger and examples for Business case * 1. Updated bcs swagger and examples * 1. Added resourceId in Business case list * 1. Fixed custom words * 1. Resolve spellcheck * 1. Fix model validation check for Business case * 1. Added custom words * Fix Model Validation Errors for AKS * updated few examples * Update WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json Updated webAppAssessmentOptions * Add and Update AKS Swagger Examples * Update Swagger File with Latest Changes * Fix Prettier Check * Updating examples * update * 1. Updated swagger * 1. Moved to types version v5 * 1. Fixed Business case validation for Get and Create * 1. Updated Business case Delete to sync operation * 1. Updated Business case delete response code in examples * Fix Prettier Check * 1. Added AKS changes in swagger * 1. Fixed prettier check in swagger * Fix Model Validation Errors for AKS * 1. Updated AVSOnly * 1. Reverted custome-words.txt. This change needs to be taken right before activating the PR * 1. Model validation fixes for previous version * 1. Updated PrivateEndpointConnections examples * 1. Updated PE fix * 1. Updated PE examples * 1. Fixed Hotfix changes from previous version * 1. Fixed version typo * 1. Fixed Duplicate Key issue * Update Swagger with POS Core and AKS Changes * Add visibility read to Immutable Models in AKS and POS Core Swagger * Fix Model Validation Errors for AKS * 1. Updated custom-words list for spellcheck * 1. Added custom word * 1. Linux Ahub changes * 1. Fixed prettier check * 1. Updated businesscases to camelCase * 1. Updated swagger to use the same enum for Ahub * 1. Updated links from v4 to v5 * 1. Resolved custom-words conflict * update comments * update * Update description for readonly properties for AKS * 1. Resolve ProvisioningState readonly issues * 1. Resolve ProxyResource readonly issue * Update Swagger with Latest Changes from AKS * Update PUT AKS Example * 1. Custom-words update * 1. Added lint suppressions * 1. Fixed indentation issue in readme * 1. Edited Readme * 1. Updated Readme * 1. Fixed Lintdiff * 1. Manually adding provisioningState at the resource property level * 1. Reverting the manual addition for readOnly in provisioningState * 1. Typespec generated provisioningState resolution * 1. Updated provisioningState and example * 1. Updated WebAppAssessmentV2 Create example to remove provisioningState in PUT call * 1. Updated WebAppCollector to use provisioningState readonly * 1. Updated WebAppCollectorOperations_Create_MaximumSet_Gen * 1. Removed unused model from Swagger * 1. Remove suppression check * 1. Applied suppression for AvoidAdditionalProperties 2. Fixed camelCasing in examples * 1. Removed custom words * 1. Updated description for POS * 1. Changed location modelling from Enum to string. * 1. Updated camelCasing 2. Updated cSpell.json 3. Updated custom-words.txt * 1. Fixed descriptions --------- Co-authored-by: Kushal Mehrotra Co-authored-by: Umesh Yadav Co-authored-by: Tanvi Dhope Co-authored-by: tanvidhope-microsoft <129372814+tanvidhope-microsoft@users.noreply.github.com> * Mjmadhu playwrighttesting microsoft.azure playwright service 2023 10 01 preview cp (#27611) * Base commit to add new version folders * Moving unrequired stable version back to preview * Update python readme (#27504) Co-authored-by: Yi Gu * fix Nsp link properties description (#27601) * fix link spec * updated examples * fix pretty * Introducing service group for orbital (aogs and aodg) (#27582) * Introducing service group for orbital (aogs and aodg) * Updated path to common-types * Updated tag * changing folder structure * Moved from Id to a ResourceReference object * Updated descriptions * Updated id to resourceId * Updated examples * Revert "Updated examples" This reverts commit 0f5604a0bc53a715bc2e119d6fc4863ec441a4dc. * Revert "Updated id to resourceId" This reverts commit 8d31746216d949562d31c2a98b7ccc13c7557adf. * TypeSpec conversion for Purview Policy (#26460) * Initial Purview Policy TypeSpec conversion * Update examples * Fixing doc, ProxyResource and other fixes * Fixing output * Fixing example values * fix example values * Fixing addition of name * Fixing prettier on example json * Adding {scope} backcompat override * Fix model validation * Fixing model errors * Fixing format error * Work around scope size bug * Update readme.md for SDK generation (#27664) * Update readme.md * add readme.go.md --------- Co-authored-by: Peng Jiahui <804873052@qq.com> * disable model flatten for service Azure Large Instance&HDInsight Container (#27613) * disable-flatten * Create readme.java.md * Create readme.java.md * Update readme.java.md * update typescript.md --------- Co-authored-by: Weidong Xu Co-authored-by: Xiaofei Cao <92354331+XiaofeiCao@users.noreply.github.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> * [Hub Generated] Review request for Microsoft.RecoveryServices to add version stable/2023-08-01 (#26302) * Adds base for updating Microsoft.RecoveryServices from version stable/2023-06-01 to version 2023-08-01 * Updates readme * Updates API version in new specs and examples * Add example for DelteInfra API * Add reference to new API in service file/ Update A2A EnableProtection input * Fix semantic errors * Fix naming convention issue * Adding default response for the new API * Fix: Swagger LintDiff errors * Fix: Swagger LintDiff errors * Fix: minor typo * Fix: default error schema * Fix: default error schema * Fix: Remove 204 response code as per ARM guideline * Fix: Swagger PrettierCheck errors * Fix spellcheck issue * Address comments * Address comments * Revert "Address comments" This reverts commit 0087c5db206c0448d9b413de742229f23a70bd76. * Add 200 response * Address comments * Revert "Address comments" This reverts commit 9c9a8735d7aa3e02d6b00dcf968b48ea41f0c230. * Remove 200 response --------- Co-authored-by: Tim Lovell-Smith * TSP Conversion for Microsoft.ApiCenter (#27618) * TSP Conversion for Microsoft.ApiCenter * Changing parameter names in json * Changed parameter for Services.CreateOrUpdate * Fixing formatting * Fix example properties * [EventGrid] Microsoft.AVS/privateClouds events (#24015) * Microsoft.AVS/privateClouds events * linting * remove datastore events for now * rename version/dir to preview and exclude examples * SDK review feedback * change dict type definition * versioning * Properties->Data * update typescript.md (#27679) * Adding E5 SKU to stable branch for GA release (#27656) * Adds base for updating Microsoft.Cache from version stable/2023-11-01 to version 2024-02-01 * Updates readme * Updates API version in new specs and examples * Add E5 to stable branch for GA release * update events with metadata (#27137) * Update readme.md Reverting global tag to stable GA version for SDK release * adding metadata to missing events * Revert "adding metadata to missing events" This reverts commit 9c149b5052173b752c5981fcf6a81f8b4ad1a8cc. * adding metadata to missing events * merged from master * fixing conflict * resolving conflicts * removing unwanted code --------- Co-authored-by: Jooneil Ahn * Feature/datamap tsp (#26702) * initial commit * update attr * add security scheme * Update models.tsp * update * Update models.tsp * update * update examples * update * update * update * Update routes.tsp * update * Update routes.tsp * Update tspconfig.yaml * update interface name * update query parameter to non-requried and correct int mdoel * correct response status code from 204 to 200 * Create openapi.json * update typo * Update openapi.json * update * update examples * update examples * update * update examples * update * update example * update businessMetadata * Update purviewdatamap.json * Update custom-words.txt * Update purviewdatamap.json * update searchoperator filter * update import examples * update * Update Search Filters (#26837) * update * Delete openapi.json * add @client * Update routes.tsp * Update routes.tsp * Update tspconfig.yaml * Update main.tsp * Update specification/purview/Azure.Analytics.Purview.DataMap/main.tsp Co-authored-by: catalinaperalta * updated * Update models.tsp * update error response * Update models.tsp * update descriptions * run tsp format * Create openapi.json * update * add api version * updated * guid is not required * update examples * update search filter * update model name * updated * update client.tsp * Update client.tsp * update client.tsp * Update client.tsp * update client.tsp * update * Update main.tsp * Rename models by comments rename xxContent to xxOptions rename ContactBasic rename SearchRequsetTaxonomySetting * Update openapi.json * client/method renaming list->get bulk -> batch remove unique using operation group guid -> id * Update client.tsp * fix casing problem * update comments * update * update discovery * update * fix example bug * update partalUpdates * update query parameter overwrite * Update attr to attribute * Update partialUpdates * align using body parameter * Update Glossary_PartialUpdateCategory.json * revert update examples in original example folder * Revert "revert update examples in original example folder" This reverts commit 867767b5dc69f259596e6379aa33617dc6b56d7f. * Update Glossary_PartialUpdateCategory.json * Revert "Update Glossary_PartialUpdateCategory.json" This reverts commit d31fe8aa07e5076cf6e3299c3a9123681ebabd23. * Revert "Revert "revert update examples in original example folder"" This reverts commit 8f7003247f3d435dc8c80188cb8a5ade814aa137. * Delete openapi.json * fix typeSpec validation error * Update purviewdatamap.json * Update purviewdatamap.json * update * update * update * update * Update models.tsp * Update models.tsp * Update readme.md * Update readme.md * update * update * Update openapi.json * move to cSpell.json * update examples * update examples * fix api doc preview * update csharp naming * update * Update client.tsp * keep purviewdatamap.json * Update readme.md * test for csharp operation group name * Update routes.tsp * Update routes.tsp * fix comments * Update routes.tsp * move to client.tsp * Update client.tsp * Update client.tsp * Update client.tsp * update api version query parameter * update api version query parameter * update * set the body for label API to align with the GA swagger doc * Update api version query parameter * update for comments * update * Update routes.tsp * update the createTime/updateTIme for an issue in csharp generator * Revert "update the createTime/updateTIme for an issue in csharp generator" This reverts commit a9e8ec26f7d01788c8b94c582a7de0b82c00ce66. * update with safeint * update to encodeName --------- Co-authored-by: Catalina Peralta Co-authored-by: yaleiZhao <87844682+yaleiZhao@users.noreply.github.com> * Resolving 2023-05-01 swagger validation errors for Azure Firewall examples. (#27403) * Added missing id property to some example resources. Added headers with locations to long-running operation examples. * Added some missing information on some response object typings regarding the location property used in long-running operations. * Fixed a possible typo 'azure-async-operation' to 'azure-asyncoperation' (removed a hyphen). * Ran prettier against azureFirewall.json * Bug fix: Remove maxLeng on ScopeParameter (#27616) * Add issue templates for question, bug, and feature request (#27610) * Add issue templates for question, bug, and feature request * Added labels to bug and feature request templates * Update .github/ISSUE_TEMPLATE/01_question.yml Co-authored-by: Konrad Jamrozik * Update .github/ISSUE_TEMPLATE/01_question.yml Co-authored-by: Konrad Jamrozik * Updates to the Spec and Version inputs --------- Co-authored-by: Konrad Jamrozik * Update clusterservice.tsp (#27684) Removal of test description that was accidentally retained during the last review * [TypeSpec] Upgrade to 0.53.0 (#27677) - Includes openapi updates as reactions to: - Azure/typespec-azure#152 - Azure/typespec-azure#176 * Add clarity to Search v1 API regarding `municipality` vs. `localName`. (#27685) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * Add clarity to Search vs API regarding vs. . See https://msazure.visualstudio.com/One/_workitems/edit/16726198. * [TypeSpec Validation] Fail fast if "npm install" fails (#27678) - Fixes #25145 * Mvvsubbu databricks microsoft.databricks 2024 02 01 preview (#27607) * Adds base for updating Microsoft.Databricks from version preview/2023-09-15-preview to version 2024-02-01-preview * Updates readme * Updates API version in new specs and examples * Adding Swagger Spec for Private DBFS * Reverting Package Tag Change * Changing Package Tag * Fixing the comments for PR * Fixing format id violations * Fixing format error * paloaltonetworks - Add Strata Cloud Manager APIs (#27681) * Add base for updating PaloAltoNetworks.Cloudngfw from version preview/2024-01-19-review to version 2024-02-07-preview * Updates readme * Updates API version in new specs and examples * Add SCM APIs in swagger * Update examples * Fix api version in example * Changed model name ProductSerialNumberRequestStatus * add directive to match parameter name (#27693) * update parameter name in examples * Revert "update parameter name in examples" This reverts commit ebba370244263a5acb24ee28cde1ed68babd4348. * update ts.md * update * Add api version 2024-02-15-preview of Azure OpenAI (#27669) * Add api version 2024-02-15-preview of Azure OpenAI * Fix spelling issues * More spelling fixes * Fix/align property names * minor fixes * Add examples for assistant apis (#27699) * Add assistant examples * add ref to examples * run prettier --------- Co-authored-by: Shruti <47434204+shrgupta773@users.noreply.github.com> * Compute GalleryRP release 2023-07-03 (#27518) * copy over old api version to new folder * new api version readme api version * Cplat 2023-07-03 (#27590) * add virtualmachineid field and make comment more generic * remove extra whitespace --------- Co-authored-by: tiregan <70166995+tiregan@users.noreply.github.com> * [TypeSpec] Bump compiler, openapi3 and autorest version with union hotfix (#27707) * Adding new api version 2024-01-01-preview (#27419) * Base Commit * Updating Elastic json * Added Examples and version Update * Updated readme * Model Validation Update 1 * More Fixes * Fixing Model Properties * More Fixes * Prettier fixes * Prettier fix 2 * adding subscription state in monitor properties * reverting package-lock json * reverting package-lock json * Adding one more API path * Fixing errors in new path 1 * Fixing Lint errors * fixing arm comments 1 * Fixing swagger errors * Fixing review comments * Fixing errors * Fixing errors * Adding suppression * Fixing suppression * Fixing suppression 2 --------- Co-authored-by: Rhea Hooda * Added customizations for pagination models (#27683) * Added customizations for pagination models * Added stream-style-serialization and removed redundant option * Revert "Added stream-style-serialization and removed redundant option" This reverts commit 27615fdb353c7326a03e44a83cbe1492896ca1af. * Fix incorrect tag name in comment. (#27741) * Update package.json (#27747) * Replace `@projectedName("json"` -> `@encodedName("application/json"` (#27740) * Release machinelearningservices microsoft.machine learning services 2024 01 01 preview shadow (#27320) * Adds base for updating Microsoft.MachineLearningServices from version preview/2023-08-01-preview to version 2024-01-01-preview * Updates readme * Updates API version in new specs and examples * Add MachineLearningService workspace publish API and datareference API to 2024-01-preview (#26495) * Add MachineLearningService workspace publish API and datareference API to 2024-01-preview * minimize diffs * fix 200 response definitions * fix example api version values * one more example version fix * Fix post uri * Revert "Fix post uri" This reverts commit 7b1f10ae0f9dcf8ed121485136a3eca2d3ca6aa7. * add suppression * add path_on_compute for 20240101 preview mfe.json (#26447) Merging to release branch * after discussion and delete unnecessary path_on_compute from literl input (#26750) * Add updateDataMounts API to 2024-01-01-preview (#26320) * Add updateDataMounts API to 2024-01-01-preview * Fix api-version in example * Add field mountMode * MoMo contract align public preview and GA (#26703) * Rearrange Parameters in mfe.json-Jan 2024 Preview (#26799) * Update mfe.json * Updated mfe.json with prettier check changes * Updated mfe.json to address new lint diff errors * Updated mfe.json with rearranged parameters * Managed resource group settings for registries (#27065) added MRG settings. * Add azureml schedule trigger once arm API contract in 2024-01-01-preview (#27116) * Add azureml schedule trigger once arm API contract in 2024-01-01-preview * Fix error * Prettier * Fix wording and update sample value. * Update * fix-spellcheckErrors-Jan24Preview (#27299) * Remove Default Value to match with GA (#27429) * Add FineTuning Job contracts. (#27469) * Add FT Job contracts. * Fix prettier. * Fix issues. * Fix spell check. * prettier fixes. * Fix examples. * Fix gates. * Fix gate. * Fix. * Fix. * Fix. * fix. * Fix. * Fix. * Fix. * Fix. * Update. * Fix. * Update the type to be Dictionary * Fix comment. * Suppress AvoidAdditionalProperties * Correction. * Fix. * Fix * try fix. * Fix * Fix. * Fix * Fix * fix. * Fix * Fix. * Fix. * Fix * Fix * Fix comment. * Fix. * try * Fix linter error. * Fix --------- Co-authored-by: Sagar Sumant * Update workspaceRP 2024-01-01-preview swagger (#27194) * Update swagger * Update format * update version * fix spell check * Update format and example * Update example name * Update format * Fix model validation * Update example * Update format * fix some lint error * update some response * Update swagger * Update policy related API * Fix policy api and example * Update parameter * Update * Update example * Address comments * format and update example * Add one description * Fix one fomat * Update example and some missing places * small fix * Address comments * Update example * Update example * Update example and descriptions * Remove HubPolicy Apis in this version * remove unused definition * Add back ComputeRuntimeDto * update with feedback * Update example * Update response shema * downgrade back to v3 common type * Update suppression * try update suppression * suppress with smaller scope * update suppressions location * Update suppression and copy cogservice schema * Update ref * Update suppression path * add more larger scope for suppression * Update suppression * Add MarketplaceSubscriptions, update ServerlessEndpoints in Microsoft.MachineLearningServices 2024-01-01-preview Staging Branch (#27426) * add MarketplaceSubscription API * add examples * lintDiff, Prettier, and ModelValidation fixes * remove now-undefined 200 from delete.json * prettier fix, again * add ServerlessEndpoint contract changes * spell check fix * prop rename serverlessEndpointState -> endpointState * mark MarketplaceSubscriptionProvisioningState definition as readOnly: true --------- Co-authored-by: chaoyu-msft <93601904+chaoyu-msft@users.noreply.github.com> Co-authored-by: Yang Cao <110205279+yancao6@users.noreply.github.com> Co-authored-by: Zhaoyang Li Co-authored-by: yuacheng35 <90874573+ycheng35xo@users.noreply.github.com> Co-authored-by: ragovada <142325886+ragovada@users.noreply.github.com> Co-authored-by: adyada <118839465+adyada@users.noreply.github.com> Co-authored-by: Peng Wang <111494967+msancolman@users.noreply.github.com> Co-authored-by: sagarsumant Co-authored-by: Sagar Sumant Co-authored-by: ZhidaLiu Co-authored-by: Teddy Todorov * added fttraidlevel in avssummary (#27686) * added fttraidlevel in avssummary * changed fttType to string type * changed the fttRaid to enum type --------- Co-authored-by: Venkat Jakka * Add Azure Programmable Connectivity dataplane APIs (#26922) * Move initial work over from private repo * Add some more TODOs * Fix location API - Remove MaxAge parameter * Resolve TODOs * fix pipeline issues * markups * markups * markups * make extenrla id also consistant with strucutre * fix formatting * Add Device to SimSwapVerifyRequest, and make IP addresses optional in LocationVerifyRequest * change the scope URL to https://management.azure.com/.default * change scopein openapi.json to https://management.azure.com/.default as well * Adding python config to tspconfig.yaml * change endpoint casing and fix formatting * update examples * fix typo * add c sharp * rename some variables because .net generatiopn is complaining about it. Request>content and response>Result * some more replaces * Fix single word classes: Single word class names are too generic and have high chance of collision with BCL types or types from other libraries * try adding veriosning * try adding ver * fix date * replace NetworkDevice >>> NetworkRetrieveResult * Typespec validation pass * replace older version with current one * Further pipeline fixing * use proper nouns, and do easy changes * camel case * replace *Interface with base path of the API * Retrieve>Retrieval * blankline * rename some variables * new lines prettier * number interface > number verification * new lines * blank lines * Add deprecation notice * remove enums and add response header * remove devicenetworkidentifier, as it's duplicate, change long/latitude to doubles * Make ApcError an extension of Azure.Core.Foundations.Error * Number verification updates for frontend auth * ImplDocument number verification in typespec * Remove python and .net sdk configuration, pending resolution of namespace discussions * Update date of api version * Some pipeline wrangling * Remove NumberVerification retrieval APIs as they will not be implemented for public preview; add suppression of ValidResponseCodeRequired * Add back Python SDK after fixes to autogen * Improve docstrings, try to localize suppressions --------- Co-authored-by: Jamie Ford Co-authored-by: Ella Bridgett-Tomkinson Co-authored-by: Aron Hegedus * Corrected the "Pricing Tiers" link text (#27752) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * Fix link to [pricing tiers]. * Fix link to [pricing tiers] in render v1 swagger file, and corrected the link in the readme to render v1. * Convert ARM TSP from enum to union (#27749) * Mark MOE API Contract MaxQueueWait as deprecated (#27688) * Update mfe.json * Update mfe.json * Update mfe.json * Adding new stable API version 2024-03-01 for Microsoft.Elastic (#27735) * Base API Commit * Updating the API version to 2024-03-01 in the new stable version files * Updating readme.md with 2024-03-01 * Updating readme.md version path * Poli check macao sar (#27755) * Update readme.md: Common/stable/2023-06-01 current: Common/stable/2023-07-01 Updated: Common/stable/2023-06-01 * PoliCheck issue, changed 'Macao' to 'Macao SAR'. * Changed ROC to Taiwan as per PoliCheck (https://policheck.microsoft.com/Pages/TermInfo.aspx?LCID=9&TermID=80176). * Changed 'Saigon' to 'Ho Chi Minh City' as per PoliCheck (http://policheck.azurewebsites.net/Pages/TermInfo.aspx?LCID=9&TermID=80184). * Changed 'Rangoon' to 'Yangon (Rangoon)' as per PoliCheck (http://policheck.azurewebsites.net/Pages/TermInfo.aspx?LCID=9&TermID=80141). * Changed 'Chungking' to 'Chongqing' as per PoliCheck (http://policheck.azurewebsites.net/Pages/TermInfo.aspx?LCID=9&TermID=214092). * [CosmosDB] Microsoft.DocumentDB 2024-02-15-preview API version (#27399) * Adds base for updating Microsoft.DocumentDB from version preview/2023-11-15-preview to version 2024-02-15-preview * Updates readme * Updates API version in new specs and examples * update duration format to resolve .net sdk track2 error (#27586) * update duration format to resolve .net sdk track2 error * use x-ms-format duration-constant * RestoreParameter's new property: RestoreWithTTLDisabled (#27448) * Add restoreWithTTLDisabled parameter to restoreParameterBase and to examples * Fix json synax - extra comma * Fix json synax - extra comma * Fix swagger lintDiff property name camel case issue * Revert back to all cap TTL * Revert to camel casing * swagger changes for perregion autoscale (#27455) * swagger changes for perregion autoscale * default to true in examples --------- Co-authored-by: Kushal Warke * Add DTS complete API (#27633) Co-authored-by: Nitesh Vijay * Resolve review comments for DTS (#27730) * Update dataTransferService.json * Fix model validation * update path to ./cosmos-db.json (#27753) * update x-ms-force-deallocate header type to string (#27765) --------- Co-authored-by: minhokang242 <128573538+minhokang242@users.noreply.github.com> Co-authored-by: Kushal Warke <156882604+kushalwarke1@users.noreply.github.com> Co-authored-by: Kushal Warke Co-authored-by: Nitesh Vijay Co-authored-by: Nitesh Vijay * [Hub Generated] Publish private branch 'eatkimchee-rpsaasmaster-fist-Microsoft.IoTFirmwareDefense-2024-01-10' (#27644) * add or modify files * fix readme tag * Removed unpublished api tags from readme * Fixing Package Version Tag (#27769) * Adds base for updating Microsoft.ContainerService/fleet from version preview/2023-08-15-preview to version 2024-02-02-preview * Updates readme * Updates API version in new specs and examples * [Fleet] UpdateRun manual skip (#27323) * manual skip API * copied examples * fix typo * fix example * add missing examples * add missing examples * fix examples * fix examples * fix examples * fix examples * fix examples * fix examples * fix examples * add fleet hub profile back * custom-words * [Fleet][UpdateRun] Rename skip target (#27449) * rename skip target * identifier * fix examples * format * [Fleet] 2024-02-02-preview Readme files (#27499) * readme files * fix typo * fix typo * fix the final-state-via options for LRO (#27574) * Add ControlPlaneOnly enum to ManagedClusterUpgradeSpec (#27491) * Add ControlPlaneOnly enum to ManagedClusterUpgradeSpec * add decorator for 2-02 release and fix comments * fix comment * fix decorator generation * fix version commenting * fix commenting typo * revise spec comments and consolidate into type comments * sync to async (#27745) * [Fleet] 2024-02-02-preview compile with latest compiler (#27750) * update compiler * update compiler * [Fleet] 2024-02-02-preview resolve conflicts (#27760) * resolve conflicts * resolve conflicts * resolve conflicts * updated package-lock --------- Co-authored-by: Allegra Domel Co-authored-by: Mike Harder Co-authored-by: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Co-authored-by: Darren Cohen <39422044+dargilco@users.noreply.github.com> Co-authored-by: johnkoh-msft <113449581+johnkoh-msft@users.noreply.github.com> Co-authored-by: wangyuantao <98181+wangyuantao@users.noreply.github.com> Co-authored-by: Yuantao Wang Co-authored-by: Kevin J Kurian <31308710+kevinjaku@users.noreply.github.com> Co-authored-by: Albert Cheng <38804567+ckairen@users.noreply.github.com> Co-authored-by: steve munk <33468793+stevemunk@users.noreply.github.com> Co-authored-by: sushil490023 Co-authored-by: Sushil Upadhyay Co-authored-by: Quentin Robinson <32183739+quentinRobinson@users.noreply.github.com> Co-authored-by: catalinaperalta Co-authored-by: Yuchao Yan Co-authored-by: abaranwal-ms <124332815+abaranwal-ms@users.noreply.github.com> Co-authored-by: Dapeng Zhang Co-authored-by: Ruoxuan Wang <52271048+ruowan@users.noreply.github.com> Co-authored-by: wangbwn <69622111+wangbwn@users.noreply.github.com> Co-authored-by: Bo Wang Co-authored-by: FumingZhang <81607949+FumingZhang@users.noreply.github.com> Co-authored-by: mwesigwaguma <111312378+mwesigwaguma@users.noreply.github.com> Co-authored-by: mahakjain314 <50352900+mahakjain314@users.noreply.github.com> Co-authored-by: 04diiguyi Co-authored-by: Yi Gu Co-authored-by: Yalin Li Co-authored-by: Xinyi Joffre Co-authored-by: Konrad Jamrozik Co-authored-by: Wes Haggard Co-authored-by: ForrestGumb Co-authored-by: Jun-wei Gan Co-authored-by: besh2014 <101864397+besh2014@users.noreply.github.com> Co-authored-by: gachauhan <107858796+gachauhan@users.noreply.github.com> Co-authored-by: namalu Co-authored-by: Nate Malubay Co-authored-by: sazeesha098 <52990439+sazeesha098@users.noreply.github.com> Co-authored-by: Zeeshan Sayyed Co-authored-by: Robert Lee Co-authored-by: wenqibu <153253179+wenqibu@users.noreply.github.com> Co-authored-by: Heath Stewart Co-authored-by: Weidong Xu Co-authored-by: Rhea Jain Co-authored-by: Jack Lichwa <52512203+jlichwa@users.noreply.github.com> Co-authored-by: Zao Wang <122930832+zaowang-ms@users.noreply.github.com> Co-authored-by: GovardhanaDK <36787828+GovardhanaDK@users.noreply.github.com> Co-authored-by: Govardhana D K Co-authored-by: Peng Jiahui <46921893+Alancere@users.noreply.github.com> Co-authored-by: Ryan Hurey Co-authored-by: will Co-authored-by: Will Huang Co-authored-by: Alec Baird <100880612+alec-baird@users.noreply.github.com> Co-authored-by: tianxinliu <121260442+tianxin-ms@users.noreply.github.com> Co-authored-by: kulalking Co-authored-by: Deyaaeldeen Almahallawi Co-authored-by: Vikas Palaskar Co-authored-by: Vikas Palaskar Co-authored-by: jylama-99 <111391678+jylama-99@users.noreply.github.com> Co-authored-by: Jyoti Lama Co-authored-by: Timothee Guerin Co-authored-by: Travis Wilson <35748617+trrwilson@users.noreply.github.com> Co-authored-by: Jose Alvarez Co-authored-by: Shawn Fang <45607042+mssfang@users.noreply.github.com> Co-authored-by: shulinwang33 <128629270+shulinwang33@users.noreply.github.com> Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Co-authored-by: pracagrawal <147133157+pracagrawal@users.noreply.github.com> Co-authored-by: MJ <71822730+mjmadhu@users.noreply.github.com> Co-authored-by: Wei Dong <40835867+dw511214992@users.noreply.github.com> Co-authored-by: Wei Dong Co-authored-by: Cunfeng <106650702+Cunfeng@users.noreply.github.com> Co-authored-by: LDD Co-authored-by: Long Ding (from Dev Box) Co-authored-by: Asaf Levi <100200009+asaflevi-ms@users.noreply.github.com> Co-authored-by: Apoorva Singh <142499457+apoorvasingh130@users.noreply.github.com> Co-authored-by: lilypan26 Co-authored-by: Lily Pan Co-authored-by: Nick Keller Co-authored-by: Jooneil Ahn Co-authored-by: Jun Sun <33297523+JunSun17@users.noreply.github.com> Co-authored-by: Jun Sun Co-authored-by: Xiaolu Dai <31124698+saragluna@users.noreply.github.com> Co-authored-by: Jeff <1830237+domainname@users.noreply.github.com> Co-authored-by: Qingyi Liu <34502364+smile37773@users.noreply.github.com> Co-authored-by: Yuwei Zhou Co-authored-by: ninpan-ms <71061174+ninpan-ms@users.noreply.github.com> Co-authored-by: Sandy Cai Co-authored-by: rohantagaru <126915631+rohantagaru@users.noreply.github.com> Co-authored-by: Tomer Shaiman Co-authored-by: VIPRAY JAIN <118152689+vipray-ms@users.noreply.github.com> Co-authored-by: Zhenhua Hu Co-authored-by: Mark Libby <67108593+mgl1969@users.noreply.github.com> Co-authored-by: xuhumsft <116764429+xuhumsft@users.noreply.github.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> Co-authored-by: Kushal <74910567+kushalmehrotra713@users.noreply.github.com> Co-authored-by: Kushal Mehrotra Co-authored-by: Umesh Yadav Co-authored-by: Tanvi Dhope Co-authored-by: tanvidhope-microsoft <129372814+tanvidhope-microsoft@users.noreply.github.com> Co-authored-by: Vineet <4174297+vineetmimrot@users.noreply.github.com> Co-authored-by: kkashojjula-msft <114022566+kkashojjula-msft@users.noreply.github.com> Co-authored-by: Allen Zhang Co-authored-by: Peng Jiahui <804873052@qq.com> Co-authored-by: Xiaofei Cao <92354331+XiaofeiCao@users.noreply.github.com> Co-authored-by: rthapliyal-msft <148342022+rthapliyal-msft@users.noreply.github.com> Co-authored-by: Tim Lovell-Smith Co-authored-by: Mark Cowlishaw Co-authored-by: Eugene Tolmachev Co-authored-by: revanthballa1188 <125347990+revanthballa1188@users.noreply.github.com> Co-authored-by: Osahumen Uyi Aghasomwan <65305780+osaghaso@users.noreply.github.com> Co-authored-by: Yifan Zhou <78060542+yifan-zhou922@users.noreply.github.com> Co-authored-by: yaleiZhao <87844682+yaleiZhao@users.noreply.github.com> Co-authored-by: ajtms <154369796+ajtms@users.noreply.github.com> Co-authored-by: Ronnie Geraghty Co-authored-by: Subrahmanyam Mandavilli Co-authored-by: Ralf Beckers Co-authored-by: Shruti <47434204+shrgupta773@users.noreply.github.com> Co-authored-by: Adam Sandor Co-authored-by: tiregan <70166995+tiregan@users.noreply.github.com> Co-authored-by: Utkarsh Jain <35839529+utkarshjain1508@users.noreply.github.com> Co-authored-by: Rhea Hooda Co-authored-by: Kayla Seager <1675997+kseager@users.noreply.github.com> Co-authored-by: chaoyu-msft <93601904+chaoyu-msft@users.noreply.github.com> Co-authored-by: Yang Cao <110205279+yancao6@users.noreply.github.com> Co-authored-by: Zhaoyang Li Co-authored-by: yuacheng35 <90874573+ycheng35xo@users.noreply.github.com> Co-authored-by: ragovada <142325886+ragovada@users.noreply.github.com> Co-authored-by: adyada <118839465+adyada@users.noreply.github.com> Co-authored-by: Peng Wang <111494967+msancolman@users.noreply.github.com> Co-authored-by: sagarsumant Co-authored-by: Sagar Sumant Co-authored-by: ZhidaLiu Co-authored-by: Teddy Todorov Co-authored-by: abhi580 <43762309+abhi580@users.noreply.github.com> Co-authored-by: Venkat Jakka Co-authored-by: Andrew Niven <150024151+AndrewNivenMSFT@users.noreply.github.com> Co-authored-by: Jamie Ford Co-authored-by: Ella Bridgett-Tomkinson Co-authored-by: Aron Hegedus Co-authored-by: Laurent Mazuel Co-authored-by: Brian Hungerman Co-authored-by: Pooja Shetty <85922721+poshett@users.noreply.github.com> Co-authored-by: carjackson-msft <124716637+carjackson-msft@users.noreply.github.com> Co-authored-by: minhokang242 <128573538+minhokang242@users.noreply.github.com> Co-authored-by: Kushal Warke <156882604+kushalwarke1@users.noreply.github.com> Co-authored-by: Kushal Warke Co-authored-by: Nitesh Vijay Co-authored-by: Nitesh Vijay Co-authored-by: eatkimchee <93681528+eatkimchee@users.noreply.github.com> Co-authored-by: Stéphane Erbrech Co-authored-by: frantran --- .github/ISSUE_TEMPLATE/01_question.yml | 46 + .github/ISSUE_TEMPLATE/02_bug.yml | 76 + .github/ISSUE_TEMPLATE/03_feature_request.yml | 34 + .../control_plane_template.md | 35 +- .github/comment.yml | 10 - .github/issue_assignment.yml | 6 - .github/pull_request_assignment.yml | 145 - cSpell.json | 81 +- custom-words.txt | 40 + ...Semantic-and-Model-Violations-Reference.md | 39 + .../references/ErrorCodeReference.md | 28 + documentation/ci-fix.md | 150 +- documentation/samplefiles/readme.python.md | 5 + eng/pipelines/templates/steps/npm-install.yml | 9 + eng/pipelines/typespec-requirement.yml | 2 +- eng/pipelines/typespec-validation-all.yml | 4 +- eng/pipelines/typespec-validation.yml | 4 +- eng/scripts/ChangedFiles-Functions.ps1 | 4 +- eng/scripts/Copy-ApiVersion.ps1 | 77 + eng/scripts/TypeSpec-Requirement.ps1 | 59 +- eng/tools/typespec-validation/ci.yml | 7 +- eng/tools/typespec-validation/package.json | 4 +- eng/tools/typespec-validation/src/index.ts | 8 + eng/tools/typespec-validation/src/tsv-host.ts | 1 + .../src/tsv-runner-host.ts | 6 +- eng/tools/typespec-validation/src/utils.ts | 6 +- .../typespec-validation/test/tsv-test-host.ts | 4 + package-lock.json | 35 +- .../ai/DocumentIntelligence/tspconfig.yaml | 9 +- .../model.common.fhir.elements.tsp | 388 + .../model.common.fhir.resources.tsp | 444 + .../model.common.request.tsp | 101 +- .../model.common.response.tsp | 80 +- .../model.common.shared.tsp | 193 +- .../HealthInsights.Common/primitives.tsp | 61 +- .../HealthInsights.OncoPhenotype/client.tsp | 70 +- .../model.oncophenotype.tsp | 24 +- .../route.oncophenotype.tsp | 14 +- .../tspconfig.yaml | 54 +- .../SuccessfulOncoPhenotypeRequest.json | 64 + .../SuccessfulOncoPhenotypeResponse.json | 65 + .../SuccessfulPatientTimelineRequest.json | 23 + .../SuccessfulPatientTimelineResponse.json | 24 + .../SuccessfulRadiologyInsightsRequest.json | 121 + .../SuccessfulRadiologyInsightsResponse.json | 33451 ++++++++++++++++ .../SuccessfulTrialMatcherRequest.json | 2996 ++ .../SuccessfulTrialMatcherResponse.json | 113 + .../HealthInsights.OpenAPI/main.tsp | 8 +- .../HealthInsights.OpenAPI/service.tsp | 12 +- .../HealthInsights.OpenAPI/tspconfig.yaml | 19 +- .../HealthInsights.PatientTimeline/client.tsp | 88 + .../model.patienttimeline.tsp | 71 + .../route.patienttimeline.tsp | 35 + .../tspconfig.yaml | 51 + .../client.tsp | 88 + .../model.radiologyinsights.tsp | 311 + .../model.radiologyinsights.valuesets.tsp | 177 + .../route.radiologyinsights.tsp | 36 + .../tspconfig.yaml | 52 + .../HealthInsights.TrialMatcher/client.tsp | 70 +- .../model.trialmatcher.tsp | 131 +- .../route.trialmatcher.tsp | 15 +- .../tspconfig.yaml | 52 +- specification/ai/HealthInsights/service.tsp | 24 - specification/ai/ImageAnalysis/client.tsp | 6 +- .../AnalyzeFromImageData_MaximumSet.json} | 4 +- specification/ai/ImageAnalysis/main.tsp | 1 - specification/ai/ImageAnalysis/models.tsp | 23 +- specification/ai/ImageAnalysis/routes.tsp | 2 +- specification/ai/ImageAnalysis/tspconfig.yaml | 4 +- specification/ai/OpenAI.Assistants/.gitignore | 3 + specification/ai/OpenAI.Assistants/README.md | 5 + .../ai/OpenAI.Assistants/assistants/main.tsp | 2 + .../OpenAI.Assistants/assistants/models.tsp | 146 + .../OpenAI.Assistants/assistants/routes.tsp | 154 + specification/ai/OpenAI.Assistants/client.tsp | 189 + .../ai/OpenAI.Assistants/common/models.tsp | 90 + .../2024-02-15-preview/create_assistant.json | 4 + .../ai/OpenAI.Assistants/files/main.tsp | 2 + .../ai/OpenAI.Assistants/files/models.tsp | 66 + .../ai/OpenAI.Assistants/files/routes.tsp | 83 + specification/ai/OpenAI.Assistants/main.tsp | 46 + .../ai/OpenAI.Assistants/messages/main.tsp | 2 + .../ai/OpenAI.Assistants/messages/models.tsp | 217 + .../ai/OpenAI.Assistants/messages/routes.tsp | 132 + .../ai/OpenAI.Assistants/run_steps/main.tsp | 2 + .../ai/OpenAI.Assistants/run_steps/models.tsp | 161 + .../ai/OpenAI.Assistants/run_steps/routes.tsp | 51 + .../ai/OpenAI.Assistants/runs/main.tsp | 2 + .../ai/OpenAI.Assistants/runs/models.tsp | 217 + .../ai/OpenAI.Assistants/runs/routes.tsp | 134 + .../ai/OpenAI.Assistants/threads/main.tsp | 2 + .../ai/OpenAI.Assistants/threads/models.tsp | 43 + .../ai/OpenAI.Assistants/threads/routes.tsp | 71 + .../ai/OpenAI.Assistants/tools/models.tsp | 232 + .../ai/OpenAI.Assistants/tspconfig.yaml | 44 + .../DocumentIntelligence.json | 42 +- .../SuccessfulOncoPhenotypeRequest.json | 64 + .../SuccessfulOncoPhenotypeResponse.json | 65 + .../SuccessfulPatientTimelineRequest.json | 23 + .../SuccessfulPatientTimelineResponse.json | 24 + .../SuccessfulRadiologyInsightsRequest.json | 121 + .../SuccessfulRadiologyInsightsResponse.json | 33451 ++++++++++++++++ .../SuccessfulTrialMatcherRequest.json | 2996 ++ .../SuccessfulTrialMatcherResponse.json | 113 + .../preview/2023-09-01-preview/openapi.json | 4898 +++ .../ai/data-plane/HealthInsights/readme.md | 20 +- .../AnalyzeFromImageData_MaximumSet.json} | 4 +- .../stable/2023-10-01/generated.json | 6 +- .../assistants_generated.json | 3452 ++ .../assistants_generated.json | 3562 ++ .../2023-11-06-beta/assistants_generated.json | 3452 ++ .../examples/create_assistant.json | 4 + .../assistants_generated.yaml | 2388 ++ .../2023-11-06-beta/assistants_generated.yaml | 2388 ++ .../assistants_generated.yaml | 2477 ++ specification/ai/readme.md | 1 - .../apicenter/ApiCenter.Management/Api.tsp | 41 + .../ApiCenter.Management/ApiDefinition.tsp | 59 + .../ApiCenter.Management/ApiVersion.tsp | 41 + .../ApiCenter.Management/Deployment.tsp | 41 + .../ApiCenter.Management/Environment.tsp | 41 + .../ApiCenter.Management/MetadataSchema.tsp | 44 + .../ApiCenter.Management/Service.tsp | 46 + .../ApiCenter.Management/Workspace.tsp | 41 + .../ApiDefinitions_CreateOrUpdate.json | 60 + .../2024-03-01/ApiDefinitions_Delete.json | 18 + .../ApiDefinitions_ExportSpecification.json | 27 + .../2024-03-01/ApiDefinitions_Get.json | 35 + .../2024-03-01/ApiDefinitions_Head.json | 21 + .../ApiDefinitions_ImportSpecification.json | 30 + .../2024-03-01/ApiDefinitions_List.json | 38 + .../ApiVersions_CreateOrUpdate.json | 51 + .../2024-03-01/ApiVersions_Delete.json | 17 + .../examples/2024-03-01/ApiVersions_Get.json | 30 + .../examples/2024-03-01/ApiVersions_Head.json | 20 + .../examples/2024-03-01/ApiVersions_List.json | 33 + .../2024-03-01/Apis_CreateOrUpdate.json | 101 + .../examples/2024-03-01/Apis_Delete.json | 16 + .../examples/2024-03-01/Apis_Get.json | 46 + .../examples/2024-03-01/Apis_Head.json | 19 + .../examples/2024-03-01/Apis_List.json | 49 + .../Deployments_CreateOrUpdate.json | 75 + .../2024-03-01/Deployments_Delete.json | 17 + .../examples/2024-03-01/Deployments_Get.json | 38 + .../examples/2024-03-01/Deployments_Head.json | 20 + .../examples/2024-03-01/Deployments_List.json | 41 + .../Environments_CreateOrUpdate.json | 89 + .../2024-03-01/Environments_Delete.json | 16 + .../examples/2024-03-01/Environments_Get.json | 37 + .../2024-03-01/Environments_Head.json | 19 + .../2024-03-01/Environments_List.json | 41 + .../MetadataSchemas_CreateOrUpdate.json | 65 + .../2024-03-01/MetadataSchemas_Delete.json | 15 + .../2024-03-01/MetadataSchemas_Get.json | 33 + .../2024-03-01/MetadataSchemas_Head.json | 18 + .../2024-03-01/MetadataSchemas_List.json | 36 + .../examples/2024-03-01/Operations_List.json | 25 + .../2024-03-01/Services_CreateOrUpdate.json | 69 + .../examples/2024-03-01/Services_Delete.json | 14 + .../Services_ExportMetadataSchema.json | 27 + .../examples/2024-03-01/Services_Get.json | 35 + .../Services_ListByResourceGroup.json | 38 + .../Services_ListBySubscription.json | 38 + .../examples/2024-03-01/Services_Update.json | 44 + .../2024-03-01/Workspaces_CreateOrUpdate.json | 46 + .../2024-03-01/Workspaces_Delete.json | 15 + .../examples/2024-03-01/Workspaces_Get.json | 27 + .../examples/2024-03-01/Workspaces_Head.json | 18 + .../examples/2024-03-01/Workspaces_List.json | 30 + .../apicenter/ApiCenter.Management/main.tsp | 211 + .../apicenter/ApiCenter.Management/models.tsp | 537 + .../ApiCenter.Management/tspconfig.yaml | 12 + .../stable/2024-03-01/apicenter.json | 4695 ++- .../ApiDefinitions_CreateOrUpdate.json | 2 + .../examples/ApiDefinitions_Delete.json | 2 + .../ApiDefinitions_ExportSpecification.json | 2 + .../examples/ApiDefinitions_Get.json | 2 + .../examples/ApiDefinitions_Head.json | 2 + .../ApiDefinitions_ImportSpecification.json | 2 + .../examples/ApiDefinitions_List.json | 2 + .../examples/ApiVersions_CreateOrUpdate.json | 2 + .../examples/ApiVersions_Delete.json | 2 + .../2024-03-01/examples/ApiVersions_Get.json | 2 + .../2024-03-01/examples/ApiVersions_Head.json | 2 + .../2024-03-01/examples/ApiVersions_List.json | 2 + .../examples/Apis_CreateOrUpdate.json | 2 + .../2024-03-01/examples/Apis_Delete.json | 2 + .../stable/2024-03-01/examples/Apis_Get.json | 2 + .../stable/2024-03-01/examples/Apis_Head.json | 2 + .../stable/2024-03-01/examples/Apis_List.json | 2 + .../examples/Deployments_CreateOrUpdate.json | 2 + .../examples/Deployments_Delete.json | 2 + .../2024-03-01/examples/Deployments_Get.json | 2 + .../2024-03-01/examples/Deployments_Head.json | 2 + .../2024-03-01/examples/Deployments_List.json | 2 + .../examples/Environments_CreateOrUpdate.json | 2 + .../examples/Environments_Delete.json | 2 + .../2024-03-01/examples/Environments_Get.json | 2 + .../examples/Environments_Head.json | 2 + .../examples/Environments_List.json | 2 + .../MetadataSchemas_CreateOrUpdate.json | 2 + .../examples/MetadataSchemas_Delete.json | 2 + .../examples/MetadataSchemas_Get.json | 2 + .../examples/MetadataSchemas_Head.json | 2 + .../examples/MetadataSchemas_List.json | 2 + .../2024-03-01/examples/Operations_List.json | 2 + .../examples/Services_CreateOrUpdate.json | 15 +- .../2024-03-01/examples/Services_Delete.json | 2 + .../Services_ExportMetadataSchema.json | 2 + .../2024-03-01/examples/Services_Get.json | 2 + .../Services_ListByResourceGroup.json | 2 + .../examples/Services_ListBySubscription.json | 2 + .../2024-03-01/examples/Services_Update.json | 13 +- .../examples/Workspaces_CreateOrUpdate.json | 2 + .../examples/Workspaces_Delete.json | 2 + .../2024-03-01/examples/Workspaces_Get.json | 2 + .../2024-03-01/examples/Workspaces_Head.json | 2 + .../2024-03-01/examples/Workspaces_List.json | 2 + .../apicenter/resource-manager/readme.java.md | 1 + .../apicenter/resource-manager/readme.md | 4 + .../2024-01-01-preview/appplatform.json | 15466 +++++++ ...ApiPortalCustomDomains_CreateOrUpdate.json | 53 + .../ApiPortalCustomDomains_Delete.json | 20 + .../examples/ApiPortalCustomDomains_Get.json | 30 + .../examples/ApiPortalCustomDomains_List.json | 33 + .../examples/ApiPortals_CreateOrUpdate.json | 110 + .../examples/ApiPortals_Delete.json | 19 + .../examples/ApiPortals_Get.json | 54 + .../examples/ApiPortals_List.json | 57 + .../examples/ApiPortals_ValidateDomain.json | 20 + .../examples/Apms_CreateOrUpdate.json | 67 + .../examples/Apms_Delete.json | 18 + .../2024-01-01-preview/examples/Apms_Get.json | 33 + .../examples/Apms_List.json | 57 + .../examples/Apms_ListSecretKeys.json | 18 + ...pplicationAccelerators_CreateOrUpdate.json | 82 + .../ApplicationAccelerators_Delete.json | 18 + .../examples/ApplicationAccelerators_Get.json | 50 + .../ApplicationAccelerators_List.json | 54 + .../examples/ApplicationLiveView_Delete.json | 18 + .../ApplicationLiveViews_CreateOrUpdate.json | 110 + .../examples/ApplicationLiveViews_Get.json | 59 + .../examples/ApplicationLiveViews_List.json | 62 + .../examples/Apps_CreateOrUpdate.json | 304 + .../Apps_CreateOrUpdate_VNetInjection.json | 311 + .../examples/Apps_Delete.json | 19 + .../2024-01-01-preview/examples/Apps_Get.json | 86 + .../examples/Apps_GetResourceUploadUrl.json | 17 + .../examples/Apps_Get_VNetInjection.json | 90 + .../examples/Apps_List.json | 89 + .../examples/Apps_List_VNetInjection.json | 93 + .../examples/Apps_SetActiveDeployments.json | 140 + .../examples/Apps_Update.json | 178 + .../examples/Apps_Update_VNetInjection.json | 189 + .../examples/Apps_ValidateDomain.json | 20 + .../examples/Bindings_CreateOrUpdate.json | 106 + .../examples/Bindings_Delete.json | 20 + .../examples/Bindings_Get.json | 39 + .../examples/Bindings_List.json | 42 + .../examples/Bindings_Update.json | 82 + .../examples/BuildServiceAgentPool_Get.json | 35 + .../examples/BuildServiceAgentPool_List.json | 39 + .../BuildServiceAgentPool_UpdatePut.json | 65 + .../BuildServiceBuilder_CreateOrUpdate.json | 104 + .../examples/BuildServiceBuilder_Delete.json | 20 + .../examples/BuildServiceBuilder_Get.json | 45 + .../examples/BuildServiceBuilder_List.json | 49 + .../BuildServiceBuilder_ListDeployments.json | 20 + .../examples/BuildService_CreateOrUpdate.json | 64 + .../BuildService_CreateOrUpdateBuild.json | 101 + .../examples/BuildService_DeleteBuild.json | 19 + .../examples/BuildService_GetBuild.json | 53 + .../examples/BuildService_GetBuildResult.json | 75 + .../BuildService_GetBuildResultLog.json | 18 + .../BuildService_GetBuildService.json | 34 + .../BuildService_GetResourceUploadUrl.json | 17 + .../BuildService_GetSupportedBuildpack.json | 31 + .../BuildService_GetSupportedStack.json | 31 + .../BuildService_ListBuildResults.json | 79 + .../BuildService_ListBuildServices.json | 38 + .../examples/BuildService_ListBuilds.json | 57 + .../BuildService_ListSupportedBuildpacks.json | 34 + .../BuildService_ListSupportedStacks.json | 35 + .../BuildpackBinding_CreateOrUpdate.json | 84 + .../examples/BuildpackBinding_Delete.json | 21 + .../examples/BuildpackBinding_Get.json | 41 + .../examples/BuildpackBinding_List.json | 44 + .../BuildpackBinding_ListForCluster.json | 66 + .../examples/Certificates_CreateOrUpdate.json | 106 + .../examples/Certificates_Delete.json | 19 + .../examples/Certificates_Get.json | 46 + .../examples/Certificates_List.json | 50 + .../examples/ConfigServers_Get.json | 37 + .../ConfigServers_Get_Consumption.json | 38 + .../examples/ConfigServers_UpdatePatch.json | 81 + ...ConfigServers_UpdatePatch_Consumption.json | 84 + .../examples/ConfigServers_UpdatePut.json | 77 + .../ConfigServers_UpdatePut_Consumption.json | 80 + .../examples/ConfigServers_Validate.json | 31 + .../ConfigurationServices_CreateOrUpdate.json | 126 + .../ConfigurationServices_Delete.json | 19 + .../examples/ConfigurationServices_Get.json | 60 + .../examples/ConfigurationServices_List.json | 63 + .../ConfigurationServices_Validate.json | 43 + ...onfigurationServices_ValidateResource.json | 42 + .../ContainerRegistries_CreateOrUpdate.json | 67 + .../examples/ContainerRegistries_Delete.json | 18 + .../examples/ContainerRegistries_Get.json | 34 + .../examples/ContainerRegistries_List.json | 38 + .../ContainerRegistries_Validate.json | 31 + .../CustomDomains_CreateOrUpdate.json | 78 + .../examples/CustomDomains_Delete.json | 20 + .../examples/CustomDomains_Get.json | 33 + .../examples/CustomDomains_List.json | 37 + .../examples/CustomDomains_Update.json | 62 + ...CustomizedAccelerators_CreateOrUpdate.json | 121 + .../CustomizedAccelerators_Delete.json | 19 + .../examples/CustomizedAccelerators_Get.json | 52 + .../examples/CustomizedAccelerators_List.json | 55 + .../CustomizedAccelerators_Validate.json | 46 + .../examples/Deployments_CreateOrUpdate.json | 304 + ...yments_CreateOrUpdate_CustomContainer.json | 323 + .../examples/Deployments_Delete.json | 20 + .../Deployments_DisableRemoteDebugging.json | 27 + .../Deployments_EnableRemoteDebugging.json | 32 + .../Deployments_GenerateHeapDump.json | 23 + .../Deployments_GenerateThreadDump.json | 23 + .../examples/Deployments_Get.json | 65 + .../examples/Deployments_GetLogFileUrl.json | 18 + .../Deployments_GetRemoteDebuggingConfig.json | 18 + .../Deployments_Get_CustomContainer.json | 78 + .../examples/Deployments_List.json | 68 + .../examples/Deployments_ListForCluster.json | 67 + .../examples/Deployments_Restart.json | 18 + .../examples/Deployments_Start.json | 18 + .../examples/Deployments_StartJFR.json | 24 + .../examples/Deployments_Stop.json | 18 + .../examples/Deployments_Update.json | 133 + .../Deployments_Update_CustomContainer.json | 155 + .../examples/DevToolPortal_Delete.json | 18 + .../DevToolPortals_CreateOrUpdate.json | 138 + .../examples/DevToolPortals_Get.json | 64 + .../examples/DevToolPortals_List.json | 67 + .../EurekaServers_Get_Consumption.json | 29 + .../EurekaServers_List_Consumption.json | 33 + ...EurekaServers_UpdatePatch_Consumption.json | 57 + .../EurekaServers_UpdatePut_Consumption.json | 53 + .../GatewayCustomDomains_CreateOrUpdate.json | 53 + .../examples/GatewayCustomDomains_Delete.json | 20 + .../examples/GatewayCustomDomains_Get.json | 30 + .../examples/GatewayCustomDomains_List.json | 33 + .../GatewayRouteConfigs_CreateOrUpdate.json | 105 + .../examples/GatewayRouteConfigs_Delete.json | 20 + .../examples/GatewayRouteConfigs_Get.json | 48 + .../examples/GatewayRouteConfigs_List.json | 51 + .../examples/Gateway_Scale.json | 80 + .../examples/Gateways_CreateOrUpdate.json | 167 + .../examples/Gateways_Delete.json | 19 + .../examples/Gateways_Get.json | 72 + .../examples/Gateways_List.json | 75 + .../examples/Gateways_ListEnvSecrets.json | 16 + .../examples/Gateways_Restart.json | 17 + .../examples/Gateways_ValidateDomain.json | 20 + .../examples/MonitoringSettings_Get.json | 34 + .../MonitoringSettings_UpdatePatch.json | 69 + .../MonitoringSettings_UpdatePut.json | 65 + .../examples/Operations_List.json | 28 + .../PredefinedAccelerators_Disable.json | 19 + .../PredefinedAccelerators_Enable.json | 19 + .../examples/PredefinedAccelerators_Get.json | 43 + .../examples/PredefinedAccelerators_List.json | 46 + .../RuntimeVersions_ListRuntimeVersions.json | 38 + .../ServiceRegistries_CreateOrUpdate.json | 77 + .../examples/ServiceRegistries_Delete.json | 19 + .../examples/ServiceRegistries_Get.json | 44 + .../examples/ServiceRegistries_List.json | 47 + .../Services_CheckNameAvailability.json | 20 + .../examples/Services_CreateOrUpdate.json | 234 + .../Services_CreateOrUpdate_Consumption.json | 110 + .../Services_CreateOrUpdate_Enterprise.json | 237 + ...Services_CreateOrUpdate_VNetInjection.json | 252 + .../examples/Services_Delete.json | 17 + .../examples/Services_DisableApmGlobally.json | 20 + .../Services_DisableTestEndpoint.json | 11 + .../examples/Services_EnableApmGlobally.json | 20 + .../examples/Services_EnableTestEndpoint.json | 19 + .../Services_FlushVnetDnsSetting.json | 16 + .../examples/Services_Get.json | 77 + .../examples/Services_Get_Consumption.json | 39 + .../examples/Services_List.json | 107 + .../examples/Services_ListBySubscription.json | 106 + .../Services_ListGloballyEnabledApms.json | 17 + .../Services_ListSupportedApmTypes.json | 31 + .../Services_ListSupportedServerVersions.json | 26 + .../examples/Services_ListTestKeys.json | 19 + .../examples/Services_RegenerateTestKey.json | 22 + .../examples/Services_Start.json | 18 + .../examples/Services_Stop.json | 18 + .../examples/Services_Update.json | 156 + .../examples/Skus_List.json | 36 + .../examples/Storages_CreateOrUpdate.json | 75 + .../examples/Storages_Delete.json | 19 + .../examples/Storages_Get.json | 30 + .../examples/Storages_List.json | 34 + .../appplatform/resource-manager/readme.go.md | 10 + .../appplatform/resource-manager/readme.md | 12 +- .../resource-manager/readme.python.md | 24 + .../package/createOrUpdatePackage.json | 11 +- .../examples/package/getPackage.json | 10 +- .../listPackagesByRuntimeEnvironment.json | 10 +- .../examples/package/updatePackage.json | 7 +- .../createRuntimeEnvironment.json | 10 +- .../getRuntimeEnvironment.json | 4 +- ...untimeEnvironmentsByAutomationAccount.json | 16 +- .../updateRuntimeEnvironment.json | 6 +- .../preview/2023-05-15-preview/package.json | 2 +- .../2023-10-11-preview/azuredatatransfer.json | 2361 ++ .../examples/approveOrRejectConnection.json | 31 + .../examples/createOrUpdateConnection.json | 42 + .../examples/createOrUpdateFlow.json | 36 + .../examples/createOrUpdatePipeline.json | 30 + .../examples/deleteConnection.json | 16 + .../examples/deleteFlow.json | 17 + .../examples/deletePipeline.json | 16 + .../examples/enableOrDisableFlow.json | 23 + .../examples/getConnection.json | 17 + .../2023-10-11-preview/examples/getFlow.json | 18 + .../examples/getPipeline.json | 17 + .../examples/linkConnection.json | 25 + .../2023-10-11-preview/examples/linkFlow.json | 26 + .../listConnectionsByResourceGroup.json | 37 + .../listConnectionsBySubscription.json | 36 + .../examples/listFlowsByConnection.json | 44 + .../examples/listOperations.json | 43 + .../examples/listPendingConnections.json | 34 + .../examples/listPendingFlows.json | 34 + .../listPipelinesByResourceGroup.json | 33 + .../examples/listPipelinesBySubscription.json | 32 + .../examples/listSchemas.json | 24 + .../examples/patchConnection.json | 47 + .../examples/patchFlow.json | 54 + .../examples/patchPipeline.json | 43 + .../examples/postListApprovedSchemas.json | 21 + .../examples/postValidateSchema.json | 16 + .../resource-manager/readme.az.md | 28 + .../resource-manager/readme.cli.md | 1 + .../resource-manager/readme.csharp.md | 15 + .../resource-manager/readme.go.md | 11 + .../resource-manager/readme.md | 79 + .../resource-manager/readme.python.md | 18 + .../resource-manager/readme.typescript.md | 14 + .../AzureLargeInstance.Management/models.tsp | 182 +- .../azurelargeinstance.json | 18 +- .../resource-manager/readme.java.md | 9 + .../resource-manager/readme.md | 5 + .../resource-manager/readme.python.md | 1 + .../resource-manager/readme.typescript.md | 24 +- .../extensions_chat_completions.json | 6 +- .../extensions_chat_completions.json | 6 +- ...extensions_chat_completions_aml_index.json | 4 - ...hat_completions_azure_search_advanced.json | 6 +- ...completions_azure_search_image_vector.json | 6 +- ...chat_completions_azure_search_minimum.json | 6 +- ...extensions_chat_completions_cosmos_db.json | 7 +- ...nsions_chat_completions_elasticsearch.json | 6 +- .../extensions_chat_completions_pinecone.json | 6 +- .../models/audio/audio_transcription.tsp | 8 +- .../models/audio/audio_translation.tsp | 8 +- .../completions/azure_content_filtering.tsp | 16 +- .../models/completions/chat_completions.tsp | 41 +- .../models/completions/chat_messages.tsp | 12 +- .../models/completions/common.tsp | 6 +- .../models/completions/completions_create.tsp | 41 +- .../extensions/oyd/authentication.tsp | 32 + .../oyd/azure_cognitive_search_options.tsp | 2 +- .../extensions/oyd/azure_cosmosdb_options.tsp | 26 +- .../azure_machinelearning_index_options.tsp | 2 +- .../extensions/oyd/elasticsearch_options.tsp | 2 +- .../extensions/oyd/pinecone_options.tsp | 17 +- .../models/completions/tools.tsp | 7 + .../models/embeddings_create.tsp | 6 +- .../OpenAI.Inference/models/images/images.tsp | 8 +- .../2023-10-01-preview/azureopenai.json | 18 + .../2024-02-15-preview/azureopenai.json | 1605 + .../2024-02-15-preview/azureopenai.yaml | 1073 + .../examples/cancel_finetuning_job.json | 25 + .../examples/cancel_finetuning_job.yaml | 23 + .../examples/delete_file.json | 13 + .../examples/delete_file.yaml | 9 + .../examples/delete_finetuning_job.json | 13 + .../examples/delete_finetuning_job.yaml | 9 + .../2024-02-15-preview/examples/get_file.json | 22 + .../2024-02-15-preview/examples/get_file.yaml | 17 + .../examples/get_file_content.json | 14 + .../examples/get_file_content.yaml | 9 + .../examples/get_files.json | 35 + .../examples/get_files.yaml | 27 + .../examples/get_finetuning_job.json | 30 + .../examples/get_finetuning_job.yaml | 25 + .../examples/get_finetuning_job_events.json | 43 + .../examples/get_finetuning_job_events.yaml | 33 + .../examples/get_finetuning_jobs.json | 35 + .../examples/get_finetuning_jobs.yaml | 27 + .../examples/get_model_base.json | 31 + .../examples/get_model_base.yaml | 25 + .../examples/get_model_finetune.json | 32 + .../examples/get_model_finetune.yaml | 24 + .../examples/get_models.json | 54 + .../examples/get_models.yaml | 41 + .../examples/import_file.json | 28 + .../examples/import_file.yaml | 48 + .../examples/post_finetuning_job.json | 30 + .../examples/post_finetuning_job.yaml | 30 + .../examples/upload_file.json | 25 + .../examples/upload_file.yaml | 21 + .../AzureOpenAI/authoring/readme.md | 22 +- .../preview/2023-06-01-preview/generated.json | 94 +- .../preview/2023-07-01-preview/generated.json | 94 +- .../examples/extensions_chat_completions.json | 6 +- .../preview/2023-08-01-preview/generated.json | 142 +- .../examples/extensions_chat_completions.json | 6 +- .../preview/2023-09-01-preview/generated.json | 142 +- ...extensions_chat_completions_aml_index.json | 4 - ...hat_completions_azure_search_advanced.json | 6 +- ...completions_azure_search_image_vector.json | 6 +- ...chat_completions_azure_search_minimum.json | 6 +- ...extensions_chat_completions_cosmos_db.json | 7 +- ...nsions_chat_completions_elasticsearch.json | 6 +- .../extensions_chat_completions_pinecone.json | 6 +- .../preview/2023-12-01-preview/generated.json | 339 +- .../examples/audio_speech.json | 18 + .../examples/audio_speech.yaml | 12 + .../examples/audio_transcription_object.json | 15 + .../examples/audio_transcription_object.yaml | 9 + .../examples/audio_transcription_text.json | 15 + .../examples/audio_transcription_text.yaml | 19 + .../examples/audio_translation_object.json | 16 + .../examples/audio_translation_object.yaml | 20 + .../examples/audio_translation_text.json | 15 + .../examples/audio_translation_text.yaml | 20 + .../examples/cancel_run.json | 37 + .../examples/cancel_run.yaml | 29 + .../examples/chat_completions.json | 43 + .../examples/chat_completions.yaml | 45 + .../examples/chat_completions_aml_index.json | 67 + .../examples/chat_completions_aml_index.yaml | 42 + ...hat_completions_azure_search_advanced.json | 96 + ...hat_completions_azure_search_advanced.yaml | 63 + ...completions_azure_search_image_vector.json | 58 + ...completions_azure_search_image_vector.yaml | 36 + ...chat_completions_azure_search_minimum.json | 63 + ...chat_completions_azure_search_minimum.yaml | 39 + .../examples/chat_completions_cosmos_db.json | 77 + .../examples/chat_completions_cosmos_db.yaml | 49 + .../chat_completions_elasticsearch.json | 65 + .../chat_completions_elasticsearch.yaml | 41 + .../examples/chat_completions_pinecone.json | 77 + .../examples/chat_completions_pinecone.yaml | 51 + .../examples/completions.json | 38 + .../examples/create_assistant.json | 42 + .../examples/create_assistant.yaml | 27 + .../examples/create_assistant_file.json | 21 + .../examples/create_assistant_file.yaml | 14 + .../examples/create_message.json | 36 + .../examples/create_message.yaml | 36 + .../examples/create_run.json | 34 + .../examples/create_run.yaml | 27 + .../examples/create_thread.json | 17 + .../examples/create_thread.yaml | 11 + .../examples/create_thread_and_run.json | 33 + .../examples/create_thread_and_run.yaml | 26 + .../examples/delete_assistant.json | 17 + .../examples/delete_assistant.yaml | 11 + .../examples/delete_assistant_file.json | 18 + .../examples/delete_assistant_file.yaml | 12 + .../examples/delete_thread.json | 17 + .../examples/delete_thread.yaml | 11 + .../examples/embeddings.json | 1566 + .../examples/embeddings.yaml | 1553 + .../examples/get_assistant_file.json | 19 + .../examples/get_assistant_file.yaml | 13 + .../examples/get_message.json | 33 + .../examples/get_message.yaml | 23 + .../examples/get_message_file.json | 20 + .../examples/get_message_file.yaml | 14 + .../2024-02-15-preview/examples/get_run.json | 32 + .../2024-02-15-preview/examples/get_run.yaml | 26 + .../examples/get_run_step.json | 40 + .../examples/get_run_step.yaml | 31 + .../examples/image_generation.json | 67 + .../examples/image_generation.yaml | 46 + .../examples/list_assistant_files.json | 26 + .../examples/list_assistant_files.yaml | 17 + .../examples/list_assistants.json | 55 + .../examples/list_assistants.yaml | 37 + .../examples/list_message_files.json | 33 + .../examples/list_message_files.yaml | 22 + .../examples/list_messages.json | 60 + .../examples/list_messages.yaml | 41 + .../examples/list_run_steps.json | 47 + .../examples/list_run_steps.yaml | 35 + .../examples/list_runs.json | 39 + .../examples/list_runs.yaml | 30 + .../examples/modify_assistant.json | 33 + .../examples/modify_assistant.yaml | 22 + .../examples/modify_message.json | 42 + .../examples/modify_message.yaml | 29 + .../examples/modify_run.json | 41 + .../examples/modify_run.yaml | 32 + .../examples/modify_thread.json | 27 + .../examples/modify_thread.yaml | 18 + .../examples/retrieve_assistant.json | 30 + .../examples/retrieve_assistant.yaml | 20 + .../examples/retrieve_thread.json | 18 + .../examples/retrieve_thread.yaml | 18 + .../examples/submit_tool_outputs_to_run.json | 68 + .../examples/submit_tool_outputs_to_run.yaml | 49 + .../preview/2024-02-15-preview/inference.json | 7760 ++++ .../preview/2024-02-15-preview/inference.yaml | 5293 +++ .../2023-10-15-preview/contentsafety.json | 84 +- .../stable/2023-10-01/contentsafety.json | 84 +- .../2023-11-15-preview/analyzetext.json | 71 +- .../2023-12-01-preview/texttospeech.json | 25 +- .../2023-10-01-preview/cognitiveservices.json | 9 +- .../examples/GetRaiPolicy.json | 8 +- .../examples/ListRaiPolicies.json | 8 +- .../examples/PutRaiPolicy.json | 24 +- .../resource-management/v4/types.json | 1 - .../resource-management/v5/types.json | 1 - .../resource-management/v6/privatelinks.json | 202 + .../Communication.JobRouter/tspconfig.yaml | 1 - .../communicationservicessms.json | 219 + .../2024-02-05-preview/examples/send.json | 85 + .../communication/data-plane/Sms/readme.md | 13 +- .../Community.Management/main.tsp | 13 +- .../stable/2023-11-01/CommunityTrainings.json | 12 +- .../stable/2023-07-03/communityGallery.json | 615 + .../CommunityGalleryImageVersion_Get.json | 37 + .../CommunityGalleryImageVersion_List.json | 40 + .../CommunityGalleryImage_Get.json | 37 + .../CommunityGalleryImage_List.json | 38 + .../CommunityGallery_Get.json | 35 + .../CommunityGallery_Create.json | 94 + .../galleryExamples/CommunityGallery_Get.json | 46 + .../GalleryApplicationVersion_Create.json | 231 + .../GalleryApplicationVersion_Delete.json | 30 + .../GalleryApplicationVersion_Get.json | 65 + ...tionVersion_Get_WithReplicationStatus.json | 84 + ...ationVersion_ListByGalleryApplication.json | 69 + .../GalleryApplicationVersion_Update.json | 76 + .../GalleryApplication_Create.json | 130 + .../GalleryApplication_Delete.json | 29 + .../GalleryApplication_Get.json | 41 + .../GalleryApplication_ListByGallery.json | 45 + .../GalleryApplication_Update.json | 67 + .../GalleryImageVersion_Create.json | 325 + ...ate_WithCommunityImageVersionAsSource.json | 325 + ...rsion_Create_WithImageVersionAsSource.json | 325 + ...ion_Create_WithShallowReplicationMode.json | 185 + ...eVersion_Create_WithSnapshotsAsSource.json | 314 + ...on_Create_WithTargetExtendedLocations.json | 367 + .../GalleryImageVersion_Create_WithVHD.json | 272 + ...geVersion_Create_WithVHD_UefiSettings.json | 404 + ...eryImageVersion_Create_WithVmAsSource.json | 325 + .../GalleryImageVersion_Delete.json | 30 + .../GalleryImageVersion_Get.json | 82 + ...mageVersion_Get_WithReplicationStatus.json | 100 + ...mageVersion_Get_WithSnapshotsAsSource.json | 81 + ...lleryImageVersion_Get_WithVhdAsSource.json | 81 + ...alleryImageVersion_ListByGalleryImage.json | 86 + .../GalleryImageVersion_Update.json | 89 + ...ryImageVersion_Update_WithoutSourceId.json | 85 + .../galleryExamples/GalleryImage_Create.json | 78 + .../galleryExamples/GalleryImage_Delete.json | 29 + .../galleryExamples/GalleryImage_Get.json | 29 + .../GalleryImage_ListByGallery.json | 33 + .../galleryExamples/GalleryImage_Update.json | 40 + .../Gallery_AddToSharingProfile.json | 71 + .../galleryExamples/Gallery_Create.json | 58 + .../Gallery_Create_SoftDeletionEnabled.json | 70 + .../Gallery_Create_WithSharingProfile.json | 70 + .../galleryExamples/Gallery_Delete.json | 28 + .../Gallery_EnableCommunityGallery.json | 26 + .../examples/galleryExamples/Gallery_Get.json | 24 + ...ry_Get_WithExpandSharingProfileGroups.json | 38 + .../Gallery_Get_WithSelectPermissions.json | 38 + .../Gallery_ListByResourceGroup.json | 28 + .../Gallery_ListBySubscription.json | 27 + .../Gallery_ResetSharingProfile.json | 26 + .../galleryExamples/Gallery_Update.json | 28 + .../SharedGalleryImageVersion_Get.json | 35 + .../SharedGalleryImageVersions_List.json | 39 + .../SharedGalleryImage_Get.json | 34 + .../SharedGalleryImages_List.json | 37 + .../SharedGallery_Get.json | 24 + .../SharedGallery_List.json | 28 + .../GalleryRP/stable/2023-07-03/gallery.json | 3286 ++ .../stable/2023-07-03/galleryRPCommon.json | 222 + .../stable/2023-07-03/sharedGallery.json | 660 + .../compute/resource-manager/readme.md | 50 +- .../Fleet.Management/fleet.tsp | 11 +- .../Fleet.Management/fleetmember.tsp | 11 +- .../Fleet.Management/update/run.tsp | 6 +- .../Fleet.Management/update/strategy.tsp | 5 +- .../examples/AgentPoolsAbortOperation.json | 18 + .../examples/AgentPoolsAssociate_CRG.json | 54 + .../AgentPoolsCreate_CustomNodeConfig.json | 124 + .../AgentPoolsCreate_DedicatedHostGroup.json | 54 + .../AgentPoolsCreate_EnableCustomCATrust.json | 54 + ...entPoolsCreate_EnableEncryptionAtHost.json | 54 + .../examples/AgentPoolsCreate_EnableFIPS.json | 54 + .../AgentPoolsCreate_EnableUltraSSD.json | 54 + .../examples/AgentPoolsCreate_Ephemeral.json | 58 + .../examples/AgentPoolsCreate_GPUMIG.json | 127 + .../AgentPoolsCreate_MessageOfTheDay.json | 60 + .../examples/AgentPoolsCreate_OSSKU.json | 127 + .../examples/AgentPoolsCreate_PPG.json | 54 + .../examples/AgentPoolsCreate_Snapshot.json | 63 + .../examples/AgentPoolsCreate_Spot.json | 86 + .../AgentPoolsCreate_TypeVirtualMachines.json | 136 + .../examples/AgentPoolsCreate_Update.json | 87 + .../examples/AgentPoolsCreate_WasmWasi.json | 60 + ...PoolsCreate_WindowsDisableOutboundNAT.json | 63 + .../AgentPoolsCreate_WindowsOSSKU.json | 54 + .../examples/AgentPoolsDelete.json | 17 + .../examples/AgentPoolsDeleteMachines.json | 22 + ...PoolsDelete_IgnorePodDisruptionBudget.json | 18 + .../examples/AgentPoolsGet.json | 30 + ...entPoolsGetAgentPoolAvailableVersions.json | 32 + .../examples/AgentPoolsGetUpgradeProfile.json | 28 + .../examples/AgentPoolsList.json | 30 + .../AgentPoolsUpgradeNodeImageVersion.json | 34 + .../examples/AgentPools_Start.json | 52 + .../examples/AgentPools_Stop.json | 52 + .../examples/AgentPools_Update.json | 75 + .../ContainerServiceGetOSOptions.json | 28 + .../examples/GetGuardrailsVersions.json | 21 + .../examples/GetSafeguardsVersions.json | 21 + .../examples/KubernetesVersions_List.json | 95 + .../examples/ListGuardrailsVersions.json | 24 + .../examples/ListSafeguardsVersions.json | 24 + .../examples/MachineGet.json | 34 + .../examples/MachineList.json | 38 + ...aintenanceConfigurationsCreate_Update.json | 94 + ...ationsCreate_Update_MaintenanceWindow.json | 116 + .../MaintenanceConfigurationsDelete.json | 13 + ...onfigurationsDelete_MaintenanceWindow.json | 13 + .../MaintenanceConfigurationsGet.json | 42 + ...ceConfigurationsGet_MaintenanceWindow.json | 48 + .../MaintenanceConfigurationsList.json | 37 + ...eConfigurationsList_MaintenanceWindow.json | 61 + .../ManagedClusterSnapshotsCreate.json | 96 + .../ManagedClusterSnapshotsDelete.json | 12 + .../examples/ManagedClusterSnapshotsGet.json | 47 + .../examples/ManagedClusterSnapshotsList.json | 49 + ...edClusterSnapshotsListByResourceGroup.json | 50 + .../ManagedClusterSnapshotsUpdateTags.json | 53 + .../ManagedClustersAbortOperation.json | 17 + .../ManagedClustersAssociate_CRG.json | 254 + ...rsCreate_AzureKeyvaultSecretsProvider.json | 259 + ...anagedClustersCreate_AzureServiceMesh.json | 355 + ...agedClustersCreate_DedicatedHostGroup.json | 251 + ...nagedClustersCreate_DisableRunCommand.json | 265 + ...gedClustersCreate_DualStackNetworking.json | 321 + ...stersCreate_EnableAIToolchainOperator.json | 236 + ...gedClustersCreate_EnableCustomCATrust.json | 269 + ...ClustersCreate_EnableEncryptionAtHost.json | 254 + .../ManagedClustersCreate_EnableUltraSSD.json | 254 + .../ManagedClustersCreate_EnabledFIPS.json | 254 + .../ManagedClustersCreate_GPUMIG.json | 281 + .../ManagedClustersCreate_HTTPProxy.json | 278 + ...rsCreate_IngressProfile_WebAppRouting.json | 249 + .../ManagedClustersCreate_MCSnapshot.json | 222 + ...nagedClustersCreate_ManagedNATGateway.json | 231 + ...edClustersCreate_NodeAutoProvisioning.json | 229 + ...agedClustersCreate_NodePublicIPPrefix.json | 254 + .../examples/ManagedClustersCreate_OSSKU.json | 281 + .../examples/ManagedClustersCreate_PPG.json | 254 + .../ManagedClustersCreate_PodIdentity.json | 263 + .../ManagedClustersCreate_Premium.json | 270 + ...ersCreate_PrivateClusterFQDNSubdomain.json | 264 + ...ustersCreate_PrivateClusterPublicFQDN.json | 268 + ...ManagedClustersCreate_SecurityProfile.json | 251 + .../ManagedClustersCreate_Snapshot.json | 263 + .../ManagedClustersCreate_Update.json | 315 + ...nagedClustersCreate_UpdateWindowsGmsa.json | 299 + .../ManagedClustersCreate_UpdateWithAHUB.json | 293 + ...stersCreate_UpdateWithEnableAzureRBAC.json | 282 + ...te_UpdateWithEnableNamespaceResources.json | 269 + ...ClustersCreate_UserAssignedNATGateway.json | 198 + ...ManagedClustersCreate_VirtualMachines.json | 229 + .../examples/ManagedClustersDelete.json | 16 + .../examples/ManagedClustersGet.json | 112 + .../ManagedClustersGetAccessProfile.json | 22 + .../ManagedClustersGetUpgradeProfile.json | 49 + ...anagedClustersGet_MeshRevisionProfile.json | 53 + ...ManagedClustersGet_MeshUpgradeProfile.json | 35 + .../examples/ManagedClustersList.json | 65 + .../ManagedClustersListByResourceGroup.json | 66 + ...edClustersListClusterCredentialResult.json | 20 + ...agedClustersList_MeshRevisionProfiles.json | 56 + ...nagedClustersList_MeshUpgradeProfiles.json | 38 + .../ManagedClustersResetAADProfile.json | 22 + ...dClustersResetServicePrincipalProfile.json | 20 + ...agedClustersRotateClusterCertificates.json | 16 + ...ustersRotateServiceAccountSigningKeys.json | 16 + .../examples/ManagedClustersStart.json | 16 + .../examples/ManagedClustersStop.json | 16 + .../examples/ManagedClustersUpdateTags.json | 68 + .../examples/OperationStatusResultGet.json | 20 + .../OperationStatusResultGetByAgentPool.json | 21 + .../examples/OperationStatusResultList.json | 34 + .../examples/Operation_List.json | 3583 ++ ...boundNetworkDependenciesEndpointsList.json | 242 + .../PrivateEndpointConnectionsDelete.json | 13 + .../PrivateEndpointConnectionsGet.json | 27 + .../PrivateEndpointConnectionsList.json | 30 + .../PrivateEndpointConnectionsUpdate.json | 50 + .../examples/PrivateLinkResourcesList.json | 25 + .../examples/ResolvePrivateLinkServiceId.json | 18 + .../examples/RunCommandRequest.json | 33 + .../examples/RunCommandResultFailed.json | 25 + .../examples/RunCommandResultSucceed.json | 28 + .../examples/SnapshotsCreate.json | 80 + .../examples/SnapshotsDelete.json | 12 + .../examples/SnapshotsGet.json | 39 + .../examples/SnapshotsList.json | 41 + .../SnapshotsListByResourceGroup.json | 42 + .../examples/SnapshotsUpdateTags.json | 45 + ...stedAccessRoleBindings_CreateOrUpdate.json | 48 + .../TrustedAccessRoleBindings_Delete.json | 17 + .../TrustedAccessRoleBindings_Get.json | 25 + .../TrustedAccessRoleBindings_List.json | 28 + .../examples/TrustedAccessRoles_List.json | 34 + .../2023-11-02-preview/managedClusters.json | 9438 +++++ .../2023-11-02-preview/scheduledEvents.json | 136 + .../aks/readme.java.md | 28 + .../Microsoft.ContainerService/aks/readme.md | 24 +- .../aks/readme.python.md | 24 +- .../examples/AgentPoolsAbortOperation.json | 18 + .../examples/AgentPoolsCreate_CRG.json | 54 + .../AgentPoolsCreate_CustomNodeConfig.json | 124 + .../AgentPoolsCreate_DedicatedHostGroup.json | 52 + ...entPoolsCreate_EnableEncryptionAtHost.json | 54 + .../examples/AgentPoolsCreate_EnableFIPS.json | 54 + .../AgentPoolsCreate_EnableUltraSSD.json | 54 + .../examples/AgentPoolsCreate_Ephemeral.json | 58 + .../examples/AgentPoolsCreate_GPUMIG.json | 127 + .../examples/AgentPoolsCreate_OSSKU.json | 127 + .../examples/AgentPoolsCreate_PPG.json | 54 + .../examples/AgentPoolsCreate_Snapshot.json | 63 + .../examples/AgentPoolsCreate_Spot.json | 86 + .../examples/AgentPoolsCreate_Update.json | 88 + .../examples/AgentPoolsCreate_WasmWasi.json | 60 + .../AgentPoolsCreate_WindowsOSSKU.json | 54 + .../2023-11-01/examples/AgentPoolsDelete.json | 17 + .../2023-11-01/examples/AgentPoolsGet.json | 30 + ...entPoolsGetAgentPoolAvailableVersions.json | 32 + .../examples/AgentPoolsGetUpgradeProfile.json | 28 + .../2023-11-01/examples/AgentPoolsList.json | 30 + .../AgentPoolsUpgradeNodeImageVersion.json | 34 + .../2023-11-01/examples/AgentPools_Start.json | 52 + .../2023-11-01/examples/AgentPools_Stop.json | 52 + .../examples/AgentPools_Update.json | 75 + .../ContainerServiceGetOSOptions.json | 28 + .../examples/KubernetesVersions_List.json | 95 + ...aintenanceConfigurationsCreate_Update.json | 94 + ...ationsCreate_Update_MaintenanceWindow.json | 98 + .../MaintenanceConfigurationsDelete.json | 13 + ...onfigurationsDelete_MaintenanceWindow.json | 13 + .../MaintenanceConfigurationsGet.json | 42 + ...ceConfigurationsGet_MaintenanceWindow.json | 40 + .../MaintenanceConfigurationsList.json | 37 + ...eConfigurationsList_MaintenanceWindow.json | 61 + .../ManagedClustersAbortOperation.json | 17 + ...rsCreate_AzureKeyvaultSecretsProvider.json | 259 + ...anagedClustersCreate_AzureServiceMesh.json | 355 + .../examples/ManagedClustersCreate_CRG.json | 254 + ...agedClustersCreate_DedicatedHostGroup.json | 249 + ...nagedClustersCreate_DisableRunCommand.json | 267 + ...gedClustersCreate_DualStackNetworking.json | 323 + ...ClustersCreate_EnableEncryptionAtHost.json | 256 + .../ManagedClustersCreate_EnableUltraSSD.json | 256 + .../ManagedClustersCreate_EnabledFIPS.json | 256 + .../ManagedClustersCreate_GPUMIG.json | 283 + .../ManagedClustersCreate_HTTPProxy.json | 280 + ...nagedClustersCreate_ManagedNATGateway.json | 233 + ...agedClustersCreate_NodePublicIPPrefix.json | 256 + .../examples/ManagedClustersCreate_OSSKU.json | 283 + .../examples/ManagedClustersCreate_PPG.json | 256 + .../ManagedClustersCreate_PodIdentity.json | 265 + .../ManagedClustersCreate_Premium.json | 274 + ...ersCreate_PrivateClusterFQDNSubdomain.json | 266 + ...ustersCreate_PrivateClusterPublicFQDN.json | 270 + ...ManagedClustersCreate_SecurityProfile.json | 262 + .../ManagedClustersCreate_Snapshot.json | 265 + .../ManagedClustersCreate_Update.json | 317 + ...nagedClustersCreate_UpdateWindowsGmsa.json | 301 + .../ManagedClustersCreate_UpdateWithAHUB.json | 295 + ...stersCreate_UpdateWithEnableAzureRBAC.json | 284 + ...ClustersCreate_UserAssignedNATGateway.json | 200 + .../examples/ManagedClustersDelete.json | 16 + .../examples/ManagedClustersGet.json | 113 + .../ManagedClustersGetAccessProfile.json | 22 + .../ManagedClustersGetUpgradeProfile.json | 49 + ...anagedClustersGet_MeshRevisionProfile.json | 53 + ...ManagedClustersGet_MeshUpgradeProfile.json | 35 + .../examples/ManagedClustersList.json | 66 + .../ManagedClustersListByResourceGroup.json | 67 + ...edClustersListClusterAdminCredentials.json | 20 + ...sListClusterMonitoringUserCredentials.json | 20 + ...gedClustersListClusterUserCredentials.json | 20 + ...agedClustersList_MeshRevisionProfiles.json | 56 + ...nagedClustersList_MeshUpgradeProfiles.json | 38 + .../ManagedClustersResetAADProfile.json | 22 + ...dClustersResetServicePrincipalProfile.json | 20 + ...agedClustersRotateClusterCertificates.json | 16 + ...ustersRotateServiceAccountSigningKeys.json | 16 + .../examples/ManagedClustersStart.json | 16 + .../examples/ManagedClustersStop.json | 16 + .../examples/ManagedClustersUpdateTags.json | 68 + .../2023-11-01/examples/Operation_List.json | 3583 ++ ...boundNetworkDependenciesEndpointsList.json | 242 + .../PrivateEndpointConnectionsDelete.json | 13 + .../PrivateEndpointConnectionsGet.json | 27 + .../PrivateEndpointConnectionsList.json | 30 + .../PrivateEndpointConnectionsUpdate.json | 50 + .../examples/PrivateLinkResourcesList.json | 25 + .../examples/ResolvePrivateLinkServiceId.json | 18 + .../examples/RunCommandRequest.json | 33 + .../examples/RunCommandResultFailed.json | 25 + .../examples/RunCommandResultSucceed.json | 28 + .../2023-11-01/examples/SnapshotsCreate.json | 80 + .../2023-11-01/examples/SnapshotsDelete.json | 12 + .../2023-11-01/examples/SnapshotsGet.json | 39 + .../2023-11-01/examples/SnapshotsList.json | 41 + .../SnapshotsListByResourceGroup.json | 42 + .../examples/SnapshotsUpdateTags.json | 45 + ...stedAccessRoleBindings_CreateOrUpdate.json | 48 + .../TrustedAccessRoleBindings_Delete.json | 17 + .../TrustedAccessRoleBindings_Get.json | 25 + .../TrustedAccessRoleBindings_List.json | 28 + .../examples/TrustedAccessRoles_List.json | 34 + .../stable/2023-11-01/managedClusters.json | 7525 ++++ .../preview/2023-03-15-preview/fleets.json | 2 +- .../preview/2023-06-15-preview/fleets.json | 2 +- .../preview/2023-08-15-preview/fleets.json | 4 +- .../fleet/stable/2023-10-15/fleets.json | 4 +- .../ContainerStorage.Management/main.tsp | 73 +- .../2023-07-01-preview/containerstorage.json | 34 +- .../contosowidgetmanager/data-plane/readme.md | 4 +- .../preview/2024-02-15-preview/cosmos-db.json | 12255 ++++++ .../dataTransferService.json | 603 + ...CosmosDBCassandraKeyspaceCreateUpdate.json | 41 + .../CosmosDBCassandraKeyspaceDelete.json | 18 + .../CosmosDBCassandraKeyspaceGet.json | 28 + .../CosmosDBCassandraKeyspaceList.json | 28 + ...DBCassandraKeyspaceMigrateToAutoscale.json | 34 + ...ndraKeyspaceMigrateToManualThroughput.json | 31 + ...osmosDBCassandraKeyspaceThroughputGet.json | 32 + ...osDBCassandraKeyspaceThroughputUpdate.json | 45 + .../CosmosDBCassandraTableCreateUpdate.json | 84 + .../CosmosDBCassandraTableDelete.json | 19 + .../examples/CosmosDBCassandraTableGet.json | 50 + .../examples/CosmosDBCassandraTableList.json | 50 + ...mosDBCassandraTableMigrateToAutoscale.json | 35 + ...ssandraTableMigrateToManualThroughput.json | 32 + .../CosmosDBCassandraTableThroughputGet.json | 33 + ...osmosDBCassandraTableThroughputUpdate.json | 44 + .../CosmosDBCassandraViewCreateUpdate.json | 42 + .../examples/CosmosDBCassandraViewDelete.json | 20 + .../examples/CosmosDBCassandraViewGet.json | 26 + .../examples/CosmosDBCassandraViewList.json | 29 + ...smosDBCassandraViewMigrateToAutoscale.json | 32 + ...assandraViewMigrateToManualThroughput.json | 29 + .../CosmosDBCassandraViewThroughputGet.json | 27 + ...CosmosDBCassandraViewThroughputUpdate.json | 40 + ...osmosDBCollectionGetMetricDefinitions.json | 41 + .../CosmosDBCollectionGetMetrics.json | 55 + .../examples/CosmosDBCollectionGetUsages.json | 29 + ...CosmosDBCollectionPartitionGetMetrics.json | 57 + .../CosmosDBCollectionPartitionGetUsages.json | 31 + ...DBCollectionPartitionRegionGetMetrics.json | 58 + .../CosmosDBDataTransferServiceCreate.json | 45 + .../CosmosDBDataTransferServiceDelete.json | 19 + .../CosmosDBDataTransferServiceGet.json | 32 + ...osmosDBDatabaseAccountCheckNameExists.json | 10 + .../CosmosDBDatabaseAccountCreateMax.json | 248 + .../CosmosDBDatabaseAccountCreateMin.json | 115 + .../CosmosDBDatabaseAccountDelete.json | 17 + ...DatabaseAccountFailoverPriorityChange.json | 29 + .../examples/CosmosDBDatabaseAccountGet.json | 142 + ...DBDatabaseAccountGetMetricDefinitions.json | 39 + .../CosmosDBDatabaseAccountGetMetrics.json | 53 + .../CosmosDBDatabaseAccountGetUsages.json | 27 + .../examples/CosmosDBDatabaseAccountList.json | 137 + ...sDBDatabaseAccountListByResourceGroup.json | 114 + ...BDatabaseAccountListConnectionStrings.json | 22 + ...baseAccountListConnectionStringsMongo.json | 20 + .../CosmosDBDatabaseAccountListKeys.json | 18 + ...smosDBDatabaseAccountListReadOnlyKeys.json | 16 + .../CosmosDBDatabaseAccountOfflineRegion.json | 21 + .../CosmosDBDatabaseAccountOnlineRegion.json | 21 + .../CosmosDBDatabaseAccountPatch.json | 222 + .../CosmosDBDatabaseAccountRegenerateKey.json | 20 + ...smosDBDatabaseAccountRegionGetMetrics.json | 54 + .../CosmosDBDatabaseGetMetricDefinitions.json | 40 + .../examples/CosmosDBDatabaseGetMetrics.json | 54 + .../examples/CosmosDBDatabaseGetUsages.json | 28 + .../CosmosDBGraphAPIComputeServiceCreate.json | 47 + .../CosmosDBGraphAPIComputeServiceDelete.json | 19 + .../CosmosDBGraphAPIComputeServiceGet.json | 34 + .../CosmosDBGraphResourceCreateUpdate.json | 41 + .../examples/CosmosDBGraphResourceDelete.json | 19 + .../examples/CosmosDBGraphResourceGet.json | 25 + .../examples/CosmosDBGraphResourceList.json | 28 + .../CosmosDBGremlinDatabaseCreateUpdate.json | 44 + .../CosmosDBGremlinDatabaseDelete.json | 18 + .../examples/CosmosDBGremlinDatabaseGet.json | 28 + .../examples/CosmosDBGremlinDatabaseList.json | 31 + ...osDBGremlinDatabaseMigrateToAutoscale.json | 34 + ...mlinDatabaseMigrateToManualThroughput.json | 31 + .../CosmosDBGremlinDatabaseThroughputGet.json | 32 + ...smosDBGremlinDatabaseThroughputUpdate.json | 45 + ...CosmosDBGremlinGraphBackupInformation.json | 28 + .../CosmosDBGremlinGraphCreateUpdate.json | 129 + .../examples/CosmosDBGremlinGraphDelete.json | 19 + .../examples/CosmosDBGremlinGraphGet.json | 69 + .../examples/CosmosDBGremlinGraphList.json | 72 + ...osmosDBGremlinGraphMigrateToAutoscale.json | 35 + ...GremlinGraphMigrateToManualThroughput.json | 32 + .../CosmosDBGremlinGraphThroughputGet.json | 33 + .../CosmosDBGremlinGraphThroughputUpdate.json | 46 + .../examples/CosmosDBLocationGet.json | 27 + .../examples/CosmosDBLocationList.json | 46 + .../CosmosDBManagedCassandraBackup.json | 20 + .../CosmosDBManagedCassandraBackupsList.json | 42 + ...CosmosDBManagedCassandraClusterCreate.json | 155 + ...osDBManagedCassandraClusterDeallocate.json | 16 + ...CosmosDBManagedCassandraClusterDelete.json | 17 + .../CosmosDBManagedCassandraClusterGet.json | 73 + ...edCassandraClusterListByResourceGroup.json | 76 + ...gedCassandraClusterListBySubscription.json | 75 + .../CosmosDBManagedCassandraClusterPatch.json | 166 + .../CosmosDBManagedCassandraClusterStart.json | 15 + .../CosmosDBManagedCassandraCommand.json | 25 + .../CosmosDBManagedCassandraCommandAsync.json | 36 + ...CosmosDBManagedCassandraCommandResult.json | 33 + ...osDBManagedCassandraCommandResultList.json | 45 + ...mosDBManagedCassandraDataCenterCreate.json | 57 + ...mosDBManagedCassandraDataCenterDelete.json | 18 + ...CosmosDBManagedCassandraDataCenterGet.json | 36 + ...osmosDBManagedCassandraDataCenterList.json | 39 + ...smosDBManagedCassandraDataCenterPatch.json | 72 + .../CosmosDBManagedCassandraListCommand.json | 27 + .../CosmosDBManagedCassandraStatus.json | 144 + ...MaterializedViewsBuilderServiceCreate.json | 45 + ...MaterializedViewsBuilderServiceDelete.json | 19 + ...sDBMaterializedViewsBuilderServiceGet.json | 32 + ...sDBMongoDBCollectionBackupInformation.json | 28 + ...CosmosDBMongoDBCollectionCreateUpdate.json | 90 + .../CosmosDBMongoDBCollectionDelete.json | 19 + .../CosmosDBMongoDBCollectionGet.json | 46 + .../CosmosDBMongoDBCollectionList.json | 46 + ...DBMongoDBCollectionMigrateToAutoscale.json | 35 + ...DBCollectionMigrateToManualThroughput.json | 32 + ...smosDBMongoDBCollectionPartitionMerge.json | 59 + ...ngoDBCollectionRedistributeThroughput.json | 70 + .../CosmosDBMongoDBCollectionRestore.json | 72 + ...lectionRetrieveThroughputDistribution.json | 50 + ...osmosDBMongoDBCollectionThroughputGet.json | 33 + ...osDBMongoDBCollectionThroughputUpdate.json | 46 + .../CosmosDBMongoDBDatabaseCreateUpdate.json | 41 + .../CosmosDBMongoDBDatabaseDelete.json | 18 + .../examples/CosmosDBMongoDBDatabaseGet.json | 28 + .../examples/CosmosDBMongoDBDatabaseList.json | 28 + ...osDBMongoDBDatabaseMigrateToAutoscale.json | 34 + ...goDBDatabaseMigrateToManualThroughput.json | 31 + ...CosmosDBMongoDBDatabasePartitionMerge.json | 58 + ...MongoDBDatabaseRedistributeThroughput.json | 69 + .../CosmosDBMongoDBDatabaseRestore.json | 47 + ...atabaseRetrieveThroughputDistribution.json | 49 + .../CosmosDBMongoDBDatabaseThroughputGet.json | 32 + ...smosDBMongoDBDatabaseThroughputUpdate.json | 45 + ...osDBMongoDBRoleDefinitionCreateUpdate.json | 71 + .../CosmosDBMongoDBRoleDefinitionDelete.json | 19 + .../CosmosDBMongoDBRoleDefinitionGet.json | 42 + .../CosmosDBMongoDBRoleDefinitionList.json | 44 + ...osDBMongoDBUserDefinitionCreateUpdate.json | 52 + .../CosmosDBMongoDBUserDefinitionDelete.json | 20 + .../CosmosDBMongoDBUserDefinitionGet.json | 31 + .../CosmosDBMongoDBUserDefinitionList.json | 33 + .../CosmosDBNotebookWorkspaceCreate.json | 23 + .../CosmosDBNotebookWorkspaceDelete.json | 18 + .../CosmosDBNotebookWorkspaceGet.json | 22 + .../CosmosDBNotebookWorkspaceList.json | 25 + ...DBNotebookWorkspaceListConnectionInfo.json | 17 + ...BNotebookWorkspaceRegenerateAuthToken.json | 18 + .../CosmosDBNotebookWorkspaceStart.json | 18 + .../examples/CosmosDBOperationsList.json | 22 + .../CosmosDBPKeyRangeIdGetMetrics.json | 58 + .../CosmosDBPKeyRangeIdRegionGetMetrics.json | 59 + .../CosmosDBPercentileGetMetrics.json | 61 + ...mosDBPercentileSourceTargetGetMetrics.json | 41 + .../CosmosDBPercentileTargetGetMetrics.json | 62 + ...smosDBPrivateEndpointConnectionDelete.json | 18 + .../CosmosDBPrivateEndpointConnectionGet.json | 30 + ...mosDBPrivateEndpointConnectionListGet.json | 50 + ...smosDBPrivateEndpointConnectionUpdate.json | 39 + .../CosmosDBPrivateLinkResourceGet.json | 28 + .../CosmosDBPrivateLinkResourceListGet.json | 31 + .../CosmosDBRegionCollectionGetMetrics.json | 56 + .../CosmosDBRestorableDatabaseAccountGet.json | 38 + ...CosmosDBRestorableDatabaseAccountList.json | 66 + ...storableDatabaseAccountNoLocationList.json | 65 + ...CosmosDBRestorableGremlinDatabaseList.json | 47 + .../CosmosDBRestorableGremlinGraphList.json | 48 + ...CosmosDBRestorableGremlinResourceList.json | 44 + ...smosDBRestorableMongodbCollectionList.json | 48 + ...CosmosDBRestorableMongodbDatabaseList.json | 47 + ...CosmosDBRestorableMongodbResourceList.json | 44 + .../CosmosDBRestorableSqlContainerList.json | 104 + .../CosmosDBRestorableSqlDatabaseList.json | 87 + .../CosmosDBRestorableSqlResourceList.json | 44 + .../examples/CosmosDBRestorableTableList.json | 47 + .../CosmosDBRestorableTableResourceList.json | 28 + ...sDBRestoreDatabaseAccountCreateUpdate.json | 156 + .../examples/CosmosDBServicesList.json | 37 + ...sDBSqlClientEncryptionKeyCreateUpdate.json | 51 + .../CosmosDBSqlClientEncryptionKeyGet.json | 35 + .../CosmosDBSqlClientEncryptionKeysList.json | 59 + ...CosmosDBSqlContainerBackupInformation.json | 28 + .../CosmosDBSqlContainerCreateUpdate.json | 163 + .../examples/CosmosDBSqlContainerDelete.json | 19 + .../examples/CosmosDBSqlContainerGet.json | 91 + .../examples/CosmosDBSqlContainerList.json | 232 + ...osmosDBSqlContainerMigrateToAutoscale.json | 35 + ...SqlContainerMigrateToManualThroughput.json | 32 + .../CosmosDBSqlContainerPartitionMerge.json | 51 + ...sDBSqlContainerRedistributeThroughput.json | 70 + .../examples/CosmosDBSqlContainerRestore.json | 99 + ...ntainerRetrieveThroughputDistribution.json | 50 + .../CosmosDBSqlContainerThroughputGet.json | 33 + .../CosmosDBSqlContainerThroughputUpdate.json | 41 + .../CosmosDBSqlDatabaseCreateUpdate.json | 39 + .../examples/CosmosDBSqlDatabaseDelete.json | 18 + .../examples/CosmosDBSqlDatabaseGet.json | 30 + .../examples/CosmosDBSqlDatabaseList.json | 33 + ...CosmosDBSqlDatabaseMigrateToAutoscale.json | 34 + ...BSqlDatabaseMigrateToManualThroughput.json | 31 + .../CosmosDBSqlDatabasePartitionMerge.json | 50 + ...osDBSqlDatabaseRedistributeThroughput.json | 69 + .../examples/CosmosDBSqlDatabaseRestore.json | 45 + ...atabaseRetrieveThroughputDistribution.json | 49 + .../CosmosDBSqlDatabaseThroughputGet.json | 32 + .../CosmosDBSqlDatabaseThroughputUpdate.json | 40 + ...mosDBSqlDedicatedGatewayServiceCreate.json | 47 + ...mosDBSqlDedicatedGatewayServiceDelete.json | 19 + ...CosmosDBSqlDedicatedGatewayServiceGet.json | 34 + ...smosDBSqlMaterializedViewCreateUpdate.json | 106 + ...CosmosDBSqlRoleAssignmentCreateUpdate.json | 36 + .../CosmosDBSqlRoleAssignmentDelete.json | 19 + .../CosmosDBSqlRoleAssignmentGet.json | 23 + .../CosmosDBSqlRoleAssignmentList.json | 26 + ...CosmosDBSqlRoleDefinitionCreateUpdate.json | 59 + .../CosmosDBSqlRoleDefinitionDelete.json | 19 + .../CosmosDBSqlRoleDefinitionGet.json | 35 + .../CosmosDBSqlRoleDefinitionList.json | 38 + ...osmosDBSqlStoredProcedureCreateUpdate.json | 39 + .../CosmosDBSqlStoredProcedureDelete.json | 20 + .../CosmosDBSqlStoredProcedureGet.json | 29 + .../CosmosDBSqlStoredProcedureList.json | 32 + .../CosmosDBSqlTriggerCreateUpdate.json | 43 + .../examples/CosmosDBSqlTriggerDelete.json | 20 + .../examples/CosmosDBSqlTriggerGet.json | 31 + .../examples/CosmosDBSqlTriggerList.json | 34 + ...sDBSqlUserDefinedFunctionCreateUpdate.json | 39 + .../CosmosDBSqlUserDefinedFunctionDelete.json | 20 + .../CosmosDBSqlUserDefinedFunctionGet.json | 29 + .../CosmosDBSqlUserDefinedFunctionList.json | 32 + .../CosmosDBTableBackupInformation.json | 27 + .../examples/CosmosDBTableCreateUpdate.json | 35 + .../examples/CosmosDBTableDelete.json | 18 + .../examples/CosmosDBTableGet.json | 28 + .../examples/CosmosDBTableList.json | 28 + .../CosmosDBTableMigrateToAutoscale.json | 34 + ...osmosDBTableMigrateToManualThroughput.json | 31 + .../examples/CosmosDBTableThroughputGet.json | 32 + .../CosmosDBTableThroughputUpdate.json | 40 + .../CosmosDBDataTransferJobCancel.json | 35 + .../CosmosDBDataTransferJobComplete.json | 35 + .../CosmosDBDataTransferJobCreate.json | 49 + .../CosmosDBDataTransferJobFeed.json | 38 + .../CosmosDBDataTransferJobGet.json | 35 + .../CosmosDBDataTransferJobPause.json | 35 + .../CosmosDBDataTransferJobResume.json | 35 + .../CosmosDBMongoClusterAddNode.json | 56 + .../CosmosDBMongoClusterCreate.json | 91 + .../CosmosDBMongoClusterCreatePITR.json | 68 + .../CosmosDBMongoClusterDelete.json | 16 + ...osmosDBMongoClusterFirewallRuleCreate.json | 57 + ...osmosDBMongoClusterFirewallRuleDelete.json | 17 + .../CosmosDBMongoClusterFirewallRuleGet.json | 31 + .../CosmosDBMongoClusterFirewallRuleList.json | 53 + .../CosmosDBMongoClusterGet.json | 47 + .../CosmosDBMongoClusterList.json | 83 + ...smosDBMongoClusterListByResourceGroup.json | 84 + ...osDBMongoClusterListConnectionStrings.json | 20 + .../CosmosDBMongoClusterNameAvailability.json | 19 + ...ClusterNameAvailability_AlreadyExists.json | 21 + .../CosmosDBMongoClusterUpdate.json | 63 + .../CosmosDBThroughputPoolAccountCreate.json | 39 + .../CosmosDBThroughputPoolAccountDelete.json | 18 + .../CosmosDBThroughputPoolAccountGet.json | 22 + .../CosmosDBThroughputPoolAccountsList.json | 32 + .../CosmosDBThroughputPoolCreate.json | 51 + .../CosmosDBThroughputPoolDelete.json | 17 + .../CosmosDBThroughputPoolGet.json | 26 + .../CosmosDBThroughputPoolList.json | 43 + .../CosmosDBThroughputPoolUpdate.json | 38 + .../2024-02-15-preview/managedCassandra.json | 1873 + .../2024-02-15-preview/mongoCluster.json | 988 + .../preview/2024-02-15-preview/mongorbac.json | 616 + .../preview/2024-02-15-preview/notebook.json | 461 + .../privateEndpointConnection.json | 318 + .../privateLinkResources.json | 195 + .../preview/2024-02-15-preview/rbac.json | 573 + .../2024-02-15-preview/restorable.json | 2073 + .../preview/2024-02-15-preview/services.json | 632 + .../2024-02-15-preview/throughputpool.json | 717 + .../cosmos-db/resource-manager/readme.md | 25 +- .../preview/2024-02-01-preview/databox.json | 7215 ++++ .../examples/AvailableSkusPost.json | 283 + .../examples/BookShipmentPickupPost.json | 33 + .../examples/JobMitigate.json | 30 + .../examples/JobsCancelPost.json | 27 + .../examples/JobsCreate.json | 182 + .../examples/JobsCreateDevicePassword.json | 184 + .../examples/JobsCreateDoubleEncryption.json | 187 + .../examples/JobsCreateExport.json | 192 + .../JobsCreateWithUserAssignedIdentity.json | 188 + .../examples/JobsDelete.json | 24 + .../2024-02-01-preview/examples/JobsGet.json | 165 + .../examples/JobsGetCmk.json | 164 + .../examples/JobsGetCopyStuck.json | 197 + .../examples/JobsGetExport.json | 129 + .../examples/JobsGetWaitingForAction.json | 238 + .../2024-02-01-preview/examples/JobsList.json | 78 + .../examples/JobsListByResourceGroup.json | 78 + .../examples/JobsListCredentials.json | 86 + .../examples/JobsPatch.json | 71 + .../examples/JobsPatchCmk.json | 57 + ...JobsPatchSystemAssignedToUserAssigned.json | 69 + .../examples/MarkDevicesShipped.json | 29 + .../examples/OperationsGet.json | 206 + .../examples/RegionConfiguration.json | 54 + .../RegionConfigurationByResourceGroup.json | 55 + .../examples/ValidateAddressPost.json | 55 + .../examples/ValidateInputs.json | 160 + .../ValidateInputsByResourceGroup.json | 161 + .../databox/resource-manager/readme.go.md | 10 + .../databox/resource-manager/readme.java.md | 14 + .../databox/resource-manager/readme.md | 11 +- .../databox/resource-manager/readme.python.md | 11 + .../stable/2023-12-01/databoxedge.json | 9757 +++++ .../stable/2023-12-01/examples/AlertGet.json | 37 + .../examples/AlertGetAllInDevice.json | 58 + .../examples/AvailableSkusList.json | 38 + .../examples/BandwidthScheduleDelete.json | 21 + .../examples/BandwidthScheduleGet.json | 30 + .../BandwidthScheduleGetAllInDevice.json | 33 + .../examples/BandwidthSchedulePut.json | 51 + .../2023-12-01/examples/ContainerDelete.json | 24 + .../2023-12-01/examples/ContainerGet.json | 28 + .../examples/ContainerListAllInDevice.json | 56 + .../2023-12-01/examples/ContainerPut.json | 43 + .../2023-12-01/examples/ContainerRefresh.json | 30 + .../examples/DataBoxEdgeDeviceDelete.json | 23 + .../examples/DataBoxEdgeDeviceGetByName.json | 58 + ...xEdgeDeviceGetByNameWithDataResidency.json | 61 + .../DataBoxEdgeDeviceGetByResourceGroup.json | 75 + .../DataBoxEdgeDeviceGetBySubscription.json | 74 + .../examples/DataBoxEdgeDevicePatch.json | 68 + .../examples/DataBoxEdgeDevicePut.json | 42 + ...DataBoxEdgeDevicePutWithDataResidency.json | 52 + .../2023-12-01/examples/DeleteAddons.json | 22 + .../examples/DeleteMonitoringConfig.json | 21 + .../examples/DeviceCapacityGet.json | 157 + .../examples/DeviceCapacityRequestPost.json | 37 + .../examples/DownloadUpdatesPost.json | 28 + .../2023-12-01/examples/ExtendedInfoPost.json | 34 + .../examples/GenerateCertificate.json | 20 + .../stable/2023-12-01/examples/GetAddons.json | 42 + .../2023-12-01/examples/GetDCAccessCode.json | 20 + ...gnosticProactiveLogCollectionSettings.json | 32 + .../GetDiagnosticRemoteSupportSettings.json | 33 + .../examples/GetMonitoringConfig.json | 37 + .../examples/GetUpdateExtendedInfo.json | 41 + .../examples/InstallUpdatesPost.json | 28 + .../stable/2023-12-01/examples/JobsGet.json | 31 + .../examples/ListMonitoringConfig.json | 41 + .../examples/NetworkSettingsGet.json | 58 + .../examples/NodeGetAllInDevice.json | 50 + .../2023-12-01/examples/OperationsGet.json | 675 + .../examples/OperationsStatusGet.json | 31 + .../2023-12-01/examples/OrderDelete.json | 23 + .../stable/2023-12-01/examples/OrderGet.json | 57 + .../examples/OrderGetAllInDevice.json | 61 + .../stable/2023-12-01/examples/OrderPut.json | 85 + .../stable/2023-12-01/examples/PutAddons.json | 52 + .../examples/PutMonitoringConfig.json | 62 + .../2023-12-01/examples/RoleDelete.json | 21 + .../stable/2023-12-01/examples/RoleGet.json | 41 + .../examples/RoleGetAllInDevice.json | 44 + .../2023-12-01/examples/RoleListAddOns.json | 36 + .../stable/2023-12-01/examples/RolePut.json | 85 + .../stable/2023-12-01/examples/SACDelete.json | 24 + .../stable/2023-12-01/examples/SACGet.json | 30 + .../examples/SACGetAllInDevice.json | 44 + .../stable/2023-12-01/examples/SACPut.json | 50 + .../examples/ScanForUpdatesPost.json | 28 + .../examples/SecuritySettingsUpdatePost.json | 37 + .../2023-12-01/examples/ShareDelete.json | 24 + .../stable/2023-12-01/examples/ShareGet.json | 45 + .../examples/ShareGetAllInDevice.json | 48 + .../stable/2023-12-01/examples/SharePut.json | 72 + .../2023-12-01/examples/ShareRefreshPost.json | 29 + .../examples/StorageAccountDelete.json | 23 + .../examples/StorageAccountGet.json | 29 + .../StorageAccountGetAllInDevice.json | 35 + .../examples/StorageAccountPut.json | 47 + .../2023-12-01/examples/TriggerDelete.json | 24 + .../2023-12-01/examples/TriggerGet.json | 34 + .../examples/TriggerGetAllInDevice.json | 37 + .../2023-12-01/examples/TriggerPut.json | 53 + .../examples/TriggerSupportPackage.json | 30 + ...gnosticProactiveLogCollectionSettings.json | 33 + ...UpdateDiagnosticRemoteSupportSettings.json | 45 + .../2023-12-01/examples/UpdateSummaryGet.json | 45 + .../examples/UploadCertificatePost.json | 38 + .../2023-12-01/examples/UserDelete.json | 30 + .../stable/2023-12-01/examples/UserGet.json | 28 + .../examples/UserGetAllInDevice.json | 38 + .../stable/2023-12-01/examples/UserPut.json | 44 + .../databoxedge/resource-manager/readme.md | 9 +- .../2024-02-01-preview/databricks.json | 1997 + .../examples/DisableEncryption.json | 132 + .../examples/EnableEncryption.json | 141 + .../ListPrivateEndpointConnections.json | 32 + .../examples/ListPrivateLinkResources.json | 30 + .../examples/OperationsList.json | 128 + ...boundNetworkDependenciesEndpointsList.json | 120 + .../examples/PrepareEncryption.json | 100 + .../PrivateEndpointConnectionsDelete.json | 20 + .../PrivateEndpointConnectionsGet.json | 29 + .../PrivateEndpointConnectionsUpdate.json | 55 + .../examples/PrivateLinkResourcesGet.json | 27 + .../examples/WorkspaceCreate.json | 114 + .../WorkspaceCreateWithParameters.json | 146 + .../examples/WorkspaceDelete.json | 19 + .../examples/WorkspaceDeleteRetainUcData.json | 20 + ...ancedSecurityComplianceCreateOrUpdate.json | 134 + ...orkspaceEnhancedSecurityComplianceGet.json | 62 + .../examples/WorkspaceGet.json | 48 + .../examples/WorkspaceGetParameters.json | 81 + .../WorkspaceManagedDiskEncryptionCreate.json | 142 + .../WorkspaceManagedDiskEncryptionGet.json | 67 + .../WorkspaceManagedDiskEncryptionUpdate.json | 150 + .../examples/WorkspaceUpdate.json | 62 + .../WorkspaceVirtualNetPeeringGet.json | 43 + .../WorkspaceVirtualNetPeeringList.json | 45 + ...ceVirtualNetworkPeeringCreateOrUpdate.json | 84 + .../WorkspaceVirtualNetworkPeeringDelete.json | 19 + .../WorkspacesListByResourceGroup.json | 87 + .../WorkspacesListBySubscription.json | 87 + .../2024-02-01-preview/vnetpeering.json | 490 + .../databricks/resource-manager/readme.md | 30 +- .../2018-06-01/entityTypes/Dataset.json | 22 +- .../2018-06-01/entityTypes/LinkedService.json | 110 + .../2018-06-01/entityTypes/Pipeline.json | 88 +- .../2018-09-01-preview/deploymentmanager.json | 1871 - .../artifactsource_createorupdate.json | 41 - ...actsource_createorupdate_artifactroot.json | 42 - .../examples/artifactsource_delete.json | 12 - .../examples/artifactsource_get.json | 27 - .../examples/operations_get.json | 165 - .../examples/rollout_createorupdate.json | 123 - .../examples/rollout_delete.json | 12 - .../examples/rollout_get.json | 124 - .../examples/rollout_post_cancel.json | 124 - .../examples/rollout_post_restart.json | 75 - .../examples/service_createorupdate.json | 32 - .../examples/service_delete.json | 13 - .../examples/service_get.json | 23 - .../servicetopology_createorupdate.json | 29 - ...ology_createorupdate_noartifactsource.json | 25 - .../examples/servicetopology_delete.json | 12 - .../examples/servicetopology_get.json | 21 - .../examples/serviceunit_createorupdate.json | 41 - ...eunit_createorupdate_noartifactsource.json | 41 - .../examples/serviceunit_delete.json | 14 - .../examples/serviceunit_get.json | 28 - .../examples/step_createorupdate.json | 35 - .../examples/step_delete.json | 12 - .../2018-09-01-preview/examples/step_get.json | 24 - .../2019-11-01-preview/deploymentmanager.json | 2421 -- .../artifactsource_createorupdate.json | 40 - ...actsource_createorupdate_artifactroot.json | 41 - .../examples/artifactsource_delete.json | 12 - .../examples/artifactsource_get.json | 27 - .../examples/artifactsources_list.json | 44 - .../examples/operations_list.json | 166 - .../examples/rollout_createorupdate.json | 122 - .../examples/rollout_delete.json | 12 - .../examples/rollout_get.json | 124 - .../examples/rollout_post_cancel.json | 124 - .../examples/rollout_post_restart.json | 75 - .../examples/rollouts_list.json | 101 - .../examples/service_createorupdate.json | 31 - .../examples/service_delete.json | 13 - .../examples/service_get.json | 23 - .../examples/services_list.json | 34 - .../examples/servicetopologies_list.json | 31 - .../servicetopology_createorupdate.json | 28 - ...ology_createorupdate_noartifactsource.json | 24 - .../examples/servicetopology_delete.json | 12 - .../examples/servicetopology_get.json | 21 - .../examples/serviceunit_createorupdate.json | 40 - ...eunit_createorupdate_noartifactsource.json | 40 - .../examples/serviceunit_delete.json | 14 - .../examples/serviceunit_get.json | 28 - .../examples/serviceunits_list.json | 43 - .../examples/step_delete.json | 12 - .../2019-11-01-preview/examples/step_get.json | 24 - .../step_health_check_createorupdate.json | 150 - .../examples/step_wait_createorupdate.json | 34 - .../examples/steps_list.json | 37 - .../resource-manager/readme.go.md | 44 - .../resource-manager/readme.md | 182 - .../resource-manager/readme.nodejs.md | 14 - .../resource-manager/readme.python.md | 20 - .../resource-manager/readme.ruby.md | 27 - .../desktopvirtualization.json | 10235 +++++ .../ActiveSessionHostConfigurations_Get.json | 88 + ...sionHostConfigurations_ListByHostPool.json | 92 + .../AppAttachPackageInfo_Import_Post.json | 126 + .../examples/AppAttachPackage_Create.json | 161 + .../examples/AppAttachPackage_Delete.json | 64 + .../examples/AppAttachPackage_Get.json | 65 + .../AppAttachPackage_ListByResourceGroup.json | 122 + .../AppAttachPackage_ListBySubscription.json | 121 + .../examples/AppAttachPackage_Update.json | 106 + .../examples/ApplicationGroup_Create.json | 84 + .../examples/ApplicationGroup_Delete.json | 39 + .../examples/ApplicationGroup_Get.json | 40 + .../ApplicationGroup_ListByResourceGroup.json | 75 + .../ApplicationGroup_ListBySubscription.json | 74 + .../examples/ApplicationGroup_Update.json | 51 + .../examples/Application_Create.json | 85 + .../examples/Application_Delete.json | 41 + .../examples/Application_Get.json | 42 + .../examples/Application_List.json | 77 + .../examples/Application_Update.json | 57 + .../examples/Desktop_Get.json | 33 + .../examples/Desktop_List.json | 39 + .../examples/Desktop_Update.json | 39 + .../examples/HostPool_Create.json | 187 + .../examples/HostPool_Delete.json | 70 + .../examples/HostPool_Get.json | 83 + .../examples/HostPool_List.json | 143 + .../HostPool_ListByResourceGroup.json | 144 + .../examples/HostPool_Update.json | 118 + ...tPools_RetrieveRegistrationToken_Post.json | 17 + .../examples/MsixImage_Expand_Post.json | 99 + .../examples/MsixPackage_Create.json | 130 + .../examples/MsixPackage_Delete.json | 54 + .../examples/MsixPackage_Get.json | 55 + .../examples/MsixPackage_List.json | 103 + .../examples/MsixPackage_Update.json | 62 + .../examples/OperationDescription_List.json | 51 + ...teEndpointConnection_DeleteByHostPool.json | 13 + ...eEndpointConnection_DeleteByWorkspace.json | 13 + ...ivateEndpointConnection_GetByHostPool.json | 37 + ...vateEndpointConnection_GetByWorkspace.json | 37 + ...vateEndpointConnection_ListByHostPool.json | 40 + ...ateEndpointConnection_ListByWorkspace.json | 40 + ...teEndpointConnection_UpdateByHostPool.json | 46 + ...eEndpointConnection_UpdateByWorkspace.json | 46 + .../PrivateLinkResources_ListByHostPool.json | 33 + .../PrivateLinkResources_ListByWorkspace.json | 33 + .../ScalingPlanPersonalSchedule_Create.json | 180 + .../ScalingPlanPersonalSchedule_Delete.json | 13 + .../ScalingPlanPersonalSchedule_Get.json | 72 + .../ScalingPlanPersonalSchedule_List.json | 134 + .../ScalingPlanPersonalSchedule_Update.json | 101 + .../ScalingPlanPooledSchedule_Create.json | 151 + .../ScalingPlanPooledSchedule_Delete.json | 13 + .../ScalingPlanPooledSchedule_Get.json | 62 + .../ScalingPlanPooledSchedule_List.json | 114 + .../ScalingPlanPooledSchedule_Update.json | 82 + .../examples/ScalingPlan_Create.json | 215 + .../examples/ScalingPlan_Delete.json | 82 + .../examples/ScalingPlan_Get.json | 83 + .../examples/ScalingPlan_ListByHostPool.json | 90 + .../ScalingPlan_ListByResourceGroup.json | 159 + .../ScalingPlan_ListBySubscription.json | 158 + .../examples/ScalingPlan_Update.json | 140 + ...HostConfigurationsOperationStatus_Get.json | 26 + ...ostConfigurationsOperationStatus_List.json | 31 + .../SessionHostConfigurations_Create.json | 238 + .../SessionHostConfigurations_Get.json | 89 + ...sionHostConfigurations_ListByHostPool.json | 93 + .../SessionHostConfigurations_Update.json | 157 + ...ionHostManagementsOperationStatus_Get.json | 62 + ...onHostManagementsOperationStatus_List.json | 120 + ...gements_ControlSessionHostUpdate_Post.json | 21 + .../SessionHostManagements_Create.json | 69 + .../examples/SessionHostManagements_Get.json | 37 + ...SessionHostManagements_ListByHostPool.json | 38 + .../SessionHostManagements_Update.json | 45 + ...stManagements_UpdateSessionHosts_Post.json | 27 + .../examples/SessionHost_Delete.json | 57 + .../examples/SessionHost_Get.json | 57 + .../examples/SessionHost_List.json | 107 + .../SessionHost_RetryProvisioning_Post.json | 12 + .../examples/SessionHost_Update.json | 65 + .../examples/StartMenuItem_List.json | 40 + .../examples/UserSession_Delete.json | 35 + .../examples/UserSession_Disconnect_Post.json | 13 + .../examples/UserSession_Get.json | 35 + .../examples/UserSession_List.json | 62 + .../examples/UserSession_ListByHostPool.json | 62 + .../UserSession_SendMessage_Post.json | 17 + .../examples/Workspace_Create.json | 73 + .../examples/Workspace_Delete.json | 35 + .../examples/Workspace_Get.json | 36 + .../Workspace_ListByResourceGroup.json | 66 + .../Workspace_ListBySubscription.json | 65 + .../examples/Workspace_Update.json | 46 + .../resource-manager/readme.md | 17 +- .../stable/2024-02-01/devbox.json | 2370 ++ .../stable/2024-02-01/devcenter.json | 361 + .../stable/2024-02-01/environments.json | 1828 + .../2024-02-01/examples/Catalogs_Get.json | 16 + .../examples/Catalogs_ListByProject.json | 19 + .../examples/DevBoxActions_Delay.json | 27 + .../examples/DevBoxActions_DelayMultiple.json | 49 + .../DevBoxActions_DelayMultipleWithError.json | 41 + .../examples/DevBoxActions_Get.json | 25 + .../examples/DevBoxActions_List.json | 40 + .../examples/DevBoxActions_Skip.json | 13 + .../examples/DevBoxOperations_Get.json | 23 + .../examples/DevBoxOperations_List.json | 40 + .../2024-02-01/examples/DevBoxes_Create.json | 72 + .../2024-02-01/examples/DevBoxes_Delete.json | 24 + .../2024-02-01/examples/DevBoxes_Get.json | 38 + .../DevBoxes_GetRemoteConnection.json | 16 + .../2024-02-01/examples/DevBoxes_List.json | 39 + .../DevBoxes_ListByUserByProject.json | 41 + .../2024-02-01/examples/DevBoxes_Repair.json | 23 + .../2024-02-01/examples/DevBoxes_Restart.json | 23 + .../2024-02-01/examples/DevBoxes_Start.json | 23 + .../2024-02-01/examples/DevBoxes_Stop.json | 24 + .../examples/EnvironmentActions_Delay.json | 25 + .../examples/EnvironmentActions_Get.json | 24 + .../examples/EnvironmentActions_List.json | 37 + .../examples/EnvironmentActions_Skip.json | 19 + .../examples/EnvironmentDefinitions_Get.json | 56 + .../EnvironmentDefinitions_ListByCatalog.json | 67 + .../EnvironmentDefinitions_ListByProject.json | 66 + ...nvironmentOperations_GetByEnvironment.json | 27 + .../EnvironmentOperations_GetLogs.json | 15 + ...vironmentOperations_ListByEnvironment.json | 30 + .../EnvironmentTypes_ListByProject.json | 22 + ...onments_CreateByEnvironmentDefinition.json | 41 + .../examples/Environments_Delete.json | 24 + .../2024-02-01/examples/Environments_Get.json | 28 + .../examples/Environments_GetOutputs.json | 49 + .../examples/Environments_ListByProject.json | 30 + .../Environments_ListByProjectByUser.json | 31 + .../examples/Environments_Patch.json | 33 + .../stable/2024-02-01/examples/Pools_Get.json | 39 + .../2024-02-01/examples/Pools_List.json | 69 + .../2024-02-01/examples/Projects_Get.json | 17 + .../examples/Projects_ListByDevCenter.json | 20 + .../2024-02-01/examples/Schedules_Get.json | 23 + .../2024-02-01/examples/Schedules_List.json | 26 + .../examples/Schedules_ListByProject.json | 25 + specification/devcenter/data-plane/readme.md | 16 +- .../Microsoft.DevOpsInfrastructure/main.tsp | 46 +- .../devopsinfrastructure.json | 12 +- .../resource-manager/readme.java.md | 30 +- .../resource-manager/readme.md | 5 + .../stable/2024-02-01/edgeorder.json | 4361 ++ .../2024-02-01/examples/CancelOrderItem.json | 27 + .../2024-02-01/examples/CreateAddress.json | 82 + .../2024-02-01/examples/CreateOrderItem.json | 168 + .../examples/DeleteAddressByName.json | 22 + .../examples/DeleteOrderItemByName.json | 22 + .../2024-02-01/examples/GetAddressByName.json | 51 + .../2024-02-01/examples/GetOrderByName.json | 50 + .../examples/GetOrderItemByName.json | 119 + .../ListAddressesAtResourceGroupLevel.json | 90 + .../ListAddressesAtSubscriptionLevel.json | 86 + .../examples/ListConfigurations.json | 103 + .../2024-02-01/examples/ListOperations.json | 184 + .../ListOrderAtResourceGroupLevel.json | 80 + .../ListOrderAtSubscriptionLevel.json | 79 + .../ListOrderItemsAtResourceGroupLevel.json | 223 + .../ListOrderItemsAtSubscriptionLevel.json | 222 + .../examples/ListProductFamilies.json | 238 + .../examples/ListProductFamiliesMetadata.json | 63 + .../2024-02-01/examples/ReturnOrderItem.json | 31 + .../2024-02-01/examples/UpdateAddress.json | 90 + .../2024-02-01/examples/UpdateOrderItem.json | 138 + .../edgeorder/resource-manager/readme.md | 25 +- .../preview/2024-01-01-preview/elastic.json | 3147 ++ .../examples/AllTrafficFilters_list.json | 36 + .../AssociateTrafficFilter_Update.json | 16 + .../AssociatedFiltersForDeployment_list.json | 36 + .../examples/BillingInfo_Get.json | 29 + .../ConnectedPartnerResources_List.json | 24 + .../examples/DeploymentInfo_List.json | 28 + .../DetachAndDeleteTrafficFilter_Delete.json | 12 + .../examples/DetachTrafficFilters_Update.json | 16 + .../examples/ElasticVersions_List.json | 20 + .../examples/ExternalUserInfo.json | 25 + .../examples/IPTrafficFilter_Create.json | 18 + .../examples/Monitor_Upgrade.json | 18 + .../examples/MonitoredResources_List.json | 21 + .../examples/Monitors_Create.json | 115 + .../examples/Monitors_Delete.json | 17 + .../examples/Monitors_Get.json | 43 + .../examples/Monitors_List.json | 45 + .../Monitors_ListByResourceGroup.json | 46 + .../examples/Monitors_Update.json | 86 + .../examples/OpenAI_CreateOrUpdate.json | 42 + .../examples/OpenAI_Delete.json | 13 + .../examples/OpenAI_Get.json | 23 + .../examples/OpenAI_GetStatus.json | 18 + .../examples/OpenAI_List.json | 26 + .../examples/Operations_List.json | 23 + .../examples/Organizations_GetApiKey.json | 18 + ..._GetElasticToAzureSubscriptionMapping.json | 25 + .../PrivateLinkTrafficFilters_Create.json | 19 + .../examples/TagRules_CreateOrUpdate.json | 59 + .../examples/TagRules_Delete.json | 18 + .../examples/TagRules_Get.json | 38 + .../examples/TagRules_List.json | 41 + .../examples/TrafficFilters_Delete.json | 12 + .../examples/UpgradableVersions_Details.json | 19 + .../examples/VMCollection_Update.json | 15 + .../examples/VMHost_List.json | 19 + .../examples/VMIngestion_Details.json | 16 + .../stable/2024-03-01/elastic.json | 3147 ++ .../examples/AllTrafficFilters_list.json | 36 + .../AssociateTrafficFilter_Update.json | 16 + .../AssociatedFiltersForDeployment_list.json | 36 + .../2024-03-01/examples/BillingInfo_Get.json | 29 + .../ConnectedPartnerResources_List.json | 24 + .../examples/DeploymentInfo_List.json | 28 + .../DetachAndDeleteTrafficFilter_Delete.json | 12 + .../examples/DetachTrafficFilters_Update.json | 16 + .../examples/ElasticVersions_List.json | 20 + .../2024-03-01/examples/ExternalUserInfo.json | 25 + .../examples/IPTrafficFilter_Create.json | 18 + .../2024-03-01/examples/Monitor_Upgrade.json | 18 + .../examples/MonitoredResources_List.json | 21 + .../2024-03-01/examples/Monitors_Create.json | 115 + .../2024-03-01/examples/Monitors_Delete.json | 17 + .../2024-03-01/examples/Monitors_Get.json | 43 + .../2024-03-01/examples/Monitors_List.json | 45 + .../Monitors_ListByResourceGroup.json | 46 + .../2024-03-01/examples/Monitors_Update.json | 86 + .../examples/OpenAI_CreateOrUpdate.json | 42 + .../2024-03-01/examples/OpenAI_Delete.json | 13 + .../2024-03-01/examples/OpenAI_Get.json | 23 + .../2024-03-01/examples/OpenAI_GetStatus.json | 18 + .../2024-03-01/examples/OpenAI_List.json | 26 + .../2024-03-01/examples/Operations_List.json | 23 + .../examples/Organizations_GetApiKey.json | 18 + ..._GetElasticToAzureSubscriptionMapping.json | 25 + .../PrivateLinkTrafficFilters_Create.json | 19 + .../examples/TagRules_CreateOrUpdate.json | 59 + .../2024-03-01/examples/TagRules_Delete.json | 18 + .../2024-03-01/examples/TagRules_Get.json | 38 + .../2024-03-01/examples/TagRules_List.json | 41 + .../examples/TrafficFilters_Delete.json | 12 + .../examples/UpgradableVersions_Details.json | 19 + .../examples/VMCollection_Update.json | 15 + .../2024-03-01/examples/VMHost_List.json | 19 + .../examples/VMIngestion_Details.json | 16 + .../elastic/resource-manager/readme.md | 34 +- .../resource-manager/readme.python.md | 5 + .../stable/2018-01-01/PrivateCloud.json | 216 + .../cloud-events-schema/cluster_updated.json | 20 + .../privatecloud_updating.json | 11 + .../script_execution_failed.json | 14 + .../event-grid-schema/cluster_updated.json | 21 + .../privatecloud_updating.json | 12 + .../script_execution_failed.json | 15 + .../AzureCommunicationServices.json | 7 + .../chat_thread_properties_updated.json | 3 + .../stable/2018-01-01/Storage.json | 70 + .../storage_task_assignment_completed.json | 15 + .../storage_task_assignment_queued.json | 12 + .../storage_task_assignment_completed.json | 16 + .../storage_task_assignment_queued.json | 13 + specification/eventgrid/data-plane/readme.md | 5 + .../2024-01-10/binaryHardeningResults.json | 195 + .../stable/2024-01-10/common.json | 84 + .../stable/2024-01-10/cryptoCertificates.json | 274 + .../stable/2024-01-10/cryptoKeys.json | 181 + .../stable/2024-01-10/cves.json | 221 + ...rdening_ListByFirmware_MaximumSet_Gen.json | 58 + ...rdening_ListByFirmware_MinimumSet_Gen.json | 16 + ...ficates_ListByFirmware_MaximumSet_Gen.json | 108 + ...ficates_ListByFirmware_MinimumSet_Gen.json | 16 + ...ptoKeys_ListByFirmware_MaximumSet_Gen.json | 57 + ...ptoKeys_ListByFirmware_MinimumSet_Gen.json | 16 + .../Cves_ListByFirmware_MaximumSet_Gen.json | 79 + .../Cves_ListByFirmware_MinimumSet_Gen.json | 16 + .../Firmwares_Create_MaximumSet_Gen.json | 89 + .../Firmwares_Create_MinimumSet_Gen.json | 20 + .../Firmwares_Delete_MaximumSet_Gen.json | 15 + .../Firmwares_Delete_MinimumSet_Gen.json | 15 + ...es_GenerateDownloadUrl_MaximumSet_Gen.json | 18 + ...es_GenerateDownloadUrl_MinimumSet_Gen.json | 16 + ...eFilesystemDownloadUrl_MaximumSet_Gen.json | 18 + ...eFilesystemDownloadUrl_MinimumSet_Gen.json | 16 + .../Firmwares_Get_MaximumSet_Gen.json | 43 + .../Firmwares_Get_MinimumSet_Gen.json | 16 + ...mwares_ListByWorkspace_MaximumSet_Gen.json | 47 + ...mwares_ListByWorkspace_MinimumSet_Gen.json | 15 + .../Firmwares_Update_MaximumSet_Gen.json | 59 + .../Firmwares_Update_MinimumSet_Gen.json | 17 + .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + ...dHashes_ListByFirmware_MaximumSet_Gen.json | 48 + ...dHashes_ListByFirmware_MinimumSet_Gen.json | 16 + ...ponents_ListByFirmware_MaximumSet_Gen.json | 48 + ...ponents_ListByFirmware_MinimumSet_Gen.json | 16 + .../Summaries_Get_MaximumSet_Gen.json | 31 + .../Summaries_Get_MinimumSet_Gen.json | 17 + ...mmaries_ListByFirmware_MaximumSet_Gen.json | 36 + ...mmaries_ListByFirmware_MinimumSet_Gen.json | 16 + .../Workspaces_Create_MaximumSet_Gen.json | 63 + .../Workspaces_Create_MinimumSet_Gen.json | 31 + .../Workspaces_Delete_MaximumSet_Gen.json | 14 + .../Workspaces_Delete_MinimumSet_Gen.json | 14 + ...aces_GenerateUploadUrl_MaximumSet_Gen.json | 20 + ...aces_GenerateUploadUrl_MinimumSet_Gen.json | 16 + .../Workspaces_Get_MaximumSet_Gen.json | 34 + .../Workspaces_Get_MinimumSet_Gen.json | 20 + ...es_ListByResourceGroup_MaximumSet_Gen.json | 38 + ...es_ListByResourceGroup_MinimumSet_Gen.json | 14 + ...ces_ListBySubscription_MaximumSet_Gen.json | 37 + ...ces_ListBySubscription_MinimumSet_Gen.json | 13 + .../Workspaces_Update_MaximumSet_Gen.json | 37 + .../Workspaces_Update_MinimumSet_Gen.json | 18 + .../stable/2024-01-10/firmwares.json | 537 + .../stable/2024-01-10/operations.json | 79 + .../stable/2024-01-10/passwordHashes.json | 168 + .../stable/2024-01-10/sbomComponents.json | 158 + .../stable/2024-01-10/summaries.json | 455 + .../stable/2024-01-10/workspaces.json | 468 + specification/fist/resource-manager/readme.md | 29 +- .../resource-manager/readme.go.md | 5 + .../resource-manager/readme.java.md | 1 + .../resource-manager/readme.md | 5 + .../examples/CreateAutoscaleCluster.json | 354 + .../examples/CreateClusterPool.json | 95 + .../CreateClusterPoolWithPrivateAks.json | 107 + .../examples/CreateClusterPoolWithUDRAks.json | 107 + .../examples/CreateRangerCluster.json | 239 + .../examples/CreateSparkCluster.json | 314 + ...CreateSparkClusterWithInternalIngress.json | 331 + .../examples/DeleteCluster.json | 22 + .../examples/DeleteClusterPool.json | 21 + .../examples/GetCluster.json | 89 + .../examples/GetClusterInstanceView.json | 30 + .../examples/GetClusterPool.json | 47 + .../examples/GetOperations.json | 26 + .../ListAvailableClusterPoolVersions.json | 43 + .../ListAvailableClusterVersions.json | 58 + .../ListClusterAvailableUpgrades.json | 43 + .../examples/ListClusterInstanceViews.json | 35 + .../examples/ListClusterJobs.json | 36 + .../ListClusterPoolAvailableUpgrades.json | 32 + .../examples/ListClusterPools.json | 46 + .../ListClusterPoolsSubscription.json | 45 + .../examples/ListClusterServiceConfigs.json | 25 + .../ListClustersByClusterPoolName.json | 88 + .../examples/LocationsNameAvailability.json | 20 + .../examples/PatchCluster.json | 455 + .../examples/PatchClusterPool.json | 96 + .../examples/PatchRangerCluster.json | 231 + .../examples/ResizeCluster.json | 143 + .../examples/RunClusterJob.json | 47 + .../UpgradeAKSPatchVersionForCluster.json | 137 + .../UpgradeAKSPatchVersionForClusterPool.json | 59 + .../examples/UpgradeHotfixForCluster.json | 141 + .../examples/UpgradeNodeOsForClusterPool.json | 57 + .../preview/2023-11-01-preview/hdinsight.json | 4234 ++ .../HDInsightOnAks/readme.java.md | 7 + .../HDInsightOnAks/readme.md | 40 +- .../examples/CheckNameAvailabilityPost.json | 19 + .../examples/OperationResultsGet.json | 20 + .../2023-12-01/examples/OperationsList.json | 113 + .../dicomservices/DicomServices_Create.json | 126 + .../dicomservices/DicomServices_Delete.json | 18 + .../dicomservices/DicomServices_Get.json | 58 + .../dicomservices/DicomServices_List.json | 89 + .../dicomservices/DicomServices_Patch.json | 119 + .../fhirservices/FhirServices_Create.json | 314 + .../fhirservices/FhirServices_Delete.json | 18 + .../fhirservices/FhirServices_Get.json | 79 + .../fhirservices/FhirServices_List.json | 33 + .../fhirservices/FhirServices_Patch.json | 45 + .../iotconnectors/iotconnector_Create.json | 214 + .../iotconnectors/iotconnector_Delete.json | 18 + .../iotconnectors/iotconnector_Get.json | 65 + .../iotconnectors/iotconnector_List.json | 121 + .../iotconnectors/iotconnector_Patch.json | 132 + .../iotconnector_fhirdestination_Create.json | 187 + .../iotconnector_fhirdestination_Delete.json | 19 + .../iotconnector_fhirdestination_Get.json | 59 + .../iotconnector_fhirdestination_List.json | 108 + .../legacy/PrivateLinkResourceGet.json | 27 + .../PrivateLinkResourcesListByService.json | 30 + .../examples/legacy/ServiceCreate.json | 177 + ...teInDataSovereignRegionWithCmkEnabled.json | 179 + .../examples/legacy/ServiceCreateMinimum.json | 95 + ...erviceCreatePrivateEndpointConnection.json | 37 + .../examples/legacy/ServiceDelete.json | 16 + ...erviceDeletePrivateEndpointConnection.json | 18 + .../examples/legacy/ServiceGet.json | 61 + ...etInDataSovereignRegionWithCmkEnabled.json | 62 + .../ServiceGetPrivateEndpointConnection.json | 28 + .../examples/legacy/ServiceList.json | 64 + .../legacy/ServiceListByResourceGroup.json | 65 + ...ServiceListPrivateEndpointConnections.json | 31 + .../examples/legacy/ServicePatch.json | 70 + .../PrivateLinkResourcesListByWorkspace.json | 32 + ...kspaceCreatePrivateEndpointConnection.json | 37 + ...kspaceDeletePrivateEndpointConnection.json | 18 + ...WorkspaceGetPrivateEndpointConnection.json | 28 + ...rkspaceListPrivateEndpointConnections.json | 31 + .../WorkspacePrivateLinkResourceGet.json | 29 + .../workspaces/Workspaces_Create.json | 47 + .../workspaces/Workspaces_Delete.json | 17 + .../examples/workspaces/Workspaces_Get.json | 21 + .../Workspaces_ListByResourceGroup.json | 25 + .../Workspaces_ListBySubscription.json | 24 + .../examples/workspaces/Workspaces_Patch.json | 46 + .../stable/2023-12-01/healthcare-apis.json | 4276 ++ .../healthcareapis/resource-manager/readme.md | 16 +- .../hybridaks/resource-manager/readme.java.md | 7 + .../hybridaks/resource-manager/readme.md | 4 + .../2024-02-01-preview/connectedClusters.json | 1033 + ...tersListClusterCredentialResultCSPAAD.json | 30 + ...rsListClusterCredentialResultCSPToken.json | 30 + ...stersListClusterCredentialResultHPAAD.json | 24 + ...ersListClusterCredentialResultHPToken.json | 24 + .../examples/CreateClusterExample.json | 83 + .../CreateClusterPrivateLinkExample.json | 89 + .../examples/CreateCluster_KindExample.json | 141 + .../examples/DeleteClusterExample.json | 18 + .../examples/GetClusterExample.json | 66 + .../GetClustersByResourceGroupExample.json | 87 + .../GetClustersBySubscriptionExample.json | 86 + .../GetProvisionedClusterExample.json | 67 + ...ListConnectedClusterOperationsExample.json | 41 + .../examples/UpdateClusterExample.json | 55 + .../resource-manager/readme.md | 9 + .../common.tsp | 13 +- .../preview/2023-10-04-preview/openapi.json | 28 +- .../models/base.tsp | 27 +- .../models/datalakeconnector.tsp | 50 +- .../models/kafkaconnector.tsp | 44 +- .../models/mqttbridgeconnector.tsp | 12 +- .../models/mqttbroker.tsp | 40 +- .../2023-10-04-preview/iotoperationsmq.json | 424 +- .../common.tsp | 15 +- .../preview/2023-10-04-preview/openapi.json | 32 +- .../stable/7.5/backuprestore.json | 435 + .../stable/7.5/certificates.json | 2075 + .../Microsoft.KeyVault/stable/7.5/common.json | 84 + .../examples/BackupCertificate-example.json | 14 + .../7.5/examples/BackupKey-example.json | 14 + .../7.5/examples/BackupSecret-example.json | 14 + .../examples/CreateCertificate-example.json | 47 + .../7.5/examples/CreateKey-example.json | 54 + .../examples/DeleteCertificate-example.json | 65 + .../DeleteCertificateContacts-example.json | 25 + .../DeleteCertificateIssuer-example.json | 33 + .../DeleteCertificateOperation-example.json | 22 + .../7.5/examples/DeleteKey-example.json | 40 + .../DeleteRoleAssignments-example.json | 22 + .../DeleteRoleDefinition-example.json | 32 + .../7.5/examples/DeleteSecret-example.json | 23 + .../7.5/examples/FullBackup-example.json | 26 + .../examples/FullBackup-pending-example.json | 19 + .../7.5/examples/FullRestore-example.json | 28 + .../7.5/examples/GetCertificate-example.json | 63 + .../GetCertificateContacts-example.json | 25 + .../GetCertificateIssuer-example.json | 33 + .../GetCertificateIssuers-example.json | 27 + .../GetCertificateOperation-example.json | 22 + .../GetCertificatePolicy-example.json | 47 + .../GetCertificateVersions-example.json | 38 + .../7.5/examples/GetCertificates-example.json | 37 + .../GetDeletedCertificate-example.json | 66 + .../GetDeletedCertificates-example.json | 31 + .../7.5/examples/GetDeletedKey-example.json | 40 + .../7.5/examples/GetDeletedKeys-example.json | 29 + .../examples/GetDeletedSecret-example.json | 23 + .../examples/GetDeletedSecrets-example.json | 30 + .../stable/7.5/examples/GetKey-example.json | 38 + .../GetKeyRotationPolicy-example.json | 37 + .../7.5/examples/GetKeyVersions-example.json | 27 + .../stable/7.5/examples/GetKeys-example.json | 26 + .../7.5/examples/GetRandomBytes-example.json | 16 + .../examples/GetRoleAssignments-example.json | 22 + .../examples/GetRoleDefinition-example.json | 32 + .../7.5/examples/GetSecret-example.json | 22 + .../examples/GetSecretVersions-example.json | 25 + .../7.5/examples/GetSecrets-example.json | 25 + .../examples/ImportCertificate-example.json | 77 + .../7.5/examples/ImportKey-example.json | 52 + .../examples/ListRoleAssignments-example.json | 25 + .../examples/ListRoleDefinitions-example.json | 36 + .../7.5/examples/ListSettings-example.json | 19 + .../examples/MergeCertificate-example.json | 68 + .../PurgeDeletedCertificate-example.json | 10 + .../7.5/examples/PurgeDeletedKey-example.json | 10 + .../examples/PurgeDeletedSecret-example.json | 10 + .../examples/PutRoleAssignments-example.json | 28 + .../examples/PutRoleDefinition-example.json | 46 + .../RecoverDeletedCertificate-example.json | 62 + .../examples/RecoverDeletedKey-example.json | 37 + .../RecoverDeletedSecret-example.json | 20 + .../stable/7.5/examples/ReleasePolicy-example | 1 + .../7.5/examples/Restore-pending-example.json | 18 + .../examples/RestoreCertificate-example.json | 70 + .../7.5/examples/RestoreKey-example.json | 37 + .../7.5/examples/RestoreSecret-example.json | 25 + .../7.5/examples/RotateKey-example.json | 37 + .../examples/SelectiveRestore-example.json | 29 + .../SetCertificateContacts-example.json | 39 + .../SetCertificateIssuer-example.json | 50 + .../7.5/examples/SetSecret-example.json | 24 + .../examples/UpdateCertificate-example.json | 39 + .../UpdateCertificateIssuer-example.json | 40 + .../UpdateCertificateOperation-example.json | 25 + .../UpdateCertificatePolicy-example.json | 80 + .../7.5/examples/UpdateKey-example.json | 43 + .../UpdateKeyRotationPolicy-example.json | 60 + .../7.5/examples/UpdateSecret-example.json | 34 + .../7.5/examples/UpdateSetting-example.json | 19 + .../7.5/examples/backupStorageAccount.json | 15 + .../stable/7.5/examples/decrypt-example.json | 20 + .../7.5/examples/deleteStorageAccount.json | 32 + .../examples/deleteStorageSasDefinition.json | 29 + .../stable/7.5/examples/encrypt-example.json | 20 + .../examples/getDeletedStorageAccount.json | 32 + .../getDeletedStorageSasDefinition.json | 29 + .../7.5/examples/getStorageAccount.json | 29 + .../7.5/examples/getStorageSasDefinition.json | 26 + .../examples/listDeletedStorageAccount.json | 50 + .../listDeletedStorageSasDefinition.json | 43 + .../7.5/examples/listStorageAccount.json | 44 + .../examples/listStorageSasDefinition.json | 37 + .../7.5/examples/purgeStorageAccount.json | 12 + .../7.5/examples/recoverStorageAccount.json | 29 + .../examples/recoverStorageSasDefinition.json | 26 + .../examples/regenerateStorageAccountKey.json | 32 + .../stable/7.5/examples/release-example.json | 18 + .../7.5/examples/restoreStorageAccount.json | 32 + .../securitydomaindownloadpost-example.json | 73 + ...securitydomainoperationstatus-example.json | 14 + .../securitydomaintransferkey-example.json | 28 + ...securitydomainuploadoperation-example.json | 22 + .../7.5/examples/setStorageAccount.json | 42 + .../7.5/examples/setStorageSasDefinition.json | 34 + .../stable/7.5/examples/sign-example.json | 20 + .../7.5/examples/unwrapKey-example.json | 20 + .../7.5/examples/updateStorageAccount.json | 33 + .../examples/updateStorageSasDefinition.json | 34 + .../stable/7.5/examples/verify-example.json | 20 + .../stable/7.5/examples/wrapKey-example.json | 20 + .../Microsoft.KeyVault/stable/7.5/index.md | 26 + .../Microsoft.KeyVault/stable/7.5/keys.json | 2257 ++ .../Microsoft.KeyVault/stable/7.5/rbac.json | 923 + .../stable/7.5/secrets.json | 882 + .../stable/7.5/securitydomain.json | 364 + .../stable/7.5/settings.json | 214 + .../stable/7.5/storage.json | 1613 + specification/keyvault/data-plane/readme.md | 21 +- .../LiftrBase/main.tsp | 14 +- .../2023-08-01-preview/astronomer.json | 12 +- .../resource-manager/readme.go.md | 11 + .../resource-manager/readme.md | 42 +- .../resource-manager/readme.python.md | 19 + .../resource-manager/readme.typescript.md | 5 +- .../LoadTestService/models.tsp | 2 +- .../2023-04-01-preview/loadtestservice.json | 48 +- .../stable/2022-11-01/loadtestservice.json | 48 +- .../createOrUpdate.json | 123 + .../CapacityReservationGroup/delete.json | 12 + .../CapacityReservationGroup/get.json | 54 + .../CapacityReservationGroup/list.json | 60 + .../listBySubscription.json | 58 + .../CapacityReservationGroup/update.json | 70 + .../Compute/createOrUpdate/AKSCompute.json | 56 + .../Compute/createOrUpdate/AmlCompute.json | 86 + .../createOrUpdate/BasicAKSCompute.json | 44 + .../createOrUpdate/BasicAmlCompute.json | 60 + .../BasicDataFactoryCompute.json | 44 + .../createOrUpdate/ComputeInstance.json | 112 + .../ComputeInstanceMinimal.json | 47 + .../ComputeInstanceWithSchedules.json | 72 + .../createOrUpdate/KubernetesCompute.json | 123 + .../examples/Compute/delete.json | 20 + .../examples/Compute/get/AKSCompute.json | 27 + .../examples/Compute/get/AmlCompute.json | 56 + .../examples/Compute/get/ComputeInstance.json | 118 + .../Compute/get/KubernetesCompute.json | 54 + .../Compute/getAllowedVMSizesForResize.json | 255 + .../examples/Compute/list.json | 45 + .../examples/Compute/listKeys.json | 19 + .../examples/Compute/listNodes.json | 33 + .../examples/Compute/patch.json | 38 + .../examples/Compute/resize.json | 19 + .../examples/Compute/restart.json | 16 + .../examples/Compute/start.json | 16 + .../examples/Compute/stop.json | 16 + .../Compute/updateCustomServices.json | 47 + .../examples/Compute/updateDataMounts.json | 22 + .../Compute/updateIdleShutdownSetting.json | 15 + .../DataReference/getBlobReferenceSAS.json | 28 + .../AzureBlobWAccountKey/createOrUpdate.json | 103 + .../createOrUpdate.json | 104 + .../createOrUpdate.json | 113 + .../AzureFileWAccountKey/createOrUpdate.json | 101 + .../examples/Datastore/delete.json | 13 + .../examples/Datastore/get.json | 46 + .../examples/Datastore/list.json | 59 + .../examples/Datastore/listSecrets.json | 18 + .../examples/Endpoint/Deployment/create.json | 53 + .../examples/Endpoint/Deployment/delete.json | 18 + .../examples/Endpoint/Deployment/get.json | 37 + .../Endpoint/Deployment/getDeployments.json | 40 + .../Endpoint/Deployment/getInWorkspace.json | 39 + .../examples/Endpoint/create.json | 47 + .../examples/Endpoint/get.json | 35 + .../examples/Endpoint/getModels.json | 133 + .../examples/Endpoint/list.json | 41 + .../examples/Endpoint/listKeys.json | 19 + .../examples/Endpoint/regenerateKey.json | 20 + .../examples/ExternalFQDN/get.json | 46 + .../examples/Feature/get.json | 40 + .../examples/Feature/list.json | 48 + .../Job/AutoMLJob/createOrUpdate.json | 333 + .../examples/Job/AutoMLJob/get.json | 125 + .../examples/Job/AutoMLJob/list.json | 136 + .../Job/CommandJob/createOrUpdate.json | 333 + .../examples/Job/CommandJob/get.json | 125 + .../examples/Job/CommandJob/list.json | 136 + .../Job/FineTuningJob/createOrUpdate.json | 181 + .../examples/Job/FineTuningJob/get.json | 80 + .../examples/Job/FineTuningJob/list.json | 91 + .../Job/PipelineJob/createOrUpdate.json | 168 + .../examples/Job/PipelineJob/get.json | 69 + .../examples/Job/PipelineJob/list.json | 76 + .../examples/Job/SweepJob/createOrUpdate.json | 333 + .../examples/Job/SweepJob/get.json | 125 + .../examples/Job/SweepJob/list.json | 136 + .../examples/Job/cancel.json | 17 + .../examples/Job/delete.json | 18 + .../examples/Job/update.json | 154 + .../examples/LabelingJob/createOrUpdate.json | 242 + .../examples/LabelingJob/delete.json | 13 + .../examples/LabelingJob/exportLabels.json | 28 + .../examples/LabelingJob/get.json | 100 + .../examples/LabelingJob/list.json | 104 + .../examples/LabelingJob/pause.json | 113 + .../examples/LabelingJob/resume.json | 118 + .../ManagedNetwork/createOrUpdateRule.json | 38 + .../examples/ManagedNetwork/deleteRule.json | 18 + .../examples/ManagedNetwork/getRule.json | 25 + .../examples/ManagedNetwork/listRule.json | 39 + .../examples/ManagedNetwork/provision.json | 24 + .../examples/Notebook/listKeys.json | 16 + .../examples/Notebook/prepare.json | 25 + .../createOrUpdate.json | 244 + .../KubernetesOnlineDeployment/get.json | 96 + .../KubernetesOnlineDeployment/listSkus.json | 35 + .../KubernetesOnlineDeployment/update.json | 111 + .../createOrUpdate.json | 229 + .../ManagedOnlineDeployment/get.json | 91 + .../ManagedOnlineDeployment/listSkus.json | 35 + .../ManagedOnlineDeployment/update.json | 106 + .../examples/OnlineDeployment/getLogs.json | 21 + .../examples/OnlineDeployment/list.json | 103 + .../createOrUpdate.json | 38 + .../PrivateEndpointConnection/delete.json | 14 + .../PrivateEndpointConnection/get.json | 30 + .../PrivateEndpointConnection/list.json | 50 + .../examples/PrivateLinkResource/list.json | 28 + .../examples/Quota/list.json | 415 + .../examples/Quota/update.json | 45 + .../createOrUpdate-SystemCreated.json | 278 + .../createOrUpdate-UserCreated.json | 260 + .../examples/Registries/delete.json | 18 + .../Registries/get-SystemCreated.json | 106 + .../examples/Registries/get-UserCreated.json | 100 + .../Registries/list-SystemCreated.json | 110 + .../examples/Registries/list-UserCreated.json | 104 + .../Registries/listBySubscription.json | 109 + .../examples/Registries/removeRegions.json | 208 + .../Registries/update-SystemCreated.json | 122 + .../Registries/update-UserCreated.json | 116 + .../CodeContainer/createOrUpdate.json | 64 + .../Registry/CodeContainer/delete.json | 18 + .../examples/Registry/CodeContainer/get.json | 33 + .../examples/Registry/CodeContainer/list.json | 58 + .../createOrGetStartPendingUpload.json | 31 + .../Registry/CodeVersion/createOrUpdate.json | 79 + .../examples/Registry/CodeVersion/delete.json | 19 + .../examples/Registry/CodeVersion/get.json | 39 + .../examples/Registry/CodeVersion/list.json | 46 + .../ComponentContainer/createOrUpdate.json | 72 + .../Registry/ComponentContainer/delete.json | 18 + .../Registry/ComponentContainer/get.json | 36 + .../Registry/ComponentContainer/list.json | 42 + .../ComponentVersion/createOrUpdate.json | 85 + .../Registry/ComponentVersion/delete.json | 19 + .../Registry/ComponentVersion/get.json | 41 + .../Registry/ComponentVersion/list.json | 48 + .../DataContainer/createOrUpdate.json | 82 + .../Registry/DataContainer/delete.json | 18 + .../examples/Registry/DataContainer/get.json | 40 + .../Registry/DataContainer/registryList.json | 46 + .../createOrGetStartPendingUpload.json | 31 + .../DataVersionBase/createOrUpdate.json | 94 + .../Registry/DataVersionBase/delete.json | 19 + .../Registry/DataVersionBase/get.json | 44 + .../DataVersionBase/registryList.json | 53 + .../EnvironmentContainer/createOrUpdate.json | 82 + .../Registry/EnvironmentContainer/delete.json | 18 + .../Registry/EnvironmentContainer/get.json | 33 + .../Registry/EnvironmentContainer/list.json | 39 + .../EnvironmentVersion/createOrUpdate.json | 138 + .../Registry/EnvironmentVersion/delete.json | 19 + .../Registry/EnvironmentVersion/get.json | 59 + .../Registry/EnvironmentVersion/list.json | 66 + .../ModelContainer/createOrUpdate.json | 64 + .../Registry/ModelContainer/delete.json | 18 + .../examples/Registry/ModelContainer/get.json | 33 + .../Registry/ModelContainer/list.json | 38 + .../createOrGetStartPendingUpload.json | 31 + .../Registry/ModelVersion/createOrUpdate.json | 103 + .../Registry/ModelVersion/delete.json | 19 + .../examples/Registry/ModelVersion/get.json | 47 + .../examples/Registry/ModelVersion/list.json | 59 + .../Registry/ModelVersion/package.json | 93 + .../examples/Schedule/createOrUpdate.json | 119 + .../examples/Schedule/delete.json | 19 + .../examples/Schedule/get.json | 52 + .../examples/Schedule/list.json | 57 + .../examples/Schedule/trigger.json | 21 + .../examples/Usage/list.json | 400 + .../examples/VirtualMachineSize/list.json | 388 + .../BatchDeployment/createOrUpdate.json | 220 + .../Workspace/BatchDeployment/delete.json | 19 + .../Workspace/BatchDeployment/get.json | 88 + .../Workspace/BatchDeployment/list.json | 95 + .../Workspace/BatchDeployment/update.json | 101 + .../BatchEndpoint/createOrUpdate.json | 139 + .../Workspace/BatchEndpoint/delete.json | 18 + .../examples/Workspace/BatchEndpoint/get.json | 60 + .../Workspace/BatchEndpoint/list.json | 66 + .../Workspace/BatchEndpoint/listKeys.json | 18 + .../Workspace/BatchEndpoint/update.json | 77 + .../CodeContainer/createOrUpdate.json | 64 + .../Workspace/CodeContainer/delete.json | 13 + .../examples/Workspace/CodeContainer/get.json | 33 + .../Workspace/CodeContainer/list.json | 59 + .../createOrGetStartPendingUpload.json | 31 + .../Workspace/CodeVersion/createOrUpdate.json | 79 + .../Workspace/CodeVersion/delete.json | 14 + .../examples/Workspace/CodeVersion/get.json | 39 + .../examples/Workspace/CodeVersion/list.json | 46 + .../Workspace/CodeVersion/publish.json | 22 + .../ComponentContainer/createOrUpdate.json | 72 + .../Workspace/ComponentContainer/delete.json | 13 + .../Workspace/ComponentContainer/get.json | 36 + .../Workspace/ComponentContainer/list.json | 41 + .../ComponentVersion/createOrUpdate.json | 85 + .../Workspace/ComponentVersion/delete.json | 14 + .../Workspace/ComponentVersion/get.json | 41 + .../Workspace/ComponentVersion/list.json | 48 + .../Workspace/ComponentVersion/publish.json | 22 + .../DataContainer/createOrUpdate.json | 79 + .../Workspace/DataContainer/delete.json | 13 + .../examples/Workspace/DataContainer/get.json | 38 + .../Workspace/DataContainer/list.json | 68 + .../DataVersionBase/createOrUpdate.json | 82 + .../Workspace/DataVersionBase/delete.json | 14 + .../Workspace/DataVersionBase/get.json | 40 + .../Workspace/DataVersionBase/list.json | 48 + .../Workspace/DataVersionBase/publish.json | 22 + .../EnvironmentContainer/createOrUpdate.json | 82 + .../EnvironmentContainer/delete.json | 13 + .../Workspace/EnvironmentContainer/get.json | 33 + .../Workspace/EnvironmentContainer/list.json | 38 + .../EnvironmentVersion/createOrUpdate.json | 138 + .../Workspace/EnvironmentVersion/delete.json | 14 + .../Workspace/EnvironmentVersion/get.json | 59 + .../Workspace/EnvironmentVersion/list.json | 66 + .../Workspace/EnvironmentVersion/publish.json | 22 + .../FeaturesetContainer/createOrUpdate.json | 81 + .../Workspace/FeaturesetContainer/delete.json | 18 + .../FeaturesetContainer/getEntity.json | 40 + .../Workspace/FeaturesetContainer/list.json | 47 + .../Workspace/FeaturesetVersion/backfill.json | 47 + .../FeaturesetVersion/createOrUpdate.json | 219 + .../Workspace/FeaturesetVersion/delete.json | 19 + .../Workspace/FeaturesetVersion/get.json | 86 + .../Workspace/FeaturesetVersion/list.json | 93 + .../createOrUpdate.json | 81 + .../FeaturestoreEntityContainer/delete.json | 18 + .../getEntity.json | 40 + .../FeaturestoreEntityContainer/list.json | 47 + .../createOrUpdate.json | 99 + .../FeaturestoreEntityVersion/delete.json | 19 + .../FeaturestoreEntityVersion/get.json | 46 + .../FeaturestoreEntityVersion/list.json | 53 + .../InferenceEndpoint/createOrUpdate.json | 132 + .../Workspace/InferenceEndpoint/delete.json | 19 + .../Workspace/InferenceEndpoint/get.json | 59 + .../Workspace/InferenceEndpoint/list.json | 68 + .../Workspace/InferenceEndpoint/update.json | 67 + .../InferenceGroup/createOrUpdate.json | 133 + .../Workspace/InferenceGroup/delete.json | 19 + .../Workspace/InferenceGroup/get.json | 59 + .../Workspace/InferenceGroup/getStatus.json | 25 + .../Workspace/InferenceGroup/list.json | 68 + .../Workspace/InferenceGroup/listSkus.json | 35 + .../Workspace/InferenceGroup/update.json | 74 + .../InferencePool/createOrUpdate.json | 240 + .../Workspace/InferencePool/delete.json | 18 + .../examples/Workspace/InferencePool/get.json | 94 + .../Workspace/InferencePool/getStatus.json | 20 + .../Workspace/InferencePool/list.json | 103 + .../Workspace/InferencePool/listSkus.json | 34 + .../Workspace/InferencePool/update.json | 115 + .../createOrUpdate.json | 68 + .../MarketplaceSubscription/delete.json | 17 + .../MarketplaceSubscription/get.json | 37 + .../MarketplaceSubscription/list.json | 42 + .../ModelContainer/createOrUpdate.json | 64 + .../Workspace/ModelContainer/delete.json | 13 + .../Workspace/ModelContainer/get.json | 33 + .../Workspace/ModelContainer/list.json | 38 + .../ModelVersion/createOrUpdate.json | 103 + .../Workspace/ModelVersion/delete.json | 14 + .../examples/Workspace/ModelVersion/get.json | 47 + .../examples/Workspace/ModelVersion/list.json | 59 + .../Workspace/ModelVersion/package.json | 93 + .../Workspace/ModelVersion/publish.json | 22 + .../Workspace/OnlineDeployment/delete.json | 19 + .../OnlineEndpoint/createOrUpdate.json | 142 + .../Workspace/OnlineEndpoint/delete.json | 18 + .../Workspace/OnlineEndpoint/get.json | 62 + .../Workspace/OnlineEndpoint/getToken.json | 20 + .../Workspace/OnlineEndpoint/list.json | 73 + .../Workspace/OnlineEndpoint/listKeys.json | 18 + .../OnlineEndpoint/regenerateKeys.json | 22 + .../Workspace/OnlineEndpoint/update.json | 76 + .../ServerlessEndpoint/createOrUpdate.json | 150 + .../Workspace/ServerlessEndpoint/delete.json | 18 + .../Workspace/ServerlessEndpoint/get.json | 66 + .../ServerlessEndpoint/getStatus.json | 19 + .../Workspace/ServerlessEndpoint/list.json | 71 + .../ServerlessEndpoint/listKeys.json | 18 + .../ServerlessEndpoint/regenerateKeys.json | 27 + .../Workspace/ServerlessEndpoint/update.json | 87 + .../examples/Workspace/create.json | 109 + .../examples/Workspace/delete.json | 17 + .../examples/Workspace/diagnose.json | 49 + .../examples/Workspace/get.json | 100 + .../Workspace/listByResourceGroup.json | 46 + .../Workspace/listBySubscription.json | 45 + .../examples/Workspace/listKeys.json | 35 + .../Workspace/listNotebookAccessToken.json | 20 + .../Workspace/listStorageAccountKeys.json | 15 + .../examples/Workspace/operationsList.json | 37 + .../examples/Workspace/resyncKeys.json | 16 + .../examples/Workspace/update.json | 45 + .../examples/WorkspaceConnection/create.json | 32 + .../examples/WorkspaceConnection/delete.json | 13 + .../examples/WorkspaceConnection/get.json | 24 + .../examples/WorkspaceConnection/list.json | 39 + .../WorkspaceConnection/listSecrets.json | 38 + .../WorkspaceConnection/testConnection.json | 24 + .../examples/WorkspaceConnection/update.json | 47 + .../examples/WorkspaceFeature/list.json | 26 + .../machineLearningServices.json | 4184 ++ .../preview/2024-01-01-preview/mfe.json | 31068 ++++++++++++++ .../2024-01-01-preview/registries.json | 909 + .../2024-01-01-preview/workspaceFeatures.json | 114 + .../2024-01-01-preview/workspaceRP.json | 5253 +++ .../stable/2023-10-01/mfe.json | 2 +- .../resource-manager/readme.md | 62 +- .../Spatial_EvaluatePointInPolygon.json | 31 - .../examples/spatial/Spatial_GetBuffer.json | 170 - .../spatial/Spatial_GetClosestPoint.json | 34 - .../examples/spatial/Spatial_GetGeofence.json | 47 - .../Spatial_GetGreatCircleDistance.json | 27 - .../examples/spatial/Spatial_PostBuffer.json | 191 - .../spatial/Spatial_PostClosestPoint.json | 77 - .../spatial/Spatial_PostGeofence.json | 133 - .../spatial/Spatial_PostPointInPolygon.json | 63 - .../Creator/preview/1.0/spatial.json | 902 - .../data-plane/Creator/preview/2.0/alias.json | 14 +- .../data-plane/Creator/preview/2.0/data.json | 18 +- .../Creator/preview/2.0/dataset.json | 14 +- .../Creator/preview/2.0/dwgconversion.json | 18 +- .../2.0/examples/wfs/WFS_GetFeatures.json | 7 +- .../Creator/preview/2.0/featurestate.json | 22 +- .../Creator/preview/2.0/tileset.json | 14 +- .../data-plane/Creator/preview/2.0/wfs.json | 20 +- .../preview/2022-09-01-preview/tileset.json | 8 +- .../preview/2023-03-01-preview/alias.json | 10 +- .../preview/2023-03-01-preview/dataset.json | 10 +- .../2023-03-01-preview/dwgconversion.json | 20 +- .../preview/2023-03-01-preview/features.json | 24 +- .../2023-03-01-preview/featurestate.json | 18 +- .../2023-03-01-preview/mapconfiguration.json | 10 +- .../preview/2023-03-01-preview/style.json | 8 +- .../preview/2023-03-01-preview/tileset.json | 22 +- .../maps/data-plane/Creator/readme.md | 2 + .../Creator/stable/2023-07-01/features.json | 24 +- .../Creator/stable/2023-07-01/tileset.json | 8 +- .../stable/2023-06-01/dataregistry.json | 8 +- .../Geolocation/preview/1.0/geolocation.json | 2 +- .../Microsoft.Maps/Data/preview/1.0/data.json | 18 +- .../Microsoft.Maps/Data/preview/2.0/data.json | 18 +- .../Render/preview/2.0/render.json | 2 +- .../Render/preview/2.1/render.json | 2 +- .../Tileset/preview/2.0/tileset.json | 2 +- .../SuccessfulWorldCopyrightRequest.json | 2 +- .../data-plane/Render/preview/1.0/render.json | 36 +- .../data-plane/Render/preview/2.0/render.json | 2 +- .../examples/Render_GetCopyrightForWorld.json | 2 +- .../Render/stable/2022-08-01/render.json | 20 +- .../data-plane/Route/preview/1.0/route.json | 18 +- .../preview/2023-10-01-preview/route.json | 8 +- .../data-plane/Search/preview/1.0/search.json | 68 +- .../Search/stable/2023-06-01/search.json | 14 +- .../Spatial/stable/2022-08-01/spatial.json | 24 +- .../1.0/examples/GetTimezoneEnumIANA.json | 12 +- .../Timezone/preview/1.0/timezone.json | 12 +- .../Traffic/preview/1.0/traffic.json | 10 +- .../Weather/stable/1.1/weather.json | 36 +- specification/maps/data-plane/readme.md | 25 +- ...smentOperations_Create_MaximumSet_Gen.json | 146 + ...smentOperations_Delete_MaximumSet_Gen.json | 15 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 25 + ...sessmentOperations_Get_MaximumSet_Gen.json | 65 + ...istByAssessmentProject_MaximumSet_Gen.json | 73 + ...sClusterOperations_Get_MaximumSet_Gen.json | 54 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 59 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 47 + ...sOptionsOperations_Get_MaximumSet_Gen.json | 38 + ...istByAssessmentProject_MaximumSet_Gen.json | 42 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 63 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 67 + ...MachinesOperations_Get_MaximumSet_Gen.json | 129 + ...tions_ListByAssessment_MaximumSet_Gen.json | 137 + ...tabaseV2Operations_Get_MaximumSet_Gen.json | 225 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 233 + ...stanceV2Operations_Get_MaximumSet_Gen.json | 474 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 505 + ...MachinesOperations_Get_MaximumSet_Gen.json | 155 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 163 + ...edEntityOperations_Get_MaximumSet_Gen.json | 330 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 330 + ...WebAppV2Operations_Get_MaximumSet_Gen.json | 63 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 71 + ...licationOperations_Get_MaximumSet_Gen.json | 73 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 81 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 3079 ++ ...istByAssessmentProject_MaximumSet_Gen.json | 3083 ++ ...tSummaryOperations_Get_MaximumSet_Gen.json | 46 + ...istByAssessmentProject_MaximumSet_Gen.json | 50 + ...jectsOperations_Create_MaximumSet_Gen.json | 144 + ...jectsOperations_Delete_MaximumSet_Gen.json | 14 + ...ProjectsOperations_Get_MaximumSet_Gen.json | 69 + ...ns_ListByResourceGroup_MaximumSet_Gen.json | 73 + ...ons_ListBySubscription_MaximumSet_Gen.json | 72 + ...jectsOperations_Update_MaximumSet_Gen.json | 88 + ...mentsOperations_Create_MaximumSet_Gen.json | 236 + ...mentsOperations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...essmentsOperations_Get_MaximumSet_Gen.json | 103 + ...Operations_ListByGroup_MaximumSet_Gen.json | 107 + ...MachinesOperations_Get_MaximumSet_Gen.json | 78 + ...ns_ListByAvsAssessment_MaximumSet_Gen.json | 86 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 144 + ...istByAssessmentProject_MaximumSet_Gen.json | 148 + ...mentsOperations_Create_MaximumSet_Gen.json | 165 + ...mentsOperations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...essmentsOperations_Get_MaximumSet_Gen.json | 74 + ...Operations_ListByGroup_MaximumSet_Gen.json | 78 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 244 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 248 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 291 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 295 + ...rations_CompareSummary_MaximumSet_Gen.json | 185 + ...sCaseOperations_Create_MaximumSet_Gen.json | 392 + ...sCaseOperations_Delete_MaximumSet_Gen.json | 15 + ...s_GetReportDownloadUrl_MaximumSet_Gen.json | 25 + ...nessCaseOperations_Get_MaximumSet_Gen.json | 145 + ...istByAssessmentProject_MaximumSet_Gen.json | 149 + ...wSummaryOperations_Get_MaximumSet_Gen.json | 122 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 126 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 252 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 256 + ...MachinesOperations_Get_MaximumSet_Gen.json | 40 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 48 + ...MachinesOperations_Get_MaximumSet_Gen.json | 40 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 48 + ...EntitiesOperations_Get_MaximumSet_Gen.json | 41 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 49 + ...dWebAppsOperations_Get_MaximumSet_Gen.json | 38 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 46 + ...roupsOperations_Create_MaximumSet_Gen.json | 85 + ...roupsOperations_Delete_MaximumSet_Gen.json | 15 + .../GroupsOperations_Get_MaximumSet_Gen.json | 44 + ...istByAssessmentProject_MaximumSet_Gen.json | 48 + ...rations_UpdateMachines_MaximumSet_Gen.json | 58 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...ctorsOperations_Create_MaximumSet_Gen.json | 62 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 33 + ...istByAssessmentProject_MaximumSet_Gen.json | 37 + ...MachinesOperations_Get_MaximumSet_Gen.json | 89 + ...istByAssessmentProject_MaximumSet_Gen.json | 97 + .../Operations_List_MaximumSet_Gen.json | 28 + ...ctionOperations_Delete_MaximumSet_Gen.json | 15 + ...nnectionOperations_Get_MaximumSet_Gen.json | 39 + ...istByAssessmentProject_MaximumSet_Gen.json | 43 + ...ctionOperations_Update_MaximumSet_Gen.json | 76 + ...ResourceOperations_Get_MaximumSet_Gen.json | 37 + ...istByAssessmentProject_MaximumSet_Gen.json | 41 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 1635 + ...istByAssessmentProject_MaximumSet_Gen.json | 1639 + ...entV2Operations_Create_MaximumSet_Gen.json | 219 + ...entV2Operations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...ssmentV2Operations_Get_MaximumSet_Gen.json | 94 + ...Operations_ListByGroup_MaximumSet_Gen.json | 254 + ...2SummaryOperations_Get_MaximumSet_Gen.json | 128 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 132 + ...ectorOperations_Create_MaximumSet_Gen.json | 97 + ...ectorOperations_Delete_MaximumSet_Gen.json | 15 + ...ollectorOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 56 + ...istByAssessmentProject_MaximumSet_Gen.json | 60 + ...entV2Operations_Create_MaximumSet_Gen.json | 167 + ...entV2Operations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...ssmentV2Operations_Get_MaximumSet_Gen.json | 70 + ...Operations_ListByGroup_MaximumSet_Gen.json | 74 + ...2SummaryOperations_Get_MaximumSet_Gen.json | 61 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 65 + ...ectorOperations_Create_MaximumSet_Gen.json | 99 + ...ectorOperations_Delete_MaximumSet_Gen.json | 15 + ...ollectorOperations_Get_MaximumSet_Gen.json | 46 + ...istByAssessmentProject_MaximumSet_Gen.json | 50 + ...cePlanV2Operations_Get_MaximumSet_Gen.json | 52 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 60 + .../preview/2023-04-01-preview/migrate.json | 24317 +++++++++++ ...ler_ClientGroupMembers_MaximumSet_Gen.json | 35 + ...ler_ExportDependencies_MaximumSet_Gen.json | 24 + ...ller_GenerateCoarseMap_MaximumSet_Gen.json | 32 + ...er_GenerateDetailedMap_MaximumSet_Gen.json | 33 + ...ler_ServerGroupMembers_MaximumSet_Gen.json | 33 + ...ntroller_CreateCluster_MaximumSet_Gen.json | 118 + ...usterController_Delete_MaximumSet_Gen.json | 15 + ...rController_GetCluster_MaximumSet_Gen.json | 59 + ...oller_ListByHypervSite_MaximumSet_Gen.json | 64 + ...ler_ClientGroupMembers_MaximumSet_Gen.json | 35 + ...ler_ExportDependencies_MaximumSet_Gen.json | 24 + ...ller_GenerateCoarseMap_MaximumSet_Gen.json | 32 + ...er_GenerateDetailedMap_MaximumSet_Gen.json | 33 + ...ler_ServerGroupMembers_MaximumSet_Gen.json | 33 + ...ateDependencyMapStatus_MaximumSet_Gen.json | 28 + ...vHostController_Create_MaximumSet_Gen.json | 107 + ...vHostController_Delete_MaximumSet_Gen.json | 20 + ...pervHostController_Get_MaximumSet_Gen.json | 55 + ...oller_ListByHypervSite_MaximumSet_Gen.json | 60 + ...pervJobsController_Get_MaximumSet_Gen.json | 51 + ...oller_ListByVmwareSite_MaximumSet_Gen.json | 55 + .../HypervJobs_Get_MaximumSet_Gen.json | 51 + ...vJobs_ListByHypervSite_MaximumSet_Gen.json | 55 + ...MachinesController_Get_MaximumSet_Gen.json | 324 + ...oller_ListByHypervSite_MaximumSet_Gen.json | 332 + ...oller_UpdateProperties_MaximumSet_Gen.json | 31 + ...hinesController_Update_MaximumSet_Gen.json | 350 + ...HypervOperationsStatus_MaximumSet_Gen.json | 29 + ...AccountsController_Get_MaximumSet_Gen.json | 36 + ...oller_ListByHypervSite_MaximumSet_Gen.json | 40 + ...er_ComputeErrorSummary_MaximumSet_Gen.json | 24 + ...ontroller_Computeusage_MaximumSet_Gen.json | 21 + ...SitesController_Create_MaximumSet_Gen.json | 117 + ...SitesController_Delete_MaximumSet_Gen.json | 14 + ...ler_ExportApplications_MaximumSet_Gen.json | 21 + ...er_ExportMachineErrors_MaximumSet_Gen.json | 25 + ...ervSitesController_Get_MaximumSet_Gen.json | 53 + ...ller_ListHealthSummary_MaximumSet_Gen.json | 37 + ...itesController_Summary_MaximumSet_Gen.json | 20 + ...SitesController_Update_MaximumSet_Gen.json | 75 + ...es_ListByResourceGroup_MaximumSet_Gen.json | 57 + ...tes_ListBySubscription_MaximumSet_Gen.json | 56 + ...chineSoftwareInventory_MaximumSet_Gen.json | 113 + ...er_ListByHypervMachine_MaximumSet_Gen.json | 117 + ...icationsController_Get_MaximumSet_Gen.json | 145 + ...oller_ListByWebAppSite_MaximumSet_Gen.json | 153 + ...tionsController_Update_MaximumSet_Gen.json | 152 + ...bServersController_Get_MaximumSet_Gen.json | 70 + ...oller_ListByWebAppSite_MaximumSet_Gen.json | 78 + ...ontroller_GetDeletejob_MaximumSet_Gen.json | 43 + ...ontroller_GetExportjob_MaximumSet_Gen.json | 28 + ...ontroller_GetImportjob_MaximumSet_Gen.json | 38 + ...portJobsController_Get_MaximumSet_Gen.json | 51 + ...oller_ListByImportSite_MaximumSet_Gen.json | 55 + ...troller_ListDeletejobs_MaximumSet_Gen.json | 47 + ...troller_ListExportjobs_MaximumSet_Gen.json | 32 + ...troller_ListImportjobs_MaximumSet_Gen.json | 42 + ...hinesController_Delete_MaximumSet_Gen.json | 15 + ...MachinesController_Get_MaximumSet_Gen.json | 83 + ...oller_ListByImportSite_MaximumSet_Gen.json | 91 + ...SitesController_Create_MaximumSet_Gen.json | 72 + ...DeleteImportedMachines_MaximumSet_Gen.json | 20 + ...SitesController_Delete_MaximumSet_Gen.json | 14 + ...esController_ExportUri_MaximumSet_Gen.json | 24 + ...ortSitesController_Get_MaximumSet_Gen.json | 37 + ...esController_ImportUri_MaximumSet_Gen.json | 24 + ...er_ListByResourceGroup_MaximumSet_Gen.json | 41 + ...ler_ListBySubscription_MaximumSet_Gen.json | 40 + ...SitesController_Update_MaximumSet_Gen.json | 46 + ...MachinesController_Get_MaximumSet_Gen.json | 323 + ...oller_ListByVmwareSite_MaximumSet_Gen.json | 331 + ...chinesController_Start_MaximumSet_Gen.json | 21 + ...achinesController_Stop_MaximumSet_Gen.json | 21 + ...hinesController_Update_MaximumSet_Gen.json | 349 + ...SitesController_Create_MaximumSet_Gen.json | 150 + ...SitesController_Delete_MaximumSet_Gen.json | 14 + ...ontroller_ErrorSummary_MaximumSet_Gen.json | 26 + ...terSitesController_Get_MaximumSet_Gen.json | 72 + ...er_ListByResourceGroup_MaximumSet_Gen.json | 76 + ...ler_ListBySubscription_MaximumSet_Gen.json | 75 + ...SitesController_Update_MaximumSet_Gen.json | 90 + ...tVmwareOperationStatus_MaximumSet_Gen.json | 29 + .../Operations_List_MaximumSet_Gen.json | 28 + ...ctionController_Create_MaximumSet_Gen.json | 82 + ...ctionController_Delete_MaximumSet_Gen.json | 15 + ...nnectionController_Get_MaximumSet_Gen.json | 42 + ...oller_ListByMasterSite_MaximumSet_Gen.json | 46 + ...esourcesController_Get_MaximumSet_Gen.json | 38 + ...oller_ListByMasterSite_MaximumSet_Gen.json | 42 + ...AccountsController_Get_MaximumSet_Gen.json | 36 + ...oller_ListByVmwareSite_MaximumSet_Gen.json | 40 + ...ler_ClientGroupMembers_MaximumSet_Gen.json | 35 + ...ler_ExportDependencies_MaximumSet_Gen.json | 24 + ...ller_GenerateCoarseMap_MaximumSet_Gen.json | 32 + ...er_GenerateDetailedMap_MaximumSet_Gen.json | 33 + ...ler_ServerGroupMembers_MaximumSet_Gen.json | 33 + ...rverJobsController_Get_MaximumSet_Gen.json | 51 + ...stByServerSiteResource_MaximumSet_Gen.json | 55 + ...erSiteOperationsStatus_MaximumSet_Gen.json | 29 + ...AccountsController_Get_MaximumSet_Gen.json | 36 + ...stByServerSiteResource_MaximumSet_Gen.json | 40 + ...er_ComputeErrorSummary_MaximumSet_Gen.json | 24 + ...ontroller_Computeusage_MaximumSet_Gen.json | 19 + ...SitesController_Create_MaximumSet_Gen.json | 120 + ...SitesController_Delete_MaximumSet_Gen.json | 14 + ...ler_ExportApplications_MaximumSet_Gen.json | 21 + ...er_ExportMachineErrors_MaximumSet_Gen.json | 25 + ...verSitesController_Get_MaximumSet_Gen.json | 53 + ...er_ListByResourceGroup_MaximumSet_Gen.json | 57 + ...ler_ListBySubscription_MaximumSet_Gen.json | 56 + ...ller_ListHealthSummary_MaximumSet_Gen.json | 37 + ...Controller_RefreshSite_MaximumSet_Gen.json | 20 + ...itesController_Summary_MaximumSet_Gen.json | 18 + ...ateDependencyMapStatus_MaximumSet_Gen.json | 28 + ...oller_UpdateProperties_MaximumSet_Gen.json | 31 + ...SitesController_Update_MaximumSet_Gen.json | 74 + ...chineSoftwareInventory_MaximumSet_Gen.json | 113 + ...ontroller_ListByServer_MaximumSet_Gen.json | 117 + ...ntroller_DeleteMachine_MaximumSet_Gen.json | 15 + ...sController_GetMachine_MaximumSet_Gen.json | 305 + ...stByServerSiteResource_MaximumSet_Gen.json | 313 + ...ntroller_UpdateMachine_MaximumSet_Gen.json | 354 + ...er_ComputeErrorSummary_MaximumSet_Gen.json | 24 + ...ontroller_Computeusage_MaximumSet_Gen.json | 20 + ...SitesController_Create_MaximumSet_Gen.json | 119 + ...SitesController_Delete_MaximumSet_Gen.json | 14 + ...ler_ExportApplications_MaximumSet_Gen.json | 21 + ...er_ExportMachineErrors_MaximumSet_Gen.json | 25 + ...troller_ExportMachines_MaximumSet_Gen.json | 23 + .../SitesController_Get_MaximumSet_Gen.json | 54 + ...er_ListByResourceGroup_MaximumSet_Gen.json | 58 + ...ler_ListBySubscription_MaximumSet_Gen.json | 57 + ...ller_ListHealthSummary_MaximumSet_Gen.json | 37 + ...itesController_Summary_MaximumSet_Gen.json | 19 + ...SitesController_Update_MaximumSet_Gen.json | 76 + ...tyGroupsController_Get_MaximumSet_Gen.json | 70 + ...ntroller_ListBySqlSite_MaximumSet_Gen.json | 78 + ...atabasesController_Get_MaximumSet_Gen.json | 77 + ...ntroller_ListBySqlSite_MaximumSet_Gen.json | 85 + ...ourceController_Create_MaximumSet_Gen.json | 61 + ...ourceController_Delete_MaximumSet_Gen.json | 16 + ...taSourceController_Get_MaximumSet_Gen.json | 33 + ...ntroller_ListBySqlSite_MaximumSet_Gen.json | 37 + .../SqlJobsController_Get_MaximumSet_Gen.json | 52 + ...ntroller_ListBySqlSite_MaximumSet_Gen.json | 56 + ..._GetSqlOperationStatus_MaximumSet_Gen.json | 30 + ...AccountsController_Get_MaximumSet_Gen.json | 37 + ...ntroller_ListBySqlSite_MaximumSet_Gen.json | 41 + ...lServersController_Get_MaximumSet_Gen.json | 102 + ...ntroller_ListBySqlSite_MaximumSet_Gen.json | 110 + ...rversController_Update_MaximumSet_Gen.json | 148 + ...SitesController_Create_MaximumSet_Gen.json | 116 + ...SitesController_Delete_MaximumSet_Gen.json | 15 + ...ontroller_ErrorSummary_MaximumSet_Gen.json | 27 + ..._ExportSqlServerErrors_MaximumSet_Gen.json | 22 + ...oller_ExportSqlServers_MaximumSet_Gen.json | 25 + ...SqlSitesController_Get_MaximumSet_Gen.json | 53 + ...oller_ListByMasterSite_MaximumSet_Gen.json | 57 + ...itesController_Refresh_MaximumSet_Gen.json | 24 + ...itesController_Summary_MaximumSet_Gen.json | 20 + ...SitesController_Update_MaximumSet_Gen.json | 80 + ...icationsController_Get_MaximumSet_Gen.json | 114 + ...oller_ListByWebAppSite_MaximumSet_Gen.json | 122 + ...tionsController_Update_MaximumSet_Gen.json | 115 + ...bServersController_Get_MaximumSet_Gen.json | 111 + ...oller_ListByWebAppSite_MaximumSet_Gen.json | 119 + ...enterController_Create_MaximumSet_Gen.json | 117 + ...enterController_Delete_MaximumSet_Gen.json | 15 + .../VcenterController_Get_MaximumSet_Gen.json | 59 + ...oller_ListByVmwareSite_MaximumSet_Gen.json | 64 + ...wareHostController_Get_MaximumSet_Gen.json | 47 + ...oller_ListByVmwareSite_MaximumSet_Gen.json | 51 + ...tVmwareOperationStatus_MaximumSet_Gen.json | 29 + ...ateDependencyMapStatus_MaximumSet_Gen.json | 28 + ...oller_UpdateProperties_MaximumSet_Gen.json | 31 + ...ler_UpdateRunAsAccount_MaximumSet_Gen.json | 28 + ...sController_UpdateTags_MaximumSet_Gen.json | 30 + ...chineSoftwareInventory_MaximumSet_Gen.json | 113 + ..._ListByMachineResource_MaximumSet_Gen.json | 117 + ...urcesController_Create_MaximumSet_Gen.json | 61 + ...urcesController_Delete_MaximumSet_Gen.json | 21 + ...aSourcesController_Get_MaximumSet_Gen.json | 33 + ...oller_ListByWebAppSite_MaximumSet_Gen.json | 37 + ...MachinesController_Get_MaximumSet_Gen.json | 59 + ...oller_ListByWebAppSite_MaximumSet_Gen.json | 67 + ...oller_UpdateProperties_MaximumSet_Gen.json | 31 + ...AccountsController_Get_MaximumSet_Gen.json | 37 + ...oller_ListByWebAppSite_MaximumSet_Gen.json | 41 + ...SitesController_Create_MaximumSet_Gen.json | 116 + ...SitesController_Delete_MaximumSet_Gen.json | 20 + ...ontroller_ErrorSummary_MaximumSet_Gen.json | 27 + ...roller_ExportInventory_MaximumSet_Gen.json | 24 + ...AppSitesController_Get_MaximumSet_Gen.json | 53 + ...oller_ListByMasterSite_MaximumSet_Gen.json | 57 + ...itesController_Refresh_MaximumSet_Gen.json | 24 + ...itesController_Summary_MaximumSet_Gen.json | 20 + ...SitesController_Update_MaximumSet_Gen.json | 80 + ...oller_ListByWebAppSite_MaximumSet_Gen.json | 120 + ...oller_ListByWebAppSite_MaximumSet_Gen.json | 78 + .../preview/2023-10-01-preview/migrate.json | 22265 ++++++++++ .../migrate/resource-manager/readme.md | 48 +- .../amfdeployment.tsp | 69 + .../clusterservice.tsp | 92 + .../MobilePacketCore.Management/common.tsp | 179 + .../AmfDeployment_CreateOrUpdate.json | 72 + .../AmfDeployment_Delete.json | 19 + .../2023-10-15-preview/AmfDeployment_Get.json | 38 + .../AmfDeployment_ListByResourceGroup.json | 41 + .../AmfDeployment_ListBySubscription.json | 41 + .../AmfDeployment_UpdateTags.json | 44 + .../ClusterService_CreateOrUpdate.json | 98 + .../ClusterService_Delete.json | 19 + .../ClusterService_Get.json | 46 + .../ClusterService_ListByResourceGroup.json | 49 + .../ClusterService_ListBySubscription.json | 49 + .../ClusterService_UpdateTags.json | 52 + .../NrfDeployment_CreateOrUpdate.json | 72 + .../NrfDeployment_Delete.json | 19 + .../2023-10-15-preview/NrfDeployment_Get.json | 38 + .../NrfDeployment_ListByResourceGroup.json | 41 + .../NrfDeployment_ListBySubscription.json | 41 + .../NrfDeployment_UpdateTags.json | 44 + .../NssfDeployment_CreateOrUpdate.json | 72 + .../NssfDeployment_Delete.json | 19 + .../NssfDeployment_Get.json | 38 + .../NssfDeployment_ListByResourceGroup.json | 41 + .../NssfDeployment_ListBySubscription.json | 41 + .../NssfDeployment_UpdateTags.json | 44 + .../ObservabilityService_CreateOrUpdate.json | 85 + .../ObservabilityService_Delete.json | 19 + .../ObservabilityService_Get.json | 42 + ...ervabilityService_ListByResourceGroup.json | 45 + ...servabilityService_ListBySubscription.json | 45 + .../ObservabilityService_UpdateTags.json | 48 + .../2023-10-15-preview/OperationList.json | 25 + .../SmfDeployment_CreateOrUpdate.json | 72 + .../SmfDeployment_Delete.json | 19 + .../2023-10-15-preview/SmfDeployment_Get.json | 38 + .../SmfDeployment_ListByResourceGroup.json | 41 + .../SmfDeployment_ListBySubscription.json | 41 + .../SmfDeployment_UpdateTags.json | 44 + .../UpfDeployment_CreateOrUpdate.json | 72 + .../UpfDeployment_Delete.json | 19 + .../2023-10-15-preview/UpfDeployment_Get.json | 38 + .../UpfDeployment_ListByResourceGroup.json | 41 + .../UpfDeployment_ListBySubscription.json | 41 + .../UpfDeployment_UpdateTags.json | 44 + .../MobilePacketCore.Management/main.tsp | 37 + .../nrfdeployment.tsp | 69 + .../nssfdeployment.tsp | 69 + .../observabilityservice.tsp | 66 + .../smfdeployment.tsp | 69 + .../tspconfig.yaml | 15 + .../upfdeployment.tsp | 69 + .../AmfDeployment_CreateOrUpdate.json | 72 + .../examples/AmfDeployment_Delete.json | 19 + .../examples/AmfDeployment_Get.json | 38 + .../AmfDeployment_ListByResourceGroup.json | 41 + .../AmfDeployment_ListBySubscription.json | 41 + .../examples/AmfDeployment_UpdateTags.json | 44 + .../ClusterService_CreateOrUpdate.json | 98 + .../examples/ClusterService_Delete.json | 19 + .../examples/ClusterService_Get.json | 46 + .../ClusterService_ListByResourceGroup.json | 49 + .../ClusterService_ListBySubscription.json | 49 + .../examples/ClusterService_UpdateTags.json | 52 + .../NrfDeployment_CreateOrUpdate.json | 72 + .../examples/NrfDeployment_Delete.json | 19 + .../examples/NrfDeployment_Get.json | 38 + .../NrfDeployment_ListByResourceGroup.json | 41 + .../NrfDeployment_ListBySubscription.json | 41 + .../examples/NrfDeployment_UpdateTags.json | 44 + .../NssfDeployment_CreateOrUpdate.json | 72 + .../examples/NssfDeployment_Delete.json | 19 + .../examples/NssfDeployment_Get.json | 38 + .../NssfDeployment_ListByResourceGroup.json | 41 + .../NssfDeployment_ListBySubscription.json | 41 + .../examples/NssfDeployment_UpdateTags.json | 44 + .../ObservabilityService_CreateOrUpdate.json | 85 + .../examples/ObservabilityService_Delete.json | 19 + .../examples/ObservabilityService_Get.json | 42 + ...ervabilityService_ListByResourceGroup.json | 45 + ...servabilityService_ListBySubscription.json | 45 + .../ObservabilityService_UpdateTags.json | 48 + .../examples/OperationList.json | 25 + .../SmfDeployment_CreateOrUpdate.json | 72 + .../examples/SmfDeployment_Delete.json | 19 + .../examples/SmfDeployment_Get.json | 38 + .../SmfDeployment_ListByResourceGroup.json | 41 + .../SmfDeployment_ListBySubscription.json | 41 + .../examples/SmfDeployment_UpdateTags.json | 44 + .../UpfDeployment_CreateOrUpdate.json | 72 + .../examples/UpfDeployment_Delete.json | 19 + .../examples/UpfDeployment_Get.json | 38 + .../UpfDeployment_ListByResourceGroup.json | 41 + .../UpfDeployment_ListBySubscription.json | 41 + .../examples/UpfDeployment_UpdateTags.json | 44 + .../2023-10-15-preview/mobilepacketcore.json | 3341 ++ .../resource-manager/readme.csharp.md | 15 + .../resource-manager/readme.go.md | 20 + .../resource-manager/readme.md | 77 + .../resource-manager/readme.python.md | 21 + .../resource-manager/readme.ruby.md | 19 + .../resource-manager/readme.typescript.md | 13 + .../networkfunction.tsp | 77 +- .../2023-05-15-preview/networkfunction.json | 14 +- .../examples/NspLinkPut.json | 8 +- .../networkSecurityPerimeter.json | 12 +- .../examples/NspLinkPut.json | 8 +- .../networkSecurityPerimeter.json | 12 +- .../stable/2023-05-01/azureFirewall.json | 9 +- .../examples/AzureFirewallDelete.json | 6 +- .../2023-05-01/examples/AzureFirewallGet.json | 3 + ...reFirewallGetWithAdditionalProperties.json | 3 + .../AzureFirewallGetWithIpGroups.json | 3 + .../AzureFirewallGetWithMgmtSubnet.json | 3 + .../examples/AzureFirewallGetWithZones.json | 3 + .../AzureFirewallListByResourceGroup.json | 3 + .../AzureFirewallListBySubscription.json | 3 + .../AzureFirewallListLearnedIPPrefixes.json | 6 +- .../2023-05-01/examples/AzureFirewallPut.json | 6 + ...reFirewallPutWithAdditionalProperties.json | 6 + .../AzureFirewallPutWithIpGroups.json | 6 + .../AzureFirewallPutWithMgmtSubnet.json | 6 + .../examples/AzureFirewallPutWithZones.json | 7 + .../examples/AzureFirewallUpdateTags.json | 6 +- .../2023-05-01/examples/IpGroupsDelete.json | 6 +- .../examples/VirtualRouterDelete.json | 6 +- .../examples/VirtualRouterPeeringDelete.json | 6 +- .../network/resource-manager/readme.python.md | 13 +- .../NetworkAnalytics.Management/main.tsp | 62 +- .../stable/2023-11-15/networkanalytics.json | 34 +- .../resource-manager/readme.md | 4 + .../preview/2024-01-01-preview/NewRelic.json | 3432 ++ .../Accounts_List_MaximumSet_Gen.json | 28 + .../Accounts_List_MinimumSet_Gen.json | 21 + .../examples/BillingInfo_Get.json | 25 + .../ConnectedPartnerResources_List.json | 24 + .../examples/LinkedResources_List.json | 19 + ...MonitoredSubscriptions_CreateorUpdate.json | 214 + .../MonitoredSubscriptions_Delete.json | 17 + .../examples/MonitoredSubscriptions_Get.json | 80 + .../examples/MonitoredSubscriptions_List.json | 84 + .../MonitoredSubscriptions_Update.json | 150 + ...onitors_CreateOrUpdate_MaximumSet_Gen.json | 209 + .../Monitors_Delete_MaximumSet_Gen.json | 20 + .../Monitors_Delete_MinimumSet_Gen.json | 20 + ...onitors_GetMetricRules_MaximumSet_Gen.json | 28 + ...onitors_GetMetricRules_MinimumSet_Gen.json | 22 + ...nitors_GetMetricStatus_MaximumSet_Gen.json | 25 + ...nitors_GetMetricStatus_MinimumSet_Gen.json | 23 + .../examples/Monitors_Get_MaximumSet_Gen.json | 81 + ...nitors_ListAppServices_MaximumSet_Gen.json | 30 + ...nitors_ListAppServices_MinimumSet_Gen.json | 24 + ...rs_ListByResourceGroup_MaximumSet_Gen.json | 85 + ...ors_ListBySubscription_MaximumSet_Gen.json | 84 + .../Monitors_ListHosts_MaximumSet_Gen.json | 30 + .../Monitors_ListHosts_MinimumSet_Gen.json | 24 + ...ListMonitoredResources_MaximumSet_Gen.json | 26 + ...ListMonitoredResources_MinimumSet_Gen.json | 18 + ...Monitors_SwitchBilling_MaximumSet_Gen.json | 98 + ...Monitors_SwitchBilling_MinimumSet_Gen.json | 90 + .../Monitors_Update_MaximumSet_Gen.json | 126 + ...Monitors_VmHostPayload_MaximumSet_Gen.json | 17 + ...Monitors_VmHostPayload_MinimumSet_Gen.json | 17 + .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + .../Organizations_List_MaximumSet_Gen.json | 27 + .../Organizations_List_MinimumSet_Gen.json | 17 + .../examples/Plans_List_MaximumSet_Gen.json | 32 + .../examples/Plans_List_MinimumSet_Gen.json | 23 + ...agRules_CreateOrUpdate_MaximumSet_Gen.json | 121 + ...agRules_CreateOrUpdate_MinimumSet_Gen.json | 31 + .../TagRules_Delete_MaximumSet_Gen.json | 20 + .../TagRules_Delete_MinimumSet_Gen.json | 20 + .../examples/TagRules_Get_MaximumSet_Gen.json | 53 + .../examples/TagRules_Get_MinimumSet_Gen.json | 19 + ...ewRelicMonitorResource_MaximumSet_Gen.json | 57 + ...ewRelicMonitorResource_MinimumSet_Gen.json | 22 + .../TagRules_Update_MaximumSet_Gen.json | 79 + .../TagRules_Update_MinimumSet_Gen.json | 20 + .../stable/2024-01-01/NewRelic.json | 3432 ++ .../Accounts_List_MaximumSet_Gen.json | 28 + .../Accounts_List_MinimumSet_Gen.json | 21 + .../2024-01-01/examples/BillingInfo_Get.json | 25 + .../ConnectedPartnerResources_List.json | 24 + .../examples/LinkedResources_List.json | 19 + ...MonitoredSubscriptions_CreateorUpdate.json | 214 + .../MonitoredSubscriptions_Delete.json | 17 + .../examples/MonitoredSubscriptions_Get.json | 80 + .../examples/MonitoredSubscriptions_List.json | 84 + .../MonitoredSubscriptions_Update.json | 150 + ...onitors_CreateOrUpdate_MaximumSet_Gen.json | 209 + .../Monitors_Delete_MaximumSet_Gen.json | 20 + .../Monitors_Delete_MinimumSet_Gen.json | 20 + ...onitors_GetMetricRules_MaximumSet_Gen.json | 28 + ...onitors_GetMetricRules_MinimumSet_Gen.json | 22 + ...nitors_GetMetricStatus_MaximumSet_Gen.json | 25 + ...nitors_GetMetricStatus_MinimumSet_Gen.json | 23 + .../examples/Monitors_Get_MaximumSet_Gen.json | 81 + ...nitors_ListAppServices_MaximumSet_Gen.json | 30 + ...nitors_ListAppServices_MinimumSet_Gen.json | 24 + ...rs_ListByResourceGroup_MaximumSet_Gen.json | 85 + ...ors_ListBySubscription_MaximumSet_Gen.json | 84 + .../Monitors_ListHosts_MaximumSet_Gen.json | 30 + .../Monitors_ListHosts_MinimumSet_Gen.json | 24 + ...ListMonitoredResources_MaximumSet_Gen.json | 26 + ...ListMonitoredResources_MinimumSet_Gen.json | 18 + ...Monitors_SwitchBilling_MaximumSet_Gen.json | 98 + ...Monitors_SwitchBilling_MinimumSet_Gen.json | 90 + .../Monitors_Update_MaximumSet_Gen.json | 126 + ...Monitors_VmHostPayload_MaximumSet_Gen.json | 17 + ...Monitors_VmHostPayload_MinimumSet_Gen.json | 17 + .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + .../Organizations_List_MaximumSet_Gen.json | 27 + .../Organizations_List_MinimumSet_Gen.json | 17 + .../examples/Plans_List_MaximumSet_Gen.json | 32 + .../examples/Plans_List_MinimumSet_Gen.json | 23 + ...agRules_CreateOrUpdate_MaximumSet_Gen.json | 121 + ...agRules_CreateOrUpdate_MinimumSet_Gen.json | 31 + .../TagRules_Delete_MaximumSet_Gen.json | 20 + .../TagRules_Delete_MinimumSet_Gen.json | 20 + .../examples/TagRules_Get_MaximumSet_Gen.json | 53 + .../examples/TagRules_Get_MinimumSet_Gen.json | 19 + ...ewRelicMonitorResource_MaximumSet_Gen.json | 57 + ...ewRelicMonitorResource_MinimumSet_Gen.json | 22 + .../TagRules_Update_MaximumSet_Gen.json | 79 + .../TagRules_Update_MinimumSet_Gen.json | 20 + .../newrelic/resource-manager/readme.md | 20 +- .../examples/Certificates_CreateOrUpdate.json | 44 + .../examples/Certificates_Delete.json | 18 + .../2023-09-01/examples/Certificates_Get.json | 31 + .../examples/Certificates_List.json | 49 + .../examples/Configurations_Analysis.json | 43 + .../Configurations_CreateOrUpdate.json | 65 + .../examples/Configurations_Delete.json | 18 + .../examples/Configurations_Get.json | 31 + .../examples/Configurations_List.json | 34 + .../examples/Deployments_Create.json | 114 + .../examples/Deployments_Delete.json | 17 + .../2023-09-01/examples/Deployments_Get.json | 45 + .../2023-09-01/examples/Deployments_List.json | 45 + .../Deployments_ListByResourceGroup.json | 46 + .../examples/Deployments_Update.json | 89 + .../2023-09-01/examples/Operations_List.json | 23 + .../stable/2023-09-01/swagger.json | 1579 + .../nginx/resource-manager/readme.md | 12 +- .../resource-manager/readme.java.md | 31 +- .../resource-manager/readme.md | 5 + .../aodg/preview/2024-03-01-preview/aodg.json | 1672 + .../examples/EdgeSiteCreate.json | 56 + .../examples/EdgeSiteDelete.json | 12 + .../examples/EdgeSiteGet.json | 27 + .../examples/EdgeSiteUpdateTag.json | 33 + .../EdgeSitesByResourceGroupList.json | 32 + .../examples/EdgeSitesBySubscriptionList.json | 31 + .../examples/GlobalCommunicationsSiteGet.json | 36 + ...CommunicationsSitesBySubscriptionList.json | 39 + .../examples/GroundStationCreate.json | 80 + .../examples/GroundStationDelete.json | 12 + .../examples/GroundStationGet.json | 35 + .../examples/GroundStationUpdateTags.json | 41 + .../GroundStationsBySubscription.json | 39 + .../examples/GroundStationsList.json | 40 + .../examples/L2ConnectionCreate.json | 96 + .../examples/L2ConnectionDelete.json | 16 + .../examples/L2ConnectionGet.json | 39 + .../examples/L2ConnectionUpdateTag.json | 50 + .../L2ConnectionsByEdgeSiteNameList.json | 20 + .../L2ConnectionsByGroundStationNameList.json | 20 + .../L2ConnectionsByResourceGroupList.json | 44 + .../L2ConnectionsBySubscriptionList.json | 43 + .../examples/OperationsList.json | 23 + .../orbital/resource-manager/readme.md | 9 + .../PaloAltoNetworks.Cloudngfw.json | 7441 ++++ ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 68 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 33 + ...GlobalRulestack_Delete_MaximumSet_Gen.json | 16 + ...GlobalRulestack_Delete_MinimumSet_Gen.json | 16 + ...ectGlobalRulestack_Get_MaximumSet_Gen.json | 32 + ...ectGlobalRulestack_Get_MinimumSet_Gen.json | 17 + ...ctGlobalRulestack_List_MaximumSet_Gen.json | 36 + ...ctGlobalRulestack_List_MinimumSet_Gen.json | 20 + ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 70 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 35 + ...tLocalRulestack_Delete_MaximumSet_Gen.json | 18 + ...tLocalRulestack_Delete_MinimumSet_Gen.json | 18 + ...jectLocalRulestack_Get_MaximumSet_Gen.json | 34 + ...jectLocalRulestack_Get_MinimumSet_Gen.json | 19 + ..._ListByLocalRulestacks_MaximumSet_Gen.json | 38 + ..._ListByLocalRulestacks_MinimumSet_Gen.json | 22 + .../FirewallStatus_Get_MaximumSet_Gen.json | 35 + .../FirewallStatus_Get_MinimumSet_Gen.json | 16 + ...Status_ListByFirewalls_MaximumSet_Gen.json | 40 + ...Status_ListByFirewalls_MinimumSet_Gen.json | 20 + ...rewalls_CreateOrUpdate_MaximumSet_Gen.json | 442 + ...rewalls_CreateOrUpdate_MinimumSet_Gen.json | 91 + .../Firewalls_Delete_MaximumSet_Gen.json | 17 + .../Firewalls_Delete_MinimumSet_Gen.json | 17 + .../Firewalls_Get_MaximumSet_Gen.json | 161 + .../Firewalls_Get_MinimumSet_Gen.json | 37 + ...ls_ListByResourceGroup_MaximumSet_Gen.json | 165 + ...ls_ListByResourceGroup_MinimumSet_Gen.json | 40 + ...lls_ListBySubscription_MaximumSet_Gen.json | 164 + ...lls_ListBySubscription_MinimumSet_Gen.json | 39 + .../Firewalls_Update_MaximumSet_Gen.json | 286 + .../Firewalls_Update_MinimumSet_Gen.json | 37 + ...lls_getGlobalRulestack_MaximumSet_Gen.json | 15 + ...lls_getGlobalRulestack_MinimumSet_Gen.json | 15 + ...irewalls_getLogProfile_MaximumSet_Gen.json | 104 + ...irewalls_getLogProfile_MinimumSet_Gen.json | 13 + ...rewalls_getSupportInfo_MaximumSet_Gen.json | 27 + ...rewalls_getSupportInfo_MinimumSet_Gen.json | 13 + ...rewalls_saveLogProfile_MaximumSet_Gen.json | 103 + ...rewalls_saveLogProfile_MinimumSet_Gen.json | 11 + ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 74 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 42 + ...GlobalRulestack_Delete_MaximumSet_Gen.json | 16 + ...GlobalRulestack_Delete_MinimumSet_Gen.json | 16 + ...istGlobalRulestack_Get_MaximumSet_Gen.json | 34 + ...istGlobalRulestack_Get_MinimumSet_Gen.json | 20 + ...stGlobalRulestack_List_MaximumSet_Gen.json | 38 + ...stGlobalRulestack_List_MinimumSet_Gen.json | 23 + ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 76 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 44 + ...tLocalRulestack_Delete_MaximumSet_Gen.json | 18 + ...tLocalRulestack_Delete_MinimumSet_Gen.json | 18 + ...ListLocalRulestack_Get_MaximumSet_Gen.json | 36 + ...ListLocalRulestack_Get_MinimumSet_Gen.json | 22 + ..._ListByLocalRulestacks_MaximumSet_Gen.json | 40 + ..._ListByLocalRulestacks_MinimumSet_Gen.json | 25 + ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 143 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 29 + ...GlobalRulestack_Delete_MaximumSet_Gen.json | 15 + ...GlobalRulestack_Delete_MinimumSet_Gen.json | 15 + .../GlobalRulestack_Get_MaximumSet_Gen.json | 57 + .../GlobalRulestack_Get_MinimumSet_Gen.json | 15 + .../GlobalRulestack_List_MaximumSet_Gen.json | 61 + .../GlobalRulestack_List_MinimumSet_Gen.json | 18 + ...GlobalRulestack_Update_MaximumSet_Gen.json | 90 + ...GlobalRulestack_Update_MinimumSet_Gen.json | 15 + ...GlobalRulestack_commit_MaximumSet_Gen.json | 13 + ...GlobalRulestack_commit_MinimumSet_Gen.json | 13 + ...Rulestack_getChangeLog_MaximumSet_Gen.json | 17 + ...Rulestack_getChangeLog_MinimumSet_Gen.json | 15 + ...dvancedSecurityObjects_MaximumSet_Gen.json | 25 + ...dvancedSecurityObjects_MinimumSet_Gen.json | 20 + ...alRulestack_listAppIds_MaximumSet_Gen.json | 20 + ...alRulestack_listAppIds_MinimumSet_Gen.json | 15 + ...ulestack_listCountries_MaximumSet_Gen.json | 21 + ...ulestack_listCountries_MinimumSet_Gen.json | 17 + ...ulestack_listFirewalls_MaximumSet_Gen.json | 16 + ...ulestack_listFirewalls_MinimumSet_Gen.json | 15 + ...redefinedUrlCategories_MaximumSet_Gen.json | 21 + ...redefinedUrlCategories_MinimumSet_Gen.json | 18 + ...k_listSecurityServices_MaximumSet_Gen.json | 25 + ...k_listSecurityServices_MinimumSet_Gen.json | 20 + ...GlobalRulestack_revert_MaximumSet_Gen.json | 9 + ...GlobalRulestack_revert_MinimumSet_Gen.json | 9 + ...alRules_CreateOrUpdate_MaximumSet_Gen.json | 246 + ...alRules_CreateOrUpdate_MinimumSet_Gen.json | 35 + .../LocalRules_Delete_MaximumSet_Gen.json | 18 + .../LocalRules_Delete_MinimumSet_Gen.json | 18 + .../LocalRules_Get_MaximumSet_Gen.json | 93 + .../LocalRules_Get_MinimumSet_Gen.json | 19 + ..._ListByLocalRulestacks_MaximumSet_Gen.json | 97 + ..._ListByLocalRulestacks_MinimumSet_Gen.json | 22 + ...LocalRules_getCounters_MaximumSet_Gen.json | 39 + ...LocalRules_getCounters_MinimumSet_Gen.json | 17 + ...lRules_refreshCounters_MaximumSet_Gen.json | 13 + ...lRules_refreshCounters_MinimumSet_Gen.json | 12 + ...calRules_resetCounters_MaximumSet_Gen.json | 21 + ...calRules_resetCounters_MinimumSet_Gen.json | 14 + ...estacks_CreateOrUpdate_MaximumSet_Gen.json | 154 + ...estacks_CreateOrUpdate_MinimumSet_Gen.json | 31 + ...LocalRulestacks_Delete_MaximumSet_Gen.json | 17 + ...LocalRulestacks_Delete_MinimumSet_Gen.json | 17 + .../LocalRulestacks_Get_MaximumSet_Gen.json | 62 + .../LocalRulestacks_Get_MinimumSet_Gen.json | 17 + ...ks_ListByResourceGroup_MaximumSet_Gen.json | 66 + ...ks_ListByResourceGroup_MinimumSet_Gen.json | 20 + ...cks_ListBySubscription_MaximumSet_Gen.json | 65 + ...cks_ListBySubscription_MinimumSet_Gen.json | 19 + ...LocalRulestacks_Update_MaximumSet_Gen.json | 97 + ...LocalRulestacks_Update_MinimumSet_Gen.json | 17 + ...LocalRulestacks_commit_MaximumSet_Gen.json | 15 + ...LocalRulestacks_commit_MinimumSet_Gen.json | 15 + ...ulestacks_getChangeLog_MaximumSet_Gen.json | 19 + ...ulestacks_getChangeLog_MinimumSet_Gen.json | 17 + ...estacks_getSupportInfo_MaximumSet_Gen.json | 27 + ...estacks_getSupportInfo_MinimumSet_Gen.json | 13 + ...dvancedSecurityObjects_MaximumSet_Gen.json | 27 + ...dvancedSecurityObjects_MinimumSet_Gen.json | 22 + ...lRulestacks_listAppIds_MaximumSet_Gen.json | 22 + ...lRulestacks_listAppIds_MinimumSet_Gen.json | 17 + ...lestacks_listCountries_MaximumSet_Gen.json | 23 + ...lestacks_listCountries_MinimumSet_Gen.json | 19 + ...lestacks_listFirewalls_MaximumSet_Gen.json | 18 + ...lestacks_listFirewalls_MinimumSet_Gen.json | 17 + ...redefinedUrlCategories_MaximumSet_Gen.json | 23 + ...redefinedUrlCategories_MinimumSet_Gen.json | 20 + ...s_listSecurityServices_MaximumSet_Gen.json | 27 + ...s_listSecurityServices_MinimumSet_Gen.json | 22 + ...LocalRulestacks_revert_MaximumSet_Gen.json | 11 + ...LocalRulestacks_revert_MinimumSet_Gen.json | 11 + .../Operations_List_MaximumSet_Gen.json | 26 + .../Operations_List_MinimumSet_Gen.json | 10 + ...udngfw_listSupportInfo_MaximumSet_Gen.json | 27 + ...udngfw_listSupportInfo_MinimumSet_Gen.json | 11 + ...stRules_CreateOrUpdate_MaximumSet_Gen.json | 244 + ...stRules_CreateOrUpdate_MinimumSet_Gen.json | 33 + .../PostRules_Delete_MaximumSet_Gen.json | 16 + .../PostRules_Delete_MinimumSet_Gen.json | 16 + .../PostRules_Get_MaximumSet_Gen.json | 91 + .../PostRules_Get_MinimumSet_Gen.json | 17 + .../PostRules_List_MaximumSet_Gen.json | 95 + .../PostRules_List_MinimumSet_Gen.json | 20 + .../PostRules_getCounters_MaximumSet_Gen.json | 37 + .../PostRules_getCounters_MinimumSet_Gen.json | 15 + ...tRules_refreshCounters_MaximumSet_Gen.json | 11 + ...tRules_refreshCounters_MinimumSet_Gen.json | 10 + ...ostRules_resetCounters_MaximumSet_Gen.json | 19 + ...ostRules_resetCounters_MinimumSet_Gen.json | 12 + ...reRules_CreateOrUpdate_MaximumSet_Gen.json | 244 + ...reRules_CreateOrUpdate_MinimumSet_Gen.json | 33 + .../PreRules_Delete_MaximumSet_Gen.json | 16 + .../PreRules_Delete_MinimumSet_Gen.json | 16 + .../examples/PreRules_Get_MaximumSet_Gen.json | 91 + .../examples/PreRules_Get_MinimumSet_Gen.json | 17 + .../PreRules_List_MaximumSet_Gen.json | 95 + .../PreRules_List_MinimumSet_Gen.json | 20 + .../PreRules_getCounters_MaximumSet_Gen.json | 37 + .../PreRules_getCounters_MinimumSet_Gen.json | 15 + ...eRules_refreshCounters_MaximumSet_Gen.json | 11 + ...eRules_refreshCounters_MinimumSet_Gen.json | 10 + ...PreRules_resetCounters_MaximumSet_Gen.json | 19 + ...PreRules_resetCounters_MinimumSet_Gen.json | 12 + ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 71 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 39 + ...GlobalRulestack_Delete_MaximumSet_Gen.json | 16 + ...GlobalRulestack_Delete_MinimumSet_Gen.json | 16 + ...istGlobalRulestack_Get_MaximumSet_Gen.json | 33 + ...istGlobalRulestack_Get_MinimumSet_Gen.json | 19 + ...stGlobalRulestack_List_MaximumSet_Gen.json | 37 + ...stGlobalRulestack_List_MinimumSet_Gen.json | 22 + ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 73 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 41 + ...tLocalRulestack_Delete_MaximumSet_Gen.json | 18 + ...tLocalRulestack_Delete_MinimumSet_Gen.json | 18 + ...ListLocalRulestack_Get_MaximumSet_Gen.json | 35 + ...ListLocalRulestack_Get_MinimumSet_Gen.json | 21 + ..._ListByLocalRulestacks_MaximumSet_Gen.json | 39 + ..._ListByLocalRulestacks_MinimumSet_Gen.json | 24 + .../PaloAltoNetworks.Cloudngfw.json | 7610 ++++ ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 68 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 33 + ...GlobalRulestack_Delete_MaximumSet_Gen.json | 16 + ...GlobalRulestack_Delete_MinimumSet_Gen.json | 16 + ...ectGlobalRulestack_Get_MaximumSet_Gen.json | 32 + ...ectGlobalRulestack_Get_MinimumSet_Gen.json | 17 + ...ctGlobalRulestack_List_MaximumSet_Gen.json | 36 + ...ctGlobalRulestack_List_MinimumSet_Gen.json | 20 + ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 70 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 35 + ...tLocalRulestack_Delete_MaximumSet_Gen.json | 18 + ...tLocalRulestack_Delete_MinimumSet_Gen.json | 18 + ...jectLocalRulestack_Get_MaximumSet_Gen.json | 34 + ...jectLocalRulestack_Get_MinimumSet_Gen.json | 19 + ..._ListByLocalRulestacks_MaximumSet_Gen.json | 38 + ..._ListByLocalRulestacks_MinimumSet_Gen.json | 22 + .../FirewallStatus_Get_MaximumSet_Gen.json | 35 + .../FirewallStatus_Get_MinimumSet_Gen.json | 16 + ...Status_ListByFirewalls_MaximumSet_Gen.json | 40 + ...Status_ListByFirewalls_MinimumSet_Gen.json | 20 + ...rewalls_CreateOrUpdate_MaximumSet_Gen.json | 442 + ...rewalls_CreateOrUpdate_MinimumSet_Gen.json | 91 + .../Firewalls_Delete_MaximumSet_Gen.json | 17 + .../Firewalls_Delete_MinimumSet_Gen.json | 17 + .../Firewalls_Get_MaximumSet_Gen.json | 161 + .../Firewalls_Get_MinimumSet_Gen.json | 37 + ...ls_ListByResourceGroup_MaximumSet_Gen.json | 165 + ...ls_ListByResourceGroup_MinimumSet_Gen.json | 40 + ...lls_ListBySubscription_MaximumSet_Gen.json | 164 + ...lls_ListBySubscription_MinimumSet_Gen.json | 39 + .../Firewalls_Update_MaximumSet_Gen.json | 286 + .../Firewalls_Update_MinimumSet_Gen.json | 37 + ...lls_getGlobalRulestack_MaximumSet_Gen.json | 15 + ...lls_getGlobalRulestack_MinimumSet_Gen.json | 15 + ...irewalls_getLogProfile_MaximumSet_Gen.json | 104 + ...irewalls_getLogProfile_MinimumSet_Gen.json | 13 + ...rewalls_getSupportInfo_MaximumSet_Gen.json | 27 + ...rewalls_getSupportInfo_MinimumSet_Gen.json | 13 + ...rewalls_saveLogProfile_MaximumSet_Gen.json | 103 + ...rewalls_saveLogProfile_MinimumSet_Gen.json | 11 + ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 74 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 42 + ...GlobalRulestack_Delete_MaximumSet_Gen.json | 16 + ...GlobalRulestack_Delete_MinimumSet_Gen.json | 16 + ...istGlobalRulestack_Get_MaximumSet_Gen.json | 34 + ...istGlobalRulestack_Get_MinimumSet_Gen.json | 20 + ...stGlobalRulestack_List_MaximumSet_Gen.json | 38 + ...stGlobalRulestack_List_MinimumSet_Gen.json | 23 + ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 76 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 44 + ...tLocalRulestack_Delete_MaximumSet_Gen.json | 18 + ...tLocalRulestack_Delete_MinimumSet_Gen.json | 18 + ...ListLocalRulestack_Get_MaximumSet_Gen.json | 36 + ...ListLocalRulestack_Get_MinimumSet_Gen.json | 22 + ..._ListByLocalRulestacks_MaximumSet_Gen.json | 40 + ..._ListByLocalRulestacks_MinimumSet_Gen.json | 25 + ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 143 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 29 + ...GlobalRulestack_Delete_MaximumSet_Gen.json | 15 + ...GlobalRulestack_Delete_MinimumSet_Gen.json | 15 + .../GlobalRulestack_Get_MaximumSet_Gen.json | 57 + .../GlobalRulestack_Get_MinimumSet_Gen.json | 15 + .../GlobalRulestack_List_MaximumSet_Gen.json | 61 + .../GlobalRulestack_List_MinimumSet_Gen.json | 18 + ...GlobalRulestack_Update_MaximumSet_Gen.json | 90 + ...GlobalRulestack_Update_MinimumSet_Gen.json | 15 + ...GlobalRulestack_commit_MaximumSet_Gen.json | 13 + ...GlobalRulestack_commit_MinimumSet_Gen.json | 13 + ...Rulestack_getChangeLog_MaximumSet_Gen.json | 17 + ...Rulestack_getChangeLog_MinimumSet_Gen.json | 15 + ...dvancedSecurityObjects_MaximumSet_Gen.json | 25 + ...dvancedSecurityObjects_MinimumSet_Gen.json | 20 + ...alRulestack_listAppIds_MaximumSet_Gen.json | 20 + ...alRulestack_listAppIds_MinimumSet_Gen.json | 15 + ...ulestack_listCountries_MaximumSet_Gen.json | 21 + ...ulestack_listCountries_MinimumSet_Gen.json | 17 + ...ulestack_listFirewalls_MaximumSet_Gen.json | 16 + ...ulestack_listFirewalls_MinimumSet_Gen.json | 15 + ...redefinedUrlCategories_MaximumSet_Gen.json | 21 + ...redefinedUrlCategories_MinimumSet_Gen.json | 18 + ...k_listSecurityServices_MaximumSet_Gen.json | 25 + ...k_listSecurityServices_MinimumSet_Gen.json | 20 + ...GlobalRulestack_revert_MaximumSet_Gen.json | 9 + ...GlobalRulestack_revert_MinimumSet_Gen.json | 9 + ...alRules_CreateOrUpdate_MaximumSet_Gen.json | 246 + ...alRules_CreateOrUpdate_MinimumSet_Gen.json | 35 + .../LocalRules_Delete_MaximumSet_Gen.json | 18 + .../LocalRules_Delete_MinimumSet_Gen.json | 18 + .../LocalRules_Get_MaximumSet_Gen.json | 93 + .../LocalRules_Get_MinimumSet_Gen.json | 19 + ..._ListByLocalRulestacks_MaximumSet_Gen.json | 97 + ..._ListByLocalRulestacks_MinimumSet_Gen.json | 22 + ...LocalRules_getCounters_MaximumSet_Gen.json | 39 + ...LocalRules_getCounters_MinimumSet_Gen.json | 17 + ...lRules_refreshCounters_MaximumSet_Gen.json | 13 + ...lRules_refreshCounters_MinimumSet_Gen.json | 12 + ...calRules_resetCounters_MaximumSet_Gen.json | 21 + ...calRules_resetCounters_MinimumSet_Gen.json | 14 + ...estacks_CreateOrUpdate_MaximumSet_Gen.json | 154 + ...estacks_CreateOrUpdate_MinimumSet_Gen.json | 31 + ...LocalRulestacks_Delete_MaximumSet_Gen.json | 17 + ...LocalRulestacks_Delete_MinimumSet_Gen.json | 17 + .../LocalRulestacks_Get_MaximumSet_Gen.json | 62 + .../LocalRulestacks_Get_MinimumSet_Gen.json | 17 + ...ks_ListByResourceGroup_MaximumSet_Gen.json | 66 + ...ks_ListByResourceGroup_MinimumSet_Gen.json | 20 + ...cks_ListBySubscription_MaximumSet_Gen.json | 65 + ...cks_ListBySubscription_MinimumSet_Gen.json | 19 + ...LocalRulestacks_Update_MaximumSet_Gen.json | 97 + ...LocalRulestacks_Update_MinimumSet_Gen.json | 17 + ...LocalRulestacks_commit_MaximumSet_Gen.json | 15 + ...LocalRulestacks_commit_MinimumSet_Gen.json | 15 + ...ulestacks_getChangeLog_MaximumSet_Gen.json | 19 + ...ulestacks_getChangeLog_MinimumSet_Gen.json | 17 + ...estacks_getSupportInfo_MaximumSet_Gen.json | 27 + ...estacks_getSupportInfo_MinimumSet_Gen.json | 13 + ...dvancedSecurityObjects_MaximumSet_Gen.json | 27 + ...dvancedSecurityObjects_MinimumSet_Gen.json | 22 + ...lRulestacks_listAppIds_MaximumSet_Gen.json | 22 + ...lRulestacks_listAppIds_MinimumSet_Gen.json | 17 + ...lestacks_listCountries_MaximumSet_Gen.json | 23 + ...lestacks_listCountries_MinimumSet_Gen.json | 19 + ...lestacks_listFirewalls_MaximumSet_Gen.json | 18 + ...lestacks_listFirewalls_MinimumSet_Gen.json | 17 + ...redefinedUrlCategories_MaximumSet_Gen.json | 23 + ...redefinedUrlCategories_MinimumSet_Gen.json | 20 + ...s_listSecurityServices_MaximumSet_Gen.json | 27 + ...s_listSecurityServices_MinimumSet_Gen.json | 22 + ...LocalRulestacks_revert_MaximumSet_Gen.json | 11 + ...LocalRulestacks_revert_MinimumSet_Gen.json | 11 + .../Operations_List_MaximumSet_Gen.json | 26 + .../Operations_List_MinimumSet_Gen.json | 10 + ...ateProductSerialNumber_MaximumSet_Gen.json | 13 + ...ateProductSerialNumber_MinimumSet_Gen.json | 13 + ...istCloudManagerTenants_MaximumSet_Gen.json | 16 + ...istCloudManagerTenants_MinimumSet_Gen.json | 15 + ...ductSerialNumberStatus_MaximumSet_Gen.json | 14 + ...ductSerialNumberStatus_MinimumSet_Gen.json | 13 + ...udngfw_listSupportInfo_MaximumSet_Gen.json | 27 + ...udngfw_listSupportInfo_MinimumSet_Gen.json | 11 + ...stRules_CreateOrUpdate_MaximumSet_Gen.json | 244 + ...stRules_CreateOrUpdate_MinimumSet_Gen.json | 33 + .../PostRules_Delete_MaximumSet_Gen.json | 16 + .../PostRules_Delete_MinimumSet_Gen.json | 16 + .../PostRules_Get_MaximumSet_Gen.json | 91 + .../PostRules_Get_MinimumSet_Gen.json | 17 + .../PostRules_List_MaximumSet_Gen.json | 95 + .../PostRules_List_MinimumSet_Gen.json | 20 + .../PostRules_getCounters_MaximumSet_Gen.json | 37 + .../PostRules_getCounters_MinimumSet_Gen.json | 15 + ...tRules_refreshCounters_MaximumSet_Gen.json | 11 + ...tRules_refreshCounters_MinimumSet_Gen.json | 10 + ...ostRules_resetCounters_MaximumSet_Gen.json | 19 + ...ostRules_resetCounters_MinimumSet_Gen.json | 12 + ...reRules_CreateOrUpdate_MaximumSet_Gen.json | 244 + ...reRules_CreateOrUpdate_MinimumSet_Gen.json | 33 + .../PreRules_Delete_MaximumSet_Gen.json | 16 + .../PreRules_Delete_MinimumSet_Gen.json | 16 + .../examples/PreRules_Get_MaximumSet_Gen.json | 91 + .../examples/PreRules_Get_MinimumSet_Gen.json | 17 + .../PreRules_List_MaximumSet_Gen.json | 95 + .../PreRules_List_MinimumSet_Gen.json | 20 + .../PreRules_getCounters_MaximumSet_Gen.json | 37 + .../PreRules_getCounters_MinimumSet_Gen.json | 15 + ...eRules_refreshCounters_MaximumSet_Gen.json | 11 + ...eRules_refreshCounters_MinimumSet_Gen.json | 10 + ...PreRules_resetCounters_MaximumSet_Gen.json | 19 + ...PreRules_resetCounters_MinimumSet_Gen.json | 12 + ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 71 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 39 + ...GlobalRulestack_Delete_MaximumSet_Gen.json | 16 + ...GlobalRulestack_Delete_MinimumSet_Gen.json | 16 + ...istGlobalRulestack_Get_MaximumSet_Gen.json | 33 + ...istGlobalRulestack_Get_MinimumSet_Gen.json | 19 + ...stGlobalRulestack_List_MaximumSet_Gen.json | 37 + ...stGlobalRulestack_List_MinimumSet_Gen.json | 22 + ...lestack_CreateOrUpdate_MaximumSet_Gen.json | 73 + ...lestack_CreateOrUpdate_MinimumSet_Gen.json | 41 + ...tLocalRulestack_Delete_MaximumSet_Gen.json | 18 + ...tLocalRulestack_Delete_MinimumSet_Gen.json | 18 + ...ListLocalRulestack_Get_MaximumSet_Gen.json | 35 + ...ListLocalRulestack_Get_MinimumSet_Gen.json | 21 + ..._ListByLocalRulestacks_MaximumSet_Gen.json | 39 + ..._ListByLocalRulestacks_MinimumSet_Gen.json | 24 + .../resource-manager/readme.md | 35 +- .../2024-02-01-preview/AccountQuotas_Get.json | 30 + .../AccountQuotas_ListByAccount.json | 33 + .../Accounts_CheckNameAvailability.json | 20 + .../Accounts_CreateOrUpdate.json | 4 +- .../Accounts_Delete.json | 4 +- .../Accounts_Get.json | 4 +- .../Accounts_ListByResourceGroup.json | 2 +- .../Accounts_ListBySubscription.json | 2 +- .../Accounts_Update.json | 4 +- .../Operations_List.json | 2 +- .../{ => 2024-02-01-preview}/Quotas_Get.json | 9 +- .../Quotas_ListBySubscription.json | 7 +- .../PlaywrightTesting.Management/main.tsp | 135 +- .../PlaywrightTesting/main.tsp | 38 +- .../2023-10-01-preview/playwrighttesting.json | 90 +- .../2023-10-01-preview/playwrighttesting.json | 16 +- .../examples/AccountQuotas_Get.json | 30 + .../examples/AccountQuotas_ListByAccount.json | 33 + .../Accounts_CheckNameAvailability.json | 20 + .../examples/Accounts_CreateOrUpdate.json | 76 + .../examples/Accounts_Delete.json | 19 + .../examples/Accounts_Get.json | 38 + .../Accounts_ListByResourceGroup.json | 41 + .../examples/Accounts_ListBySubscription.json | 40 + .../examples/Accounts_Update.json | 47 + .../examples/Operations_List.json | 46 + .../examples/Quotas_Get.json | 26 + .../examples/Quotas_ListBySubscription.json | 29 + .../2024-02-01-preview/playwrighttesting.json | 1189 + .../resource-manager/readme.md | 28 +- .../apis/common.tsp | 106 + .../apis/location.tsp | 77 + .../apis/network.tsp | 40 + .../apis/number.tsp | 100 + .../apis/simswap.tsp | 85 + .../Azure.ProgrammableConnectivity/client.tsp | 5 + .../DeviceLocation_Verify_MaximumSet_Gen.json | 38 + ...DeviceNetwork_Retrieve_MaximumSet_Gen.json | 21 + ...ication_VerifyWithCode_MaximumSet_Gen.json | 25 + ...tion_VerifyWithoutCode_MaximumSet_Gen.json | 20 + .../SimSwap_Retrieve_MaximumSet_Gen.json | 24 + .../SimSwap_Verify_MaximumSet_Gen.json | 24 + .../Azure.ProgrammableConnectivity/main.tsp | 41 + .../tspconfig.yaml | 26 + .../DeviceLocation_Verify_MaximumSet_Gen.json | 38 + ...DeviceNetwork_Retrieve_MaximumSet_Gen.json | 21 + ...ication_VerifyWithCode_MaximumSet_Gen.json | 25 + ...tion_VerifyWithoutCode_MaximumSet_Gen.json | 20 + .../SimSwap_Retrieve_MaximumSet_Gen.json | 24 + .../SimSwap_Verify_MaximumSet_Gen.json | 24 + .../preview/2024-02-09-preview/openapi.json | 1021 + .../data-plane/readme.md | 57 + .../client.tsp | 152 + .../2023-09-01/Discovery_AutoComplete.json | 40 + .../examples/2023-09-01/Discovery_Query.json | 109 + .../2023-09-01/Discovery_Query_And.json | 80 + .../Discovery_Query_AndOrNested.json | 97 + .../2023-09-01/Discovery_Query_AssetType.json | 140 + .../2023-09-01/Discovery_Query_Attribute.json | 97 + ...overy_Query_BusinessMetadataAttribute.json | 54 + .../Discovery_Query_Classification.json | 69 + .../Discovery_Query_Collection.json | 68 + .../2023-09-01/Discovery_Query_Facet.json | 150 + .../Discovery_Query_FileExtension.json | 62 + .../Discovery_Query_GlossaryTerm.json | 96 + .../2023-09-01/Discovery_Query_Id.json | 45 + .../2023-09-01/Discovery_Query_Not.json | 60 + .../Discovery_Query_ObjectType.json | 75 + ...very_Query_PaginationContinuationPage.json | 111 + .../Discovery_Query_PaginationFirstPage.json | 110 + .../Discovery_Query_PaginationLastPage.json | 110 + .../Discovery_Query_SystemTime.json | 55 + .../2023-09-01/Discovery_Query_Taxonomy.json | 94 + .../Discovery_Query_TermAssignment.json | 59 + .../2023-09-01/Discovery_Query_Type.json | 66 + .../2023-09-01/Discovery_Suggest.json | 60 + ...tity_AddClassificationToEntityByGuids.json | 21 + .../2023-09-01/Entity_AddClassifications.json | 21 + ...y_AddClassificationsByUniqueAttribute.json | 20 + .../2023-09-01/Entity_AddCustomAttribute.json | 58 + .../examples/2023-09-01/Entity_AddLabel.json} | 4 +- .../Entity_AddLabelsByUniqueAttribute.json | 15 + .../Entity_AddOrUpdate_BusinessAttribute.json | 15 + .../Entity_AddOrUpdate_BusinessMetadata.json | 16 + .../2023-09-01/Entity_BulkCreateOrUpdate.json | 106 + .../2023-09-01/Entity_BulkDelete.json | 37 + .../Entity_BulkSetClassifications.json | 41 + .../examples/2023-09-01/Entity_Create.json | 63 + .../examples/2023-09-01/Entity_Delete.json | 29 + .../Entity_DeleteByUniqueAttribute.json | 35 + .../examples/2023-09-01/Entity_Get.json | 64 + .../Entity_GetByUniqueAttributes.json | 38 + .../2023-09-01/Entity_GetClassification.json | 19 + .../2023-09-01/Entity_GetClassifications.json | 24 + .../examples/2023-09-01/Entity_GetHeader.json | 30 + ...ity_GetSampleBusinessMetadataTemplate.json | 13 + .../Entity_ImportBusinessMetadata.json | 22 + .../2023-09-01/Entity_ListByGuids.json | 117 + .../Entity_ListByUniqueAttributes.json | 53 + .../Entity_MoveEntitiesToCollection.json | 47 + .../Entity_PartialUpdateAttributeByGuid.json | 39 + ...ntity_PartialUpdateByUniqueAttributes.json | 62 + .../Entity_RemoveBusinessAttribute.json | 15 + .../Entity_RemoveBusinessMetadata.json | 16 + .../Entity_RemoveClassification.json | 12 + ...RemoveClassificationByUniqueAttribute.json | 13 + .../2023-09-01/Entity_RemoveLabels.json | 15 + .../Entity_RemoveLabelsByUniqueAttribute.json | 15 + .../examples/2023-09-01/Entity_SetLabels.json | 15 + .../Entity_SetLabelsByUniqueAttribute.json | 16 + .../examples/2023-09-01/Entity_Update.json | 62 + .../Entity_UpdateClassifications.json | 21 + ...pdateClassificationsByUniqueAttribute.json | 20 + .../Glossary_AssignTermToEntities.json | 24 + .../examples/2023-09-01/Glossary_Create.json | 32 + .../2023-09-01/Glossary_CreateCategories.json | 47 + .../2023-09-01/Glossary_CreateCategory.json | 39 + .../2023-09-01/Glossary_CreateTerm.json | 78 + .../Glossary_CreateTermWithTemplate.json | 53 + .../2023-09-01/Glossary_CreateTerms.json | 93 + .../examples/2023-09-01/Glossary_Delete.json | 11 + .../2023-09-01/Glossary_DeleteCategory.json | 11 + .../2023-09-01/Glossary_DeleteTerm.json | 11 + .../examples/2023-09-01/Glossary_Get.json | 43 + .../2023-09-01/Glossary_GetCategory.json | 41 + .../2023-09-01/Glossary_GetDetailed.json | 231 + .../examples/2023-09-01/Glossary_GetTerm.json | 86 + .../Glossary_GetTermWithoutAssets.json | 66 + .../examples/2023-09-01/Glossary_List.json | 61 + .../2023-09-01/Glossary_ListCategories.json | 74 + .../Glossary_ListCategoriesHeaders.json | 34 + .../Glossary_ListCategoryTerms.json | 22 + ...Glossary_ListEntitiesAssignedWithTerm.json | 59 + .../Glossary_ListRelatedCategories.json | 31 + .../2023-09-01/Glossary_ListRelatedTerms.json | 31 + .../2023-09-01/Glossary_ListTermHeaders.json | 27 + .../2023-09-01/Glossary_ListTerms.json | 105 + .../2023-09-01/Glossary_PartialUpdate.json | 60 + .../Glossary_PartialUpdateCategory.json | 45 + .../Glossary_PartialUpdateTerm.json | 60 + ...sary_RemoveTermAssignmentFromEntities.json | 17 + .../examples/2023-09-01/Glossary_Update.json | 98 + .../2023-09-01/Glossary_UpdateCategory.json | 65 + .../2023-09-01/Glossary_UpdateTerm.json | 94 + .../examples/2023-09-01/Lineage_Get.json | 26 + .../Lineage_GetByUniqueAttribute.json | 65 + .../2023-09-01/Lineage_GetNextPage.json | 27 + .../2023-09-01/Relationship_Create.json | 60 + .../2023-09-01/Relationship_Delete.json | 11 + .../examples/2023-09-01/Relationship_Get.json | 41 + .../2023-09-01/Relationship_Update.json | 61 + .../examples/2023-09-01/Type_BulkCreate.json | 73 + .../Type_BulkCreateBusinessMetadataDefs.json | 77 + .../examples/2023-09-01/Type_BulkDelete.json | 35 + .../examples/2023-09-01/Type_BulkUpdate.json | 290 + .../examples/2023-09-01/Type_Delete.json | 11 + .../Type_GetBusinessMetadataDefByGuid.json | 43 + .../Type_GetBusinessMetadataDefByName.json | 43 + .../examples/2023-09-01/Type_GetByGuid.json | 43 + .../examples/2023-09-01/Type_GetByName.json | 43 + .../Type_GetClassificationDefByGuid.json | 28 + .../Type_GetClassificationDefByName.json | 28 + .../2023-09-01/Type_GetEntityDefByGuid.json | 58 + .../2023-09-01/Type_GetEntityDefByName.json | 58 + .../2023-09-01/Type_GetEnumDefByGuid.json | 38 + .../2023-09-01/Type_GetEnumDefByName.json | 38 + .../Type_GetRelationshipDefByGuid.json | 41 + .../Type_GetRelationshipDefByName.json | 41 + .../2023-09-01/Type_GetStructDefByGuid.json | 48 + .../2023-09-01/Type_GetStructDefByName.json | 48 + .../Type_GetTermTemplateDefByGuid.json | 85 + .../Type_GetTermTemplateDefByName.json | 85 + .../examples/2023-09-01/Type_List.json | 272 + .../2023-09-01/Type_ListEnumDefs.json | 93 + .../examples/2023-09-01/Type_ListHeaders.json | 29 + .../2023-09-01/Type_ListTermTemplateDefs.json | 94 + .../Azure.Analytics.Purview.DataMap/main.tsp | 42 + .../models.tsp | 1949 + .../routes.tsp | 2133 + .../tspconfig.yaml | 37 + .../examples/Discovery_AutoComplete.json | 6 +- .../2023-09-01/examples/Discovery_Query.json | 6 +- .../examples/Discovery_Query_And.json | 6 +- .../examples/Discovery_Query_AndOrNested.json | 6 +- .../examples/Discovery_Query_AssetType.json | 6 +- .../examples/Discovery_Query_Attribute.json | 6 +- ...overy_Query_BusinessMetadataAttribute.json | 6 +- .../Discovery_Query_Classification.json | 6 +- .../examples/Discovery_Query_Collection.json | 6 +- .../examples/Discovery_Query_Facet.json | 6 +- .../Discovery_Query_FileExtension.json | 6 +- .../Discovery_Query_GlossaryTerm.json | 6 +- .../examples/Discovery_Query_Id.json | 6 +- .../examples/Discovery_Query_Not.json | 6 +- .../examples/Discovery_Query_ObjectType.json | 56 +- ...very_Query_PaginationContinuationPage.json | 6 +- .../Discovery_Query_PaginationFirstPage.json | 6 +- .../Discovery_Query_PaginationLastPage.json | 6 +- .../examples/Discovery_Query_SystemTime.json | 6 +- .../examples/Discovery_Query_Taxonomy.json | 6 +- .../Discovery_Query_TermAssignment.json | 6 +- .../examples/Discovery_Query_Type.json | 6 +- .../examples/Discovery_Suggest.json | 6 +- ...tity_AddClassificationToEntityByGuids.json | 6 +- .../examples/Entity_AddClassifications.json | 6 +- ...y_AddClassificationsByUniqueAttribute.json | 6 +- .../examples/Entity_AddCustomAttribute.json | 7 +- .../2023-09-01/examples/Entity_AddLabel.json | 15 + .../Entity_AddLabelsByUniqueAttribute.json | 4 +- .../Entity_AddOrUpdate_BusinessAttribute.json | 6 +- .../Entity_AddOrUpdate_BusinessMetadata.json | 16 + .../examples/Entity_BulkCreateOrUpdate.json | 6 +- .../examples/Entity_BulkDelete.json | 4 +- .../Entity_BulkSetClassifications.json | 6 +- .../2023-09-01/examples/Entity_Create.json | 7 +- .../2023-09-01/examples/Entity_Delete.json | 4 +- .../Entity_DeleteByUniqueAttribute.json | 4 +- .../2023-09-01/examples/Entity_Get.json | 7 +- .../Entity_GetByUniqueAttributes.json | 7 +- .../examples/Entity_GetClassification.json | 4 +- .../examples/Entity_GetClassifications.json | 4 +- .../2023-09-01/examples/Entity_GetHeader.json | 4 +- ...ity_GetSampleBusinessMetadataTemplate.json | 7 +- .../Entity_ImportBusinessMetadata.json | 6 +- .../examples/Entity_ListByGuids.json | 7 +- .../Entity_ListByUniqueAttributes.json | 7 +- .../Entity_MoveEntitiesToCollection.json | 6 +- .../Entity_PartialUpdateAttributeByGuid.json | 4 +- ...ntity_PartialUpdateByUniqueAttributes.json | 10 +- .../Entity_RemoveBusinessAttribute.json | 6 +- .../Entity_RemoveBusinessMetadata.json | 4 +- .../examples/Entity_RemoveClassification.json | 4 +- ...RemoveClassificationByUniqueAttribute.json | 4 +- .../examples/Entity_RemoveLabels.json | 15 + .../Entity_RemoveLabelsByUniqueAttribute.json | 4 +- .../2023-09-01/examples/Entity_SetLabels.json | 15 + .../Entity_SetLabelsByUniqueAttribute.json | 4 +- .../2023-09-01/examples/Entity_Update.json | 7 +- .../Entity_UpdateClassifications.json | 6 +- ...pdateClassificationsByUniqueAttribute.json | 6 +- .../Glossary_AssignTermToEntities.json | 8 +- .../2023-09-01/examples/Glossary_Create.json | 6 +- .../examples/Glossary_CreateCategories.json | 6 +- .../examples/Glossary_CreateCategory.json | 6 +- .../examples/Glossary_CreateTerm.json | 6 +- .../Glossary_CreateTermWithTemplate.json | 6 +- .../examples/Glossary_CreateTerms.json | 6 +- .../2023-09-01/examples/Glossary_Delete.json | 6 +- .../examples/Glossary_DeleteCategory.json | 6 +- .../examples/Glossary_DeleteTerm.json | 6 +- .../2023-09-01/examples/Glossary_Get.json | 6 +- .../examples/Glossary_GetCategory.json | 6 +- .../examples/Glossary_GetDetailed.json | 6 +- .../2023-09-01/examples/Glossary_GetTerm.json | 6 +- .../Glossary_GetTermWithoutAssets.json | 6 +- .../2023-09-01/examples/Glossary_List.json | 4 +- .../examples/Glossary_ListCategories.json | 6 +- .../Glossary_ListCategoriesHeaders.json | 6 +- .../examples/Glossary_ListCategoryTerms.json | 6 +- ...Glossary_ListEntitiesAssignedWithTerm.json | 6 +- .../Glossary_ListRelatedCategories.json | 6 +- .../examples/Glossary_ListRelatedTerms.json | 6 +- .../examples/Glossary_ListTermHeaders.json | 6 +- .../examples/Glossary_ListTerms.json | 6 +- .../examples/Glossary_PartialUpdate.json | 8 +- .../Glossary_PartialUpdateCategory.json | 8 +- .../examples/Glossary_PartialUpdateTerm.json | 10 +- ...sary_RemoveTermAssignmentFromEntities.json | 8 +- .../2023-09-01/examples/Glossary_Update.json | 8 +- .../examples/Glossary_UpdateCategory.json | 8 +- .../examples/Glossary_UpdateTerm.json | 8 +- .../2023-09-01/examples/Lineage_Get.json | 4 +- .../Lineage_GetByUniqueAttribute.json | 4 +- .../examples/Lineage_GetNextPage.json | 4 +- .../examples/Relationship_Create.json | 6 +- .../examples/Relationship_Delete.json | 4 +- .../2023-09-01/examples/Relationship_Get.json | 4 +- .../examples/Relationship_Update.json | 6 +- .../2023-09-01/examples/Type_BulkCreate.json | 6 +- .../Type_BulkCreateBusinessMetadataDefs.json | 6 +- .../2023-09-01/examples/Type_BulkDelete.json | 6 +- .../2023-09-01/examples/Type_BulkUpdate.json | 6 +- .../2023-09-01/examples/Type_Delete.json | 4 +- .../Type_GetBusinessMetadataDefByGuid.json | 4 +- .../Type_GetBusinessMetadataDefByName.json | 4 +- .../2023-09-01/examples/Type_GetByGuid.json | 4 +- .../2023-09-01/examples/Type_GetByName.json | 4 +- .../Type_GetClassificationDefByGuid.json | 4 +- .../Type_GetClassificationDefByName.json | 4 +- .../examples/Type_GetEntityDefByGuid.json | 4 +- .../examples/Type_GetEntityDefByName.json | 4 +- .../examples/Type_GetEnumDefByGuid.json | 4 +- .../examples/Type_GetEnumDefByName.json | 4 +- .../Type_GetRelationshipDefByGuid.json | 4 +- .../Type_GetRelationshipDefByName.json | 4 +- .../examples/Type_GetStructDefByGuid.json | 4 +- .../examples/Type_GetStructDefByName.json | 4 +- .../Type_GetTermTemplateDefByGuid.json | 4 +- .../Type_GetTermTemplateDefByName.json | 4 +- .../stable/2023-09-01/examples/Type_List.json | 7 +- .../examples/Type_ListEnumDefs.json | 7 +- .../2023-09-01/examples/Type_ListHeaders.json | 4 +- .../examples/Type_ListTermTemplateDefs.json | 7 +- .../stable/2023-09-01/purviewdatamap.json | 10655 ++--- specification/purview/data-plane/readme.md | 14 + .../PurviewPolicy.Management/backcompat.tsp | 15 + .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + .../PurviewPolicies_List_MaximumSet_Gen.json} | 31 +- .../PurviewPolicy.Management/main.tsp | 32 + .../PurviewPolicy.Management/policy.tsp | 146 + .../PurviewPolicy.Management/tspconfig.yaml | 12 + .../examples/Operations_List.json | 29 - .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + .../PurviewPolicies_List_MaximumSet_Gen.json | 69 + .../preview/2023-06-01-preview/policy.json | 374 +- .../examples/jobDelete.json | 13 + .../2023-11-13-preview/examples/jobGet.json | 57 + .../2023-11-13-preview/examples/jobList.json | 140 + .../2023-11-13-preview/examples/jobPatch.json | 55 + .../2023-11-13-preview/examples/jobPut.json | 95 + .../examples/providerStatus.json | 90 + .../examples/quotaList.json | 63 + .../examples/sessionClose.json | 30 + .../examples/sessionGet.json | 30 + .../examples/sessionJobsList.json | 84 + .../examples/sessionList.json | 49 + .../examples/sessionPut.json | 48 + .../examples/storageGet.json | 20 + .../examples/topLevelItemsList.json | 77 + .../preview/2023-11-13-preview/quantum.json | 1333 + specification/quantum/data-plane/readme.md | 11 +- .../quantum/data-plane/readme.python.md | 6 +- .../2023-11-13-preview/examples/listKeys.json | 25 + .../examples/offeringsList.json | 90 + .../examples/operations.json | 23 + ...uantumWorkspacesCheckNameAvailability.json | 20 + .../examples/quantumWorkspacesDelete.json | 27 + .../examples/quantumWorkspacesGet.json | 68 + .../quantumWorkspacesListResourceGroup.json | 55 + .../quantumWorkspacesListSubscription.json | 54 + .../examples/quantumWorkspacesPatch.json | 74 + .../examples/quantumWorkspacesPut.json | 137 + .../examples/regenerateKey.json | 17 + .../preview/2023-11-13-preview/quantum.json | 1130 + .../quantum/resource-manager/readme.md | 11 +- .../quantum/resource-manager/readme.python.md | 3 + .../examples/MigrationRecoveryPoints_Get.json | 28 + ...oints_ListByReplicationMigrationItems.json | 40 + .../2023-08-01/examples/Operations_List.json | 1228 + .../examples/RecoveryPoints_Get.json | 28 + ...oints_ListByReplicationProtectedItems.json | 40 + .../ReplicationAlertSettings_Create.json | 37 + .../ReplicationAlertSettings_Get.json | 28 + .../ReplicationAlertSettings_List.json | 31 + .../examples/ReplicationAppliances_List.json | 27 + .../ReplicationEligibilityResults_Get.json | 32 + .../ReplicationEligibilityResults_List.json | 43 + .../examples/ReplicationEvents_Get.json | 37 + .../examples/ReplicationEvents_List.json | 68 + .../ReplicationFabrics_CheckConsistency.json | 43 + .../examples/ReplicationFabrics_Create.json | 50 + .../examples/ReplicationFabrics_Delete.json | 22 + .../examples/ReplicationFabrics_Get.json | 37 + .../examples/ReplicationFabrics_List.json | 40 + .../ReplicationFabrics_MigrateToAad.json | 22 + .../examples/ReplicationFabrics_Purge.json | 22 + ...ReplicationFabrics_ReassociateGateway.json | 55 + .../ReplicationFabrics_RenewCertificate.json | 48 + .../ReplicationInfrastructure_Delete.json | 17 + .../examples/ReplicationJobs_Cancel.json | 60 + .../examples/ReplicationJobs_Export.json | 51 + .../examples/ReplicationJobs_Get.json | 62 + .../examples/ReplicationJobs_List.json | 73 + .../examples/ReplicationJobs_Restart.json | 61 + .../examples/ReplicationJobs_Resume.json | 84 + .../ReplicationLogicalNetworks_Get.json | 28 + ...icalNetworks_ListByReplicationFabrics.json | 42 + .../ReplicationMigrationItems_Create.json | 73 + .../ReplicationMigrationItems_Delete.json | 24 + .../ReplicationMigrationItems_Get.json | 46 + .../ReplicationMigrationItems_List.json | 47 + ...ListByReplicationProtectionContainers.json | 49 + .../ReplicationMigrationItems_Migrate.json | 60 + ...cationMigrationItems_PauseReplication.json | 53 + ...ationMigrationItems_ResumeReplication.json | 56 + .../ReplicationMigrationItems_Resync.json | 59 + ...ReplicationMigrationItems_TestMigrate.json | 60 + ...tionMigrationItems_TestMigrateCleanup.json | 56 + .../ReplicationMigrationItems_Update.json | 58 + .../ReplicationNetworkMappings_Create.json | 51 + .../ReplicationNetworkMappings_Delete.json | 24 + .../ReplicationNetworkMappings_Get.json | 36 + .../ReplicationNetworkMappings_List.json | 38 + ...orkMappings_ListByReplicationNetworks.json | 39 + .../ReplicationNetworkMappings_Update.json | 51 + .../examples/ReplicationNetworks_Get.json | 28 + .../examples/ReplicationNetworks_List.json | 52 + ...tionNetworks_ListByReplicationFabrics.json | 53 + .../examples/ReplicationPolicies_Create.json | 40 + .../examples/ReplicationPolicies_Delete.json | 22 + .../examples/ReplicationPolicies_Get.json | 27 + .../examples/ReplicationPolicies_List.json | 30 + .../examples/ReplicationPolicies_Update.json | 40 + .../ReplicationProtectableItems_Get.json | 35 + ...ListByReplicationProtectionContainers.json | 56 + .../ReplicationProtectedItems_AddDisks.json | 81 + ...tionProtectedItems_ApplyRecoveryPoint.json | 74 + .../ReplicationProtectedItems_Create.json | 72 + .../ReplicationProtectedItems_Delete.json | 31 + ...licationProtectedItems_FailoverCancel.json | 64 + ...licationProtectedItems_FailoverCommit.json | 65 + .../ReplicationProtectedItems_Get.json | 57 + .../ReplicationProtectedItems_List.json | 58 + ...ListByReplicationProtectionContainers.json | 60 + ...icationProtectedItems_PlannedFailover.json | 74 + .../ReplicationProtectedItems_Purge.json | 24 + ...ReplicationProtectedItems_RemoveDisks.json | 76 + ...ationProtectedItems_RepairReplication.json | 63 + .../ReplicationProtectedItems_Reprotect.json | 74 + ...ionProtectedItems_ResolveHealthErrors.json | 76 + ...licationProtectedItems_SwitchProvider.json | 77 + ...eplicationProtectedItems_TestFailover.json | 71 + ...ionProtectedItems_TestFailoverCleanup.json | 71 + ...ationProtectedItems_UnplannedFailover.json | 75 + .../ReplicationProtectedItems_Update.json | 88 + ...icationProtectedItems_UpdateAppliance.json | 76 + ...nProtectedItems_UpdateMobilityService.json | 67 + ...ionProtectionContainerMappings_Create.json | 51 + ...ionProtectionContainerMappings_Delete.json | 29 + ...cationProtectionContainerMappings_Get.json | 35 + ...ationProtectionContainerMappings_List.json | 36 + ...ListByReplicationProtectionContainers.json | 38 + ...tionProtectionContainerMappings_Purge.json | 24 + ...ionProtectionContainerMappings_Update.json | 57 + ...eplicationProtectionContainers_Create.json | 45 + ...eplicationProtectionContainers_Delete.json | 23 + ...ionContainers_DiscoverProtectableItem.json | 43 + .../ReplicationProtectionContainers_Get.json | 30 + .../ReplicationProtectionContainers_List.json | 32 + ...onContainers_ListByReplicationFabrics.json | 33 + ...ProtectionContainers_SwitchProtection.json | 44 + .../ReplicationProtectionIntents_Create.json | 43 + .../ReplicationProtectionIntents_Get.json | 34 + .../ReplicationProtectionIntents_List.json | 37 + .../ReplicationRecoveryPlans_Create.json | 88 + .../ReplicationRecoveryPlans_Delete.json | 22 + ...plicationRecoveryPlans_FailoverCancel.json | 51 + ...plicationRecoveryPlans_FailoverCommit.json | 88 + .../ReplicationRecoveryPlans_Get.json | 73 + .../ReplicationRecoveryPlans_List.json | 41 + ...licationRecoveryPlans_PlannedFailover.json | 99 + .../ReplicationRecoveryPlans_Reprotect.json | 88 + ...ReplicationRecoveryPlans_TestFailover.json | 96 + ...tionRecoveryPlans_TestFailoverCleanup.json | 93 + ...cationRecoveryPlans_UnplannedFailover.json | 100 + .../ReplicationRecoveryPlans_Update.json | 119 + ...ationRecoveryServicesProviders_Create.json | 61 + ...ationRecoveryServicesProviders_Delete.json | 23 + ...licationRecoveryServicesProviders_Get.json | 36 + ...icationRecoveryServicesProviders_List.json | 38 + ...cesProviders_ListByReplicationFabrics.json | 39 + ...cationRecoveryServicesProviders_Purge.json | 23 + ...veryServicesProviders_RefreshProvider.json | 42 + ...nStorageClassificationMappings_Create.json | 37 + ...nStorageClassificationMappings_Delete.json | 24 + ...tionStorageClassificationMappings_Get.json | 26 + ...ionStorageClassificationMappings_List.json | 27 + ...stByReplicationStorageClassifications.json | 29 + ...ReplicationStorageClassifications_Get.json | 25 + ...eplicationStorageClassifications_List.json | 27 + ...ssifications_ListByReplicationFabrics.json | 28 + .../examples/ReplicationVaultHealth_Get.json | 44 + .../ReplicationVaultHealth_Refresh.json | 37 + .../ReplicationVaultSetting_Create.json | 29 + .../examples/ReplicationVaultSetting_Get.json | 24 + .../ReplicationVaultSetting_List.json | 28 + .../examples/ReplicationvCenters_Create.json | 47 + .../examples/ReplicationvCenters_Delete.json | 23 + .../examples/ReplicationvCenters_Get.json | 32 + .../examples/ReplicationvCenters_List.json | 34 + ...tionvCenters_ListByReplicationFabrics.json | 35 + .../examples/ReplicationvCenters_Update.json | 43 + .../SupportedOperatingSystems_Get.json | 48 + ...Sizes_ListByReplicationProtectedItems.json | 57 + .../stable/2023-08-01/service.json | 25387 ++++++++++++ .../resource-manager/readme.md | 13 +- .../2024-02-01/examples/OperationsList.json | 31 + .../examples/OperationsStatusGet.json | 19 + .../examples/RedisEnterpriseCreate.json | 124 + .../RedisEnterpriseDatabasesCreate.json | 108 + ...riseDatabasesCreateWithGeoReplication.json | 86 + .../RedisEnterpriseDatabasesDelete.json | 19 + .../RedisEnterpriseDatabasesExport.json | 21 + .../RedisEnterpriseDatabasesFlush.json | 22 + .../RedisEnterpriseDatabasesForceUnlink.json | 22 + .../examples/RedisEnterpriseDatabasesGet.json | 37 + .../RedisEnterpriseDatabasesImport.json | 24 + ...RedisEnterpriseDatabasesListByCluster.json | 40 + .../RedisEnterpriseDatabasesListKeys.json | 17 + ...RedisEnterpriseDatabasesRegenerateKey.json | 26 + .../RedisEnterpriseDatabasesUpdate.json | 53 + .../examples/RedisEnterpriseDelete.json | 18 + ...rpriseDeletePrivateEndpointConnection.json | 19 + .../examples/RedisEnterpriseGet.json | 50 + ...nterpriseGetPrivateEndpointConnection.json | 29 + .../examples/RedisEnterpriseList.json | 33 + .../RedisEnterpriseListByResourceGroup.json | 39 + ...erpriseListPrivateEndpointConnections.json | 49 + ...disEnterpriseListPrivateLinkResources.json | 30 + ...nterprisePutPrivateEndpointConnection.json | 37 + .../examples/RedisEnterpriseUpdate.json | 59 + .../stable/2024-02-01/redisenterprise.json | 1955 + .../resource-manager/readme.md | 13 +- .../scvmm/resource-manager/readme.java.md | 53 +- .../scvmm/resource-manager/readme.md | 4 + .../SearchIndexAutocompleteDocumentsGet.json | 38 + .../SearchIndexAutocompleteDocumentsPost.json | 36 + .../examples/SearchIndexCountDocuments.json | 12 + .../examples/SearchIndexGetDocument.json | 22 + .../examples/SearchIndexIndexDocuments.json | 93 + .../SearchIndexSearchDocumentsGet.json | 86 + .../SearchIndexSearchDocumentsPost.json | 118 + .../SearchIndexSuggestDocumentsGet.json | 47 + .../SearchIndexSuggestDocumentsPost.json | 39 + .../examples/SearchServiceCreateAlias.json | 22 + .../SearchServiceCreateDataSource.json | 70 + .../examples/SearchServiceCreateIndex.json | 690 + .../examples/SearchServiceCreateIndexer.json | 58 + .../SearchServiceCreateOrUpdateAlias.json | 32 + ...SearchServiceCreateOrUpdateDataSource.json | 95 + .../SearchServiceCreateOrUpdateIndex.json | 1050 + .../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 | 412 + .../SearchServiceGetIndexStatistics.json | 16 + .../examples/SearchServiceGetIndexer.json | 36 + .../SearchServiceGetIndexerStatus.json | 89 + .../SearchServiceGetServiceStatistics.json | 56 + .../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 + .../2024-03-01-Preview/searchindex.json | 2826 ++ .../2024-03-01-Preview/searchservice.json | 12259 ++++++ .../search/data-plane/Azure.Search/readme.md | 36 +- .../resource-manager/readme.python.md | 5 - .../2023-12-01-preview/AlertRules.json | 2600 ++ .../2023-12-01-preview/AutomationRules.json | 1495 + .../2023-12-01-preview/BillingStatistics.json | 226 + .../preview/2023-12-01-preview/Bookmarks.json | 751 + .../2023-12-01-preview/ContentPackages.json | 319 + .../ContentProductPackages.json | 232 + .../ContentProductTemplates.json | 226 + .../2023-12-01-preview/ContentTemplates.json | 353 + .../2023-12-01-preview/Enrichment.json | 381 + .../preview/2023-12-01-preview/Entities.json | 1556 + .../2023-12-01-preview/EntityQueries.json | 507 + .../EntityQueryTemplates.json | 304 + .../2023-12-01-preview/FileImports.json | 564 + .../preview/2023-12-01-preview/Hunts.json | 994 + .../preview/2023-12-01-preview/Incidents.json | 1658 + .../preview/2023-12-01-preview/Metadata.json | 774 + .../2023-12-01-preview/OfficeConsents.json | 234 + .../2023-12-01-preview/OnboardingStates.json | 284 + .../2023-12-01-preview/Recommendations.json | 564 + .../SecurityMLAnalyticsSettings.json | 444 + .../preview/2023-12-01-preview/Settings.json | 423 + .../2023-12-01-preview/SourceControls.json | 1005 + .../ThreatIntelligence.json | 1097 + .../TriggeredAnalyticsRuleRuns.json | 353 + .../2023-12-01-preview/Watchlists.json | 721 + .../WorkspaceManagerAssignments.json | 737 + .../WorkspaceManagerConfigurations.json | 323 + .../WorkspaceManagerGroups.json | 318 + .../WorkspaceManagerMembers.json | 310 + .../2023-12-01-preview/common/AlertTypes.json | 81 + .../common/ContentCommonTypes.json | 646 + .../common/EntityTypes.json | 2550 ++ .../common/IncidentTypes.json | 246 + .../common/RelationTypes.json | 95 + .../common/ThreatIntelligenceTypes.json | 48 + .../dataConnectorDefinitions.json | 737 + .../2023-12-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 | 34 + .../examples/contentPackages/GetPackages.json | 39 + .../GetProductPackageById.json | 76 + .../contentPackages/GetProductPackages.json | 78 + .../contentPackages/InstallPackage.json | 151 + .../contentPackages/UninstallPackage.json | 13 + .../contentTemplates/DeleteTemplate.json | 13 + .../GetProductTemplateById.json | 43 + .../contentTemplates/GetProductTemplates.json | 45 + .../contentTemplates/GetTemplateById.json | 41 + .../contentTemplates/GetTemplates.json | 43 + .../contentTemplates/InstallTemplate.json | 228 + ...teCustomizableDataConnectorDefinition.json | 264 + .../DeleteDataConnectorDefinitionById.json | 13 + ...stomizableDataConnectoeDefinitionById.json | 101 + .../GetDataConnectorDefinitions.json | 100 + ...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 | 37 + ...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 | 162 + .../sourcecontrols/DeleteSourceControl.json | 29 + .../sourcecontrols/GetSourceControlById.json | 75 + .../sourcecontrols/GetSourceControls.json | 78 + .../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-12-01-preview/operations.json | 138 + .../resource-manager/readme.md | 44 +- .../servicefabric/resource-manager/readme.md | 6 +- .../managedapplication.json | 2 + .../2023-12-01-preview/managedcluster.json | 2 + .../ServiceNetworking.Management/main.tsp | 22 +- .../stable/2023-11-01/TrafficController.json | 60 +- .../sphere/Sphere.Management/catalog.tsp | 42 +- .../sphere/Sphere.Management/common.tsp | 47 +- .../sphere/Sphere.Management/device.tsp | 35 +- .../sphere/Sphere.Management/deviceGroup.tsp | 59 +- .../DeleteCatalog.json | 0 .../DeleteDeployment.json | 0 .../DeleteDevice.json | 0 .../DeleteDeviceGroup.json | 0 .../{ => 2022-09-01-preview}/DeleteImage.json | 2 +- .../DeleteProduct.json | 0 .../{ => 2022-09-01-preview}/GetCatalog.json | 0 .../GetCatalogsRG.json | 0 .../GetCatalogsSub.json | 0 .../GetCertificate.json | 0 .../GetCertificates.json | 0 .../GetDeployment.json | 0 .../GetDeployments.json | 0 .../{ => 2022-09-01-preview}/GetDevice.json | 0 .../GetDeviceGroup.json | 0 .../GetDeviceGroups.json | 0 .../{ => 2022-09-01-preview}/GetDevices.json | 0 .../{ => 2022-09-01-preview}/GetImage.json | 2 +- .../{ => 2022-09-01-preview}/GetImages.json | 0 .../GetOperations.json | 0 .../{ => 2022-09-01-preview}/GetProduct.json | 0 .../{ => 2022-09-01-preview}/GetProducts.json | 0 .../PatchCatalog.json | 0 .../{ => 2022-09-01-preview}/PatchDevice.json | 0 .../PatchDeviceGroup.json | 0 .../PatchProduct.json | 0 .../PostClaimDevices.json | 0 .../PostCountDevicesCatalog.json | 0 .../PostCountDevicesDeviceGroup.json | 0 .../PostCountDevicesProduct.json | 0 .../PostGenerateDefaultDeviceGroups.json | 0 .../PostGenerateDeviceCapabilityImage.json | 0 .../PostListDeploymentsByCatalog.json | 0 .../PostListDeviceGroupsCatalog.json | 0 .../PostListDeviceInsightsCatalog.json | 0 .../PostListDevicesByCatalog.json | 0 .../PostRetrieveCatalogCertChain.json | 0 .../PostRetrieveProofOfPossessionNonce.json | 0 .../{ => 2022-09-01-preview}/PutCatalog.json | 0 .../PutDeployment.json | 0 .../{ => 2022-09-01-preview}/PutDevice.json | 0 .../PutDeviceGroup.json | 0 .../{ => 2022-09-01-preview}/PutImage.json | 2 +- .../{ => 2022-09-01-preview}/PutProduct.json | 0 .../examples/2024-04-01/DeleteCatalog.json | 24 + .../examples/2024-04-01/DeleteDeployment.json | 27 + .../examples/2024-04-01/DeleteDevice.json | 27 + .../2024-04-01/DeleteDeviceGroup.json | 26 + .../examples/2024-04-01/DeleteImage.json | 25 + .../examples/2024-04-01/DeleteProduct.json | 25 + .../examples/2024-04-01/GetCatalog.json | 21 + .../examples/2024-04-01/GetCatalogsRG.json | 30 + .../examples/2024-04-01/GetCatalogsSub.json | 29 + .../examples/2024-04-01/GetCertificate.json | 17 + .../examples/2024-04-01/GetCertificates.json | 18 + .../examples/2024-04-01/GetDeployment.json | 38 + .../examples/2024-04-01/GetDeployments.json | 42 + .../examples/2024-04-01/GetDevice.json | 29 + .../examples/2024-04-01/GetDeviceGroup.json | 26 + .../examples/2024-04-01/GetDeviceGroups.json | 30 + .../examples/2024-04-01/GetDevices.json | 29 + .../examples/2024-04-01/GetImage.json | 17 + .../examples/2024-04-01/GetImages.json | 27 + .../examples/2024-04-01/GetOperations.json | 35 + .../examples/2024-04-01/GetProduct.json | 23 + .../examples/2024-04-01/GetProducts.json | 29 + .../examples/2024-04-01/PatchCatalog.json | 25 + .../examples/2024-04-01/PatchDevice.json | 36 + .../examples/2024-04-01/PatchDeviceGroup.json | 33 + .../examples/2024-04-01/PatchProduct.json | 30 + .../examples/2024-04-01/PostClaimDevices.json | 25 + .../2024-04-01/PostCountDevicesCatalog.json | 18 + .../PostCountDevicesDeviceGroup.json | 20 + .../2024-04-01/PostCountDevicesProduct.json | 21 + .../PostGenerateDefaultDeviceGroups.json | 40 + .../PostGenerateDeviceCapabilityImage.json | 32 + .../PostListDeploymentsByCatalog.json | 27 + .../PostListDeviceGroupsCatalog.json | 32 + .../PostListDeviceInsightsCatalog.json | 40 + .../2024-04-01/PostListDevicesByCatalog.json | 27 + .../PostRetrieveCatalogCertChain.json | 19 + .../PostRetrieveProofOfPossessionNonce.json | 22 + .../2024-04-01/PostUploadImageCatalog.json | 23 + .../examples/2024-04-01/PutCatalog.json | 34 + .../examples/2024-04-01/PutDeployment.json | 47 + .../examples/2024-04-01/PutDevice.json | 34 + .../examples/2024-04-01/PutDeviceGroup.json | 46 + .../examples/2024-04-01/PutImage.json | 34 + .../examples/2024-04-01/PutProduct.json | 30 + .../sphere/Sphere.Management/image.tsp | 62 +- .../sphere/Sphere.Management/main.tsp | 17 +- .../sphere/Sphere.Management/product.tsp | 19 +- .../2022-09-01-preview/azuresphere.json | 128 +- .../examples/DeleteImage.json | 2 +- .../2022-09-01-preview/examples/GetImage.json | 2 +- .../2022-09-01-preview/examples/PutImage.json | 2 +- .../stable/2024-04-01/azuresphere.json | 4374 ++ .../2024-04-01/examples/DeleteCatalog.json | 24 + .../2024-04-01/examples/DeleteDeployment.json | 27 + .../2024-04-01/examples/DeleteDevice.json | 27 + .../examples/DeleteDeviceGroup.json | 26 + .../2024-04-01/examples/DeleteImage.json | 25 + .../2024-04-01/examples/DeleteProduct.json | 25 + .../2024-04-01/examples/GetCatalog.json | 21 + .../2024-04-01/examples/GetCatalogsRG.json | 30 + .../2024-04-01/examples/GetCatalogsSub.json | 29 + .../2024-04-01/examples/GetCertificate.json | 17 + .../2024-04-01/examples/GetCertificates.json | 18 + .../2024-04-01/examples/GetDeployment.json | 38 + .../2024-04-01/examples/GetDeployments.json | 42 + .../stable/2024-04-01/examples/GetDevice.json | 29 + .../2024-04-01/examples/GetDeviceGroup.json | 26 + .../2024-04-01/examples/GetDeviceGroups.json | 30 + .../2024-04-01/examples/GetDevices.json | 29 + .../stable/2024-04-01/examples/GetImage.json | 17 + .../stable/2024-04-01/examples/GetImages.json | 27 + .../2024-04-01/examples/GetOperations.json | 35 + .../2024-04-01/examples/GetProduct.json | 23 + .../2024-04-01/examples/GetProducts.json | 29 + .../2024-04-01/examples/PatchCatalog.json | 25 + .../2024-04-01/examples/PatchDevice.json | 36 + .../2024-04-01/examples/PatchDeviceGroup.json | 33 + .../2024-04-01/examples/PatchProduct.json | 30 + .../2024-04-01/examples/PostClaimDevices.json | 25 + .../examples/PostCountDevicesCatalog.json | 18 + .../examples/PostCountDevicesDeviceGroup.json | 20 + .../examples/PostCountDevicesProduct.json | 21 + .../PostGenerateDefaultDeviceGroups.json | 40 + .../PostGenerateDeviceCapabilityImage.json | 32 + .../PostListDeploymentsByCatalog.json | 27 + .../examples/PostListDeviceGroupsCatalog.json | 32 + .../PostListDeviceInsightsCatalog.json | 40 + .../examples/PostListDevicesByCatalog.json | 27 + .../PostRetrieveCatalogCertChain.json | 19 + .../PostRetrieveProofOfPossessionNonce.json | 22 + .../examples/PostUploadImageCatalog.json | 23 + .../2024-04-01/examples/PutCatalog.json | 34 + .../2024-04-01/examples/PutDeployment.json | 47 + .../stable/2024-04-01/examples/PutDevice.json | 34 + .../2024-04-01/examples/PutDeviceGroup.json | 46 + .../stable/2024-04-01/examples/PutImage.json | 34 + .../2024-04-01/examples/PutProduct.json | 30 + .../sphere/resource-manager/readme.md | 10 + .../resource-manager/readme.java.md | 8 + .../storageactions/resource-manager/readme.md | 5 + .../resource-manager/readme.python.md | 1 + .../2020-12-01/entityTypes/Dataset.json | 20 + .../2020-12-01/entityTypes/LinkedService.json | 101 + .../2020-12-01/entityTypes/Pipeline.json | 62 +- .../SparkFrontend_SparkBatch_Create.json | 2 +- .../Azure.AI.DocumentTranslation/main.tsp | 11 +- .../preview/2023-11-01-preview/openapi.json | 14 + .../SAPVirtualInstance/readme.java.md | 7 + .../SAPVirtualInstance/readme.md | 5 + .../SAPVirtualInstance/readme.python.md | 4 +- tsconfig.json | 26 +- 4369 files changed, 687662 insertions(+), 18338 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/01_question.yml create mode 100644 .github/ISSUE_TEMPLATE/02_bug.yml create mode 100644 .github/ISSUE_TEMPLATE/03_feature_request.yml delete mode 100644 .github/issue_assignment.yml delete mode 100644 .github/pull_request_assignment.yml create mode 100644 eng/scripts/Copy-ApiVersion.ps1 create mode 100644 specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.elements.tsp create mode 100644 specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.resources.tsp create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulOncoPhenotypeRequest.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulOncoPhenotypeResponse.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulPatientTimelineRequest.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulPatientTimelineResponse.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulRadiologyInsightsRequest.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulRadiologyInsightsResponse.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulTrialMatcherRequest.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulTrialMatcherResponse.json create mode 100644 specification/ai/HealthInsights/HealthInsights.PatientTimeline/client.tsp create mode 100644 specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp create mode 100644 specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp create mode 100644 specification/ai/HealthInsights/HealthInsights.PatientTimeline/tspconfig.yaml create mode 100644 specification/ai/HealthInsights/HealthInsights.RadiologyInsights/client.tsp create mode 100644 specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.tsp create mode 100644 specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.valuesets.tsp create mode 100644 specification/ai/HealthInsights/HealthInsights.RadiologyInsights/route.radiologyinsights.tsp create mode 100644 specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml delete mode 100644 specification/ai/HealthInsights/service.tsp rename specification/ai/{data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromBuffer_MaximumSet.json => ImageAnalysis/examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json} (99%) create mode 100644 specification/ai/OpenAI.Assistants/.gitignore create mode 100644 specification/ai/OpenAI.Assistants/README.md create mode 100644 specification/ai/OpenAI.Assistants/assistants/main.tsp create mode 100644 specification/ai/OpenAI.Assistants/assistants/models.tsp create mode 100644 specification/ai/OpenAI.Assistants/assistants/routes.tsp create mode 100644 specification/ai/OpenAI.Assistants/client.tsp create mode 100644 specification/ai/OpenAI.Assistants/common/models.tsp create mode 100644 specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json create mode 100644 specification/ai/OpenAI.Assistants/files/main.tsp create mode 100644 specification/ai/OpenAI.Assistants/files/models.tsp create mode 100644 specification/ai/OpenAI.Assistants/files/routes.tsp create mode 100644 specification/ai/OpenAI.Assistants/main.tsp create mode 100644 specification/ai/OpenAI.Assistants/messages/main.tsp create mode 100644 specification/ai/OpenAI.Assistants/messages/models.tsp create mode 100644 specification/ai/OpenAI.Assistants/messages/routes.tsp create mode 100644 specification/ai/OpenAI.Assistants/run_steps/main.tsp create mode 100644 specification/ai/OpenAI.Assistants/run_steps/models.tsp create mode 100644 specification/ai/OpenAI.Assistants/run_steps/routes.tsp create mode 100644 specification/ai/OpenAI.Assistants/runs/main.tsp create mode 100644 specification/ai/OpenAI.Assistants/runs/models.tsp create mode 100644 specification/ai/OpenAI.Assistants/runs/routes.tsp create mode 100644 specification/ai/OpenAI.Assistants/threads/main.tsp create mode 100644 specification/ai/OpenAI.Assistants/threads/models.tsp create mode 100644 specification/ai/OpenAI.Assistants/threads/routes.tsp create mode 100644 specification/ai/OpenAI.Assistants/tools/models.tsp create mode 100644 specification/ai/OpenAI.Assistants/tspconfig.yaml create mode 100644 specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulOncoPhenotypeRequest.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulOncoPhenotypeResponse.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulPatientTimelineRequest.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulPatientTimelineResponse.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulRadiologyInsightsRequest.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulRadiologyInsightsResponse.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulTrialMatcherRequest.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulTrialMatcherResponse.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/openapi.json rename specification/ai/{ImageAnalysis/examples/2023-10-01/AnalyzeFromBuffer_MaximumSet.json => data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json} (99%) create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml create mode 100644 specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml delete mode 100644 specification/ai/readme.md create mode 100644 specification/apicenter/ApiCenter.Management/Api.tsp create mode 100644 specification/apicenter/ApiCenter.Management/ApiDefinition.tsp create mode 100644 specification/apicenter/ApiCenter.Management/ApiVersion.tsp create mode 100644 specification/apicenter/ApiCenter.Management/Deployment.tsp create mode 100644 specification/apicenter/ApiCenter.Management/Environment.tsp create mode 100644 specification/apicenter/ApiCenter.Management/MetadataSchema.tsp create mode 100644 specification/apicenter/ApiCenter.Management/Service.tsp create mode 100644 specification/apicenter/ApiCenter.Management/Workspace.tsp create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_ExportSpecification.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_ImportSpecification.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Operations_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_ExportMetadataSchema.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_ListByResourceGroup.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_ListBySubscription.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_Update.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_List.json create mode 100644 specification/apicenter/ApiCenter.Management/main.tsp create mode 100644 specification/apicenter/ApiCenter.Management/models.tsp create mode 100644 specification/apicenter/ApiCenter.Management/tspconfig.yaml create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_ValidateDomain.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_ListSecretKeys.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveView_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveViews_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveViews_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveViews_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_CreateOrUpdate_VNetInjection.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_GetResourceUploadUrl.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Get_VNetInjection.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_List_VNetInjection.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_SetActiveDeployments.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Update.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Update_VNetInjection.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_ValidateDomain.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_Update.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceAgentPool_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceAgentPool_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceAgentPool_UpdatePut.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_ListDeployments.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_CreateOrUpdateBuild.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_DeleteBuild.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuild.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuildResult.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuildResultLog.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuildService.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetResourceUploadUrl.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetSupportedBuildpack.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetSupportedStack.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListBuildResults.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListBuildServices.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListBuilds.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListSupportedBuildpacks.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListSupportedStacks.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_ListForCluster.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_Get_Consumption.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePatch.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePatch_Consumption.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePut.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePut_Consumption.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_Validate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_Validate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_ValidateResource.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_Validate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_Update.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_Validate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_CreateOrUpdate_CustomContainer.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_DisableRemoteDebugging.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_EnableRemoteDebugging.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GenerateHeapDump.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GenerateThreadDump.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GetLogFileUrl.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GetRemoteDebuggingConfig.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Get_CustomContainer.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_ListForCluster.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Restart.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Start.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_StartJFR.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Stop.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Update.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Update_CustomContainer.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortal_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortals_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortals_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortals_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_Get_Consumption.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_List_Consumption.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_UpdatePatch_Consumption.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_UpdatePut_Consumption.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateway_Scale.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_ListEnvSecrets.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_Restart.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_ValidateDomain.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/MonitoringSettings_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/MonitoringSettings_UpdatePatch.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/MonitoringSettings_UpdatePut.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Operations_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_Disable.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_Enable.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/RuntimeVersions_ListRuntimeVersions.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CheckNameAvailability.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate_Consumption.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate_Enterprise.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate_VNetInjection.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_DisableApmGlobally.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_DisableTestEndpoint.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_EnableApmGlobally.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_EnableTestEndpoint.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_FlushVnetDnsSetting.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Get_Consumption.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListBySubscription.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListGloballyEnabledApms.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListSupportedApmTypes.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListSupportedServerVersions.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListTestKeys.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_RegenerateTestKey.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Start.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Stop.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Update.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Skus_List.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_CreateOrUpdate.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_Delete.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_Get.json create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_List.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/azuredatatransfer.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/approveOrRejectConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/createOrUpdateConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/createOrUpdateFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/createOrUpdatePipeline.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/deleteConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/deleteFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/deletePipeline.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/enableOrDisableFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/getConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/getFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/getPipeline.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/linkConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/linkFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listConnectionsByResourceGroup.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listConnectionsBySubscription.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listFlowsByConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listOperations.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPendingConnections.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPendingFlows.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPipelinesByResourceGroup.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPipelinesBySubscription.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listSchemas.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/patchConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/patchFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/patchPipeline.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/postListApprovedSchemas.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/postValidateSchema.json create mode 100644 specification/azuredatatransfer/resource-manager/readme.az.md create mode 100644 specification/azuredatatransfer/resource-manager/readme.cli.md create mode 100644 specification/azuredatatransfer/resource-manager/readme.csharp.md create mode 100644 specification/azuredatatransfer/resource-manager/readme.go.md create mode 100644 specification/azuredatatransfer/resource-manager/readme.md create mode 100644 specification/azuredatatransfer/resource-manager/readme.python.md create mode 100644 specification/azuredatatransfer/resource-manager/readme.typescript.md create mode 100644 specification/azurelargeinstance/resource-manager/readme.java.md create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/azureopenai.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/azureopenai.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/cancel_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/cancel_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file_content.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file_content.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job_events.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job_events.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_jobs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_jobs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_base.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_base.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_finetune.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_finetune.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_models.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_models.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/import_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/import_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/post_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/post_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/upload_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/upload_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_speech.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_speech.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_object.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_text.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_object.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_text.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/cancel_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/cancel_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_aml_index.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_aml_index.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_advanced.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_advanced.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_image_vector.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_image_vector.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_minimum.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_minimum.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_cosmos_db.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_cosmos_db.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_elasticsearch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_elasticsearch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_pinecone.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_pinecone.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread_and_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread_and_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/embeddings.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/embeddings.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_assistant_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_assistant_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run_step.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run_step.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/image_generation.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/image_generation.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistant_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistant_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistants.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistants.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_message_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_message_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_messages.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_messages.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_run_steps.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_run_steps.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_runs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_runs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.yaml create mode 100644 specification/common-types/resource-management/v6/privatelinks.json create mode 100644 specification/communication/data-plane/Sms/preview/2024-02-05-preview/communicationservicessms.json create mode 100644 specification/communication/data-plane/Sms/preview/2024-02-05-preview/examples/send.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/communityGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_Get.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_List.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImage_Get.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImage_List.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGallery_Get.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/CommunityGallery_Create.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/CommunityGallery_Get.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Create.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Delete.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Get.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Get_WithReplicationStatus.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_ListByGalleryApplication.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Update.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Create.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Delete.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Get.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_ListByGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Update.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithCommunityImageVersionAsSource.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithImageVersionAsSource.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithShallowReplicationMode.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithTargetExtendedLocations.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD_UefiSettings.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithVmAsSource.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Delete.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get_WithReplicationStatus.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get_WithSnapshotsAsSource.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get_WithVhdAsSource.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_ListByGalleryImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Update.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Update_WithoutSourceId.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Create.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Delete.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Get.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_ListByGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Update.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_AddToSharingProfile.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Create.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Create_SoftDeletionEnabled.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Create_WithSharingProfile.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Delete.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_EnableCommunityGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Get.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Get_WithExpandSharingProfileGroups.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Get_WithSelectPermissions.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_ListByResourceGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_ListBySubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_ResetSharingProfile.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Update.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImageVersions_List.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImage_Get.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImages_List.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGallery_Get.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGallery_List.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/gallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/galleryRPCommon.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/sharedGallery.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsAbortOperation.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsAssociate_CRG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableFIPS.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Ephemeral.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_GPUMIG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_OSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Snapshot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Spot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_WasmWasi.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsDeleteMachines.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPools_Start.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPools_Stop.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPools_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ContainerServiceGetOSOptions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/GetGuardrailsVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/GetSafeguardsVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/KubernetesVersions_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ListGuardrailsVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ListSafeguardsVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MachineGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MachineList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsCreate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersAbortOperation.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersAssociate_CRG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_GPUMIG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_HTTPProxy.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_MCSnapshot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_OSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PodIdentity.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_Premium.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_SecurityProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_Snapshot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_VirtualMachines.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGetAccessProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersListClusterCredentialResult.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersResetAADProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersRotateClusterCertificates.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersStart.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersStop.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OperationStatusResultGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OperationStatusResultGetByAgentPool.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OperationStatusResultList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/Operation_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateLinkResourcesList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ResolvePrivateLinkServiceId.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/RunCommandRequest.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/RunCommandResultFailed.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/RunCommandResultSucceed.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsCreate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_Delete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_Get.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoles_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/managedClusters.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/scheduledEvents.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsAbortOperation.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_CRG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_CustomNodeConfig.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_DedicatedHostGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_EnableFIPS.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_EnableUltraSSD.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Ephemeral.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_GPUMIG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_OSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Snapshot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Spot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_WasmWasi.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_WindowsOSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsUpgradeNodeImageVersion.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPools_Start.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPools_Stop.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPools_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ContainerServiceGetOSOptions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/KubernetesVersions_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersAbortOperation.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_AzureServiceMesh.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_CRG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_DedicatedHostGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_DisableRunCommand.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_DualStackNetworking.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_EnableUltraSSD.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_EnabledFIPS.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_GPUMIG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_HTTPProxy.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_ManagedNATGateway.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_OSSKU.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PodIdentity.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_Premium.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_SecurityProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_Snapshot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UpdateWithAHUB.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGetAccessProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGet_MeshRevisionProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGet_MeshUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListClusterAdminCredentials.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListClusterUserCredentials.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersList_MeshRevisionProfiles.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersList_MeshUpgradeProfiles.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersResetAADProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersResetServicePrincipalProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersRotateClusterCertificates.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersStart.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersStop.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/Operation_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/OutboundNetworkDependenciesEndpointsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateLinkResourcesList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ResolvePrivateLinkServiceId.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/RunCommandRequest.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/RunCommandResultFailed.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/RunCommandResultSucceed.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsCreate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_Delete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_Get.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoles_List.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/managedClusters.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/dataTransferService.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionGetMetricDefinitions.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionGetUsages.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionPartitionGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionPartitionGetUsages.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionPartitionRegionGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDataTransferServiceCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDataTransferServiceDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDataTransferServiceGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountCheckNameExists.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountCreateMax.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountCreateMin.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGetMetricDefinitions.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGetUsages.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListByResourceGroup.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListConnectionStrings.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListKeys.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListReadOnlyKeys.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountOfflineRegion.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountOnlineRegion.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountPatch.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountRegenerateKey.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountRegionGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseGetMetricDefinitions.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseGetUsages.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphAPIComputeServiceCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphAPIComputeServiceDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphAPIComputeServiceGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphBackupInformation.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBLocationGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBLocationList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraBackup.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraBackupsList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterDeallocate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterListByResourceGroup.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterListBySubscription.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterPatch.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterStart.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommand.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommandAsync.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommandResult.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommandResultList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterPatch.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraListCommand.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraStatus.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMaterializedViewsBuilderServiceCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMaterializedViewsBuilderServiceDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMaterializedViewsBuilderServiceGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionBackupInformation.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionPartitionMerge.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionRedistributeThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionRestore.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionRetrieveThroughputDistribution.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabasePartitionMerge.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseRedistributeThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseRestore.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseRetrieveThroughputDistribution.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceStart.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBOperationsList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPKeyRangeIdGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPKeyRangeIdRegionGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPercentileGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPercentileSourceTargetGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPercentileTargetGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionListGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateLinkResourceGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateLinkResourceListGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRegionCollectionGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableDatabaseAccountGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableDatabaseAccountList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableGremlinDatabaseList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableGremlinGraphList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableGremlinResourceList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableMongodbCollectionList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableMongodbDatabaseList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableMongodbResourceList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableSqlContainerList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableSqlDatabaseList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableSqlResourceList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableTableList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableTableResourceList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBServicesList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlClientEncryptionKeyCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlClientEncryptionKeyGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlClientEncryptionKeysList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerBackupInformation.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerPartitionMerge.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerRedistributeThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerRestore.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerRetrieveThroughputDistribution.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabasePartitionMerge.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseRedistributeThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseRestore.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseRetrieveThroughputDistribution.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDedicatedGatewayServiceCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDedicatedGatewayServiceDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDedicatedGatewayServiceGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlMaterializedViewCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableBackupInformation.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobCancel.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobComplete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobFeed.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobPause.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobResume.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterAddNode.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterCreatePITR.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterListByResourceGroup.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterListConnectionStrings.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterNameAvailability.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterNameAvailability_AlreadyExists.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountsList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/mongoCluster.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/mongorbac.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/notebook.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/privateEndpointConnection.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/privateLinkResources.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/rbac.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/restorable.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/services.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/throughputpool.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/databox.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/AvailableSkusPost.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/BookShipmentPickupPost.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobMitigate.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCancelPost.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreate.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateDevicePassword.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateDoubleEncryption.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateExport.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateWithUserAssignedIdentity.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsDelete.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGet.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetCmk.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetCopyStuck.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetExport.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetWaitingForAction.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsList.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsListByResourceGroup.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsListCredentials.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsPatch.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsPatchCmk.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsPatchSystemAssignedToUserAssigned.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/MarkDevicesShipped.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/OperationsGet.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/RegionConfiguration.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/RegionConfigurationByResourceGroup.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/ValidateAddressPost.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/ValidateInputs.json create mode 100644 specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/ValidateInputsByResourceGroup.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/databoxedge.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/AlertGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/AlertGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/AvailableSkusList.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthScheduleDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthScheduleGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthScheduleGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthSchedulePut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerListAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerPut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerRefresh.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetByName.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetBySubscription.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDevicePatch.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDevicePut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDevicePutWithDataResidency.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeleteAddons.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeleteMonitoringConfig.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeviceCapacityGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeviceCapacityRequestPost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DownloadUpdatesPost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ExtendedInfoPost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GenerateCertificate.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetAddons.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetDCAccessCode.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetDiagnosticProactiveLogCollectionSettings.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetDiagnosticRemoteSupportSettings.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetMonitoringConfig.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetUpdateExtendedInfo.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/InstallUpdatesPost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/JobsGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ListMonitoringConfig.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/NetworkSettingsGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/NodeGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OperationsGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OperationsStatusGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderPut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/PutAddons.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/PutMonitoringConfig.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleListAddOns.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RolePut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACPut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ScanForUpdatesPost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SecuritySettingsUpdatePost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SharePut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareRefreshPost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountPut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerPut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerSupportPackage.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UpdateDiagnosticProactiveLogCollectionSettings.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UpdateDiagnosticRemoteSupportSettings.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UpdateSummaryGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UploadCertificatePost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserPut.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/databricks.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/DisableEncryption.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/EnableEncryption.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/ListPrivateEndpointConnections.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/ListPrivateLinkResources.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/OperationsList.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/OutboundNetworkDependenciesEndpointsList.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrepareEncryption.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateEndpointConnectionsDelete.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateEndpointConnectionsGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateEndpointConnectionsUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateLinkResourcesGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceCreate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceCreateWithParameters.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceDelete.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceDeleteRetainUcData.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceEnhancedSecurityComplianceCreateOrUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceEnhancedSecurityComplianceGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceGetParameters.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceManagedDiskEncryptionCreate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceManagedDiskEncryptionGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceManagedDiskEncryptionUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetPeeringGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetPeeringList.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetworkPeeringDelete.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspacesListByResourceGroup.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspacesListBySubscription.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/vnetpeering.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate_artifactroot.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_delete.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/operations_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_delete.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_cancel.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_restart.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_delete.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate_noartifactsource.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_delete.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate_noartifactsource.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_delete.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_delete.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/deploymentmanager.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_createorupdate_artifactroot.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_delete.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsources_list.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/operations_list.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_delete.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_post_cancel.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_post_restart.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollouts_list.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/service_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/service_delete.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/service_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/services_list.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopologies_list.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_createorupdate_noartifactsource.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_delete.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_createorupdate_noartifactsource.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_delete.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunits_list.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_delete.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_get.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_health_check_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_wait_createorupdate.json delete mode 100644 specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/steps_list.json delete mode 100644 specification/deploymentmanager/resource-manager/readme.go.md delete mode 100644 specification/deploymentmanager/resource-manager/readme.md delete mode 100644 specification/deploymentmanager/resource-manager/readme.nodejs.md delete mode 100644 specification/deploymentmanager/resource-manager/readme.python.md delete mode 100644 specification/deploymentmanager/resource-manager/readme.ruby.md create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/desktopvirtualization.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ActiveSessionHostConfigurations_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackageInfo_Import_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_ListByResourceGroup.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_ListBySubscription.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_ListByResourceGroup.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_ListBySubscription.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Desktop_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Desktop_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Desktop_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_ListByResourceGroup.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPools_RetrieveRegistrationToken_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixImage_Expand_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/OperationDescription_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_GetByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_GetByWorkspace.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_ListByWorkspace.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateLinkResources_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateLinkResources_ListByWorkspace.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_ListByResourceGroup.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_ListBySubscription.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurationsOperationStatus_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurationsOperationStatus_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagementsOperationStatus_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagementsOperationStatus_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_RetryProvisioning_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_Update.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/StartMenuItem_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_Disconnect_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_List.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_ListByHostPool.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_SendMessage_Post.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Create.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Delete.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Get.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_ListByResourceGroup.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_ListBySubscription.json create mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Update.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/devbox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/devcenter.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/environments.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Catalogs_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Catalogs_ListByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_Delay.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_DelayMultiple.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_DelayMultipleWithError.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_Skip.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxOperations_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxOperations_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Create.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Delete.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_GetRemoteConnection.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_ListByUserByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Repair.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Restart.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Start.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Stop.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_Delay.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_Skip.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentDefinitions_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentDefinitions_ListByCatalog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentDefinitions_ListByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentOperations_GetByEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentOperations_GetLogs.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentOperations_ListByEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentTypes_ListByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_CreateByEnvironmentDefinition.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_Delete.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_GetOutputs.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_ListByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_ListByProjectByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_Patch.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Pools_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Pools_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Projects_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Projects_ListByDevCenter.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Schedules_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Schedules_List.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Schedules_ListByProject.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/edgeorder.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/CancelOrderItem.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/CreateAddress.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/CreateOrderItem.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/DeleteAddressByName.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/DeleteOrderItemByName.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/GetAddressByName.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/GetOrderByName.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/GetOrderItemByName.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListAddressesAtResourceGroupLevel.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListAddressesAtSubscriptionLevel.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListConfigurations.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOperations.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderAtResourceGroupLevel.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderAtSubscriptionLevel.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderItemsAtResourceGroupLevel.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderItemsAtSubscriptionLevel.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListProductFamilies.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListProductFamiliesMetadata.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ReturnOrderItem.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/UpdateAddress.json create mode 100644 specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/UpdateOrderItem.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/elastic.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/AllTrafficFilters_list.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/AssociateTrafficFilter_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/AssociatedFiltersForDeployment_list.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/BillingInfo_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/ConnectedPartnerResources_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/DeploymentInfo_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/DetachAndDeleteTrafficFilter_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/DetachTrafficFilters_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/ElasticVersions_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/ExternalUserInfo.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/IPTrafficFilter_Create.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitor_Upgrade.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/MonitoredResources_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Create.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_ListByResourceGroup.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_CreateOrUpdate.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_GetStatus.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Operations_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Organizations_GetApiKey.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/PrivateLinkTrafficFilters_Create.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_CreateOrUpdate.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TrafficFilters_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/UpgradableVersions_Details.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/VMCollection_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/VMHost_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/VMIngestion_Details.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/elastic.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/AllTrafficFilters_list.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/AssociateTrafficFilter_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/AssociatedFiltersForDeployment_list.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/BillingInfo_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/ConnectedPartnerResources_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/DeploymentInfo_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/DetachAndDeleteTrafficFilter_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/DetachTrafficFilters_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/ElasticVersions_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/ExternalUserInfo.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/IPTrafficFilter_Create.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitor_Upgrade.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/MonitoredResources_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Create.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_ListByResourceGroup.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_CreateOrUpdate.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_GetStatus.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Operations_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Organizations_GetApiKey.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Organizations_GetElasticToAzureSubscriptionMapping.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/PrivateLinkTrafficFilters_Create.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_CreateOrUpdate.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TrafficFilters_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/UpgradableVersions_Details.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/VMCollection_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/VMHost_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/VMIngestion_Details.json create mode 100644 specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/PrivateCloud.json create mode 100644 specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/cloud-events-schema/cluster_updated.json create mode 100644 specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/cloud-events-schema/privatecloud_updating.json create mode 100644 specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/cloud-events-schema/script_execution_failed.json create mode 100644 specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/event-grid-schema/cluster_updated.json create mode 100644 specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/event-grid-schema/privatecloud_updating.json create mode 100644 specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/event-grid-schema/script_execution_failed.json create mode 100644 specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/storage_task_assignment_completed.json create mode 100644 specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/storage_task_assignment_queued.json create mode 100644 specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/event-grid-schema/storage_task_assignment_completed.json create mode 100644 specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/event-grid-schema/storage_task_assignment_queued.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/binaryHardeningResults.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/common.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cryptoCertificates.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cryptoKeys.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cves.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/BinaryHardening_ListByFirmware_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/BinaryHardening_ListByFirmware_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoCertificates_ListByFirmware_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoCertificates_ListByFirmware_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoKeys_ListByFirmware_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoKeys_ListByFirmware_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Cves_ListByFirmware_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Cves_ListByFirmware_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Create_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Create_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Delete_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Delete_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateDownloadUrl_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateDownloadUrl_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateFilesystemDownloadUrl_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateFilesystemDownloadUrl_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Get_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Get_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_ListByWorkspace_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_ListByWorkspace_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Update_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Update_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Operations_List_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/PasswordHashes_ListByFirmware_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/PasswordHashes_ListByFirmware_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/SbomComponents_ListByFirmware_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/SbomComponents_ListByFirmware_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_Get_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_Get_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_ListByFirmware_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_ListByFirmware_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Create_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Create_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Delete_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Delete_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_GenerateUploadUrl_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_GenerateUploadUrl_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Get_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Get_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Update_MaximumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Update_MinimumSet_Gen.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/firmwares.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/operations.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/passwordHashes.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/sbomComponents.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/summaries.json create mode 100644 specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/workspaces.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateAutoscaleCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPool.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithPrivateAks.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithUDRAks.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateRangerCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkClusterWithInternalIngress.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteClusterPool.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterInstanceView.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterPool.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetOperations.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterPoolVersions.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterVersions.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterAvailableUpgrades.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterInstanceViews.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterJobs.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolAvailableUpgrades.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPools.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolsSubscription.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterServiceConfigs.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClustersByClusterPoolName.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/LocationsNameAvailability.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchClusterPool.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchRangerCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ResizeCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/RunClusterJob.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeHotfixForCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeNodeOsForClusterPool.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/hdinsight.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.java.md create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/CheckNameAvailabilityPost.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/OperationResultsGet.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/OperationsList.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Create.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Delete.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Get.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_List.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Patch.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Create.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Delete.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Get.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_List.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Patch.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Create.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Delete.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Get.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_List.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Patch.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_Create.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_Delete.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_Get.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_List.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/PrivateLinkResourceGet.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/PrivateLinkResourcesListByService.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreate.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreateInDataSovereignRegionWithCmkEnabled.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreateMinimum.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreatePrivateEndpointConnection.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceDelete.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceDeletePrivateEndpointConnection.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceGet.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceGetInDataSovereignRegionWithCmkEnabled.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceGetPrivateEndpointConnection.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceList.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceListByResourceGroup.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceListPrivateEndpointConnections.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServicePatch.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/PrivateLinkResourcesListByWorkspace.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceCreatePrivateEndpointConnection.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceDeletePrivateEndpointConnection.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceGetPrivateEndpointConnection.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceListPrivateEndpointConnections.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspacePrivateLinkResourceGet.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Create.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Delete.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Get.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_ListByResourceGroup.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_ListBySubscription.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Patch.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/healthcare-apis.json create mode 100644 specification/hybridaks/resource-manager/readme.java.md create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/connectedClusters.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPAAD.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPToken.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultHPAAD.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultHPToken.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/CreateClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/CreateClusterPrivateLinkExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/CreateCluster_KindExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/DeleteClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetClustersByResourceGroupExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetClustersBySubscriptionExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetProvisionedClusterExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ListConnectedClusterOperationsExample.json create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/UpdateClusterExample.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/backuprestore.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/certificates.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/common.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/BackupCertificate-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/BackupKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/BackupSecret-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/CreateCertificate-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/CreateKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificate-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificateContacts-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificateIssuer-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificateOperation-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteRoleAssignments-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteRoleDefinition-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteSecret-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/FullBackup-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/FullBackup-pending-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/FullRestore-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificate-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateContacts-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateIssuer-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateIssuers-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateOperation-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificatePolicy-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateVersions-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificates-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedCertificate-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedCertificates-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedKeys-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedSecret-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedSecrets-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKeyRotationPolicy-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKeyVersions-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKeys-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetRandomBytes-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetRoleAssignments-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetRoleDefinition-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetSecret-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetSecretVersions-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetSecrets-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ImportCertificate-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ImportKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ListRoleAssignments-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ListRoleDefinitions-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ListSettings-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/MergeCertificate-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PurgeDeletedCertificate-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PurgeDeletedKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PurgeDeletedSecret-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PutRoleAssignments-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PutRoleDefinition-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RecoverDeletedCertificate-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RecoverDeletedKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RecoverDeletedSecret-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ReleasePolicy-example create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/Restore-pending-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RestoreCertificate-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RestoreKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RestoreSecret-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RotateKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SelectiveRestore-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SetCertificateContacts-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SetCertificateIssuer-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SetSecret-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificate-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificateIssuer-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificateOperation-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificatePolicy-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateKeyRotationPolicy-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateSecret-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateSetting-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/backupStorageAccount.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/decrypt-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/deleteStorageAccount.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/deleteStorageSasDefinition.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/encrypt-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getDeletedStorageAccount.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getDeletedStorageSasDefinition.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getStorageAccount.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getStorageSasDefinition.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listDeletedStorageAccount.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listDeletedStorageSasDefinition.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listStorageAccount.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listStorageSasDefinition.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/purgeStorageAccount.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/recoverStorageAccount.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/recoverStorageSasDefinition.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/regenerateStorageAccountKey.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/release-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/restoreStorageAccount.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomaindownloadpost-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomainoperationstatus-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomaintransferkey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomainuploadoperation-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/setStorageAccount.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/setStorageSasDefinition.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/sign-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/unwrapKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/updateStorageAccount.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/updateStorageSasDefinition.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/verify-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/wrapKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/index.md create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/keys.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/rbac.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/secrets.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/securitydomain.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/settings.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/storage.json create mode 100644 specification/liftrastronomer/resource-manager/readme.go.md create mode 100644 specification/liftrastronomer/resource-manager/readme.python.md rename specification/{deploymentmanager => liftrastronomer}/resource-manager/readme.typescript.md (67%) create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/listBySubscription.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/AKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/AmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/BasicAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/BasicAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/ComputeInstance.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/KubernetesCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/AKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/AmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/ComputeInstance.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/KubernetesCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/getAllowedVMSizesForResize.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/listKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/listNodes.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/patch.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/resize.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/restart.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/start.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/stop.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/updateCustomServices.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/updateDataMounts.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/updateIdleShutdownSetting.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/DataReference/getBlobReferenceSAS.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/listSecrets.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/create.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/getDeployments.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/getInWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/create.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/getModels.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/listKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/regenerateKey.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ExternalFQDN/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Feature/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Feature/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/AutoMLJob/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/AutoMLJob/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/AutoMLJob/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/CommandJob/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/CommandJob/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/CommandJob/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/FineTuningJob/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/FineTuningJob/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/FineTuningJob/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/PipelineJob/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/PipelineJob/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/PipelineJob/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/SweepJob/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/SweepJob/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/SweepJob/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/cancel.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/exportLabels.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/pause.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/resume.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/createOrUpdateRule.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/deleteRule.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/getRule.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/listRule.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/provision.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Notebook/listKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Notebook/prepare.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/getLogs.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateLinkResource/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Quota/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Quota/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/createOrUpdate-SystemCreated.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/createOrUpdate-UserCreated.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/get-SystemCreated.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/get-UserCreated.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/list-SystemCreated.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/list-UserCreated.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/listBySubscription.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/removeRegions.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/update-SystemCreated.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/update-UserCreated.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/registryList.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/registryList.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/package.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/trigger.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Usage/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/VirtualMachineSize/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/listKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/publish.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/publish.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/publish.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/publish.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/getEntity.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/backfill.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/getEntity.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/getStatus.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/listSkus.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/getStatus.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/listSkus.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/package.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/publish.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineDeployment/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/getToken.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/listKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/regenerateKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/getStatus.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/listKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/regenerateKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/create.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/diagnose.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listByResourceGroup.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listBySubscription.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listNotebookAccessToken.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listStorageAccountKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/operationsList.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/resyncKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/create.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/listSecrets.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/testConnection.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceFeature/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/machineLearningServices.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/mfe.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/registries.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceFeatures.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_EvaluatePointInPolygon.json delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetBuffer.json delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetClosestPoint.json delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGeofence.json delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGreatCircleDistance.json delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostBuffer.json delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostClosestPoint.json delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostGeofence.json delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostPointInPolygon.json delete mode 100644 specification/maps/data-plane/Creator/preview/1.0/spatial.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/migrate.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_ClientGroupMembers_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_ExportDependencies_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_ServerGroupMembers_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_CreateCluster_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_GetCluster_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_ListByHypervSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_ClientGroupMembers_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_ExportDependencies_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_ServerGroupMembers_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_UpdateDependencyMapStatus_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_ListByHypervSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobsController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobsController_ListByVmwareSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobs_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobs_ListByHypervSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_ListByHypervSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_UpdateProperties_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervOperationsStatusController_GetHypervOperationsStatus_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervRunAsAccountsController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervRunAsAccountsController_ListByHypervSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ComputeErrorSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Computeusage_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ExportApplications_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ExportMachineErrors_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ListHealthSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Summary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSites_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSites_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSoftwareInventoriesController_ListByHypervMachine_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebApplicationsController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebApplicationsController_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebServersController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebServersController_ListByWebAppSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_GetDeletejob_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_GetExportjob_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_GetImportjob_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListByImportSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListDeletejobs_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListExportjobs_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListImportjobs_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportMachinesController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportMachinesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportMachinesController_ListByImportSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_DeleteImportedMachines_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ExportUri_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ImportUri_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_ListByVmwareSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Start_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Stop_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_ErrorSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesOperationsStatusController_GetVmwareOperationStatus_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_ListByMasterSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateLinkResourcesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateLinkResourcesController_ListByMasterSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/RunAsAccountsController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/RunAsAccountsController_ListByVmwareSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_ClientGroupMembers_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_ExportDependencies_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_ServerGroupMembers_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerJobsController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerJobsController_ListByServerSiteResource_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerOperationsStatusController_GetServerSiteOperationsStatus_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerRunAsAccountsController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerRunAsAccountsController_ListByServerSiteResource_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ComputeErrorSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Computeusage_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ExportApplications_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ExportMachineErrors_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ListHealthSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_RefreshSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Summary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_UpdateDependencyMapStatus_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_UpdateProperties_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSoftwareInventoriesController_ListByServer_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_DeleteMachine_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_GetMachine_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_ListByServerSiteResource_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_UpdateMachine_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ComputeErrorSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Computeusage_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ExportApplications_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ExportMachineErrors_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ExportMachines_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ListHealthSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Summary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlAvailabilityGroupsController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlAvailabilityGroupsController_ListBySqlSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDatabasesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDatabasesController_ListBySqlSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_ListBySqlSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlJobsController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlJobsController_ListBySqlSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlOperationsStatusController_GetSqlOperationStatus_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlRunAsAccountsController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlRunAsAccountsController_ListBySqlSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlServersController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlServersController_ListBySqlSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlServersController_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ErrorSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ExportSqlServerErrors_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ExportSqlServers_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ListByMasterSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Refresh_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Summary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebApplicationsController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebApplicationsController_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebServersController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebServersController_ListByWebAppSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_ListByVmwareSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareHostController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareHostController_ListByVmwareSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareOperationsStatus_GetVmwareOperationStatus_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateDependencyMapStatus_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateProperties_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateRunAsAccount_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateTags_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_ListByWebAppSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppExtendedMachinesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppExtendedMachinesController_ListByWebAppSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppPropertiesController_UpdateProperties_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppRunAsAccountsController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppRunAsAccountsController_ListByWebAppSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_ErrorSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_ExportInventory_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_ListByMasterSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Refresh_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Summary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebServersController_ListByWebAppSite_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/migrate.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/amfdeployment.tsp create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/clusterservice.tsp create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/common.tsp create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_Delete.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_Get.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_ListBySubscription.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_UpdateTags.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_Delete.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_Get.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_ListBySubscription.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_UpdateTags.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_Delete.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_Get.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_ListBySubscription.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_UpdateTags.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_Delete.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_Get.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_ListBySubscription.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_UpdateTags.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_Delete.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_Get.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_ListBySubscription.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_UpdateTags.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/OperationList.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_Delete.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_Get.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_ListBySubscription.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_UpdateTags.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_Delete.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_Get.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_ListBySubscription.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_UpdateTags.json create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/main.tsp create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/nrfdeployment.tsp create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/nssfdeployment.tsp create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/observabilityservice.tsp create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/smfdeployment.tsp create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/tspconfig.yaml create mode 100644 specification/mobilepacketcore/MobilePacketCore.Management/upfdeployment.tsp create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_Delete.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_Get.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_ListBySubscription.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_UpdateTags.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_Delete.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_Get.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_ListBySubscription.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_UpdateTags.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_Delete.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_Get.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_ListBySubscription.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_UpdateTags.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_Delete.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_Get.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_ListBySubscription.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_UpdateTags.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_Delete.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_Get.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_ListBySubscription.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_UpdateTags.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/OperationList.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_Delete.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_Get.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_ListBySubscription.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_UpdateTags.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_CreateOrUpdate.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_Delete.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_Get.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_ListByResourceGroup.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_ListBySubscription.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_UpdateTags.json create mode 100644 specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/mobilepacketcore.json create mode 100644 specification/mobilepacketcore/resource-manager/readme.csharp.md create mode 100644 specification/mobilepacketcore/resource-manager/readme.go.md create mode 100644 specification/mobilepacketcore/resource-manager/readme.md create mode 100644 specification/mobilepacketcore/resource-manager/readme.python.md create mode 100644 specification/mobilepacketcore/resource-manager/readme.ruby.md create mode 100644 specification/mobilepacketcore/resource-manager/readme.typescript.md create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Accounts_List_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Accounts_List_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/BillingInfo_Get.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/ConnectedPartnerResources_List.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/LinkedResources_List.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_CreateorUpdate.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_Delete.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_Get.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_List.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_Update.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Get_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Update_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Operations_List_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Organizations_List_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Organizations_List_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Plans_List_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Plans_List_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Get_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Get_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Update_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Update_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/NewRelic.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Accounts_List_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Accounts_List_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/BillingInfo_Get.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/ConnectedPartnerResources_List.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/LinkedResources_List.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_CreateorUpdate.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_Delete.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_Get.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_List.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_Update.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Delete_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Delete_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricRules_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricRules_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Get_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListAppServices_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListAppServices_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListHosts_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListHosts_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_SwitchBilling_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_SwitchBilling_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Update_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_VmHostPayload_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_VmHostPayload_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Operations_List_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Organizations_List_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Organizations_List_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Plans_List_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Plans_List_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Delete_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Delete_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Get_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Get_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Update_MaximumSet_Gen.json create mode 100644 specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Update_MinimumSet_Gen.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_CreateOrUpdate.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_Delete.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_Get.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_List.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_Analysis.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_CreateOrUpdate.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_Delete.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_Get.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_List.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Create.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Delete.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Get.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_List.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_ListByResourceGroup.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Update.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Operations_List.json create mode 100644 specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/swagger.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/aodg.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteCreate.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteDelete.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteUpdateTag.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSitesByResourceGroupList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSitesBySubscriptionList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GlobalCommunicationsSiteGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GlobalCommunicationsSitesBySubscriptionList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationCreate.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationDelete.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationUpdateTags.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationsBySubscription.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationsList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionCreate.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionDelete.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionUpdateTag.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsByEdgeSiteNameList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsByGroundStationNameList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsByResourceGroupList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsBySubscriptionList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/OperationsList.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/PaloAltoNetworks.Cloudngfw.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_ListByFirewalls_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_ListByFirewalls_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Update_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Update_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getGlobalRulestack_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getGlobalRulestack_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getLogProfile_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getLogProfile_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getSupportInfo_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getSupportInfo_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_saveLogProfile_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_saveLogProfile_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Update_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Update_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_commit_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_commit_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_getChangeLog_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_getChangeLog_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAppIds_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAppIds_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listCountries_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listCountries_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listFirewalls_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listFirewalls_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listSecurityServices_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listSecurityServices_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_revert_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_revert_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_ListByLocalRulestacks_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_ListByLocalRulestacks_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_getCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_getCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_refreshCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_refreshCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_resetCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_resetCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Update_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Update_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_commit_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_commit_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getChangeLog_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getChangeLog_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getSupportInfo_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getSupportInfo_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAppIds_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAppIds_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listCountries_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listCountries_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listFirewalls_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listFirewalls_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listSecurityServices_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listSecurityServices_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_revert_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_revert_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Operations_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_getCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_getCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_refreshCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_refreshCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_resetCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_resetCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_getCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_getCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_refreshCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_refreshCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_resetCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_resetCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/PaloAltoNetworks.Cloudngfw.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_ListByFirewalls_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_ListByFirewalls_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Update_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Update_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getGlobalRulestack_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getGlobalRulestack_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getLogProfile_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getLogProfile_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getSupportInfo_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getSupportInfo_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_saveLogProfile_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_saveLogProfile_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Update_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Update_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_commit_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_commit_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_getChangeLog_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_getChangeLog_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAppIds_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAppIds_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listCountries_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listCountries_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listFirewalls_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listFirewalls_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listSecurityServices_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listSecurityServices_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_revert_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_revert_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_ListByLocalRulestacks_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_ListByLocalRulestacks_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_getCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_getCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_refreshCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_refreshCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_resetCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_resetCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListByResourceGroup_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListBySubscription_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Update_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Update_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_commit_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_commit_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getChangeLog_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getChangeLog_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getSupportInfo_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getSupportInfo_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAppIds_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAppIds_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listCountries_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listCountries_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listFirewalls_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listFirewalls_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listSecurityServices_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listSecurityServices_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_revert_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_revert_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Operations_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_createProductSerialNumber_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_createProductSerialNumber_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listCloudManagerTenants_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listCloudManagerTenants_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listProductSerialNumberStatus_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listProductSerialNumberStatus_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_getCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_getCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_refreshCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_refreshCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_resetCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_resetCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_getCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_getCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_refreshCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_refreshCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_resetCounters_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_resetCounters_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_List_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_List_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Delete_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Delete_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Get_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Get_MinimumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json create mode 100644 specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json create mode 100644 specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_Get.json create mode 100644 specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_ListByAccount.json create mode 100644 specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CheckNameAvailability.json rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{ => 2024-02-01-preview}/Accounts_CreateOrUpdate.json (96%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{ => 2024-02-01-preview}/Accounts_Delete.json (87%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{ => 2024-02-01-preview}/Accounts_Get.json (93%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{ => 2024-02-01-preview}/Accounts_ListByResourceGroup.json (97%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{ => 2024-02-01-preview}/Accounts_ListBySubscription.json (96%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{ => 2024-02-01-preview}/Accounts_Update.json (94%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{ => 2024-02-01-preview}/Operations_List.json (97%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{ => 2024-02-01-preview}/Quotas_Get.json (72%) rename specification/playwrighttesting/PlaywrightTesting.Management/examples/{ => 2024-02-01-preview}/Quotas_ListBySubscription.json (75%) create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/AccountQuotas_Get.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/AccountQuotas_ListByAccount.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_CheckNameAvailability.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_CreateOrUpdate.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_Delete.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_Get.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_ListByResourceGroup.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_ListBySubscription.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_Update.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Operations_List.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Quotas_Get.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Quotas_ListBySubscription.json create mode 100644 specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/common.tsp create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/location.tsp create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/network.tsp create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/simswap.tsp create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/client.tsp create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/DeviceLocation_Verify_MaximumSet_Gen.json create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/DeviceNetwork_Retrieve_MaximumSet_Gen.json create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/NumberVerification_VerifyWithCode_MaximumSet_Gen.json create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/NumberVerification_VerifyWithoutCode_MaximumSet_Gen.json create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/SimSwap_Retrieve_MaximumSet_Gen.json create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/SimSwap_Verify_MaximumSet_Gen.json create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/main.tsp create mode 100644 specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml create mode 100644 specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/DeviceLocation_Verify_MaximumSet_Gen.json create mode 100644 specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/DeviceNetwork_Retrieve_MaximumSet_Gen.json create mode 100644 specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/NumberVerification_VerifyWithCode_MaximumSet_Gen.json create mode 100644 specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/NumberVerification_VerifyWithoutCode_MaximumSet_Gen.json create mode 100644 specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/SimSwap_Retrieve_MaximumSet_Gen.json create mode 100644 specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/SimSwap_Verify_MaximumSet_Gen.json create mode 100644 specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json create mode 100644 specification/programmableconnectivity/data-plane/readme.md create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/client.tsp create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassifications.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json rename specification/purview/{data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Label.json => Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json} (73%) create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessMetadata.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkCreateOrUpdate.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkDelete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkSetClassifications.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Delete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_DeleteByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassification.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassifications.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetHeader.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetSampleBusinessMetadataTemplate.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_MoveEntitiesToCollection.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateAttributeByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateByUniqueAttributes.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassification.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassificationByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassifications.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassificationsByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Create.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategories.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategory.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerms.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Delete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteCategory.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Get.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetCategory.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetDetailed.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_List.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategories.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoriesHeaders.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoryTerms.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListEntitiesAssignedWithTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedCategories.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedTerms.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTermHeaders.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTerms.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_Get.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetNextPage.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Create.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Delete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Get.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Update.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreate.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkDelete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkUpdate.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_Delete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_List.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListHeaders.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/main.tsp create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/models.tsp create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessMetadata.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json create mode 100644 specification/purviewpolicy/PurviewPolicy.Management/backcompat.tsp create mode 100644 specification/purviewpolicy/PurviewPolicy.Management/examples/2023-06-01-preview/Operations_List_MaximumSet_Gen.json create mode 100644 specification/purviewpolicy/PurviewPolicy.Management/examples/2023-06-01-preview/Operations_List_MinimumSet_Gen.json rename specification/purviewpolicy/{resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/PolicyList.json => PurviewPolicy.Management/examples/2023-06-01-preview/PurviewPolicies_List_MaximumSet_Gen.json} (61%) create mode 100644 specification/purviewpolicy/PurviewPolicy.Management/main.tsp create mode 100644 specification/purviewpolicy/PurviewPolicy.Management/policy.tsp create mode 100644 specification/purviewpolicy/PurviewPolicy.Management/tspconfig.yaml delete mode 100644 specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/Operations_List.json create mode 100644 specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/Operations_List_MinimumSet_Gen.json create mode 100644 specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/PurviewPolicies_List_MaximumSet_Gen.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobDelete.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobGet.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobList.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobPatch.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobPut.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/providerStatus.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/quotaList.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionClose.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionGet.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionJobsList.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionList.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionPut.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/storageGet.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/topLevelItemsList.json create mode 100644 specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/quantum.json create mode 100644 specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/listKeys.json create mode 100644 specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/offeringsList.json create mode 100644 specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/operations.json create mode 100644 specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesCheckNameAvailability.json create mode 100644 specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesDelete.json create mode 100644 specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesGet.json create mode 100644 specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListResourceGroup.json create mode 100644 specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListSubscription.json create mode 100644 specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPatch.json create mode 100644 specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPut.json create mode 100644 specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/regenerateKey.json create mode 100644 specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/quantum.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/MigrationRecoveryPoints_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/Operations_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/RecoveryPoints_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAlertSettings_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAlertSettings_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAlertSettings_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAppliances_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEligibilityResults_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEligibilityResults_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEvents_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEvents_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_CheckConsistency.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_MigrateToAad.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Purge.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_ReassociateGateway.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_RenewCertificate.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationInfrastructure_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Cancel.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Export.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Restart.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Resume.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationLogicalNetworks_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Migrate.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_PauseReplication.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_ResumeReplication.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Resync.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_TestMigrate.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworks_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworks_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworks_ListByReplicationFabrics.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectableItems_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_AddDisks.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_FailoverCancel.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_FailoverCommit.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_PlannedFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Purge.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_RemoveDisks.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_RepairReplication.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Reprotect.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_SwitchProvider.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_TestFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_UnplannedFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_UpdateAppliance.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_UpdateMobilityService.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Purge.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_SwitchProtection.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionIntents_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionIntents_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionIntents_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_FailoverCancel.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_FailoverCommit.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_PlannedFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Reprotect.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_TestFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Purge.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassifications_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassifications_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultHealth_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultHealth_Refresh.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultSetting_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultSetting_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultSetting_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_ListByReplicationFabrics.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/SupportedOperatingSystems_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/service.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/OperationsList.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/OperationsStatusGet.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseCreate.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesCreate.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesCreateWithGeoReplication.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesDelete.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesExport.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesFlush.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesForceUnlink.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesGet.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesImport.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesListByCluster.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesListKeys.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesRegenerateKey.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesUpdate.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDelete.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDeletePrivateEndpointConnection.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseGet.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseGetPrivateEndpointConnection.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseList.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseListByResourceGroup.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseListPrivateEndpointConnections.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseListPrivateLinkResources.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterprisePutPrivateEndpointConnection.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseUpdate.json create mode 100644 specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/redisenterprise.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexAutocompleteDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexAutocompleteDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexCountDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexGetDocument.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexIndexDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSearchDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSearchDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSuggestDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSuggestDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndexStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndexerStatus.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetServiceStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceIndexAnalyze.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListAliases.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListDataSources.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListIndexers.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListIndexes.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListSkillsets.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListSynonymMaps.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceResetDocs.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceResetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceResetSkills.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceRunIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchindex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchservice.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/AlertRules.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/AutomationRules.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/BillingStatistics.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Bookmarks.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentPackages.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentProductPackages.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentProductTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Enrichment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Entities.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/EntityQueries.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/EntityQueryTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/FileImports.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Hunts.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Incidents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Metadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/OfficeConsents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/OnboardingStates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Recommendations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/SecurityMLAnalyticsSettings.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Settings.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/SourceControls.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/TriggeredAnalyticsRuleRuns.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Watchlists.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/WorkspaceManagerAssignments.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/WorkspaceManagerConfigurations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/WorkspaceManagerGroups.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/WorkspaceManagerMembers.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/AlertTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/ContentCommonTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/EntityTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/IncidentTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/RelationTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/ThreatIntelligenceTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/dataConnectorDefinitions.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/dataConnectors.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/actions/CreateActionOfAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/actions/DeleteActionOfAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/actions/GetActionOfAlertRuleById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/actions/GetAllActionsByAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateFusionAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateNrtAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateScheduledAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/DeleteAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetAllAlertRules.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetFusionAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetNrtAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetScheduledAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/automationRules/AutomationRules_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/automationRules/AutomationRules_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/automationRules/AutomationRules_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/automationRules/AutomationRules_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/billingStatistics/GetAllBillingStatistics.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/billingStatistics/GetBillingStatistic.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/CreateBookmark.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/DeleteBookmark.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/GetBookmarkById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/GetBookmarks.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/expand/PostExpandBookmark.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/relations/DeleteBookmarkRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/GetPackageById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/GetPackages.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/GetProductPackageById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/GetProductPackages.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/InstallPackage.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/UninstallPackage.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/DeleteTemplate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/GetProductTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/GetProductTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/GetTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/GetTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/InstallTemplate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/CreateCustomizableDataConnectorDefinition.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/DeleteDataConnectorDefinitionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/GetCustomizableDataConnectoeDefinitionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/GetDataConnectorDefinitions.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsDynamics365.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsIoT.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMdatp.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsOffice365Project.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsOfficeIRM.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsOfficePowerBI.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/ConnectAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/ConnectAPIPollingV2Logs.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateDynamics365DataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateGenericUI.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateGoogleCloudPlatform.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateOffice365ProjectDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateOfficePowerBIDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateThreatIntelligenceDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteGenericUI.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteGoogleCloudPlatform.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DisconnectAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAmazonWebServicesS3ById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetDataConnectors.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetDynamics365DataConnectorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetGenericUI.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetGoogleCloudPlatformById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetIoTById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftThreatProtectionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetOffice365ProjectDataConnetorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetOfficePowerBIDataConnetorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetThreatIntelligenceTaxiiById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/enrichment/GetGeodataByIp.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/enrichment/GetWhoisByDomainName.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetAccountEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetAzureResourceEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetCloudApplicationEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetDnsEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetEntities.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetFileEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetFileHashEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetHostEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetIoTDeviceEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetIpEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetMailClusterEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetMailMessageEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetMailboxEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetMalwareEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetProcessEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetQueries.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetRegistryKeyEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetRegistryValueEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetSecurityAlertEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetSecurityGroupEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetSubmissionMailEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetUrlEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/expand/PostExpandEntity.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/insights/PostGetInsights.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/relations/GetAllEntityRelations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/relations/GetEntityRelationByName.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/timeline/PostTimelineEntity.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/CreateEntityQueryActivity.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/DeleteEntityQuery.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/GetActivityEntityQueryById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/GetEntityQueries.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueryTemplates/GetEntityQueryTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/fileImports/CreateFileImport.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/fileImports/DeleteFileImport.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/fileImports/GetFileImportById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/fileImports/GetFileImports.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/CreateHunt.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/CreateHuntComment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/CreateHuntRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/DeleteHunt.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/DeleteHuntComment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/DeleteHuntRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntCommentById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntComments.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntRelationById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntRelations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHunts.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentAlerts/Incidents_ListAlerts.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentComments/IncidentComments_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentComments/IncidentComments_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentComments/IncidentComments_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentEntities/Incidents_ListEntities.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTeam/Incidents_CreateTeam.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/Incidents_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/Incidents_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/Incidents_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/Incidents_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/relations/CreateIncidentRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/relations/DeleteIncidentRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/relations/GetAllIncidentRelations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/relations/GetIncidentRelationByName.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/manualTrigger/Entities_RunPlaybook.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/DeleteMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/GetAllMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/GetAllMetadataOData.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/GetMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/PatchMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/PutMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/PutMetadataMinimal.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/officeConsents/DeleteOfficeConsents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/officeConsents/GetOfficeConsents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/officeConsents/GetOfficeConsentsById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/onboardingStates/GetAllSentinelOnboardingStates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/onboardingStates/GetSentinelOnboardingState.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/operations/ListOperations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/recommendations/GetRecommendation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/recommendations/GetRecommendations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/recommendations/PatchRecommendation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/repositories/GetRepositories.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/settings/DeleteEyesOnSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/settings/GetAllSettings.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/settings/GetEyesOnSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/settings/UpdateEyesOnSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/CreateSourceControl.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/DeleteSourceControl.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/GetSourceControlById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/GetSourceControls.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/AppendTagsThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/CollectThreatIntelligenceMetrics.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/CreateThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/DeleteThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/GetThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/GetThreatIntelligenceById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/QueryThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/ReplaceTagsThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/UpdateThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/CreateWatchlist.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/CreateWatchlistItem.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/DeleteWatchlist.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/DeleteWatchlistItem.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/GetWatchlistByAlias.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/GetWatchlistItemById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/GetWatchlistItems.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/GetWatchlists.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/CreateJob.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/DeleteJob.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/GetAllJobs.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/GetJob.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/operations.json rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/DeleteCatalog.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/DeleteDeployment.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/DeleteDevice.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/DeleteDeviceGroup.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/DeleteImage.json (91%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/DeleteProduct.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetCatalog.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetCatalogsRG.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetCatalogsSub.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetCertificate.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetCertificates.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetDeployment.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetDeployments.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetDevice.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetDeviceGroup.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetDeviceGroups.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetDevices.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetImage.json (87%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetImages.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetOperations.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetProduct.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/GetProducts.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PatchCatalog.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PatchDevice.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PatchDeviceGroup.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PatchProduct.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PostClaimDevices.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PostCountDevicesCatalog.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PostCountDevicesDeviceGroup.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PostCountDevicesProduct.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PostGenerateDefaultDeviceGroups.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PostGenerateDeviceCapabilityImage.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PostListDeploymentsByCatalog.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PostListDeviceGroupsCatalog.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PostListDeviceInsightsCatalog.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PostListDevicesByCatalog.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PostRetrieveCatalogCertChain.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PostRetrieveProofOfPossessionNonce.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PutCatalog.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PutDeployment.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PutDevice.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PutDeviceGroup.json (100%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PutImage.json (97%) rename specification/sphere/Sphere.Management/examples/{ => 2022-09-01-preview}/PutProduct.json (100%) create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/DeleteCatalog.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeployment.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDevice.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeviceGroup.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/DeleteImage.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/DeleteProduct.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalog.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsRG.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsSub.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificate.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificates.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployment.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployments.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetDevice.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroup.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroups.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetDevices.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetImage.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetImages.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetOperations.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetProduct.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/GetProducts.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PatchCatalog.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PatchDevice.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PatchDeviceGroup.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PatchProduct.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostClaimDevices.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesCatalog.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesDeviceGroup.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesProduct.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDefaultDeviceGroups.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDeviceCapabilityImage.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeploymentsByCatalog.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceGroupsCatalog.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceInsightsCatalog.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostListDevicesByCatalog.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveCatalogCertChain.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveProofOfPossessionNonce.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PostUploadImageCatalog.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PutCatalog.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PutDeployment.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PutDevice.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PutDeviceGroup.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PutImage.json create mode 100644 specification/sphere/Sphere.Management/examples/2024-04-01/PutProduct.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteCatalog.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeployment.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDevice.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeviceGroup.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteImage.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteProduct.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalog.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsRG.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsSub.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificate.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificates.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployment.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployments.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevice.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroup.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroups.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevices.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImage.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImages.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetOperations.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProduct.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProducts.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchCatalog.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDevice.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDeviceGroup.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchProduct.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostClaimDevices.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesCatalog.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesDeviceGroup.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesProduct.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDefaultDeviceGroups.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDeviceCapabilityImage.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeploymentsByCatalog.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceGroupsCatalog.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceInsightsCatalog.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDevicesByCatalog.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveCatalogCertChain.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveProofOfPossessionNonce.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostUploadImageCatalog.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutCatalog.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeployment.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDevice.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeviceGroup.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutImage.json create mode 100644 specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutProduct.json create mode 100644 specification/storageactions/resource-manager/readme.java.md create mode 100644 specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.java.md diff --git a/.github/ISSUE_TEMPLATE/01_question.yml b/.github/ISSUE_TEMPLATE/01_question.yml new file mode 100644 index 000000000000..be5d67143f3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_question.yml @@ -0,0 +1,46 @@ +name: Question/Query +description: Use this template to file a question/query for the API Spec team that are not bugs or feature requests. +title: "[Question]" + +labels: + - question + +body: + - type: input + id: api_spec + attributes: + label: API Spec link + description: "Link to the OpenAPI or TypeSpec spec" + placeholder: "e.g. https://github.com/Azure/azure-rest-api-specs/blob/main/specification/containerservice/Fleet.Management/main.tsp" + validations: + required: true + + - type: input + id: version + attributes: + label: API Spec version + description: "Version of the API Spec" + placeholder: "e.g. 2023-10-15" + validations: + required: true + + - type: textarea + id: background + attributes: + label: Question/Query + description: How can we help? + placeholder: Description + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: | + Please provide more information on your environment: + * Hosting platform or OS and .NET runtime version (`dotnet --info` output for .NET Core projects): [e.g. Azure AppService or Windows 10 .NET Framework 4.8] + * IDE and version: [e.g. Visual Studio 16.3] + placeholder: Environment + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/02_bug.yml b/.github/ISSUE_TEMPLATE/02_bug.yml new file mode 100644 index 000000000000..d5bfd4aa215e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_bug.yml @@ -0,0 +1,76 @@ +name: Bug report +description: Use this template to file a bug on an API Spec. +title: "[BUG]" + +labels: + - bug + +body: + - type: input + id: api_spec + attributes: + label: API Spec link + description: "Link to the OpenAPI or TypeSpec spec" + placeholder: "e.g. https://github.com/Azure/azure-rest-api-specs/blob/main/specification/containerservice/Fleet.Management/main.tsp" + validations: + required: true + + - type: input + id: version + attributes: + label: API Spec version + description: "Version of the API Spec" + placeholder: "e.g. 2023-10-15" + validations: + required: true + + - type: textarea + id: background + attributes: + label: Describe the bug + description: Please provide the description of issue you're seeing. + placeholder: Description + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: | + Provide a description of the expected behavior. + placeholder: Expected behavior + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: | + Provide a description of the actual behavior observed. If applicable please include any error messages, exception stacktraces or memory dumps. + placeholder: Actual behavior + validations: + required: true + + - type: textarea + id: repro-steps + attributes: + label: Reproduction Steps + description: | + Please include minimal steps to reproduce the problem if possible. E.g.: the smallest possible code snippet; or a small project, with steps to run it. If possible include text as text rather than screenshots (so it shows up in searches). + placeholder: Minimal Reproduction + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: | + Please provide more information on your environment: + * Hosting platform or OS and .NET runtime version (`dotnet --info` output for .NET Core projects): [e.g. Azure AppService or Windows 10 .NET Framework 4.8] + * IDE and version : [e.g. Visual Studio 16.3] + placeholder: Environment + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/03_feature_request.yml b/.github/ISSUE_TEMPLATE/03_feature_request.yml new file mode 100644 index 000000000000..ced2c8c55b64 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03_feature_request.yml @@ -0,0 +1,34 @@ +name: Feature request +description: Use this template to file a feature request on an API Spec. +title: "[FEATURE REQ]" + +labels: + - feature-request + +body: + - type: input + id: api_spec + attributes: + label: API Spec link + description: "Link to the OpenAPI or TypeSpec spec" + placeholder: "e.g. https://github.com/Azure/azure-rest-api-specs/blob/main/specification/containerservice/Fleet.Management/main.tsp" + validations: + required: true + + - type: input + id: version + attributes: + label: API Spec version + description: "Version of the API Spec" + placeholder: "e.g. 2023-10-15" + validations: + required: true + + - type: textarea + id: background + attributes: + label: Please describe the feature. + description: What feature would you like to get added? What problem is it solving? + placeholder: Feature description + validations: + required: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md b/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md index 615c0d072e2c..5547f7527871 100644 --- a/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md @@ -1,6 +1,10 @@ # ARM (Control Plane) API Specification Update Pull Request -> Tip: overwhelmed by all this guidance? See the `Getting help` section at the bottom of this PR description. +> [!TIP] +> Overwhelmed by all this guidance? See the `Getting help` section at the bottom of this PR description. + +> [!NOTE] +> As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review. ## PR review workflow diagram @@ -27,9 +31,7 @@ If the automation determines you have breaking changes, i.e. Step 1 from the dia ### ARM API changes review (Diagram Step 2) -- If this PR is in purview of ARM review then automation will add the `ARMReview` label. -- If you want to force ARM review, add the label yourself. -- Proceed according to the diagram at the top of this comment. +- For help with Step 2 / "ARM review", see https://aka.ms/azsdk/pr-arm-review. @@ -38,23 +40,20 @@ If the automation determines you have breaking changes, i.e. Step 1 from the dia ### Diagram footnotes -[1] [ARM review queue] (for **merge** queues, see [2]) -The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page. -If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label `ARMChangesRequested` -is removed from your PR. This should cause the label `WaitForARMFeedback` to be added. -[2] [public repo merge queue], [private repo merge queue] (for **ARM review** queue, [1]) - -If you need further help with anything, see `Getting help` section below. +[1] See [ARM review queue] (for **PR merge** queues, see [2]). +[2] [public repo merge queue], [private repo merge queue] (for **ARM review** queue, [1]) +The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours. ## Purpose of this PR -What's the purpose of this PR? Check all that apply. This is **mandatory**! +What's the purpose of this PR? Check the specific option that applies. This is **mandatory**! - - [ ] New API version. (If API spec is not defined in TypeSpec, the PR should have been generated using [OpenAPI Hub](https://aka.ms/openapihub)). + - [ ] New resource provider. + - [ ] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using [OpenAPI Hub](https://aka.ms/openapihub)). - [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.) - - [ ] Update existing version to fix swagger quality issues in S360. + - [ ] Update existing version to fix OpenAPI spec quality issues in S360. - [ ] Other, please clarify: - _edit this with your clarification_ @@ -67,7 +66,7 @@ and followed the instructions by checking all the boxes: - [ ] I have reviewed following [Resource Provider guidelines](https://aka.ms/rpguidelines), including [ARM resource provider contract](https://github.com/Azure/azure-resource-manager-rpc) and [REST guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md) (estimated time: 4 hours). - I understand this is required before I can proceed to the Diagram Step 2, "ARM API changes Review", for this PR. + I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR. ## Additional information @@ -82,8 +81,7 @@ in the `Generated ApiView` comment added to this PR. You can use ApiView to show Suppressing failures If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the -[Swagger-Suppression-Process](https://aka.ms/azsdk/pr-suppressions) -to get approval. +[suppressions guide](https://aka.ms/azsdk/pr-suppressions) to get approval. @@ -93,11 +91,12 @@ to get approval. - To understand what you must do next to merge this PR, see the `Next Steps to Merge` comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix. +- For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review. - If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes. - If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR. -[ARM review queue]: https://github.com/search?q=org%3AAzure+is%3Apr+is%3Aopen+label%3AWaitForARMFeedback+-label%3AIDCDevDiv++draft%3Afalse+sort%3Acreated-asc+&type=pullrequests +[ARM review queue]: https://aka.ms/azsdk/pr-arm-review#about-the-arm-review-queue [public repo merge queue]: https://github.com/Azure/azure-rest-api-specs/pulls?q=is%3Aopen+is%3Apr+label%3AMergeRequested+draft%3Afalse+sort%3Acreated-asc [private repo merge queue]: https://github.com/Azure/azure-rest-api-specs-pr/pulls?q=is%3Aopen+is%3Apr+label%3AMergeRequested+-label%3AApproved-OkToMerge+draft%3Afalse+sort%3Acreated-asc [breaking changes process]: https://eng.ms/docs/cloud-ai-platform/azure-core/azure-core-pm-and-design/trusted-platform-pm-karimb/service-lifecycle-and-actions-team/service-lifecycle-actions-team/apex/media/launchingproductbreakingchanges#breaking-change-process-1 diff --git a/.github/comment.yml b/.github/comment.yml index c9ca38549bd7..57779c57ae98 100644 --- a/.github/comment.yml +++ b/.github/comment.yml @@ -1,14 +1,4 @@ --- -- rule: - type: label - label: "CI-MissingBaseCommit" - onLabeledComments: >- - Hi @${PRAuthor}! For review efficiency consideration, - when creating a new API version, it is required to place API specs of the - base version in the first commit, and push new version updates into successive commits. - You can use OpenAPIHub to initialize the PR for adding a new version.
- For more details refer to the [wiki](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version). - - rule: type: label repoAllowList: diff --git a/.github/issue_assignment.yml b/.github/issue_assignment.yml deleted file mode 100644 index 556dddd7b5c1..000000000000 --- a/.github/issue_assignment.yml +++ /dev/null @@ -1,6 +0,0 @@ ---- -- rule: - booleanFilterExpression: "APIStewardshipBoard-ReviewRequested" - assignees: - - diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml deleted file mode 100644 index 9dec6256604e..000000000000 --- a/.github/pull_request_assignment.yml +++ /dev/null @@ -1,145 +0,0 @@ ---- -- rule: - # translator data-plane PR - paths: - - "specification/cognitiveservices/data-plane/TranslatorText/**" - reviewers: - - kristapratico - -- rule: - # OpenAI data-plane PR - paths: - - "specification/cognitiveservices/data-plane/AzureOpenAI/**" - - "specification/cognitiveservices/OpenAI.Inference/**" - reviewers: - - lmazuel - -- rule: - # Cognitive Services - Language pillar data-plane PR - paths: - - "specification/cognitiveservices/data-plane/Language/**" - reviewers: - - kristapratico - - heaths - -- rule: - # Key Vault data-plane PR - paths: - - "specification/keyvault/data-plane/**" - reviewers: - - heaths - -- rule: - paths: - - "specification/confidentialledger/data-plane/**" - reviewers: - - christothes - -- rule: - # eventgrid data-plane PR - paths: - - "specification/eventgrid/data-plane/**" - reviewers: - - JoshLove-msft - -- rule: - # storage data-plane PR - paths: - - "specification/storage/data-plane/**" - reviewers: - - tg-msft - -- rule: - # synapse data-plane PR - paths: - - "specification/synapse/data-plane/**" - reviewers: - - lmazuel - -- rule: - # data-plane PR - paths: - - "specification/**/data-plane/iot**" - reviewers: - - drwill-ms - -- rule: - # data-plane PR - paths: - - "specification/**/data-plane/**" - - "dev/**/data-plane/**" - reviewers: - - anuchandy - - jhendrixMSFT - - tjprescott - -- rule: - # resource management plane typespec PR's - paths: - - "specification/**/*Management/**" - - "specification/**/*Management.Shared/**" - reviewers: - - rkmanda - -- rule: - paths: - - "specification/**/*.cadl" - - "specification/**/*.tsp" - reviewers: - - anuchandy - - jhendrixMSFT - - tjprescott - -- rule: - paths: - - "specification/network/**" - reviewers: - - rkmanda - branches: - - release-network-Microsoft.Network-official - -- rule: - paths: "specification/sql/**" - reviewers: - - rkmanda - branches: - - dev-sql- - -- rule: - paths: "specification/@(financialdataservices|standbypool)/**" - reviewers: - - rkmanda - branches: - - RPSaaSDev - -- rule: - paths: - - "documentation/**" - reviewers: - - josefree - - weshaggard - -- rule: - paths: - - ".github/**" - - "**/azure-pipelines.yml" - - ".azure-pipelines/**" - - ".azure-pipelines-preproduction/**" - reviewers: - - weshaggard - - konrad-jamrozik - -- rule: - # resource management plane swagger PR's - paths: - - "specification/**/resource-manager/**" - - "specification/common-types/resource-management/**" - reviewers: - - rkmanda - -- rule: - # temporary catchall - paths: - - "**" - reviewers: - - weshaggard diff --git a/cSpell.json b/cSpell.json index 53edfde971f0..fbfb6e35f688 100644 --- a/cSpell.json +++ b/cSpell.json @@ -177,6 +177,13 @@ "Noreuse" ] }, + { + "filename": "**/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/**/*json", + "words": [ + "vtpm", + "trustedlaunch" + ] + }, { "filename": "**/specification/containerregistry/data-plane/Microsoft.ContainerRegistry/preview/2018-08-10/containerregistry.json", "words": [ @@ -417,7 +424,8 @@ "idms", "Idms", "Cluter", - "Mfamily" + "Mfamily", + "Datacentre" ] }, { @@ -794,6 +802,28 @@ "Fpushpins" ] }, + { + "filename": "**/specification/maps/data-plane/Spatial/stable/2022-08-01/spatial.json", + "words": [ + "postbuffer", + "getbuffer", + "postclosestpoint", + "getclosestpoint" + ] + }, + { + "filename": "**/specification/maps/data-plane/Search/stable/2023-06-01/search.json", + "words": [ + "geocodingresponse" + ] + }, + { + "filename": "**/specification/maps/data-plane/Search/preview/1.0/search.json", + "words": [ + "searchaddressresult", + "searchaddressreverseresponse" + ] + }, { "filename": "**/specification/communication/data-plane/Chat/preview/2020-09-21-preview2/communicationserviceschat.json", "words": [ @@ -940,12 +970,25 @@ ] }, { - "filename": "**/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/preview/**/*.json", + "filename": "**/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/**/*.json", + "words": [ + "datareferences", + "Groundedness", + "AOAI", + "testconnection", + "aoai" + ] + }, + { + "filename": "**/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/**/*.json", "words": [ "RELRO", "relro", "rpath", - "runpath" + "runpath", + "SBOM", + "Sbom", + "sbom" ] }, { @@ -961,11 +1004,43 @@ "mpga" ] }, + { + "filename": "**/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json", + "words": [ + "springboot" + ] + }, { "filename": "**/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/**/*.json", "words": [ "throughputpool" ] + }, + { + "filename": "**/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/**/*.json", + "words": [ + "timerange" + ] + }, + { + "filename": "**/specification/search/data-plane/Azure.Search/**/*.json", + "words": [ + "rerank", + "discretizing" + ] + }, + { + "filename": "**/specification/nginx/resource-manager/NGINX.NGINXPLUS/**/*.json", + "words": [ + "nginx", + "nginxaas" + ] + }, + { + "filename": "**/specification/containerservice/resource-manager/Microsoft.ContainerService/**/*.json", + "words": [ + "containerd" + ] } ], "enableFiletypes": [ diff --git a/custom-words.txt b/custom-words.txt index db672e292548..097744ef3a13 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -125,6 +125,7 @@ aods aosm apac apacheavro +apcgatewayapi api's apim apimanagement @@ -194,6 +195,7 @@ arima arimax arin arjun +armn armtemplates arp arpa @@ -421,6 +423,7 @@ bzip cacerts cadl calculatebaseline +camara canadacentral canadaeast canceldelete @@ -936,11 +939,14 @@ español esrp esrps estaba +esxi +esxiNfcBuffer etag etags etcd ethereum ethertype +ethi eucloud eucloudprototype eugps @@ -1098,6 +1104,7 @@ geofences geofencing geojson geopair +geor georegions georeplication geospatial @@ -1171,6 +1178,7 @@ granularities graphrbac graphservice greenplum +grek groundstation groupby groupedby @@ -1187,6 +1195,7 @@ guami guestconfiguration guid guids +gujr gurung guti gxlarge @@ -1222,6 +1231,7 @@ healthmodels healthstatus heatbeat heatmap +hebr hecto helmchart helpdesk @@ -1434,6 +1444,7 @@ jobschedules johnc johndeere johnsmith +jpan json jsonl jsonld @@ -1474,6 +1485,7 @@ keyvaultproperties keyvaulturi keyversion khaling +khmr khtml kibana kiswahili @@ -1482,6 +1494,7 @@ kmgtpe kmph Kmskeyaccessdenied Kmskeynotfound +knda knowledgebase knowledgebases koelner @@ -1524,6 +1537,7 @@ labservices lajolla lakehouse languagedata +laoo largefacelists largepersongroups largerc @@ -1754,6 +1768,7 @@ mlapi mlflow mlflowtrackinguri mltable +mlym mmtc mnist mobo @@ -1835,6 +1850,7 @@ myimage mylocation mylog mymodel +mymr mypath mypicture mypictures @@ -1993,6 +2009,7 @@ octokit odata odatatype odbc +odia oeverify offboard offboarding @@ -2054,6 +2071,7 @@ optout organisation orgs originpath +orya oscp osdisk osdiskforlinuxsimple @@ -2214,6 +2232,7 @@ privatelinks privatelinkscopes privatelinkservice privatepreview +probs projecthilo propagations propogation @@ -2855,6 +2874,7 @@ taginheritance tagname tagsandregions tagvalue +taml targetduration taskcompletion taskcounts @@ -2869,6 +2889,7 @@ teamsinterop telangana telemetryconfig teleportal +telu tempdb templated templatelink @@ -2897,10 +2918,12 @@ textanalytics tfidf tful tfvc +thaa thangmi thirdparty threatintelligence threatintelligenceindicators +tibt tilejson tileset tilesetconfiguration @@ -3091,6 +3114,7 @@ usermetadata userpreference userprincipalname usersetting +usersync usertime usql usuk @@ -3952,6 +3976,7 @@ CapacityReservationGroups Paas PAAS ciem +Apigee capacityreservationgroup capacityreservationgroups ciam @@ -3960,3 +3985,18 @@ protobuf proto msvideo SOQL +Mulesoft +retroperitoneal +codeable +telehealth +loinc +wacc +hyperthread +Hyperthread +Capex +capex +Opex +opex +decomission +Decommisioned +Decommision \ No newline at end of file diff --git a/documentation/Semantic-and-Model-Violations-Reference.md b/documentation/Semantic-and-Model-Violations-Reference.md index f2c6b299dc0d..24cb13a1d700 100644 --- a/documentation/Semantic-and-Model-Violations-Reference.md +++ b/documentation/Semantic-and-Model-Violations-Reference.md @@ -95,6 +95,9 @@ This document lists the set of automated rules that can be validated against swa | [INTERNAL_ERROR](#INTERNAL_ERROR) | [OAV100](#INTERNAL_ERROR) | | [REQUEST_VALIDATION_ERROR](#REQUEST_VALIDATION_ERROR) | [OAV109](#REQUEST_VALIDATION_ERROR) | | [RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE](#RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE) | [OAV111](#RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE) | +| [ROUNDTRIP_INCONSISTENT_PROPERTY](#ROUNDTRIP_INCONSISTENT_PROPERTY) | | +| [ROUNDTRIP_MISSING_PROPERTY](#ROUNDTRIP_MISSING_PROPERTY) | | +| [ROUNDTRIP_ADDITIONAL_PROPERTY](#ROUNDTRIP_ADDITIONAL_PROPERTY) | | | [LRO_RESPONSE_CODE](#LRO_RESPONSE_CODE) | | | [LRO_RESPONSE_HEADER](#LRO_RESPONSE_HEADER) | | | [MISSING_RESOURCE_ID](#MISSING_RESOURCE_ID) | | @@ -838,6 +841,42 @@ This document lists the set of automated rules that can be validated against swa **How to fix the violation**: Remove this property from the response in example or in traffic payload. +### ROUNDTRIP_INCONSISTENT_PROPERTY + +**Output Message**: The property’s value in the GET response is different from what was set in the preceding PUT request. If it is a read-only property, update the swagger definition for this property to mark it as "readOnly": true. Alternatively, keep the property in the GET schema but remove it from the PUT schema. If it is immutable (its value cannot be changed after creation), update the swagger definition for this property to mark it with the "x-ms-mutability": ["create", "read"] annotation. If the property has a default value, update the Swagger definition for this property to mark it with "default": annotation. + +**Description**: The property’s value in the GET response is different from what was set in the preceding PUT request. This usually happens when the property is read-only so its value cannot be set by users, or its value can be set in the initial PUT request but cannot be updated afterwards. It is also possible that the property has a default value, and it is set to that value when a null value is included in the PUT request. There are some other cases where ROUNDTRIP_INCONSISTENT_PROPERTY is raised but cannot be fixed in swagger, for which you might need to send exception requests (please refer to the **How to fix the violation section** section below for more details). + +**How to fix the violation**: +- Check if the property is read-only. If yes, update the swagger definition for this property to mark it as "readOnly": true. Alternatively, keep the property in the GET schema but remove it from the PUT schema. +- Check if the property's value cannot be updated after creation. If yes, update the swagger definition for this property to mark it with the "x-ms-mutability": ["create", "read"] annotation. +- Check if the property has a static default value that doesn't depend on other properties. If yes, update the Swagger definition for this property to mark it with "default": annotation. +- If none of the above applies, check if one of the following behaviors is true for the property, send an exception request, but consider updating your service implementation to fix the behavior: + - The property has a dynamic default value that depends on other properties / some other resources (violates [Property Design Best Practices](https://armwiki.azurewebsites.net/rp_onboarding/process/property_design_best_practices.html#readwrite-properties-with-static-default-values)). + - The property's value always gets normalized (violates [ARM PRC](https://github.com/Azure/azure-resource-manager-rpc/blob/eec9f32c0357d0421be13c82ced767943013901a/v1.0/resource-api-reference.md#put-resource)). + + +### ROUNDTRIP_MISSING_PROPERTY + +**Output Message**: The property is present in the PUT request but is either never returned in the GET response or is returned with a null value. If this is a property that carries a secret such as a password, update the Swagger definition to mark it with the "x-ms-secret": true annotation. If it is write-only but does not carries a secret, update the swagger definition for this property to mark it with the "x-ms-mutability": ["create", "update"] annotation. + +**Description**: The property is present in the PUT request, but in the subsequent GET response, it is either never returned or is returned with a null value, which means the property is write-only and is likely to carry a secret. + +**How to fix the violation**: +- Check if the property carries a secret. If yes, mark the property definition with the "x-ms-secret": true annotation. +- Check if the property does not carry a secret but is still write-only. If yes, mark the property definition with the "x-ms-mutability": ["create", "update"] annotation. + + +### ROUNDTRIP_ADDITIONAL_PROPERTY + +**Output Message**: The property is returned in the GET response, but it is not declared in the PUT request. If it is a read-only property, update the swagger definition for this property to mark it as \"readOnly\": true. Alternatively, keep the property in the GET schema but remove it from the PUT schema. If the property has a default value, update the Swagger definition for this property to mark it with \"default\": annotation. + +**Description**: The property was not in the PUT request, but it is returned in the subsequent GET response. This implies that the property is read-only or has a default value. + +**How to fix the violation**: +- Check if the property is read-only. If yes, update the swagger definition for this property to mark it as "readOnly": true. Alternatively, keep the property in the GET schema but remove it from the PUT schema. +- Check if the property has a default value. If yes, update the Swagger definition for this property to mark it with "default": annotation. + ### LRO_RESPONSE_CODE **Output Message**: Respond to the initial request of a long running operation, Patch/Post call must return 201 or 202, Delete call must return 202 or 204, Put call must return 202 or 201 or 200, but {statusCode} being returned. diff --git a/documentation/api-scenario/references/ErrorCodeReference.md b/documentation/api-scenario/references/ErrorCodeReference.md index 79862826f3db..5863185800d1 100644 --- a/documentation/api-scenario/references/ErrorCodeReference.md +++ b/documentation/api-scenario/references/ErrorCodeReference.md @@ -91,3 +91,31 @@ Example: } } ``` + +## ROUNDTRIP_INCONSISTENT_PROPERTY + +**Error message** The property's value in the response is different from what was set in the request. Path: {}. Request: {}. Response: {} + +Example: The sku in request parameters is `default`, but actual return is `standard`. + +```diff +{ + "parameters":{ + "properties":{ + "name":"myService", + "SKU":"default" + } + }, + "responses":{ + "200":{ + "properties":{ + "name":"myService", ++ "SKU":"standard" +- "SKU":"default" + + } + } + } +} + +``` diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index 204d7347edf2..58da72c51087 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -1,17 +1,51 @@ +# Table of Contents + +- [Table of Contents](#table-of-contents) +- [CI Fix Guide](#ci-fix-guide) + - [Prerequisites](#prerequisites) + - [`Swagger SpellCheck`](#swagger-spellcheck) + - [`Swagger PrettierCheck`](#swagger-prettiercheck) + - [Prettier reference](#prettier-reference) + - [`Swagger ModelValidation`](#swagger-modelvalidation) + - [`Swagger SemanticValidation`](#swagger-semanticvalidation) + - [`Swagger BreakingChange` and `BreakingChange(Cross-Version)`](#swagger-breakingchange-and-breakingchangecross-version) + - [Adding label on PR automatically](#adding-label-on-pr-automatically) + - [Run `oad` locally](#run-oad-locally) + - [`Swagger LintDiff` and `Swagger Lint(RPaaS)`](#swagger-lintdiff-and-swagger-lintrpaas) + - [`Swagger LintDiff` for TypeSpec: troubleshooting guides](#swagger-lintdiff-for-typespec-troubleshooting-guides) + - [`Record` causes `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition`](#recordunkown-causes-avoidadditionalproperties-and-propertiestypeobjectnodefinition) + - [`RequestBodyMustExistForPutPatch`](#requestbodymustexistforputpatch) + - [`PatchPropertiesCorrespondToPutProperties`](#patchpropertiescorrespondtoputproperties) + - [`@singleton` causes `EvenSegmentedPathForPutOperation` and `XmsPageableForListCalls`](#singleton-causes-evensegmentedpathforputoperation-and-xmspageableforlistcalls) + - [`AvoidAnonymousParameter`, `AvoidAnonymousTypes`, `IntegerTypeMustHaveFormat`](#avoidanonymousparameter-avoidanonymoustypes-integertypemusthaveformat) + - [`AvoidAnonymousTypes` inside a 202 response](#avoidanonymoustypes-inside-a-202-response) + - [`OAuth2Auth` causes `XmsEnumValidation`](#oauth2auth-causes-xmsenumvalidation) + - [`Swagger Avocado`](#swagger-avocado) + - [Get help fixing Avocado validation failures](#get-help-fixing-avocado-validation-failures) + - [Run avocado locally](#run-avocado-locally) + - [`Swagger ApiDocPreview`](#swagger-apidocpreview) + - [`TypeSpec Validation`](#typespec-validation) + - [Run `tsv` locally](#run-tsv-locally) + - [Suppression Process](#suppression-process) + - [Checks not covered by this guide](#checks-not-covered-by-this-guide) + - [Obsolete checks](#obsolete-checks) + # CI Fix Guide Short link: https://aka.ms/azsdk/ci-fix This page provides detailed instructions on how to diagnose, reproduce, fix and get help on various [automated validation tooling] failures on your [Azure REST API specs PR]. +For more help, see [aka.ms/azsdk/pr-getting-help] and [aka.ms/azsdk/support]. + ## 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 +## `Swagger SpellCheck` If you receive a spelling failure either fix the spelling to match or if there are words that need to be suppressed for your service then add the word to the override list in [cspell.json](https://github.com/Azure/azure-rest-api-specs/blob/main/cSpell.json). Either -add to your existing section or create a new section for your specific spec or service family if the work is more generally used in losts of files under your service. +add to your existing section or create a new section for your specific spec or service family if the work is more generally used in lots of files under your service. ``` "overrides": [ ... example of specific file override @@ -36,7 +70,7 @@ If you need more information on see [cspell configuration](https://cspell.org/co *Note*: We are trying to move away from one shared dictionary file so try and avoid editing custom-words.txt in the root as it will likely go away in the future. -## Prettier check +## `Swagger PrettierCheck` First, ensure you have fulfilled `Prerequisites` as explained above. @@ -46,7 +80,7 @@ To update all the spec files for a given service run the following: # 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 +# OPTIONAL STEP: To fix a particular service OpenAPI spec cd to that directory like cd specification/contosowidgetmanager # Install the dependencies to the local 'node_modules' folder. @@ -67,45 +101,45 @@ Then please commit and push changes made by prettier. - [Source: Swagger-Prettier-Check.ps1](https://github.com/Azure/azure-rest-api-specs/blob/main/eng/scripts/Swagger-Prettier-Check.ps1) - [Pipeline: Swagger PrettierCheck](https://dev.azure.com/azure-sdk/public/_build?definitionId=6405) -## Model Validation +## `Swagger ModelValidation` -Run Model Validation locally: +To repro issues with `Swagger ModelValidation` locally: ``` npm install -g oav -oav validate-example +oav validate-example ``` Please see [readme](https://github.com/Azure/oav/blob/bd04e228b4181c53769ed88e561dec5212e77253/README.md) for how to install or run tool in details. Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/static-validation/static/errors/default). Refer to [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/Semantic-and-Model-Violations-Reference.md) for detailed description of validations and how-to-fix guidance. Refer to [Swagger-Example-Generation](https://github.com/Azure/oav/blob/develop/documentation/example-generation.md) for example automatic generation. -## Semantic Validation +## `Swagger SemanticValidation` -Run Semantic Validation locally: +To repro issues with `Swagger SemanticValidation` locally: ``` npm install -g oav -oav validate-spec +oav validate-spec ``` Please see [readme](https://github.com/Azure/oav/blob/bd04e228b4181c53769ed88e561dec5212e77253/README.md) for how to install or run tool in details. Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/static-validation/static/errors/default) Refer to [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/Semantic-and-Model-Violations-Reference.md) for detailed description of validations and how-to-fix guidance. -## Breaking Change Check +## `Swagger BreakingChange` and `BreakingChange(Cross-Version)` - An API contract is identified by its api-version value. Once published, no changes to this API contract are allowed. This applies regardless of whether the API contract is for private preview, public preview, or GA (stable). - - The same-version breaking change linter rules check for changes to an existing api-version swagger. + - The same-version breaking change linter rules check for changes to an existing api-version OpenAPI spec. - When introducing a new API contract (preview or not), the new API contract must be backwards compatible with the previous GA’s API contract. - However, during a (private or public) preview cycle, a new preview API contract does not have to be backwards compatible with the previous preview API contract although it must still be backwards compatible with the latest GA API contract. - - The cross version breaking change linter rules checks for this by comparing the new swagger with the latest GA swagger. If there is no latest GA swagger, then the latest preview if it > 1 year old. If nether a GA or preview > 1 year old exists, then the swagger is considered good. + - The cross version breaking change linter rules checks for this by comparing the new OpenAPI spec with the latest GA OpenAPI spec. If there is no latest GA OpenAPI spec, then the latest preview if it > 1 year old. If nether a GA or preview > 1 year old exists, then the OpenAPI spec is considered good. ### Adding label on PR automatically The breaking change check has two types of violations: one is breaking change in the same version but not breaking change in a new version, the other is breaking change even in a new version. -For the former, a label 'NewApiVersionRequired' will be added automatically; For the latter, a label 'BreakingChangeReviewRequired' will be added automatically. Adding each label will trigger a github comment with guildance on how to fix. +For the former, a label 'NewApiVersionRequired' will be added automatically; For the latter, a label 'BreakingChangeReviewRequired' will be added automatically. Adding each label will trigger a github comment with guldance on how to fix. -### Run locally +### Run `oad` locally -run oad locally (the breaking change is reported by oad tool): +To repro issues with "breaking changes" checks, you can locally run the tool that powers them [Azure/openapi-diff](https://github.com/Azure/openapi-diff) aka `oad`: ``` npm install -g @azure/oad oad compare @@ -114,7 +148,7 @@ Please see [readme](https://github.com/Azure/openapi-diff/blob/main/README.md) f Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/diff). Refer to [Oad Docs](https://github.com/Azure/openapi-diff/tree/main/docs) for detailed description of all oad rules. -## Swagger LintDiff +## `Swagger LintDiff` and `Swagger Lint(RPaaS)` The [LintDiff validation tool](https://github.com/Azure/azure-openapi-validator) runs linting rules against specification difference. Two specifications are compared: the specification as it would be when proposed PR is merged, vs the specification as seen before the PR is merged. @@ -123,21 +157,62 @@ If that guidance is not enough, please also refer to the [LintDiff rules.md doc] To reproduce LintDiff failures locally, see [CONTRIBUTING.md / How to locally reproduce a LintDiff failure occurring on a PR](https://github.com/Azure/azure-openapi-validator/blob/main/CONTRIBUTING.md#how-to-locally-reproduce-a-lintdiff-failure-occurring-on-a-pr). -## Swagger LintDiff for TypeSpec +## `Swagger LintDiff` for TypeSpec: troubleshooting guides + +Check `Swagger LintDiff` may fail for the OpenAPI generated from TypeSpec, even if there are no warnings or errors reported from the TypeSpec compiler. Causes include bugs in the TypeSpec OpenAPI emitter, bugs in LintDiff rules, incompatibilities between TypeSpec and LintDiff, or checks duplicated in TypeSpec and LintDiff. + +We are working to address the root causes (where possible). Until then, we recommend you [suppress](#suppression-process) these LintDiff errors, using a "permanent suppression" with a descriptive "reason", so we can revert your suppression when the root cause is fixed. ### `Record` causes `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition` -The use of `Record` in TypeSpec is discouraged, and there is a TypeSpec lint rule to enforce this. If you still need to use `Record`, the swagger generated will cause many LintDiff errors of types `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition`. You will need to suppress both the TypeSpec violation (in TypeSpec source code) and the LintDiff violations (in `readme.md`). +The use of `Record` in TypeSpec is discouraged, and there is a TypeSpec lint rule to enforce this. If you still need to use `Record`, the OpenAPI spec generated will cause many LintDiff errors of types `AvoidAdditionalProperties` and `PropertiesTypeObjectNoDefinition`. You will need to suppress both the TypeSpec violation (in TypeSpec source code) and the LintDiff violations. ### `RequestBodyMustExistForPutPatch` -We believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/641. Until fixed, spec authors should **not** suppress the violations in `readme.md`, but rather have label `Approved-LintDiff` applied to their PR to ignore the errors. +We believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/641 ### `PatchPropertiesCorrespondToPutProperties` -We believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/642. Until fixed, spec authors should **not** suppress the violations in `readme.md`, but rather have label `Approved-LintDiff` applied to their PR to ignore the errors. +We believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/642 + +### `@singleton` causes `EvenSegmentedPathForPutOperation` and `XmsPageableForListCalls` + +If `EvenSegmentedPathForPutOperation` and/or `XmsPageableForListCalls` are failing for OpenAPI generated from TypeSpec using `@singleton` (OpenAPI path ends with `/default`), we believe this is a false positive: https://github.com/Azure/azure-openapi-validator/issues/646 + +### `AvoidAnonymousParameter`, `AvoidAnonymousTypes`, `IntegerTypeMustHaveFormat` + +Data-plane specs can suppress violations of the following rules, since they only exist for the benefit of SDKs generated from swagger, and data-plane SDKs are generated directly from TypeSpec. Resource-manager specs should **not** suppress violations of these rules, since resource-manager SDKs are generated from OpenAPI, and rely on these errors being fixed. + +* `AvoidAnonymousParameter` +* `AvoidAnonymousTypes` +* `IntegerTypeMustHaveFormat` + +### `AvoidAnonymousTypes` inside a 202 response + +As an exception to the previous note, resource-manager specs **may** be able to suppress `AvoidAnonymousTypes`, but only if the error is inside a 202 response from a long-running operation (LRO). It is known that SDKs do not need to generate type names for such responses. -## Avocado +### `OAuth2Auth` causes `XmsEnumValidation` + +TypeSpec using `OAuth2Auth` may generate the following OpenAPI: + +``` +"type": { + "type": "string", + "description": "OAuth2 authentication", + "enum": [ + "oauth2" + ] +}, +``` + +Which causes error `XmsEnumValidation`. The recommended workaround is to add `omit-unreachable-types: true` to your `tspconfig.yaml`. + +## `Swagger Avocado` + +>[!IMPORTANT] +> `Swagger Avocado` check is not a blocking for merging your PR, even if it fails. +> It is left to the discretion of the PR reviewer if the Avocado failure actually +> needs to be addressed or suppressed. ### Get help fixing Avocado validation failures @@ -153,12 +228,12 @@ avocado When type avocado in command line, avocado will validate in the current directory. -Note: When running in Swagger PR pipeline, Avocado only report errors with file updates in the PR, but ignore the errors existing in base. However when running Avocado against local directory, it reports all errors existing in the files. +Note: When running in OpenAPI spec PR pipeline, Avocado only report errors with file updates in the PR, but ignore the errors existing in base. However when running Avocado against local directory, it reports all errors existing in the files. - Run all specs: Clone the repo `azure/azure-rest-api-specs` and run "avocado" in folder `azure/azure-rest-api-specs`. - Run single service specs: create a folder `specification`. and move your service specs folder in `specification`. run "avocado" -## API Doc Preview +## `Swagger ApiDocPreview` If you see `Swagger ApiDocPreview ` check fail with a failure [like this one](https://github.com/Azure/azure-rest-api-specs/pull/24841/checks?check_run_id=15056283615): @@ -166,13 +241,14 @@ If you see `Swagger ApiDocPreview ` check fail with a failure [like this one](ht |-|-| | ❌ RestBuild error | "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=373646&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
"detail":"Run.ps1 failed with exit code 1 " | -Refer to [troubleshoothing REST API documentation](https://eng.ms/docs/products/azure-developer-experience/design/api-docs-troubleshooting). +Refer to [troubleshooting REST API documentation](https://eng.ms/docs/products/azure-developer-experience/design/api-docs-troubleshooting). + +## `TypeSpec Validation` -## TypeSpec Validation +This validator will help ensure your TypeSpec project follows [standard conventions](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/typespec-structure-guidelines.md) as well ensures that the [generated OpenAPI spec](https://azure.github.io/typespec-azure/docs/emitters/typespec-autorest) files are in-sync with your project. -This validator will help ensure your TypeSpec project follows [standard conventions](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/typespec-structure-guidelines.md) as well ensures that the [generated swagger](https://azure.github.io/typespec-azure/docs/emitters/typespec-autorest) files are in-sync with your project. +### Run `tsv` locally -### Run tsv locally ``` cd git checkout @@ -184,15 +260,23 @@ git commit; git push (if any changes) # example npx tsv specification/contosowidgetmanager/Contoso.WidgetManager ``` -Then check any errors that might be outputted and address any issues as needed. If there are changed files after the run it generally means that the generated swagger files were not in-sync with the TypeSpec project and you should include those changes in your pull request as well. +Then check any errors that might be outputted and address any issues as needed. If there are changed files after the runit generally means +that the generated OpenAPI spec files were not in-sync with the TypeSpec project and you should include those changes in your pull request as well. + +If none of the above helped, please reach out on [TypeSpec Discussions Teams channel]. ## Suppression Process In case there are validation errors reported against your service that you believe do not apply, we have a suppression process you can follow to permanently remove these reported errors for your specs. Refer to the [suppression guide](https://aka.ms/pr-suppressions) for detailed guidance. -## Obsolete tools +## Checks not covered by this guide + +If you have an issue with a check that is not covered by this guide and the help at [aka.ms/azsdk/pr-getting-help] is not enough, +please reach out on the Teams channel: [aka.ms/azsdk/support/specreview-channel]. + +## Obsolete checks -Following tools have been removed from the validation toolchain as of August 2023. +Following checks have been removed from the validation toolchain as of August 2023. - API Readiness Check - Service API Readiness Test @@ -200,3 +284,7 @@ Following tools have been removed from the validation toolchain as of August 202 [automated validation tooling]: https://eng.ms/docs/products/azure-developer-experience/design/api-specs/api-tooling [Azure REST API specs PR]: https://eng.ms/docs/products/azure-developer-experience/design/api-specs-pr/api-specs-pr +[aka.ms/azsdk/pr-getting-help]: https://aka.ms/azsdk/pr-getting-help +[aka.ms/azsdk/support/specreview-channel]: https://aka.ms/azsdk/support/specreview-channel +[aka.ms/azsdk/support]: https://aka.ms/azsdk/support +[TypeSpec Discussions Teams channel]: https://teams.microsoft.com/l/channel/19%3A906c1efbbec54dc8949ac736633e6bdf%40thread.skype/TypeSpec%20Discussion%20%F0%9F%90%AE?groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47 diff --git a/documentation/samplefiles/readme.python.md b/documentation/samplefiles/readme.python.md index 77370bd6ea83..9a8ce22a92da 100644 --- a/documentation/samplefiles/readme.python.md +++ b/documentation/samplefiles/readme.python.md @@ -16,3 +16,8 @@ clear-output-folder: true no-namespace-folders: true output-folder: $(python-sdks-folder)/[[ServiceName]]/azure-mgmt-[[ServiceName]]/azure/mgmt/[[ServiceName]] ``` + +``` yaml $(python) +modelerfour: + flatten-models: false +``` diff --git a/eng/pipelines/templates/steps/npm-install.yml b/eng/pipelines/templates/steps/npm-install.yml index 6ea32a5642da..feaefe92bf16 100644 --- a/eng/pipelines/templates/steps/npm-install.yml +++ b/eng/pipelines/templates/steps/npm-install.yml @@ -1,4 +1,13 @@ +parameters: +- name: NodeVersion + type: string + default: 20.x steps: + - task: NodeTool@0 + inputs: + versionSpec: ${{ parameters.NodeVersion }} + displayName: "Use Node ${{ parameters.NodeVersion }}" + - script: npm --version --loglevel info displayName: npm --version diff --git a/eng/pipelines/typespec-requirement.yml b/eng/pipelines/typespec-requirement.yml index 6f2f3405f166..da77037c4aae 100644 --- a/eng/pipelines/typespec-requirement.yml +++ b/eng/pipelines/typespec-requirement.yml @@ -1,7 +1,7 @@ trigger: none jobs: -- job: TypeSpec_Requirement +- job: displayName: TypeSpec Requirement pool: name: azsdk-pool-mms-ubuntu-2204-general diff --git a/eng/pipelines/typespec-validation-all.yml b/eng/pipelines/typespec-validation-all.yml index 100546bfe18b..3e5e80169c68 100644 --- a/eng/pipelines/typespec-validation-all.yml +++ b/eng/pipelines/typespec-validation-all.yml @@ -37,7 +37,8 @@ resources: - main jobs: -- job: Validate_All_Specs +- job: + displayName: Validate All Specs strategy: matrix: @@ -59,4 +60,3 @@ jobs: $(Build.SourcesDirectory)/eng/scripts/Validate-TypeSpec.ps1 -CheckAll -GitClean -Verbose displayName: Validate All Specs ignoreLASTEXITCODE: true - condition: succeededOrFailed() diff --git a/eng/pipelines/typespec-validation.yml b/eng/pipelines/typespec-validation.yml index f394233a5325..a943d307d603 100644 --- a/eng/pipelines/typespec-validation.yml +++ b/eng/pipelines/typespec-validation.yml @@ -1,7 +1,8 @@ trigger: none jobs: -- job: Validate_Impacted_Specs +- job: + displayName: Validated Impacted Specs pool: name: azsdk-pool-mms-ubuntu-2204-general vmImage: ubuntu-22.04 @@ -13,4 +14,3 @@ jobs: $(Build.SourcesDirectory)/eng/scripts/Validate-TypeSpec.ps1 -GitClean -Verbose displayName: Validate Impacted Specs ignoreLASTEXITCODE: true - condition: succeededOrFailed() diff --git a/eng/scripts/ChangedFiles-Functions.ps1 b/eng/scripts/ChangedFiles-Functions.ps1 index 0968b252df54..074d282ab297 100644 --- a/eng/scripts/ChangedFiles-Functions.ps1 +++ b/eng/scripts/ChangedFiles-Functions.ps1 @@ -18,8 +18,8 @@ function Get-ChangedFiles($baseCommitish = "HEAD^", $targetCommitish = "HEAD", $ return $changedFiles } -function Get-ChangedSwaggerFiles() { - $changedFiles = Get-ChangedFilesUnderSpecification +function Get-ChangedSwaggerFiles($changedFiles = (Get-ChangedFiles)) { + $changedFiles = Get-ChangedFilesUnderSpecification $changedFiles $changedSwaggerFiles = $changedFiles.Where({ $_.EndsWith(".json") diff --git a/eng/scripts/Copy-ApiVersion.ps1 b/eng/scripts/Copy-ApiVersion.ps1 new file mode 100644 index 000000000000..19583778c3b8 --- /dev/null +++ b/eng/scripts/Copy-ApiVersion.ps1 @@ -0,0 +1,77 @@ +[CmdletBinding()] +param ( + [Parameter(Mandatory = $true)] + [string] $ServiceDirectory, + + [Parameter()] + [ValidateSet('data-plane', 'resource-manager')] + [string] $ServiceType = 'data-plane', + + [Parameter(Mandatory = $true)] + [string] $Provider, + + [Parameter()] + [ValidateScript({ + function script:Get-Version([string] $version) { + if ($version -match '^(?stable|preview)/(?(\d{4}-\d{2}-\d{2}|\d+\.\d+)(-preview(\.\d+)?)?)$') { + return $Matches['status'], $Matches['version'] + } + + throw 'Version must start with "stable/" or "preview/" and end with either a date-based version (recommended) like 2024-01-05 or a major.minor semver, followed by an optional "-preview" for previews APIs.' + } + # Throwing or returning truthy is sufficient. + Get-Version $_ + })] + [string] $FromVersion, + + [Parameter()] + [ValidateScript({Get-Version $_})] + [string] $ToVersion +) + +$ErrorActionPreference = 'Stop' + +$oldVersionStatus, $oldVersion = Get-Version $FromVersion +$newVersionStatus, $newVersion = Get-Version $ToVersion + +$repoDirectory = Resolve-Path "$PSScriptRoot/../.." +$readmeDirectory = Join-Path $repoDirectory "specification/$ServiceDirectory/$ServiceType" -Resolve +$oldDirectory = Join-Path $repoDirectory "specification/$ServiceDirectory/$ServiceType/$Provider/$oldVersionStatus/$oldVersion" -Resolve +$newDirectory = Join-Path $repoDirectory "specification/$ServiceDirectory/$ServiceType/$Provider/$newVersionStatus/$newVersion" + +# Copy the specs and create and initial commit to make it easier to diff changes to the previous version in a PR. +Copy-Item $oldDirectory $newDirectory -Recurse -Force + +git add $newDirectory +@" +Copy files from $FromVersion + +Copied the files in a separate commit. +This allows reviewers to easily diff subsequent changes against the previous spec. +"@ | git commit --file=- + +# Replace the $oldVersion with the $newVersion within all files in $newDirectory. +foreach ($file in Get-ChildItem $newDirectory -File -Recurse) { + Write-Verbose "Replacing any API versions in $file" + $content = $file | Get-Content -Raw + $content -replace $oldVersion, $newVersion | Set-Content $file.FullName +} + +# Commit just the version changes. +git add $newDirectory +@" +Update version to $ToVersion + +Updated the API version from $FromVersion to $ToVersion. +"@ | git commit --file=- + +Write-Host '' +Write-Host '!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!' -ForegroundColor 'Yellow' +Write-Host '!!! IMPORTANT: Action Required !!!' -ForegroundColor 'Yellow' +Write-Host '!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!' -ForegroundColor 'Yellow' +Write-Host '' +Write-Host "You must manually update the default version and copy $FromVersion sections from any markdown files in $readmeDirectory." +Write-Host 'When complete, commit those changes as shown below, push to the upstream repo, and submit a pull request.' +Write-Host '' +Write-Host ' git commit -am"Updated readme files"' +Write-Host '' \ No newline at end of file diff --git a/eng/scripts/TypeSpec-Requirement.ps1 b/eng/scripts/TypeSpec-Requirement.ps1 index 00abdce9300d..e7909dc10026 100644 --- a/eng/scripts/TypeSpec-Requirement.ps1 +++ b/eng/scripts/TypeSpec-Requirement.ps1 @@ -1,5 +1,10 @@ [CmdletBinding()] param ( + [Parameter(Position = 0)] + [string] $BaseCommitish = "HEAD^", + [Parameter(Position = 1)] + [string] $TargetCommitish = "HEAD" + ) Set-StrictMode -Version 3 @@ -9,9 +14,9 @@ Set-StrictMode -Version 3 $repoPath = Resolve-Path "$PSScriptRoot/../.." $pathsWithErrors = @() -$filesToCheck = @(Get-ChangedSwaggerFiles).Where({ +$filesToCheck = (Get-ChangedSwaggerFiles (Get-ChangedFiles $BaseCommitish $TargetCommitish)).Where({ ($_ -notmatch "/(examples|scenarios|restler|common|common-types)/") -and - ($_ -match "specification/(?[^/]+/(data-plane|resource-manager).*?/(preview|stable)/([^/]+))/[^/]+\.json$") + ($_ -match "specification/[^/]+/(data-plane|resource-manager).*?/(preview|stable)/[^/]+/[^/]+\.json$") }) if (!$filesToCheck) { @@ -21,28 +26,48 @@ else { # Cache responses to GitHub web requests, for efficiency and to prevent rate limiting $responseCache = @{} - # Example: specification/foo/resource-manager/Microsoft.Foo/stable/2023-01-01/Foo.json # - Forward slashes on both Linux and Windows + # - May be nested 4 or 5 levels deep, perhaps even deeper + # - Examples + # - specification/foo/data-plane/Foo/stable/2023-01-01/Foo.json + # - specification/foo/data-plane/Foo/bar/stable/2023-01-01/Foo.json + # - specification/foo/resource-manager/Microsoft.Foo/stable/2023-01-01/Foo.json foreach ($file in $filesToCheck) { LogInfo "Checking $file" - $jsonContent = Get-Content (Join-Path $repoPath $file) | ConvertFrom-Json -AsHashtable + try { + $jsonContent = Get-Content (Join-Path $repoPath $file) | ConvertFrom-Json -AsHashtable + + if ($null -ne ${jsonContent}?["info"]?["x-typespec-generated"]) { + LogInfo " OpenAPI was generated from TypeSpec (contains '/info/x-typespec-generated')" + # Skip further checks, since spec is already using TypeSpec + continue + } + else { + LogInfo " OpenAPI was not generated from TypeSpec (missing '/info/x-typespec-generated')" + } + } + catch { + LogWarning " OpenAPI cannot be parsed as JSON, so assuming not generated from TypeSpec" + LogWarning " $_" + } - if ($null -ne ${jsonContent}?["info"]?["x-typespec-generated"]) { - LogInfo " OpenAPI was generated from TypeSpec (contains '/info/x-typespec-generated')" - # Skip further checks, since spec is already using TypeSpec - continue + # Extract path between "specification/" and "/(preview|stable)" + if ($file -match "specification/(?[^/]+/(data-plane|resource-manager).*?)/(preview|stable)/[^/]+/[^/]+\.json$") { + $servicePath = $Matches["servicePath"] } else { - LogInfo " OpenAPI was not generated from TypeSpec (missing '/info/x-typespec-generated')" + LogError " Path to OpenAPI did not match expected regex. Unable to extract service path." + LogJobFailure + exit 1 } - # Example: specification/foo/resource-manager/Microsoft.Foo - $pathToServiceName = ($file -split '/')[0..3] -join '/' + $urlToStableFolder = "https://github.com/Azure/azure-rest-api-specs/tree/main/specification/$servicePath/stable" - $urlToStableFolder = "https://github.com/Azure/azure-rest-api-specs/tree/main/$pathToServiceName/stable" + # Avoid conflict with pipeline secret + $logUrlToStableFolder = $urlToStableFolder -replace '^https://','' - LogInfo " Checking $urlToStableFolder" + LogInfo " Checking $logUrlToStableFolder" $responseStatus = $responseCache[$urlToStableFolder]; if ($null -ne $responseStatus) { @@ -56,7 +81,7 @@ else { $responseCache[$urlToStableFolder] = $responseStatus } catch { - LogError " Exception making web request to ${urlToStableFolder}: $_" + LogError " Exception making web request to ${logUrlToStableFolder}: $_" LogJobFailure exit 1 } @@ -65,14 +90,14 @@ else { LogInfo " Status: $responseStatus" if ($responseStatus -eq 200) { - LogInfo " Branch 'main' contains path '$pathToServiceName/stable', so spec already exists and is not required to use TypeSpec" + LogInfo " Branch 'main' contains path '$servicePath/stable', so spec already exists and is not required to use TypeSpec" } elseif ($response.StatusCode -eq 404) { - LogInfo " Branch 'main' does not contain path '$pathToServiceName/stable', so spec is new and must use TypeSpec" + LogInfo " Branch 'main' does not contain path '$servicePath/stable', so spec is new and must use TypeSpec" $pathsWithErrors += $file } else { - LogError "Unexpected response from ${urlToStableFolder}: ${response.StatusCode}" + LogError "Unexpected response from ${logUrlToStableFolder}: ${response.StatusCode}" LogJobFailure exit 1 } diff --git a/eng/tools/typespec-validation/ci.yml b/eng/tools/typespec-validation/ci.yml index 16bd9b269831..720f81405ed9 100644 --- a/eng/tools/typespec-validation/ci.yml +++ b/eng/tools/typespec-validation/ci.yml @@ -17,16 +17,19 @@ pr: - eng/tools/typespec-validation jobs: -- job: Test +- job: + displayName: Test strategy: matrix: Linux: Pool: azsdk-pool-mms-ubuntu-2204-general OsVmImage: ubuntu-22.04 + NodeVersion: 18.x Windows: Pool: azsdk-pool-mms-win-2022-general OsVmImage: windows-2022 + NodeVersion: 21.x pool: name: $(Pool) @@ -34,6 +37,8 @@ jobs: steps: - template: /eng/pipelines/templates/steps/npm-install.yml + parameters: + NodeVersion: $(NodeVersion) - script: npm test displayName: npm test diff --git a/eng/tools/typespec-validation/package.json b/eng/tools/typespec-validation/package.json index 11a126acd43d..1e60cf8a921e 100644 --- a/eng/tools/typespec-validation/package.json +++ b/eng/tools/typespec-validation/package.json @@ -18,13 +18,13 @@ "@types/debug": "^4.1.8", "@types/mocha": "^10.0.2", "@types/node": "^18.16.18", - "typescript": "~5.1.3" + "typescript": "~5.3.3" }, "scripts": { "postinstall": "tsc", "test": "mocha --recursive --exit" }, "engines": { - "node": "^16.17.0 || ^18.3.0 || ^20.0.0" + "node": "^18.3.0 || ^20.0.0 || ^21.0.0" } } diff --git a/eng/tools/typespec-validation/src/index.ts b/eng/tools/typespec-validation/src/index.ts index 895872d4cc1c..997df10cb64b 100755 --- a/eng/tools/typespec-validation/src/index.ts +++ b/eng/tools/typespec-validation/src/index.ts @@ -21,6 +21,14 @@ export async function main() { const folder = parsedArgs.positionals[0]; const absolutePath = host.normalizePath(folder); + if (!(await host.checkFileExists(absolutePath))) { + console.log(`Folder ${absolutePath} does not exist`); + process.exit(1); + } + if (!(await host.isDirectory(absolutePath))) { + console.log(`Please run TypeSpec Validation on a directory path`); + process.exit(1); + } console.log("Running TypeSpecValidation on folder: ", absolutePath); const rules = [ diff --git a/eng/tools/typespec-validation/src/tsv-host.ts b/eng/tools/typespec-validation/src/tsv-host.ts index b470537bc40e..b274ed2a0a28 100644 --- a/eng/tools/typespec-validation/src/tsv-host.ts +++ b/eng/tools/typespec-validation/src/tsv-host.ts @@ -1,5 +1,6 @@ export interface TsvHost { checkFileExists(file: string): Promise; + isDirectory(path: string): Promise; gitOperation(folder: string): IGitOperation; readTspConfig(folder: string): Promise; runCmd(cmd: string, cwd: string): Promise<[Error | null, string, string]>; diff --git a/eng/tools/typespec-validation/src/tsv-runner-host.ts b/eng/tools/typespec-validation/src/tsv-runner-host.ts index 6876528b1168..d42261acda80 100644 --- a/eng/tools/typespec-validation/src/tsv-runner-host.ts +++ b/eng/tools/typespec-validation/src/tsv-runner-host.ts @@ -3,13 +3,17 @@ import { readFile } from "fs/promises"; import { IGitOperation, TsvHost } from "./tsv-host.js"; import { globby } from "globby"; import { simpleGit } from "simple-git"; -import { checkFileExists, normalizePath, runCmd } from "./utils.js"; +import { checkFileExists, isDirectory, normalizePath, runCmd } from "./utils.js"; export class TsvRunnerHost implements TsvHost { checkFileExists(file: string): Promise { return checkFileExists(file); } + isDirectory(path: string) { + return isDirectory(path); + } + gitOperation(folder: string): IGitOperation { return simpleGit(folder); } diff --git a/eng/tools/typespec-validation/src/utils.ts b/eng/tools/typespec-validation/src/utils.ts index 9675a63882e3..c2471159f9d3 100644 --- a/eng/tools/typespec-validation/src/utils.ts +++ b/eng/tools/typespec-validation/src/utils.ts @@ -1,4 +1,4 @@ -import { access } from "fs/promises"; +import { access, stat } from "fs/promises"; import { exec } from "child_process"; import defaultPath, { PlatformPath } from "path"; @@ -22,6 +22,10 @@ export async function checkFileExists(file: string) { .catch(() => false); } +export async function isDirectory(path: string) { + return (await stat(path)).isDirectory(); +} + export function normalizePath(folder: string, path: PlatformPath = defaultPath) { return path .resolve(folder) diff --git a/eng/tools/typespec-validation/test/tsv-test-host.ts b/eng/tools/typespec-validation/test/tsv-test-host.ts index 3e846e5856b5..f974608896bd 100644 --- a/eng/tools/typespec-validation/test/tsv-test-host.ts +++ b/eng/tools/typespec-validation/test/tsv-test-host.ts @@ -44,6 +44,10 @@ export class TsvTestHost implements TsvHost { return true; } + async isDirectory(_path: string): Promise { + return true; + } + normalizePath(folder: string): string { return normalizePath(folder, this.path); } diff --git a/package-lock.json b/package-lock.json index 42d7883b78a1..ae4cc14bc123 100644 --- a/package-lock.json +++ b/package-lock.json @@ -84,6 +84,37 @@ "node": ">=14.17" } }, + "eng/tools/node_modules/globby": { + "version": "13.2.2", + "resolved": "https://registry.npmjs.org/globby/-/globby-13.2.2.tgz", + "integrity": "sha512-Y1zNGV+pzQdh7H39l9zgB4PJqjRNqydvdYCDG4HFXM4XuvSaQQlEc91IU1yALL8gUTDomgBAfz3XJdmUS+oo0w==", + "dev": true, + "dependencies": { + "dir-glob": "^3.0.1", + "fast-glob": "^3.3.0", + "ignore": "^5.2.4", + "merge2": "^1.4.1", + "slash": "^4.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "eng/tools/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" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "eng/tools/typespec-validation": { "name": "@azure-tools/typespec-validation", "version": "0.0.1", @@ -103,10 +134,10 @@ "@types/node": "^18.16.18", "globby": "^13.1.1", "mocha": "^10.2.0", - "typescript": "~5.1.3" + "typescript": "~5.3.3" }, "engines": { - "node": "^16.17.0 || ^18.3.0 || ^20.0.0" + "node": "^18.3.0 || ^20.0.0 || ^21.0.0" } }, "node_modules/@azure-tools/typespec-apiview": { diff --git a/specification/ai/DocumentIntelligence/tspconfig.yaml b/specification/ai/DocumentIntelligence/tspconfig.yaml index 6dad95e3398a..53f8d00bb5fd 100644 --- a/specification/ai/DocumentIntelligence/tspconfig.yaml +++ b/specification/ai/DocumentIntelligence/tspconfig.yaml @@ -18,11 +18,10 @@ options: output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/DocumentIntelligence.json" # Uncomment this line and add "@azure-tools/typespec-python" to your package.json to generate Python code "@azure-tools/typespec-python": - "basic-setup-py": true - "package-version": 1.0.0b1 - "package-dir": "azure-ai-documentintelligence" - "package-name": "azure-ai-documentintelligence" - # "output-path": + package-pprint-name: "Azure AI Document Intelligence" + package-dir: "azure-ai-documentintelligence" + package-name: "{package-dir}" + package-version: 1.0.0b2 "@azure-tools/typespec-java": package-dir: "azure-ai-documentintelligence" namespace: "com.azure.ai.documentintelligence" diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.elements.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.elements.tsp new file mode 100644 index 000000000000..52b984dde70f --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.elements.tsp @@ -0,0 +1,388 @@ +using TypeSpec.Rest; +namespace Fhir.R4; + +alias markdown = string; + +@pattern("([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?") +scalar fhirDate extends string; + +@pattern("([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?") +scalar fhirDateTime extends string; + +@pattern("([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))") +scalar fhirInstant extends string; + +scalar fhirUri extends string; + +alias value_x = { + @doc("Value as Quantity") + valueQuantity?: Quantity; + + @doc("Value as CodeableConcept") + valueCodeableConcept?: CodeableConcept; + + @doc("Value as string") + valueString?: string; + + @doc("Value as boolean") + valueBoolean?: boolean; + + @doc("Value as integer") + valueInteger?: int32; + + @doc("Value as Range.") + valueRange?: Range; + + @doc("Value as Ratio.") + valueRatio?: Ratio; + + @doc("Value as SampledData.") + valueSampledData?: SampledData; + + @doc("Value as time (hh:mm:ss)") + valueTime?: plainTime; + + @doc("Value as dateTime.") + valueDateTime?: fhirDateTime; + + @doc("Value as Period.") + valuePeriod?: Period; + + @doc("Value as reference.") + valueReference?: Reference; +}; + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +Base for all elements +Based on [FHIR Element](https://www.hl7.org/fhir/datatypes.html#Element) +""") +model Extension extends Element { + @doc("Source of the definition for the extension code - a logical name or a URL.") + url: fhirUri; + + ...value_x; +} + +@doc("FHIR extendible element") +model Extendible { + @doc("Additional Content defined by implementations") + extension?: Extension[]; +} + +@doc(""" +The base definition for all elements contained inside a resource. +Based on [FHIR Element](https://www.hl7.org/fhir/R4/element.html) +""") +model Element { + @doc("Unique id for inter-element referencing") + id?: string; + + #suppress "@azure-tools/typespec-azure-core/property-name-conflict" "must keep the name 'extension' for compatibility with FHIR" + @doc("Additional Content defined by implementations") + extension?: Extension[]; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +A Coding is a representation of a defined concept using a symbol from a defined "code system". +Based on [FHIR Coding](https://www.hl7.org/fhir/R4/datatypes.html#Coding) +""") +model Coding extends Element { + @doc("Identity of the terminology system") + system?: fhirUri; + + @doc("Version of the system - if relevant") + version?: string; + + @doc("Symbol in syntax defined by the system") + code?: string; + + @doc("Representation defined by the system") + display?: string; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +Concept - reference to a terminology or just text +Based on [FHIR CodeableConcept](https://www.hl7.org/fhir/R4/datatypes.html#CodeableConcept) +""") +model CodeableConcept extends Element { + @doc("Code defined by a terminology system") + coding?: Array; + + @doc("Plain text representation of the concept") + text?: string; +} + +alias canonical = fhirUri; + +@doc(""" +Metadata about a resource +Based on [FHIR Meta](https://www.hl7.org/fhir/R4/resource.html#Meta) +""") +model Meta { + @doc("The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.") + versionId?: string; + + @doc("When the resource last changed - e.g. when the version changed.") + lastUpdated?: fhirInstant; + + @doc("A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.") + source?: fhirUri; + + @doc("A list of profiles (references to [StructureDefinition](https://www.hl7.org/fhir/structuredefinition.html) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](https://www.hl7.org/fhir/structuredefinition-definitions.html#StructureDefinition.url).") + profile?: Array; + + @doc("Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.") + security?: Array; + + @doc("Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.") + tag?: Array; +} + +alias xhtml = string; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +Any resource that is a [DomainResource](https://www.hl7.org/fhir/domainresource.html) may include a human-readable narrative that contains a summary of the resource and may be used to represent the content of the resource to a human. +Based on [FHIR Narrative](https://www.hl7.org/fhir/R4/narrative.html#Narrative) +""") +model Narrative extends Element { + @doc("generated, extensions, additional, empty") + status: string; + + @doc("xhtml") + div: xhtml; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +A reference from one resource to another +Based on [FHIR Reference](https://www.hl7.org/fhir/R4/references.html) +""") +model Reference extends Element { + #suppress "@azure-tools/typespec-azure-core/property-name-conflict" "must keep the name 'reference' for compatibility with FHIR" + @doc("Literal reference, Relative, internal or absolute URL") + reference?: string; + + @doc("Type the reference refers to (e.g. \"Patient\")") + type?: fhirUri; + + @doc("Logical reference, when literal reference is not known") + identifier?: Identifier; + + @doc("Text alternative for the resource") + display?: string; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +An identifier intended for computation +Based on [FHIR Identifier](https://www.hl7.org/fhir/R4/identifier.html) +""") +model Identifier extends Element { + @doc("usual | official | temp | secondary | old (If known)") + use?: string; + + @doc("Description of identifier") + type?: CodeableConcept; + + @doc("The namespace for the identifier value") + system?: fhirUri; + + @doc("The value that is unique") + value?: string; + + @doc("Time period when id is/was valid for use") + period?: Period; + + @doc("Organization that issued id (may be just text)") + assigner?: Reference; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +A time period defined by a start and end date and optionally time +Based on [FHIR Period](https://www.hl7.org/fhir/R4/datatypes.html#Period) +""") +model Period extends Element { + @doc("Starting time with inclusive boundary") + start?: fhirDateTime; + + @doc("End time with inclusive boundary, if not ongoing") + end?: fhirDateTime; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +A measured or measurable amount +Based on [FHIR Quantity](https://www.hl7.org/fhir/R4/datatypes.html#Quantity) +""") +model Quantity extends Element { + @doc("Numerical value (with implicit precision)") + value?: float64; + + @doc("< | <= | >= | > - how to understand the value") + comparator?: string; + + @doc("Unit representation") + unit?: string; + + @doc("System that defines coded unit form") + system?: fhirUri; + + @doc("Coded form of the unit") + code?: string; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +A set of ordered Quantities defined by a low and high limit +Based on [FHIR Range](https://www.hl7.org/fhir/R4/datatypes.html#Range) +""") +model Range extends Element { + @doc("Low limit") + low?: Quantity; + + @doc("High limit") + high?: Quantity; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +A ratio of two Quantity values - a numerator and a denominator +Based on [FHIR Ratio](https://www.hl7.org/fhir/R4/datatypes.html#Ratio) +""") +model Ratio extends Element { + @doc("Numerator value") + numerator?: Quantity; + + @doc("Denominator value") + denominator?: Quantity; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +A text note which also contains information about who made the statement and when +Based on [FHIR Annotation](https://www.hl7.org/fhir/R4/datatypes.html#Annotation) +""") +model Annotation extends Element { + @doc("Individual responsible for the annotation") + authorString?: string; + + @doc("When the annotation was made") + time?: fhirDateTime; + + @doc("The annotation - text content (as markdown)") + text: string; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +A series of measurements taken by a device +Based on [FHIR SampledData](https://www.hl7.org/fhir/R4/datatypes.html#SampledData) +""") +model SampledData extends Element { + @doc("Zero value and units") + origin: Quantity; + + @doc("Number of milliseconds between samples") + period: float64; + + @doc("Multiply data by this before adding to origin") + factor?: float64; + + @doc("Lower limit of detection") + lowerLimit?: float64; + + @doc("Upper limit of detection") + upperLimit?: float64; + + @doc("Number of sample points at each time point") + @minValue(1) + dimensions: int32; + + @doc("Decimal values with spaces, or \"E\" | \"U\" | \"L\"") + data?: string; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail) +""") +model ContactDetail extends Element { + @doc("Name of an individual to contact") + name?: string; + + @doc("Contact details for individual or organization") + telecom?: Array; +} + +@doc(""" +Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. +See https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint +""") +model ContactPoint { + @doc("phone | fax | email | pager | url | sms | other") + system?: ContactPointSystem; + + @doc("The actual contact point details") + value?: string; + + @doc("home | work | temp | old | mobile - purpose of this contact point") + use?: ContactPointUse; + + @doc("Specify preferred order of use (1 = highest)") + rank?: int32; + + @doc("Time period when the contact point was/is in use") + period?: Period; +} + +@doc(""" +Contact Point System +see https://www.hl7.org/fhir/R4/valueset-contact-point-system.html +""") +enum ContactPointSystem { + @doc("Phone") + Phone: "phone", + + @doc("Fax") + Fax: "fax", + + @doc("Email") + Email: "email", + + @doc("Pager") + Pager: "pager", + + @doc("Url") + Url: "url", + + @doc("Sms") + Sms: "sms", + + @doc("Other") + Other: "other", +} + +@doc(""" +Contact Point Use +See: http://hl7.org/fhir/ValueSet/contact-point-use +""") +enum ContactPointUse { + @doc("Home") + Home: "home", + + @doc("Work") + Work: "work", + + @doc("Temp") + Temp: "temp", + + @doc("Old") + Old: "old", + + @doc("Mobile") + Mobile: "mobile", +} diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.resources.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.resources.tsp new file mode 100644 index 000000000000..feb8561e2102 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.Common/model.common.fhir.resources.tsp @@ -0,0 +1,444 @@ +import "./model.common.fhir.elements.tsp"; + +using TypeSpec.Rest; + +namespace Fhir.R4; + +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" +@doc(""" +Resource is the ancestor of DomainResource from which most resources are derived. Bundle, Parameters, and Binary extend Resource directly. +Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html +""") +model Resource is Record { + @doc("The type of resource") + resourceType: string; + + @doc("Resource Id") + id?: string; + + @doc("Metadata about the resource") + meta?: Meta; + + @doc("A set of rules under which this content was created") + implicitRules?: fhirUri; + + @doc("Language of the resource content") + language?: string; +} + +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "must extends Resource to be able use clientName in both Resource and DomainResource" +@doc(""" +A resource with narrative, extensions, and contained resources +Based on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html) +""") +@discriminator("resourceType") +model DomainResource extends Resource { + @doc("Text summary of the resource, for human interpretation") + text?: Narrative; + + @doc("Contained, inline Resources") + contained?: Array; + + @doc("Additional Content defined by implementations") + extension?: Array; + + @doc("Extensions that cannot be ignored") + modifierExtension?: Array; +} + +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" +@doc(""" +Detailed information about conditions, problems or diagnoses +Based on [FHIR Condition](https://www.hl7.org/fhir/R4/condition.html) +""") +model Condition extends DomainResource { + @doc("resourceType") + resourceType: "Condition"; + + @doc("External Ids for this condition") + identifier?: Array; + + @doc("active | recurrence | relapse | inactive | remission | resolved") + clinicalStatus?: CodeableConcept; + + @doc("unconfirmed | provisional | differential | confirmed | refuted | entered-in-error") + verificationStatus?: CodeableConcept; + + @doc("problem-list-item | encounter-diagnosis") + category?: Array; + + @doc("Subjective severity of condition") + severity?: CodeableConcept; + + @doc("Identification of the condition, problem or diagnosis") + code?: CodeableConcept; + + @doc("Anatomical location, if relevant") + bodySite?: Array; + + @doc("Encounter created as part of") + encounter?: Reference; + + @doc("Estimated or actual date, date-time, or age") + onsetDateTime?: fhirDateTime; + + @doc("Estimated or actual date, date-time, or age") + onsetAge?: Quantity; + + @doc("Estimated or actual date, date-time, or age") + onsetPeriod?: Period; + + @doc("Estimated or actual date, date-time, or age") + onsetRange?: Range; + + @doc("Estimated or actual date, date-time, or age") + onsetString?: string; + + @doc("When in resolution/remission") + abatementDateTime?: fhirDateTime; + + @doc("When in resolution/remission") + abatementAge?: Quantity; + + @doc("When in resolution/remission") + abatementPeriod?: Period; + + @doc("When in resolution/remission") + abatementRange?: Range; + + @doc("When in resolution/remission") + abatementString?: string; + + @doc("Date record was first recorded") + recordedDate?: fhirDateTime; + + @doc("stge/grade, usually assessed formally") + stage?: Array; + + @doc("Additional information about the Condition") + note?: Array; +} + +@doc(""" +Stage/grade, usually assessed formally +Based on [FHIR Condition.Stage](https://www.hl7.org/fhir/R4/condition.html) +""") +model ConditionStage { + @doc("Simple summary (disease specific)") + summary?: CodeableConcept; + + @doc("Kind of staging") + type?: CodeableConcept; +} + +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" +@doc(""" +Detailed information about observations +Based on [FHIR Observation](https://www.hl7.org/fhir/R4/observation.html) +""") +model Observation extends DomainResource { + @doc("resourceType") + resourceType: "Observation"; + + @doc("Business Identifier for observation") + identifier?: Array; + + @doc("registered | preliminary | final | amended +") + status: ObservationStatusCodeType; + + @doc("Classification of type of observation") + category?: Array; + + @doc("Type of observation (code / type)") + code: CodeableConcept; + + @doc("Who and/or what the observation is about") + subject?: Reference; + + @doc("Healthcare event during which this observation is made") + encounter?: Reference; + + @doc("Clinically relevant time/time-period for observation") + effectiveDateTime?: fhirDateTime; + + @doc("Clinically relevant time/time-period for observation") + effectivePeriod?: Period; + + @doc("Clinically relevant time/time-period for observation") + effectiveInstant?: fhirInstant; + + @doc("Date/Time this version was made available") + issued?: fhirInstant; + + @doc("Actual result") + valueQuantity?: Quantity; + + @doc("Actual result") + valueCodeableConcept?: CodeableConcept; + + @doc("Actual result") + valueString?: string; + + @doc("Actual result") + valueBoolean?: boolean; + + @doc("Actual result") + valueInteger?: int32; + + @doc("Actual result") + valueRange?: Range; + + @doc("Actual result") + valueRatio?: Ratio; + + @doc("Actual result") + valueSampledData?: SampledData; + + @doc("Actual result") + valueTime?: plainTime; + + @doc("Actual result") + valueDateTime?: fhirDateTime; + + @doc("Actual result") + valuePeriod?: Period; + + @doc("Why the result is missing") + dataAbsentReason?: CodeableConcept; + + @doc("High, low, normal, etc.") + interpretation?: Array; + + @doc("Comments about the observation") + note?: Array; + + @doc("Observed body part") + bodySite?: CodeableConcept; + + @doc("How it was done") + method?: CodeableConcept; + + @doc("Provides guide for interpretation") + referenceRange?: Array; + + @doc("Related resource that belongs to the Observation group") + hasMember?: Array; + + @doc("Related measurements the observation is made from") + derivedFrom?: Array; + + @doc("Component results") + component?: Array; +} + +@doc(""" +Provides guide for interpretation of component result +Based on [FHIR Observation.referenceRange](https://www.hl7.org/fhir/R4/observation.html) +""") +model ObservationReferenceRange { + @doc("Low Range, if relevant") + low?: Quantity; + + @doc("High Range, if relevant") + high?: Quantity; + + @doc("Reference range qualifier") + type?: CodeableConcept; + + @doc("Reference range population") + appliesTo?: Array; + + @doc("Applicable age range, if relevant") + age?: Range; + + @doc("Text based reference range in an observation") + text?: string; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Keep is much as close to FHIR Spec" +@doc(""" +Component results +Based on [FHIR Observation.component](https://www.hl7.org/fhir/R4/observation.html) +""") +model ObservationComponent extends Element { + @doc("Type of component observation (code / type)") + code: CodeableConcept; + + ...value_x; + + @doc("Why the component result is missing") + dataAbsentReason?: CodeableConcept; + + @doc("High, low, normal, etc.") + interpretation?: Array; + + @doc("Provides guide for interpretation of component result") + referenceRange?: Array; +} + +@doc(""" +Observation Status +Based on [FHIR ObservationStatus](https://www.hl7.org/fhir/R4/valueset-observation-status.html) +""") +enum ObservationStatusCodeType { + @doc("The existence of the observation is registered, but there is no result yet available.") + Registered: "registered", + + @doc("This is an initial or interim observation: data may be incomplete or unverified.") + Preliminary: "preliminary", + + @doc("The observation is complete and verified by an authorized person.") + Final: "final", + + @doc("Subsequent to being Final, the observation has been modified subsequent. This includes updates/new information and corrections.") + Amended: "amended", + + @doc("Subsequent to being Final, the observation has been modified to correct an error in the test result.") + Corrected: "corrected", + + @doc("The observation is unavailable because the measurement was not started or not completed (also sometimes called \"aborted\").") + Cancelled: "cancelled", + + @doc("The observation has been withdrawn following previous final release.") + EnteredInError: "entered-in-error", + + @doc("The observation status is unknown. Note that \"unknown\" is a value of last resort and every attempt should be made to provide a meaningful value other than \"unknown\".") + Unknown: "unknown", +} + +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" +@doc(""" +Detailed information about Research Study +Based on [FHIR ResearchStudy](https://www.hl7.org/fhir/R4/researchstudy.html) +""") +model ResearchStudy extends DomainResource { + @doc("resourceType") + resourceType: "ResearchStudy"; + + @doc("Business Identifier for study") + identifier?: Array; + + @doc("Name for this study") + title?: string; + + @doc("Steps followed in executing study") + protocol?: Array; + + @doc("Part of larger study") + partOf?: Array; + + @doc("active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn") + status: ResearchStudyStatusCodeType; + + @doc("treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility") + primaryPurposeType?: CodeableConcept; + + @doc("n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4") + phase?: CodeableConcept; + + @doc("Classifications for the study") + category?: Array; + + @doc("Drugs, devices, etc. under study") + focus?: Array; + + @doc("Condition being studied") + condition?: Array; + + @doc("Contact details for the study") + contact?: Array; + + @doc("Used to search for the study") + keyword?: Array; + + @doc("Geographic region(s) for study") + location?: Array; + + @doc("What this is study doing") + description?: markdown; + + @doc("Inclusion & exclusion criteria") + enrollment?: Array; + + @doc("When the study began and ended") + period?: Period; + + @doc("Organization that initiates and is legally responsible for the study") + sponsor?: Reference; + + @doc("Researcher who oversees multiple aspects of the study") + principalInvestigator?: Reference; + + @doc("Facility where study activities are conducted") + site?: Array; + + @doc("accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design") + reasonStopped?: CodeableConcept; + + @doc("Comments made about the study") + note?: Array; + + @doc("Defined path through the study for a subject") + arm?: Array; + + @doc("A goal for the study") + objective?: Array; +} + +alias ResearchStudyArm = { + @doc("Label for study arm") + name: string; + + @doc("Categorization of study arm") + type?: CodeableConcept; + + @doc("Short explanation of study path") + description?: string; +}; + +alias ResearchStudyObjective = { + @doc("Label for the objective") + name: string; + + @doc("primary | secondary | exploratory") + type?: CodeableConcept; +}; + +@doc(""" +https://www.hl7.org/fhir/R4/codesystem-research-study-status.html +""") +enum ResearchStudyStatusCodeType { + @doc("The study is open for accrual.") + Active: "active", + + @doc("Study is completed prematurely and will not resume; patients are no longer examined nor treated.") + AdministrativelyCompleted: "administratively-completed", + + @doc("Protocol is approved by the review board.") + Approved: "approved", + + @doc("Study is closed for accrual; patients can be examined and treated.") + ClosedToAccrual: "closed-to-accrual", + + @doc("The study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study subjects have completed treatment or intervention but are still being followed according to the primary objective of the study.") + ClosedToAccrualAndIntervention: "closed-to-accrual-and-intervention", + + @doc("Study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study subjects have completed treatment or intervention but are still being followed according to the primary objective of the study.") + Completed: "completed", + + @doc("Protocol was disapproved by the review board.") + Disapproved: "disapproved", + + @doc("Protocol is submitted to the review board for approval.") + InReview: "in-review", + + @doc("The study is temporarily closed to accrual; a pause in accrual while study is reviewed, but is expected to resume.") + TemporarilyClosedToAccrual: "temporarily-closed-to-accrual", + + @doc("Study is temporarily closed for accrual; can be potentially resumed in the future") + TemporarilyClosedToAccrualAndIntervention: "temporarily-closed-to-accrual-and-intervention", + + @doc("Protocol was withdrawn by the lead organization.") + Withdrawn: "withdrawn", +} diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.request.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.request.tsp index b9491b12d096..7272b4d8c57d 100644 --- a/specification/ai/HealthInsights/HealthInsights.Common/model.common.request.tsp +++ b/specification/ai/HealthInsights/HealthInsights.Common/model.common.request.tsp @@ -1,4 +1,6 @@ import "./model.common.shared.tsp"; +import "./model.common.fhir.elements.tsp"; +import "./model.common.fhir.resources.tsp"; using TypeSpec.Rest; @@ -30,8 +32,11 @@ Patient structured information, including demographics and known structured clin """) info?: PatientInfo; + @doc("Patient encounters/visits.") + encounters?: Array; + @doc("Patient unstructured clinical data, given as documents.") - data?: PatientDocument[]; + patientDocuments?: Array; } @doc("Patient structured information, including demographics and known structured clinical information.") @@ -43,7 +48,7 @@ model PatientInfo { birthDate?: plainDate; @doc("Known clinical information for the patient, structured.") - clinicalInfo?: ClinicalCodedElement[]; + clinicalInfo?: Array; } #suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" @@ -69,11 +74,11 @@ enum ClinicalDocumentType { Consultation: "consultation", DischargeSummary: "dischargeSummary", HistoryAndPhysical: "historyAndPhysical", + RadiologyReport: "radiologyReport", Procedure: "procedure", Progress: "progress", - Imaging: "imaging", Laboratory: "laboratory", - Pathology: "pathology", + PathologyReport: "pathologyReport", } #suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" @@ -83,7 +88,10 @@ In case the source type is 'inline', the content is given as a string (for insta In case the source type is 'reference', the content is given as a URI. """) enum DocumentContentSourceType { + @doc("The content is given as a string (for instance, text).") Inline: "inline", + + @doc("The content is given as a URI.") Reference: "reference", } @@ -105,10 +113,95 @@ model PatientDocument { @doc("The date and time when the document was created.") createdDateTime?: utcDateTime; + @doc("Document author(s)") + authors?: Array; + + @doc("specialty type the document") + specialtyType?: SpecialtyType; + + @doc("Administrative metadata for the document.") + administrativeMetadata?: DocumentAdministrativeMetadata; + @doc("The content of the patient document.") content: DocumentContent; } +@doc("Document administrative metadata") +model DocumentAdministrativeMetadata { + @doc("List of procedure information associated with the document.") + @minItems(1) + orderedProcedures?: Array; + + @doc("Reference to the encounter associated with the document.") + encounterId?: string; +} + +@doc("visit/encounter information") +model Encounter { + @doc("The id of the visit.") + id: string; + + @doc(""" + Time period of the visit. + In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to indicate the discharge time. + """) + period?: TimePeriod; + + @doc("The class of the encounter.") + class?: EncounterClass; +} + +@doc("Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR value set--http://....).") +enum EncounterClass { + @doc(""" + A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned to a location where patients generally stay at least overnight and provided with room, board, and continuous nursing service. + """) + InPatient: "inpatient", + + @doc(""" + The term ambulatory usually implies that the patient has come to the location and is not assigned to a bed. Sometimes referred to as an outpatient encounter. + """) + Ambulatory: "ambulatory", + + @doc(""" + An encounter where the patient usually will start in different encounter, such as one in the emergency department but then transition to this type of encounter because they require a significant period of treatment and monitoring to determine whether or not their condition warrants an inpatient admission or discharge. + """) + Observation: "observation", + + @doc(""" + A patient encounter that takes place at a dedicated healthcare service delivery location where the patient receives immediate evaluation and treatment, provided until the patient can be discharged or responsibility for the patient's care is transferred elsewhere (for example, the patient could be admitted as an inpatient or transferred to another facility. + """) + Emergency: "emergency", + + @doc(""" + A patient encounter where the patient is not physically present for the encounter, such as in a telehealth encounter, phone call, or electronic communication. + """) + Virtual: "virtual", + + @doc(""" + Healthcare encounter that takes place in the residence of the patient or a designee + """) + HealthHome: "healthHome", +} + +@doc("Known values codes that can be used to indicate the type of the Specialty.") +enum SpecialtyType { + @doc("pathology") + Pathology: "pathology", + + @doc("radiology") + Radiology: "radiology", +} + +@doc("Document author") +model DocumentAuthor { + @doc("author id") + id?: string; + + @doc("Text representation of the full name") + fullName?: string; +} + @doc("The content of the patient document.") model DocumentContent { @doc(""" diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.response.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.response.tsp index a7d04f15ce02..6acc0d05d2b4 100644 --- a/specification/ai/HealthInsights/HealthInsights.Common/model.common.response.tsp +++ b/specification/ai/HealthInsights/HealthInsights.Common/model.common.response.tsp @@ -1,37 +1,50 @@ import "./model.common.shared.tsp"; +using Azure.Core; 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.") +/** + * Provides status details for long running operations. + * @template TStatusResult The type of the operation status result. + * @template TStatusError The type of the operation status error. If not provided, the default error is used. + */ +@doc("Provides status details for long running operations.") +model HealthInsightsOperationStatus< + TStatusResult = never, + TStatusError = Foundations.Error +> { + @key("operationId") + @doc("The unique ID of the operation.") @visibility("read") - @key - jobId: Azure.Core.uuid; + id: Azure.Core.uuid; + + @doc("The status of the operation") + @visibility("read") + @lroStatus + status: JobStatus; @doc("The date and time when the processing job was created.") @visibility("read") - createdDateTime: utcDateTime; + createdDateTime?: utcDateTime; @doc("The date and time when the processing job is set to expire.") @visibility("read") - expirationDateTime: utcDateTime; + expirationDateTime?: utcDateTime; @doc("The date and time when the processing job was last updated.") @visibility("read") - lastUpdateDateTime: utcDateTime; + lastUpdateDateTime?: utcDateTime; - @doc("The status of the processing job.") - @visibility("read") - status: JobStatus; - - @doc("An array of errors, if any errors occurred during the processing job.") - @visibility("read") - errors?: Azure.Core.Foundations.Error[]; -}; + @doc("Error object that describes the error when status is \"Failed\".") + error?: TStatusError; + @doc("The result of the operation.") + @lroResult + result?: TStatusResult; +} +////////////////// Inference ////////////////// @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.") @@ -46,6 +59,20 @@ model Inference { confidenceScore?: float32; } +#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next version" +@doc("The status of the processing job.") +@lroStatus +enum JobStatus { + NotStarted: "notStarted", + Running: "running", + Succeeded: "succeeded", + Failed: "failed", + Canceled: "canceled", +} + +@doc("The version of the model used for inference, expressed as the model date.") +scalar ModelVersion extends string; + @doc("A piece of evidence from a clinical note (text document).") model ClinicalNoteEvidence { @doc("The identifier of the document containing the evidence.") @@ -79,24 +106,3 @@ system. @maxValue(1) importance?: float32; } - -@doc("A piece of evidence corresponding to a Trial Matcher inference.") -model TrialMatcherInferenceEvidence { - @doc("A piece of evidence from the eligibility criteria text of a clinical trial.") - eligibilityCriteriaEvidence?: string; - - ...InferenceEvidence; -} - -#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next version" -@doc("The status of the processing job.") -enum JobStatus { - NotStarted: "notStarted", - Running: "running", - Succeeded: "succeeded", - Failed: "failed", - PartiallyCompleted: "partiallyCompleted", -} - -@doc("The version of the model used for inference, expressed as the model date.") -scalar ModelVersion extends string; diff --git a/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp b/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp index fc0f9e6577ac..327af95dabdb 100644 --- a/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp +++ b/specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp @@ -2,23 +2,161 @@ using TypeSpec.Rest; namespace AzureHealthInsights; +@doc("ConditionStage") +model ConditionStage { + @doc(""" + Simple summary (disease specific) + see: https://www.hl7.org/fhir/valueset-condition-stage.html +""") + summary: Fhir.R4.CodeableConcept; + + @doc(""" + Kind of staging + see: https://www.hl7.org/fhir/valueset-condition-stage-kind.html + """) + type?: Fhir.R4.CodeableConcept; +} + +@doc("InterpretationType ") +enum InterpretationType { + @doc("Normal") + Normal: "normal", + + @doc("Abnormal") + Abnormal: "abnormal", + + @doc("Below normal") + Low: "low", + + @doc("Above normal") + High: "high", + + @doc("Better") + Better: "better", + + @doc("Worse") + Worse: "worse", + + @doc("Resistant") + Resistant: "resistant", + + @doc("Susceptible") + Susceptible: "susceptible", + + @doc("As Expected") + Expected: "expected", + + @doc("Not as Expected") + NotExpected: "notExpected", +} + @doc(""" -A piece of clinical information, expressed as a code in a clinical coding system. +ObservationStatusType based on FHIR valueset observation-status +see: https://www.hl7.org/fhir/codesystem-observation-status.html """) -model ClinicalCodedElement { - @doc("The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS.") - system: string; +enum ObservationStatusType { + @doc("The existence of the observation is registered, but there is no result yet available.") + Registered: "registered", - @doc("The code within the given clinical coding system.") - code: string; + @doc("This is an initial or interim observation: data may be incomplete or unverified.") + Preliminary: "preliminary", - @doc("The name of this coded concept in the coding system.") - name?: string; + @doc(""" + The observation is complete and there are no further actions needed. Additional information such as 'released', 'signed', etc would be represented using [Provenance](provenance.html) which provides not only the act but also the actors and dates and other related data. + These act states would be associated with an observation status of `preliminary` until they are all completed and then a status of `final` would be applied. + """) + Final: "final", - @doc("A value associated with the code within the given clinical coding system.") - value?: string; + @doc("Subsequent to being Final, the observation has been modified subsequent. This includes updates/new information and corrections.") + Amended: "amended", + + @doc("Subsequent to being Final, the observation has been modified to correct an error in the test result.") + Corrected: "corrected", + + @doc("The observation is unavailable because the measurement was not started or not completed (also sometimes called \"aborted\").") + Cancelled: "cancelled", + + @doc("The observation has been withdrawn following previous final release. This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be \"cancelled\" rather than \"entered-in-error\".)") + EnteredInError: "enteredInError", + + @doc("The authoring/source system does not know which of the status values currently applies for this observation. Note: This concept is not to be used for \"other\" - one of the listed statuses is presumed to apply, but the authoring/source system does not know which.") + Unknown: "unknown", } +@doc(""" +ConditionDiagnosisSeverityType based on SNOMED CT International edition 31-July 2022 +see: http://snomed.info/sct +""") +enum ConditionDiagnosisSeverityType { + @doc("Severe ( http://snomed.info/sct#24484000 ))") + Severe: "severe", + + @doc("Moderate ( http://snomed.info/sct#6736007 ))") + Moderate: "moderate", + + @doc("Mild ( http://snomed.info/sct#255604002 ))") + Mild: "mild", +} + +@doc(""" +ConditionCategoryType based on FHIR valueset condition-category +""") +enum ConditionCategoryType { + @doc("An item on a problem list that can be managed over time and can be expressed by a practitioner (e.g. physician, nurse), patient or related person.") + ProblemListItem: "problemListItem", + + @doc("A point in time diagnosis (e.g. from a physician or nurse) in context of an encounter.") + EncounterDiagnosis: "encounterDiagnosis", +} + +@doc(""" +VerificationStatusType based of FHIR valueset condition-ver-status. +see: https://terminology.hl7.org/5.1.0/CodeSystem-condition-ver-status.html +""") +enum VerificationStatusType { + @doc("There is not sufficient diagnostic and/or clinical evidence to treat this as a confirmed condition.") + Unconfirmed: "unconfirmed", + + @doc("This is a tentative diagnosis - still a candidate that is under consideration.") + Provisional: "provisional", + + @doc("One of a set of potential (and typically mutually exclusive) diagnoses asserted to further guide the diagnostic process and preliminary treatment.") + Differential: "differential", + + @doc("There is sufficient diagnostic and/or clinical evidence to treat this as a confirmed condition.") + Confirmed: "confirmed", + + @doc("This condition has been ruled out by diagnostic and clinical evidence.") + Refuted: "refuted", + + @doc("The statement was entered in error and is not valid.") + EnteredInError: "enteredInError", +} + +// @doc(""" +// ClinicalStatusType based on FHIR ValueSet condition-clinical. +// See: https://terminology.hl7.org/5.1.0/CodeSystem-condition-clinical.html +// """) +// enum ClinicalStatusType { +// @doc("The subject is currently experiencing the condition or situation, there is evidence of the condition or situation, or considered to be a significant risk.") +// Active: "active"; +// @doc("The subject is experiencing a reoccurrence or repeating of a previously resolved condition or situation, e.g. urinary tract infection, food insecurity.") +// Recurrence: "recurrence"; +// @doc("The subject is experiencing a return of a condition or situation after a period of improvement or remission, e.g. relapse of cancer, alcoholism.") +// Relapse: "relapse"; +// @doc("The subject is no longer experiencing the condition or situation and there is no longer evidence or appreciable risk of the condition or situation.") +// Inactive: "inactive"; +// @doc("The subject is not presently experiencing the condition or situation, but there is a risk of the condition or situation returning.") +// Remission: "remission"; +// @doc("The subject is not presently experiencing the condition or situation and there is a negligible perceived risk of the condition or situation returning.") +// Resolved: "resolved"; +// @doc(""" +// The authoring/source system does not know which of the status values currently applies for this condition. +// Note: This concept is not to be used for 'other' - one of the listed statuses is presumed to apply, but the authoring/source system does not know which. +// """) +// Unknown: "unknown"; +// } + @doc(""" A location given as a combination of city, state and country/region. It could specify a city, a state or a country/region. In case a city is specified, either state +country/region or country/region (for countries/regions where there are no states) should be added. @@ -34,3 +172,38 @@ model GeographicLocation { @doc("Country/region name.") countryOrRegion: string; } + +@doc("A duration of time during which an event is happening") +model TimePeriod { + @doc("Starting time with inclusive boundary") + start?: utcDateTime; + + @doc("End time with inclusive boundary, if not ongoing") + end?: utcDateTime; +} + +@doc("Procedure information") +model OrderedProcedure is Fhir.R4.Extendible { + @doc("Procedure code") + code?: Fhir.R4.CodeableConcept; + + @doc("Procedure description") + description?: string; +} + +@doc(""" +A piece of clinical information, expressed as a code in a clinical coding system. +""") +model ClinicalCodedElement { + @doc("The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS.") + system: string; + + @doc("The code within the given clinical coding system.") + code: string; + + @doc("The name of this coded concept in the coding system.") + name?: string; + + @doc("A value associated with the code within the given clinical coding system.") + value?: string; +} diff --git a/specification/ai/HealthInsights/HealthInsights.Common/primitives.tsp b/specification/ai/HealthInsights/HealthInsights.Common/primitives.tsp index c1fabf7a1040..e8a887b5d93e 100644 --- a/specification/ai/HealthInsights/HealthInsights.Common/primitives.tsp +++ b/specification/ai/HealthInsights/HealthInsights.Common/primitives.tsp @@ -1,17 +1,62 @@ using Azure.Core; using TypeSpec.Http; +using Azure.Core.Traits; + 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, - TResponse -> is Azure.Core.Foundations.Operation< +op HealthInsightsLongRunningRpcOperation< + TParams extends TypeSpec.Reflection.Model, + TResponse extends TypeSpec.Reflection.Model, + TModelResult extends TypeSpec.Reflection.Model, + Traits extends TypeSpec.Reflection.Model = {} +> is Azure.Core.RpcOperation< TParams & RepeatabilityRequestHeaders, - (Foundations.AcceptedResponse & Foundations.RetryAfterHeader> & - RepeatabilityResponseHeaders) | TResponse, - RepeatabilityRequestHeaders & RepeatabilityResponseHeaders, - Azure.Core.Foundations.ErrorResponse + RepeatabilityResponseHeaders & + HealthInsightsOperationStatus, + Traits +>; + +#suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "This is a template" +@doc("Long running Pool operation template") +op HealthInsightsLongRunningPollOperation is Azure.Core.RpcOperation< + { + @doc("A processing job identifier.") + @path("id") + id: Azure.Core.uuid; + }, + TResult, + HealthInsightsRetryAfterTrait >; + +/** + * Metadata for long running operation status monitor locations. + * @template TStatusResult The type of the operation status result. + */ +@doc("Metadata for long running operation status monitor locations") +model HealthInsightsLongRunningStatusLocation { + @pollingLocation + @doc("The location for monitoring the operation state.") + @TypeSpec.Http.header("Operation-Location") + operationLocation: HealthInsightsResourceLocation>; +} + +/** + * A URL that points to a resource. + * @template TResource The type of resource that the URL points to. + */ +@doc("The location of an instance of {name}", TResource) +scalar HealthInsightsResourceLocation extends url; + +@trait("HealthInsightsRetryAfterTrait") +@doc("Health Insights retry after trait") +model HealthInsightsRetryAfterTrait { + @doc("The retry-after header.") + retryAfter: { + @traitLocation(TraitLocation.Response) + response: Foundations.RetryAfterHeader; + }; +} diff --git a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/client.tsp b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/client.tsp index 8f8460ce9d82..741be34c76ff 100644 --- a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/client.tsp +++ b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/client.tsp @@ -3,14 +3,12 @@ import "./route.oncophenotype.tsp"; import "@typespec/rest"; import "@typespec/http"; -import "@typespec/versioning"; import "../HealthInsights.OpenAPI/service.tsp"; using Azure.ClientGenerator.Core; -@TypeSpec.Versioning.useDependency(Azure.Core.Versions.v1_0_Preview_1) @TypeSpec.Versioning.useDependency( - AzureHealthInsights.ApiVersion.v2023_03_01_preview + AzureHealthInsights.ApiVersion.v2023_09_01_Preview ) namespace ClientForAzureHealthInsights; @@ -19,6 +17,72 @@ namespace ClientForAzureHealthInsights; service: AzureHealthInsights, }) interface CancerProfilingClient { + #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "https://github.com/microsoft/typespec/issues/2037" inferCancerProfile is AzureHealthInsights.OncoPhenotype.createJob; } + +@@projectedName(Fhir.R4.Extension, "java", "Fhir_R4_Extension"); +@@projectedName(Fhir.R4.Extension, "csharp", "Fhir_R4_Extension"); +@@projectedName(Fhir.R4.Extendible, "java", "Fhir_R4_Extendible"); +@@projectedName(Fhir.R4.Extendible, "csharp", "Fhir_R4_Extendible"); +@@projectedName(Fhir.R4.Element, "java", "Fhir_R4_Element"); +@@projectedName(Fhir.R4.Element, "csharp", "Fhir_R4_Element"); +@@projectedName(Fhir.R4.Coding, "java", "Fhir_R4_Coding"); +@@projectedName(Fhir.R4.Coding, "csharp", "Fhir_R4_Coding"); +@@projectedName(Fhir.R4.CodeableConcept, "java", "Fhir_R4_CodeableConcept"); +@@projectedName(Fhir.R4.CodeableConcept, "csharp", "Fhir_R4_CodeableConcept"); +@@projectedName(Fhir.R4.Meta, "java", "Fhir_R4_Meta"); +@@projectedName(Fhir.R4.Meta, "csharp", "Fhir_R4_Meta"); +@@projectedName(Fhir.R4.Narrative, "java", "Fhir_R4_Narrative"); +@@projectedName(Fhir.R4.Narrative, "csharp", "Fhir_R4_Narrative"); +@@projectedName(Fhir.R4.Reference, "java", "Fhir_R4_Reference"); +@@projectedName(Fhir.R4.Reference, "csharp", "Fhir_R4_Reference"); +@@projectedName(Fhir.R4.Identifier, "java", "Fhir_R4_Identifier"); +@@projectedName(Fhir.R4.Identifier, "csharp", "Fhir_R4_Identifier"); +@@projectedName(Fhir.R4.Period, "java", "Fhir_R4_Period"); +@@projectedName(Fhir.R4.Period, "csharp", "Fhir_R4_Period"); +@@projectedName(Fhir.R4.Quantity, "java", "Fhir_R4_Quantity"); +@@projectedName(Fhir.R4.Quantity, "csharp", "Fhir_R4_Quantity"); +@@projectedName(Fhir.R4.Range, "java", "Fhir_R4_Range"); +@@projectedName(Fhir.R4.Range, "csharp", "Fhir_R4_Range"); +@@projectedName(Fhir.R4.Ratio, "java", "Fhir_R4_Ratio"); +@@projectedName(Fhir.R4.Ratio, "csharp", "Fhir_R4_Ratio"); +@@projectedName(Fhir.R4.Annotation, "java", "Fhir_R4_Annotation"); +@@projectedName(Fhir.R4.Annotation, "csharp", "Fhir_R4_Annotation"); +@@projectedName(Fhir.R4.SampledData, "java", "Fhir_R4_SampledData"); +@@projectedName(Fhir.R4.SampledData, "csharp", "Fhir_R4_SampledData"); +@@projectedName(Fhir.R4.ContactDetail, "java", "Fhir_R4_ContactDetail"); +@@projectedName(Fhir.R4.ContactDetail, "csharp", "Fhir_R4_ContactDetail"); +@@projectedName(Fhir.R4.ContactPoint, "java", "Fhir_R4_ContactPoint"); +@@projectedName(Fhir.R4.ContactPoint, "csharp", "Fhir_R4_ContactPoint"); +@@projectedName(Fhir.R4.Resource, "java", "Fhir_R4_Resource"); +@@projectedName(Fhir.R4.Resource, "csharp", "Fhir_R4_Resource"); +@@projectedName(Fhir.R4.DomainResource, "java", "Fhir_R4_DomainResource"); +@@projectedName(Fhir.R4.DomainResource, "csharp", "Fhir_R4_DomainResource"); +@@projectedName(Fhir.R4.Condition, "java", "Fhir_R4_Condition"); +@@projectedName(Fhir.R4.Condition, "csharp", "Fhir_R4_Condition"); +@@projectedName(Fhir.R4.ConditionStage, "java", "Fhir_R4_ConditionStage"); +@@projectedName(Fhir.R4.ConditionStage, "csharp", "Fhir_R4_ConditionStage"); +@@projectedName(Fhir.R4.Observation, "java", "Fhir_R4_Observation"); +@@projectedName(Fhir.R4.Observation, "csharp", "Fhir_R4_Observation"); +@@projectedName(Fhir.R4.ObservationReferenceRange, + "java", + "Fhir_R4_ObservationReferenceRange" +); +@@projectedName(Fhir.R4.ObservationReferenceRange, + "csharp", + "Fhir_R4_ObservationReferenceRange" +); +@@projectedName(Fhir.R4.ObservationComponent, + "java", + "Fhir_R4_ObservationComponent" +); +@@projectedName(Fhir.R4.ObservationComponent, + "csharp", + "Fhir_R4_ObservationComponent" +); +@@projectedName(Fhir.R4.ResearchStudy, "java", "Fhir_R4_ResearchStudy"); +@@projectedName(Fhir.R4.ResearchStudy, "csharp", "Fhir_R4_ResearchStudy"); +@@projectedName(AzureHealthInsights.PatientInfoSex, "client", "PatientSex"); +@@projectedName(AzureHealthInsights.PatientInfo, "client", "PatientDetails"); diff --git a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp index d8d119be6f73..b1671219ef20 100644 --- a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp +++ b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp @@ -1,10 +1,9 @@ import "../HealthInsights.Common/model.common.request.tsp"; import "../HealthInsights.Common/model.common.response.tsp"; import "../HealthInsights.Common/model.common.shared.tsp"; -import "@azure-tools/typespec-azure-core"; +import "../HealthInsights.Common/model.common.fhir.elements.tsp"; using TypeSpec.Rest; -using Azure.Core; namespace AzureHealthInsights; @@ -16,21 +15,15 @@ model OncoPhenotypeData { configuration?: OncoPhenotypeModelConfiguration; } -@resource("oncophenotype/jobs") @doc("The response for the Onco Phenotype request.") -model OncoPhenotypeResult { - ...Response; - - @doc("The inference results for the Onco Phenotype request.") - @visibility("read") - @lroResult - results?: OncoPhenotypeResults; -} +@resource("onco-phenotype/jobs") +model OncoPhenotypeResult + is HealthInsightsOperationStatus; @doc("The inference results for the Onco Phenotype request.") -model OncoPhenotypeResults { +model OncoPhenotypeInferenceResult { @doc("Results for the patients given in the request.") - patients: OncoPhenotypePatientResult[]; + patientResults: OncoPhenotypePatientResult[]; @doc("The version of the model used for inference, expressed as the model date.") modelVersion: ModelVersion; @@ -39,10 +32,10 @@ model OncoPhenotypeResults { @doc("The results of the model's work for a single patient.") model OncoPhenotypePatientResult { @doc("The identifier given for the patient in the request.") - id: string; + patientId: string; @doc("The model's inferences for the given patient.") - inferences: OncoPhenotypeInference[]; + inferences: Array; } @doc("An inference made by the Onco Phenotype model regarding a patient.") @@ -89,4 +82,5 @@ enum OncoPhenotypeInferenceType { PathologicStageT: "pathologicStageT", PathologicStageN: "pathologicStageN", PathologicStageM: "pathologicStageM", + DiagnosisDate: "diagnosisDate", } diff --git a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp index 9d9ffa6e90ce..6f9f5f8e2ce1 100644 --- a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp +++ b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp @@ -12,16 +12,24 @@ using TypeSpec.Http; namespace AzureHealthInsights; interface OncoPhenotype { + #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Service uses a jobId in the path" @summary("Get Onco Phenotype job details") @tag("OncoPhenotype") @doc("Gets the status and details of the Onco Phenotype job.") - getJob is Azure.Core.ResourceRead; + @get + @route("/onco-phenotype/jobs/{id}") + getJob is HealthInsightsLongRunningPollOperation; + #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" #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") - createJob is LongRunningRpcOperation; + @route("/onco-phenotype/jobs") + createJob is HealthInsightsLongRunningRpcOperation< + OncoPhenotypeData, + OncoPhenotypeResult, + OncoPhenotypeInferenceResult + >; } diff --git a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/tspconfig.yaml b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/tspconfig.yaml index e1df4402a136..4c774611f806 100644 --- a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/tspconfig.yaml +++ b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/tspconfig.yaml @@ -1,19 +1,51 @@ -emit: [] +parameters: + "service-dir": + default: "sdk/healthinsights" + "service-name": + default: "HealthInsights" + "dependencies": + "additionalDirectories": + - "specification/ai/HealthInsights/HealthInsights.Common/" + - "specification/ai/HealthInsights/HealthInsights.OpenAPI/" + default: "" + "python-sdk-folder": + default: "{project-root}/azure-sdk-for-python/" + "java-sdk-folder": + default: "{project-root}/azure-sdk-for-java/" + "js-sdk-folder": + default: "{project-root}/azure-sdk-for-js/" + "csharp-sdk-folder": + default: "{project-root}/azure-sdk-for-net/" + "service-directory-name": + default: "healthinsights" +emit: + - "@azure-tools/typespec-autorest" linter: extends: - "@azure-tools/typespec-azure-core/all" options: - "@azure-tools/typespec-csharp": - namespace : "Azure.Health.Insights.CancerProfiling" - clear-output-folder : true - new-project : false - model-namespace : false + "@azure-tools/typespec-python": + package-pprint-name: '"Azure Health Insights - Cancer Profiling"' + package-mode: "dataplane" + package-version: 1.0.0b2 + package-dir: "azure-healthinsights-cancerprofiling" + package-name: "{package-dir}" + emitter-output-dir: "{python-sdk-folder}/sdk/{service-directory-name}/{package-name}" "@azure-tools/typespec-java": - namespace: "Com.Azure.Health.Insights.CancerProfiling" + package-dir: "azure-health-insights-cancerprofiling" + namespace: com.azure.health.insights.cancerprofiling + partial-update: true + emitter-output-dir: "{java-sdk-folder}/sdk/{service-directory-name}/azure-health-insights-cancerprofiling" + "@azure-tools/typespec-csharp": + save-inputs: false clear-output-folder: true - new-project: false + package-dir: "Azure.Health.Insights.CancerProfiling" + namespace: "{package-dir}" model-namespace: false - "@azure-tools/cadl-typescript": + "@azure-tools/typespec-ts": + package-dir: "azurehealthinsightscancerprofiling-rest" + emitter-output-dir: "{js-sdk-folder}/sdk/{service-directory-name}/health-insights-cancerprofiling-rest" + generateMetadata: true + generateTest: true packageDetails: - name: "@azure-rest/health-insights-cancerprofiling" - description: "Azure Health Insights CancerProfiling" + name: "@azure-rest/health-insights-cancerprofiling" \ No newline at end of file diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulOncoPhenotypeRequest.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulOncoPhenotypeRequest.json new file mode 100644 index 000000000000..08280a8b2e72 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulOncoPhenotypeRequest.json @@ -0,0 +1,64 @@ +{ + "operationId": "OncoPhenotype_CreateJob", + "title": "Creates an Onco Phenotype job with the given request body.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "body": { + "patients": [ + { + "id": "Patient ID Example 1", + "info": { + "sex": "female", + "birthDate": "1975-09-27" + }, + "patientDocuments": [ + { + "type": "note", + "clinicalType": "historyAndPhysical", + "id": "1", + "language": "en", + "createdDateTime": "2021-10-26T16:54:44.739Z", + "content": { + "sourceType": "inline", + "value": "Sample note 1" + } + }, + { + "type": "note", + "clinicalType": "imaging", + "id": "2", + "language": "en", + "createdDateTime": "2020-11-26T16:39:44.739Z", + "content": { + "sourceType": "inline", + "value": "Sample note 2" + } + } + ] + } + ], + "configuration": { + "verbose": true, + "includeEvidence": true, + "inferenceTypes": [ + "histology", + "clinicalStageT" + ], + "checkForCancerCase": false + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/health-insights/onco-phenotype/jobs/{id}?api-version=2023-09-01-preview", + "Retry-After": "1" + }, + "body": { + "status": "notStarted", + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulOncoPhenotypeResponse.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulOncoPhenotypeResponse.json new file mode 100644 index 000000000000..5695c10cdfc4 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulOncoPhenotypeResponse.json @@ -0,0 +1,65 @@ +{ + "operationId": "OncoPhenotype_GetJob", + "title": "Gets the status and details of the Onco Phenotype job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + "responses": { + "200": { + "body": { + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "createdDateTime": "2021-11-26T17:22:27.386Z", + "expirationDateTime": "2021-11-26T17:22:27.386Z", + "lastUpdateDateTime": "2021-11-26T17:22:27.386Z", + "status": "succeeded", + "result": { + "patientResults": [ + { + "patientId": "Patient ID Example 1", + "inferences": [ + { + "type": "histology", + "value": "8561", + "description": "Adenolymphoma", + "confidenceScore": 0.85, + "evidence": [ + { + "patientDataEvidence": { + "id": "1", + "text": "string", + "offset": 70, + "length": 135 + }, + "importance": 1 + } + ] + }, + { + "type": "clinicalStageT", + "value": "T3", + "description": "Locally advanced disease at risk for micrometastases", + "confidenceScore": 0.88, + "evidence": [ + { + "patientDataEvidence": { + "id": "2", + "text": "string", + "offset": 12, + "length": 9 + }, + "importance": 1 + } + ], + "caseId": "1" + } + ] + } + ], + "modelVersion": "2021-11-26" + } + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulPatientTimelineRequest.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulPatientTimelineRequest.json new file mode 100644 index 000000000000..50500c8cea6e --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulPatientTimelineRequest.json @@ -0,0 +1,23 @@ +{ + "operationId": "PatientTimeline_CreateJob", + "title": "Creates a Patient Timeline job with the given request body.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "body": { + "patients": [] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/health-insights/patient-timeline/jobs/{id}?api-version=2023-09-01-preview", + "Retry-After": "1" + }, + "body": { + "status": "notStarted", + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulPatientTimelineResponse.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulPatientTimelineResponse.json new file mode 100644 index 000000000000..a73eff7a3e34 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulPatientTimelineResponse.json @@ -0,0 +1,24 @@ +{ + "operationId": "PatientTimeline_GetJob", + "title": "Gets the status and details of the Patient Timeline job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754" + }, + "responses": { + "200": { + "body": { + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754", + "createdDateTime": "2021-11-28T09:13:11.046Z", + "expirationDateTime": "2021-11-28T09:13:11.046Z", + "lastUpdateDateTime": "2021-11-28T09:13:11.046Z", + "status": "succeeded", + "result": { + "patientResults": [], + "modelVersion": "2021-10-28" + } + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulRadiologyInsightsRequest.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulRadiologyInsightsRequest.json new file mode 100644 index 000000000000..6041b94cdfcb --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulRadiologyInsightsRequest.json @@ -0,0 +1,121 @@ +{ + "operationId": "RadiologyInsights_CreateJob", + "title": "Creates a Radiology Insights job with the given request body.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "body": { + "configuration": { + "inferenceOptions": { + "followupRecommendationOptions": { + "includeRecommendationsWithNoSpecifiedModality": false, + "includeRecommendationsInReferences": false, + "provideFocusedSentenceEvidence": false + }, + "findingOptions": { + "provideFocusedSentenceEvidence": false + } + }, + "inferenceTypes": [ + "finding", + "ageMismatch", + "lateralityDiscrepancy", + "sexMismatch", + "completeOrderDiscrepancy", + "limitedOrderDiscrepancy", + "criticalResult", + "criticalRecommendation", + "followupRecommendation", + "followupCommunication", + "radiologyProcedure" + ], + "locale": "en-US", + "verbose": false, + "includeEvidence": true + }, + "patients": [ + { + "id": "sample id 1", + "info": { + "sex": "male", + "clinicalInfo": [ + { + "resourceType": "Observation", + "status": "unknown", + "code": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0018802", + "display": "MalignantNeoplasms" + } + ] + }, + "valueBoolean": "true" + } + ] + }, + "encounters": [ + { + "id": "encounterid1", + "period": { + "start": "2023-12-21T00:00:00", + "end": "2023-12-21T00:00:00" + }, + "class": "inpatient" + } + ], + "patientDocuments": [ + { + "type": "note", + "clinicalType": "radiologyReport", + "id": "docid1", + "language": "en", + "authors": [ + { + "id": "authorid1", + "fullName": "authorname1" + } + ], + "specialtyType": "radiology", + "createdDateTime": "2023-12-21T00:00:00", + "administrativeMetadata": { + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "system": "Http://hl7.org/fhir/ValueSet/cpt-all", + "code": "111111", + "display": "CT ABD/PELVIS" + } + ] + }, + "description": "CT ABD/PELVIS" + } + ], + "encounterId": "encounterid1" + }, + "content": { + "sourceType": "inline", + "value": "[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\n[**Hospital 4**] MEDICAL CONDITION:\r\n52 year old man with urosepsis, s/p nephrostogram on [**4-12**], today with acute\r\nSOB, fever, rigors.\r\nREASON FOR THIS EXAMINATION:\r\n? PE, evidence of pneumonia\r\nNo contraindications for IV contrast\r\n______________________________________________________________________________\r\nFINAL REPORT\r\nINDICATION: History of urosepsis status post nephrostogram on [**4-12**], today\r\nwith acute shortness of breath, fevers, and rigors. Also reported hematocrit\r\ndrop. Evaluate for pulmonary embolism or hematoma.\r\nCOMPARISON: Non-contrast CT of the abdomen and pelvis dated [**2143-4-11**].\r\nTECHNIQUE: MDCT acquired images of the chest, abdomen, and pelvis were\r\nobtained before and after the administration of IV contrast. A true CT\r\nangiogram could not be performed due to lack of appropriate intravenous\r\naccess.\r\nCT OF THE CHEST WITHOUT AND WITH IV CONTRAST: Evaluation of the pulmonary\r\narteries is limited with no large central pulmonary embolism seen. Evaluation\r\nof the segmental and subsegmental branches is limited. There is a central\r\nvenous catheter that terminates in the right atrium. There are numerous small\r\nmesenteric and axillary lymph nodes that do not meet CT criteria for\r\npathologic enlargement. There are coronary artery calcifications. There are\r\nbilateral small layering pleural effusions with associated compressive\r\natelectasis. The images of the lungs are limited due to motion. There\r\nappears to be a patchy, predominantly ground-glass opacity in both lower\r\nlobes, left worse than right. The aorta appears intact. There is debris in\r\nthe trachea.\r\nCT OF THE ABDOMEN WITHOUT AND WITH IV CONTRAST: There is high-density\r\nmaterial tracking along the course of a dilated left ureter consistent with\r\nhemorrhage that is new compared to the previous study. New stranding in the\r\nleft retroperitoneum is also present consistent with retroperitoneal\r\nhemorrhage. Perinephric stranding is present, as was seen on the previous\r\nstudy. The degree of dilatation of the left ureter is unchanged. Several\r\nfoci of air outside of the collecting system are present, presumably\r\npostprocedural in nature. Contrast-enhanced images show abnormal perfusion of\r\nthe left kidney with a striated appearance, most severe at the upper pole with\r\nperipheral wedge-shaped hypoenhancing areas also present on top of the areas\r\nof reduced perfusion. No active extravasation of contrast is seen. The right\r\nkidney is normal. The liver, spleen, and adrenal glands are unremarkable.\r\nPancreas is unremarkable with slightly prominent distal common bile duct\r\nmeasuring up to 8-9 mm. There is a small cystic lesion measuring 5 mm at the\r\nhead of the pancreas (series 10, image 143). Small and large bowel are\r\n(Over)\r\n[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\nFINAL REPORT\r\n(Cont)\r\ngrossly unremarkable. The aorta, celiac artery, superior mesenteric artery,\r\ninferior mesenteric artery, and renal arteries appear patent.\r\nCT OF THE PELVIS WITHOUT AND WITH IV CONTRAST: The prostate gland is\r\nenlarged. Thickening of the bladder wall is again demonstrated. Several foci\r\nof air within the bladder are presumably secondary to the Foley catheter. The\r\nrectum and sigmoid colon are unremarkable.\r\nBONE WINDOWS: There are degenerative changes with no suspicious lytic or\r\nsclerotic lesions.\r\nIMPRESSION:\r\n1. New high-density material surrounding the left ureter and tracking within\r\nthe retroperitoneum consistent with hemorrhage.\r\n2. Abnormal perfusion of the left kidney, most severe at the upper pole.\r\nFindings are consistent with pyelonephritis. Edema and abnormal perfusion at\r\nthe upper pole and interpolar region medially with multiple peripheral\r\nhypoenhancing wedge- shaped regions likely represent ischemia and a component\r\nof infarction.\r\n3. Limited examination for pulmonary embolism due to suboptimal contrast\r\nbolus with no large central embolus seen. Evaluation of distal segmental and\r\nsubsegmental branches is limited.\r\n4. Small bilateral layering pleural effusions with associated compressive\r\natelectasis. Patchy predominantly ground-glass opacities in both lower lobes,\r\nleft worse than right could represent pneumonia or pneumonitis.\r\n5. 5mm cystic lesion in the head of the pancreas. Recommend 1 year follow up.\r\nThe above was discussed with Dr. [**First Name8 (NamePattern2) 951**] [**Last Name (NamePattern1) 1238**] at approximately 6:30 p.m. on\r\n[**2143-4-13**].\r\n" + } + } + ] + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2023-09-01-preview", + "Retry-After": "1" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulRadiologyInsightsResponse.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulRadiologyInsightsResponse.json new file mode 100644 index 000000000000..6167030c095f --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulRadiologyInsightsResponse.json @@ -0,0 +1,33451 @@ +{ + "operationId": "RadiologyInsights_GetJob", + "title": "Gets the status and details of the Radiology Insights job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + }, + "responses": { + "200": { + "body": { + "result": { + "patientResults": [ + { + "patientId": "sample id 1", + "inferences": [ + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6839", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246501002", + "display": "TECHNIQUE (ATTRIBUTE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4466 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4508 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6840", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246501002", + "display": "TECHNIQUE (ATTRIBUTE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4572 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4586 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4621 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4633 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6856", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6857", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6858", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91302008", + "display": "SEPSIS (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "46241-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "HOSPITAL ADMISSION DIAGNOSIS - REPORTED" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6859", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 457 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 457 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6860", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for exam" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6861", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for exam" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6862", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6863", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6864", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35566002", + "display": "HEMATOMA (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6865", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "81040000", + "display": "PULMONARY ARTERY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID974", + "display": "PULMONARY ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28586", + "display": "SET OF PULMONARY ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1301 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1307 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "large;;central" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1301 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1307 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6866", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41699000", + "display": "EFFUSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "compressive;;atelectasis" + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1668 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "27123005", + "display": "BILIARY SLUDGE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1668 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6867", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46621007", + "display": "ATELECTASIS (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71173004", + "display": "COMPRESSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6868", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + }, + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + }, + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6869", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6870", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6871", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6872", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91302008", + "display": "SEPSIS (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "46241-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "HOSPITAL ADMISSION DIAGNOSIS - REPORTED" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6874", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6875", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52674009", + "display": "ISCHEMIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6876", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55641003", + "display": "INFARCT (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6877", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4529 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "bolus" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4529 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6878", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41699000", + "display": "EFFUSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "compressive;;atelectasis" + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4647 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "27123005", + "display": "BILIARY SLUDGE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4647 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6879", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46621007", + "display": "ATELECTASIS (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71173004", + "display": "COMPRESSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6882", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "390870001", + "display": "SHORT OF BREATH DRESSING/UNDRESSING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6883", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "386661006", + "display": "FEVER (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6884", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43724002", + "display": "CHILL (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "16046003", + "display": "MUSCLE RIGIDITY (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6885", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "390870001", + "display": "SHORT OF BREATH DRESSING/UNDRESSING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6886", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "386661006", + "display": "FEVER (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6887", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43724002", + "display": "CHILL (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "16046003", + "display": "MUSCLE RIGIDITY (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6889", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "18115005", + "display": "PATHOLOGIC CALCIFICATION, CALCIFIED STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41801008", + "display": "CORONARY ARTERY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28727", + "display": "SET OF CORONARY ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID35862", + "display": "CORONARY ARTERY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6890", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "128305008", + "display": "ABNORMALLY OPAQUE STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1819 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "patchy" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1819 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6891", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "257159000", + "display": "DEBRIS (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "955009", + "display": "BRONCHIAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1247", + "display": "TRACHEA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6892", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2040 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2040 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6893", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "25322007", + "display": "DILATATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6894", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "118247008", + "display": "RADIOLOGIC FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6895", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "118247008", + "display": "RADIOLOGIC FINDING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2278 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6896", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "25322007", + "display": "DILATATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2396 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "58158008", + "display": "STABLE (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2396 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6897", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2417 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2422 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15158005", + "display": "AIR (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID223", + "display": "RENAL COLLECTING SYSTEM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2429 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "outside" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2417 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2422 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2429 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6898", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29663", + "display": "LEFT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2616 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272141005", + "display": "SEVERITIES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24484000", + "display": "SEVERE (SEVERITY MODIFIER) (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2647 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2658 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "peripheral;;wedge-shaped" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2616 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2630 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2636 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2647 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2658 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2671 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2675 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2685 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6899", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2736 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260400001", + "display": "REDUCED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "reduced" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2736 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6900", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2772 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2775 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "76676007", + "display": "EXTRAVASATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2751 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "active" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2751 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2772 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2775 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6901", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "367643001", + "display": "CYST (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID171", + "display": "HEAD OF PANCREAS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2991 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3021 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3023 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "value": 5.0, + "unit": "MILLIMETER" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2991 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3021 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3023 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6902", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3715 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3718 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89977008", + "display": "INCREASED THICKNESS (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89837001", + "display": "URINARY BLADDER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30135", + "display": "WALL OF URINARY BLADDER" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3715 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3718 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6903", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15158005", + "display": "AIR (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89837001", + "display": "URINARY BLADDER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID237", + "display": "URINARY BLADDER" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6904", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362975008", + "display": "DEGENERATIVE DISORDER (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272673000", + "display": "BONE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28569", + "display": "SET OF BONE ORGANS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13197", + "display": "BONE ORGAN" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6905", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43846000", + "display": "SCLEROSIS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272673000", + "display": "BONE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28569", + "display": "SET OF BONE ORGANS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13197", + "display": "BONE ORGAN" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3951 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3962 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "suspicious;;lytic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3951 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3962 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6907", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "267038008", + "display": "EDEMA (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45851105", + "display": "REGION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45851105", + "display": "REGION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4317 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6908", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4347 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "peripheral" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4347 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4359 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4363 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4373 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4378 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4380 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4387 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6909", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4543 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4549 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "large;;central" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4543 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4549 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6910", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "128305008", + "display": "ABNORMALLY OPAQUE STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4732 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "Patchy" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4732 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6911", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "367643001", + "display": "CYST (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID171", + "display": "HEAD OF PANCREAS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4867 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4868 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "value": 5.0, + "unit": "MILLIMETER" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4867 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4868 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6912", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "164836004", + "display": "MUSCULOSKELETAL MOVEMENT (OBSERVABLE ENTITY)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6913", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID223", + "display": "RENAL COLLECTING SYSTEM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2487 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "postprocedural" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2487 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6914", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29663", + "display": "LEFT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2590 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2599 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6915", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "4657009", + "display": "PROMINENT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "28273000", + "display": "BILE DUCT STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID199", + "display": "COMMON BILE DUCT" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2911 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "4657009", + "display": "PROMINENT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2965 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2971 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2975 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "comparator": "<=" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2911 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2930 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2965 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2971 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2975 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6916", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3689 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260376009", + "display": "ENLARGED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41216001", + "display": "PROSTATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID343", + "display": "PROSTATE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3689 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6917", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "397685007", + "display": "FINDING RELATED TO FOCUSING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6921", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281157001", + "display": "SYSTEMIC VASCULAR STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID480", + "display": "AORTA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6922", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29662", + "display": "RIGHT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6923", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23451007", + "display": "ADRENAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "10200004", + "display": "LIVER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "78961009", + "display": "SPLENIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28752", + "display": "SET OF ADRENAL GLANDS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID88", + "display": "ADRENAL GLAND" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID58", + "display": "LIVER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID86", + "display": "SPLEEN" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6924", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID170", + "display": "PANCREAS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6925", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281471001", + "display": "STRUCTURE OF ABDOMINAL BLOOD VESSEL (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "244261004", + "display": "ABDOMINAL VISCERAL ARTERY (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "56400007", + "display": "STRUCTURE OF RENAL VEIN (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281157001", + "display": "SYSTEMIC VASCULAR STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID906", + "display": "CELIAC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID927", + "display": "SUPERIOR MESENTERIC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID939", + "display": "INFERIOR MESENTERIC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID936", + "display": "RENAL ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID49729", + "display": "SET OF RENAL ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID480", + "display": "AORTA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID50393", + "display": "SET OF ABDOMINAL ARTERIES" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "final assessment" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6926", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71854001", + "display": "COLON STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "34402009", + "display": "RECTUM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID162", + "display": "SIGMOID COLON" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID163", + "display": "RECTUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6930", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6933", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6936", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "30746006", + "display": "LYMPHADENOPATHY (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15425007", + "display": "PERITONEUM (SEROUS MEMBRANE) STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID33180", + "display": "MESENTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small;;pathologic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6938", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "30746006", + "display": "LYMPHADENOPATHY (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "47109002", + "display": "STRUCTURE OF LYMPH NODE OF THORAX (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28849", + "display": "AXILLARY LYMPH NODE GROUP" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1517", + "display": "AXILLARY LYMPH NODE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small;;pathologic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6940", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6943", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6946", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6948", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6950", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6952", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "followupCommunication", + "dateTime": [ + "2023-12-21T18:30:00" + ], + "recipient": [ + "doctor" + ], + "wasAcknowledged": true, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4957 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4972 + }, + { + "url": "length", + "valueInteger": 76 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 5066 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 5080 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "RETROPERITONEAL HEMORRHAGE", + "finding": { + "resourceType": "Observation", + "id": "6869", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "RETROPERITONEAL HEMORRHAGE", + "finding": { + "resourceType": "Observation", + "id": "6933", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "PNEUMONIA", + "finding": { + "resourceType": "Observation", + "id": "6948", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "procedureCodes": [ + { + "coding": [ + { + "system": "http://loinc.org", + "code": "44115-4", + "display": "CT ABDOMEN AND PELVIS" + } + ] + } + ], + "imagingProcedures": [ + { + "modality": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "77477000", + "display": "COMPUTERIZED AXIAL TOMOGRAPHY (PROCEDURE)" + } + ] + }, + "anatomy": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "113345001", + "display": "ABDOMINAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "modality": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "77477000", + "display": "COMPUTERIZED AXIAL TOMOGRAPHY (PROCEDURE)" + } + ] + }, + "anatomy": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "12921003", + "display": "PELVIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + } + ], + "orderedProcedure": { + "code": { + "coding": [ + { + "code": "111111" + } + ] + }, + "description": "CT ABD/PELVIS." + }, + "kind": "radiologyProcedure" + } + ] + } + ], + "modelVersion": "2024-01-19-preview" + }, + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12", + "createdDateTime": "2024-01-29T19:50:52Z", + "expirationDateTime": "2024-01-30T19:50:52Z", + "lastUpdateDateTime": "2024-01-29T19:51:12Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulTrialMatcherRequest.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulTrialMatcherRequest.json new file mode 100644 index 000000000000..680e2d698c5a --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulTrialMatcherRequest.json @@ -0,0 +1,2996 @@ +{ + "operationId": "TrialMatcher_CreateJob", + "title": "Creates a Trial Matcher job with the given request body.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "body": { + "patients": [ + { + "id": "Patient ID Example 2", + "info": { + "sex": "female", + "birthDate": "1976-09-10", + "clinicalInfo": [ + { + "resourceType": "Condition", + "code": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0041296", + "display": "Tuberculosis" + } + ] + } + }, + { + "code": { + "coding": [ + { + "code": "C0006826", + "display": "MalignantNeoplasms", + "system": "http://www.nlm.nih.gov/research/umls" + } + ] + }, + "resourceType": "Observation", + "status": "unknown", + "valueBoolean": true + }, + { + "code": { + "coding": [ + { + "code": "C0018802", + "display": "MalignantNeoplasms", + "system": "http://www.nlm.nih.gov/research/umls" + } + ] + }, + "resourceType": "Observation", + "status": "unknown", + "valueBoolean": true + } + ] + } + } + ], + "configuration": { + "verbose": true, + "includeEvidence": true, + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", + "contained": [ + { + "resourceType": "PlanDefinition", + "id": "1b5bc5d5-9413-43f7-9da6-70db2606b7cd", + "name": "Rilpivirine", + "title": "Rilpivirine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Rilpivirine", + "description": "Patients will receive rilpivirine tablet 25 milligram or adjusted dose orally once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "30f45f8a-a0f5-4eed-a5e1-4819137c10b2", + "name": "Zidovudine", + "title": "Zidovudine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Zidovudine", + "description": "Type=exact, form= appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "8958e19c-17db-4152-874d-cf68c3918769", + "name": "Abacavir", + "title": "Abacavir", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Abacavir", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "bef1c7b6-1e1a-4fb4-8bcd-b9d965dd09e6", + "name": "Tenofovir disoproxil fumarate", + "title": "Tenofovir disoproxil fumarate", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Tenofovir disoproxil fumarate", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "ec554338-0167-4034-98dd-ee1cd5860430", + "name": "Lamivudine", + "title": "Lamivudine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Lamivudine", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "8ddc695e-efab-441e-bd49-c1decfdb80bf", + "name": "Emtricitabine", + "title": "Emtricitabine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Emtricitabine", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "Group", + "id": "73e459c6-9b92-479d-b122-0712d18a9131", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0723712", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "220281", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000046327", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "7381", + "display": "therapeutic" + } + ], + "text": "therapeutic" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0086413", + "display": "HIV vaccine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C1325", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "347399", + "display": "HIV vaccine" + }, + { + "system": "http://hl7.org/fhir/sid/cvx", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v2.5", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v3.0", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D016915", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000015914", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "3059-5000", + "display": "HIV vaccine" + }, + { + "system": "http://loinc.org", + "code": "LP183501-8", + "display": "HIV vaccine" + } + ], + "text": "HIV vaccine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "127161fc-b30f-4efc-ae14-2d064dc6084b", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#73e459c6-9b92-479d-b122-0712d18a9131", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationClass" + } + ], + "text": "HIV drug", + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "somecode", + "display": "somecode" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "c26ff014-3da3-419b-9338-6e4b4d49031e", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D019829", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00238", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000712787", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "99DK7FVK1H", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "99DK7FVK1H", + "display": "nevirapine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4020991", + "display": "nevirapine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C29277", + "display": "nevirapine" + }, + { + "system": "http://snomed.info/sctv", + "code": "108704001", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "75157", + "display": "nevirapine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG01", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "006062", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "eiK..", + "display": "nevirapine" + }, + { + "system": "http://loinc.org", + "code": "LP21317-0", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "175112", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2010013984", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000016392", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2030", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "4007-0088", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "53654", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m56485", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000656", + "display": "nevirapine" + } + ], + "text": "nevirapine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0043474", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040121", + "display": "zidovudine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C947", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015215", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2109-4800", + "display": "zidovudine" + }, + { + "system": "http://snomed.info/sctv", + "code": "387151007", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "05223", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "41905", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00495", + "display": "zidovudine" + }, + { + "system": "http://snomed.info/sct", + "code": "C-55B60", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "ei5..", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000013273", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044478", + "display": "zidovudine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4019502", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "11413", + "display": "zidovudine" + }, + { + "system": "http://loinc.org", + "code": "LP16744-2", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0602670", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m89510", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "4B9XT59T7S", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2650", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C947", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "4B9XT59T7S", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00034", + "display": "zidovudine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AF01", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000671", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "003019", + "display": "zidovudine" + } + ], + "text": "zidovudine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "9ab418f5-9bf1-4bb7-a55f-0eed1244addb", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#c26ff014-3da3-419b-9338-6e4b4d49031e", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0282474", + "display": "mother-to-child transmission" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D018445", + "display": "mother-to-child transmission" + } + ], + "text": "mother-to-child transmission" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "c31f130b-c0e7-411a-a32b-57f07ea62559", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#127161fc-b30f-4efc-ae14-2d064dc6084b", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#9ab418f5-9bf1-4bb7-a55f-0eed1244addb", + "type": "Group" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "1d943af4-3b3e-4363-9e82-bc0e59b8c3e1", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D019829", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00238", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000712787", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "99DK7FVK1H", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "99DK7FVK1H", + "display": "NVP" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4020991", + "display": "NVP" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C29277", + "display": "NVP" + }, + { + "system": "http://snomed.info/sctv", + "code": "108704001", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "75157", + "display": "NVP" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG01", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "006062", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "eiK..", + "display": "NVP" + }, + { + "system": "http://loinc.org", + "code": "LP21317-0", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "175112", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2010013984", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000016392", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2030", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "4007-0088", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "53654", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m56485", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000656", + "display": "NVP" + } + ], + "text": "NVP" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0043474", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040121", + "display": "AZT" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C947", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015215", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2109-4800", + "display": "AZT" + }, + { + "system": "http://snomed.info/sctv", + "code": "387151007", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "05223", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "41905", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00495", + "display": "AZT" + }, + { + "system": "http://snomed.info/sct", + "code": "C-55B60", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "ei5..", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000013273", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044478", + "display": "AZT" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4019502", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "11413", + "display": "AZT" + }, + { + "system": "http://loinc.org", + "code": "LP16744-2", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0602670", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m89510", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "4B9XT59T7S", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2650", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C947", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "4B9XT59T7S", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00034", + "display": "AZT" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AF01", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000671", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "003019", + "display": "AZT" + } + ], + "text": "AZT" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "8eddc9da-cdfc-43d9-a9fc-5306d66362f3", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#1d943af4-3b3e-4363-9e82-bc0e59b8c3e1", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0282474", + "display": "mother-to-child transmission" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D018445", + "display": "mother-to-child transmission" + } + ], + "text": "mother-to-child transmission" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "4ee79ae8-bf19-4474-a72e-3616ac0a9fdf", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationClass" + } + ], + "text": "ARVs" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#8eddc9da-cdfc-43d9-a9fc-5306d66362f3", + "type": "Group" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "583a9867-c95e-4225-bd19-47c324e26c0f", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ExaminationName" + } + ], + "text": "Plasma viral load" + }, + "valueQuantity": { + "value": 100000, + "comparator": ">" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "35d36257-564c-48e0-9c65-b2551870b0bb", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "with NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D005838", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "20920", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000005452", + "display": "genotypic" + }, + { + "system": "http://loinc.org", + "code": "LP345004-8", + "display": "genotypic" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C16631", + "display": "genotypic" + }, + { + "system": "http://snomed.info/sctv", + "code": "145681002", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000660739", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000002877", + "display": "genotypic" + }, + { + "system": "http://snomed.info/sct", + "code": "F-E0280", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1258-5784", + "display": "genotypic" + } + ], + "text": "genotypic" + }, + "valueCodeableConcept": { + "text": "value:" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "text": "non-nucleoside reverse transcriptase inhibitor resistance" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "bdcbe31b-c0f7-4205-9b75-34a8418cfdb2", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0041296", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "41", + "display": "tuberculosis" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31051", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000012630", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sctv", + "code": "56717001", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A1...", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D014376", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "INFECT", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000513048", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU076452", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021870", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "0923", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-14800", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "A15-A19", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00198", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/dxp", + "code": "U004166", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://loinc.org", + "code": "LA10513-2", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85138408", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sct", + "code": "D-0188", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch", + "code": "U004809", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "A70012", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "A15-A19.9", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "A15-A19.9", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccs", + "code": "1", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccs_10", + "code": "1", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0368-2498", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004838", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "010-018.99", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "A70", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "754", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1018255", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "54410", + "display": "tuberculosis" + } + ], + "text": "tuberculosis" + }, + "valueCodeableConcept": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ConditionQualifier" + } + ], + "text": "active" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "text": "treated for tuberculosis" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "2a43edc4-0000-0000-0000-000000000000", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "text": "human immuno deficiency virus infection" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ExaminationName" + } + ], + "text": "HIV-1 plasma viral load" + }, + "valueQuantity": { + "value": 500, + "unit": "HIV-1" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#c31f130b-c0e7-411a-a32b-57f07ea62559", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#4ee79ae8-bf19-4474-a72e-3616ac0a9fdf", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#583a9867-c95e-4225-bd19-47c324e26c0f", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#35d36257-564c-48e0-9c65-b2551870b0bb", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "text": "disallowed concomitant therapy" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0001175", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "B20", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ram", + "code": "DX272", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/qmr", + "code": "R0121441", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A788z", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://snomed.info/sctv", + "code": "186715004", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "1684", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000000649", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc", + "code": "B90", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10000563", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31779", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "00595", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000163", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000023174", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "HIV SYND", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B90001", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "B90", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "1", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00716", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-36310", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "1233", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU080583", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044365", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-6271", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "042", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "023", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://loinc.org", + "code": "LA10430-9", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1014998", + "display": "Acquired Immunodeficiency Syndrome" + } + ], + "text": "Acquired Immunodeficiency Syndrome" + }, + "valueCodeableConcept": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ConditionQualifier" + } + ], + "text": "currently active" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#bdcbe31b-c0f7-4205-9b75-34a8418cfdb2", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "coding": [ + { + "system": "http://loinc.org", + "code": "63900-5", + "display": "age" + } + ], + "text": "age" + }, + "valueRange": { + "low": { + "value": 6, + "unit": "years", + "system": "http://unitsofmeasure.org", + "code": "a" + }, + "high": { + "value": 17, + "unit": "years", + "system": "http://unitsofmeasure.org", + "code": "a" + } + }, + "exclude": false + } + ] + } + ], + "identifier": [ + { + "use": "official", + "value": "CR002677", + "assigner": { + "display": "Janssen Sciences Ireland UC" + } + }, + { + "use": "usual", + "value": "NCTtesttest", + "assigner": { + "display": "ClinicalTrials.gov" + } + }, + { + "use": "secondary", + "value": "TMC278-TiDP38-C213" + }, + { + "use": "secondary", + "value": "2008-001696-30" + } + ], + "title": "A Study to Evaluate the Pharmacokinetics, Safety, Tolerability, and Antiviral Efficacy of Rilpivirine (TMC278) in Human Immunodeficiency Virus Infected Adolescents and Children Aged Greater Than or Equal to 6 Years", + "protocol": [ + { + "reference": "#1b5bc5d5-9413-43f7-9da6-70db2606b7cd", + "type": "PlanDefinition", + "display": "Rilpivirine" + }, + { + "reference": "#30f45f8a-a0f5-4eed-a5e1-4819137c10b2", + "type": "PlanDefinition", + "display": "Zidovudine" + }, + { + "reference": "#8958e19c-17db-4152-874d-cf68c3918769", + "type": "PlanDefinition", + "display": "Abacavir" + }, + { + "reference": "#bef1c7b6-1e1a-4fb4-8bcd-b9d965dd09e6", + "type": "PlanDefinition", + "display": "Tenofovir disoproxil fumarate" + }, + { + "reference": "#ec554338-0167-4034-98dd-ee1cd5860430", + "type": "PlanDefinition", + "display": "Lamivudine" + }, + { + "reference": "#8ddc695e-efab-441e-bd49-c1decfdb80bf", + "type": "PlanDefinition", + "display": "Emtricitabine" + } + ], + "status": "active", + "primaryPurposeType": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type", + "version": "4.0.0", + "code": "treatment", + "display": "Treatment" + } + ], + "text": "Treatment" + }, + "phase": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-phase", + "version": "4.0.0", + "code": "phase-2", + "display": "Phase 2" + } + ], + "text": "Phase 2" + }, + "category": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type", + "version": "4.0.0", + "code": "treatment", + "display": "Treatment" + } + ], + "text": "Treatment" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "Interventional", + "display": "Interventional" + } + ], + "text": "Interventional" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "Single Group Assignment", + "display": "Single Group Assignment" + } + ], + "text": "Single Group Assignment" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "None (Open Label)", + "display": "None (Open Label)" + } + ], + "text": "None (Open Label)" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "NoneRetained", + "display": "NoneRetained" + } + ], + "text": "NoneRetained" + } + ], + "focus": [ + { + "text": "Drug" + } + ], + "condition": [ + { + "text": "Human Immuno Deficiency (HIV) Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0021051", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sctv", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "39922", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000045724", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "D-4600", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-5885", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021460", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006602", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3131", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hpo", + "code": "HP:0002721", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/omim", + "code": "MTHU032911", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B99011", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "2156", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007153", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C39725", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "279.3", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X20GZ", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "F-C0450", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "U000355", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://loinc.org", + "code": "MTHU054768", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nanda-i", + "code": "02515", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85064574", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1007151", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU037620", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004832", + "display": "Immunologic Deficiency Syndromes" + } + ], + "text": "Immunologic Deficiency Syndromes" + } + ], + "contact": [ + { + "name": "Use link at the bottom of the page to see if you qualify for an enrolling site (see list). If you still have questions:", + "telecom": [ + { + "system": "email", + "value": "JNJ.CT@sylogent.com", + "use": "work" + } + ] + }, + { + "name": "StudyDirector Janssen Sciences Ireland UC Clinical Trial" + } + ], + "keyword": [ + { + "text": "HIV Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0599685", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D044966", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "250564", + "display": "Antiretroviral" + }, + { + "system": "http://snomed.info/sctv", + "code": "713540004", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0715-4905", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2003006231", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000042059", + "display": "Antiretroviral" + } + ], + "text": "Antiretroviral" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0019704", + "display": "HIV-1" + }, + { + "system": "http://snomed.info/sctv", + "code": "243598007", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cdisc", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X73kd", + "display": "HIV-1" + }, + { + "system": "http://loinc.org", + "code": "MTHU009425", + "display": "HIV-1" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://snomed.info/sct", + "code": "L-35211", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10020455", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "3130-7357", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015497", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ncbi", + "code": "11676", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006190", + "display": "HIV-1" + } + ], + "text": "HIV-1" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0001175", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "B20", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ram", + "code": "DX272", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/qmr", + "code": "R0121441", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A788z", + "display": "AIDS" + }, + { + "system": "http://snomed.info/sctv", + "code": "186715004", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "1684", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000000649", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc", + "code": "B90", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10000563", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31779", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "00595", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000163", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000023174", + "display": "AIDS" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "HIV SYND", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B90001", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "B90", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "1", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00716", + "display": "AIDS" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-36310", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "1233", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU080583", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044365", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-6271", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "042", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "023", + "display": "AIDS" + }, + { + "system": "http://loinc.org", + "code": "LA10430-9", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1014998", + "display": "AIDS" + } + ], + "text": "AIDS" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0008059", + "display": "Children" + }, + { + "system": "http://snomed.info/sct", + "code": "S-10170", + "display": "Children" + }, + { + "system": "http://snomed.info/sctv", + "code": "67822003", + "display": "Children" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C16423", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85023418", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000007008", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D002648", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000002765", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "0060058", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0635-1343", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch", + "code": "U005340", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v3.0", + "code": "CHD", + "display": "Children" + }, + { + "system": "http://loinc.org", + "code": "LA9949-4", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C16423", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/dxp", + "code": "U000730", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "C16423", + "display": "Children" + } + ], + "text": "Children" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C1566826", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "309423", + "display": "Rilpivirine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG05", + "display": "Rilpivirine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C76929", + "display": "Rilpivirine" + }, + { + "system": "http://snomed.info/sctv", + "code": "703777002", + "display": "Rilpivirine" + }, + { + "system": "http://loinc.org", + "code": "MTHU042155", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB08864", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d07776", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "FI96A8X663", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "FI96A8X663", + "display": "Rilpivirine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4030730", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "1102270", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "4688", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m7163", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000068696", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU002683", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "013795", + "display": "Rilpivirine" + } + ], + "text": "Rilpivirine (TMC278)" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C1521725", + "display": "Pediatric" + }, + { + "system": "http://loinc.org", + "code": "LP100615-6", + "display": "Pediatric" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C39299", + "display": "Pediatric" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000046245", + "display": "Pediatric" + } + ], + "text": "Pediatric" + }, + { + "text": "Human Immuno Deficiency (HIV) Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0021051", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sctv", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "39922", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000045724", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "D-4600", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-5885", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021460", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006602", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3131", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hpo", + "code": "HP:0002721", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/omim", + "code": "MTHU032911", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B99011", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "2156", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007153", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C39725", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "279.3", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X20GZ", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "F-C0450", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "U000355", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://loinc.org", + "code": "MTHU054768", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nanda-i", + "code": "02515", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85064574", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1007151", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU037620", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004832", + "display": "Immunologic Deficiency Syndromes" + } + ], + "text": "Immunologic Deficiency Syndromes" + }, + { + "coding": [ + { + "system": "http://hl7.org/fhir/administrative-gender", + "code": "Unknown", + "display": "Unknown" + } + ], + "text": "Unknown" + }, + { + "coding": [ + { + "system": "http://decades-value-set.ctm.microsoft.org", + "code": "0", + "display": "Age keyword for indexing - 0" + } + ], + "text": "Age keyword for indexing - 0" + }, + { + "coding": [ + { + "system": "http://decades-value-set.ctm.microsoft.org", + "code": "10", + "display": "Age keyword for indexing - 10" + } + ], + "text": "Age keyword for indexing - 10" + } + ], + "description": "This is a Phase II, open-label (all people involved know the identity of the assigned drug)\r\n and single arm study. The study will consist of a screening period of maximum 8 weeks, an\r\n initial treatment period of 48 weeks, a post week 48 treatment extension period of 4 years,\r\n and a 4 week follow-up period. A follow-up period will take place regardless of the presence\r\n of serious adverse events (SAEs) if patients withdraw early (ie, before Week 48) or if\r\n patients do not participate in the extension after Week 48; after Week 48, a 4-week follow-up\r\n visit is only required in case of ongoing (S)AEs at the final on treatment visit. The initial\r\n 48-week treatment period will be structured into 2 age Cohorts; Cohort 1 (Aged greater than\r\n or equal to [>=] 12 to less than [<] 18 years) and Cohort 2 (Children Aged >= 6 to < 12\r\n years) and each Cohort will have 2 parts. The first part of the trial (Part 1) is designed to\r\n evaluate the steady-state pharmacokinetic (PK) profile and the short-term safety and\r\n antiviral activity of rilpivirine 25 mg or adjusted dose once daily when administered in\r\n combination with 2 NRTIs. At Week 2/4, intensive PK will be done and an analysis together\r\n with short-term safety and antiviral activity will be reviewed by a data monitoring committee\r\n (DMC). For adolescents (Cohort 1) if the mean steady-state exposure in this first group of\r\n patients is comparable to that of the adult population (ie, is within 80-125 percentage of\r\n the mean exposure of the 25 mg once daily dose group in study, TMC278-C204), and the Week 2/4\r\n safety and antiviral activity results have been reviewed and deemed satisfactory by the DMC,\r\n the second part of the trial will start. The second part of the trial will evaluate long-term\r\n (48 weeks and 240 weeks) safety, efficacy, and pharmacokinetics of rilpivirine in combination\r\n with the background regimen of 2 NRTIs with a primary analysis time point at 24 weeks. For\r\n patients aged greater than or equal to (>=) 6 to less than (<) 12 years (Cohort 2), after\r\n being treated for at least 4 weeks and the Week 2 intensive PK and Week 4 safety and\r\n antiviral activity have been reviewed and results are satisfactory, recruitment in Part 1\r\n will resume and additional subjects will be enrolled to have at least 10 subjects in Part 1.\r\n Once an appropriate RPV dose has been selected, Part 1 of Cohort 2 will be considered\r\n complete and Part 2 will start. All patients from Part 1 will roll over in Part 2 and\r\n additional patients will be recruited in Part 2 to have at least 25 subjects (including those\r\n from Part 1) overall. In both cohorts of the trial, the ART will consist of rilpivirine 25 mg\r\n or adjusted dose once daily and an investigator-selected background regimen containing 2\r\n NRTIs. Patients safety will be monitored throughout the study and during the follow up\r\n visits.", + "enrollment": [ + { + "reference": "#2a43edc4-0000-0000-0000-000000000000", + "type": "Group" + } + ], + "period": { + "start": "2011-01", + "end": "2027-08" + }, + "arm": [ + { + "name": "Rilpivirine (TMC278)", + "type": { + "text": "Experimental" + }, + "description": "The patients will receive rilpivirine with 2 nucleoside/nucleotide reverse transcriptase inhibitors (NRTIs) as a background regimen in Cohort 1 [Aged greater than or equal to (> =) 12 to less than (<) 18 years] and Cohort 2 (children aged > = 6 to < 12 years). The NRTIs includes zidovudine, abacavir, or tenofovir disoproxil fumarate in combination with lamivudine or emtricitabine." + } + ] + } + ], + "registryFilters": [ + { + "studyTypes": [ + "interventional", + "observational" + ], + "recruitmentStatuses": [ + "recruiting", + "enrollingByInvitation" + ], + "phases": [ + "phase2", + "phase3" + ], + "purposes": [ + "diagnostic", + "prevention", + "basicScience" + ], + "sources": [ + "clinicaltrials.gov" + ], + "facilityLocations": [ + { + "city": "Basel", + "countryOrRegion": "Switzerland" + }, + { + "city": "Allschwil", + "countryOrRegion": "Switzerland" + } + ] + }, + { + "sponsors": [ + "Janssen" + ], + "sources": [ + "clinicaltrials.gov" + ], + "facilityAreas": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 7.588576, + 47.559601 + ] + }, + "properties": { + "subType": "Circle", + "radius": 80000 + } + } + ] + }, + { + "ids": [ + "NCT04006015", + "NCT04545788", + "NCT04773711" + ], + "sources": [ + "clinicaltrials.gov" + ] + } + ] + } + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version=2023-09-01-preview", + "Retry-After": "1" + }, + "body": { + "status": "notStarted", + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754" + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulTrialMatcherResponse.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulTrialMatcherResponse.json new file mode 100644 index 000000000000..eda21af93fa1 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2023-09-01-preview/SuccessfulTrialMatcherResponse.json @@ -0,0 +1,113 @@ +{ + "operationId": "TrialMatcher_GetJob", + "title": "Gets the status and details of the Trial Matcher job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754" + }, + "responses": { + "200": { + "body": { + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754", + "createdDateTime": "2021-11-28T09:13:11.046Z", + "expirationDateTime": "2021-11-28T09:13:11.046Z", + "lastUpdateDateTime": "2021-11-28T09:13:11.046Z", + "status": "succeeded", + "result": { + "patientResults": [ + { + "patientId": "Patient ID Example 2", + "inferences": [ + { + "type": "trialEligibility", + "value": "Eligible", + "description": "SwEaTB - Diagnosing of Acute Tuberculosis", + "confidenceScore": 1, + "evidence": [ + { + "eligibilityCriteriaEvidence": "In-patients with acute tuberculosis", + "patientInfoEvidence": { + "system": "UMLS", + "code": "C0019046", + "name": "tuberculosis" + }, + "importance": 1 + } + ], + "clinicalTrialId": "NCT03667742", + "source": "clinicaltrials.gov", + "metadata": { + "phases": [ + "phase3" + ], + "studyType": "observational", + "recruitmentStatus": "recruiting", + "conditions": [ + "Tuberculosis" + ], + "sponsors": [ + "University Hospital, Basel, Switzerland" + ], + "contacts": [ + { + "name": "John Doe, PD Dr. Med", + "email": "John@contoso.com", + "phone": "+55-555-5555-55" + } + ], + "facilities": [ + { + "name": "University Hospital, Basel", + "city": "Basel", + "countryOrRegion": "Switzerland" + } + ] + } + }, + { + "type": "trialEligibility", + "value": "Ineligible", + "description": "Design of an Integrative Algorithm for Staging Tuberculosis (STAGE-TB)", + "confidenceScore": 1, + "evidence": [ + { + "eligibilityCriteriaEvidence": "negative for Quantiferon- TB Gold Plus Test or ELISpot", + "patientInfoEvidence": { + "system": "UMLS", + "code": "C0920508", + "name": "Enzyme-Linked Immunospot Assay", + "value": "30,000 PBMC cells per 10ul" + }, + "importance": 1 + } + ], + "clinicalTrialId": "NCT03691883", + "source": "clinicaltrials.gov" + } + ], + "neededClinicalInfo": [ + { + "system": "UMLS", + "code": "C4317078", + "name": "Mycobacterium Tuberculosis Measurement ", + "semanticType": "Laboratory Procedure", + "category": "EXAMINATION_NAME" + }, + { + "system": "UMLS", + "code": "C0008031", + "name": "Chest Pain", + "semanticType": "Sign or Symptom", + "category": "SYMPTOM_OR_SIGN" + } + ] + } + ], + "modelVersion": "2021-10-28", + "knowledgeGraphLastUpdateDate": "2021-11-26" + } + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/main.tsp b/specification/ai/HealthInsights/HealthInsights.OpenAPI/main.tsp index aa9c8633de0a..72910e1430cb 100644 --- a/specification/ai/HealthInsights/HealthInsights.OpenAPI/main.tsp +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/main.tsp @@ -1,7 +1,11 @@ import "../HealthInsights.TrialMatcher/route.trialmatcher.tsp"; import "../HealthInsights.OncoPhenotype/route.oncophenotype.tsp"; - +import "../HealthInsights.RadiologyInsights/route.radiologyinsights.tsp"; +import "../HealthInsights.PatientTimeline/route.patienttimeline.tsp"; import "@typespec/rest"; import "@typespec/http"; -import "@typespec/versioning"; import "./service.tsp"; + +// FIXME: This is a workaround. Tracking issue: https://github.com/microsoft/typespec/issues/2826 +alias _ForceOrderOfReslutionExtension_ = Fhir.R4.Extension; +alias _ForceOrderOfReslutionCodeableConcept_ = Fhir.R4.CodeableConcept; diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp b/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp index eca08aa8c346..9edabd705905 100644 --- a/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp @@ -4,13 +4,13 @@ using TypeSpec.Http; using TypeSpec.Versioning; @service({ - title: "Azure Health Insights", + title: "Azure AI Health Insights", }) @versioned(ApiVersion) -@doc("Azure Health Insights provides an API that serves insight models, specific for Health & Life Sciences, that perform analysis and provide inferences to be used by a human.") +@doc("Azure AI Health Insights provides an API that serves insight models, specific for Health & Life Sciences, that perform analysis and provide inferences to be used by a human.") @server( - "{endpoint}/healthinsights", - "Azure Health Insights provides an API that serves insight models, specific for Health & Life Sciences, that perform analysis and provide inferences to be used by a human.", + "{endpoint}/health-insights", + "Azure AI Health Insights provides an API that serves insight models, specific for Health & Life Sciences, that perform analysis and provide inferences to be used by a human.", { @doc("Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).") endpoint: url, @@ -21,6 +21,6 @@ namespace AzureHealthInsights; #suppress "@azure-tools/typespec-azure-core/documentation-required" "https://github.com/Azure/typespec-azure/issues/3107" enum ApiVersion { - @useDependency(Azure.Core.Versions.v1_0_Preview_1) - v2023_03_01_preview: "2023-03-01-preview", + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2023_09_01_Preview: "2023-09-01-preview", } diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/tspconfig.yaml b/specification/ai/HealthInsights/HealthInsights.OpenAPI/tspconfig.yaml index f3a0b6a11722..930eac15de0e 100644 --- a/specification/ai/HealthInsights/HealthInsights.OpenAPI/tspconfig.yaml +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/tspconfig.yaml @@ -1,12 +1,17 @@ -emit: [ - "@azure-tools/typespec-autorest", -] +parameters: + "service-dir": + default: "sdk/healthinsights" + "service-name": + default: "HealthInsights" +emit: + - "@azure-tools/typespec-autorest" linter: extends: - "@azure-tools/typespec-azure-core/all" options: "@azure-tools/typespec-autorest": - 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" + azure-resource-provider-folder: "data-plane" + emitter-output-dir: "{project-root}/../.." + examples-directory: examples + omit-unreachable-types: true + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" diff --git a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/client.tsp b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/client.tsp new file mode 100644 index 000000000000..2ebbdadee4dd --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/client.tsp @@ -0,0 +1,88 @@ +import "@azure-tools/typespec-client-generator-core"; +import "./route.patienttimeline.tsp"; + +import "@typespec/rest"; +import "@typespec/http"; +import "../HealthInsights.OpenAPI/service.tsp"; + +using Azure.ClientGenerator.Core; + +@TypeSpec.Versioning.useDependency( + AzureHealthInsights.ApiVersion.v2023_09_01_Preview +) +namespace ClientForAzureHealthInsights; + +@client({ + name: "PatientTimelineClient", + service: AzureHealthInsights, +}) +interface PatientTimelineClient { + #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "https://github.com/microsoft/typespec/issues/2037" + inferPatientTimeline is AzureHealthInsights.PatientTimeline.createJob; +} + +@@projectedName(Fhir.R4.Extension, "java", "Fhir_R4_Extension"); +@@projectedName(Fhir.R4.Extension, "csharp", "Fhir_R4_Extension"); +@@projectedName(Fhir.R4.Extendible, "java", "Fhir_R4_Extendible"); +@@projectedName(Fhir.R4.Extendible, "csharp", "Fhir_R4_Extendible"); +@@projectedName(Fhir.R4.Element, "java", "Fhir_R4_Element"); +@@projectedName(Fhir.R4.Element, "csharp", "Fhir_R4_Element"); +@@projectedName(Fhir.R4.Coding, "java", "Fhir_R4_Coding"); +@@projectedName(Fhir.R4.Coding, "csharp", "Fhir_R4_Coding"); +@@projectedName(Fhir.R4.CodeableConcept, "java", "Fhir_R4_CodeableConcept"); +@@projectedName(Fhir.R4.CodeableConcept, "csharp", "Fhir_R4_CodeableConcept"); +@@projectedName(Fhir.R4.Meta, "java", "Fhir_R4_Meta"); +@@projectedName(Fhir.R4.Meta, "csharp", "Fhir_R4_Meta"); +@@projectedName(Fhir.R4.Narrative, "java", "Fhir_R4_Narrative"); +@@projectedName(Fhir.R4.Narrative, "csharp", "Fhir_R4_Narrative"); +@@projectedName(Fhir.R4.Reference, "java", "Fhir_R4_Reference"); +@@projectedName(Fhir.R4.Reference, "csharp", "Fhir_R4_Reference"); +@@projectedName(Fhir.R4.Identifier, "java", "Fhir_R4_Identifier"); +@@projectedName(Fhir.R4.Identifier, "csharp", "Fhir_R4_Identifier"); +@@projectedName(Fhir.R4.Period, "java", "Fhir_R4_Period"); +@@projectedName(Fhir.R4.Period, "csharp", "Fhir_R4_Period"); +@@projectedName(Fhir.R4.Quantity, "java", "Fhir_R4_Quantity"); +@@projectedName(Fhir.R4.Quantity, "csharp", "Fhir_R4_Quantity"); +@@projectedName(Fhir.R4.Range, "java", "Fhir_R4_Range"); +@@projectedName(Fhir.R4.Range, "csharp", "Fhir_R4_Range"); +@@projectedName(Fhir.R4.Ratio, "java", "Fhir_R4_Ratio"); +@@projectedName(Fhir.R4.Ratio, "csharp", "Fhir_R4_Ratio"); +@@projectedName(Fhir.R4.Annotation, "java", "Fhir_R4_Annotation"); +@@projectedName(Fhir.R4.Annotation, "csharp", "Fhir_R4_Annotation"); +@@projectedName(Fhir.R4.SampledData, "java", "Fhir_R4_SampledData"); +@@projectedName(Fhir.R4.SampledData, "csharp", "Fhir_R4_SampledData"); +@@projectedName(Fhir.R4.ContactDetail, "java", "Fhir_R4_ContactDetail"); +@@projectedName(Fhir.R4.ContactDetail, "csharp", "Fhir_R4_ContactDetail"); +@@projectedName(Fhir.R4.ContactPoint, "java", "Fhir_R4_ContactPoint"); +@@projectedName(Fhir.R4.ContactPoint, "csharp", "Fhir_R4_ContactPoint"); +@@projectedName(Fhir.R4.Resource, "java", "Fhir_R4_Resource"); +@@projectedName(Fhir.R4.Resource, "csharp", "Fhir_R4_Resource"); +@@projectedName(Fhir.R4.DomainResource, "java", "Fhir_R4_DomainResource"); +@@projectedName(Fhir.R4.DomainResource, "csharp", "Fhir_R4_DomainResource"); +@@projectedName(Fhir.R4.Condition, "java", "Fhir_R4_Condition"); +@@projectedName(Fhir.R4.Condition, "csharp", "Fhir_R4_Condition"); +@@projectedName(Fhir.R4.ConditionStage, "java", "Fhir_R4_ConditionStage"); +@@projectedName(Fhir.R4.ConditionStage, "csharp", "Fhir_R4_ConditionStage"); +@@projectedName(Fhir.R4.Observation, "java", "Fhir_R4_Observation"); +@@projectedName(Fhir.R4.Observation, "csharp", "Fhir_R4_Observation"); +@@projectedName(Fhir.R4.ObservationReferenceRange, + "java", + "Fhir_R4_ObservationReferenceRange" +); +@@projectedName(Fhir.R4.ObservationReferenceRange, + "csharp", + "Fhir_R4_ObservationReferenceRange" +); +@@projectedName(Fhir.R4.ObservationComponent, + "java", + "Fhir_R4_ObservationComponent" +); +@@projectedName(Fhir.R4.ObservationComponent, + "csharp", + "Fhir_R4_ObservationComponent" +); +@@projectedName(Fhir.R4.ResearchStudy, "java", "Fhir_R4_ResearchStudy"); +@@projectedName(Fhir.R4.ResearchStudy, "csharp", "Fhir_R4_ResearchStudy"); +@@projectedName(AzureHealthInsights.PatientInfoSex, "client", "PatientSex"); +@@projectedName(AzureHealthInsights.PatientInfo, "client", "PatientDetails"); diff --git a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp new file mode 100644 index 000000000000..962fee222946 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp @@ -0,0 +1,71 @@ +import "../HealthInsights.Common/model.common.request.tsp"; +import "../HealthInsights.Common/model.common.response.tsp"; +import "../HealthInsights.Common/model.common.shared.tsp"; +import "../HealthInsights.Common/model.common.fhir.elements.tsp"; +import "../HealthInsights.Common/model.common.fhir.resources.tsp"; + +using TypeSpec.Rest; + +namespace AzureHealthInsights; + +@doc("The body of the Patient Timeline request.") +model PatientTimelineData { + ...Request; + + @doc("Configuration affecting the Patient Timeline model's inference.") + configuration?: PatientTimelineModelConfiguration; +} + +@doc("Configuration affecting the Patient Timeline model's inference.") +model PatientTimelineModelConfiguration { + ...ModelConfiguration; +} + +@resource("patient-timeline/jobs") +@doc("The response for the Patient Timeline request.") +model PatientTimelineResult + is HealthInsightsOperationStatus; + +@doc("The inference results for the Patient Timeline request.") +model PatientTimelineInferenceResult { + @doc("Results for the patients given in the request.") + patientResults: PatientTimelinePatientResult[]; + + @doc("The version of the model used for inference, expressed as the model date.") + modelVersion: ModelVersion; +} + +@doc("The results of the model's work for a single patient.") +model PatientTimelinePatientResult { + @doc("The identifier given for the patient in the request.") + patientId: string; + + @doc("The model's inferences for the given patient.") + inferences: Array; +} + +@doc("An inference made by the Patient Timeline model regarding a patient.") +model PatientTimelineInference is Fhir.R4.Extendible { + @doc("The type of the Patient Timeline inference.") + type: PatientTimelineInferenceType; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" + @doc(""" + FHIR 4.0 representation of the piece of clinical info. + additional dependent resources maybe contained (e.g. MedicationStatement may contain Medication) + -- In the SDK we will have custom mapping to map this type to JsonObject + """) + resource?: Fhir.R4.DomainResource; + + @doc("Time range relevant to this Timeline inference.") + period?: TimePeriod; +} + +@doc("The type of the Patient Timeline inference.") +enum PatientTimelineInferenceType { + @doc("The inference is a timeline event.") + TimelineEvent: "timelineEvent", + + @doc("The inference is a summary item.") + SummaryItem: "summaryItem", +} diff --git a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp new file mode 100644 index 000000000000..16b536ce4bf3 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp @@ -0,0 +1,35 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "@typespec/http"; + +import "./model.patienttimeline.tsp"; +import "../HealthInsights.Common/primitives.tsp"; + +using Azure.Core; +using TypeSpec.Rest; +using TypeSpec.Http; + +namespace AzureHealthInsights; + +interface PatientTimeline { + #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Service uses a jobId in the path" + @summary("Get Patient Timeline job details") + @tag("PatientTimeline") + @doc("Gets the status and details of the Patient Timeline job.") + @get + @route("/patient-timeline/jobs/{id}") + getJob is HealthInsightsLongRunningPollOperation; + + #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" + @summary("Create Patient Timeline job") + @tag("PatientTimeline") + @doc("Creates a Patient Timeline job with the given request body.") + @pollingOperation(PatientTimeline.getJob) + @route("/patient-timeline/jobs") + createJob is HealthInsightsLongRunningRpcOperation< + PatientTimelineData, + PatientTimelineResult, + PatientTimelineInferenceResult + >; +} diff --git a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/tspconfig.yaml b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/tspconfig.yaml new file mode 100644 index 000000000000..4df8413434f6 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/tspconfig.yaml @@ -0,0 +1,51 @@ +parameters: + "service-dir": + default: "sdk/healthinsights" + "service-name": + default: "HealthInsights" + "dependencies": + "additionalDirectories": + - "specification/ai/HealthInsights/HealthInsights.Common/" + - "specification/ai/HealthInsights/HealthInsights.OpenAPI/" + default: "" + "python-sdk-folder": + default: "{project-root}/azure-sdk-for-python/" + "java-sdk-folder": + default: "{project-root}/azure-sdk-for-java/" + "js-sdk-folder": + default: "{project-root}/azure-sdk-for-js/" + "csharp-sdk-folder": + default: "{project-root}/azure-sdk-for-net/" + "service-directory-name": + default: "healthinsights" +emit: + - "@azure-tools/typespec-autorest" +linter: + extends: + - "@azure-tools/typespec-azure-core/all" +options: + "@azure-tools/typespec-python": + package-pprint-name: '"Azure Health Insights - Patient Timeline"' + package-mode: "dataplane" + package-version: 1.0.0b1 + package-dir: "azure-healthinsights-patienttimeline" + package-name: "{package-dir}" + emitter-output-dir: "{python-sdk-folder}/sdk/{service-directory-name}/{package-name}" + "@azure-tools/typespec-java": + package-dir: "azure-health-insights-patienttimeline" + namespace: com.azure.health.insights.patienttimeline + partial-update: true + emitter-output-dir: "{java-sdk-folder}/sdk/{service-directory-name}/azure-health-insights-patienttimeline" + "@azure-tools/typespec-csharp": + save-inputs: false + clear-output-folder: true + package-dir: "Azure.Health.Insights.PatientTimeline" + namespace: "{package-dir}" + model-namespace: false + "@azure-tools/typespec-ts": + package-dir: "azurehealthinsightspatienttimeline-rest" + emitter-output-dir: "{js-sdk-folder}/sdk/{service-directory-name}/health-insights-patienttimeline-rest" + generateMetadata: true + generateTest: true + packageDetails: + name: "@azure-rest/health-insights-patienttimeline" diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/client.tsp b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/client.tsp new file mode 100644 index 000000000000..d19844386f4a --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/client.tsp @@ -0,0 +1,88 @@ +import "@azure-tools/typespec-client-generator-core"; +import "./route.radiologyinsights.tsp"; + +import "@typespec/rest"; +import "@typespec/http"; +import "../HealthInsights.OpenAPI/service.tsp"; + +using Azure.ClientGenerator.Core; + +@TypeSpec.Versioning.useDependency( + AzureHealthInsights.ApiVersion.v2023_09_01_Preview +) +namespace ClientForAzureHealthInsights; + +@client({ + name: "RadiologyInsightsClient", + service: AzureHealthInsights, +}) +interface RadiologyInsightsClient { + #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "https://github.com/microsoft/typespec/issues/2037" + inferRadiologyInsights is AzureHealthInsights.RadiologyInsights.createJob; +} + +@@projectedName(Fhir.R4.Extension, "java", "Fhir_R4_Extension"); +@@projectedName(Fhir.R4.Extension, "csharp", "Fhir_R4_Extension"); +@@projectedName(Fhir.R4.Extendible, "java", "Fhir_R4_Extendible"); +@@projectedName(Fhir.R4.Extendible, "csharp", "Fhir_R4_Extendible"); +@@projectedName(Fhir.R4.Element, "java", "Fhir_R4_Element"); +@@projectedName(Fhir.R4.Element, "csharp", "Fhir_R4_Element"); +@@projectedName(Fhir.R4.Coding, "java", "Fhir_R4_Coding"); +@@projectedName(Fhir.R4.Coding, "csharp", "Fhir_R4_Coding"); +@@projectedName(Fhir.R4.CodeableConcept, "java", "Fhir_R4_CodeableConcept"); +@@projectedName(Fhir.R4.CodeableConcept, "csharp", "Fhir_R4_CodeableConcept"); +@@projectedName(Fhir.R4.Meta, "java", "Fhir_R4_Meta"); +@@projectedName(Fhir.R4.Meta, "csharp", "Fhir_R4_Meta"); +@@projectedName(Fhir.R4.Narrative, "java", "Fhir_R4_Narrative"); +@@projectedName(Fhir.R4.Narrative, "csharp", "Fhir_R4_Narrative"); +@@projectedName(Fhir.R4.Reference, "java", "Fhir_R4_Reference"); +@@projectedName(Fhir.R4.Reference, "csharp", "Fhir_R4_Reference"); +@@projectedName(Fhir.R4.Identifier, "java", "Fhir_R4_Identifier"); +@@projectedName(Fhir.R4.Identifier, "csharp", "Fhir_R4_Identifier"); +@@projectedName(Fhir.R4.Period, "java", "Fhir_R4_Period"); +@@projectedName(Fhir.R4.Period, "csharp", "Fhir_R4_Period"); +@@projectedName(Fhir.R4.Quantity, "java", "Fhir_R4_Quantity"); +@@projectedName(Fhir.R4.Quantity, "csharp", "Fhir_R4_Quantity"); +@@projectedName(Fhir.R4.Range, "java", "Fhir_R4_Range"); +@@projectedName(Fhir.R4.Range, "csharp", "Fhir_R4_Range"); +@@projectedName(Fhir.R4.Ratio, "java", "Fhir_R4_Ratio"); +@@projectedName(Fhir.R4.Ratio, "csharp", "Fhir_R4_Ratio"); +@@projectedName(Fhir.R4.Annotation, "java", "Fhir_R4_Annotation"); +@@projectedName(Fhir.R4.Annotation, "csharp", "Fhir_R4_Annotation"); +@@projectedName(Fhir.R4.SampledData, "java", "Fhir_R4_SampledData"); +@@projectedName(Fhir.R4.SampledData, "csharp", "Fhir_R4_SampledData"); +@@projectedName(Fhir.R4.ContactDetail, "java", "Fhir_R4_ContactDetail"); +@@projectedName(Fhir.R4.ContactDetail, "csharp", "Fhir_R4_ContactDetail"); +@@projectedName(Fhir.R4.ContactPoint, "java", "Fhir_R4_ContactPoint"); +@@projectedName(Fhir.R4.ContactPoint, "csharp", "Fhir_R4_ContactPoint"); +@@projectedName(Fhir.R4.Resource, "java", "Fhir_R4_Resource"); +@@projectedName(Fhir.R4.Resource, "csharp", "Fhir_R4_Resource"); +@@projectedName(Fhir.R4.DomainResource, "java", "Fhir_R4_DomainResource"); +@@projectedName(Fhir.R4.DomainResource, "csharp", "Fhir_R4_DomainResource"); +@@projectedName(Fhir.R4.Condition, "java", "Fhir_R4_Condition"); +@@projectedName(Fhir.R4.Condition, "csharp", "Fhir_R4_Condition"); +@@projectedName(Fhir.R4.ConditionStage, "java", "Fhir_R4_ConditionStage"); +@@projectedName(Fhir.R4.ConditionStage, "csharp", "Fhir_R4_ConditionStage"); +@@projectedName(Fhir.R4.Observation, "java", "Fhir_R4_Observation"); +@@projectedName(Fhir.R4.Observation, "csharp", "Fhir_R4_Observation"); +@@projectedName(Fhir.R4.ObservationReferenceRange, + "java", + "Fhir_R4_ObservationReferenceRange" +); +@@projectedName(Fhir.R4.ObservationReferenceRange, + "csharp", + "Fhir_R4_ObservationReferenceRange" +); +@@projectedName(Fhir.R4.ObservationComponent, + "java", + "Fhir_R4_ObservationComponent" +); +@@projectedName(Fhir.R4.ObservationComponent, + "csharp", + "Fhir_R4_ObservationComponent" +); +@@projectedName(Fhir.R4.ResearchStudy, "java", "Fhir_R4_ResearchStudy"); +@@projectedName(Fhir.R4.ResearchStudy, "csharp", "Fhir_R4_ResearchStudy"); +@@projectedName(AzureHealthInsights.PatientInfoSex, "client", "PatientSex"); +@@projectedName(AzureHealthInsights.PatientInfo, "client", "PatientDetails"); diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.tsp b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.tsp new file mode 100644 index 000000000000..757a3c9355e3 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.tsp @@ -0,0 +1,311 @@ +import "../HealthInsights.Common/model.common.request.tsp"; +import "../HealthInsights.Common/model.common.response.tsp"; +import "../HealthInsights.Common/model.common.shared.tsp"; +import "../HealthInsights.Common/model.common.fhir.elements.tsp"; +import "./model.radiologyinsights.valuesets.tsp"; + +using TypeSpec.Rest; + +namespace AzureHealthInsights; + +@doc("Contains the list of patients, and configuration data.") +model RadiologyInsightsData { + ...Request; + + @doc("Configuration affecting the Radiology Insights model's inference.") + configuration?: RadiologyInsightsModelConfiguration; +} + +@doc("Configuration affecting the Radiology Insights model's inference.") +model RadiologyInsightsModelConfiguration { + ...ModelConfiguration; + + @doc("This is a list of inference types to be inferred for the current request. It could be used if only part of the Radiology Insights inferences are required. If this list is omitted or empty, the model will return all the inference types.") + inferenceTypes?: RadiologyInsightsInferenceType[]; + + @doc("Options regarding follow up recommendation inferences and finding inferences.") + inferenceOptions?: RadiologyInsightsInferenceOptions; + + @doc("Local for the model to use. If not specified, the model will use the default locale.") + locale?: string; +} + +@doc("Options regarding follow up recommendation inferences and finding inferences.") +model RadiologyInsightsInferenceOptions { + @doc("Follow-up recommendation options.") + followupRecommendationOptions?: FollowupRecommendationOptions; + + @doc("Finding options.") + findingOptions?: FindingOptions; +} + +@doc("Follow-up recommendation options.") +model FollowupRecommendationOptions { + @doc("Include/Exclude follow-up recommendations without a specific radiology procedure. Default is false.") + includeRecommendationsWithNoSpecifiedModality?: boolean; + + @doc("Include/Exclude follow-up recommendations in references to a guideline or article. Default is false.") + includeRecommendationsInReferences?: boolean; + + @doc("If this is true, provide one or more sentences as evidence for the recommendation, next to the token evidence. The start and end positions of these sentences will be put in an extension with url 'modality_sentences'. Default is false.") + provideFocusedSentenceEvidence?: boolean; +} + +@doc("Finding options.") +model FindingOptions { + @doc("If this is true, provide the sentence that contains the first token of the finding's clinical indicator (i.e. the medical problem), if there is one. This sentence is provided as an extension with url 'ci_sentence', next to the token evidence. Default is false.") + provideFocusedSentenceEvidence?: boolean; +} + +@resource("radiology-insights/jobs") +@doc("Response for the Radiology Insights request.") +model RadiologyInsightsResult + is HealthInsightsOperationStatus; + +@doc("The inference results for the Radiology Insights request. If field 'status' has value 'succeeded', then field 'result' will contain an instance of RadiologyInsightsInferenceResult.") +model RadiologyInsightsInferenceResult { + @doc("Results for the patients given in the request.") + patientResults: RadiologyInsightsPatientResult[]; + + @doc("The version of the model used for inference, expressed as the model date.") + modelVersion: ModelVersion; +} + +@doc("Results of the model's work for a single patient.") +model RadiologyInsightsPatientResult { + @doc("Identifier given for the patient in the request.") + patientId: string; + + @doc("The model's inferences for the given patient.") + inferences: RadiologyInsightsInference[]; +} + +@doc(""" +An inference made by the Radiology Insights model regarding a patient. + - AgeMismatch + - SexMismatch + - LateralityDiscrepancy + - CompleteOrderDiscrepancy + - LimitedOrderDiscrepancy + - Finding + - CriticalResult + - FollowupRecommendation + - RadiologyProcedure + - FollowupCommunication +""") +@discriminator("kind") +model RadiologyInsightsInference is Fhir.R4.Extendible; + +@doc("A notification for age mismatch is displayed when the age mentioned in a document for a specific patient does not match the age specified in the patient information.") +model AgeMismatchInference extends RadiologyInsightsInference { + @doc("Inference type.") + kind: RadiologyInsightsInferenceType.AgeMismatch; +} + +@doc("A notification for a sex mismatch is displayed when the gender, personal pronouns, gender-related body parts, or gender-related procedures mentioned in a patient's clinical document are either inconsistent or do not match the gender specified in the patient information.") +model SexMismatchInference extends RadiologyInsightsInference { + @doc("Inference type.") + kind: RadiologyInsightsInferenceType.SexMismatch; + + @doc("Sex indication : SNOMED CT code for gender finding.") + sexIndication: Fhir.R4.CodeableConcept; +} + +@doc("A laterality mismatch occurs when there is a discrepancy between the clinical documentation and the ordered procedure (orderLateralityMismatch), a contradiction within the clinical document (textLateralityContradiction), or when no laterality is mentioned (textLateralityMissing).") +model LateralityDiscrepancyInference extends RadiologyInsightsInference { + @doc("Inference type.") + kind: RadiologyInsightsInferenceType.LateralityDiscrepancy; + + @doc("Laterality indication : SNOMED CT code for laterality qualifier value.") + lateralityIndication?: Fhir.R4.CodeableConcept; + + @doc("Mismatch type : orderLateralityMismatch, textLateralityContradiction, textLateralityMissing.") + discrepancyType: LateralityDiscrepancyType; +} + +@doc("A complete order discrepancy is shown when one or more body parts and/or measurements that should be in the document (because there is a complete order) are not present.") +model CompleteOrderDiscrepancyInference extends RadiologyInsightsInference { + @doc("Inference type.") + kind: RadiologyInsightsInferenceType.CompleteOrderDiscrepancy; + + @doc("Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast.") + orderType: Fhir.R4.CodeableConcept; + + @doc("List of missing body parts required by a complete order : SNOMED CT codes.") + missingBodyParts?: Array; + + @doc("List of missing body parts that require measurement by a complete order : SNOMED CT codes.") + missingBodyPartMeasurements?: Array; +} + +@doc("A limited order discrepancy occurs when there is a limited order, but all body parts and measurements that are needed for a complete order are present in the document.") +model LimitedOrderDiscrepancyInference extends RadiologyInsightsInference { + @doc("Inference type.") + kind: RadiologyInsightsInferenceType.LimitedOrderDiscrepancy; + + @doc("Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast.") + orderType: Fhir.R4.CodeableConcept; + + @doc("List of body parts found in the document : SNOMED CT codes.") + presentBodyParts?: Array; + + @doc("List of body parts that are measured according to the document : SNOMED CT codes.") + presentBodyPartMeasurements?: Array; +} + +@doc("Findings in a radiology report typically describe abnormalities, lesions, or other notable observations related to the anatomy or pathology of the imaged area.") +model FindingInference extends RadiologyInsightsInference { + @doc("Inference type.") + kind: RadiologyInsightsInferenceType.Finding; + + @doc("Finding data : contains extensions, fields and components linked with the finding.") + finding: Fhir.R4.Observation; +} + +@doc("Critical results refer to findings of utmost importance that may require timely attention due to their potential impact on patient care.") +model CriticalResultInference extends RadiologyInsightsInference { + @doc("Inference type.") + kind: RadiologyInsightsInferenceType.CriticalResult; + + @doc("The complete Critical Result, as outlined below, will be reused for the recommendation.") + result: CriticalResult; +} + +@doc("Critical Result consists of two properties.") +model CriticalResult { + @doc("Description : medical problem.") + description: string; + + @doc("Finding linked to the critical result.") + finding?: Fhir.R4.Observation; +} + +@doc("Radiology procedures are the specific imaging studies or examinations ordered for the patient, extracted from the document information and text.") +model RadiologyProcedureInference extends RadiologyInsightsInference { + @doc("Inference type.") + kind: RadiologyInsightsInferenceType.RadiologyProcedure; + + @doc("LOINC codes for the procedure.") + procedureCodes?: Array; + + @minItems(1) + @doc("Imaging procedures.") + imagingProcedures: Array; + + @doc("Ordered procedure information from the document information or text.") + orderedProcedure: OrderedProcedure; +} + +@doc("Follow-up recommendations offer guidance to healthcare providers on managing and monitoring patients based on the findings of imaging studies.") +model FollowupRecommendationInference extends RadiologyInsightsInference { + @doc("Inference type.") + kind: RadiologyInsightsInferenceType.FollowupRecommendation; + + @doc("Date and time are displayed when the procedure is recommended to be done at a specific point in time.") + effectiveDateTime?: Fhir.R4.fhirDateTime; + + @doc("The period is shown if a specific period is mentioned, with a start and end date-time.") + effectivePeriod?: Fhir.R4.Period; + + @doc("Findings related to the recommendation.") + @minItems(1) + findings?: Array; + + @doc("The conditional value indicates whether or not the sentence containing the recommendation includes a conditional statement. Keywords for conditional statements include 'if', 'when', 'unless', and so on.") + isConditional: boolean; + + @doc("The option value indicates whether or not the sentence containing the recommendation includes an optional statement. Keywords for optional statements include 'recommend', 'consider', and so on.") + isOption: boolean; + + @doc("The guideline value indicates whether or not the recommendation is part of a guideline section that compiles all recommendations applicable to various findings.") + isGuideline: boolean; + + @doc("Hedging refers to ambiguous, vague or imprecise language within the sentence of the recommendation. Keywords for hedging are 'can be','may be',and so on.") + isHedging: boolean; + + @doc("The procedure recommendation can be a generic procedure or an imaging procedure.") + recommendedProcedure: ProcedureRecommendation; +} + +@doc("The procedure recommendation can be a generic procedure or an imaging procedure.") +@discriminator("kind") +model ProcedureRecommendation {} + +@doc("Generic procedure information.") +model GenericProcedureRecommendation extends ProcedureRecommendation { + @doc("Procedure type : generic.") + kind: "genericProcedureRecommendation"; + + @doc("Procedure modality : SNOMED CT code.") + code: Fhir.R4.CodeableConcept; + + @doc("Procedure description : MANAGEMENT PROCEDURE (PROCEDURE) or CONSULTATION (PROCEDURE) based on SNOMED CT.") + description?: string; +} + +@doc("Imaging procedures.") +model ImagingProcedureRecommendation extends ProcedureRecommendation { + @doc("Procedure type : imaging.") + kind: "imagingProcedureRecommendation"; + + @doc("LOINC codes for the procedure.") + procedureCodes?: Array; + + @minItems(1) + @doc("Imaging procedures.") + imagingProcedures: Array; +} + +@doc("Imaging procedure.") +model ImagingProcedure { + @doc("Modality : SNOMED CT code.") + modality: Fhir.R4.CodeableConcept; + + @doc("Anatomy : SNOMED CT code.") + anatomy: Fhir.R4.CodeableConcept; + + @doc("Laterality : SNOMED CT code.") + laterality?: Fhir.R4.CodeableConcept; + + @doc("Contrast : see RadiologyCodeWithTypes (below).") + contrast?: RadiologyCodeWithTypes; + + @doc("View : see RadiologyCodeWithTypes (below).") + view?: RadiologyCodeWithTypes; +} + +@doc("Radiology code with types : used in imaging procedure recommendation for contrast and view.") +model RadiologyCodeWithTypes { + @doc("The SNOMED CT code indicates whether imaging was conducted with or without contrast in the case of contrast, and in the case of views, it denotes the number of views.") + code: Fhir.R4.CodeableConcept; + + @doc("The collection of types will indicate the contrast substance used in the case of contrast and, in the case of views, it will specify the types of views, such as lateral and frontal, etc.") + types: Array; +} + +@doc("Finding reference for recommendation.") +model RecommendationFinding is Fhir.R4.Extendible { + @doc("Finding linked to a recommendation.") + finding?: Fhir.R4.Observation; + + @doc("Critical result linked to a recommendation.") + criticalFinding?: CriticalResult; + + @doc("Recommendation finding status.") + recommendationFindingStatus: RecommendationFindingStatusType; +} + +@doc("Follow-up communication involves the exchange of important information, recommendations, or updates between radiologists and other healthcare professionals involved in a patient's care.") +model FollowupCommunicationInference extends RadiologyInsightsInference { + @doc("Inference type.") + kind: RadiologyInsightsInferenceType.FollowupCommunication; + + @doc("Communication date and time.") + dateTime?: Array; + + @doc("Recipient of the communication.") + recipient?: Array; + + @doc("Communication was acknowledged.") + wasAcknowledged: boolean; +} diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.valuesets.tsp b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.valuesets.tsp new file mode 100644 index 000000000000..2e3b3a24b88b --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.valuesets.tsp @@ -0,0 +1,177 @@ +import "../HealthInsights.Common/model.common.fhir.elements.tsp"; + +namespace AzureHealthInsights; + +@doc("A Radiology Insights inference types.") +enum RadiologyInsightsInferenceType { + @doc("Age mismatch inference type") + AgeMismatch: "ageMismatch", + + @doc("Laterality discrepancy inference type") + LateralityDiscrepancy: "lateralityDiscrepancy", + + @doc("Sex mismatch inference type") + SexMismatch: "sexMismatch", + + @doc("Complete order discrepancy inference type") + CompleteOrderDiscrepancy: "completeOrderDiscrepancy", + + @doc("Limited order discrepancy inference type") + LimitedOrderDiscrepancy: "limitedOrderDiscrepancy", + + @doc("Finding inference type") + Finding: "finding", + + @doc("Critical finding inference type") + CriticalResult: "criticalResult", + + @doc("Recommendation inference type") + FollowupRecommendation: "followupRecommendation", + + @doc("Followup Communication inference type") + FollowupCommunication: "followupCommunication", + + @doc("Radiology Procedure inference type") + RadiologyProcedure: "radiologyProcedure", +} + +@doc("Laterality discrepancy type") +enum LateralityDiscrepancyType { + @doc("Mismatch between order and text") + OrderLateralityMismatch: "orderLateralityMismatch", + + @doc("Contradiction in text") + TextLateralityContradiction: "textLateralityContradiction", + + @doc("Missing laterality in text") + TextLateralityMissing: "textLateralityMissing", +} + +@doc("consider using ClinicalCodeableConcept system: http://unitsofmeasure.org") +enum MeasureUnitType { + @doc("Undefined measure unit type") + Undefined: "undefined", + + @doc("Rate measure unit type") + Rate: "rate", + + @doc("Concentration measure unit type") + Concentration: "concentration", + + @doc("Mass measure unit type") + Mass: "mass", + + @doc("Time measure unit type") + Time: "time", + + @doc("Length measure unit type") + Length: "length", + + @doc("Area measure unit type") + Area: "area", + + @doc("Volume measure unit type") + Volume: "volume", + + @doc("Amount measure unit type") + Amount: "amount", + + @doc("Percentage measure unit type") + Percentage: "percentage", + + @doc("Pressure measure unit type") + Pressure: "pressure", + + @doc("Temperature measure unit type") + Temperature: "temperature", + + @doc("Velocity measure unit type") + Velocity: "velocity", + + @doc("Angle measure unit type") + Angle: "angle", + + @doc("Energy measure unit type") + Energy: "energy", + + @doc("Radioactivity measure unit type") + Radioactivity: "radioactivity", +} + +@doc("Medical Professional Type") +enum MedicalProfessionalType { + @doc("Unknown medical professional type") + Unknown: "unknown", + + @doc("Doctor medical professional type") + Doctor: "doctor", + + @doc("Nurse medical professional type") + Nurse: "nurse", + + @doc("Technician medical professional type") + Midwife: "midwife", + + @doc("Technician medical professional type") + PhysicianAssistant: "physicianAssistant", +} + +@doc("Laterality type") +enum LateralityType { + @doc("Left laterality type") + Left: "left", + + @doc("Right laterality type") + Right: "right", + + @doc("Right and left laterality type") + Bilateral: "bilateral", + + @doc("Unilateral laterality type") + Unilateral: "unilateral", +} + +@doc("Recommendation finding status") +enum RecommendationFindingStatusType { + @doc("Present finding status") + Present: "present", + + @doc("Differential finding status") + Differential: "differential", + + @doc("Rule out finding status") + RuleOut: "ruleOut", + + @doc("Conditional finding status") + Conditional: "conditional", +} + +@doc(""" +DiseaseCourseType value set system url = http://github.com/Azure/HealthInsights/RadiologyInsights/ValueSet/condition-course +The below values can be used for binding in DiseaseCourseExtension.valueCodeableConcept +""") +enum DiseaseCourseType { + @doc("Acute") + Acute: "acute", + + @doc("Chronic") + Chronic: "chronic", + + @doc("Acute on chronic") + AcuteOnChronic: "acuteOnChronic", + + @doc("Intermittent") + Intermittent: "intermittent", + + @doc("Relapsing") + Relapsing: "relapsing", + + @doc("Prolonged") + Prolonged: "prolonged", + + @doc("Paroxysmal") + Paroxysmal: "paroxysmal", + + @doc("Seasonal course") + SeasonalCourse: "seasonalCourse", +} diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/route.radiologyinsights.tsp b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/route.radiologyinsights.tsp new file mode 100644 index 000000000000..9b7dbf515b2a --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/route.radiologyinsights.tsp @@ -0,0 +1,36 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "@typespec/http"; + +import "./model.radiologyinsights.tsp"; +import "./model.radiologyinsights.valuesets.tsp"; +import "../HealthInsights.Common/primitives.tsp"; + +using Azure.Core; +using TypeSpec.Rest; +using TypeSpec.Http; + +namespace AzureHealthInsights; + +interface RadiologyInsights { + #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Service uses a jobId in the path" + @summary("Get Radiology Insights job details") + @tag("RadiologyInsights") + @doc("Gets the status and details of the Radiology Insights job.") + @get + @route("/radiology-insights/jobs/{id}") + getJob is HealthInsightsLongRunningPollOperation; + + #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" + @summary("Create Radiology Insights job") + @tag("RadiologyInsights") + @doc("Creates a Radiology Insights job with the given request body.") + @pollingOperation(RadiologyInsights.getJob) + @route("/radiology-insights/jobs") + createJob is HealthInsightsLongRunningRpcOperation< + RadiologyInsightsData, + RadiologyInsightsResult, + RadiologyInsightsInferenceResult + >; +} diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml new file mode 100644 index 000000000000..ec5097dffa4b --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml @@ -0,0 +1,52 @@ +parameters: + "service-dir": + default: "sdk/healthinsights" + "service-name": + default: "HealthInsights" + "dependencies": + "additionalDirectories": + - "specification/ai/HealthInsights/HealthInsights.Common/" + - "specification/ai/HealthInsights/HealthInsights.OpenAPI/" + default: "" + "python-sdk-folder": + default: "{project-root}/azure-sdk-for-python/" + "java-sdk-folder": + default: "{project-root}/azure-sdk-for-java/" + "js-sdk-folder": + default: "{project-root}/azure-sdk-for-js/" + "csharp-sdk-folder": + default: "{project-root}/azure-sdk-for-net/" + "service-directory-name": + default: "healthinsights" +emit: + - "@azure-tools/typespec-autorest" +linter: + extends: + - "@azure-tools/typespec-azure-core/all" +options: + "@azure-tools/typespec-python": + package-pprint-name: '"Azure Health Insights - Radiology Insights"' + package-mode: "dataplane" + package-version: 1.0.0b1 + package-dir: "azure-healthinsights-radiologyinsights" + package-name: "{package-dir}" + emitter-output-dir: "{python-sdk-folder}/sdk/{service-directory-name}/{package-name}" + "@azure-tools/typespec-java": + package-dir: "azure-health-insights-radiologyinsights" + namespace: com.azure.health.insights.radiologyinsights + service-name: "RadiologyInsights" + partial-update: true + emitter-output-dir: "{java-sdk-folder}/sdk/{service-directory-name}/azure-health-insights-radiologyinsights" + "@azure-tools/typespec-csharp": + save-inputs: false + clear-output-folder: true + package-dir: "Azure.Health.Insights.RadiologyInsights" + namespace: "{package-dir}" + model-namespace: false + "@azure-tools/typespec-ts": + package-dir: "azurehealthinsightsradiologyinsights-rest" + emitter-output-dir: "{js-sdk-folder}/sdk/{service-directory-name}/health-insights-cancerprofiling-rest" + generateMetadata: true + generateTest: true + packageDetails: + name: "@azure-rest/health-insights-radiologyinsights" diff --git a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/client.tsp b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/client.tsp index 516b22dfdcc4..7f3e42e0e051 100644 --- a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/client.tsp +++ b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/client.tsp @@ -3,14 +3,12 @@ import "./route.trialmatcher.tsp"; import "@typespec/rest"; import "@typespec/http"; -import "@typespec/versioning"; import "../HealthInsights.OpenAPI/service.tsp"; using Azure.ClientGenerator.Core; -@TypeSpec.Versioning.useDependency(Azure.Core.Versions.v1_0_Preview_1) @TypeSpec.Versioning.useDependency( - AzureHealthInsights.ApiVersion.v2023_03_01_preview + AzureHealthInsights.ApiVersion.v2023_09_01_Preview ) namespace ClientForAzureHealthInsights; @@ -19,6 +17,72 @@ namespace ClientForAzureHealthInsights; service: AzureHealthInsights, }) interface ClinicalMatchingClient { + #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "https://github.com/microsoft/typespec/issues/2037" matchTrials is AzureHealthInsights.TrialMatcher.createJob; } + +@@projectedName(Fhir.R4.Extension, "java", "Fhir_R4_Extension"); +@@projectedName(Fhir.R4.Extension, "csharp", "Fhir_R4_Extension"); +@@projectedName(Fhir.R4.Extendible, "java", "Fhir_R4_Extendible"); +@@projectedName(Fhir.R4.Extendible, "csharp", "Fhir_R4_Extendible"); +@@projectedName(Fhir.R4.Element, "java", "Fhir_R4_Element"); +@@projectedName(Fhir.R4.Element, "csharp", "Fhir_R4_Element"); +@@projectedName(Fhir.R4.Coding, "java", "Fhir_R4_Coding"); +@@projectedName(Fhir.R4.Coding, "csharp", "Fhir_R4_Coding"); +@@projectedName(Fhir.R4.CodeableConcept, "java", "Fhir_R4_CodeableConcept"); +@@projectedName(Fhir.R4.CodeableConcept, "csharp", "Fhir_R4_CodeableConcept"); +@@projectedName(Fhir.R4.Meta, "java", "Fhir_R4_Meta"); +@@projectedName(Fhir.R4.Meta, "csharp", "Fhir_R4_Meta"); +@@projectedName(Fhir.R4.Narrative, "java", "Fhir_R4_Narrative"); +@@projectedName(Fhir.R4.Narrative, "csharp", "Fhir_R4_Narrative"); +@@projectedName(Fhir.R4.Reference, "java", "Fhir_R4_Reference"); +@@projectedName(Fhir.R4.Reference, "csharp", "Fhir_R4_Reference"); +@@projectedName(Fhir.R4.Identifier, "java", "Fhir_R4_Identifier"); +@@projectedName(Fhir.R4.Identifier, "csharp", "Fhir_R4_Identifier"); +@@projectedName(Fhir.R4.Period, "java", "Fhir_R4_Period"); +@@projectedName(Fhir.R4.Period, "csharp", "Fhir_R4_Period"); +@@projectedName(Fhir.R4.Quantity, "java", "Fhir_R4_Quantity"); +@@projectedName(Fhir.R4.Quantity, "csharp", "Fhir_R4_Quantity"); +@@projectedName(Fhir.R4.Range, "java", "Fhir_R4_Range"); +@@projectedName(Fhir.R4.Range, "csharp", "Fhir_R4_Range"); +@@projectedName(Fhir.R4.Ratio, "java", "Fhir_R4_Ratio"); +@@projectedName(Fhir.R4.Ratio, "csharp", "Fhir_R4_Ratio"); +@@projectedName(Fhir.R4.Annotation, "java", "Fhir_R4_Annotation"); +@@projectedName(Fhir.R4.Annotation, "csharp", "Fhir_R4_Annotation"); +@@projectedName(Fhir.R4.SampledData, "java", "Fhir_R4_SampledData"); +@@projectedName(Fhir.R4.SampledData, "csharp", "Fhir_R4_SampledData"); +@@projectedName(Fhir.R4.ContactDetail, "java", "Fhir_R4_ContactDetail"); +@@projectedName(Fhir.R4.ContactDetail, "csharp", "Fhir_R4_ContactDetail"); +@@projectedName(Fhir.R4.ContactPoint, "java", "Fhir_R4_ContactPoint"); +@@projectedName(Fhir.R4.ContactPoint, "csharp", "Fhir_R4_ContactPoint"); +@@projectedName(Fhir.R4.Resource, "java", "Fhir_R4_Resource"); +@@projectedName(Fhir.R4.Resource, "csharp", "Fhir_R4_Resource"); +@@projectedName(Fhir.R4.DomainResource, "java", "Fhir_R4_DomainResource"); +@@projectedName(Fhir.R4.DomainResource, "csharp", "Fhir_R4_DomainResource"); +@@projectedName(Fhir.R4.Condition, "java", "Fhir_R4_Condition"); +@@projectedName(Fhir.R4.Condition, "csharp", "Fhir_R4_Condition"); +@@projectedName(Fhir.R4.ConditionStage, "java", "Fhir_R4_ConditionStage"); +@@projectedName(Fhir.R4.ConditionStage, "csharp", "Fhir_R4_ConditionStage"); +@@projectedName(Fhir.R4.Observation, "java", "Fhir_R4_Observation"); +@@projectedName(Fhir.R4.Observation, "csharp", "Fhir_R4_Observation"); +@@projectedName(Fhir.R4.ObservationReferenceRange, + "java", + "Fhir_R4_ObservationReferenceRange" +); +@@projectedName(Fhir.R4.ObservationReferenceRange, + "csharp", + "Fhir_R4_ObservationReferenceRange" +); +@@projectedName(Fhir.R4.ObservationComponent, + "java", + "Fhir_R4_ObservationComponent" +); +@@projectedName(Fhir.R4.ObservationComponent, + "csharp", + "Fhir_R4_ObservationComponent" +); +@@projectedName(Fhir.R4.ResearchStudy, "java", "Fhir_R4_ResearchStudy"); +@@projectedName(Fhir.R4.ResearchStudy, "csharp", "Fhir_R4_ResearchStudy"); +@@projectedName(AzureHealthInsights.PatientInfoSex, "client", "PatientSex"); +@@projectedName(AzureHealthInsights.PatientInfo, "client", "PatientDetails"); diff --git a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp index da62117ae22d..5bfefa34be75 100644 --- a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp +++ b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp @@ -1,10 +1,9 @@ import "../HealthInsights.Common/model.common.request.tsp"; import "../HealthInsights.Common/model.common.response.tsp"; import "../HealthInsights.Common/model.common.shared.tsp"; -import "@azure-tools/typespec-azure-core"; +import "../HealthInsights.Common/model.common.fhir.elements.tsp"; using TypeSpec.Rest; -using Azure.Core; namespace AzureHealthInsights; @@ -29,21 +28,15 @@ resulting trial set is a union of the two sets. clinicalTrials: ClinicalTrials; } -@resource("trialmatcher/jobs") +@resource("trial-matcher/jobs") @doc("The response for the Trial Matcher request.") -model TrialMatcherResult { - ...Response; - - @doc("The inference results for the Trial Matcher request.") - @visibility("read") - @lroResult - results?: TrialMatcherResults; -} +model TrialMatcherResult + is HealthInsightsOperationStatus; @doc("The inference results for the Trial Matcher request.") -model TrialMatcherResults { +model TrialMatcherInferenceResult { @doc("Results for the patients given in the request.") - patients: TrialMatcherPatientResult[]; + patientResults: TrialMatcherPatientResult[]; @doc("The version of the model used for inference, expressed as the model date.") modelVersion: ModelVersion; @@ -52,20 +45,6 @@ model TrialMatcherResults { knowledgeGraphLastUpdateDate?: plainDate; } -@doc("The results of the model's work for a single patient.") -model TrialMatcherPatientResult { - @doc("The identifier given for the patient in the request.") - id: string; - - @doc("The model's inferences for the given patient.") - inferences: TrialMatcherInference[]; - - @doc(""" -Clinical information which is needed to provide better trial matching results for the patient. -""") - neededClinicalInfo?: NeededClinicalInfo; -} - @doc("Clinical information which is needed to provide better trial matching results for the patient.") model NeededClinicalInfo is ExtendedClinicalCodedElement[]; @@ -86,6 +65,28 @@ The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, category?: string; } +@doc("The results of the model's work for a single patient.") +model TrialMatcherPatientResult { + @doc("The identifier given for the patient in the request.") + patientId: string; + + @doc("The inference results for the patient.") + inferences: Array; + + @doc(""" + Clinical information which is needed to provide better trial matching results for the patient. + """) + neededClinicalInfo?: NeededClinicalInfo; +} + +@doc("A piece of evidence corresponding to a Trial Matcher inference.") +model TrialMatcherInferenceEvidence { + @doc("A piece of evidence from the eligibility criteria text of a clinical trial.") + eligibilityCriteriaEvidence?: string; + + ...InferenceEvidence; +} + @doc("An inference made by the Trial Matcher model regarding a patient.") model TrialMatcherInference { @doc("The type of the Trial Matcher inference.") @@ -98,7 +99,7 @@ model TrialMatcherInference { @doc("The identifier of the clinical trial.") @minLength(1) - id?: string; + clinicalTrialId?: string; @doc("Possible sources of a clinical trial.") source?: ClinicalTrialSource; @@ -115,12 +116,12 @@ In case both are given, the resulting trial set is a union of the two sets. model ClinicalTrials { @doc("A list of clinical trials.") @minItems(1) - customTrials?: ClinicalTrialDetails[]; + customTrials?: Array; @doc(""" -A list of filters, each one creating a selection of trials from a given -clinical trial registry. -""") + A list of filters, each one creating a selection of trials from a given + clinical trial registry. + """) @minItems(1) registryFilters?: ClinicalTrialRegistryFilter[]; } @@ -234,56 +235,6 @@ model AreaProperties { radius: float64; } -@doc("A description of a clinical trial.") -model ClinicalTrialDetails { - @doc(""" -A given identifier for the clinical trial. Has to be unique within a list of clinical trials. -""") - @minLength(1) - id: string; - - @doc(""" -The eligibility criteria of the clinical trial (inclusion and exclusion), given as text. -""") - eligibilityCriteriaText?: string; - - @doc("Demographic criteria for a clinical trial.") - demographics?: ClinicalTrialDemographics; - - @doc("Trial data which is of interest to the potential participant.") - metadata: ClinicalTrialMetadata; -} - -@doc("Demographic criteria for a clinical trial.") -model ClinicalTrialDemographics { - @doc("Indication of the sex of people who may participate in the clinical trial.") - acceptedSex?: ClinicalTrialAcceptedSex; - - @doc("A definition of the range of ages accepted by a clinical trial. Contains a minimum age and/or a maximum age.") - acceptedAgeRange?: AcceptedAgeRange; -} - -@doc(""" -A definition of the range of ages accepted by a clinical trial. Contains a minimum age and/or a maximum age. -""") -model AcceptedAgeRange { - @doc("A person's age, given as a number (value) and a unit (e.g. years, months)") - minimumAge?: AcceptedAge; - - @doc("A person's age, given as a number (value) and a unit (e.g. years, months)") - maximumAge?: AcceptedAge; -} - -@doc("A person's age, given as a number (value) and a unit (e.g. years, months)") -model AcceptedAge { - @doc("Possible units for a person's age.") - unit: AgeUnit; - - @doc("The number of years/months/days that represents the person's age.") - @minValueExclusive(0.0) - value: float32; -} - @doc("Trial data which is of interest to the potential participant.") model ClinicalTrialMetadata { @doc(""" @@ -336,22 +287,6 @@ model ClinicalTrialResearchFacility { ...GeographicLocation; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" -@doc("Possible values for the Sex eligibility criterion as accepted by clinical trials, which indicates the sex of people who may participate in a clinical study.") -enum ClinicalTrialAcceptedSex { - All: "all", - Female: "female", - Male: "male", -} - -#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" -@doc("Possible units for a person's age.") -enum AgeUnit { - Years: "years", - Months: "months", - Days: "days", -} - #suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" @doc("Possible phases of a clinical trial.") enum ClinicalTrialPhase { diff --git a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp index 3faf9fc355ae..93e95071ca9c 100644 --- a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp +++ b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp @@ -1,7 +1,6 @@ import "@azure-tools/typespec-azure-core"; import "@typespec/rest"; import "@typespec/http"; - import "./model.trialmatcher.tsp"; import "../HealthInsights.Common/primitives.tsp"; @@ -12,16 +11,24 @@ using TypeSpec.Http; namespace AzureHealthInsights; interface TrialMatcher { + #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Service uses a jobId in the path" @summary("Get Trial Matcher job details") @tag("TrialMatcher") @doc("Gets the status and details of the Trial Matcher job.") - getJob is Azure.Core.ResourceRead; + @get + @route("/trial-matcher/jobs/{id}") + getJob is HealthInsightsLongRunningPollOperation; + #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" #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") - createJob is LongRunningRpcOperation; + @route("/trial-matcher/jobs") + createJob is HealthInsightsLongRunningRpcOperation< + TrialMatcherData, + TrialMatcherResult, + TrialMatcherInferenceResult + >; } diff --git a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/tspconfig.yaml b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/tspconfig.yaml index b75525ca55f2..4032033c525b 100644 --- a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/tspconfig.yaml +++ b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/tspconfig.yaml @@ -1,19 +1,51 @@ -emit: [] +parameters: + "service-dir": + default: "sdk/healthinsights" + "service-name": + default: "HealthInsights" + "dependencies": + "additionalDirectories": + - "specification/ai/HealthInsights/HealthInsights.Common/" + - "specification/ai/HealthInsights/HealthInsights.OpenAPI/" + default: "" + "python-sdk-folder": + default: "{project-root}/azure-sdk-for-python/" + "java-sdk-folder": + default: "{project-root}/azure-sdk-for-java/" + "js-sdk-folder": + default: "{project-root}/azure-sdk-for-js/" + "csharp-sdk-folder": + default: "{project-root}/azure-sdk-for-net/" + "service-directory-name": + default: "healthinsights" +emit: + - "@azure-tools/typespec-autorest" linter: extends: - "@azure-tools/typespec-azure-core/all" options: - "@azure-tools/typespec-csharp": - namespace : "Azure.Health.Insights.ClinicalMatching" - clear-output-folder : true - new-project : false - model-namespace : false + "@azure-tools/typespec-python": + package-pprint-name: '"Azure Health Insights - Clinical Matching"' + package-mode: "dataplane" + package-version: 1.0.0b2 + package-dir: "azure-healthinsights-clinicalmatching" + package-name: "{package-dir}" + emitter-output-dir: "{python-sdk-folder}/sdk/{service-directory-name}/{package-name}" "@azure-tools/typespec-java": - namespace: "Com.Azure.Health.Insights.ClinicalMatching" + package-dir: "azure-health-insights-clinicalmatching" + namespace: com.azure.health.insights.clinicalmatching + partial-update: true + emitter-output-dir: "{java-sdk-folder}/sdk/{service-directory-name}/azure-health-insights-clinicalmatching" + "@azure-tools/typespec-csharp": + save-inputs: false clear-output-folder: true - new-project: false + package-dir: "Azure.Health.Insights.ClinicalMatching" + namespace: "{package-dir}" model-namespace: false - "@azure-tools/cadl-typescript": + "@azure-tools/typespec-ts": + package-dir: "azurehealthinsightsclinicalmatching-rest" + emitter-output-dir: "{js-sdk-folder}/sdk/{service-directory-name}/health-insights-cancerprofiling-rest" + generateMetadata: true + generateTest: true packageDetails: name: "@azure-rest/health-insights-clinicalmatching" - description: "Azure Health Insights ClinicalMatching" diff --git a/specification/ai/HealthInsights/service.tsp b/specification/ai/HealthInsights/service.tsp deleted file mode 100644 index 1df0a2e8cece..000000000000 --- a/specification/ai/HealthInsights/service.tsp +++ /dev/null @@ -1,24 +0,0 @@ -using TypeSpec.Rest; -using TypeSpec.Http; -using TypeSpec.Versioning; - -@service({ - title: "Azure Health Insights", -}) -@versioned(ApiVersion) -@doc("Azure Health Insights provides an API that serves insight models, specific for Health & Life Sciences, that perform analysis and provide inferences to be used by a human.") -@server( - "{endpoint}/healthinsights", - "Azure Health Insights provides an API that serves insight models, specific for Health & Life Sciences, that perform analysis and provide inferences to be used by a human.", - { - @doc("Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).") - endpoint: url, - } -) -@useAuth(ApiKeyAuth) -namespace AzureHealthInsights; - -#suppress "@azure-tools/typespec-azure-core/documentation-required" "https://github.com/Azure/typespec-azure/issues/3107" -enum ApiVersion { - v2023_03_01_preview: "2023-03-01-preview", -} diff --git a/specification/ai/ImageAnalysis/client.tsp b/specification/ai/ImageAnalysis/client.tsp index 3e1b0ea8d213..15dc6f531856 100644 --- a/specification/ai/ImageAnalysis/client.tsp +++ b/specification/ai/ImageAnalysis/client.tsp @@ -3,7 +3,7 @@ import "./main.tsp"; using Azure.ClientGenerator.Core; -@@access(ImageAnalysis.analyzeFromBuffer, Access.internal, "csharp"); +@@access(ImageAnalysis.analyzeFromImageData, Access.internal, "csharp"); @@access(ImageAnalysis.analyzeFromUrl, Access.internal, "csharp"); @@access(ImageAnalysis.CaptionResult, Access.public, "csharp"); @@ -28,7 +28,7 @@ using Azure.ClientGenerator.Core; @@projectedName(ImageAnalysis.VisualFeatures, "csharp", "VisualFeaturesImpl"); -@@access(ImageAnalysis.analyzeFromBuffer, Access.internal, "java"); +@@access(ImageAnalysis.analyzeFromImageData, Access.internal, "java"); @@access(ImageAnalysis.analyzeFromUrl, Access.internal, "java"); @@access(ImageAnalysis.CaptionResult, Access.public, "java"); @@ -52,7 +52,7 @@ using Azure.ClientGenerator.Core; @@access(ImageAnalysis.TagsResult, Access.public, "java"); @@access(ImageAnalysis.VisualFeatures, Access.public, "java"); -@@access(ImageAnalysis.analyzeFromBuffer, Access.internal, "python"); +@@access(ImageAnalysis.analyzeFromImageData, Access.internal, "python"); @@access(ImageAnalysis.analyzeFromUrl, Access.internal, "python"); @@access(ImageAnalysis.CaptionResult, Access.public, "python"); diff --git a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromBuffer_MaximumSet.json b/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json similarity index 99% rename from specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromBuffer_MaximumSet.json rename to specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json index c8f2cd466ddb..336d20f470b1 100644 --- a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromBuffer_MaximumSet.json +++ b/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromImageData_MaximumSet.json @@ -1,6 +1,6 @@ { - "title": "AnalyzeFromBuffer", - "operationId": "AnalyzeFromBuffer", + "title": "AnalyzeFromImageData", + "operationId": "AnalyzeFromImageData", "parameters": { "api-version": "2023-10-01", "features": [ diff --git a/specification/ai/ImageAnalysis/main.tsp b/specification/ai/ImageAnalysis/main.tsp index 609c2caeca43..7cd08845b0dd 100644 --- a/specification/ai/ImageAnalysis/main.tsp +++ b/specification/ai/ImageAnalysis/main.tsp @@ -15,7 +15,6 @@ using Azure.Core; }) @versioned(ImageAnalysis.Versions) @useAuth(ApiKeyAuth) -@useAuth(BearerAuth) @server( "{endpoint}/computervision", "Analyze an image to generate a description of its content, detect text, objects and more.", diff --git a/specification/ai/ImageAnalysis/models.tsp b/specification/ai/ImageAnalysis/models.tsp index d10022135c4d..8216950a6abf 100644 --- a/specification/ai/ImageAnalysis/models.tsp +++ b/specification/ai/ImageAnalysis/models.tsp @@ -15,12 +15,12 @@ model ImageBoundingBox { @doc("Width of the area, in pixels.") @minValue(0) - @projectedName("json", "w") + @encodedName("application/json", "w") width: int32; @doc("Height of the area, in pixels.") @minValue(0) - @projectedName("json", "h") + @encodedName("application/json", "h") height: int32; } @@ -82,6 +82,7 @@ The first caption always applies to the whole image. model DenseCaptionsResult { @doc("The list of image captions.") @minItems(1) + @projectedName("python", "list") values: Array; } @@ -165,14 +166,14 @@ model DetectedTextBlock { @doc("Represents the outcome of an Image Analysis operation.") model ImageAnalysisResult { @doc("The generated phrase that describes the content of the analyzed image.") - @projectedName("json", "captionResult") + @encodedName("application/json", "captionResult") caption?: CaptionResult; @doc(""" The up to 10 generated phrases, the first describing the content of the whole image, and the others describing the content of different regions of the image. """) - @projectedName("json", "denseCaptionsResult") + @encodedName("application/json", "denseCaptionsResult") denseCaptions?: DenseCaptionsResult; @doc("Metadata associated with the analyzed image.") @@ -182,26 +183,26 @@ model ImageAnalysisResult { modelVersion: string; @doc("A list of detected physical objects in the analyzed image, and their location.") - @projectedName("json", "objectsResult") + @encodedName("application/json", "objectsResult") objects?: ObjectsResult; @doc("A list of detected people in the analyzed image, and their location.") - @projectedName("json", "peopleResult") + @encodedName("application/json", "peopleResult") people?: PeopleResult; @doc("The extracted printed and hand-written text in the analyze image. Also knows as OCR.") - @projectedName("json", "readResult") + @encodedName("application/json", "readResult") read?: ReadResult; @doc(""" A list of crop regions at the desired as aspect ratios (if provided) that can be used as image thumbnails. These regions preserve as much content as possible from the analyzed image, with priority given to detected faces. """) - @projectedName("json", "smartCropsResult") + @encodedName("application/json", "smartCropsResult") smartCrops?: SmartCropsResult; @doc("A list of content tags in the analyzed image.") - @projectedName("json", "tagsResult") + @encodedName("application/json", "tagsResult") tags?: TagsResult; } @@ -220,6 +221,7 @@ model ImageMetadata { model ObjectsResult { @doc("A list of physical object detected in an image and their location.") @minItems(0) + @projectedName("python", "list") values: Array; } @@ -227,6 +229,7 @@ model ObjectsResult { model PeopleResult { @doc("A list of people detected in an image and their location.") @minItems(0) + @projectedName("python", "list") values: Array; } @@ -245,6 +248,7 @@ These regions preserve as much content as possible from the analyzed image, with model SmartCropsResult { @doc("A list of crop regions.") @minItems(1) + @projectedName("python", "list") values: Array; } @@ -273,6 +277,7 @@ that appear in the image. model TagsResult { @doc("A list of tags.") @minItems(0) + @projectedName("python", "list") values: Array; } diff --git a/specification/ai/ImageAnalysis/routes.tsp b/specification/ai/ImageAnalysis/routes.tsp index 72c6f983ca83..0bdebd4b889a 100644 --- a/specification/ai/ImageAnalysis/routes.tsp +++ b/specification/ai/ImageAnalysis/routes.tsp @@ -75,7 +75,7 @@ alias SharedAnalyzeQuery = { @route("imageanalysis:analyze") @post @sharedRoute -op analyzeFromBuffer is Azure.Core.RpcOperation< +op analyzeFromImageData is Azure.Core.RpcOperation< { @doc("The format of the HTTP payload.") @header diff --git a/specification/ai/ImageAnalysis/tspconfig.yaml b/specification/ai/ImageAnalysis/tspconfig.yaml index c02f047c4e6a..094b2b1702ad 100644 --- a/specification/ai/ImageAnalysis/tspconfig.yaml +++ b/specification/ai/ImageAnalysis/tspconfig.yaml @@ -27,6 +27,6 @@ options: # We switched two public methods to private. Make sure this is not overridden next time the SDK is emitted. partial-update: true "@azure-tools/typespec-ts": - package-dir: "imageAnalysis" + package-dir: "ai-vision-image-analysis-rest" packageDetails: - name: "@azure/imageAnalysis" + name: "@azure-rest/ai-vision-image-analysis" diff --git a/specification/ai/OpenAI.Assistants/.gitignore b/specification/ai/OpenAI.Assistants/.gitignore new file mode 100644 index 000000000000..694c8707cbd7 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/.gitignore @@ -0,0 +1,3 @@ +**/package.json +**/package-lock.json +tsp-output/** diff --git a/specification/ai/OpenAI.Assistants/README.md b/specification/ai/OpenAI.Assistants/README.md new file mode 100644 index 000000000000..43abb27c65e8 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/README.md @@ -0,0 +1,5 @@ +title: OpenAIAssistants +clear-output-folder: false +guessResourceKey: true +isAzureSpec: true +namespace: azure.ai.openai.assistants \ No newline at end of file diff --git a/specification/ai/OpenAI.Assistants/assistants/main.tsp b/specification/ai/OpenAI.Assistants/assistants/main.tsp new file mode 100644 index 000000000000..3b662be82ec5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/assistants/main.tsp @@ -0,0 +1,2 @@ +import "./models.tsp"; +import "./routes.tsp"; diff --git a/specification/ai/OpenAI.Assistants/assistants/models.tsp b/specification/ai/OpenAI.Assistants/assistants/models.tsp new file mode 100644 index 000000000000..6f82c711d58d --- /dev/null +++ b/specification/ai/OpenAI.Assistants/assistants/models.tsp @@ -0,0 +1,146 @@ +import "@typespec/versioning"; +import "../common/models.tsp"; +import "../tools/models.tsp"; + +namespace Azure.AI.OpenAI.Assistants; + +using TypeSpec.Http; +using TypeSpec.Versioning; + +@doc("Represents an assistant that can call the model and use tools.") +@added(ServiceApiVersions.v2024_02_15_preview) +model Assistant { + @doc("The identifier, which can be referenced in API endpoints.") + id: string; + + @doc("The object type, which is always assistant.") + object: "assistant"; + + @encodedName("application/json", "created_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this object was created.") + createdAt: utcDateTime; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The name of the assistant.") + name: string | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The description of the assistant.") + description: string | null; + + @doc("The ID of the model to use.") + `model`: string; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The system instructions for the assistant to use.") + instructions: string | null; + + @doc("The collection of tools enabled for the assistant.") + tools: ToolDefinition[] = []; + + @encodedName("application/json", "file_ids") + @doc("A list of attached file IDs, ordered by creation date in ascending order.") + fileIds: string[] = []; + + ...RequiredNullableMetadata; +} + +@doc("The request details to use when creating a new assistant.") +@added(ServiceApiVersions.v2024_02_15_preview) +model AssistantCreationOptions { + @doc("The ID of the model to use.") + `model`: string; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The name of the new assistant.") + name?: string | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The description of the new assistant.") + description?: string | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The system instructions for the new assistant to use.") + instructions?: string | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The collection of tools to enable for the new assistant.") + tools?: ToolDefinition[] = []; + + @encodedName("application/json", "file_ids") + @doc("A list of previously uploaded file IDs to attach to the assistant.") + fileIds?: string[] = []; + + ...OptionalNullableMetadata; +} + +@doc("The request details to use when modifying an existing assistant.") +@added(ServiceApiVersions.v2024_02_15_preview) +model UpdateAssistantOptions { + @path + @doc("The ID of the assistant to modify.") + assistantId: string; + + @doc("The ID of the model to use.") + `model`?: string; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The modified name for the assistant to use.") + name?: string | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The modified description for the assistant to use.") + description?: string | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The modified system instructions for the new assistant to use.") + instructions?: string | null; + + @doc("The modified collection of tools to enable for the assistant.") + tools?: ToolDefinition[] = []; + + @encodedName("application/json", "file_ids") + @doc("The modified list of previously uploaded fileIDs to attach to the assistant.") + fileIds?: string[] = []; + + ...OptionalNullableMetadata; +} + +@doc("The status of an assistant deletion operation.") +@added(ServiceApiVersions.v2024_02_15_preview) +model AssistantDeletionStatus { + ...DeletionStatus; + + @doc("The object type, which is always 'assistant.deleted'.") + object: "assistant.deleted"; +} + +@doc("Information about a file attached to an assistant, as used by tools that can read files.") +@added(ServiceApiVersions.v2024_02_15_preview) +model AssistantFile { + @doc("The identifier, which can be referenced in API endpoints.") + id: string; + + @doc("The object type, which is always 'assistant.file'.") + object: "assistant.file"; + + @encodedName("application/json", "created_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this object was created.") + createdAt: utcDateTime; + + @encodedName("application/json", "assistant_id") + @doc("The assistant ID that the file is attached to.") + assistantId: string; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "https://github.com/Azure/autorest.csharp/issues/4041" +@doc("The status of an assistant file deletion operation.") +@added(ServiceApiVersions.v2024_02_15_preview) +model AssistantFileDeletionStatus { + ...DeletionStatus; + + @doc("The object type, which is always 'assistant.file.deleted'.") + object: "assistant.file.deleted"; +} diff --git a/specification/ai/OpenAI.Assistants/assistants/routes.tsp b/specification/ai/OpenAI.Assistants/assistants/routes.tsp new file mode 100644 index 000000000000..bbdb7829485a --- /dev/null +++ b/specification/ai/OpenAI.Assistants/assistants/routes.tsp @@ -0,0 +1,154 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; +import "./models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.OpenAI.Assistants; + +/** + * Creates a new assistant. + * + * @returns The new assistant instance. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@added(ServiceApiVersions.v2024_02_15_preview) +@route("/assistants") +op createAssistant(...AssistantCreationOptions): Assistant; + +/** + * Gets a list of assistants that were previously created. + * + * @returns The requested list of assistants. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@added(ServiceApiVersions.v2024_02_15_preview) +@route("/assistants") +op listAssistants(...OpenAIListRequestOptions): OpenAIPageableListOf; + +/** + * Retrieves an existing assistant. + * + * @param assistantId The ID of the assistant to retrieve. + * @returns The requested assistant instance. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API name parity" +@get +@route("/assistants/{assistantId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op getAssistant(@path assistantId: string): Assistant; + +/** + * Modifies an existing assistant. + * + * @param updateAssistantOptions The details of the modification to perform on a specified assistant. + * @returns The updated assistant instance. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/assistants/{assistantId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op updateAssistant(...UpdateAssistantOptions): Assistant; + +/** + * Deletes an assistant. + * + * @param assistantId The ID of the assistant to delete. + * @returns Status information about the requested deletion operation. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@delete +@route("/assistants/{assistantId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op deleteAssistant(@path assistantId: string): AssistantDeletionStatus; + +/** + * Attaches a previously uploaded file to an assistant for use by tools that can read files. + * + * @param assistantId The ID of the assistant to attach the file to. + * @param fileId The ID of the previously uploaded file to attach. + * @returns Information about the attached file. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("assistants/{assistantId}/files") +@added(ServiceApiVersions.v2024_02_15_preview) +op createAssistantFile( + @path assistantId: string, + @encodedName("application/json", "file_id") fileId: string, +): AssistantFile; + +/** + * Gets a list of files attached to a specific assistant, as used by tools that can read files. + * + * @param assistantId The ID of the assistant to retrieve the list of attached files for. + * @returns The requested list of files attached to the specified assistant. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@route("assistants/{assistantId}/files") +@added(ServiceApiVersions.v2024_02_15_preview) +op listAssistantFiles( + @path assistantId: string, + ...OpenAIListRequestOptions, +): OpenAIPageableListOf; + +/** + * Retrieves a file attached to an assistant. + * + * @param assistantId The ID of the assistant associated with the attached file. + * @param fileId The ID of the file to retrieve. + * @returns A representation of the attached file. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API name parity" +@get +@route("assistants/{assistantId}/files/{fileId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op getAssistantFile( + @path assistantId: string, + @path fileId: string, +): AssistantFile; + +/** + * Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read + * files. + * + * @param assistantId The ID of the assistant from which the specified file should be unlinked. + * @param fileId The ID of the file to unlink from the specified assistant. + * @returns Status information about the requested file association deletion. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@delete +@route("assistants/{assistantId}/files/{fileId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op deleteAssistantFile( + @path assistantId: string, + @path fileId: string, +): AssistantFileDeletionStatus; diff --git a/specification/ai/OpenAI.Assistants/client.tsp b/specification/ai/OpenAI.Assistants/client.tsp new file mode 100644 index 000000000000..73f71849c520 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/client.tsp @@ -0,0 +1,189 @@ +import "@azure-tools/typespec-client-generator-core"; + +import "./main.tsp"; + +using Azure.ClientGenerator.Core; + +#suppress "@azure-tools/typespec-azure-core/casing-style" "OpenAI is a case-sensitive name" +@TypeSpec.Versioning.versioned(Azure.AI.OpenAI.Assistants.ServiceApiVersions) +namespace Azure.AI.OpenAI.Assistants; + +// Trivial response value containers should treat these containers as internal details and instead surface a shimmed +// operation that exposes the underlying data directly. +@@projectedName(AssistantDeletionStatus, + "csharp", + "InternalAssistantDeletionStatus" +); +@@access(deleteAssistant, Access.internal, "csharp"); +@@projectedName(deleteAssistant, "csharp", "InternalDeleteAssistant"); +@@access(AssistantFileDeletionStatus, Access.internal, "csharp"); +@@projectedName(AssistantFileDeletionStatus, + "csharp", + "InternalAssistantFileDeletionStatus" +); +@@access(deleteAssistantFile, Access.internal, "csharp"); +@@projectedName(deleteAssistantFile, "csharp", "InternalUnlinkAssistantFile"); +@@access(deleteThread, Access.internal, "csharp"); +@@projectedName(deleteThread, "csharp", "InternalDeleteThread"); +@@access(listAssistants, Access.internal, "csharp"); +@@projectedName(listAssistants, "csharp", "InternalGetAssistants"); +@@access(listAssistantFiles, Access.internal, "csharp"); +@@projectedName(listAssistantFiles, "csharp", "InternalGetAssistantFiles"); +@@access(listMessageFiles, Access.internal, "csharp"); +@@projectedName(listMessageFiles, "csharp", "InternalGetMessageFiles"); +@@access(listRunSteps, Access.internal, "csharp"); +@@projectedName(listRunSteps, "csharp", "InternalGetRunSteps"); +@@access(listMessages, Access.internal, "csharp"); +@@projectedName(listMessages, "csharp", "InternalGetMessages"); +@@access(listRuns, Access.internal, "csharp"); +@@projectedName(listRuns, "csharp", "InternalGetRuns"); +@@access(FileListResponse, Access.internal, "csharp"); +@@projectedName(FileListResponse, "csharp", "InternalFileListResponse"); +@@access(listFiles, Access.internal, "csharp"); +@@projectedName(listFiles, "csharp", "InternalListFiles"); +@@access(FileDeletionStatus, Access.internal, "csharp"); +@@projectedName(FileDeletionStatus, "csharp", "InternalFileDeletionStatus"); +@@access(deleteFile, Access.internal, "csharp"); +@@projectedName(deleteFile, "csharp", "InternalDeleteFile"); + +// In addition to top-level response value containers, trivial intermediate structure -- levels of single-use model +// hierarchy that don't convey explanatory or functional benefit to consumers of the surface -- should also be +// internalized and merged into the more useful top-level type. + +// FunctionToolDefinition: merge FunctionDefinition structure to recast e.g. toolDefinition.function.name into +// toolDefinition.name + +@@access(FunctionDefinition, Access.internal); +@@projectedName(FunctionDefinition, "csharp", "InternalFunctionDefinition"); +@@projectedName(FunctionToolDefinition.function, "csharp", "InternalFunction"); + +// SubmitToolOutputsAction: include .tool_calls directly rather than via an intermediate .details. + +@@access(SubmitToolOutputsDetails, Access.internal); +@@projectedName(SubmitToolOutputsDetails, + "csharp", + "InternalSubmitToolOutputsDetails" +); +@@projectedName(SubmitToolOutputsAction.submitToolOutputs, + "csharp", + "InternalDetails" +); + +// RequiredFunctionToolCall, RunStepFunctionToolCall: include name/arguments/output directly + +@@access(RunStepFunctionToolCallDetails, Access.internal); +@@projectedName(RunStepFunctionToolCallDetails, + "csharp", + "InternalRunStepFunctionToolCallDetails" +); +@@projectedName(RequiredFunctionToolCall.function, "csharp", "InternalDetails"); +@@access(RequiredFunctionToolCallDetails, Access.internal); +@@projectedName(RequiredFunctionToolCallDetails, + "csharp", + "InternalRequiredFunctionToolCallDetails" +); +@@projectedName(RunStepFunctionToolCall.function, "csharp", "InternalDetails"); + +// RunStepCodeInterpreterToolCall: include input/outputs directly + +@@access(RunStepCodeInterpreterToolCallDetails, Access.internal); +@@projectedName(RunStepCodeInterpreterToolCallDetails, + "csharp", + "InternalCodeInterpreterToolCallDetails" +); +@@projectedName(RunStepCodeInterpreterToolCall.codeInterpreter, + "csharp", + "InternalDetails" +); + +// MessageTextContent: text/annotations can also merge + +@@access(MessageTextDetails, Access.internal); +@@projectedName(MessageTextDetails, "csharp", "InternalMessageTextDetails"); +@@projectedName(MessageTextContent.text, "csharp", "InternalDetails"); + +// MessageTextFileCitationAnnotation: file_id/quote don't need another type + +@@access(MessageTextFileCitationDetails, Access.internal); +@@projectedName(MessageTextFileCitationDetails, + "csharp", + "InternalMessageTextFileCitationDetails" +); +@@projectedName(MessageTextFileCitationAnnotation.fileCitation, + "csharp", + "InternalDetails" +); + +// MessageTextFilePathAnnotation: file_id doesn't need a separate details client type + +@@access(MessageTextFilePathDetails, Access.internal); +@@projectedName(MessageTextFilePathDetails, + "csharp", + "InternalMessageTextFilePathDetails" +); +@@projectedName(MessageTextFilePathAnnotation.filePath, + "csharp", + "InternalDetails" +); + +// MessageImageFileContent: *two* levels of intermediate structure can be squashed to bring file_id to the parent +// type. Per earlier precedent with image generation, even the introduction of more image file representations (e.g. +// base64) are better accomplished via another approach at the client layer. + +@@access(MessageImageFileDetails, Access.internal); +@@access(MessageImageFileIdDetails, Access.internal); +@@projectedName(MessageImageFileDetails, + "csharp", + "InternalMessageImageFileDetails" +); +@@projectedName(MessageImageFileContent.imageFile, "csharp", "InternalDetails"); +@@projectedName(MessageImageFileIdDetails, + "csharp", + "InternalMessageImageFileIdDetails" +); +@@projectedName(MessageImageFileDetails.fileId, "csharp", "InternalDetails"); + +// Several of the content item types are not intended to be used as input + +@@usage(MessageTextContent, Usage.output); +@@usage(MessageImageFileContent, Usage.output); +@@usage(MessageTextContent, Usage.output); +@@usage(MessageTextFileCitationAnnotation, Usage.output); +@@usage(MessageTextFilePathAnnotation, Usage.output); + +// Ensure some shared types remain public despite interaction with previously internalized details + +@@access(MessageTextFilePathAnnotation, Access.public); +@@access(MessageTextFileCitationAnnotation, Access.public); +@@access(ListSortOrder, Access.public); +@@access(RequiredToolCall, Access.public); +@@usage(FilePurpose, Usage.input | Usage.output); +@@usage(ListSortOrder, Usage.input | Usage.output); + +// Additional, language-specific idiomatic renames + +@@projectedName(OpenAIFile, "csharp", "OpenAIFile"); +@@projectedName(OpenAIFile.bytes, "csharp", "Size"); +@@projectedName(FilePurpose, "csharp", "OpenAIFilePurpose"); +@@projectedName(ThreadMessage.content, "csharp", "ContentItems"); +@@projectedName(MessageTextDetails.value, "csharp", "Text"); +@@projectedName(CreateRunOptions.`model`, "csharp", "OverrideModelName"); +@@projectedName(CreateRunOptions.instructions, + "csharp", + "OverrideInstructions" +); +@@projectedName(CreateRunOptions.tools, "csharp", "OverrideTools"); +@@projectedName(CreateAndRunThreadOptions.`model`, + "csharp", + "OverrideModelName" +); +@@projectedName(CreateAndRunThreadOptions.instructions, + "csharp", + "OverrideInstructions" +); +@@projectedName(CreateAndRunThreadOptions.tools, "csharp", "OverrideTools"); +// From https://platform.openai.com/docs/assistants/how-it-works +// "Note that deleting an AssistantFile doesn’t delete the original File object, it simply deletes the association +// between that File and the Assistant." +@@projectedName(createAssistantFile, "csharp", "LinkAssistantFile"); +// 'Unlink' counterpart already renamed for DeletionStatus merge diff --git a/specification/ai/OpenAI.Assistants/common/models.tsp b/specification/ai/OpenAI.Assistants/common/models.tsp new file mode 100644 index 000000000000..3cb86ef89fb5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/common/models.tsp @@ -0,0 +1,90 @@ +import "@typespec/http"; +import "@typespec/versioning"; + +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.OpenAI.Assistants; + +@doc("The possible values for roles attributed to messages in a thread.") +@added(ServiceApiVersions.v2024_02_15_preview) +enum MessageRole { + @doc("The role representing the end-user.") + user: "user", + + @doc("The role representing the assistant.") + assistant: "assistant", +} + +@doc("The available sorting options when requesting a list of response objects.") +enum ListSortOrder { + @doc("Specifies an ascending sort order.") + ascending: "asc", + + @doc("Specifies a descending sort order.") + descending: "desc", +} + +alias OpenAIListRequestOptions = { + @doc("A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.") + @query + limit?: int32 = 20; + + @doc("Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.") + @query + order?: ListSortOrder = ListSortOrder.descending; + + @doc("A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.") + @query + after?: string; + + @doc("A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.") + @query + before?: string; +}; + +#suppress "@azure-tools/typespec-azure-core/casing-style" "OpenAI is a case-sensitive name" +@doc("The response data for a requested list of items.") +model OpenAIPageableListOf { + @doc("The object type, which is always list.") + object: "list"; + + @doc("The requested list of items.") + data: T[]; + + @encodedName("application/json", "first_id") + @doc("The first ID represented in this list.") + firstId: string; + + @encodedName("application/json", "last_id") + @doc("The last ID represented in this list.") + lastId: string; + + @encodedName("application/json", "has_more") + @doc("A value indicating whether there are additional values available not captured in this list.") + hasMore: boolean; +} + +alias DeletionStatus = { + @doc("The ID of the resource specified for deletion.") + id: string; + + @doc("A value indicating whether deletion was successful.") + deleted: boolean; +}; + +alias RequiredNullableMetadata = { + /** + * A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + metadata: Record | null; +}; + +alias OptionalNullableMetadata = { + /** + * A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + */ + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + metadata?: Record | null; +}; diff --git a/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json new file mode 100644 index 000000000000..24f1208ac3df --- /dev/null +++ b/specification/ai/OpenAI.Assistants/examples/2024-02-15-preview/create_assistant.json @@ -0,0 +1,4 @@ +{ + "title": "Assistants_CreateAssistant", + "operationId": "Assistants_CreateAssistant" +} diff --git a/specification/ai/OpenAI.Assistants/files/main.tsp b/specification/ai/OpenAI.Assistants/files/main.tsp new file mode 100644 index 000000000000..3b662be82ec5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/files/main.tsp @@ -0,0 +1,2 @@ +import "./models.tsp"; +import "./routes.tsp"; diff --git a/specification/ai/OpenAI.Assistants/files/models.tsp b/specification/ai/OpenAI.Assistants/files/models.tsp new file mode 100644 index 000000000000..87a897edff65 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/files/models.tsp @@ -0,0 +1,66 @@ +import "@typespec/versioning"; + +namespace Azure.AI.OpenAI.Assistants; + +using TypeSpec.Versioning; + +#suppress "@azure-tools/typespec-azure-core/casing-style" "OpenAI is a case-sensitive name" +@doc("Represents an assistant that can call the model and use tools.") +@added(ServiceApiVersions.v2024_02_15_preview) +model OpenAIFile { + @doc("The object type, which is always 'file'.") + object: "file"; + + @doc("The identifier, which can be referenced in API endpoints.") + id: string; + + @doc("The size of the file, in bytes.") + bytes: int32; + + @doc("The name of the file.") + filename: string; + + @encodedName("application/json", "created_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this object was created.") + createdAt: utcDateTime; + + @doc("The intended purpose of a file.") + purpose: FilePurpose; +} + +@doc("The possible values denoting the intended usage of a file.") +@added(ServiceApiVersions.v2024_02_15_preview) +enum FilePurpose { + @doc("Indicates a file is used for fine tuning input.") + fineTune: "fine-tune", + + @doc("Indicates a file is used for fine tuning results.") + fineTuneResults: "fine-tune-results", + + @doc("Indicates a file is used as input to assistants.") + assistants: "assistants", + + @doc("Indicates a file is used as output by assistants.") + assistantsOutput: "assistants_output", +} + +@doc("The response data from a file list operation.") +@added(ServiceApiVersions.v2024_02_15_preview) +model FileListResponse { + @doc("The object type, which is always 'list'.") + object: "list"; + + @doc("The files returned for the request.") + data: OpenAIFile[]; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "https://github.com/Azure/autorest.csharp/issues/4041" +@doc("A status response from a file deletion operation.") +@added(ServiceApiVersions.v2024_02_15_preview) +model FileDeletionStatus { + ...DeletionStatus; + + @doc("The object type, which is always 'file'.") + object: "file"; +} diff --git a/specification/ai/OpenAI.Assistants/files/routes.tsp b/specification/ai/OpenAI.Assistants/files/routes.tsp new file mode 100644 index 000000000000..fde1cfc385e3 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/files/routes.tsp @@ -0,0 +1,83 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; +import "./models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.OpenAI.Assistants; + +/** + * Gets a list of previously uploaded files. + * + * @param purpose A value that, when provided, limits list results to files matching the corresponding purpose. + * @returns The requested list of files. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@added(ServiceApiVersions.v2024_02_15_preview) +@route("/files") +op listFiles(@query purpose?: FilePurpose): FileListResponse; + +/** + * Uploads a file for use by other operations. + * + * @param contentType The 'content-type' header value, always 'multipart/format-data' for this operation. + * @param file The file data (not filename) to upload. + * @param purpose The intended purpose of the file. + * @param filename A filename to associate with the uploaded data. + * @returns A representation of the uploaded file. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +#suppress "@azure-tools/typespec-azure-core/byos" "mirrored API" +@post +@added(ServiceApiVersions.v2024_02_15_preview) +@route("/files") +op uploadFile( + @header contentType: "multipart/form-data", + @projectedName("csharp", "Data") file: bytes, + purpose: FilePurpose, + + /* + * Spec note: filename is not documented as a distinct option but functionally should be one. The value is encoded + * in the multipart Content-Disposition header for the data section and can be provided independently of + * any specific data source like a file. It can be inferred in some circumstances (as when using direct + * file input, like curl does) but should remain configurable when using a stream or other data source + * lacking an a priori name. + */ + filename?: string, +): OpenAIFile; + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@delete +@doc("Delete a previously uploaded file.") +@route("/files/{fileId}") +op deleteFile( + @doc("The ID of the file to delete.") + @encodedName("application/json", "file_id") + @path + fileId: string, +): FileDeletionStatus; + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API name parity" +@get +@route("/files/{fileId}") +@doc("Returns information about a specific file. Does not retrieve file content.") +op getFile( + @doc("The ID of the file to retrieve.") + @path + @encodedName("application/json", "file_id") + fileId: string, +): OpenAIFile; diff --git a/specification/ai/OpenAI.Assistants/main.tsp b/specification/ai/OpenAI.Assistants/main.tsp new file mode 100644 index 000000000000..b8113066df16 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/main.tsp @@ -0,0 +1,46 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/http"; +import "@typespec/versioning"; +import "./assistants/main.tsp"; +import "./threads/main.tsp"; +import "./messages/main.tsp"; +import "./runs/main.tsp"; +import "./run_steps/main.tsp"; +import "./files/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Versioning; + +using Azure.Core; + +#suppress "@azure-tools/typespec-azure-core/casing-style" "OpenAI is a case-sensitive name" +@useAuth( + ApiKeyAuth | OAuth2Auth<[ + { + type: OAuth2FlowType.implicit, + authorizationUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + scopes: ["https://cognitiveservices.azure.com/.default"], + } + ]> +) +@service({ + title: "Azure OpenAI", +}) +@server( + "{endpoint}", + "Azure OpenAI APIs for Assistants.", + { + @doc("An OpenAI endpoint supporting assistants functionality.") + endpoint: string, + } +) +@versioned(ServiceApiVersions) +@doc("Azure OpenAI APIs for Assistants.") +namespace Azure.AI.OpenAI.Assistants; + +@doc("The known set of supported API versions.") +enum ServiceApiVersions { + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @doc("The initial version of Azure OpenAI Assistants that corresponds to functionality in OpenAI's first beta release.") + v2024_02_15_preview: "2024-02-15-preview", +} diff --git a/specification/ai/OpenAI.Assistants/messages/main.tsp b/specification/ai/OpenAI.Assistants/messages/main.tsp new file mode 100644 index 000000000000..3b662be82ec5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/messages/main.tsp @@ -0,0 +1,2 @@ +import "./models.tsp"; +import "./routes.tsp"; diff --git a/specification/ai/OpenAI.Assistants/messages/models.tsp b/specification/ai/OpenAI.Assistants/messages/models.tsp new file mode 100644 index 000000000000..f53eba607013 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/messages/models.tsp @@ -0,0 +1,217 @@ +import "@typespec/versioning"; + +namespace Azure.AI.OpenAI.Assistants; + +using TypeSpec.Versioning; + +@doc("A single message within an assistant thread, as provided during that thread's creation for its initial state.") +@added(ServiceApiVersions.v2024_02_15_preview) +model ThreadInitializationMessage { + @doc("The role associated with the assistant thread message. Currently, only 'user' is supported when providing initial messages to a new thread.") + role: MessageRole; + + @doc("The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API.") + content: string; + + @encodedName("application/json", "file_ids") + @doc(""" + A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can + access files. + """) + fileIds?: string[] = []; + + ...OptionalNullableMetadata; +} + +@doc("A single, existing message within an assistant thread.") +@added(ServiceApiVersions.v2024_02_15_preview) +model ThreadMessage { + @doc("The identifier, which can be referenced in API endpoints.") + id: string; + + @doc("The object type, which is always 'thread.message'.") + object: "thread.message"; + + @encodedName("application/json", "created_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this object was created.") + createdAt: utcDateTime; + + @encodedName("application/json", "thread_id") + @doc("The ID of the thread that this message belongs to.") + threadId: string; + + @doc("The role associated with the assistant thread message.") + role: MessageRole; + + @doc("The list of content items associated with the assistant thread message.") + content: MessageContent[]; + + @encodedName("application/json", "assistant_id") + @doc("If applicable, the ID of the assistant that authored this message.") + assistantId?: string; + + @encodedName("application/json", "run_id") + @doc("If applicable, the ID of the run associated with the authoring of this message.") + runId?: string; + + @encodedName("application/json", "file_ids") + @doc(""" + A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can + access files. + """) + fileIds: string[]; + + ...RequiredNullableMetadata; +} + +// Message content types: "text" | "image_file" + +@discriminator("type") +@doc("An abstract representation of a single item of thread message content.") +@added(ServiceApiVersions.v2024_02_15_preview) +model MessageContent { + @doc("The object type.") + type: string; +} + +@doc("A representation of a textual item of thread message content.") +@added(ServiceApiVersions.v2024_02_15_preview) +model MessageTextContent extends MessageContent { + @doc("The object type, which is always 'text'.") + type: "text"; + + @doc("The text and associated annotations for this thread message content item.") + text: MessageTextDetails; +} + +@doc("A representation of image file content in a thread message.") +@added(ServiceApiVersions.v2024_02_15_preview) +model MessageImageFileContent extends MessageContent { + @doc("The object type, which is always 'image_file'.") + type: "image_file"; + + @encodedName("application/json", "image_file") + @doc("The image file for this thread message content item.") + imageFile: MessageImageFileDetails; +} + +// Text content details + +@doc("The text and associated annotations for a single item of assistant thread message content.") +@added(ServiceApiVersions.v2024_02_15_preview) +model MessageTextDetails { + @doc("The text data.") + value: string; + + @doc("A list of annotations associated with this text.") + annotations: MessageTextAnnotation[]; +} + +// Annotations, used by text content: "file_citation" | "file_path" + +@discriminator("type") +@doc("An abstract representation of an annotation to text thread message content.") +@added(ServiceApiVersions.v2024_02_15_preview) +model MessageTextAnnotation { + @doc("The object type.") + type: string; + + @doc("The textual content associated with this text annotation item.") + text: string; + + @encodedName("application/json", "start_index") + @doc("The first text index associated with this text annotation.") + startIndex: int32; + + @encodedName("application/json", "end_index") + @doc("The last text index associated with this text annotation.") + endIndex: int32; +} + +// File citation annotation + details + +@doc("A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.") +@added(ServiceApiVersions.v2024_02_15_preview) +model MessageTextFileCitationAnnotation extends MessageTextAnnotation { + @doc("The object type, which is always 'file_citation'.") + type: "file_citation"; + + @encodedName("application/json", "file_citation") + @doc(""" + A citation within the message that points to a specific quote from a specific file. + Generated when the assistant uses the "retrieval" tool to search files. + """) + fileCitation: MessageTextFileCitationDetails; +} + +@doc("A representation of a file-based text citation, as used in a file-based annotation of text thread message content.") +@added(ServiceApiVersions.v2024_02_15_preview) +model MessageTextFileCitationDetails { + @encodedName("application/json", "file_id") + @doc("The ID of the file associated with this citation.") + fileId: string; + + @doc("The specific quote cited in the associated file.") + quote: string; +} + +// File path annotation + details + +@doc("A citation within the message that points to a file located at a specific path.") +@added(ServiceApiVersions.v2024_02_15_preview) +model MessageTextFilePathAnnotation extends MessageTextAnnotation { + @doc("The object type, which is always 'file_path'.") + type: "file_path"; + + @encodedName("application/json", "file_path") + @doc("A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.") + filePath: MessageTextFilePathDetails; +} + +@doc("An encapsulation of an image file ID, as used by message image content.") +@added(ServiceApiVersions.v2024_02_15_preview) +model MessageTextFilePathDetails { + @doc("The ID of the specific file that the citation is from.") + @encodedName("application/json", "file_id") + fileId: string; +} + +// Image file content details + +@doc("An image reference, as represented in thread message content.") +@added(ServiceApiVersions.v2024_02_15_preview) +model MessageImageFileDetails { + @encodedName("application/json", "file_id") + @doc("The ID for the file associated with this image.") + fileId: MessageImageFileIdDetails; +} + +@doc("An encapsulation of an image file ID, as used by message image content.") +@added(ServiceApiVersions.v2024_02_15_preview) +model MessageImageFileIdDetails { + @doc("The ID of the specific image file.") + @encodedName("application/json", "file_id") + fileId: string; +} + +// Assistant message file representation, used for message "list files" route responses + +@doc("Information about a file attached to an assistant thread message.") +@added(ServiceApiVersions.v2024_02_15_preview) +model MessageFile { + @doc("The identifier, which can be referenced in API endpoints.") + id: string; + + @doc("The object type, which is always 'thread.message.file'.") + object: "thread.message.file"; + + @encodedName("application/json", "created_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this object was created.") + createdAt: utcDateTime; + + @encodedName("application/json", "message_id") + @doc("The ID of the message that this file is attached to.") + messageId: string; +} diff --git a/specification/ai/OpenAI.Assistants/messages/routes.tsp b/specification/ai/OpenAI.Assistants/messages/routes.tsp new file mode 100644 index 000000000000..356bf12e140f --- /dev/null +++ b/specification/ai/OpenAI.Assistants/messages/routes.tsp @@ -0,0 +1,132 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; +import "../common/models.tsp"; +import "./models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +using Azure.Core; + +namespace Azure.AI.OpenAI.Assistants; + +/** + * Creates a new message on a specified thread. + * + * @param threadId The ID of the thread to create the new message on. + * @param role The role to associate with the new message. + * @param content The textual content for the new message. + * @param fileIds A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. + * @returns A representation of the new message. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/threads/{threadId}/messages") +@added(ServiceApiVersions.v2024_02_15_preview) +op createMessage( + @path threadId: string, + role: MessageRole, + content: string, + @encodedName("application/json", "file_ids") fileIds?: string[], + ...OptionalNullableMetadata, +): ThreadMessage; + +/** + * Gets a list of messages that exist on a thread. + * + * @param threadId The ID of the thread to list messages from. + * @returns The requested list of messages. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@route("/threads/{threadId}/messages") +@added(ServiceApiVersions.v2024_02_15_preview) +op listMessages( + @path threadId: string, + ...OpenAIListRequestOptions, +): OpenAIPageableListOf; + +/** + * Gets an existing message from an existing thread. + * + * @param threadId The ID of the thread to retrieve the specified message from. + * @param messageId The ID of the message to retrieve from the specified thread. + * @returns A representation of the requested message. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API name parity" +@get +@route("/threads/{threadId}/messages/{messageId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op getMessage(@path threadId: string, @path messageId: string): ThreadMessage; + +/** + * Modifies an existing message on an existing thread. + * + * @param threadId The ID of the thread containing the specified message to modify. + * @param messageId The ID of the message to modify on the specified thread. + * @returns A representation of the modified message. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/threads/{threadId}/messages/{messageId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op updateMessage( + @path threadId: string, + @path messageId: string, + ...OptionalNullableMetadata, +): ThreadMessage; + +/** + * Gets a list of previously uploaded files associated with a message from a thread. + * + * @param threadId The ID of the thread containing the message to list files from. + * @param messageId The ID of the message to list files from. + * @returns The requested list of files associated with the specified message. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@route("/threads/{threadId}/messages/{messageId}/files") +@added(ServiceApiVersions.v2024_02_15_preview) +op listMessageFiles( + @path threadId: string, + @path messageId: string, + ...OpenAIListRequestOptions, +): OpenAIPageableListOf; + +/** + * Gets information about a file attachment to a message within a thread. + * + * @param threadId The ID of the thread containing the message to get information from. + * @param messageId The ID of the message to get information from. + * @param fileId The ID of the file to get information about. + * @returns The requested file information. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API name parity" +@get +@route("/threads/{threadId}/messages/{messageId}/files/{fileId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op getMessageFile( + @path threadId: string, + @path messageId: string, + @path fileId: string, +): MessageFile; diff --git a/specification/ai/OpenAI.Assistants/run_steps/main.tsp b/specification/ai/OpenAI.Assistants/run_steps/main.tsp new file mode 100644 index 000000000000..3b662be82ec5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/run_steps/main.tsp @@ -0,0 +1,2 @@ +import "./models.tsp"; +import "./routes.tsp"; diff --git a/specification/ai/OpenAI.Assistants/run_steps/models.tsp b/specification/ai/OpenAI.Assistants/run_steps/models.tsp new file mode 100644 index 000000000000..d13b49c3e9da --- /dev/null +++ b/specification/ai/OpenAI.Assistants/run_steps/models.tsp @@ -0,0 +1,161 @@ +import "@typespec/versioning"; +import "../tools/models.tsp"; + +namespace Azure.AI.OpenAI.Assistants; + +using TypeSpec.Versioning; + +@doc("Detailed information about a single step of an assistant thread run.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStep { + @doc("The identifier, which can be referenced in API endpoints.") + id: string; + + @doc("The object type, which is always 'thread.run.step'.") + object: "thread.run.step"; + + @doc("The type of run step, which can be either message_creation or tool_calls.") + type: RunStepType; + + @encodedName("application/json", "assistant_id") + @doc("The ID of the assistant associated with the run step.") + assistantId: string; + + @encodedName("application/json", "thread_id") + @doc("The ID of the thread that was run.") + threadId: string; + + @encodedName("application/json", "run_id") + @doc("The ID of the run that this run step is a part of.") + runId: string; + + @doc("The status of this run step.") + status: RunStepStatus; + + @encodedName("application/json", "step_details") + @doc("The details for this run step.") + stepDetails: RunStepDetails; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "last_error") + @doc("If applicable, information about the last error encountered by this run step.") + lastError: RunStepError | null; + + @encodedName("application/json", "created_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this object was created.") + createdAt: utcDateTime; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "expired_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this item expired.") + expiredAt: utcDateTime | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "completed_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this completed.") + completedAt: utcDateTime | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "cancelled_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this was cancelled.") + cancelledAt: utcDateTime | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "failed_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this failed.") + failedAt: utcDateTime | null; + + ...RequiredNullableMetadata; +} + +@doc("The possible types of run steps.") +@added(ServiceApiVersions.v2024_02_15_preview) +enum RunStepType { + @doc("Represents a run step to create a message.") + messageCreation: "message_creation", + + @doc("Represents a run step that calls tools.") + toolCalls: "tool_calls", +} + +@discriminator("type") +@doc("An abstract representation of the details for a run step.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepDetails { + @doc("The object type.") + type: RunStepType; +} + +@doc("The detailed information associated with a message creation run step.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepMessageCreationDetails extends RunStepDetails { + @doc("The object type, which is always 'message_creation'.") + type: RunStepType.messageCreation; + + @encodedName("application/json", "message_creation") + @doc("Information about the message creation associated with this run step.") + messageCreation: RunStepMessageCreationReference; +} + +@doc("The detailed information associated with a run step calling tools.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepToolCallDetails extends RunStepDetails { + @doc("The object type, which is always 'tool_calls'.") + type: RunStepType.toolCalls; + + @encodedName("application/json", "tool_calls") + @doc("A list of tool call details for this run step.") + toolCalls: RunStepToolCall[]; +} + +@doc("The details of a message created as a part of a run step.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepMessageCreationReference { + @encodedName("application/json", "message_id") + @doc("The ID of the message created by this run step.") + messageId: string; +} + +@doc("Possible values for the status of a run step.") +@added(ServiceApiVersions.v2024_02_15_preview) +enum RunStepStatus { + @doc("Represents a run step still in progress.") + inProgress: "in_progress", + + @doc("Represents a run step that was cancelled.") + cancelled: "cancelled", + + @doc("Represents a run step that failed.") + failed: "failed", + + @doc("Represents a run step that successfully completed.") + completed: "completed", + + @doc("Represents a run step that expired before otherwise finishing.") + expired: "expired", +} + +@doc("Possible error code values attributable to a failed run step.") +@added(ServiceApiVersions.v2024_02_15_preview) +enum RunStepErrorCode { + @doc("Represents a server error.") + serverError: "server_error", + + @doc("Represents an error indicating configured rate limits were exceeded.") + rateLimitExceeded: "rate_limit_exceeded", +} + +@doc("The error information associated with a failed run step.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepError { + @doc("The error code for this error.") + code: RunStepErrorCode; + + @doc("The human-readable text associated with this error.") + message: string; +} diff --git a/specification/ai/OpenAI.Assistants/run_steps/routes.tsp b/specification/ai/OpenAI.Assistants/run_steps/routes.tsp new file mode 100644 index 000000000000..b23a0b2b6272 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/run_steps/routes.tsp @@ -0,0 +1,51 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; +import "../common/models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.OpenAI.Assistants; + +/** + * Gets a single run step from a thread run. + * + * @param threadId The ID of the thread that was run. + * @param runId The ID of the specific run to retrieve the step from. + * @param stepId The ID of the step to retrieve information about. + * @returns Information about the requested run step. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API name parity" +@get +@route("/threads/{threadId}/runs/{runId}/steps/{stepId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op getRunStep( + @path threadId: string, + @path runId: string, + @path stepId: string, +): RunStep; + +/** + * Gets a list of run steps from a thread run. + * + * @param threadId The ID of the thread that was run. + * @param runId The ID of the run to list steps from. + * @returns The requested list of run steps. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@route("/threads/{threadId}/runs/{runId}/steps") +@added(ServiceApiVersions.v2024_02_15_preview) +op listRunSteps( + @path threadId: string, + @path runId: string, + ...OpenAIListRequestOptions, +): OpenAIPageableListOf; diff --git a/specification/ai/OpenAI.Assistants/runs/main.tsp b/specification/ai/OpenAI.Assistants/runs/main.tsp new file mode 100644 index 000000000000..3b662be82ec5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/runs/main.tsp @@ -0,0 +1,2 @@ +import "./models.tsp"; +import "./routes.tsp"; diff --git a/specification/ai/OpenAI.Assistants/runs/models.tsp b/specification/ai/OpenAI.Assistants/runs/models.tsp new file mode 100644 index 000000000000..18ab265d1e12 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/runs/models.tsp @@ -0,0 +1,217 @@ +import "@typespec/versioning"; +import "../common/models.tsp"; +import "../threads/models.tsp"; +import "../tools/models.tsp"; + +namespace Azure.AI.OpenAI.Assistants; + +using TypeSpec.Versioning; + +@doc("Data representing a single evaluation run of an assistant thread.") +@added(ServiceApiVersions.v2024_02_15_preview) +model ThreadRun { + @doc("The identifier, which can be referenced in API endpoints.") + id: string; + + @doc("The object type, which is always 'thread.run'.") + object: "thread.run"; + + @encodedName("application/json", "thread_id") + @doc("The ID of the thread associated with this run.") + threadId: string; + + @encodedName("application/json", "assistant_id") + @doc("The ID of the assistant associated with the thread this run was performed against.") + assistantId: string; + + @doc("The status of the assistant thread run.") + status: RunStatus; + + // Internal note: API reference describes this as nullable and the spec explicitly defines it as required and + // nullable, but actual test traffic confirms that runs without tool calls do not present + // required_action on their responses. We split the difference to be optional and nullable. + // https://platform.openai.com/docs/api-reference/runs/object#runs/object-expires_at + // https://github.com/openai/openai-openapi/blob/master/openapi.yaml#L8245 + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "required_action") + @doc("The details of the action required for the assistant thread run to continue.") + requiredAction?: RequiredAction | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "last_error") + @doc("The last error, if any, encountered by this assistant thread run.") + lastError: RunError | null; + + @doc("The ID of the model to use.") + `model`: string; + + @doc("The overridden system instructions used for this assistant thread run.") + instructions: string; + + @doc("The overridden enabled tools used for this assistant thread run.") + tools: ToolDefinition[] = []; + + @encodedName("application/json", "file_ids") + @doc("A list of attached file IDs, ordered by creation date in ascending order.") + fileIds: string[] = []; + + @encodedName("application/json", "created_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this object was created.") + createdAt: utcDateTime; + + // Internal note: API reference describes this as non-nullable, but retrieveThreadRun gets a null expiresAt + // for completed runs. + // https://platform.openai.com/docs/api-reference/runs/object#runs/object-expires_at + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "expires_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this item expires.") + expiresAt: utcDateTime | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "started_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this item was started.") + startedAt: utcDateTime | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "completed_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this completed.") + completedAt: utcDateTime | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "cancelled_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this was cancelled.") + cancelledAt: utcDateTime | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "failed_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this failed.") + failedAt: utcDateTime | null; + + ...RequiredNullableMetadata; +} + +@doc("The details used when creating a new run of an assistant thread.") +@added(ServiceApiVersions.v2024_02_15_preview) +model CreateRunOptions { + @doc("The ID of the assistant that should run the thread.") + @encodedName("application/json", "assistant_id") + assistantId: string; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The overridden model name that the assistant should use to run the thread.") + `model`?: string | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The overridden system instructions that the assistant should use to run the thread.") + instructions?: string | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @encodedName("application/json", "additional_instructions") + @doc(""" + Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior + on a per-run basis without overriding other instructions. + """) + additionalInstructions?: string | null; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The overridden list of enabled tools that the assistant should use to run the thread.") + tools?: ToolDefinition[] | null; + + ...OptionalNullableMetadata; +} + +@doc("The details of an error as encountered by an assistant thread run.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunError { + @doc("The status for the error.") + code: string; + + @doc("The human-readable text associated with the error.") + message: string; +} + +@doc("Possible values for the status of an assistant thread run.") +@added(ServiceApiVersions.v2024_02_15_preview) +enum RunStatus { + @doc("Represents a run that is queued to start.") + queued: "queued", + + @doc("Represents a run that is in progress.") + inProgress: "in_progress", + + @doc("Represents a run that needs another operation, such as tool output submission, to continue.") + requiresAction: "requires_action", + + @doc("Represents a run that is in the process of cancellation.") + cancelling: "cancelling", + + @doc("Represents a run that has been cancelled.") + cancelled: "cancelled", + + @doc("Represents a run that failed.") + failed: "failed", + + @doc("Represents a run that successfully completed.") + completed: "completed", + + @doc("Represents a run that expired before it could otherwise finish.") + expired: "expired", +} + +@discriminator("type") +@doc("An abstract representation of a required action for an assistant thread run to continue.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RequiredAction { + @doc("The object type.") + type: string; +} + +@doc("The details for required tool calls that must be submitted for an assistant thread run to continue.") +@added(ServiceApiVersions.v2024_02_15_preview) +model SubmitToolOutputsAction extends RequiredAction { + @doc("The object type, which is always 'submit_tool_outputs'.") + type: "submit_tool_outputs"; + + @encodedName("application/json", "submit_tool_outputs") + @doc("The details describing tools that should be called to submit tool outputs.") + submitToolOutputs: SubmitToolOutputsDetails; +} + +@doc("The details describing tools that should be called to submit tool outputs.") +@added(ServiceApiVersions.v2024_02_15_preview) +model SubmitToolOutputsDetails { + @encodedName("application/json", "tool_calls") + @doc("The list of tool calls that must be resolved for the assistant thread run to continue.") + toolCalls: RequiredToolCall[]; +} + +@doc("The details used when creating and immediately running a new assistant thread.") +@added(ServiceApiVersions.v2024_02_15_preview) +model CreateAndRunThreadOptions { + @encodedName("application/json", "assistant_id") + @doc("The ID of the assistant for which the thread should be created.") + assistantId: string; + + @doc("The details used to create the new thread.") + thread?: AssistantThreadCreationOptions; + + @doc("The overridden model that the assistant should use to run the thread.") + @projectedName("csharp", "overrideModelName") + `model`?: string; + + @doc("The overridden system instructions the assistant should use to run the thread.") + @projectedName("csharp", "overrideInstructions") + instructions?: string; + + @doc("The overridden list of enabled tools the assistant should use to run the thread.") + @projectedName("csharp", "overrideTools") + tools?: ToolDefinition[]; + + ...OptionalNullableMetadata; +} diff --git a/specification/ai/OpenAI.Assistants/runs/routes.tsp b/specification/ai/OpenAI.Assistants/runs/routes.tsp new file mode 100644 index 000000000000..1a4f417b33db --- /dev/null +++ b/specification/ai/OpenAI.Assistants/runs/routes.tsp @@ -0,0 +1,134 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; +import "../threads/models.tsp"; +import "../runs/models.tsp"; +import "./models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.OpenAI.Assistants; + +/** + * Creates and starts a new run of the specified thread using the specified assistant. + * + * @param threadId The ID of the thread to run. + * @param createRunOptions The details for the run to create. + * + * @returns Information about the new thread run. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/threads/{threadId}/runs") +@doc("Creates a new run for an assistant thread.") +@added(ServiceApiVersions.v2024_02_15_preview) +op createRun( + @path threadId: string, + @body createRunOptions: CreateRunOptions, +): ThreadRun; + +/** + * Gets a list of runs for a specified thread. + * + * @param threadId The ID of the thread to list runs from. + * @returns The requested list of thread runs. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API responds with a container" +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@get +@route("/threads/{threadId}/runs") +@added(ServiceApiVersions.v2024_02_15_preview) +op listRuns( + @path threadId: string, + ...OpenAIListRequestOptions, +): OpenAIPageableListOf; + +/** + * Gets an existing run from an existing thread. + * + * @param threadId The ID of the thread to retrieve run information from. + * @param runId The ID of the thread to retrieve information about. + * @returns The requested information about the specified thread run. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API name parity" +@get +@route("/threads/{threadId}/runs/{runId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op getRun(@path threadId: string, @path runId: string): ThreadRun; + +/** + * Modifies an existing thread run. + * + * @param threadId The ID of the thread associated with the specified run. + * @param runId The ID of the run to modify. + * @returns Information about the modified run. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/threads/{threadId}/runs/{runId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op updateRun( + @path threadId: string, + @path runId: string, + ...OptionalNullableMetadata, +): ThreadRun; + +/** + * Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. + * + * @param threadId The ID of the thread that was run. + * @param runId The ID of the run that requires tool outputs. + * @param toolOutputs The list of tool outputs requested by tool calls from the specified run. + * @returns Updated information about the run. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/threads/{threadId}/runs/{runId}/submit_tool_outputs") +@added(ServiceApiVersions.v2024_02_15_preview) +op submitToolOutputsToRun( + @path threadId: string, + @path runId: string, + @encodedName("application/json", "tool_outputs") toolOutputs: ToolOutput[], +): ThreadRun; + +/** + * Cancels a run of an in progress thread. + * + * @param threadId The ID of the thread being run. + * @param runId The ID of the run to cancel. + * @returns Updated information about the cancelled run. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/threads/{threadId}/runs/{runId}/cancel") +@added(ServiceApiVersions.v2024_02_15_preview) +op cancelRun(@path threadId: string, @path runId: string): ThreadRun; + +/** + * Creates a new thread and immediately starts a run of that thread. + * + * @returns Information about the newly created thread. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/threads/runs") +@doc("Creates a new assistant thread and immediately starts a run using that new thread.") +@added(ServiceApiVersions.v2024_02_15_preview) +op createThreadAndRun(...CreateAndRunThreadOptions): ThreadRun; diff --git a/specification/ai/OpenAI.Assistants/threads/main.tsp b/specification/ai/OpenAI.Assistants/threads/main.tsp new file mode 100644 index 000000000000..3b662be82ec5 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/threads/main.tsp @@ -0,0 +1,2 @@ +import "./models.tsp"; +import "./routes.tsp"; diff --git a/specification/ai/OpenAI.Assistants/threads/models.tsp b/specification/ai/OpenAI.Assistants/threads/models.tsp new file mode 100644 index 000000000000..d4097d0fecb0 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/threads/models.tsp @@ -0,0 +1,43 @@ +import "@typespec/versioning"; +import "../common/models.tsp"; +import "../messages/models.tsp"; + +using TypeSpec.Versioning; + +namespace Azure.AI.OpenAI.Assistants; + +@doc("Information about a single thread associated with an assistant.") +@added(ServiceApiVersions.v2024_02_15_preview) +model AssistantThread { + @doc("The identifier, which can be referenced in API endpoints.") + id: string; + + @doc("The object type, which is always 'thread'.") + object: "thread"; + + @encodedName("application/json", "created_at") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + @doc("The Unix timestamp, in seconds, representing when this object was created.") + createdAt: utcDateTime; + + ...RequiredNullableMetadata; +} + +@doc("The details used to create a new assistant thread.") +@added(ServiceApiVersions.v2024_02_15_preview) +model AssistantThreadCreationOptions { + @doc("The initial messages to associate with the new thread.") + messages?: ThreadInitializationMessage[]; + + ...OptionalNullableMetadata; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "https://github.com/Azure/autorest.csharp/issues/4041" +@doc("The status of a thread deletion operation.") +@added(ServiceApiVersions.v2024_02_15_preview) +model ThreadDeletionStatus { + ...DeletionStatus; + + @doc("The object type, which is always 'thread.deleted'.") + object: "thread.deleted"; +} diff --git a/specification/ai/OpenAI.Assistants/threads/routes.tsp b/specification/ai/OpenAI.Assistants/threads/routes.tsp new file mode 100644 index 000000000000..6867743b97ec --- /dev/null +++ b/specification/ai/OpenAI.Assistants/threads/routes.tsp @@ -0,0 +1,71 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; +import "./models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.OpenAI.Assistants; + +/** + * Creates a new thread. Threads contain messages and can be run by assistants. + * + * @returns Information about the newly created thread. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@added(ServiceApiVersions.v2024_02_15_preview) +@route("/threads") +op createThread(...AssistantThreadCreationOptions): AssistantThread; + +// list threads? + +/** + * Gets information about an existing thread. + * + * @param threadId The ID of the thread to retrieve information about. + * @returns Information about the requested thread. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +#suppress "@azure-tools/typespec-azure-core/use-standard-names" "mirrored API name parity" +@get +@route("/threads/{threadId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op getThread(@path threadId: string): AssistantThread; + +/** + * Modifies an existing thread. + * + * @param threadId The ID of the thread to modify. + * @returns Information about the modified thread. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@post +@route("/threads/{threadId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op updateThread( + @path threadId: string, + ...OptionalNullableMetadata, +): AssistantThread; + +/** + * Deletes an existing thread. + * + * @param threadId The ID of the thread to delete. + * @returns Status information about the requested thread deletion operation. + */ +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "not yet an Azure operation" +#suppress "@azure-tools/typespec-azure-core/no-operation-id" "non-standard operations" +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "not yet versioned" +@delete +@route("/threads/{threadId}") +@added(ServiceApiVersions.v2024_02_15_preview) +op deleteThread(@path threadId: string): ThreadDeletionStatus; diff --git a/specification/ai/OpenAI.Assistants/tools/models.tsp b/specification/ai/OpenAI.Assistants/tools/models.tsp new file mode 100644 index 000000000000..250013bdf449 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/tools/models.tsp @@ -0,0 +1,232 @@ +import "@typespec/http"; +import "@typespec/versioning"; + +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.AI.OpenAI.Assistants; + +// +// Tool inputs -- definitions used before model evaluation to configure assistants, threads, and messages +// + +@doc("An abstract representation of an input tool definition that an assistant can use.") +@discriminator("type") +@added(ServiceApiVersions.v2024_02_15_preview) +model ToolDefinition { + @doc("The object type.") + type: string; +} + +@doc("The input definition information for a code interpreter tool as used to configure an assistant.") +@added(ServiceApiVersions.v2024_02_15_preview) +model CodeInterpreterToolDefinition extends ToolDefinition { + @doc("The object type, which is always 'code_interpreter'.") + type: "code_interpreter"; +} + +@doc("The input definition information for a retrieval tool as used to configure an assistant.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RetrievalToolDefinition extends ToolDefinition { + @doc("The object type, which is always 'retrieval'.") + type: "retrieval"; +} + +@doc("The input definition information for a function tool as used to configure an assistant.") +@added(ServiceApiVersions.v2024_02_15_preview) +model FunctionToolDefinition extends ToolDefinition { + @doc("The object type, which is always 'function'.") + type: "function"; + + @doc("The definition of the concrete function that the function tool should call.") + function: FunctionDefinition; +} + +// Definition details: Functions + +@doc("The input definition information for a function.") +@added(ServiceApiVersions.v2024_02_15_preview) +model FunctionDefinition { + @doc("The name of the function to be called.") + name: string; + + @doc("A description of what the function does, used by the model to choose when and how to call the function.") + description?: string; + + #suppress "@azure-tools/typespec-azure-core/no-unknown" "External API shape takes an arbitrary json" + @doc("The parameters the functions accepts, described as a JSON Schema object.") + parameters: unknown; +} + +// +// Required tool calls -- provided on a run and represent tools that need outputs submitted for the run to continue +// + +@discriminator("type") +@doc(""" +An abstract representation a a tool invocation needed by the model to continue a run. +""") +@added(ServiceApiVersions.v2024_02_15_preview) +model RequiredToolCall { + @doc("The object type for the required tool call.") + type: string; + + @doc("The ID of the tool call. This ID must be referenced when submitting tool outputs.") + id: string; +} + +@added(ServiceApiVersions.v2024_02_15_preview) +@doc("A representation of a requested call to a function tool, needed by the model to continue evaluation of a run.") +model RequiredFunctionToolCall extends RequiredToolCall { + @doc("The object type of the required tool call. Always 'function' for function tools.") + type: "function"; + + @doc("Detailed information about the function to be executed by the tool that includes name and arguments.") + function: RequiredFunctionToolCallDetails; +} + +@added(ServiceApiVersions.v2024_02_15_preview) +@doc("The detailed information for a function invocation, as provided by a required action invoking a function tool, that includes the name of and arguments to the function.") +model RequiredFunctionToolCallDetails { + @doc("The name of the function.") + name: string; + + @doc("The arguments to use when invoking the named function, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation.") + arguments: string; +} + +// +// Tool calls -- present in run steps and provide information about tool execution +// + +@discriminator("type") +@doc("An abstract representation of a detailed tool call as recorded within a run step for an existing run.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepToolCall { + @doc("The object type.") + type: string; + + @doc("The ID of the tool call. This ID must be referenced when you submit tool outputs.") + id: string; +} + +@doc(""" +A record of a call to a code interpreter tool, issued by the model in evaluation of a defined tool, that +represents inputs and outputs consumed and emitted by the code interpreter. +""") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepCodeInterpreterToolCall extends RunStepToolCall { + @doc("The object type, which is always 'code_interpreter'.") + type: "code_interpreter"; + + @encodedName("application/json", "code_interpreter") + @doc("The details of the tool call to the code interpreter tool.") + codeInterpreter: RunStepCodeInterpreterToolCallDetails; +} + +@doc(""" +A record of a call to a retrieval tool, issued by the model in evaluation of a defined tool, that represents +executed retrieval actions. +""") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepRetrievalToolCall extends RunStepToolCall { + @doc("The object type, which is always 'retrieval'.") + type: "retrieval"; + + @doc("The key/value pairs produced by the retrieval tool.") + retrieval: Record; +} + +@doc(""" +A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs +and output consumed and emitted by the specified function. +""") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepFunctionToolCall extends RunStepToolCall { + @doc("The object type, which is always 'function'.") + type: "function"; + + @doc("The detailed information about the function called by the model.") + function: RunStepFunctionToolCallDetails; +} + +// Call details: Code Interpreter + +@doc("The detailed information about a code interpreter invocation by the model.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepCodeInterpreterToolCallDetails { + @doc("The input provided by the model to the code interpreter tool.") + input: string; + + @doc("The outputs produced by the code interpreter tool back to the model in response to the tool call.") + outputs: RunStepCodeInterpreterToolCallOutput[]; +} + +@discriminator("type") +@doc("An abstract representation of an emitted output from a code interpreter tool.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepCodeInterpreterToolCallOutput { + @doc("The object type.") + type: string; +} + +@doc("A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepCodeInterpreterLogOutput + extends RunStepCodeInterpreterToolCallOutput { + @doc("The object type, which is always 'logs'.") + type: "logs"; + + @doc("The serialized log output emitted by the code interpreter.") + logs: string; +} + +@doc("A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepCodeInterpreterImageOutput + extends RunStepCodeInterpreterToolCallOutput { + @doc("The object type, which is always 'image'.") + type: "image"; + + @doc("Referential information for the image associated with this output.") + image: RunStepCodeInterpreterImageReference; +} + +@doc("An image reference emitted by a code interpreter tool in response to a tool call by the model.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepCodeInterpreterImageReference { + @encodedName("application/json", "file_id") + @doc("The ID of the file associated with this image.") + fileId: string; +} + +// Call details: Functions + +@doc("The detailed information about the function called by the model.") +@added(ServiceApiVersions.v2024_02_15_preview) +model RunStepFunctionToolCallDetails { + @doc("The name of the function.") + name: string; + + @doc("The arguments that the model requires are provided to the named function.") + arguments: string; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality" + @doc("The output of the function, only populated for function calls that have already have had their outputs submitted.") + output: string | null; +} + +// +// Tool outputs -- structured data that provides requested information from tools back to the model +// + +@doc("The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.") +@added(ServiceApiVersions.v2024_02_15_preview) +model ToolOutput { + @doc("The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.") + @encodedName("application/json", "tool_call_id") + toolCallId?: string; + + @doc("The output from the tool to be submitted.") + output?: string; +} diff --git a/specification/ai/OpenAI.Assistants/tspconfig.yaml b/specification/ai/OpenAI.Assistants/tspconfig.yaml new file mode 100644 index 000000000000..c1fa66723956 --- /dev/null +++ b/specification/ai/OpenAI.Assistants/tspconfig.yaml @@ -0,0 +1,44 @@ +parameters: + "service-dir": + default: "sdk/openai/assistants" + "dependencies": + default: "" +emit: + - "@azure-tools/typespec-autorest" + - "@typespec/openapi3" +# - "@azure-tools/typespec-java" +# - "@azure-tools/typespec-csharp" +linter: + extends: + - "@azure-tools/typespec-azure-core/all" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" + emitter-output-dir: "{project-root}/../" + output-file: "data-plane/OpenAI.Assistants/OpenApiV2/{version-status}/{version}/assistants_generated.json" + examples-directory: "{project-root}/examples" + omit-unreachable-types: true + "@typespec/openapi3": + emitter-output-dir: "{project-root}/../" + output-file: "data-plane/OpenAI.Assistants/OpenApiV3/{version}/assistants_generated.yaml" + "@azure-tools/typespec-csharp": + package-dir: "Azure.AI.OpenAI.Assistants" + namespace: "Azure.AI.OpenAI.Assistants" + clear-output-folder: true + model-namespace: false + generate-protocol-methods: false + "@azure-tools/typespec-java": + package-dir: "azure-ai-openai-assistants" + namespace: "com.azure.ai.openai.assistants" + partial-update: true + enable-sync-stack: true + generate-tests: false + custom-types-subpackage: "implementation.models" + custom-types: "FileListResponse,OpenAIPageableListOfAssistant,OpenAIPageableListOfAssistantFile,OpenAIPageableListOfMessageFile,OpenAIPageableListOfRunStep,OpenAIPageableListOfThreadMessage,OpenAIPageableListOfThreadRun" + "@azure-tools/typespec-ts": + package-dir: "openai" + generateMetadata: false + generateTest: false + isModularLibrary: true + packageDetails: + name: "@azure/openai-assistants" diff --git a/specification/ai/data-plane/DocumentIntelligence/preview/2023-10-31-preview/DocumentIntelligence.json b/specification/ai/data-plane/DocumentIntelligence/preview/2023-10-31-preview/DocumentIntelligence.json index 01140fbdffaa..5c679e964d11 100644 --- a/specification/ai/data-plane/DocumentIntelligence/preview/2023-10-31-preview/DocumentIntelligence.json +++ b/specification/ai/data-plane/DocumentIntelligence/preview/2023-10-31-preview/DocumentIntelligence.json @@ -3136,9 +3136,47 @@ "description": "An object representing the location and content of a table cell.", "properties": { "kind": { - "$ref": "#/definitions/DocumentTableCellKind", + "type": "string", "description": "Table cell kind.", - "default": "content" + "default": "content", + "enum": [ + "content", + "rowHeader", + "columnHeader", + "stubHead", + "description" + ], + "x-ms-enum": { + "name": "DocumentTableCellKind", + "modelAsString": true, + "values": [ + { + "name": "content", + "value": "content", + "description": "Contains the main content/data." + }, + { + "name": "rowHeader", + "value": "rowHeader", + "description": "Describes the content of the row." + }, + { + "name": "columnHeader", + "value": "columnHeader", + "description": "Describes the content of the column." + }, + { + "name": "stubHead", + "value": "stubHead", + "description": "Describes the row headers, usually located at the top left corner of a table." + }, + { + "name": "description", + "value": "description", + "description": "Describes the content in (parts of) the table." + } + ] + } }, "rowIndex": { "type": "integer", diff --git a/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulOncoPhenotypeRequest.json b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulOncoPhenotypeRequest.json new file mode 100644 index 000000000000..08280a8b2e72 --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulOncoPhenotypeRequest.json @@ -0,0 +1,64 @@ +{ + "operationId": "OncoPhenotype_CreateJob", + "title": "Creates an Onco Phenotype job with the given request body.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "body": { + "patients": [ + { + "id": "Patient ID Example 1", + "info": { + "sex": "female", + "birthDate": "1975-09-27" + }, + "patientDocuments": [ + { + "type": "note", + "clinicalType": "historyAndPhysical", + "id": "1", + "language": "en", + "createdDateTime": "2021-10-26T16:54:44.739Z", + "content": { + "sourceType": "inline", + "value": "Sample note 1" + } + }, + { + "type": "note", + "clinicalType": "imaging", + "id": "2", + "language": "en", + "createdDateTime": "2020-11-26T16:39:44.739Z", + "content": { + "sourceType": "inline", + "value": "Sample note 2" + } + } + ] + } + ], + "configuration": { + "verbose": true, + "includeEvidence": true, + "inferenceTypes": [ + "histology", + "clinicalStageT" + ], + "checkForCancerCase": false + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/health-insights/onco-phenotype/jobs/{id}?api-version=2023-09-01-preview", + "Retry-After": "1" + }, + "body": { + "status": "notStarted", + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulOncoPhenotypeResponse.json b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulOncoPhenotypeResponse.json new file mode 100644 index 000000000000..5695c10cdfc4 --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulOncoPhenotypeResponse.json @@ -0,0 +1,65 @@ +{ + "operationId": "OncoPhenotype_GetJob", + "title": "Gets the status and details of the Onco Phenotype job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + "responses": { + "200": { + "body": { + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "createdDateTime": "2021-11-26T17:22:27.386Z", + "expirationDateTime": "2021-11-26T17:22:27.386Z", + "lastUpdateDateTime": "2021-11-26T17:22:27.386Z", + "status": "succeeded", + "result": { + "patientResults": [ + { + "patientId": "Patient ID Example 1", + "inferences": [ + { + "type": "histology", + "value": "8561", + "description": "Adenolymphoma", + "confidenceScore": 0.85, + "evidence": [ + { + "patientDataEvidence": { + "id": "1", + "text": "string", + "offset": 70, + "length": 135 + }, + "importance": 1 + } + ] + }, + { + "type": "clinicalStageT", + "value": "T3", + "description": "Locally advanced disease at risk for micrometastases", + "confidenceScore": 0.88, + "evidence": [ + { + "patientDataEvidence": { + "id": "2", + "text": "string", + "offset": 12, + "length": 9 + }, + "importance": 1 + } + ], + "caseId": "1" + } + ] + } + ], + "modelVersion": "2021-11-26" + } + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulPatientTimelineRequest.json b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulPatientTimelineRequest.json new file mode 100644 index 000000000000..50500c8cea6e --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulPatientTimelineRequest.json @@ -0,0 +1,23 @@ +{ + "operationId": "PatientTimeline_CreateJob", + "title": "Creates a Patient Timeline job with the given request body.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "body": { + "patients": [] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/health-insights/patient-timeline/jobs/{id}?api-version=2023-09-01-preview", + "Retry-After": "1" + }, + "body": { + "status": "notStarted", + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulPatientTimelineResponse.json b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulPatientTimelineResponse.json new file mode 100644 index 000000000000..a73eff7a3e34 --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulPatientTimelineResponse.json @@ -0,0 +1,24 @@ +{ + "operationId": "PatientTimeline_GetJob", + "title": "Gets the status and details of the Patient Timeline job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754" + }, + "responses": { + "200": { + "body": { + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754", + "createdDateTime": "2021-11-28T09:13:11.046Z", + "expirationDateTime": "2021-11-28T09:13:11.046Z", + "lastUpdateDateTime": "2021-11-28T09:13:11.046Z", + "status": "succeeded", + "result": { + "patientResults": [], + "modelVersion": "2021-10-28" + } + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulRadiologyInsightsRequest.json b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulRadiologyInsightsRequest.json new file mode 100644 index 000000000000..6041b94cdfcb --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulRadiologyInsightsRequest.json @@ -0,0 +1,121 @@ +{ + "operationId": "RadiologyInsights_CreateJob", + "title": "Creates a Radiology Insights job with the given request body.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "body": { + "configuration": { + "inferenceOptions": { + "followupRecommendationOptions": { + "includeRecommendationsWithNoSpecifiedModality": false, + "includeRecommendationsInReferences": false, + "provideFocusedSentenceEvidence": false + }, + "findingOptions": { + "provideFocusedSentenceEvidence": false + } + }, + "inferenceTypes": [ + "finding", + "ageMismatch", + "lateralityDiscrepancy", + "sexMismatch", + "completeOrderDiscrepancy", + "limitedOrderDiscrepancy", + "criticalResult", + "criticalRecommendation", + "followupRecommendation", + "followupCommunication", + "radiologyProcedure" + ], + "locale": "en-US", + "verbose": false, + "includeEvidence": true + }, + "patients": [ + { + "id": "sample id 1", + "info": { + "sex": "male", + "clinicalInfo": [ + { + "resourceType": "Observation", + "status": "unknown", + "code": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0018802", + "display": "MalignantNeoplasms" + } + ] + }, + "valueBoolean": "true" + } + ] + }, + "encounters": [ + { + "id": "encounterid1", + "period": { + "start": "2023-12-21T00:00:00", + "end": "2023-12-21T00:00:00" + }, + "class": "inpatient" + } + ], + "patientDocuments": [ + { + "type": "note", + "clinicalType": "radiologyReport", + "id": "docid1", + "language": "en", + "authors": [ + { + "id": "authorid1", + "fullName": "authorname1" + } + ], + "specialtyType": "radiology", + "createdDateTime": "2023-12-21T00:00:00", + "administrativeMetadata": { + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "system": "Http://hl7.org/fhir/ValueSet/cpt-all", + "code": "111111", + "display": "CT ABD/PELVIS" + } + ] + }, + "description": "CT ABD/PELVIS" + } + ], + "encounterId": "encounterid1" + }, + "content": { + "sourceType": "inline", + "value": "[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\n[**Hospital 4**] MEDICAL CONDITION:\r\n52 year old man with urosepsis, s/p nephrostogram on [**4-12**], today with acute\r\nSOB, fever, rigors.\r\nREASON FOR THIS EXAMINATION:\r\n? PE, evidence of pneumonia\r\nNo contraindications for IV contrast\r\n______________________________________________________________________________\r\nFINAL REPORT\r\nINDICATION: History of urosepsis status post nephrostogram on [**4-12**], today\r\nwith acute shortness of breath, fevers, and rigors. Also reported hematocrit\r\ndrop. Evaluate for pulmonary embolism or hematoma.\r\nCOMPARISON: Non-contrast CT of the abdomen and pelvis dated [**2143-4-11**].\r\nTECHNIQUE: MDCT acquired images of the chest, abdomen, and pelvis were\r\nobtained before and after the administration of IV contrast. A true CT\r\nangiogram could not be performed due to lack of appropriate intravenous\r\naccess.\r\nCT OF THE CHEST WITHOUT AND WITH IV CONTRAST: Evaluation of the pulmonary\r\narteries is limited with no large central pulmonary embolism seen. Evaluation\r\nof the segmental and subsegmental branches is limited. There is a central\r\nvenous catheter that terminates in the right atrium. There are numerous small\r\nmesenteric and axillary lymph nodes that do not meet CT criteria for\r\npathologic enlargement. There are coronary artery calcifications. There are\r\nbilateral small layering pleural effusions with associated compressive\r\natelectasis. The images of the lungs are limited due to motion. There\r\nappears to be a patchy, predominantly ground-glass opacity in both lower\r\nlobes, left worse than right. The aorta appears intact. There is debris in\r\nthe trachea.\r\nCT OF THE ABDOMEN WITHOUT AND WITH IV CONTRAST: There is high-density\r\nmaterial tracking along the course of a dilated left ureter consistent with\r\nhemorrhage that is new compared to the previous study. New stranding in the\r\nleft retroperitoneum is also present consistent with retroperitoneal\r\nhemorrhage. Perinephric stranding is present, as was seen on the previous\r\nstudy. The degree of dilatation of the left ureter is unchanged. Several\r\nfoci of air outside of the collecting system are present, presumably\r\npostprocedural in nature. Contrast-enhanced images show abnormal perfusion of\r\nthe left kidney with a striated appearance, most severe at the upper pole with\r\nperipheral wedge-shaped hypoenhancing areas also present on top of the areas\r\nof reduced perfusion. No active extravasation of contrast is seen. The right\r\nkidney is normal. The liver, spleen, and adrenal glands are unremarkable.\r\nPancreas is unremarkable with slightly prominent distal common bile duct\r\nmeasuring up to 8-9 mm. There is a small cystic lesion measuring 5 mm at the\r\nhead of the pancreas (series 10, image 143). Small and large bowel are\r\n(Over)\r\n[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\nFINAL REPORT\r\n(Cont)\r\ngrossly unremarkable. The aorta, celiac artery, superior mesenteric artery,\r\ninferior mesenteric artery, and renal arteries appear patent.\r\nCT OF THE PELVIS WITHOUT AND WITH IV CONTRAST: The prostate gland is\r\nenlarged. Thickening of the bladder wall is again demonstrated. Several foci\r\nof air within the bladder are presumably secondary to the Foley catheter. The\r\nrectum and sigmoid colon are unremarkable.\r\nBONE WINDOWS: There are degenerative changes with no suspicious lytic or\r\nsclerotic lesions.\r\nIMPRESSION:\r\n1. New high-density material surrounding the left ureter and tracking within\r\nthe retroperitoneum consistent with hemorrhage.\r\n2. Abnormal perfusion of the left kidney, most severe at the upper pole.\r\nFindings are consistent with pyelonephritis. Edema and abnormal perfusion at\r\nthe upper pole and interpolar region medially with multiple peripheral\r\nhypoenhancing wedge- shaped regions likely represent ischemia and a component\r\nof infarction.\r\n3. Limited examination for pulmonary embolism due to suboptimal contrast\r\nbolus with no large central embolus seen. Evaluation of distal segmental and\r\nsubsegmental branches is limited.\r\n4. Small bilateral layering pleural effusions with associated compressive\r\natelectasis. Patchy predominantly ground-glass opacities in both lower lobes,\r\nleft worse than right could represent pneumonia or pneumonitis.\r\n5. 5mm cystic lesion in the head of the pancreas. Recommend 1 year follow up.\r\nThe above was discussed with Dr. [**First Name8 (NamePattern2) 951**] [**Last Name (NamePattern1) 1238**] at approximately 6:30 p.m. on\r\n[**2143-4-13**].\r\n" + } + } + ] + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2023-09-01-preview", + "Retry-After": "1" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulRadiologyInsightsResponse.json b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulRadiologyInsightsResponse.json new file mode 100644 index 000000000000..6167030c095f --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulRadiologyInsightsResponse.json @@ -0,0 +1,33451 @@ +{ + "operationId": "RadiologyInsights_GetJob", + "title": "Gets the status and details of the Radiology Insights job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + }, + "responses": { + "200": { + "body": { + "result": { + "patientResults": [ + { + "patientId": "sample id 1", + "inferences": [ + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6839", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246501002", + "display": "TECHNIQUE (ATTRIBUTE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4466 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4508 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6840", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246501002", + "display": "TECHNIQUE (ATTRIBUTE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4572 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4586 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4621 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4633 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6856", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6857", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6858", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91302008", + "display": "SEPSIS (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "46241-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "HOSPITAL ADMISSION DIAGNOSIS - REPORTED" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6859", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 457 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 457 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6860", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for exam" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6861", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for exam" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6862", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6863", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6864", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35566002", + "display": "HEMATOMA (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6865", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "81040000", + "display": "PULMONARY ARTERY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID974", + "display": "PULMONARY ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28586", + "display": "SET OF PULMONARY ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1301 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1307 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "large;;central" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1301 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1307 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6866", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41699000", + "display": "EFFUSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "compressive;;atelectasis" + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1668 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "27123005", + "display": "BILIARY SLUDGE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1668 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6867", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46621007", + "display": "ATELECTASIS (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71173004", + "display": "COMPRESSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6868", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + }, + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + }, + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6869", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6870", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6871", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6872", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91302008", + "display": "SEPSIS (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "46241-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "HOSPITAL ADMISSION DIAGNOSIS - REPORTED" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6874", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6875", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52674009", + "display": "ISCHEMIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6876", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55641003", + "display": "INFARCT (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6877", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4529 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "bolus" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4529 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6878", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41699000", + "display": "EFFUSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "compressive;;atelectasis" + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4647 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "27123005", + "display": "BILIARY SLUDGE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4647 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6879", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46621007", + "display": "ATELECTASIS (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71173004", + "display": "COMPRESSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6882", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "390870001", + "display": "SHORT OF BREATH DRESSING/UNDRESSING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6883", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "386661006", + "display": "FEVER (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6884", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43724002", + "display": "CHILL (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "16046003", + "display": "MUSCLE RIGIDITY (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6885", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "390870001", + "display": "SHORT OF BREATH DRESSING/UNDRESSING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6886", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "386661006", + "display": "FEVER (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6887", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43724002", + "display": "CHILL (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "16046003", + "display": "MUSCLE RIGIDITY (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6889", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "18115005", + "display": "PATHOLOGIC CALCIFICATION, CALCIFIED STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41801008", + "display": "CORONARY ARTERY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28727", + "display": "SET OF CORONARY ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID35862", + "display": "CORONARY ARTERY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6890", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "128305008", + "display": "ABNORMALLY OPAQUE STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1819 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "patchy" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1819 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6891", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "257159000", + "display": "DEBRIS (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "955009", + "display": "BRONCHIAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1247", + "display": "TRACHEA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6892", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2040 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2040 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6893", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "25322007", + "display": "DILATATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6894", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "118247008", + "display": "RADIOLOGIC FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6895", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "118247008", + "display": "RADIOLOGIC FINDING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2278 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6896", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "25322007", + "display": "DILATATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2396 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "58158008", + "display": "STABLE (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2396 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6897", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2417 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2422 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15158005", + "display": "AIR (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID223", + "display": "RENAL COLLECTING SYSTEM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2429 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "outside" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2417 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2422 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2429 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6898", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29663", + "display": "LEFT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2616 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272141005", + "display": "SEVERITIES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24484000", + "display": "SEVERE (SEVERITY MODIFIER) (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2647 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2658 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "peripheral;;wedge-shaped" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2616 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2630 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2636 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2647 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2658 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2671 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2675 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2685 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6899", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2736 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260400001", + "display": "REDUCED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "reduced" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2736 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6900", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2772 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2775 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "76676007", + "display": "EXTRAVASATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2751 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "active" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2751 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2772 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2775 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6901", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "367643001", + "display": "CYST (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID171", + "display": "HEAD OF PANCREAS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2991 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3021 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3023 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "value": 5.0, + "unit": "MILLIMETER" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2991 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3021 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3023 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6902", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3715 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3718 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89977008", + "display": "INCREASED THICKNESS (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89837001", + "display": "URINARY BLADDER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30135", + "display": "WALL OF URINARY BLADDER" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3715 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3718 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6903", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15158005", + "display": "AIR (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89837001", + "display": "URINARY BLADDER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID237", + "display": "URINARY BLADDER" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6904", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362975008", + "display": "DEGENERATIVE DISORDER (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272673000", + "display": "BONE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28569", + "display": "SET OF BONE ORGANS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13197", + "display": "BONE ORGAN" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6905", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43846000", + "display": "SCLEROSIS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272673000", + "display": "BONE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28569", + "display": "SET OF BONE ORGANS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13197", + "display": "BONE ORGAN" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3951 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3962 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "suspicious;;lytic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3951 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3962 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6907", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "267038008", + "display": "EDEMA (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45851105", + "display": "REGION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45851105", + "display": "REGION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4317 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6908", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4347 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "peripheral" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4347 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4359 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4363 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4373 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4378 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4380 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4387 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6909", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4543 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4549 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "large;;central" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4543 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4549 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6910", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "128305008", + "display": "ABNORMALLY OPAQUE STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4732 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "Patchy" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4732 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6911", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "367643001", + "display": "CYST (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID171", + "display": "HEAD OF PANCREAS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4867 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4868 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "value": 5.0, + "unit": "MILLIMETER" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4867 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4868 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6912", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "164836004", + "display": "MUSCULOSKELETAL MOVEMENT (OBSERVABLE ENTITY)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6913", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID223", + "display": "RENAL COLLECTING SYSTEM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2487 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "postprocedural" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2487 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6914", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29663", + "display": "LEFT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2590 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2599 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6915", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "4657009", + "display": "PROMINENT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "28273000", + "display": "BILE DUCT STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID199", + "display": "COMMON BILE DUCT" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2911 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "4657009", + "display": "PROMINENT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2965 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2971 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2975 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "comparator": "<=" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2911 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2930 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2965 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2971 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2975 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6916", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3689 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260376009", + "display": "ENLARGED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41216001", + "display": "PROSTATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID343", + "display": "PROSTATE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3689 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6917", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "397685007", + "display": "FINDING RELATED TO FOCUSING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6921", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281157001", + "display": "SYSTEMIC VASCULAR STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID480", + "display": "AORTA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6922", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29662", + "display": "RIGHT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6923", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23451007", + "display": "ADRENAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "10200004", + "display": "LIVER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "78961009", + "display": "SPLENIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28752", + "display": "SET OF ADRENAL GLANDS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID88", + "display": "ADRENAL GLAND" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID58", + "display": "LIVER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID86", + "display": "SPLEEN" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6924", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID170", + "display": "PANCREAS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6925", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281471001", + "display": "STRUCTURE OF ABDOMINAL BLOOD VESSEL (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "244261004", + "display": "ABDOMINAL VISCERAL ARTERY (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "56400007", + "display": "STRUCTURE OF RENAL VEIN (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281157001", + "display": "SYSTEMIC VASCULAR STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID906", + "display": "CELIAC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID927", + "display": "SUPERIOR MESENTERIC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID939", + "display": "INFERIOR MESENTERIC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID936", + "display": "RENAL ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID49729", + "display": "SET OF RENAL ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID480", + "display": "AORTA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID50393", + "display": "SET OF ABDOMINAL ARTERIES" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "final assessment" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6926", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71854001", + "display": "COLON STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "34402009", + "display": "RECTUM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID162", + "display": "SIGMOID COLON" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID163", + "display": "RECTUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6930", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6933", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6936", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "30746006", + "display": "LYMPHADENOPATHY (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15425007", + "display": "PERITONEUM (SEROUS MEMBRANE) STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID33180", + "display": "MESENTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small;;pathologic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6938", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "30746006", + "display": "LYMPHADENOPATHY (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "47109002", + "display": "STRUCTURE OF LYMPH NODE OF THORAX (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28849", + "display": "AXILLARY LYMPH NODE GROUP" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1517", + "display": "AXILLARY LYMPH NODE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small;;pathologic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6940", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6943", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6946", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6948", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6950", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6952", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "followupCommunication", + "dateTime": [ + "2023-12-21T18:30:00" + ], + "recipient": [ + "doctor" + ], + "wasAcknowledged": true, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4957 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4972 + }, + { + "url": "length", + "valueInteger": 76 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 5066 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 5080 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "RETROPERITONEAL HEMORRHAGE", + "finding": { + "resourceType": "Observation", + "id": "6869", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "RETROPERITONEAL HEMORRHAGE", + "finding": { + "resourceType": "Observation", + "id": "6933", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "PNEUMONIA", + "finding": { + "resourceType": "Observation", + "id": "6948", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "procedureCodes": [ + { + "coding": [ + { + "system": "http://loinc.org", + "code": "44115-4", + "display": "CT ABDOMEN AND PELVIS" + } + ] + } + ], + "imagingProcedures": [ + { + "modality": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "77477000", + "display": "COMPUTERIZED AXIAL TOMOGRAPHY (PROCEDURE)" + } + ] + }, + "anatomy": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "113345001", + "display": "ABDOMINAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "modality": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "77477000", + "display": "COMPUTERIZED AXIAL TOMOGRAPHY (PROCEDURE)" + } + ] + }, + "anatomy": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "12921003", + "display": "PELVIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + } + ], + "orderedProcedure": { + "code": { + "coding": [ + { + "code": "111111" + } + ] + }, + "description": "CT ABD/PELVIS." + }, + "kind": "radiologyProcedure" + } + ] + } + ], + "modelVersion": "2024-01-19-preview" + }, + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12", + "createdDateTime": "2024-01-29T19:50:52Z", + "expirationDateTime": "2024-01-30T19:50:52Z", + "lastUpdateDateTime": "2024-01-29T19:51:12Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulTrialMatcherRequest.json b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulTrialMatcherRequest.json new file mode 100644 index 000000000000..680e2d698c5a --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulTrialMatcherRequest.json @@ -0,0 +1,2996 @@ +{ + "operationId": "TrialMatcher_CreateJob", + "title": "Creates a Trial Matcher job with the given request body.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "body": { + "patients": [ + { + "id": "Patient ID Example 2", + "info": { + "sex": "female", + "birthDate": "1976-09-10", + "clinicalInfo": [ + { + "resourceType": "Condition", + "code": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0041296", + "display": "Tuberculosis" + } + ] + } + }, + { + "code": { + "coding": [ + { + "code": "C0006826", + "display": "MalignantNeoplasms", + "system": "http://www.nlm.nih.gov/research/umls" + } + ] + }, + "resourceType": "Observation", + "status": "unknown", + "valueBoolean": true + }, + { + "code": { + "coding": [ + { + "code": "C0018802", + "display": "MalignantNeoplasms", + "system": "http://www.nlm.nih.gov/research/umls" + } + ] + }, + "resourceType": "Observation", + "status": "unknown", + "valueBoolean": true + } + ] + } + } + ], + "configuration": { + "verbose": true, + "includeEvidence": true, + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", + "contained": [ + { + "resourceType": "PlanDefinition", + "id": "1b5bc5d5-9413-43f7-9da6-70db2606b7cd", + "name": "Rilpivirine", + "title": "Rilpivirine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Rilpivirine", + "description": "Patients will receive rilpivirine tablet 25 milligram or adjusted dose orally once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "30f45f8a-a0f5-4eed-a5e1-4819137c10b2", + "name": "Zidovudine", + "title": "Zidovudine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Zidovudine", + "description": "Type=exact, form= appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "8958e19c-17db-4152-874d-cf68c3918769", + "name": "Abacavir", + "title": "Abacavir", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Abacavir", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "bef1c7b6-1e1a-4fb4-8bcd-b9d965dd09e6", + "name": "Tenofovir disoproxil fumarate", + "title": "Tenofovir disoproxil fumarate", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Tenofovir disoproxil fumarate", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "ec554338-0167-4034-98dd-ee1cd5860430", + "name": "Lamivudine", + "title": "Lamivudine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Lamivudine", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "8ddc695e-efab-441e-bd49-c1decfdb80bf", + "name": "Emtricitabine", + "title": "Emtricitabine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Emtricitabine", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "Group", + "id": "73e459c6-9b92-479d-b122-0712d18a9131", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0723712", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "220281", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000046327", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "7381", + "display": "therapeutic" + } + ], + "text": "therapeutic" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0086413", + "display": "HIV vaccine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C1325", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "347399", + "display": "HIV vaccine" + }, + { + "system": "http://hl7.org/fhir/sid/cvx", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v2.5", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v3.0", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D016915", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000015914", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "3059-5000", + "display": "HIV vaccine" + }, + { + "system": "http://loinc.org", + "code": "LP183501-8", + "display": "HIV vaccine" + } + ], + "text": "HIV vaccine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "127161fc-b30f-4efc-ae14-2d064dc6084b", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#73e459c6-9b92-479d-b122-0712d18a9131", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationClass" + } + ], + "text": "HIV drug", + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "somecode", + "display": "somecode" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "c26ff014-3da3-419b-9338-6e4b4d49031e", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D019829", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00238", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000712787", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "99DK7FVK1H", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "99DK7FVK1H", + "display": "nevirapine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4020991", + "display": "nevirapine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C29277", + "display": "nevirapine" + }, + { + "system": "http://snomed.info/sctv", + "code": "108704001", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "75157", + "display": "nevirapine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG01", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "006062", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "eiK..", + "display": "nevirapine" + }, + { + "system": "http://loinc.org", + "code": "LP21317-0", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "175112", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2010013984", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000016392", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2030", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "4007-0088", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "53654", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m56485", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000656", + "display": "nevirapine" + } + ], + "text": "nevirapine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0043474", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040121", + "display": "zidovudine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C947", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015215", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2109-4800", + "display": "zidovudine" + }, + { + "system": "http://snomed.info/sctv", + "code": "387151007", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "05223", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "41905", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00495", + "display": "zidovudine" + }, + { + "system": "http://snomed.info/sct", + "code": "C-55B60", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "ei5..", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000013273", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044478", + "display": "zidovudine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4019502", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "11413", + "display": "zidovudine" + }, + { + "system": "http://loinc.org", + "code": "LP16744-2", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0602670", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m89510", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "4B9XT59T7S", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2650", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C947", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "4B9XT59T7S", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00034", + "display": "zidovudine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AF01", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000671", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "003019", + "display": "zidovudine" + } + ], + "text": "zidovudine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "9ab418f5-9bf1-4bb7-a55f-0eed1244addb", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#c26ff014-3da3-419b-9338-6e4b4d49031e", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0282474", + "display": "mother-to-child transmission" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D018445", + "display": "mother-to-child transmission" + } + ], + "text": "mother-to-child transmission" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "c31f130b-c0e7-411a-a32b-57f07ea62559", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#127161fc-b30f-4efc-ae14-2d064dc6084b", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#9ab418f5-9bf1-4bb7-a55f-0eed1244addb", + "type": "Group" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "1d943af4-3b3e-4363-9e82-bc0e59b8c3e1", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D019829", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00238", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000712787", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "99DK7FVK1H", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "99DK7FVK1H", + "display": "NVP" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4020991", + "display": "NVP" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C29277", + "display": "NVP" + }, + { + "system": "http://snomed.info/sctv", + "code": "108704001", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "75157", + "display": "NVP" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG01", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "006062", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "eiK..", + "display": "NVP" + }, + { + "system": "http://loinc.org", + "code": "LP21317-0", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "175112", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2010013984", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000016392", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2030", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "4007-0088", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "53654", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m56485", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000656", + "display": "NVP" + } + ], + "text": "NVP" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0043474", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040121", + "display": "AZT" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C947", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015215", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2109-4800", + "display": "AZT" + }, + { + "system": "http://snomed.info/sctv", + "code": "387151007", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "05223", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "41905", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00495", + "display": "AZT" + }, + { + "system": "http://snomed.info/sct", + "code": "C-55B60", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "ei5..", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000013273", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044478", + "display": "AZT" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4019502", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "11413", + "display": "AZT" + }, + { + "system": "http://loinc.org", + "code": "LP16744-2", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0602670", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m89510", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "4B9XT59T7S", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2650", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C947", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "4B9XT59T7S", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00034", + "display": "AZT" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AF01", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000671", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "003019", + "display": "AZT" + } + ], + "text": "AZT" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "8eddc9da-cdfc-43d9-a9fc-5306d66362f3", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#1d943af4-3b3e-4363-9e82-bc0e59b8c3e1", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0282474", + "display": "mother-to-child transmission" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D018445", + "display": "mother-to-child transmission" + } + ], + "text": "mother-to-child transmission" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "4ee79ae8-bf19-4474-a72e-3616ac0a9fdf", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationClass" + } + ], + "text": "ARVs" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#8eddc9da-cdfc-43d9-a9fc-5306d66362f3", + "type": "Group" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "583a9867-c95e-4225-bd19-47c324e26c0f", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ExaminationName" + } + ], + "text": "Plasma viral load" + }, + "valueQuantity": { + "value": 100000, + "comparator": ">" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "35d36257-564c-48e0-9c65-b2551870b0bb", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "with NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D005838", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "20920", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000005452", + "display": "genotypic" + }, + { + "system": "http://loinc.org", + "code": "LP345004-8", + "display": "genotypic" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C16631", + "display": "genotypic" + }, + { + "system": "http://snomed.info/sctv", + "code": "145681002", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000660739", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000002877", + "display": "genotypic" + }, + { + "system": "http://snomed.info/sct", + "code": "F-E0280", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1258-5784", + "display": "genotypic" + } + ], + "text": "genotypic" + }, + "valueCodeableConcept": { + "text": "value:" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "text": "non-nucleoside reverse transcriptase inhibitor resistance" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "bdcbe31b-c0f7-4205-9b75-34a8418cfdb2", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0041296", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "41", + "display": "tuberculosis" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31051", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000012630", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sctv", + "code": "56717001", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A1...", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D014376", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "INFECT", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000513048", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU076452", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021870", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "0923", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-14800", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "A15-A19", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00198", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/dxp", + "code": "U004166", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://loinc.org", + "code": "LA10513-2", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85138408", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sct", + "code": "D-0188", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch", + "code": "U004809", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "A70012", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "A15-A19.9", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "A15-A19.9", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccs", + "code": "1", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccs_10", + "code": "1", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0368-2498", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004838", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "010-018.99", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "A70", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "754", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1018255", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "54410", + "display": "tuberculosis" + } + ], + "text": "tuberculosis" + }, + "valueCodeableConcept": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ConditionQualifier" + } + ], + "text": "active" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "text": "treated for tuberculosis" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "2a43edc4-0000-0000-0000-000000000000", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "text": "human immuno deficiency virus infection" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ExaminationName" + } + ], + "text": "HIV-1 plasma viral load" + }, + "valueQuantity": { + "value": 500, + "unit": "HIV-1" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#c31f130b-c0e7-411a-a32b-57f07ea62559", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#4ee79ae8-bf19-4474-a72e-3616ac0a9fdf", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#583a9867-c95e-4225-bd19-47c324e26c0f", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#35d36257-564c-48e0-9c65-b2551870b0bb", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "text": "disallowed concomitant therapy" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0001175", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "B20", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ram", + "code": "DX272", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/qmr", + "code": "R0121441", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A788z", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://snomed.info/sctv", + "code": "186715004", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "1684", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000000649", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc", + "code": "B90", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10000563", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31779", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "00595", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000163", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000023174", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "HIV SYND", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B90001", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "B90", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "1", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00716", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-36310", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "1233", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU080583", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044365", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-6271", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "042", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "023", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://loinc.org", + "code": "LA10430-9", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1014998", + "display": "Acquired Immunodeficiency Syndrome" + } + ], + "text": "Acquired Immunodeficiency Syndrome" + }, + "valueCodeableConcept": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ConditionQualifier" + } + ], + "text": "currently active" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#bdcbe31b-c0f7-4205-9b75-34a8418cfdb2", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "coding": [ + { + "system": "http://loinc.org", + "code": "63900-5", + "display": "age" + } + ], + "text": "age" + }, + "valueRange": { + "low": { + "value": 6, + "unit": "years", + "system": "http://unitsofmeasure.org", + "code": "a" + }, + "high": { + "value": 17, + "unit": "years", + "system": "http://unitsofmeasure.org", + "code": "a" + } + }, + "exclude": false + } + ] + } + ], + "identifier": [ + { + "use": "official", + "value": "CR002677", + "assigner": { + "display": "Janssen Sciences Ireland UC" + } + }, + { + "use": "usual", + "value": "NCTtesttest", + "assigner": { + "display": "ClinicalTrials.gov" + } + }, + { + "use": "secondary", + "value": "TMC278-TiDP38-C213" + }, + { + "use": "secondary", + "value": "2008-001696-30" + } + ], + "title": "A Study to Evaluate the Pharmacokinetics, Safety, Tolerability, and Antiviral Efficacy of Rilpivirine (TMC278) in Human Immunodeficiency Virus Infected Adolescents and Children Aged Greater Than or Equal to 6 Years", + "protocol": [ + { + "reference": "#1b5bc5d5-9413-43f7-9da6-70db2606b7cd", + "type": "PlanDefinition", + "display": "Rilpivirine" + }, + { + "reference": "#30f45f8a-a0f5-4eed-a5e1-4819137c10b2", + "type": "PlanDefinition", + "display": "Zidovudine" + }, + { + "reference": "#8958e19c-17db-4152-874d-cf68c3918769", + "type": "PlanDefinition", + "display": "Abacavir" + }, + { + "reference": "#bef1c7b6-1e1a-4fb4-8bcd-b9d965dd09e6", + "type": "PlanDefinition", + "display": "Tenofovir disoproxil fumarate" + }, + { + "reference": "#ec554338-0167-4034-98dd-ee1cd5860430", + "type": "PlanDefinition", + "display": "Lamivudine" + }, + { + "reference": "#8ddc695e-efab-441e-bd49-c1decfdb80bf", + "type": "PlanDefinition", + "display": "Emtricitabine" + } + ], + "status": "active", + "primaryPurposeType": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type", + "version": "4.0.0", + "code": "treatment", + "display": "Treatment" + } + ], + "text": "Treatment" + }, + "phase": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-phase", + "version": "4.0.0", + "code": "phase-2", + "display": "Phase 2" + } + ], + "text": "Phase 2" + }, + "category": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type", + "version": "4.0.0", + "code": "treatment", + "display": "Treatment" + } + ], + "text": "Treatment" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "Interventional", + "display": "Interventional" + } + ], + "text": "Interventional" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "Single Group Assignment", + "display": "Single Group Assignment" + } + ], + "text": "Single Group Assignment" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "None (Open Label)", + "display": "None (Open Label)" + } + ], + "text": "None (Open Label)" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "NoneRetained", + "display": "NoneRetained" + } + ], + "text": "NoneRetained" + } + ], + "focus": [ + { + "text": "Drug" + } + ], + "condition": [ + { + "text": "Human Immuno Deficiency (HIV) Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0021051", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sctv", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "39922", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000045724", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "D-4600", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-5885", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021460", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006602", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3131", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hpo", + "code": "HP:0002721", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/omim", + "code": "MTHU032911", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B99011", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "2156", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007153", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C39725", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "279.3", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X20GZ", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "F-C0450", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "U000355", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://loinc.org", + "code": "MTHU054768", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nanda-i", + "code": "02515", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85064574", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1007151", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU037620", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004832", + "display": "Immunologic Deficiency Syndromes" + } + ], + "text": "Immunologic Deficiency Syndromes" + } + ], + "contact": [ + { + "name": "Use link at the bottom of the page to see if you qualify for an enrolling site (see list). If you still have questions:", + "telecom": [ + { + "system": "email", + "value": "JNJ.CT@sylogent.com", + "use": "work" + } + ] + }, + { + "name": "StudyDirector Janssen Sciences Ireland UC Clinical Trial" + } + ], + "keyword": [ + { + "text": "HIV Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0599685", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D044966", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "250564", + "display": "Antiretroviral" + }, + { + "system": "http://snomed.info/sctv", + "code": "713540004", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0715-4905", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2003006231", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000042059", + "display": "Antiretroviral" + } + ], + "text": "Antiretroviral" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0019704", + "display": "HIV-1" + }, + { + "system": "http://snomed.info/sctv", + "code": "243598007", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cdisc", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X73kd", + "display": "HIV-1" + }, + { + "system": "http://loinc.org", + "code": "MTHU009425", + "display": "HIV-1" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://snomed.info/sct", + "code": "L-35211", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10020455", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "3130-7357", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015497", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ncbi", + "code": "11676", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006190", + "display": "HIV-1" + } + ], + "text": "HIV-1" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0001175", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "B20", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ram", + "code": "DX272", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/qmr", + "code": "R0121441", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A788z", + "display": "AIDS" + }, + { + "system": "http://snomed.info/sctv", + "code": "186715004", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "1684", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000000649", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc", + "code": "B90", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10000563", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31779", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "00595", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000163", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000023174", + "display": "AIDS" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "HIV SYND", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B90001", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "B90", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "1", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00716", + "display": "AIDS" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-36310", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "1233", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU080583", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044365", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-6271", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "042", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "023", + "display": "AIDS" + }, + { + "system": "http://loinc.org", + "code": "LA10430-9", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1014998", + "display": "AIDS" + } + ], + "text": "AIDS" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0008059", + "display": "Children" + }, + { + "system": "http://snomed.info/sct", + "code": "S-10170", + "display": "Children" + }, + { + "system": "http://snomed.info/sctv", + "code": "67822003", + "display": "Children" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C16423", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85023418", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000007008", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D002648", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000002765", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "0060058", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0635-1343", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch", + "code": "U005340", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v3.0", + "code": "CHD", + "display": "Children" + }, + { + "system": "http://loinc.org", + "code": "LA9949-4", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C16423", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/dxp", + "code": "U000730", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "C16423", + "display": "Children" + } + ], + "text": "Children" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C1566826", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "309423", + "display": "Rilpivirine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG05", + "display": "Rilpivirine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C76929", + "display": "Rilpivirine" + }, + { + "system": "http://snomed.info/sctv", + "code": "703777002", + "display": "Rilpivirine" + }, + { + "system": "http://loinc.org", + "code": "MTHU042155", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB08864", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d07776", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "FI96A8X663", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "FI96A8X663", + "display": "Rilpivirine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4030730", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "1102270", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "4688", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m7163", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000068696", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU002683", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "013795", + "display": "Rilpivirine" + } + ], + "text": "Rilpivirine (TMC278)" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C1521725", + "display": "Pediatric" + }, + { + "system": "http://loinc.org", + "code": "LP100615-6", + "display": "Pediatric" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C39299", + "display": "Pediatric" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000046245", + "display": "Pediatric" + } + ], + "text": "Pediatric" + }, + { + "text": "Human Immuno Deficiency (HIV) Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0021051", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sctv", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "39922", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000045724", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "D-4600", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-5885", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021460", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006602", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3131", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hpo", + "code": "HP:0002721", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/omim", + "code": "MTHU032911", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B99011", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "2156", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007153", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C39725", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "279.3", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X20GZ", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "F-C0450", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "U000355", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://loinc.org", + "code": "MTHU054768", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nanda-i", + "code": "02515", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85064574", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1007151", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU037620", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004832", + "display": "Immunologic Deficiency Syndromes" + } + ], + "text": "Immunologic Deficiency Syndromes" + }, + { + "coding": [ + { + "system": "http://hl7.org/fhir/administrative-gender", + "code": "Unknown", + "display": "Unknown" + } + ], + "text": "Unknown" + }, + { + "coding": [ + { + "system": "http://decades-value-set.ctm.microsoft.org", + "code": "0", + "display": "Age keyword for indexing - 0" + } + ], + "text": "Age keyword for indexing - 0" + }, + { + "coding": [ + { + "system": "http://decades-value-set.ctm.microsoft.org", + "code": "10", + "display": "Age keyword for indexing - 10" + } + ], + "text": "Age keyword for indexing - 10" + } + ], + "description": "This is a Phase II, open-label (all people involved know the identity of the assigned drug)\r\n and single arm study. The study will consist of a screening period of maximum 8 weeks, an\r\n initial treatment period of 48 weeks, a post week 48 treatment extension period of 4 years,\r\n and a 4 week follow-up period. A follow-up period will take place regardless of the presence\r\n of serious adverse events (SAEs) if patients withdraw early (ie, before Week 48) or if\r\n patients do not participate in the extension after Week 48; after Week 48, a 4-week follow-up\r\n visit is only required in case of ongoing (S)AEs at the final on treatment visit. The initial\r\n 48-week treatment period will be structured into 2 age Cohorts; Cohort 1 (Aged greater than\r\n or equal to [>=] 12 to less than [<] 18 years) and Cohort 2 (Children Aged >= 6 to < 12\r\n years) and each Cohort will have 2 parts. The first part of the trial (Part 1) is designed to\r\n evaluate the steady-state pharmacokinetic (PK) profile and the short-term safety and\r\n antiviral activity of rilpivirine 25 mg or adjusted dose once daily when administered in\r\n combination with 2 NRTIs. At Week 2/4, intensive PK will be done and an analysis together\r\n with short-term safety and antiviral activity will be reviewed by a data monitoring committee\r\n (DMC). For adolescents (Cohort 1) if the mean steady-state exposure in this first group of\r\n patients is comparable to that of the adult population (ie, is within 80-125 percentage of\r\n the mean exposure of the 25 mg once daily dose group in study, TMC278-C204), and the Week 2/4\r\n safety and antiviral activity results have been reviewed and deemed satisfactory by the DMC,\r\n the second part of the trial will start. The second part of the trial will evaluate long-term\r\n (48 weeks and 240 weeks) safety, efficacy, and pharmacokinetics of rilpivirine in combination\r\n with the background regimen of 2 NRTIs with a primary analysis time point at 24 weeks. For\r\n patients aged greater than or equal to (>=) 6 to less than (<) 12 years (Cohort 2), after\r\n being treated for at least 4 weeks and the Week 2 intensive PK and Week 4 safety and\r\n antiviral activity have been reviewed and results are satisfactory, recruitment in Part 1\r\n will resume and additional subjects will be enrolled to have at least 10 subjects in Part 1.\r\n Once an appropriate RPV dose has been selected, Part 1 of Cohort 2 will be considered\r\n complete and Part 2 will start. All patients from Part 1 will roll over in Part 2 and\r\n additional patients will be recruited in Part 2 to have at least 25 subjects (including those\r\n from Part 1) overall. In both cohorts of the trial, the ART will consist of rilpivirine 25 mg\r\n or adjusted dose once daily and an investigator-selected background regimen containing 2\r\n NRTIs. Patients safety will be monitored throughout the study and during the follow up\r\n visits.", + "enrollment": [ + { + "reference": "#2a43edc4-0000-0000-0000-000000000000", + "type": "Group" + } + ], + "period": { + "start": "2011-01", + "end": "2027-08" + }, + "arm": [ + { + "name": "Rilpivirine (TMC278)", + "type": { + "text": "Experimental" + }, + "description": "The patients will receive rilpivirine with 2 nucleoside/nucleotide reverse transcriptase inhibitors (NRTIs) as a background regimen in Cohort 1 [Aged greater than or equal to (> =) 12 to less than (<) 18 years] and Cohort 2 (children aged > = 6 to < 12 years). The NRTIs includes zidovudine, abacavir, or tenofovir disoproxil fumarate in combination with lamivudine or emtricitabine." + } + ] + } + ], + "registryFilters": [ + { + "studyTypes": [ + "interventional", + "observational" + ], + "recruitmentStatuses": [ + "recruiting", + "enrollingByInvitation" + ], + "phases": [ + "phase2", + "phase3" + ], + "purposes": [ + "diagnostic", + "prevention", + "basicScience" + ], + "sources": [ + "clinicaltrials.gov" + ], + "facilityLocations": [ + { + "city": "Basel", + "countryOrRegion": "Switzerland" + }, + { + "city": "Allschwil", + "countryOrRegion": "Switzerland" + } + ] + }, + { + "sponsors": [ + "Janssen" + ], + "sources": [ + "clinicaltrials.gov" + ], + "facilityAreas": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 7.588576, + 47.559601 + ] + }, + "properties": { + "subType": "Circle", + "radius": 80000 + } + } + ] + }, + { + "ids": [ + "NCT04006015", + "NCT04545788", + "NCT04773711" + ], + "sources": [ + "clinicaltrials.gov" + ] + } + ] + } + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version=2023-09-01-preview", + "Retry-After": "1" + }, + "body": { + "status": "notStarted", + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754" + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulTrialMatcherResponse.json b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulTrialMatcherResponse.json new file mode 100644 index 000000000000..eda21af93fa1 --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/examples/SuccessfulTrialMatcherResponse.json @@ -0,0 +1,113 @@ +{ + "operationId": "TrialMatcher_GetJob", + "title": "Gets the status and details of the Trial Matcher job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-09-01-preview", + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754" + }, + "responses": { + "200": { + "body": { + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754", + "createdDateTime": "2021-11-28T09:13:11.046Z", + "expirationDateTime": "2021-11-28T09:13:11.046Z", + "lastUpdateDateTime": "2021-11-28T09:13:11.046Z", + "status": "succeeded", + "result": { + "patientResults": [ + { + "patientId": "Patient ID Example 2", + "inferences": [ + { + "type": "trialEligibility", + "value": "Eligible", + "description": "SwEaTB - Diagnosing of Acute Tuberculosis", + "confidenceScore": 1, + "evidence": [ + { + "eligibilityCriteriaEvidence": "In-patients with acute tuberculosis", + "patientInfoEvidence": { + "system": "UMLS", + "code": "C0019046", + "name": "tuberculosis" + }, + "importance": 1 + } + ], + "clinicalTrialId": "NCT03667742", + "source": "clinicaltrials.gov", + "metadata": { + "phases": [ + "phase3" + ], + "studyType": "observational", + "recruitmentStatus": "recruiting", + "conditions": [ + "Tuberculosis" + ], + "sponsors": [ + "University Hospital, Basel, Switzerland" + ], + "contacts": [ + { + "name": "John Doe, PD Dr. Med", + "email": "John@contoso.com", + "phone": "+55-555-5555-55" + } + ], + "facilities": [ + { + "name": "University Hospital, Basel", + "city": "Basel", + "countryOrRegion": "Switzerland" + } + ] + } + }, + { + "type": "trialEligibility", + "value": "Ineligible", + "description": "Design of an Integrative Algorithm for Staging Tuberculosis (STAGE-TB)", + "confidenceScore": 1, + "evidence": [ + { + "eligibilityCriteriaEvidence": "negative for Quantiferon- TB Gold Plus Test or ELISpot", + "patientInfoEvidence": { + "system": "UMLS", + "code": "C0920508", + "name": "Enzyme-Linked Immunospot Assay", + "value": "30,000 PBMC cells per 10ul" + }, + "importance": 1 + } + ], + "clinicalTrialId": "NCT03691883", + "source": "clinicaltrials.gov" + } + ], + "neededClinicalInfo": [ + { + "system": "UMLS", + "code": "C4317078", + "name": "Mycobacterium Tuberculosis Measurement ", + "semanticType": "Laboratory Procedure", + "category": "EXAMINATION_NAME" + }, + { + "system": "UMLS", + "code": "C0008031", + "name": "Chest Pain", + "semanticType": "Sign or Symptom", + "category": "SYMPTOM_OR_SIGN" + } + ] + } + ], + "modelVersion": "2021-10-28", + "knowledgeGraphLastUpdateDate": "2021-11-26" + } + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/openapi.json b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/openapi.json new file mode 100644 index 000000000000..34e747ad05f3 --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2023-09-01-preview/openapi.json @@ -0,0 +1,4898 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure AI Health Insights", + "version": "2023-09-01-preview", + "description": "Azure AI Health Insights provides an API that serves insight models, specific for Health & Life Sciences, that perform analysis and provide inferences to be used by a human.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/health-insights", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "tags": [ + { + "name": "TrialMatcher" + }, + { + "name": "OncoPhenotype" + }, + { + "name": "RadiologyInsights" + }, + { + "name": "PatientTimeline" + } + ], + "paths": { + "/onco-phenotype/jobs": { + "post": { + "operationId": "OncoPhenotype_CreateJob", + "tags": [ + "OncoPhenotype" + ], + "summary": "Create Onco Phenotype job", + "description": "Creates an Onco Phenotype job with the given request body.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId" + }, + { + "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OncoPhenotypeData" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "type": "object", + "description": "Provides status details for long running operations.", + "properties": { + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The unique ID of the operation.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the operation", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was created.", + "readOnly": true + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job is set to expire.", + "readOnly": true + }, + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was last updated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\"." + }, + "result": { + "$ref": "#/definitions/OncoPhenotypeInferenceResult", + "description": "The result of the operation." + } + }, + "required": [ + "id", + "status" + ] + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Repeatability-Result": { + "type": "string", + "description": "Indicates whether the repeatable request was accepted or rejected.", + "enum": [ + "accepted", + "rejected" + ], + "x-ms-enum": { + "name": "RepeatabilityResult", + "modelAsString": false, + "values": [ + { + "name": "accepted", + "value": "accepted", + "description": "If the request was accepted and the server guarantees that the server state reflects a single execution of the operation." + }, + { + "name": "rejected", + "value": "rejected", + "description": "If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid\nor because the Repeatability-First-Sent value was outside the range of values held by the server." + } + ] + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates an Onco Phenotype job with the given request body.": { + "$ref": "./examples/SuccessfulOncoPhenotypeRequest.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/onco-phenotype/jobs/{id}": { + "get": { + "operationId": "OncoPhenotype_GetJob", + "tags": [ + "OncoPhenotype" + ], + "summary": "Get Onco Phenotype job details", + "description": "Gets the status and details of the Onco Phenotype job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "A processing job identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OncoPhenotypeResult" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the status and details of the Onco Phenotype job.": { + "$ref": "./examples/SuccessfulOncoPhenotypeResponse.json" + } + } + } + }, + "/patient-timeline/jobs": { + "post": { + "operationId": "PatientTimeline_CreateJob", + "tags": [ + "PatientTimeline" + ], + "summary": "Create Patient Timeline job", + "description": "Creates a Patient Timeline job with the given request body.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId" + }, + { + "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatientTimelineData" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "type": "object", + "description": "Provides status details for long running operations.", + "properties": { + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The unique ID of the operation.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the operation", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was created.", + "readOnly": true + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job is set to expire.", + "readOnly": true + }, + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was last updated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\"." + }, + "result": { + "$ref": "#/definitions/PatientTimelineInferenceResult", + "description": "The result of the operation." + } + }, + "required": [ + "id", + "status" + ] + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Repeatability-Result": { + "type": "string", + "description": "Indicates whether the repeatable request was accepted or rejected.", + "enum": [ + "accepted", + "rejected" + ], + "x-ms-enum": { + "name": "RepeatabilityResult", + "modelAsString": false, + "values": [ + { + "name": "accepted", + "value": "accepted", + "description": "If the request was accepted and the server guarantees that the server state reflects a single execution of the operation." + }, + { + "name": "rejected", + "value": "rejected", + "description": "If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid\nor because the Repeatability-First-Sent value was outside the range of values held by the server." + } + ] + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates a Patient Timeline job with the given request body.": { + "$ref": "./examples/SuccessfulPatientTimelineRequest.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/patient-timeline/jobs/{id}": { + "get": { + "operationId": "PatientTimeline_GetJob", + "tags": [ + "PatientTimeline" + ], + "summary": "Get Patient Timeline job details", + "description": "Gets the status and details of the Patient Timeline job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "A processing job identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PatientTimelineResult" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the status and details of the Patient Timeline job.": { + "$ref": "./examples/SuccessfulPatientTimelineResponse.json" + } + } + } + }, + "/radiology-insights/jobs": { + "post": { + "operationId": "RadiologyInsights_CreateJob", + "tags": [ + "RadiologyInsights" + ], + "summary": "Create Radiology Insights job", + "description": "Creates a Radiology Insights job with the given request body.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId" + }, + { + "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RadiologyInsightsData" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "type": "object", + "description": "Provides status details for long running operations.", + "properties": { + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The unique ID of the operation.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the operation", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was created.", + "readOnly": true + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job is set to expire.", + "readOnly": true + }, + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was last updated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\"." + }, + "result": { + "$ref": "#/definitions/RadiologyInsightsInferenceResult", + "description": "The result of the operation." + } + }, + "required": [ + "id", + "status" + ] + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Repeatability-Result": { + "type": "string", + "description": "Indicates whether the repeatable request was accepted or rejected.", + "enum": [ + "accepted", + "rejected" + ], + "x-ms-enum": { + "name": "RepeatabilityResult", + "modelAsString": false, + "values": [ + { + "name": "accepted", + "value": "accepted", + "description": "If the request was accepted and the server guarantees that the server state reflects a single execution of the operation." + }, + { + "name": "rejected", + "value": "rejected", + "description": "If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid\nor because the Repeatability-First-Sent value was outside the range of values held by the server." + } + ] + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates a Radiology Insights job with the given request body.": { + "$ref": "./examples/SuccessfulRadiologyInsightsRequest.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/radiology-insights/jobs/{id}": { + "get": { + "operationId": "RadiologyInsights_GetJob", + "tags": [ + "RadiologyInsights" + ], + "summary": "Get Radiology Insights job details", + "description": "Gets the status and details of the Radiology Insights job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "A processing job identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RadiologyInsightsResult" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the status and details of the Radiology Insights job.": { + "$ref": "./examples/SuccessfulRadiologyInsightsResponse.json" + } + } + } + }, + "/trial-matcher/jobs": { + "post": { + "operationId": "TrialMatcher_CreateJob", + "tags": [ + "TrialMatcher" + ], + "summary": "Create Trial Matcher job", + "description": "Creates a Trial Matcher job with the given request body.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId" + }, + { + "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrialMatcherData" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "type": "object", + "description": "Provides status details for long running operations.", + "properties": { + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The unique ID of the operation.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the operation", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was created.", + "readOnly": true + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job is set to expire.", + "readOnly": true + }, + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was last updated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\"." + }, + "result": { + "$ref": "#/definitions/TrialMatcherInferenceResult", + "description": "The result of the operation." + } + }, + "required": [ + "id", + "status" + ] + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Repeatability-Result": { + "type": "string", + "description": "Indicates whether the repeatable request was accepted or rejected.", + "enum": [ + "accepted", + "rejected" + ], + "x-ms-enum": { + "name": "RepeatabilityResult", + "modelAsString": false, + "values": [ + { + "name": "accepted", + "value": "accepted", + "description": "If the request was accepted and the server guarantees that the server state reflects a single execution of the operation." + }, + { + "name": "rejected", + "value": "rejected", + "description": "If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid\nor because the Repeatability-First-Sent value was outside the range of values held by the server." + } + ] + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates a Trial Matcher job with the given request body.": { + "$ref": "./examples/SuccessfulTrialMatcherRequest.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/trial-matcher/jobs/{id}": { + "get": { + "operationId": "TrialMatcher_GetJob", + "tags": [ + "TrialMatcher" + ], + "summary": "Get Trial Matcher job details", + "description": "Gets the status and details of the Trial Matcher job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "A processing job identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TrialMatcherResult" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the status and details of the Trial Matcher job.": { + "$ref": "./examples/SuccessfulTrialMatcherResponse.json" + } + } + } + } + }, + "definitions": { + "AgeMismatchInference": { + "type": "object", + "description": "A notification for age mismatch is displayed when the age mentioned in a document for a specific patient does not match the age specified in the patient information.", + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "ageMismatch" + }, + "AreaGeometry": { + "type": "object", + "description": "`GeoJSON` geometry, representing the area circle's center.", + "properties": { + "type": { + "$ref": "#/definitions/GeoJsonGeometryType", + "description": "`GeoJSON` geometry type." + }, + "coordinates": { + "type": "array", + "description": "Coordinates of the area circle's center, represented according to the `GeoJSON` standard.\nThis is an array of 2 decimal numbers, longitude and latitude (precisely in this order).", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "number", + "format": "float" + } + } + }, + "required": [ + "type", + "coordinates" + ] + }, + "AreaProperties": { + "type": "object", + "description": "`GeoJSON` object properties.", + "properties": { + "subType": { + "$ref": "#/definitions/GeoJsonPropertiesSubType", + "description": "`GeoJSON` object sub-type." + }, + "radius": { + "type": "number", + "format": "double", + "description": "The radius of the area's circle, in meters." + } + }, + "required": [ + "subType", + "radius" + ] + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "ClinicalCodedElement": { + "type": "object", + "description": "A piece of clinical information, expressed as a code in a clinical coding system.", + "properties": { + "system": { + "type": "string", + "description": "The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS." + }, + "code": { + "type": "string", + "description": "The code within the given clinical coding system." + }, + "name": { + "type": "string", + "description": "The name of this coded concept in the coding system." + }, + "value": { + "type": "string", + "description": "A value associated with the code within the given clinical coding system." + } + }, + "required": [ + "system", + "code" + ] + }, + "ClinicalDocumentType": { + "type": "string", + "description": "The type of the clinical document.", + "enum": [ + "consultation", + "dischargeSummary", + "historyAndPhysical", + "radiologyReport", + "procedure", + "progress", + "laboratory", + "pathologyReport" + ], + "x-ms-enum": { + "name": "ClinicalDocumentType", + "modelAsString": true, + "values": [ + { + "name": "Consultation", + "value": "consultation" + }, + { + "name": "DischargeSummary", + "value": "dischargeSummary" + }, + { + "name": "HistoryAndPhysical", + "value": "historyAndPhysical" + }, + { + "name": "RadiologyReport", + "value": "radiologyReport" + }, + { + "name": "Procedure", + "value": "procedure" + }, + { + "name": "Progress", + "value": "progress" + }, + { + "name": "Laboratory", + "value": "laboratory" + }, + { + "name": "PathologyReport", + "value": "pathologyReport" + } + ] + } + }, + "ClinicalNoteEvidence": { + "type": "object", + "description": "A piece of evidence from a clinical note (text document).", + "properties": { + "id": { + "type": "string", + "description": "The identifier of the document containing the evidence." + }, + "text": { + "type": "string", + "description": "The actual text span which is evidence for the inference." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The start index of the evidence text span in the document (0 based).", + "minimum": 0 + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the evidence text span.", + "minimum": 1 + } + }, + "required": [ + "id", + "offset", + "length" + ] + }, + "ClinicalTrialMetadata": { + "type": "object", + "description": "Trial data which is of interest to the potential participant.", + "properties": { + "phases": { + "type": "array", + "description": "Phases which are relevant for the clinical trial.\nEach clinical trial can be in a certain phase or in multiple phases.", + "items": { + "$ref": "#/definitions/ClinicalTrialPhase" + } + }, + "studyType": { + "$ref": "#/definitions/ClinicalTrialStudyType", + "description": "Possible study types of a clinical trial." + }, + "recruitmentStatus": { + "$ref": "#/definitions/ClinicalTrialRecruitmentStatus", + "description": "Possible recruitment status of a clinical trial." + }, + "conditions": { + "type": "array", + "description": "Medical conditions and their synonyms which are relevant for the clinical trial, given as strings.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "sponsors": { + "type": "array", + "description": "Sponsors/collaborators involved with the trial.", + "items": { + "type": "string" + } + }, + "contacts": { + "type": "array", + "description": "Contact details of the trial administrators, for patients that want to participate in the trial.", + "items": { + "$ref": "#/definitions/ContactDetails" + }, + "x-ms-identifiers": [] + }, + "facilities": { + "type": "array", + "description": "Research facilities where the clinical trial is conducted.", + "items": { + "$ref": "#/definitions/ClinicalTrialResearchFacility" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "conditions" + ] + }, + "ClinicalTrialPhase": { + "type": "string", + "description": "Possible phases of a clinical trial.", + "enum": [ + "notApplicable", + "earlyPhase1", + "phase1", + "phase2", + "phase3", + "phase4" + ], + "x-ms-enum": { + "name": "ClinicalTrialPhase", + "modelAsString": true, + "values": [ + { + "name": "NotApplicable", + "value": "notApplicable" + }, + { + "name": "EarlyPhase1", + "value": "earlyPhase1" + }, + { + "name": "Phase1", + "value": "phase1" + }, + { + "name": "Phase2", + "value": "phase2" + }, + { + "name": "Phase3", + "value": "phase3" + }, + { + "name": "Phase4", + "value": "phase4" + } + ] + } + }, + "ClinicalTrialPurpose": { + "type": "string", + "description": "Possible purposes of a clinical trial.", + "enum": [ + "notApplicable", + "screening", + "diagnostic", + "prevention", + "healthServicesResearch", + "treatment", + "deviceFeasibility", + "supportiveCare", + "basicScience", + "other" + ], + "x-ms-enum": { + "name": "ClinicalTrialPurpose", + "modelAsString": true, + "values": [ + { + "name": "NotApplicable", + "value": "notApplicable" + }, + { + "name": "Screening", + "value": "screening" + }, + { + "name": "Diagnostic", + "value": "diagnostic" + }, + { + "name": "Prevention", + "value": "prevention" + }, + { + "name": "HealthServicesResearch", + "value": "healthServicesResearch" + }, + { + "name": "Treatment", + "value": "treatment" + }, + { + "name": "DeviceFeasibility", + "value": "deviceFeasibility" + }, + { + "name": "SupportiveCare", + "value": "supportiveCare" + }, + { + "name": "BasicScience", + "value": "basicScience" + }, + { + "name": "Other", + "value": "other" + } + ] + } + }, + "ClinicalTrialRecruitmentStatus": { + "type": "string", + "description": "Possible recruitment status of a clinical trial.", + "enum": [ + "unknownStatus", + "notYetRecruiting", + "recruiting", + "enrollingByInvitation" + ], + "x-ms-enum": { + "name": "ClinicalTrialRecruitmentStatus", + "modelAsString": true, + "values": [ + { + "name": "UnknownStatus", + "value": "unknownStatus" + }, + { + "name": "NotYetRecruiting", + "value": "notYetRecruiting" + }, + { + "name": "Recruiting", + "value": "recruiting" + }, + { + "name": "EnrollingByInvitation", + "value": "enrollingByInvitation" + } + ] + } + }, + "ClinicalTrialRegistryFilter": { + "type": "object", + "description": "A filter defining a subset of clinical trials from a given clinical trial registry (e.g. clinicaltrials.gov).", + "properties": { + "conditions": { + "type": "array", + "description": "Trials with any of the given medical conditions will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the medical conditions.", + "items": { + "type": "string" + } + }, + "studyTypes": { + "type": "array", + "description": "Trials with any of the given study types will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the study types.", + "items": { + "$ref": "#/definitions/ClinicalTrialStudyType" + } + }, + "recruitmentStatuses": { + "type": "array", + "description": "Trials with any of the given recruitment statuses will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the recruitment statuses.", + "items": { + "$ref": "#/definitions/ClinicalTrialRecruitmentStatus" + } + }, + "sponsors": { + "type": "array", + "description": "Trials with any of the given sponsors will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the sponsors.", + "items": { + "type": "string" + } + }, + "phases": { + "type": "array", + "description": "Trials with any of the given phases will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the phases.", + "items": { + "$ref": "#/definitions/ClinicalTrialPhase" + } + }, + "purposes": { + "type": "array", + "description": "Trials with any of the given purposes will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the purposes.", + "items": { + "$ref": "#/definitions/ClinicalTrialPurpose" + } + }, + "ids": { + "type": "array", + "description": "Trials with any of the given identifiers will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the trial identifiers.", + "items": { + "type": "string" + } + }, + "sources": { + "type": "array", + "description": "Trials with any of the given sources will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the sources.", + "items": { + "$ref": "#/definitions/ClinicalTrialSource" + } + }, + "facilityNames": { + "type": "array", + "description": "Trials with any of the given facility names will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the trial facility names.", + "items": { + "type": "string" + } + }, + "facilityLocations": { + "type": "array", + "description": "Trials with any of the given facility locations will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the trial facility locations.", + "items": { + "$ref": "#/definitions/GeographicLocation" + }, + "x-ms-identifiers": [] + }, + "facilityAreas": { + "type": "array", + "description": "Trials with any of the given facility area boundaries will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the trial facility area boundaries.", + "items": { + "$ref": "#/definitions/GeographicArea" + }, + "x-ms-identifiers": [] + } + } + }, + "ClinicalTrialResearchFacility": { + "type": "object", + "description": "Details of a research facility where a clinical trial is conducted.", + "properties": { + "name": { + "type": "string", + "description": "The facility's name." + }, + "city": { + "type": "string", + "description": "City name." + }, + "state": { + "type": "string", + "description": "State name." + }, + "countryOrRegion": { + "type": "string", + "description": "Country/region name." + } + }, + "required": [ + "name", + "countryOrRegion" + ] + }, + "ClinicalTrialSource": { + "type": "string", + "description": "Possible sources of a clinical trial.", + "enum": [ + "custom", + "clinicaltrials.gov" + ], + "x-ms-enum": { + "name": "ClinicalTrialSource", + "modelAsString": true, + "values": [ + { + "name": "Custom", + "value": "custom" + }, + { + "name": "ClinicaltrialsGov", + "value": "clinicaltrials.gov" + } + ] + } + }, + "ClinicalTrialStudyType": { + "type": "string", + "description": "Possible study types of a clinical trial.", + "enum": [ + "interventional", + "observational", + "expandedAccess", + "patientRegistries" + ], + "x-ms-enum": { + "name": "ClinicalTrialStudyType", + "modelAsString": true, + "values": [ + { + "name": "Interventional", + "value": "interventional" + }, + { + "name": "Observational", + "value": "observational" + }, + { + "name": "ExpandedAccess", + "value": "expandedAccess" + }, + { + "name": "PatientRegistries", + "value": "patientRegistries" + } + ] + } + }, + "ClinicalTrials": { + "type": "object", + "description": "The clinical trials that the patient(s) should be matched to. \nThe trial selection can be given as a list of custom clinical trials and/or a list of filters to known clinical trial registries.\nIn case both are given, the resulting trial set is a union of the two sets.", + "properties": { + "customTrials": { + "type": "array", + "description": "A list of clinical trials.", + "minItems": 1, + "items": { + "$ref": "#/definitions/Fhir.R4.ResearchStudy" + } + }, + "registryFilters": { + "type": "array", + "description": "A list of filters, each one creating a selection of trials from a given\nclinical trial registry.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ClinicalTrialRegistryFilter" + }, + "x-ms-identifiers": [] + } + } + }, + "CompleteOrderDiscrepancyInference": { + "type": "object", + "description": "A complete order discrepancy is shown when one or more body parts and/or measurements that should be in the document (because there is a complete order) are not present.", + "properties": { + "orderType": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast." + }, + "missingBodyParts": { + "type": "array", + "description": "List of missing body parts required by a complete order : SNOMED CT codes.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "missingBodyPartMeasurements": { + "type": "array", + "description": "List of missing body parts that require measurement by a complete order : SNOMED CT codes.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + } + }, + "required": [ + "orderType" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "completeOrderDiscrepancy" + }, + "ContactDetails": { + "type": "object", + "description": "A person's contact details.", + "properties": { + "name": { + "type": "string", + "description": "The person's name." + }, + "email": { + "type": "string", + "description": "The person's email." + }, + "phone": { + "type": "string", + "description": "A person's phone number." + } + } + }, + "CriticalResult": { + "type": "object", + "description": "Critical Result consists of two properties.", + "properties": { + "description": { + "type": "string", + "description": "Description : medical problem." + }, + "finding": { + "$ref": "#/definitions/Fhir.R4.Observation", + "description": "Finding linked to the critical result." + } + }, + "required": [ + "description" + ] + }, + "CriticalResultInference": { + "type": "object", + "description": "Critical results refer to findings of utmost importance that may require timely attention due to their potential impact on patient care.", + "properties": { + "result": { + "$ref": "#/definitions/CriticalResult", + "description": "The complete Critical Result, as outlined below, will be reused for the recommendation." + } + }, + "required": [ + "result" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "criticalResult" + }, + "DocumentAdministrativeMetadata": { + "type": "object", + "description": "Document administrative metadata", + "properties": { + "orderedProcedures": { + "type": "array", + "description": "List of procedure information associated with the document.", + "minItems": 1, + "items": { + "$ref": "#/definitions/OrderedProcedure" + }, + "x-ms-identifiers": [] + }, + "encounterId": { + "type": "string", + "description": "Reference to the encounter associated with the document." + } + } + }, + "DocumentAuthor": { + "type": "object", + "description": "Document author", + "properties": { + "id": { + "type": "string", + "description": "author id" + }, + "fullName": { + "type": "string", + "description": "Text representation of the full name" + } + } + }, + "DocumentContent": { + "type": "object", + "description": "The content of the patient document.", + "properties": { + "sourceType": { + "$ref": "#/definitions/DocumentContentSourceType", + "description": "The type of the content's source.\nIn case the source type is 'inline', the content is given as a string (for instance, text).\nIn case the source type is 'reference', the content is given as a URI." + }, + "value": { + "type": "string", + "description": "The content of the document, given either inline (as a string) or as a reference (URI)." + } + }, + "required": [ + "sourceType", + "value" + ] + }, + "DocumentContentSourceType": { + "type": "string", + "description": "The type of the content's source. \nIn case the source type is 'inline', the content is given as a string (for instance, text). \nIn case the source type is 'reference', the content is given as a URI.", + "enum": [ + "inline", + "reference" + ], + "x-ms-enum": { + "name": "DocumentContentSourceType", + "modelAsString": true, + "values": [ + { + "name": "Inline", + "value": "inline", + "description": "The content is given as a string (for instance, text)." + }, + { + "name": "Reference", + "value": "reference", + "description": "The content is given as a URI." + } + ] + } + }, + "DocumentType": { + "type": "string", + "description": "The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document).", + "enum": [ + "note", + "fhirBundle", + "dicom", + "genomicSequencing" + ], + "x-ms-enum": { + "name": "DocumentType", + "modelAsString": true, + "values": [ + { + "name": "Note", + "value": "note" + }, + { + "name": "FhirBundle", + "value": "fhirBundle" + }, + { + "name": "Dicom", + "value": "dicom" + }, + { + "name": "GenomicSequencing", + "value": "genomicSequencing" + } + ] + } + }, + "Encounter": { + "type": "object", + "description": "visit/encounter information", + "properties": { + "id": { + "type": "string", + "description": "The id of the visit." + }, + "period": { + "$ref": "#/definitions/TimePeriod", + "description": "Time period of the visit.\nIn case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to indicate the discharge time." + }, + "class": { + "$ref": "#/definitions/EncounterClass", + "description": "The class of the encounter." + } + }, + "required": [ + "id" + ] + }, + "EncounterClass": { + "type": "string", + "description": "Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR value set--http://....).", + "enum": [ + "inpatient", + "ambulatory", + "observation", + "emergency", + "virtual", + "healthHome" + ], + "x-ms-enum": { + "name": "EncounterClass", + "modelAsString": true, + "values": [ + { + "name": "InPatient", + "value": "inpatient", + "description": "A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned to a location where patients generally stay at least overnight and provided with room, board, and continuous nursing service." + }, + { + "name": "Ambulatory", + "value": "ambulatory", + "description": "The term ambulatory usually implies that the patient has come to the location and is not assigned to a bed. Sometimes referred to as an outpatient encounter." + }, + { + "name": "Observation", + "value": "observation", + "description": "An encounter where the patient usually will start in different encounter, such as one in the emergency department but then transition to this type of encounter because they require a significant period of treatment and monitoring to determine whether or not their condition warrants an inpatient admission or discharge. " + }, + { + "name": "Emergency", + "value": "emergency", + "description": "A patient encounter that takes place at a dedicated healthcare service delivery location where the patient receives immediate evaluation and treatment, provided until the patient can be discharged or responsibility for the patient's care is transferred elsewhere (for example, the patient could be admitted as an inpatient or transferred to another facility." + }, + { + "name": "Virtual", + "value": "virtual", + "description": "A patient encounter where the patient is not physically present for the encounter, such as in a telehealth encounter, phone call, or electronic communication." + }, + { + "name": "HealthHome", + "value": "healthHome", + "description": "Healthcare encounter that takes place in the residence of the patient or a designee" + } + ] + } + }, + "ExtendedClinicalCodedElement": { + "type": "object", + "description": "A piece of clinical information, expressed as a code in a clinical coding system, extended by semantic information.", + "properties": { + "system": { + "type": "string", + "description": "The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS." + }, + "code": { + "type": "string", + "description": "The code within the given clinical coding system." + }, + "name": { + "type": "string", + "description": "The name of this coded concept in the coding system." + }, + "value": { + "type": "string", + "description": "A value associated with the code within the given clinical coding system." + }, + "semanticType": { + "type": "string", + "description": "The [UMLS semantic type](https://www.nlm.nih.gov/research/umls/META3_current_semantic_types.html) associated with the coded concept." + }, + "category": { + "type": "string", + "description": "The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, Medication, Examination." + } + }, + "required": [ + "system", + "code" + ] + }, + "Fhir.R4.Annotation": { + "type": "object", + "description": "A text note which also contains information about who made the statement and when\nBased on [FHIR Annotation](https://www.hl7.org/fhir/R4/datatypes.html#Annotation)", + "properties": { + "authorString": { + "type": "string", + "description": "Individual responsible for the annotation" + }, + "time": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "When the annotation was made" + }, + "text": { + "type": "string", + "description": "The annotation - text content (as markdown)" + } + }, + "required": [ + "text" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.CodeableConcept": { + "type": "object", + "description": "Concept - reference to a terminology or just text\nBased on [FHIR CodeableConcept](https://www.hl7.org/fhir/R4/datatypes.html#CodeableConcept)", + "properties": { + "coding": { + "type": "array", + "description": "Code defined by a terminology system", + "items": { + "$ref": "#/definitions/Fhir.R4.Coding" + } + }, + "text": { + "type": "string", + "description": "Plain text representation of the concept" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Coding": { + "type": "object", + "description": "A Coding is a representation of a defined concept using a symbol from a defined \"code system\".\nBased on [FHIR Coding](https://www.hl7.org/fhir/R4/datatypes.html#Coding)", + "properties": { + "system": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "Identity of the terminology system" + }, + "version": { + "type": "string", + "description": "Version of the system - if relevant" + }, + "code": { + "type": "string", + "description": "Symbol in syntax defined by the system" + }, + "display": { + "type": "string", + "description": "Representation defined by the system" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Condition": { + "type": "object", + "description": "Detailed information about conditions, problems or diagnoses\nBased on [FHIR Condition](https://www.hl7.org/fhir/R4/condition.html)", + "properties": { + "identifier": { + "type": "array", + "description": "External Ids for this condition", + "items": { + "$ref": "#/definitions/Fhir.R4.Identifier" + } + }, + "clinicalStatus": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "active | recurrence | relapse | inactive | remission | resolved" + }, + "verificationStatus": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error" + }, + "category": { + "type": "array", + "description": "problem-list-item | encounter-diagnosis", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "severity": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Subjective severity of condition" + }, + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Identification of the condition, problem or diagnosis" + }, + "bodySite": { + "type": "array", + "description": "Anatomical location, if relevant", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "encounter": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Encounter created as part of" + }, + "onsetDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Estimated or actual date, date-time, or age" + }, + "onsetAge": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Estimated or actual date, date-time, or age" + }, + "onsetPeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Estimated or actual date, date-time, or age" + }, + "onsetRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Estimated or actual date, date-time, or age" + }, + "onsetString": { + "type": "string", + "description": "Estimated or actual date, date-time, or age" + }, + "abatementDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "When in resolution/remission" + }, + "abatementAge": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "When in resolution/remission" + }, + "abatementPeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "When in resolution/remission" + }, + "abatementRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "When in resolution/remission" + }, + "abatementString": { + "type": "string", + "description": "When in resolution/remission" + }, + "recordedDate": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Date record was first recorded" + }, + "stage": { + "type": "array", + "description": "stge/grade, usually assessed formally", + "items": { + "$ref": "#/definitions/Fhir.R4.ConditionStage" + }, + "x-ms-identifiers": [] + }, + "note": { + "type": "array", + "description": "Additional information about the Condition", + "items": { + "$ref": "#/definitions/Fhir.R4.Annotation" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.DomainResource" + } + ], + "x-ms-discriminator-value": "Condition" + }, + "Fhir.R4.ConditionStage": { + "type": "object", + "description": "Stage/grade, usually assessed formally\nBased on [FHIR Condition.Stage](https://www.hl7.org/fhir/R4/condition.html)", + "properties": { + "summary": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Simple summary (disease specific)" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Kind of staging" + } + } + }, + "Fhir.R4.ContactDetail": { + "type": "object", + "description": "Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail)", + "properties": { + "name": { + "type": "string", + "description": "Name of an individual to contact" + }, + "telecom": { + "type": "array", + "description": "Contact details for individual or organization", + "items": { + "$ref": "#/definitions/Fhir.R4.ContactPoint" + }, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.ContactPoint": { + "type": "object", + "description": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.\nSee https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint", + "properties": { + "system": { + "$ref": "#/definitions/Fhir.R4.ContactPointSystem", + "description": "phone | fax | email | pager | url | sms | other" + }, + "value": { + "type": "string", + "description": "The actual contact point details" + }, + "use": { + "$ref": "#/definitions/Fhir.R4.ContactPointUse", + "description": "home | work | temp | old | mobile - purpose of this contact point" + }, + "rank": { + "type": "integer", + "format": "int32", + "description": "Specify preferred order of use (1 = highest)" + }, + "period": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Time period when the contact point was/is in use" + } + } + }, + "Fhir.R4.ContactPointSystem": { + "type": "string", + "description": "Contact Point System\nsee https://www.hl7.org/fhir/R4/valueset-contact-point-system.html", + "enum": [ + "phone", + "fax", + "email", + "pager", + "url", + "sms", + "other" + ], + "x-ms-enum": { + "name": "ContactPointSystem", + "modelAsString": true, + "values": [ + { + "name": "Phone", + "value": "phone", + "description": "Phone" + }, + { + "name": "Fax", + "value": "fax", + "description": "Fax" + }, + { + "name": "Email", + "value": "email", + "description": "Email" + }, + { + "name": "Pager", + "value": "pager", + "description": "Pager" + }, + { + "name": "Url", + "value": "url", + "description": "Url" + }, + { + "name": "Sms", + "value": "sms", + "description": "Sms" + }, + { + "name": "Other", + "value": "other", + "description": "Other" + } + ] + } + }, + "Fhir.R4.ContactPointUse": { + "type": "string", + "description": "Contact Point Use\nSee: \thttp://hl7.org/fhir/ValueSet/contact-point-use", + "enum": [ + "home", + "work", + "temp", + "old", + "mobile" + ], + "x-ms-enum": { + "name": "ContactPointUse", + "modelAsString": true, + "values": [ + { + "name": "Home", + "value": "home", + "description": "Home" + }, + { + "name": "Work", + "value": "work", + "description": "Work" + }, + { + "name": "Temp", + "value": "temp", + "description": "Temp" + }, + { + "name": "Old", + "value": "old", + "description": "Old" + }, + { + "name": "Mobile", + "value": "mobile", + "description": "Mobile" + } + ] + } + }, + "Fhir.R4.DomainResource": { + "type": "object", + "description": "A resource with narrative, extensions, and contained resources\nBased on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html)", + "properties": { + "resourceType": { + "type": "string", + "description": "Discriminator property for DomainResource." + }, + "text": { + "$ref": "#/definitions/Fhir.R4.Narrative", + "description": "Text summary of the resource, for human interpretation" + }, + "contained": { + "type": "array", + "description": "Contained, inline Resources", + "items": { + "$ref": "#/definitions/Fhir.R4.Resource" + } + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + }, + "modifierExtension": { + "type": "array", + "description": "Extensions that cannot be ignored", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + }, + "discriminator": "resourceType", + "required": [ + "resourceType" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Resource" + } + ] + }, + "Fhir.R4.Element": { + "type": "object", + "description": "The base definition for all elements contained inside a resource.\nBased on [FHIR Element](https://www.hl7.org/fhir/R4/element.html)", + "properties": { + "id": { + "type": "string", + "description": "Unique id for inter-element referencing" + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + } + }, + "Fhir.R4.Extension": { + "type": "object", + "description": "Base for all elements\nBased on [FHIR Element](https://www.hl7.org/fhir/datatypes.html#Element)", + "properties": { + "url": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "Source of the definition for the extension code - a logical name or a URL." + }, + "valueQuantity": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Value as Quantity" + }, + "valueCodeableConcept": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Value as CodeableConcept" + }, + "valueString": { + "type": "string", + "description": "Value as string" + }, + "valueBoolean": { + "type": "boolean", + "description": "Value as boolean" + }, + "valueInteger": { + "type": "integer", + "format": "int32", + "description": "Value as integer" + }, + "valueRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Value as Range." + }, + "valueRatio": { + "$ref": "#/definitions/Fhir.R4.Ratio", + "description": "Value as Ratio." + }, + "valueSampledData": { + "$ref": "#/definitions/Fhir.R4.SampledData", + "description": "Value as SampledData." + }, + "valueTime": { + "type": "string", + "format": "time", + "description": "Value as time (hh:mm:ss)" + }, + "valueDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Value as dateTime." + }, + "valuePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Value as Period." + }, + "valueReference": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Value as reference." + } + }, + "required": [ + "url" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Identifier": { + "type": "object", + "description": "An identifier intended for computation\nBased on [FHIR Identifier](https://www.hl7.org/fhir/R4/identifier.html)", + "properties": { + "use": { + "type": "string", + "description": "usual | official | temp | secondary | old (If known)" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Description of identifier" + }, + "system": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "The namespace for the identifier value" + }, + "value": { + "type": "string", + "description": "The value that is unique" + }, + "period": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Time period when id is/was valid for use" + }, + "assigner": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Organization that issued id (may be just text)" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Meta": { + "type": "object", + "description": "Metadata about a resource\nBased on [FHIR Meta](https://www.hl7.org/fhir/R4/resource.html#Meta)", + "properties": { + "versionId": { + "type": "string", + "description": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted." + }, + "lastUpdated": { + "$ref": "#/definitions/Fhir.R4.fhirInstant", + "description": "When the resource last changed - e.g. when the version changed." + }, + "source": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc." + }, + "profile": { + "type": "array", + "description": "A list of profiles (references to [StructureDefinition](https://www.hl7.org/fhir/structuredefinition.html) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](https://www.hl7.org/fhir/structuredefinition-definitions.html#StructureDefinition.url).", + "items": { + "$ref": "#/definitions/Fhir.R4.fhirUri" + } + }, + "security": { + "type": "array", + "description": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.", + "items": { + "$ref": "#/definitions/Fhir.R4.Coding" + } + }, + "tag": { + "type": "array", + "description": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.", + "items": { + "$ref": "#/definitions/Fhir.R4.Coding" + } + } + } + }, + "Fhir.R4.Narrative": { + "type": "object", + "description": "Any resource that is a [DomainResource](https://www.hl7.org/fhir/domainresource.html) may include a human-readable narrative that contains a summary of the resource and may be used to represent the content of the resource to a human.\nBased on [FHIR Narrative](https://www.hl7.org/fhir/R4/narrative.html#Narrative)", + "properties": { + "status": { + "type": "string", + "description": "generated, extensions, additional, empty" + }, + "div": { + "type": "string", + "description": "xhtml" + } + }, + "required": [ + "status", + "div" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Observation": { + "type": "object", + "description": "Detailed information about observations\nBased on [FHIR Observation](https://www.hl7.org/fhir/R4/observation.html)", + "properties": { + "identifier": { + "type": "array", + "description": "Business Identifier for observation", + "items": { + "$ref": "#/definitions/Fhir.R4.Identifier" + } + }, + "status": { + "$ref": "#/definitions/Fhir.R4.ObservationStatusCodeType", + "description": "registered | preliminary | final | amended +" + }, + "category": { + "type": "array", + "description": "Classification of type of observation", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Type of observation (code / type)" + }, + "subject": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Who and/or what the observation is about" + }, + "encounter": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Healthcare event during which this observation is made" + }, + "effectiveDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Clinically relevant time/time-period for observation" + }, + "effectivePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Clinically relevant time/time-period for observation" + }, + "effectiveInstant": { + "$ref": "#/definitions/Fhir.R4.fhirInstant", + "description": "Clinically relevant time/time-period for observation" + }, + "issued": { + "$ref": "#/definitions/Fhir.R4.fhirInstant", + "description": "Date/Time this version was made available" + }, + "valueQuantity": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Actual result" + }, + "valueCodeableConcept": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Actual result" + }, + "valueString": { + "type": "string", + "description": "Actual result" + }, + "valueBoolean": { + "type": "boolean", + "description": "Actual result" + }, + "valueInteger": { + "type": "integer", + "format": "int32", + "description": "Actual result" + }, + "valueRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Actual result" + }, + "valueRatio": { + "$ref": "#/definitions/Fhir.R4.Ratio", + "description": "Actual result" + }, + "valueSampledData": { + "$ref": "#/definitions/Fhir.R4.SampledData", + "description": "Actual result" + }, + "valueTime": { + "type": "string", + "format": "time", + "description": "Actual result" + }, + "valueDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Actual result" + }, + "valuePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Actual result" + }, + "dataAbsentReason": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Why the result is missing" + }, + "interpretation": { + "type": "array", + "description": "High, low, normal, etc.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "note": { + "type": "array", + "description": "Comments about the observation", + "items": { + "$ref": "#/definitions/Fhir.R4.Annotation" + } + }, + "bodySite": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Observed body part" + }, + "method": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "How it was done" + }, + "referenceRange": { + "type": "array", + "description": "Provides guide for interpretation", + "items": { + "$ref": "#/definitions/Fhir.R4.ObservationReferenceRange" + }, + "x-ms-identifiers": [] + }, + "hasMember": { + "type": "array", + "description": "Related resource that belongs to the Observation group", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "derivedFrom": { + "type": "array", + "description": "Related measurements the observation is made from", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "component": { + "type": "array", + "description": "Component results", + "items": { + "$ref": "#/definitions/Fhir.R4.ObservationComponent" + } + } + }, + "required": [ + "status", + "code" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.DomainResource" + } + ], + "x-ms-discriminator-value": "Observation" + }, + "Fhir.R4.ObservationComponent": { + "type": "object", + "description": "Component results\nBased on [FHIR Observation.component](https://www.hl7.org/fhir/R4/observation.html)", + "properties": { + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Type of component observation (code / type)" + }, + "valueQuantity": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Value as Quantity" + }, + "valueCodeableConcept": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Value as CodeableConcept" + }, + "valueString": { + "type": "string", + "description": "Value as string" + }, + "valueBoolean": { + "type": "boolean", + "description": "Value as boolean" + }, + "valueInteger": { + "type": "integer", + "format": "int32", + "description": "Value as integer" + }, + "valueRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Value as Range." + }, + "valueRatio": { + "$ref": "#/definitions/Fhir.R4.Ratio", + "description": "Value as Ratio." + }, + "valueSampledData": { + "$ref": "#/definitions/Fhir.R4.SampledData", + "description": "Value as SampledData." + }, + "valueTime": { + "type": "string", + "format": "time", + "description": "Value as time (hh:mm:ss)" + }, + "valueDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Value as dateTime." + }, + "valuePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Value as Period." + }, + "valueReference": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Value as reference." + }, + "dataAbsentReason": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Why the component result is missing" + }, + "interpretation": { + "type": "array", + "description": "High, low, normal, etc.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "referenceRange": { + "type": "array", + "description": "Provides guide for interpretation of component result", + "items": { + "$ref": "#/definitions/Fhir.R4.ObservationReferenceRange" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "code" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.ObservationReferenceRange": { + "type": "object", + "description": "Provides guide for interpretation of component result\nBased on [FHIR Observation.referenceRange](https://www.hl7.org/fhir/R4/observation.html)", + "properties": { + "low": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Low Range, if relevant" + }, + "high": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "High Range, if relevant" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Reference range qualifier" + }, + "appliesTo": { + "type": "array", + "description": "Reference range population", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "age": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Applicable age range, if relevant" + }, + "text": { + "type": "string", + "description": "Text based reference range in an observation" + } + } + }, + "Fhir.R4.ObservationStatusCodeType": { + "type": "string", + "description": "Observation Status\nBased on [FHIR ObservationStatus](https://www.hl7.org/fhir/R4/valueset-observation-status.html)", + "enum": [ + "registered", + "preliminary", + "final", + "amended", + "corrected", + "cancelled", + "entered-in-error", + "unknown" + ], + "x-ms-enum": { + "name": "ObservationStatusCodeType", + "modelAsString": true, + "values": [ + { + "name": "Registered", + "value": "registered", + "description": "The existence of the observation is registered, but there is no result yet available." + }, + { + "name": "Preliminary", + "value": "preliminary", + "description": "This is an initial or interim observation: data may be incomplete or unverified." + }, + { + "name": "Final", + "value": "final", + "description": "The observation is complete and verified by an authorized person." + }, + { + "name": "Amended", + "value": "amended", + "description": "Subsequent to being Final, the observation has been modified subsequent. This includes updates/new information and corrections." + }, + { + "name": "Corrected", + "value": "corrected", + "description": "Subsequent to being Final, the observation has been modified to correct an error in the test result." + }, + { + "name": "Cancelled", + "value": "cancelled", + "description": "The observation is unavailable because the measurement was not started or not completed (also sometimes called \"aborted\")." + }, + { + "name": "EnteredInError", + "value": "entered-in-error", + "description": "The observation has been withdrawn following previous final release." + }, + { + "name": "Unknown", + "value": "unknown", + "description": "The observation status is unknown. Note that \"unknown\" is a value of last resort and every attempt should be made to provide a meaningful value other than \"unknown\"." + } + ] + } + }, + "Fhir.R4.Period": { + "type": "object", + "description": "A time period defined by a start and end date and optionally time\nBased on [FHIR Period](https://www.hl7.org/fhir/R4/datatypes.html#Period)", + "properties": { + "start": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Starting time with inclusive boundary" + }, + "end": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "End time with inclusive boundary, if not ongoing" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Quantity": { + "type": "object", + "description": "A measured or measurable amount\nBased on [FHIR Quantity](https://www.hl7.org/fhir/R4/datatypes.html#Quantity)", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "Numerical value (with implicit precision)" + }, + "comparator": { + "type": "string", + "description": "< | <= | >= | > - how to understand the value" + }, + "unit": { + "type": "string", + "description": "Unit representation" + }, + "system": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "System that defines coded unit form" + }, + "code": { + "type": "string", + "description": "Coded form of the unit" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Range": { + "type": "object", + "description": "A set of ordered Quantities defined by a low and high limit\nBased on [FHIR Range](https://www.hl7.org/fhir/R4/datatypes.html#Range)", + "properties": { + "low": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Low limit" + }, + "high": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "High limit" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Ratio": { + "type": "object", + "description": "A ratio of two Quantity values - a numerator and a denominator\nBased on [FHIR Ratio](https://www.hl7.org/fhir/R4/datatypes.html#Ratio)", + "properties": { + "numerator": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Numerator value" + }, + "denominator": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Denominator value" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Reference": { + "type": "object", + "description": "A reference from one resource to another\nBased on [FHIR Reference](https://www.hl7.org/fhir/R4/references.html)", + "properties": { + "reference": { + "type": "string", + "description": "Literal reference, Relative, internal or absolute URL" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "Type the reference refers to (e.g. \"Patient\")" + }, + "identifier": { + "$ref": "#/definitions/Fhir.R4.Identifier", + "description": "Logical reference, when literal reference is not known" + }, + "display": { + "type": "string", + "description": "Text alternative for the resource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.ResearchStudy": { + "type": "object", + "description": "Detailed information about Research Study \nBased on [FHIR ResearchStudy](https://www.hl7.org/fhir/R4/researchstudy.html)", + "properties": { + "identifier": { + "type": "array", + "description": "Business Identifier for study", + "items": { + "$ref": "#/definitions/Fhir.R4.Identifier" + } + }, + "title": { + "type": "string", + "description": "Name for this study" + }, + "protocol": { + "type": "array", + "description": "Steps followed in executing study", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "partOf": { + "type": "array", + "description": "Part of larger study", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "status": { + "$ref": "#/definitions/Fhir.R4.ResearchStudyStatusCodeType", + "description": "active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn" + }, + "primaryPurposeType": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility" + }, + "phase": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4" + }, + "category": { + "type": "array", + "description": "Classifications for the study", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "focus": { + "type": "array", + "description": "Drugs, devices, etc. under study", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "condition": { + "type": "array", + "description": "Condition being studied", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "contact": { + "type": "array", + "description": "Contact details for the study", + "items": { + "$ref": "#/definitions/Fhir.R4.ContactDetail" + } + }, + "keyword": { + "type": "array", + "description": "Used to search for the study", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "location": { + "type": "array", + "description": "Geographic region(s) for study", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "description": { + "type": "string", + "description": "What this is study doing" + }, + "enrollment": { + "type": "array", + "description": "Inclusion & exclusion criteria", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "period": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "When the study began and ended" + }, + "sponsor": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Organization that initiates and is legally responsible for the study" + }, + "principalInvestigator": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Researcher who oversees multiple aspects of the study" + }, + "site": { + "type": "array", + "description": "Facility where study activities are conducted", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "reasonStopped": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design" + }, + "note": { + "type": "array", + "description": "Comments made about the study", + "items": { + "$ref": "#/definitions/Fhir.R4.Annotation" + } + }, + "arm": { + "type": "array", + "description": "Defined path through the study for a subject", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Label for study arm" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Categorization of study arm" + }, + "description": { + "type": "string", + "description": "Short explanation of study path" + } + }, + "required": [ + "name" + ] + }, + "x-ms-identifiers": [] + }, + "objective": { + "type": "array", + "description": "A goal for the study", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Label for the objective" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "primary | secondary | exploratory" + } + }, + "required": [ + "name" + ] + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "status" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.DomainResource" + } + ], + "x-ms-discriminator-value": "ResearchStudy" + }, + "Fhir.R4.ResearchStudyStatusCodeType": { + "type": "string", + "description": "https://www.hl7.org/fhir/R4/codesystem-research-study-status.html", + "enum": [ + "active", + "administratively-completed", + "approved", + "closed-to-accrual", + "closed-to-accrual-and-intervention", + "completed", + "disapproved", + "in-review", + "temporarily-closed-to-accrual", + "temporarily-closed-to-accrual-and-intervention", + "withdrawn" + ], + "x-ms-enum": { + "name": "ResearchStudyStatusCodeType", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "active", + "description": "The study is open for accrual." + }, + { + "name": "AdministrativelyCompleted", + "value": "administratively-completed", + "description": "Study is completed prematurely and will not resume; patients are no longer examined nor treated." + }, + { + "name": "Approved", + "value": "approved", + "description": "Protocol is approved by the review board." + }, + { + "name": "ClosedToAccrual", + "value": "closed-to-accrual", + "description": "Study is closed for accrual; patients can be examined and treated." + }, + { + "name": "ClosedToAccrualAndIntervention", + "value": "closed-to-accrual-and-intervention", + "description": "The study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study subjects have completed treatment or intervention but are still being followed according to the primary objective of the study." + }, + { + "name": "Completed", + "value": "completed", + "description": "Study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study subjects have completed treatment or intervention but are still being followed according to the primary objective of the study." + }, + { + "name": "Disapproved", + "value": "disapproved", + "description": "Protocol was disapproved by the review board." + }, + { + "name": "InReview", + "value": "in-review", + "description": "Protocol is submitted to the review board for approval." + }, + { + "name": "TemporarilyClosedToAccrual", + "value": "temporarily-closed-to-accrual", + "description": "The study is temporarily closed to accrual; a pause in accrual while study is reviewed, but is expected to resume." + }, + { + "name": "TemporarilyClosedToAccrualAndIntervention", + "value": "temporarily-closed-to-accrual-and-intervention", + "description": "Study is temporarily closed for accrual; can be potentially resumed in the future" + }, + { + "name": "Withdrawn", + "value": "withdrawn", + "description": "Protocol was withdrawn by the lead organization." + } + ] + } + }, + "Fhir.R4.Resource": { + "type": "object", + "description": "Resource is the ancestor of DomainResource from which most resources are derived. Bundle, Parameters, and Binary extend Resource directly.\nBased on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource" + }, + "id": { + "type": "string", + "description": "Resource Id" + }, + "meta": { + "$ref": "#/definitions/Fhir.R4.Meta", + "description": "Metadata about the resource" + }, + "implicitRules": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "A set of rules under which this content was created" + }, + "language": { + "type": "string", + "description": "Language of the resource content" + } + }, + "required": [ + "resourceType" + ], + "additionalProperties": {} + }, + "Fhir.R4.SampledData": { + "type": "object", + "description": "A series of measurements taken by a device\nBased on [FHIR SampledData](https://www.hl7.org/fhir/R4/datatypes.html#SampledData)", + "properties": { + "origin": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Zero value and units" + }, + "period": { + "type": "number", + "format": "double", + "description": "Number of milliseconds between samples" + }, + "factor": { + "type": "number", + "format": "double", + "description": "Multiply data by this before adding to origin" + }, + "lowerLimit": { + "type": "number", + "format": "double", + "description": "Lower limit of detection" + }, + "upperLimit": { + "type": "number", + "format": "double", + "description": "Upper limit of detection" + }, + "dimensions": { + "type": "integer", + "format": "int32", + "description": "Number of sample points at each time point", + "minimum": 1 + }, + "data": { + "type": "string", + "description": "Decimal values with spaces, or \"E\" | \"U\" | \"L\"" + } + }, + "required": [ + "origin", + "period", + "dimensions" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.fhirDateTime": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?" + }, + "Fhir.R4.fhirInstant": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))" + }, + "Fhir.R4.fhirUri": { + "type": "string" + }, + "FindingInference": { + "type": "object", + "description": "Findings in a radiology report typically describe abnormalities, lesions, or other notable observations related to the anatomy or pathology of the imaged area.", + "properties": { + "finding": { + "$ref": "#/definitions/Fhir.R4.Observation", + "description": "Finding data : contains extensions, fields and components linked with the finding." + } + }, + "required": [ + "finding" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "finding" + }, + "FindingOptions": { + "type": "object", + "description": "Finding options.", + "properties": { + "provideFocusedSentenceEvidence": { + "type": "boolean", + "description": "If this is true, provide the sentence that contains the first token of the finding's clinical indicator (i.e. the medical problem), if there is one. This sentence is provided as an extension with url 'ci_sentence', next to the token evidence. Default is false." + } + } + }, + "FollowupCommunicationInference": { + "type": "object", + "description": "Follow-up communication involves the exchange of important information, recommendations, or updates between radiologists and other healthcare professionals involved in a patient's care.", + "properties": { + "dateTime": { + "type": "array", + "description": "Communication date and time.", + "items": { + "type": "string", + "format": "date-time" + } + }, + "recipient": { + "type": "array", + "description": "Recipient of the communication.", + "items": { + "$ref": "#/definitions/MedicalProfessionalType" + } + }, + "wasAcknowledged": { + "type": "boolean", + "description": "Communication was acknowledged." + } + }, + "required": [ + "wasAcknowledged" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "followupCommunication" + }, + "FollowupRecommendationInference": { + "type": "object", + "description": "Follow-up recommendations offer guidance to healthcare providers on managing and monitoring patients based on the findings of imaging studies.", + "properties": { + "effectiveDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Date and time are displayed when the procedure is recommended to be done at a specific point in time." + }, + "effectivePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "The period is shown if a specific period is mentioned, with a start and end date-time." + }, + "findings": { + "type": "array", + "description": "Findings related to the recommendation.", + "minItems": 1, + "items": { + "$ref": "#/definitions/RecommendationFinding" + }, + "x-ms-identifiers": [] + }, + "isConditional": { + "type": "boolean", + "description": "The conditional value indicates whether or not the sentence containing the recommendation includes a conditional statement. Keywords for conditional statements include 'if', 'when', 'unless', and so on." + }, + "isOption": { + "type": "boolean", + "description": "The option value indicates whether or not the sentence containing the recommendation includes an optional statement. Keywords for optional statements include 'recommend', 'consider', and so on." + }, + "isGuideline": { + "type": "boolean", + "description": "The guideline value indicates whether or not the recommendation is part of a guideline section that compiles all recommendations applicable to various findings." + }, + "isHedging": { + "type": "boolean", + "description": "Hedging refers to ambiguous, vague or imprecise language within the sentence of the recommendation. Keywords for hedging are 'can be','may be',and so on." + }, + "recommendedProcedure": { + "$ref": "#/definitions/ProcedureRecommendation", + "description": "The procedure recommendation can be a generic procedure or an imaging procedure." + } + }, + "required": [ + "isConditional", + "isOption", + "isGuideline", + "isHedging", + "recommendedProcedure" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "followupRecommendation" + }, + "FollowupRecommendationOptions": { + "type": "object", + "description": "Follow-up recommendation options.", + "properties": { + "includeRecommendationsWithNoSpecifiedModality": { + "type": "boolean", + "description": "Include/Exclude follow-up recommendations without a specific radiology procedure. Default is false." + }, + "includeRecommendationsInReferences": { + "type": "boolean", + "description": "Include/Exclude follow-up recommendations in references to a guideline or article. Default is false." + }, + "provideFocusedSentenceEvidence": { + "type": "boolean", + "description": "If this is true, provide one or more sentences as evidence for the recommendation, next to the token evidence. The start and end positions of these sentences will be put in an extension with url 'modality_sentences'. Default is false." + } + } + }, + "GenericProcedureRecommendation": { + "type": "object", + "description": "Generic procedure information.", + "properties": { + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Procedure modality : SNOMED CT code." + }, + "description": { + "type": "string", + "description": "Procedure description : MANAGEMENT PROCEDURE (PROCEDURE) or CONSULTATION (PROCEDURE) based on SNOMED CT." + } + }, + "required": [ + "code" + ], + "allOf": [ + { + "$ref": "#/definitions/ProcedureRecommendation" + } + ], + "x-ms-discriminator-value": "genericProcedureRecommendation" + }, + "GeoJsonGeometryType": { + "type": "string", + "description": "`GeoJSON` geometry type.", + "enum": [ + "Point" + ], + "x-ms-enum": { + "name": "GeoJsonGeometryType", + "modelAsString": true, + "values": [ + { + "name": "Point", + "value": "Point" + } + ] + } + }, + "GeoJsonPropertiesSubType": { + "type": "string", + "description": "`GeoJSON` object sub-type.", + "enum": [ + "Circle" + ], + "x-ms-enum": { + "name": "GeoJsonPropertiesSubType", + "modelAsString": true, + "values": [ + { + "name": "Circle", + "value": "Circle" + } + ] + } + }, + "GeoJsonType": { + "type": "string", + "description": "`GeoJSON` type.", + "enum": [ + "Feature" + ], + "x-ms-enum": { + "name": "GeoJsonType", + "modelAsString": true, + "values": [ + { + "name": "Feature", + "value": "Feature" + } + ] + } + }, + "GeographicArea": { + "type": "object", + "description": "A geographic area, expressed as a `Circle` geometry represented using a `GeoJSON Feature` (see [GeoJSON spec](https://tools.ietf.org/html/rfc7946)).", + "properties": { + "type": { + "$ref": "#/definitions/GeoJsonType", + "description": "`GeoJSON` type." + }, + "geometry": { + "$ref": "#/definitions/AreaGeometry", + "description": "`GeoJSON` geometry, representing the area circle's center." + }, + "properties": { + "$ref": "#/definitions/AreaProperties", + "description": "`GeoJSON` object properties." + } + }, + "required": [ + "type", + "geometry", + "properties" + ] + }, + "GeographicLocation": { + "type": "object", + "description": "A location given as a combination of city, state and country/region. It could specify a city, a state or a country/region.\nIn case a city is specified, either state +country/region or country/region (for countries/regions where there are no states) should be added.\nIn case a state is specified (without a city), country/region should be added.", + "properties": { + "city": { + "type": "string", + "description": "City name." + }, + "state": { + "type": "string", + "description": "State name." + }, + "countryOrRegion": { + "type": "string", + "description": "Country/region name." + } + }, + "required": [ + "countryOrRegion" + ] + }, + "ImagingProcedure": { + "type": "object", + "description": "Imaging procedure.", + "properties": { + "modality": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Modality : SNOMED CT code." + }, + "anatomy": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Anatomy : SNOMED CT code." + }, + "laterality": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Laterality : SNOMED CT code." + }, + "contrast": { + "$ref": "#/definitions/RadiologyCodeWithTypes", + "description": "Contrast : see RadiologyCodeWithTypes (below)." + }, + "view": { + "$ref": "#/definitions/RadiologyCodeWithTypes", + "description": "View : see RadiologyCodeWithTypes (below)." + } + }, + "required": [ + "modality", + "anatomy" + ] + }, + "ImagingProcedureRecommendation": { + "type": "object", + "description": "Imaging procedures.", + "properties": { + "procedureCodes": { + "type": "array", + "description": "LOINC codes for the procedure.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "imagingProcedures": { + "type": "array", + "description": "Imaging procedures.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ImagingProcedure" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "imagingProcedures" + ], + "allOf": [ + { + "$ref": "#/definitions/ProcedureRecommendation" + } + ], + "x-ms-discriminator-value": "imagingProcedureRecommendation" + }, + "InferenceEvidence": { + "type": "object", + "description": "A piece of evidence corresponding to an inference.", + "properties": { + "patientDataEvidence": { + "$ref": "#/definitions/ClinicalNoteEvidence", + "description": "A piece of evidence from a clinical note (text document)." + }, + "patientInfoEvidence": { + "$ref": "#/definitions/ClinicalCodedElement", + "description": "A piece of clinical information, expressed as a code in a clinical coding\nsystem." + }, + "importance": { + "type": "number", + "format": "float", + "description": "A value indicating how important this piece of evidence is for the inference.", + "minimum": 0, + "maximum": 1 + } + } + }, + "JobStatus": { + "type": "string", + "description": "The status of the processing job.", + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "canceled" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "notStarted" + }, + { + "name": "Running", + "value": "running" + }, + { + "name": "Succeeded", + "value": "succeeded" + }, + { + "name": "Failed", + "value": "failed" + }, + { + "name": "Canceled", + "value": "canceled" + } + ] + } + }, + "LateralityDiscrepancyInference": { + "type": "object", + "description": "A laterality mismatch occurs when there is a discrepancy between the clinical documentation and the ordered procedure (orderLateralityMismatch), a contradiction within the clinical document (textLateralityContradiction), or when no laterality is mentioned (textLateralityMissing).", + "properties": { + "lateralityIndication": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Laterality indication : SNOMED CT code for laterality qualifier value." + }, + "discrepancyType": { + "$ref": "#/definitions/LateralityDiscrepancyType", + "description": "Mismatch type : orderLateralityMismatch, textLateralityContradiction, textLateralityMissing." + } + }, + "required": [ + "discrepancyType" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "lateralityDiscrepancy" + }, + "LateralityDiscrepancyType": { + "type": "string", + "description": "Laterality discrepancy type", + "enum": [ + "orderLateralityMismatch", + "textLateralityContradiction", + "textLateralityMissing" + ], + "x-ms-enum": { + "name": "LateralityDiscrepancyType", + "modelAsString": true, + "values": [ + { + "name": "OrderLateralityMismatch", + "value": "orderLateralityMismatch", + "description": "Mismatch between order and text" + }, + { + "name": "TextLateralityContradiction", + "value": "textLateralityContradiction", + "description": "Contradiction in text" + }, + { + "name": "TextLateralityMissing", + "value": "textLateralityMissing", + "description": "Missing laterality in text" + } + ] + } + }, + "LimitedOrderDiscrepancyInference": { + "type": "object", + "description": "A limited order discrepancy occurs when there is a limited order, but all body parts and measurements that are needed for a complete order are present in the document.", + "properties": { + "orderType": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast." + }, + "presentBodyParts": { + "type": "array", + "description": "List of body parts found in the document : SNOMED CT codes.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "presentBodyPartMeasurements": { + "type": "array", + "description": "List of body parts that are measured according to the document : SNOMED CT codes.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + } + }, + "required": [ + "orderType" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "limitedOrderDiscrepancy" + }, + "MedicalProfessionalType": { + "type": "string", + "description": "Medical Professional Type", + "enum": [ + "unknown", + "doctor", + "nurse", + "midwife", + "physicianAssistant" + ], + "x-ms-enum": { + "name": "MedicalProfessionalType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "unknown", + "description": "Unknown medical professional type" + }, + { + "name": "Doctor", + "value": "doctor", + "description": "Doctor medical professional type" + }, + { + "name": "Nurse", + "value": "nurse", + "description": "Nurse medical professional type" + }, + { + "name": "Midwife", + "value": "midwife", + "description": "Technician medical professional type" + }, + { + "name": "PhysicianAssistant", + "value": "physicianAssistant", + "description": "Technician medical professional type" + } + ] + } + }, + "ModelVersion": { + "type": "string", + "description": "The version of the model used for inference, expressed as the model date." + }, + "NeededClinicalInfo": { + "type": "array", + "description": "Clinical information which is needed to provide better trial matching results for the patient.", + "items": { + "$ref": "#/definitions/ExtendedClinicalCodedElement" + }, + "x-ms-identifiers": [] + }, + "OncoPhenotypeData": { + "type": "object", + "description": "The body of the Onco Phenotype request.", + "properties": { + "patients": { + "type": "array", + "description": "The list of patients, including their clinical information and data.", + "items": { + "$ref": "#/definitions/PatientRecord" + } + }, + "configuration": { + "$ref": "#/definitions/OncoPhenotypeModelConfiguration", + "description": "Configuration affecting the Onco Phenotype model's inference." + } + }, + "required": [ + "patients" + ] + }, + "OncoPhenotypeInference": { + "type": "object", + "description": "An inference made by the Onco Phenotype model regarding a patient.", + "properties": { + "type": { + "$ref": "#/definitions/OncoPhenotypeInferenceType", + "description": "The type of the Onco Phenotype inference" + }, + "value": { + "type": "string", + "description": "The value of the inference, as relevant for the given inference type." + }, + "description": { + "type": "string", + "description": "The description corresponding to the inference value." + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Confidence score for this inference.", + "minimum": 0, + "maximum": 1 + }, + "evidence": { + "type": "array", + "description": "The evidence corresponding to the inference value.", + "items": { + "$ref": "#/definitions/InferenceEvidence" + }, + "x-ms-identifiers": [] + }, + "caseId": { + "type": "string", + "description": "An identifier for a clinical case, if there are multiple clinical cases regarding the same patient." + } + }, + "required": [ + "type", + "value" + ] + }, + "OncoPhenotypeInferenceResult": { + "type": "object", + "description": "The inference results for the Onco Phenotype request.", + "properties": { + "patientResults": { + "type": "array", + "description": "Results for the patients given in the request.", + "items": { + "$ref": "#/definitions/OncoPhenotypePatientResult" + }, + "x-ms-identifiers": [] + }, + "modelVersion": { + "$ref": "#/definitions/ModelVersion", + "description": "The version of the model used for inference, expressed as the model date." + } + }, + "required": [ + "patientResults", + "modelVersion" + ] + }, + "OncoPhenotypeInferenceType": { + "type": "string", + "description": "The type of the Onco Phenotype inference.", + "enum": [ + "tumorSite", + "histology", + "clinicalStageT", + "clinicalStageN", + "clinicalStageM", + "pathologicStageT", + "pathologicStageN", + "pathologicStageM", + "diagnosisDate" + ], + "x-ms-enum": { + "name": "OncoPhenotypeInferenceType", + "modelAsString": true, + "values": [ + { + "name": "TumorSite", + "value": "tumorSite" + }, + { + "name": "Histology", + "value": "histology" + }, + { + "name": "ClinicalStageT", + "value": "clinicalStageT" + }, + { + "name": "ClinicalStageN", + "value": "clinicalStageN" + }, + { + "name": "ClinicalStageM", + "value": "clinicalStageM" + }, + { + "name": "PathologicStageT", + "value": "pathologicStageT" + }, + { + "name": "PathologicStageN", + "value": "pathologicStageN" + }, + { + "name": "PathologicStageM", + "value": "pathologicStageM" + }, + { + "name": "DiagnosisDate", + "value": "diagnosisDate" + } + ] + } + }, + "OncoPhenotypeModelConfiguration": { + "type": "object", + "description": "Configuration affecting the Onco Phenotype model's inference.", + "properties": { + "verbose": { + "type": "boolean", + "description": "An indication whether the model should produce verbose output.", + "default": false + }, + "includeEvidence": { + "type": "boolean", + "description": "An indication whether the model's output should include evidence for the inferences.", + "default": true + }, + "inferenceTypes": { + "type": "array", + "description": "A list of inference types to be inferred for the current request.\nThis could be used if only part of the Onco Phenotype inferences are required.\nIf this list is omitted or empty, the model will return all the inference types.", + "items": { + "$ref": "#/definitions/OncoPhenotypeInferenceType" + } + }, + "checkForCancerCase": { + "type": "boolean", + "description": "An indication whether to perform a preliminary step on the patient's documents to determine whether they relate to a Cancer case.", + "default": false + } + } + }, + "OncoPhenotypePatientResult": { + "type": "object", + "description": "The results of the model's work for a single patient.", + "properties": { + "patientId": { + "type": "string", + "description": "The identifier given for the patient in the request." + }, + "inferences": { + "type": "array", + "description": "The model's inferences for the given patient.", + "items": { + "$ref": "#/definitions/OncoPhenotypeInference" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "patientId", + "inferences" + ] + }, + "OncoPhenotypeResult": { + "type": "object", + "description": "The response for the Onco Phenotype request.", + "properties": { + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The unique ID of the operation.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the operation", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was created.", + "readOnly": true + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job is set to expire.", + "readOnly": true + }, + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was last updated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\"." + }, + "result": { + "$ref": "#/definitions/OncoPhenotypeInferenceResult", + "description": "The result of the operation." + } + }, + "required": [ + "id", + "status" + ] + }, + "OrderedProcedure": { + "type": "object", + "description": "Procedure information", + "properties": { + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + }, + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Procedure code" + }, + "description": { + "type": "string", + "description": "Procedure description" + } + } + }, + "PatientDocument": { + "type": "object", + "description": "A clinical document related to a patient. Document here is in the wide sense - not just a text document (note).", + "properties": { + "type": { + "$ref": "#/definitions/DocumentType", + "description": "The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document)." + }, + "clinicalType": { + "$ref": "#/definitions/ClinicalDocumentType", + "description": "The type of the clinical document." + }, + "id": { + "type": "string", + "description": "A given identifier for the document. Has to be unique across all documents for a single patient.", + "minLength": 1 + }, + "language": { + "type": "string", + "description": "A 2 letter ISO 639-1 representation of the language of the document." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the document was created." + }, + "authors": { + "type": "array", + "description": "Document author(s)", + "items": { + "$ref": "#/definitions/DocumentAuthor" + } + }, + "specialtyType": { + "$ref": "#/definitions/SpecialtyType", + "description": "specialty type the document" + }, + "administrativeMetadata": { + "$ref": "#/definitions/DocumentAdministrativeMetadata", + "description": "Administrative metadata for the document." + }, + "content": { + "$ref": "#/definitions/DocumentContent", + "description": "The content of the patient document." + } + }, + "required": [ + "type", + "id", + "content" + ] + }, + "PatientInfo": { + "type": "object", + "description": "Patient structured information, including demographics and known structured clinical information.", + "properties": { + "sex": { + "$ref": "#/definitions/PatientInfoSex", + "description": "The patient's sex." + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The patient's date of birth." + }, + "clinicalInfo": { + "type": "array", + "description": "Known clinical information for the patient, structured.", + "items": { + "$ref": "#/definitions/Fhir.R4.Resource" + } + } + } + }, + "PatientInfoSex": { + "type": "string", + "description": "The patient's sex.", + "enum": [ + "female", + "male", + "unspecified" + ], + "x-ms-enum": { + "name": "PatientInfoSex", + "modelAsString": true, + "values": [ + { + "name": "Female", + "value": "female" + }, + { + "name": "Male", + "value": "male" + }, + { + "name": "Unspecified", + "value": "unspecified" + } + ] + } + }, + "PatientRecord": { + "type": "object", + "description": "A patient record, including their clinical information and data.", + "properties": { + "id": { + "type": "string", + "description": "A given identifier for the patient. Has to be unique across all patients in a single request.", + "minLength": 1 + }, + "info": { + "$ref": "#/definitions/PatientInfo", + "description": "Patient structured information, including demographics and known structured clinical information." + }, + "encounters": { + "type": "array", + "description": "Patient encounters/visits.", + "items": { + "$ref": "#/definitions/Encounter" + } + }, + "patientDocuments": { + "type": "array", + "description": "Patient unstructured clinical data, given as documents.", + "items": { + "$ref": "#/definitions/PatientDocument" + } + } + }, + "required": [ + "id" + ] + }, + "PatientTimelineData": { + "type": "object", + "description": "The body of the Patient Timeline request.", + "properties": { + "patients": { + "type": "array", + "description": "The list of patients, including their clinical information and data.", + "items": { + "$ref": "#/definitions/PatientRecord" + } + }, + "configuration": { + "$ref": "#/definitions/PatientTimelineModelConfiguration", + "description": "Configuration affecting the Patient Timeline model's inference." + } + }, + "required": [ + "patients" + ] + }, + "PatientTimelineInference": { + "type": "object", + "description": "An inference made by the Patient Timeline model regarding a patient.", + "properties": { + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + }, + "type": { + "$ref": "#/definitions/PatientTimelineInferenceType", + "description": "The type of the Patient Timeline inference." + }, + "resource": { + "$ref": "#/definitions/Fhir.R4.DomainResource", + "description": "FHIR 4.0 representation of the piece of clinical info.\nadditional dependent resources maybe contained (e.g. MedicationStatement may contain Medication)\n-- In the SDK we will have custom mapping to map this type to JsonObject" + }, + "period": { + "$ref": "#/definitions/TimePeriod", + "description": "Time range relevant to this Timeline inference." + } + }, + "required": [ + "type" + ] + }, + "PatientTimelineInferenceResult": { + "type": "object", + "description": "The inference results for the Patient Timeline request.", + "properties": { + "patientResults": { + "type": "array", + "description": "Results for the patients given in the request.", + "items": { + "$ref": "#/definitions/PatientTimelinePatientResult" + }, + "x-ms-identifiers": [] + }, + "modelVersion": { + "$ref": "#/definitions/ModelVersion", + "description": "The version of the model used for inference, expressed as the model date." + } + }, + "required": [ + "patientResults", + "modelVersion" + ] + }, + "PatientTimelineInferenceType": { + "type": "string", + "description": "The type of the Patient Timeline inference.", + "enum": [ + "timelineEvent", + "summaryItem" + ], + "x-ms-enum": { + "name": "PatientTimelineInferenceType", + "modelAsString": true, + "values": [ + { + "name": "TimelineEvent", + "value": "timelineEvent", + "description": "The inference is a timeline event." + }, + { + "name": "SummaryItem", + "value": "summaryItem", + "description": "The inference is a summary item." + } + ] + } + }, + "PatientTimelineModelConfiguration": { + "type": "object", + "description": "Configuration affecting the Patient Timeline model's inference.", + "properties": { + "verbose": { + "type": "boolean", + "description": "An indication whether the model should produce verbose output.", + "default": false + }, + "includeEvidence": { + "type": "boolean", + "description": "An indication whether the model's output should include evidence for the inferences.", + "default": true + } + } + }, + "PatientTimelinePatientResult": { + "type": "object", + "description": "The results of the model's work for a single patient.", + "properties": { + "patientId": { + "type": "string", + "description": "The identifier given for the patient in the request." + }, + "inferences": { + "type": "array", + "description": "The model's inferences for the given patient.", + "items": { + "$ref": "#/definitions/PatientTimelineInference" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "patientId", + "inferences" + ] + }, + "PatientTimelineResult": { + "type": "object", + "description": "The response for the Patient Timeline request.", + "properties": { + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The unique ID of the operation.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the operation", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was created.", + "readOnly": true + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job is set to expire.", + "readOnly": true + }, + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was last updated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\"." + }, + "result": { + "$ref": "#/definitions/PatientTimelineInferenceResult", + "description": "The result of the operation." + } + }, + "required": [ + "id", + "status" + ] + }, + "ProcedureRecommendation": { + "type": "object", + "description": "The procedure recommendation can be a generic procedure or an imaging procedure.", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for ProcedureRecommendation." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "RadiologyCodeWithTypes": { + "type": "object", + "description": "Radiology code with types : used in imaging procedure recommendation for contrast and view.", + "properties": { + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "The SNOMED CT code indicates whether imaging was conducted with or without contrast in the case of contrast, and in the case of views, it denotes the number of views." + }, + "types": { + "type": "array", + "description": "The collection of types will indicate the contrast substance used in the case of contrast and, in the case of views, it will specify the types of views, such as lateral and frontal, etc.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + } + }, + "required": [ + "code", + "types" + ] + }, + "RadiologyInsightsData": { + "type": "object", + "description": "Contains the list of patients, and configuration data.", + "properties": { + "patients": { + "type": "array", + "description": "The list of patients, including their clinical information and data.", + "items": { + "$ref": "#/definitions/PatientRecord" + } + }, + "configuration": { + "$ref": "#/definitions/RadiologyInsightsModelConfiguration", + "description": "Configuration affecting the Radiology Insights model's inference." + } + }, + "required": [ + "patients" + ] + }, + "RadiologyInsightsInference": { + "type": "object", + "description": "An inference made by the Radiology Insights model regarding a patient.\n - AgeMismatch\n - SexMismatch\n - LateralityDiscrepancy\n - CompleteOrderDiscrepancy\n - LimitedOrderDiscrepancy\n - Finding\n - CriticalResult\n - FollowupRecommendation\n - RadiologyProcedure\n - FollowupCommunication", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for RadiologyInsightsInference." + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "RadiologyInsightsInferenceOptions": { + "type": "object", + "description": "Options regarding follow up recommendation inferences and finding inferences.", + "properties": { + "followupRecommendationOptions": { + "$ref": "#/definitions/FollowupRecommendationOptions", + "description": "Follow-up recommendation options." + }, + "findingOptions": { + "$ref": "#/definitions/FindingOptions", + "description": "Finding options." + } + } + }, + "RadiologyInsightsInferenceResult": { + "type": "object", + "description": "The inference results for the Radiology Insights request. If field 'status' has value 'succeeded', then field 'result' will contain an instance of RadiologyInsightsInferenceResult.", + "properties": { + "patientResults": { + "type": "array", + "description": "Results for the patients given in the request.", + "items": { + "$ref": "#/definitions/RadiologyInsightsPatientResult" + }, + "x-ms-identifiers": [] + }, + "modelVersion": { + "$ref": "#/definitions/ModelVersion", + "description": "The version of the model used for inference, expressed as the model date." + } + }, + "required": [ + "patientResults", + "modelVersion" + ] + }, + "RadiologyInsightsInferenceType": { + "type": "string", + "description": "A Radiology Insights inference types.", + "enum": [ + "ageMismatch", + "lateralityDiscrepancy", + "sexMismatch", + "completeOrderDiscrepancy", + "limitedOrderDiscrepancy", + "finding", + "criticalResult", + "followupRecommendation", + "followupCommunication", + "radiologyProcedure" + ], + "x-ms-enum": { + "name": "RadiologyInsightsInferenceType", + "modelAsString": true, + "values": [ + { + "name": "AgeMismatch", + "value": "ageMismatch", + "description": "Age mismatch inference type" + }, + { + "name": "LateralityDiscrepancy", + "value": "lateralityDiscrepancy", + "description": "Laterality discrepancy inference type" + }, + { + "name": "SexMismatch", + "value": "sexMismatch", + "description": "Sex mismatch inference type" + }, + { + "name": "CompleteOrderDiscrepancy", + "value": "completeOrderDiscrepancy", + "description": "Complete order discrepancy inference type" + }, + { + "name": "LimitedOrderDiscrepancy", + "value": "limitedOrderDiscrepancy", + "description": "Limited order discrepancy inference type" + }, + { + "name": "Finding", + "value": "finding", + "description": "Finding inference type" + }, + { + "name": "CriticalResult", + "value": "criticalResult", + "description": "Critical finding inference type" + }, + { + "name": "FollowupRecommendation", + "value": "followupRecommendation", + "description": "Recommendation inference type" + }, + { + "name": "FollowupCommunication", + "value": "followupCommunication", + "description": "Followup Communication inference type" + }, + { + "name": "RadiologyProcedure", + "value": "radiologyProcedure", + "description": "Radiology Procedure inference type" + } + ] + } + }, + "RadiologyInsightsModelConfiguration": { + "type": "object", + "description": "Configuration affecting the Radiology Insights model's inference.", + "properties": { + "verbose": { + "type": "boolean", + "description": "An indication whether the model should produce verbose output.", + "default": false + }, + "includeEvidence": { + "type": "boolean", + "description": "An indication whether the model's output should include evidence for the inferences.", + "default": true + }, + "inferenceTypes": { + "type": "array", + "description": "This is a list of inference types to be inferred for the current request. It could be used if only part of the Radiology Insights inferences are required. If this list is omitted or empty, the model will return all the inference types.", + "items": { + "$ref": "#/definitions/RadiologyInsightsInferenceType" + } + }, + "inferenceOptions": { + "$ref": "#/definitions/RadiologyInsightsInferenceOptions", + "description": "Options regarding follow up recommendation inferences and finding inferences." + }, + "locale": { + "type": "string", + "description": "Local for the model to use. If not specified, the model will use the default locale." + } + } + }, + "RadiologyInsightsPatientResult": { + "type": "object", + "description": "Results of the model's work for a single patient.", + "properties": { + "patientId": { + "type": "string", + "description": "Identifier given for the patient in the request." + }, + "inferences": { + "type": "array", + "description": "The model's inferences for the given patient.", + "items": { + "$ref": "#/definitions/RadiologyInsightsInference" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "patientId", + "inferences" + ] + }, + "RadiologyInsightsResult": { + "type": "object", + "description": "Response for the Radiology Insights request.", + "properties": { + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The unique ID of the operation.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the operation", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was created.", + "readOnly": true + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job is set to expire.", + "readOnly": true + }, + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was last updated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\"." + }, + "result": { + "$ref": "#/definitions/RadiologyInsightsInferenceResult", + "description": "The result of the operation." + } + }, + "required": [ + "id", + "status" + ] + }, + "RadiologyProcedureInference": { + "type": "object", + "description": "Radiology procedures are the specific imaging studies or examinations ordered for the patient, extracted from the document information and text.", + "properties": { + "procedureCodes": { + "type": "array", + "description": "LOINC codes for the procedure.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "imagingProcedures": { + "type": "array", + "description": "Imaging procedures.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ImagingProcedure" + }, + "x-ms-identifiers": [] + }, + "orderedProcedure": { + "$ref": "#/definitions/OrderedProcedure", + "description": "Ordered procedure information from the document information or text." + } + }, + "required": [ + "imagingProcedures", + "orderedProcedure" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "radiologyProcedure" + }, + "RecommendationFinding": { + "type": "object", + "description": "Finding reference for recommendation.", + "properties": { + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + }, + "finding": { + "$ref": "#/definitions/Fhir.R4.Observation", + "description": "Finding linked to a recommendation." + }, + "criticalFinding": { + "$ref": "#/definitions/CriticalResult", + "description": "Critical result linked to a recommendation." + }, + "recommendationFindingStatus": { + "$ref": "#/definitions/RecommendationFindingStatusType", + "description": "Recommendation finding status." + } + }, + "required": [ + "recommendationFindingStatus" + ] + }, + "RecommendationFindingStatusType": { + "type": "string", + "description": "Recommendation finding status", + "enum": [ + "present", + "differential", + "ruleOut", + "conditional" + ], + "x-ms-enum": { + "name": "RecommendationFindingStatusType", + "modelAsString": true, + "values": [ + { + "name": "Present", + "value": "present", + "description": "Present finding status" + }, + { + "name": "Differential", + "value": "differential", + "description": "Differential finding status" + }, + { + "name": "RuleOut", + "value": "ruleOut", + "description": "Rule out finding status" + }, + { + "name": "Conditional", + "value": "conditional", + "description": "Conditional finding status" + } + ] + } + }, + "SexMismatchInference": { + "type": "object", + "description": "A notification for a sex mismatch is displayed when the gender, personal pronouns, gender-related body parts, or gender-related procedures mentioned in a patient's clinical document are either inconsistent or do not match the gender specified in the patient information.", + "properties": { + "sexIndication": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Sex indication : SNOMED CT code for gender finding." + } + }, + "required": [ + "sexIndication" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "sexMismatch" + }, + "SpecialtyType": { + "type": "string", + "description": "Known values codes that can be used to indicate the type of the Specialty.", + "enum": [ + "pathology", + "radiology" + ], + "x-ms-enum": { + "name": "SpecialtyType", + "modelAsString": true, + "values": [ + { + "name": "Pathology", + "value": "pathology", + "description": "pathology" + }, + { + "name": "Radiology", + "value": "radiology", + "description": "radiology" + } + ] + } + }, + "TimePeriod": { + "type": "object", + "description": "A duration of time during which an event is happening", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "Starting time with inclusive boundary" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "End time with inclusive boundary, if not ongoing" + } + } + }, + "TrialMatcherData": { + "type": "object", + "description": "The body of the Trial Matcher request.", + "properties": { + "patients": { + "type": "array", + "description": "The list of patients, including their clinical information and data.", + "items": { + "$ref": "#/definitions/PatientRecord" + } + }, + "configuration": { + "$ref": "#/definitions/TrialMatcherModelConfiguration", + "description": "Configuration affecting the Trial Matcher model's inference." + } + }, + "required": [ + "patients" + ] + }, + "TrialMatcherInference": { + "type": "object", + "description": "An inference made by the Trial Matcher model regarding a patient.", + "properties": { + "type": { + "$ref": "#/definitions/TrialMatcherInferenceType", + "description": "The type of the Trial Matcher inference." + }, + "value": { + "type": "string", + "description": "The value of the inference, as relevant for the given inference type." + }, + "description": { + "type": "string", + "description": "The description corresponding to the inference value." + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Confidence score for this inference.", + "minimum": 0, + "maximum": 1 + }, + "evidence": { + "type": "array", + "description": "The evidence corresponding to the inference value.", + "items": { + "$ref": "#/definitions/TrialMatcherInferenceEvidence" + }, + "x-ms-identifiers": [] + }, + "clinicalTrialId": { + "type": "string", + "description": "The identifier of the clinical trial.", + "minLength": 1 + }, + "source": { + "$ref": "#/definitions/ClinicalTrialSource", + "description": "Possible sources of a clinical trial." + }, + "metadata": { + "$ref": "#/definitions/ClinicalTrialMetadata", + "description": "Trial data which is of interest to the potential participant." + } + }, + "required": [ + "type", + "value" + ] + }, + "TrialMatcherInferenceEvidence": { + "type": "object", + "description": "A piece of evidence corresponding to a Trial Matcher inference.", + "properties": { + "eligibilityCriteriaEvidence": { + "type": "string", + "description": "A piece of evidence from the eligibility criteria text of a clinical trial." + }, + "patientDataEvidence": { + "$ref": "#/definitions/ClinicalNoteEvidence", + "description": "A piece of evidence from a clinical note (text document)." + }, + "patientInfoEvidence": { + "$ref": "#/definitions/ClinicalCodedElement", + "description": "A piece of clinical information, expressed as a code in a clinical coding\nsystem." + }, + "importance": { + "type": "number", + "format": "float", + "description": "A value indicating how important this piece of evidence is for the inference.", + "minimum": 0, + "maximum": 1 + } + } + }, + "TrialMatcherInferenceResult": { + "type": "object", + "description": "The inference results for the Trial Matcher request.", + "properties": { + "patientResults": { + "type": "array", + "description": "Results for the patients given in the request.", + "items": { + "$ref": "#/definitions/TrialMatcherPatientResult" + }, + "x-ms-identifiers": [] + }, + "modelVersion": { + "$ref": "#/definitions/ModelVersion", + "description": "The version of the model used for inference, expressed as the model date." + }, + "knowledgeGraphLastUpdateDate": { + "type": "string", + "format": "date", + "description": "The date when the clinical trials knowledge graph was last updated." + } + }, + "required": [ + "patientResults", + "modelVersion" + ] + }, + "TrialMatcherInferenceType": { + "type": "string", + "description": "The type of the Trial Matcher inference.", + "enum": [ + "trialEligibility" + ], + "x-ms-enum": { + "name": "TrialMatcherInferenceType", + "modelAsString": true, + "values": [ + { + "name": "TrialEligibility", + "value": "trialEligibility" + } + ] + } + }, + "TrialMatcherModelConfiguration": { + "type": "object", + "description": "Configuration affecting the Trial Matcher model's inference.", + "properties": { + "verbose": { + "type": "boolean", + "description": "An indication whether the model should produce verbose output.", + "default": false + }, + "includeEvidence": { + "type": "boolean", + "description": "An indication whether the model's output should include evidence for the inferences.", + "default": true + }, + "clinicalTrials": { + "$ref": "#/definitions/ClinicalTrials", + "description": "The clinical trials that the patient(s) should be matched to.
The trial\nselection can be given as a list of custom clinical trials and/or a list of\nfilters to known clinical trial registries. In case both are given, the\nresulting trial set is a union of the two sets." + } + }, + "required": [ + "clinicalTrials" + ] + }, + "TrialMatcherPatientResult": { + "type": "object", + "description": "The results of the model's work for a single patient.", + "properties": { + "patientId": { + "type": "string", + "description": "The identifier given for the patient in the request." + }, + "inferences": { + "type": "array", + "description": "The inference results for the patient.", + "items": { + "$ref": "#/definitions/TrialMatcherInference" + }, + "x-ms-identifiers": [] + }, + "neededClinicalInfo": { + "$ref": "#/definitions/NeededClinicalInfo", + "description": "Clinical information which is needed to provide better trial matching results for the patient." + } + }, + "required": [ + "patientId", + "inferences" + ] + }, + "TrialMatcherResult": { + "type": "object", + "description": "The response for the Trial Matcher request.", + "properties": { + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The unique ID of the operation.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the operation", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was created.", + "readOnly": true + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job is set to expire.", + "readOnly": true + }, + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was last updated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\"." + }, + "result": { + "$ref": "#/definitions/TrialMatcherInferenceResult", + "description": "The result of the operation." + } + }, + "required": [ + "id", + "status" + ] + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent": { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "Specifies the date and time at which the request was first created.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method", + "x-ms-client-name": "repeatabilityFirstSent" + }, + "Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId": { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-client-name": "repeatabilityRequestId" + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/readme.md b/specification/ai/data-plane/HealthInsights/readme.md index 9e8e2f518b94..4d885f884815 100644 --- a/specification/ai/data-plane/HealthInsights/readme.md +++ b/specification/ai/data-plane/HealthInsights/readme.md @@ -4,10 +4,10 @@ Configuration for generating Health Insights SDK. -The current release is `2023-03-01-preview`. +The current release is `2023-09-01-preview`. ```yaml -tag: 2023-03-01-preview +tag: 2023-09-01-preview add-credentials: true openapi-type: data-plane ``` @@ -22,4 +22,20 @@ These settings apply only when `--tag=2023-03-01-preview` is specified on the co ```yaml $(tag) == '2023-03-01-preview' input-file: - preview/2023-03-01-preview/openapi.json +``` + +### Release 2023-09-01-preview + + +These settings apply only when `--tag=2023-09-01-preview` is specified on the command line. + +```yaml $(tag) == '2023-09-01-preview' +input-file: + - preview/2023-09-01-preview/openapi.json +``` + +```yaml +directive: + - suppress: AvoidAnonymousTypes + reason: The spec is auto-generated. Tracking issue to fix is https://github.com/Azure/typespec-azure-pr/issues/3349 ``` \ No newline at end of file diff --git a/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromBuffer_MaximumSet.json b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json similarity index 99% rename from specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromBuffer_MaximumSet.json rename to specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json index c8f2cd466ddb..336d20f470b1 100644 --- a/specification/ai/ImageAnalysis/examples/2023-10-01/AnalyzeFromBuffer_MaximumSet.json +++ b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/examples/AnalyzeFromImageData_MaximumSet.json @@ -1,6 +1,6 @@ { - "title": "AnalyzeFromBuffer", - "operationId": "AnalyzeFromBuffer", + "title": "AnalyzeFromImageData", + "operationId": "AnalyzeFromImageData", "parameters": { "api-version": "2023-10-01", "features": [ diff --git a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json index edab1f7c4e1a..a223b95be137 100644 --- a/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json +++ b/specification/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json @@ -49,7 +49,7 @@ "paths": { "/imageanalysis:analyze": { "post": { - "operationId": "AnalyzeFromBuffer", + "operationId": "AnalyzeFromImageData", "description": "Performs a single Image Analysis operation", "consumes": [ "application/octet-stream" @@ -196,8 +196,8 @@ } }, "x-ms-examples": { - "AnalyzeFromBuffer": { - "$ref": "./examples/AnalyzeFromBuffer_MaximumSet.json" + "AnalyzeFromImageData": { + "$ref": "./examples/AnalyzeFromImageData_MaximumSet.json" } } } diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json new file mode 100644 index 000000000000..436e3f654419 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2023-02-15-preview/assistants_generated.json @@ -0,0 +1,3452 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI", + "version": "2023-02-15-preview", + "description": "Azure OpenAI APIs for Assistants.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "An OpenAI endpoint supporting assistants functionality.", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "api-key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/assistants": { + "get": { + "operationId": "ListAssistants", + "description": "Gets a list of assistants that were previously created.", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of assistants.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/Assistant" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateAssistant", + "description": "Creates a new assistant.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AssistantCreationOptions" + } + } + ], + "responses": { + "200": { + "description": "The new assistant instance.", + "schema": { + "$ref": "#/definitions/Assistant" + } + } + } + } + }, + "/assistants/{assistantId}": { + "get": { + "operationId": "GetAssistant", + "description": "Retrieves an existing assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested assistant instance.", + "schema": { + "$ref": "#/definitions/Assistant" + } + } + } + }, + "post": { + "operationId": "ModifyAssistant", + "description": "Modifies an existing assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to modify.", + "required": true, + "type": "string" + }, + { + "name": "modificationOptions", + "in": "body", + "description": "The details of the modification to perform on the specified assistant.", + "required": true, + "schema": { + "$ref": "#/definitions/AssistantModificationOptions" + } + } + ], + "responses": { + "200": { + "description": "The updated assistant instance.", + "schema": { + "$ref": "#/definitions/Assistant" + } + } + } + }, + "delete": { + "operationId": "DeleteAssistant", + "description": "Deletes an assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Status information about the requested deletion operation.", + "schema": { + "$ref": "#/definitions/AssistantDeletionStatus" + } + } + } + } + }, + "/assistants/{assistantId}/files": { + "get": { + "operationId": "ListAssistantFiles", + "description": "Gets a list of files attached to a specific assistant, as used by tools that can read files.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to retrieve the list of attached files for.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of files attached to the specified assistant.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/AssistantFile" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateAssistantFile", + "description": "Attaches a previously uploaded file to an assistant for use by tools that can read files.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to attach the file to.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the previously uploaded file to attach.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + } + } + ], + "responses": { + "200": { + "description": "Information about the attached file.", + "schema": { + "$ref": "#/definitions/AssistantFile" + } + } + } + } + }, + "/assistants/{assistantId}/files/{fileId}": { + "get": { + "operationId": "GetAssistantFile", + "description": "Retrieves a file attached to an assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant associated with the attached file.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A representation of the attached file.", + "schema": { + "$ref": "#/definitions/AssistantFile" + } + } + } + }, + "delete": { + "operationId": "DeleteAssistantFile", + "description": "Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read\nfiles.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant from which the specified file should be unlinked.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to unlink from the specified assistant.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Status information about the requested file association deletion.", + "schema": { + "$ref": "#/definitions/AssistantFileDeletionStatus" + } + } + } + } + }, + "/files": { + "get": { + "operationId": "ListFiles", + "description": "Gets a list of previously uploaded files.", + "parameters": [ + { + "name": "purpose", + "in": "query", + "description": "A value that, when provided, limits list results to files matching the corresponding purpose.", + "required": false, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output" + ], + "x-ms-enum": { + "name": "FilePurpose", + "modelAsString": true, + "values": [ + { + "name": "fineTune", + "value": "fine-tune", + "description": "Indicates a file is used for fine tuning input." + }, + { + "name": "fineTuneResults", + "value": "fine-tune-results", + "description": "Indicates a file is used for fine tuning results." + }, + { + "name": "assistants", + "value": "assistants", + "description": "Indicates a file is used as input to assistants." + }, + { + "name": "assistantsOutput", + "value": "assistants_output", + "description": "Indicates a file is used as output by assistants." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The requested list of files.", + "schema": { + "$ref": "#/definitions/FileListResponse" + } + } + } + }, + "post": { + "operationId": "CreateFile", + "description": "Uploads a file for use by other operations.", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "name": "file", + "in": "formData", + "description": "The file data (not filename) to upload.", + "required": true, + "type": "file" + }, + { + "name": "purpose", + "in": "formData", + "description": "The intended purpose of the file.", + "required": true, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output" + ], + "x-ms-enum": { + "name": "FilePurpose", + "modelAsString": true, + "values": [ + { + "name": "fineTune", + "value": "fine-tune", + "description": "Indicates a file is used for fine tuning input." + }, + { + "name": "fineTuneResults", + "value": "fine-tune-results", + "description": "Indicates a file is used for fine tuning results." + }, + { + "name": "assistants", + "value": "assistants", + "description": "Indicates a file is used as input to assistants." + }, + { + "name": "assistantsOutput", + "value": "assistants_output", + "description": "Indicates a file is used as output by assistants." + } + ] + } + }, + { + "name": "filename", + "in": "formData", + "description": "A filename to associate with the uploaded data.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A representation of the uploaded file.", + "schema": { + "$ref": "#/definitions/OpenAIFile" + } + } + } + } + }, + "/files/{fileId}": { + "get": { + "operationId": "RetrieveFile", + "description": "Returns information about a specific file. Does not retrieve file content.", + "parameters": [ + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OpenAIFile" + } + } + } + }, + "delete": { + "operationId": "DeleteFile", + "description": "Delete a previously uploaded file.", + "parameters": [ + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/FileDeletionStatus" + } + } + } + } + }, + "/threads": { + "post": { + "operationId": "CreateThread", + "description": "Creates a new thread. Threads contain messages and can be run by assistants.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AssistantThreadCreationOptions" + } + } + ], + "responses": { + "200": { + "description": "Information about the newly created thread.", + "schema": { + "$ref": "#/definitions/AssistantThread" + } + } + } + } + }, + "/threads/{threadId}": { + "get": { + "operationId": "GetThread", + "description": "Gets information about an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to retrieve information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Information about the requested thread.", + "schema": { + "$ref": "#/definitions/AssistantThread" + } + } + } + }, + "post": { + "operationId": "ModifyThread", + "description": "Modifies an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to modify.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "Information about the modified thread.", + "schema": { + "$ref": "#/definitions/AssistantThread" + } + } + } + }, + "delete": { + "operationId": "DeleteThread", + "description": "Deletes an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Status information about the requested thread deletion operation.", + "schema": { + "$ref": "#/definitions/ThreadDeletionStatus" + } + } + } + } + }, + "/threads/{threadId}/messages": { + "get": { + "operationId": "ListMessages", + "description": "Gets a list of messages that exist on a thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to list messages from.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of messages.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/ThreadMessage" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateMessage", + "description": "Creates a new message on a specified thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to create the new message on.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "role": { + "$ref": "#/definitions/MessageRole", + "description": "The role to associate with the new message." + }, + "content": { + "type": "string", + "description": "The textual content for the new message." + }, + "file_ids": { + "type": "array", + "description": "A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files.", + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "role", + "content" + ] + } + } + ], + "responses": { + "200": { + "description": "A representation of the new message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + } + }, + "/threads/{threadId}/messages/{messageId}": { + "get": { + "operationId": "GetMessage", + "description": "Gets an existing message from an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to retrieve the specified message from.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to retrieve from the specified thread.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A representation of the requested message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + }, + "post": { + "operationId": "ModifyMessage", + "description": "Modifies an existing message on an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread containing the specified message to modify.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to modify on the specified thread.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "A representation of the modified message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + } + }, + "/threads/{threadId}/messages/{messageId}/files": { + "get": { + "operationId": "ListMessageFiles", + "description": "Gets a list of previously uploaded files associated with a message from a thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread containing the message to list files from.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to list files from.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of files associated with the specified message.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/MessageFile" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + } + }, + "/threads/{threadId}/messages/{messageId}/files/{fileId}": { + "get": { + "operationId": "GetMessageFile", + "description": "Gets information about a file attachment to a message within a thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread containing the message to get information from.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to get information from.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to get information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested file information.", + "schema": { + "$ref": "#/definitions/MessageFile" + } + } + } + } + }, + "/threads/{threadId}/runs": { + "get": { + "operationId": "ListRuns", + "description": "Gets a list of runs for a specified thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to list runs from.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of thread runs.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/ThreadRun" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateRun", + "description": "Creates a new run for an assistant thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to run.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "assistant_id": { + "type": "string", + "description": "The ID of the assistant that should run the thread.", + "x-ms-client-name": "assistantId" + }, + "model": { + "type": "string", + "description": "The overridden model name that the assistant should use to run the thread." + }, + "instructions": { + "type": "string", + "description": "The overridden system instructions that the assistant should use to run the thread." + }, + "tools": { + "type": "array", + "description": "The overridden list of enabled tools that the assistant should use to run the thread.", + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "assistant_id" + ] + } + } + ], + "responses": { + "200": { + "description": "Information about the new thread run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}": { + "get": { + "operationId": "GetRun", + "description": "Gets an existing run from an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to retrieve run information from.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the thread to retrieve information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested information about the specified thread run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + }, + "post": { + "operationId": "ModifyRun", + "description": "Modifies an existing thread run.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread associated with the specified run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run to modify.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "Information about the modified run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/cancel": { + "post": { + "operationId": "CancelRun", + "description": "Cancels a run of an in progress thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread being run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run to cancel.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Updated information about the cancelled run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/steps": { + "get": { + "operationId": "ListRunSteps", + "description": "Gets a list of run steps from a thread run.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread that was run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run to list steps from.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of run steps.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/RunStep" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/steps/{stepId}": { + "get": { + "operationId": "GetRunStep", + "description": "Gets a single run step from a thread run.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread that was run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the specific run to retrieve the step from.", + "required": true, + "type": "string" + }, + { + "name": "stepId", + "in": "path", + "description": "The ID of the step to retrieve information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Information about the requested run step.", + "schema": { + "$ref": "#/definitions/RunStep" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/submit_tool_outputs": { + "post": { + "operationId": "SubmitToolOutputsToRun", + "description": "Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread that was run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run that requires tool outputs.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "tool_outputs": { + "type": "array", + "description": "The list of tool outputs requested by tool calls from the specified run.", + "items": { + "$ref": "#/definitions/ToolOutput" + }, + "x-ms-client-name": "toolOutputs", + "x-ms-identifiers": [] + } + }, + "required": [ + "tool_outputs" + ] + } + } + ], + "responses": { + "200": { + "description": "Updated information about the run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/runs": { + "post": { + "operationId": "CreateThreadAndRun", + "description": "Creates a new assistant thread and immediately starts a run using that new thread.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateAndRunThreadOptions" + } + } + ], + "responses": { + "200": { + "description": "Information about the newly created thread.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + } + }, + "definitions": { + "Assistant": { + "type": "object", + "description": "Represents an assistant that can call the model and use tools.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always assistant.", + "enum": [ + "assistant" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "name": { + "type": "string", + "description": "The name of the assistant.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "The description of the assistant.", + "x-nullable": true + }, + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "instructions": { + "type": "string", + "description": "The system instructions for the assistant to use.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The collection of tools enabled for the assistant.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "file_ids": { + "type": "array", + "description": "A list of attached file IDs, ordered by creation date in ascending order.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "name", + "description", + "model", + "instructions", + "tools", + "file_ids", + "metadata" + ] + }, + "AssistantCreationOptions": { + "type": "object", + "description": "The request details to use when creating a new assistant.", + "properties": { + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "name": { + "type": "string", + "description": "The name of the new assistant.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "The description of the new assistant.", + "x-nullable": true + }, + "instructions": { + "type": "string", + "description": "The system instructions for the new assistant to use.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The collection of tools to enable for the new assistant.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "file_ids": { + "type": "array", + "description": "A list of previously uploaded file IDs to attach to the assistant.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "model" + ] + }, + "AssistantDeletionStatus": { + "type": "object", + "description": "The status of an assistant deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'assistant.deleted'.", + "enum": [ + "assistant.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "AssistantFile": { + "type": "object", + "description": "Information about a file attached to an assistant, as used by tools that can read files.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'assistant.file'.", + "enum": [ + "assistant.file" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "assistant_id": { + "type": "string", + "description": "The assistant ID that the file is attached to.", + "x-ms-client-name": "assistantId" + } + }, + "required": [ + "id", + "object", + "created_at", + "assistant_id" + ] + }, + "AssistantFileDeletionStatus": { + "type": "object", + "description": "The status of an assistant file deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'assistant.file.deleted'.", + "enum": [ + "assistant.file.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "AssistantModificationOptions": { + "type": "object", + "description": "The request details to use when modifying an existing assistant.", + "properties": { + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "name": { + "type": "string", + "description": "The modified name for the assistant to use.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "The modified description for the assistant to use.", + "x-nullable": true + }, + "instructions": { + "type": "string", + "description": "The modified system instructions for the new assistant to use.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The modified collection of tools to enable for the assistant.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "file_ids": { + "type": "array", + "description": "The modified list of previously uploaded fileIDs to attach to the assistant.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "AssistantThread": { + "type": "object", + "description": "Information about a single thread associated with an assistant.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread'.", + "enum": [ + "thread" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "metadata" + ] + }, + "AssistantThreadCreationOptions": { + "type": "object", + "description": "The details used to create a new assistant thread.", + "properties": { + "messages": { + "type": "array", + "description": "The messages to associate with the new thread.", + "items": { + "$ref": "#/definitions/ThreadMessage" + } + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "CodeInterpreterImageOutput": { + "type": "object", + "description": "A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.", + "properties": { + "image": { + "$ref": "#/definitions/CodeInterpreterImageReference", + "description": "Referential information for the image associated with this output." + } + }, + "required": [ + "image" + ], + "allOf": [ + { + "$ref": "#/definitions/CodeInterpreterToolCallOutput" + } + ], + "x-ms-discriminator-value": "image" + }, + "CodeInterpreterImageReference": { + "type": "object", + "description": "An image reference emitted by a code interpreter tool in response to a tool call by the model.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file associated with this image.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "CodeInterpreterLogOutput": { + "type": "object", + "description": "A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.", + "properties": { + "logs": { + "type": "string", + "description": "The serialized log output emitted by the code interpreter." + } + }, + "required": [ + "logs" + ], + "allOf": [ + { + "$ref": "#/definitions/CodeInterpreterToolCallOutput" + } + ], + "x-ms-discriminator-value": "logs" + }, + "CodeInterpreterToolCall": { + "type": "object", + "description": "A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that\nrepresents submitted output needed or already fulfilled by the tool for the model to continue.", + "properties": { + "code_interpreter": { + "$ref": "#/definitions/CodeInterpreterToolCallDetails", + "description": "The details of the tool call to the code interpreter tool.", + "x-ms-client-name": "codeInterpreter" + } + }, + "required": [ + "code_interpreter" + ], + "allOf": [ + { + "$ref": "#/definitions/ToolCall" + } + ], + "x-ms-discriminator-value": "code_interpreter" + }, + "CodeInterpreterToolCallDetails": { + "type": "object", + "description": "The detailed information about a code interpreter invocation by the model.", + "properties": { + "input": { + "type": "string", + "description": "The input provided by the model to the code interpreter tool." + }, + "outputs": { + "type": "array", + "description": "The outputs produced by the code interpreter tool back to the model in response to the tool call.", + "items": { + "$ref": "#/definitions/CodeInterpreterToolCallOutput" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "input", + "outputs" + ] + }, + "CodeInterpreterToolCallOutput": { + "type": "object", + "description": "An abstract representation of an emitted output from a code interpreter tool.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "CodeInterpreterToolDefinition": { + "type": "object", + "description": "The input definition information for a code interpreter tool as used to configure an assistant.", + "allOf": [ + { + "$ref": "#/definitions/ToolDefinition" + } + ], + "x-ms-discriminator-value": "code_interpreter" + }, + "CreateAndRunThreadOptions": { + "type": "object", + "description": "The details used when creating and immediately running a new assistant thread.", + "properties": { + "assistant_id": { + "type": "string", + "description": "The ID of the assistant for which the thread should be created.", + "x-ms-client-name": "assistantId" + }, + "thread": { + "$ref": "#/definitions/AssistantThreadCreationOptions", + "description": "The details used to create the new thread." + }, + "model": { + "type": "string", + "description": "The overridden model that the assistant should use to run the thread." + }, + "instructions": { + "type": "string", + "description": "The overridden system instructions the assistant should use to run the thread." + }, + "tools": { + "type": "array", + "description": "The overridden list of enabled tools the assistant should use to run the thread.", + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "assistant_id" + ] + }, + "FileDeletionStatus": { + "type": "object", + "description": "A status response from a file deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'file'.", + "enum": [ + "file" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "FileListResponse": { + "type": "object", + "description": "The response data from a file list operation.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always 'list'.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The files returned for the request.", + "items": { + "$ref": "#/definitions/OpenAIFile" + } + } + }, + "required": [ + "object", + "data" + ] + }, + "FilePurpose": { + "type": "string", + "description": "The possible values denoting the intended usage of a file.", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output" + ], + "x-ms-enum": { + "name": "FilePurpose", + "modelAsString": true, + "values": [ + { + "name": "fineTune", + "value": "fine-tune", + "description": "Indicates a file is used for fine tuning input." + }, + { + "name": "fineTuneResults", + "value": "fine-tune-results", + "description": "Indicates a file is used for fine tuning results." + }, + { + "name": "assistants", + "value": "assistants", + "description": "Indicates a file is used as input to assistants." + }, + { + "name": "assistantsOutput", + "value": "assistants_output", + "description": "Indicates a file is used as output by assistants." + } + ] + } + }, + "FunctionDefinition": { + "type": "object", + "description": "The input definition information for a function.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to be called." + }, + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "parameters": { + "description": "The parameters the functions accepts, described as a JSON Schema object." + } + }, + "required": [ + "name", + "parameters" + ] + }, + "FunctionToolCall": { + "type": "object", + "description": "A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\ngiven function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue.", + "properties": { + "function": { + "$ref": "#/definitions/FunctionToolCallDetails", + "description": "The detailed information about the function called by the model." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/ToolCall" + } + ], + "x-ms-discriminator-value": "function" + }, + "FunctionToolCallDetails": { + "type": "object", + "description": "The detailed information about the function called by the model.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments that the model requires are provided to the named function." + }, + "output": { + "type": "string", + "description": "The output of the function, only populated for function calls that have already have had their outputs submitted.", + "x-nullable": true + } + }, + "required": [ + "name", + "arguments", + "output" + ] + }, + "FunctionToolDefinition": { + "type": "object", + "description": "The input definition information for a function tool as used to configure an assistant.", + "properties": { + "function": { + "$ref": "#/definitions/FunctionDefinition", + "description": "The definition of the concrete function that the function tool should call." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/ToolDefinition" + } + ], + "x-ms-discriminator-value": "function" + }, + "MessageContent": { + "type": "object", + "description": "An abstract representation of a single item of thread message content.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "MessageFile": { + "type": "object", + "description": "Information about a file attached to an assistant thread message.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.message.file'.", + "enum": [ + "thread.message.file" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "message_id": { + "type": "string", + "description": "The ID of the message that this file is attached to.", + "x-ms-client-name": "messageId" + } + }, + "required": [ + "id", + "object", + "created_at", + "message_id" + ] + }, + "MessageFileCitationTextAnnotation": { + "type": "object", + "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.", + "properties": { + "file_citation": { + "$ref": "#/definitions/MessageTextFileCitationDetails", + "description": "A citation within the message that points to a specific quote from a specific file.\nGenerated when the assistant uses the \"retrieval\" tool to search files.", + "x-ms-client-name": "fileCitation" + } + }, + "required": [ + "file_citation" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTextAnnotation" + } + ], + "x-ms-discriminator-value": "file_citation" + }, + "MessageFilePathDetails": { + "type": "object", + "description": "An encapsulation of an image file ID, as used by message image content.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the specific file that the citation is from.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "MessageFilePathTextAnnotation": { + "type": "object", + "description": "A citation within the message that points to a file located at a specific path.", + "properties": { + "file_path": { + "$ref": "#/definitions/MessageFilePathDetails", + "description": "A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.", + "x-ms-client-name": "filePath" + } + }, + "required": [ + "file_path" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTextAnnotation" + } + ], + "x-ms-discriminator-value": "file_path" + }, + "MessageImageFileContent": { + "type": "object", + "description": "A representation of image file content in a thread message.", + "properties": { + "image_file": { + "$ref": "#/definitions/MessageImageFileDetails", + "description": "The image file for this thread message content item.", + "x-ms-client-name": "imageFile" + } + }, + "required": [ + "image_file" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageContent" + } + ], + "x-ms-discriminator-value": "image_file" + }, + "MessageImageFileDetails": { + "type": "object", + "description": "An image reference, as represented in thread message content.", + "properties": { + "file_id": { + "$ref": "#/definitions/MessageImageFileIdDetails", + "description": "The ID for the file associated with this image.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "MessageImageFileIdDetails": { + "type": "object", + "description": "An encapsulation of an image file ID, as used by message image content.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the specific image file.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "MessageRole": { + "type": "string", + "description": "The possible values for roles attributed to messages in a thread.", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "MessageRole", + "modelAsString": true, + "values": [ + { + "name": "user", + "value": "user", + "description": "The role representing the end-user." + }, + { + "name": "assistant", + "value": "assistant", + "description": "The role representing the assistant." + } + ] + } + }, + "MessageTextAnnotation": { + "type": "object", + "description": "An abstract representation of an annotation to text thread message content.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + }, + "text": { + "type": "string", + "description": "The textual content associated with this text annotation item." + }, + "start_index": { + "type": "integer", + "format": "int32", + "description": "The first text index associated with this text annotation.", + "x-ms-client-name": "startIndex" + }, + "end_index": { + "type": "integer", + "format": "int32", + "description": "The last text index associated with this text annotation.", + "x-ms-client-name": "endIndex" + } + }, + "discriminator": "type", + "required": [ + "type", + "text", + "start_index", + "end_index" + ] + }, + "MessageTextContent": { + "type": "object", + "description": "A representation of a textual item of thread message content.", + "properties": { + "text": { + "$ref": "#/definitions/MessageTextDetails", + "description": "The text and associated annotations for this thread message content item." + } + }, + "required": [ + "text" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageContent" + } + ], + "x-ms-discriminator-value": "text" + }, + "MessageTextDetails": { + "type": "object", + "description": "The text and associated annotations for a single item of assistant thread message content.", + "properties": { + "value": { + "type": "string", + "description": "The text data." + }, + "annotations": { + "type": "array", + "description": "A list of annotations associated with this text.", + "items": { + "$ref": "#/definitions/MessageTextAnnotation" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "value", + "annotations" + ] + }, + "MessageTextFileCitationDetails": { + "type": "object", + "description": "A representation of a file-based text citation, as used in a file-based annotation of text thread message content.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file associated with this citation.", + "x-ms-client-name": "fileId" + }, + "quote": { + "type": "string", + "description": "The specific quote cited in the associated file." + } + }, + "required": [ + "file_id", + "quote" + ] + }, + "OpenAIFile": { + "type": "object", + "description": "Represents an assistant that can call the model and use tools.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always 'file'.", + "enum": [ + "file" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "bytes": { + "type": "integer", + "format": "int32", + "description": "The size of the file, in bytes." + }, + "filename": { + "type": "string", + "description": "The name of the file." + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "purpose": { + "$ref": "#/definitions/FilePurpose", + "description": "The intended purpose of a file." + } + }, + "required": [ + "object", + "id", + "bytes", + "filename", + "created_at", + "purpose" + ] + }, + "RequiredAction": { + "type": "object", + "description": "An abstract representation of a required action for an assistant thread run to continue.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "RetrievalToolCall": { + "type": "object", + "description": "A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents\nsubmitted output needed or already fulfilled by the tool for the model to continue.", + "properties": { + "retrieval": { + "type": "object", + "description": "The key/value pairs produced by the retrieval tool.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "retrieval" + ], + "allOf": [ + { + "$ref": "#/definitions/ToolCall" + } + ], + "x-ms-discriminator-value": "retrieval" + }, + "RetrievalToolDefinition": { + "type": "object", + "description": "The input definition information for a retrieval tool as used to configure an assistant.", + "allOf": [ + { + "$ref": "#/definitions/ToolDefinition" + } + ], + "x-ms-discriminator-value": "retrieval" + }, + "RunError": { + "type": "object", + "description": "The details of an error as encountered by an assistant thread run.", + "properties": { + "code": { + "type": "string", + "description": "The status for the error." + }, + "message": { + "type": "string", + "description": "The human-readable text associated with the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "RunStatus": { + "type": "string", + "description": "Possible values for the status of an assistant thread run.", + "enum": [ + "queued", + "in_progress", + "requires_action", + "cancelling", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunStatus", + "modelAsString": true, + "values": [ + { + "name": "queued", + "value": "queued", + "description": "Represents a run that is queued to start." + }, + { + "name": "inProgress", + "value": "in_progress", + "description": "Represents a run that is in progress." + }, + { + "name": "requiresAction", + "value": "requires_action", + "description": "Represents a run that needs another operation, such as tool output submission, to continue." + }, + { + "name": "cancelling", + "value": "cancelling", + "description": "Represents a run that is in the process of cancellation." + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Represents a run that has been cancelled." + }, + { + "name": "failed", + "value": "failed", + "description": "Represents a run that failed." + }, + { + "name": "completed", + "value": "completed", + "description": "Represents a run that successfully completed." + }, + { + "name": "expired", + "value": "expired", + "description": "Represents a run that expired before it could otherwise finish." + } + ] + } + }, + "RunStep": { + "type": "object", + "description": "Detailed information about a single step of an assistant thread run.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.run.step'.", + "enum": [ + "thread.run.step" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "type": { + "$ref": "#/definitions/RunStepType", + "description": "The type of run step, which can be either message_creation or tool_calls." + }, + "assistant_id": { + "type": "string", + "description": "The ID of the assistant associated with the run step.", + "x-ms-client-name": "assistantId" + }, + "thread_id": { + "type": "string", + "description": "The ID of the thread that was run.", + "x-ms-client-name": "threadId" + }, + "run_id": { + "type": "string", + "description": "The ID of the run that this run step is a part of.", + "x-ms-client-name": "runId" + }, + "status": { + "$ref": "#/definitions/RunStepStatus", + "description": "The status of this run step." + }, + "step_details": { + "$ref": "#/definitions/RunStepDetails", + "description": "The details for this run step.", + "x-ms-client-name": "stepDetails" + }, + "last_error": { + "type": "object", + "description": "If applicable, information about the last error encountered by this run step.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RunStepError" + } + ], + "x-ms-client-name": "lastError" + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "expired_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this item expired.", + "x-nullable": true, + "x-ms-client-name": "expiredAt" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this completed.", + "x-nullable": true, + "x-ms-client-name": "completedAt" + }, + "cancelled_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this was cancelled.", + "x-nullable": true, + "x-ms-client-name": "cancelledAt" + }, + "failed_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this failed.", + "x-nullable": true, + "x-ms-client-name": "failedAt" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "type", + "assistant_id", + "thread_id", + "run_id", + "status", + "step_details", + "last_error", + "created_at", + "expired_at", + "completed_at", + "cancelled_at", + "failed_at", + "metadata" + ] + }, + "RunStepDetails": { + "type": "object", + "description": "An abstract representation of the details for a run step.", + "properties": { + "type": { + "$ref": "#/definitions/RunStepType", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "RunStepError": { + "type": "object", + "description": "The error information associated with a failed run step.", + "properties": { + "code": { + "$ref": "#/definitions/RunStepErrorCode", + "description": "The error code for this error." + }, + "message": { + "type": "string", + "description": "The human-readable text associated with this error." + } + }, + "required": [ + "code", + "message" + ] + }, + "RunStepErrorCode": { + "type": "string", + "description": "Possible error code values attributable to a failed run step.", + "enum": [ + "server_error", + "rate_limit_exceeded" + ], + "x-ms-enum": { + "name": "RunStepErrorCode", + "modelAsString": true, + "values": [ + { + "name": "serverError", + "value": "server_error", + "description": "Represents a server error." + }, + { + "name": "rateLimitExceeded", + "value": "rate_limit_exceeded", + "description": "Represents an error indicating configured rate limits were exceeded." + } + ] + } + }, + "RunStepMessageCreationDetails": { + "type": "object", + "description": "The detailed information associated with a message creation run step.", + "properties": { + "message_creation": { + "$ref": "#/definitions/RunStepMessageCreationReference", + "description": "Information about the message creation associated with this run step.", + "x-ms-client-name": "messageCreation" + } + }, + "required": [ + "message_creation" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepDetails" + } + ], + "x-ms-discriminator-value": "message_creation" + }, + "RunStepMessageCreationReference": { + "type": "object", + "description": "The details of a message created as a part of a run step.", + "properties": { + "message_id": { + "type": "string", + "description": "The ID of the message created by this run step.", + "x-ms-client-name": "messageId" + } + }, + "required": [ + "message_id" + ] + }, + "RunStepStatus": { + "type": "string", + "description": "Possible values for the status of a run step.", + "enum": [ + "in_progress", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunStepStatus", + "modelAsString": true, + "values": [ + { + "name": "inProgress", + "value": "in_progress", + "description": "Represents a run step still in progress." + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Represents a run step that was cancelled." + }, + { + "name": "failed", + "value": "failed", + "description": "Represents a run step that failed." + }, + { + "name": "completed", + "value": "completed", + "description": "Represents a run step that successfully completed." + }, + { + "name": "expired", + "value": "expired", + "description": "Represents a run step that expired before otherwise finishing." + } + ] + } + }, + "RunStepToolCallDetails": { + "type": "object", + "description": "The detailed information associated with a run step calling tools.", + "properties": { + "tool_calls": { + "type": "array", + "description": "A list tool call details for this run step.", + "items": { + "$ref": "#/definitions/ToolCall" + }, + "x-ms-client-name": "toolCalls" + } + }, + "required": [ + "tool_calls" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepDetails" + } + ], + "x-ms-discriminator-value": "tool_calls" + }, + "RunStepType": { + "type": "string", + "description": "The possible types of run steps.", + "enum": [ + "message_creation", + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepType", + "modelAsString": true, + "values": [ + { + "name": "messageCreation", + "value": "message_creation", + "description": "Represents a run step to create a message." + }, + { + "name": "toolCalls", + "value": "tool_calls", + "description": "Represents a run step that calls tools." + } + ] + } + }, + "SubmitToolOutputsAction": { + "type": "object", + "description": "The details for required tool calls that must be submitted for an assistant thread run to continue.", + "properties": { + "submit_tool_outputs": { + "$ref": "#/definitions/SubmitToolOutputsDetails", + "description": "The details describing tools that should be called to submit tool outputs.", + "x-ms-client-name": "submitToolOutputs" + } + }, + "required": [ + "submit_tool_outputs" + ], + "allOf": [ + { + "$ref": "#/definitions/RequiredAction" + } + ], + "x-ms-discriminator-value": "submit_tool_outputs" + }, + "SubmitToolOutputsDetails": { + "type": "object", + "description": "The details describing tools that should be called to submit tool outputs.", + "properties": { + "tool_calls": { + "type": "array", + "description": "The list of tool calls that must be resolved for the assistant thread run to continue.", + "items": { + "$ref": "#/definitions/ToolCall" + }, + "x-ms-client-name": "toolCalls" + } + }, + "required": [ + "tool_calls" + ] + }, + "ThreadDeletionStatus": { + "type": "object", + "description": "The status of a thread deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.deleted'.", + "enum": [ + "thread.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "ThreadMessage": { + "type": "object", + "description": "A single message within an assistant thread.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.message'.", + "enum": [ + "thread.message" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "thread_id": { + "type": "string", + "description": "The ID of the thread that this message belongs to.", + "x-ms-client-name": "threadId" + }, + "role": { + "$ref": "#/definitions/MessageRole", + "description": "The role associated with the assistant thread message." + }, + "content": { + "type": "array", + "description": "The list of content items associated with the assistant thread message.", + "items": { + "$ref": "#/definitions/MessageContent" + }, + "x-ms-identifiers": [] + }, + "assistant_id": { + "type": "string", + "description": "If applicable, the ID of the assistant that authored this message.", + "x-ms-client-name": "assistantId" + }, + "run_id": { + "type": "string", + "description": "If applicable, the ID of the run associated with the authoring of this message.", + "x-ms-client-name": "runId" + }, + "file_ids": { + "type": "array", + "description": "A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can\naccess files.", + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "thread_id", + "role", + "content", + "file_ids", + "metadata" + ] + }, + "ThreadRun": { + "type": "object", + "description": "Data representing a single evaluation run of an assistant thread.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.run'.", + "enum": [ + "thread.run" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "thread_id": { + "type": "string", + "description": "The ID of the thread associated with this run.", + "x-ms-client-name": "threadId" + }, + "assistant_id": { + "type": "string", + "description": "The ID of the assistant associated with the thread this run was performed against.", + "x-ms-client-name": "assistantId" + }, + "status": { + "$ref": "#/definitions/RunStatus", + "description": "The status of the assistant thread run." + }, + "required_action": { + "type": "object", + "description": "The details of the action required for the assistant thread run to continue.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RequiredAction" + } + ], + "x-ms-client-name": "requiredAction" + }, + "last_error": { + "type": "object", + "description": "The last error, if any, encountered by this assistant thread run.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RunError" + } + ], + "x-ms-client-name": "lastError" + }, + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "instructions": { + "type": "string", + "description": "The overridden system instructions used for this assistant thread run." + }, + "tools": { + "type": "array", + "description": "The overridden enabled tools used for this assistant thread run.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "file_ids": { + "type": "array", + "description": "A list of attached file IDs, ordered by creation date in ascending order.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this item expires.", + "x-nullable": true, + "x-ms-client-name": "expiresAt" + }, + "started_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this item was started.", + "x-nullable": true, + "x-ms-client-name": "startedAt" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this completed.", + "x-nullable": true, + "x-ms-client-name": "completedAt" + }, + "cancelled_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this was cancelled.", + "x-nullable": true, + "x-ms-client-name": "cancelledAt" + }, + "failed_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this failed.", + "x-nullable": true, + "x-ms-client-name": "failedAt" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "thread_id", + "assistant_id", + "status", + "last_error", + "model", + "instructions", + "tools", + "file_ids", + "created_at", + "expires_at", + "started_at", + "completed_at", + "cancelled_at", + "failed_at", + "metadata" + ] + }, + "ToolCall": { + "type": "object", + "description": "An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must\nbe fulfilled and have its outputs submitted before the model can continue.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + }, + "id": { + "type": "string", + "description": "The ID of the tool call. This ID must be referenced when you submit tool outputs." + } + }, + "discriminator": "type", + "required": [ + "type", + "id" + ] + }, + "ToolDefinition": { + "type": "object", + "description": "An abstract representation of an input tool definition that an assistant can use.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ToolOutput": { + "type": "object", + "description": "The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.", + "properties": { + "tool_call_id": { + "type": "string", + "description": "The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.", + "x-ms-client-name": "toolCallId" + }, + "output": { + "type": "string", + "description": "The output from the tool to be submitted." + } + } + } + }, + "parameters": {} +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json new file mode 100644 index 000000000000..bd498c33990f --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json @@ -0,0 +1,3562 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI", + "version": "2024-02-15-preview", + "description": "Azure OpenAI APIs for Assistants.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "An OpenAI endpoint supporting assistants functionality.", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "api-key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/assistants": { + "get": { + "operationId": "ListAssistants", + "description": "Gets a list of assistants that were previously created.", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of assistants.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/Assistant" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateAssistant", + "description": "Creates a new assistant.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AssistantCreationOptions" + } + } + ], + "responses": { + "200": { + "description": "The new assistant instance.", + "schema": { + "$ref": "#/definitions/Assistant" + } + } + } + } + }, + "/assistants/{assistantId}": { + "get": { + "operationId": "GetAssistant", + "description": "Retrieves an existing assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested assistant instance.", + "schema": { + "$ref": "#/definitions/Assistant" + } + } + } + }, + "post": { + "operationId": "UpdateAssistant", + "description": "Modifies an existing assistant.", + "parameters": [ + { + "$ref": "#/parameters/UpdateAssistantOptions.assistantId" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAssistantOptions" + } + } + ], + "responses": { + "200": { + "description": "The updated assistant instance.", + "schema": { + "$ref": "#/definitions/Assistant" + } + } + } + }, + "delete": { + "operationId": "DeleteAssistant", + "description": "Deletes an assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Status information about the requested deletion operation.", + "schema": { + "$ref": "#/definitions/AssistantDeletionStatus" + } + } + } + } + }, + "/assistants/{assistantId}/files": { + "get": { + "operationId": "ListAssistantFiles", + "description": "Gets a list of files attached to a specific assistant, as used by tools that can read files.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to retrieve the list of attached files for.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of files attached to the specified assistant.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/AssistantFile" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateAssistantFile", + "description": "Attaches a previously uploaded file to an assistant for use by tools that can read files.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to attach the file to.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the previously uploaded file to attach.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + } + } + ], + "responses": { + "200": { + "description": "Information about the attached file.", + "schema": { + "$ref": "#/definitions/AssistantFile" + } + } + } + } + }, + "/assistants/{assistantId}/files/{fileId}": { + "get": { + "operationId": "GetAssistantFile", + "description": "Retrieves a file attached to an assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant associated with the attached file.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A representation of the attached file.", + "schema": { + "$ref": "#/definitions/AssistantFile" + } + } + } + }, + "delete": { + "operationId": "DeleteAssistantFile", + "description": "Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read\nfiles.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant from which the specified file should be unlinked.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to unlink from the specified assistant.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Status information about the requested file association deletion.", + "schema": { + "$ref": "#/definitions/AssistantFileDeletionStatus" + } + } + } + } + }, + "/files": { + "get": { + "operationId": "ListFiles", + "description": "Gets a list of previously uploaded files.", + "parameters": [ + { + "name": "purpose", + "in": "query", + "description": "A value that, when provided, limits list results to files matching the corresponding purpose.", + "required": false, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output" + ], + "x-ms-enum": { + "name": "FilePurpose", + "modelAsString": true, + "values": [ + { + "name": "fineTune", + "value": "fine-tune", + "description": "Indicates a file is used for fine tuning input." + }, + { + "name": "fineTuneResults", + "value": "fine-tune-results", + "description": "Indicates a file is used for fine tuning results." + }, + { + "name": "assistants", + "value": "assistants", + "description": "Indicates a file is used as input to assistants." + }, + { + "name": "assistantsOutput", + "value": "assistants_output", + "description": "Indicates a file is used as output by assistants." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The requested list of files.", + "schema": { + "$ref": "#/definitions/FileListResponse" + } + } + } + }, + "post": { + "operationId": "UploadFile", + "description": "Uploads a file for use by other operations.", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "name": "file", + "in": "formData", + "description": "The file data (not filename) to upload.", + "required": true, + "type": "file" + }, + { + "name": "purpose", + "in": "formData", + "description": "The intended purpose of the file.", + "required": true, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output" + ], + "x-ms-enum": { + "name": "FilePurpose", + "modelAsString": true, + "values": [ + { + "name": "fineTune", + "value": "fine-tune", + "description": "Indicates a file is used for fine tuning input." + }, + { + "name": "fineTuneResults", + "value": "fine-tune-results", + "description": "Indicates a file is used for fine tuning results." + }, + { + "name": "assistants", + "value": "assistants", + "description": "Indicates a file is used as input to assistants." + }, + { + "name": "assistantsOutput", + "value": "assistants_output", + "description": "Indicates a file is used as output by assistants." + } + ] + } + }, + { + "name": "filename", + "in": "formData", + "description": "A filename to associate with the uploaded data.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A representation of the uploaded file.", + "schema": { + "$ref": "#/definitions/OpenAIFile" + } + } + } + } + }, + "/files/{fileId}": { + "get": { + "operationId": "GetFile", + "description": "Returns information about a specific file. Does not retrieve file content.", + "parameters": [ + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OpenAIFile" + } + } + } + }, + "delete": { + "operationId": "DeleteFile", + "description": "Delete a previously uploaded file.", + "parameters": [ + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/FileDeletionStatus" + } + } + } + } + }, + "/threads": { + "post": { + "operationId": "CreateThread", + "description": "Creates a new thread. Threads contain messages and can be run by assistants.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AssistantThreadCreationOptions" + } + } + ], + "responses": { + "200": { + "description": "Information about the newly created thread.", + "schema": { + "$ref": "#/definitions/AssistantThread" + } + } + } + } + }, + "/threads/{threadId}": { + "get": { + "operationId": "GetThread", + "description": "Gets information about an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to retrieve information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Information about the requested thread.", + "schema": { + "$ref": "#/definitions/AssistantThread" + } + } + } + }, + "post": { + "operationId": "UpdateThread", + "description": "Modifies an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to modify.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "Information about the modified thread.", + "schema": { + "$ref": "#/definitions/AssistantThread" + } + } + } + }, + "delete": { + "operationId": "DeleteThread", + "description": "Deletes an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Status information about the requested thread deletion operation.", + "schema": { + "$ref": "#/definitions/ThreadDeletionStatus" + } + } + } + } + }, + "/threads/{threadId}/messages": { + "get": { + "operationId": "ListMessages", + "description": "Gets a list of messages that exist on a thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to list messages from.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of messages.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/ThreadMessage" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateMessage", + "description": "Creates a new message on a specified thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to create the new message on.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "role": { + "$ref": "#/definitions/MessageRole", + "description": "The role to associate with the new message." + }, + "content": { + "type": "string", + "description": "The textual content for the new message." + }, + "file_ids": { + "type": "array", + "description": "A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files.", + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "role", + "content" + ] + } + } + ], + "responses": { + "200": { + "description": "A representation of the new message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + } + }, + "/threads/{threadId}/messages/{messageId}": { + "get": { + "operationId": "GetMessage", + "description": "Gets an existing message from an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to retrieve the specified message from.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to retrieve from the specified thread.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A representation of the requested message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + }, + "post": { + "operationId": "UpdateMessage", + "description": "Modifies an existing message on an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread containing the specified message to modify.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to modify on the specified thread.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "A representation of the modified message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + } + }, + "/threads/{threadId}/messages/{messageId}/files": { + "get": { + "operationId": "ListMessageFiles", + "description": "Gets a list of previously uploaded files associated with a message from a thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread containing the message to list files from.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to list files from.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of files associated with the specified message.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/MessageFile" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + } + }, + "/threads/{threadId}/messages/{messageId}/files/{fileId}": { + "get": { + "operationId": "GetMessageFile", + "description": "Gets information about a file attachment to a message within a thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread containing the message to get information from.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to get information from.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to get information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested file information.", + "schema": { + "$ref": "#/definitions/MessageFile" + } + } + } + } + }, + "/threads/{threadId}/runs": { + "get": { + "operationId": "ListRuns", + "description": "Gets a list of runs for a specified thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to list runs from.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of thread runs.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/ThreadRun" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateRun", + "description": "Creates a new run for an assistant thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to run.", + "required": true, + "type": "string" + }, + { + "name": "createRunOptions", + "in": "body", + "description": "The details for the run to create.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateRunOptions" + } + } + ], + "responses": { + "200": { + "description": "Information about the new thread run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}": { + "get": { + "operationId": "GetRun", + "description": "Gets an existing run from an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to retrieve run information from.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the thread to retrieve information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested information about the specified thread run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + }, + "post": { + "operationId": "UpdateRun", + "description": "Modifies an existing thread run.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread associated with the specified run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run to modify.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "Information about the modified run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/cancel": { + "post": { + "operationId": "CancelRun", + "description": "Cancels a run of an in progress thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread being run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run to cancel.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Updated information about the cancelled run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/steps": { + "get": { + "operationId": "ListRunSteps", + "description": "Gets a list of run steps from a thread run.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread that was run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run to list steps from.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of run steps.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/RunStep" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/steps/{stepId}": { + "get": { + "operationId": "GetRunStep", + "description": "Gets a single run step from a thread run.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread that was run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the specific run to retrieve the step from.", + "required": true, + "type": "string" + }, + { + "name": "stepId", + "in": "path", + "description": "The ID of the step to retrieve information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Information about the requested run step.", + "schema": { + "$ref": "#/definitions/RunStep" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/submit_tool_outputs": { + "post": { + "operationId": "SubmitToolOutputsToRun", + "description": "Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread that was run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run that requires tool outputs.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "tool_outputs": { + "type": "array", + "description": "The list of tool outputs requested by tool calls from the specified run.", + "items": { + "$ref": "#/definitions/ToolOutput" + }, + "x-ms-client-name": "toolOutputs", + "x-ms-identifiers": [] + } + }, + "required": [ + "tool_outputs" + ] + } + } + ], + "responses": { + "200": { + "description": "Updated information about the run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/runs": { + "post": { + "operationId": "CreateThreadAndRun", + "description": "Creates a new assistant thread and immediately starts a run using that new thread.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateAndRunThreadOptions" + } + } + ], + "responses": { + "200": { + "description": "Information about the newly created thread.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + } + }, + "definitions": { + "Assistant": { + "type": "object", + "description": "Represents an assistant that can call the model and use tools.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always assistant.", + "enum": [ + "assistant" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "name": { + "type": "string", + "description": "The name of the assistant.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "The description of the assistant.", + "x-nullable": true + }, + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "instructions": { + "type": "string", + "description": "The system instructions for the assistant to use.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The collection of tools enabled for the assistant.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "file_ids": { + "type": "array", + "description": "A list of attached file IDs, ordered by creation date in ascending order.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "name", + "description", + "model", + "instructions", + "tools", + "file_ids", + "metadata" + ] + }, + "AssistantCreationOptions": { + "type": "object", + "description": "The request details to use when creating a new assistant.", + "properties": { + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "name": { + "type": "string", + "description": "The name of the new assistant.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "The description of the new assistant.", + "x-nullable": true + }, + "instructions": { + "type": "string", + "description": "The system instructions for the new assistant to use.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The collection of tools to enable for the new assistant.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "file_ids": { + "type": "array", + "description": "A list of previously uploaded file IDs to attach to the assistant.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "model" + ] + }, + "AssistantDeletionStatus": { + "type": "object", + "description": "The status of an assistant deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'assistant.deleted'.", + "enum": [ + "assistant.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "AssistantFile": { + "type": "object", + "description": "Information about a file attached to an assistant, as used by tools that can read files.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'assistant.file'.", + "enum": [ + "assistant.file" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "assistant_id": { + "type": "string", + "description": "The assistant ID that the file is attached to.", + "x-ms-client-name": "assistantId" + } + }, + "required": [ + "id", + "object", + "created_at", + "assistant_id" + ] + }, + "AssistantFileDeletionStatus": { + "type": "object", + "description": "The status of an assistant file deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'assistant.file.deleted'.", + "enum": [ + "assistant.file.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "AssistantThread": { + "type": "object", + "description": "Information about a single thread associated with an assistant.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread'.", + "enum": [ + "thread" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "metadata" + ] + }, + "AssistantThreadCreationOptions": { + "type": "object", + "description": "The details used to create a new assistant thread.", + "properties": { + "messages": { + "type": "array", + "description": "The initial messages to associate with the new thread.", + "items": { + "$ref": "#/definitions/ThreadInitializationMessage" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "CodeInterpreterToolDefinition": { + "type": "object", + "description": "The input definition information for a code interpreter tool as used to configure an assistant.", + "allOf": [ + { + "$ref": "#/definitions/ToolDefinition" + } + ], + "x-ms-discriminator-value": "code_interpreter" + }, + "CreateAndRunThreadOptions": { + "type": "object", + "description": "The details used when creating and immediately running a new assistant thread.", + "properties": { + "assistant_id": { + "type": "string", + "description": "The ID of the assistant for which the thread should be created.", + "x-ms-client-name": "assistantId" + }, + "thread": { + "$ref": "#/definitions/AssistantThreadCreationOptions", + "description": "The details used to create the new thread." + }, + "model": { + "type": "string", + "description": "The overridden model that the assistant should use to run the thread." + }, + "instructions": { + "type": "string", + "description": "The overridden system instructions the assistant should use to run the thread." + }, + "tools": { + "type": "array", + "description": "The overridden list of enabled tools the assistant should use to run the thread.", + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "assistant_id" + ] + }, + "CreateRunOptions": { + "type": "object", + "description": "The details used when creating a new run of an assistant thread.", + "properties": { + "assistant_id": { + "type": "string", + "description": "The ID of the assistant that should run the thread.", + "x-ms-client-name": "assistantId" + }, + "model": { + "type": "string", + "description": "The overridden model name that the assistant should use to run the thread.", + "x-nullable": true + }, + "instructions": { + "type": "string", + "description": "The overridden system instructions that the assistant should use to run the thread.", + "x-nullable": true + }, + "additional_instructions": { + "type": "string", + "description": "Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior\non a per-run basis without overriding other instructions.", + "x-nullable": true, + "x-ms-client-name": "additionalInstructions" + }, + "tools": { + "type": "array", + "description": "The overridden list of enabled tools that the assistant should use to run the thread.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "assistant_id" + ] + }, + "FileDeletionStatus": { + "type": "object", + "description": "A status response from a file deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'file'.", + "enum": [ + "file" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "FileListResponse": { + "type": "object", + "description": "The response data from a file list operation.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always 'list'.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The files returned for the request.", + "items": { + "$ref": "#/definitions/OpenAIFile" + } + } + }, + "required": [ + "object", + "data" + ] + }, + "FilePurpose": { + "type": "string", + "description": "The possible values denoting the intended usage of a file.", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output" + ], + "x-ms-enum": { + "name": "FilePurpose", + "modelAsString": true, + "values": [ + { + "name": "fineTune", + "value": "fine-tune", + "description": "Indicates a file is used for fine tuning input." + }, + { + "name": "fineTuneResults", + "value": "fine-tune-results", + "description": "Indicates a file is used for fine tuning results." + }, + { + "name": "assistants", + "value": "assistants", + "description": "Indicates a file is used as input to assistants." + }, + { + "name": "assistantsOutput", + "value": "assistants_output", + "description": "Indicates a file is used as output by assistants." + } + ] + } + }, + "FunctionDefinition": { + "type": "object", + "description": "The input definition information for a function.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to be called." + }, + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "parameters": { + "description": "The parameters the functions accepts, described as a JSON Schema object." + } + }, + "required": [ + "name", + "parameters" + ] + }, + "FunctionToolDefinition": { + "type": "object", + "description": "The input definition information for a function tool as used to configure an assistant.", + "properties": { + "function": { + "$ref": "#/definitions/FunctionDefinition", + "description": "The definition of the concrete function that the function tool should call." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/ToolDefinition" + } + ], + "x-ms-discriminator-value": "function" + }, + "MessageContent": { + "type": "object", + "description": "An abstract representation of a single item of thread message content.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "MessageFile": { + "type": "object", + "description": "Information about a file attached to an assistant thread message.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.message.file'.", + "enum": [ + "thread.message.file" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "message_id": { + "type": "string", + "description": "The ID of the message that this file is attached to.", + "x-ms-client-name": "messageId" + } + }, + "required": [ + "id", + "object", + "created_at", + "message_id" + ] + }, + "MessageImageFileContent": { + "type": "object", + "description": "A representation of image file content in a thread message.", + "properties": { + "image_file": { + "$ref": "#/definitions/MessageImageFileDetails", + "description": "The image file for this thread message content item.", + "x-ms-client-name": "imageFile" + } + }, + "required": [ + "image_file" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageContent" + } + ], + "x-ms-discriminator-value": "image_file" + }, + "MessageImageFileDetails": { + "type": "object", + "description": "An image reference, as represented in thread message content.", + "properties": { + "file_id": { + "$ref": "#/definitions/MessageImageFileIdDetails", + "description": "The ID for the file associated with this image.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "MessageImageFileIdDetails": { + "type": "object", + "description": "An encapsulation of an image file ID, as used by message image content.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the specific image file.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "MessageRole": { + "type": "string", + "description": "The possible values for roles attributed to messages in a thread.", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "MessageRole", + "modelAsString": true, + "values": [ + { + "name": "user", + "value": "user", + "description": "The role representing the end-user." + }, + { + "name": "assistant", + "value": "assistant", + "description": "The role representing the assistant." + } + ] + } + }, + "MessageTextAnnotation": { + "type": "object", + "description": "An abstract representation of an annotation to text thread message content.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + }, + "text": { + "type": "string", + "description": "The textual content associated with this text annotation item." + }, + "start_index": { + "type": "integer", + "format": "int32", + "description": "The first text index associated with this text annotation.", + "x-ms-client-name": "startIndex" + }, + "end_index": { + "type": "integer", + "format": "int32", + "description": "The last text index associated with this text annotation.", + "x-ms-client-name": "endIndex" + } + }, + "discriminator": "type", + "required": [ + "type", + "text", + "start_index", + "end_index" + ] + }, + "MessageTextContent": { + "type": "object", + "description": "A representation of a textual item of thread message content.", + "properties": { + "text": { + "$ref": "#/definitions/MessageTextDetails", + "description": "The text and associated annotations for this thread message content item." + } + }, + "required": [ + "text" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageContent" + } + ], + "x-ms-discriminator-value": "text" + }, + "MessageTextDetails": { + "type": "object", + "description": "The text and associated annotations for a single item of assistant thread message content.", + "properties": { + "value": { + "type": "string", + "description": "The text data." + }, + "annotations": { + "type": "array", + "description": "A list of annotations associated with this text.", + "items": { + "$ref": "#/definitions/MessageTextAnnotation" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "value", + "annotations" + ] + }, + "MessageTextFileCitationAnnotation": { + "type": "object", + "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.", + "properties": { + "file_citation": { + "$ref": "#/definitions/MessageTextFileCitationDetails", + "description": "A citation within the message that points to a specific quote from a specific file.\nGenerated when the assistant uses the \"retrieval\" tool to search files.", + "x-ms-client-name": "fileCitation" + } + }, + "required": [ + "file_citation" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTextAnnotation" + } + ], + "x-ms-discriminator-value": "file_citation" + }, + "MessageTextFileCitationDetails": { + "type": "object", + "description": "A representation of a file-based text citation, as used in a file-based annotation of text thread message content.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file associated with this citation.", + "x-ms-client-name": "fileId" + }, + "quote": { + "type": "string", + "description": "The specific quote cited in the associated file." + } + }, + "required": [ + "file_id", + "quote" + ] + }, + "MessageTextFilePathAnnotation": { + "type": "object", + "description": "A citation within the message that points to a file located at a specific path.", + "properties": { + "file_path": { + "$ref": "#/definitions/MessageTextFilePathDetails", + "description": "A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.", + "x-ms-client-name": "filePath" + } + }, + "required": [ + "file_path" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTextAnnotation" + } + ], + "x-ms-discriminator-value": "file_path" + }, + "MessageTextFilePathDetails": { + "type": "object", + "description": "An encapsulation of an image file ID, as used by message image content.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the specific file that the citation is from.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "OpenAIFile": { + "type": "object", + "description": "Represents an assistant that can call the model and use tools.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always 'file'.", + "enum": [ + "file" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "bytes": { + "type": "integer", + "format": "int32", + "description": "The size of the file, in bytes." + }, + "filename": { + "type": "string", + "description": "The name of the file." + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "purpose": { + "$ref": "#/definitions/FilePurpose", + "description": "The intended purpose of a file." + } + }, + "required": [ + "object", + "id", + "bytes", + "filename", + "created_at", + "purpose" + ] + }, + "RequiredAction": { + "type": "object", + "description": "An abstract representation of a required action for an assistant thread run to continue.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "RequiredFunctionToolCall": { + "type": "object", + "description": "A representation of a requested call to a function tool, needed by the model to continue evaluation of a run.", + "properties": { + "function": { + "$ref": "#/definitions/RequiredFunctionToolCallDetails", + "description": "Detailed information about the function to be executed by the tool that includes name and arguments." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/RequiredToolCall" + } + ], + "x-ms-discriminator-value": "function" + }, + "RequiredFunctionToolCallDetails": { + "type": "object", + "description": "The detailed information for a function invocation, as provided by a required action invoking a function tool, that includes the name of and arguments to the function.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments to use when invoking the named function, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation." + } + }, + "required": [ + "name", + "arguments" + ] + }, + "RequiredToolCall": { + "type": "object", + "description": "An abstract representation a a tool invocation needed by the model to continue a run.", + "properties": { + "type": { + "type": "string", + "description": "The object type for the required tool call." + }, + "id": { + "type": "string", + "description": "The ID of the tool call. This ID must be referenced when submitting tool outputs." + } + }, + "discriminator": "type", + "required": [ + "type", + "id" + ] + }, + "RetrievalToolDefinition": { + "type": "object", + "description": "The input definition information for a retrieval tool as used to configure an assistant.", + "allOf": [ + { + "$ref": "#/definitions/ToolDefinition" + } + ], + "x-ms-discriminator-value": "retrieval" + }, + "RunError": { + "type": "object", + "description": "The details of an error as encountered by an assistant thread run.", + "properties": { + "code": { + "type": "string", + "description": "The status for the error." + }, + "message": { + "type": "string", + "description": "The human-readable text associated with the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "RunStatus": { + "type": "string", + "description": "Possible values for the status of an assistant thread run.", + "enum": [ + "queued", + "in_progress", + "requires_action", + "cancelling", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunStatus", + "modelAsString": true, + "values": [ + { + "name": "queued", + "value": "queued", + "description": "Represents a run that is queued to start." + }, + { + "name": "inProgress", + "value": "in_progress", + "description": "Represents a run that is in progress." + }, + { + "name": "requiresAction", + "value": "requires_action", + "description": "Represents a run that needs another operation, such as tool output submission, to continue." + }, + { + "name": "cancelling", + "value": "cancelling", + "description": "Represents a run that is in the process of cancellation." + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Represents a run that has been cancelled." + }, + { + "name": "failed", + "value": "failed", + "description": "Represents a run that failed." + }, + { + "name": "completed", + "value": "completed", + "description": "Represents a run that successfully completed." + }, + { + "name": "expired", + "value": "expired", + "description": "Represents a run that expired before it could otherwise finish." + } + ] + } + }, + "RunStep": { + "type": "object", + "description": "Detailed information about a single step of an assistant thread run.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.run.step'.", + "enum": [ + "thread.run.step" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "type": { + "$ref": "#/definitions/RunStepType", + "description": "The type of run step, which can be either message_creation or tool_calls." + }, + "assistant_id": { + "type": "string", + "description": "The ID of the assistant associated with the run step.", + "x-ms-client-name": "assistantId" + }, + "thread_id": { + "type": "string", + "description": "The ID of the thread that was run.", + "x-ms-client-name": "threadId" + }, + "run_id": { + "type": "string", + "description": "The ID of the run that this run step is a part of.", + "x-ms-client-name": "runId" + }, + "status": { + "$ref": "#/definitions/RunStepStatus", + "description": "The status of this run step." + }, + "step_details": { + "$ref": "#/definitions/RunStepDetails", + "description": "The details for this run step.", + "x-ms-client-name": "stepDetails" + }, + "last_error": { + "type": "object", + "description": "If applicable, information about the last error encountered by this run step.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RunStepError" + } + ], + "x-ms-client-name": "lastError" + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "expired_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this item expired.", + "x-nullable": true, + "x-ms-client-name": "expiredAt" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this completed.", + "x-nullable": true, + "x-ms-client-name": "completedAt" + }, + "cancelled_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this was cancelled.", + "x-nullable": true, + "x-ms-client-name": "cancelledAt" + }, + "failed_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this failed.", + "x-nullable": true, + "x-ms-client-name": "failedAt" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "type", + "assistant_id", + "thread_id", + "run_id", + "status", + "step_details", + "last_error", + "created_at", + "expired_at", + "completed_at", + "cancelled_at", + "failed_at", + "metadata" + ] + }, + "RunStepCodeInterpreterImageOutput": { + "type": "object", + "description": "A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.", + "properties": { + "image": { + "$ref": "#/definitions/RunStepCodeInterpreterImageReference", + "description": "Referential information for the image associated with this output." + } + }, + "required": [ + "image" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepCodeInterpreterToolCallOutput" + } + ], + "x-ms-discriminator-value": "image" + }, + "RunStepCodeInterpreterImageReference": { + "type": "object", + "description": "An image reference emitted by a code interpreter tool in response to a tool call by the model.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file associated with this image.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "RunStepCodeInterpreterLogOutput": { + "type": "object", + "description": "A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.", + "properties": { + "logs": { + "type": "string", + "description": "The serialized log output emitted by the code interpreter." + } + }, + "required": [ + "logs" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepCodeInterpreterToolCallOutput" + } + ], + "x-ms-discriminator-value": "logs" + }, + "RunStepCodeInterpreterToolCall": { + "type": "object", + "description": "A record of a call to a code interpreter tool, issued by the model in evaluation of a defined tool, that\nrepresents inputs and outputs consumed and emitted by the code interpreter.", + "properties": { + "code_interpreter": { + "$ref": "#/definitions/RunStepCodeInterpreterToolCallDetails", + "description": "The details of the tool call to the code interpreter tool.", + "x-ms-client-name": "codeInterpreter" + } + }, + "required": [ + "code_interpreter" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepToolCall" + } + ], + "x-ms-discriminator-value": "code_interpreter" + }, + "RunStepCodeInterpreterToolCallDetails": { + "type": "object", + "description": "The detailed information about a code interpreter invocation by the model.", + "properties": { + "input": { + "type": "string", + "description": "The input provided by the model to the code interpreter tool." + }, + "outputs": { + "type": "array", + "description": "The outputs produced by the code interpreter tool back to the model in response to the tool call.", + "items": { + "$ref": "#/definitions/RunStepCodeInterpreterToolCallOutput" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "input", + "outputs" + ] + }, + "RunStepCodeInterpreterToolCallOutput": { + "type": "object", + "description": "An abstract representation of an emitted output from a code interpreter tool.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "RunStepDetails": { + "type": "object", + "description": "An abstract representation of the details for a run step.", + "properties": { + "type": { + "$ref": "#/definitions/RunStepType", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "RunStepError": { + "type": "object", + "description": "The error information associated with a failed run step.", + "properties": { + "code": { + "$ref": "#/definitions/RunStepErrorCode", + "description": "The error code for this error." + }, + "message": { + "type": "string", + "description": "The human-readable text associated with this error." + } + }, + "required": [ + "code", + "message" + ] + }, + "RunStepErrorCode": { + "type": "string", + "description": "Possible error code values attributable to a failed run step.", + "enum": [ + "server_error", + "rate_limit_exceeded" + ], + "x-ms-enum": { + "name": "RunStepErrorCode", + "modelAsString": true, + "values": [ + { + "name": "serverError", + "value": "server_error", + "description": "Represents a server error." + }, + { + "name": "rateLimitExceeded", + "value": "rate_limit_exceeded", + "description": "Represents an error indicating configured rate limits were exceeded." + } + ] + } + }, + "RunStepFunctionToolCall": { + "type": "object", + "description": "A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs\nand output consumed and emitted by the specified function.", + "properties": { + "function": { + "$ref": "#/definitions/RunStepFunctionToolCallDetails", + "description": "The detailed information about the function called by the model." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepToolCall" + } + ], + "x-ms-discriminator-value": "function" + }, + "RunStepFunctionToolCallDetails": { + "type": "object", + "description": "The detailed information about the function called by the model.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments that the model requires are provided to the named function." + }, + "output": { + "type": "string", + "description": "The output of the function, only populated for function calls that have already have had their outputs submitted.", + "x-nullable": true + } + }, + "required": [ + "name", + "arguments", + "output" + ] + }, + "RunStepMessageCreationDetails": { + "type": "object", + "description": "The detailed information associated with a message creation run step.", + "properties": { + "message_creation": { + "$ref": "#/definitions/RunStepMessageCreationReference", + "description": "Information about the message creation associated with this run step.", + "x-ms-client-name": "messageCreation" + } + }, + "required": [ + "message_creation" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepDetails" + } + ], + "x-ms-discriminator-value": "message_creation" + }, + "RunStepMessageCreationReference": { + "type": "object", + "description": "The details of a message created as a part of a run step.", + "properties": { + "message_id": { + "type": "string", + "description": "The ID of the message created by this run step.", + "x-ms-client-name": "messageId" + } + }, + "required": [ + "message_id" + ] + }, + "RunStepRetrievalToolCall": { + "type": "object", + "description": "A record of a call to a retrieval tool, issued by the model in evaluation of a defined tool, that represents\nexecuted retrieval actions.", + "properties": { + "retrieval": { + "type": "object", + "description": "The key/value pairs produced by the retrieval tool.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "retrieval" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepToolCall" + } + ], + "x-ms-discriminator-value": "retrieval" + }, + "RunStepStatus": { + "type": "string", + "description": "Possible values for the status of a run step.", + "enum": [ + "in_progress", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunStepStatus", + "modelAsString": true, + "values": [ + { + "name": "inProgress", + "value": "in_progress", + "description": "Represents a run step still in progress." + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Represents a run step that was cancelled." + }, + { + "name": "failed", + "value": "failed", + "description": "Represents a run step that failed." + }, + { + "name": "completed", + "value": "completed", + "description": "Represents a run step that successfully completed." + }, + { + "name": "expired", + "value": "expired", + "description": "Represents a run step that expired before otherwise finishing." + } + ] + } + }, + "RunStepToolCall": { + "type": "object", + "description": "An abstract representation of a detailed tool call as recorded within a run step for an existing run.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + }, + "id": { + "type": "string", + "description": "The ID of the tool call. This ID must be referenced when you submit tool outputs." + } + }, + "discriminator": "type", + "required": [ + "type", + "id" + ] + }, + "RunStepToolCallDetails": { + "type": "object", + "description": "The detailed information associated with a run step calling tools.", + "properties": { + "tool_calls": { + "type": "array", + "description": "A list of tool call details for this run step.", + "items": { + "$ref": "#/definitions/RunStepToolCall" + }, + "x-ms-client-name": "toolCalls" + } + }, + "required": [ + "tool_calls" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepDetails" + } + ], + "x-ms-discriminator-value": "tool_calls" + }, + "RunStepType": { + "type": "string", + "description": "The possible types of run steps.", + "enum": [ + "message_creation", + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepType", + "modelAsString": true, + "values": [ + { + "name": "messageCreation", + "value": "message_creation", + "description": "Represents a run step to create a message." + }, + { + "name": "toolCalls", + "value": "tool_calls", + "description": "Represents a run step that calls tools." + } + ] + } + }, + "SubmitToolOutputsAction": { + "type": "object", + "description": "The details for required tool calls that must be submitted for an assistant thread run to continue.", + "properties": { + "submit_tool_outputs": { + "$ref": "#/definitions/SubmitToolOutputsDetails", + "description": "The details describing tools that should be called to submit tool outputs.", + "x-ms-client-name": "submitToolOutputs" + } + }, + "required": [ + "submit_tool_outputs" + ], + "allOf": [ + { + "$ref": "#/definitions/RequiredAction" + } + ], + "x-ms-discriminator-value": "submit_tool_outputs" + }, + "SubmitToolOutputsDetails": { + "type": "object", + "description": "The details describing tools that should be called to submit tool outputs.", + "properties": { + "tool_calls": { + "type": "array", + "description": "The list of tool calls that must be resolved for the assistant thread run to continue.", + "items": { + "$ref": "#/definitions/RequiredToolCall" + }, + "x-ms-client-name": "toolCalls" + } + }, + "required": [ + "tool_calls" + ] + }, + "ThreadDeletionStatus": { + "type": "object", + "description": "The status of a thread deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.deleted'.", + "enum": [ + "thread.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "ThreadInitializationMessage": { + "type": "object", + "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.", + "properties": { + "role": { + "$ref": "#/definitions/MessageRole", + "description": "The role associated with the assistant thread message. Currently, only 'user' is supported when providing initial messages to a new thread." + }, + "content": { + "type": "string", + "description": "The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API." + }, + "file_ids": { + "type": "array", + "description": "A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can\naccess files.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "role", + "content" + ] + }, + "ThreadMessage": { + "type": "object", + "description": "A single, existing message within an assistant thread.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.message'.", + "enum": [ + "thread.message" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "thread_id": { + "type": "string", + "description": "The ID of the thread that this message belongs to.", + "x-ms-client-name": "threadId" + }, + "role": { + "$ref": "#/definitions/MessageRole", + "description": "The role associated with the assistant thread message." + }, + "content": { + "type": "array", + "description": "The list of content items associated with the assistant thread message.", + "items": { + "$ref": "#/definitions/MessageContent" + }, + "x-ms-identifiers": [] + }, + "assistant_id": { + "type": "string", + "description": "If applicable, the ID of the assistant that authored this message.", + "x-ms-client-name": "assistantId" + }, + "run_id": { + "type": "string", + "description": "If applicable, the ID of the run associated with the authoring of this message.", + "x-ms-client-name": "runId" + }, + "file_ids": { + "type": "array", + "description": "A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can\naccess files.", + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "thread_id", + "role", + "content", + "file_ids", + "metadata" + ] + }, + "ThreadRun": { + "type": "object", + "description": "Data representing a single evaluation run of an assistant thread.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.run'.", + "enum": [ + "thread.run" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "thread_id": { + "type": "string", + "description": "The ID of the thread associated with this run.", + "x-ms-client-name": "threadId" + }, + "assistant_id": { + "type": "string", + "description": "The ID of the assistant associated with the thread this run was performed against.", + "x-ms-client-name": "assistantId" + }, + "status": { + "$ref": "#/definitions/RunStatus", + "description": "The status of the assistant thread run." + }, + "required_action": { + "type": "object", + "description": "The details of the action required for the assistant thread run to continue.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RequiredAction" + } + ], + "x-ms-client-name": "requiredAction" + }, + "last_error": { + "type": "object", + "description": "The last error, if any, encountered by this assistant thread run.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RunError" + } + ], + "x-ms-client-name": "lastError" + }, + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "instructions": { + "type": "string", + "description": "The overridden system instructions used for this assistant thread run." + }, + "tools": { + "type": "array", + "description": "The overridden enabled tools used for this assistant thread run.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "file_ids": { + "type": "array", + "description": "A list of attached file IDs, ordered by creation date in ascending order.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this item expires.", + "x-nullable": true, + "x-ms-client-name": "expiresAt" + }, + "started_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this item was started.", + "x-nullable": true, + "x-ms-client-name": "startedAt" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this completed.", + "x-nullable": true, + "x-ms-client-name": "completedAt" + }, + "cancelled_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this was cancelled.", + "x-nullable": true, + "x-ms-client-name": "cancelledAt" + }, + "failed_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this failed.", + "x-nullable": true, + "x-ms-client-name": "failedAt" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "thread_id", + "assistant_id", + "status", + "last_error", + "model", + "instructions", + "tools", + "file_ids", + "created_at", + "expires_at", + "started_at", + "completed_at", + "cancelled_at", + "failed_at", + "metadata" + ] + }, + "ToolDefinition": { + "type": "object", + "description": "An abstract representation of an input tool definition that an assistant can use.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ToolOutput": { + "type": "object", + "description": "The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.", + "properties": { + "tool_call_id": { + "type": "string", + "description": "The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.", + "x-ms-client-name": "toolCallId" + }, + "output": { + "type": "string", + "description": "The output from the tool to be submitted." + } + } + }, + "UpdateAssistantOptions": { + "type": "object", + "description": "The request details to use when modifying an existing assistant.", + "properties": { + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "name": { + "type": "string", + "description": "The modified name for the assistant to use.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "The modified description for the assistant to use.", + "x-nullable": true + }, + "instructions": { + "type": "string", + "description": "The modified system instructions for the new assistant to use.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The modified collection of tools to enable for the assistant.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "file_ids": { + "type": "array", + "description": "The modified list of previously uploaded fileIDs to attach to the assistant.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": { + "UpdateAssistantOptions.assistantId": { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to modify.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json new file mode 100644 index 000000000000..7b5bd59f8c14 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/assistants_generated.json @@ -0,0 +1,3452 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI", + "version": "2023-11-06-beta", + "description": "Azure OpenAI APIs for Assistants.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "An OpenAI endpoint supporting assistants functionality.", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "api-key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/assistants": { + "get": { + "operationId": "ListAssistants", + "description": "Gets a list of assistants that were previously created.", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of assistants.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/Assistant" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateAssistant", + "description": "Creates a new assistant.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AssistantCreationOptions" + } + } + ], + "responses": { + "200": { + "description": "The new assistant instance.", + "schema": { + "$ref": "#/definitions/Assistant" + } + } + } + } + }, + "/assistants/{assistantId}": { + "get": { + "operationId": "GetAssistant", + "description": "Retrieves an existing assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested assistant instance.", + "schema": { + "$ref": "#/definitions/Assistant" + } + } + } + }, + "post": { + "operationId": "ModifyAssistant", + "description": "Modifies an existing assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to modify.", + "required": true, + "type": "string" + }, + { + "name": "modificationOptions", + "in": "body", + "description": "The details of the modification to perform on the specified assistant.", + "required": true, + "schema": { + "$ref": "#/definitions/AssistantModificationOptions" + } + } + ], + "responses": { + "200": { + "description": "The updated assistant instance.", + "schema": { + "$ref": "#/definitions/Assistant" + } + } + } + }, + "delete": { + "operationId": "DeleteAssistant", + "description": "Deletes an assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Status information about the requested deletion operation.", + "schema": { + "$ref": "#/definitions/AssistantDeletionStatus" + } + } + } + } + }, + "/assistants/{assistantId}/files": { + "get": { + "operationId": "ListAssistantFiles", + "description": "Gets a list of files attached to a specific assistant, as used by tools that can read files.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to retrieve the list of attached files for.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of files attached to the specified assistant.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/AssistantFile" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateAssistantFile", + "description": "Attaches a previously uploaded file to an assistant for use by tools that can read files.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant to attach the file to.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the previously uploaded file to attach.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + } + } + ], + "responses": { + "200": { + "description": "Information about the attached file.", + "schema": { + "$ref": "#/definitions/AssistantFile" + } + } + } + } + }, + "/assistants/{assistantId}/files/{fileId}": { + "get": { + "operationId": "GetAssistantFile", + "description": "Retrieves a file attached to an assistant.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant associated with the attached file.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A representation of the attached file.", + "schema": { + "$ref": "#/definitions/AssistantFile" + } + } + } + }, + "delete": { + "operationId": "DeleteAssistantFile", + "description": "Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read\nfiles.", + "parameters": [ + { + "name": "assistantId", + "in": "path", + "description": "The ID of the assistant from which the specified file should be unlinked.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to unlink from the specified assistant.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Status information about the requested file association deletion.", + "schema": { + "$ref": "#/definitions/AssistantFileDeletionStatus" + } + } + } + } + }, + "/files": { + "get": { + "operationId": "ListFiles", + "description": "Gets a list of previously uploaded files.", + "parameters": [ + { + "name": "purpose", + "in": "query", + "description": "A value that, when provided, limits list results to files matching the corresponding purpose.", + "required": false, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output" + ], + "x-ms-enum": { + "name": "FilePurpose", + "modelAsString": true, + "values": [ + { + "name": "fineTune", + "value": "fine-tune", + "description": "Indicates a file is used for fine tuning input." + }, + { + "name": "fineTuneResults", + "value": "fine-tune-results", + "description": "Indicates a file is used for fine tuning results." + }, + { + "name": "assistants", + "value": "assistants", + "description": "Indicates a file is used as input to assistants." + }, + { + "name": "assistantsOutput", + "value": "assistants_output", + "description": "Indicates a file is used as output by assistants." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The requested list of files.", + "schema": { + "$ref": "#/definitions/FileListResponse" + } + } + } + }, + "post": { + "operationId": "CreateFile", + "description": "Uploads a file for use by other operations.", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "name": "file", + "in": "formData", + "description": "The file data (not filename) to upload.", + "required": true, + "type": "file" + }, + { + "name": "purpose", + "in": "formData", + "description": "The intended purpose of the file.", + "required": true, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output" + ], + "x-ms-enum": { + "name": "FilePurpose", + "modelAsString": true, + "values": [ + { + "name": "fineTune", + "value": "fine-tune", + "description": "Indicates a file is used for fine tuning input." + }, + { + "name": "fineTuneResults", + "value": "fine-tune-results", + "description": "Indicates a file is used for fine tuning results." + }, + { + "name": "assistants", + "value": "assistants", + "description": "Indicates a file is used as input to assistants." + }, + { + "name": "assistantsOutput", + "value": "assistants_output", + "description": "Indicates a file is used as output by assistants." + } + ] + } + }, + { + "name": "filename", + "in": "formData", + "description": "A filename to associate with the uploaded data.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A representation of the uploaded file.", + "schema": { + "$ref": "#/definitions/OpenAIFile" + } + } + } + } + }, + "/files/{fileId}": { + "get": { + "operationId": "RetrieveFile", + "description": "Returns information about a specific file. Does not retrieve file content.", + "parameters": [ + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OpenAIFile" + } + } + } + }, + "delete": { + "operationId": "DeleteFile", + "description": "Delete a previously uploaded file.", + "parameters": [ + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/FileDeletionStatus" + } + } + } + } + }, + "/threads": { + "post": { + "operationId": "CreateThread", + "description": "Creates a new thread. Threads contain messages and can be run by assistants.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AssistantThreadCreationOptions" + } + } + ], + "responses": { + "200": { + "description": "Information about the newly created thread.", + "schema": { + "$ref": "#/definitions/AssistantThread" + } + } + } + } + }, + "/threads/{threadId}": { + "get": { + "operationId": "GetThread", + "description": "Gets information about an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to retrieve information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Information about the requested thread.", + "schema": { + "$ref": "#/definitions/AssistantThread" + } + } + } + }, + "post": { + "operationId": "ModifyThread", + "description": "Modifies an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to modify.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "Information about the modified thread.", + "schema": { + "$ref": "#/definitions/AssistantThread" + } + } + } + }, + "delete": { + "operationId": "DeleteThread", + "description": "Deletes an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Status information about the requested thread deletion operation.", + "schema": { + "$ref": "#/definitions/ThreadDeletionStatus" + } + } + } + } + }, + "/threads/{threadId}/messages": { + "get": { + "operationId": "ListMessages", + "description": "Gets a list of messages that exist on a thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to list messages from.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of messages.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/ThreadMessage" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateMessage", + "description": "Creates a new message on a specified thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to create the new message on.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "role": { + "$ref": "#/definitions/MessageRole", + "description": "The role to associate with the new message." + }, + "content": { + "type": "string", + "description": "The textual content for the new message." + }, + "file_ids": { + "type": "array", + "description": "A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files.", + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "role", + "content" + ] + } + } + ], + "responses": { + "200": { + "description": "A representation of the new message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + } + }, + "/threads/{threadId}/messages/{messageId}": { + "get": { + "operationId": "GetMessage", + "description": "Gets an existing message from an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to retrieve the specified message from.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to retrieve from the specified thread.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A representation of the requested message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + }, + "post": { + "operationId": "ModifyMessage", + "description": "Modifies an existing message on an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread containing the specified message to modify.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to modify on the specified thread.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "A representation of the modified message.", + "schema": { + "$ref": "#/definitions/ThreadMessage" + } + } + } + } + }, + "/threads/{threadId}/messages/{messageId}/files": { + "get": { + "operationId": "ListMessageFiles", + "description": "Gets a list of previously uploaded files associated with a message from a thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread containing the message to list files from.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to list files from.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of files associated with the specified message.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/MessageFile" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + } + }, + "/threads/{threadId}/messages/{messageId}/files/{fileId}": { + "get": { + "operationId": "GetMessageFile", + "description": "Gets information about a file attachment to a message within a thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread containing the message to get information from.", + "required": true, + "type": "string" + }, + { + "name": "messageId", + "in": "path", + "description": "The ID of the message to get information from.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The ID of the file to get information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested file information.", + "schema": { + "$ref": "#/definitions/MessageFile" + } + } + } + } + }, + "/threads/{threadId}/runs": { + "get": { + "operationId": "ListRuns", + "description": "Gets a list of runs for a specified thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to list runs from.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of thread runs.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/ThreadRun" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + }, + "post": { + "operationId": "CreateRun", + "description": "Creates a new run for an assistant thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to run.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "assistant_id": { + "type": "string", + "description": "The ID of the assistant that should run the thread.", + "x-ms-client-name": "assistantId" + }, + "model": { + "type": "string", + "description": "The overridden model name that the assistant should use to run the thread." + }, + "instructions": { + "type": "string", + "description": "The overridden system instructions that the assistant should use to run the thread." + }, + "tools": { + "type": "array", + "description": "The overridden list of enabled tools that the assistant should use to run the thread.", + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "assistant_id" + ] + } + } + ], + "responses": { + "200": { + "description": "Information about the new thread run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}": { + "get": { + "operationId": "GetRun", + "description": "Gets an existing run from an existing thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread to retrieve run information from.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the thread to retrieve information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested information about the specified thread run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + }, + "post": { + "operationId": "ModifyRun", + "description": "Modifies an existing thread run.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread associated with the specified run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run to modify.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "Information about the modified run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/cancel": { + "post": { + "operationId": "CancelRun", + "description": "Cancels a run of an in progress thread.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread being run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run to cancel.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Updated information about the cancelled run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/steps": { + "get": { + "operationId": "ListRunSteps", + "description": "Gets a list of run steps from a thread run.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread that was run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run to list steps from.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.", + "required": false, + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.", + "required": false, + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListSortOrder", + "modelAsString": true, + "values": [ + { + "name": "ascending", + "value": "asc", + "description": "Specifies an ascending sort order." + }, + { + "name": "descending", + "value": "desc", + "description": "Specifies a descending sort order." + } + ] + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.", + "required": false, + "type": "string" + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The requested list of run steps.", + "schema": { + "type": "object", + "description": "The response data for a requested list of items.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always list.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The requested list of items.", + "items": { + "$ref": "#/definitions/RunStep" + } + }, + "first_id": { + "type": "string", + "description": "The first ID represented in this list.", + "x-ms-client-name": "firstId" + }, + "last_id": { + "type": "string", + "description": "The last ID represented in this list.", + "x-ms-client-name": "lastId" + }, + "has_more": { + "type": "boolean", + "description": "A value indicating whether there are additional values available not captured in this list.", + "x-ms-client-name": "hasMore" + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/steps/{stepId}": { + "get": { + "operationId": "GetRunStep", + "description": "Gets a single run step from a thread run.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread that was run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the specific run to retrieve the step from.", + "required": true, + "type": "string" + }, + { + "name": "stepId", + "in": "path", + "description": "The ID of the step to retrieve information about.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Information about the requested run step.", + "schema": { + "$ref": "#/definitions/RunStep" + } + } + } + } + }, + "/threads/{threadId}/runs/{runId}/submit_tool_outputs": { + "post": { + "operationId": "SubmitToolOutputsToRun", + "description": "Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.", + "parameters": [ + { + "name": "threadId", + "in": "path", + "description": "The ID of the thread that was run.", + "required": true, + "type": "string" + }, + { + "name": "runId", + "in": "path", + "description": "The ID of the run that requires tool outputs.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "tool_outputs": { + "type": "array", + "description": "The list of tool outputs requested by tool calls from the specified run.", + "items": { + "$ref": "#/definitions/ToolOutput" + }, + "x-ms-client-name": "toolOutputs", + "x-ms-identifiers": [] + } + }, + "required": [ + "tool_outputs" + ] + } + } + ], + "responses": { + "200": { + "description": "Updated information about the run.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + }, + "/threads/runs": { + "post": { + "operationId": "CreateThreadAndRun", + "description": "Creates a new assistant thread and immediately starts a run using that new thread.", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateAndRunThreadOptions" + } + } + ], + "responses": { + "200": { + "description": "Information about the newly created thread.", + "schema": { + "$ref": "#/definitions/ThreadRun" + } + } + } + } + } + }, + "definitions": { + "Assistant": { + "type": "object", + "description": "Represents an assistant that can call the model and use tools.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always assistant.", + "enum": [ + "assistant" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "name": { + "type": "string", + "description": "The name of the assistant.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "The description of the assistant.", + "x-nullable": true + }, + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "instructions": { + "type": "string", + "description": "The system instructions for the assistant to use.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The collection of tools enabled for the assistant.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "file_ids": { + "type": "array", + "description": "A list of attached file IDs, ordered by creation date in ascending order.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "name", + "description", + "model", + "instructions", + "tools", + "file_ids", + "metadata" + ] + }, + "AssistantCreationOptions": { + "type": "object", + "description": "The request details to use when creating a new assistant.", + "properties": { + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "name": { + "type": "string", + "description": "The name of the new assistant.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "The description of the new assistant.", + "x-nullable": true + }, + "instructions": { + "type": "string", + "description": "The system instructions for the new assistant to use.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The collection of tools to enable for the new assistant.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "file_ids": { + "type": "array", + "description": "A list of previously uploaded file IDs to attach to the assistant.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "model" + ] + }, + "AssistantDeletionStatus": { + "type": "object", + "description": "The status of an assistant deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'assistant.deleted'.", + "enum": [ + "assistant.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "AssistantFile": { + "type": "object", + "description": "Information about a file attached to an assistant, as used by tools that can read files.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'assistant.file'.", + "enum": [ + "assistant.file" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "assistant_id": { + "type": "string", + "description": "The assistant ID that the file is attached to.", + "x-ms-client-name": "assistantId" + } + }, + "required": [ + "id", + "object", + "created_at", + "assistant_id" + ] + }, + "AssistantFileDeletionStatus": { + "type": "object", + "description": "The status of an assistant file deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'assistant.file.deleted'.", + "enum": [ + "assistant.file.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "AssistantModificationOptions": { + "type": "object", + "description": "The request details to use when modifying an existing assistant.", + "properties": { + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "name": { + "type": "string", + "description": "The modified name for the assistant to use.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "The modified description for the assistant to use.", + "x-nullable": true + }, + "instructions": { + "type": "string", + "description": "The modified system instructions for the new assistant to use.", + "x-nullable": true + }, + "tools": { + "type": "array", + "description": "The modified collection of tools to enable for the assistant.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "file_ids": { + "type": "array", + "description": "The modified list of previously uploaded fileIDs to attach to the assistant.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "AssistantThread": { + "type": "object", + "description": "Information about a single thread associated with an assistant.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread'.", + "enum": [ + "thread" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "metadata" + ] + }, + "AssistantThreadCreationOptions": { + "type": "object", + "description": "The details used to create a new assistant thread.", + "properties": { + "messages": { + "type": "array", + "description": "The messages to associate with the new thread.", + "items": { + "$ref": "#/definitions/ThreadMessage" + } + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "CodeInterpreterImageOutput": { + "type": "object", + "description": "A representation of an image output emitted by a code interpreter tool in response to a tool call by the model.", + "properties": { + "image": { + "$ref": "#/definitions/CodeInterpreterImageReference", + "description": "Referential information for the image associated with this output." + } + }, + "required": [ + "image" + ], + "allOf": [ + { + "$ref": "#/definitions/CodeInterpreterToolCallOutput" + } + ], + "x-ms-discriminator-value": "image" + }, + "CodeInterpreterImageReference": { + "type": "object", + "description": "An image reference emitted by a code interpreter tool in response to a tool call by the model.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file associated with this image.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "CodeInterpreterLogOutput": { + "type": "object", + "description": "A representation of a log output emitted by a code interpreter tool in response to a tool call by the model.", + "properties": { + "logs": { + "type": "string", + "description": "The serialized log output emitted by the code interpreter." + } + }, + "required": [ + "logs" + ], + "allOf": [ + { + "$ref": "#/definitions/CodeInterpreterToolCallOutput" + } + ], + "x-ms-discriminator-value": "logs" + }, + "CodeInterpreterToolCall": { + "type": "object", + "description": "A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that\nrepresents submitted output needed or already fulfilled by the tool for the model to continue.", + "properties": { + "code_interpreter": { + "$ref": "#/definitions/CodeInterpreterToolCallDetails", + "description": "The details of the tool call to the code interpreter tool.", + "x-ms-client-name": "codeInterpreter" + } + }, + "required": [ + "code_interpreter" + ], + "allOf": [ + { + "$ref": "#/definitions/ToolCall" + } + ], + "x-ms-discriminator-value": "code_interpreter" + }, + "CodeInterpreterToolCallDetails": { + "type": "object", + "description": "The detailed information about a code interpreter invocation by the model.", + "properties": { + "input": { + "type": "string", + "description": "The input provided by the model to the code interpreter tool." + }, + "outputs": { + "type": "array", + "description": "The outputs produced by the code interpreter tool back to the model in response to the tool call.", + "items": { + "$ref": "#/definitions/CodeInterpreterToolCallOutput" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "input", + "outputs" + ] + }, + "CodeInterpreterToolCallOutput": { + "type": "object", + "description": "An abstract representation of an emitted output from a code interpreter tool.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "CodeInterpreterToolDefinition": { + "type": "object", + "description": "The input definition information for a code interpreter tool as used to configure an assistant.", + "allOf": [ + { + "$ref": "#/definitions/ToolDefinition" + } + ], + "x-ms-discriminator-value": "code_interpreter" + }, + "CreateAndRunThreadOptions": { + "type": "object", + "description": "The details used when creating and immediately running a new assistant thread.", + "properties": { + "assistant_id": { + "type": "string", + "description": "The ID of the assistant for which the thread should be created.", + "x-ms-client-name": "assistantId" + }, + "thread": { + "$ref": "#/definitions/AssistantThreadCreationOptions", + "description": "The details used to create the new thread." + }, + "model": { + "type": "string", + "description": "The overridden model that the assistant should use to run the thread." + }, + "instructions": { + "type": "string", + "description": "The overridden system instructions the assistant should use to run the thread." + }, + "tools": { + "type": "array", + "description": "The overridden list of enabled tools the assistant should use to run the thread.", + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "assistant_id" + ] + }, + "FileDeletionStatus": { + "type": "object", + "description": "A status response from a file deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'file'.", + "enum": [ + "file" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "FileListResponse": { + "type": "object", + "description": "The response data from a file list operation.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always 'list'.", + "enum": [ + "list" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "data": { + "type": "array", + "description": "The files returned for the request.", + "items": { + "$ref": "#/definitions/OpenAIFile" + } + } + }, + "required": [ + "object", + "data" + ] + }, + "FilePurpose": { + "type": "string", + "description": "The possible values denoting the intended usage of a file.", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output" + ], + "x-ms-enum": { + "name": "FilePurpose", + "modelAsString": true, + "values": [ + { + "name": "fineTune", + "value": "fine-tune", + "description": "Indicates a file is used for fine tuning input." + }, + { + "name": "fineTuneResults", + "value": "fine-tune-results", + "description": "Indicates a file is used for fine tuning results." + }, + { + "name": "assistants", + "value": "assistants", + "description": "Indicates a file is used as input to assistants." + }, + { + "name": "assistantsOutput", + "value": "assistants_output", + "description": "Indicates a file is used as output by assistants." + } + ] + } + }, + "FunctionDefinition": { + "type": "object", + "description": "The input definition information for a function.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to be called." + }, + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "parameters": { + "description": "The parameters the functions accepts, described as a JSON Schema object." + } + }, + "required": [ + "name", + "parameters" + ] + }, + "FunctionToolCall": { + "type": "object", + "description": "A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents\ngiven function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue.", + "properties": { + "function": { + "$ref": "#/definitions/FunctionToolCallDetails", + "description": "The detailed information about the function called by the model." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/ToolCall" + } + ], + "x-ms-discriminator-value": "function" + }, + "FunctionToolCallDetails": { + "type": "object", + "description": "The detailed information about the function called by the model.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments that the model requires are provided to the named function." + }, + "output": { + "type": "string", + "description": "The output of the function, only populated for function calls that have already have had their outputs submitted.", + "x-nullable": true + } + }, + "required": [ + "name", + "arguments", + "output" + ] + }, + "FunctionToolDefinition": { + "type": "object", + "description": "The input definition information for a function tool as used to configure an assistant.", + "properties": { + "function": { + "$ref": "#/definitions/FunctionDefinition", + "description": "The definition of the concrete function that the function tool should call." + } + }, + "required": [ + "function" + ], + "allOf": [ + { + "$ref": "#/definitions/ToolDefinition" + } + ], + "x-ms-discriminator-value": "function" + }, + "MessageContent": { + "type": "object", + "description": "An abstract representation of a single item of thread message content.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "MessageFile": { + "type": "object", + "description": "Information about a file attached to an assistant thread message.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.message.file'.", + "enum": [ + "thread.message.file" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "message_id": { + "type": "string", + "description": "The ID of the message that this file is attached to.", + "x-ms-client-name": "messageId" + } + }, + "required": [ + "id", + "object", + "created_at", + "message_id" + ] + }, + "MessageFileCitationTextAnnotation": { + "type": "object", + "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.", + "properties": { + "file_citation": { + "$ref": "#/definitions/MessageTextFileCitationDetails", + "description": "A citation within the message that points to a specific quote from a specific file.\nGenerated when the assistant uses the \"retrieval\" tool to search files.", + "x-ms-client-name": "fileCitation" + } + }, + "required": [ + "file_citation" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTextAnnotation" + } + ], + "x-ms-discriminator-value": "file_citation" + }, + "MessageFilePathDetails": { + "type": "object", + "description": "An encapsulation of an image file ID, as used by message image content.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the specific file that the citation is from.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "MessageFilePathTextAnnotation": { + "type": "object", + "description": "A citation within the message that points to a file located at a specific path.", + "properties": { + "file_path": { + "$ref": "#/definitions/MessageFilePathDetails", + "description": "A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.", + "x-ms-client-name": "filePath" + } + }, + "required": [ + "file_path" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTextAnnotation" + } + ], + "x-ms-discriminator-value": "file_path" + }, + "MessageImageFileContent": { + "type": "object", + "description": "A representation of image file content in a thread message.", + "properties": { + "image_file": { + "$ref": "#/definitions/MessageImageFileDetails", + "description": "The image file for this thread message content item.", + "x-ms-client-name": "imageFile" + } + }, + "required": [ + "image_file" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageContent" + } + ], + "x-ms-discriminator-value": "image_file" + }, + "MessageImageFileDetails": { + "type": "object", + "description": "An image reference, as represented in thread message content.", + "properties": { + "file_id": { + "$ref": "#/definitions/MessageImageFileIdDetails", + "description": "The ID for the file associated with this image.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "MessageImageFileIdDetails": { + "type": "object", + "description": "An encapsulation of an image file ID, as used by message image content.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the specific image file.", + "x-ms-client-name": "fileId" + } + }, + "required": [ + "file_id" + ] + }, + "MessageRole": { + "type": "string", + "description": "The possible values for roles attributed to messages in a thread.", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "MessageRole", + "modelAsString": true, + "values": [ + { + "name": "user", + "value": "user", + "description": "The role representing the end-user." + }, + { + "name": "assistant", + "value": "assistant", + "description": "The role representing the assistant." + } + ] + } + }, + "MessageTextAnnotation": { + "type": "object", + "description": "An abstract representation of an annotation to text thread message content.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + }, + "text": { + "type": "string", + "description": "The textual content associated with this text annotation item." + }, + "start_index": { + "type": "integer", + "format": "int32", + "description": "The first text index associated with this text annotation.", + "x-ms-client-name": "startIndex" + }, + "end_index": { + "type": "integer", + "format": "int32", + "description": "The last text index associated with this text annotation.", + "x-ms-client-name": "endIndex" + } + }, + "discriminator": "type", + "required": [ + "type", + "text", + "start_index", + "end_index" + ] + }, + "MessageTextContent": { + "type": "object", + "description": "A representation of a textual item of thread message content.", + "properties": { + "text": { + "$ref": "#/definitions/MessageTextDetails", + "description": "The text and associated annotations for this thread message content item." + } + }, + "required": [ + "text" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageContent" + } + ], + "x-ms-discriminator-value": "text" + }, + "MessageTextDetails": { + "type": "object", + "description": "The text and associated annotations for a single item of assistant thread message content.", + "properties": { + "value": { + "type": "string", + "description": "The text data." + }, + "annotations": { + "type": "array", + "description": "A list of annotations associated with this text.", + "items": { + "$ref": "#/definitions/MessageTextAnnotation" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "value", + "annotations" + ] + }, + "MessageTextFileCitationDetails": { + "type": "object", + "description": "A representation of a file-based text citation, as used in a file-based annotation of text thread message content.", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file associated with this citation.", + "x-ms-client-name": "fileId" + }, + "quote": { + "type": "string", + "description": "The specific quote cited in the associated file." + } + }, + "required": [ + "file_id", + "quote" + ] + }, + "OpenAIFile": { + "type": "object", + "description": "Represents an assistant that can call the model and use tools.", + "properties": { + "object": { + "type": "string", + "description": "The object type, which is always 'file'.", + "enum": [ + "file" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "bytes": { + "type": "integer", + "format": "int32", + "description": "The size of the file, in bytes." + }, + "filename": { + "type": "string", + "description": "The name of the file." + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "purpose": { + "$ref": "#/definitions/FilePurpose", + "description": "The intended purpose of a file." + } + }, + "required": [ + "object", + "id", + "bytes", + "filename", + "created_at", + "purpose" + ] + }, + "RequiredAction": { + "type": "object", + "description": "An abstract representation of a required action for an assistant thread run to continue.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "RetrievalToolCall": { + "type": "object", + "description": "A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents\nsubmitted output needed or already fulfilled by the tool for the model to continue.", + "properties": { + "retrieval": { + "type": "object", + "description": "The key/value pairs produced by the retrieval tool.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "retrieval" + ], + "allOf": [ + { + "$ref": "#/definitions/ToolCall" + } + ], + "x-ms-discriminator-value": "retrieval" + }, + "RetrievalToolDefinition": { + "type": "object", + "description": "The input definition information for a retrieval tool as used to configure an assistant.", + "allOf": [ + { + "$ref": "#/definitions/ToolDefinition" + } + ], + "x-ms-discriminator-value": "retrieval" + }, + "RunError": { + "type": "object", + "description": "The details of an error as encountered by an assistant thread run.", + "properties": { + "code": { + "type": "string", + "description": "The status for the error." + }, + "message": { + "type": "string", + "description": "The human-readable text associated with the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "RunStatus": { + "type": "string", + "description": "Possible values for the status of an assistant thread run.", + "enum": [ + "queued", + "in_progress", + "requires_action", + "cancelling", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunStatus", + "modelAsString": true, + "values": [ + { + "name": "queued", + "value": "queued", + "description": "Represents a run that is queued to start." + }, + { + "name": "inProgress", + "value": "in_progress", + "description": "Represents a run that is in progress." + }, + { + "name": "requiresAction", + "value": "requires_action", + "description": "Represents a run that needs another operation, such as tool output submission, to continue." + }, + { + "name": "cancelling", + "value": "cancelling", + "description": "Represents a run that is in the process of cancellation." + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Represents a run that has been cancelled." + }, + { + "name": "failed", + "value": "failed", + "description": "Represents a run that failed." + }, + { + "name": "completed", + "value": "completed", + "description": "Represents a run that successfully completed." + }, + { + "name": "expired", + "value": "expired", + "description": "Represents a run that expired before it could otherwise finish." + } + ] + } + }, + "RunStep": { + "type": "object", + "description": "Detailed information about a single step of an assistant thread run.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.run.step'.", + "enum": [ + "thread.run.step" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "type": { + "$ref": "#/definitions/RunStepType", + "description": "The type of run step, which can be either message_creation or tool_calls." + }, + "assistant_id": { + "type": "string", + "description": "The ID of the assistant associated with the run step.", + "x-ms-client-name": "assistantId" + }, + "thread_id": { + "type": "string", + "description": "The ID of the thread that was run.", + "x-ms-client-name": "threadId" + }, + "run_id": { + "type": "string", + "description": "The ID of the run that this run step is a part of.", + "x-ms-client-name": "runId" + }, + "status": { + "$ref": "#/definitions/RunStepStatus", + "description": "The status of this run step." + }, + "step_details": { + "$ref": "#/definitions/RunStepDetails", + "description": "The details for this run step.", + "x-ms-client-name": "stepDetails" + }, + "last_error": { + "type": "object", + "description": "If applicable, information about the last error encountered by this run step.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RunStepError" + } + ], + "x-ms-client-name": "lastError" + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "expired_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this item expired.", + "x-nullable": true, + "x-ms-client-name": "expiredAt" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this completed.", + "x-nullable": true, + "x-ms-client-name": "completedAt" + }, + "cancelled_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this was cancelled.", + "x-nullable": true, + "x-ms-client-name": "cancelledAt" + }, + "failed_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this failed.", + "x-nullable": true, + "x-ms-client-name": "failedAt" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "type", + "assistant_id", + "thread_id", + "run_id", + "status", + "step_details", + "last_error", + "created_at", + "expired_at", + "completed_at", + "cancelled_at", + "failed_at", + "metadata" + ] + }, + "RunStepDetails": { + "type": "object", + "description": "An abstract representation of the details for a run step.", + "properties": { + "type": { + "$ref": "#/definitions/RunStepType", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "RunStepError": { + "type": "object", + "description": "The error information associated with a failed run step.", + "properties": { + "code": { + "$ref": "#/definitions/RunStepErrorCode", + "description": "The error code for this error." + }, + "message": { + "type": "string", + "description": "The human-readable text associated with this error." + } + }, + "required": [ + "code", + "message" + ] + }, + "RunStepErrorCode": { + "type": "string", + "description": "Possible error code values attributable to a failed run step.", + "enum": [ + "server_error", + "rate_limit_exceeded" + ], + "x-ms-enum": { + "name": "RunStepErrorCode", + "modelAsString": true, + "values": [ + { + "name": "serverError", + "value": "server_error", + "description": "Represents a server error." + }, + { + "name": "rateLimitExceeded", + "value": "rate_limit_exceeded", + "description": "Represents an error indicating configured rate limits were exceeded." + } + ] + } + }, + "RunStepMessageCreationDetails": { + "type": "object", + "description": "The detailed information associated with a message creation run step.", + "properties": { + "message_creation": { + "$ref": "#/definitions/RunStepMessageCreationReference", + "description": "Information about the message creation associated with this run step.", + "x-ms-client-name": "messageCreation" + } + }, + "required": [ + "message_creation" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepDetails" + } + ], + "x-ms-discriminator-value": "message_creation" + }, + "RunStepMessageCreationReference": { + "type": "object", + "description": "The details of a message created as a part of a run step.", + "properties": { + "message_id": { + "type": "string", + "description": "The ID of the message created by this run step.", + "x-ms-client-name": "messageId" + } + }, + "required": [ + "message_id" + ] + }, + "RunStepStatus": { + "type": "string", + "description": "Possible values for the status of a run step.", + "enum": [ + "in_progress", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunStepStatus", + "modelAsString": true, + "values": [ + { + "name": "inProgress", + "value": "in_progress", + "description": "Represents a run step still in progress." + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Represents a run step that was cancelled." + }, + { + "name": "failed", + "value": "failed", + "description": "Represents a run step that failed." + }, + { + "name": "completed", + "value": "completed", + "description": "Represents a run step that successfully completed." + }, + { + "name": "expired", + "value": "expired", + "description": "Represents a run step that expired before otherwise finishing." + } + ] + } + }, + "RunStepToolCallDetails": { + "type": "object", + "description": "The detailed information associated with a run step calling tools.", + "properties": { + "tool_calls": { + "type": "array", + "description": "A list tool call details for this run step.", + "items": { + "$ref": "#/definitions/ToolCall" + }, + "x-ms-client-name": "toolCalls" + } + }, + "required": [ + "tool_calls" + ], + "allOf": [ + { + "$ref": "#/definitions/RunStepDetails" + } + ], + "x-ms-discriminator-value": "tool_calls" + }, + "RunStepType": { + "type": "string", + "description": "The possible types of run steps.", + "enum": [ + "message_creation", + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepType", + "modelAsString": true, + "values": [ + { + "name": "messageCreation", + "value": "message_creation", + "description": "Represents a run step to create a message." + }, + { + "name": "toolCalls", + "value": "tool_calls", + "description": "Represents a run step that calls tools." + } + ] + } + }, + "SubmitToolOutputsAction": { + "type": "object", + "description": "The details for required tool calls that must be submitted for an assistant thread run to continue.", + "properties": { + "submit_tool_outputs": { + "$ref": "#/definitions/SubmitToolOutputsDetails", + "description": "The details describing tools that should be called to submit tool outputs.", + "x-ms-client-name": "submitToolOutputs" + } + }, + "required": [ + "submit_tool_outputs" + ], + "allOf": [ + { + "$ref": "#/definitions/RequiredAction" + } + ], + "x-ms-discriminator-value": "submit_tool_outputs" + }, + "SubmitToolOutputsDetails": { + "type": "object", + "description": "The details describing tools that should be called to submit tool outputs.", + "properties": { + "tool_calls": { + "type": "array", + "description": "The list of tool calls that must be resolved for the assistant thread run to continue.", + "items": { + "$ref": "#/definitions/ToolCall" + }, + "x-ms-client-name": "toolCalls" + } + }, + "required": [ + "tool_calls" + ] + }, + "ThreadDeletionStatus": { + "type": "object", + "description": "The status of a thread deletion operation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource specified for deletion." + }, + "deleted": { + "type": "boolean", + "description": "A value indicating whether deletion was successful." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.deleted'.", + "enum": [ + "thread.deleted" + ], + "x-ms-enum": { + "modelAsString": false + } + } + }, + "required": [ + "id", + "deleted", + "object" + ] + }, + "ThreadMessage": { + "type": "object", + "description": "A single message within an assistant thread.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.message'.", + "enum": [ + "thread.message" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "thread_id": { + "type": "string", + "description": "The ID of the thread that this message belongs to.", + "x-ms-client-name": "threadId" + }, + "role": { + "$ref": "#/definitions/MessageRole", + "description": "The role associated with the assistant thread message." + }, + "content": { + "type": "array", + "description": "The list of content items associated with the assistant thread message.", + "items": { + "$ref": "#/definitions/MessageContent" + }, + "x-ms-identifiers": [] + }, + "assistant_id": { + "type": "string", + "description": "If applicable, the ID of the assistant that authored this message.", + "x-ms-client-name": "assistantId" + }, + "run_id": { + "type": "string", + "description": "If applicable, the ID of the run associated with the authoring of this message.", + "x-ms-client-name": "runId" + }, + "file_ids": { + "type": "array", + "description": "A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can\naccess files.", + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "created_at", + "thread_id", + "role", + "content", + "file_ids", + "metadata" + ] + }, + "ThreadRun": { + "type": "object", + "description": "Data representing a single evaluation run of an assistant thread.", + "properties": { + "id": { + "type": "string", + "description": "The identifier, which can be referenced in API endpoints." + }, + "object": { + "type": "string", + "description": "The object type, which is always 'thread.run'.", + "enum": [ + "thread.run" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "thread_id": { + "type": "string", + "description": "The ID of the thread associated with this run.", + "x-ms-client-name": "threadId" + }, + "assistant_id": { + "type": "string", + "description": "The ID of the assistant associated with the thread this run was performed against.", + "x-ms-client-name": "assistantId" + }, + "status": { + "$ref": "#/definitions/RunStatus", + "description": "The status of the assistant thread run." + }, + "required_action": { + "type": "object", + "description": "The details of the action required for the assistant thread run to continue.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RequiredAction" + } + ], + "x-ms-client-name": "requiredAction" + }, + "last_error": { + "type": "object", + "description": "The last error, if any, encountered by this assistant thread run.", + "x-nullable": true, + "allOf": [ + { + "$ref": "#/definitions/RunError" + } + ], + "x-ms-client-name": "lastError" + }, + "model": { + "type": "string", + "description": "The ID of the model to use." + }, + "instructions": { + "type": "string", + "description": "The overridden system instructions used for this assistant thread run." + }, + "tools": { + "type": "array", + "description": "The overridden enabled tools used for this assistant thread run.", + "default": [], + "items": { + "$ref": "#/definitions/ToolDefinition" + }, + "x-ms-identifiers": [] + }, + "file_ids": { + "type": "array", + "description": "A list of attached file IDs, ordered by creation date in ascending order.", + "default": [], + "items": { + "type": "string" + }, + "x-ms-client-name": "fileIds" + }, + "created_at": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp, in seconds, representing when this object was created.", + "x-ms-client-name": "createdAt" + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this item expires.", + "x-nullable": true, + "x-ms-client-name": "expiresAt" + }, + "started_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this item was started.", + "x-nullable": true, + "x-ms-client-name": "startedAt" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this completed.", + "x-nullable": true, + "x-ms-client-name": "completedAt" + }, + "cancelled_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this was cancelled.", + "x-nullable": true, + "x-ms-client-name": "cancelledAt" + }, + "failed_at": { + "type": "string", + "format": "date-time", + "description": "The Unix timestamp, in seconds, representing when this failed.", + "x-nullable": true, + "x-ms-client-name": "failedAt" + }, + "metadata": { + "type": "object", + "description": "A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "object", + "thread_id", + "assistant_id", + "status", + "last_error", + "model", + "instructions", + "tools", + "file_ids", + "created_at", + "expires_at", + "started_at", + "completed_at", + "cancelled_at", + "failed_at", + "metadata" + ] + }, + "ToolCall": { + "type": "object", + "description": "An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must\nbe fulfilled and have its outputs submitted before the model can continue.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + }, + "id": { + "type": "string", + "description": "The ID of the tool call. This ID must be referenced when you submit tool outputs." + } + }, + "discriminator": "type", + "required": [ + "type", + "id" + ] + }, + "ToolDefinition": { + "type": "object", + "description": "An abstract representation of an input tool definition that an assistant can use.", + "properties": { + "type": { + "type": "string", + "description": "The object type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ToolOutput": { + "type": "object", + "description": "The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.", + "properties": { + "tool_call_id": { + "type": "string", + "description": "The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.", + "x-ms-client-name": "toolCallId" + }, + "output": { + "type": "string", + "description": "The output from the tool to be submitted." + } + } + } + }, + "parameters": {} +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json new file mode 100644 index 000000000000..24f1208ac3df --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV2/stable/2023-11-06-beta/examples/create_assistant.json @@ -0,0 +1,4 @@ +{ + "title": "Assistants_CreateAssistant", + "operationId": "Assistants_CreateAssistant" +} diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml new file mode 100644 index 000000000000..8a83ec762134 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-02-15-preview/assistants_generated.yaml @@ -0,0 +1,2388 @@ +openapi: 3.0.0 +info: + title: Azure OpenAI + version: 2023-02-15-preview + description: Azure OpenAI APIs for Assistants. +tags: [] +paths: + /assistants: + post: + operationId: createAssistant + description: Creates a new assistant. + parameters: [] + responses: + '200': + description: The new assistant instance. + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantCreationOptions' + get: + operationId: listAssistants + description: Gets a list of assistants that were previously created. + parameters: + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of assistants. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/Assistant' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /assistants/{assistantId}: + get: + operationId: getAssistant + description: Retrieves an existing assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to retrieve. + schema: + type: string + responses: + '200': + description: The requested assistant instance. + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + post: + operationId: modifyAssistant + description: Modifies an existing assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to modify. + schema: + type: string + responses: + '200': + description: The updated assistant instance. + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + requestBody: + description: The details of the modification to perform on the specified assistant. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantModificationOptions' + delete: + operationId: deleteAssistant + description: Deletes an assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to delete. + schema: + type: string + responses: + '200': + description: Status information about the requested deletion operation. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantDeletionStatus' + /assistants/{assistantId}/files: + post: + operationId: createAssistantFile + description: Attaches a previously uploaded file to an assistant for use by tools that can read files. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to attach the file to. + schema: + type: string + responses: + '200': + description: Information about the attached file. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantFile' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + file_id: + type: string + description: The ID of the previously uploaded file to attach. + required: + - file_id + get: + operationId: listAssistantFiles + description: Gets a list of files attached to a specific assistant, as used by tools that can read files. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to retrieve the list of attached files for. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of files attached to the specified assistant. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/AssistantFile' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /assistants/{assistantId}/files/{fileId}: + get: + operationId: getAssistantFile + description: Retrieves a file attached to an assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant associated with the attached file. + schema: + type: string + - name: fileId + in: path + required: true + description: The ID of the file to retrieve. + schema: + type: string + responses: + '200': + description: A representation of the attached file. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantFile' + delete: + operationId: deleteAssistantFile + description: |- + Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read + files. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant from which the specified file should be unlinked. + schema: + type: string + - name: fileId + in: path + required: true + description: The ID of the file to unlink from the specified assistant. + schema: + type: string + responses: + '200': + description: Status information about the requested file association deletion. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantFileDeletionStatus' + /files: + get: + operationId: listFiles + description: Gets a list of previously uploaded files. + parameters: + - name: purpose + in: query + required: false + description: A value that, when provided, limits list results to files matching the corresponding purpose. + schema: + $ref: '#/components/schemas/FilePurpose' + responses: + '200': + description: The requested list of files. + content: + application/json: + schema: + $ref: '#/components/schemas/FileListResponse' + post: + operationId: createFile + description: Uploads a file for use by other operations. + parameters: [] + responses: + '200': + description: A representation of the uploaded file. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIFile' + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + purpose: + allOf: + - $ref: '#/components/schemas/FilePurpose' + description: The intended purpose of the file. + filename: + type: string + description: A filename to associate with the uploaded data. + required: + - file + - purpose + /files/{fileId}/{file_id}: + delete: + operationId: deleteFile + description: Delete a previously uploaded file. + parameters: + - name: fileId + in: path + required: true + description: The ID of the file to delete. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/FileDeletionStatus' + get: + operationId: retrieveFile + description: Returns information about a specific file. Does not retrieve file content. + parameters: + - name: fileId + in: path + required: true + description: The ID of the file to retrieve. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIFile' + /threads: + post: + operationId: createThread + description: Creates a new thread. Threads contain messages and can be run by assistants. + parameters: [] + responses: + '200': + description: Information about the newly created thread. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThread' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThreadCreationOptions' + /threads/runs: + post: + operationId: createThreadAndRun + description: Creates a new assistant thread and immediately starts a run using that new thread. + parameters: [] + responses: + '200': + description: Information about the newly created thread. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndRunThreadOptions' + /threads/{threadId}: + get: + operationId: getThread + description: Gets information about an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to retrieve information about. + schema: + type: string + responses: + '200': + description: Information about the requested thread. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThread' + post: + operationId: modifyThread + description: Modifies an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to modify. + schema: + type: string + responses: + '200': + description: Information about the modified thread. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThread' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + delete: + operationId: deleteThread + description: Deletes an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to delete. + schema: + type: string + responses: + '200': + description: Status information about the requested thread deletion operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadDeletionStatus' + /threads/{threadId}/messages: + post: + operationId: createMessage + description: Creates a new message on a specified thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to create the new message on. + schema: + type: string + responses: + '200': + description: A representation of the new message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + description: The role to associate with the new message. + content: + type: string + description: The textual content for the new message. + file_ids: + type: array + items: + type: string + description: A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + required: + - role + - content + get: + operationId: listMessages + description: Gets a list of messages that exist on a thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to list messages from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of messages. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/ThreadMessage' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/messages/{messageId}: + get: + operationId: getMessage + description: Gets an existing message from an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to retrieve the specified message from. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to retrieve from the specified thread. + schema: + type: string + responses: + '200': + description: A representation of the requested message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + post: + operationId: modifyMessage + description: Modifies an existing message on an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread containing the specified message to modify. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to modify on the specified thread. + schema: + type: string + responses: + '200': + description: A representation of the modified message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + /threads/{threadId}/messages/{messageId}/files: + get: + operationId: listMessageFiles + description: Gets a list of previously uploaded files associated with a message from a thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread containing the message to list files from. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to list files from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of files associated with the specified message. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/MessageFile' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/messages/{messageId}/files/{fileId}: + get: + operationId: getMessageFile + description: Gets information about a file attachment to a message within a thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread containing the message to get information from. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to get information from. + schema: + type: string + - name: fileId + in: path + required: true + description: The ID of the file to get information about. + schema: + type: string + responses: + '200': + description: The requested file information. + content: + application/json: + schema: + $ref: '#/components/schemas/MessageFile' + /threads/{threadId}/runs: + post: + operationId: createRun + description: Creates a new run for an assistant thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to run. + schema: + type: string + responses: + '200': + description: Information about the new thread run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + assistant_id: + type: string + description: The ID of the assistant that should run the thread. + model: + type: string + description: The overridden model name that the assistant should use to run the thread. + instructions: + type: string + description: The overridden system instructions that the assistant should use to run the thread. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The overridden list of enabled tools that the assistant should use to run the thread. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + required: + - assistant_id + get: + operationId: listRuns + description: Gets a list of runs for a specified thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to list runs from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of thread runs. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/ThreadRun' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/runs/{runId}: + get: + operationId: getRun + description: Gets an existing run from an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to retrieve run information from. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the thread to retrieve information about. + schema: + type: string + responses: + '200': + description: The requested information about the specified thread run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + post: + operationId: modifyRun + description: Modifies an existing thread run. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread associated with the specified run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run to modify. + schema: + type: string + responses: + '200': + description: Information about the modified run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + /threads/{threadId}/runs/{runId}/cancel: + post: + operationId: cancelRun + description: Cancels a run of an in progress thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread being run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run to cancel. + schema: + type: string + responses: + '200': + description: Updated information about the cancelled run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + /threads/{threadId}/runs/{runId}/steps: + get: + operationId: listRunSteps + description: Gets a list of run steps from a thread run. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread that was run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run to list steps from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of run steps. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/RunStep' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/runs/{runId}/steps/{stepId}: + get: + operationId: getRunStep + description: Gets a single run step from a thread run. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread that was run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the specific run to retrieve the step from. + schema: + type: string + - name: stepId + in: path + required: true + description: The ID of the step to retrieve information about. + schema: + type: string + responses: + '200': + description: Information about the requested run step. + content: + application/json: + schema: + $ref: '#/components/schemas/RunStep' + /threads/{threadId}/runs/{runId}/submit_tool_outputs: + post: + operationId: submitToolOutputsToRun + description: Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread that was run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run that requires tool outputs. + schema: + type: string + responses: + '200': + description: Updated information about the run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tool_outputs: + type: array + items: + $ref: '#/components/schemas/ToolOutput' + description: The list of tool outputs requested by tool calls from the specified run. + required: + - tool_outputs +security: + - ApiKeyAuth: [] + - OAuth2Auth: + - https://cognitiveservices.azure.com/.default +components: + schemas: + Assistant: + type: object + required: + - id + - object + - created_at + - name + - description + - model + - instructions + - tools + - file_ids + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - assistant + description: The object type, which is always assistant. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + name: + type: string + nullable: true + description: The name of the assistant. + description: + type: string + nullable: true + description: The description of the assistant. + model: + type: string + description: The ID of the model to use. + instructions: + type: string + nullable: true + description: The system instructions for the assistant to use. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The collection of tools enabled for the assistant. + default: [] + file_ids: + type: array + items: + type: string + description: A list of attached file IDs, ordered by creation date in ascending order. + default: [] + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Represents an assistant that can call the model and use tools. + AssistantCreationOptions: + type: object + required: + - model + properties: + model: + type: string + description: The ID of the model to use. + name: + type: string + nullable: true + description: The name of the new assistant. + description: + type: string + nullable: true + description: The description of the new assistant. + instructions: + type: string + nullable: true + description: The system instructions for the new assistant to use. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The collection of tools to enable for the new assistant. + default: [] + file_ids: + type: array + items: + type: string + description: A list of previously uploaded file IDs to attach to the assistant. + default: [] + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The request details to use when creating a new assistant. + AssistantDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - assistant.deleted + description: The object type, which is always 'assistant.deleted'. + description: The status of an assistant deletion operation. + AssistantFile: + type: object + required: + - id + - object + - created_at + - assistant_id + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - assistant.file + description: The object type, which is always 'assistant.file'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + assistant_id: + type: string + description: The assistant ID that the file is attached to. + description: Information about a file attached to an assistant, as used by tools that can read files. + AssistantFileDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - assistant.file.deleted + description: The object type, which is always 'assistant.file.deleted'. + description: The status of an assistant file deletion operation. + AssistantModificationOptions: + type: object + properties: + model: + type: string + description: The ID of the model to use. + name: + type: string + nullable: true + description: The modified name for the assistant to use. + description: + type: string + nullable: true + description: The modified description for the assistant to use. + instructions: + type: string + nullable: true + description: The modified system instructions for the new assistant to use. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The modified collection of tools to enable for the assistant. + default: [] + file_ids: + type: array + items: + type: string + description: The modified list of previously uploaded fileIDs to attach to the assistant. + default: [] + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The request details to use when modifying an existing assistant. + AssistantThread: + type: object + required: + - id + - object + - created_at + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread + description: The object type, which is always 'thread'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Information about a single thread associated with an assistant. + AssistantThreadCreationOptions: + type: object + properties: + messages: + type: array + items: + $ref: '#/components/schemas/ThreadMessage' + description: The messages to associate with the new thread. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The details used to create a new assistant thread. + CodeInterpreterImageOutput: + type: object + required: + - type + - image + properties: + type: + type: string + enum: + - image + description: The object type, which is always 'image'. + image: + allOf: + - $ref: '#/components/schemas/CodeInterpreterImageReference' + description: Referential information for the image associated with this output. + allOf: + - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' + description: A representation of an image output emitted by a code interpreter tool in response to a tool call by the model. + CodeInterpreterImageReference: + type: object + required: + - file_id + properties: + file_id: + type: string + description: The ID of the file associated with this image. + description: An image reference emitted by a code interpreter tool in response to a tool call by the model. + CodeInterpreterLogOutput: + type: object + required: + - type + - logs + properties: + type: + type: string + enum: + - logs + description: The object type, which is always 'logs'. + logs: + type: string + description: The serialized log output emitted by the code interpreter. + allOf: + - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' + description: A representation of a log output emitted by a code interpreter tool in response to a tool call by the model. + CodeInterpreterToolCall: + type: object + required: + - type + - code_interpreter + properties: + type: + type: string + enum: + - code_interpreter + description: The object type, which is always 'code_interpreter'. + code_interpreter: + allOf: + - $ref: '#/components/schemas/CodeInterpreterToolCallDetails' + description: The details of the tool call to the code interpreter tool. + allOf: + - $ref: '#/components/schemas/ToolCall' + description: |- + A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that + represents submitted output needed or already fulfilled by the tool for the model to continue. + CodeInterpreterToolCallDetails: + type: object + required: + - input + - outputs + properties: + input: + type: string + description: The input provided by the model to the code interpreter tool. + outputs: + type: array + items: + $ref: '#/components/schemas/CodeInterpreterToolCallOutput' + description: The outputs produced by the code interpreter tool back to the model in response to the tool call. + description: The detailed information about a code interpreter invocation by the model. + CodeInterpreterToolCallOutput: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + logs: '#/components/schemas/CodeInterpreterLogOutput' + image: '#/components/schemas/CodeInterpreterImageOutput' + description: An abstract representation of an emitted output from a code interpreter tool. + CodeInterpreterToolDefinition: + type: object + required: + - type + properties: + type: + type: string + enum: + - code_interpreter + description: The object type, which is always 'code_interpreter'. + allOf: + - $ref: '#/components/schemas/ToolDefinition' + description: The input definition information for a code interpreter tool as used to configure an assistant. + CreateAndRunThreadOptions: + type: object + required: + - assistant_id + properties: + assistant_id: + type: string + description: The ID of the assistant for which the thread should be created. + thread: + allOf: + - $ref: '#/components/schemas/AssistantThreadCreationOptions' + description: The details used to create the new thread. + model: + type: string + description: The overridden model that the assistant should use to run the thread. + instructions: + type: string + description: The overridden system instructions the assistant should use to run the thread. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The overridden list of enabled tools the assistant should use to run the thread. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The details used when creating and immediately running a new assistant thread. + FileDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - file + description: The object type, which is always 'file'. + description: A status response from a file deletion operation. + FileListResponse: + type: object + required: + - object + - data + properties: + object: + type: string + enum: + - list + description: The object type, which is always 'list'. + data: + type: array + items: + $ref: '#/components/schemas/OpenAIFile' + description: The files returned for the request. + description: The response data from a file list operation. + FilePurpose: + type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + description: The possible values denoting the intended usage of a file. + FunctionDefinition: + type: object + required: + - name + - parameters + properties: + name: + type: string + description: The name of the function to be called. + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + parameters: + description: The parameters the functions accepts, described as a JSON Schema object. + description: The input definition information for a function. + FunctionToolCall: + type: object + required: + - type + - function + properties: + type: + type: string + enum: + - function + description: The object type, which is always 'function'. + function: + allOf: + - $ref: '#/components/schemas/FunctionToolCallDetails' + description: The detailed information about the function called by the model. + allOf: + - $ref: '#/components/schemas/ToolCall' + description: |- + A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents + given function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue. + FunctionToolCallDetails: + type: object + required: + - name + - arguments + - output + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments that the model requires are provided to the named function. + output: + type: string + nullable: true + description: The output of the function, only populated for function calls that have already have had their outputs submitted. + description: The detailed information about the function called by the model. + FunctionToolDefinition: + type: object + required: + - type + - function + properties: + type: + type: string + enum: + - function + description: The object type, which is always 'function'. + function: + allOf: + - $ref: '#/components/schemas/FunctionDefinition' + description: The definition of the concrete function that the function tool should call. + allOf: + - $ref: '#/components/schemas/ToolDefinition' + description: The input definition information for a function tool as used to configure an assistant. + ListSortOrder: + type: string + enum: + - asc + - desc + description: The available sorting options when requesting a list of response objects. + MessageContent: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/MessageTextContent' + image_file: '#/components/schemas/MessageImageFileContent' + description: An abstract representation of a single item of thread message content. + MessageFile: + type: object + required: + - id + - object + - created_at + - message_id + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.message.file + description: The object type, which is always 'thread.message.file'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + message_id: + type: string + description: The ID of the message that this file is attached to. + description: Information about a file attached to an assistant thread message. + MessageFileCitationTextAnnotation: + type: object + required: + - type + - file_citation + properties: + type: + type: string + enum: + - file_citation + description: The object type, which is always 'file_citation'. + file_citation: + allOf: + - $ref: '#/components/schemas/MessageTextFileCitationDetails' + description: |- + A citation within the message that points to a specific quote from a specific file. + Generated when the assistant uses the "retrieval" tool to search files. + allOf: + - $ref: '#/components/schemas/MessageTextAnnotation' + description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files. + MessageFilePathDetails: + type: object + required: + - file_id + properties: + file_id: + type: string + description: The ID of the specific file that the citation is from. + description: An encapsulation of an image file ID, as used by message image content. + MessageFilePathTextAnnotation: + type: object + required: + - type + - file_path + properties: + type: + type: string + enum: + - file_path + description: The object type, which is always 'file_path'. + file_path: + allOf: + - $ref: '#/components/schemas/MessageFilePathDetails' + description: A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. + allOf: + - $ref: '#/components/schemas/MessageTextAnnotation' + description: A citation within the message that points to a file located at a specific path. + MessageImageFileContent: + type: object + required: + - type + - image_file + properties: + type: + type: string + enum: + - image_file + description: The object type, which is always 'image_file'. + image_file: + allOf: + - $ref: '#/components/schemas/MessageImageFileDetails' + description: The image file for this thread message content item. + allOf: + - $ref: '#/components/schemas/MessageContent' + description: A representation of image file content in a thread message. + MessageImageFileDetails: + type: object + required: + - file_id + properties: + file_id: + allOf: + - $ref: '#/components/schemas/MessageImageFileIdDetails' + description: The ID for the file associated with this image. + description: An image reference, as represented in thread message content. + MessageImageFileIdDetails: + type: object + required: + - file_id + properties: + file_id: + type: string + description: The ID of the specific image file. + description: An encapsulation of an image file ID, as used by message image content. + MessageRole: + type: string + enum: + - user + - assistant + description: The possible values for roles attributed to messages in a thread. + MessageTextAnnotation: + type: object + required: + - type + - text + - start_index + - end_index + properties: + type: + type: string + description: The object type. + text: + type: string + description: The textual content associated with this text annotation item. + start_index: + type: integer + format: int32 + description: The first text index associated with this text annotation. + end_index: + type: integer + format: int32 + description: The last text index associated with this text annotation. + discriminator: + propertyName: type + mapping: + file_citation: '#/components/schemas/MessageFileCitationTextAnnotation' + file_path: '#/components/schemas/MessageFilePathTextAnnotation' + description: An abstract representation of an annotation to text thread message content. + MessageTextContent: + type: object + required: + - type + - text + properties: + type: + type: string + enum: + - text + description: The object type, which is always 'text'. + text: + allOf: + - $ref: '#/components/schemas/MessageTextDetails' + description: The text and associated annotations for this thread message content item. + allOf: + - $ref: '#/components/schemas/MessageContent' + description: A representation of a textual item of thread message content. + MessageTextDetails: + type: object + required: + - value + - annotations + properties: + value: + type: string + description: The text data. + annotations: + type: array + items: + $ref: '#/components/schemas/MessageTextAnnotation' + description: A list of annotations associated with this text. + description: The text and associated annotations for a single item of assistant thread message content. + MessageTextFileCitationDetails: + type: object + required: + - file_id + - quote + properties: + file_id: + type: string + description: The ID of the file associated with this citation. + quote: + type: string + description: The specific quote cited in the associated file. + description: A representation of a file-based text citation, as used in a file-based annotation of text thread message content. + OpenAIFile: + type: object + required: + - object + - id + - bytes + - filename + - created_at + - purpose + properties: + object: + type: string + enum: + - file + description: The object type, which is always 'file'. + id: + type: string + description: The identifier, which can be referenced in API endpoints. + bytes: + type: integer + format: int32 + description: The size of the file, in bytes. + filename: + type: string + description: The name of the file. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + purpose: + allOf: + - $ref: '#/components/schemas/FilePurpose' + description: The intended purpose of a file. + description: Represents an assistant that can call the model and use tools. + RequiredAction: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + submit_tool_outputs: '#/components/schemas/SubmitToolOutputsAction' + description: An abstract representation of a required action for an assistant thread run to continue. + RetrievalToolCall: + type: object + required: + - type + - retrieval + properties: + type: + type: string + enum: + - retrieval + description: The object type, which is always 'retrieval'. + retrieval: + type: object + additionalProperties: + type: string + description: The key/value pairs produced by the retrieval tool. + allOf: + - $ref: '#/components/schemas/ToolCall' + description: |- + A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents + submitted output needed or already fulfilled by the tool for the model to continue. + RetrievalToolDefinition: + type: object + required: + - type + properties: + type: + type: string + enum: + - retrieval + description: The object type, which is always 'retrieval'. + allOf: + - $ref: '#/components/schemas/ToolDefinition' + description: The input definition information for a retrieval tool as used to configure an assistant. + RunError: + type: object + required: + - code + - message + properties: + code: + type: string + description: The status for the error. + message: + type: string + description: The human-readable text associated with the error. + description: The details of an error as encountered by an assistant thread run. + RunStatus: + type: string + enum: + - queued + - in_progress + - requires_action + - cancelling + - cancelled + - failed + - completed + - expired + description: Possible values for the status of an assistant thread run. + RunStep: + type: object + required: + - id + - object + - type + - assistant_id + - thread_id + - run_id + - status + - step_details + - last_error + - created_at + - expired_at + - completed_at + - cancelled_at + - failed_at + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.run.step + description: The object type, which is always 'thread.run.step'. + type: + allOf: + - $ref: '#/components/schemas/RunStepType' + description: The type of run step, which can be either message_creation or tool_calls. + assistant_id: + type: string + description: The ID of the assistant associated with the run step. + thread_id: + type: string + description: The ID of the thread that was run. + run_id: + type: string + description: The ID of the run that this run step is a part of. + status: + allOf: + - $ref: '#/components/schemas/RunStepStatus' + description: The status of this run step. + step_details: + allOf: + - $ref: '#/components/schemas/RunStepDetails' + description: The details for this run step. + last_error: + type: object + allOf: + - $ref: '#/components/schemas/RunStepError' + nullable: true + description: If applicable, information about the last error encountered by this run step. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + expired_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this item expired. + completed_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this completed. + cancelled_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this was cancelled. + failed_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this failed. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Detailed information about a single step of an assistant thread run. + RunStepDetails: + type: object + required: + - type + properties: + type: + allOf: + - $ref: '#/components/schemas/RunStepType' + description: The object type. + discriminator: + propertyName: type + mapping: + message_creation: '#/components/schemas/RunStepMessageCreationDetails' + tool_calls: '#/components/schemas/RunStepToolCallDetails' + description: An abstract representation of the details for a run step. + RunStepError: + type: object + required: + - code + - message + properties: + code: + allOf: + - $ref: '#/components/schemas/RunStepErrorCode' + description: The error code for this error. + message: + type: string + description: The human-readable text associated with this error. + description: The error information associated with a failed run step. + RunStepErrorCode: + type: string + enum: + - server_error + - rate_limit_exceeded + description: Possible error code values attributable to a failed run step. + RunStepMessageCreationDetails: + type: object + required: + - type + - message_creation + properties: + type: + type: string + enum: + - message_creation + description: The object type, which is always 'message_creation'. + message_creation: + allOf: + - $ref: '#/components/schemas/RunStepMessageCreationReference' + description: Information about the message creation associated with this run step. + allOf: + - $ref: '#/components/schemas/RunStepDetails' + description: The detailed information associated with a message creation run step. + RunStepMessageCreationReference: + type: object + required: + - message_id + properties: + message_id: + type: string + description: The ID of the message created by this run step. + description: The details of a message created as a part of a run step. + RunStepStatus: + type: string + enum: + - in_progress + - cancelled + - failed + - completed + - expired + description: Possible values for the status of a run step. + RunStepToolCallDetails: + type: object + required: + - type + - tool_calls + properties: + type: + type: string + enum: + - tool_calls + description: The object type, which is always 'tool_calls'. + tool_calls: + type: array + items: + $ref: '#/components/schemas/ToolCall' + description: A list tool call details for this run step. + allOf: + - $ref: '#/components/schemas/RunStepDetails' + description: The detailed information associated with a run step calling tools. + RunStepType: + type: string + enum: + - message_creation + - tool_calls + description: The possible types of run steps. + ServiceApiVersions: + type: string + enum: + - 2023-02-15-preview + description: The known set of supported API versions. + SubmitToolOutputsAction: + type: object + required: + - type + - submit_tool_outputs + properties: + type: + type: string + enum: + - submit_tool_outputs + description: The object type, which is always 'submit_tool_outputs'. + submit_tool_outputs: + allOf: + - $ref: '#/components/schemas/SubmitToolOutputsDetails' + description: The details describing tools that should be called to submit tool outputs. + allOf: + - $ref: '#/components/schemas/RequiredAction' + description: The details for required tool calls that must be submitted for an assistant thread run to continue. + SubmitToolOutputsDetails: + type: object + required: + - tool_calls + properties: + tool_calls: + type: array + items: + $ref: '#/components/schemas/ToolCall' + description: The list of tool calls that must be resolved for the assistant thread run to continue. + description: The details describing tools that should be called to submit tool outputs. + ThreadDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - thread.deleted + description: The object type, which is always 'thread.deleted'. + description: The status of a thread deletion operation. + ThreadMessage: + type: object + required: + - id + - object + - created_at + - thread_id + - role + - content + - file_ids + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.message + description: The object type, which is always 'thread.message'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + thread_id: + type: string + description: The ID of the thread that this message belongs to. + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + description: The role associated with the assistant thread message. + content: + type: array + items: + $ref: '#/components/schemas/MessageContent' + description: The list of content items associated with the assistant thread message. + assistant_id: + type: string + description: If applicable, the ID of the assistant that authored this message. + run_id: + type: string + description: If applicable, the ID of the run associated with the authoring of this message. + file_ids: + type: array + items: + type: string + description: |- + A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can + access files. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: A single message within an assistant thread. + ThreadRun: + type: object + required: + - id + - object + - thread_id + - assistant_id + - status + - last_error + - model + - instructions + - tools + - file_ids + - created_at + - expires_at + - started_at + - completed_at + - cancelled_at + - failed_at + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.run + description: The object type, which is always 'thread.run'. + thread_id: + type: string + description: The ID of the thread associated with this run. + assistant_id: + type: string + description: The ID of the assistant associated with the thread this run was performed against. + status: + allOf: + - $ref: '#/components/schemas/RunStatus' + description: The status of the assistant thread run. + required_action: + type: object + allOf: + - $ref: '#/components/schemas/RequiredAction' + nullable: true + description: The details of the action required for the assistant thread run to continue. + last_error: + type: object + allOf: + - $ref: '#/components/schemas/RunError' + nullable: true + description: The last error, if any, encountered by this assistant thread run. + model: + type: string + description: The ID of the model to use. + instructions: + type: string + description: The overridden system instructions used for this assistant thread run. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The overridden enabled tools used for this assistant thread run. + default: [] + file_ids: + type: array + items: + type: string + description: A list of attached file IDs, ordered by creation date in ascending order. + default: [] + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + expires_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this item expires. + started_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this item was started. + completed_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this completed. + cancelled_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this was cancelled. + failed_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this failed. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Data representing a single evaluation run of an assistant thread. + ToolCall: + type: object + required: + - type + - id + properties: + type: + type: string + description: The object type. + id: + type: string + description: The ID of the tool call. This ID must be referenced when you submit tool outputs. + discriminator: + propertyName: type + mapping: + code_interpreter: '#/components/schemas/CodeInterpreterToolCall' + retrieval: '#/components/schemas/RetrievalToolCall' + function: '#/components/schemas/FunctionToolCall' + description: |- + An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must + be fulfilled and have its outputs submitted before the model can continue. + ToolDefinition: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + code_interpreter: '#/components/schemas/CodeInterpreterToolDefinition' + retrieval: '#/components/schemas/RetrievalToolDefinition' + function: '#/components/schemas/FunctionToolDefinition' + description: An abstract representation of an input tool definition that an assistant can use. + ToolOutput: + type: object + properties: + tool_call_id: + type: string + description: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. + output: + type: string + description: The output from the tool to be submitted. + description: The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. + securitySchemes: + ApiKeyAuth: + type: apiKey + in: header + name: api-key + OAuth2Auth: + type: oauth2 + flows: + implicit: + authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize + scopes: + https://cognitiveservices.azure.com/.default: '' +servers: + - url: '{endpoint}' + description: Azure OpenAI APIs for Assistants. + variables: + endpoint: + default: '' + description: An OpenAI endpoint supporting assistants functionality. diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml new file mode 100644 index 000000000000..ee485d79df7c --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2023-11-06-beta/assistants_generated.yaml @@ -0,0 +1,2388 @@ +openapi: 3.0.0 +info: + title: Azure OpenAI + version: 2023-11-06-beta + description: Azure OpenAI APIs for Assistants. +tags: [] +paths: + /assistants: + post: + operationId: createAssistant + description: Creates a new assistant. + parameters: [] + responses: + '200': + description: The new assistant instance. + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantCreationOptions' + get: + operationId: listAssistants + description: Gets a list of assistants that were previously created. + parameters: + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of assistants. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/Assistant' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /assistants/{assistantId}: + get: + operationId: getAssistant + description: Retrieves an existing assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to retrieve. + schema: + type: string + responses: + '200': + description: The requested assistant instance. + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + post: + operationId: modifyAssistant + description: Modifies an existing assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to modify. + schema: + type: string + responses: + '200': + description: The updated assistant instance. + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + requestBody: + description: The details of the modification to perform on the specified assistant. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantModificationOptions' + delete: + operationId: deleteAssistant + description: Deletes an assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to delete. + schema: + type: string + responses: + '200': + description: Status information about the requested deletion operation. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantDeletionStatus' + /assistants/{assistantId}/files: + post: + operationId: createAssistantFile + description: Attaches a previously uploaded file to an assistant for use by tools that can read files. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to attach the file to. + schema: + type: string + responses: + '200': + description: Information about the attached file. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantFile' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + file_id: + type: string + description: The ID of the previously uploaded file to attach. + required: + - file_id + get: + operationId: listAssistantFiles + description: Gets a list of files attached to a specific assistant, as used by tools that can read files. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to retrieve the list of attached files for. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of files attached to the specified assistant. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/AssistantFile' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /assistants/{assistantId}/files/{fileId}: + get: + operationId: getAssistantFile + description: Retrieves a file attached to an assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant associated with the attached file. + schema: + type: string + - name: fileId + in: path + required: true + description: The ID of the file to retrieve. + schema: + type: string + responses: + '200': + description: A representation of the attached file. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantFile' + delete: + operationId: deleteAssistantFile + description: |- + Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read + files. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant from which the specified file should be unlinked. + schema: + type: string + - name: fileId + in: path + required: true + description: The ID of the file to unlink from the specified assistant. + schema: + type: string + responses: + '200': + description: Status information about the requested file association deletion. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantFileDeletionStatus' + /files: + get: + operationId: listFiles + description: Gets a list of previously uploaded files. + parameters: + - name: purpose + in: query + required: false + description: A value that, when provided, limits list results to files matching the corresponding purpose. + schema: + $ref: '#/components/schemas/FilePurpose' + responses: + '200': + description: The requested list of files. + content: + application/json: + schema: + $ref: '#/components/schemas/FileListResponse' + post: + operationId: createFile + description: Uploads a file for use by other operations. + parameters: [] + responses: + '200': + description: A representation of the uploaded file. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIFile' + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + purpose: + allOf: + - $ref: '#/components/schemas/FilePurpose' + description: The intended purpose of the file. + filename: + type: string + description: A filename to associate with the uploaded data. + required: + - file + - purpose + /files/{fileId}/{file_id}: + delete: + operationId: deleteFile + description: Delete a previously uploaded file. + parameters: + - name: fileId + in: path + required: true + description: The ID of the file to delete. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/FileDeletionStatus' + get: + operationId: retrieveFile + description: Returns information about a specific file. Does not retrieve file content. + parameters: + - name: fileId + in: path + required: true + description: The ID of the file to retrieve. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIFile' + /threads: + post: + operationId: createThread + description: Creates a new thread. Threads contain messages and can be run by assistants. + parameters: [] + responses: + '200': + description: Information about the newly created thread. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThread' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThreadCreationOptions' + /threads/runs: + post: + operationId: createThreadAndRun + description: Creates a new assistant thread and immediately starts a run using that new thread. + parameters: [] + responses: + '200': + description: Information about the newly created thread. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndRunThreadOptions' + /threads/{threadId}: + get: + operationId: getThread + description: Gets information about an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to retrieve information about. + schema: + type: string + responses: + '200': + description: Information about the requested thread. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThread' + post: + operationId: modifyThread + description: Modifies an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to modify. + schema: + type: string + responses: + '200': + description: Information about the modified thread. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThread' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + delete: + operationId: deleteThread + description: Deletes an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to delete. + schema: + type: string + responses: + '200': + description: Status information about the requested thread deletion operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadDeletionStatus' + /threads/{threadId}/messages: + post: + operationId: createMessage + description: Creates a new message on a specified thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to create the new message on. + schema: + type: string + responses: + '200': + description: A representation of the new message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + description: The role to associate with the new message. + content: + type: string + description: The textual content for the new message. + file_ids: + type: array + items: + type: string + description: A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + required: + - role + - content + get: + operationId: listMessages + description: Gets a list of messages that exist on a thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to list messages from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of messages. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/ThreadMessage' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/messages/{messageId}: + get: + operationId: getMessage + description: Gets an existing message from an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to retrieve the specified message from. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to retrieve from the specified thread. + schema: + type: string + responses: + '200': + description: A representation of the requested message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + post: + operationId: modifyMessage + description: Modifies an existing message on an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread containing the specified message to modify. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to modify on the specified thread. + schema: + type: string + responses: + '200': + description: A representation of the modified message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + /threads/{threadId}/messages/{messageId}/files: + get: + operationId: listMessageFiles + description: Gets a list of previously uploaded files associated with a message from a thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread containing the message to list files from. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to list files from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of files associated with the specified message. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/MessageFile' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/messages/{messageId}/files/{fileId}: + get: + operationId: getMessageFile + description: Gets information about a file attachment to a message within a thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread containing the message to get information from. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to get information from. + schema: + type: string + - name: fileId + in: path + required: true + description: The ID of the file to get information about. + schema: + type: string + responses: + '200': + description: The requested file information. + content: + application/json: + schema: + $ref: '#/components/schemas/MessageFile' + /threads/{threadId}/runs: + post: + operationId: createRun + description: Creates a new run for an assistant thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to run. + schema: + type: string + responses: + '200': + description: Information about the new thread run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + assistant_id: + type: string + description: The ID of the assistant that should run the thread. + model: + type: string + description: The overridden model name that the assistant should use to run the thread. + instructions: + type: string + description: The overridden system instructions that the assistant should use to run the thread. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The overridden list of enabled tools that the assistant should use to run the thread. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + required: + - assistant_id + get: + operationId: listRuns + description: Gets a list of runs for a specified thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to list runs from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of thread runs. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/ThreadRun' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/runs/{runId}: + get: + operationId: getRun + description: Gets an existing run from an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to retrieve run information from. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the thread to retrieve information about. + schema: + type: string + responses: + '200': + description: The requested information about the specified thread run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + post: + operationId: modifyRun + description: Modifies an existing thread run. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread associated with the specified run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run to modify. + schema: + type: string + responses: + '200': + description: Information about the modified run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + /threads/{threadId}/runs/{runId}/cancel: + post: + operationId: cancelRun + description: Cancels a run of an in progress thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread being run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run to cancel. + schema: + type: string + responses: + '200': + description: Updated information about the cancelled run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + /threads/{threadId}/runs/{runId}/steps: + get: + operationId: listRunSteps + description: Gets a list of run steps from a thread run. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread that was run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run to list steps from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of run steps. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/RunStep' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/runs/{runId}/steps/{stepId}: + get: + operationId: getRunStep + description: Gets a single run step from a thread run. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread that was run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the specific run to retrieve the step from. + schema: + type: string + - name: stepId + in: path + required: true + description: The ID of the step to retrieve information about. + schema: + type: string + responses: + '200': + description: Information about the requested run step. + content: + application/json: + schema: + $ref: '#/components/schemas/RunStep' + /threads/{threadId}/runs/{runId}/submit_tool_outputs: + post: + operationId: submitToolOutputsToRun + description: Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread that was run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run that requires tool outputs. + schema: + type: string + responses: + '200': + description: Updated information about the run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tool_outputs: + type: array + items: + $ref: '#/components/schemas/ToolOutput' + description: The list of tool outputs requested by tool calls from the specified run. + required: + - tool_outputs +security: + - ApiKeyAuth: [] + - OAuth2Auth: + - https://cognitiveservices.azure.com/.default +components: + schemas: + Assistant: + type: object + required: + - id + - object + - created_at + - name + - description + - model + - instructions + - tools + - file_ids + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - assistant + description: The object type, which is always assistant. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + name: + type: string + nullable: true + description: The name of the assistant. + description: + type: string + nullable: true + description: The description of the assistant. + model: + type: string + description: The ID of the model to use. + instructions: + type: string + nullable: true + description: The system instructions for the assistant to use. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The collection of tools enabled for the assistant. + default: [] + file_ids: + type: array + items: + type: string + description: A list of attached file IDs, ordered by creation date in ascending order. + default: [] + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Represents an assistant that can call the model and use tools. + AssistantCreationOptions: + type: object + required: + - model + properties: + model: + type: string + description: The ID of the model to use. + name: + type: string + nullable: true + description: The name of the new assistant. + description: + type: string + nullable: true + description: The description of the new assistant. + instructions: + type: string + nullable: true + description: The system instructions for the new assistant to use. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The collection of tools to enable for the new assistant. + default: [] + file_ids: + type: array + items: + type: string + description: A list of previously uploaded file IDs to attach to the assistant. + default: [] + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The request details to use when creating a new assistant. + AssistantDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - assistant.deleted + description: The object type, which is always 'assistant.deleted'. + description: The status of an assistant deletion operation. + AssistantFile: + type: object + required: + - id + - object + - created_at + - assistant_id + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - assistant.file + description: The object type, which is always 'assistant.file'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + assistant_id: + type: string + description: The assistant ID that the file is attached to. + description: Information about a file attached to an assistant, as used by tools that can read files. + AssistantFileDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - assistant.file.deleted + description: The object type, which is always 'assistant.file.deleted'. + description: The status of an assistant file deletion operation. + AssistantModificationOptions: + type: object + properties: + model: + type: string + description: The ID of the model to use. + name: + type: string + nullable: true + description: The modified name for the assistant to use. + description: + type: string + nullable: true + description: The modified description for the assistant to use. + instructions: + type: string + nullable: true + description: The modified system instructions for the new assistant to use. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The modified collection of tools to enable for the assistant. + default: [] + file_ids: + type: array + items: + type: string + description: The modified list of previously uploaded fileIDs to attach to the assistant. + default: [] + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The request details to use when modifying an existing assistant. + AssistantThread: + type: object + required: + - id + - object + - created_at + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread + description: The object type, which is always 'thread'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Information about a single thread associated with an assistant. + AssistantThreadCreationOptions: + type: object + properties: + messages: + type: array + items: + $ref: '#/components/schemas/ThreadMessage' + description: The messages to associate with the new thread. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The details used to create a new assistant thread. + CodeInterpreterImageOutput: + type: object + required: + - type + - image + properties: + type: + type: string + enum: + - image + description: The object type, which is always 'image'. + image: + allOf: + - $ref: '#/components/schemas/CodeInterpreterImageReference' + description: Referential information for the image associated with this output. + allOf: + - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' + description: A representation of an image output emitted by a code interpreter tool in response to a tool call by the model. + CodeInterpreterImageReference: + type: object + required: + - file_id + properties: + file_id: + type: string + description: The ID of the file associated with this image. + description: An image reference emitted by a code interpreter tool in response to a tool call by the model. + CodeInterpreterLogOutput: + type: object + required: + - type + - logs + properties: + type: + type: string + enum: + - logs + description: The object type, which is always 'logs'. + logs: + type: string + description: The serialized log output emitted by the code interpreter. + allOf: + - $ref: '#/components/schemas/CodeInterpreterToolCallOutput' + description: A representation of a log output emitted by a code interpreter tool in response to a tool call by the model. + CodeInterpreterToolCall: + type: object + required: + - type + - code_interpreter + properties: + type: + type: string + enum: + - code_interpreter + description: The object type, which is always 'code_interpreter'. + code_interpreter: + allOf: + - $ref: '#/components/schemas/CodeInterpreterToolCallDetails' + description: The details of the tool call to the code interpreter tool. + allOf: + - $ref: '#/components/schemas/ToolCall' + description: |- + A tool call to a code interpreter tool, issued by the model in evaluation of a configured code interpreter tool, that + represents submitted output needed or already fulfilled by the tool for the model to continue. + CodeInterpreterToolCallDetails: + type: object + required: + - input + - outputs + properties: + input: + type: string + description: The input provided by the model to the code interpreter tool. + outputs: + type: array + items: + $ref: '#/components/schemas/CodeInterpreterToolCallOutput' + description: The outputs produced by the code interpreter tool back to the model in response to the tool call. + description: The detailed information about a code interpreter invocation by the model. + CodeInterpreterToolCallOutput: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + logs: '#/components/schemas/CodeInterpreterLogOutput' + image: '#/components/schemas/CodeInterpreterImageOutput' + description: An abstract representation of an emitted output from a code interpreter tool. + CodeInterpreterToolDefinition: + type: object + required: + - type + properties: + type: + type: string + enum: + - code_interpreter + description: The object type, which is always 'code_interpreter'. + allOf: + - $ref: '#/components/schemas/ToolDefinition' + description: The input definition information for a code interpreter tool as used to configure an assistant. + CreateAndRunThreadOptions: + type: object + required: + - assistant_id + properties: + assistant_id: + type: string + description: The ID of the assistant for which the thread should be created. + thread: + allOf: + - $ref: '#/components/schemas/AssistantThreadCreationOptions' + description: The details used to create the new thread. + model: + type: string + description: The overridden model that the assistant should use to run the thread. + instructions: + type: string + description: The overridden system instructions the assistant should use to run the thread. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The overridden list of enabled tools the assistant should use to run the thread. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The details used when creating and immediately running a new assistant thread. + FileDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - file + description: The object type, which is always 'file'. + description: A status response from a file deletion operation. + FileListResponse: + type: object + required: + - object + - data + properties: + object: + type: string + enum: + - list + description: The object type, which is always 'list'. + data: + type: array + items: + $ref: '#/components/schemas/OpenAIFile' + description: The files returned for the request. + description: The response data from a file list operation. + FilePurpose: + type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + description: The possible values denoting the intended usage of a file. + FunctionDefinition: + type: object + required: + - name + - parameters + properties: + name: + type: string + description: The name of the function to be called. + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + parameters: + description: The parameters the functions accepts, described as a JSON Schema object. + description: The input definition information for a function. + FunctionToolCall: + type: object + required: + - type + - function + properties: + type: + type: string + enum: + - function + description: The object type, which is always 'function'. + function: + allOf: + - $ref: '#/components/schemas/FunctionToolCallDetails' + description: The detailed information about the function called by the model. + allOf: + - $ref: '#/components/schemas/ToolCall' + description: |- + A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents + given function inputs and submitted function outputs needed or already fulfilled by the tool for the model to continue. + FunctionToolCallDetails: + type: object + required: + - name + - arguments + - output + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments that the model requires are provided to the named function. + output: + type: string + nullable: true + description: The output of the function, only populated for function calls that have already have had their outputs submitted. + description: The detailed information about the function called by the model. + FunctionToolDefinition: + type: object + required: + - type + - function + properties: + type: + type: string + enum: + - function + description: The object type, which is always 'function'. + function: + allOf: + - $ref: '#/components/schemas/FunctionDefinition' + description: The definition of the concrete function that the function tool should call. + allOf: + - $ref: '#/components/schemas/ToolDefinition' + description: The input definition information for a function tool as used to configure an assistant. + ListSortOrder: + type: string + enum: + - asc + - desc + description: The available sorting options when requesting a list of response objects. + MessageContent: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/MessageTextContent' + image_file: '#/components/schemas/MessageImageFileContent' + description: An abstract representation of a single item of thread message content. + MessageFile: + type: object + required: + - id + - object + - created_at + - message_id + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.message.file + description: The object type, which is always 'thread.message.file'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + message_id: + type: string + description: The ID of the message that this file is attached to. + description: Information about a file attached to an assistant thread message. + MessageFileCitationTextAnnotation: + type: object + required: + - type + - file_citation + properties: + type: + type: string + enum: + - file_citation + description: The object type, which is always 'file_citation'. + file_citation: + allOf: + - $ref: '#/components/schemas/MessageTextFileCitationDetails' + description: |- + A citation within the message that points to a specific quote from a specific file. + Generated when the assistant uses the "retrieval" tool to search files. + allOf: + - $ref: '#/components/schemas/MessageTextAnnotation' + description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files. + MessageFilePathDetails: + type: object + required: + - file_id + properties: + file_id: + type: string + description: The ID of the specific file that the citation is from. + description: An encapsulation of an image file ID, as used by message image content. + MessageFilePathTextAnnotation: + type: object + required: + - type + - file_path + properties: + type: + type: string + enum: + - file_path + description: The object type, which is always 'file_path'. + file_path: + allOf: + - $ref: '#/components/schemas/MessageFilePathDetails' + description: A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. + allOf: + - $ref: '#/components/schemas/MessageTextAnnotation' + description: A citation within the message that points to a file located at a specific path. + MessageImageFileContent: + type: object + required: + - type + - image_file + properties: + type: + type: string + enum: + - image_file + description: The object type, which is always 'image_file'. + image_file: + allOf: + - $ref: '#/components/schemas/MessageImageFileDetails' + description: The image file for this thread message content item. + allOf: + - $ref: '#/components/schemas/MessageContent' + description: A representation of image file content in a thread message. + MessageImageFileDetails: + type: object + required: + - file_id + properties: + file_id: + allOf: + - $ref: '#/components/schemas/MessageImageFileIdDetails' + description: The ID for the file associated with this image. + description: An image reference, as represented in thread message content. + MessageImageFileIdDetails: + type: object + required: + - file_id + properties: + file_id: + type: string + description: The ID of the specific image file. + description: An encapsulation of an image file ID, as used by message image content. + MessageRole: + type: string + enum: + - user + - assistant + description: The possible values for roles attributed to messages in a thread. + MessageTextAnnotation: + type: object + required: + - type + - text + - start_index + - end_index + properties: + type: + type: string + description: The object type. + text: + type: string + description: The textual content associated with this text annotation item. + start_index: + type: integer + format: int32 + description: The first text index associated with this text annotation. + end_index: + type: integer + format: int32 + description: The last text index associated with this text annotation. + discriminator: + propertyName: type + mapping: + file_citation: '#/components/schemas/MessageFileCitationTextAnnotation' + file_path: '#/components/schemas/MessageFilePathTextAnnotation' + description: An abstract representation of an annotation to text thread message content. + MessageTextContent: + type: object + required: + - type + - text + properties: + type: + type: string + enum: + - text + description: The object type, which is always 'text'. + text: + allOf: + - $ref: '#/components/schemas/MessageTextDetails' + description: The text and associated annotations for this thread message content item. + allOf: + - $ref: '#/components/schemas/MessageContent' + description: A representation of a textual item of thread message content. + MessageTextDetails: + type: object + required: + - value + - annotations + properties: + value: + type: string + description: The text data. + annotations: + type: array + items: + $ref: '#/components/schemas/MessageTextAnnotation' + description: A list of annotations associated with this text. + description: The text and associated annotations for a single item of assistant thread message content. + MessageTextFileCitationDetails: + type: object + required: + - file_id + - quote + properties: + file_id: + type: string + description: The ID of the file associated with this citation. + quote: + type: string + description: The specific quote cited in the associated file. + description: A representation of a file-based text citation, as used in a file-based annotation of text thread message content. + OpenAIFile: + type: object + required: + - object + - id + - bytes + - filename + - created_at + - purpose + properties: + object: + type: string + enum: + - file + description: The object type, which is always 'file'. + id: + type: string + description: The identifier, which can be referenced in API endpoints. + bytes: + type: integer + format: int32 + description: The size of the file, in bytes. + filename: + type: string + description: The name of the file. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + purpose: + allOf: + - $ref: '#/components/schemas/FilePurpose' + description: The intended purpose of a file. + description: Represents an assistant that can call the model and use tools. + RequiredAction: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + submit_tool_outputs: '#/components/schemas/SubmitToolOutputsAction' + description: An abstract representation of a required action for an assistant thread run to continue. + RetrievalToolCall: + type: object + required: + - type + - retrieval + properties: + type: + type: string + enum: + - retrieval + description: The object type, which is always 'retrieval'. + retrieval: + type: object + additionalProperties: + type: string + description: The key/value pairs produced by the retrieval tool. + allOf: + - $ref: '#/components/schemas/ToolCall' + description: |- + A tool call to a retrieval tool, issued by the model in evaluation of a configured retrieval tool, that represents + submitted output needed or already fulfilled by the tool for the model to continue. + RetrievalToolDefinition: + type: object + required: + - type + properties: + type: + type: string + enum: + - retrieval + description: The object type, which is always 'retrieval'. + allOf: + - $ref: '#/components/schemas/ToolDefinition' + description: The input definition information for a retrieval tool as used to configure an assistant. + RunError: + type: object + required: + - code + - message + properties: + code: + type: string + description: The status for the error. + message: + type: string + description: The human-readable text associated with the error. + description: The details of an error as encountered by an assistant thread run. + RunStatus: + type: string + enum: + - queued + - in_progress + - requires_action + - cancelling + - cancelled + - failed + - completed + - expired + description: Possible values for the status of an assistant thread run. + RunStep: + type: object + required: + - id + - object + - type + - assistant_id + - thread_id + - run_id + - status + - step_details + - last_error + - created_at + - expired_at + - completed_at + - cancelled_at + - failed_at + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.run.step + description: The object type, which is always 'thread.run.step'. + type: + allOf: + - $ref: '#/components/schemas/RunStepType' + description: The type of run step, which can be either message_creation or tool_calls. + assistant_id: + type: string + description: The ID of the assistant associated with the run step. + thread_id: + type: string + description: The ID of the thread that was run. + run_id: + type: string + description: The ID of the run that this run step is a part of. + status: + allOf: + - $ref: '#/components/schemas/RunStepStatus' + description: The status of this run step. + step_details: + allOf: + - $ref: '#/components/schemas/RunStepDetails' + description: The details for this run step. + last_error: + type: object + allOf: + - $ref: '#/components/schemas/RunStepError' + nullable: true + description: If applicable, information about the last error encountered by this run step. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + expired_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this item expired. + completed_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this completed. + cancelled_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this was cancelled. + failed_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this failed. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Detailed information about a single step of an assistant thread run. + RunStepDetails: + type: object + required: + - type + properties: + type: + allOf: + - $ref: '#/components/schemas/RunStepType' + description: The object type. + discriminator: + propertyName: type + mapping: + message_creation: '#/components/schemas/RunStepMessageCreationDetails' + tool_calls: '#/components/schemas/RunStepToolCallDetails' + description: An abstract representation of the details for a run step. + RunStepError: + type: object + required: + - code + - message + properties: + code: + allOf: + - $ref: '#/components/schemas/RunStepErrorCode' + description: The error code for this error. + message: + type: string + description: The human-readable text associated with this error. + description: The error information associated with a failed run step. + RunStepErrorCode: + type: string + enum: + - server_error + - rate_limit_exceeded + description: Possible error code values attributable to a failed run step. + RunStepMessageCreationDetails: + type: object + required: + - type + - message_creation + properties: + type: + type: string + enum: + - message_creation + description: The object type, which is always 'message_creation'. + message_creation: + allOf: + - $ref: '#/components/schemas/RunStepMessageCreationReference' + description: Information about the message creation associated with this run step. + allOf: + - $ref: '#/components/schemas/RunStepDetails' + description: The detailed information associated with a message creation run step. + RunStepMessageCreationReference: + type: object + required: + - message_id + properties: + message_id: + type: string + description: The ID of the message created by this run step. + description: The details of a message created as a part of a run step. + RunStepStatus: + type: string + enum: + - in_progress + - cancelled + - failed + - completed + - expired + description: Possible values for the status of a run step. + RunStepToolCallDetails: + type: object + required: + - type + - tool_calls + properties: + type: + type: string + enum: + - tool_calls + description: The object type, which is always 'tool_calls'. + tool_calls: + type: array + items: + $ref: '#/components/schemas/ToolCall' + description: A list tool call details for this run step. + allOf: + - $ref: '#/components/schemas/RunStepDetails' + description: The detailed information associated with a run step calling tools. + RunStepType: + type: string + enum: + - message_creation + - tool_calls + description: The possible types of run steps. + ServiceApiVersions: + type: string + enum: + - 2023-11-06-beta + description: The known set of supported API versions. + SubmitToolOutputsAction: + type: object + required: + - type + - submit_tool_outputs + properties: + type: + type: string + enum: + - submit_tool_outputs + description: The object type, which is always 'submit_tool_outputs'. + submit_tool_outputs: + allOf: + - $ref: '#/components/schemas/SubmitToolOutputsDetails' + description: The details describing tools that should be called to submit tool outputs. + allOf: + - $ref: '#/components/schemas/RequiredAction' + description: The details for required tool calls that must be submitted for an assistant thread run to continue. + SubmitToolOutputsDetails: + type: object + required: + - tool_calls + properties: + tool_calls: + type: array + items: + $ref: '#/components/schemas/ToolCall' + description: The list of tool calls that must be resolved for the assistant thread run to continue. + description: The details describing tools that should be called to submit tool outputs. + ThreadDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - thread.deleted + description: The object type, which is always 'thread.deleted'. + description: The status of a thread deletion operation. + ThreadMessage: + type: object + required: + - id + - object + - created_at + - thread_id + - role + - content + - file_ids + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.message + description: The object type, which is always 'thread.message'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + thread_id: + type: string + description: The ID of the thread that this message belongs to. + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + description: The role associated with the assistant thread message. + content: + type: array + items: + $ref: '#/components/schemas/MessageContent' + description: The list of content items associated with the assistant thread message. + assistant_id: + type: string + description: If applicable, the ID of the assistant that authored this message. + run_id: + type: string + description: If applicable, the ID of the run associated with the authoring of this message. + file_ids: + type: array + items: + type: string + description: |- + A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can + access files. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: A single message within an assistant thread. + ThreadRun: + type: object + required: + - id + - object + - thread_id + - assistant_id + - status + - last_error + - model + - instructions + - tools + - file_ids + - created_at + - expires_at + - started_at + - completed_at + - cancelled_at + - failed_at + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.run + description: The object type, which is always 'thread.run'. + thread_id: + type: string + description: The ID of the thread associated with this run. + assistant_id: + type: string + description: The ID of the assistant associated with the thread this run was performed against. + status: + allOf: + - $ref: '#/components/schemas/RunStatus' + description: The status of the assistant thread run. + required_action: + type: object + allOf: + - $ref: '#/components/schemas/RequiredAction' + nullable: true + description: The details of the action required for the assistant thread run to continue. + last_error: + type: object + allOf: + - $ref: '#/components/schemas/RunError' + nullable: true + description: The last error, if any, encountered by this assistant thread run. + model: + type: string + description: The ID of the model to use. + instructions: + type: string + description: The overridden system instructions used for this assistant thread run. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The overridden enabled tools used for this assistant thread run. + default: [] + file_ids: + type: array + items: + type: string + description: A list of attached file IDs, ordered by creation date in ascending order. + default: [] + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + expires_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this item expires. + started_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this item was started. + completed_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this completed. + cancelled_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this was cancelled. + failed_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this failed. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Data representing a single evaluation run of an assistant thread. + ToolCall: + type: object + required: + - type + - id + properties: + type: + type: string + description: The object type. + id: + type: string + description: The ID of the tool call. This ID must be referenced when you submit tool outputs. + discriminator: + propertyName: type + mapping: + code_interpreter: '#/components/schemas/CodeInterpreterToolCall' + retrieval: '#/components/schemas/RetrievalToolCall' + function: '#/components/schemas/FunctionToolCall' + description: |- + An abstract representation a tool call, issued by the model in evaluation of a configured tool definition, that must + be fulfilled and have its outputs submitted before the model can continue. + ToolDefinition: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + code_interpreter: '#/components/schemas/CodeInterpreterToolDefinition' + retrieval: '#/components/schemas/RetrievalToolDefinition' + function: '#/components/schemas/FunctionToolDefinition' + description: An abstract representation of an input tool definition that an assistant can use. + ToolOutput: + type: object + properties: + tool_call_id: + type: string + description: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. + output: + type: string + description: The output from the tool to be submitted. + description: The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. + securitySchemes: + ApiKeyAuth: + type: apiKey + in: header + name: api-key + OAuth2Auth: + type: oauth2 + flows: + implicit: + authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize + scopes: + https://cognitiveservices.azure.com/.default: '' +servers: + - url: '{endpoint}' + description: Azure OpenAI APIs for Assistants. + variables: + endpoint: + default: '' + description: An OpenAI endpoint supporting assistants functionality. diff --git a/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml new file mode 100644 index 000000000000..180f405b7555 --- /dev/null +++ b/specification/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml @@ -0,0 +1,2477 @@ +openapi: 3.0.0 +info: + title: Azure OpenAI + version: 2024-02-15-preview + description: Azure OpenAI APIs for Assistants. +tags: [] +paths: + /assistants: + post: + operationId: createAssistant + description: Creates a new assistant. + parameters: [] + responses: + '200': + description: The new assistant instance. + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantCreationOptions' + get: + operationId: listAssistants + description: Gets a list of assistants that were previously created. + parameters: + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of assistants. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/Assistant' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /assistants/{assistantId}: + get: + operationId: getAssistant + description: Retrieves an existing assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to retrieve. + schema: + type: string + responses: + '200': + description: The requested assistant instance. + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + post: + operationId: updateAssistant + description: Modifies an existing assistant. + parameters: + - $ref: '#/components/parameters/UpdateAssistantOptions.assistantId' + responses: + '200': + description: The updated assistant instance. + content: + application/json: + schema: + $ref: '#/components/schemas/Assistant' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAssistantOptions' + delete: + operationId: deleteAssistant + description: Deletes an assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to delete. + schema: + type: string + responses: + '200': + description: Status information about the requested deletion operation. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantDeletionStatus' + /assistants/{assistantId}/files: + post: + operationId: createAssistantFile + description: Attaches a previously uploaded file to an assistant for use by tools that can read files. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to attach the file to. + schema: + type: string + responses: + '200': + description: Information about the attached file. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantFile' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + file_id: + type: string + description: The ID of the previously uploaded file to attach. + required: + - file_id + get: + operationId: listAssistantFiles + description: Gets a list of files attached to a specific assistant, as used by tools that can read files. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant to retrieve the list of attached files for. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of files attached to the specified assistant. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/AssistantFile' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /assistants/{assistantId}/files/{fileId}: + get: + operationId: getAssistantFile + description: Retrieves a file attached to an assistant. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant associated with the attached file. + schema: + type: string + - name: fileId + in: path + required: true + description: The ID of the file to retrieve. + schema: + type: string + responses: + '200': + description: A representation of the attached file. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantFile' + delete: + operationId: deleteAssistantFile + description: |- + Unlinks a previously attached file from an assistant, rendering it unavailable for use by tools that can read + files. + parameters: + - name: assistantId + in: path + required: true + description: The ID of the assistant from which the specified file should be unlinked. + schema: + type: string + - name: fileId + in: path + required: true + description: The ID of the file to unlink from the specified assistant. + schema: + type: string + responses: + '200': + description: Status information about the requested file association deletion. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantFileDeletionStatus' + /files: + get: + operationId: listFiles + description: Gets a list of previously uploaded files. + parameters: + - name: purpose + in: query + required: false + description: A value that, when provided, limits list results to files matching the corresponding purpose. + schema: + $ref: '#/components/schemas/FilePurpose' + responses: + '200': + description: The requested list of files. + content: + application/json: + schema: + $ref: '#/components/schemas/FileListResponse' + post: + operationId: uploadFile + description: Uploads a file for use by other operations. + parameters: [] + responses: + '200': + description: A representation of the uploaded file. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIFile' + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + purpose: + allOf: + - $ref: '#/components/schemas/FilePurpose' + description: The intended purpose of the file. + filename: + type: string + description: A filename to associate with the uploaded data. + required: + - file + - purpose + /files/{fileId}: + delete: + operationId: deleteFile + description: Delete a previously uploaded file. + parameters: + - name: fileId + in: path + required: true + description: The ID of the file to delete. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/FileDeletionStatus' + get: + operationId: getFile + description: Returns information about a specific file. Does not retrieve file content. + parameters: + - name: fileId + in: path + required: true + description: The ID of the file to retrieve. + schema: + type: string + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIFile' + /threads: + post: + operationId: createThread + description: Creates a new thread. Threads contain messages and can be run by assistants. + parameters: [] + responses: + '200': + description: Information about the newly created thread. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThread' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThreadCreationOptions' + /threads/runs: + post: + operationId: createThreadAndRun + description: Creates a new assistant thread and immediately starts a run using that new thread. + parameters: [] + responses: + '200': + description: Information about the newly created thread. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndRunThreadOptions' + /threads/{threadId}: + get: + operationId: getThread + description: Gets information about an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to retrieve information about. + schema: + type: string + responses: + '200': + description: Information about the requested thread. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThread' + post: + operationId: updateThread + description: Modifies an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to modify. + schema: + type: string + responses: + '200': + description: Information about the modified thread. + content: + application/json: + schema: + $ref: '#/components/schemas/AssistantThread' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + delete: + operationId: deleteThread + description: Deletes an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to delete. + schema: + type: string + responses: + '200': + description: Status information about the requested thread deletion operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadDeletionStatus' + /threads/{threadId}/messages: + post: + operationId: createMessage + description: Creates a new message on a specified thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to create the new message on. + schema: + type: string + responses: + '200': + description: A representation of the new message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + description: The role to associate with the new message. + content: + type: string + description: The textual content for the new message. + file_ids: + type: array + items: + type: string + description: A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + required: + - role + - content + get: + operationId: listMessages + description: Gets a list of messages that exist on a thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to list messages from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of messages. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/ThreadMessage' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/messages/{messageId}: + get: + operationId: getMessage + description: Gets an existing message from an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to retrieve the specified message from. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to retrieve from the specified thread. + schema: + type: string + responses: + '200': + description: A representation of the requested message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + post: + operationId: updateMessage + description: Modifies an existing message on an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread containing the specified message to modify. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to modify on the specified thread. + schema: + type: string + responses: + '200': + description: A representation of the modified message. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadMessage' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + /threads/{threadId}/messages/{messageId}/files: + get: + operationId: listMessageFiles + description: Gets a list of previously uploaded files associated with a message from a thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread containing the message to list files from. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to list files from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of files associated with the specified message. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/MessageFile' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/messages/{messageId}/files/{fileId}: + get: + operationId: getMessageFile + description: Gets information about a file attachment to a message within a thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread containing the message to get information from. + schema: + type: string + - name: messageId + in: path + required: true + description: The ID of the message to get information from. + schema: + type: string + - name: fileId + in: path + required: true + description: The ID of the file to get information about. + schema: + type: string + responses: + '200': + description: The requested file information. + content: + application/json: + schema: + $ref: '#/components/schemas/MessageFile' + /threads/{threadId}/runs: + post: + operationId: createRun + description: Creates a new run for an assistant thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to run. + schema: + type: string + responses: + '200': + description: Information about the new thread run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + description: The details for the run to create. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRunOptions' + get: + operationId: listRuns + description: Gets a list of runs for a specified thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to list runs from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of thread runs. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/ThreadRun' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/runs/{runId}: + get: + operationId: getRun + description: Gets an existing run from an existing thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread to retrieve run information from. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the thread to retrieve information about. + schema: + type: string + responses: + '200': + description: The requested information about the specified thread run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + post: + operationId: updateRun + description: Modifies an existing thread run. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread associated with the specified run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run to modify. + schema: + type: string + responses: + '200': + description: Information about the modified run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + /threads/{threadId}/runs/{runId}/cancel: + post: + operationId: cancelRun + description: Cancels a run of an in progress thread. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread being run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run to cancel. + schema: + type: string + responses: + '200': + description: Updated information about the cancelled run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + /threads/{threadId}/runs/{runId}/steps: + get: + operationId: listRunSteps + description: Gets a list of run steps from a thread run. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread that was run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run to list steps from. + schema: + type: string + - name: limit + in: query + required: false + description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + schema: + type: integer + format: int32 + default: 20 + - name: order + in: query + required: false + description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. + schema: + $ref: '#/components/schemas/ListSortOrder' + default: desc + - name: after + in: query + required: false + description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + required: false + description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + responses: + '200': + description: The requested list of run steps. + content: + application/json: + schema: + type: object + required: + - object + - data + - first_id + - last_id + - has_more + properties: + object: + type: string + enum: + - list + description: The object type, which is always list. + data: + type: array + items: + $ref: '#/components/schemas/RunStep' + description: The requested list of items. + first_id: + type: string + description: The first ID represented in this list. + last_id: + type: string + description: The last ID represented in this list. + has_more: + type: boolean + description: A value indicating whether there are additional values available not captured in this list. + description: The response data for a requested list of items. + /threads/{threadId}/runs/{runId}/steps/{stepId}: + get: + operationId: getRunStep + description: Gets a single run step from a thread run. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread that was run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the specific run to retrieve the step from. + schema: + type: string + - name: stepId + in: path + required: true + description: The ID of the step to retrieve information about. + schema: + type: string + responses: + '200': + description: Information about the requested run step. + content: + application/json: + schema: + $ref: '#/components/schemas/RunStep' + /threads/{threadId}/runs/{runId}/submit_tool_outputs: + post: + operationId: submitToolOutputsToRun + description: Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. + parameters: + - name: threadId + in: path + required: true + description: The ID of the thread that was run. + schema: + type: string + - name: runId + in: path + required: true + description: The ID of the run that requires tool outputs. + schema: + type: string + responses: + '200': + description: Updated information about the run. + content: + application/json: + schema: + $ref: '#/components/schemas/ThreadRun' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tool_outputs: + type: array + items: + $ref: '#/components/schemas/ToolOutput' + description: The list of tool outputs requested by tool calls from the specified run. + required: + - tool_outputs +security: + - ApiKeyAuth: [] + - OAuth2Auth: + - https://cognitiveservices.azure.com/.default +components: + parameters: + UpdateAssistantOptions.assistantId: + name: assistantId + in: path + required: true + description: The ID of the assistant to modify. + schema: + type: string + schemas: + Assistant: + type: object + required: + - id + - object + - created_at + - name + - description + - model + - instructions + - tools + - file_ids + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - assistant + description: The object type, which is always assistant. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + name: + type: string + nullable: true + description: The name of the assistant. + description: + type: string + nullable: true + description: The description of the assistant. + model: + type: string + description: The ID of the model to use. + instructions: + type: string + nullable: true + description: The system instructions for the assistant to use. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The collection of tools enabled for the assistant. + default: [] + file_ids: + type: array + items: + type: string + description: A list of attached file IDs, ordered by creation date in ascending order. + default: [] + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Represents an assistant that can call the model and use tools. + AssistantCreationOptions: + type: object + required: + - model + properties: + model: + type: string + description: The ID of the model to use. + name: + type: string + nullable: true + description: The name of the new assistant. + description: + type: string + nullable: true + description: The description of the new assistant. + instructions: + type: string + nullable: true + description: The system instructions for the new assistant to use. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The collection of tools to enable for the new assistant. + default: [] + file_ids: + type: array + items: + type: string + description: A list of previously uploaded file IDs to attach to the assistant. + default: [] + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The request details to use when creating a new assistant. + AssistantDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - assistant.deleted + description: The object type, which is always 'assistant.deleted'. + description: The status of an assistant deletion operation. + AssistantFile: + type: object + required: + - id + - object + - created_at + - assistant_id + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - assistant.file + description: The object type, which is always 'assistant.file'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + assistant_id: + type: string + description: The assistant ID that the file is attached to. + description: Information about a file attached to an assistant, as used by tools that can read files. + AssistantFileDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - assistant.file.deleted + description: The object type, which is always 'assistant.file.deleted'. + description: The status of an assistant file deletion operation. + AssistantThread: + type: object + required: + - id + - object + - created_at + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread + description: The object type, which is always 'thread'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Information about a single thread associated with an assistant. + AssistantThreadCreationOptions: + type: object + properties: + messages: + type: array + items: + $ref: '#/components/schemas/ThreadInitializationMessage' + description: The initial messages to associate with the new thread. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The details used to create a new assistant thread. + CodeInterpreterToolDefinition: + type: object + required: + - type + properties: + type: + type: string + enum: + - code_interpreter + description: The object type, which is always 'code_interpreter'. + allOf: + - $ref: '#/components/schemas/ToolDefinition' + description: The input definition information for a code interpreter tool as used to configure an assistant. + CreateAndRunThreadOptions: + type: object + required: + - assistant_id + properties: + assistant_id: + type: string + description: The ID of the assistant for which the thread should be created. + thread: + allOf: + - $ref: '#/components/schemas/AssistantThreadCreationOptions' + description: The details used to create the new thread. + model: + type: string + description: The overridden model that the assistant should use to run the thread. + instructions: + type: string + description: The overridden system instructions the assistant should use to run the thread. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The overridden list of enabled tools the assistant should use to run the thread. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The details used when creating and immediately running a new assistant thread. + CreateRunOptions: + type: object + required: + - assistant_id + properties: + assistant_id: + type: string + description: The ID of the assistant that should run the thread. + model: + type: string + nullable: true + description: The overridden model name that the assistant should use to run the thread. + instructions: + type: string + nullable: true + description: The overridden system instructions that the assistant should use to run the thread. + additional_instructions: + type: string + nullable: true + description: |- + Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior + on a per-run basis without overriding other instructions. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + nullable: true + description: The overridden list of enabled tools that the assistant should use to run the thread. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The details used when creating a new run of an assistant thread. + FileDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - file + description: The object type, which is always 'file'. + description: A status response from a file deletion operation. + FileListResponse: + type: object + required: + - object + - data + properties: + object: + type: string + enum: + - list + description: The object type, which is always 'list'. + data: + type: array + items: + $ref: '#/components/schemas/OpenAIFile' + description: The files returned for the request. + description: The response data from a file list operation. + FilePurpose: + type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + description: The possible values denoting the intended usage of a file. + FunctionDefinition: + type: object + required: + - name + - parameters + properties: + name: + type: string + description: The name of the function to be called. + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + parameters: + description: The parameters the functions accepts, described as a JSON Schema object. + description: The input definition information for a function. + FunctionToolDefinition: + type: object + required: + - type + - function + properties: + type: + type: string + enum: + - function + description: The object type, which is always 'function'. + function: + allOf: + - $ref: '#/components/schemas/FunctionDefinition' + description: The definition of the concrete function that the function tool should call. + allOf: + - $ref: '#/components/schemas/ToolDefinition' + description: The input definition information for a function tool as used to configure an assistant. + ListSortOrder: + type: string + enum: + - asc + - desc + description: The available sorting options when requesting a list of response objects. + MessageContent: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/MessageTextContent' + image_file: '#/components/schemas/MessageImageFileContent' + description: An abstract representation of a single item of thread message content. + MessageFile: + type: object + required: + - id + - object + - created_at + - message_id + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.message.file + description: The object type, which is always 'thread.message.file'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + message_id: + type: string + description: The ID of the message that this file is attached to. + description: Information about a file attached to an assistant thread message. + MessageImageFileContent: + type: object + required: + - type + - image_file + properties: + type: + type: string + enum: + - image_file + description: The object type, which is always 'image_file'. + image_file: + allOf: + - $ref: '#/components/schemas/MessageImageFileDetails' + description: The image file for this thread message content item. + allOf: + - $ref: '#/components/schemas/MessageContent' + description: A representation of image file content in a thread message. + MessageImageFileDetails: + type: object + required: + - file_id + properties: + file_id: + allOf: + - $ref: '#/components/schemas/MessageImageFileIdDetails' + description: The ID for the file associated with this image. + description: An image reference, as represented in thread message content. + MessageImageFileIdDetails: + type: object + required: + - file_id + properties: + file_id: + type: string + description: The ID of the specific image file. + description: An encapsulation of an image file ID, as used by message image content. + MessageRole: + type: string + enum: + - user + - assistant + description: The possible values for roles attributed to messages in a thread. + MessageTextAnnotation: + type: object + required: + - type + - text + - start_index + - end_index + properties: + type: + type: string + description: The object type. + text: + type: string + description: The textual content associated with this text annotation item. + start_index: + type: integer + format: int32 + description: The first text index associated with this text annotation. + end_index: + type: integer + format: int32 + description: The last text index associated with this text annotation. + discriminator: + propertyName: type + mapping: + file_citation: '#/components/schemas/MessageTextFileCitationAnnotation' + file_path: '#/components/schemas/MessageTextFilePathAnnotation' + description: An abstract representation of an annotation to text thread message content. + MessageTextContent: + type: object + required: + - type + - text + properties: + type: + type: string + enum: + - text + description: The object type, which is always 'text'. + text: + allOf: + - $ref: '#/components/schemas/MessageTextDetails' + description: The text and associated annotations for this thread message content item. + allOf: + - $ref: '#/components/schemas/MessageContent' + description: A representation of a textual item of thread message content. + MessageTextDetails: + type: object + required: + - value + - annotations + properties: + value: + type: string + description: The text data. + annotations: + type: array + items: + $ref: '#/components/schemas/MessageTextAnnotation' + description: A list of annotations associated with this text. + description: The text and associated annotations for a single item of assistant thread message content. + MessageTextFileCitationAnnotation: + type: object + required: + - type + - file_citation + properties: + type: + type: string + enum: + - file_citation + description: The object type, which is always 'file_citation'. + file_citation: + allOf: + - $ref: '#/components/schemas/MessageTextFileCitationDetails' + description: |- + A citation within the message that points to a specific quote from a specific file. + Generated when the assistant uses the "retrieval" tool to search files. + allOf: + - $ref: '#/components/schemas/MessageTextAnnotation' + description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files. + MessageTextFileCitationDetails: + type: object + required: + - file_id + - quote + properties: + file_id: + type: string + description: The ID of the file associated with this citation. + quote: + type: string + description: The specific quote cited in the associated file. + description: A representation of a file-based text citation, as used in a file-based annotation of text thread message content. + MessageTextFilePathAnnotation: + type: object + required: + - type + - file_path + properties: + type: + type: string + enum: + - file_path + description: The object type, which is always 'file_path'. + file_path: + allOf: + - $ref: '#/components/schemas/MessageTextFilePathDetails' + description: A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. + allOf: + - $ref: '#/components/schemas/MessageTextAnnotation' + description: A citation within the message that points to a file located at a specific path. + MessageTextFilePathDetails: + type: object + required: + - file_id + properties: + file_id: + type: string + description: The ID of the specific file that the citation is from. + description: An encapsulation of an image file ID, as used by message image content. + OpenAIFile: + type: object + required: + - object + - id + - bytes + - filename + - created_at + - purpose + properties: + object: + type: string + enum: + - file + description: The object type, which is always 'file'. + id: + type: string + description: The identifier, which can be referenced in API endpoints. + bytes: + type: integer + format: int32 + description: The size of the file, in bytes. + filename: + type: string + description: The name of the file. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + purpose: + allOf: + - $ref: '#/components/schemas/FilePurpose' + description: The intended purpose of a file. + description: Represents an assistant that can call the model and use tools. + RequiredAction: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + submit_tool_outputs: '#/components/schemas/SubmitToolOutputsAction' + description: An abstract representation of a required action for an assistant thread run to continue. + RequiredFunctionToolCall: + type: object + required: + - type + - function + properties: + type: + type: string + enum: + - function + description: The object type of the required tool call. Always 'function' for function tools. + function: + allOf: + - $ref: '#/components/schemas/RequiredFunctionToolCallDetails' + description: Detailed information about the function to be executed by the tool that includes name and arguments. + allOf: + - $ref: '#/components/schemas/RequiredToolCall' + description: A representation of a requested call to a function tool, needed by the model to continue evaluation of a run. + RequiredFunctionToolCallDetails: + type: object + required: + - name + - arguments + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments to use when invoking the named function, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation. + description: The detailed information for a function invocation, as provided by a required action invoking a function tool, that includes the name of and arguments to the function. + RequiredToolCall: + type: object + required: + - type + - id + properties: + type: + type: string + description: The object type for the required tool call. + id: + type: string + description: The ID of the tool call. This ID must be referenced when submitting tool outputs. + discriminator: + propertyName: type + mapping: + function: '#/components/schemas/RequiredFunctionToolCall' + description: An abstract representation a a tool invocation needed by the model to continue a run. + RetrievalToolDefinition: + type: object + required: + - type + properties: + type: + type: string + enum: + - retrieval + description: The object type, which is always 'retrieval'. + allOf: + - $ref: '#/components/schemas/ToolDefinition' + description: The input definition information for a retrieval tool as used to configure an assistant. + RunError: + type: object + required: + - code + - message + properties: + code: + type: string + description: The status for the error. + message: + type: string + description: The human-readable text associated with the error. + description: The details of an error as encountered by an assistant thread run. + RunStatus: + type: string + enum: + - queued + - in_progress + - requires_action + - cancelling + - cancelled + - failed + - completed + - expired + description: Possible values for the status of an assistant thread run. + RunStep: + type: object + required: + - id + - object + - type + - assistant_id + - thread_id + - run_id + - status + - step_details + - last_error + - created_at + - expired_at + - completed_at + - cancelled_at + - failed_at + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.run.step + description: The object type, which is always 'thread.run.step'. + type: + allOf: + - $ref: '#/components/schemas/RunStepType' + description: The type of run step, which can be either message_creation or tool_calls. + assistant_id: + type: string + description: The ID of the assistant associated with the run step. + thread_id: + type: string + description: The ID of the thread that was run. + run_id: + type: string + description: The ID of the run that this run step is a part of. + status: + allOf: + - $ref: '#/components/schemas/RunStepStatus' + description: The status of this run step. + step_details: + allOf: + - $ref: '#/components/schemas/RunStepDetails' + description: The details for this run step. + last_error: + type: object + allOf: + - $ref: '#/components/schemas/RunStepError' + nullable: true + description: If applicable, information about the last error encountered by this run step. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + expired_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this item expired. + completed_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this completed. + cancelled_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this was cancelled. + failed_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this failed. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Detailed information about a single step of an assistant thread run. + RunStepCodeInterpreterImageOutput: + type: object + required: + - type + - image + properties: + type: + type: string + enum: + - image + description: The object type, which is always 'image'. + image: + allOf: + - $ref: '#/components/schemas/RunStepCodeInterpreterImageReference' + description: Referential information for the image associated with this output. + allOf: + - $ref: '#/components/schemas/RunStepCodeInterpreterToolCallOutput' + description: A representation of an image output emitted by a code interpreter tool in response to a tool call by the model. + RunStepCodeInterpreterImageReference: + type: object + required: + - file_id + properties: + file_id: + type: string + description: The ID of the file associated with this image. + description: An image reference emitted by a code interpreter tool in response to a tool call by the model. + RunStepCodeInterpreterLogOutput: + type: object + required: + - type + - logs + properties: + type: + type: string + enum: + - logs + description: The object type, which is always 'logs'. + logs: + type: string + description: The serialized log output emitted by the code interpreter. + allOf: + - $ref: '#/components/schemas/RunStepCodeInterpreterToolCallOutput' + description: A representation of a log output emitted by a code interpreter tool in response to a tool call by the model. + RunStepCodeInterpreterToolCall: + type: object + required: + - type + - code_interpreter + properties: + type: + type: string + enum: + - code_interpreter + description: The object type, which is always 'code_interpreter'. + code_interpreter: + allOf: + - $ref: '#/components/schemas/RunStepCodeInterpreterToolCallDetails' + description: The details of the tool call to the code interpreter tool. + allOf: + - $ref: '#/components/schemas/RunStepToolCall' + description: |- + A record of a call to a code interpreter tool, issued by the model in evaluation of a defined tool, that + represents inputs and outputs consumed and emitted by the code interpreter. + RunStepCodeInterpreterToolCallDetails: + type: object + required: + - input + - outputs + properties: + input: + type: string + description: The input provided by the model to the code interpreter tool. + outputs: + type: array + items: + $ref: '#/components/schemas/RunStepCodeInterpreterToolCallOutput' + description: The outputs produced by the code interpreter tool back to the model in response to the tool call. + description: The detailed information about a code interpreter invocation by the model. + RunStepCodeInterpreterToolCallOutput: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + logs: '#/components/schemas/RunStepCodeInterpreterLogOutput' + image: '#/components/schemas/RunStepCodeInterpreterImageOutput' + description: An abstract representation of an emitted output from a code interpreter tool. + RunStepDetails: + type: object + required: + - type + properties: + type: + allOf: + - $ref: '#/components/schemas/RunStepType' + description: The object type. + discriminator: + propertyName: type + mapping: + message_creation: '#/components/schemas/RunStepMessageCreationDetails' + tool_calls: '#/components/schemas/RunStepToolCallDetails' + description: An abstract representation of the details for a run step. + RunStepError: + type: object + required: + - code + - message + properties: + code: + allOf: + - $ref: '#/components/schemas/RunStepErrorCode' + description: The error code for this error. + message: + type: string + description: The human-readable text associated with this error. + description: The error information associated with a failed run step. + RunStepErrorCode: + type: string + enum: + - server_error + - rate_limit_exceeded + description: Possible error code values attributable to a failed run step. + RunStepFunctionToolCall: + type: object + required: + - type + - function + properties: + type: + type: string + enum: + - function + description: The object type, which is always 'function'. + function: + allOf: + - $ref: '#/components/schemas/RunStepFunctionToolCallDetails' + description: The detailed information about the function called by the model. + allOf: + - $ref: '#/components/schemas/RunStepToolCall' + description: |- + A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs + and output consumed and emitted by the specified function. + RunStepFunctionToolCallDetails: + type: object + required: + - name + - arguments + - output + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments that the model requires are provided to the named function. + output: + type: string + nullable: true + description: The output of the function, only populated for function calls that have already have had their outputs submitted. + description: The detailed information about the function called by the model. + RunStepMessageCreationDetails: + type: object + required: + - type + - message_creation + properties: + type: + type: string + enum: + - message_creation + description: The object type, which is always 'message_creation'. + message_creation: + allOf: + - $ref: '#/components/schemas/RunStepMessageCreationReference' + description: Information about the message creation associated with this run step. + allOf: + - $ref: '#/components/schemas/RunStepDetails' + description: The detailed information associated with a message creation run step. + RunStepMessageCreationReference: + type: object + required: + - message_id + properties: + message_id: + type: string + description: The ID of the message created by this run step. + description: The details of a message created as a part of a run step. + RunStepRetrievalToolCall: + type: object + required: + - type + - retrieval + properties: + type: + type: string + enum: + - retrieval + description: The object type, which is always 'retrieval'. + retrieval: + type: object + additionalProperties: + type: string + description: The key/value pairs produced by the retrieval tool. + allOf: + - $ref: '#/components/schemas/RunStepToolCall' + description: |- + A record of a call to a retrieval tool, issued by the model in evaluation of a defined tool, that represents + executed retrieval actions. + RunStepStatus: + type: string + enum: + - in_progress + - cancelled + - failed + - completed + - expired + description: Possible values for the status of a run step. + RunStepToolCall: + type: object + required: + - type + - id + properties: + type: + type: string + description: The object type. + id: + type: string + description: The ID of the tool call. This ID must be referenced when you submit tool outputs. + discriminator: + propertyName: type + mapping: + code_interpreter: '#/components/schemas/RunStepCodeInterpreterToolCall' + retrieval: '#/components/schemas/RunStepRetrievalToolCall' + function: '#/components/schemas/RunStepFunctionToolCall' + description: An abstract representation of a detailed tool call as recorded within a run step for an existing run. + RunStepToolCallDetails: + type: object + required: + - type + - tool_calls + properties: + type: + type: string + enum: + - tool_calls + description: The object type, which is always 'tool_calls'. + tool_calls: + type: array + items: + $ref: '#/components/schemas/RunStepToolCall' + description: A list of tool call details for this run step. + allOf: + - $ref: '#/components/schemas/RunStepDetails' + description: The detailed information associated with a run step calling tools. + RunStepType: + type: string + enum: + - message_creation + - tool_calls + description: The possible types of run steps. + ServiceApiVersions: + type: string + enum: + - 2024-02-15-preview + description: The known set of supported API versions. + SubmitToolOutputsAction: + type: object + required: + - type + - submit_tool_outputs + properties: + type: + type: string + enum: + - submit_tool_outputs + description: The object type, which is always 'submit_tool_outputs'. + submit_tool_outputs: + allOf: + - $ref: '#/components/schemas/SubmitToolOutputsDetails' + description: The details describing tools that should be called to submit tool outputs. + allOf: + - $ref: '#/components/schemas/RequiredAction' + description: The details for required tool calls that must be submitted for an assistant thread run to continue. + SubmitToolOutputsDetails: + type: object + required: + - tool_calls + properties: + tool_calls: + type: array + items: + $ref: '#/components/schemas/RequiredToolCall' + description: The list of tool calls that must be resolved for the assistant thread run to continue. + description: The details describing tools that should be called to submit tool outputs. + ThreadDeletionStatus: + type: object + required: + - id + - deleted + - object + properties: + id: + type: string + description: The ID of the resource specified for deletion. + deleted: + type: boolean + description: A value indicating whether deletion was successful. + object: + type: string + enum: + - thread.deleted + description: The object type, which is always 'thread.deleted'. + description: The status of a thread deletion operation. + ThreadInitializationMessage: + type: object + required: + - role + - content + properties: + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + description: The role associated with the assistant thread message. Currently, only 'user' is supported when providing initial messages to a new thread. + content: + type: string + description: The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API. + file_ids: + type: array + items: + type: string + description: |- + A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can + access files. + default: [] + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: A single message within an assistant thread, as provided during that thread's creation for its initial state. + ThreadMessage: + type: object + required: + - id + - object + - created_at + - thread_id + - role + - content + - file_ids + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.message + description: The object type, which is always 'thread.message'. + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + thread_id: + type: string + description: The ID of the thread that this message belongs to. + role: + allOf: + - $ref: '#/components/schemas/MessageRole' + description: The role associated with the assistant thread message. + content: + type: array + items: + $ref: '#/components/schemas/MessageContent' + description: The list of content items associated with the assistant thread message. + assistant_id: + type: string + description: If applicable, the ID of the assistant that authored this message. + run_id: + type: string + description: If applicable, the ID of the run associated with the authoring of this message. + file_ids: + type: array + items: + type: string + description: |- + A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can + access files. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: A single, existing message within an assistant thread. + ThreadRun: + type: object + required: + - id + - object + - thread_id + - assistant_id + - status + - last_error + - model + - instructions + - tools + - file_ids + - created_at + - expires_at + - started_at + - completed_at + - cancelled_at + - failed_at + - metadata + properties: + id: + type: string + description: The identifier, which can be referenced in API endpoints. + object: + type: string + enum: + - thread.run + description: The object type, which is always 'thread.run'. + thread_id: + type: string + description: The ID of the thread associated with this run. + assistant_id: + type: string + description: The ID of the assistant associated with the thread this run was performed against. + status: + allOf: + - $ref: '#/components/schemas/RunStatus' + description: The status of the assistant thread run. + required_action: + type: object + allOf: + - $ref: '#/components/schemas/RequiredAction' + nullable: true + description: The details of the action required for the assistant thread run to continue. + last_error: + type: object + allOf: + - $ref: '#/components/schemas/RunError' + nullable: true + description: The last error, if any, encountered by this assistant thread run. + model: + type: string + description: The ID of the model to use. + instructions: + type: string + description: The overridden system instructions used for this assistant thread run. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The overridden enabled tools used for this assistant thread run. + default: [] + file_ids: + type: array + items: + type: string + description: A list of attached file IDs, ordered by creation date in ascending order. + default: [] + created_at: + type: integer + format: unixtime + description: The Unix timestamp, in seconds, representing when this object was created. + expires_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this item expires. + started_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this item was started. + completed_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this completed. + cancelled_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this was cancelled. + failed_at: + type: string + format: date-time + nullable: true + description: The Unix timestamp, in seconds, representing when this failed. + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: Data representing a single evaluation run of an assistant thread. + ToolDefinition: + type: object + required: + - type + properties: + type: + type: string + description: The object type. + discriminator: + propertyName: type + mapping: + code_interpreter: '#/components/schemas/CodeInterpreterToolDefinition' + retrieval: '#/components/schemas/RetrievalToolDefinition' + function: '#/components/schemas/FunctionToolDefinition' + description: An abstract representation of an input tool definition that an assistant can use. + ToolOutput: + type: object + properties: + tool_call_id: + type: string + description: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. + output: + type: string + description: The output from the tool to be submitted. + description: The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. + UpdateAssistantOptions: + type: object + properties: + model: + type: string + description: The ID of the model to use. + name: + type: string + nullable: true + description: The modified name for the assistant to use. + description: + type: string + nullable: true + description: The modified description for the assistant to use. + instructions: + type: string + nullable: true + description: The modified system instructions for the new assistant to use. + tools: + type: array + items: + $ref: '#/components/schemas/ToolDefinition' + description: The modified collection of tools to enable for the assistant. + default: [] + file_ids: + type: array + items: + type: string + description: The modified list of previously uploaded fileIDs to attach to the assistant. + default: [] + metadata: + type: object + additionalProperties: + type: string + nullable: true + description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. + description: The request details to use when modifying an existing assistant. + securitySchemes: + ApiKeyAuth: + type: apiKey + in: header + name: api-key + OAuth2Auth: + type: oauth2 + flows: + implicit: + authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize + scopes: + https://cognitiveservices.azure.com/.default: '' +servers: + - url: '{endpoint}' + description: Azure OpenAI APIs for Assistants. + variables: + endpoint: + default: '' + description: An OpenAI endpoint supporting assistants functionality. diff --git a/specification/ai/readme.md b/specification/ai/readme.md deleted file mode 100644 index 900aeeb15559..000000000000 --- a/specification/ai/readme.md +++ /dev/null @@ -1 +0,0 @@ -Please place all Azure AI Service related API Specifications in this folder. diff --git a/specification/apicenter/ApiCenter.Management/Api.tsp b/specification/apicenter/ApiCenter.Management/Api.tsp new file mode 100644 index 000000000000..72253660be4a --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/Api.tsp @@ -0,0 +1,41 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./Workspace.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using TypeSpec.Http; + +namespace Microsoft.ApiCenter; +@doc("API entity.") +@parentResource(Workspace) +model Api is ProxyResource { + @doc("The name of the API.") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9-]{3,90}$") + @path + @key("apiName") + @segment("apis") + name: string; +} + +@armResourceOperations +interface Apis { + @doc("Returns details of the API.") + get is ArmResourceRead; + @doc("Checks if specified API exists.") + @head + head( + ...ResourceInstanceParameters>, + ): OkResponse | ErrorResponse; + @doc("Creates new or updates existing API.") + createOrUpdate is ArmResourceCreateOrReplaceSync; + @doc("Deletes specified API.") + delete is ArmResourceDeleteSync; + @doc("Returns a collection of APIs.") + list is ArmResourceListByParent; +} diff --git a/specification/apicenter/ApiCenter.Management/ApiDefinition.tsp b/specification/apicenter/ApiCenter.Management/ApiDefinition.tsp new file mode 100644 index 000000000000..f9d3b507b1fe --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/ApiDefinition.tsp @@ -0,0 +1,59 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiVersion.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using TypeSpec.Http; + +namespace Microsoft.ApiCenter; +@doc("API definition entity.") +@parentResource(ApiVersion) +model ApiDefinition is ProxyResource { + @doc("The name of the API definition.") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9-]{3,90}$") + @path + @key("definitionName") + @segment("definitions") + name: string; +} + +@armResourceOperations +interface ApiDefinitions { + @doc("Returns details of the API definition.") + get is ArmResourceRead; + @doc("Checks if specified API definition exists.") + @head + head( + ...ResourceInstanceParameters>, + ): OkResponse | ErrorResponse; + @doc("Creates new or updates existing API definition.") + createOrUpdate is ArmResourceCreateOrReplaceSync; + @doc("Deletes specified API definition.") + delete is ArmResourceDeleteSync; + @doc("Returns a collection of API definitions.") + list is ArmResourceListByParent; + @doc("Imports the API specification.") + importSpecification is ArmResourceActionAsync< + ApiDefinition, + ApiSpecImportRequest, + ApiImportSuccess + >; + @doc("Exports the API specification.") + exportSpecification is ArmResourceActionAsync< + ApiDefinition, + void, + ApiSpecExportResult + >; +} + +/** The API specification was successfully imported. */ +model ApiImportSuccess { + /** The response status code */ + @statusCode code: 200; +} diff --git a/specification/apicenter/ApiCenter.Management/ApiVersion.tsp b/specification/apicenter/ApiCenter.Management/ApiVersion.tsp new file mode 100644 index 000000000000..191b24721e13 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/ApiVersion.tsp @@ -0,0 +1,41 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./Api.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using TypeSpec.Http; + +namespace Microsoft.ApiCenter; +@doc("API version entity.") +@parentResource(Api) +model ApiVersion is ProxyResource { + @doc("The name of the API version.") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9-]{3,90}$") + @path + @key("versionName") + @segment("versions") + name: string; +} + +@armResourceOperations +interface ApiVersions { + @doc("Returns details of the API version.") + get is ArmResourceRead; + @doc("Checks if specified API version exists.") + @head + head( + ...ResourceInstanceParameters>, + ): OkResponse | ErrorResponse; + @doc("Creates new or updates existing API version.") + createOrUpdate is ArmResourceCreateOrReplaceSync; + @doc("Deletes specified API version") + delete is ArmResourceDeleteSync; + @doc("Returns a collection of API versions.") + list is ArmResourceListByParent; +} diff --git a/specification/apicenter/ApiCenter.Management/Deployment.tsp b/specification/apicenter/ApiCenter.Management/Deployment.tsp new file mode 100644 index 000000000000..2eab2cf135a1 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/Deployment.tsp @@ -0,0 +1,41 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./Api.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using TypeSpec.Http; + +namespace Microsoft.ApiCenter; +@doc("API deployment entity.") +@parentResource(Api) +model Deployment is ProxyResource { + @doc("The name of the API deployment.") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9-]{3,90}$") + @path + @key("deploymentName") + @segment("deployments") + name: string; +} + +@armResourceOperations +interface Deployments { + @doc("Returns details of the API deployment.") + get is ArmResourceRead; + @doc("Checks if specified API deployment exists.") + @head + head( + ...ResourceInstanceParameters>, + ): OkResponse | ErrorResponse; + @doc("Creates new or updates existing API deployment.") + createOrUpdate is ArmResourceCreateOrReplaceSync; + @doc("Deletes API deployment.") + delete is ArmResourceDeleteSync; + @doc("Returns a collection of API deployments.") + list is ArmResourceListByParent; +} diff --git a/specification/apicenter/ApiCenter.Management/Environment.tsp b/specification/apicenter/ApiCenter.Management/Environment.tsp new file mode 100644 index 000000000000..3825f4dd26fc --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/Environment.tsp @@ -0,0 +1,41 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./Workspace.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using TypeSpec.Http; + +namespace Microsoft.ApiCenter; +@doc("Environment entity.") +@parentResource(Workspace) +model Environment is ProxyResource { + @doc("The name of the environment.") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9-]{3,90}$") + @path + @key("environmentName") + @segment("environments") + name: string; +} + +@armResourceOperations +interface Environments { + @doc("Returns details of the environment.") + get is ArmResourceRead; + @doc("Checks if specified environment exists.") + @head + head( + ...ResourceInstanceParameters>, + ): OkResponse | ErrorResponse; + @doc("Creates new or updates existing environment.") + createOrUpdate is ArmResourceCreateOrReplaceSync; + @doc("Deletes the environment.") + delete is ArmResourceDeleteSync; + @doc("Returns a collection of environments.") + list is ArmResourceListByParent; +} diff --git a/specification/apicenter/ApiCenter.Management/MetadataSchema.tsp b/specification/apicenter/ApiCenter.Management/MetadataSchema.tsp new file mode 100644 index 000000000000..e95c4f4d3dae --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/MetadataSchema.tsp @@ -0,0 +1,44 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./Service.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using TypeSpec.Http; + +namespace Microsoft.ApiCenter; +@doc("Metadata schema entity. Used to define metadata for the entities in API catalog.") +@parentResource(Service) +model MetadataSchema is ProxyResource { + @doc("The name of the metadata schema.") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9-]{3,90}$") + @path + @key("metadataSchemaName") + @segment("metadataSchemas") + name: string; +} + +@armResourceOperations +interface MetadataSchemas { + @doc("Returns details of the metadata schema.") + get is ArmResourceRead; + @doc("Checks if specified metadata schema exists.") + @head + head( + ...ResourceInstanceParameters< + MetadataSchema, + BaseParameters + >, + ): OkResponse | ErrorResponse; + @doc("Creates new or updates existing metadata schema.") + createOrUpdate is ArmResourceCreateOrReplaceSync; + @doc("Deletes specified metadata schema.") + delete is ArmResourceDeleteSync; + @doc("Returns a collection of metadata schemas.") + list is ArmResourceListByParent; +} diff --git a/specification/apicenter/ApiCenter.Management/Service.tsp b/specification/apicenter/ApiCenter.Management/Service.tsp new file mode 100644 index 000000000000..3142ab515b00 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/Service.tsp @@ -0,0 +1,46 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using TypeSpec.Http; + +namespace Microsoft.ApiCenter; +@doc("The service entity.") +model Service is TrackedResource { + @doc("The name of Azure API Center service.") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9-]{3,90}$") + @path + @key("serviceName") + @segment("services") + name: string; + + ...Azure.ResourceManager.ManagedServiceIdentity; +} + +@armResourceOperations +interface Services { + @doc("Returns details of the service.") + get is Azure.ResourceManager.ArmResourceRead; + @doc("Creates new or updates existing API.") + createOrUpdate is Azure.ResourceManager.ArmResourceCreateOrReplaceSync; + @doc("Updates existing service.") + update is ArmResourcePatchSync; + @doc("Deletes specified service.") + delete is ArmResourceDeleteSync; + @doc("Returns a collection of services within the resource group.") + listByResourceGroup is Azure.ResourceManager.ArmResourceListByParent; + @doc("Lists services within an Azure subscription.") + listBySubscription is ArmListBySubscription; + @doc("Exports the effective metadata schema.") + exportMetadataSchema is ArmResourceActionAsync< + Service, + MetadataSchemaExportRequest, + MetadataSchemaExportResult + >; +} diff --git a/specification/apicenter/ApiCenter.Management/Workspace.tsp b/specification/apicenter/ApiCenter.Management/Workspace.tsp new file mode 100644 index 000000000000..04c4fbf4a4c4 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/Workspace.tsp @@ -0,0 +1,41 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./Service.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using TypeSpec.Http; + +namespace Microsoft.ApiCenter; +@doc("Workspace entity.") +@parentResource(Service) +model Workspace is ProxyResource { + @doc("The name of the workspace.") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9-]{3,90}$") + @path + @key("workspaceName") + @segment("workspaces") + name: string; +} + +@armResourceOperations +interface Workspaces { + @doc("Returns details of the workspace.") + get is ArmResourceRead; + @doc("Checks if specified workspace exists.") + @head + head( + ...ResourceInstanceParameters>, + ): OkResponse | ErrorResponse; + @doc("Creates new or updates existing workspace.") + createOrUpdate is ArmResourceCreateOrReplaceSync; + @doc("Deletes specified workspace.") + delete is ArmResourceDeleteSync; + @doc("Returns a collection of workspaces.") + list is ArmResourceListByParent; +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_CreateOrUpdate.json new file mode 100644 index 000000000000..053833679cea --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_CreateOrUpdate.json @@ -0,0 +1,60 @@ +{ + "operationId": "ApiDefinitions_CreateOrUpdate", + "title": "ApiDefinitions_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "openapi", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-03-01", + "payload": { + "properties": { + "title": "OpenAPI", + "description": "Default spec" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/versions/definitions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "name": "openapi", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "OpenAPI", + "description": "Default spec", + "specification": { + "name": "openapi", + "version": "3.0.6" + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/versions/definitions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "name": "openapi", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "OpenAPI", + "description": "Default spec", + "specification": { + "name": "openapi", + "version": "3.0.6" + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_Delete.json new file mode 100644 index 000000000000..deff5dfefec0 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_Delete.json @@ -0,0 +1,18 @@ +{ + "operationId": "ApiDefinitions_Delete", + "title": "ApiDefinitions_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-03-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_ExportSpecification.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_ExportSpecification.json new file mode 100644 index 000000000000..ca4b8ad4e9d5 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_ExportSpecification.json @@ -0,0 +1,27 @@ +{ + "operationId": "ApiDefinitions_ExportSpecification", + "title": "ApiDefinitions_ExportSpecification", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "format": "inline", + "value": "{ ... }" + } + }, + "202": { + "headers": { + "location": "https://..." + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_Get.json new file mode 100644 index 000000000000..a02f85950086 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_Get.json @@ -0,0 +1,35 @@ +{ + "operationId": "ApiDefinitions_Get", + "title": "ApiDefinitions_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/versions/definitions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "name": "openapi", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "OpenAPI", + "description": "Default spec", + "specification": { + "name": "openapi", + "version": "3.0.6" + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_Head.json new file mode 100644 index 000000000000..976d7fbec7ec --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_Head.json @@ -0,0 +1,21 @@ +{ + "operationId": "ApiDefinitions_Head", + "title": "ApiDefinitions_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_ImportSpecification.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_ImportSpecification.json new file mode 100644 index 000000000000..b3b497508524 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_ImportSpecification.json @@ -0,0 +1,30 @@ +{ + "operationId": "ApiDefinitions_ImportSpecification", + "title": "ApiDefinitions_ImportSpecification", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-03-01", + "payload": { + "format": "link", + "value": "https://...", + "specification": { + "name": "openapi", + "version": "3.0.1" + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://..." + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_List.json new file mode 100644 index 000000000000..3c96f25f3a01 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiDefinitions_List.json @@ -0,0 +1,38 @@ +{ + "operationId": "ApiDefinitions_List", + "title": "ApiDefinitions_ListByApiVersion", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/apis/versions/definitions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "name": "openapi", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "OpenAPI", + "description": "Default spec", + "specification": { + "name": "openapi", + "version": "3.0.6" + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_CreateOrUpdate.json new file mode 100644 index 000000000000..b85f753b2f0a --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "operationId": "ApiVersions_CreateOrUpdate", + "title": "ApiVersions_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-03-01", + "payload": { + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/apis/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01", + "name": "2023-01-01", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/apis/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01", + "name": "2023-01-01", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_Delete.json new file mode 100644 index 000000000000..a9364ba7fd55 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_Delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "ApiVersions_Delete", + "title": "ApiVersions_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-03-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_Get.json new file mode 100644 index 000000000000..288fc01a31d6 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_Get.json @@ -0,0 +1,30 @@ +{ + "operationId": "ApiVersions_Get", + "title": "ApiVersions_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/apis/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01", + "name": "2023-01-01", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_Head.json new file mode 100644 index 000000000000..1d0ffbc27000 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_Head.json @@ -0,0 +1,20 @@ +{ + "operationId": "ApiVersions_Head", + "title": "ApiVersions_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_List.json new file mode 100644 index 000000000000..6cc59088dbb8 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/ApiVersions_List.json @@ -0,0 +1,33 @@ +{ + "operationId": "ApiVersions_List", + "title": "ApiVersions_ListByApi", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/environments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_CreateOrUpdate.json new file mode 100644 index 000000000000..291995eb4dc0 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_CreateOrUpdate.json @@ -0,0 +1,101 @@ +{ + "operationId": "Apis_CreateOrUpdate", + "title": "Apis_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-03-01", + "payload": { + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api", + "name": "echo-api", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api", + "name": "echo-api", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_Delete.json new file mode 100644 index 000000000000..24df3858cc86 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_Delete.json @@ -0,0 +1,16 @@ +{ + "operationId": "Apis_Delete", + "title": "Apis_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-03-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_Get.json new file mode 100644 index 000000000000..ae4f66669395 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_Get.json @@ -0,0 +1,46 @@ +{ + "operationId": "Apis_Get", + "title": "Apis_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_Head.json new file mode 100644 index 000000000000..29789f042103 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_Head.json @@ -0,0 +1,19 @@ +{ + "operationId": "Apis_Head", + "title": "Apis_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_List.json new file mode 100644 index 000000000000..7cfab5d2623d --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Apis_List.json @@ -0,0 +1,49 @@ +{ + "operationId": "Apis_List", + "title": "Apis_ListByWorkspace", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/environments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api", + "name": "echo-api", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_CreateOrUpdate.json new file mode 100644 index 000000000000..278f4f06736b --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_CreateOrUpdate.json @@ -0,0 +1,75 @@ +{ + "operationId": "Deployments_CreateOrUpdate", + "title": "Deployments_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "deploymentName": "production", + "api-version": "2024-03-01", + "payload": { + "properties": { + "title": "Production deployment", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/deployments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production", + "name": "production", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Production deployment", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/deployments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production", + "name": "production", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Production deployment", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_Delete.json new file mode 100644 index 000000000000..19caaefdb5a7 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_Delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "Deployments_Delete", + "title": "Deployments_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "deploymentName": "production", + "api-version": "2024-03-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_Get.json new file mode 100644 index 000000000000..375e72ad3538 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "Deployments_Get", + "title": "Deployments_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "deploymentName": "production", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/deployments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Production deployment", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_Head.json new file mode 100644 index 000000000000..6feacfe7acf5 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_Head.json @@ -0,0 +1,20 @@ +{ + "operationId": "Deployments_Head", + "title": "Deployments_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "deploymentName": "production", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_List.json new file mode 100644 index 000000000000..364d0ccbb7f1 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Deployments_List.json @@ -0,0 +1,41 @@ +{ + "operationId": "Deployments_List", + "title": "Deployments_ListByApi", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/apis/deployments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Development", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_CreateOrUpdate.json new file mode 100644 index 000000000000..e0d7ad6ab3a2 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_CreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "operationId": "Environments_CreateOrUpdate", + "title": "Environments_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "environmentName": "public", + "api-version": "2024-03-01", + "payload": { + "properties": { + "title": "Contoso Europe Azure API Management", + "description": "The primary Azure API Management service for the European division of Contoso.", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [ + "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso" + ] + }, + "onboarding": { + "instructions": "Sign in or sign up in the specified developer portal to request API access. You must complete the internal privacy training for your account to be approved.", + "developerPortalUri": [ + "https://developer.contoso.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/environments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/environments/public", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Contoso Europe Azure API Management", + "description": "The primary Azure API Management service for the European division of Contoso.", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [ + "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso" + ] + }, + "onboarding": { + "instructions": "Sign in or sign up in the specified developer portal to request API access. You must complete the internal privacy training for your account to be approved.", + "developerPortalUri": [ + "https://developer.contoso.com" + ] + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/environments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/environments/public", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Contoso Europe Azure API Management", + "description": "The primary Azure API Management service for the European division of Contoso.", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [ + "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso" + ] + }, + "onboarding": { + "instructions": "Sign in or sign up in the specified developer portal to request API access. You must complete the internal privacy training for your account to be approved.", + "developerPortalUri": [ + "https://developer.contoso.com" + ] + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_Delete.json new file mode 100644 index 000000000000..2df043db988b --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_Delete.json @@ -0,0 +1,16 @@ +{ + "operationId": "Environments_Delete", + "title": "Environments_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "environmentName": "public", + "api-version": "2024-03-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_Get.json new file mode 100644 index 000000000000..67396ba65744 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_Get.json @@ -0,0 +1,37 @@ +{ + "operationId": "Environments_Get", + "title": "Environments_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "environmentName": "public", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/environments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/environments/public", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Public", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [] + }, + "onboarding": { + "developerPortalUri": [] + }, + "customProperties": {} + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_Head.json new file mode 100644 index 000000000000..680842d55f1c --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_Head.json @@ -0,0 +1,19 @@ +{ + "operationId": "Environments_Head", + "title": "Environments_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "environmentName": "public", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_List.json new file mode 100644 index 000000000000..48ebd7217d5f --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Environments_List.json @@ -0,0 +1,41 @@ +{ + "operationId": "Environments_List", + "title": "Environments_ListByWorkspace", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/environments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/environments/public", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Contoso Europe Azure API Management", + "description": "The primary Azure API Management service for the European division of Contoso.", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [] + }, + "onboarding": { + "developerPortalUri": [] + }, + "customProperties": {} + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_CreateOrUpdate.json new file mode 100644 index 000000000000..7a20cd9c82c7 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_CreateOrUpdate.json @@ -0,0 +1,65 @@ +{ + "operationId": "MetadataSchemas_CreateOrUpdate", + "title": "MetadataSchemas_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "metadataSchemaName": "author", + "api-version": "2024-03-01", + "payload": { + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/metadataSchemas", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author", + "name": "author", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/metadataSchemas", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author", + "name": "author", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_Delete.json new file mode 100644 index 000000000000..71660a9dc53c --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_Delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "MetadataSchemas_Delete", + "title": "MetadataSchemas_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "metadataSchemaName": "author", + "api-version": "2024-03-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_Get.json new file mode 100644 index 000000000000..cad327f8c406 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_Get.json @@ -0,0 +1,33 @@ +{ + "operationId": "MetadataSchemas_Get", + "title": "MetadataSchemas_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "metadataSchemaName": "lastName", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/metadataSchemas", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author", + "name": "author", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_Head.json new file mode 100644 index 000000000000..e77a9103354c --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_Head.json @@ -0,0 +1,18 @@ +{ + "operationId": "MetadataSchemas_Head", + "title": "MetadataSchemas_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "metadataSchemaName": "author", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_List.json new file mode 100644 index 000000000000..fd6745cb15d2 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/MetadataSchemas_List.json @@ -0,0 +1,36 @@ +{ + "operationId": "MetadataSchemas_List", + "title": "MetadataSchemas_ListByService", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/metadataSchemas", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author", + "name": "author", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Operations_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Operations_List.json new file mode 100644 index 000000000000..166e05ff1ff9 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Operations_List.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "List Provider Operations", + "parameters": { + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ApiCenter/services/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.ApiCenter", + "resource": "services", + "operation": "Lists services", + "description": "Lists registered services" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_CreateOrUpdate.json new file mode 100644 index 000000000000..3f23d5d186b7 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_CreateOrUpdate.json @@ -0,0 +1,69 @@ +{ + "operationId": "Services_CreateOrUpdate", + "title": "Services_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-03-01", + "resource": { + "properties": {}, + "tags": {}, + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_Delete.json new file mode 100644 index 000000000000..578485418310 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_Delete.json @@ -0,0 +1,14 @@ +{ + "operationId": "Services_Delete", + "title": "Services_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-03-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_ExportMetadataSchema.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_ExportMetadataSchema.json new file mode 100644 index 000000000000..0f14fc2b22b2 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_ExportMetadataSchema.json @@ -0,0 +1,27 @@ +{ + "operationId": "Services_ExportMetadataSchema", + "title": "Services_ExportMetadataSchema", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "assignedTo": "api", + "api-version": "2024-03-01", + "payload": { + "assignedTo": "api" + } + }, + "responses": { + "200": { + "body": { + "format": "json-schema", + "value": "{\"type\":\"object\",\"properties\":{ ... }}" + } + }, + "202": { + "headers": { + "location": "https://..." + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_Get.json new file mode 100644 index 000000000000..185ae5875135 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_Get.json @@ -0,0 +1,35 @@ +{ + "operationId": "Services_Get", + "title": "Services_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_ListByResourceGroup.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_ListByResourceGroup.json new file mode 100644 index 000000000000..c509c8214fb6 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_ListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "operationId": "Services_ListByResourceGroup", + "title": "Services_ListByResourceGroup", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_ListBySubscription.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_ListBySubscription.json new file mode 100644 index 000000000000..35f67f89ba95 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_ListBySubscription.json @@ -0,0 +1,38 @@ +{ + "operationId": "Services_ListBySubscription", + "title": "Services_ListBySubscription", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_Update.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_Update.json new file mode 100644 index 000000000000..c064e4d68da6 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Services_Update.json @@ -0,0 +1,44 @@ +{ + "operationId": "Services_Update", + "title": "Services_Update", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-03-01", + "payload": { + "tags": {}, + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_CreateOrUpdate.json new file mode 100644 index 000000000000..f7e35e537e39 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_CreateOrUpdate.json @@ -0,0 +1,46 @@ +{ + "operationId": "Workspaces_CreateOrUpdate", + "title": "Workspaces_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-03-01", + "payload": { + "properties": { + "title": "default" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default", + "name": "default", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "default" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default", + "name": "default", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "default" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_Delete.json new file mode 100644 index 000000000000..afb270cd6edc --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_Delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "Workspaces_Delete", + "title": "Workspaces_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-03-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_Get.json new file mode 100644 index 000000000000..8a5add4654db --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_Get.json @@ -0,0 +1,27 @@ +{ + "operationId": "Workspaces_Get", + "title": "Workspaces_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default", + "name": "default", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "default" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_Head.json new file mode 100644 index 000000000000..966502982e9b --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_Head.json @@ -0,0 +1,18 @@ +{ + "operationId": "Workspaces_Head", + "title": "Workspaces_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_List.json new file mode 100644 index 000000000000..5994737e7781 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-03-01/Workspaces_List.json @@ -0,0 +1,30 @@ +{ + "operationId": "Workspaces_List", + "title": "Workspaces_ListByService", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default", + "name": "default", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "default" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/main.tsp b/specification/apicenter/ApiCenter.Management/main.tsp new file mode 100644 index 000000000000..1bd14878ed13 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/main.tsp @@ -0,0 +1,211 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "./models.tsp"; +import "./Service.tsp"; +import "./MetadataSchema.tsp"; +import "./Workspace.tsp"; +import "./Api.tsp"; +import "./ApiVersion.tsp"; +import "./ApiDefinition.tsp"; +import "./Deployment.tsp"; +import "./Environment.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; +@armProviderNamespace +@service({ + title: "Azure API Center", +}) +@versioned(Versions) +@doc("Azure API Center Resource Provider.") +@Azure.ResourceManager.armCommonTypesVersion("v5") +namespace Microsoft.ApiCenter; + +@doc("The available API versions.") +enum Versions { + /** The initial service version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_03_01: "2024-03-01", +} + +@@projectedName(Apis.createOrUpdate::parameters.resource, "json", "payload"); +@@projectedName(Apis.createOrUpdate::parameters.resource, "client", "payload"); + +@@projectedName(ApiDefinitions.createOrUpdate::parameters.resource, + "json", + "payload" +); +@@projectedName(ApiDefinitions.createOrUpdate::parameters.resource, + "client", + "payload" +); + +@@projectedName(ApiVersions.createOrUpdate::parameters.resource, + "json", + "payload" +); +@@projectedName(ApiVersions.createOrUpdate::parameters.resource, + "client", + "payload" +); + +@@projectedName(Deployments.createOrUpdate::parameters.resource, + "json", + "payload" +); +@@projectedName(Deployments.createOrUpdate::parameters.resource, + "client", + "payload" +); + +@@projectedName(Environments.createOrUpdate::parameters.resource, + "json", + "payload" +); +@@projectedName(Environments.createOrUpdate::parameters.resource, + "client", + "payload" +); + +@@projectedName(MetadataSchemas.createOrUpdate::parameters.resource, + "json", + "payload" +); +@@projectedName(MetadataSchemas.createOrUpdate::parameters.resource, + "client", + "payload" +); + +@@projectedName(Services.update::parameters.properties, "json", "payload"); +@@projectedName(Services.update::parameters.properties, "client", "payload"); + +@@projectedName(Workspaces.createOrUpdate::parameters.resource, + "json", + "payload" +); +@@projectedName(Workspaces.createOrUpdate::parameters.resource, + "client", + "payload" +); + +@@projectedName(ApiDefinitions.importSpecification::parameters.body, + "json", + "payload" +); + +@@projectedName(ApiDefinitions.importSpecification::parameters.body, + "client", + "payload" +); + +@@projectedName(ApiDefinitions.exportSpecification::parameters.body, + "json", + "payload" +); + +@@projectedName(ApiDefinitions.exportSpecification::parameters.body, + "client", + "payload" +); + +@@projectedName(Services.exportMetadataSchema::parameters.body, + "json", + "payload" +); + +@@projectedName(Services.exportMetadataSchema::parameters.body, + "client", + "payload" +); + +@@visibility(Azure.Core.Page.nextLink, "read"); +@@visibility(Azure.Core.Page.value, "read"); +/** + * A resource list operation, at the scope of the resource's parent + * @template TResource the resource being patched + * @template TBaseParameters Optional. Allows overriding the operation parameters + * @template TParentName Optional. The name of the parent resource + * @template TParentFriendlyName Optional. The friendly name of the parent resource + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "Template" +#suppress "@azure-tools/typespec-azure-core/casing-style" "It is pascal case" +@get +@autoRoute +@listsResource(TResource) +@segmentOf(TResource) +@armResourceList(TResource) +op ArmResourceListByParent< + TResource extends ArmResource, + TBaseParameters = BaseParameters, + TParentName extends valueof string = "", + TParentFriendlyName extends valueof string = "" +>( + ...ResourceParentParameters, + ...OdataFilterParameter, +): ArmResponse> | ErrorResponse; + +/** + * A resource GET operation + * @template TResource the resource being patched + * @template TBaseParameters Optional. Allows overriding the operation parameters + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "Template" +#suppress "@azure-tools/typespec-azure-core/casing-style" "It is pascal case" +@autoRoute +@doc("Get a {name}", TResource) +@get +@armResourceRead(TResource) +op ArmResourceRead< + TResource extends ArmResource, + TBaseParameters = BaseParameters +>( + ...ResourceInstanceParameters, +): ArmResponseWithEtag | ErrorResponse; + +/** + * Synchronous PUT operation for ARM resources + * @template TResource the resource being patched + * @template TBaseParameters Optional. Allows overriding the operation parameters + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "Template" +#suppress "@azure-tools/typespec-azure-core/casing-style" "It is pascal case" +@autoRoute +@doc("Create a {name}", TResource) +@armResourceCreateOrUpdate(TResource) +@put +op ArmResourceCreateOrReplaceSync< + TResource extends ArmResource, + TBaseParameters = BaseParameters +>( + ...ResourceInstanceParameters, + + @doc("Resource create parameters.") + @body + resource: TResource, +): ArmResourceUpdatedResponseWithEtag | ArmResourceCreatedSyncResponseWithEtag | ErrorResponse; + +@doc("Resource '{name}' create operation succeeded", TResource) +model ArmResourceCreatedSyncResponseWithEtag + is Body { + ...CreatedResponse; + ...Azure.Core.EtagResponseEnvelope; +} + +@doc("Resource '{name}' update operation succeeded", TResource) +model ArmResourceUpdatedResponseWithEtag + is ArmResponseWithEtag; + +@doc("Azure operation completed successfully.") +model ArmResponseWithEtag { + ...OkResponse; + ...Azure.Core.EtagResponseEnvelope; + ...Body; +} diff --git a/specification/apicenter/ApiCenter.Management/models.tsp b/specification/apicenter/ApiCenter.Management/models.tsp new file mode 100644 index 000000000000..275f7e23859a --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/models.tsp @@ -0,0 +1,537 @@ +import "@typespec/rest"; +import "@typespec/http"; + +using TypeSpec.Rest; +using TypeSpec.Http; + +namespace Microsoft.ApiCenter; + +interface Operations extends Azure.ResourceManager.Operations {} + +@doc("The odata filter") +model OdataFilterParameter { + @doc("OData filter parameter.") + @query("$filter") + filter?: string; +} + +/** The expected types of origin */ +union Origin { + string, + + /** Origin with User */ + "user", + + /** Origin with System */ + "system", + + /** Origin with user and system */ + "user,system", +} + +/** The type of action */ +union ActionType { + string, + + /** an internal action */ + "Internal", +} + +/** The provisioning state of the resource */ +union ProvisioningState { + string, + Azure.ResourceManager.ResourceProvisioningState, +} + +/** The type of managed service identity */ +union ManagedServiceIdentityType { + string, + + /** No identity */ + "None", + + /** Assigned by the system */ + "SystemAssigned", + + /** assigned by the user */ + "UserAssigned", + + /** Both system-assigned and user-assigned identities */ + "SystemAssigned,UserAssigned", +} + +/** How the resource was created */ +union CreatedByType { + string, + + /** Created by user */ + "User", + + /** Created by Application */ + "Application", + + /** Created by Managed Identity */ + "ManagedIdentity", + + /** Created By Key */ + "Key", +} + +/** Assignment entity for Metadata */ +union MetadataAssignmentEntity { + string, + + /** Assigned to API */ + "api", + + /** Assigned to Environment */ + "environment", + + /** Assigned to Deployment */ + "deployment", +} + +/** The format for schema export */ +union MetadataSchemaExportFormat { + string, + + @doc("The inlined content of a schema document.") + "inline", + + @doc("The link to a schema document. The URL is valid for 5 minutes.") + "link", +} + +/** The kind of the API */ +union ApiKind { + string, + + /** A Representational State Transfer Api */ + "rest", + + /** A Graph query language Api */ + "graphql", + + /** A gRPC Api */ + "grpc", + + /** A SOAP Api */ + "soap", + + /** Web Hook */ + "webhook", + + /** Web Socket */ + "websocket", +} + +/** The stage of the Api development lifecycle */ +union LifecycleStage { + string, + + /** design stage */ + "design", + + /** development stage */ + "development", + + /** testing stage */ + "testing", + + /** In preview */ + "preview", + + /** In production */ + "production", + + /** deprecated stage */ + "deprecated", + + /** Retired stage */ + "retired", +} + +/** Source format for imported Api spec */ +union ApiSpecImportSourceFormat { + string, + @doc("The inlined content of a specification document.") "inline", + + @doc(""" +The link to a specification document hosted on a publicly accessible internet +address. +""") + "link", +} + +/** Result format for exported Api spec */ +union ApiSpecExportResultFormat { + string, + @doc("The inlined content of a specification document.") "inline", + + @doc("The link to the result of the export operation. The URL is valid for 5 minutes.") + "link", +} + +/** State of the Deployment */ +union DeploymentState { + string, + + /** Active State */ + "active", + + /** Inactive State */ + "inactive", +} + +/** The kind of environment */ +union EnvironmentKind { + string, + + /** Development environment */ + "development", + + /** Testing environment */ + "testing", + + /** Staging environment */ + "staging", + + /** Production environment */ + "production", +} + +/** The type of environment server */ +union EnvironmentServerType { + string, + + /** Api Management Server */ + "Azure API Management", + + /** Compute server */ + "Azure compute service", + + /** Apigee server */ + "Apigee API Management", + + /** AWS Api Gateway server */ + "AWS API Gateway", + + /** Kong API Gateway server */ + "Kong API Gateway", + + /** Kubernetes server */ + "Kubernetes", + + /** Mulesoft Api Management server */ + "MuleSoft API Management", +} + +@doc("The properties of the service.") +model ServiceProperties { + @doc("Provisioning state of the service.") + @visibility("read") + provisioningState?: ProvisioningState; +} + +@doc("The metadata schema export request.") +model MetadataSchemaExportRequest { + @doc("An entity the metadata schema is requested for.") + assignedTo?: MetadataAssignmentEntity; +} + +@doc("The metadata schema export result.") +model MetadataSchemaExportResult { + @doc("The export format for the schema") + format?: MetadataSchemaExportFormat; + + @doc("The result of the export operation.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Existing service" +@doc("Metadata schema properties.") +model MetadataSchemaProperties { + @doc("The schema defining the type.") + schema: string; + + @doc("The assignees") + assignedTo?: MetadataAssignment[]; +} + +@doc("Assignment metadata") +model MetadataAssignment { + @doc("The entities this metadata schema component gets applied to.") + entity?: MetadataAssignmentEntity; + + @doc("Required assignment") + required?: boolean; + + @doc("Deprecated assignment") + deprecated?: boolean; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Existing service" +@doc("Workspace properties.") +model WorkspaceProperties { + @doc("Workspace title.") + @maxLength(50) + @minLength(1) + title: string; + + @doc("Workspace description.") + description?: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Existing service" +@doc("API properties.") +model ApiProperties { + @doc("API title.") + @maxLength(50) + @minLength(1) + title: string; + + @doc("Kind of API. For example, REST or GraphQL.") + kind: ApiKind; + + @doc("Description of the API.") + @maxLength(1000) + description?: string; + + @doc("Short description of the API.") + @maxLength(200) + summary?: string; + + @doc("Current lifecycle stage of the API.") + @visibility("read") + lifecycleStage?: LifecycleStage; + + @doc("Terms of service for the API.") + termsOfService?: TermsOfService; + + @doc("The set of external documentation") + @maxItems(20) + externalDocumentation?: ExternalDocumentation[]; + + @doc("The set of contacts") + contacts?: Contact[]; + + @doc("The license information for the API.") + license?: License; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Existing spec" + @doc("The custom metadata defined for API catalog entities.") + customProperties?: CustomProperties; +} + +@doc("Terms of service for the API.") +model TermsOfService { + @doc("URL pointing to the terms of service.") + @maxLength(200) + url: url; +} + +@doc("Additional, external documentation for the API.") +model ExternalDocumentation { + @doc("Title of the documentation.") + @maxLength(50) + title?: string; + + @doc("Description of the documentation.") + @maxLength(500) + description?: string; + + @doc("URL pointing to the documentation.") + @maxLength(200) + url: url; +} + +@doc("Contact information") +model Contact { + @doc("Name of the contact.") + @maxLength(100) + name?: string; + + @doc("URL for the contact.") + @maxLength(200) + url?: url; + + @doc("Email address of the contact.") + @maxLength(100) + email?: string; +} + +@doc("The license information for the API.") +model License { + @doc("Name of the license.") + @maxLength(100) + name?: string; + + @doc(""" +URL pointing to the license details. The URL field is mutually exclusive of the +identifier field. +""") + @maxLength(200) + url?: url; + + @doc(""" +SPDX license information for the API. The identifier field is mutually +exclusive of the URL field. +""") + @maxLength(50) + identifier?: url; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Existing service" +@doc("API version properties entity.") +model ApiVersionProperties { + @doc("API version title.") + @maxLength(50) + @minLength(1) + title: string; + + @doc("Current lifecycle stage of the API.") + lifecycleStage: LifecycleStage; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Existing service" +@doc("API definition properties entity.") +model ApiDefinitionProperties { + @doc("API definition title.") + @maxLength(50) + @minLength(1) + title: string; + + @doc("API definition description.") + description?: string; + + @doc("API specification details.") + @visibility("read") + specification?: ApiDefinitionPropertiesSpecification; +} + +@doc("API specification details.") +model ApiDefinitionPropertiesSpecification { + @doc("Specification name.") + name?: string; + + @doc("Specification version.") + version?: string; +} + +@doc("The API specification source entity properties.") +model ApiSpecImportRequest { + @doc("Value of the API specification source.") + value?: string; + + @doc("Format of the API specification source.") + format?: ApiSpecImportSourceFormat; + + @doc("API specification details.") + specification?: ApiSpecImportRequestSpecification; +} + +@doc("API specification details.") +model ApiSpecImportRequestSpecification { + @doc("Specification name.") + name?: string; + + @doc("Specification version.") + version?: string; +} + +@doc("The API specification export result.") +model ApiSpecExportResult { + @doc("The format of exported result") + format?: ApiSpecExportResultFormat; + + @doc("The result of the export operation.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Existing service" +@doc("API deployment entity properties.") +model DeploymentProperties { + @doc("API deployment title") + @maxLength(50) + @minLength(1) + title?: string; + + @doc("Description of the deployment.") + @maxLength(500) + description?: string; + + @doc("API center-scoped environment resource ID.") + environmentId?: string; + + @doc("API center-scoped definition resource ID.") + definitionId?: string; + + @doc("State of API deployment.") + state?: DeploymentState; + + @doc("The deployment server") + server?: DeploymentServer; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Existing spec" + @doc("The custom metadata defined for API catalog entities.") + customProperties?: CustomProperties; +} + +@summary("Custom Properties") +@doc("The custom metadata defined for API catalog entities.") +model CustomProperties {} + +@doc("Server") +model DeploymentServer { + @doc("Base runtime URLs for this deployment.") + runtimeUri?: SmallString[]; +} + +/** Used for restricted length uris */ +@maxLength(200) +scalar SmallString extends url; + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Existing service" +@doc("Environment properties entity.") +model EnvironmentProperties { + @doc("Environment title.") + @maxLength(50) + @minLength(1) + title: string; + + @doc("The environment description.") + description?: string; + + @doc("Environment kind.") + kind: EnvironmentKind; + + @doc("Server information of the environment.") + server?: EnvironmentServer; + + @doc("Environment onboarding information") + onboarding?: Onboarding; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Existing spec" + @doc("The custom metadata defined for API catalog entities.") + customProperties?: CustomProperties; +} + +@doc("Server information of the environment.") +model EnvironmentServer { + @doc("Type of the server that represents the environment.") + type?: EnvironmentServerType; + + @maxItems(1) + @doc("The location of the management portal") + managementPortalUri?: string[]; +} + +@doc("Onboarding information") +model Onboarding { + @doc("Onboarding guide.") + instructions?: string; + + @maxItems(1) + @doc("The location of the development portal") + developerPortalUri?: string[]; +} diff --git a/specification/apicenter/ApiCenter.Management/tspconfig.yaml b/specification/apicenter/ApiCenter.Management/tspconfig.yaml new file mode 100644 index 000000000000..465166051c62 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/tspconfig.yaml @@ -0,0 +1,12 @@ +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/apicenter.json" + examples-directory: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-resource-manager/all" diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/apicenter.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/apicenter.json index 63ec11796cf6..84558195d679 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/apicenter.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/apicenter.json @@ -3,7 +3,12 @@ "info": { "title": "Azure API Center", "version": "2024-03-01", - "description": "Azure API Center Resource Provider." + "description": "Azure API Center Resource Provider.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] }, "schemes": [ "https" @@ -35,47 +40,41 @@ }, "tags": [ { - "name": "Provider" + "name": "Operations" }, { "name": "Services" }, { - "name": "Environment" + "name": "MetadataSchemas" }, { - "name": "MetadataSchema" + "name": "Workspaces" }, { - "name": "Workspace" + "name": "Apis" }, { - "name": "Api" + "name": "ApiVersions" }, { - "name": "ApiVersion" + "name": "ApiDefinitions" }, { - "name": "ApiDefinition" + "name": "Deployments" }, { - "name": "Deployment" + "name": "Environments" } ], "paths": { "/providers/Microsoft.ApiCenter/operations": { "get": { + "operationId": "Operations_List", "tags": [ - "Provider" + "Operations" ], - "operationId": "Operations_List", - "summary": "List resource provider operations", - "description": "Returns a collection of resource provider operations.", - "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" - } - }, + "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" @@ -83,7 +82,7 @@ ], "responses": { "200": { - "description": "Operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } @@ -95,6 +94,11 @@ } } }, + "x-ms-examples": { + "List Provider Operations": { + "$ref": "./examples/Operations_List.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -102,16 +106,11 @@ }, "/subscriptions/{subscriptionId}/providers/Microsoft.ApiCenter/services": { "get": { + "operationId": "Services_ListBySubscription", "tags": [ - "Service" + "Services" ], - "operationId": "Services_ListBySubscription", "description": "Lists services within an Azure subscription.", - "x-ms-examples": { - "Services_ListBySubscription": { - "$ref": "./examples/Services_ListBySubscription.json" - } - }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" @@ -122,18 +121,23 @@ ], "responses": { "200": { - "description": "The service list.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/ServiceCollection" + "$ref": "#/definitions/ServiceListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "Services_ListBySubscription": { + "$ref": "./examples/Services_ListBySubscription.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -141,16 +145,11 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services": { "get": { + "operationId": "Services_ListByResourceGroup", "tags": [ "Services" ], - "operationId": "Services_ListByResourceGroup", "description": "Returns a collection of services within the resource group.", - "x-ms-examples": { - "Services_ListByResourceGroup": { - "$ref": "./examples/Services_ListByResourceGroup.json" - } - }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" @@ -164,9 +163,9 @@ ], "responses": { "200": { - "description": "Operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/ServiceCollection" + "$ref": "#/definitions/ServiceListResult" } }, "default": { @@ -176,6 +175,11 @@ } } }, + "x-ms-examples": { + "Services_ListByResourceGroup": { + "$ref": "./examples/Services_ListByResourceGroup.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -183,17 +187,11 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}": { "get": { + "operationId": "Services_Get", "tags": [ "Services" ], - "operationId": "Services_Get", - "summary": "Get service", "description": "Returns details of the service.", - "x-ms-examples": { - "Services_Get": { - "$ref": "./examples/Services_Get.json" - } - }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" @@ -205,12 +203,19 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ServiceNameParameter" + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { - "description": "Operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Service" } @@ -221,20 +226,19 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Services_Get": { + "$ref": "./examples/Services_Get.json" + } } }, "put": { + "operationId": "Services_CreateOrUpdate", "tags": [ "Services" ], - "operationId": "Services_CreateOrUpdate", - "summary": "Create or update service", "description": "Creates new or updates existing API.", - "x-ms-examples": { - "Services_Create": { - "$ref": "./examples/Services_CreateOrUpdate.json" - } - }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" @@ -246,12 +250,20 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ServiceNameParameter" + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { - "name": "payload", + "name": "resource", "in": "body", - "description": "The service entity.", + "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/Service" } @@ -259,13 +271,13 @@ ], "responses": { "200": { - "description": "The service was successfully updated.", + "description": "Resource 'Service' update operation succeeded", "schema": { "$ref": "#/definitions/Service" } }, "201": { - "description": "The service was successfully created.", + "description": "Resource 'Service' create operation succeeded", "schema": { "$ref": "#/definitions/Service" } @@ -276,20 +288,19 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Services_CreateOrUpdate": { + "$ref": "./examples/Services_CreateOrUpdate.json" + } } }, "patch": { + "operationId": "Services_Update", "tags": [ "Services" ], - "operationId": "Services_Update", - "summary": "Update service", "description": "Updates existing service.", - "x-ms-examples": { - "Services_Update": { - "$ref": "./examples/Services_Update.json" - } - }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" @@ -301,20 +312,29 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ServiceNameParameter" + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "payload", "in": "body", - "description": "The service properties to be updated.", + "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/ServiceUpdate" - } + }, + "x-ms-client-name": "properties" } ], "responses": { "200": { - "description": "The service was successfully updated.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Service" } @@ -325,20 +345,19 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Services_Update": { + "$ref": "./examples/Services_Update.json" + } } }, "delete": { + "operationId": "Services_Delete", "tags": [ "Services" ], - "operationId": "Services_Delete", - "summary": "Delete service", "description": "Deletes specified service.", - "x-ms-examples": { - "Services_Delete": { - "$ref": "./examples/Services_Delete.json" - } - }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" @@ -350,15 +369,22 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ServiceNameParameter" + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { - "description": "The service was successfully deleted." + "description": "Resource deleted successfully." }, "204": { - "description": "The service was successfully deleted." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -366,54 +392,75 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Services_Delete": { + "$ref": "./examples/Services_Delete.json" + } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/exportMetadataSchema": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], "post": { + "operationId": "Services_ExportMetadataSchema", "tags": [ - "MetadataSchema" + "Services" ], - "operationId": "Services_ExportMetadataSchema", - "summary": "Export effective metadata schema", "description": "Exports the effective metadata schema.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, { "name": "payload", "in": "body", + "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/MetadataSchemaExportRequest" }, - "description": "The metadata schema request details." + "x-ms-client-name": "body" } ], "responses": { "200": { - "description": "The result of export operation.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MetadataSchemaExportResult" } }, "202": { - "description": "Request to export the metadata schema was accepted. The 'Location' response header contains the URL where the status of the long running operation can be checked." + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -423,50 +470,60 @@ "Services_ExportMetadataSchema": { "$ref": "./examples/Services_ExportMetadataSchema.json" } - } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/metadataSchemas": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ODataFilterParameter" - } - ], "get": { + "operationId": "MetadataSchemas_List", "tags": [ - "MetadataSchema" + "MetadataSchemas" ], - "operationId": "MetadataSchemas_List", - "summary": "List metadata schemas", "description": "Returns a collection of metadata schemas.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } + ], "responses": { "200": { - "description": "Paginated collection of metadata schemas.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/MetadataSchemaCollection" + "$ref": "#/definitions/MetadataSchemaListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "MetadataSchemas_List": { + "MetadataSchemas_ListByService": { "$ref": "./examples/MetadataSchemas_List.json" } }, @@ -476,45 +533,58 @@ } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/metadataSchemas/{metadataSchemaName}": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/MetadataSchemaNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], "get": { "operationId": "MetadataSchemas_Get", - "summary": "Get metadata schema", - "description": "Returns details of the metadata schema.", "tags": [ - "MetadataSchema" + "MetadataSchemas" + ], + "description": "Returns details of the metadata schema.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "metadataSchemaName", + "in": "path", + "description": "The name of the metadata schema.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } ], "responses": { "200": { - "description": "The response body contains the metadata schema entity.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MetadataSchema" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -527,50 +597,79 @@ } }, "put": { + "operationId": "MetadataSchemas_CreateOrUpdate", "tags": [ - "MetadataSchema" + "MetadataSchemas" ], - "operationId": "MetadataSchemas_CreateOrUpdate", - "summary": "Create or update metadata schema", "description": "Creates new or updates existing metadata schema.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "metadataSchemaName", + "in": "path", + "description": "The name of the metadata schema.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, { "name": "payload", "in": "body", + "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/MetadataSchema" }, - "description": "Metadata schema entity." + "x-ms-client-name": "resource" } ], "responses": { "200": { - "description": "Metadata schema was successfully updated.", + "description": "Resource 'MetadataSchema' update operation succeeded", "schema": { "$ref": "#/definitions/MetadataSchema" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "201": { - "description": "Metadata schema was successfully created.", + "description": "Resource 'MetadataSchema' create operation succeeded", "schema": { "$ref": "#/definitions/MetadataSchema" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -583,21 +682,51 @@ } }, "delete": { + "operationId": "MetadataSchemas_Delete", "tags": [ - "MetadataSchema" + "MetadataSchemas" ], - "operationId": "MetadataSchemas_Delete", - "summary": "Delete metadata schema", "description": "Deletes specified metadata schema.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "metadataSchemaName", + "in": "path", + "description": "The name of the metadata schema.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], "responses": { "200": { - "description": "The metadata schema was successfully deleted." + "description": "Resource deleted successfully." }, "204": { - "description": "The metadata schema was successfully deleted." + "description": "Resource does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -610,15 +739,45 @@ } }, "head": { + "operationId": "MetadataSchemas_Head", "tags": [ - "MetadataSchema" + "MetadataSchemas" ], - "operationId": "MetadataSchemas_Head", - "summary": "Check if metadata schema exists", "description": "Checks if specified metadata schema exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "metadataSchemaName", + "in": "path", + "description": "The name of the metadata schema.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], "responses": { "200": { - "description": "OK" + "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", @@ -636,93 +795,112 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces": { "get": { + "operationId": "Workspaces_List", "tags": [ - "Workspace" + "Workspaces" ], - "operationId": "Workspaces_List", - "summary": "List workspaces", "description": "Returns a collection of workspaces.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } + ], "responses": { "200": { - "description": "Paginated collection of workspaces.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkspaceCollection" + "$ref": "#/definitions/WorkspaceListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Workspaces_List": { + "Workspaces_ListByService": { "$ref": "./examples/Workspaces_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ODataFilterParameter" - } - ] + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], "get": { "operationId": "Workspaces_Get", - "summary": "Get workspace", - "description": "Returns details of the workspace.", "tags": [ - "Workspace" + "Workspaces" + ], + "description": "Returns details of the workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } ], "responses": { "200": { - "description": "The response body contains the workspace entity.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Workspace" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -735,77 +913,136 @@ } }, "put": { + "operationId": "Workspaces_CreateOrUpdate", "tags": [ - "Workspace" + "Workspaces" ], - "operationId": "Workspaces_CreateOrUpdate", - "summary": "Create or update workspace", "description": "Creates new or updates existing workspace.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, { "name": "payload", "in": "body", + "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Workspace" }, - "description": "Workspace entity." + "x-ms-client-name": "resource" } ], "responses": { "200": { - "description": "The workspace was successfully updated.", + "description": "Resource 'Workspace' update operation succeeded", "schema": { "$ref": "#/definitions/Workspace" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "201": { - "description": "The workspace was successfully created.", + "description": "Resource 'Workspace' create operation succeeded", "schema": { "$ref": "#/definitions/Workspace" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Workspace_CreateOrUpdate": { + "Workspaces_CreateOrUpdate": { "$ref": "./examples/Workspaces_CreateOrUpdate.json" } } }, "delete": { + "operationId": "Workspaces_Delete", "tags": [ - "Workspace" + "Workspaces" ], - "operationId": "Workspaces_Delete", - "summary": "Delete workspace", "description": "Deletes specified workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], "responses": { "200": { - "description": "The workspace was successfully deleted." + "description": "Resource deleted successfully." }, "204": { - "description": "The workspace was successfully deleted." + "description": "Resource does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -818,15 +1055,45 @@ } }, "head": { + "operationId": "Workspaces_Head", "tags": [ - "Workspace" + "Workspaces" ], - "operationId": "Workspaces_Head", - "summary": "Check if workspace exists", "description": "Checks if specified workspace exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], "responses": { "200": { - "description": "OK" + "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", @@ -844,48 +1111,61 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis": { "get": { + "operationId": "Apis_List", "tags": [ - "Api" + "Apis" ], - "operationId": "Apis_List", - "summary": "List APIs", "description": "Returns a collection of APIs.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ServiceNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { - "$ref": "#/parameters/ODataFilterParameter" + "$ref": "#/parameters/OdataFilterParameter" } ], "responses": { "200": { - "description": "Paginated collection of APIs.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/ApiCollection" + "$ref": "#/definitions/ApiListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Apis_List": { + "Apis_ListByWorkspace": { "$ref": "./examples/Apis_List.json" } }, @@ -895,48 +1175,68 @@ } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ApiNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], "get": { "operationId": "Apis_Get", - "summary": "Get API", - "description": "Returns details of the API.", "tags": [ - "Api" + "Apis" + ], + "description": "Returns details of the API.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } ], "responses": { "200": { - "description": "The response body contains the API entity.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Api" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -949,50 +1249,89 @@ } }, "put": { + "operationId": "Apis_CreateOrUpdate", "tags": [ - "Api" + "Apis" ], - "operationId": "Apis_CreateOrUpdate", - "summary": "Create or update API", "description": "Creates new or updates existing API.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, { "name": "payload", "in": "body", + "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Api" }, - "description": "API entity." + "x-ms-client-name": "resource" } ], "responses": { "200": { - "description": "API was successfully updated.", + "description": "Resource 'Api' update operation succeeded", "schema": { "$ref": "#/definitions/Api" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "201": { - "description": "API was successfully created.", + "description": "Resource 'Api' create operation succeeded", "schema": { "$ref": "#/definitions/Api" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -1005,21 +1344,61 @@ } }, "delete": { + "operationId": "Apis_Delete", "tags": [ - "Api" + "Apis" ], - "operationId": "Apis_Delete", - "summary": "Delete API", "description": "Deletes specified API.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], "responses": { "200": { - "description": "The API was successfully deleted." + "description": "Resource deleted successfully." }, "204": { - "description": "The API was successfully deleted." + "description": "Resource does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -1032,15 +1411,55 @@ } }, "head": { + "operationId": "Apis_Head", "tags": [ - "Api" + "Apis" ], - "operationId": "Apis_Head", - "summary": "Check if API exists", "description": "Checks if specified API exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], "responses": { "200": { - "description": "OK" + "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", @@ -1056,54 +1475,74 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ApiNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ODataFilterParameter" - } - ], + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments": { "get": { + "operationId": "Deployments_List", "tags": [ - "ApiVersion" + "Deployments" + ], + "description": "Returns a collection of API deployments.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } ], - "operationId": "ApiVersions_List", - "summary": "List API versions", - "description": "Returns a collection of API versions.", "responses": { "200": { - "description": "Paginated collection of API versions.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/ApiVersionCollection" + "$ref": "#/definitions/DeploymentListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "ApiVersions_List": { - "$ref": "./examples/ApiVersions_List.json" + "Deployments_ListByApi": { + "$ref": "./examples/Deployments_List.json" } }, "x-ms-pageable": { @@ -1111,156 +1550,332 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ApiNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}": { "get": { + "operationId": "Deployments_Get", "tags": [ - "ApiVersion" + "Deployments" + ], + "description": "Returns details of the API deployment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the API deployment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } ], - "summary": "Get API version", - "operationId": "ApiVersions_Get", - "description": "Returns details of the API version.", "responses": { "200": { - "description": "The response body contains the API version entity.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/ApiVersion" + "$ref": "#/definitions/Deployment" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "ApiVersions_Get": { - "$ref": "./examples/ApiVersions_Get.json" + "Deployments_Get": { + "$ref": "./examples/Deployments_Get.json" } } }, "put": { + "operationId": "Deployments_CreateOrUpdate", "tags": [ - "ApiVersion" + "Deployments" ], - "summary": "Create or update API version", - "operationId": "ApiVersions_CreateOrUpdate", - "description": "Creates new or updates existing API version.", + "description": "Creates new or updates existing API deployment.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the API deployment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, { "name": "payload", "in": "body", + "description": "Resource create parameters.", "required": true, "schema": { - "$ref": "#/definitions/ApiVersion" + "$ref": "#/definitions/Deployment" }, - "description": "API version entity." + "x-ms-client-name": "resource" } ], "responses": { "200": { - "description": "API version was successfully updated.", + "description": "Resource 'Deployment' update operation succeeded", "schema": { - "$ref": "#/definitions/ApiVersion" + "$ref": "#/definitions/Deployment" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "201": { - "description": "API version was successfully created.", + "description": "Resource 'Deployment' create operation succeeded", "schema": { - "$ref": "#/definitions/ApiVersion" + "$ref": "#/definitions/Deployment" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "ApiVersions_CreateOrUpdate": { - "$ref": "./examples/ApiVersions_CreateOrUpdate.json" + "Deployments_CreateOrUpdate": { + "$ref": "./examples/Deployments_CreateOrUpdate.json" } } }, "delete": { + "operationId": "Deployments_Delete", "tags": [ - "ApiVersion" + "Deployments" + ], + "description": "Deletes API deployment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the API deployment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } ], - "summary": "Delete API version", - "operationId": "ApiVersions_Delete", - "description": "Deletes specified API version", "responses": { "200": { - "description": "The API version was successfully deleted." + "description": "Resource deleted successfully." }, "204": { - "description": "The API version was successfully deleted." + "description": "Resource does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "ApiVersions_Delete": { - "$ref": "./examples/ApiVersions_Delete.json" + "Deployments_Delete": { + "$ref": "./examples/Deployments_Delete.json" } } }, "head": { + "operationId": "Deployments_Head", "tags": [ - "ApiVersion" + "Deployments" + ], + "description": "Checks if specified API deployment exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the API deployment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } ], - "summary": "Check if API version exists", - "operationId": "ApiVersions_Head", - "description": "Checks if specified API version exists.", "responses": { "200": { - "description": "OK" + "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", @@ -1270,223 +1885,413 @@ } }, "x-ms-examples": { - "ApiVersions_Head": { - "$ref": "./examples/ApiVersions_Head.json" + "Deployments_Head": { + "$ref": "./examples/Deployments_Head.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ApiNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ODataFilterParameter" - } - ], + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions": { "get": { + "operationId": "ApiVersions_List", "tags": [ - "ApiDefinition" + "ApiVersions" ], - "operationId": "ApiDefinitions_List", - "summary": "List API definitions", - "description": "Returns a collection of API definitions.", - "responses": { - "200": { - "description": "Paginated collection of API definitions.", - "schema": { - "$ref": "#/definitions/ApiDefinitionCollection" - } + "description": "Returns a collection of API versions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ApiDefinitions_List": { - "$ref": "./examples/ApiDefinitions_List.json" - } - }, - "x-ms-pageable": { + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiVersions_ListByApi": { + "$ref": "./examples/ApiVersions_List.json" + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ApiNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionNameParameter" - }, - { - "$ref": "#/parameters/ApiDefinitionNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}": { "get": { + "operationId": "ApiVersions_Get", "tags": [ - "ApiDefinition" + "ApiVersions" + ], + "description": "Returns details of the API version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } ], - "summary": "Get API definition", - "operationId": "ApiDefinitions_Get", - "description": "Returns details of the API definition.", "responses": { "200": { - "description": "The response body contains the API definition entity.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/ApiDefinition" + "$ref": "#/definitions/ApiVersion" }, "headers": { "ETag": { - "description": "Current entity state definition. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "ApiDefinitions_Get": { - "$ref": "./examples/ApiDefinitions_Get.json" + "ApiVersions_Get": { + "$ref": "./examples/ApiVersions_Get.json" } } }, "put": { + "operationId": "ApiVersions_CreateOrUpdate", "tags": [ - "ApiDefinition" + "ApiVersions" ], - "operationId": "ApiDefinitions_CreateOrUpdate", - "summary": "Create or update API definition", - "description": "Creates new or updates existing API definition.", + "description": "Creates new or updates existing API version.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, { "name": "payload", "in": "body", + "description": "Resource create parameters.", "required": true, "schema": { - "$ref": "#/definitions/ApiDefinition" + "$ref": "#/definitions/ApiVersion" }, - "description": "API definition entity." + "x-ms-client-name": "resource" } ], "responses": { "200": { - "description": "API definition was successfully updated.", + "description": "Resource 'ApiVersion' update operation succeeded", "schema": { - "$ref": "#/definitions/ApiDefinition" + "$ref": "#/definitions/ApiVersion" }, "headers": { "ETag": { - "description": "Current entity state definition. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "201": { - "description": "API definition was successfully created.", + "description": "Resource 'ApiVersion' create operation succeeded", "schema": { - "$ref": "#/definitions/ApiDefinition" + "$ref": "#/definitions/ApiVersion" }, "headers": { "ETag": { - "description": "Current entity state definition. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "ApiDefinitions_CreateOrUpdate": { - "$ref": "./examples/ApiDefinitions_CreateOrUpdate.json" + "ApiVersions_CreateOrUpdate": { + "$ref": "./examples/ApiVersions_CreateOrUpdate.json" } } }, "delete": { + "operationId": "ApiVersions_Delete", "tags": [ - "ApiDefinition" + "ApiVersions" + ], + "description": "Deletes specified API version", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } ], - "operationId": "ApiDefinitions_Delete", - "summary": "Delete API definition", - "description": "Deletes specified API definition.", "responses": { "200": { - "description": "The API definition was successfully deleted." + "description": "Resource deleted successfully." }, "204": { - "description": "The API definition was successfully deleted." + "description": "Resource does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "ApiDefinitions_Delete": { - "$ref": "./examples/ApiDefinitions_Delete.json" + "ApiVersions_Delete": { + "$ref": "./examples/ApiVersions_Delete.json" } } }, "head": { + "operationId": "ApiVersions_Head", "tags": [ - "ApiDefinition" + "ApiVersions" + ], + "description": "Checks if specified API version exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } ], - "summary": "Check if API definition exists", - "operationId": "ApiDefinitions_Head", - "description": "Checks if specified API definition exists.", "responses": { "200": { - "description": "OK" + "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", @@ -1496,184 +2301,90 @@ } }, "x-ms-examples": { - "ApiDefinitions_Head": { - "$ref": "./examples/ApiDefinitions_Head.json" + "ApiVersions_Head": { + "$ref": "./examples/ApiVersions_Head.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}/importSpecification": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ApiNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionNameParameter" - }, - { - "$ref": "#/parameters/ApiDefinitionNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions": { + "get": { + "operationId": "ApiDefinitions_List", "tags": [ - "ApiVersion" + "ApiDefinitions" ], - "summary": "Import API specification", - "operationId": "ApiDefinitions_ImportSpecification", - "description": "Imports the API specification.", + "description": "Returns a collection of API definitions.", "parameters": [ { - "name": "payload", - "in": "body", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", "required": true, - "schema": { - "$ref": "#/definitions/ApiSpecImportRequest" - }, - "description": "The API specification source entity." - } - ], - "responses": { - "200": { - "description": "The API specification was successfully imported." + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" }, - "202": { - "description": "Request to import an API specification was accepted. The 'Location' response header contains the URL where the status of the long running operation can be checked." + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ApiDefinitions_ImportSpecification": { - "$ref": "./examples/ApiDefinitions_ImportSpecification.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}/exportSpecification": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ApiNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionNameParameter" - }, - { - "$ref": "#/parameters/ApiDefinitionNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "post": { - "tags": [ - "ApiVersion" - ], - "summary": "Export API specification", - "operationId": "ApiDefinitions_ExportSpecification", - "description": "Exports the API specification.", - "responses": { - "200": { - "description": "The result of export operation.", - "schema": { - "$ref": "#/definitions/ApiSpecExportResult" - } + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" }, - "202": { - "description": "Request to export the API specification was accepted. The 'Location' response header contains the URL where the status of the long running operation can be checked." + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ApiDefinitions_ExportSpecification": { - "$ref": "./examples/ApiDefinitions_ExportSpecification.json" + { + "$ref": "#/parameters/OdataFilterParameter" } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ApiNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ODataFilterParameter" - } - ], - "get": { - "tags": [ - "Deployment" ], - "operationId": "Deployments_List", - "summary": "List deployments", - "description": "Returns a collection of API deployments.", "responses": { "200": { - "description": "Paginated collection of API deployments.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/DeploymentCollection" + "$ref": "#/definitions/ApiDefinitionListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Deployments_List": { - "$ref": "./examples/Deployments_List.json" + "ApiDefinitions_ListByApiVersion": { + "$ref": "./examples/ApiDefinitions_List.json" } }, "x-ms-pageable": { @@ -1681,156 +2392,288 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ApiNameParameter" - }, - { - "$ref": "#/parameters/ApiDeploymentNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}": { + "get": { + "operationId": "ApiDefinitions_Get", "tags": [ - "Deployment" + "ApiDefinitions" ], - "summary": "Delete API deployment", - "operationId": "Deployments_Delete", - "description": "Deletes API deployment.", - "responses": { - "200": { - "description": "The API deployment was successfully deleted." + "description": "Returns details of the API definition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, - "204": { - "description": "The API deployment was successfully deleted." + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Deployments_Delete": { - "$ref": "./examples/Deployments_Delete.json" + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "The name of the API definition.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" } - } - }, - "get": { - "tags": [ - "Deployment" ], - "operationId": "Deployments_Get", - "summary": "Get API deployment", - "description": "Returns details of the API deployment.", "responses": { "200": { - "description": "The response body contains the API deployment entity.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/ApiDefinition" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Deployments_Get": { - "$ref": "./examples/Deployments_Get.json" + "ApiDefinitions_Get": { + "$ref": "./examples/ApiDefinitions_Get.json" } } }, "put": { + "operationId": "ApiDefinitions_CreateOrUpdate", "tags": [ - "Deployment" + "ApiDefinitions" ], - "operationId": "Deployments_CreateOrUpdate", - "summary": "Create or update API deployment", - "description": "Creates new or updates existing API deployment.", + "description": "Creates new or updates existing API definition.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "The name of the API definition.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, { "name": "payload", "in": "body", + "description": "Resource create parameters.", "required": true, "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/ApiDefinition" }, - "description": "API deployment entity." + "x-ms-client-name": "resource" } ], "responses": { "200": { - "description": "API deployment was successfully updated.", + "description": "Resource 'ApiDefinition' update operation succeeded", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/ApiDefinition" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "201": { - "description": "API deployment was successfully created.", + "description": "Resource 'ApiDefinition' create operation succeeded", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/ApiDefinition" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Deployments_CreateOrUpdate": { - "$ref": "./examples/Deployments_CreateOrUpdate.json" + "ApiDefinitions_CreateOrUpdate": { + "$ref": "./examples/ApiDefinitions_CreateOrUpdate.json" } } }, - "head": { + "delete": { + "operationId": "ApiDefinitions_Delete", "tags": [ - "Deployment" + "ApiDefinitions" + ], + "description": "Deletes specified API definition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "The name of the API definition.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } ], - "operationId": "Deployments_Head", - "summary": "Check if API deployment exists", - "description": "Checks if specified API deployment exists.", "responses": { "200": { - "description": "OK" + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -1840,130 +2683,540 @@ } }, "x-ms-examples": { - "Deployments_Head": { - "$ref": "./examples/Deployments_Head.json" + "ApiDefinitions_Delete": { + "$ref": "./examples/ApiDefinitions_Delete.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments": { - "get": { + }, + "head": { + "operationId": "ApiDefinitions_Head", "tags": [ - "Environment" + "ApiDefinitions" ], - "operationId": "Environments_List", - "summary": "List environments", - "description": "Returns a collection of environments.", - "responses": { - "200": { - "description": "The response body contains the environment entity.", + "description": "Checks if specified API definition exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "The name of the API definition.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiDefinitions_Head": { + "$ref": "./examples/ApiDefinitions_Head.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}/exportSpecification": { + "post": { + "operationId": "ApiDefinitions_ExportSpecification", + "tags": [ + "ApiDefinitions" + ], + "description": "Exports the API specification.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "The name of the API definition.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/EnvironmentCollection" + "$ref": "#/definitions/ApiSpecExportResult" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Environments_List": { - "$ref": "./examples/Environments_List.json" + "ApiDefinitions_ExportSpecification": { + "$ref": "./examples/ApiDefinitions_ExportSpecification.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "x-ms-long-running-operation-options": { + "final-state-via": "location" }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}/importSpecification": { + "post": { + "operationId": "ApiDefinitions_ImportSpecification", + "tags": [ + "ApiDefinitions" + ], + "description": "Imports the API specification.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "The name of the API definition.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "payload", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApiSpecImportRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "The API specification was successfully imported." + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } }, - { - "$ref": "#/parameters/ServiceNameParameter" + "x-ms-examples": { + "ApiDefinitions_ImportSpecification": { + "$ref": "./examples/ApiDefinitions_ImportSpecification.json" + } }, - { - "$ref": "#/parameters/WorkspaceNameParameter" + "x-ms-long-running-operation-options": { + "final-state-via": "location" }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments": { + "get": { + "operationId": "Environments_List", + "tags": [ + "Environments" + ], + "description": "Returns a collection of environments.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnvironmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } }, - { - "$ref": "#/parameters/ODataFilterParameter" + "x-ms-examples": { + "Environments_ListByWorkspace": { + "$ref": "./examples/Environments_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - ] + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments/{environmentName}": { - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/EnvironmentNameParameter" + "get": { + "operationId": "Environments_Get", + "tags": [ + "Environments" + ], + "description": "Returns details of the environment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Environment" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "x-ms-examples": { + "Environments_Get": { + "$ref": "./examples/Environments_Get.json" + } } - ], + }, "put": { + "operationId": "Environments_CreateOrUpdate", "tags": [ - "Environment" + "Environments" ], - "operationId": "Environments_CreateOrUpdate", - "summary": "Create or update environment", "description": "Creates new or updates existing environment.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, { "name": "payload", "in": "body", + "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Environment" }, - "description": "Environment entity." + "x-ms-client-name": "resource" } ], "responses": { "200": { - "description": "The environment was successfully updated.", + "description": "Resource 'Environment' update operation succeeded", "schema": { "$ref": "#/definitions/Environment" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "201": { - "description": "The environment was successfully created.", + "description": "Resource 'Environment' create operation succeeded", "schema": { "$ref": "#/definitions/Environment" }, "headers": { "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" + "type": "string", + "description": "The entity tag for the response." } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -1976,21 +3229,61 @@ } }, "delete": { + "operationId": "Environments_Delete", "tags": [ - "Environment" + "Environments" ], - "operationId": "Environments_Delete", - "summary": "Delete environment", "description": "Deletes the environment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], "responses": { "200": { - "description": "The environment was successfully deleted." + "description": "Resource deleted successfully." }, "204": { - "description": "The environment was successfully deleted." + "description": "Resource does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -2003,193 +3296,140 @@ } }, "head": { + "operationId": "Environments_Head", "tags": [ - "Environment" + "Environments" ], - "operationId": "Environments_Head", - "summary": "Check if environment exists", "description": "Checks if specified environment exists.", - "responses": { - "200": { - "description": "OK" + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Environments_Head": { - "$ref": "./examples/Environments_Head.json" + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" } - } - }, - "get": { - "tags": [ - "Environment" ], - "operationId": "Environments_Get", - "summary": "Get environment", - "description": "Returns details of the environment.", "responses": { "200": { - "description": "The response body contains the environment entity.", - "schema": { - "$ref": "#/definitions/Environment" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } + "description": "The request has succeeded." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Environments_Get": { - "$ref": "./examples/Environments_Get.json" + "Environments_Head": { + "$ref": "./examples/Environments_Head.json" } } } } }, "definitions": { - "ProvisioningState": { + "ActionType": { "type": "string", - "description": "Provisioning state of the service.", + "description": "The type of action", "enum": [ - "Succeeded", - "Failed", - "Canceled" + "Internal" ], "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - }, - "readOnly": true + "name": "ActionType", + "modelAsString": true, + "values": [ + { + "name": "Internal", + "value": "Internal", + "description": "an internal action" + } + ] + } }, - "Service": { + "Api": { "type": "object", + "description": "API entity.", "properties": { "properties": { - "$ref": "#/definitions/ServiceProperties", - "x-ms-client-flatten": true - }, - "identity": { - "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + "$ref": "#/definitions/ApiProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] } }, - "description": "The service entity.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, - "ServiceCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Service" - }, - "x-typespec-name": "Service[]", - "description": "The Service items on this page" - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "Rest.ResourceLocation" - } - }, - "description": "The response of a Service list operation.", - "required": [ - "value" - ] - }, - "ServiceProperties": { - "type": "object", - "description": "The properties of the service.", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } - }, - "x-ms-mutability": [ - "read", - "create" ] }, - "ServiceUpdate": { + "ApiDefinition": { "type": "object", + "description": "API definition entity.", "properties": { "properties": { - "$ref": "#/definitions/ServiceProperties", - "x-ms-client-flatten": true + "$ref": "#/definitions/ApiDefinitionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] } }, - "description": "The service properties to be updated." - }, - "MetadataSchema": { - "type": "object", - "title": "Metadata schema", - "description": "Metadata schema entity. Used to define metadata for the entities in API catalog.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/MetadataSchemaProperties" - } - } - }, - "MetadataSchemaProperties": { - "type": "object", - "title": "Metadata schema properties", - "description": "Metadata schema properties.", - "properties": { - "schema": { - "type": "string", - "description": "The schema defining the type." - }, - "assignedTo": { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataAssignment" - }, - "x-ms-identifiers": [ - "entity" - ] - } - }, - "required": [ - "schema" ] }, - "MetadataSchemaCollection": { + "ApiDefinitionListResult": { "type": "object", - "title": "Metadata schema collection", - "description": "Paginated collection of metadata schemas.", + "description": "The response of a ApiDefinition list operation.", "properties": { "value": { "type": "array", + "description": "The ApiDefinition items on this page", "items": { - "$ref": "#/definitions/MetadataSchema" + "$ref": "#/definitions/ApiDefinition" }, - "description": "Page items.", "readOnly": true }, "nextLink": { @@ -2198,54 +3438,111 @@ "description": "The link to the next page of items", "readOnly": true } - } - }, - "Workspace": { - "type": "object", - "title": "Workspace", - "description": "Workspace entity.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkspaceProperties" - } - } + }, + "required": [ + "value" + ] }, - "WorkspaceProperties": { - "title": "Workspace properties", + "ApiDefinitionProperties": { "type": "object", + "description": "API definition properties entity.", "properties": { "title": { "type": "string", - "description": "Workspace title.", - "example": "Contoso API contributors", + "description": "API definition title.", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", - "description": "Workspace description." + "description": "API definition description." + }, + "specification": { + "$ref": "#/definitions/ApiDefinitionPropertiesSpecification", + "description": "API specification details.", + "readOnly": true } }, "required": [ "title" + ] + }, + "ApiDefinitionPropertiesSpecification": { + "type": "object", + "description": "API specification details.", + "properties": { + "name": { + "type": "string", + "description": "Specification name." + }, + "version": { + "type": "string", + "description": "Specification version." + } + } + }, + "ApiImportSuccess": { + "type": "object", + "description": "The API specification was successfully imported." + }, + "ApiKind": { + "type": "string", + "description": "The kind of the API", + "enum": [ + "rest", + "graphql", + "grpc", + "soap", + "webhook", + "websocket" ], - "description": "Workspace properties." + "x-ms-enum": { + "name": "ApiKind", + "modelAsString": true, + "values": [ + { + "name": "rest", + "value": "rest", + "description": "A Representational State Transfer Api" + }, + { + "name": "graphql", + "value": "graphql", + "description": "A Graph query language Api" + }, + { + "name": "grpc", + "value": "grpc", + "description": "A gRPC Api" + }, + { + "name": "soap", + "value": "soap", + "description": "A SOAP Api" + }, + { + "name": "webhook", + "value": "webhook", + "description": "Web Hook" + }, + { + "name": "websocket", + "value": "websocket", + "description": "Web Socket" + } + ] + } }, - "WorkspaceCollection": { + "ApiListResult": { "type": "object", + "description": "The response of a Api list operation.", "properties": { "value": { "type": "array", + "description": "The Api items on this page", "items": { - "$ref": "#/definitions/Workspace" + "$ref": "#/definitions/Api" }, - "description": "Page items.", "readOnly": true }, "nextLink": { @@ -2255,58 +3552,26 @@ "readOnly": true } }, - "title": "Workspace collection", - "description": "Paginated collection of workspaces." - }, - "Api": { - "type": "object", - "title": "API", - "description": "API entity.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiProperties" - } - } + "required": [ + "value" + ] }, "ApiProperties": { "type": "object", - "title": "API properties", "description": "API properties.", "properties": { "title": { "type": "string", "description": "API title.", - "example": "Echo API", "minLength": 1, "maxLength": 50 }, "kind": { - "type": "string", - "title": "API kind", - "description": "Kind of API. For example, REST or GraphQL.", - "enum": [ - "rest", - "graphql", - "grpc", - "soap", - "webhook", - "websocket" - ], - "x-ms-enum": { - "name": "ApiKind", - "modelAsString": true - }, - "example": "graphql" + "$ref": "#/definitions/ApiKind", + "description": "Kind of API. For example, REST or GraphQL." }, "description": { "type": "string", - "title": "Description", "description": "Description of the API.", "maxLength": 1000 }, @@ -2317,31 +3582,37 @@ }, "lifecycleStage": { "$ref": "#/definitions/LifecycleStage", + "description": "Current lifecycle stage of the API.", "readOnly": true }, "termsOfService": { - "$ref": "#/definitions/TermsOfService" + "$ref": "#/definitions/TermsOfService", + "description": "Terms of service for the API." }, "externalDocumentation": { "type": "array", + "description": "The set of external documentation", + "maxItems": 20, "items": { "$ref": "#/definitions/ExternalDocumentation" }, - "maxItems": 20, "x-ms-identifiers": [] }, "contacts": { "type": "array", + "description": "The set of contacts", "items": { "$ref": "#/definitions/Contact" }, "x-ms-identifiers": [] }, "license": { - "$ref": "#/definitions/License" + "$ref": "#/definitions/License", + "description": "The license information for the API." }, "customProperties": { - "$ref": "#/definitions/CustomProperties" + "$ref": "#/definitions/CustomProperties", + "description": "The custom metadata defined for API catalog entities." } }, "required": [ @@ -2349,57 +3620,156 @@ "kind" ] }, - "ApiCollection": { + "ApiSpecExportResult": { "type": "object", + "description": "The API specification export result.", "properties": { + "format": { + "$ref": "#/definitions/ApiSpecExportResultFormat", + "description": "The format of exported result" + }, "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Api" + "type": "string", + "description": "The result of the export operation." + } + } + }, + "ApiSpecExportResultFormat": { + "type": "string", + "description": "Result format for exported Api spec", + "enum": [ + "inline", + "link" + ], + "x-ms-enum": { + "name": "ApiSpecExportResultFormat", + "modelAsString": true, + "values": [ + { + "name": "inline", + "value": "inline", + "description": "The inlined content of a specification document." }, - "description": "Page items.", - "readOnly": true + { + "name": "link", + "value": "link", + "description": "The link to the result of the export operation. The URL is valid for 5 minutes." + } + ] + } + }, + "ApiSpecImportRequest": { + "type": "object", + "description": "The API specification source entity properties.", + "properties": { + "value": { + "type": "string", + "description": "Value of the API specification source." }, - "nextLink": { + "format": { + "$ref": "#/definitions/ApiSpecImportSourceFormat", + "description": "Format of the API specification source." + }, + "specification": { + "$ref": "#/definitions/ApiSpecImportRequestSpecification", + "description": "API specification details." + } + } + }, + "ApiSpecImportRequestSpecification": { + "type": "object", + "description": "API specification details.", + "properties": { + "name": { "type": "string", - "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "Specification name." + }, + "version": { + "type": "string", + "description": "Specification version." } - }, - "title": "API collection", - "description": "Paginated collection of APIs." + } + }, + "ApiSpecImportSourceFormat": { + "type": "string", + "description": "Source format for imported Api spec", + "enum": [ + "inline", + "link" + ], + "x-ms-enum": { + "name": "ApiSpecImportSourceFormat", + "modelAsString": true, + "values": [ + { + "name": "inline", + "value": "inline", + "description": "The inlined content of a specification document." + }, + { + "name": "link", + "value": "link", + "description": "The link to a specification document hosted on a publicly accessible internet\naddress." + } + ] + } }, "ApiVersion": { "type": "object", - "title": "API version", "description": "API version entity.", "properties": { "properties": { + "$ref": "#/definitions/ApiVersionProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiVersionProperties" + "x-ms-mutability": [ + "read", + "create" + ] } }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, + "ApiVersionListResult": { + "type": "object", + "description": "The response of a ApiVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ApiVersion items on this page", + "items": { + "$ref": "#/definitions/ApiVersion" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, "ApiVersionProperties": { "type": "object", - "title": "API version properties", "description": "API version properties entity.", "properties": { "title": { "type": "string", "description": "API version title.", - "example": "1.0.1", "minLength": 1, "maxLength": 50 }, "lifecycleStage": { - "$ref": "#/definitions/LifecycleStage" + "$ref": "#/definitions/LifecycleStage", + "description": "Current lifecycle stage of the API." } }, "required": [ @@ -2407,92 +3777,251 @@ "lifecycleStage" ] }, - "ApiVersionCollection": { + "Contact": { "type": "object", - "title": "API version collection", - "description": "Paginated collection of API versions.", + "description": "Contact information", "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiVersion" - }, - "description": "Page items.", - "readOnly": true + "name": { + "type": "string", + "description": "Name of the contact.", + "maxLength": 100 }, - "nextLink": { + "url": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "URL for the contact.", + "maxLength": 200 + }, + "email": { + "type": "string", + "description": "Email address of the contact.", + "maxLength": 100 } } }, - "ApiDefinition": { + "CreatedByType": { + "type": "string", + "description": "How the resource was created", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "CreatedByType", + "modelAsString": true, + "values": [ + { + "name": "User", + "value": "User", + "description": "Created by user" + }, + { + "name": "Application", + "value": "Application", + "description": "Created by Application" + }, + { + "name": "ManagedIdentity", + "value": "ManagedIdentity", + "description": "Created by Managed Identity" + }, + { + "name": "Key", + "value": "Key", + "description": "Created By Key" + } + ] + } + }, + "CustomProperties": { "type": "object", - "title": "API definition", - "description": "API definition entity.", + "description": "The custom metadata defined for API catalog entities." + }, + "Deployment": { + "type": "object", + "description": "API deployment entity.", "properties": { "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiDefinitionProperties" + "x-ms-mutability": [ + "read", + "create" + ] } }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, - "ApiDefinitionProperties": { + "DeploymentListResult": { "type": "object", - "title": "API definition properties", - "description": "API definition properties entity.", + "description": "The response of a Deployment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Deployment items on this page", + "items": { + "$ref": "#/definitions/Deployment" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "DeploymentProperties": { + "type": "object", + "description": "API deployment entity properties.", "properties": { "title": { "type": "string", - "description": "API definition title.", - "example": "OpenAPI", + "description": "API deployment title", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", - "description": "API definition description." + "description": "Description of the deployment.", + "maxLength": 500 }, - "specification": { - "type": "object", - "description": "API specification details.", - "readOnly": true, - "properties": { - "name": { - "type": "string", - "description": "Specification name.", - "example": "openapi" - }, - "version": { - "type": "string", - "description": "Specification version.", - "example": "3.0.1" - } + "environmentId": { + "type": "string", + "description": "API center-scoped environment resource ID." + }, + "definitionId": { + "type": "string", + "description": "API center-scoped definition resource ID." + }, + "state": { + "$ref": "#/definitions/DeploymentState", + "description": "State of API deployment." + }, + "server": { + "$ref": "#/definitions/DeploymentServer", + "description": "The deployment server" + }, + "customProperties": { + "$ref": "#/definitions/CustomProperties", + "description": "The custom metadata defined for API catalog entities." + } + } + }, + "DeploymentServer": { + "type": "object", + "description": "Server", + "properties": { + "runtimeUri": { + "type": "array", + "description": "Base runtime URLs for this deployment.", + "items": { + "$ref": "#/definitions/SmallString" + } + } + } + }, + "DeploymentState": { + "type": "string", + "description": "State of the Deployment", + "enum": [ + "active", + "inactive" + ], + "x-ms-enum": { + "name": "DeploymentState", + "modelAsString": true, + "values": [ + { + "name": "active", + "value": "active", + "description": "Active State" + }, + { + "name": "inactive", + "value": "inactive", + "description": "Inactive State" + } + ] + } + }, + "Environment": { + "type": "object", + "description": "Environment entity.", + "properties": { + "properties": { + "$ref": "#/definitions/EnvironmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EnvironmentKind": { + "type": "string", + "description": "The kind of environment", + "enum": [ + "development", + "testing", + "staging", + "production" + ], + "x-ms-enum": { + "name": "EnvironmentKind", + "modelAsString": true, + "values": [ + { + "name": "development", + "value": "development", + "description": "Development environment" + }, + { + "name": "testing", + "value": "testing", + "description": "Testing environment" + }, + { + "name": "staging", + "value": "staging", + "description": "Staging environment" + }, + { + "name": "production", + "value": "production", + "description": "Production environment" } - } - }, - "required": [ - "title" - ] + ] + } }, - "ApiDefinitionCollection": { + "EnvironmentListResult": { "type": "object", - "title": "API version collection", - "description": "Paginated collection of API definitions.", + "description": "The response of a Environment list operation.", "properties": { "value": { "type": "array", + "description": "The Environment items on this page", "items": { - "$ref": "#/definitions/ApiDefinition" + "$ref": "#/definitions/Environment" }, - "description": "Page items.", "readOnly": true }, "nextLink": { @@ -2501,64 +4030,40 @@ "description": "The link to the next page of items", "readOnly": true } - } - }, - "Environment": { - "title": "Environment", - "type": "object", - "description": "Environment entity.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/EnvironmentProperties" - } }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" - } + "required": [ + "value" ] }, "EnvironmentProperties": { "type": "object", - "title": "Environment entity properties", "description": "Environment properties entity.", "properties": { "title": { "type": "string", "description": "Environment title.", - "example": "Contoso Europe Azure API Management", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", - "title": "Description.", - "example": "The primary Azure API Management service for the European division of Contoso." + "description": "The environment description." }, "kind": { - "type": "string", - "description": "Environment kind.", - "enum": [ - "development", - "testing", - "staging", - "production" - ], - "x-ms-enum": { - "name": "EnvironmentKind", - "modelAsString": true - }, - "example": "production" + "$ref": "#/definitions/EnvironmentKind", + "description": "Environment kind." }, "server": { - "$ref": "#/definitions/EnvironmentServer" + "$ref": "#/definitions/EnvironmentServer", + "description": "Server information of the environment." }, "onboarding": { - "$ref": "#/definitions/Onboarding" + "$ref": "#/definitions/Onboarding", + "description": "Environment onboarding information" }, "customProperties": { - "$ref": "#/definitions/CustomProperties" + "$ref": "#/definitions/CustomProperties", + "description": "The custom metadata defined for API catalog entities." } }, "required": [ @@ -2566,176 +4071,325 @@ "kind" ] }, - "EnvironmentCollection": { + "EnvironmentServer": { "type": "object", - "title": "Environments collection", - "description": "Paginated collection of environments.", + "description": "Server information of the environment.", "properties": { - "value": { + "type": { + "$ref": "#/definitions/EnvironmentServerType", + "description": "Type of the server that represents the environment." + }, + "managementPortalUri": { "type": "array", + "description": "The location of the management portal", + "maxItems": 1, "items": { - "$ref": "#/definitions/Environment" - }, - "description": "Page items.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "type": "string" + } } } }, - "Deployment": { - "type": "object", - "title": "API deployment", - "description": "API deployment entity.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DeploymentProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" - } - ] + "EnvironmentServerType": { + "type": "string", + "description": "The type of environment server", + "enum": [ + "Azure API Management", + "Azure compute service", + "Apigee API Management", + "AWS API Gateway", + "Kong API Gateway", + "Kubernetes", + "MuleSoft API Management" + ], + "x-ms-enum": { + "name": "EnvironmentServerType", + "modelAsString": true, + "values": [ + { + "name": "Azure API Management", + "value": "Azure API Management", + "description": "Api Management Server" + }, + { + "name": "Azure compute service", + "value": "Azure compute service", + "description": "Compute server" + }, + { + "name": "Apigee API Management", + "value": "Apigee API Management", + "description": "Apigee server" + }, + { + "name": "AWS API Gateway", + "value": "AWS API Gateway", + "description": "AWS Api Gateway server" + }, + { + "name": "Kong API Gateway", + "value": "Kong API Gateway", + "description": "Kong API Gateway server" + }, + { + "name": "Kubernetes", + "value": "Kubernetes", + "description": "Kubernetes server" + }, + { + "name": "MuleSoft API Management", + "value": "MuleSoft API Management", + "description": "Mulesoft Api Management server" + } + ] + } }, - "DeploymentProperties": { + "ExternalDocumentation": { "type": "object", - "title": "API deployment properties", - "description": "API deployment entity properties.", + "description": "Additional, external documentation for the API.", "properties": { "title": { "type": "string", - "description": "API deployment title", - "example": "Production deployment", - "minLength": 1, + "description": "Title of the documentation.", "maxLength": 50 }, "description": { "type": "string", - "title": "Description", - "description": "Description of the deployment.", - "maxLength": 500, - "example": "Public cloud production deployment." - }, - "environmentId": { - "type": "string", - "description": "API center-scoped environment resource ID.", - "example": "/workspaces/default/environments/production" + "description": "Description of the documentation.", + "maxLength": 500 }, - "definitionId": { + "url": { "type": "string", - "description": "API center-scoped definition resource ID.", - "example": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" - }, - "state": { - "$ref": "#/definitions/DeploymentState" - }, - "server": { - "$ref": "#/definitions/DeploymentServer" - }, - "customProperties": { - "$ref": "#/definitions/CustomProperties" + "format": "uri", + "description": "URL pointing to the documentation.", + "maxLength": 200 } - } + }, + "required": [ + "url" + ] }, - "DeploymentCollection": { + "License": { "type": "object", - "title": "API deployment collection", - "description": "Paginated collection of API deployments.", + "description": "The license information for the API.", "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Deployment" - }, - "description": "Page items.", - "readOnly": true + "name": { + "type": "string", + "description": "Name of the license.", + "maxLength": 100 }, - "nextLink": { + "url": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "readOnly": true + "description": "URL pointing to the license details. The URL field is mutually exclusive of the\nidentifier field.", + "maxLength": 200 + }, + "identifier": { + "type": "string", + "format": "uri", + "description": "SPDX license information for the API. The identifier field is mutually\nexclusive of the URL field.", + "maxLength": 50 } } }, - "ApiSpecImportRequest": { + "LifecycleStage": { + "type": "string", + "description": "The stage of the Api development lifecycle", + "enum": [ + "design", + "development", + "testing", + "preview", + "production", + "deprecated", + "retired" + ], + "x-ms-enum": { + "name": "LifecycleStage", + "modelAsString": true, + "values": [ + { + "name": "design", + "value": "design", + "description": "design stage" + }, + { + "name": "development", + "value": "development", + "description": "development stage" + }, + { + "name": "testing", + "value": "testing", + "description": "testing stage" + }, + { + "name": "preview", + "value": "preview", + "description": "In preview" + }, + { + "name": "production", + "value": "production", + "description": "In production" + }, + { + "name": "deprecated", + "value": "deprecated", + "description": "deprecated stage" + }, + { + "name": "retired", + "value": "retired", + "description": "Retired stage" + } + ] + } + }, + "ManagedServiceIdentityType": { + "type": "string", + "description": "The type of managed service identity", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No identity" + }, + { + "name": "SystemAssigned", + "value": "SystemAssigned", + "description": "Assigned by the system" + }, + { + "name": "UserAssigned", + "value": "UserAssigned", + "description": "assigned by the user" + }, + { + "name": "SystemAssigned,UserAssigned", + "value": "SystemAssigned,UserAssigned", + "description": "Both system-assigned and user-assigned identities" + } + ] + } + }, + "MetadataAssignment": { "type": "object", - "description": "The API specification source entity properties.", + "description": "Assignment metadata", "properties": { - "value": { - "type": "string", - "description": "Value of the API specification source." + "entity": { + "$ref": "#/definitions/MetadataAssignmentEntity", + "description": "The entities this metadata schema component gets applied to." }, - "format": { - "type": "string", - "description": "Format of the API specification source.", - "enum": [ - "inline", - "link" - ], - "x-ms-enum": { - "name": "ApiSpecImportSourceFormat", - "modelAsString": true, - "values": [ - { - "value": "inline", - "description": "The inlined content of a specification document." - }, - { - "value": "link", - "description": "The link to a specification document hosted on a publicly accessible internet address." - } - ] - } + "required": { + "type": "boolean", + "description": "Required assignment" }, - "specification": { - "type": "object", - "description": "API specification details.", - "properties": { - "name": { - "type": "string", - "description": "Specification name.", - "example": "openapi" - }, - "version": { - "type": "string", - "description": "Specification version.", - "example": "3.0.1" - } + "deprecated": { + "type": "boolean", + "description": "Deprecated assignment" + } + } + }, + "MetadataAssignmentEntity": { + "type": "string", + "description": "Assignment entity for Metadata", + "enum": [ + "api", + "environment", + "deployment" + ], + "x-ms-enum": { + "name": "MetadataAssignmentEntity", + "modelAsString": true, + "values": [ + { + "name": "api", + "value": "api", + "description": "Assigned to API" + }, + { + "name": "environment", + "value": "environment", + "description": "Assigned to Environment" + }, + { + "name": "deployment", + "value": "deployment", + "description": "Assigned to Deployment" } + ] + } + }, + "MetadataSchema": { + "type": "object", + "description": "Metadata schema entity. Used to define metadata for the entities in API catalog.", + "properties": { + "properties": { + "$ref": "#/definitions/MetadataSchemaProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } + ] + }, + "MetadataSchemaExportFormat": { + "type": "string", + "description": "The format for schema export", + "enum": [ + "inline", + "link" + ], + "x-ms-enum": { + "name": "MetadataSchemaExportFormat", + "modelAsString": true, + "values": [ + { + "name": "inline", + "value": "inline", + "description": "The inlined content of a schema document." + }, + { + "name": "link", + "value": "link", + "description": "The link to a schema document. The URL is valid for 5 minutes." + } + ] } }, - "ApiSpecExportResult": { + "MetadataSchemaExportRequest": { "type": "object", - "description": "The API specification export result.", + "description": "The metadata schema export request.", + "properties": { + "assignedTo": { + "$ref": "#/definitions/MetadataAssignmentEntity", + "description": "An entity the metadata schema is requested for." + } + } + }, + "MetadataSchemaExportResult": { + "type": "object", + "description": "The metadata schema export result.", "properties": { "format": { - "type": "string", - "enum": [ - "link", - "inline" - ], - "x-ms-enum": { - "name": "ApiSpecExportResultFormat", - "modelAsString": true, - "values": [ - { - "value": "inline", - "description": "The inlined content of a specification document." - }, - { - "value": "link", - "description": "The link to the result of the export operation. The URL is valid for 5 minutes." - } - ] - } + "$ref": "#/definitions/MetadataSchemaExportFormat", + "description": "The export format for the schema" }, "value": { "type": "string", @@ -2743,368 +4397,315 @@ } } }, - "MetadataSchemaExportRequest": { + "MetadataSchemaListResult": { + "type": "object", + "description": "The response of a MetadataSchema list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MetadataSchema items on this page", + "items": { + "$ref": "#/definitions/MetadataSchema" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "MetadataSchemaProperties": { "type": "object", - "description": "The metadata schema export request.", + "description": "Metadata schema properties.", "properties": { - "assignedTo": { + "schema": { "type": "string", - "description": "An entity the metadata schema is requested for.", - "enum": [ - "api", - "environment", - "deployment" - ], - "x-ms-enum": { - "name": "MetadataAssignmentEntity", - "modelAsString": true - } + "description": "The schema defining the type." + }, + "assignedTo": { + "type": "array", + "description": "The assignees", + "items": { + "$ref": "#/definitions/MetadataAssignment" + }, + "x-ms-identifiers": [] } - } + }, + "required": [ + "schema" + ] }, - "MetadataSchemaExportResult": { + "Onboarding": { "type": "object", - "description": "The metadata schema export result.", + "description": "Onboarding information", "properties": { - "format": { + "instructions": { "type": "string", - "enum": [ - "inline", - "link" - ], - "x-ms-enum": { - "name": "MetadataSchemaExportFormat", - "modelAsString": true, - "values": [ - { - "value": "inline", - "description": "The inlined content of a schema document." - }, - { - "value": "link", - "description": "The link to a schema document. The URL is valid for 5 minutes." - } - ] - } + "description": "Onboarding guide." }, - "value": { - "type": "string", - "description": "The result of the export operation." + "developerPortalUri": { + "type": "array", + "description": "The location of the development portal", + "maxItems": 1, + "items": { + "type": "string" + } } } }, - "CustomProperties": { - "title": "Custom properties", - "description": "The custom metadata defined for API catalog entities.", - "type": "object" + "Origin": { + "type": "string", + "description": "The expected types of origin", + "enum": [ + "user", + "system", + "user,system" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true, + "values": [ + { + "name": "user", + "value": "user", + "description": "Origin with User" + }, + { + "name": "system", + "value": "system", + "description": "Origin with System" + }, + { + "name": "user,system", + "value": "user,system", + "description": "Origin with user and system" + } + ] + } }, - "LifecycleStage": { + "ProvisioningState": { "type": "string", - "description": "Current lifecycle stage of the API.", + "description": "The provisioning state of the resource", "enum": [ - "design", - "development", - "testing", - "preview", - "production", - "deprecated", - "retired" + "Succeeded", + "Failed", + "Canceled" ], "x-ms-enum": { - "name": "LifecycleStage", - "modelAsString": true + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] }, - "example": "development" + "readOnly": true }, - "TermsOfService": { + "Service": { "type": "object", - "title": "Terms of service", - "description": "Terms of service for the API.", + "description": "The service entity.", "properties": { - "url": { - "type": "string", - "title": "URL", - "description": "URL pointing to the terms of service.", - "format": "uri", - "maxLength": 200, - "example": "https://www.contoso.com/terms" + "properties": { + "$ref": "#/definitions/ServiceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." } }, - "required": [ - "url" + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } ] }, - "ExternalDocumentation": { + "ServiceListResult": { "type": "object", - "title": "External documentation", - "description": "Additional, external documentation for the API.", + "description": "The response of a Service list operation.", "properties": { - "title": { - "type": "string", - "description": "Title of the documentation.", - "example": "API developer guide", - "maxLength": 50 - }, - "description": { - "type": "string", - "title": "Description", - "description": "Description of the documentation.", - "maxLength": 500 + "value": { + "type": "array", + "description": "The Service items on this page", + "items": { + "$ref": "#/definitions/Service" + }, + "readOnly": true }, - "url": { - "title": "URL", - "description": "URL pointing to the documentation.", + "nextLink": { "type": "string", "format": "uri", - "maxLength": 200 + "description": "The link to the next page of items", + "readOnly": true } }, "required": [ - "url" + "value" ] }, - "Contact": { + "ServiceProperties": { "type": "object", + "description": "The properties of the service.", "properties": { - "name": { - "title": "Name", - "description": "Name of the contact.", - "type": "string", - "maxLength": 100, - "example": "John Doe" - }, - "url": { - "title": "URL", - "description": "URL for the contact.", - "type": "string", - "format": "uri", - "maxLength": 200 - }, - "email": { - "title": "Email address", - "description": "Email address of the contact.", - "type": "string", - "maxLength": 100, - "example": "john@contoso.com" + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the service.", + "readOnly": true } } }, - "License": { + "ServiceUpdate": { "type": "object", - "title": "License", - "description": "The license information for the API.", + "description": "The type used for update operations of the Service.", "properties": { - "name": { - "title": "Name", - "description": "Name of the license.", - "type": "string", - "maxLength": 100 - }, - "url": { - "title": "URL", - "description": "URL pointing to the license details. The URL field is mutually exclusive of the identifier field.", - "type": "string", - "format": "uri", - "maxLength": 200 + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." }, - "identifier": { - "title": "Identifier", - "description": "SPDX license information for the API. The identifier field is mutually exclusive of the URL field.", - "type": "string", - "format": "uri", - "maxLength": 50 + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } } } }, - "EnvironmentServer": { - "type": "object", - "title": "Server", - "description": "Server information of the environment.", - "properties": { - "type": { - "type": "string", - "description": "Type of the server that represents the environment.", - "enum": [ - "Azure API Management", - "Azure compute service", - "Apigee API Management", - "AWS API Gateway", - "Kong API Gateway", - "Kubernetes", - "MuleSoft API Management" - ], - "x-ms-enum": { - "name": "EnvironmentServerType", - "modelAsString": true - }, - "example": "Azure API Management" - }, - "managementPortalUri": { - "type": "array", - "items": { - "type": "string", - "title": "Management portal URI", - "example": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.ApiManagement/service/my-api-management-service" - }, - "maxItems": 1 - } - } + "SmallString": { + "type": "string", + "format": "uri", + "description": "Used for restricted length uris", + "maxLength": 200 }, - "DeploymentServer": { + "TermsOfService": { "type": "object", - "title": "Server", + "description": "Terms of service for the API.", "properties": { - "runtimeUri": { - "title": "Server runtime base URI", - "description": "Base runtime URLs for this deployment.", - "type": "array", - "items": { - "type": "string", - "format": "uri", - "maxLength": 200, - "example": "https://api.contoso.com" - } + "url": { + "type": "string", + "format": "uri", + "description": "URL pointing to the terms of service.", + "maxLength": 200 } - } + }, + "required": [ + "url" + ] }, - "DeploymentState": { + "Versions": { "type": "string", - "title": "State", - "description": "State of API deployment.", + "description": "The available API versions.", "enum": [ - "active", - "inactive" + "2024-03-01" ], "x-ms-enum": { - "name": "DeploymentState", - "modelAsString": true + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2024_03_01", + "value": "2024-03-01", + "description": "The initial service version" + } + ] } }, - "Onboarding": { + "Workspace": { "type": "object", + "description": "Workspace entity.", "properties": { - "instructions": { - "type": "string", - "description": "Onboarding guide.", - "example": "Sign in or sign up in the specified developer portal to request API access. You must complete the internal privacy training for your account to be approved." - }, - "developerPortalUri": { + "properties": { + "$ref": "#/definitions/WorkspaceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkspaceListResult": { + "type": "object", + "description": "The response of a Workspace list operation.", + "properties": { + "value": { "type": "array", + "description": "The Workspace items on this page", "items": { - "type": "string", - "description": "Developer portal URI.", - "example": "https://developer.contoso.com" + "$ref": "#/definitions/Workspace" }, - "maxItems": 1 + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true } - } + }, + "required": [ + "value" + ] }, - "MetadataAssignment": { + "WorkspaceProperties": { "type": "object", + "description": "Workspace properties.", "properties": { - "entity": { + "title": { "type": "string", - "description": "The entities this metadata schema component gets applied to.", - "enum": [ - "api", - "deployment", - "environment" - ], - "x-ms-enum": { - "name": "MetadataAssignmentEntity", - "modelAsString": true - }, - "example": "api" - }, - "required": { - "type": "boolean" + "description": "Workspace title.", + "minLength": 1, + "maxLength": 50 }, - "deprecated": { - "type": "boolean" + "description": { + "type": "string", + "description": "Workspace description." } - } + }, + "required": [ + "title" + ] } }, "parameters": { - "ServiceNameParameter": { - "type": "string", - "name": "serviceName", - "in": "path", - "required": true, - "description": "The name of Azure API Center service.", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, - "ApiNameParameter": { - "type": "string", - "name": "apiName", - "in": "path", - "required": true, - "description": "The name of the API.", - "minLength": 1, - "maxLength": 90 - }, - "ApiVersionNameParameter": { - "type": "string", - "name": "versionName", - "in": "path", - "required": true, - "description": "The name of the API version.", - "minLength": 1, - "maxLength": 90 - }, - "ApiDefinitionNameParameter": { - "type": "string", - "name": "definitionName", - "in": "path", - "required": true, - "description": "The name of the API definition.", - "minLength": 1, - "maxLength": 90 - }, - "ApiDeploymentNameParameter": { - "type": "string", - "name": "deploymentName", - "in": "path", - "required": true, - "description": "The name of the API deployment.", - "minLength": 1, - "maxLength": 90 - }, - "EnvironmentNameParameter": { - "type": "string", - "name": "environmentName", - "in": "path", - "required": true, - "description": "The name of the environment.", - "minLength": 1, - "maxLength": 90 - }, - "MetadataSchemaNameParameter": { - "type": "string", - "name": "metadataSchemaName", - "in": "path", - "required": true, - "description": "The name of the metadata schema.", - "minLength": 1, - "maxLength": 90 - }, - "WorkspaceNameParameter": { - "type": "string", - "name": "workspaceName", - "in": "path", - "required": true, - "description": "The name of the workspace.", - "minLength": 1, - "maxLength": 90 - }, - "ODataFilterParameter": { - "type": "string", + "OdataFilterParameter": { "name": "$filter", "in": "query", + "description": "OData filter parameter.", "required": false, - "description": "OData filter parameter." + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-client-name": "filter" } } } diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_CreateOrUpdate.json index bbb5a6e02096..053833679cea 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_CreateOrUpdate.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_CreateOrUpdate.json @@ -1,4 +1,6 @@ { + "operationId": "ApiDefinitions_CreateOrUpdate", + "title": "ApiDefinitions_CreateOrUpdate", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_Delete.json index 7379519196a0..deff5dfefec0 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_Delete.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_Delete.json @@ -1,4 +1,6 @@ { + "operationId": "ApiDefinitions_Delete", + "title": "ApiDefinitions_Delete", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_ExportSpecification.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_ExportSpecification.json index cba592da63f3..ca4b8ad4e9d5 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_ExportSpecification.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_ExportSpecification.json @@ -1,4 +1,6 @@ { + "operationId": "ApiDefinitions_ExportSpecification", + "title": "ApiDefinitions_ExportSpecification", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_Get.json index 2777dd8670d6..a02f85950086 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_Get.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_Get.json @@ -1,4 +1,6 @@ { + "operationId": "ApiDefinitions_Get", + "title": "ApiDefinitions_Get", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_Head.json index fd596bfdf936..976d7fbec7ec 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_Head.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_Head.json @@ -1,4 +1,6 @@ { + "operationId": "ApiDefinitions_Head", + "title": "ApiDefinitions_Head", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_ImportSpecification.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_ImportSpecification.json index d63a23b72e91..b3b497508524 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_ImportSpecification.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_ImportSpecification.json @@ -1,4 +1,6 @@ { + "operationId": "ApiDefinitions_ImportSpecification", + "title": "ApiDefinitions_ImportSpecification", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_List.json index adc5c160aa0e..3c96f25f3a01 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_List.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_List.json @@ -1,4 +1,6 @@ { + "operationId": "ApiDefinitions_List", + "title": "ApiDefinitions_ListByApiVersion", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_CreateOrUpdate.json index f78cef4b7088..b85f753b2f0a 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_CreateOrUpdate.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_CreateOrUpdate.json @@ -1,4 +1,6 @@ { + "operationId": "ApiVersions_CreateOrUpdate", + "title": "ApiVersions_CreateOrUpdate", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_Delete.json index 31a9c3870f80..a9364ba7fd55 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_Delete.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_Delete.json @@ -1,4 +1,6 @@ { + "operationId": "ApiVersions_Delete", + "title": "ApiVersions_Delete", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_Get.json index 6efc849c4911..288fc01a31d6 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_Get.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_Get.json @@ -1,4 +1,6 @@ { + "operationId": "ApiVersions_Get", + "title": "ApiVersions_Get", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_Head.json index e16c32d9f141..1d0ffbc27000 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_Head.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_Head.json @@ -1,4 +1,6 @@ { + "operationId": "ApiVersions_Head", + "title": "ApiVersions_Head", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_List.json index 3b8fbca861de..6cc59088dbb8 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_List.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiVersions_List.json @@ -1,4 +1,6 @@ { + "operationId": "ApiVersions_List", + "title": "ApiVersions_ListByApi", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_CreateOrUpdate.json index 28dbec5e39ed..291995eb4dc0 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_CreateOrUpdate.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_CreateOrUpdate.json @@ -1,4 +1,6 @@ { + "operationId": "Apis_CreateOrUpdate", + "title": "Apis_CreateOrUpdate", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Delete.json index ac1cc6bf6b87..24df3858cc86 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Delete.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Delete.json @@ -1,4 +1,6 @@ { + "operationId": "Apis_Delete", + "title": "Apis_Delete", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Get.json index edeece90fe49..ae4f66669395 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Get.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Get.json @@ -1,4 +1,6 @@ { + "operationId": "Apis_Get", + "title": "Apis_Get", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Head.json index 5537333be501..29789f042103 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Head.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Head.json @@ -1,4 +1,6 @@ { + "operationId": "Apis_Head", + "title": "Apis_Head", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_List.json index dc1b05e2b6bc..7cfab5d2623d 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_List.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_List.json @@ -1,4 +1,6 @@ { + "operationId": "Apis_List", + "title": "Apis_ListByWorkspace", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_CreateOrUpdate.json index 6a266196cbef..278f4f06736b 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_CreateOrUpdate.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_CreateOrUpdate.json @@ -1,4 +1,6 @@ { + "operationId": "Deployments_CreateOrUpdate", + "title": "Deployments_CreateOrUpdate", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_Delete.json index c16177c57976..19caaefdb5a7 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_Delete.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_Delete.json @@ -1,4 +1,6 @@ { + "operationId": "Deployments_Delete", + "title": "Deployments_Delete", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_Get.json index 2a362a52d549..375e72ad3538 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_Get.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_Get.json @@ -1,4 +1,6 @@ { + "operationId": "Deployments_Get", + "title": "Deployments_Get", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_Head.json index cfa524e80773..6feacfe7acf5 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_Head.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_Head.json @@ -1,4 +1,6 @@ { + "operationId": "Deployments_Head", + "title": "Deployments_Head", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_List.json index b2c6b0ea4a9c..364d0ccbb7f1 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_List.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_List.json @@ -1,4 +1,6 @@ { + "operationId": "Deployments_List", + "title": "Deployments_ListByApi", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_CreateOrUpdate.json index 378d870e0f30..e0d7ad6ab3a2 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_CreateOrUpdate.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_CreateOrUpdate.json @@ -1,4 +1,6 @@ { + "operationId": "Environments_CreateOrUpdate", + "title": "Environments_CreateOrUpdate", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_Delete.json index 1306f8377427..2df043db988b 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_Delete.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_Delete.json @@ -1,4 +1,6 @@ { + "operationId": "Environments_Delete", + "title": "Environments_Delete", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_Get.json index d62076ad2331..67396ba65744 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_Get.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_Get.json @@ -1,4 +1,6 @@ { + "operationId": "Environments_Get", + "title": "Environments_Get", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_Head.json index 7084c4a2eb9c..680842d55f1c 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_Head.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_Head.json @@ -1,4 +1,6 @@ { + "operationId": "Environments_Head", + "title": "Environments_Head", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_List.json index cc7eec363109..48ebd7217d5f 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_List.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Environments_List.json @@ -1,4 +1,6 @@ { + "operationId": "Environments_List", + "title": "Environments_ListByWorkspace", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_CreateOrUpdate.json index e1c46f0bff66..7a20cd9c82c7 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_CreateOrUpdate.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_CreateOrUpdate.json @@ -1,4 +1,6 @@ { + "operationId": "MetadataSchemas_CreateOrUpdate", + "title": "MetadataSchemas_CreateOrUpdate", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Delete.json index eebb56b2662d..71660a9dc53c 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Delete.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Delete.json @@ -1,4 +1,6 @@ { + "operationId": "MetadataSchemas_Delete", + "title": "MetadataSchemas_Delete", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Get.json index 45374ae550ed..cad327f8c406 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Get.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Get.json @@ -1,4 +1,6 @@ { + "operationId": "MetadataSchemas_Get", + "title": "MetadataSchemas_Get", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Head.json index 68b3f2dfa2e0..e77a9103354c 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Head.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_Head.json @@ -1,4 +1,6 @@ { + "operationId": "MetadataSchemas_Head", + "title": "MetadataSchemas_Head", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_List.json index 2e5ee6c8505c..fd6745cb15d2 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_List.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/MetadataSchemas_List.json @@ -1,4 +1,6 @@ { + "operationId": "MetadataSchemas_List", + "title": "MetadataSchemas_ListByService", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Operations_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Operations_List.json index dd338de3e344..166e05ff1ff9 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Operations_List.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Operations_List.json @@ -1,4 +1,6 @@ { + "operationId": "Operations_List", + "title": "List Provider Operations", "parameters": { "api-version": "2024-03-01" }, diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_CreateOrUpdate.json index 1abe7d4c5389..3f23d5d186b7 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_CreateOrUpdate.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_CreateOrUpdate.json @@ -1,9 +1,22 @@ { + "operationId": "Services_CreateOrUpdate", + "title": "Services_CreateOrUpdate", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", "serviceName": "contoso", - "api-version": "2024-03-01" + "api-version": "2024-03-01", + "resource": { + "properties": {}, + "tags": {}, + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {} + } + } + } }, "responses": { "200": { diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_Delete.json index 825e4b124391..578485418310 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_Delete.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_Delete.json @@ -1,4 +1,6 @@ { + "operationId": "Services_Delete", + "title": "Services_Delete", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_ExportMetadataSchema.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_ExportMetadataSchema.json index ad9130bef6b1..0f14fc2b22b2 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_ExportMetadataSchema.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_ExportMetadataSchema.json @@ -1,4 +1,6 @@ { + "operationId": "Services_ExportMetadataSchema", + "title": "Services_ExportMetadataSchema", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_Get.json index 08a56675e711..185ae5875135 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_Get.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_Get.json @@ -1,4 +1,6 @@ { + "operationId": "Services_Get", + "title": "Services_Get", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_ListByResourceGroup.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_ListByResourceGroup.json index d09c20bbd077..c509c8214fb6 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_ListByResourceGroup.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_ListByResourceGroup.json @@ -1,4 +1,6 @@ { + "operationId": "Services_ListByResourceGroup", + "title": "Services_ListByResourceGroup", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_ListBySubscription.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_ListBySubscription.json index d09c20bbd077..35f67f89ba95 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_ListBySubscription.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_ListBySubscription.json @@ -1,4 +1,6 @@ { + "operationId": "Services_ListBySubscription", + "title": "Services_ListBySubscription", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_Update.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_Update.json index 08a56675e711..c064e4d68da6 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_Update.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Services_Update.json @@ -1,9 +1,20 @@ { + "operationId": "Services_Update", + "title": "Services_Update", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", "serviceName": "contoso", - "api-version": "2024-03-01" + "api-version": "2024-03-01", + "payload": { + "tags": {}, + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {} + } + } + } }, "responses": { "200": { diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_CreateOrUpdate.json index 5a18278ac4c9..f7e35e537e39 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_CreateOrUpdate.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_CreateOrUpdate.json @@ -1,4 +1,6 @@ { + "operationId": "Workspaces_CreateOrUpdate", + "title": "Workspaces_CreateOrUpdate", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_Delete.json index 79ceec3559bc..afb270cd6edc 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_Delete.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_Delete.json @@ -1,4 +1,6 @@ { + "operationId": "Workspaces_Delete", + "title": "Workspaces_Delete", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_Get.json index b8bcc31aca3c..8a5add4654db 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_Get.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_Get.json @@ -1,4 +1,6 @@ { + "operationId": "Workspaces_Get", + "title": "Workspaces_Get", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_Head.json index cc1068de5a23..966502982e9b 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_Head.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_Head.json @@ -1,4 +1,6 @@ { + "operationId": "Workspaces_Head", + "title": "Workspaces_Head", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_List.json index 3eee9a7850d5..5994737e7781 100644 --- a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_List.json +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Workspaces_List.json @@ -1,4 +1,6 @@ { + "operationId": "Workspaces_List", + "title": "Workspaces_ListByService", "parameters": { "resourceGroupName": "contoso-resources", "subscriptionId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/apicenter/resource-manager/readme.java.md b/specification/apicenter/resource-manager/readme.java.md index 86efedbeba7d..f96bbd1b21f9 100644 --- a/specification/apicenter/resource-manager/readme.java.md +++ b/specification/apicenter/resource-manager/readme.java.md @@ -4,4 +4,5 @@ These settings apply only when `--java` is specified on the command line. ```yaml $(java) service-name: ApiCenter +client-flattened-annotation-target: disabled ``` diff --git a/specification/apicenter/resource-manager/readme.md b/specification/apicenter/resource-manager/readme.md index 8d2d18a816d6..cd2047bd9dee 100644 --- a/specification/apicenter/resource-manager/readme.md +++ b/specification/apicenter/resource-manager/readme.md @@ -30,6 +30,10 @@ openapi-subtype: providerHub tag: package-2024-03 ``` +``` yaml +modelerfour: + flatten-models: false +``` ### Tag: package-2024-03 diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json new file mode 100644 index 000000000000..6ce5f0c61341 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json @@ -0,0 +1,15466 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-01-preview", + "title": "AppPlatformManagementClient", + "description": "REST API for Azure Spring Apps" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get a Service and its properties.", + "operationId": "Services_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Service.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Services_Get": { + "$ref": "./examples/Services_Get.json" + }, + "Services_Get_Consumption": { + "$ref": "./examples/Services_Get_Consumption.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create a new Service or update an exiting Service.", + "operationId": "Services_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Service.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "201": { + "description": "Created. The response describes the new Service and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Service is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Services_CreateOrUpdate": { + "$ref": "./examples/Services_CreateOrUpdate.json" + }, + "Services_CreateOrUpdate_VNetInjection": { + "$ref": "./examples/Services_CreateOrUpdate_VNetInjection.json" + }, + "Services_CreateOrUpdate_Enterprise": { + "$ref": "./examples/Services_CreateOrUpdate_Enterprise.json" + }, + "Services_CreateOrUpdate_Consumption": { + "$ref": "./examples/Services_CreateOrUpdate_Consumption.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to delete a Service.", + "operationId": "Services_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is deleted successfully." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Services_Delete": { + "$ref": "./examples/Services_Delete.json" + } + } + }, + "patch": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to update an exiting Service.", + "operationId": "Services_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Service.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Service is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Services_Update": { + "$ref": "./examples/Services_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/listTestKeys": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "List test keys for a Service.", + "operationId": "Services_ListTestKeys", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the test keys.", + "schema": { + "$ref": "#/definitions/TestKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Services_ListTestKeys": { + "$ref": "./examples/Services_ListTestKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/regenerateTestKey": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Regenerate a test key for a Service.", + "operationId": "Services_RegenerateTestKey", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "regenerateTestKeyRequest", + "in": "body", + "description": "Parameters for the operation", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateTestKeyRequestPayload" + } + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/TestKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Services_RegenerateTestKey": { + "$ref": "./examples/Services_RegenerateTestKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/disableTestEndpoint": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Disable test endpoint functionality for a Service.", + "operationId": "Services_DisableTestEndpoint", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Services_DisableTestEndpoint": { + "$ref": "./examples/Services_DisableTestEndpoint.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/enableTestEndpoint": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Enable test endpoint functionality for a Service.", + "operationId": "Services_EnableTestEndpoint", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TestKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Services_EnableTestEndpoint": { + "$ref": "./examples/Services_EnableTestEndpoint.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/stop": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Stop a Service.", + "operationId": "Services_Stop", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the stop operation is performed in the background." + }, + "404": { + "description": "Not found. The response indicates the service does not exist.", + "x-ms-error-response": true + }, + "409": { + "description": "Conflict. The response indicates the exiting Service is now updating.", + "x-ms-error-response": true + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Services_Stop": { + "$ref": "./examples/Services_Stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/start": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Start a Service.", + "operationId": "Services_Start", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the stop operation is performed in the background." + }, + "404": { + "description": "Not found. The response indicates the service does not exist.", + "x-ms-error-response": true + }, + "409": { + "description": "Conflict. The response indicates the exiting Service is now updating.", + "x-ms-error-response": true + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Services_Start": { + "$ref": "./examples/Services_Start.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/flushVirtualNetworkDnsSettings": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Flush Virtual Network DNS settings for a VNET injected Service.", + "operationId": "Services_FlushVnetDnsSetting", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the Flush VNET DNS setting operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "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": { + "Services_FlushVnetDnsSetting": { + "$ref": "./examples/Services_FlushVnetDnsSetting.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/supportedApmTypes": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List supported APM types for a Service.", + "operationId": "Services_ListSupportedApmTypes", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the supported APM types.", + "schema": { + "$ref": "#/definitions/SupportedApmTypes" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Services_ListSupportedApmTypes": { + "$ref": "./examples/Services_ListSupportedApmTypes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/listGloballyEnabledApms": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "List globally enabled APMs for a Service.", + "operationId": "Services_ListGloballyEnabledApms", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the globally enabled APMs.", + "schema": { + "$ref": "#/definitions/GloballyEnabledApms" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Services_ListGloballyEnabledApms": { + "$ref": "./examples/Services_ListGloballyEnabledApms.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/enableApmGlobally": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Enable an APM globally.", + "operationId": "Services_EnableApmGlobally", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "apm", + "in": "body", + "description": "The target APM for the enable operation", + "required": true, + "schema": { + "$ref": "#/definitions/ApmReference" + } + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the APM is now enabling globally and contains a Location header to query the operation result.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "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": "azure-async-operation" + }, + "x-ms-examples": { + "Services_EnableApmGlobally": { + "$ref": "./examples/Services_EnableApmGlobally.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/disableApmGlobally": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Disable an APM globally.", + "operationId": "Services_DisableApmGlobally", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "apm", + "in": "body", + "description": "The target APM for the disable operation", + "required": true, + "schema": { + "$ref": "#/definitions/ApmReference" + } + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the APM is now disabling globally and contains a Location header to query the operation result.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "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": "azure-async-operation" + }, + "x-ms-examples": { + "Services_DisableApmGlobally": { + "$ref": "./examples/Services_DisableApmGlobally.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get collection of APMs.", + "operationId": "Apms_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of APMs.", + "schema": { + "$ref": "#/definitions/ApmResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Apms_List": { + "$ref": "./examples/Apms_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms/{apmName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the APM by name.", + "operationId": "Apms_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApmNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the APM.", + "schema": { + "$ref": "#/definitions/ApmResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Apms_Get": { + "$ref": "./examples/Apms_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update an APM.", + "operationId": "Apms_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApmNameParameter" + }, + { + "name": "apmResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ApmResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the APM updated.", + "schema": { + "$ref": "#/definitions/ApmResource" + } + }, + "201": { + "description": "Created. The response describes the new APM created and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ApmResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Apms_CreateOrUpdate": { + "$ref": "./examples/Apms_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to delete an APM", + "operationId": "Apms_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApmNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the resource doesn't exist." + }, + "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": { + "Apms_Delete": { + "$ref": "./examples/Apms_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms/{apmName}/listSecretKeys": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "List keys of APM sensitive properties.", + "operationId": "Apms_ListSecretKeys", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApmNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the keys of APM sensitive properties.", + "schema": { + "$ref": "#/definitions/ApmSecretKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Apms_ListSecretKeys": { + "$ref": "./examples/Apms_ListSecretKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/eurekaServers": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List the eureka server settings.", + "operationId": "EurekaServers_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding eureka server settings.", + "schema": { + "$ref": "#/definitions/EurekaServerResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "EurekaServers_List_Consumption": { + "$ref": "./examples/EurekaServers_List_Consumption.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/eurekaServers/default": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the eureka server settings.", + "operationId": "EurekaServers_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding eureka server settings.", + "schema": { + "$ref": "#/definitions/EurekaServerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "EurekaServers_Get_Consumption": { + "$ref": "./examples/EurekaServers_Get_Consumption.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Update the eureka server settings.", + "operationId": "EurekaServers_UpdatePut", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "eurekaServerResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/EurekaServerResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated eureka server settings.", + "schema": { + "$ref": "#/definitions/EurekaServerResource" + } + }, + "201": { + "description": "Created. The response indicates the exiting eureka server settings are now updating and contain a Azure-AsyncOperation\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/EurekaServerResource" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "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": "azure-async-operation" + }, + "x-ms-examples": { + "EurekaServers_UpdatePut_Consumption": { + "$ref": "./examples/EurekaServers_UpdatePut_Consumption.json" + } + } + }, + "patch": { + "tags": [ + "AppPlatform" + ], + "description": "Update the eureka server settings.", + "operationId": "EurekaServers_UpdatePatch", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "eurekaServerResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/EurekaServerResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated eureka server settings.", + "schema": { + "$ref": "#/definitions/EurekaServerResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting eureka server settings are now updating and contain a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/EurekaServerResource" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "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": { + "EurekaServers_UpdatePatch": { + "$ref": "./examples/EurekaServers_UpdatePatch_Consumption.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/default": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the config server and its properties.", + "operationId": "ConfigServers_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Config Server.", + "schema": { + "$ref": "#/definitions/ConfigServerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ConfigServers_Get": { + "$ref": "./examples/ConfigServers_Get.json" + }, + "ConfigServers_Get_Consumption": { + "$ref": "./examples/ConfigServers_Get_Consumption.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Update the config server.", + "operationId": "ConfigServers_UpdatePut", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "configServerResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigServerResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Config Server.", + "schema": { + "$ref": "#/definitions/ConfigServerResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Config Server is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/ConfigServerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ConfigServers_UpdatePut": { + "$ref": "./examples/ConfigServers_UpdatePut.json" + }, + "ConfigServers_UpdatePut_Consumption": { + "$ref": "./examples/ConfigServers_UpdatePut_Consumption.json" + } + } + }, + "patch": { + "tags": [ + "AppPlatform" + ], + "description": "Update the config server.", + "operationId": "ConfigServers_UpdatePatch", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "configServerResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigServerResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Config Server.", + "schema": { + "$ref": "#/definitions/ConfigServerResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Config Server is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/ConfigServerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ConfigServers_UpdatePatch": { + "$ref": "./examples/ConfigServers_UpdatePatch.json" + }, + "ConfigServers_UpdatePatch_Consumption": { + "$ref": "./examples/ConfigServers_UpdatePatch_Consumption.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/validate": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Check if the config server settings are valid.", + "operationId": "ConfigServers_Validate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "configServerSettings", + "in": "body", + "description": "Config server settings to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigServerSettings" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the validation result of Config Server.", + "schema": { + "$ref": "#/definitions/ConfigServerSettingsValidateResult" + } + }, + "202": { + "description": "Accepted. The response indicates the ConfigServerSetting is validating.", + "schema": { + "$ref": "#/definitions/ConfigServerSettingsValidateResult" + } + }, + "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": { + "ConfigServers_Validate": { + "$ref": "./examples/ConfigServers_Validate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the Application Configuration Service and its properties.", + "operationId": "ConfigurationServices_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Application Configuration Service.", + "schema": { + "$ref": "#/definitions/ConfigurationServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ConfigurationServices_Get": { + "$ref": "./examples/ConfigurationServices_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create the default Application Configuration Service or update the existing Application Configuration Service.", + "operationId": "ConfigurationServices_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationServiceNameParameter" + }, + { + "name": "configurationServiceResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationServiceResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Application Configuration Service.", + "schema": { + "$ref": "#/definitions/ConfigurationServiceResource" + } + }, + "201": { + "description": "Created. The response describes the new Service and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ConfigurationServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ConfigurationServices_CreateOrUpdate": { + "$ref": "./examples/ConfigurationServices_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Disable the default Application Configuration Service.", + "operationId": "ConfigurationServices_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the default Application Configuration Service has deleted." + }, + "202": { + "description": "Accepted. The response indicates the default Application Configuration Service is now deleting." + }, + "204": { + "description": "Success. The response indicates the default Application Configuration Service doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ConfigurationServices_Delete": { + "$ref": "./examples/ConfigurationServices_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in a Service.", + "operationId": "ConfigurationServices_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of configuration service in the Service.", + "schema": { + "$ref": "#/definitions/ConfigurationServiceResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConfigurationServices_List": { + "$ref": "./examples/ConfigurationServices_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}/validate": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Check if the Application Configuration Service settings are valid.", + "operationId": "ConfigurationServices_Validate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationServiceNameParameter" + }, + { + "name": "settings", + "in": "body", + "description": "Application Configuration Service settings to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationServiceSettings" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the validation result of Application Configuration Service.", + "schema": { + "$ref": "#/definitions/ConfigurationServiceSettingsValidateResult" + } + }, + "202": { + "description": "Accepted. The response indicates the ConfigurationServiceSettings is validating.", + "schema": { + "$ref": "#/definitions/ConfigurationServiceSettingsValidateResult" + } + }, + "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": { + "ConfigurationServices_Validate": { + "$ref": "./examples/ConfigurationServices_Validate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}/validateResource": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Check if the Application Configuration Service resource is valid.", + "operationId": "ConfigurationServices_ValidateResource", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationServiceNameParameter" + }, + { + "name": "configurationServiceResource", + "in": "body", + "description": "Application Configuration Service resource to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationServiceResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the validation result of Application Configuration Service.", + "schema": { + "$ref": "#/definitions/ConfigurationServiceSettingsValidateResult" + } + }, + "202": { + "description": "Accepted. The response indicates the ConfigurationServiceSettings is validating.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "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": { + "ConfigurationServices_ValidateResource": { + "$ref": "./examples/ConfigurationServices_ValidateResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the Service Registry and its properties.", + "operationId": "ServiceRegistries_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ServiceRegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Service Registry.", + "schema": { + "$ref": "#/definitions/ServiceRegistryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ServiceRegistries_Get": { + "$ref": "./examples/ServiceRegistries_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create the default Service Registry or update the existing Service Registry.", + "operationId": "ServiceRegistries_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ServiceRegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Service Registry.", + "schema": { + "$ref": "#/definitions/ServiceRegistryResource" + } + }, + "201": { + "description": "Created. The response describes the new created Service Registry and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ServiceRegistryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServiceRegistries_CreateOrUpdate": { + "$ref": "./examples/ServiceRegistries_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Disable the default Service Registry.", + "operationId": "ServiceRegistries_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ServiceRegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the default Service Registries has deleted." + }, + "202": { + "description": "Accepted. The response indicates the default Service Registries is now deleting." + }, + "204": { + "description": "Success. The response indicates the default Service Registries doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServiceRegistries_Delete": { + "$ref": "./examples/ServiceRegistries_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in a Service.", + "operationId": "ServiceRegistries_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Service Registry resources in the Service.", + "schema": { + "$ref": "#/definitions/ServiceRegistryResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServiceRegistries_List": { + "$ref": "./examples/ServiceRegistries_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationLiveViews": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in a Service.", + "operationId": "ApplicationLiveViews_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Application Live View resources in the Service.", + "schema": { + "$ref": "#/definitions/ApplicationLiveViewResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApplicationLiveViews_List": { + "$ref": "./examples/ApplicationLiveViews_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationLiveViews/{applicationLiveViewName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the Application Live and its properties.", + "operationId": "ApplicationLiveViews_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationLiveViewNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Application Live View.", + "schema": { + "$ref": "#/definitions/ApplicationLiveViewResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationLiveViews_Get": { + "$ref": "./examples/ApplicationLiveViews_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create the default Application Live View or update the existing Application Live View.", + "operationId": "ApplicationLiveViews_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationLiveViewNameParameter" + }, + { + "name": "applicationLiveViewResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationLiveViewResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Application Live View.", + "schema": { + "$ref": "#/definitions/ApplicationLiveViewResource" + } + }, + "201": { + "description": "Created. The response describes the new created Application Live View and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ApplicationLiveViewResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApplicationLiveViews_CreateOrUpdate": { + "$ref": "./examples/ApplicationLiveViews_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Disable the default Application Live View.", + "operationId": "ApplicationLiveViews_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationLiveViewNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the default Application Live View is now deleting.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the defaultApplication Live View doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApplicationLiveViews_Delete": { + "$ref": "./examples/ApplicationLiveView_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/devToolPortals": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in a Service.", + "operationId": "DevToolPortals_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Dev Tool Portal resources in the Service.", + "schema": { + "$ref": "#/definitions/DevToolPortalResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DevToolPortals_List": { + "$ref": "./examples/DevToolPortals_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/DevToolPortals/{devToolPortalName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the Application Live and its properties.", + "operationId": "DevToolPortals_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/DevToolPortalNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Dev Tool Portal.", + "schema": { + "$ref": "#/definitions/DevToolPortalResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevToolPortals_Get": { + "$ref": "./examples/DevToolPortals_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create the default Dev Tool Portal or update the existing Dev Tool Portal.", + "operationId": "DevToolPortals_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/DevToolPortalNameParameter" + }, + { + "name": "DevToolPortalResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/DevToolPortalResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Dev Tool Portal.", + "schema": { + "$ref": "#/definitions/DevToolPortalResource" + } + }, + "201": { + "description": "Created. The response describes the new created Dev Tool Portal and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/DevToolPortalResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DevToolPortals_CreateOrUpdate": { + "$ref": "./examples/DevToolPortals_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Disable the default Dev Tool Portal.", + "operationId": "DevToolPortals_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/DevToolPortalNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the default Dev Tool Portal is now deleting.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the defaultDev Tool Portal doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DevToolPortals_Delete": { + "$ref": "./examples/DevToolPortal_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List container registries resource.", + "operationId": "ContainerRegistries_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the Container Registries to one Azure Spring Apps resource.", + "schema": { + "$ref": "#/definitions/ContainerRegistryResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ContainerRegistries_List": { + "$ref": "./examples/ContainerRegistries_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries/{containerRegistryName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the container registries resource.", + "operationId": "ContainerRegistries_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ContainerRegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the container registry.", + "schema": { + "$ref": "#/definitions/ContainerRegistryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ContainerRegistries_Get": { + "$ref": "./examples/ContainerRegistries_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update container registry resource.", + "operationId": "ContainerRegistries_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ContainerRegistryNameParameter" + }, + { + "name": "containerRegistryResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerRegistryResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the existed container registry updated.", + "schema": { + "$ref": "#/definitions/ContainerRegistryResource" + } + }, + "201": { + "description": "Created. The response describes the new container registry resource created and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ContainerRegistryResource" + } + }, + "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": { + "ContainerRegistries_CreateOrUpdate": { + "$ref": "./examples/ContainerRegistries_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete a container registry resource.", + "operationId": "ContainerRegistries_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ContainerRegistryNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the resource doesn't exist." + }, + "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": { + "ContainerRegistries_Delete": { + "$ref": "./examples/ContainerRegistries_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries/{containerRegistryName}/validate": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Check if the container registry properties are valid.", + "operationId": "ContainerRegistries_Validate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ContainerRegistryNameParameter" + }, + { + "name": "ContainerRegistryProperties", + "in": "body", + "description": "Parameters for the validate operation", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerRegistryProperties" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the validation result of container registry.", + "schema": { + "$ref": "#/definitions/ContainerRegistryValidateResult" + } + }, + "202": { + "description": "Accepted. The response indicates the container registry properties is validating.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "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": { + "ContainerRegistries_Validate": { + "$ref": "./examples/ContainerRegistries_Validate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List build services resource.", + "operationId": "BuildService_ListBuildServices", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the Build Services.", + "schema": { + "$ref": "#/definitions/BuildServiceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BuildService_ListBuildServices": { + "$ref": "./examples/BuildService_ListBuildServices.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get a build service resource.", + "operationId": "BuildService_GetBuildService", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the Build Service.", + "schema": { + "$ref": "#/definitions/BuildService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildService_GetBuildService": { + "$ref": "./examples/BuildService_GetBuildService.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create a build service resource.", + "operationId": "BuildService_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "name": "buildService", + "in": "body", + "description": "Parameters for the create operation", + "required": true, + "schema": { + "$ref": "#/definitions/BuildService" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the Build Service.", + "schema": { + "$ref": "#/definitions/BuildService" + } + }, + "201": { + "description": "Created. The response describes the Build Service and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/BuildService" + } + }, + "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": { + "BuildService_CreateOrUpdate": { + "$ref": "./examples/BuildService_CreateOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List KPack builds.", + "operationId": "BuildService_ListBuilds", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the builds.", + "schema": { + "$ref": "#/definitions/BuildCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BuildService_ListBuilds": { + "$ref": "./examples/BuildService_ListBuilds.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get a KPack build.", + "operationId": "BuildService_GetBuild", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the Build.", + "schema": { + "$ref": "#/definitions/Build" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildService_GetBuild": { + "$ref": "./examples/BuildService_GetBuild.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update a KPack build.", + "operationId": "BuildService_CreateOrUpdateBuild", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + }, + { + "name": "build", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/Build" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Build.", + "schema": { + "$ref": "#/definitions/Build" + } + }, + "201": { + "description": "Created. The response describes the new Build and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/Build" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildService_CreateOrUpdateBuild": { + "$ref": "./examples/BuildService_CreateOrUpdateBuild.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "delete a KPack build.", + "operationId": "BuildService_DeleteBuild", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the build resource doesn't exist or has deleted." + }, + "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": { + "BuildService_DeleteBuild": { + "$ref": "./examples/BuildService_DeleteBuild.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildpackBindings": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get collection of buildpack bindings under all builders.", + "operationId": "BuildpackBinding_ListForCluster", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of buildpack bindings under all builders in the cluster.", + "schema": { + "$ref": "#/definitions/BuildpackBindingResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BuildpackBinding_ListForCluster": { + "$ref": "./examples/BuildpackBinding_ListForCluster.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings/{buildpackBindingName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get a buildpack binding by name.", + "operationId": "BuildpackBinding_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildpackBindingNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a Buildpack Binding.", + "schema": { + "$ref": "#/definitions/BuildpackBindingResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildpackBinding_Get": { + "$ref": "./examples/BuildpackBinding_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update a buildpack binding.", + "operationId": "BuildpackBinding_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildpackBindingNameParameter" + }, + { + "name": "buildpackBinding", + "in": "body", + "description": "The target buildpack binding for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/BuildpackBindingResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes a Buildpack Binding for the create or update operation.", + "schema": { + "$ref": "#/definitions/BuildpackBindingResource" + } + }, + "201": { + "description": "Created. The response describes the new Buildpack Binding and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/BuildpackBindingResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BuildpackBinding_CreateOrUpdate": { + "$ref": "./examples/BuildpackBinding_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to delete a Buildpack Binding", + "operationId": "BuildpackBinding_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildpackBindingNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BuildpackBinding_Delete": { + "$ref": "./examples/BuildpackBinding_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all buildpack bindings in a builder.", + "operationId": "BuildpackBinding_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Buildpack Binding in the builder.", + "schema": { + "$ref": "#/definitions/BuildpackBindingResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BuildpackBinding_Get": { + "$ref": "./examples/BuildpackBinding_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List KPack build results.", + "operationId": "BuildService_ListBuildResults", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the build results.", + "schema": { + "$ref": "#/definitions/BuildResultCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BuildService_ListBuildResults": { + "$ref": "./examples/BuildService_ListBuildResults.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results/{buildResultName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get a KPack build result.", + "operationId": "BuildService_GetBuildResult", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + }, + { + "$ref": "#/parameters/BuildResultNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the build result.", + "schema": { + "$ref": "#/definitions/BuildResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildService_GetBuildResult": { + "$ref": "./examples/BuildService_GetBuildResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results/{buildResultName}/getLogFileUrl": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Get a KPack build result log download URL.", + "operationId": "BuildService_GetBuildResultLog", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + }, + { + "$ref": "#/parameters/BuildResultNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. Build result log exists and can be downloaded.", + "schema": { + "$ref": "#/definitions/BuildResultLog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildService_GetBuildResultLog": { + "$ref": "./examples/BuildService_GetBuildResultLog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get a KPack builder.", + "operationId": "BuildServiceBuilder_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the Builder", + "schema": { + "$ref": "#/definitions/BuilderResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildServiceBuilder_Get": { + "$ref": "./examples/BuildServiceBuilder_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update a KPack builder.", + "operationId": "BuildServiceBuilder_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + }, + { + "name": "builderResource", + "in": "body", + "description": "The target builder for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/BuilderResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the Builder", + "schema": { + "$ref": "#/definitions/BuilderResource" + } + }, + "201": { + "description": "Created. The response describes the new Builder and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/BuilderResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BuildServiceBuilder_CreateOrUpdate": { + "$ref": "./examples/BuildServiceBuilder_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete a KPack builder.", + "operationId": "BuildServiceBuilder_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the builder resource has deleted." + }, + "202": { + "description": "Accepted. The response indicates the builder resource is deleting." + }, + "204": { + "description": "Success. The response indicates the builder resource doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BuildServiceBuilder_Delete": { + "$ref": "./examples/BuildServiceBuilder_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List KPack builders result.", + "operationId": "BuildServiceBuilder_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the Builder List", + "schema": { + "$ref": "#/definitions/BuilderResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BuildServiceBuilder_List": { + "$ref": "./examples/BuildServiceBuilder_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/getResourceUploadUrl": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Get an resource upload URL for build service, which may be artifacts or source archive.", + "operationId": "BuildService_GetResourceUploadUrl", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the resource upload URL.", + "schema": { + "$ref": "#/definitions/ResourceUploadDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildService_GetResourceUploadUrl": { + "$ref": "./examples/BuildService_GetResourceUploadUrl.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedBuildpacks": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get all supported buildpacks.", + "operationId": "BuildService_ListSupportedBuildpacks", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes all supported buildpacks.", + "schema": { + "$ref": "#/definitions/SupportedBuildpacksCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildService_ListSupportedBuildpacks": { + "$ref": "./examples/BuildService_ListSupportedBuildpacks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedBuildpacks/{buildpackName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the supported buildpack resource.", + "operationId": "BuildService_GetSupportedBuildpack", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceBuildpackNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the supported buildpack.", + "schema": { + "$ref": "#/definitions/SupportedBuildpackResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildService_GetSupportedBuildpack": { + "$ref": "./examples/BuildService_GetSupportedBuildpack.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedStacks": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get all supported stacks.", + "operationId": "BuildService_ListSupportedStacks", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes all supported stacks.", + "schema": { + "$ref": "#/definitions/SupportedStacksCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildService_ListSupportedStacks": { + "$ref": "./examples/BuildService_ListSupportedStacks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedStacks/{stackName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the supported stack resource.", + "operationId": "BuildService_GetSupportedStack", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceStackNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the supported stack.", + "schema": { + "$ref": "#/definitions/SupportedStackResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildService_GetSupportedStack": { + "$ref": "./examples/BuildService_GetSupportedStack.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/agentPools": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List build service agent pool.", + "operationId": "BuildServiceAgentPool_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes build service agent pool.", + "schema": { + "$ref": "#/definitions/BuildServiceAgentPoolResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BuildServiceAgentPool_List": { + "$ref": "./examples/BuildServiceAgentPool_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get build service agent pool.", + "operationId": "BuildServiceAgentPool_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceAgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes build service agent pool.", + "schema": { + "$ref": "#/definitions/BuildServiceAgentPoolResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildServiceAgentPool_Get": { + "$ref": "./examples/BuildServiceAgentPool_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update build service agent pool.", + "operationId": "BuildServiceAgentPool_UpdatePut", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceAgentPoolNameParameter" + }, + { + "name": "agentPoolResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/BuildServiceAgentPoolResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes build service agent pool.", + "schema": { + "$ref": "#/definitions/BuildServiceAgentPoolResource" + } + }, + "201": { + "description": "Created. The response describes the new build service agent pool and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/BuildServiceAgentPoolResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BuildServiceAgentPool_UpdatePut": { + "$ref": "./examples/BuildServiceAgentPool_UpdatePut.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/monitoringSettings/default": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the Monitoring Setting and its properties.", + "operationId": "MonitoringSettings_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Monitoring Setting.", + "schema": { + "$ref": "#/definitions/MonitoringSettingResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "MonitoringSettings_Get": { + "$ref": "./examples/MonitoringSettings_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Update the Monitoring Setting.", + "operationId": "MonitoringSettings_UpdatePut", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "monitoringSettingResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/MonitoringSettingResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Monitoring Setting.", + "schema": { + "$ref": "#/definitions/MonitoringSettingResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Monitoring Setting is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/MonitoringSettingResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "MonitoringSettings_UpdatePut": { + "$ref": "./examples/MonitoringSettings_UpdatePut.json" + } + } + }, + "patch": { + "tags": [ + "AppPlatform" + ], + "description": "Update the Monitoring Setting.", + "operationId": "MonitoringSettings_UpdatePatch", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "monitoringSettingResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/MonitoringSettingResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Monitoring Setting.", + "schema": { + "$ref": "#/definitions/MonitoringSettingResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Monitoring Setting is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/MonitoringSettingResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "MonitoringSettings_UpdatePatch": { + "$ref": "./examples/MonitoringSettings_UpdatePatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get an App and its properties.", + "operationId": "Apps_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "name": "syncStatus", + "in": "query", + "description": "Indicates whether sync status", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding App.", + "schema": { + "$ref": "#/definitions/AppResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Apps_Get": { + "$ref": "./examples/Apps_Get.json" + }, + "Apps_Get_VNetInjection": { + "$ref": "./examples/Apps_Get_VNetInjection.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create a new App or update an exiting App.", + "operationId": "Apps_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "name": "appResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/AppResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated App.", + "schema": { + "$ref": "#/definitions/AppResource" + } + }, + "201": { + "description": "Created. The response describes the new App and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/AppResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting App is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/AppResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Apps_CreateOrUpdate": { + "$ref": "./examples/Apps_CreateOrUpdate.json" + }, + "Apps_CreateOrUpdate_VNetInjection": { + "$ref": "./examples/Apps_CreateOrUpdate_VNetInjection.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to delete an App.", + "operationId": "Apps_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Apps_Delete": { + "$ref": "./examples/Apps_Delete.json" + } + } + }, + "patch": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to update an exiting App.", + "operationId": "Apps_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "name": "appResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/AppResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated App.", + "schema": { + "$ref": "#/definitions/AppResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting App is now updating and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/AppResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Apps_Update": { + "$ref": "./examples/Apps_Update.json" + }, + "Apps_Update_VNetInjection": { + "$ref": "./examples/Apps_Update_VNetInjection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in a Service.", + "operationId": "Apps_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Apps in the Service.", + "schema": { + "$ref": "#/definitions/AppResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Apps_List": { + "$ref": "./examples/Apps_List.json" + }, + "Apps_List_VNetInjection": { + "$ref": "./examples/Apps_List_VNetInjection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/getResourceUploadUrl": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Get an resource upload URL for an App, which may be artifacts or source archive.", + "operationId": "Apps_GetResourceUploadUrl", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the resource upload URL.", + "schema": { + "$ref": "#/definitions/ResourceUploadDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Apps_GetResourceUploadUrl": { + "$ref": "./examples/Apps_GetResourceUploadUrl.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/setActiveDeployments": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Set existing Deployment under the app as active", + "operationId": "Apps_SetActiveDeployments", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "name": "activeDeploymentCollection", + "in": "body", + "description": "A list of Deployment name to be active.", + "required": true, + "schema": { + "$ref": "#/definitions/ActiveDeploymentCollection" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the active deployment.", + "schema": { + "$ref": "#/definitions/AppResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Binding is now updating and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/AppResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Apps_SetActiveDeployments": { + "$ref": "./examples/Apps_SetActiveDeployments.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings/{bindingName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get a Binding and its properties.", + "operationId": "Bindings_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/BindingNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Binding.", + "schema": { + "$ref": "#/definitions/BindingResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Bindings_Get": { + "$ref": "./examples/Bindings_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create a new Binding or update an exiting Binding.", + "operationId": "Bindings_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/BindingNameParameter" + }, + { + "name": "bindingResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/BindingResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the created or updated Binding.", + "schema": { + "$ref": "#/definitions/BindingResource" + } + }, + "201": { + "description": "Created. The response describes the new Binding and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/BindingResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Binding is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/BindingResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Bindings_CreateOrUpdate": { + "$ref": "./examples/Bindings_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to delete a Binding.", + "operationId": "Bindings_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/BindingNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Bindings_Delete": { + "$ref": "./examples/Bindings_Delete.json" + } + } + }, + "patch": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to update an exiting Binding.", + "operationId": "Bindings_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/BindingNameParameter" + }, + { + "name": "bindingResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/BindingResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Binding.", + "schema": { + "$ref": "#/definitions/BindingResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Binding is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/BindingResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Bindings_Update": { + "$ref": "./examples/Bindings_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in an App.", + "operationId": "Bindings_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Bindings in the App.", + "schema": { + "$ref": "#/definitions/BindingResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Bindings_List": { + "$ref": "./examples/Bindings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages/{storageName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the storage resource.", + "operationId": "Storages_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/StorageNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the storage.", + "schema": { + "$ref": "#/definitions/StorageResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Storages_Get": { + "$ref": "./examples/Storages_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update storage resource.", + "operationId": "Storages_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/StorageNameParameter" + }, + { + "name": "storageResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/StorageResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the existed storage updated.", + "schema": { + "$ref": "#/definitions/StorageResource" + } + }, + "201": { + "description": "Created. The response describes the new storage resource created and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/StorageResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting storage is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/StorageResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Storages_CreateOrUpdate": { + "$ref": "./examples/Storages_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the storage resource.", + "operationId": "Storages_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/StorageNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the storage deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "No content. The response indicates the storage doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Storages_Delete": { + "$ref": "./examples/Storages_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List all the storages of one Azure Spring Apps resource.", + "operationId": "Storages_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe all the storages attached to one Azure Spring Apps resource.", + "schema": { + "$ref": "#/definitions/StorageResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Storages_List": { + "$ref": "./examples/Storages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the certificate resource.", + "operationId": "Certificates_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the certificate.", + "schema": { + "$ref": "#/definitions/CertificateResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Certificates_Get": { + "$ref": "./examples/Certificates_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update certificate resource.", + "operationId": "Certificates_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "name": "certificateResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the existed certificate updated.", + "schema": { + "$ref": "#/definitions/CertificateResource" + } + }, + "201": { + "description": "Created. The response describes the new certificate and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/CertificateResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting certificate is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/CertificateResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Certificates_CreateOrUpdate": { + "$ref": "./examples/Certificates_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the certificate resource.", + "operationId": "Certificates_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the certificate deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "No content. The response indicates the certificate doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Certificates_Delete": { + "$ref": "./examples/Certificates_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List all the certificates of one user.", + "operationId": "Certificates_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the list of certificates in the Service.", + "schema": { + "$ref": "#/definitions/CertificateResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Certificates_List": { + "$ref": "./examples/Certificates_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Checks that the resource name is valid and is not already in use.", + "operationId": "Services_CheckNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "the region", + "required": true, + "type": "string" + }, + { + "name": "availabilityParameters", + "in": "body", + "description": "Parameters supplied to the operation.", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Services_CheckNameAvailability": { + "$ref": "./examples/Services_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains/{domainName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the custom domain of one lifecycle application.", + "operationId": "CustomDomains_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/CustomDomainNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the custom domain.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CustomDomains_Get": { + "$ref": "./examples/CustomDomains_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update custom domain of one lifecycle application.", + "operationId": "CustomDomains_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/CustomDomainNameParameter" + }, + { + "name": "domainResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the existed custom domain updated.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "201": { + "description": "Created. The response describes the new custom domain and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting custom domain is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CustomDomains_CreateOrUpdate": { + "$ref": "./examples/CustomDomains_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the custom domain of one lifecycle application.", + "operationId": "CustomDomains_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/CustomDomainNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the custom domain deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "No content. The response indicates the custom domain doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CustomDomains_Delete": { + "$ref": "./examples/CustomDomains_Delete.json" + } + } + }, + "patch": { + "tags": [ + "AppPlatform" + ], + "description": "Update custom domain of one lifecycle application.", + "operationId": "CustomDomains_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/CustomDomainNameParameter" + }, + { + "name": "domainResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the existed custom domain updated.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting custom domain is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CustomDomains_Update": { + "$ref": "./examples/CustomDomains_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List the custom domains of one lifecycle application.", + "operationId": "CustomDomains_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the custom domain resource list of one application.", + "schema": { + "$ref": "#/definitions/CustomDomainResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CustomDomains_List": { + "$ref": "./examples/CustomDomains_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/validateDomain": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Check the resource name is valid as well as not in use.", + "operationId": "Apps_ValidateDomain", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "name": "validatePayload", + "in": "body", + "description": "Custom domain payload to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainValidatePayload" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the name is available.", + "schema": { + "$ref": "#/definitions/CustomDomainValidateResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Apps_ValidateDomain": { + "$ref": "./examples/Apps_ValidateDomain.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get a Deployment and its properties.", + "operationId": "Deployments_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Deployment.", + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Deployments_Get": { + "$ref": "./examples/Deployments_Get.json" + }, + "Deployments_Get_CustomContainer": { + "$ref": "./examples/Deployments_Get_CustomContainer.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create a new Deployment or update an exiting Deployment.", + "operationId": "Deployments_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "deploymentResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Deployment.", + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + }, + "201": { + "description": "Created. The response describes the new Deployment and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Deployment is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_CreateOrUpdate": { + "$ref": "./examples/Deployments_CreateOrUpdate.json" + }, + "Deployments_CreateOrUpdate_CustomContainer": { + "$ref": "./examples/Deployments_CreateOrUpdate_CustomContainer.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to delete a Deployment.", + "operationId": "Deployments_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_Delete": { + "$ref": "./examples/Deployments_Delete.json" + } + } + }, + "patch": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to update an exiting Deployment.", + "operationId": "Deployments_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "deploymentResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Deployment.", + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Deployment is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_Update": { + "$ref": "./examples/Deployments_Update.json" + }, + "Deployments_Update_CustomContainer": { + "$ref": "./examples/Deployments_Update_CustomContainer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in an App.", + "operationId": "Deployments_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "name": "version", + "in": "query", + "description": "Version of the deployments to be listed", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "uniqueItems": false + }, + { + "name": "$expand", + "in": "query", + "description": "The expand expression to apply on the operation.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Deployments in the App.", + "schema": { + "$ref": "#/definitions/DeploymentResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Deployments_List": { + "$ref": "./examples/Deployments_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/deployments": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List deployments for a certain service", + "operationId": "Deployments_ListForCluster", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "version", + "in": "query", + "description": "Version of the deployments to be listed", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "uniqueItems": false + }, + { + "name": "$expand", + "in": "query", + "description": "The expand expression to apply on the operation.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Deployments_ListForCluster": { + "$ref": "./examples/Deployments_ListForCluster.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/listUsingDeployments": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "List deployments that are using the builder.", + "operationId": "BuildServiceBuilder_ListDeployments", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BuildServiceBuilder_ListDeployments": { + "$ref": "./examples/BuildServiceBuilder_ListDeployments.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/start": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Start the deployment.", + "operationId": "Deployments_Start", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the Deployment is now starting and contains a Location header to\r\nquery the operation result." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_Start": { + "$ref": "./examples/Deployments_Start.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/stop": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Stop the deployment.", + "operationId": "Deployments_Stop", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the Deployment is now stopping and contains a Location header to\r\nquery the operation result." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_Stop": { + "$ref": "./examples/Deployments_Stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/restart": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Restart the deployment.", + "operationId": "Deployments_Restart", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the Deployment is now restarting and contains a Location header\r\nto query the operation result." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_Restart": { + "$ref": "./examples/Deployments_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/enableRemoteDebugging": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Enable remote debugging.", + "operationId": "Deployments_EnableRemoteDebugging", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "remoteDebuggingPayload", + "in": "body", + "description": "Parameters for enable remote debugging", + "required": false, + "schema": { + "$ref": "#/definitions/RemoteDebuggingPayload" + } + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/RemoteDebugging" + } + }, + "202": { + "description": "Accepted. The response indicates the RemoteDebugging is now enabling and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/RemoteDebugging" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_EnableRemoteDebugging": { + "$ref": "./examples/Deployments_EnableRemoteDebugging.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/disableRemoteDebugging": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Disable remote debugging.", + "operationId": "Deployments_DisableRemoteDebugging", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/RemoteDebugging" + } + }, + "202": { + "description": "Accepted. The response indicates the RemoteDebugging is now disabling and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/RemoteDebugging" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_DisableRemoteDebugging": { + "$ref": "./examples/Deployments_DisableRemoteDebugging.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/getRemoteDebuggingConfig": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Get remote debugging config.", + "operationId": "Deployments_GetRemoteDebuggingConfig", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/RemoteDebugging" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Deployments_GetRemoteDebuggingConfig": { + "$ref": "./examples/Deployments_GetRemoteDebuggingConfig.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/getLogFileUrl": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Get deployment log file URL", + "operationId": "Deployments_GetLogFileUrl", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response contains the log file URL.", + "schema": { + "$ref": "#/definitions/LogFileUrlResponse" + } + }, + "204": { + "description": "Success. The deployment does not have log file." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Deployments_GetLogFileUrl": { + "$ref": "./examples/Deployments_GetLogFileUrl.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/generateHeapDump": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Generate Heap Dump", + "operationId": "Deployments_GenerateHeapDump", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "diagnosticParameters", + "in": "body", + "description": "Parameters for the diagnostic operation", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticParameters" + } + } + ], + "responses": { + "200": { + "description": "Success. A heap dump was generated." + }, + "202": { + "description": "Accepted. The response indicates a heap dump is generating." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_GenerateHeapDump": { + "$ref": "./examples/Deployments_GenerateHeapDump.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/generateThreadDump": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Generate Thread Dump", + "operationId": "Deployments_GenerateThreadDump", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "diagnosticParameters", + "in": "body", + "description": "Parameters for the diagnostic operation", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticParameters" + } + } + ], + "responses": { + "200": { + "description": "Success. A thread dump was generated." + }, + "202": { + "description": "Accepted. The response indicates a thread dump is generating." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_GenerateHeapDump": { + "$ref": "./examples/Deployments_GenerateThreadDump.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/startJFR": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Start JFR", + "operationId": "Deployments_StartJFR", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "diagnosticParameters", + "in": "body", + "description": "Parameters for the diagnostic operation", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticParameters" + } + } + ], + "responses": { + "200": { + "description": "Success. A JFR generated." + }, + "202": { + "description": "Accepted. The response indicates a JFR is starting." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_StartJFR": { + "$ref": "./examples/Deployments_StartJFR.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/Spring": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in a subscription.", + "operationId": "Services_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Services in the subscription.", + "schema": { + "$ref": "#/definitions/ServiceResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Services_ListBySubscription": { + "$ref": "./examples/Services_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "Services_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Services in the resource group.", + "schema": { + "$ref": "#/definitions/ServiceResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Services_List": { + "$ref": "./examples/Services_List.json" + } + } + } + }, + "/providers/Microsoft.AppPlatform/operations": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Lists all of the available REST API operations of the Microsoft.AppPlatform provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/AvailableOperations" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/providers/Microsoft.AppPlatform/runtimeVersions": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Lists all of the available runtime versions supported by Microsoft.AppPlatform provider.", + "operationId": "RuntimeVersions_ListRuntimeVersions", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the details of all supported deployment runtime versions.", + "schema": { + "$ref": "#/definitions/AvailableRuntimeVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "RuntimeVersions_ListRuntimeVersions": { + "$ref": "./examples/RuntimeVersions_ListRuntimeVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/skus": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Lists all of the available skus of the Microsoft.AppPlatform provider.", + "operationId": "Skus_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourceSkuCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Skus_List": { + "$ref": "./examples/Skus_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/supportedServerVersions": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Lists all of the available server versions supported by Microsoft.AppPlatform provider.", + "operationId": "Services_ListSupportedServerVersions", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the supported server versions.", + "schema": { + "$ref": "#/definitions/SupportedServerVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Services_ListSupportedServerVersions": { + "$ref": "./examples/Services_ListSupportedServerVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the Spring Cloud Gateway and its properties.", + "operationId": "Gateways_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Spring Cloud Gateway.", + "schema": { + "$ref": "#/definitions/GatewayResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gateways_Get": { + "$ref": "./examples/Gateways_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.", + "operationId": "Gateways_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "name": "gatewayResource", + "in": "body", + "description": "The gateway for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Spring Cloud Gateway.", + "schema": { + "$ref": "#/definitions/GatewayResource" + } + }, + "201": { + "description": "Created. The response describes the new created Spring Cloud Gateway and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/GatewayResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Gateways_CreateOrUpdate": { + "$ref": "./examples/Gateways_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to update an exiting Spring Cloud Gateway capacity.", + "operationId": "Gateways_UpdateCapacity", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "name": "gatewayCapacityResource", + "in": "body", + "description": "The gateway capacity for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/SkuObject" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Spring Cloud Gateway capacity.", + "schema": { + "$ref": "#/definitions/GatewayResource" + } + }, + "202": { + "description": "Accepted. The response indicates the new exiting Spring Cloud Gateway capacity is now updating and contains a Location\r\nheader to query the operation result.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "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": { + "Gateway_Scale": { + "$ref": "./examples/Gateway_Scale.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Disable the default Spring Cloud Gateway.", + "operationId": "Gateways_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the default Spring Cloud Gateway has deleted." + }, + "202": { + "description": "Accepted. The response indicates the default Spring Cloud Gateway is now deleting." + }, + "204": { + "description": "Success. The response indicates the default Spring Cloud Gateway doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Gateways_Delete": { + "$ref": "./examples/Gateways_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/listEnvSecrets": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "List sensitive environment variables of Spring Cloud Gateway.", + "operationId": "Gateways_ListEnvSecrets", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the sensitive environment variables of Spring Cloud Gateway.", + "schema": { + "$ref": "#/definitions/GatewayEnvSecrets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gateways_ListEnvSecrets": { + "$ref": "./examples/Gateways_ListEnvSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/restart": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Restart the Spring Cloud Gateway.", + "operationId": "Gateways_Restart", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates gateway is now restarting and contains a Location header\r\nto query the operation result.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "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": { + "Gateways_Restart": { + "$ref": "./examples/Gateways_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in a Service.", + "operationId": "Gateways_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of gateways in the Service.", + "schema": { + "$ref": "#/definitions/GatewayResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gateways_List": { + "$ref": "./examples/Gateways_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs/{routeConfigName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the Spring Cloud Gateway route configs.", + "operationId": "GatewayRouteConfigs_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "$ref": "#/parameters/GatewayRouteConfigNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Spring Cloud Gateway route configs.", + "schema": { + "$ref": "#/definitions/GatewayRouteConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GatewayRouteConfigs_Get": { + "$ref": "./examples/GatewayRouteConfigs_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create the default Spring Cloud Gateway route configs or update the existing Spring Cloud Gateway route configs.", + "operationId": "GatewayRouteConfigs_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "$ref": "#/parameters/GatewayRouteConfigNameParameter" + }, + { + "name": "gatewayRouteConfigResource", + "in": "body", + "description": "The Spring Cloud Gateway route config for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayRouteConfigResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Spring Cloud Gateway route configs.", + "schema": { + "$ref": "#/definitions/GatewayRouteConfigResource" + } + }, + "201": { + "description": "Created. The response describes the new created Spring Cloud Gateway route configs and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/GatewayRouteConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GatewayRouteConfigs_CreateOrUpdate": { + "$ref": "./examples/GatewayRouteConfigs_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the Spring Cloud Gateway route config.", + "operationId": "GatewayRouteConfigs_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "$ref": "#/parameters/GatewayRouteConfigNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the Spring Cloud Gateway route config has deleted." + }, + "202": { + "description": "Accepted. The response indicates the Spring Cloud Gateway route config is now deleting." + }, + "204": { + "description": "Success. The response indicates the Spring Cloud Gateway route config doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GatewayRouteConfigs_Delete": { + "$ref": "./examples/GatewayRouteConfigs_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handle requests to list all Spring Cloud Gateway route configs.", + "operationId": "GatewayRouteConfigs_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Spring Cloud Gateway route configs.", + "schema": { + "$ref": "#/definitions/GatewayRouteConfigResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GatewayRouteConfigs_List": { + "$ref": "./examples/GatewayRouteConfigs_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains/{domainName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the Spring Cloud Gateway custom domain.", + "operationId": "GatewayCustomDomains_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "$ref": "#/parameters/GatewayCustomDomainParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Spring Cloud Gateway custom domain.", + "schema": { + "$ref": "#/definitions/GatewayCustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GatewayCustomDomains_Get": { + "$ref": "./examples/GatewayCustomDomains_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update the Spring Cloud Gateway custom domain.", + "operationId": "GatewayCustomDomains_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "$ref": "#/parameters/GatewayCustomDomainParameter" + }, + { + "name": "gatewayCustomDomainResource", + "in": "body", + "description": "The gateway custom domain resource for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayCustomDomainResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Spring Cloud Gateway custom domain.", + "schema": { + "$ref": "#/definitions/GatewayCustomDomainResource" + } + }, + "201": { + "description": "Created. The response describes the new created Spring Cloud Gateway custom domain and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/GatewayCustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GatewayCustomDomains_CreateOrUpdate": { + "$ref": "./examples/GatewayCustomDomains_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the Spring Cloud Gateway custom domain.", + "operationId": "GatewayCustomDomains_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "$ref": "#/parameters/GatewayCustomDomainParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the Spring Cloud Gateway custom domain has deleted." + }, + "202": { + "description": "Accepted. The response indicates the Spring Cloud Gateway custom domain is now deleting." + }, + "204": { + "description": "Success. The response indicates the Spring Cloud Gateway custom domain doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GatewayCustomDomains_Delete": { + "$ref": "./examples/GatewayCustomDomains_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handle requests to list all Spring Cloud Gateway custom domains.", + "operationId": "GatewayCustomDomains_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Spring Cloud Gateway custom domains.", + "schema": { + "$ref": "#/definitions/GatewayCustomDomainResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GatewayCustomDomains_List": { + "$ref": "./examples/GatewayCustomDomains_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/validateDomain": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Check the domains are valid as well as not in use.", + "operationId": "Gateways_ValidateDomain", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "name": "validatePayload", + "in": "body", + "description": "Custom domain payload to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainValidatePayload" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the name is available.", + "schema": { + "$ref": "#/definitions/CustomDomainValidateResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gateways_ValidateDomain": { + "$ref": "./examples/Gateways_ValidateDomain.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the API portal and its properties.", + "operationId": "ApiPortals_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding API portal.", + "schema": { + "$ref": "#/definitions/ApiPortalResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApiPortals_Get": { + "$ref": "./examples/ApiPortals_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create the default API portal or update the existing API portal.", + "operationId": "ApiPortals_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + }, + { + "name": "apiPortalResource", + "in": "body", + "description": "The API portal for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ApiPortalResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated API portal.", + "schema": { + "$ref": "#/definitions/ApiPortalResource" + } + }, + "201": { + "description": "Created. The response describes the new created API portal and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ApiPortalResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApiPortals_CreateOrUpdate": { + "$ref": "./examples/ApiPortals_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the default API portal.", + "operationId": "ApiPortals_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the default API portal has deleted." + }, + "202": { + "description": "Accepted. The response indicates the default API portal is now deleting." + }, + "204": { + "description": "Success. The response indicates the default API portal doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApiPortals_Delete": { + "$ref": "./examples/ApiPortals_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in a Service.", + "operationId": "ApiPortals_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of API portals in the Service.", + "schema": { + "$ref": "#/definitions/ApiPortalResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApiPortals_List": { + "$ref": "./examples/ApiPortals_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains/{domainName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the API portal custom domain.", + "operationId": "ApiPortalCustomDomains_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalCustomDomainParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding API portal custom domain.", + "schema": { + "$ref": "#/definitions/ApiPortalCustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApiPortalCustomDomains_Get": { + "$ref": "./examples/ApiPortalCustomDomains_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update the API portal custom domain.", + "operationId": "ApiPortalCustomDomains_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalCustomDomainParameter" + }, + { + "name": "apiPortalCustomDomainResource", + "in": "body", + "description": "The API portal custom domain for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ApiPortalCustomDomainResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Spring Cloud Gateway route configs.", + "schema": { + "$ref": "#/definitions/ApiPortalCustomDomainResource" + } + }, + "201": { + "description": "Created. The response describes the new created Spring Cloud Gateway custom domain and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ApiPortalCustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApiPortalCustomDomains_CreateOrUpdate": { + "$ref": "./examples/ApiPortalCustomDomains_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the API portal custom domain.", + "operationId": "ApiPortalCustomDomains_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalCustomDomainParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the API portal custom domain has deleted." + }, + "202": { + "description": "Accepted. The response indicates the API portal custom domain is now deleting." + }, + "204": { + "description": "Success. The response indicates the API portal custom domain doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApiPortalCustomDomains_Delete": { + "$ref": "./examples/ApiPortalCustomDomains_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handle requests to list all API portal custom domains.", + "operationId": "ApiPortalCustomDomains_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of API portal custom domains.", + "schema": { + "$ref": "#/definitions/ApiPortalCustomDomainResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApiPortalCustomDomains_List": { + "$ref": "./examples/ApiPortalCustomDomains_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/validateDomain": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Check the domains are valid as well as not in use.", + "operationId": "ApiPortals_ValidateDomain", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + }, + { + "name": "validatePayload", + "in": "body", + "description": "Custom domain payload to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainValidatePayload" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the name is available.", + "schema": { + "$ref": "#/definitions/CustomDomainValidateResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApiPortals_ValidateDomain": { + "$ref": "./examples/ApiPortals_ValidateDomain.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handle requests to list all application accelerator.", + "operationId": "ApplicationAccelerators_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of application accelerator.", + "schema": { + "$ref": "#/definitions/ApplicationAcceleratorResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApplicationAccelerators_List": { + "$ref": "./examples/ApplicationAccelerators_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the application accelerator.", + "operationId": "ApplicationAccelerators_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding application accelerator.", + "schema": { + "$ref": "#/definitions/ApplicationAcceleratorResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationAccelerators_Get": { + "$ref": "./examples/ApplicationAccelerators_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update the application accelerator.", + "operationId": "ApplicationAccelerators_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "name": "applicationAcceleratorResource", + "in": "body", + "description": "The application accelerator for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationAcceleratorResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated application accelerator.", + "schema": { + "$ref": "#/definitions/ApplicationAcceleratorResource" + } + }, + "201": { + "description": "Created. The response describes the new created application accelerator and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ApplicationAcceleratorResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApplicationAccelerators_CreateOrUpdate": { + "$ref": "./examples/ApplicationAccelerators_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the application accelerator.", + "operationId": "ApplicationAccelerators_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the application accelerator is now deleting.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the application accelerator doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApplicationAccelerators_Delete": { + "$ref": "./examples/ApplicationAccelerators_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/customizedAccelerators": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handle requests to list all customized accelerators.", + "operationId": "CustomizedAccelerators_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of customized accelerators.", + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CustomizedAccelerators_List": { + "$ref": "./examples/CustomizedAccelerators_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/customizedAccelerators/{customizedAcceleratorName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the customized accelerator.", + "operationId": "CustomizedAccelerators_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/CustomizedAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding customized accelerator.", + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CustomizedAccelerators_Get": { + "$ref": "./examples/CustomizedAccelerators_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update the customized accelerator.", + "operationId": "CustomizedAccelerators_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/CustomizedAcceleratorNameParameter" + }, + { + "name": "customizedAcceleratorResource", + "in": "body", + "description": "The customized accelerator for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated customized accelerator.", + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorResource" + } + }, + "201": { + "description": "Created. The response describes the new created customized accelerator and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CustomizedAccelerators_CreateOrUpdate": { + "$ref": "./examples/CustomizedAccelerators_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the customized accelerator.", + "operationId": "CustomizedAccelerators_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/CustomizedAcceleratorNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the customized accelerator is now deleting.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the customized accelerator doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CustomizedAccelerators_Delete": { + "$ref": "./examples/CustomizedAccelerators_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/customizedAccelerators/{customizedAcceleratorName}/validate": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Check the customized accelerator are valid.", + "x-ms-long-running-operation": true, + "operationId": "CustomizedAccelerators_Validate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/CustomizedAcceleratorNameParameter" + }, + { + "name": "properties", + "in": "body", + "description": "Customized accelerator properties to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorProperties" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the customized accelerator is valid.", + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorValidateResult" + } + }, + "202": { + "description": "Accepted. The response indicates the CustomizedAccelerator is validating.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CustomizedAccelerators_Validate": { + "$ref": "./examples/CustomizedAccelerators_Validate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/predefinedAccelerators": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handle requests to list all predefined accelerators.", + "operationId": "PredefinedAccelerators_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of predefined accelerators.", + "schema": { + "$ref": "#/definitions/PredefinedAcceleratorResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PredefinedAccelerators_List": { + "$ref": "./examples/PredefinedAccelerators_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/predefinedAccelerators/{predefinedAcceleratorName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the predefined accelerator.", + "operationId": "PredefinedAccelerators_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/PredefinedAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding predefined accelerator.", + "schema": { + "$ref": "#/definitions/PredefinedAcceleratorResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PredefinedAccelerators_Get": { + "$ref": "./examples/PredefinedAccelerators_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/predefinedAccelerators/{predefinedAcceleratorName}/disable": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Disable predefined accelerator.", + "operationId": "PredefinedAccelerators_Disable", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/PredefinedAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the PredefinedAccelerator is now disabling and contains a Location header to query the operation result.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PredefinedAccelerators_Disable": { + "$ref": "./examples/PredefinedAccelerators_Disable.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/predefinedAccelerators/{predefinedAcceleratorName}/enable": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Enable predefined accelerator.", + "operationId": "PredefinedAccelerators_Enable", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/PredefinedAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the PredefinedAccelerator is now enabling and contains a Location header to query the operation result.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PredefinedAccelerators_Enable": { + "$ref": "./examples/PredefinedAccelerators_Enable.json" + } + } + } + } + }, + "definitions": { + "ServiceResource": { + "description": "Service resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ClusterResourceProperties", + "description": "Properties of the Service resource", + "x-ms-client-flatten": false + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the Service resource" + } + } + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The GEO location of the resource.", + "type": "string" + }, + "tags": { + "description": "Tags of the service which is a list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Resource": { + "description": "The core properties of ARM resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "x-ms-azure-resource": true + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "properties": { + "createdBy": { + "description": "The identity that created the resource.", + "type": "string" + }, + "createdByType": { + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "type": "string" + }, + "lastModifiedBy": { + "description": "The identity that last modified the resource.", + "type": "string" + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "lastModifiedByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of resource modification (UTC).", + "type": "string" + } + }, + "readOnly": true + }, + "ClusterResourceProperties": { + "description": "Service properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Service", + "enum": [ + "Creating", + "Updating", + "Starting", + "Stopping", + "Deleting", + "Deleted", + "Succeeded", + "Failed", + "Moving", + "Moved", + "MoveFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Network profile of the Service" + }, + "vnetAddons": { + "$ref": "#/definitions/ServiceVNetAddons", + "description": "Additional Service settings in vnet injection instance" + }, + "maintenanceScheduleConfiguration": { + "$ref": "#/definitions/MaintenanceScheduleConfiguration", + "description": "Additional Service settings for planned maintenance" + }, + "version": { + "format": "int32", + "description": "Version of the Service", + "type": "integer", + "readOnly": true + }, + "serviceId": { + "description": "ServiceInstanceEntity Id which uniquely identifies a created resource", + "type": "string", + "readOnly": true + }, + "managedEnvironmentId": { + "description": "The resource Id of the Managed Environment that the Spring Apps instance builds on", + "type": "string" + }, + "infraResourceGroup": { + "description": "The name of the resource group that contains the infrastructure resources", + "type": "string" + }, + "powerState": { + "description": "Power state of the Service", + "enum": [ + "Running", + "Stopped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PowerState", + "modelAsString": true + } + }, + "zoneRedundant": { + "type": "boolean", + "default": false, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "fqdn": { + "description": "Fully qualified dns name of the service instance", + "type": "string", + "readOnly": true + }, + "marketplaceResource": { + "$ref": "#/definitions/MarketplaceResource", + "description": "Purchasing 3rd party product of the Service resource." + } + } + }, + "ManagedIdentityProperties": { + "description": "Managed identity properties retrieved from ARM request headers.", + "type": "object", + "properties": { + "type": { + "description": "Type of the managed identity", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true + } + }, + "principalId": { + "description": "Principal Id of system-assigned managed identity.", + "type": "string" + }, + "tenantId": { + "description": "Tenant Id of system-assigned managed identity.", + "type": "string" + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedManagedIdentities", + "description": "Properties of user-assigned managed identities" + } + } + }, + "UserAssignedManagedIdentities": { + "description": "User-assigned managed identities in key-value map. The key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedManagedIdentity" + } + }, + "UserAssignedManagedIdentity": { + "description": "The details of the user-assigned managed identity assigned to an App.", + "type": "object", + "properties": { + "principalId": { + "description": "Principal Id of user-assigned managed identity.", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "Client Id of user-assigned managed identity.", + "type": "string", + "readOnly": true + } + } + }, + "BuildServiceCollection": { + "description": "Object that includes an array of Build service resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Build service resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BuildService" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ContainerRegistryResourceCollection": { + "description": "Collection compose of container registry resources list and a possible link for next page.", + "type": "object", + "properties": { + "value": { + "description": "The container registry resources list.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistryResource" + } + }, + "nextLink": { + "description": "The link to next page of storage list.", + "type": "string" + } + } + }, + "ContainerRegistryResource": { + "description": "Container registry resource payload.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ContainerRegistryProperties", + "description": "Properties of the container registry resource payload.", + "x-ms-client-flatten": false + } + } + }, + "ContainerRegistryProperties": { + "description": "Container registry resource payload.", + "type": "object", + "required": [ + "credentials" + ], + "properties": { + "credentials": { + "$ref": "#/definitions/ContainerRegistryCredentials", + "description": "The credentials of the container registry resource." + }, + "provisioningState": { + "description": "State of the Container Registry.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ContainerRegistryProvisioningState", + "modelAsString": true + } + } + } + }, + "ContainerRegistryCredentials": { + "description": "The credential for the container registry resource.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "The credential type of the container registry credentials.", + "type": "string" + } + }, + "discriminator": "type" + }, + "ContainerRegistryBasicCredentials": { + "description": "The basic authentication properties for the container registry resource.", + "type": "object", + "required": [ + "type", + "server", + "username", + "password" + ], + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryCredentials" + } + ], + "properties": { + "server": { + "description": "The login server of the Container Registry.", + "type": "string" + }, + "username": { + "description": "The username of the Container Registry.", + "type": "string" + }, + "password": { + "description": "The password of the Container Registry.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "x-ms-discriminator-value": "BasicAuth" + }, + "ContainerRegistryValidateResult": { + "description": "Validation result for container registry properties", + "type": "object", + "properties": { + "isValid": { + "description": "Indicate if the container registry properties are valid", + "type": "boolean" + }, + "message": { + "description": "Detailed validation messages.", + "type": "string" + } + } + }, + "BuildService": { + "description": "Build service resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BuildServiceProperties", + "description": "Properties of the build resource", + "x-ms-client-flatten": false + } + } + }, + "BuildServiceProperties": { + "description": "Build service resource properties payload", + "type": "object", + "properties": { + "containerRegistry": { + "description": "The resource id of the container registry used in this build service.", + "type": "string" + }, + "kPackVersion": { + "description": "The installed KPack version in this build service.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the KPack build service", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BuildServiceProvisioningState", + "modelAsString": true + } + }, + "resourceRequests": { + "description": "The runtime resource configuration of this build service.", + "type": "object", + "properties": { + "cpu": { + "description": "vCPU allocated to the entire build service node pool.", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "Memory allocated to the entire build service node pool.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "BuildCollection": { + "description": "Object that includes an array of Build resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Build resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Build" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "Build": { + "description": "Build resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BuildProperties", + "description": "Properties of the build resource", + "x-ms-client-flatten": false + } + } + }, + "BuildProperties": { + "description": "Build resource properties payload", + "type": "object", + "properties": { + "relativePath": { + "description": "The relative path of source code", + "type": "string" + }, + "builder": { + "description": "The resource id of builder to build the source code", + "type": "string" + }, + "agentPool": { + "description": "The resource id of agent pool", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state of the KPack build result", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BuildProvisioningState", + "modelAsString": true + } + }, + "env": { + "description": "The environment variables for this build", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "apms": { + "$ref": "#/definitions/ApmReferenceCollection", + "description": "The APMs for this build" + }, + "certificates": { + "$ref": "#/definitions/CertificateReferenceCollection", + "description": "The CA Certificates for this build" + }, + "triggeredBuildResult": { + "$ref": "#/definitions/TriggeredBuildResult", + "description": " The build result triggered by this build" + }, + "resourceRequests": { + "$ref": "#/definitions/BuildResourceRequests", + "description": "The customized build resource for this build" + } + } + }, + "BuildResourceRequests": { + "description": "Resource request payload of Build Resource.", + "type": "object", + "properties": { + "cpu": { + "description": "Optional Cpu allocated to the build resource. 1 core can be represented by 1 or 1000m. \r\nThe default value is 1, this should not exceed build service agent pool cpu size.", + "type": "string", + "default": "1" + }, + "memory": { + "description": "Optional Memory allocated to the build resource. 1 GB can be represented by 1Gi or 1024Mi. \r\nThe default value is 2Gi, this should not exceed build service agent pool memory size.", + "type": "string", + "default": "2Gi" + } + } + }, + "TriggeredBuildResult": { + "description": "The build result triggered by a build", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "description": "The unique build id of this build result", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning state of this build result", + "enum": [ + "Queuing", + "Building", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TriggeredBuildResultProvisioningState", + "modelAsString": true + } + }, + "image": { + "description": "The container image of this build result", + "type": "string" + }, + "lastTransitionTime": { + "format": "date-time", + "description": "The last transition time of this build result", + "type": "string" + }, + "lastTransitionReason": { + "description": "The last transition reason of this build result", + "type": "string" + }, + "lastTransitionStatus": { + "description": "The last transition status of this build result", + "type": "string" + } + } + }, + "BuildResultCollection": { + "description": "Object that includes an array of Build result resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Build result resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BuildResult" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "BuildResult": { + "description": "Build result resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BuildResultProperties", + "description": "Properties of the build result resource", + "x-ms-client-flatten": false + } + } + }, + "BuildResultProperties": { + "description": "Build result resource properties payload", + "type": "object", + "properties": { + "name": { + "description": "The name of this build result", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state of the KPack build result", + "enum": [ + "Queuing", + "Building", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BuildResultProvisioningState", + "modelAsString": true + } + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Error when build is failed." + }, + "buildPodName": { + "description": "The build pod name which can be used to get the build log streaming.", + "type": "string" + }, + "buildStages": { + "description": "All of the build stage (init-container and container) resources in build pod.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BuildStageProperties" + }, + "readOnly": true + }, + "image": { + "description": "The container registry image of this build result.", + "type": "string", + "readOnly": true + } + } + }, + "BuildStageProperties": { + "description": "The build stage (init-container and container) resources in build pod.", + "type": "object", + "properties": { + "name": { + "description": "The name of this build stage resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The provisioning state of this build stage resource.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "KPackBuildStageProvisioningState", + "modelAsString": true + } + }, + "exitCode": { + "description": "The exit code of this build init container.", + "type": "string", + "readOnly": true + }, + "reason": { + "description": "The reason of this build init container.", + "type": "string", + "readOnly": true + } + } + }, + "BuildResultLog": { + "description": "Build result log resource properties payload", + "type": "object", + "properties": { + "blobUrl": { + "description": "The public download URL of this build result log", + "type": "string" + } + } + }, + "BuilderResourceCollection": { + "description": "Object that includes an array of Builder resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Builder resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BuilderResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "BuilderResource": { + "description": "KPack Builder resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BuilderProperties", + "description": "Property of the Builder resource." + } + } + }, + "BuilderProperties": { + "description": "KPack Builder properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "Builder provision status.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BuilderProvisioningState", + "modelAsString": true + } + }, + "stack": { + "description": "Builder cluster stack property.", + "type": "object", + "$ref": "#/definitions/StackProperties" + }, + "buildpackGroups": { + "description": "Builder buildpack groups.", + "type": "array", + "items": { + "$ref": "#/definitions/BuildpacksGroupProperties" + } + } + } + }, + "StackProperties": { + "description": "KPack ClusterStack properties payload", + "type": "object", + "properties": { + "id": { + "description": "Id of the ClusterStack.", + "type": "string" + }, + "version": { + "description": "Version of the ClusterStack", + "type": "string" + } + } + }, + "BuildpacksGroupProperties": { + "description": "Buildpack group properties of the Builder", + "type": "object", + "properties": { + "name": { + "description": "Buildpack group name", + "type": "string" + }, + "buildpacks": { + "description": "Buildpacks in the buildpack group", + "type": "array", + "uniqueItems": false, + "items": { + "$ref": "#/definitions/BuildpackProperties" + } + } + } + }, + "BuildpackProperties": { + "description": "Buildpack properties payload", + "type": "object", + "properties": { + "id": { + "description": "Id of the buildpack", + "type": "string" + }, + "version": { + "description": "Version of the buildpack", + "type": "string", + "readOnly": true + } + } + }, + "SupportedBuildpacksCollection": { + "description": "Object that includes an array of supported buildpacks resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of supported buildpacks resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SupportedBuildpackResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SupportedBuildpackResource": { + "description": "Supported buildpack resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SupportedBuildpackResourceProperties" + } + } + }, + "SupportedBuildpackResourceProperties": { + "description": "Supported buildpack resource properties", + "type": "object", + "properties": { + "buildpackId": { + "description": "The id of supported buildpack", + "type": "string" + }, + "version": { + "description": "The version of supported buildpack", + "type": "string" + } + } + }, + "SupportedStacksCollection": { + "description": "Object that includes an array of supported stacks resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of supported stacks resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SupportedStackResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SupportedStackResource": { + "description": "Supported stack resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SupportedStackResourceProperties" + } + } + }, + "SupportedStackResourceProperties": { + "description": "Supported stack resource properties", + "type": "object", + "properties": { + "stackId": { + "description": "The id of supported stack", + "type": "string" + }, + "version": { + "description": "The version of supported stack", + "type": "string" + } + } + }, + "BuildServiceAgentPoolResourceCollection": { + "description": "Object that includes an array of build service agent pool resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of build service agent pool resource", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BuildServiceAgentPoolResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "BuildServiceAgentPoolResource": { + "description": "The build service agent pool resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "build service agent pool properties", + "type": "object", + "$ref": "#/definitions/BuildServiceAgentPoolProperties" + } + } + }, + "BuildServiceAgentPoolProperties": { + "description": "Build service agent pool properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the build service agent pool", + "type": "string", + "readOnly": true + }, + "poolSize": { + "description": "build service agent pool size properties", + "type": "object", + "$ref": "#/definitions/BuildServiceAgentPoolSizeProperties" + } + } + }, + "BuildServiceAgentPoolSizeProperties": { + "description": "Build service agent pool size properties", + "type": "object", + "properties": { + "name": { + "description": "The name of build service agent pool size", + "type": "string" + }, + "cpu": { + "description": "The cpu property of build service agent pool size", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "The memory property of build service agent pool size", + "type": "string", + "readOnly": true + } + } + }, + "ConfigurationServiceResourceCollection": { + "description": "Object that includes an array of configuration service resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of configuration service resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationServiceResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ConfigurationServiceResource": { + "description": "Application Configuration Service resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationServiceProperties" + } + } + }, + "ConfigurationServiceProperties": { + "description": "Application Configuration Service properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the Application Configuration Service.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ConfigurationServiceProvisioningState", + "modelAsString": true + } + }, + "generation": { + "description": "The generation of the Application Configuration Service.", + "enum": [ + "Gen1", + "Gen2" + ], + "type": "string", + "default": "Gen1", + "x-ms-enum": { + "name": "ConfigurationServiceGeneration", + "modelAsString": true + } + }, + "resourceRequests": { + "$ref": "#/definitions/ConfigurationServiceResourceRequests", + "description": "The requested resource quantity for required CPU and Memory." + }, + "instances": { + "description": "Collection of instances belong to Application Configuration Service.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationServiceInstance" + }, + "readOnly": true + }, + "settings": { + "$ref": "#/definitions/ConfigurationServiceSettings" + } + } + }, + "ConfigurationServiceResourceRequests": { + "description": "Resource request payload of Application Configuration Service", + "type": "object", + "readOnly": true, + "properties": { + "cpu": { + "description": "Cpu allocated to each Application Configuration Service instance", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "Memory allocated to each Application Configuration Service instance", + "type": "string", + "readOnly": true + }, + "instanceCount": { + "format": "int32", + "description": "Instance count of the Application Configuration Service", + "type": "integer", + "readOnly": true + } + } + }, + "ConfigurationServiceSettings": { + "description": "The settings of Application Configuration Service.", + "type": "object", + "properties": { + "gitProperty": { + "$ref": "#/definitions/ConfigurationServiceGitProperty" + }, + "refreshIntervalInSeconds": { + "format": "int32", + "description": "How often (in seconds) to check repository updates. Minimum value is 0.", + "type": "integer" + } + } + }, + "ConfigurationServiceGitProperty": { + "description": "Property of git environment.", + "type": "object", + "properties": { + "repositories": { + "$ref": "#/definitions/ConfigurationServiceGitPropertyRepository" + } + } + }, + "ConfigurationServiceGitPropertyRepository": { + "description": "Repositories of Application Configuration Service git property.", + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationServiceGitRepository" + } + }, + "ConfigurationServiceSettingsValidateResult": { + "description": "Validation result for configuration service settings", + "type": "object", + "properties": { + "gitPropertyValidationResult": { + "$ref": "#/definitions/ConfigurationServiceGitPropertyValidateResult" + } + } + }, + "ConfigurationServiceGitPropertyValidateResult": { + "description": "Validation result for configuration service settings", + "type": "object", + "properties": { + "isValid": { + "description": "Indicate if the configuration service settings are valid", + "type": "boolean" + }, + "gitReposValidationResult": { + "description": "The detail validation results", + "type": "array", + "items": { + "$ref": "#/definitions/ValidationMessages" + } + } + } + }, + "ValidationMessages": { + "description": "Validate messages of the configuration service git repositories", + "type": "object", + "properties": { + "name": { + "description": "The name of the configuration service git repository.", + "type": "string" + }, + "messages": { + "description": "Detailed validation messages.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ConfigurationServiceInstance": { + "description": "Collection of instances belong to the Application Configuration Service", + "type": "object", + "properties": { + "name": { + "description": "Name of the Application Configuration Service instance", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the Application Configuration Service instance", + "type": "string", + "readOnly": true + } + } + }, + "ConfigurationServiceGitRepository": { + "description": "Git repository property payload for Application Configuration Service", + "required": [ + "name", + "patterns", + "uri", + "label" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the repository", + "type": "string" + }, + "patterns": { + "description": "Collection of patterns of the repository", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "uri": { + "description": "URI of the repository", + "type": "string" + }, + "label": { + "description": "Label of the repository", + "type": "string" + }, + "searchPaths": { + "description": "Searching path of the repository", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "username": { + "description": "Username of git repository basic auth.", + "type": "string" + }, + "password": { + "description": "Password of git repository basic auth.", + "type": "string" + }, + "hostKey": { + "description": "Public sshKey of git repository.", + "type": "string" + }, + "hostKeyAlgorithm": { + "description": "SshKey algorithm of git repository.", + "type": "string" + }, + "privateKey": { + "description": "Private sshKey algorithm of git repository.", + "type": "string" + }, + "strictHostKeyChecking": { + "description": "Strict host key checking or not.", + "type": "boolean" + }, + "gitImplementation": { + "description": "Git libraries used to support various repository providers", + "$ref": "#/definitions/GitImplementation" + }, + "caCertResourceId": { + "description": "Resource Id of CA certificate for https URL of Git repository.", + "type": "string" + } + } + }, + "GitImplementation": { + "description": "Git libraries used to support various repository providers", + "enum": [ + "go-git", + "libgit2" + ], + "type": "string", + "x-ms-enum": { + "name": "GitImplementation", + "modelAsString": true + } + }, + "ApplicationLiveViewResourceCollection": { + "description": "Object that includes an array of Application Live View resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Application Live View resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationLiveViewResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ApplicationLiveViewResource": { + "description": "Application Live View resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationLiveViewProperties" + } + } + }, + "ApplicationLiveViewProperties": { + "description": "Application Live View properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the Application Live View.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ApplicationLiveViewProvisioningState", + "modelAsString": true + } + }, + "components": { + "uniqueItems": false, + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ApplicationLiveViewComponent" + }, + "readOnly": true, + "description": "Component details of Application Live View" + } + } + }, + "ApplicationLiveViewComponent": { + "description": "Application Live View properties payload", + "type": "object", + "properties": { + "name": { + "description": "Name of the component.", + "readOnly": true + }, + "resourceRequests": { + "$ref": "#/definitions/ApplicationLiveViewResourceRequests", + "description": "The requested resource quantity for required CPU and Memory.", + "readOnly": true + }, + "instances": { + "description": "Collection of instances belong to Application Live View.", + "uniqueItems": false, + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ApplicationLiveViewInstance" + }, + "readOnly": true + } + } + }, + "ApplicationLiveViewResourceRequests": { + "description": "The resource quantity for required CPU and Memory of Application Live View component", + "type": "object", + "readOnly": true, + "properties": { + "cpu": { + "description": "Cpu quantity allocated to each Application Live View component instance. 1 core can be represented by 1 or 1000m.", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "Memory quantity allocated to each Application Live View component instance. 1 GB can be represented by 1Gi or 1024Mi.", + "type": "string", + "readOnly": true + }, + "instanceCount": { + "description": "Desired instance count of Application Live View component instance.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "ApplicationLiveViewInstance": { + "description": "Collection of instances belong to the Application Live View", + "type": "object", + "properties": { + "name": { + "description": "Name of the Application Live View instance.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the Application Live View instance. It can be Pending, Running, Succeeded, Failed, Unknown.", + "type": "string", + "readOnly": true + } + } + }, + "DevToolPortalResourceCollection": { + "description": "Object that includes an array of Dev Tool Portal resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Dev Tool Portal resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DevToolPortalResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "DevToolPortalResource": { + "description": "Dev Tool Portal resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DevToolPortalProperties" + } + } + }, + "DevToolPortalProperties": { + "description": "Dev Tool Portal properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the Dev Tool Portal.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DevToolPortalProvisioningState", + "modelAsString": true + } + }, + "components": { + "description": "Collection of components belong to Dev Tool Portal.", + "uniqueItems": false, + "type": "array", + "x-ms-identifiers": [ + "name" + ], + "items": { + "$ref": "#/definitions/DevToolPortalComponent" + }, + "readOnly": true + }, + "public": { + "description": "Indicates whether the resource exposes public endpoint", + "type": "boolean", + "default": false + }, + "url": { + "description": "URL of the resource, exposed when 'public' is true.", + "type": "string", + "readOnly": true + }, + "ssoProperties": { + "$ref": "#/definitions/DevToolPortalSsoProperties", + "description": "Single sign-on related configuration" + }, + "features": { + "$ref": "#/definitions/DevToolPortalFeatureSettings", + "description": "Settings for Dev Tool Portal" + } + } + }, + "DevToolPortalComponent": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true + }, + "resourceRequests": { + "$ref": "#/definitions/DevToolPortalResourceRequests", + "description": "The requested resource quantity for required CPU and Memory." + }, + "instances": { + "description": "Collection of instances belong to Dev Tool Portal.", + "uniqueItems": false, + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/DevToolPortalInstance" + }, + "readOnly": true + } + } + }, + "DevToolPortalSsoProperties": { + "description": "Single sign-on related configuration", + "type": "object", + "properties": { + "scopes": { + "description": "It defines the specific actions applications can be allowed to do on a user's behalf", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "clientId": { + "description": "The public identifier for the application", + "type": "string" + }, + "clientSecret": { + "description": "The secret known only to the application and the authorization server", + "x-ms-secret": true, + "type": "string" + }, + "metadataUrl": { + "description": "The URI of a JSON file with generic OIDC provider configuration.", + "type": "string" + } + } + }, + "DevToolPortalFeatureSettings": { + "description": "Settings for Dev Tool Portal", + "type": "object", + "properties": { + "applicationAccelerator": { + "$ref": "#/definitions/DevToolPortalFeatureDetail", + "description": "Detail of Accelerator plugin" + }, + "applicationLiveView": { + "$ref": "#/definitions/DevToolPortalFeatureDetail", + "description": "Detail of App Live View plugin" + } + } + }, + "DevToolPortalFeatureDetail": { + "description": "Detail settings for Dev Tool Portal feature", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "State of the plugin", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "DevToolPortalFeatureState", + "values": [ + { + "description": "Enable the plugin in Dev Tool Portal.", + "value": "Enabled" + }, + { + "description": "Disable the plugin in Dev Tool Portal.", + "value": "Disabled" + } + ] + } + }, + "route": { + "type": "string", + "description": "Route path to visit the plugin", + "readOnly": true + } + } + }, + "DevToolPortalResourceRequests": { + "description": "The resource quantity for required CPU and Memory of Dev Tool Portal", + "type": "object", + "readOnly": true, + "properties": { + "cpu": { + "description": "Cpu quantity allocated to each Dev Tool Portal instance. 1 core can be represented by 1 or 1000m", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "Memory quantity allocated to each Dev Tool Portal instance. 1 GB can be represented by 1Gi or 1024Mi.", + "type": "string", + "readOnly": true + }, + "instanceCount": { + "description": "Desired instance count of Dev Tool Portal.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "DevToolPortalInstance": { + "description": "Collection of instances belong to the Dev Tool Portal.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Dev Tool Portal instance.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the Dev Tool Portal instance. It can be Pending, Running, Succeeded, Failed, Unknown.", + "type": "string", + "readOnly": true + } + } + }, + "ServiceRegistryResourceCollection": { + "description": "Object that includes an array of Service Registry resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Service Registry resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceRegistryResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ServiceRegistryResource": { + "description": "Service Registry resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceRegistryProperties" + } + } + }, + "ServiceRegistryProperties": { + "description": "Service Registry properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the Service Registry.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ServiceRegistryProvisioningState", + "modelAsString": true + } + }, + "resourceRequests": { + "$ref": "#/definitions/ServiceRegistryResourceRequests", + "description": "The requested resource quantity for required CPU and Memory." + }, + "instances": { + "description": "Collection of instances belong to Service Registry.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceRegistryInstance" + }, + "readOnly": true + } + } + }, + "ServiceRegistryResourceRequests": { + "description": "Resource request payload of Service Registry", + "type": "object", + "readOnly": true, + "properties": { + "cpu": { + "description": "Cpu allocated to each Service Registry instance", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "Memory allocated to each Service Registry instance", + "type": "string", + "readOnly": true + }, + "instanceCount": { + "format": "int32", + "description": "Instance count of the Service Registry", + "type": "integer", + "readOnly": true + } + } + }, + "ServiceRegistryInstance": { + "description": "Collection of instances belong to the Service Registry", + "type": "object", + "properties": { + "name": { + "description": "Name of the Service Registry instance", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the Service Registry instance", + "type": "string", + "readOnly": true + } + } + }, + "Sku": { + "description": "Sku of Azure Spring Apps", + "type": "object", + "properties": { + "name": { + "description": "Name of the Sku", + "type": "string", + "default": "S0" + }, + "tier": { + "description": "Tier of the Sku", + "type": "string", + "default": "Standard" + }, + "capacity": { + "format": "int32", + "description": "Current capacity of the target resource", + "type": "integer" + } + } + }, + "MarketplaceResource": { + "description": "Purchasing 3rd Party product for one Azure Spring Apps instance", + "type": "object", + "properties": { + "plan": { + "description": "The plan id of the 3rd Party Artifact that is being procured.", + "type": "string" + }, + "publisher": { + "description": "The publisher id of the 3rd Party Artifact that is being bought.", + "type": "string" + }, + "product": { + "description": "The 3rd Party artifact that is being procured.", + "type": "string" + } + } + }, + "ConfigServerSettingsValidateResult": { + "description": "Validation result for config server settings", + "type": "object", + "properties": { + "isValid": { + "description": "Indicate if the config server settings are valid", + "type": "boolean" + }, + "details": { + "description": "The detail validation results", + "type": "array", + "items": { + "$ref": "#/definitions/ConfigServerSettingsErrorRecord" + } + } + } + }, + "ConfigServerSettingsErrorRecord": { + "description": "Error record of the config server settings", + "type": "object", + "properties": { + "name": { + "description": "The name of the config server settings error record", + "type": "string" + }, + "uri": { + "description": "The uri of the config server settings error record", + "type": "string" + }, + "messages": { + "description": "The detail error messages of the record", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EurekaServerResourceCollection": { + "description": "Object that includes an array of Eureka server resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Eureka server resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/EurekaServerResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "EurekaServerResource": { + "description": "Eureka server resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EurekaServerProperties", + "description": "Properties of the eureka server resource", + "x-ms-client-flatten": false + } + } + }, + "EurekaServerProperties": { + "description": "Eureka server properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the eureka server.", + "enum": [ + "Failed", + "Succeeded", + "Updating", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EurekaServerState", + "modelAsString": true + } + }, + "enabledState": { + "type": "string", + "description": "Enabled state of the eureka server. This is only used in Consumption tier.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "EurekaServerEnabledState", + "values": [ + { + "description": "Enable the eureka server.", + "value": "Enabled" + }, + { + "description": "Disable the eureka server.", + "value": "Disabled" + } + ] + } + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Error when applying eureka server settings." + } + } + }, + "ConfigServerResource": { + "description": "Config Server resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ConfigServerProperties", + "description": "Properties of the Config Server resource", + "x-ms-client-flatten": false + } + } + }, + "ConfigServerProperties": { + "description": "Config server git properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the config server.", + "enum": [ + "NotAvailable", + "Deleted", + "Failed", + "Succeeded", + "Updating" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ConfigServerState", + "modelAsString": true + } + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Error when apply config server settings." + }, + "enabledState": { + "type": "string", + "description": "Enabled state of the config server. This is only used in Consumption tier.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ConfigServerEnabledState", + "values": [ + { + "description": "Enable the config server.", + "value": "Enabled" + }, + { + "description": "Disable the config server.", + "value": "Disabled" + } + ] + } + }, + "configServer": { + "$ref": "#/definitions/ConfigServerSettings", + "description": "Settings of config server." + } + } + }, + "MonitoringSettingResource": { + "description": "Monitoring Setting resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MonitoringSettingProperties", + "description": "Properties of the Monitoring Setting resource", + "x-ms-client-flatten": false + } + } + }, + "MonitoringSettingProperties": { + "description": "Monitoring Setting properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the Monitoring Setting.", + "enum": [ + "NotAvailable", + "Failed", + "Succeeded", + "Updating" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MonitoringSettingState", + "modelAsString": true + } + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Error when apply Monitoring Setting changes." + }, + "traceEnabled": { + "description": "Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not", + "type": "boolean" + }, + "appInsightsInstrumentationKey": { + "description": "Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings", + "type": "string" + }, + "appInsightsSamplingRate": { + "description": "Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]", + "format": "double", + "maximum": 100.0, + "minimum": 0.0, + "type": "number" + }, + "appInsightsAgentVersions": { + "$ref": "#/definitions/applicationInsightsAgentVersions", + "description": "Indicates the versions of application insight agent" + } + } + }, + "applicationInsightsAgentVersions": { + "description": "Application Insights agent versions properties payload", + "type": "object", + "properties": { + "java": { + "description": "Indicates the version of application insight java agent", + "type": "string", + "readOnly": true + } + } + }, + "NetworkProfile": { + "description": "Service network profile payload", + "type": "object", + "properties": { + "serviceRuntimeSubnetId": { + "description": "Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "appSubnetId": { + "description": "Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "serviceCidr": { + "description": "Azure Spring Apps service reserved CIDR", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "serviceRuntimeNetworkResourceGroup": { + "description": "Name of the resource group containing network resources of Azure Spring Apps Service Runtime", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "appNetworkResourceGroup": { + "description": "Name of the resource group containing network resources for customer apps in Azure Spring Apps", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "outboundIPs": { + "description": "Desired outbound IP resources for Azure Spring Apps resource.", + "type": "object", + "readOnly": true, + "properties": { + "publicIPs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "A list of public IP addresses." + } + } + }, + "requiredTraffics": { + "description": "Required inbound or outbound traffics for Azure Spring Apps resource.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RequiredTraffic" + } + }, + "ingressConfig": { + "description": "Ingress configuration payload for Azure Spring Apps resource.", + "$ref": "#/definitions/IngressConfig" + }, + "outboundType": { + "description": "The egress traffic type of Azure Spring Apps VNet instances.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "RequiredTraffic": { + "description": "Required inbound or outbound traffic for Azure Spring Apps resource.", + "type": "object", + "properties": { + "protocol": { + "description": "The protocol of required traffic", + "type": "string", + "readOnly": true + }, + "port": { + "description": "The port of required traffic", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "ips": { + "description": "The ip list of required traffic", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "fqdns": { + "description": "The FQDN list of required traffic", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "direction": { + "description": "The direction of required traffic", + "type": "string", + "readOnly": true, + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "trafficDirection", + "modelAsString": true + } + } + } + }, + "IngressConfig": { + "description": "Ingress configuration payload for Azure Spring Apps resource.", + "type": "object", + "properties": { + "readTimeoutInSeconds": { + "format": "int32", + "description": "Ingress read time out in seconds.", + "type": "integer" + } + } + }, + "Error": { + "description": "The error code compose of code and message.", + "type": "object", + "properties": { + "code": { + "description": "The code of error.", + "type": "string" + }, + "message": { + "description": "The message of error.", + "type": "string" + } + } + }, + "ServiceVNetAddons": { + "description": "Additional Service settings in vnet injection instance", + "type": "object", + "properties": { + "logStreamPublicEndpoint": { + "description": "Indicates whether the log stream in vnet injection instance could be accessed from internet.", + "type": "boolean", + "default": false + }, + "dataPlanePublicEndpoint": { + "description": "Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.", + "type": "boolean", + "default": false + } + } + }, + "MaintenanceScheduleConfiguration": { + "description": "Configuration for the planned maintenance", + "type": "object", + "required": [ + "frequency" + ], + "properties": { + "frequency": { + "description": "The frequency to run the maintenance job", + "enum": [ + "Weekly" + ], + "type": "string", + "x-ms-enum": { + "name": "Frequency", + "modelAsString": true + } + } + }, + "discriminator": "frequency" + }, + "WeeklyMaintenanceScheduleConfiguration": { + "description": "Weekly planned maintenance", + "required": [ + "frequency", + "hour", + "day" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MaintenanceScheduleConfiguration" + } + ], + "properties": { + "hour": { + "description": "The hour to run the maintenance job", + "format": "int32", + "maximum": 23, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The duration time to run the maintenance job, specified in ISO8601 format, e.g. PT8H", + "type": "string", + "readOnly": true + }, + "day": { + "description": "The day to run the maintenance job", + "type": "string", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "Weekly" + }, + "ConfigServerSettings": { + "description": "The settings of config server.", + "type": "object", + "properties": { + "gitProperty": { + "$ref": "#/definitions/ConfigServerGitProperty", + "description": "Property of git environment." + } + } + }, + "ConfigServerGitProperty": { + "description": "Property of git.", + "required": [ + "uri" + ], + "type": "object", + "properties": { + "repositories": { + "description": "Repositories of git.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GitPatternRepository" + } + }, + "uri": { + "description": "URI of the repository", + "type": "string" + }, + "label": { + "description": "Label of the repository", + "type": "string" + }, + "searchPaths": { + "description": "Searching path of the repository", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "username": { + "description": "Username of git repository basic auth.", + "type": "string" + }, + "password": { + "description": "Password of git repository basic auth.", + "type": "string" + }, + "hostKey": { + "description": "Public sshKey of git repository.", + "type": "string" + }, + "hostKeyAlgorithm": { + "description": "SshKey algorithm of git repository.", + "type": "string" + }, + "privateKey": { + "description": "Private sshKey algorithm of git repository.", + "type": "string" + }, + "strictHostKeyChecking": { + "description": "Strict host key checking or not.", + "type": "boolean" + } + } + }, + "GitPatternRepository": { + "description": "Git repository property payload for config server", + "required": [ + "name", + "uri" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the repository", + "type": "string" + }, + "pattern": { + "description": "Collection of pattern of the repository", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "uri": { + "description": "URI of the repository", + "type": "string" + }, + "label": { + "description": "Label of the repository", + "type": "string" + }, + "searchPaths": { + "description": "Searching path of the repository", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "username": { + "description": "Username of git repository basic auth.", + "type": "string" + }, + "password": { + "description": "Password of git repository basic auth.", + "type": "string" + }, + "hostKey": { + "description": "Public sshKey of git repository.", + "type": "string" + }, + "hostKeyAlgorithm": { + "description": "SshKey algorithm of git repository.", + "type": "string" + }, + "privateKey": { + "description": "Private sshKey algorithm of git repository.", + "type": "string" + }, + "strictHostKeyChecking": { + "description": "Strict host key checking or not.", + "type": "boolean" + } + } + }, + "TestKeys": { + "description": "Test keys payload", + "type": "object", + "properties": { + "primaryKey": { + "description": "Primary key", + "type": "string" + }, + "secondaryKey": { + "description": "Secondary key", + "type": "string" + }, + "primaryTestEndpoint": { + "description": "Primary test endpoint", + "type": "string" + }, + "secondaryTestEndpoint": { + "description": "Secondary test endpoint", + "type": "string" + }, + "enabled": { + "description": "Indicates whether the test endpoint feature enabled or not", + "type": "boolean" + } + } + }, + "RegenerateTestKeyRequestPayload": { + "description": "Regenerate test key request payload", + "required": [ + "keyType" + ], + "type": "object", + "properties": { + "keyType": { + "description": "Type of the test key", + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "TestKeyType", + "modelAsString": true + } + } + } + }, + "AppResource": { + "description": "App resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AppResourceProperties", + "description": "Properties of the App resource", + "x-ms-client-flatten": false + }, + "identity": { + "$ref": "#/definitions/ManagedIdentityProperties", + "description": "The Managed Identity type of the app resource" + }, + "location": { + "description": "The GEO location of the application, always the same with its parent resource", + "type": "string" + } + } + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "AppResourceProperties": { + "description": "App resource properties payload", + "type": "object", + "properties": { + "public": { + "description": "Indicates whether the App exposes public endpoint", + "type": "boolean" + }, + "url": { + "description": "URL of the App", + "type": "string", + "readOnly": true + }, + "addonConfigs": { + "description": "Collection of addons", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "provisioningState": { + "description": "Provisioning state of the App", + "enum": [ + "Succeeded", + "Failed", + "Creating", + "Updating", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AppResourceProvisioningState", + "modelAsString": true + } + }, + "fqdn": { + "description": "Fully qualified dns Name.", + "type": "string", + "readOnly": true + }, + "httpsOnly": { + "description": "Indicate if only https is allowed.", + "type": "boolean", + "default": false + }, + "temporaryDisk": { + "$ref": "#/definitions/TemporaryDisk", + "description": "Temporary disk settings" + }, + "persistentDisk": { + "$ref": "#/definitions/PersistentDisk", + "description": "Persistent disk settings" + }, + "customPersistentDisks": { + "$ref": "#/definitions/CustomPersistentDiskCollection", + "description": "List of custom persistent disks" + }, + "enableEndToEndTLS": { + "description": "Indicate if end to end TLS is enabled.", + "type": "boolean", + "default": false + }, + "loadedCertificates": { + "description": "Collection of loaded certificates", + "$ref": "#/definitions/LoadedCertificateCollection" + }, + "vnetAddons": { + "description": "Additional App settings in vnet injection instance", + "$ref": "#/definitions/AppVNetAddons" + }, + "ingressSettings": { + "description": "App ingress settings payload.", + "$ref": "#/definitions/IngressSettings" + }, + "secrets": { + "description": "Collection of auth secrets", + "type": "array", + "items": { + "$ref": "#/definitions/Secret" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "workloadProfileName": { + "description": "The workload profile used for this app. Supported for Consumption + Dedicated plan.", + "type": "string" + }, + "testEndpointAuthState": { + "description": "State of test endpoint auth.", + "type": "string", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "TestEndpointAuthState", + "values": [ + { + "description": "Enable test endpoint auth.", + "value": "Enabled" + }, + { + "description": "Disable test endpoint auth", + "value": "Disabled" + } + ] + } + } + } + }, + "TemporaryDisk": { + "description": "Temporary disk payload", + "type": "object", + "properties": { + "sizeInGB": { + "format": "int32", + "description": "Size of the temporary disk in GB", + "maximum": 5.0, + "minimum": 0.0, + "type": "integer" + }, + "mountPath": { + "description": "Mount path of the temporary disk", + "type": "string", + "default": "/tmp" + } + } + }, + "PersistentDisk": { + "description": "Persistent disk payload", + "type": "object", + "properties": { + "sizeInGB": { + "format": "int32", + "description": "Size of the persistent disk in GB", + "maximum": 50.0, + "minimum": 0.0, + "type": "integer" + }, + "usedInGB": { + "format": "int32", + "description": "Size of the used persistent disk in GB", + "maximum": 50.0, + "minimum": 0.0, + "type": "integer", + "readOnly": true + }, + "mountPath": { + "description": "Mount path of the persistent disk", + "type": "string" + } + } + }, + "LoadedCertificate": { + "description": "Loaded certificate payload", + "required": [ + "resourceId" + ], + "type": "object", + "properties": { + "resourceId": { + "description": "Resource Id of loaded certificate", + "type": "string" + }, + "loadTrustStore": { + "description": "Indicate whether the certificate will be loaded into default trust store, only work for Java runtime.", + "type": "boolean", + "default": false + } + } + }, + "LoadedCertificateCollection": { + "description": "Collection of loaded certificate resources list and a possible link for next page.", + "type": "array", + "items": { + "$ref": "#/definitions/LoadedCertificate" + } + }, + "AppVNetAddons": { + "description": "Additional App settings in vnet injection instance", + "type": "object", + "properties": { + "publicEndpoint": { + "description": "Indicates whether the App in vnet injection instance exposes endpoint which could be accessed from internet.", + "type": "boolean", + "default": false + }, + "publicEndpointUrl": { + "description": "URL of the App in vnet injection instance which could be accessed from internet", + "type": "string", + "readOnly": true + } + } + }, + "IngressSettings": { + "description": "App ingress settings payload.", + "type": "object", + "properties": { + "readTimeoutInSeconds": { + "format": "int32", + "description": "Ingress read time out in seconds.", + "type": "integer" + }, + "sendTimeoutInSeconds": { + "format": "int32", + "description": "Ingress send time out in seconds.", + "type": "integer" + }, + "sessionAffinity": { + "description": "Type of the affinity, set this to Cookie to enable session affinity.", + "enum": [ + "Cookie", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "SessionAffinity", + "modelAsString": true + } + }, + "sessionCookieMaxAge": { + "description": "Time in seconds until the cookie expires.", + "format": "int32", + "type": "integer" + }, + "backendProtocol": { + "description": "How ingress should communicate with this app backend service.", + "enum": [ + "GRPC", + "Default" + ], + "type": "string", + "x-ms-enum": { + "name": "BackendProtocol", + "modelAsString": true + } + }, + "clientAuth": { + "description": "Client-Certification Authentication.", + "type": "object", + "properties": { + "certificates": { + "description": "Collection of certificate resource id.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "AppResourceCollection": { + "description": "Object that includes an array of App resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of App resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/AppResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ActiveDeploymentCollection": { + "description": "Object that includes an array of Deployment resource name and set them as active.", + "type": "object", + "properties": { + "activeDeploymentNames": { + "description": "Collection of Deployment name.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ResourceUploadDefinition": { + "description": "Resource upload definition payload", + "type": "object", + "properties": { + "relativePath": { + "description": "Source relative path", + "type": "string" + }, + "uploadUrl": { + "description": "Upload URL", + "type": "string" + } + } + }, + "BindingResource": { + "description": "Binding resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BindingResourceProperties", + "description": "Properties of the Binding resource", + "x-ms-client-flatten": false + } + } + }, + "BindingResourceProperties": { + "description": "Binding resource properties payload", + "type": "object", + "properties": { + "resourceName": { + "description": "The name of the bound resource", + "type": "string", + "readOnly": true + }, + "resourceType": { + "description": "The standard Azure resource type of the bound resource", + "type": "string", + "readOnly": true + }, + "resourceId": { + "description": "The Azure resource id of the bound resource", + "type": "string" + }, + "key": { + "description": "The key of the bound resource", + "type": "string" + }, + "bindingParameters": { + "description": "Binding parameters of the Binding resource", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "generatedProperties": { + "description": "The generated Spring Boot property file for this binding. The secret will be deducted.", + "type": "string", + "readOnly": true + }, + "createdAt": { + "description": "Creation time of the Binding resource", + "type": "string", + "readOnly": true + }, + "updatedAt": { + "description": "Update time of the Binding resource", + "type": "string", + "readOnly": true + } + } + }, + "BindingResourceCollection": { + "description": "Object that includes an array of Binding resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Binding resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BindingResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CertificateResource": { + "description": "Certificate resource payload.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CertificateProperties", + "description": "Properties of the certificate resource payload.", + "x-ms-client-flatten": false + } + } + }, + "CertificateProperties": { + "description": "Certificate resource payload.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of the certificate source.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "thumbprint": { + "description": "The thumbprint of certificate.", + "type": "string", + "readOnly": true + }, + "issuer": { + "description": "The issuer of certificate.", + "type": "string", + "readOnly": true + }, + "issuedDate": { + "description": "The issue date of certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "The expiration date of certificate.", + "type": "string", + "readOnly": true + }, + "activateDate": { + "description": "The activate date of certificate.", + "type": "string", + "readOnly": true + }, + "subjectName": { + "description": "The subject name of certificate.", + "type": "string", + "readOnly": true + }, + "dnsNames": { + "description": "The domain list of certificate.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the Certificate", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CertificateResourceProvisioningState", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "KeyVaultCertificateProperties": { + "description": "Properties of certificate imported from key vault.", + "required": [ + "type", + "vaultUri", + "keyVaultCertName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CertificateProperties" + } + ], + "properties": { + "vaultUri": { + "description": "The vault uri of user key vault.", + "type": "string" + }, + "keyVaultCertName": { + "description": "The certificate name of key vault.", + "type": "string" + }, + "certVersion": { + "description": "The certificate version of key vault.", + "type": "string" + }, + "excludePrivateKey": { + "description": "Optional. If set to true, it will not import private key from key vault.", + "type": "boolean", + "default": false + }, + "autoSync": { + "description": "Indicates whether to automatically synchronize certificate from key vault or not.", + "enum": [ + "Disabled", + "Enabled" + ], + "default": "Disabled", + "type": "string", + "x-ms-enum": { + "name": "KeyVaultCertificateAutoSync", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "KeyVaultCertificate" + }, + "ContentCertificateProperties": { + "description": "Properties of certificate imported from key vault.", + "required": [ + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CertificateProperties" + } + ], + "properties": { + "content": { + "description": "The content of uploaded certificate.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "x-ms-discriminator-value": "ContentCertificate" + }, + "CertificateResourceCollection": { + "description": "Collection compose of certificate resources list and a possible link for next page.", + "type": "object", + "properties": { + "value": { + "description": "The certificate resources list.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/CertificateResource" + } + }, + "nextLink": { + "description": "The link to next page of certificate list.", + "type": "string" + } + } + }, + "StorageResource": { + "description": "Storage resource payload.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageProperties", + "description": "Properties of the storage resource payload.", + "x-ms-client-flatten": false + } + } + }, + "StorageProperties": { + "description": "Storage resource payload.", + "type": "object", + "required": [ + "storageType" + ], + "properties": { + "storageType": { + "description": "The type of the storage.", + "enum": [ + "StorageAccount" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + } + }, + "discriminator": "storageType" + }, + "StorageAccount": { + "description": "storage resource of type Azure Storage Account.", + "type": "object", + "required": [ + "storageType", + "accountName", + "accountKey" + ], + "allOf": [ + { + "$ref": "#/definitions/StorageProperties" + } + ], + "properties": { + "accountName": { + "description": "The account name of the Azure Storage Account.", + "type": "string" + }, + "accountKey": { + "description": "The account key of the Azure Storage Account.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "x-ms-discriminator-value": "StorageAccount" + }, + "StorageResourceCollection": { + "description": "Collection compose of storage resources list and a possible link for next page.", + "type": "object", + "properties": { + "value": { + "description": "The storage resources list.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/StorageResource" + } + }, + "nextLink": { + "description": "The link to next page of storage list.", + "type": "string" + } + } + }, + "CustomPersistentDiskResource": { + "description": "Custom persistent disk resource payload.", + "type": "object", + "required": [ + "storageId" + ], + "properties": { + "customPersistentDiskProperties": { + "$ref": "#/definitions/CustomPersistentDiskProperties", + "description": "Properties of the custom persistent disk resource payload.", + "x-ms-client-flatten": false + }, + "storageId": { + "description": "The resource id of Azure Spring Apps Storage resource.", + "type": "string" + } + } + }, + "CustomPersistentDiskProperties": { + "description": "Custom persistent disk resource payload.", + "required": [ + "type", + "mountPath" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of the underlying resource to mount as a persistent disk.", + "enum": [ + "AzureFileVolume" + ], + "type": "string", + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + }, + "mountPath": { + "description": "The mount path of the persistent disk.", + "type": "string" + }, + "readOnly": { + "description": "Indicates whether the persistent disk is a readOnly one.", + "type": "boolean" + }, + "enableSubPath": { + "description": "If set to true, it will create and mount a dedicated directory for every individual app instance.", + "type": "boolean", + "default": false + }, + "mountOptions": { + "description": "These are the mount options for a persistent disk.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + }, + "discriminator": "type" + }, + "CustomPersistentDiskCollection": { + "description": "Collection of persistent disk resources list and a possible link for next page.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomPersistentDiskResource" + } + }, + "AzureFileVolume": { + "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", + "type": "object", + "required": [ + "type", + "mountPath" + ], + "allOf": [ + { + "$ref": "#/definitions/CustomPersistentDiskProperties" + } + ], + "properties": { + "shareName": { + "description": "The share name of the Azure File share.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureFileVolume" + }, + "NameAvailabilityParameters": { + "description": "Name availability parameters payload", + "required": [ + "type", + "name" + ], + "type": "object", + "properties": { + "type": { + "description": "Type of the resource to check name availability", + "type": "string" + }, + "name": { + "description": "Name to be checked", + "type": "string" + } + } + }, + "NameAvailability": { + "description": "Name availability result payload", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available", + "type": "boolean" + }, + "reason": { + "description": "Reason why the name is not available", + "type": "string" + }, + "message": { + "description": "Message why the name is not available", + "type": "string" + } + }, + "readOnly": true + }, + "CustomDomainResource": { + "description": "Custom domain resource payload.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomDomainProperties", + "description": "Properties of the custom domain resource.", + "x-ms-client-flatten": false + } + } + }, + "CustomDomainProperties": { + "description": "Custom domain of app resource payload.", + "type": "object", + "properties": { + "thumbprint": { + "description": "The thumbprint of bound certificate.", + "type": "string" + }, + "appName": { + "description": "The app name of domain.", + "type": "string", + "readOnly": true + }, + "certName": { + "description": "The bound certificate name of domain.", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state of the Domain", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CustomDomainResourceProvisioningState", + "modelAsString": true + } + } + } + }, + "CustomDomainResourceCollection": { + "description": "Collection compose of a custom domain resources list and a possible link for next page.", + "type": "object", + "properties": { + "value": { + "description": "The custom domain resources list.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "nextLink": { + "description": "The link to next page of custom domain list.", + "type": "string" + } + } + }, + "CustomDomainValidatePayload": { + "description": "Custom domain validate payload.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name to be validated", + "type": "string" + } + } + }, + "CustomDomainValidateResult": { + "description": "Validation result for custom domain.", + "type": "object", + "properties": { + "isValid": { + "description": "Indicates if domain name is valid.", + "type": "boolean" + }, + "message": { + "description": "Message of why domain name is invalid.", + "type": "string" + } + } + }, + "RemoteDebuggingPayload": { + "description": "Remote debugging payload.", + "type": "object", + "properties": { + "port": { + "description": "Application debugging port.", + "type": "integer", + "format": "int32" + } + } + }, + "RemoteDebugging": { + "description": "Remote debugging config.", + "type": "object", + "properties": { + "port": { + "description": "Application debugging port", + "type": "integer", + "format": "int32" + }, + "enabled": { + "description": "Indicate if remote debugging is enabled", + "type": "boolean" + } + } + }, + "CustomScaleRule": { + "description": "Azure Spring Apps App Instance Custom scaling rule.", + "type": "object", + "properties": { + "type": { + "description": "Type of the custom scale rule\neg: azure-servicebus, redis etc.", + "type": "string" + }, + "metadata": { + "description": "Metadata properties to describe custom scale rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "auth": { + "description": "Authentication secrets for the custom scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + } + } + }, + "HttpScaleRule": { + "description": "Azure Spring Apps App Instance Http scaling rule.", + "type": "object", + "properties": { + "metadata": { + "description": "Metadata properties to describe http scale rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "auth": { + "description": "Authentication secrets for the custom scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + } + } + }, + "TcpScaleRule": { + "description": "Azure Spring Apps App Instance Tcp scaling rule.", + "type": "object", + "properties": { + "metadata": { + "description": "Metadata properties to describe tcp scale rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "auth": { + "description": "Authentication secrets for the tcp scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + } + } + }, + "QueueScaleRule": { + "description": "Azure Spring Apps App Instance Azure Queue based scaling rule.", + "type": "object", + "properties": { + "queueName": { + "description": "Queue name.", + "type": "string" + }, + "queueLength": { + "format": "int32", + "description": "Queue length.", + "type": "integer" + }, + "auth": { + "description": "Authentication secrets for the queue scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + } + } + }, + "Scale": { + "description": "Azure Spring Apps scaling configurations.", + "type": "object", + "properties": { + "minReplicas": { + "format": "int32", + "description": "Optional. Minimum number of container replicas.", + "type": "integer" + }, + "maxReplicas": { + "format": "int32", + "description": "Optional. Maximum number of container replicas. Defaults to 10 if not set.", + "type": "integer", + "default": 10 + }, + "rules": { + "description": "Scaling rules.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ScaleRule": { + "description": "Azure Spring Apps App Instance scaling rule.", + "type": "object", + "properties": { + "name": { + "description": "Scale Rule Name", + "type": "string" + }, + "azureQueue": { + "$ref": "#/definitions/QueueScaleRule", + "description": "Azure Queue based scaling." + }, + "custom": { + "$ref": "#/definitions/CustomScaleRule", + "description": "Custom scale rule." + }, + "http": { + "$ref": "#/definitions/HttpScaleRule", + "description": "HTTP requests based scaling." + }, + "tcp": { + "$ref": "#/definitions/TcpScaleRule", + "description": "Tcp requests based scaling." + } + } + }, + "ScaleRuleAuth": { + "description": "Auth Secrets for Azure Spring Apps App Instance Scale Rule", + "type": "object", + "properties": { + "secretRef": { + "description": "Name of the Azure Spring Apps App Instance secret from which to pull the auth params.", + "type": "string" + }, + "triggerParameter": { + "description": "Trigger Parameter that uses the secret", + "type": "string" + } + } + }, + "Secret": { + "description": "Secret definition.", + "type": "object", + "properties": { + "name": { + "description": "Secret Name.", + "type": "string" + }, + "value": { + "description": "Secret Value.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "DeploymentResource": { + "description": "Deployment resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DeploymentResourceProperties", + "description": "Properties of the Deployment resource", + "x-ms-client-flatten": false + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the Deployment resource" + } + } + }, + "DeploymentResourceProperties": { + "description": "Deployment resource properties payload", + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/UserSourceInfo", + "description": "Uploaded source information of the deployment." + }, + "deploymentSettings": { + "$ref": "#/definitions/DeploymentSettings", + "description": "Deployment settings of the Deployment" + }, + "provisioningState": { + "description": "Provisioning state of the Deployment", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeploymentResourceProvisioningState", + "modelAsString": true + } + }, + "status": { + "description": "Status of the Deployment", + "enum": [ + "Stopped", + "Running" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeploymentResourceStatus", + "modelAsString": true + } + }, + "active": { + "description": "Indicates whether the Deployment is active", + "type": "boolean" + }, + "instances": { + "description": "Collection of instances belong to the Deployment", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentInstance" + }, + "readOnly": true + } + } + }, + "UserSourceInfo": { + "description": "Source information for a deployment", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Type of the source uploaded", + "type": "string" + }, + "version": { + "description": "Version of the source", + "type": "string" + } + }, + "discriminator": "type" + }, + "UploadedUserSourceInfo": { + "description": "Source with uploaded location", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UserSourceInfo" + } + ], + "properties": { + "relativePath": { + "description": "Relative path of the storage which stores the source", + "type": "string" + } + } + }, + "JarUploadedUserSourceInfo": { + "description": "Uploaded Jar binary for a deployment", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UploadedUserSourceInfo" + } + ], + "properties": { + "runtimeVersion": { + "description": "Runtime version of the Jar file", + "type": "string" + }, + "jvmOptions": { + "description": "JVM parameter", + "type": "string" + } + }, + "x-ms-discriminator-value": "Jar" + }, + "WarUploadedUserSourceInfo": { + "description": "Uploaded War binary for a deployment", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UploadedUserSourceInfo" + } + ], + "properties": { + "runtimeVersion": { + "description": "Runtime version of the war file", + "type": "string" + }, + "jvmOptions": { + "description": "JVM parameter", + "type": "string" + }, + "serverVersion": { + "description": "Server version, currently only Apache Tomcat is supported", + "type": "string" + } + }, + "x-ms-discriminator-value": "War" + }, + "SourceUploadedUserSourceInfo": { + "description": "Uploaded Java source code binary for a deployment", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UploadedUserSourceInfo" + } + ], + "properties": { + "artifactSelector": { + "description": "Selector for the artifact to be used for the deployment for multi-module projects. This should be\r\nthe relative path to the target module/project.", + "type": "string" + }, + "runtimeVersion": { + "description": "Runtime version of the source file", + "type": "string" + } + }, + "x-ms-discriminator-value": "Source" + }, + "NetCoreZipUploadedUserSourceInfo": { + "description": "Uploaded Jar binary for a deployment", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UploadedUserSourceInfo" + } + ], + "properties": { + "netCoreMainEntryPath": { + "description": "The path to the .NET executable relative to zip root", + "type": "string" + }, + "runtimeVersion": { + "description": "Runtime version of the .Net file", + "type": "string" + } + }, + "x-ms-discriminator-value": "NetCoreZip" + }, + "BuildResultUserSourceInfo": { + "description": "Reference to a build result", + "type": "object", + "x-ms-discriminator-value": "BuildResult", + "allOf": [ + { + "$ref": "#/definitions/UserSourceInfo" + } + ], + "properties": { + "buildResultId": { + "description": "Resource id of an existing succeeded build result under the same Spring instance.", + "type": "string" + } + } + }, + "CustomContainerUserSourceInfo": { + "description": "Custom container user source info", + "type": "object", + "x-ms-discriminator-value": "Container", + "allOf": [ + { + "$ref": "#/definitions/UserSourceInfo" + } + ], + "properties": { + "customContainer": { + "$ref": "#/definitions/CustomContainer" + } + } + }, + "CustomContainer": { + "description": "Custom container payload", + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "The name of the registry that contains the container image" + }, + "containerImage": { + "type": "string", + "description": "Container image of the custom container. This should be in the form of : without the server name of the registry" + }, + "command": { + "description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "args": { + "description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "imageRegistryCredential": { + "$ref": "#/definitions/ImageRegistryCredential", + "description": "Credential of the image registry" + }, + "languageFramework": { + "description": "Language framework of the container image uploaded. Supported values: \"springboot\", \"\", null.", + "type": "string" + } + } + }, + "ImageRegistryCredential": { + "description": "Credential of the image registry", + "type": "object", + "properties": { + "username": { + "type": "string", + "description": "The username of the image registry credential" + }, + "password": { + "type": "string", + "description": "The password of the image registry credential" + } + } + }, + "DeploymentSettings": { + "description": "Deployment settings payload", + "type": "object", + "properties": { + "resourceRequests": { + "$ref": "#/definitions/ResourceRequests", + "description": "The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later." + }, + "environmentVariables": { + "description": "Collection of environment variables", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "apms": { + "$ref": "#/definitions/ApmReferenceCollection", + "description": "Collection of ApmReferences" + }, + "addonConfigs": { + "description": "Collection of addons", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "livenessProbe": { + "$ref": "#/definitions/Probe", + "description": "Periodic probe of App Instance liveness. App Instance will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + }, + "readinessProbe": { + "$ref": "#/definitions/Probe", + "description": "Periodic probe of App Instance service readiness. App Instance will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + }, + "startupProbe": { + "$ref": "#/definitions/Probe", + "description": "StartupProbe indicates that the App Instance has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a App Instance's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + }, + "terminationGracePeriodSeconds": { + "description": "Optional duration in seconds the App Instance needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the App Instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 90 seconds.", + "format": "int32", + "type": "integer", + "default": 90 + }, + "scale": { + "$ref": "#/definitions/Scale", + "description": "Scaling properties for the Azure Spring Apps App Instance." + }, + "containerProbeSettings": { + "$ref": "#/definitions/ContainerProbeSettings" + } + } + }, + "Probe": { + "description": "Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic.", + "type": "object", + "required": [ + "disableProbe" + ], + "properties": { + "probeAction": { + "$ref": "#/definitions/ProbeAction", + "description": "The action of the probe." + }, + "disableProbe": { + "description": "Indicate whether the probe is disabled.", + "type": "boolean", + "default": false + }, + "initialDelaySeconds": { + "description": "Number of seconds after the App Instance has started before probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "format": "int32", + "type": "integer" + }, + "periodSeconds": { + "description": "How often (in seconds) to perform the probe. Minimum value is 1.", + "format": "int32", + "type": "integer" + }, + "timeoutSeconds": { + "description": "Number of seconds after which the probe times out. Minimum value is 1.", + "format": "int32", + "type": "integer" + }, + "failureThreshold": { + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.", + "format": "int32", + "type": "integer" + }, + "successThreshold": { + "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 for liveness and startup. Minimum value is 1.", + "format": "int32", + "type": "integer" + } + } + }, + "ProbeAction": { + "description": "The action of the probe.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of the action to take to perform the health check.", + "enum": [ + "HTTPGetAction", + "TCPSocketAction", + "ExecAction" + ], + "type": "string", + "x-ms-enum": { + "name": "ProbeActionType", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "HTTPGetAction": { + "description": "HTTPGetAction describes an action based on HTTP Get requests.", + "properties": { + "path": { + "description": "Path to access on the HTTP server.", + "type": "string" + }, + "scheme": { + "description": "Scheme to use for connecting to the host. Defaults to HTTP.\n\nPossible enum values:\n - `\"HTTP\"` means that the scheme used will be http://\n - `\"HTTPS\"` means that the scheme used will be https://", + "enum": [ + "HTTP", + "HTTPS" + ], + "type": "string", + "x-ms-enum": { + "name": "HTTPSchemeType", + "modelAsString": true + } + } + }, + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProbeAction" + } + ], + "x-ms-discriminator-value": "HTTPGetAction" + }, + "ExecAction": { + "description": "ExecAction describes a \"run in container\" action.", + "properties": { + "command": { + "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.", + "items": { + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProbeAction" + } + ], + "x-ms-discriminator-value": "ExecAction" + }, + "TCPSocketAction": { + "description": "TCPSocketAction describes an action based on opening a socket", + "properties": {}, + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProbeAction" + } + ], + "x-ms-discriminator-value": "TCPSocketAction" + }, + "ContainerProbeSettings": { + "description": "Container liveness and readiness probe settings", + "type": "object", + "properties": { + "disableProbe": { + "description": "Indicates whether disable the liveness and readiness probe", + "type": "boolean" + } + } + }, + "DeploymentInstance": { + "description": "Deployment instance payload", + "type": "object", + "properties": { + "name": { + "description": "Name of the deployment instance", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the deployment instance", + "type": "string", + "readOnly": true + }, + "reason": { + "description": "Failed reason of the deployment instance", + "type": "string", + "readOnly": true + }, + "discoveryStatus": { + "description": "Discovery status of the deployment instance", + "type": "string", + "readOnly": true + }, + "startTime": { + "description": "Start time of the deployment instance", + "type": "string", + "readOnly": true + }, + "zone": { + "description": "Availability zone information of the deployment instance", + "type": "string", + "readOnly": true + } + } + }, + "DeploymentList": { + "description": "A list of deployments resource ids.", + "type": "object", + "properties": { + "deployments": { + "description": "A list of deployment resource ids.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DeploymentResourceCollection": { + "description": "Object that includes an array of App resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Deployment resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ResourceRequests": { + "description": "Deployment resource request payload", + "type": "object", + "properties": { + "cpu": { + "description": "Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier.", + "type": "string" + }, + "memory": { + "description": "Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier.", + "type": "string" + } + } + }, + "LogFileUrlResponse": { + "description": "Log file URL payload", + "required": [ + "url" + ], + "type": "object", + "properties": { + "url": { + "description": "URL of the log file", + "type": "string" + } + } + }, + "DiagnosticParameters": { + "description": "Diagnostic parameters of diagnostic operations", + "type": "object", + "properties": { + "appInstance": { + "description": "App instance name", + "type": "string" + }, + "filePath": { + "description": "Your target file path in your own BYOS", + "type": "string" + }, + "duration": { + "description": "Duration of your JFR. 1 min can be represented by 1m or 60s.", + "type": "string" + } + } + }, + "ServiceResourceList": { + "description": "Object that includes an array of Service resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Service resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "AvailableOperations": { + "description": "Available operations of the service", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OperationDetail" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationDetail": { + "description": "Operation detail payload", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Display of the operation" + }, + "actionType": { + "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", + "type": "string", + "readOnly": true, + "enum": [ + "Internal" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation" + } + } + }, + "OperationDisplay": { + "description": "Operation display payload", + "type": "object", + "properties": { + "provider": { + "description": "Resource provider of the operation", + "type": "string" + }, + "resource": { + "description": "Resource of the operation", + "type": "string" + }, + "operation": { + "description": "Localized friendly name for the operation", + "type": "string" + }, + "description": { + "description": "Localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "Service specifications of the operation" + } + } + }, + "ServiceSpecification": { + "description": "Service specification payload", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Specifications of the Log for Azure Monitoring", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + }, + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + } + } + }, + "LogSpecification": { + "description": "Specifications of the Log for Azure Monitoring", + "type": "object", + "properties": { + "name": { + "description": "Name of the log", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the log", + "type": "string" + }, + "blobDuration": { + "description": "Blob duration of the log", + "type": "string" + } + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric", + "type": "string" + }, + "unit": { + "description": "Unit that makes sense for the metric", + "type": "string" + }, + "category": { + "description": "Name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "supportedAggregationTypes": { + "description": "Supported aggregation types", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "supportedTimeGrainTypes": { + "description": "Supported time grain types", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.", + "type": "boolean" + }, + "dimensions": { + "description": "Dimensions of the metric", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + } + }, + "sourceMdmNamespace": { + "description": "Name of the MDM namespace. Optional.", + "type": "string" + } + } + }, + "MetricDimension": { + "description": "Specifications of the Dimension of metrics", + "type": "object", + "properties": { + "name": { + "description": "Name of the dimension", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "Whether this dimension should be included for the Shoebox export scenario", + "type": "boolean" + } + } + }, + "ResourceSkuCollection": { + "description": "Object that includes an array of Azure Spring Apps SKU and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of resource SKU", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSku" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ResourceSku": { + "description": "Describes an available Azure Spring Apps SKU.", + "type": "object", + "properties": { + "resourceType": { + "description": "Gets the type of resource the SKU applies to.", + "type": "string" + }, + "name": { + "description": "Gets the name of SKU.", + "type": "string" + }, + "tier": { + "description": "Gets the tier of SKU.", + "type": "string" + }, + "capacity": { + "$ref": "#/definitions/SkuCapacity", + "description": "Gets the capacity of SKU." + }, + "locations": { + "description": "Gets the set of locations that the SKU is available.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "locationInfo": { + "description": "Gets a list of locations and availability zones in those locations where the SKU is available.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuLocationInfo" + } + }, + "restrictions": { + "description": "Gets the restrictions because of which SKU cannot be used. This is\r\nempty if there are no restrictions.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuRestrictions" + } + } + } + }, + "SkuCapacity": { + "description": "The SKU capacity", + "required": [ + "minimum" + ], + "type": "object", + "properties": { + "minimum": { + "format": "int32", + "description": "Gets or sets the minimum.", + "type": "integer" + }, + "maximum": { + "format": "int32", + "description": "Gets or sets the maximum.", + "type": "integer" + }, + "default": { + "format": "int32", + "description": "Gets or sets the default.", + "type": "integer" + }, + "scaleType": { + "description": "Gets or sets the type of the scale.", + "enum": [ + "None", + "Manual", + "Automatic" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuScaleType", + "modelAsString": true + } + } + } + }, + "ResourceSkuLocationInfo": { + "description": "Locations and availability zones where the SKU is available", + "type": "object", + "properties": { + "location": { + "description": "Gets location of the SKU", + "type": "string" + }, + "zones": { + "description": "Gets list of availability zones where the SKU is supported.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "zoneDetails": { + "description": "Gets details of capabilities available to a SKU in specific zones.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuZoneDetails" + } + } + } + }, + "ResourceSkuRestrictions": { + "description": "Restrictions where the SKU cannot be used", + "type": "object", + "properties": { + "type": { + "description": "Gets the type of restrictions. Possible values include: 'Location', 'Zone'", + "enum": [ + "Location", + "Zone" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceSkuRestrictionsType", + "modelAsString": true + } + }, + "values": { + "description": "Gets the value of restrictions. If the restriction type is set to\r\nlocation. This would be different locations where the SKU is restricted.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "restrictionInfo": { + "$ref": "#/definitions/ResourceSkuRestrictionInfo", + "description": "Gets the information about the restriction where the SKU cannot be used." + }, + "reasonCode": { + "description": "Gets the reason for restriction. Possible values include: 'QuotaId', 'NotAvailableForSubscription'", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceSkuRestrictionsReasonCode", + "modelAsString": true + } + } + } + }, + "ResourceSkuZoneDetails": { + "description": "Details of capabilities available to a SKU in specific zones", + "type": "object", + "properties": { + "name": { + "description": "Gets the set of zones that the SKU is available in with the\r\nspecified capabilities.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "capabilities": { + "description": "Gets a list of capabilities that are available for the SKU in the\r\nspecified list of zones.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuCapabilities" + } + } + } + }, + "ResourceSkuRestrictionInfo": { + "description": "Information about the restriction where the SKU cannot be used", + "type": "object", + "properties": { + "locations": { + "description": "Gets locations where the SKU is restricted", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "zones": { + "description": "Gets list of availability zones where the SKU is restricted.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ResourceSkuCapabilities": { + "type": "object", + "properties": { + "name": { + "description": "Gets an invariant to describe the feature.", + "type": "string" + }, + "value": { + "description": "Gets an invariant if the feature is measured by quantity.", + "type": "string" + } + } + }, + "CloudError": { + "type": "object", + "description": "An error response from the service.", + "properties": { + "error": { + "description": "An error response from the service.", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "type": "object", + "description": "An error response from the service.", + "properties": { + "code": { + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", + "type": "string" + }, + "message": { + "description": "A message describing the error, intended to be suitable for display in a user interface.", + "type": "string" + }, + "target": { + "description": "The target of the particular error. For example, the name of the property in error.", + "type": "string" + }, + "details": { + "description": "A list of additional details about the error.", + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + } + } + }, + "x-ms-external": true + }, + "AvailableRuntimeVersions": { + "type": "object", + "properties": { + "value": { + "description": "A list of all supported runtime versions.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SupportedRuntimeVersion" + }, + "readOnly": true + } + }, + "readOnly": true + }, + "SupportedRuntimeVersion": { + "description": "Supported deployment runtime version descriptor.", + "type": "object", + "properties": { + "value": { + "description": "The raw value which could be passed to deployment CRUD operations.", + "enum": [ + "Java_8", + "Java_11", + "Java_17", + "Java_21", + "NetCore_31" + ], + "type": "string", + "x-ms-enum": { + "name": "SupportedRuntimeValue", + "modelAsString": true + } + }, + "platform": { + "description": "The platform of this runtime version (possible values: \"Java\" or \".NET\").", + "enum": [ + "Java", + ".NET Core" + ], + "type": "string", + "x-ms-enum": { + "name": "SupportedRuntimePlatform", + "modelAsString": true + } + }, + "version": { + "description": "The detailed version (major.minor) of the platform.", + "type": "string" + } + }, + "readOnly": true + }, + "SupportedServerVersions": { + "description": "Supported server versions.", + "type": "object", + "properties": { + "value": { + "description": "Collection of the supported server versions.", + "uniqueItems": false, + "type": "array", + "x-ms-identifiers": [ + "value" + ], + "items": { + "$ref": "#/definitions/SupportedServerVersion" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SupportedServerVersion": { + "description": "Supported server version.", + "type": "object", + "properties": { + "value": { + "description": "The raw server version value which could be passed to deployment CRUD operations.", + "type": "string" + }, + "server": { + "description": "The server name.", + "type": "string" + }, + "version": { + "description": "The Server version.", + "type": "string" + } + }, + "readOnly": true + }, + "BuildpackBindingResourceCollection": { + "description": "Object that includes an array of BuildpackBinding resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of BuildpackBinding resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BuildpackBindingResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "BuildpackBindingResource": { + "description": "Buildpack Binding Resource object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Properties of a buildpack binding", + "$ref": "#/definitions/BuildpackBindingProperties" + } + } + }, + "BuildpackBindingProperties": { + "description": "Properties of a buildpack binding", + "type": "object", + "properties": { + "bindingType": { + "description": "Buildpack Binding Type", + "enum": [ + "ApplicationInsights", + "ApacheSkyWalking", + "AppDynamics", + "Dynatrace", + "NewRelic", + "ElasticAPM", + "CACertificates" + ], + "type": "string", + "x-ms-enum": { + "name": "bindingType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "State of the Buildpack Binding.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BuildpackBindingProvisioningState", + "modelAsString": true + } + }, + "launchProperties": { + "description": "The object describes the buildpack binding launch properties", + "$ref": "#/definitions/BuildpackBindingLaunchProperties" + } + } + }, + "BuildpackBindingLaunchProperties": { + "description": "Buildpack Binding Launch Properties", + "type": "object", + "properties": { + "properties": { + "description": "Non-sensitive properties for launchProperties", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "secrets": { + "description": "Sensitive properties for launchProperties", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ApmResourceCollection": { + "description": "Object that includes an array of APM resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of APM resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ApmResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ApmResource": { + "description": "APM Resource object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ApmProperties", + "description": "Properties of an APM", + "x-ms-client-flatten": false + } + } + }, + "ApmProperties": { + "description": "Properties of an APM", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "APM Type", + "type": "string" + }, + "provisioningState": { + "description": "State of the APM.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ApmProvisioningState", + "modelAsString": true + } + }, + "properties": { + "description": "Non-sensitive properties for the APM", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "secrets": { + "description": "Sensitive properties for the APM", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + } + } + }, + "ApmSecretKeys": { + "description": "Keys of APM sensitive properties", + "type": "object", + "properties": { + "value": { + "description": "Collection of the keys for the APM sensitive properties", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SupportedApmTypes": { + "description": "Supported APM types payload", + "type": "object", + "properties": { + "value": { + "description": "Collection of the supported APM type", + "uniqueItems": false, + "type": "array", + "x-ms-identifiers": [ + "name" + ], + "items": { + "$ref": "#/definitions/SupportedApmType" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SupportedApmType": { + "description": "Supported APM type", + "type": "object", + "properties": { + "name": { + "description": "The name of the supported APM type", + "type": "string" + } + } + }, + "GloballyEnabledApms": { + "description": "Globally enabled APMs payload", + "type": "object", + "properties": { + "value": { + "description": "Collection of the globally enabled APMs", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ApmReference": { + "description": "A reference to the APM", + "required": [ + "resourceId" + ], + "type": "object", + "properties": { + "resourceId": { + "description": "Resource Id of the APM", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AppPlatform/Spring/apms" + } + ] + } + } + } + }, + "ApmReferenceCollection": { + "description": "Collection of ApmReferences", + "type": "array", + "x-ms-identifiers": [ + "resourceId" + ], + "items": { + "$ref": "#/definitions/ApmReference" + } + }, + "CertificateReference": { + "description": "A reference to the certificate", + "required": [ + "resourceId" + ], + "type": "object", + "properties": { + "resourceId": { + "description": "Resource Id of the certificate", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AppPlatform/Spring/certificates" + } + ] + } + } + } + }, + "CertificateReferenceCollection": { + "description": "Collection of CertificateReferences", + "type": "array", + "x-ms-identifiers": [ + "resourceId" + ], + "items": { + "$ref": "#/definitions/CertificateReference" + } + }, + "GatewayResourceCollection": { + "description": "Object that includes an array of gateway resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of gateway resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GatewayResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "GatewayResource": { + "description": "Spring Cloud Gateway resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/GatewayProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the Spring Cloud Gateway resource" + } + } + }, + "SkuObject": { + "description": "Resource Sku object used for scaling out and scaling in.", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the Spring Cloud Gateway resource" + } + } + }, + "GatewayProperties": { + "description": "Spring Cloud Gateway properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the Spring Cloud Gateway.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "GatewayProvisioningState", + "modelAsString": true + } + }, + "public": { + "description": "Indicates whether the Spring Cloud Gateway exposes endpoint.", + "type": "boolean", + "default": false + }, + "url": { + "description": "URL of the Spring Cloud Gateway, exposed when 'public' is true.", + "type": "string", + "readOnly": true + }, + "httpsOnly": { + "description": "Indicate if only https is allowed.", + "type": "boolean", + "default": false + }, + "ssoProperties": { + "$ref": "#/definitions/SsoProperties" + }, + "apiMetadataProperties": { + "$ref": "#/definitions/GatewayApiMetadataProperties" + }, + "corsProperties": { + "$ref": "#/definitions/GatewayCorsProperties" + }, + "clientAuth": { + "description": "Client-Certification Authentication.", + "type": "object", + "properties": { + "certificates": { + "description": "Collection of certificate resource Ids in Azure Spring Apps.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "certificateVerification": { + "description": "Whether to enable certificate verification or not", + "type": "string", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "GatewayCertificateVerification", + "values": [ + { + "description": "Enable certificate verification in Spring Cloud Gateway.", + "value": "Enabled" + }, + { + "description": "Disable certificate verification in Spring Cloud Gateway.", + "value": "Disabled" + } + ] + } + } + } + }, + "apmTypes": { + "description": "Collection of APM type used in Spring Cloud Gateway", + "uniqueItems": true, + "type": "array", + "items": { + "description": "Type of application performance monitoring", + "enum": [ + "ApplicationInsights", + "AppDynamics", + "Dynatrace", + "NewRelic", + "ElasticAPM" + ], + "type": "string", + "x-ms-enum": { + "name": "ApmType", + "modelAsString": true + } + } + }, + "apms": { + "$ref": "#/definitions/ApmReferenceCollection", + "description": "Collection of ApmReferences in service level" + }, + "environmentVariables": { + "description": "Environment variables of Spring Cloud Gateway", + "type": "object", + "properties": { + "properties": { + "description": "Non-sensitive properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "secrets": { + "description": "Sensitive properties", + "type": "object", + "x-ms-secret": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "resourceRequests": { + "$ref": "#/definitions/GatewayResourceRequests", + "description": "The requested resource quantity for required CPU and Memory." + }, + "addonConfigs": { + "description": "Collection of addons for Spring Cloud Gateway", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "instances": { + "description": "Collection of instances belong to Spring Cloud Gateway.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GatewayInstance" + }, + "readOnly": true + }, + "operatorProperties": { + "$ref": "#/definitions/GatewayOperatorProperties", + "readOnly": true + }, + "responseCacheProperties": { + "$ref": "#/definitions/GatewayResponseCacheProperties", + "description": "The properties to configure different types of response cache for Spring Cloud Gateway.", + "x-ms-client-flatten": false + } + } + }, + "SsoProperties": { + "description": "Single sign-on related configuration", + "type": "object", + "properties": { + "scope": { + "description": "It defines the specific actions applications can be allowed to do on a user's behalf", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "clientId": { + "description": "The public identifier for the application", + "type": "string" + }, + "clientSecret": { + "description": "The secret known only to the application and the authorization server", + "type": "string" + }, + "issuerUri": { + "description": "The URI of Issuer Identifier", + "type": "string" + } + } + }, + "GatewayApiMetadataProperties": { + "description": "API metadata property for Spring Cloud Gateway", + "type": "object", + "properties": { + "title": { + "description": "Title describing the context of the APIs available on the Gateway instance (default: `Spring Cloud Gateway for K8S`)", + "type": "string" + }, + "description": { + "description": "Detailed description of the APIs available on the Gateway instance (default: `Generated OpenAPI 3 document that describes the API routes configured.`)", + "type": "string" + }, + "documentation": { + "description": "Location of additional documentation for the APIs available on the Gateway instance", + "type": "string" + }, + "version": { + "description": "Version of APIs available on this Gateway instance (default: `unspecified`).", + "type": "string" + }, + "serverUrl": { + "description": "Base URL that API consumers will use to access APIs on the Gateway instance.", + "type": "string" + } + } + }, + "GatewayCorsProperties": { + "description": "Cross-Origin Resource Sharing property", + "type": "object", + "properties": { + "allowedOrigins": { + "description": "Allowed origins to make cross-site requests. The special value `*` allows all domains.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedOriginPatterns": { + "description": "Allowed origin patterns to make cross-site requests.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedMethods": { + "description": "Allowed HTTP methods on cross-site requests. The special value `*` allows all methods. If not set, `GET` and `HEAD` are allowed by default.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedHeaders": { + "description": "Allowed headers in cross-site requests. The special value `*` allows actual requests to send any header.", + "type": "array", + "items": { + "type": "string" + } + }, + "maxAge": { + "format": "int32", + "description": "How long, in seconds, the response from a pre-flight request can be cached by clients.", + "type": "integer" + }, + "allowCredentials": { + "description": "Whether user credentials are supported on cross-site requests. Valid values: `true`, `false`.", + "type": "boolean" + }, + "exposedHeaders": { + "description": "HTTP response headers to expose for cross-site requests.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GatewayResourceRequests": { + "description": "Resource request payload of Spring Cloud Gateway.", + "type": "object", + "properties": { + "cpu": { + "description": "Cpu allocated to each Spring Cloud Gateway instance.", + "type": "string", + "default": "1" + }, + "memory": { + "description": "Memory allocated to each Spring Cloud Gateway instance.", + "type": "string", + "default": "2Gi" + } + } + }, + "GatewayOperatorProperties": { + "description": "Properties of the Spring Cloud Gateway Operator.", + "type": "object", + "readOnly": true, + "properties": { + "resourceRequests": { + "$ref": "#/definitions/GatewayOperatorResourceRequests", + "description": "The requested resource quantity for required CPU and Memory." + }, + "instances": { + "description": "Collection of instances belong to Spring Cloud Gateway operator.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GatewayInstance" + }, + "readOnly": true + } + } + }, + "GatewayOperatorResourceRequests": { + "description": "Properties of the Spring Cloud Gateway Operator.", + "type": "object", + "readOnly": true, + "properties": { + "cpu": { + "description": "Cpu allocated to each Spring Cloud Gateway Operator instance.", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "Memory allocated to each Spring Cloud Gateway Operator instance.", + "type": "string", + "readOnly": true + }, + "instanceCount": { + "format": "int32", + "description": "Instance count of the Spring Cloud Gateway Operator.", + "type": "integer", + "readOnly": true + } + } + }, + "GatewayInstance": { + "description": "Collection of instances belong to the Spring Cloud Gateway", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Name of the Spring Cloud Gateway instance", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the Spring Cloud Gateway instance", + "type": "string", + "readOnly": true + } + } + }, + "GatewayEnvSecrets": { + "description": "Sensitive properties for Spring Cloud Gateway", + "type": "object", + "x-ms-secret": true, + "additionalProperties": { + "type": "string" + } + }, + "GatewayRouteConfigResource": { + "description": "Spring Cloud Gateway route config resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/GatewayRouteConfigProperties" + } + } + }, + "GatewayRouteConfigProperties": { + "description": "API route config of the Spring Cloud Gateway", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the Spring Cloud Gateway route config.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "GatewayProvisioningState", + "modelAsString": true + } + }, + "appResourceId": { + "description": "The resource Id of the Azure Spring Apps app, required unless route defines `uri`.", + "type": "string" + }, + "openApi": { + "$ref": "#/definitions/GatewayRouteConfigOpenApiProperties" + }, + "protocol": { + "description": "Protocol of routed Azure Spring Apps applications.", + "enum": [ + "HTTP", + "HTTPS" + ], + "default": "HTTP", + "type": "string", + "x-ms-enum": { + "name": "GatewayRouteConfigProtocol", + "modelAsString": true + } + }, + "routes": { + "description": "Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GatewayApiRoute" + } + }, + "ssoEnabled": { + "description": "Enable Single Sign-On in app level.", + "type": "boolean" + }, + "predicates": { + "description": "A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "filters": { + "description": "To modify the request before sending it to the target endpoint, or the received response in app level.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GatewayRouteConfigOpenApiProperties": { + "description": "OpenAPI properties of Spring Cloud Gateway route config.", + "type": "object", + "properties": { + "uri": { + "description": "The URI of OpenAPI specification.", + "type": "string" + } + } + }, + "GatewayApiRoute": { + "description": "API route config of the Spring Cloud Gateway", + "type": "object", + "properties": { + "title": { + "description": "A title, will be applied to methods in the generated OpenAPI documentation.", + "type": "string" + }, + "description": { + "description": "A description, will be applied to methods in the generated OpenAPI documentation.", + "type": "string" + }, + "uri": { + "description": "Full uri, will override `appName`.", + "type": "string" + }, + "ssoEnabled": { + "description": "Enable sso validation.", + "type": "boolean" + }, + "tokenRelay": { + "description": "Pass currently-authenticated user's identity token to application service, default is 'false'", + "type": "boolean" + }, + "predicates": { + "description": "A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "filters": { + "description": "To modify the request before sending it to the target endpoint, or the received response.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "order": { + "description": "Route processing order.", + "type": "integer", + "format": "int32" + }, + "tags": { + "description": "Classification tags, will be applied to methods in the generated OpenAPI documentation.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GatewayRouteConfigResourceCollection": { + "description": "Object that includes an array of Spring Cloud Gateway route config resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Spring Cloud Gateway route config resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GatewayRouteConfigResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "GatewayCustomDomainResource": { + "description": "Custom domain of the Spring Cloud Gateway", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/GatewayCustomDomainProperties" + } + } + }, + "GatewayCustomDomainProperties": { + "description": "The properties of custom domain for Spring Cloud Gateway", + "type": "object", + "properties": { + "thumbprint": { + "description": "The thumbprint of bound certificate.", + "type": "string" + } + } + }, + "GatewayCustomDomainResourceCollection": { + "description": "Object that includes an array of Spring Cloud Gateway custom domain resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Spring Cloud Gateway custom domain resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GatewayCustomDomainResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "GatewayResponseCacheProperties": { + "description": "Spring Cloud Gateway response cache properties.", + "required": [ + "responseCacheType" + ], + "type": "object", + "properties": { + "responseCacheType": { + "description": "The type of the response cache.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "responseCacheType" + }, + "GatewayLocalResponseCachePerRouteProperties": { + "description": "Spring Cloud Gateway local response cache per route properties.", + "required": [ + "responseCacheType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GatewayResponseCacheProperties" + } + ], + "properties": { + "size": { + "description": "Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.", + "type": "string" + }, + "timeToLive": { + "description": "Time before a cached entry is expired (300s, 5m, 1h...)", + "type": "string" + } + }, + "x-ms-discriminator-value": "LocalCachePerRoute" + }, + "GatewayLocalResponseCachePerInstanceProperties": { + "description": "Spring Cloud Gateway local response cache per instance properties.", + "required": [ + "responseCacheType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GatewayResponseCacheProperties" + } + ], + "properties": { + "size": { + "description": "Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries", + "type": "string" + }, + "timeToLive": { + "description": "Time before a cached entry is expired (300s, 5m, 1h...)", + "type": "string" + } + }, + "x-ms-discriminator-value": "LocalCachePerInstance" + }, + "ApiPortalResourceCollection": { + "description": "Object that includes an array of API portal resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of API portal resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ApiPortalResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ApiPortalResource": { + "description": "API portal resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ApiPortalProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the API portal resource" + } + } + }, + "ApiPortalProperties": { + "description": "API portal properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the API portal.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ApiPortalProvisioningState", + "modelAsString": true + } + }, + "public": { + "description": "Indicates whether the API portal exposes endpoint.", + "type": "boolean", + "default": false + }, + "url": { + "description": "URL of the API portal, exposed when 'public' is true.", + "type": "string", + "readOnly": true + }, + "httpsOnly": { + "description": "Indicate if only https is allowed.", + "type": "boolean", + "default": false + }, + "gatewayIds": { + "description": "The array of resource Ids of gateway to integrate with API portal.", + "type": "array", + "items": { + "type": "string" + } + }, + "sourceUrls": { + "description": "Collection of OpenAPI source URL locations.", + "type": "array", + "items": { + "type": "string" + } + }, + "ssoProperties": { + "$ref": "#/definitions/SsoProperties" + }, + "resourceRequests": { + "$ref": "#/definitions/ApiPortalResourceRequests", + "description": "The requested resource quantity for required CPU and Memory.", + "readOnly": true + }, + "instances": { + "description": "Collection of instances belong to API portal.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ApiPortalInstance" + }, + "readOnly": true + }, + "apiTryOutEnabledState": { + "description": "Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.", + "type": "string", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ApiPortalApiTryOutEnabledState", + "modelAsString": true + } + } + } + }, + "ApiPortalResourceRequests": { + "description": "Resource requests of the API portal", + "type": "object", + "properties": { + "cpu": { + "description": "Cpu allocated to each API portal instance", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "Memory allocated to each API portal instance", + "type": "string", + "readOnly": true + } + } + }, + "ApiPortalInstance": { + "description": "Collection of instances belong to the API portal", + "type": "object", + "properties": { + "name": { + "description": "Name of the API portal instance", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the API portal instance", + "type": "string", + "readOnly": true + } + } + }, + "ApiPortalCustomDomainResource": { + "description": "Custom domain of the API portal", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ApiPortalCustomDomainProperties" + } + } + }, + "ApiPortalCustomDomainProperties": { + "description": "The properties of custom domain for API portal", + "type": "object", + "properties": { + "thumbprint": { + "description": "The thumbprint of bound certificate.", + "type": "string" + } + } + }, + "ApiPortalCustomDomainResourceCollection": { + "description": "Object that includes an array of API portal custom domain resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of API portal custom domain resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ApiPortalCustomDomainResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ApplicationAcceleratorResourceCollection": { + "description": "Object that includes an array of application accelerator resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of application accelerator resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationAcceleratorResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ApplicationAcceleratorResource": { + "description": "Application accelerator resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationAcceleratorProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the application accelerator resource" + } + } + }, + "ApplicationAcceleratorProperties": { + "description": "Application accelerator properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the application accelerator.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ApplicationAcceleratorProvisioningState", + "modelAsString": true + } + }, + "components": { + "description": "Collection of components belong to application accelerator.", + "uniqueItems": false, + "type": "array", + "x-ms-identifiers": [ + "name" + ], + "items": { + "$ref": "#/definitions/ApplicationAcceleratorComponent" + }, + "readOnly": true + } + } + }, + "ApplicationAcceleratorComponent": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true + }, + "resourceRequests": { + "$ref": "#/definitions/ApplicationAcceleratorResourceRequests" + }, + "instances": { + "type": "array", + "x-ms-identifiers": [ + "name" + ], + "items": { + "$ref": "#/definitions/ApplicationAcceleratorInstance" + }, + "readOnly": true + } + } + }, + "ApplicationAcceleratorResourceRequests": { + "type": "object", + "properties": { + "cpu": { + "description": "Cpu allocated to each application accelerator component. 1 core can be represented by 1 or 1000m", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "Memory allocated to each application accelerator component. 1 GB can be represented by 1Gi or 1024Mi.", + "type": "string", + "readOnly": true + }, + "instanceCount": { + "format": "int32", + "description": "Instance count of the application accelerator component.", + "type": "integer", + "readOnly": true + } + } + }, + "ApplicationAcceleratorInstance": { + "type": "object", + "properties": { + "name": { + "description": "Name of the Application Accelerator instance.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the Application Accelerator instance. It can be Pending, Running, Succeeded, Failed, Unknown.", + "type": "string", + "readOnly": true + } + } + }, + "CustomizedAcceleratorResourceCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomizedAcceleratorResource" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "CustomizedAcceleratorResource": { + "description": "Customized accelerator resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomizedAcceleratorProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the customized accelerator resource" + } + } + }, + "CustomizedAcceleratorProperties": { + "description": "Customized accelerator properties payload", + "required": [ + "gitRepository" + ], + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the customized accelerator.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CustomizedAcceleratorProvisioningState", + "modelAsString": true + } + }, + "acceleratorType": { + "description": "Type of the customized accelerator.", + "enum": [ + "Accelerator", + "Fragment" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomizedAcceleratorType", + "modelAsString": true + } + }, + "displayName": { + "type": "string" + }, + "description": { + "type": "string" + }, + "iconUrl": { + "type": "string" + }, + "acceleratorTags": { + "type": "array", + "items": { + "type": "string" + } + }, + "imports": { + "type": "array", + "readOnly": true, + "description": "Imports references all imports that this accelerator/fragment depends upon.", + "items": { + "type": "string" + } + }, + "gitRepository": { + "$ref": "#/definitions/AcceleratorGitRepository" + } + } + }, + "AcceleratorGitRepository": { + "required": [ + "url", + "authSetting" + ], + "type": "object", + "properties": { + "url": { + "description": "Git repository URL for the accelerator.", + "type": "string" + }, + "intervalInSeconds": { + "description": "Interval for checking for updates to Git or image repository.", + "format": "int32", + "type": "integer" + }, + "branch": { + "description": "Git repository branch to be used.", + "type": "string" + }, + "commit": { + "description": "Git repository commit to be used.", + "type": "string" + }, + "gitTag": { + "description": "Git repository tag to be used.", + "type": "string" + }, + "authSetting": { + "$ref": "#/definitions/AcceleratorAuthSetting", + "description": "Properties of the auth setting payload.", + "x-ms-client-flatten": false + }, + "subPath": { + "description": "Folder path inside the git repository to consider as the root of the accelerator or fragment.", + "type": "string" + } + } + }, + "AcceleratorAuthSetting": { + "description": "Auth setting payload.", + "required": [ + "authType" + ], + "type": "object", + "properties": { + "authType": { + "description": "The type of the auth setting.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "authType" + }, + "AcceleratorPublicSetting": { + "description": "Auth setting for public url.", + "required": [ + "authType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcceleratorAuthSetting" + } + ], + "properties": { + "caCertResourceId": { + "description": "Resource Id of CA certificate for https URL of Git repository.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AppPlatform/Spring/certificates" + } + ] + } + } + }, + "x-ms-discriminator-value": "Public" + }, + "AcceleratorBasicAuthSetting": { + "description": "Auth setting for basic auth.", + "required": [ + "authType", + "username" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcceleratorAuthSetting" + } + ], + "properties": { + "caCertResourceId": { + "description": "Resource Id of CA certificate for https URL of Git repository.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AppPlatform/Spring/certificates" + } + ] + } + }, + "username": { + "description": "Username of git repository basic auth.", + "type": "string" + }, + "password": { + "description": "Password of git repository basic auth.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "x-ms-discriminator-value": "BasicAuth" + }, + "AcceleratorSshSetting": { + "description": "Auth setting for SSH auth.", + "required": [ + "authType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcceleratorAuthSetting" + } + ], + "properties": { + "hostKey": { + "description": "Public SSH Key of git repository.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "hostKeyAlgorithm": { + "description": "SSH Key algorithm of git repository.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "privateKey": { + "description": "Private SSH Key algorithm of git repository.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "x-ms-discriminator-value": "SSH" + }, + "CustomizedAcceleratorValidateResult": { + "description": "Validation result for customized accelerator properties", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "State of the customized accelerator validation result", + "default": "Valid", + "enum": [ + "Valid", + "Invalid" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "CustomizedAcceleratorValidateResultState", + "values": [ + { + "description": "Customized accelerator properties are valid.", + "value": "Valid" + }, + { + "description": "Customized accelerator properties are invalid.", + "value": "Invalid" + } + ] + } + }, + "errorMessage": { + "description": "The detail validation results", + "type": "string" + } + } + }, + "PredefinedAcceleratorResourceCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PredefinedAcceleratorResource" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "PredefinedAcceleratorResource": { + "description": "Predefined accelerator resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PredefinedAcceleratorProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the predefined accelerator resource" + } + } + }, + "PredefinedAcceleratorProperties": { + "description": "Predefined accelerator properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the predefined accelerator.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PredefinedAcceleratorProvisioningState", + "modelAsString": true + } + }, + "displayName": { + "type": "string", + "readOnly": true + }, + "description": { + "type": "string", + "readOnly": true + }, + "iconUrl": { + "type": "string", + "readOnly": true + }, + "acceleratorTags": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "state": { + "type": "string", + "description": "State of the predefined accelerator.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PredefinedAcceleratorState", + "values": [ + { + "description": "Enable the predefined accelerator.", + "value": "Enabled" + }, + { + "description": "Disable the predefined accelerator.", + "value": "Disabled" + } + ] + } + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1 + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServiceNameParameter": { + "name": "serviceName", + "in": "path", + "description": "The name of the Service resource.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9-]*[a-z0-9]$", + "x-ms-parameter-location": "method" + }, + "AppNameParameter": { + "name": "appName", + "in": "path", + "description": "The name of the App resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApmNameParameter": { + "name": "apmName", + "in": "path", + "description": "The name of the APM", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9-]*[a-z0-9]$", + "x-ms-parameter-location": "method" + }, + "DeploymentNameParameter": { + "name": "deploymentName", + "in": "path", + "description": "The name of the Deployment resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ContainerRegistryNameParameter": { + "name": "containerRegistryName", + "in": "path", + "description": "The name of the container registry.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9-]*[a-z0-9]$", + "x-ms-parameter-location": "method" + }, + "BuildServiceNameParameter": { + "name": "buildServiceName", + "in": "path", + "description": "The name of the build service resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BuildServiceBuildpackNameParameter": { + "name": "buildpackName", + "in": "path", + "description": "The name of the buildpack resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BuildServiceStackNameParameter": { + "name": "stackName", + "in": "path", + "description": "The name of the stack resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BuildServiceAgentPoolNameParameter": { + "name": "agentPoolName", + "in": "path", + "description": "The name of the build service agent pool resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BuilderNameParameter": { + "name": "builderName", + "in": "path", + "description": "The name of the builder resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BuildNameParameter": { + "name": "buildName", + "in": "path", + "description": "The name of the build resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BuildResultNameParameter": { + "name": "buildResultName", + "in": "path", + "description": "The name of the build result resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BuildResultLogNameParameter": { + "name": "buildResultLogName", + "in": "path", + "description": "The name of the build result log resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BuildpackBindingNameParameter": { + "name": "buildpackBindingName", + "in": "path", + "description": "The name of the Buildpack Binding Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BindingNameParameter": { + "name": "bindingName", + "in": "path", + "description": "The name of the Binding resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CustomDomainNameParameter": { + "name": "domainName", + "in": "path", + "description": "The name of the custom domain resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CertificateNameParameter": { + "name": "certificateName", + "in": "path", + "description": "The name of the certificate resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "StorageNameParameter": { + "name": "storageName", + "in": "path", + "description": "The name of the storage resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConfigurationServiceNameParameter": { + "name": "configurationServiceName", + "in": "path", + "description": "The name of Application Configuration Service.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + }, + "ServiceRegistryNameParameter": { + "name": "serviceRegistryName", + "in": "path", + "description": "The name of Service Registry.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApplicationLiveViewNameParameter": { + "name": "applicationLiveViewName", + "in": "path", + "description": "The name of Application Live View.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + }, + "DevToolPortalNameParameter": { + "name": "devToolPortalName", + "in": "path", + "description": "The name of Dev Tool Portal.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + }, + "GatewayNameParameter": { + "name": "gatewayName", + "in": "path", + "description": "The name of Spring Cloud Gateway.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + }, + "GatewayRouteConfigNameParameter": { + "name": "routeConfigName", + "in": "path", + "description": "The name of the Spring Cloud Gateway route config.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "GatewayCustomDomainParameter": { + "name": "domainName", + "in": "path", + "description": "The name of the Spring Cloud Gateway custom domain.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiPortalNameParameter": { + "name": "apiPortalName", + "in": "path", + "description": "The name of API portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiPortalCustomDomainParameter": { + "name": "domainName", + "in": "path", + "description": "The name of the API portal custom domain.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApplicationAcceleratorNameParameter": { + "name": "applicationAcceleratorName", + "in": "path", + "description": "The name of the application accelerator.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9-]*[a-z0-9]$", + "x-ms-parameter-location": "method" + }, + "CustomizedAcceleratorNameParameter": { + "name": "customizedAcceleratorName", + "in": "path", + "description": "The name of the customized accelerator.", + "required": true, + "type": "string", + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])$", + "x-ms-parameter-location": "method" + }, + "PredefinedAcceleratorNameParameter": { + "name": "predefinedAcceleratorName", + "in": "path", + "description": "The name of the predefined accelerator.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9-]*[a-z0-9]$", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_CreateOrUpdate.json new file mode 100644 index 000000000000..1dbbd6c577c4 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_CreateOrUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "apiPortalName": "default", + "domainName": "myDomainName", + "apiPortalCustomDomainResource": { + "properties": { + "thumbprint": "*" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "thumbprint": "*" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apiPortals/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default/domains/myDomainName", + "name": "myDomainName" + } + }, + "201": { + "body": { + "properties": { + "thumbprint": "*" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apiPortals/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default/domains/myDomainName", + "name": "myDomainName" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_Delete.json new file mode 100644 index 000000000000..3e7de9c9b7a6 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "domainName": "myDomainName", + "apiPortalName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_Get.json new file mode 100644 index 000000000000..2f23dee653b4 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "apiPortalName": "default", + "domainName": "myDomainName" + }, + "responses": { + "200": { + "body": { + "properties": { + "thumbprint": "*" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apiPortals/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default/domains/myDomainName", + "name": "myDomainName" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_List.json new file mode 100644 index 000000000000..733d120215a7 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortalCustomDomains_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "apiPortalName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "thumbprint": "*" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apiPortals/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default/domains/myDomain", + "name": "myDomain" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_CreateOrUpdate.json new file mode 100644 index 000000000000..b6a809609129 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_CreateOrUpdate.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "apiPortalName": "default", + "apiPortalResource": { + "properties": { + "public": true, + "gatewayIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default" + ], + "apiTryOutEnabledState": "Enabled" + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "public": true, + "url": "test-url", + "gatewayIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default" + ], + "resourceRequests": { + "cpu": "1", + "memory": "1G" + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ], + "apiTryOutEnabledState": "Enabled" + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apiPortals", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "public": true, + "url": "test-url", + "gatewayIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default" + ], + "resourceRequests": { + "cpu": "1", + "memory": "1G" + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apiPortals", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_Delete.json new file mode 100644 index 000000000000..8a2f97ce49d2 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "apiPortalName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_Get.json new file mode 100644 index 000000000000..31a13d40f858 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_Get.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "apiPortalName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "public": true, + "url": "test-url", + "gatewayIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default" + ], + "resourceRequests": { + "cpu": "1", + "memory": "1G" + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ], + "apiTryOutEnabledState": "Enabled" + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apiPortals", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_List.json new file mode 100644 index 000000000000..98b7e38dcefc --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "public": true, + "url": "test-url", + "gatewayIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default" + ], + "resourceRequests": { + "cpu": "1", + "memory": "1G" + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ], + "apiTryOutEnabledState": "Enabled" + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apiPortals", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default", + "name": "default" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_ValidateDomain.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_ValidateDomain.json new file mode 100644 index 000000000000..cbfc3a5797c4 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApiPortals_ValidateDomain.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "apiPortalName": "default", + "validatePayload": { + "name": "mydomain.io" + } + }, + "responses": { + "200": { + "body": { + "isValid": false, + "message": "Certificate is invalid, please check if it is a self signed cert or if it contains a suitable dns name" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_CreateOrUpdate.json new file mode 100644 index 000000000000..e9b8a543549e --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_CreateOrUpdate.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "apmName": "myappinsights", + "apmResource": { + "properties": { + "type": "ApplicationInsights", + "properties": { + "any-string": "any-string", + "sampling-rate": "12.0" + }, + "secrets": { + "connection-string": "XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXX;XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXXXXXXXX" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "type": "ApplicationInsights", + "properties": { + "any-string": "any-string", + "sampling-rate": "12.0" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apms", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights", + "name": "myappinsights" + } + }, + "201": { + "body": { + "properties": { + "type": "ApplicationInsights", + "properties": { + "any-string": "any-string", + "sampling-rate": "12.0" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apms", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights", + "name": "myappinsights" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_Delete.json new file mode 100644 index 000000000000..9c2ba10a87eb --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "apmName": "myappinsights" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_Get.json new file mode 100644 index 000000000000..9a4e5d657ba0 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "apmName": "myappinsights" + }, + "responses": { + "200": { + "body": { + "properties": { + "type": "ApplicationInsights", + "properties": { + "any-string": "any-string", + "sampling-rate": "12.0" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apms", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights", + "name": "myappinsights" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_List.json new file mode 100644 index 000000000000..4fa373da32e7 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "type": "ApplicationInsights", + "properties": { + "any-string": "any-string", + "sampling-rate": "12.0" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apms", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights", + "name": "myappinsights" + }, + { + "properties": { + "type": "AppDynamics", + "properties": { + "abc": "def" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apms", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappdynamic", + "name": "myappdynamic" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_ListSecretKeys.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_ListSecretKeys.json new file mode 100644 index 000000000000..b03b186f38e1 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apms_ListSecretKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "apmName": "myappinsights" + }, + "responses": { + "200": { + "body": { + "value": [ + "connection-string" + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_CreateOrUpdate.json new file mode 100644 index 000000000000..424d2df5530e --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_CreateOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default", + "applicationAcceleratorResource": { + "properties": {}, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "components": [] + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationAccelerators", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "components": [ + { + "name": "component1", + "resourceRequests": { + "cpu": "1", + "memory": "1Gi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + } + ] + } + ] + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationAccelerators", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_Delete.json new file mode 100644 index 000000000000..adccdbc6067c --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_Get.json new file mode 100644 index 000000000000..424f70e4cb8b --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_Get.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "components": [ + { + "name": "component1", + "resourceRequests": { + "cpu": "1", + "memory": "1Gi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + } + ] + } + ] + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationAccelerators", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_List.json new file mode 100644 index 000000000000..271d75fedfcf --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationAccelerators_List.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "components": [ + { + "name": "component1", + "resourceRequests": { + "cpu": "1", + "memory": "1Gi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + } + ] + } + ] + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationAccelerators", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default", + "name": "default" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveView_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveView_Delete.json new file mode 100644 index 000000000000..4334f1697b23 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveView_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationLiveViewName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveViews_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveViews_CreateOrUpdate.json new file mode 100644 index 000000000000..9fa784be039a --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveViews_CreateOrUpdate.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationLiveViewName": "default", + "applicationLiveViewResource": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "components": [ + { + "name": "app-live-view-server", + "resourceRequests": { + "cpu": "1", + "memory": "1Gi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "app-live-view-server-name", + "status": "Running" + } + ] + }, + { + "name": "app-live-view-connector", + "resourceRequests": { + "cpu": "500m", + "memory": "500Mi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "app-live-view-connector-name1", + "status": "Starting" + } + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationLiveViews", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default", + "name": "default" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "components": [ + { + "name": "app-live-view-server", + "resourceRequests": { + "cpu": "1", + "memory": "1Gi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "app-live-view-server-name", + "status": "Running" + } + ] + }, + { + "name": "app-live-view-connector", + "resourceRequests": { + "cpu": "500m", + "memory": "500Mi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "app-live-view-connector-name1", + "status": "Starting" + } + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationLiveViews", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveViews_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveViews_Get.json new file mode 100644 index 000000000000..7586bdbd4dd5 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveViews_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationLiveViewName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "components": [ + { + "name": "app-live-view-server", + "resourceRequests": { + "cpu": "1", + "memory": "1Gi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "app-live-view-server-name", + "status": "Running" + } + ] + }, + { + "name": "app-live-view-connector", + "resourceRequests": { + "cpu": "500m", + "memory": "500Mi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "app-live-view-connector-name1", + "status": "Starting" + } + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationLiveViews", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveViews_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveViews_List.json new file mode 100644 index 000000000000..c69a76a8b0e7 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ApplicationLiveViews_List.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "components": [ + { + "name": "app-live-view-server", + "resourceRequests": { + "cpu": "1", + "memory": "1Gi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "app-live-view-server-name", + "status": "Running" + } + ] + }, + { + "name": "app-live-view-connector", + "resourceRequests": { + "cpu": "500m", + "memory": "500Mi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "app-live-view-connector-name1", + "status": "Starting" + } + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationLiveViews", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default", + "name": "default" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_CreateOrUpdate.json new file mode 100644 index 000000000000..ca99dc55c505 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_CreateOrUpdate.json @@ -0,0 +1,304 @@ +{ + "parameters": { + "appResource": { + "properties": { + "public": true, + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "addonConfigs": { + "ApplicationConfigurationService": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs" + }, + "ServiceRegistry": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry" + } + }, + "persistentDisk": { + "sizeInGB": 2, + "mountPath": "/mypersistentdisk" + }, + "loadedCertificates": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1", + "loadTrustStore": false + }, + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2", + "loadTrustStore": true + } + ], + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "enableSubPath": true, + "mountOptions": [ + "uid=0", + "gid=0", + "dir_mode=0777", + "file_mode=0777" + ], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ], + "workloadProfileName": "dedicated1" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": null, + "tenantId": null, + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": null, + "principalId": null + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": null, + "principalId": null + } + } + }, + "location": "eastus" + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": { + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.azuremicroservices.io", + "provisioningState": "Succeeded", + "fqdn": "myapp.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "addonConfigs": { + "ApplicationConfigurationService": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs" + }, + "ServiceRegistry": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry" + } + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "enableSubPath": true, + "mountOptions": [ + "uid=0", + "gid=0", + "dir_mode=0777", + "file_mode=0777" + ], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ], + "workloadProfileName": "dedicated1" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + }, + "201": { + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.azuremicroservices.io", + "provisioningState": "Creating", + "fqdn": "myapp.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "addonConfigs": { + "ApplicationConfigurationService": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs" + }, + "ServiceRegistry": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry" + } + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "enableSubPath": true, + "mountOptions": [ + "uid=0", + "gid=0", + "dir_mode=0777", + "file_mode=0777" + ], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ], + "workloadProfileName": "dedicated1" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + }, + "202": { + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.azuremicroservices.io", + "provisioningState": "Updating", + "fqdn": "myapp.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "addonConfigs": { + "ApplicationConfigurationService": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs" + }, + "ServiceRegistry": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry" + } + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "enableSubPath": true, + "mountOptions": [ + "uid=0", + "gid=0", + "dir_mode=0777", + "file_mode=0777" + ], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ], + "workloadProfileName": "dedicated1" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_CreateOrUpdate_VNetInjection.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_CreateOrUpdate_VNetInjection.json new file mode 100644 index 000000000000..cf7cb8b48d80 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_CreateOrUpdate_VNetInjection.json @@ -0,0 +1,311 @@ +{ + "parameters": { + "appResource": { + "properties": { + "public": true, + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "vnetAddons": { + "publicEndpoint": true + }, + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "addonConfigs": { + "ApplicationConfigurationService": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs" + }, + "ServiceRegistry": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry" + } + }, + "persistentDisk": { + "sizeInGB": 2, + "mountPath": "/mypersistentdisk" + }, + "loadedCertificates": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1", + "loadTrustStore": false + }, + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2", + "loadTrustStore": true + } + ], + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [ + "uid=0", + "gid=0", + "dir_mode=0777", + "file_mode=0777" + ], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": null, + "tenantId": null, + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": null, + "principalId": null + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": null, + "principalId": null + } + } + }, + "location": "eastus" + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": { + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.private.azuremicroservices.io", + "provisioningState": "Succeeded", + "fqdn": "myapp.private.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "vnetAddons": { + "publicEndpoint": true, + "publicEndpointUrl": "myapp.myservice.azuremicroservices.io" + }, + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "addonConfigs": { + "ApplicationConfigurationService": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs" + }, + "ServiceRegistry": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry" + } + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [ + "uid=0", + "gid=0", + "dir_mode=0777", + "file_mode=0777" + ], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + }, + "201": { + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.private.azuremicroservices.io", + "provisioningState": "Creating", + "fqdn": "myapp.private.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "vnetAddons": { + "publicEndpoint": true, + "publicEndpointUrl": "myapp.myservice.azuremicroservices.io" + }, + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "addonConfigs": { + "ApplicationConfigurationService": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs" + }, + "ServiceRegistry": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry" + } + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [ + "uid=0", + "gid=0", + "dir_mode=0777", + "file_mode=0777" + ], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + }, + "202": { + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.private.azuremicroservices.io", + "provisioningState": "Updating", + "fqdn": "myapp.private.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "vnetAddons": { + "publicEndpoint": true, + "publicEndpointUrl": "myapp.myservice.azuremicroservices.io" + }, + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "addonConfigs": { + "ApplicationConfigurationService": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs" + }, + "ServiceRegistry": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry" + } + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [ + "uid=0", + "gid=0", + "dir_mode=0777", + "file_mode=0777" + ], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Delete.json new file mode 100644 index 000000000000..30f84771502a --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Get.json new file mode 100644 index 000000000000..30bc280e89f5 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Get.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": { + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.azuremicroservices.io", + "provisioningState": "Succeeded", + "fqdn": "myapp.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "loadedCertificates": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1", + "loadTrustStore": false + }, + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2", + "loadTrustStore": true + } + ], + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [ + "uid=0", + "gid=0", + "dir_mode=0777", + "file_mode=0777" + ], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_GetResourceUploadUrl.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_GetResourceUploadUrl.json new file mode 100644 index 000000000000..c1d1f36a07de --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_GetResourceUploadUrl.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": { + "body": { + "relativePath": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20190801-3ed9f4a2-986b-4bbd-b833-a42dccb2f777", + "uploadUrl": "https://springcloudstorageaccount.file.core.windows.net/bd172614181f42e2853f6fd90029cda8/e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20190801-3ed9f4a2-986b-4bbd-b833-a42dccb2f777?sv=2018-03-28&sr=f&sig=SampleSignature&se=2019-08-01T10%3A42%3A21Z&sp=w" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Get_VNetInjection.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Get_VNetInjection.json new file mode 100644 index 000000000000..f87a8c1bc648 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Get_VNetInjection.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": { + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.private.azuremicroservices.io", + "provisioningState": "Succeeded", + "fqdn": "myapp.private.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "vnetAddons": { + "publicEndpoint": true, + "publicEndpointUrl": "myapp.myservice.azuremicroservices.io" + }, + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "loadedCertificates": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1", + "loadTrustStore": false + }, + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2", + "loadTrustStore": true + } + ], + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [ + "uid=0", + "gid=0", + "dir_mode=0777", + "file_mode=0777" + ], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_List.json new file mode 100644 index 000000000000..e6ef2f41d40c --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_List.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "public": true, + "url": "myapp.myservice.azuremicroservices.io", + "provisioningState": "Succeeded", + "fqdn": "myapp.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "loadedCertificates": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1", + "loadTrustStore": false + }, + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2", + "loadTrustStore": true + } + ], + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [ + "uid=0", + "gid=0", + "dir_mode=0777", + "file_mode=0777" + ], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_List_VNetInjection.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_List_VNetInjection.json new file mode 100644 index 000000000000..65c0c7ae76dc --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_List_VNetInjection.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "public": true, + "url": "myapp.myservice.private.azuremicroservices.io", + "provisioningState": "Succeeded", + "fqdn": "myapp.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "vnetAddons": { + "publicEndpoint": true, + "publicEndpointUrl": "myapp.myservice.azuremicroservices.io" + }, + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "loadedCertificates": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1", + "loadTrustStore": false + }, + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2", + "loadTrustStore": true + } + ], + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [ + "uid=0", + "gid=0", + "dir_mode=0777", + "file_mode=0777" + ], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_SetActiveDeployments.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_SetActiveDeployments.json new file mode 100644 index 000000000000..1d2739d5d8f7 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_SetActiveDeployments.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "activeDeploymentCollection": { + "activeDeploymentNames": [ + "default" + ] + } + }, + "responses": { + "200": { + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.azuremicroservices.io", + "provisioningState": "Succeeded", + "fqdn": "myapp.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.azuremicroservices.io", + "provisioningState": "Updating", + "fqdn": "myapp.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Update.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Update.json new file mode 100644 index 000000000000..e32e5341924f --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Update.json @@ -0,0 +1,178 @@ +{ + "parameters": { + "appResource": { + "properties": { + "public": true, + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "persistentDisk": { + "sizeInGB": 2, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": null, + "tenantId": null, + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": null, + "principalId": null + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": null, + "principalId": null + } + } + }, + "location": "eastus" + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": { + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.azuremicroservices.io", + "provisioningState": "Succeeded", + "fqdn": "myapp.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.azuremicroservices.io", + "provisioningState": "Updating", + "fqdn": "myapp.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Update_VNetInjection.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Update_VNetInjection.json new file mode 100644 index 000000000000..96af9d948a37 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_Update_VNetInjection.json @@ -0,0 +1,189 @@ +{ + "parameters": { + "appResource": { + "properties": { + "public": true, + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "vnetAddons": { + "publicEndpoint": true + }, + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "persistentDisk": { + "sizeInGB": 2, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": null, + "tenantId": null, + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": null, + "principalId": null + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": null, + "principalId": null + } + } + }, + "location": "eastus" + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": { + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.private.azuremicroservices.io", + "provisioningState": "Succeeded", + "fqdn": "myapp.private.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "vnetAddons": { + "publicEndpoint": true, + "publicEndpointUrl": "myapp.myservice.azuremicroservices.io" + }, + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": { + "properties": { + "public": true, + "url": "myapp.myservice.private.azuremicroservices.io", + "provisioningState": "Updating", + "fqdn": "myapp.private.mydomain.com", + "httpsOnly": false, + "enableEndToEndTLS": false, + "testEndpointAuthState": "Enabled", + "vnetAddons": { + "publicEndpoint": true, + "publicEndpointUrl": "myapp.myservice.azuremicroservices.io" + }, + "temporaryDisk": { + "sizeInGB": 2, + "mountPath": "/mytemporarydisk" + }, + "persistentDisk": { + "sizeInGB": 2, + "usedInGB": 1, + "mountPath": "/mypersistentdisk" + }, + "customPersistentDisks": [ + { + "customPersistentDiskProperties": { + "type": "AzureFileVolume", + "mountPath": "/mypath1/mypath2", + "mountOptions": [], + "shareName": "myFileShare" + }, + "storageId": "myASCStorageID" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "principalid", + "tenantId": "tenantid", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", + "name": "myapp" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_ValidateDomain.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_ValidateDomain.json new file mode 100644 index 000000000000..27e7bcf0b3ac --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Apps_ValidateDomain.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "validatePayload": { + "name": "mydomain.io" + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": { + "body": { + "isValid": false, + "message": "Certificate is invalid, please check if it is a self signed cert or if it contains a suitable dns name" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_CreateOrUpdate.json new file mode 100644 index 000000000000..39f8d2ac73f3 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_CreateOrUpdate.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "bindingResource": { + "properties": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1", + "key": "xxxx", + "bindingParameters": { + "databaseName": "db1", + "apiType": "SQL" + }, + "generatedProperties": null, + "createdAt": null, + "updatedAt": null + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "bindingName": "mybinding" + }, + "responses": { + "200": { + "body": { + "properties": { + "resourceName": "my-cosmosdb-1", + "resourceType": "Microsoft.DocumentDB", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1", + "bindingParameters": { + "databaseName": "db1", + "apiType": "SQL" + }, + "generatedProperties": "", + "createdAt": "2019-01-01T12:34:56.000Z", + "updatedAt": "2019-01-01T12:34:56.000Z" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/bindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/bindings/mybinding", + "name": "mybinding" + } + }, + "201": { + "body": { + "properties": { + "resourceName": "my-cosmosdb-1", + "resourceType": "Microsoft.DocumentDB", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1", + "bindingParameters": { + "databaseName": "db1", + "apiType": "SQL" + }, + "generatedProperties": "", + "createdAt": "2019-01-01T12:34:56.000Z", + "updatedAt": "2019-01-01T12:34:56.000Z" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/bindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/bindings/mybinding", + "name": "mybinding" + } + }, + "202": { + "body": { + "properties": { + "resourceName": "my-cosmosdb-1", + "resourceType": "Microsoft.DocumentDB", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1", + "bindingParameters": { + "databaseName": "db1", + "apiType": "SQL" + }, + "generatedProperties": "", + "createdAt": "2019-01-01T12:34:56.000Z", + "updatedAt": "2019-01-01T12:34:56.000Z" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/bindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/bindings/mybinding", + "name": "mybinding" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_Delete.json new file mode 100644 index 000000000000..9c92a19736c9 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "bindingName": "mybinding" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_Get.json new file mode 100644 index 000000000000..5ee868f19eff --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "bindingName": "mybinding" + }, + "responses": { + "200": { + "body": { + "properties": { + "resourceName": "my-cosmosdb-1", + "resourceType": "Microsoft.DocumentDB", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1", + "bindingParameters": { + "databaseName": "db1", + "apiType": "SQL" + }, + "generatedProperties": "", + "createdAt": "2019-01-01T12:34:56.000Z", + "updatedAt": "2019-01-01T12:34:56.000Z" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/bindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/bindings/mybinding", + "name": "mybinding" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_List.json new file mode 100644 index 000000000000..9b32f22959c1 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "resourceName": "my-cosmosdb-1", + "resourceType": "Microsoft.DocumentDB", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1", + "bindingParameters": { + "databaseName": "db1", + "apiType": "SQL" + }, + "generatedProperties": "", + "createdAt": "2019-01-01T12:34:56.000Z", + "updatedAt": "2019-01-01T12:34:56.000Z" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/bindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/bindings/mybinding", + "name": "mybinding" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_Update.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_Update.json new file mode 100644 index 000000000000..70c4d89c8cb7 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Bindings_Update.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "bindingResource": { + "properties": { + "key": "xxxx", + "bindingParameters": { + "databaseName": "db1", + "apiType": "SQL" + }, + "generatedProperties": null, + "createdAt": null, + "updatedAt": null + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "bindingName": "mybinding" + }, + "responses": { + "200": { + "body": { + "properties": { + "resourceName": "my-cosmosdb-1", + "resourceType": "Microsoft.DocumentDB", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1", + "bindingParameters": { + "databaseName": "db1", + "apiType": "SQL" + }, + "generatedProperties": "", + "createdAt": "2019-01-01T12:34:56.000Z", + "updatedAt": "2019-01-01T12:34:56.000Z" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/bindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/bindings/mybinding", + "name": "mybinding" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": { + "properties": { + "resourceName": "my-cosmosdb-1", + "resourceType": "Microsoft.DocumentDB", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1", + "bindingParameters": { + "databaseName": "db1", + "apiType": "SQL" + }, + "generatedProperties": "", + "createdAt": "2019-01-01T12:34:56.000Z", + "updatedAt": "2019-01-01T12:34:56.000Z" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/bindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/bindings/mybinding", + "name": "mybinding" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceAgentPool_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceAgentPool_Get.json new file mode 100644 index 000000000000..dcc25b62f535 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceAgentPool_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "agentPoolName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "poolSize": { + "name": "S3", + "cpu": "4", + "memory": "8Gi" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/agentPools", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceAgentPool_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceAgentPool_List.json new file mode 100644 index 000000000000..87260f4cc36e --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceAgentPool_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "poolSize": { + "name": "S3", + "cpu": "4", + "memory": "8Gi" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/agentPools", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default", + "name": "default" + } + ], + "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools?$page=2" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceAgentPool_UpdatePut.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceAgentPool_UpdatePut.json new file mode 100644 index 000000000000..69c1f92d5140 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceAgentPool_UpdatePut.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "agentPoolName": "default", + "agentPoolResource": { + "properties": { + "poolSize": { + "name": "S3" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "poolSize": { + "name": "S3", + "cpu": "4", + "memory": "8Gi" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/agentPools", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default", + "name": "default" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Created", + "poolSize": { + "name": "S3", + "cpu": "4", + "memory": "8Gi" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/agentPools", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_CreateOrUpdate.json new file mode 100644 index 000000000000..64209a28e235 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_CreateOrUpdate.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "builderName": "mybuilder", + "builderResource": { + "properties": { + "stack": { + "id": "io.buildpacks.stacks.bionic", + "version": "base" + }, + "buildpackGroups": [ + { + "name": "mix", + "buildpacks": [ + { + "id": "tanzu-buildpacks/java-azure" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "stack": { + "id": "io.buildpacks.stacks.bionic", + "version": "base" + }, + "buildpackGroups": [ + { + "name": "mix", + "buildpacks": [ + { + "id": "tanzu-buildpacks/java-azure", + "version": "10.0.0" + }, + { + "id": "tanzu-buildpacks/dotnet-core", + "version": "2.9.0" + } + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/mybuilder", + "name": "mybuilder" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "stack": { + "id": "io.buildpacks.stacks.bionic", + "version": "base" + }, + "buildpackGroups": [ + { + "name": "mix", + "buildpacks": [ + { + "id": "tanzu-buildpacks/java-azure", + "version": "10.0.0" + }, + { + "id": "tanzu-buildpacks/dotnet-core", + "version": "2.9.0" + } + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/mybuilder", + "name": "mybuilder" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_Delete.json new file mode 100644 index 000000000000..163980f7c770 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "builderName": "mybuilder" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_Get.json new file mode 100644 index 000000000000..1115215e5526 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "builderName": "mybuilder" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "stack": { + "id": "io.buildpacks.stacks.bionic", + "version": "base" + }, + "buildpackGroups": [ + { + "name": "mix", + "buildpacks": [ + { + "id": "tanzu-buildpacks/java-azure", + "version": "10.0.0" + } + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/mybuilder", + "name": "mybuilder" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_List.json new file mode 100644 index 000000000000..9cb1a2321444 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_List.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "stack": { + "id": "io.buildpacks.stacks.bionic", + "version": "base" + }, + "buildpackGroups": [ + { + "name": "mix", + "buildpacks": [ + { + "id": "tanzu-buildpacks/java-azure", + "version": "10.0.0" + } + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/mybuilder", + "name": "mybuilder" + } + ], + "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders?$page=2" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_ListDeployments.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_ListDeployments.json new file mode 100644 index 000000000000..df17300b6b23 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildServiceBuilder_ListDeployments.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "builderName": "default" + }, + "responses": { + "200": { + "body": { + "deployments": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/test/deployments/default", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/test/deployments/green" + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_CreateOrUpdate.json new file mode 100644 index 000000000000..e25c42cdcf5b --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_CreateOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "buildService": { + "properties": { + "containerRegistry": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/containerRegistrys/default" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "kPackVersion": "0.7.2", + "containerRegistry": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/containerRegistrys/default", + "provisioningState": "Succeeded", + "resourceRequests": { + "cpu": "2000m", + "memory": "4Gi" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default", + "name": "default" + } + }, + "201": { + "body": { + "properties": { + "kPackVersion": "0.7.2", + "containerRegistry": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/containerRegistrys/default", + "provisioningState": "Creating", + "resourceRequests": { + "cpu": null, + "memory": null + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_CreateOrUpdateBuild.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_CreateOrUpdateBuild.json new file mode 100644 index 000000000000..24480c14e0a2 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_CreateOrUpdateBuild.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "buildName": "mybuild", + "build": { + "properties": { + "builder": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default", + "agentPool": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default", + "relativePath": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777", + "env": { + "environmentVariable": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "certificates": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1" + }, + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2" + } + ], + "resourceRequests": { + "cpu": "1", + "memory": "2Gi" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "builder": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default", + "agentPool": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default", + "provisioningState": "Succeeded", + "relativePath": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777", + "env": { + "environmentVariable": "test" + }, + "resourceRequests": { + "cpu": "1", + "memory": "2Gi" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builds", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/mybuild", + "name": "mybuild" + } + }, + "201": { + "body": { + "properties": { + "builder": "default-builder", + "relativePath": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777", + "env": { + "environmentVariable": "test" + }, + "triggeredBuildResult": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/mybuild/results/123", + "provisioningState": "Queuing", + "image": "acr123.azurec.io/result-123", + "lastTransitionTime": "2021-08-11T03:17:03.944Z", + "lastTransitionReason": "CONFIG", + "lastTransitionStatus": "False" + }, + "resourceRequests": { + "cpu": "1", + "memory": "2Gi" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builds", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/mybuild", + "name": "mybuild" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_DeleteBuild.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_DeleteBuild.json new file mode 100644 index 000000000000..9a61d46a8d79 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_DeleteBuild.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "buildName": "mybuild" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuild.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuild.json new file mode 100644 index 000000000000..6e8d0a26f047 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuild.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "buildName": "mybuild" + }, + "responses": { + "200": { + "body": { + "properties": { + "builder": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default", + "agentPool": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default", + "provisioningState": "Succeeded", + "relativePath": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777", + "env": { + "environmentVariable": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "certificates": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1" + }, + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2" + } + ], + "resourceRequests": { + "cpu": "1", + "memory": "2Gi" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builds", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/mybuild", + "name": "mybuild" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuildResult.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuildResult.json new file mode 100644 index 000000000000..906d13b495bd --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuildResult.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "buildName": "mybuild", + "buildResultName": "123" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "123", + "provisioningState": "Failed", + "error": { + "code": "51", + "message": "Build failed in stage build with reason OOMKilled, please refer to https://aka.ms/buildexitcode" + }, + "buildPodName": "mybuild-default-1", + "buildStages": [ + { + "name": "prepare", + "status": "Succeeded", + "exitCode": "0", + "reason": "Completed" + }, + { + "name": "detect", + "status": "Succeeded", + "exitCode": "0", + "reason": "Completed" + }, + { + "name": "analyze", + "status": "Succeeded", + "exitCode": "0", + "reason": "Completed" + }, + { + "name": "restore", + "status": "Succeeded", + "exitCode": "0", + "reason": "Completed" + }, + { + "name": "build", + "status": "Failed", + "exitCode": "51", + "reason": "Error" + }, + { + "name": "export", + "status": "NotStarted", + "exitCode": "-1" + } + ], + "image": "myacr.azurecr.io/build-result-image:latest" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builds/results", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/mybuild/results/123", + "name": "123" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuildResultLog.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuildResultLog.json new file mode 100644 index 000000000000..e088a50ca5af --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuildResultLog.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "buildName": "mybuild", + "buildResultName": "123" + }, + "responses": { + "200": { + "body": { + "blobUrl": "https://sample-storage-account-name.blob.core.windows.net/sample-log-blob-file?readonly-sas-token" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuildService.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuildService.json new file mode 100644 index 000000000000..c28526f590b0 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetBuildService.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "kPackVersion": "0.3.1", + "provisioningState": "Succeeded", + "resourceRequests": { + "cpu": "200m", + "memory": "4Gi" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetResourceUploadUrl.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetResourceUploadUrl.json new file mode 100644 index 000000000000..9b19eb4f8872 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetResourceUploadUrl.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default" + }, + "responses": { + "200": { + "body": { + "relativePath": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777", + "uploadUrl": "https://springcloudstorageaccount.file.core.windows.net/bd172614181f42e2853f6fd90029cda8/e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777?sv=2021-06-01&sr=f&sig=SampleSignature&se=2021-06-01T10%3A42%3A21Z&sp=w" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetSupportedBuildpack.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetSupportedBuildpack.json new file mode 100644 index 000000000000..e6d21e868ad1 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetSupportedBuildpack.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "buildpackName": "tanzu-buildpacks-java-azure" + }, + "responses": { + "200": { + "body": { + "properties": { + "buildpackId": "tanzu-buildpacks/java-azure", + "version": "10.0.0" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/supportedBuildpacks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/supportedBuildpacks/tanzu-buildpacks-java-azure", + "name": "tanzu-buildpacks-java-azure" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetSupportedStack.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetSupportedStack.json new file mode 100644 index 000000000000..901e57341362 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_GetSupportedStack.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "stackName": "io.buildpacks.stacks.bionic-base" + }, + "responses": { + "200": { + "body": { + "properties": { + "stackId": "io.buildpacks.stacks.bionic", + "version": "base" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/supportedStacks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/supportedBuildpacks/io.buildpacks.stacks.bionic-base", + "name": "io.buildpacks.stacks.bionic-base" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListBuildResults.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListBuildResults.json new file mode 100644 index 000000000000..25fe13c84c84 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListBuildResults.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "buildName": "mybuild" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "name": "123", + "provisioningState": "Failed", + "error": { + "code": "51", + "message": "Build failed in stage build with reason OOMKilled, please refer to https://aka.ms/buildexitcode" + }, + "buildPodName": "mybuild-default-1", + "buildStages": [ + { + "name": "prepare", + "status": "Succeeded", + "exitCode": "0", + "reason": "Completed" + }, + { + "name": "detect", + "status": "Succeeded", + "exitCode": "0", + "reason": "Completed" + }, + { + "name": "analyze", + "status": "Succeeded", + "exitCode": "0", + "reason": "Completed" + }, + { + "name": "restore", + "status": "Succeeded", + "exitCode": "0", + "reason": "Completed" + }, + { + "name": "build", + "status": "Failed", + "exitCode": "51", + "reason": "Error" + }, + { + "name": "export", + "status": "NotStarted", + "exitCode": "-1" + } + ], + "image": "myacr.azurecr.io/build-result-image:latest" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builds/results", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/mybuild/results/123", + "name": "123" + } + ], + "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/mybuild/results?$page=2" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListBuildServices.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListBuildServices.json new file mode 100644 index 000000000000..ced7362173fc --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListBuildServices.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "kPackVersion": "0.3.1", + "provisioningState": "Succeeded", + "resourceRequests": { + "cpu": "200m", + "memory": "4Gi" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default", + "name": "default" + } + ], + "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices?$page=2" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListBuilds.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListBuilds.json new file mode 100644 index 000000000000..3cc48386a3fc --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListBuilds.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "builder": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default", + "agentPool": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default", + "provisioningState": "Succeeded", + "relativePath": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777", + "env": { + "environmentVariable": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "certificates": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1" + }, + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2" + } + ], + "resourceRequests": { + "cpu": "1", + "memory": "2Gi" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builds", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/myBuild", + "name": "myBuild" + } + ], + "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds?$page=2" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListSupportedBuildpacks.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListSupportedBuildpacks.json new file mode 100644 index 000000000000..2e359c31e11f --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListSupportedBuildpacks.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "buildpackId": "tanzu-buildpacks/java-azure" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/supportedBuildpacks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/supportedBuildpacks/tanzu-buildpacks-java-azure", + "name": "tanzu-buildpacks-java-azure" + } + ], + "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/supportedBuildpacks?$page=2" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListSupportedStacks.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListSupportedStacks.json new file mode 100644 index 000000000000..ee4119035884 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildService_ListSupportedStacks.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "stackId": "io.buildpacks.stacks.bionic", + "version": "base" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/supportedStacks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/supportedStacks/io.buildpacks.stacks.bionic-base", + "name": "io.buildpacks.stacks.bionic-base" + } + ], + "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/supportedStacks?$page=2" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_CreateOrUpdate.json new file mode 100644 index 000000000000..646640c52f26 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_CreateOrUpdate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "builderName": "default", + "buildpackBindingName": "myBuildpackBinding", + "buildpackBinding": { + "properties": { + "bindingType": "ApplicationInsights", + "launchProperties": { + "properties": { + "abc": "def", + "any-string": "any-string", + "sampling-rate": "12.0" + }, + "secrets": { + "connection-string": "XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXX;XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXXXXXXXX" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "bindingType": "ApplicationInsights", + "launchProperties": { + "properties": { + "abc": "def", + "any-string": "any-string", + "sampling-rate": "12.0" + }, + "secrets": { + "connection-string": "*" + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/myBuildpackBinding", + "name": "myBuildpackBinding" + } + }, + "201": { + "body": { + "properties": { + "bindingType": "ApplicationInsights", + "launchProperties": { + "properties": { + "abc": "def", + "any-string": "any-string", + "sampling-rate": "12.0" + }, + "secrets": { + "connection-string": "*" + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/myBuildpackBinding", + "name": "myBuildpackBinding" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_Delete.json new file mode 100644 index 000000000000..972f9413d6aa --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_Delete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "builderName": "default", + "buildpackBindingName": "myBuildpackBinding" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_Get.json new file mode 100644 index 000000000000..59ea0e8414ea --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "builderName": "default", + "buildpackBindingName": "myBuildpackBinding" + }, + "responses": { + "200": { + "body": { + "properties": { + "bindingType": "ApplicationInsights", + "launchProperties": { + "properties": { + "abc": "def", + "any-string": "any-string", + "sampling-rate": "12.0" + }, + "secrets": { + "connection-string": "*" + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/myBuildpackBinding", + "name": "myBuildpackBinding" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_List.json new file mode 100644 index 000000000000..a27c28f1b147 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "buildServiceName": "default", + "builderName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "bindingType": "ApplicationInsights", + "launchProperties": { + "properties": { + "abc": "def", + "any-string": "any-string", + "sampling-rate": "12.0" + }, + "secrets": { + "connection-string": "*" + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/myBuildpackBinding", + "name": "myBuildpackBinding" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_ListForCluster.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_ListForCluster.json new file mode 100644 index 000000000000..827c67060c01 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/BuildpackBinding_ListForCluster.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "bindingType": "ApplicationInsights", + "launchProperties": { + "properties": { + "abc": "def", + "any-string": "any-string", + "sampling-rate": "12.0" + }, + "secrets": { + "connection-string": "*" + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/myBuildpackBinding", + "name": "myBuildpackBinding" + }, + { + "properties": { + "bindingType": "AppDynamics", + "launchProperties": { + "properties": { + "abc": "def" + }, + "secrets": {} + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/appdynamic", + "name": "appdynamic" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_CreateOrUpdate.json new file mode 100644 index 000000000000..1bc40d557863 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_CreateOrUpdate.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "certificateResource": { + "properties": { + "type": "KeyVaultCertificate", + "vaultUri": "https://myvault.vault.azure.net", + "keyVaultCertName": "mycert", + "certVersion": "08a219d06d874795a96db47e06fbb01e", + "autoSync": "Enabled" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "certificateName": "mycertificate" + }, + "responses": { + "200": { + "body": { + "properties": { + "type": "KeyVaultCertificate", + "excludePrivateKey": false, + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "vaultUri": "https://myvault.vault.azure.net", + "keyVaultCertName": "mycert", + "certVersion": "08a219d06d874795a96db47e06fbb01e", + "issuer": "mydomain.com", + "issuedDate": "2019-02-20T07:40:42Z", + "expirationDate": "2019-02-21T07:40:42Z", + "activateDate": "2019-02-22T07:40:42Z", + "subjectName": "mysubjectname", + "dnsNames": [ + "mydomain.com", + "mydomain.net", + "mydomain.io" + ], + "autoSync": "Enabled" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate", + "name": "mycertificate" + } + }, + "201": { + "body": { + "properties": { + "type": "KeyVaultCertificate", + "excludePrivateKey": false, + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "vaultUri": "https://myvault.vault.azure.net", + "keyVaultCertName": "mycert", + "certVersion": "08a219d06d874795a96db47e06fbb01e", + "issuer": "mydomain.com", + "issuedDate": "2019-02-20T07:40:42Z", + "expirationDate": "2019-02-21T07:40:42Z", + "activateDate": "2019-02-22T07:40:42Z", + "subjectName": "mysubjectname", + "dnsNames": [ + "mydomain.com", + "mydomain.net", + "mydomain.io" + ], + "autoSync": "Enabled" + }, + "type": "Microsoft.AppPlatform/Spring/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate", + "name": "mycertificate" + } + }, + "202": { + "body": { + "properties": { + "type": "KeyVaultCertificate", + "excludePrivateKey": false, + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "vaultUri": "https://myvault.vault.azure.net", + "keyVaultCertName": "mycert", + "certVersion": "08a219d06d874795a96db47e06fbb01e", + "issuer": "mydomain.com", + "issuedDate": "2019-02-20T07:40:42Z", + "expirationDate": "2019-02-21T07:40:42Z", + "activateDate": "2019-02-22T07:40:42Z", + "subjectName": "mysubjectname", + "dnsNames": [ + "mydomain.com", + "mydomain.net", + "mydomain.io" + ], + "autoSync": "Enabled" + }, + "type": "Microsoft.AppPlatform/Spring/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate", + "name": "mycertificate" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_Delete.json new file mode 100644 index 000000000000..e3d806a2fcb3 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "certificateName": "mycertificate" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_Get.json new file mode 100644 index 000000000000..e3290cf8fc3b --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "certificateName": "mycertificate" + }, + "responses": { + "200": { + "body": { + "properties": { + "type": "KeyVaultCertificate", + "excludePrivateKey": false, + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "vaultUri": "https://myvault.vault.azure.net", + "keyVaultCertName": "mycert", + "certVersion": "08a219d06d874795a96db47e06fbb01e", + "issuer": "mydomain.com", + "issuedDate": "2019-02-20T07:40:42Z", + "expirationDate": "2019-02-21T07:40:42Z", + "activateDate": "2019-02-22T07:40:42Z", + "subjectName": "mysubjectname", + "dnsNames": [ + "mydomain.com", + "mydomain.net", + "mydomain.io" + ], + "autoSync": "Disabled", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate", + "name": "mycertificate" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_List.json new file mode 100644 index 000000000000..5fad8602a03d --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Certificates_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "type": "KeyVaultCertificate", + "excludePrivateKey": false, + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "vaultUri": "https://myvault.vault.azure.net", + "keyVaultCertName": "mycert", + "certVersion": "08a219d06d874795a96db47e06fbb01e", + "issuer": "mydomain.com", + "issuedDate": "2019-02-20T07:40:42Z", + "expirationDate": "2019-02-21T07:40:42Z", + "activateDate": "2019-02-22T07:40:42Z", + "subjectName": "mysubjectname", + "dnsNames": [ + "mydomain.com", + "mydomain.net", + "mydomain.io" + ], + "autoSync": "Disabled", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate", + "name": "mycertificate" + } + ], + "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates?$page=2" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_Get.json new file mode 100644 index 000000000000..fca1ae7e1aa5 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_Get_Consumption.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_Get_Consumption.json new file mode 100644 index 000000000000..d18013dd7060 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_Get_Consumption.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "enabledState": "Enabled", + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePatch.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePatch.json new file mode 100644 index 000000000000..3aa4a15f00d7 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePatch.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "configServerResource": { + "properties": { + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + } + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": { + "properties": { + "provisioningState": "Updating", + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePatch_Consumption.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePatch_Consumption.json new file mode 100644 index 000000000000..ef8a2c92c3cd --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePatch_Consumption.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "configServerResource": { + "properties": { + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + }, + "enabledState": "Enabled" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": { + "properties": { + "provisioningState": "Updating", + "enabledState": "Enabled", + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "enabledState": "Enabled", + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePut.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePut.json new file mode 100644 index 000000000000..1465e700e724 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePut.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "configServerResource": { + "properties": { + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + } + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "202": { + "body": { + "properties": { + "provisioningState": "Updating", + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePut_Consumption.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePut_Consumption.json new file mode 100644 index 000000000000..f5d2fee5d40e --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_UpdatePut_Consumption.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "configServerResource": { + "properties": { + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + }, + "enabledState": "Enabled" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "202": { + "body": { + "properties": { + "provisioningState": "Updating", + "enabledState": "Enabled", + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "enabledState": "Enabled", + "configServer": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_Validate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_Validate.json new file mode 100644 index 000000000000..5f2673b0b492 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigServers_Validate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "configServerSettings": { + "gitProperty": { + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master", + "searchPaths": [ + "/" + ] + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "isValid": true + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": {} + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_CreateOrUpdate.json new file mode 100644 index 000000000000..cd7119265aaa --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_CreateOrUpdate.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "configurationServiceName": "default", + "configurationServiceResource": { + "properties": { + "settings": { + "gitProperty": { + "repositories": [ + { + "name": "fake", + "uri": "https://github.com/fake-user/fake-repository", + "patterns": [ + "app/dev" + ], + "label": "master" + } + ] + }, + "refreshIntervalInSeconds": 60 + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "settings": { + "gitProperty": { + "repositories": [ + { + "name": "fake", + "uri": "https://github.com/fake-user/fake-repository", + "patterns": [ + "app/dev" + ], + "label": "master" + } + ] + }, + "refreshIntervalInSeconds": 60 + }, + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configurationServices", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "settings": { + "gitProperty": { + "repositories": [ + { + "name": "fake", + "uri": "https://github.com/fake-user/fake-repository", + "patterns": [ + "app/dev" + ], + "label": "master" + } + ] + }, + "refreshIntervalInSeconds": 60 + }, + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configurationServices", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_Delete.json new file mode 100644 index 000000000000..6d81e901e4e8 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "configurationServiceName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_Get.json new file mode 100644 index 000000000000..244a04ca4eb9 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_Get.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "configurationServiceName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "settings": { + "gitProperty": { + "repositories": [ + { + "name": "fake", + "patterns": [ + "app1", + "app2/dev" + ], + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master" + } + ] + }, + "refreshIntervalInSeconds": 60 + }, + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configurationServices", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_List.json new file mode 100644 index 000000000000..2b106e5dfab0 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_List.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "settings": { + "gitProperty": { + "repositories": [ + { + "name": "fake", + "patterns": [ + "app1", + "app2/dev" + ], + "uri": "https://github.com/fake-user/fake-repository.git", + "label": "master" + } + ] + }, + "refreshIntervalInSeconds": 60 + }, + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/configurationServices", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/default", + "name": "default" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_Validate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_Validate.json new file mode 100644 index 000000000000..060e30bbcf6a --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_Validate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "configurationServiceName": "default", + "settings": { + "gitProperty": { + "repositories": [ + { + "name": "fake", + "uri": "https://github.com/fake-user/fake-repository", + "patterns": [ + "app/dev" + ], + "label": "master" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "gitPropertyValidationResult": { + "isValid": true + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": { + "gitPropertyValidationResult": { + "isValid": true + } + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_ValidateResource.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_ValidateResource.json new file mode 100644 index 000000000000..80793b70a261 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ConfigurationServices_ValidateResource.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "configurationServiceName": "default", + "configurationServiceResource": { + "properties": { + "settings": { + "gitProperty": { + "repositories": [ + { + "name": "fake", + "uri": "https://github.com/fake-user/fake-repository", + "patterns": [ + "app/dev" + ], + "label": "master" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "gitPropertyValidationResult": { + "isValid": true + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_CreateOrUpdate.json new file mode 100644 index 000000000000..34e8e62652d0 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_CreateOrUpdate.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "containerRegistryResource": { + "properties": { + "credentials": { + "type": "BasicAuth", + "server": "myServer", + "username": "myUsername", + "password": "myPassword" + } + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "my-service", + "containerRegistryName": "my-container-registry" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "credentials": { + "type": "BasicAuth", + "server": "myServer", + "username": "myUsername" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/containerRegistries", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/my-service/containerRegistries/my-container-registry", + "name": "my-container-registry" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "credentials": { + "type": "BasicAuth", + "server": "myServer", + "username": "myUsername" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/containerRegistries", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/my-service/containerRegistries/my-container-registry", + "name": "my-container-registry" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_Delete.json new file mode 100644 index 000000000000..2c65d7e260eb --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "service-name", + "containerRegistryName": "my-container-registry" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_Get.json new file mode 100644 index 000000000000..767eb1fea74a --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "service-name", + "containerRegistryName": "my-container-registry" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "credentials": { + "type": "BasicAuth", + "server": "myServer", + "username": "myUsername" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/containerRegistries", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/service-name/containerRegistries/my-container-registry", + "name": "my-container-registry" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_List.json new file mode 100644 index 000000000000..02267ed26ae6 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "my-service" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "credentials": { + "type": "BasicAuth", + "server": "myServer", + "username": "myUsername" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/containerRegistries", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/my-service/containerRegistries/my-container-registry", + "name": "my-container-registry" + } + ], + "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/my-service/containerRegistries?$page=2" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_Validate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_Validate.json new file mode 100644 index 000000000000..3421a82432b1 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ContainerRegistries_Validate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "ContainerRegistryProperties": { + "credentials": { + "type": "BasicAuth", + "server": "myServer", + "username": "myUsername", + "password": "myPassword" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "my-service", + "containerRegistryName": "my-container-registry" + }, + "responses": { + "200": { + "body": { + "isValid": false, + "message": "Validate container registry failed. please check the properties first." + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_CreateOrUpdate.json new file mode 100644 index 000000000000..eccd9e57fb27 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_CreateOrUpdate.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "domainResource": { + "properties": { + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "certName": "mycert" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "domainName": "mydomain.com" + }, + "responses": { + "200": { + "body": { + "properties": { + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "appName": "myapp", + "certName": "mycert" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com", + "name": "mydomain.com" + } + }, + "201": { + "body": { + "properties": { + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "appName": "myapp", + "certName": "mycert" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com", + "name": "mydomain.com" + } + }, + "202": { + "body": { + "properties": { + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "appName": "myapp", + "certName": "mycert" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com", + "name": "mydomain.com" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_Delete.json new file mode 100644 index 000000000000..19c6ce23fe01 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "domainName": "mydomain.com" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_Get.json new file mode 100644 index 000000000000..1311082ce9df --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "domainName": "mydomain.com" + }, + "responses": { + "200": { + "body": { + "properties": { + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "appName": "myapp", + "certName": "mycert", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com", + "name": "mydomain.com" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_List.json new file mode 100644 index 000000000000..fa723c2d21f9 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "appName": "myapp", + "certName": "mycert", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com", + "name": "mydomain.com" + } + ], + "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains?$page=2" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_Update.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_Update.json new file mode 100644 index 000000000000..39117a7d7ec7 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomDomains_Update.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "domainResource": { + "properties": { + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "certName": "mycert" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "domainName": "mydomain.com" + }, + "responses": { + "200": { + "body": { + "properties": { + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "appName": "myapp", + "certName": "mycert" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com", + "name": "mydomain.com" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": { + "properties": { + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", + "appName": "myapp", + "certName": "mycert" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com", + "name": "mydomain.com" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_CreateOrUpdate.json new file mode 100644 index 000000000000..957e3df6c1ea --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_CreateOrUpdate.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default", + "customizedAcceleratorName": "acc-name", + "customizedAcceleratorResource": { + "properties": { + "displayName": "acc-name", + "description": "acc-desc", + "iconUrl": "acc-icon", + "acceleratorTags": [ + "tag-a", + "tag-b" + ], + "gitRepository": { + "url": "git-url", + "intervalInSeconds": 70, + "branch": "git-branch", + "commit": "12345", + "gitTag": "git-tag", + "authSetting": { + "authType": "SSH", + "privateKey": "git-auth-privatekey", + "hostKey": "git-auth-hostkey", + "hostKeyAlgorithm": "git-auth-algorithm" + } + } + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "displayName": "acc-name", + "description": "acc-desc", + "iconUrl": "acc-icon", + "acceleratorTags": [ + "tag-a", + "tag-b" + ], + "gitRepository": { + "url": "git-url", + "intervalInSeconds": 70, + "branch": "git-branch", + "commit": "12345", + "gitTag": "git-tag", + "authSetting": { + "authType": "SSH" + } + } + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default/customizedAccelerators/acc-name", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "displayName": "acc-name", + "description": "acc-desc", + "iconUrl": "acc-icon", + "acceleratorTags": [ + "tag-a", + "tag-b" + ], + "gitRepository": { + "url": "git-url", + "intervalInSeconds": 70, + "branch": "git-branch", + "commit": "12345", + "gitTag": "git-tag", + "authSetting": { + "authType": "SSH" + } + } + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default/customizedAccelerators/acc-name", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_Delete.json new file mode 100644 index 000000000000..1d64aea26001 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default", + "customizedAcceleratorName": "acc-name" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_Get.json new file mode 100644 index 000000000000..02b7015cd31b --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default", + "customizedAcceleratorName": "acc-name" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "displayName": "acc-name", + "description": "acc-desc", + "iconUrl": "acc-icon", + "acceleratorTags": [ + "tag-a", + "tag-b" + ], + "gitRepository": { + "url": "git-url", + "intervalInSeconds": 70, + "branch": "git-branch", + "commit": "12345", + "gitTag": "git-tag", + "authSetting": { + "authType": "SSH" + } + } + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default/customizedAccelerators/acc-name", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_List.json new file mode 100644 index 000000000000..ac5fe2e32acf --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_List.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "displayName": "acc-name", + "description": "acc-desc", + "iconUrl": "acc-icon", + "acceleratorTags": [ + "tag-a", + "tag-b" + ], + "gitRepository": { + "url": "git-url", + "intervalInSeconds": 70, + "branch": "git-branch", + "commit": "12345", + "gitTag": "git-tag", + "authSetting": { + "authType": "SSH" + } + } + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default/customizedAccelerators", + "name": "default" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_Validate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_Validate.json new file mode 100644 index 000000000000..a9a0fb42d6b8 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/CustomizedAccelerators_Validate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default", + "customizedAcceleratorName": "acc-name", + "properties": { + "displayName": "acc-name", + "description": "acc-desc", + "iconUrl": "acc-icon", + "acceleratorTags": [ + "tag-a", + "tag-b" + ], + "gitRepository": { + "url": "git-url", + "intervalInSeconds": 70, + "branch": "git-branch", + "commit": "12345", + "gitTag": "git-tag", + "authSetting": { + "authType": "SSH", + "privateKey": "git-auth-privatekey", + "hostKey": "git-auth-hostkey", + "hostKeyAlgorithm": "git-auth-algorithm" + } + } + } + }, + "responses": { + "200": { + "body": { + "state": "Valid", + "errorMessage": "" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_CreateOrUpdate.json new file mode 100644 index 000000000000..0d5d8c93924a --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_CreateOrUpdate.json @@ -0,0 +1,304 @@ +{ + "parameters": { + "deploymentResource": { + "properties": { + "source": { + "type": "Source", + "relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc", + "version": "1.0", + "artifactSelector": "sub-module-1" + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "addonConfigs": { + "ApplicationConfigurationService": { + "patterns": [ + "mypattern" + ] + } + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "terminationGracePeriodSeconds": 30, + "livenessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "readinessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "startupProbe": null + }, + "instances": null + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "201": { + "body": { + "properties": { + "source": { + "type": "Source", + "relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc", + "version": "1.0", + "artifactSelector": "sub-module-1" + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "terminationGracePeriodSeconds": 30, + "livenessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "readinessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "startupProbe": null + }, + "provisioningState": "Creating", + "status": "Running", + "active": false, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "pending", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + }, + "200": { + "body": { + "properties": { + "source": { + "type": "Source", + "relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc", + "version": "1.0", + "artifactSelector": "sub-module-1" + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "terminationGracePeriodSeconds": 30, + "livenessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "readinessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "startupProbe": null + }, + "provisioningState": "Succeeded", + "status": "Running", + "active": false, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "pending", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + }, + "202": { + "body": { + "properties": { + "source": { + "type": "Source", + "relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc", + "version": "1.0", + "artifactSelector": "sub-module-1" + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "terminationGracePeriodSeconds": 30, + "livenessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "readinessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "startupProbe": null + }, + "provisioningState": "Updating", + "status": "Running", + "active": false, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "pending", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_CreateOrUpdate_CustomContainer.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_CreateOrUpdate_CustomContainer.json new file mode 100644 index 000000000000..2990f0816b7c --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_CreateOrUpdate_CustomContainer.json @@ -0,0 +1,323 @@ +{ + "parameters": { + "deploymentResource": { + "properties": { + "source": { + "type": "Container", + "customContainer": { + "server": "myacr.azurecr.io", + "containerImage": "myContainerImage:v1", + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ], + "imageRegistryCredential": { + "username": "myUsername", + "password": "myPassword" + }, + "languageFramework": "springboot" + } + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "terminationGracePeriodSeconds": 30, + "livenessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "readinessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "startupProbe": null + }, + "instances": null + } + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "201": { + "body": { + "properties": { + "source": { + "type": "Container", + "customContainer": { + "server": "myacr.azurecr.io", + "containerImage": "myContainerImage:v1", + "imageRegistryCredential": { + "username": "myUsername", + "password": "" + }, + "languageFramework": "springboot" + } + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "terminationGracePeriodSeconds": 30, + "livenessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "readinessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "startupProbe": null + }, + "provisioningState": "Creating", + "status": "Running", + "active": false, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "N/A", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + }, + "200": { + "body": { + "properties": { + "source": { + "type": "Container", + "customContainer": { + "server": "myacr.azurecr.io", + "containerImage": "myContainerImage:v1", + "imageRegistryCredential": { + "username": "myUsername", + "password": "" + }, + "languageFramework": "springboot" + } + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "terminationGracePeriodSeconds": 30, + "livenessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "readinessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "startupProbe": null + }, + "provisioningState": "Succeeded", + "status": "Running", + "active": false, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "N/A", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + }, + "202": { + "body": { + "properties": { + "source": { + "type": "Container", + "customContainer": { + "server": "myacr.azurecr.io", + "containerImage": "myContainerImage:v1", + "imageRegistryCredential": { + "username": "myUsername", + "password": "" + }, + "languageFramework": "springboot" + } + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "terminationGracePeriodSeconds": 30, + "livenessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "readinessProbe": { + "disableProbe": false, + "initialDelaySeconds": 30, + "periodSeconds": 10, + "failureThreshold": 3, + "probeAction": { + "type": "HTTPGetAction", + "path": "/health", + "scheme": "HTTP" + } + }, + "startupProbe": null + }, + "provisioningState": "Updating", + "status": "Running", + "active": false, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "N/A", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Delete.json new file mode 100644 index 000000000000..e620538001c1 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_DisableRemoteDebugging.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_DisableRemoteDebugging.json new file mode 100644 index 000000000000..3e605897870e --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_DisableRemoteDebugging.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": { + "body": { + "port": 5005, + "enabled": false + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.AppPlatform/...pathToOperationResult..." + }, + "body": { + "port": 5005, + "enabled": false + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_EnableRemoteDebugging.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_EnableRemoteDebugging.json new file mode 100644 index 000000000000..d9ca1febf9ba --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_EnableRemoteDebugging.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment", + "RemoteDebuggingPayload": { + "properties": { + "port": 5005 + } + } + }, + "responses": { + "200": { + "body": { + "port": 5005, + "enabled": true + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.AppPlatform/...pathToOperationResult..." + }, + "body": { + "port": 5005, + "enabled": true + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GenerateHeapDump.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GenerateHeapDump.json new file mode 100644 index 000000000000..d1d68452d0db --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GenerateHeapDump.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "diagnosticParameters": { + "appInstance": "myappinstance", + "filePath": "/byos/diagnose" + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GenerateThreadDump.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GenerateThreadDump.json new file mode 100644 index 000000000000..d1d68452d0db --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GenerateThreadDump.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "diagnosticParameters": { + "appInstance": "myappinstance", + "filePath": "/byos/diagnose" + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Get.json new file mode 100644 index 000000000000..284408f79a5c --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": { + "body": { + "properties": { + "source": { + "type": "Source", + "relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc", + "version": "1.0", + "artifactSelector": "sub-module-1" + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ] + }, + "provisioningState": "Succeeded", + "status": "Running", + "active": true, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "pending", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GetLogFileUrl.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GetLogFileUrl.json new file mode 100644 index 000000000000..df88f5b6bdca --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GetLogFileUrl.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": { + "body": { + "url": "https://spring.blob.core.windows.net/logs/110ec0c337154d45b1f01daf2196c0bf/b58b0cb4ecdea3c65311b4ca8833fe47b6ae0a7500f87a8eb31e8379d3fe48f1-2019081312-42b7b90c-f108-4c09-b33d-1ea134f57f23?sv=2018-03-28&sr=b&sig=example-signature&se=2019-08-14T09%3A43%3A52Z&sp=r" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GetRemoteDebuggingConfig.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GetRemoteDebuggingConfig.json new file mode 100644 index 000000000000..86eea66ac7ee --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_GetRemoteDebuggingConfig.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": { + "body": { + "port": 5005, + "enabled": true + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Get_CustomContainer.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Get_CustomContainer.json new file mode 100644 index 000000000000..425de0d64086 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Get_CustomContainer.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": { + "body": { + "properties": { + "source": { + "type": "Container", + "customContainer": { + "server": "myacr.azurecr.io", + "containerImage": "myContainerImage:v1", + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ], + "imageRegistryCredential": { + "username": "myUsername", + "password": "" + }, + "languageFramework": "springboot" + } + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ] + }, + "provisioningState": "Succeeded", + "status": "Running", + "active": false, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "N/A", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_List.json new file mode 100644 index 000000000000..783acc5b514d --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_List.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "source": { + "type": "Source", + "relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc", + "version": "1.0", + "artifactSelector": "sub-module-1" + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ] + }, + "provisioningState": "Succeeded", + "status": "Running", + "active": true, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "pending", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_ListForCluster.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_ListForCluster.json new file mode 100644 index 000000000000..2e3736c861de --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_ListForCluster.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "source": { + "type": "Source", + "relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc", + "version": "1.0", + "artifactSelector": "sub-module-1" + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ] + }, + "provisioningState": "Succeeded", + "status": "Running", + "active": true, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "pending", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Restart.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Restart.json new file mode 100644 index 000000000000..1099ac2476e7 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Restart.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.AppPlatform/...pathToOperationResult..." + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Start.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Start.json new file mode 100644 index 000000000000..1099ac2476e7 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Start.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.AppPlatform/...pathToOperationResult..." + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_StartJFR.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_StartJFR.json new file mode 100644 index 000000000000..58fddda12911 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_StartJFR.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "diagnosticParameters": { + "appInstance": "myappinstance", + "filePath": "/byos/diagnose", + "duration": "60s" + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Stop.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Stop.json new file mode 100644 index 000000000000..1099ac2476e7 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Stop.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.AppPlatform/...pathToOperationResult..." + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Update.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Update.json new file mode 100644 index 000000000000..cae48cf2547b --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Update.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "deploymentResource": { + "properties": { + "source": { + "type": "Source", + "relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc", + "version": "1.0", + "artifactSelector": "sub-module-1" + }, + "instances": null + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": { + "body": { + "properties": { + "source": { + "type": "Source", + "relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc", + "version": "1.0", + "artifactSelector": "sub-module-1" + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ] + }, + "provisioningState": "Succeeded", + "status": "Running", + "active": true, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "pending", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": { + "properties": { + "source": { + "type": "Source", + "relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc", + "version": "1.0", + "artifactSelector": "sub-module-1" + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ] + }, + "provisioningState": "Updating", + "status": "Running", + "active": true, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "pending", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Update_CustomContainer.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Update_CustomContainer.json new file mode 100644 index 000000000000..6866134385e4 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Deployments_Update_CustomContainer.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "deploymentResource": { + "properties": { + "source": { + "type": "Container", + "customContainer": { + "server": "mynewacr.azurecr.io", + "containerImage": "myNewContainerImage:v1", + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ], + "imageRegistryCredential": { + "username": "myNewUsername", + "password": "" + } + } + }, + "instances": null + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "deploymentName": "mydeployment" + }, + "responses": { + "200": { + "body": { + "properties": { + "source": { + "type": "Container", + "customContainer": { + "server": "mynewacr.azurecr.io", + "containerImage": "myNewContainerImage:v1", + "imageRegistryCredential": { + "username": "myNewUsername", + "password": "" + } + } + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ] + }, + "provisioningState": "Succeeded", + "status": "Running", + "active": false, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "N/A", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": { + "properties": { + "source": { + "type": "Container", + "customContainer": { + "server": "mynewacr.azurecr.io", + "containerImage": "myNewContainerImage:v1", + "imageRegistryCredential": { + "username": "myNewUsername", + "password": "" + } + } + }, + "deploymentSettings": { + "resourceRequests": { + "cpu": "1000m", + "memory": "3Gi" + }, + "environmentVariables": { + "env": "test" + }, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ] + }, + "provisioningState": "Updating", + "status": "Running", + "active": false, + "instances": [ + { + "name": "instance1", + "status": "Running", + "discoveryStatus": "N/A", + "startTime": "2020-08-26T01:55:02Z" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 1 + }, + "type": "Microsoft.AppPlatform/Spring/apps/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment", + "name": "mydeployment" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortal_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortal_Delete.json new file mode 100644 index 000000000000..e2613170a461 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortal_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "devToolPortalName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortals_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortals_CreateOrUpdate.json new file mode 100644 index 000000000000..8d01a524b5c0 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortals_CreateOrUpdate.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "devToolPortalName": "default", + "DevToolPortalResource": { + "properties": { + "public": true, + "ssoProperties": { + "clientId": "00000000-0000-0000-0000-000000000000", + "scopes": [ + "openid" + ], + "clientSecret": "xxxxx", + "metadataUrl": "https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/v2.0/.well-known/openid-configuration" + }, + "features": { + "applicationAccelerator": { + "state": "Enabled" + }, + "applicationLiveView": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "public": true, + "ssoProperties": { + "clientId": "00000000-0000-0000-0000-000000000000", + "scopes": [ + "openid" + ], + "metadataUrl": "https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/v2.0/.well-known/openid-configuration" + }, + "features": { + "applicationAccelerator": { + "state": "Enabled", + "route": "create" + }, + "applicationLiveView": { + "state": "Enabled", + "route": "appliveview" + } + }, + "url": "aaa.com", + "provisioningState": "Succeeded", + "components": [ + { + "name": "server", + "resourceRequests": { + "cpu": "1", + "memory": "1Gi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "dev-tool-portal-server-name", + "status": "Running" + } + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationLiveViews", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default", + "name": "default" + } + }, + "201": { + "body": { + "properties": { + "public": true, + "ssoProperties": { + "clientId": "00000000-0000-0000-0000-000000000000", + "scopes": [ + "openid" + ], + "metadataUrl": "https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/v2.0/.well-known/openid-configuration" + }, + "features": { + "applicationAccelerator": { + "state": "Enabled", + "route": "create" + }, + "applicationLiveView": { + "state": "Enabled", + "route": "appliveview" + } + }, + "url": "aaa.com", + "provisioningState": "Succeeded", + "components": [ + { + "name": "server", + "resourceRequests": { + "cpu": "1", + "memory": "1Gi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "dev-tool-portal-server-name", + "status": "Running" + } + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationLiveViews", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortals_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortals_Get.json new file mode 100644 index 000000000000..c0f321c672cc --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortals_Get.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "devToolPortalName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "public": true, + "ssoProperties": { + "clientId": "00000000-0000-0000-0000-000000000000", + "scopes": [ + "openid" + ], + "metadataUrl": "https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/v2.0/.well-known/openid-configuration" + }, + "features": { + "applicationAccelerator": { + "state": "Enabled", + "route": "create" + }, + "applicationLiveView": { + "state": "Enabled", + "route": "appliveview" + } + }, + "url": "aaa.com", + "provisioningState": "Succeeded", + "components": [ + { + "name": "server", + "resourceRequests": { + "cpu": "1", + "memory": "1Gi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "dev-tool-portal-server-name", + "status": "Running" + } + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationLiveViews", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortals_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortals_List.json new file mode 100644 index 000000000000..191d557ee234 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/DevToolPortals_List.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "public": true, + "ssoProperties": { + "clientId": "00000000-0000-0000-0000-000000000000", + "scopes": [ + "openid" + ], + "metadataUrl": "https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/v2.0/.well-known/openid-configuration" + }, + "features": { + "applicationAccelerator": { + "state": "Enabled", + "route": "create" + }, + "applicationLiveView": { + "state": "Enabled", + "route": "appliveview" + } + }, + "url": "aaa.com", + "provisioningState": "Succeeded", + "components": [ + { + "name": "server", + "resourceRequests": { + "cpu": "1", + "memory": "1Gi", + "instanceCount": 1 + }, + "instances": [ + { + "name": "dev-tool-portal-server-name", + "status": "Running" + } + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationLiveViews", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default", + "name": "default" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_Get_Consumption.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_Get_Consumption.json new file mode 100644 index 000000000000..64ee37ee3b07 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_Get_Consumption.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "enabledState": "Enabled" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/eurekaServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/eurekaServers/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_List_Consumption.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_List_Consumption.json new file mode 100644 index 000000000000..477ccadb91e2 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_List_Consumption.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "enabledState": "Enabled" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/eurekaServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/eurekaServers", + "name": "default" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_UpdatePatch_Consumption.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_UpdatePatch_Consumption.json new file mode 100644 index 000000000000..b325747ea054 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_UpdatePatch_Consumption.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "eurekaServerResource": { + "properties": { + "enabledState": "Enabled" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": { + "properties": { + "provisioningState": "Updating", + "enabledState": "Enabled" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/eurekaServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/eurekaServers/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "enabledState": "Enabled" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/eurekaServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/eurekaServers/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_UpdatePut_Consumption.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_UpdatePut_Consumption.json new file mode 100644 index 000000000000..ab586bec270c --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/EurekaServers_UpdatePut_Consumption.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "eurekaServerResource": { + "properties": { + "enabledState": "Enabled" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Updating", + "enabledState": "Enabled" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/eurekaServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/eurekaServers/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "enabledState": "Enabled" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/eurekaServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/eurekaServers/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_CreateOrUpdate.json new file mode 100644 index 000000000000..6a509a30345c --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_CreateOrUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default", + "domainName": "myDomainName", + "gatewayCustomDomainResource": { + "properties": { + "thumbprint": "*" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "thumbprint": "*" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/domains/myDomainName", + "name": "myDomainName" + } + }, + "201": { + "body": { + "properties": { + "thumbprint": "*" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/domains/myDomainName", + "name": "myDomainName" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_Delete.json new file mode 100644 index 000000000000..ca5d53a5a7a7 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default", + "domainName": "myDomainName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_Get.json new file mode 100644 index 000000000000..0d4eb4161983 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default", + "domainName": "myDomainName" + }, + "responses": { + "200": { + "body": { + "properties": { + "thumbprint": "*" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/domains/myDomainName", + "name": "myDomainName" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_List.json new file mode 100644 index 000000000000..efe122dc4c37 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayCustomDomains_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "thumbprint": "*" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/domains/myDomain", + "name": "myDomain" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_CreateOrUpdate.json new file mode 100644 index 000000000000..6f59c1b1f487 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_CreateOrUpdate.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default", + "routeConfigName": "myRouteConfig", + "gatewayRouteConfigResource": { + "properties": { + "appResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp", + "openApi": { + "uri": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json" + }, + "protocol": "HTTPS", + "routes": [ + { + "title": "myApp route config", + "ssoEnabled": true, + "predicates": [ + "Path=/api5/customer/**" + ], + "filters": [ + "StripPrefix=2", + "RateLimit=1,1s" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "appResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp", + "protocol": "HTTPS", + "openApi": { + "uri": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json" + }, + "routes": [ + { + "title": "myApp route config", + "ssoEnabled": true, + "predicates": [ + "Path=/api5/customer/**" + ], + "filters": [ + "StripPrefix=2", + "RateLimit=1,1s" + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways/routeConfigs", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/routeConfigs/myRouteConfig", + "name": "myRouteConfig" + } + }, + "201": { + "body": { + "properties": { + "appResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp", + "protocol": "HTTPS", + "openApi": { + "uri": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json" + }, + "routes": [ + { + "title": "myApp route config", + "ssoEnabled": true, + "predicates": [ + "Path=/api5/customer/**" + ], + "filters": [ + "StripPrefix=2", + "RateLimit=1,1s" + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways/routeConfigs", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/routeConfigs/myRouteConfig", + "name": "myRouteConfig" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_Delete.json new file mode 100644 index 000000000000..fa66e4215a1b --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default", + "routeConfigName": "myRouteConfig" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_Get.json new file mode 100644 index 000000000000..9e47cd36b89b --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default", + "routeConfigName": "myRouteConfig" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "appResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp", + "openApi": { + "uri": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json" + }, + "protocol": "HTTPS", + "routes": [ + { + "title": "myApp route config", + "ssoEnabled": true, + "predicates": [ + "Path=/api5/customer/**" + ], + "filters": [ + "StripPrefix=2", + "RateLimit=1,1s" + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways/routeConfigs", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/routeConfigs/myRouteConfig", + "name": "myRouteConfig" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_List.json new file mode 100644 index 000000000000..0b846897cb98 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/GatewayRouteConfigs_List.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "appResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp", + "openApi": { + "uri": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json" + }, + "protocol": "HTTPS", + "routes": [ + { + "title": "myApp route config", + "ssoEnabled": true, + "predicates": [ + "Path=/api5/customer/**" + ], + "filters": [ + "StripPrefix=2", + "RateLimit=1,1s" + ] + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways/routeConfigs", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/routeConfigs/myRouteConfig", + "name": "myRouteConfig" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateway_Scale.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateway_Scale.json new file mode 100644 index 000000000000..3e0f2540aa17 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateway_Scale.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default", + "gatewayCapacityResource": { + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "public": true, + "url": "test-url", + "resourceRequests": { + "cpu": "1", + "memory": "1G" + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ], + "operatorProperties": { + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + } + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_CreateOrUpdate.json new file mode 100644 index 000000000000..8de06c38d807 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_CreateOrUpdate.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default", + "gatewayResource": { + "properties": { + "public": true, + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "resourceRequests": { + "cpu": "1", + "memory": "1G" + }, + "responseCacheProperties": { + "responseCacheType": "LocalCachePerRoute", + "size": "5MB", + "timeToLive": "300s" + } + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "public": true, + "url": "test-url", + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "resourceRequests": { + "cpu": "1", + "memory": "1G" + }, + "responseCacheProperties": { + "responseCacheType": "LocalCachePerRoute", + "size": "5MB", + "timeToLive": "300s" + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ], + "operatorProperties": { + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + } + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "public": true, + "url": "test-url", + "apms": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + } + ], + "resourceRequests": { + "cpu": "1", + "memory": "1G" + }, + "responseCacheProperties": { + "responseCacheType": "LocalCachePerRoute", + "size": "5MB", + "timeToLive": "300s" + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ], + "operatorProperties": { + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + } + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_Delete.json new file mode 100644 index 000000000000..3d61f7b0940f --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_Get.json new file mode 100644 index 000000000000..282444ff7486 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_Get.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "public": true, + "url": "test-url", + "resourceRequests": { + "cpu": "1", + "memory": "1G" + }, + "responseCacheProperties": { + "responseCacheType": "LocalCachePerRoute", + "size": "5MB", + "timeToLive": "300s" + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ], + "operatorProperties": { + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + } + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_List.json new file mode 100644 index 000000000000..24b57f0423a2 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_List.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "public": true, + "url": "test-url", + "resourceRequests": { + "cpu": "1", + "memory": "1G" + }, + "responseCacheProperties": { + "responseCacheType": "LocalCachePerRoute", + "size": "5MB", + "timeToLive": "300s" + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ], + "operatorProperties": { + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + } + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default", + "name": "default" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_ListEnvSecrets.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_ListEnvSecrets.json new file mode 100644 index 000000000000..b3716819bd56 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_ListEnvSecrets.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default" + }, + "responses": { + "200": { + "body": { + "key": "value" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_Restart.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_Restart.json new file mode 100644 index 000000000000..07545cc60bf7 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_Restart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.AppPlatform/...pathToOperationResult..." + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_ValidateDomain.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_ValidateDomain.json new file mode 100644 index 000000000000..746f091c2ea4 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Gateways_ValidateDomain.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "gatewayName": "default", + "validatePayload": { + "name": "mydomain.io" + } + }, + "responses": { + "200": { + "body": { + "isValid": false, + "message": "Certificate is invalid, please check if it is a self signed cert or if it contains a suitable dns name" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/MonitoringSettings_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/MonitoringSettings_Get.json new file mode 100644 index 000000000000..ec90d429fd50 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/MonitoringSettings_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "traceEnabled": true, + "appInsightsInstrumentationKey": "00000000-0000-0000-0000-000000000000", + "appInsightsSamplingRate": 10.0, + "appInsightsAgentVersions": { + "java": "3.0.0" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/monitoringSettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/monitoringSettings/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/MonitoringSettings_UpdatePatch.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/MonitoringSettings_UpdatePatch.json new file mode 100644 index 000000000000..5f843d0a380e --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/MonitoringSettings_UpdatePatch.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "monitoringSettingResource": { + "properties": { + "traceEnabled": true, + "appInsightsInstrumentationKey": "00000000-0000-0000-0000-000000000000", + "appInsightsSamplingRate": 10.0 + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + }, + "body": { + "properties": { + "provisioningState": "Updating", + "traceEnabled": true, + "appInsightsInstrumentationKey": "00000000-0000-0000-0000-000000000000", + "appInsightsSamplingRate": 10.0, + "appInsightsAgentVersions": { + "java": "3.0.0" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/monitoringSettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/monitoringSettings/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "traceEnabled": true, + "appInsightsInstrumentationKey": "00000000-0000-0000-0000-000000000000", + "appInsightsSamplingRate": 10.0, + "appInsightsAgentVersions": { + "java": "3.0.0" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/monitoringSettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/monitoringSettings/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/MonitoringSettings_UpdatePut.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/MonitoringSettings_UpdatePut.json new file mode 100644 index 000000000000..916587809e44 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/MonitoringSettings_UpdatePut.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "monitoringSettingResource": { + "properties": { + "traceEnabled": true, + "appInsightsInstrumentationKey": "00000000-0000-0000-0000-000000000000", + "appInsightsSamplingRate": 10.0 + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "202": { + "body": { + "properties": { + "provisioningState": "Updating", + "traceEnabled": true, + "appInsightsInstrumentationKey": "00000000-0000-0000-0000-000000000000", + "appInsightsSamplingRate": 10.0, + "appInsightsAgentVersions": { + "java": "3.0.0" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/monitoringSettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/monitoringSettings/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "traceEnabled": true, + "appInsightsInstrumentationKey": "00000000-0000-0000-0000-000000000000", + "appInsightsSamplingRate": 10.0, + "appInsightsAgentVersions": { + "java": "3.0.0" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/monitoringSettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/monitoringSettings/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Operations_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..2752ca64b0c1 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Operations_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AppPlatform/Spring/read", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Distributed Managed Service for Spring", + "resource": "Managed Applications", + "operation": "Create or Update Managed Applications", + "description": "Create or Update Managed Applications" + }, + "origin": "user,system", + "properties": { + "serviceSpecification": null + } + } + ], + "nextLink": "providers/Microsoft.AppPlatform?$skipToken={opaqueString}" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_Disable.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_Disable.json new file mode 100644 index 000000000000..df083d23ff5e --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_Disable.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default", + "predefinedAcceleratorName": "acc-name" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_Enable.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_Enable.json new file mode 100644 index 000000000000..df083d23ff5e --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_Enable.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default", + "predefinedAcceleratorName": "acc-name" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_Get.json new file mode 100644 index 000000000000..df940fdb9012 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default", + "predefinedAcceleratorName": "acc-name" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "displayName": "acc-name", + "description": "acc-desc", + "iconUrl": "acc-icon", + "acceleratorTags": [ + "tag-a", + "tag-b" + ], + "state": "Enabled" + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationAccelerators/predefinedAccelerators", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default/predefinedAccelerators/acc-name", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_List.json new file mode 100644 index 000000000000..339346eef3fa --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/PredefinedAccelerators_List.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "applicationAcceleratorName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "displayName": "acc-name", + "description": "acc-desc", + "iconUrl": "acc-icon", + "acceleratorTags": [ + "tag-a", + "tag-b" + ], + "state": "Enabled" + }, + "sku": { + "name": "E0", + "tier": "Enterprise", + "capacity": 2 + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/applicationAccelerators/predefinedAccelerators", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default/predefinedAccelerators", + "name": "default" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/RuntimeVersions_ListRuntimeVersions.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/RuntimeVersions_ListRuntimeVersions.json new file mode 100644 index 000000000000..4f499b061626 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/RuntimeVersions_ListRuntimeVersions.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "value": "Java_8", + "platform": "Java", + "version": "8" + }, + { + "value": "Java_11", + "platform": "Java", + "version": "11" + }, + { + "value": "Java_17", + "platform": "Java", + "version": "17" + }, + { + "value": "Java_21", + "platform": "Java", + "version": "21" + }, + { + "value": "NetCore_31", + "platform": ".NET Core", + "version": "3.1" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_CreateOrUpdate.json new file mode 100644 index 000000000000..9008ad3c072b --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_CreateOrUpdate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "serviceRegistryName": "default" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/serviceRegistries", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/default", + "name": "default" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/serviceRegistries", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_Delete.json new file mode 100644 index 000000000000..b86264e28bab --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "serviceRegistryName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_Get.json new file mode 100644 index 000000000000..8f3b8c1ea724 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "serviceRegistryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/serviceRegistries", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/default", + "name": "default" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_List.json new file mode 100644 index 000000000000..b592b2f948c5 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/ServiceRegistries_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "resourceRequests": { + "cpu": "1", + "memory": "1G", + "instanceCount": 2 + }, + "instances": [ + { + "name": "instance1", + "status": "Running" + }, + { + "name": "instance2", + "status": "Running" + } + ] + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/serviceRegistries", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/default", + "name": "default" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CheckNameAvailability.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CheckNameAvailability.json new file mode 100644 index 000000000000..fcb7b7cc1f46 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "eastus", + "availabilityParameters": { + "type": "Microsoft.AppPlatform/Spring", + "name": "myservice" + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The name is already used." + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate.json new file mode 100644 index 000000000000..cb24c2e98307 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate.json @@ -0,0 +1,234 @@ +{ + "parameters": { + "resource": { + "properties": { + "maintenanceScheduleConfiguration": { + "frequency": "Weekly", + "hour": 10, + "day": "Sunday" + } + }, + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "serviceId": "12345678abcd1234abcd12345678abcd", + "maintenanceScheduleConfiguration": { + "frequency": "Weekly", + "hour": 10, + "day": "Sunday", + "duration": "PT8H" + }, + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + }, + "ingressConfig": { + "readTimeoutInSeconds": 300 + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "serviceId": "12345678abcd1234abcd12345678abcd", + "maintenanceScheduleConfiguration": { + "frequency": "Weekly", + "hour": 10, + "day": "Sunday", + "duration": "PT8H" + }, + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + }, + "202": { + "body": { + "properties": { + "provisioningState": "Updating", + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate_Consumption.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate_Consumption.json new file mode 100644 index 000000000000..4e7939defc18 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate_Consumption.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "resource": { + "properties": { + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.App/managedEnvironments/myenvironment" + }, + "sku": { + "name": "S0", + "tier": "StandardGen2" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "serviceId": "12345678abcd1234abcd12345678abcd", + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.App/managedEnvironments/myenvironment", + "infraResourceGroup": "myenvironment_SpringApps_12345678abcd1234abcd12345678abcd" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "StandardGen2" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "serviceId": "12345678abcd1234abcd12345678abcd", + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.App/managedEnvironments/myenvironment", + "infraResourceGroup": "myenvironment_SpringApps_12345678abcd1234abcd12345678abcd" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "StandardGen2" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + }, + "202": { + "body": { + "properties": { + "provisioningState": "Updating", + "serviceId": "12345678abcd1234abcd12345678abcd", + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.App/managedEnvironments/myenvironment", + "infraResourceGroup": "myenvironment_SpringApps_12345678abcd1234abcd12345678abcd" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "StandardGen2" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate_Enterprise.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate_Enterprise.json new file mode 100644 index 000000000000..35623cd88157 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate_Enterprise.json @@ -0,0 +1,237 @@ +{ + "parameters": { + "resource": { + "properties": { + "marketplaceResource": { + "plan": "tanzu-asc-ent-mtr", + "product": "azure-spring-cloud-vmware-tanzu-2", + "publisher": "vmware-inc" + } + }, + "sku": { + "name": "E0", + "tier": "Enterprise" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + }, + "ingressConfig": { + "readTimeoutInSeconds": 300 + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + }, + "marketplaceResource": { + "plan": "tanzu-asc-ent-mtr", + "product": "azure-spring-cloud-vmware-tanzu-2", + "publisher": "vmware-inc" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "E0", + "tier": "Enterprise" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + }, + "marketplaceResource": { + "plan": "tanzu-asc-ent-mtr", + "product": "azure-spring-cloud-vmware-tanzu-2", + "publisher": "vmware-inc" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "E0", + "tier": "Enterprise" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + }, + "202": { + "body": { + "properties": { + "provisioningState": "Updating", + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + }, + "marketplaceResource": { + "plan": "tanzu-asc-ent-mtr", + "product": "azure-spring-cloud-vmware-tanzu-2", + "publisher": "vmware-inc" + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "E0", + "tier": "Enterprise" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate_VNetInjection.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate_VNetInjection.json new file mode 100644 index 000000000000..6bee963cc20c --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_CreateOrUpdate_VNetInjection.json @@ -0,0 +1,252 @@ +{ + "parameters": { + "resource": { + "properties": { + "networkProfile": { + "serviceRuntimeSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/serviceRuntime", + "appSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/apps", + "serviceCidr": "10.8.0.0/16,10.244.0.0/16,10.245.0.1/16", + "serviceRuntimeNetworkResourceGroup": "my-service-runtime-network-rg", + "appNetworkResourceGroup": "my-app-network-rg", + "ingressConfig": { + "readTimeoutInSeconds": 300 + } + }, + "vnetAddons": { + "logStreamPublicEndpoint": true, + "dataPlanePublicEndpoint": true + } + }, + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "networkProfile": { + "serviceRuntimeSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/serviceRuntime", + "appSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/apps", + "serviceCidr": "10.8.0.0/16,10.244.0.0/16,10.245.0.1/16", + "serviceRuntimeNetworkResourceGroup": "my-service-runtime-network-rg", + "appNetworkResourceGroup": "my-app-network-rg", + "outboundIPs": { + "publicIPs": [ + "40.64.67.13" + ] + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + }, + "vnetAddons": { + "logStreamPublicEndpoint": true, + "dataPlanePublicEndpoint": true + }, + "serviceId": "12345678abcd1234abcd12345678abcd" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "networkProfile": { + "serviceRuntimeSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/serviceRuntime", + "appSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/apps", + "serviceCidr": "10.8.0.0/16,10.244.0.0/16,10.245.0.1/16", + "serviceRuntimeNetworkResourceGroup": "my-service-runtime-network-rg", + "appNetworkResourceGroup": "my-app-network-rg", + "outboundIPs": { + "publicIPs": [ + "40.64.67.13" + ] + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + }, + "vnetAddons": { + "logStreamPublicEndpoint": true, + "dataPlanePublicEndpoint": true + }, + "serviceId": "12345678abcd1234abcd12345678abcd" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + }, + "202": { + "body": { + "properties": { + "provisioningState": "Updating", + "networkProfile": { + "serviceRuntimeSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/serviceRuntime", + "appSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/apps", + "serviceCidr": "10.8.0.0/16,10.244.0.0/16,10.245.0.1/16", + "serviceRuntimeNetworkResourceGroup": "my-service-runtime-network-rg", + "appNetworkResourceGroup": "my-app-network-rg", + "outboundIPs": { + "publicIPs": [ + "40.64.67.13" + ] + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + }, + "vnetAddons": { + "logStreamPublicEndpoint": true, + "dataPlanePublicEndpoint": true + }, + "serviceId": "12345678abcd1234abcd12345678abcd" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Delete.json new file mode 100644 index 000000000000..15d9da02ad72 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.AppPlatform/...pathToOperationResult..." + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_DisableApmGlobally.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_DisableApmGlobally.json new file mode 100644 index 000000000000..4cbd34310651 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_DisableApmGlobally.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "apm": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_DisableTestEndpoint.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_DisableTestEndpoint.json new file mode 100644 index 000000000000..b232a5f9f791 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_DisableTestEndpoint.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_EnableApmGlobally.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_EnableApmGlobally.json new file mode 100644 index 000000000000..4cbd34310651 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_EnableApmGlobally.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "apm": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_EnableTestEndpoint.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_EnableTestEndpoint.json new file mode 100644 index 000000000000..9e56f780395f --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_EnableTestEndpoint.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "", + "primaryTestEndpoint": "", + "secondaryTestEndpoint": "", + "enabled": true + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_FlushVnetDnsSetting.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_FlushVnetDnsSetting.json new file mode 100644 index 000000000000..363abda2af10 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_FlushVnetDnsSetting.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Get.json new file mode 100644 index 000000000000..32b6e273ea46 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Get.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + }, + "ingressConfig": { + "readTimeoutInSeconds": 300 + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Get_Consumption.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Get_Consumption.json new file mode 100644 index 000000000000..5de3a970c1fe --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Get_Consumption.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "serviceId": "12345678abcd1234abcd12345678abcd", + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.App/managedEnvironments/myenvironment", + "infraResourceGroup": "myenvironment_SpringApps_12345678abcd1234abcd12345678abcd" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "StandardGen2" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_List.json new file mode 100644 index 000000000000..3c8003b78077 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_List.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + }, + "ingressConfig": { + "readTimeoutInSeconds": 300 + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + }, + { + "properties": { + "provisioningState": "Succeeded", + "serviceId": "12345678abcd1234abcd12345678abc1", + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.App/managedEnvironments/myenvironment", + "infraResourceGroup": "myenvironment_SpringApps_12345678abcd1234abcd12345678abc1" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "StandardGen2" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice1", + "name": "myservice1" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListBySubscription.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListBySubscription.json new file mode 100644 index 000000000000..f93c9642ef7b --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListBySubscription.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + }, + "ingressConfig": { + "readTimeoutInSeconds": 300 + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + }, + { + "properties": { + "provisioningState": "Succeeded", + "serviceId": "12345678abcd1234abcd12345678abc1", + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.App/managedEnvironments/myenvironment", + "infraResourceGroup": "myenvironment_SpringApps_12345678abcd1234abcd12345678abc1" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "StandardGen2" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice1", + "name": "myservice1" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListGloballyEnabledApms.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListGloballyEnabledApms.json new file mode 100644 index 000000000000..5338e43cfb34 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListGloballyEnabledApms.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights" + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListSupportedApmTypes.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListSupportedApmTypes.json new file mode 100644 index 000000000000..1b5597c10445 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListSupportedApmTypes.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AppDynamics" + }, + { + "name": "ApplicationInsights" + }, + { + "name": "Dynatrace" + }, + { + "name": "ElasticAPM" + }, + { + "name": "NewRelic" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListSupportedServerVersions.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListSupportedServerVersions.json new file mode 100644 index 000000000000..78bef376535b --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListSupportedServerVersions.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "value": "Tomcat_9", + "server": "Tomcat", + "version": "9" + }, + { + "value": "Tomcat_10", + "server": "Tomcat", + "version": "10" + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListTestKeys.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListTestKeys.json new file mode 100644 index 000000000000..9e56f780395f --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_ListTestKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "", + "primaryTestEndpoint": "", + "secondaryTestEndpoint": "", + "enabled": true + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_RegenerateTestKey.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_RegenerateTestKey.json new file mode 100644 index 000000000000..3f6d1f1d8279 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_RegenerateTestKey.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "regenerateTestKeyRequest": { + "keyType": "Primary" + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "", + "primaryTestEndpoint": "", + "secondaryTestEndpoint": "", + "enabled": true + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Start.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Start.json new file mode 100644 index 000000000000..4a22dfcd7085 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Start.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "404": {}, + "409": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Stop.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Stop.json new file mode 100644 index 000000000000..4a22dfcd7085 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Stop.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "404": {}, + "409": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Update.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Update.json new file mode 100644 index 000000000000..b89ecdf6ccdd --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Services_Update.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "resource": { + "properties": {}, + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/myservice/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/myservice?api-version=2024-01-01-preview" + }, + "body": { + "properties": { + "provisioningState": "Updating", + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + }, + "ingressConfig": { + "readTimeoutInSeconds": 300 + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + }, + "requiredTraffics": [ + { + "protocol": "TCP", + "port": 443, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "UDP", + "port": 1194, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + }, + { + "protocol": "TCP", + "port": 9000, + "ips": [ + "20.62.211.25", + "52.188.47.226" + ], + "direction": "Outbound" + } + ] + } + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Skus_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Skus_List.json new file mode 100644 index 000000000000..be87d719f410 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Skus_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Spring", + "name": "B0", + "tier": "Basic", + "capacity": { + "minimum": 1, + "maximum": 20, + "default": 1, + "scaleType": "Automatic" + }, + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [], + "zoneDetails": [] + } + ], + "restrictions": [] + } + ] + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_CreateOrUpdate.json new file mode 100644 index 000000000000..c91704319c8e --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_CreateOrUpdate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "storageResource": { + "properties": { + "storageType": "StorageAccount", + "accountName": "storage-account-name", + "accountKey": "account-key-of-storage-account" + } + }, + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "storageName": "mystorage" + }, + "responses": { + "200": { + "body": { + "properties": { + "storageType": "StorageAccount", + "accountName": "storage-account-name" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/storages", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/storages/mystorage", + "name": "mystorage" + } + }, + "201": { + "body": { + "properties": { + "storageType": "StorageAccount", + "accountName": "storage-account-name" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/storages", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/storages/mystorage", + "name": "mystorage" + } + }, + "202": { + "body": { + "properties": { + "storageType": "StorageAccount", + "accountName": "storage-account-name" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/storages", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/storages/mystorage", + "name": "mystorage" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_Delete.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_Delete.json new file mode 100644 index 000000000000..f66bfd1bede1 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "storageName": "mystorage" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-01-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_Get.json new file mode 100644 index 000000000000..1d61f7901bf2 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "storageName": "mystorage" + }, + "responses": { + "200": { + "body": { + "properties": { + "storageType": "StorageAccount", + "accountName": "storage-account-name" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/storages", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/storages/mystorage", + "name": "mystorage" + } + } + } +} diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_List.json new file mode 100644 index 000000000000..becc9228ee1b --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2024-01-01-preview/examples/Storages_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "storageType": "StorageAccount", + "accountName": "storage-account-name" + }, + "systemData": { + "createdBy": "sample-user", + "createdByType": "User", + "createdAt": "2021-08-11T03:16:03.944Z", + "lastModifiedBy": "sample-user", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-11T03:17:03.944Z" + }, + "type": "Microsoft.AppPlatform/Spring/storages", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/storages/mystorage", + "name": "mystorage" + } + ], + "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/storages?$page=2" + } + } + } +} diff --git a/specification/appplatform/resource-manager/readme.go.md b/specification/appplatform/resource-manager/readme.go.md index 347ea37cec7e..7aeb8d4a331b 100644 --- a/specification/appplatform/resource-manager/readme.go.md +++ b/specification/appplatform/resource-manager/readme.go.md @@ -21,6 +21,7 @@ azure-arm: true ``` yaml $(go) && $(multiapi) batch: + - tag: package-preview-2024-01 - tag: package-2023-12 - tag: package-preview-2023-11 - tag: package-preview-2023-09 @@ -41,6 +42,15 @@ batch: - tag: package-2020-07 ``` +### Tag: package-preview-2024-01 and go + +These settings apply only when `--tag=package-preview-2024-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-preview-2024-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2024-01-01-preview/$(namespace) +``` + ### Tag: package-2023-12 and go These settings apply only when `--tag=package-2023-12 --go` is specified on the command line. diff --git a/specification/appplatform/resource-manager/readme.md b/specification/appplatform/resource-manager/readme.md index 7bad8fc9dcec..53b3b898cf02 100644 --- a/specification/appplatform/resource-manager/readme.md +++ b/specification/appplatform/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the AppPlatform API. ``` yaml openapi-type: arm -tag: package-2023-12 +tag: package-preview-2024-01 ``` ### Suppression @@ -59,12 +59,20 @@ suppressions: reason: start,stop,flushDNSsetting api do not have return body in async operation ``` +### Tag: package-preview-2024-01 + +These settings apply only when `--tag=package-preview-2024-01` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-01' +input-file: + - Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json +``` ### Tag: package-2023-12 These settings apply only when `--tag=package-2023-12` is specified on the command line. -```yaml $(tag) == 'package-2023-12' +``` yaml $(tag) == 'package-2023-12' input-file: - Microsoft.AppPlatform/stable/2023-12-01/appplatform.json ``` diff --git a/specification/appplatform/resource-manager/readme.python.md b/specification/appplatform/resource-manager/readme.python.md index a203a3c4bec5..79b699192352 100644 --- a/specification/appplatform/resource-manager/readme.python.md +++ b/specification/appplatform/resource-manager/readme.python.md @@ -19,9 +19,12 @@ Generate all API versions currently shipped for this package ```yaml $(python) +default-api-version: "2023-12-01" multiapi: true clear-output-folder: true batch: + - tag: package-preview-2024-01 + - tag: package-2023-12 - tag: package-preview-2023-11 - tag: package-preview-2023-09 - tag: package-preview-2023-07 @@ -44,9 +47,30 @@ batch: ``` yaml $(multiapiscript) output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform/azure/mgmt/appplatform/ +clear-output-folder: false perform-load: false ``` +### Tag: package-preview-2024-01 and python + +These settings apply only when `--tag=package-preview-2024-01 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-preview-2024-01' && $(python) +namespace: azure.mgmt.appplatform.v2024_01_01_preview +output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform/azure/mgmt/appplatform/v2024_01_01_preview +``` + +### Tag: package-2023-12 and python + +These settings apply only when `--tag=package-2023-12 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2023-12' && $(python) +namespace: azure.mgmt.appplatform.v2023_12_01 +output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform/azure/mgmt/appplatform/v2023_12_01 +``` + ### Tag: package-preview-2023-11 and python These settings apply only when `--tag=package-preview-2023-11 --python` is specified on the command line. diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/createOrUpdatePackage.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/createOrUpdatePackage.json index 6d0f8d75c1da..acadd657d681 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/createOrUpdatePackage.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/createOrUpdatePackage.json @@ -13,8 +13,7 @@ "contentHash": { "algorithm": "sha265", "value": "07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A" - }, - "version": "1.0.0.0" + } } } } @@ -23,9 +22,9 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/OmsCompositeResources", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources", "name": "OmsCompositeResources", - "type": "Microsoft.Automation/AutomationAccounts/Modules", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments/packages", "location": "East US 2", "tags": {}, "properties": { @@ -47,9 +46,9 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/OmsCompositeResources", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources", "name": "OmsCompositeResources", - "type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironmentss/Package", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments/packages", "location": "East US 2", "tags": {}, "properties": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/getPackage.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/getPackage.json index 062c3b70f0cc..0cf961c7eb57 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/getPackage.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/getPackage.json @@ -11,16 +11,16 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/myEnv/packages/OmsCompositeResources", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources", "name": "OmsCompositeResources", - "type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironmentss/Package", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments/packages", "location": "East US 2", "tags": {}, "properties": { "default": false, - "version": null, - "sizeInBytes": 0, - "provisioningState": "Creating" + "version": "1.0.0", + "sizeInBytes": 1560, + "provisioningState": "Succeeded" }, "systemData": { "createdAt": "2023-07-05T07:32:41.4389914+00:00", diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/listPackagesByRuntimeEnvironment.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/listPackagesByRuntimeEnvironment.json index e2c5e798503f..50c290c52fd9 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/listPackagesByRuntimeEnvironment.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/listPackagesByRuntimeEnvironment.json @@ -12,9 +12,9 @@ "body": { "value": [ { - "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/myEnv/packages/OmsCompositeResources", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources", "name": "OmsCompositeResources", - "type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironmentss/Package", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments/packages", "location": "East US 2", "tags": {}, "properties": { @@ -33,9 +33,9 @@ } }, { - "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/myEnv/packages/OmsCompositeResources2", - "name": "OmsCompositeResources", - "type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironmentss/Package", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources2", + "name": "OmsCompositeResources2", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments/packages", "location": "East US 2", "tags": {}, "properties": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/updatePackage.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/updatePackage.json index 408c93ae05db..ec7a253c18a0 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/updatePackage.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/updatePackage.json @@ -13,8 +13,7 @@ "contentHash": { "algorithm": "sha265", "value": "07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A" - }, - "version": "1.0.0.0" + } } } } @@ -23,9 +22,9 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/OmsCompositeResources", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyAutomationAccount/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources", "name": "OmsCompositeResources", - "type": "Microsoft.Automation/AutomationAccounts/Modules", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments/packages", "location": "East US 2", "tags": {}, "properties": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/createRuntimeEnvironment.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/createRuntimeEnvironment.json index 9e43d707e457..8f6ad7cc55ce 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/createRuntimeEnvironment.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/createRuntimeEnvironment.json @@ -12,7 +12,7 @@ "version": "7.1" }, "defaultPackages": { - "Az": "6.*" + "Az": "8.3.0" } }, "location": "East US 2" @@ -24,7 +24,7 @@ "body": { "name": "myRuntimeEnvironmentName", "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName", - "type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments", "location": "East US 2", "tags": {}, "systemData": { @@ -37,7 +37,7 @@ "version": "7.1" }, "defaultPackages": { - "Az": "6.*" + "Az": "8.3.0" } } } @@ -47,7 +47,7 @@ "body": { "name": "myRuntimeEnvironmentName", "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName", - "type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments", "location": "East US 2", "tags": {}, "systemData": { @@ -60,7 +60,7 @@ "version": "7.1" }, "defaultPackages": { - "Az": "6.*" + "Az": "8.3.0" } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/getRuntimeEnvironment.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/getRuntimeEnvironment.json index e5ee6d9e4b66..604dd9e871e8 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/getRuntimeEnvironment.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/getRuntimeEnvironment.json @@ -12,7 +12,7 @@ "body": { "name": "myRuntimeEnvironmentName", "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName", - "type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments", "location": "East US 2", "tags": {}, "systemData": { @@ -25,7 +25,7 @@ "version": "7.1" }, "defaultPackages": { - "Az": "6.*" + "Az": "8.3.0" }, "description": "Description of the Runtime Environment" } diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/listRuntimeEnvironmentsByAutomationAccount.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/listRuntimeEnvironmentsByAutomationAccount.json index 19f91cade2db..4340b0085203 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/listRuntimeEnvironmentsByAutomationAccount.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/listRuntimeEnvironmentsByAutomationAccount.json @@ -13,7 +13,7 @@ { "name": "myRuntimeEnvironmentName", "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName", - "type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments", "location": "East US 2", "tags": {}, "systemData": { @@ -23,10 +23,10 @@ "properties": { "runtime": { "language": "PowerShell", - "version": "7.1" + "version": "5.1" }, "defaultPackages": { - "Az": "6.*" + "Az": "8.3.0" }, "description": "Description of the Runtime Environment" } @@ -34,7 +34,7 @@ { "name": "myRuntimeEnvironmentName2", "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName2", - "type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments", "location": "East US 2", "tags": {}, "systemData": { @@ -47,7 +47,7 @@ "version": "7.1" }, "defaultPackages": { - "Az": "6.*" + "Az": "8.3.0" }, "description": "Description of the Runtime Environment" } @@ -55,7 +55,7 @@ { "name": "myRuntimeEnvironmentName3", "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName3", - "type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments", "location": "East US 2", "tags": {}, "systemData": { @@ -65,10 +65,10 @@ "properties": { "runtime": { "language": "PowerShell", - "version": "7.1" + "version": "7.2" }, "defaultPackages": { - "Az": "6.*" + "Az": "8.3.0" }, "description": "Description of the Runtime Environment" } diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/updateRuntimeEnvironment.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/updateRuntimeEnvironment.json index 7e902ff893f2..76a54492acf5 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/updateRuntimeEnvironment.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/runtimeEnvironment/updateRuntimeEnvironment.json @@ -8,7 +8,7 @@ "parameters": { "properties": { "defaultPackages": { - "Az": "6.*" + "Az": "8.3.0" } } } @@ -19,7 +19,7 @@ "body": { "name": "myRuntimeEnvironmentName", "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName", - "type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments", + "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments", "location": "East US 2", "tags": {}, "properties": { @@ -28,7 +28,7 @@ "version": "7.1" }, "defaultPackages": { - "Az": "6.*" + "Az": "8.3.0" }, "description": "Description of the Runtime Environment" }, diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/package.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/package.json index 6f5adc4eeb40..05e6bd2e4390 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/package.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2023-05-15-preview/package.json @@ -279,7 +279,7 @@ "tags": [ "Package" ], - "operationId": "Packages_ListByRuntimeEnvironment", + "operationId": "Package_ListByRuntimeEnvironment", "description": "Retrieve the a list of Packages", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/packageoperations" diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/azuredatatransfer.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/azuredatatransfer.json new file mode 100644 index 000000000000..021b8d990f0b --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/azuredatatransfer.json @@ -0,0 +1,2361 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-10-11-preview", + "title": "azuredatatransferrp", + "description": "Azure Data Transfer service resource provider" + }, + "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.AzureDataTransfer/validateSchema": { + "post": { + "description": "Validates a schema for Azure Data Transfer.", + "x-ms-examples": { + "Performs action request": { + "$ref": "examples/postValidateSchema.json" + } + }, + "operationId": "AzureDataTransfer_validateSchema", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "schema", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/schema" + }, + "description": "The schema to validate" + } + ], + "responses": { + "200": { + "description": "Result of the schema validation.", + "schema": { + "$ref": "#/definitions/validateSchemaResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.AzureDataTransfer/listApprovedSchemas": { + "post": { + "description": "Lists approved schemas for Azure Data Transfer.", + "x-ms-examples": { + "Performs action request": { + "$ref": "examples/postListApprovedSchemas.json" + } + }, + "operationId": "AzureDataTransfer_listApprovedSchemas", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "pipeline", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/listApprovedSchemasRequest" + }, + "description": "The request to list approved schemas." + } + ], + "responses": { + "200": { + "description": "List of approved schemas.", + "schema": { + "$ref": "#/definitions/schemasListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}": { + "get": { + "description": "Gets flow resource.", + "x-ms-examples": { + "Gets flow resource": { + "$ref": "examples/getFlow.json" + } + }, + "operationId": "Flows_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Creates or updates the flow resource.", + "operationId": "Flows_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates the flow resource": { + "$ref": "examples/createOrUpdateFlow.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "flow", + "description": "Flow body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/flow" + } + } + ], + "responses": { + "200": { + "description": "Created the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "201": { + "description": "Accepted creation the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Deletes the flow resource.", + "x-ms-examples": { + "Deletes the flow resource": { + "$ref": "examples/deleteFlow.json" + } + }, + "operationId": "Flows_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted delete the flows resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "204": { + "description": "Deleted the flows resource." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "description": "Updates the flow resource.", + "operationId": "Flows_Update", + "x-ms-examples": { + "Updates the flow resource": { + "$ref": "examples/patchFlow.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "flow", + "description": "Flow body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/flowsPatch" + } + } + ], + "responses": { + "200": { + "description": "Updated the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Accepted update to the flows resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/flow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/enable": { + "post": { + "description": "Enables the specified flow.", + "x-ms-examples": { + "Enables the specified flow": { + "$ref": "examples/enableOrDisableFlow.json" + } + }, + "operationId": "Flows_Enable", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Enables a flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Enables a flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/disable": { + "post": { + "description": "Disables the specified flow", + "x-ms-examples": { + "Disables the specified flow": { + "$ref": "examples/enableOrDisableFlow.json" + } + }, + "operationId": "Flows_Disable", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Disables a flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Disables a flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/link": { + "post": { + "description": "Links the specified flow.", + "x-ms-examples": { + "Links the specified flow": { + "$ref": "examples/linkFlow.json" + } + }, + "operationId": "Flows_Link", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "flow", + "description": "Flow body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Links a flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Links a flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows": { + "get": { + "description": "Gets flows in a connection.", + "x-ms-examples": { + "Gets flows in a connection": { + "$ref": "examples/listFlowsByConnection.json" + } + }, + "operationId": "Flows_ListByConnection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Listed all flows under the resource group.", + "schema": { + "$ref": "#/definitions/flowsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}": { + "get": { + "description": "Gets connection resource.", + "x-ms-examples": { + "Gets connection resource": { + "$ref": "examples/getConnection.json" + } + }, + "operationId": "Connections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Creates or updates the connection resource.", + "operationId": "Connections_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates the connection resource": { + "$ref": "examples/createOrUpdateConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/connection" + } + } + ], + "responses": { + "200": { + "description": "Created the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "201": { + "description": "Accepted create of the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Deletes the connection resource.", + "x-ms-examples": { + "Deletes the connection resource": { + "$ref": "examples/deleteConnection.json" + } + }, + "operationId": "Connections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted delete the connections resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "204": { + "description": "Deleted the connections resource." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "description": "Updates the connection resource.", + "operationId": "Connections_Update", + "x-ms-examples": { + "Updates the connection resource": { + "$ref": "examples/patchConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/connectionsPatch" + } + } + ], + "responses": { + "200": { + "description": "Updated the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Accepted update to the connections resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/connection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/link": { + "post": { + "description": "Links the connection to its pending connection.", + "x-ms-examples": { + "Links the specified connection": { + "$ref": "examples/linkConnection.json" + } + }, + "operationId": "Connections_Link", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Links a connection.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Links a connection.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingConnections": { + "post": { + "description": "Lists all pending connections for a connection.", + "x-ms-examples": { + "Lists a list of pending connections": { + "$ref": "examples/listPendingConnections.json" + } + }, + "operationId": "ListPendingConnections_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all pending connections.", + "schema": { + "$ref": "#/definitions/pendingConnectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingFlows": { + "post": { + "description": "Lists all pending flows for a connection.", + "x-ms-examples": { + "Lists a list of pending flows": { + "$ref": "examples/listPendingFlows.json" + } + }, + "operationId": "ListPendingFlows_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all connections under the resource group.", + "schema": { + "$ref": "#/definitions/pendingFlowsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections": { + "get": { + "description": "Gets connections in a resource group.", + "x-ms-examples": { + "Gets connections in a resource group": { + "$ref": "examples/listConnectionsByResourceGroup.json" + } + }, + "operationId": "Connections_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all connections under the resource group.", + "schema": { + "$ref": "#/definitions/connectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/connections": { + "get": { + "description": "Gets connections in a subscription.", + "x-ms-examples": { + "Gets connections in a subscription": { + "$ref": "examples/listConnectionsBySubscription.json" + } + }, + "operationId": "Connections_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all connections under the subscription.", + "schema": { + "$ref": "#/definitions/connectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}": { + "get": { + "description": "Gets pipeline resource.", + "x-ms-examples": { + "Gets pipeline resource": { + "$ref": "examples/getPipeline.json" + } + }, + "operationId": "Pipelines_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Creates or updates the pipeline resource.", + "operationId": "Pipelines_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates the pipeline resource": { + "$ref": "examples/createOrUpdatePipeline.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "pipeline", + "description": "Pipeline body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/pipeline" + } + } + ], + "responses": { + "200": { + "description": "Created the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "201": { + "description": "Accepted create of the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Deletes the pipeline resource.", + "x-ms-examples": { + "Deletes the pipeline resource": { + "$ref": "examples/deletePipeline.json" + } + }, + "operationId": "Pipelines_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted delete of the pipelines resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "204": { + "description": "Deleted the pipelines resource." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "description": "Updates the pipeline resource.", + "operationId": "Pipelines_Update", + "x-ms-examples": { + "Updates the pipeline resource": { + "$ref": "examples/patchPipeline.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "pipeline", + "description": "Pipeline body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/pipelinesPatch" + } + } + ], + "responses": { + "200": { + "description": "Updated the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "202": { + "description": "Accepted update to the pipelines resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/approveConnection": { + "post": { + "description": "Approves the specified connection in a pipeline.", + "x-ms-examples": { + "Approves the specified connection in a pipeline": { + "$ref": "examples/approveOrRejectConnection.json" + } + }, + "operationId": "Pipelines_ApproveConnection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Approves a connection.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Approves a connection.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/rejectConnection": { + "post": { + "description": "Rejects the specified connection in a pipeline.", + "x-ms-examples": { + "Rejects the specified connection in a pipeline": { + "$ref": "examples/approveOrRejectConnection.json" + } + }, + "operationId": "Pipelines_RejectConnection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Rejects a connection.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Rejects a connection.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/listSchemas": { + "post": { + "description": "Lists the schemas for the specified connection in a pipeline.", + "x-ms-examples": { + "Lists schemas for a pipeline": { + "$ref": "examples/listSchemas.json" + } + }, + "operationId": "ListSchemas_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "schema", + "description": "Schema(s) to retrieve", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/schema" + } + } + ], + "responses": { + "200": { + "description": "Approves a connection.", + "schema": { + "description": "The schemas for this connection", + "$ref": "#/definitions/schemasListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines": { + "get": { + "description": "Gets pipelines in a resource group.", + "x-ms-examples": { + "Gets pipelines in a resource group": { + "$ref": "examples/listPipelinesByResourceGroup.json" + } + }, + "operationId": "Pipelines_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all pipelines under the resource group.", + "schema": { + "$ref": "#/definitions/pipelinesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/pipelines": { + "get": { + "description": "Gets pipelines in a subscription.", + "x-ms-examples": { + "Gets pipelines in a subscription": { + "$ref": "examples/listPipelinesBySubscription.json" + } + }, + "operationId": "Pipelines_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all pipelines under the subscription.", + "schema": { + "$ref": "#/definitions/pipelinesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.AzureDataTransfer/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/listOperations.json" + } + }, + "description": "Lists all of the available Microsoft.AzureDataTransfer REST API operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all of the available operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "validateSchemaResult": { + "type": "object", + "description": "Result of the schema validation.", + "properties": { + "status": { + "enum": [ + "Succeeded", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "validateSchemaStatus", + "modelAsString": true + }, + "description": "Validation status of the schema" + }, + "message": { + "type": "string", + "description": "Message describing the schema validation" + } + } + }, + "listApprovedSchemasRequest": { + "type": "object", + "properties": { + "pipeline": { + "type": "string", + "description": "The name of the pipeline to filter approved schemas." + }, + "direction": { + "description": "The direction pipeline to filter approved schemas.", + "enum": [ + "Send", + "Receive" + ], + "type": "string", + "x-ms-enum": { + "name": "listApprovedSchemasDirection", + "modelAsString": true + } + } + } + }, + "selectedResource": { + "type": "object", + "description": "A resource selected from ARM", + "properties": { + "name": { + "type": "string", + "description": "Name of the connection" + }, + "id": { + "type": "string", + "description": "Id of the connection" + }, + "location": { + "type": "string", + "description": "Location of the connection", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "subscriptionName": { + "type": "string", + "description": "Name of the subscription with the connection" + } + }, + "required": [ + "id" + ] + }, + "flowProperties": { + "type": "object", + "properties": { + "connection": { + "$ref": "#/definitions/selectedResource", + "description": "The connection associated with this flow" + }, + "flowId": { + "type": "string", + "description": "Dataflow GUID associated with this flow", + "readOnly": true + }, + "keyVaultUri": { + "type": "string", + "description": "AME, PME, or TORUS only! AKV Chain Containing SAS Token" + }, + "linkStatus": { + "enum": [ + "Linked", + "Unlinked" + ], + "type": "string", + "x-ms-enum": { + "name": "linkStatusFlow", + "modelAsString": true + }, + "description": "Link status of the current flow", + "readOnly": true + }, + "linkedFlowId": { + "type": "string", + "description": "Resource ID of the linked flow", + "readOnly": true + }, + "status": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "flowStatus", + "modelAsString": true + }, + "description": "Status of the current flow" + }, + "storageAccountName": { + "type": "string", + "description": "Storage Account" + }, + "storageAccountId": { + "type": "string", + "format": "arm-id", + "description": "Storage Account ID", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "scopes": [ + "*" + ], + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + }, + "storageContainerName": { + "type": "string", + "description": "Storage Container Name" + }, + "serviceBusQueueId": { + "type": "string", + "format": "arm-id", + "description": "Service Bus Queue ID", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "scopes": [ + "*" + ], + "type": "Microsoft.Storage/namespaces/queues" + } + ] + } + }, + "flowType": { + "$ref": "#/definitions/flowType", + "description": "The flow type for this flow" + }, + "dataType": { + "enum": [ + "Blob", + "Table" + ], + "type": "string", + "x-ms-enum": { + "name": "dataType", + "modelAsString": true + }, + "description": "Transfer Storage Blobs or Tables" + }, + "provisioningState": { + "description": "Provisioning state of the flow", + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this flow", + "items": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/schema", + "description": "The selected schema for this flow" + } + }, + "description": "Properties of flow" + }, + "flow": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "$ref": "#/definitions/flowProperties" + }, + "plan": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed identity of the flow resource, if configured." + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "The flow resource definition." + }, + "pendingFlow": { + "type": "object", + "description": "Pending flow object", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Subscription ID of the pending flow.", + "readOnly": true + }, + "connectionId": { + "type": "string", + "description": "Connection ID of the pending flow.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/flowProperties" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "flowsPatch": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed identity of the flow resource, if configured." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "The flows resource patch definition." + }, + "flowsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/flow" + }, + "description": "Flows array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The flows list result." + }, + "connectionProperties": { + "type": "object", + "properties": { + "pipeline": { + "type": "string", + "description": "Pipeline to use to transfer data" + }, + "direction": { + "description": "Direction of data movement", + "enum": [ + "Send", + "Receive" + ], + "type": "string", + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + }, + "justification": { + "type": "string", + "description": "Justification for the connection request" + }, + "status": { + "description": "Status of the connection", + "enum": [ + "InReview", + "Approved", + "Rejected", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "status", + "modelAsString": true + }, + "readOnly": true + }, + "statusReason": { + "type": "string", + "description": "Reason for status", + "readOnly": true + }, + "linkStatus": { + "enum": [ + "Linked", + "Unlinked" + ], + "type": "string", + "x-ms-enum": { + "name": "linkStatus", + "modelAsString": true + }, + "description": "Link status of the current connection", + "readOnly": true + }, + "linkedConnectionId": { + "type": "string", + "description": "Resource ID of the linked connection", + "readOnly": true + }, + "flowTypes": { + "$ref": "#/definitions/flowTypes", + "description": "The flow types being requested for this connection" + }, + "requirementId": { + "description": "Requirement ID of the connection", + "type": "string" + }, + "remoteSubscriptionId": { + "description": "Subscription ID to link cloud subscriptions together", + "type": "string" + }, + "approver": { + "description": "Approver of this connection request", + "type": "string", + "readOnly": true + }, + "pin": { + "description": "PIN to link requests together", + "type": "string" + }, + "dateSubmitted": { + "type": "string", + "format": "date-time", + "description": "The timestamp that this connection request was submitted at", + "readOnly": true + }, + "primaryContact": { + "type": "string", + "description": "The primary contact for this connection request" + }, + "secondaryContacts": { + "type": "array", + "description": "The secondary contacts for this connection request", + "items": { + "type": "string" + } + }, + "provisioningState": { + "description": "Provisioning state of the connection", + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this connection", + "items": { + "type": "string" + } + }, + "schemas": { + "description": "The schemas for this connection", + "$ref": "#/definitions/schemas" + } + }, + "required": [ + "pipeline" + ], + "description": "Properties of connection" + }, + "connection": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "$ref": "#/definitions/connectionProperties" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "The connection resource definition." + }, + "pendingConnection": { + "type": "object", + "description": "Pending connection object", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Subscription ID of the pending connection.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/connectionProperties" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "connectionsPatch": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "The connections resource patch definition." + }, + "connectionsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/connection" + }, + "description": "Connections array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The connections list result." + }, + "pendingConnectionsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/pendingConnection" + }, + "description": "Connections array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The connections list result." + }, + "pendingFlowsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/pendingFlow" + }, + "description": "flows array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The connections list result." + }, + "operationStatusProperties": { + "type": "object", + "description": "Operation status associated with the last patch request", + "properties": { + "status": { + "enum": [ + "Failed", + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "operationStatusEnum", + "modelAsString": true + }, + "description": "Operation status for the last patch request for this connection.", + "readOnly": true + }, + "id": { + "type": "string", + "description": "Operation status ID of the last patch request for this connection.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Message for the operation for the last patch request for this connection.", + "readOnly": true + } + } + }, + "internalMetadataProperties": { + "type": "object", + "description": "Internal metadata of the connection inside pipeline.", + "properties": { + "operationStatus": { + "$ref": "#/definitions/operationStatusProperties" + }, + "statusSetBy": { + "type": "string", + "description": "User that last set the approved status for this connection", + "readOnly": true + } + }, + "additionalProperties": {} + }, + "pipelineConnection": { + "description": "Connection body inside a pipeline", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Connection id inside pipeline" + }, + "name": { + "type": "string", + "description": "Connection name inside pipeline", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Connection type inside pipeline", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Connection location inside pipeline", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "etag": { + "type": "string", + "description": "Connection etag inside pipeline", + "readOnly": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + }, + "properties": { + "type": "object", + "description": "Connection properties inside pipeline", + "properties": { + "internalMetadata": { + "$ref": "#/definitions/internalMetadataProperties" + } + }, + "additionalProperties": {} + } + }, + "additionalProperties": {}, + "required": [ + "id" + ] + }, + "pipelineProperties": { + "type": "object", + "properties": { + "remoteCloud": { + "type": "string", + "description": "Remote cloud of the data to be transferred or received" + }, + "displayName": { + "type": "string", + "description": "Display name of this pipeline" + }, + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/pipelineConnection" + }, + "description": "Connections associated with pipeline", + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + }, + "subscribers": { + "type": "array", + "items": { + "$ref": "#/definitions/subscriber" + }, + "x-ms-identifiers": [], + "description": "Subscribers of this resource" + }, + "provisioningState": { + "description": "Provisioning state of the pipeline", + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this pipeline", + "items": { + "type": "string" + } + }, + "flowTypes": { + "$ref": "#/definitions/flowTypes", + "description": "The flow types allowed for this pipeline" + } + }, + "required": [ + "remoteCloud" + ], + "description": "Properties of pipeline" + }, + "pipeline": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "$ref": "#/definitions/pipelineProperties" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "The pipeline resource definition." + }, + "pipelinesPatch": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/pipelineConnection" + }, + "description": "Connections associated with pipeline", + "x-ms-identifiers": [ + "id" + ] + }, + "flowTypes": { + "$ref": "#/definitions/flowTypes", + "description": "The flow types allowed for this pipeline" + } + }, + "description": "Properties of pipelines patch body." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "The pipelines resource patch definition." + }, + "pipelinesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/pipeline" + }, + "description": "Pipelines array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The pipelines list result." + }, + "subscriber": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "Email of the subscriber" + }, + "notifications": { + "type": "integer", + "format": "int64", + "description": "Number specifying what notifications to receive" + } + } + }, + "schemas": { + "type": "array", + "description": "The schemas for this connection", + "x-ms-identifiers": [ + "connectionId", + "name" + ], + "items": { + "$ref": "#/definitions/schema" + } + }, + "schema": { + "type": "object", + "description": "The schema object.", + "properties": { + "id": { + "type": "string", + "description": "ID associated with this schema" + }, + "connectionId": { + "type": "string", + "description": "Connection ID associated with this schema" + }, + "status": { + "enum": [ + "New", + "Approved" + ], + "type": "string", + "x-ms-enum": { + "name": "schemaStatus", + "modelAsString": true + }, + "description": "Status of the schema" + }, + "name": { + "type": "string", + "description": "Name of the schema" + }, + "content": { + "type": "string", + "description": "Content of the schema" + } + } + }, + "schemasListResult": { + "type": "object", + "properties": { + "value": { + "description": "Schemas array.", + "$ref": "#/definitions/schemas" + } + }, + "description": "The schemas list result." + }, + "flowTypes": { + "type": "array", + "description": "The flow types that are allowed for this resource", + "items": { + "$ref": "#/definitions/flowType" + } + }, + "flowType": { + "enum": [ + "Unknown", + "Complex", + "DevSecOps", + "Messaging", + "Mission", + "MicrosoftInternal", + "BasicFiles", + "Data" + ], + "type": "string", + "x-ms-enum": { + "name": "flowType", + "modelAsString": true + }, + "description": "Flow type for the specified resource" + }, + "resourceBody": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the resource." + }, + "statusReason": { + "type": "string", + "description": "Reason for resource operation." + } + }, + "required": [ + "id" + ], + "description": "The resource to reference." + } + }, + "parameters": { + "flowNameParameter": { + "x-ms-parameter-location": "method", + "name": "flowName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$", + "maxLength": 64, + "minLength": 3, + "description": "The name for the flow that is to be onboarded." + }, + "connectionNameParameter": { + "x-ms-parameter-location": "method", + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$", + "maxLength": 64, + "minLength": 3, + "description": "The name for the connection that is to be requested." + }, + "pipelineNameParameter": { + "x-ms-parameter-location": "method", + "name": "pipelineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$", + "maxLength": 64, + "minLength": 3, + "description": "The name for the pipeline that is to be requested." + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/approveOrRejectConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/approveOrRejectConnection.json new file mode 100644 index 000000000000..705b2389de68 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/approveOrRejectConnection.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "statusReason": "Example reason" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2023-10-11-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/createOrUpdateConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/createOrUpdateConnection.json new file mode 100644 index 000000000000..713dec2d9105 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/createOrUpdateConnection.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": { + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + }, + "location": "East US" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/createOrUpdateFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/createOrUpdateFlow.json new file mode 100644 index 000000000000..557facfa1ce2 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/createOrUpdateFlow.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "flow": { + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + } + }, + "location": "East US" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/createOrUpdatePipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/createOrUpdatePipeline.json new file mode 100644 index 000000000000..7282647b72d0 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/createOrUpdatePipeline.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": { + "properties": { + "remoteCloud": "testdc" + }, + "location": "East US" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/deleteConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/deleteConnection.json new file mode 100644 index 000000000000..768ad98de2fa --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/deleteConnection.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2023-10-11-preview" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/deleteFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/deleteFlow.json new file mode 100644 index 000000000000..9a6d1941311b --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/deleteFlow.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2023-10-11-preview" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/deletePipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/deletePipeline.json new file mode 100644 index 000000000000..5ccd7d9136ee --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/deletePipeline.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2023-10-11-preview" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/enableOrDisableFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/enableOrDisableFlow.json new file mode 100644 index 000000000000..95e8dc6b404d --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/enableOrDisableFlow.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2023-10-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/getConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/getConnection.json new file mode 100644 index 000000000000..14a651e53077 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/getConnection.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connection/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/getFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/getFlow.json new file mode 100644 index 000000000000..bcaa70ae6669 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/getFlow.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/getPipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/getPipeline.json new file mode 100644 index 000000000000..3a519f345369 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/getPipeline.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/linkConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/linkConnection.json new file mode 100644 index 000000000000..4b7f998580ab --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/linkConnection.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connection", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2023-10-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/linkFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/linkFlow.json new file mode 100644 index 000000000000..c5c89effa176 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/linkFlow.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "flow": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2023-10-11-preview" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listConnectionsByResourceGroup.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listConnectionsByResourceGroup.json new file mode 100644 index 000000000000..aa5ca3af63ff --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listConnectionsByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + }, + { + "name": "testConnection2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listConnectionsBySubscription.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listConnectionsBySubscription.json new file mode 100644 index 000000000000..0faa21bc5dfe --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listConnectionsBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + }, + { + "name": "testConnection2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listFlowsByConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listFlowsByConnection.json new file mode 100644 index 000000000000..218121abf4af --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listFlowsByConnection.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "connectionName": "testConnection", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + } + } + }, + { + "name": "testConnection2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + } + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listOperations.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listOperations.json new file mode 100644 index 000000000000..3120aa85c46a --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listOperations.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "teleportalClient", + "api-version": "2023-10-11-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureDataTransfer/read", + "display": { + "provider": "CTS Experience", + "resource": "Flow", + "operation": "Read flows", + "description": "Read flows" + } + }, + { + "name": "Microsoft.AzureDataTransfer/write", + "display": { + "provider": "CTS Experience", + "resource": "Flow", + "operation": "Update flows", + "description": "Update flows" + } + }, + { + "name": "Microsoft.AzureDataTransfer/delete", + "display": { + "provider": "CTS Experience", + "resource": "Flow", + "operation": "Delete flows", + "description": "Delete flows" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPendingConnections.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPendingConnections.json new file mode 100644 index 000000000000..58bfb075dc78 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPendingConnections.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "connectionName": "testConnection", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "location": "East US", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + }, + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "location": "East US", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPendingFlows.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPendingFlows.json new file mode 100644 index 000000000000..07de65291538 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPendingFlows.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "connectionName": "testConnection", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testFlow", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob" + }, + { + "name": "testInstallation2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPipelinesByResourceGroup.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPipelinesByResourceGroup.json new file mode 100644 index 000000000000..d643fb0b457f --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPipelinesByResourceGroup.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPipeline", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + }, + { + "name": "testPipeline2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPipelinesBySubscription.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPipelinesBySubscription.json new file mode 100644 index 000000000000..9583b6d84538 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listPipelinesBySubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPipeline", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + }, + { + "name": "testPipeline2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listSchemas.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listSchemas.json new file mode 100644 index 000000000000..9c4aa753bba9 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/listSchemas.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "schema": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "name": "test.xsd" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test.xsd", + "content": "xsd content" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/patchConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/patchConnection.json new file mode 100644 index 000000000000..25321f7be09c --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/patchConnection.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": {}, + "tags": { + "tag": "value" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2023-10-11-preview" + }, + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + }, + "200": { + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/patchFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/patchFlow.json new file mode 100644 index 000000000000..1839646db644 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/patchFlow.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "flow": {}, + "tags": { + "tag": "value" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2023-10-11-preview" + }, + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + } + } + } + }, + "200": { + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + } + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/patchPipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/patchPipeline.json new file mode 100644 index 000000000000..cf0f045fd8ed --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/patchPipeline.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2023-10-11-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": {}, + "tags": { + "tag": "value" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2023-10-11-preview" + }, + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + }, + "200": { + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/postListApprovedSchemas.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/postListApprovedSchemas.json new file mode 100644 index 000000000000..6823f20b039d --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/postListApprovedSchemas.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-10-11-preview", + "pipeline": { + "pipeline": "test", + "direction": "Send" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test.xsd", + "content": "xsd content" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/postValidateSchema.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/postValidateSchema.json new file mode 100644 index 000000000000..78e933f2393f --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/preview/2023-10-11-preview/examples/postValidateSchema.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-11-preview", + "schema": { + "name": "schema.xml" + } + }, + "responses": { + "200": { + "body": { + "status": "Failed", + "message": "Validation failed" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/readme.az.md b/specification/azuredatatransfer/resource-manager/readme.az.md new file mode 100644 index 000000000000..0cd06f8c05cb --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/readme.az.md @@ -0,0 +1,28 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +For new Resource Provider. It is highly recommended to onboard Azure CLI extensions. There's no differences in terms of customer usage. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: azuredatatransfer + namespace: azure.mgmt.azuredatatransfer + package-name: azure-mgmt-azuredatatransfer +az-output-folder: $(azure-cli-extension-folder)/src/azuredatatransfer +python-sdk-output-folder: "$(az-output-folder)/azext_azuredatatransfer/vendored_sdks/azuredatatransfer" +# add additional configuration here specific for Azure CLI +# refer to the faq.md for more details +``` + + + +This is for command modules that already in azure cli main repo. +``` yaml $(az) && $(target-mode) == 'core' +az: + extensions: azuredatatransfer + namespace: azure.mgmt.azuredatatransfer + package-name: azure-mgmt-azuredatatransfer +az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/azuredatatransfer +python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/azuredatatransfer" +``` \ No newline at end of file diff --git a/specification/azuredatatransfer/resource-manager/readme.cli.md b/specification/azuredatatransfer/resource-manager/readme.cli.md new file mode 100644 index 000000000000..c6cf6ad37ea4 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/readme.cli.md @@ -0,0 +1 @@ +## CLI Common Settings for all the command line tools \ No newline at end of file diff --git a/specification/azuredatatransfer/resource-manager/readme.csharp.md b/specification/azuredatatransfer/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..00705786c763 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.AzureDataTransfer + output-folder: $(csharp-sdks-folder)/azuredatatransfer/management/Microsoft.AzureDataTransfer/GeneratedProtocol +``` diff --git a/specification/azuredatatransfer/resource-manager/readme.go.md b/specification/azuredatatransfer/resource-manager/readme.go.md new file mode 100644 index 000000000000..f23afe971379 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/azuredatatransfer/armazuredatatransfer +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +``` diff --git a/specification/azuredatatransfer/resource-manager/readme.md b/specification/azuredatatransfer/resource-manager/readme.md new file mode 100644 index 000000000000..107e12c1a304 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/readme.md @@ -0,0 +1,79 @@ +# azuredatatransfer + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for azuredatatransfer. + +## 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 azuredatatransfer. + +```yaml +openapi-type: arm +openapi-subtype: rpaas +tag: package-2023-10-11-preview +``` + +### Tag: package-2023-10-11-preview + +These settings apply only when `--tag=package-2023-10-11-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-10-11-preview' +input-file: + - Microsoft.AzureDataTransfer/preview/2023-10-11-preview/azuredatatransfer.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-java + - repo: azure-sdk-for-go + - 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) diff --git a/specification/azuredatatransfer/resource-manager/readme.python.md b/specification/azuredatatransfer/resource-manager/readme.python.md new file mode 100644 index 000000000000..3e4a01a3d110 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/readme.python.md @@ -0,0 +1,18 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-azuredatatransfer +namespace: azure.mgmt.azuredatatransfer +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/azuredatatransfer/azure-mgmt-azuredatatransfer/azure/mgmt/azuredatatransfer +``` diff --git a/specification/azuredatatransfer/resource-manager/readme.typescript.md b/specification/azuredatatransfer/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..5d9625774fa3 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-azuredatatransfer" + output-folder: "$(typescript-sdks-folder)/sdk/azuredatatransfer/arm-azuredatatransfer" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +``` diff --git a/specification/azurelargeinstance/AzureLargeInstance.Management/models.tsp b/specification/azurelargeinstance/AzureLargeInstance.Management/models.tsp index fec1d1c51610..10911950f164 100644 --- a/specification/azurelargeinstance/AzureLargeInstance.Management/models.tsp +++ b/specification/azurelargeinstance/AzureLargeInstance.Management/models.tsp @@ -11,252 +11,266 @@ namespace Microsoft.AzureLargeInstance; interface Operations extends Azure.ResourceManager.Operations {} @doc("Enum of the hardware options (vendor and/or their product name) for an Azure Large Instance") -enum AzureLargeInstanceHardwareTypeNamesEnum { +union AzureLargeInstanceHardwareTypeNamesEnum { + string, + @doc("Hardware type of UCS from vendor Cisco") - Cisco_UCS, + "Cisco_UCS", @doc("Hardware type of HPE from vendor Hewlett Packard Enterprise") - HPE, + "HPE", @doc("Hardware type of SDFLEX") - SDFLEX, + "SDFLEX", } @doc("Enum of available model types (each of which have their own storage / memory sizes) for an Azure Large Instance type. See https://docs.microsoft.com/azure/sap/large-instances/hana-available-skus") -enum AzureLargeInstanceSizeNamesEnum { +union AzureLargeInstanceSizeNamesEnum { + string, + @doc("Type I class SKU that can't be purchased anymore") - S72m, + "S72m", @doc("Type I class SKU that can't be purchased anymore") - S144m, + "S144m", @doc("Type I class SKU that can't be purchased anymore") - S72, + "S72", @doc("Type I class SKU that can't be purchased anymore") - S144, + "S144", @doc("Type I class SKU that can't be purchased anymore") - S192, + "S192", @doc("Type I class SKU that can't be purchased anymore") - S192m, + "S192m", @doc("Type I class SKU that can't be purchased anymore") - S192xm, + "S192xm", @doc("2 sockets, 96 CPU threads, 48 CPU cores, 768 GB total memory, 768 GB DRAM, 3.0 TB storage, Cisco_UCS hardware type") - S96, + "S96", @doc("No longer offered or used.") - S112, + "S112", @doc("4 sockets, 224 CPU threads, 112 CPU cores, 3 TB total memory, 3 TB DRAM, 6.3 TB storage, Cisco_UCS hardware type") - S224, + "S224", @doc("4 sockets, 224 CPU threads, 112 CPU cores, 6 TB total memory, 6 TB DRAM, 10.5 TB storage, Cisco_UCS hardware type") - S224m, + "S224m", @doc("4 sockets, 224 CPU threads, 112 CPU cores, 6 TB total memory, 3 TB DRAM, 3 TB memory optane, 10.5 TB storage, Cisco_UCS hardware type") - S224om, + "S224om", @doc("4 sockets, 224 CPU threads, 112 CPU cores, 4.5 TB total memory, 1.5 TB DRAM, 3 TB memory optane, 8.4 TB storage, Cisco_UCS hardware type") - S224oo, + "S224oo", @doc("4 sockets, 224 CPU threads, 112 CPU cores, 9 TB total memory, 3 TB DRAM, 6 TB memory optane, 14.8 TB storage, Cisco_UCS hardware type") - S224oom, + "S224oom", @doc("4 sockets, 224 CPU threads, 112 CPU cores, 7.5TB total memory, 1.5 TB DRAM, 6 TB memory optane, 12.7 TB storage, Cisco_UCS hardware type") - S224ooo, + "S224ooo", @doc("4 sockets, 448 CPU threads, 6 TB total memory, SDFLEX hardware type") - S224se, + "S224se", @doc("8 sockets, 384 CPU threads, 192 CPU cores, 4 TB total memory, 4 TB DRAM, 16 TB storage, HPEMc990x hardware type") - S384, + "S384", @doc("8 sockets, 384 CPU threads, 192 CPU cores, 6 TB total memory, 6 TB DRAM, 18 TB storage, HPEMc990x hardware type") - S384m, + "S384m", @doc("8 sockets, 384 CPU threads, 192 CPU cores, 8 TB total memory, 8 TB DRAM, 22 TB storage, HPEMc990x hardware type") - S384xm, + "S384xm", @doc("8 sockets, 384 CPU threads, 12 TB total memory, HPEMc990x hardware type") - S384xxm, + "S384xxm", @doc("8 sockets, 448 CPU threads, 224 CPU cores, 6 TB total memory, 6 TB DRAM, 10.5 TB storage, SDFLEX hardware type") - S448, + "S448", @doc("8 sockets, 448 CPU threads, 224 CPU cores, 12 TB total memory, 12 TB DRAM, 18.9 TB storage, SDFLEX hardware type") - S448m, + "S448m", @doc("8 sockets, 448 CPU threads, 224 CPU cores, 12 TB total memory, 6 TB DRAM, 6 TB memory optane, 18.9 TB storage, SDFLEX hardware type") - S448om, + "S448om", @doc("8 sockets, 448 CPU threads, 224 CPU cores, 9 TB total memory, 3 TB DRAM, 6 TB memory optane, 14.8 TB storage, SDFLEX hardware type") - S448oo, + "S448oo", @doc("8 sockets, 448 CPU threads, 224 CPU cores, 18 TB total memory, 6 TB DRAM, 12 memory optane, 27.4 TB storage, SDFLEX hardware type") - S448oom, + "S448oom", @doc("8 sockets, 448 CPU threads, 224 CPU cores, 15 TB total memory, 3 TB DRAM, 12 memory optane, 23.2 TB storage, SDFLEX hardware type") - S448ooo, + "S448ooo", @doc("8 sockets, 448 CPU threads, 12 TB total memory, SDFLEX hardware type") - S448se, + "S448se", @doc("12 sockets, 576 CPU threads, 288 CPU cores, 12 TB total memory, 12 TB DRAM, 28 TB storage, HPEMc990x hardware type") - S576m, + "S576m", @doc("12 sockets, 576 CPU threads, 288 CPU cores, 18 TB total memory, HPEMc990x hardware type") - S576xm, + "S576xm", @doc("12 sockets, 672 CPU threads, 336 CPU cores, 9 TB total memory, 9 TB DRAM, 14.7 TB storage, SDFLEX hardware type") - S672, + "S672", @doc("12 sockets, 672 CPU threads, 336 CPU cores, 18 TB total memory, 18 TB DRAM, 27.4 TB storage, SDFLEX hardware type") - S672m, + "S672m", @doc("12 sockets, 672 CPU threads, 336 CPU cores, 18 TB total memory, 9 TB DRAM, 9 TB memory optane, 27.4 TB storage, SDFLEX hardware type") - S672om, + "S672om", @doc("12 sockets, 672 CPU threads, 336 CPU cores, 13.5 TB total memory, 4.5 TB DRAM, 9 TB memory optane, 21.1 TB storage, SDFLEX hardware type") - S672oo, + "S672oo", @doc("12 sockets, 672 CPU threads, 336 CPU cores, 27 TB total memory, 9 TB DRAM, 18 TB memory optane, 40 TB storage, SDFLEX hardware type") - S672oom, + "S672oom", @doc("12 sockets, 672 CPU threads, 336 CPU cores, 22.5 TB total memory, 4.5 TB DRAM, 18 TB memory optane, 33.7 TB storage, SDFLEX hardware type") - S672ooo, + "S672ooo", @doc("No longer offered or used.") - S768, + "S768", @doc("16 sockets, 768 CPU threads, 384 CPU cores, 16 TB total memory, 16 TB DRAM, 36 TB storage, HPEMc990x hardware type") - S768m, + "S768m", @doc("16 sockets, 768 CPU threads, 384 CPU cores, 24 TB total memory, 24 TB DRAM, 56 TB storage, HPEMc990x hardware type") - S768xm, + "S768xm", @doc("16 sockets, 896 CPU threads, 448 CPU cores, 12 TB total memory, 12 TB DRAM, 18.9 TB storage, SDFLEX hardware type") - S896, + "S896", @doc("16 sockets, 896 CPU threads, 448 CPU cores, 24 TB total memory, 24 TB DRAM, 35.8 TB storage, SDFLEX hardware type") - S896m, + "S896m", @doc("16 sockets, 896 CPU threads, 448 CPU cores, 24 TB total memory, 12 TB DRAM, 12 TB memory optane, 35.8 TB storage, SDFLEX hardware type") - S896om, + "S896om", @doc("16 sockets, 896 CPU threads, 448 CPU cores, 18 TB total memory, 6 TB DRAM, 12 TB memory optane, 27.4 TB storage, SDFLEX hardware type") - S896oo, + "S896oo", @doc("16 sockets, 896 CPU threads, 448 CPU cores, 36 TB total memory, 12 TB DRAM, 24 TB memory optane, 52.7 TB storage, SDFLEX hardware type") - S896oom, + "S896oom", @doc("16 sockets, 896 CPU threads, 448 CPU cores, 30 TB total memory, 6 TB DRAM, 24 TB memory optane, 44.3 TB storage, SDFLEX hardware type") - S896ooo, + "S896ooo", @doc("20 sockets, 960 CPU threads, 480 CPU cores, 20 TB total memory, 20 TB DRAM, 46 TB storage, HPEMc990x hardware type") - S960m, + "S960m", } @doc("Power states that an Azure Large Instance can be in") -enum AzureLargeInstancePowerStateEnum { +union AzureLargeInstancePowerStateEnum { + string, + @doc("Starting means that the Azure Large Instance resource is turning on.") - starting, + "starting", @doc("Started means that the Azure Large Instance resource has been powered on.") - started, + "started", @doc("Stopping means that the Azure Large Instance resource is shutting down.") - stopping, + "stopping", @doc("Stopped means that the Azure Large Instance resource has shut down.") - stopped, + "stopped", @doc("Restarting means that the Azure Large Instance resource is restarting.") - restarting, + "restarting", @doc("Unknown means that the state of the Azure Large Instance is unknown.") - `unknown`, + "unknown", } @doc("Provisioning states that an Azure Large Instance can be in") -enum AzureLargeInstanceProvisioningStatesEnum { +union AzureLargeInstanceProvisioningStatesEnum { + string, + @doc("Accepted means Azure Large Instance resource provisioning has been accepted.") - Accepted, + Accepted: "Accepted", @doc("Creating means Azure Large Instance resource is being created.") - Creating, + Creating: "Creating", @doc("Updating means an existing Azure Large Instance resource is being updated") - Updating, + Updating: "Updating", @doc("Failed means Azure Large Instance resource is in failed state") - Failed, + Failed: "Failed", @doc("Succeeded means Azure Large Instance resource creation succeeded during last create/update") - Succeeded, + Succeeded: "Succeeded", @doc("Deleting means Azure Large Instance resource is in the process of being deleted") - Deleting, + Deleting: "Deleting", @doc("Migrating means Azure Large Instance resource is being migrated from one subscription or resource group to another") - Migrating, + Migrating: "Migrating", @doc("Cancelled Azure Large Instance resource operation has been cancelled") - Canceled, + Canceled: "Canceled", } @doc("The type of identity that created the resource: User, Application, ManagedIdentity") -enum CreatedByType { +union CreatedByType { + string, + @doc("An AAD user. The createdByType/lastModifiedBy property will be a user principal name (email address).") - User, + "User", @doc("An AAD application. The createdByType/lastModifiedBy property will be the Application Id.") - Application, + "Application", @doc("A Managed Identity. The createdByType/lastModifiedBy property will be the ManagedIdentity resource Id") - ManagedIdentity, + "ManagedIdentity", @doc("A key") - Key, + "Key", } @doc("Enum of two possible values to determine if the ALI instance restart operation should forcefully terminate and halt any existing processes that may be running on the server or not.") -enum AzureLargeInstanceForcePowerState { +union AzureLargeInstanceForcePowerState { + string, + @doc("Active means that the restart operation will terminate and halt existing processes that may be running on the server") - active, + "active", @doc("Inactive means that the restart operation will not terminate and halt existing processes that may be running on the server") - inactive, + "inactive", } @doc("An enum of possible operation states for an AzureLargeStorageInstances") -enum ProvisioningState { +union ProvisioningState { + string, + @doc("Accepted means ARM resource has been accepted.") - Accepted, + "Accepted", @doc("Creating means ARM resource is being created.") - Creating, + "Creating", @doc("Updating means an existing ARM resource is being updated") - Updating, + "Updating", @doc("Failed means resource is in failed state") - Failed, + "Failed", @doc("Succeeded means resource creation succeeded during last create/update") - Succeeded, + "Succeeded", @doc("Deleting means resource is in the process of being deleted") - Deleting, + "Deleting", @doc("Cancelled means resource operation has been cancelled") - Canceled, + "Canceled", @doc("Migrating means resource is being migrated from one subscription or resource group to another") - Migrating, + "Migrating", } @doc("Describes the properties of an Azure Large Instance.") @@ -376,7 +390,7 @@ model IpAddress { ipAddress?: string; } -@doc(""" +@doc(""" The active state empowers the server with the ability to forcefully terminate and halt any existing processes that may be running on the server """) diff --git a/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/azurelargeinstance.json b/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/azurelargeinstance.json index 5da3b86ec36b..b32cbc128785 100644 --- a/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/azurelargeinstance.json +++ b/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/preview/2023-07-20-preview/azurelargeinstance.json @@ -64,7 +64,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } @@ -103,7 +103,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AzureLargeInstanceListResult" } @@ -142,7 +142,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AzureLargeStorageInstanceListResult" } @@ -184,7 +184,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AzureLargeInstanceListResult" } @@ -234,7 +234,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AzureLargeInstance" } @@ -289,7 +289,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AzureLargeInstance" } @@ -535,7 +535,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AzureLargeStorageInstanceListResult" } @@ -585,7 +585,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AzureLargeStorageInstance" } @@ -640,7 +640,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AzureLargeStorageInstance" } diff --git a/specification/azurelargeinstance/resource-manager/readme.java.md b/specification/azurelargeinstance/resource-manager/readme.java.md new file mode 100644 index 000000000000..694afd54f345 --- /dev/null +++ b/specification/azurelargeinstance/resource-manager/readme.java.md @@ -0,0 +1,9 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +title: LargeInstanceMgmtClient +service-name: Large Instance +client-flattened-annotation-target: disabled +``` diff --git a/specification/azurelargeinstance/resource-manager/readme.md b/specification/azurelargeinstance/resource-manager/readme.md index 573576192327..93cf895814e5 100644 --- a/specification/azurelargeinstance/resource-manager/readme.md +++ b/specification/azurelargeinstance/resource-manager/readme.md @@ -29,6 +29,11 @@ openapi-type: arm tag: package-2023-07-20-preview ``` +``` yaml +modelerfour: + flatten-models: false +``` + ### Tag: package-2023-07-20-preview These settings apply only when `--tag=package-2023-07-20-preview` is specified on the command line. diff --git a/specification/azurelargeinstance/resource-manager/readme.python.md b/specification/azurelargeinstance/resource-manager/readme.python.md index 6772853b3e9e..fa7f0ea3e42c 100644 --- a/specification/azurelargeinstance/resource-manager/readme.python.md +++ b/specification/azurelargeinstance/resource-manager/readme.python.md @@ -4,6 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. ``` yaml $(python) +title: LargeInstanceMgmtClient azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-azurelargeinstance diff --git a/specification/azurelargeinstance/resource-manager/readme.typescript.md b/specification/azurelargeinstance/resource-manager/readme.typescript.md index 612c73d95356..2245541d38bb 100644 --- a/specification/azurelargeinstance/resource-manager/readme.typescript.md +++ b/specification/azurelargeinstance/resource-manager/readme.typescript.md @@ -4,11 +4,31 @@ These settings apply only when `--typescript` is specified on the command line. Please also specify `--typescript-sdks-folder=`. ``` yaml $(typescript) +title: LargeInstanceManagementClient typescript: azure-arm: true - package-name: "@azure/arm-azurelargeinstance" - output-folder: "$(typescript-sdks-folder)/sdk/azurelargeinstance/arm-azurelargeinstance" + package-name: "@azure/arm-largeinstance" + output-folder: "$(typescript-sdks-folder)/sdk/largeinstance/arm-largeinstance" payload-flattening-threshold: 1 clear-output-folder: true generate-metadata: true + +directive: + - from: azurelargeinstance.json + where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureLargeInstance/azureLargeInstances/{azureLargeInstanceName}"].patch.parameters' + transform: > + for (const param of $) { + if (param['name'] == 'tagsParameter') { + delete param["x-ms-client-name"] + } + } + - from: azurelargeinstance.json + where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureLargeInstance/azureLargeStorageInstances/{azureLargeStorageInstanceName}"].patch.parameters' + transform: > + for (const param of $) { + if (param['name'] == 'tagsParameter') { + delete param["x-ms-client-name"] + } + } + ``` diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-08-01-preview/extensions_chat_completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-08-01-preview/extensions_chat_completions.json index 5265df25b2e6..5aa5aebb5803 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-08-01-preview/extensions_chat_completions.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-08-01-preview/extensions_chat_completions.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "key": "{search admin key}", "indexName": "{index name}" } diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-09-01-preview/extensions_chat_completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-09-01-preview/extensions_chat_completions.json index dbaca3214431..7df840fc4769 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-09-01-preview/extensions_chat_completions.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-09-01-preview/extensions_chat_completions.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "key": "{search admin key}", "indexName": "{index name}" } diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json index 24d661ad76fd..effee4f8f5a7 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json index 0968a3dbea37..269dde63613b 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "authentication": { "type": "UserAssignedManagedIdentity", "managedIdentityResourceId": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json index 860e6e9e4b22..5c04637a4eb4 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "indexName": "{index name}", "queryType": "vector", "fieldsMapping": { diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_minimum.json index 6979c66744f7..378e5e33c51e 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_minimum.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_minimum.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "indexName": "{index name}" } } diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json index d2d8295cefa8..6d34d089490b 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -32,6 +28,9 @@ "deploymentName": "{embedding deployment name}" }, "fieldsMapping": { + "contentFields": [ + "content" + ], "vectorFields": [ "contentvector" ] diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_elasticsearch.json index 01680301b679..db3ea789f8d5 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_elasticsearch.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_elasticsearch.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "Elasticsearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", "indexName": "{index name}", "authentication": { "type": "KeyAndKeyId", diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_pinecone.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_pinecone.json index 2cbd35ec2ab5..3cac930b509b 100644 --- a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_pinecone.json +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_pinecone.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -22,7 +18,7 @@ "parameters": { "authentication": { "type": "APIKey", - "apiKey": "{api key}" + "key": "{api key}" }, "environment": "{environment name}", "indexName": "{index name}", diff --git a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp index 1e68921410b1..536752d25067 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp @@ -51,7 +51,7 @@ model AudioTranscriptionOptions { @doc(""" The requested format of the transcription response data, which will influence the content and detail of the result. """) - @projectedName("json", "response_format") + @encodedName("application/json", "response_format") responseFormat?: AudioTranscriptionFormat; @doc(""" @@ -109,16 +109,16 @@ model AudioTranscriptionSegment { temperature: float32; @doc("The average log probability associated with this audio segment.") - @projectedName("json", "avg_logprob") + @encodedName("application/json", "avg_logprob") @projectedName("csharp", "AverageLogProbability") avgLogprob: float32; @doc("The compression ratio of this audio segment.") - @projectedName("json", "compression_ratio") + @encodedName("application/json", "compression_ratio") compressionRatio: float32; @doc("The probability of no speech detection within this audio segment.") - @projectedName("json", "no_speech_prob") + @encodedName("application/json", "no_speech_prob") @projectedName("csharp", "NoSpeechProbability") noSpeechProb: float32; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp index d2a09137b0df..113f78a8899c 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp @@ -51,7 +51,7 @@ model AudioTranslationOptions { @doc(""" The requested format of the translation response data, which will influence the content and detail of the result. """) - @projectedName("json", "response_format") + @encodedName("application/json", "response_format") responseFormat?: AudioTranslationFormat; @doc(""" @@ -102,16 +102,16 @@ model AudioTranslationSegment { temperature: float32; @doc("The average log probability associated with this audio segment.") - @projectedName("json", "avg_logprob") + @encodedName("application/json", "avg_logprob") @projectedName("csharp", "AverageLogProbability") avgLogprob: float32; @doc("The compression ratio of this audio segment.") - @projectedName("json", "compression_ratio") + @encodedName("application/json", "compression_ratio") compressionRatio: float32; @doc("The probability of no speech detection within this audio segment.") - @projectedName("json", "no_speech_prob") + @encodedName("application/json", "no_speech_prob") @projectedName("csharp", "NoSpeechProbability") noSpeechProb: float32; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp index ec4416042ad5..3a0f2c06aa79 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp @@ -46,11 +46,9 @@ enum ContentFilterSeverity { @doc("Information about filtered content severity level and if it has been filtered or not.") model ContentFilterResult { @doc("Ratings for the intensity and risk level of filtered content.") - @projectedName("json", "severity") severity: ContentFilterSeverity; @doc("A value indicating whether or not the content has been filtered.") - @projectedName("json", "filtered") filtered: boolean; } @@ -82,7 +80,7 @@ alias ContentFilterResultsBase = { Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself. """) - @projectedName("json", "self_harm") + @encodedName("application/json", "self_harm") selfHarm?: ContentFilterResult; @added(ServiceApiVersions.v2023_12_01_Preview) @@ -90,7 +88,7 @@ alias ContentFilterResultsBase = { profanity?: ContentFilterDetectionResult; @added(ServiceApiVersions.v2023_12_01_Preview) - @projectedName("json", "custom_blocklists") + @encodedName("application/json", "custom_blocklists") @doc("Describes detection results against configured custom blocklists.") customBlocklists?: ContentFilterBlocklistIdResult[]; @@ -117,12 +115,12 @@ model ContentFilterResultsForChoice { ...ContentFilterResultsBase; @added(ServiceApiVersions.v2023_12_01_Preview) - @projectedName("json", "protected_material_text") + @encodedName("application/json", "protected_material_text") @doc("Information about detection of protected text material.") protectedMaterialText?: ContentFilterDetectionResult; @added(ServiceApiVersions.v2023_12_01_Preview) - @projectedName("json", "protected_material_code") + @encodedName("application/json", "protected_material_code") @doc("Information about detection of protected code material.") protectedMaterialCode?: ContentFilterCitedDetectionResult; } @@ -133,11 +131,11 @@ Content filtering results for a single prompt in the request. """) model ContentFilterResultsForPrompt { @doc("The index of this prompt in the set of prompt results") - @projectedName("json", "prompt_index") + @encodedName("application/json", "prompt_index") promptIndex: int32; @doc("Content filtering results for this prompt") - @projectedName("json", "content_filter_results") + @encodedName("application/json", "content_filter_results") contentFilterResults: ContentFilterResultDetailsForPrompt; } @@ -156,7 +154,7 @@ model ContentFilterDetectionResult { model ContentFilterCitedDetectionResult { ...ContentFilterDetectionResult; - @projectedName("json", "URL") + @encodedName("application/json", "URL") @doc("The internet location associated with the detection.") url?: url; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp index e1380c7171c6..2aa9f37b49ff 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp @@ -58,7 +58,6 @@ model ChatCompletionsOptions { the behavior of the assistant, followed by alternating messages between the User and Assistant roles. """) - @projectedName("json", "messages") messages: ChatRequestMessage[]; @doc("A list of functions the model may generate JSON inputs for.") @@ -72,13 +71,13 @@ model ChatCompletionsOptions { Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. "none" is the default when no functions are present. "auto" is the default if functions are present. """) - @projectedName("json", "function_call") + @encodedName("application/json", "function_call") @added(ServiceApiVersions.v2023_07_01_Preview) @removed(ServiceApiVersions.v2023_12_01_Preview) functionCall?: FunctionCallConfig; @doc("The maximum number of tokens to generate.") - @projectedName("json", "max_tokens") + @encodedName("application/json", "max_tokens") maxTokens?: int32; @doc(""" @@ -88,7 +87,6 @@ model ChatCompletionsOptions { It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. """) - @projectedName("json", "temperature") temperature?: float32; @doc(""" @@ -99,7 +97,7 @@ model ChatCompletionsOptions { It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. """) - @projectedName("json", "top_p") + @encodedName("application/json", "top_p") @projectedName("csharp", "NucleusSamplingFactor") topP?: float32; @@ -110,7 +108,7 @@ model ChatCompletionsOptions { a full ban or exclusive selection of a token, respectively. The exact behavior of a given bias score varies by model. """) - @projectedName("json", "logit_bias") + @encodedName("application/json", "logit_bias") @projectedName("csharp", "TokenSelectionBiases") logitBias?: Record; @@ -118,7 +116,6 @@ model ChatCompletionsOptions { An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes. """) - @projectedName("json", "user") user?: string; @doc(""" @@ -127,14 +124,12 @@ model ChatCompletionsOptions { Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop. """) - @projectedName("json", "n") @projectedName("csharp", "ChoiceCount") n?: int32; @doc(""" A collection of textual sequences that will end completions generation. """) - @projectedName("json", "stop") @projectedName("csharp", "StopSequences") stop?: string[]; @@ -144,7 +139,7 @@ model ChatCompletionsOptions { Positive values will make tokens less likely to appear when they already exist and increase the model's likelihood to output new topics. """) - @projectedName("json", "presence_penalty") + @encodedName("application/json", "presence_penalty") presencePenalty?: float32; @doc(""" @@ -153,13 +148,12 @@ model ChatCompletionsOptions { Positive values will make tokens less likely to appear as their frequency increases and decrease the likelihood of the model repeating the same statements verbatim. """) - @projectedName("json", "frequency_penalty") + @encodedName("application/json", "frequency_penalty") frequencyPenalty?: float32; @doc(""" A value indicating whether chat completions should be streamed for this request. """) - @projectedName("json", "stream") @projectedName("csharp", "InternalShouldStreamResponse") stream?: boolean; @@ -168,7 +162,6 @@ model ChatCompletionsOptions { Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that's connected to. """) - @projectedName("json", "model") @projectedName("csharp", "DeploymentName") `model`?: string; @@ -182,7 +175,6 @@ model ChatCompletionsOptions { // "extensions" instead of "data sources" for representing the additional configuration information. A future // service API version will absorb these proposed changes and allow us to retire the extra complexity. @added(ServiceApiVersions.v2023_08_01_Preview) - @projectedName("json", "dataSources") @projectedName("csharp", "InternalAzureExtensionsDataSources") dataSources?: AzureChatExtensionConfiguration[]; @@ -198,7 +190,7 @@ model ChatCompletionsOptions { """) seed?: int64; - @projectedName("json", "response_format") + @encodedName("application/json", "response_format") @added(ServiceApiVersions.v2023_12_01_Preview) @doc("An object specifying the format that the model must output. Used to enable JSON mode.") responseFormat?: ChatCompletionsResponseFormat; @@ -207,7 +199,7 @@ model ChatCompletionsOptions { @doc("The available tool definitions that the chat completions request can use, including caller-defined functions.") tools?: ChatCompletionsToolDefinition[]; - @projectedName("json", "tool_choice") + @encodedName("application/json", "tool_choice") @added(ServiceApiVersions.v2023_12_01_Preview) @doc(""" If specified, the model will configure which of the provided tools it can use for the chat completions response. @@ -223,17 +215,15 @@ Token limits and other settings may limit the number of choices generated. @added(ServiceApiVersions.v2023_05_15) model ChatChoice { @doc("The chat message for a given chat completions prompt.") - @projectedName("json", "message") message?: ChatResponseMessage; @doc("The ordered index associated with this chat completions choice.") - @projectedName("json", "index") index: int32; #suppress "@azure-tools/typespec-azure-core/no-nullable" "The operation already returns nulls" #suppress "@azure-tools/typespec-autorest/union-unsupported" "OpenAPI v2 support deferred" @doc("The reason that this chat completions choice completed its generated.") - @projectedName("json", "finish_reason") + @encodedName("application/json", "finish_reason") finishReason: CompletionsFinishReason | null; // Note: this property is currently speculative via observation and not yet documented anywhere. @@ -242,11 +232,10 @@ model ChatChoice { This structured representation replaces 'finish_reason' for some models. """) @added(ServiceApiVersions.v2023_12_01_Preview) - @projectedName("json", "finish_details") + @encodedName("application/json", "finish_details") finishDetails?: ChatFinishDetails; @doc("The delta message content for a streaming response.") - @projectedName("json", "delta") @projectedName("csharp", "InternalStreamingDeltaMessage") delta?: ChatResponseMessage; @@ -256,7 +245,7 @@ model ChatChoice { determines the intensity and risk level of harmful content) and if it has been filtered or not. """) @added(ServiceApiVersions.v2023_06_01_Preview) - @projectedName("json", "content_filter_results") + @encodedName("application/json", "content_filter_results") contentFilterResults?: ContentFilterResultsForChoice; @added(ServiceApiVersions.v2023_12_01_Preview) @@ -276,14 +265,12 @@ provided prompt data. @added(ServiceApiVersions.v2023_05_15) model ChatCompletions { @doc("A unique identifier associated with this chat completions response.") - @projectedName("json", "id") id: string; @doc(""" The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970. """) - @projectedName("json", "created") @projectedName("java", "createdAt") @encode(DateTimeKnownEncoding.unixTimestamp, int32) created: utcDateTime; @@ -293,7 +280,6 @@ model ChatCompletions { Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated. """) - @projectedName("json", "choices") choices: ChatChoice[]; @doc(""" @@ -301,11 +287,11 @@ model ChatCompletions { results for different prompts may arrive at different times or in different orders. """) @added(ServiceApiVersions.v2023_06_01_Preview) - @projectedName("json", "prompt_filter_results") + @encodedName("application/json", "prompt_filter_results") promptFilterResults?: ContentFilterResultsForPrompt[]; @added(ServiceApiVersions.v2023_12_01_Preview) - @projectedName("json", "system_fingerprint") + @encodedName("application/json", "system_fingerprint") @doc(""" Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. @@ -315,7 +301,6 @@ model ChatCompletions { @doc(""" Usage information for tokens processed and generated as part of this completions operation. """) - @projectedName("json", "usage") usage: CompletionsUsage; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_messages.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_messages.tsp index 261f8ef9f611..e07cad33c8db 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_messages.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_messages.tsp @@ -60,7 +60,7 @@ model ChatMessageImageContentItem extends ChatMessageContentItem { type: "image_url"; @doc("An internet location, which must be accessible to the model,from which the image may be retrieved.") - @projectedName("json", "image_url") + @encodedName("application/json", "image_url") imageUrl: ChatMessageImageUrl; } @@ -127,7 +127,7 @@ model ChatRequestAssistantMessage extends ChatRequestMessage { @doc("An optional name for the participant.") name?: string; - @projectedName("json", "tool_calls") + @encodedName("application/json", "tool_calls") @added(ServiceApiVersions.v2023_12_01_Preview) @doc(""" The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat @@ -137,7 +137,7 @@ model ChatRequestAssistantMessage extends ChatRequestMessage { @added(ServiceApiVersions.v2023_07_01_Preview) @removed(ServiceApiVersions.v2023_12_01_Preview) - @projectedName("json", "function_call") + @encodedName("application/json", "function_call") @doc(""" The function call that must be resolved and have its output appended to subsequent input messages for the chat completions request to resolve as configured. @@ -155,7 +155,7 @@ model ChatRequestToolMessage extends ChatRequestMessage { @doc("The content of the message.") content: string | null; - @projectedName("json", "tool_call_id") + @encodedName("application/json", "tool_call_id") @doc("The ID of the tool call resolved by the provided content.") toolCallId: string; } @@ -186,7 +186,7 @@ model ChatResponseMessage { content: string | null; @added(ServiceApiVersions.v2023_12_01_Preview) - @projectedName("json", "tool_calls") + @encodedName("application/json", "tool_calls") @doc(""" The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat completions request to resolve as configured. @@ -194,7 +194,7 @@ model ChatResponseMessage { toolCalls?: ChatCompletionsToolCall[]; @added(ServiceApiVersions.v2023_07_01_Preview) - @projectedName("json", "function_call") + @encodedName("application/json", "function_call") @doc(""" The function call that must be resolved and have its output appended to subsequent input messages for the chat completions request to resolve as configured. diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp index 3c5b697aef47..b510324ec244 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp @@ -12,15 +12,15 @@ other consumers. """) model CompletionsUsage { @doc("The number of tokens generated across all completions emissions.") - @projectedName("json", "completion_tokens") + @encodedName("application/json", "completion_tokens") completionTokens: int32; @doc("The number of tokens in the provided prompts for the completions request.") - @projectedName("json", "prompt_tokens") + @encodedName("application/json", "prompt_tokens") promptTokens: int32; @doc("The total number of tokens processed for the completions request and response.") - @projectedName("json", "total_tokens") + @encodedName("application/json", "total_tokens") totalTokens: int32; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp index 12d789dce2fa..4d8cd96cd0d7 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp @@ -18,12 +18,11 @@ provided prompt data. """) model CompletionsOptions { @doc("The prompts to generate completions from.") - @projectedName("json", "prompt") @projectedName("csharp", "Prompts") prompt: string[]; @doc("The maximum number of tokens to generate.") - @projectedName("json", "max_tokens") + @encodedName("application/json", "max_tokens") maxTokens?: int32; @doc(""" @@ -33,7 +32,6 @@ model CompletionsOptions { It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. """) - @projectedName("json", "temperature") temperature?: float32; @doc(""" @@ -44,7 +42,7 @@ model CompletionsOptions { It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. """) - @projectedName("json", "top_p") + @encodedName("application/json", "top_p") @projectedName("csharp", "NucleusSamplingFactor") topP?: float32; @@ -55,7 +53,7 @@ model CompletionsOptions { a full ban or exclusive selection of a token, respectively. The exact behavior of a given bias score varies by model. """) - @projectedName("json", "logit_bias") + @encodedName("application/json", "logit_bias") @projectedName("csharp", "TokenSelectionBiases") logitBias?: Record; @@ -63,7 +61,6 @@ model CompletionsOptions { An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes. """) - @projectedName("json", "user") user?: string; @doc(""" @@ -72,7 +69,6 @@ model CompletionsOptions { Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop. """) - @projectedName("json", "n") @projectedName("csharp", "ChoicesPerPrompt") n?: int32; @@ -80,7 +76,6 @@ model CompletionsOptions { A value that controls the emission of log probabilities for the provided number of most likely tokens within a completions response. """) - @projectedName("json", "logprobs") @projectedName("csharp", "LogProbabilityCount") logprobs?: int32; @@ -88,13 +83,11 @@ model CompletionsOptions { A value specifying whether completions responses should include input prompts as prefixes to their generated output. """) - @projectedName("json", "echo") echo?: boolean; @doc(""" A collection of textual sequences that will end completions generation. """) - @projectedName("json", "stop") @projectedName("csharp", "StopSequences") stop?: string[]; @@ -104,7 +97,7 @@ model CompletionsOptions { Positive values will make tokens less likely to appear when they already exist and increase the model's likelihood to output new topics. """) - @projectedName("json", "presence_penalty") + @encodedName("application/json", "presence_penalty") presencePenalty?: float32; @doc(""" @@ -113,7 +106,7 @@ model CompletionsOptions { Positive values will make tokens less likely to appear as their frequency increases and decrease the likelihood of the model repeating the same statements verbatim. """) - @projectedName("json", "frequency_penalty") + @encodedName("application/json", "frequency_penalty") frequencyPenalty?: float32; @doc(""" @@ -124,14 +117,13 @@ model CompletionsOptions { Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop. """) - @projectedName("json", "best_of") + @encodedName("application/json", "best_of") @projectedName("csharp", "GenerationSampleCount") bestOf?: int32; @doc(""" A value indicating whether chat completions should be streamed for this request. """) - @projectedName("json", "stream") @projectedName("csharp", "InternalShouldStreamResponse") stream?: boolean; @@ -140,7 +132,6 @@ model CompletionsOptions { Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that's connected to. """) - @projectedName("json", "model") @projectedName("csharp", "DeploymentName") `model`?: string; } @@ -152,14 +143,12 @@ provided prompt data. """) model Completions { @doc("A unique identifier associated with this completions response.") - @projectedName("json", "id") id: string; @doc(""" The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970. """) - @projectedName("json", "created") @projectedName("java", "createdAt") @encode(DateTimeKnownEncoding.unixTimestamp, int32) created: utcDateTime; @@ -169,7 +158,7 @@ model Completions { results for different prompts may arrive at different times or in different orders. """) @added(ServiceApiVersions.v2023_06_01_Preview) - @projectedName("json", "prompt_filter_results") + @encodedName("application/json", "prompt_filter_results") promptFilterResults?: ContentFilterResultsForPrompt[]; @doc(""" @@ -177,13 +166,11 @@ model Completions { Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated. """) - @projectedName("json", "choices") choices: Choice[]; @doc(""" Usage information for tokens processed and generated as part of this completions operation. """) - @projectedName("json", "usage") usage: CompletionsUsage; } @@ -194,11 +181,9 @@ Token limits and other settings may limit the number of choices generated. """) model Choice { @doc("The generated text for a given completions prompt.") - @projectedName("json", "text") text: string; @doc("The ordered index associated with this completions choice.") - @projectedName("json", "index") index: int32; @doc(""" @@ -207,19 +192,18 @@ model Choice { determines the intensity and risk level of harmful content) and if it has been filtered or not. """) @added(ServiceApiVersions.v2023_06_01_Preview) - @projectedName("json", "content_filter_results") + @encodedName("application/json", "content_filter_results") contentFilterResults?: ContentFilterResultsForChoice; #suppress "@azure-tools/typespec-azure-core/no-nullable" "The operation already returns nulls" @doc("The log probabilities model for tokens associated with this completions choice.") - @projectedName("json", "logprobs") @projectedName("csharp", "LogProbabilityModel") logprobs: CompletionsLogProbabilityModel | null; #suppress "@azure-tools/typespec-azure-core/no-nullable" "The operation already returns nulls" #suppress "@azure-tools/typespec-autorest/union-unsupported" "OpenAPI v2 support deferred" @doc("Reason for finishing") - @projectedName("json", "finish_reason") + @encodedName("application/json", "finish_reason") finishReason: CompletionsFinishReason | null; } @@ -230,23 +214,22 @@ Representation of a log probabilities model for a completions generation. """) model CompletionsLogProbabilityModel { @doc("The textual forms of tokens evaluated in this probability model.") - @projectedName("json", "tokens") tokens: string[]; @doc("A collection of log probability values for the tokens in this completions data.") - @projectedName("json", "token_logprobs") + @encodedName("application/json", "token_logprobs") @projectedName("csharp", "TokenLogProbabilities") @projectedName("java", "tokenLogProbabilities") tokenLogprobs: NullableFloat[]; @doc("A mapping of tokens to maximum log probability values in this completions data.") - @projectedName("json", "top_logprobs") + @encodedName("application/json", "top_logprobs") @projectedName("csharp", "TopLogProbabilities") @projectedName("java", "topLogProbabilities") topLogprobs: Record[]; @doc("The text offsets associated with tokens in this completions data.") - @projectedName("json", "text_offset") + @encodedName("application/json", "text_offset") @projectedName("csharp", "TextOffsets") @projectedName("java", "textOffsets") textOffset: int32[]; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp index 657a61bba75d..46bd8786c3c5 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp @@ -18,6 +18,12 @@ enum OnYourDataAuthenticationType { @doc("Authentication via key and key ID pair.") keyAndKeyId: "KeyAndKeyId", + @doc("Authentication via encoded API key.") + encodedApiKey: "EncodedAPIKey", + + @doc("Authentication via access token.") + accessToken: "AccessToken", + @doc("Authentication via system-assigned managed identity.") systemAssignedManagedIdentity: "SystemAssignedManagedIdentity", @@ -75,6 +81,32 @@ model OnYourDataKeyAndKeyIdAuthenticationOptions keyId: string; } +@doc(""" +The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key. +""") +@added(ServiceApiVersions.v2023_08_01_Preview) +model OnYourDataEncodedApiKeyAuthenticationOptions + extends OnYourDataAuthenticationOptions { + @doc("The authentication type of Elasticsearch encoded API Key.") + type: OnYourDataAuthenticationType.encodedApiKey; + + @doc("The encoded API key to use for authentication.") + encodedApiKey: string; +} + +@doc(""" +The authentication options for Azure OpenAI On Your Data when using access token. +""") +@added(ServiceApiVersions.v2023_08_01_Preview) +model OnYourDataAccessTokenAuthenticationOptions + extends OnYourDataAuthenticationOptions { + @doc("The authentication type of access token.") + type: OnYourDataAuthenticationType.accessToken; + + @doc("The access token to use for authentication.") + accessToken: string; +} + @doc(""" The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity. """) diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cognitive_search_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cognitive_search_options.tsp index 8ef494030b21..83ff77ac430d 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cognitive_search_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cognitive_search_options.tsp @@ -26,7 +26,7 @@ model AzureCognitiveSearchChatExtensionConfiguration } @added(ServiceApiVersions.v2023_08_01_Preview) -@doc("Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.") +@doc("Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. The supported authentication types are APIKey, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.") model AzureCognitiveSearchChatExtensionParameters { ...OnYourDataCommonChatExtensionConfiguration; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp index e169fc9dbfde..b940c3082784 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp @@ -10,7 +10,7 @@ using TypeSpec.Versioning; #suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" @added(ServiceApiVersions.v2023_12_01_Preview) @doc(""" -A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat +A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat extension. """) model AzureCosmosDBChatExtensionConfiguration @@ -29,7 +29,7 @@ model AzureCosmosDBChatExtensionConfiguration @added(ServiceApiVersions.v2023_12_01_Preview) @doc(""" Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for -MongoDB vCore. +MongoDB vCore. The supported authentication type is ConnectionString. """) model AzureCosmosDBChatExtensionParameters { ...OnYourDataCommonChatExtensionConfiguration; @@ -51,13 +51,33 @@ model AzureCosmosDBChatExtensionParameters { fieldsMapping: AzureCosmosDBFieldMappingOptions; @doc("The embedding dependency for vector search.") - embeddingDependency?: OnYourDataVectorizationSource; + embeddingDependency: OnYourDataVectorizationSource; } #suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" @doc("Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource.") @added(ServiceApiVersions.v2023_12_01_Preview) model AzureCosmosDBFieldMappingOptions { + @doc("The name of the index field to use as a title.") + @projectedName("csharp", "TitleFieldName") + titleField?: string; + + @doc("The name of the index field to use as a URL.") + @projectedName("csharp", "UrlFieldName") + urlField?: string; + + @doc("The name of the index field to use as a filepath.") + @projectedName("csharp", "FilepathFieldName") + filepathField?: string; + + @doc("The names of index fields that should be treated as content.") + @projectedName("csharp", "ContentFieldNames") + contentFields: string[]; + + @doc("The separator pattern that content fields should use.") + @projectedName("csharp", "ContentFieldSeparator") + contentFieldsSeparator?: string; + @doc("The names of fields that represent vector data.") @projectedName("csharp", "VectorFieldNames") vectorFields: string[]; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp index ae37887aac41..368adc73c1ef 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp @@ -24,7 +24,7 @@ model AzureMachineLearningIndexChatExtensionConfiguration } @added(ServiceApiVersions.v2023_12_01_Preview) -@doc("Parameters for the Azure Machine Learning vector index chat extension.") +@doc("Parameters for the Azure Machine Learning vector index chat extension. The supported authentication types are AccessToken, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.") model AzureMachineLearningIndexChatExtensionParameters { ...OnYourDataCommonChatExtensionConfiguration; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp index fe691977fb69..4d433e91cb5d 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp @@ -24,7 +24,7 @@ model ElasticsearchChatExtensionConfiguration } @added(ServiceApiVersions.v2023_12_01_Preview) -@doc("Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension.") +@doc("Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. The supported authentication types are KeyAndKeyId and EncodedAPIKey.") model ElasticsearchChatExtensionParameters { ...OnYourDataCommonChatExtensionConfiguration; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp index dc1096b96fda..6ebb9f2069d1 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp @@ -10,7 +10,7 @@ using TypeSpec.Versioning; #suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" @added(ServiceApiVersions.v2023_12_01_Preview) @doc(""" -A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat +A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat extension. """) model PineconeChatExtensionConfiguration @@ -26,7 +26,7 @@ model PineconeChatExtensionConfiguration } @added(ServiceApiVersions.v2023_12_01_Preview) -@doc("Parameters for configuring Azure OpenAI Pinecone chat extensions.") +@doc("Parameters for configuring Azure OpenAI Pinecone chat extensions. The supported authentication type is APIKey.") model PineconeChatExtensionParameters { ...OnYourDataCommonChatExtensionConfiguration; @@ -42,7 +42,7 @@ model PineconeChatExtensionParameters { fieldsMapping: PineconeFieldMappingOptions; @doc("The embedding dependency for vector search.") - embeddingDependency?: OnYourDataVectorizationSource; + embeddingDependency: OnYourDataVectorizationSource; } @doc("Optional settings to control how fields are processed when using a configured Pinecone resource.") @@ -62,18 +62,9 @@ model PineconeFieldMappingOptions { @doc("The names of index fields that should be treated as content.") @projectedName("csharp", "ContentFieldNames") - contentFields?: string[]; + contentFields: string[]; @doc("The separator pattern that content fields should use.") @projectedName("csharp", "ContentFieldSeparator") contentFieldsSeparator?: string; - - @doc("The names of fields that represent vector data.") - @projectedName("csharp", "VectorFieldNames") - vectorFields?: string[]; - - @added(ServiceApiVersions.v2023_12_01_Preview) - @doc("The names of fields that represent image vector data.") - @projectedName("csharp", "ImageVectorFieldNames") - imageVectorFields?: string[]; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/tools.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/tools.tsp index d947beae32fe..a7d973b15052 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/tools.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/tools.tsp @@ -40,6 +40,13 @@ model ChatCompletionsNamedFunctionToolSelection @doc("The object type, which is always 'function'.") type: "function"; + @doc("The function that should be called.") + function: ChatCompletionsFunctionToolSelection; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("A tool selection of a specific, named function tool that will limit chat completions to using the named function.") +model ChatCompletionsFunctionToolSelection { @doc("The name of the function that should be called.") name: string; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp b/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp index 59f6bc7c6d84..92a39c23bb70 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/embeddings_create.tsp @@ -16,7 +16,6 @@ model EmbeddingsOptions { An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes. """) - @projectedName("json", "user") user?: string; @doc(""" @@ -24,7 +23,6 @@ model EmbeddingsOptions { Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that's connected to. """) - @projectedName("json", "model") @projectedName("csharp", "DeploymentName") `model`?: string; @@ -67,10 +65,10 @@ model EmbeddingItem { @doc("Measurement of the amount of tokens used in this request and response.") model EmbeddingsUsage { @doc("Number of tokens sent in the original request.") - @projectedName("json", "prompt_tokens") + @encodedName("application/json", "prompt_tokens") promptTokens: int32; @doc("Total number of tokens transacted in this request/response.") - @projectedName("json", "total_tokens") + @encodedName("application/json", "total_tokens") totalTokens: int32; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp b/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp index a80a53300efd..200c97d3ee7f 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp @@ -120,7 +120,7 @@ model ImageGenerationOptions { size?: ImageSize = ImageSize.size1024x1024; @doc("The format in which image generation response items should be presented.") - @projectedName("json", "response_format") + @encodedName("application/json", "response_format") responseFormat?: ImageGenerationResponseFormat = ImageGenerationResponseFormat.url; @doc(""" @@ -151,7 +151,7 @@ model ImageGenerationData { url?: url; @doc("The complete data for an image, represented as a base64-encoded string.") - @projectedName("json", "b64_json") + @encodedName("application/json", "b64_json") base64Data?: string; @doc(""" @@ -159,7 +159,7 @@ model ImageGenerationData { Only provided with dall-3-models and only when revisions were made to the prompt. """) @added(ServiceApiVersions.v2023_12_01_Preview) - @projectedName("json", "revised_prompt") + @encodedName("application/json", "revised_prompt") revisedPrompt?: string; } @@ -170,7 +170,6 @@ model ImageGenerations { A timestamp representing when this operation was started. Expressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000. """) - @projectedName("json", "created") @projectedName("java", "createdAt") @encode(DateTimeKnownEncoding.unixTimestamp, int32) created: utcDateTime; @@ -197,7 +196,6 @@ model BatchImageGenerationOperationResponse { id: string; @doc("A timestamp when this job or item was created (in unix epochs).") - @projectedName("json", "created") @projectedName("java", "createdAt") @encode(DateTimeKnownEncoding.unixTimestamp, int32) created: utcDateTime; diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2023-10-01-preview/azureopenai.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2023-10-01-preview/azureopenai.json index feeac1129c8b..f638c42c9cf0 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2023-10-01-preview/azureopenai.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2023-10-01-preview/azureopenai.json @@ -1201,6 +1201,18 @@ "name": "embeddingKey", "description": "The key to use for accessing the embeddings model if enabled and if Managed Identity is not setup.", "type": "string" + }, + { + "in": "header", + "name": "storageEndpoint", + "description": "The blob storage endpoint hosting the data that will be ingested. Required for ResourceId format of storageConnectionString.", + "type": "string" + }, + { + "in": "header", + "name": "embeddingDeploymentName", + "description": "The name of embedding deployment of the current Azure OpenAI resource to use for accessing the embeddings model.", + "type": "string" } ], "responses": { @@ -2364,6 +2376,12 @@ "completionAction": { "$ref": "#/definitions/IngestionJobCompletionAction" }, + "chunkSize": { + "type": "integer", + "format": "int32", + "default": 1024, + "description": "This number defines the maximum number of tokens in each chunk produced by the ingestion flow." + }, "status": { "$ref": "#/definitions/OperationState" }, diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/azureopenai.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/azureopenai.json new file mode 100644 index 000000000000..3543ba640154 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/azureopenai.json @@ -0,0 +1,1605 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI API version 2024-02-15-preview", + "description": "APIs for fine-tuning and managing deployments of OpenAI models.", + "version": "2024-02-15-preview" + }, + "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": [ + { + "in": "query", + "name": "purpose", + "description": "Only return files with the given purpose.", + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output" + ], + "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." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + } + ] + } + }, + { + "$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", + "assistants" + ], + "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." + }, + { + "value": "assistants", + "description": "This file contains data that can be attached to an assistant." + } + ] + } + }, + { + "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_tuning/jobs": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "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": "FineTuning_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of events to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all fine tune jobs owned by this account.": { + "$ref": "./examples/get_finetuning_jobs.json" + } + } + }, + "post": { + "tags": [ + "Fine-tuning:" + ], + "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": "FineTuning_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fineTuningJob", + "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/FineTuningJobCreation" + } + } + ], + "responses": { + "201": { + "description": "The fine tune has been successfully created.", + "schema": { + "$ref": "#/definitions/FineTuningJob" + }, + "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_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "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": "FineTuning_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a fine tune job.": { + "$ref": "./examples/get_finetuning_job.json" + } + } + }, + "delete": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Deletes the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTuning_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-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_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/events": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "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": "FineTuning_GetEvents", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of events to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobEventList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting events of a fine tune job.": { + "$ref": "./examples/get_finetuning_job_events.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/cancel": { + "post": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Cancels the processing of the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTuning_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-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/FineTuningJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Canceling a fine tune job.": { + "$ref": "./examples/cancel_finetuning_job.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", + "tooManyRequests", + "unauthorized", + "contentFilter" + ], + "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." + }, + { + "value": "tooManyRequests", + "description": "Too many requests. Please retry later." + }, + { + "value": "unauthorized", + "description": "The current user/api key is not authorized for the operation." + }, + { + "value": "contentFilter", + "description": "Image generation failed as a result of our safety system." + } + ] + } + }, + "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" + } + } + }, + "EventType": { + "title": "EventType", + "description": "Defines the severity of a content filter result.", + "enum": [ + "message", + "metrics" + ], + "type": "string", + "x-ms-enum": { + "name": "EventType", + "modelAsString": true, + "values": [ + { + "value": "message", + "description": "Event only contains human readable messages." + }, + { + "value": "metrics", + "description": "Event contains metrics." + } + ] + } + }, + "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" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FileState" + }, + "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" + }, + "status_details": { + "description": "The error message with details in case processing of this file failed.", + "type": "string", + "readOnly": true + } + } + }, + "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" + } + } + } + }, + "FileState": { + "title": "FileState", + "description": "The state of a file.", + "enum": [ + "uploaded", + "pending", + "running", + "processed", + "error", + "deleting", + "deleted" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FileState", + "modelAsString": true, + "values": [ + { + "value": "uploaded", + "description": "The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state." + }, + { + "value": "pending", + "description": "The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state." + }, + { + "value": "running", + "description": "The operation has started to be processed. It can be categorized as an active state." + }, + { + "value": "processed", + "description": "The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state." + }, + { + "value": "error", + "description": "The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state." + }, + { + "value": "deleting", + "description": "The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state." + }, + { + "value": "deleted", + "description": "The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state." + } + ] + } + }, + "FineTuningHyperParameters": { + "title": "FineTuningHyperParameters", + "description": "The hyper parameter settings used in a fine tune job.", + "type": "object", + "properties": { + "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" + } + } + }, + "FineTuningJob": { + "title": "FineTuningJob", + "description": "Defines the values of a fine tune job.", + "required": [ + "model", + "training_file" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FineTuningState" + }, + "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_file": { + "description": "The file which is used for training.", + "minLength": 1, + "type": "string" + }, + "validation_file": { + "description": "The file which is used to evaluate the fine tuned model during training.", + "type": "string" + }, + "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": { + "type": "string" + } + }, + "finished_at": { + "format": "int32", + "description": "A timestamp when this job or item has finished successfully (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "organisation_id": { + "description": "The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.", + "type": "string" + }, + "trained_tokens": { + "format": "int32", + "description": "The total number of billable tokens processed by this fine tuning job.", + "type": "integer", + "readOnly": true + }, + "hyperparameters": { + "$ref": "#/definitions/FineTuningHyperParameters" + }, + "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" + } + } + }, + "FineTuningJobCreation": { + "title": "FineTuningJobCreation", + "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" + }, + "hyperparameters": { + "$ref": "#/definitions/FineTuningHyperParameters" + }, + "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" + } + } + }, + "FineTuningJobEvent": { + "title": "FineTuningJobEvent", + "required": [ + "created_at", + "level", + "message", + "type" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "id": { + "description": "The identity of this event.", + "type": "string", + "readOnly": true + }, + "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" + }, + "type": { + "$ref": "#/definitions/EventType" + }, + "data": { + "description": "Machine readable data of this event." + } + } + }, + "FineTuningJobEventList": { + "title": "FineTuningJobEventList", + "description": "Represents a list of events.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJobEvent" + } + }, + "has_more": { + "description": "A value indicating whether the list of events contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningJobList": { + "title": "FineTuningJobList", + "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/FineTuningJob" + } + }, + "has_more": { + "description": "A value indicating whether the list of events contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningState": { + "title": "FineTuningState", + "description": "The state of a finetunes object or fine tuning job.", + "enum": [ + "created", + "pending", + "running", + "succeeded", + "cancelled", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FineTuningState", + "modelAsString": true, + "values": [ + { + "value": "created", + "description": "The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state." + }, + { + "value": "pending", + "description": "The operation is not yet queued to be processed in the future. It can be categorized as an inactive state." + }, + { + "value": "running", + "description": "The operation has started to be processed. It can be categorized as an active state." + }, + { + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state." + }, + { + "value": "cancelled", + "description": "The operation has been cancelled and is incomplete. It can be categorized as a terminal state." + }, + { + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state." + } + ] + } + }, + "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" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FineTuningState" + }, + "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" + } + } + } + }, + "OperationState": { + "title": "OperationState", + "description": "The state of a job or item.", + "enum": [ + "notRunning", + "running", + "succeeded", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "value": "notRunning", + "description": "The operation is not yet 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": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed." + } + ] + } + }, + "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", + "assistants", + "assistants_output" + ], + "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." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + } + ] + } + }, + "TypeDiscriminator": { + "title": "TypeDiscriminator", + "description": "Defines the type of an object.", + "enum": [ + "list", + "fine_tuning.job", + "file", + "fine_tuning.job.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_tuning.job", + "description": "This object represents a fine tune job." + }, + { + "value": "file", + "description": "This object represents a file." + }, + { + "value": "fine_tuning.job.event", + "description": "This object represents an event of a fine tuning job." + }, + { + "value": "model", + "description": "This object represents a model (can be a base model or fine tune job result)." + } + ] + } + } + }, + "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": "2024-02-15-preview", + "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/preview/2024-02-15-preview/azureopenai.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/azureopenai.yaml new file mode 100644 index 000000000000..8b8ce2969625 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/azureopenai.yaml @@ -0,0 +1,1073 @@ +swagger: '2.0' +info: + title: Azure OpenAI API version 2024-02-15-preview + description: APIs for fine-tuning and managing deployments of OpenAI models. + version: 2024-02-15-preview +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: + - in: query + name: purpose + description: Only return files with the given purpose. + type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + 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. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + - $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 + - assistants + 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. + - value: assistants + description: This file contains data that can be attached to an assistant. + - 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_tuning/jobs: + get: + tags: + - 'Fine-tuning:' + 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: FineTuning_List + produces: + - application/json + parameters: + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of events to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/FineTuningJobList' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting all fine tune jobs owned by this account.: + $ref: ./examples/get_finetuning_jobs.json + post: + tags: + - 'Fine-tuning:' + 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: FineTuning_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: '#/parameters/apiVersionQueryParameter' + - in: body + name: fineTuningJob + 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/FineTuningJobCreation' + responses: + '201': + description: The fine tune has been successfully created. + schema: + $ref: '#/definitions/FineTuningJob' + 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_finetuning_job.json + /fine_tuning/jobs/{fine-tuning-job-id}: + get: + tags: + - 'Fine-tuning:' + 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: FineTuning_Get + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/FineTuningJob' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting a fine tune job.: + $ref: ./examples/get_finetuning_job.json + delete: + tags: + - 'Fine-tuning:' + summary: Deletes the fine-tune job specified by the given fine-tune-id. + operationId: FineTuning_Delete + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-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_finetuning_job.json + /fine_tuning/jobs/{fine-tuning-job-id}/events: + get: + tags: + - 'Fine-tuning:' + 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: FineTuning_GetEvents + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of events to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/FineTuningJobEventList' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting events of a fine tune job.: + $ref: ./examples/get_finetuning_job_events.json + /fine_tuning/jobs/{fine-tuning-job-id}/cancel: + post: + tags: + - 'Fine-tuning:' + summary: Cancels the processing of the fine-tune job specified by the given fine-tune-id. + operationId: FineTuning_Cancel + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-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/FineTuningJob' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Canceling a fine tune job.: + $ref: ./examples/cancel_finetuning_job.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 + - tooManyRequests + - unauthorized + - contentFilter + 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. + - value: tooManyRequests + description: Too many requests. Please retry later. + - value: unauthorized + description: The current user/api key is not authorized for the operation. + - value: contentFilter + description: Image generation failed as a result of our safety system. + 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' + EventType: + title: EventType + description: Defines the severity of a content filter result. + enum: + - message + - metrics + type: string + x-ms-enum: + name: EventType + modelAsString: true + values: + - value: message + description: Event only contains human readable messages. + - value: metrics + description: Event contains metrics. + 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' + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: '#/definitions/FileState' + 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 + status_details: + description: The error message with details in case processing of this file failed. + type: string + readOnly: true + 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' + FileState: + title: FileState + description: The state of a file. + enum: + - uploaded + - pending + - running + - processed + - error + - deleting + - deleted + type: string + readOnly: true + x-ms-enum: + name: FileState + modelAsString: true + values: + - value: uploaded + description: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. + - value: pending + description: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. + - value: running + description: The operation has started to be processed. It can be categorized as an active state. + - value: processed + description: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. + - value: error + description: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. + - value: deleting + description: The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. + - value: deleted + description: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. + FineTuningHyperParameters: + title: FineTuningHyperParameters + description: The hyper parameter settings used in a fine tune job. + type: object + properties: + 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 + FineTuningJob: + title: FineTuningJob + description: Defines the values of a fine tune job. + required: + - model + - training_file + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: '#/definitions/FineTuningState' + 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_file: + description: The file which is used for training. + minLength: 1 + type: string + validation_file: + description: The file which is used to evaluate the fine tuned model during training. + type: string + 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: + type: string + finished_at: + format: int32 + description: A timestamp when this job or item has finished successfully (in unix epochs). + type: integer + readOnly: true + organisation_id: + description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only. + type: string + trained_tokens: + format: int32 + description: The total number of billable tokens processed by this fine tuning job. + type: integer + readOnly: true + hyperparameters: + $ref: '#/definitions/FineTuningHyperParameters' + 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 + FineTuningJobCreation: + title: FineTuningJobCreation + 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 + hyperparameters: + $ref: '#/definitions/FineTuningHyperParameters' + 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 + FineTuningJobEvent: + title: FineTuningJobEvent + required: + - created_at + - level + - message + - type + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + id: + description: The identity of this event. + type: string + readOnly: true + 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 + type: + $ref: '#/definitions/EventType' + data: + description: Machine readable data of this event. + FineTuningJobEventList: + title: FineTuningJobEventList + description: Represents a list of events. + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + data: + description: The list of items. + type: array + items: + $ref: '#/definitions/FineTuningJobEvent' + has_more: + description: A value indicating whether the list of events contains more elements than returned. + type: boolean + FineTuningJobList: + title: FineTuningJobList + 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/FineTuningJob' + has_more: + description: A value indicating whether the list of events contains more elements than returned. + type: boolean + FineTuningState: + title: FineTuningState + description: The state of a finetunes object or fine tuning job. + enum: + - created + - pending + - running + - succeeded + - cancelled + - failed + type: string + readOnly: true + x-ms-enum: + name: FineTuningState + modelAsString: true + values: + - value: created + description: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. + - value: pending + description: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state. + - value: running + description: The operation has started to be processed. It can be categorized as an active state. + - value: succeeded + description: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. + - value: cancelled + description: The operation has been cancelled and is incomplete. It can be categorized as a terminal state. + - value: failed + description: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. + 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' + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: '#/definitions/FineTuningState' + 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' + OperationState: + title: OperationState + description: The state of a job or item. + enum: + - notRunning + - running + - succeeded + - failed + type: string + readOnly: true + x-ms-enum: + name: OperationState + modelAsString: true + values: + - value: notRunning + description: The operation is not yet 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: failed + description: The operation has completed processing with a failure and cannot be further consumed. + 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 + - assistants + - assistants_output + 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. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + TypeDiscriminator: + title: TypeDiscriminator + description: Defines the type of an object. + enum: + - list + - fine_tuning.job + - file + - fine_tuning.job.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_tuning.job + description: This object represents a fine tune job. + - value: file + description: This object represents a file. + - value: fine_tuning.job.event + description: This object represents an event of a fine tuning job. + - value: model + description: This object represents a model (can be a base model or fine tune job result). +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: 2024-02-15-preview + 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/preview/2024-02-15-preview/examples/cancel_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/cancel_finetuning_job.json new file mode 100644 index 000000000000..cd370b1546aa --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/cancel_finetuning_job.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparameters": { + "n_epochs": 2 + }, + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "finished_at": 1646127311, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "canceled", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/cancel_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/cancel_finetuning_job.yaml new file mode 100644 index 000000000000..319c9e42ef89 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/cancel_finetuning_job.yaml @@ -0,0 +1,23 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-02-15-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + hyperparameters: + n_epochs: 2 + suffix: + status: cancelled + model: curie + fine_tuned_model: + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + finished_at: 1646127311 + organisation_id: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_file.json new file mode 100644 index 000000000000..fe861f99b61b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_file.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_file.yaml new file mode 100644 index 000000000000..196d9980fcd9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_file.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-02-15-preview + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 204: + headers: {} + body: diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_finetuning_job.json new file mode 100644 index 000000000000..7c87af0f6dfa --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_finetuning_job.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_finetuning_job.yaml new file mode 100644 index 000000000000..af1e4dd3d7b3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/delete_finetuning_job.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-02-15-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 204: + headers: {} + body: diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file.json new file mode 100644 index 000000000000..01bb2d0c8d2f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file.yaml new file mode 100644 index 000000000000..6856b5880b8a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file.yaml @@ -0,0 +1,17 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-02-15-preview + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: + status_details: + status: processed + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file_content.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file_content.json new file mode 100644 index 000000000000..902c8503fbde --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file_content.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": "raw file content" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file_content.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file_content.yaml new file mode 100644 index 000000000000..06022de09e40 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_file_content.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-02-15-preview + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: raw file content diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_files.json new file mode 100644 index 000000000000..fdc3e39f3556 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_files.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "object": "file" + }, + { + "bytes": 32423, + "purpose": "fine-tune-results", + "filename": "results.csv", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "object": "file" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_files.yaml new file mode 100644 index 000000000000..611759ee7106 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_files.yaml @@ -0,0 +1,27 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-02-15-preview +responses: + 200: + headers: {} + body: + data: + - status_details: + status: processed + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + - statistics: + status_details: + status: processed + bytes: 32423 + purpose: fine-tune-results + filename: results.csv + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job.json new file mode 100644 index 000000000000..6d4985cf34dd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparameters": { + "n_epochs": 2 + }, + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "result_files": [ + "file-181a1cbdcdcf4677ada87f63a0928099" + ], + "finished_at": 1646127311, + "trained_tokens": 2342, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "succeeded", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job.yaml new file mode 100644 index 000000000000..b15c6e275778 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job.yaml @@ -0,0 +1,25 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-02-15-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + hyperparameters: + n_epochs: 2 + suffix: + status: succeeded + model: curie + fine_tuned_model: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + - file-181a1cbdcdcf4677ada87f63a0928099 + finished_at: 1646127311 + organisation_id: + trained_tokens: 2342 + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job_events.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job_events.json new file mode 100644 index 000000000000..f5a99d3b7ff7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job_events.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "id": "ft-event-363dcd7cb4c74539bc53293c1dceef05", + "created_at": 1646126127, + "level": "info", + "message": "Job enqueued. Waiting for jobs ahead to complete.", + "type": "message", + "object": "fine_tuning.job.event" + }, + { + "id": "ft-event-8c2a44999790437cb3230e543fa2cf0f", + "created_at": 1646126169, + "level": "info", + "message": "Job started.", + "type": "message", + "object": "fine_tuning.job.event" + }, + { + "id": "ft-event-2d47d651d2f3484c8187c88c00078147", + "created_at": 1646126192, + "level": "info", + "message": "Job succeeded.", + "type": "message", + "object": "fine_tuning.job.event" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job_events.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job_events.yaml new file mode 100644 index 000000000000..40d4360d93c0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_job_events.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-02-15-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + has_more: false + data: + - id: ftevent-363dcd7cb4c74539bc53293c1dceef05 + created_at: 1646126127 + level: Info + message: Job enqueued. Waiting for jobs ahead to complete. + type: message + data: + object: fine_tuning.job.event + - id: ftevent-8c2a44999790437cb3230e543fa2cf0f + created_at: 1646126169 + level: Info + message: Job started. + type: message + data: + object: fine_tuning.job.event + - id: ftevent-2d47d651d2f3484c8187c88c00078147 + created_at: 1646126192 + level: Info + message: Job succeeded. + type: message + data: + object: fine_tuning.job.event + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_jobs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_jobs.json new file mode 100644 index 000000000000..b2105860d3d1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_jobs.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "hyperparameters": { + "n_epochs": 2 + }, + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "result_files": [ + "file-181a1cbdcdcf4677ada87f63a0928099" + ], + "finished_at": 1646127311, + "trained_tokens": 2342, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "succeeded", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_jobs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_jobs.yaml new file mode 100644 index 000000000000..29b428ed5846 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_finetuning_jobs.yaml @@ -0,0 +1,27 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-02-15-preview +responses: + 200: + headers: {} + body: + has_more: false + data: + - hyperparameters: + n_epochs: 2 + suffix: + status: succeeded + model: curie + fine_tuned_model: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + - file-181a1cbdcdcf4677ada87f63a0928099 + finished_at: 1646127311 + organisation_id: + trained_tokens: 2342 + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_base.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_base.json new file mode 100644 index 000000000000..ee62737741eb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_base.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview", + "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, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_base.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_base.yaml new file mode 100644 index 000000000000..387ef7b6029a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_base.yaml @@ -0,0 +1,25 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-02-15-preview + model-id: curie +responses: + 200: + headers: {} + body: + status: succeeded + model: + fine_tune: + 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 + created_at: 1646126127 + object: model diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_finetune.json new file mode 100644 index 000000000000..a7efb2d6093c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_finetune.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview", + "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, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_finetune.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_finetune.yaml new file mode 100644 index 000000000000..c76a13242688 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_model_finetune.yaml @@ -0,0 +1,24 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-02-15-preview + model-id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + status: succeeded + 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 + created_at: 1646126127 + object: model diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_models.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_models.json new file mode 100644 index 000000000000..41afc99117ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_models.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview" + }, + "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, + "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, + "object": "model" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_models.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_models.yaml new file mode 100644 index 000000000000..68cfa768a7f8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/get_models.yaml @@ -0,0 +1,41 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-02-15-preview +responses: + 200: + headers: {} + body: + data: + - status: succeeded + model: + fine_tune: + 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 + created_at: 1646126127 + object: model + - status: succeeded + 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 + created_at: 1646126127 + object: model + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/import_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/import_file.json new file mode 100644 index 000000000000..fb2dd321ea42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/import_file.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview", + "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, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/import_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/import_file.yaml new file mode 100644 index 000000000000..4af1881948b2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/import_file.yaml @@ -0,0 +1,48 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2023-10-01-preview + fileImport: + purpose: fine-tune + filename: puppy.jsonl + content_url: &o0 + absolutePath: /trainingdata/puppy.jsonl + absoluteUri: *o0 + localPath: /trainingdata/puppy.jsonl + authority: www.contoso.com + hostNameType: Dns + isDefaultPort: true + isFile: false + isLoopback: false + pathAndQuery: /trainingdata/puppy.jsonl + segments: + - / + - trainingdata/ + - puppy.jsonl + isUnc: false + host: www.contoso.com + port: 443 + query: '' + fragment: '' + scheme: https + originalString: *o0 + dnsSafeHost: www.contoso.com + idnHost: www.contoso.com + isAbsoluteUri: true + userEscaped: false + userInfo: '' + Content-Type: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099 + body: + statistics: + status_details: + status: pending + bytes: + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/post_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/post_finetuning_job.json new file mode 100644 index 000000000000..10787d095b61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/post_finetuning_job.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview", + "fineTuningJob": { + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "body": { + "hyperparameters": { + "n_epochs": 2 + }, + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "notRunning", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/post_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/post_finetuning_job.yaml new file mode 100644 index 000000000000..3c8f95d31d7f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/post_finetuning_job.yaml @@ -0,0 +1,30 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2023-10-01-preview + fineTuningJob: + hyperparameters: + suffix: + model: curie + trainingFile: file-181a1cbdcdcf4677ada87f63a0928099 + validationFile: + Content-Type: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f + body: + hyperparameters: + n_epochs: 2 + suffix: + status: pending + model: curie + fine_tuned_model: + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + finished_at: + organisation_id: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/upload_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/upload_file.json new file mode 100644 index 000000000000..f32450b13326 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/upload_file.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-02-15-preview", + "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, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/upload_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/upload_file.yaml new file mode 100644 index 000000000000..67ecbb879ba8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-02-15-preview/examples/upload_file.yaml @@ -0,0 +1,21 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2023-10-01-preview + 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: + statistics: + status_details: + status: pending + bytes: + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md index 98bcb42c2c15..4ab952c86714 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_2023_12_01_preview`. +The current release for the AzureOpenAI is `release_2024_02_15_preview`. ``` yaml tag: release_2022_12_01 @@ -225,3 +225,23 @@ directive: - suppress: IntegerTypeMustHaveFormat reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. ``` + +## AzureOpenAI 2024-02-15-preview +These settings apply only when `--tag=release_2024_02_15_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2024_02_15_preview' +input-file: preview/2024-02-15-preview/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/inference/preview/2023-06-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json index 22f163ead36b..3f188ba6762a 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json @@ -1279,14 +1279,54 @@ "default": 1 }, "size": { - "$ref": "#/definitions/ImageSize", + "type": "string", "description": "The desired dimensions for generated images.\nDall-e-2 models support 256x256, 512x512, or 1024x1024.\nDall-e-3 models support 1024x1024, 1792x1024, or 1024x1792.", - "default": "1024x1024" + "default": "1024x1024", + "enum": [ + "256x256", + "512x512" + ], + "x-ms-enum": { + "name": "ImageSize", + "modelAsString": true, + "values": [ + { + "name": "size256x256", + "value": "256x256", + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size512x512", + "value": "512x512", + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." + } + ] + } }, "response_format": { - "$ref": "#/definitions/ImageGenerationResponseFormat", + "type": "string", "description": "The format in which image generation response items should be presented.", "default": "url", + "enum": [ + "url", + "b64_json" + ], + "x-ms-enum": { + "name": "ImageGenerationResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "url", + "value": "url", + "description": "Image generation response items should provide a URL from which the image may be retrieved." + }, + { + "name": "base64", + "value": "b64_json", + "description": "Image generation response items should provide image data as a base64-encoded string." + } + ] + }, "x-ms-client-name": "responseFormat" }, "user": { @@ -1298,30 +1338,6 @@ "prompt" ] }, - "ImageGenerationResponseFormat": { - "type": "string", - "description": "The format in which the generated images are returned.", - "enum": [ - "url", - "b64_json" - ], - "x-ms-enum": { - "name": "ImageGenerationResponseFormat", - "modelAsString": true, - "values": [ - { - "name": "url", - "value": "url", - "description": "Image generation response items should provide a URL from which the image may be retrieved." - }, - { - "name": "base64", - "value": "b64_json", - "description": "Image generation response items should provide image data as a base64-encoded string." - } - ] - } - }, "ImageGenerations": { "type": "object", "description": "The result of a successful image generation operation.", @@ -1344,30 +1360,6 @@ "created", "data" ] - }, - "ImageSize": { - "type": "string", - "description": "The desired size of generated images.", - "enum": [ - "256x256", - "512x512" - ], - "x-ms-enum": { - "name": "ImageSize", - "modelAsString": true, - "values": [ - { - "name": "size256x256", - "value": "256x256", - "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." - }, - { - "name": "size512x512", - "value": "512x512", - "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." - } - ] - } } }, "parameters": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json index e27eaa74284b..683f2fd965dd 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json @@ -1376,14 +1376,54 @@ "default": 1 }, "size": { - "$ref": "#/definitions/ImageSize", + "type": "string", "description": "The desired dimensions for generated images.\nDall-e-2 models support 256x256, 512x512, or 1024x1024.\nDall-e-3 models support 1024x1024, 1792x1024, or 1024x1792.", - "default": "1024x1024" + "default": "1024x1024", + "enum": [ + "256x256", + "512x512" + ], + "x-ms-enum": { + "name": "ImageSize", + "modelAsString": true, + "values": [ + { + "name": "size256x256", + "value": "256x256", + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size512x512", + "value": "512x512", + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." + } + ] + } }, "response_format": { - "$ref": "#/definitions/ImageGenerationResponseFormat", + "type": "string", "description": "The format in which image generation response items should be presented.", "default": "url", + "enum": [ + "url", + "b64_json" + ], + "x-ms-enum": { + "name": "ImageGenerationResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "url", + "value": "url", + "description": "Image generation response items should provide a URL from which the image may be retrieved." + }, + { + "name": "base64", + "value": "b64_json", + "description": "Image generation response items should provide image data as a base64-encoded string." + } + ] + }, "x-ms-client-name": "responseFormat" }, "user": { @@ -1395,30 +1435,6 @@ "prompt" ] }, - "ImageGenerationResponseFormat": { - "type": "string", - "description": "The format in which the generated images are returned.", - "enum": [ - "url", - "b64_json" - ], - "x-ms-enum": { - "name": "ImageGenerationResponseFormat", - "modelAsString": true, - "values": [ - { - "name": "url", - "value": "url", - "description": "Image generation response items should provide a URL from which the image may be retrieved." - }, - { - "name": "base64", - "value": "b64_json", - "description": "Image generation response items should provide image data as a base64-encoded string." - } - ] - } - }, "ImageGenerations": { "type": "object", "description": "The result of a successful image generation operation.", @@ -1441,30 +1457,6 @@ "created", "data" ] - }, - "ImageSize": { - "type": "string", - "description": "The desired size of generated images.", - "enum": [ - "256x256", - "512x512" - ], - "x-ms-enum": { - "name": "ImageSize", - "modelAsString": true, - "values": [ - { - "name": "size256x256", - "value": "256x256", - "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." - }, - { - "name": "size512x512", - "value": "512x512", - "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." - } - ] - } } }, "parameters": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/examples/extensions_chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/examples/extensions_chat_completions.json index 5265df25b2e6..5aa5aebb5803 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/examples/extensions_chat_completions.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/examples/extensions_chat_completions.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "key": "{search admin key}", "indexName": "{index name}" } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json index 808d4193b987..eb5f8ec271b7 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json @@ -488,7 +488,7 @@ }, "AzureCognitiveSearchChatExtensionParameters": { "type": "object", - "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.", + "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. The supported authentication types are APIKey, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -1660,14 +1660,54 @@ "default": 1 }, "size": { - "$ref": "#/definitions/ImageSize", + "type": "string", "description": "The desired dimensions for generated images.\nDall-e-2 models support 256x256, 512x512, or 1024x1024.\nDall-e-3 models support 1024x1024, 1792x1024, or 1024x1792.", - "default": "1024x1024" + "default": "1024x1024", + "enum": [ + "256x256", + "512x512" + ], + "x-ms-enum": { + "name": "ImageSize", + "modelAsString": true, + "values": [ + { + "name": "size256x256", + "value": "256x256", + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size512x512", + "value": "512x512", + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." + } + ] + } }, "response_format": { - "$ref": "#/definitions/ImageGenerationResponseFormat", + "type": "string", "description": "The format in which image generation response items should be presented.", "default": "url", + "enum": [ + "url", + "b64_json" + ], + "x-ms-enum": { + "name": "ImageGenerationResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "url", + "value": "url", + "description": "Image generation response items should provide a URL from which the image may be retrieved." + }, + { + "name": "base64", + "value": "b64_json", + "description": "Image generation response items should provide image data as a base64-encoded string." + } + ] + }, "x-ms-client-name": "responseFormat" }, "user": { @@ -1679,30 +1719,6 @@ "prompt" ] }, - "ImageGenerationResponseFormat": { - "type": "string", - "description": "The format in which the generated images are returned.", - "enum": [ - "url", - "b64_json" - ], - "x-ms-enum": { - "name": "ImageGenerationResponseFormat", - "modelAsString": true, - "values": [ - { - "name": "url", - "value": "url", - "description": "Image generation response items should provide a URL from which the image may be retrieved." - }, - { - "name": "base64", - "value": "b64_json", - "description": "Image generation response items should provide image data as a base64-encoded string." - } - ] - } - }, "ImageGenerations": { "type": "object", "description": "The result of a successful image generation operation.", @@ -1726,29 +1742,24 @@ "data" ] }, - "ImageSize": { - "type": "string", - "description": "The desired size of generated images.", - "enum": [ - "256x256", - "512x512" + "OnYourDataAccessTokenAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using access token.", + "properties": { + "accessToken": { + "type": "string", + "description": "The access token to use for authentication." + } + }, + "required": [ + "accessToken" ], - "x-ms-enum": { - "name": "ImageSize", - "modelAsString": true, - "values": [ - { - "name": "size256x256", - "value": "256x256", - "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." - }, - { - "name": "size512x512", - "value": "512x512", - "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." - } - ] - } + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "AccessToken" }, "OnYourDataApiKeyAuthenticationOptions": { "type": "object", @@ -1790,6 +1801,8 @@ "APIKey", "ConnectionString", "KeyAndKeyId", + "EncodedAPIKey", + "AccessToken", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], @@ -1812,6 +1825,16 @@ "value": "KeyAndKeyId", "description": "Authentication via key and key ID pair." }, + { + "name": "encodedApiKey", + "value": "EncodedAPIKey", + "description": "Authentication via encoded API key." + }, + { + "name": "accessToken", + "value": "AccessToken", + "description": "Authentication via access token." + }, { "name": "systemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", @@ -1844,6 +1867,25 @@ ], "x-ms-discriminator-value": "ConnectionString" }, + "OnYourDataEncodedApiKeyAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.", + "properties": { + "encodedApiKey": { + "type": "string", + "description": "The encoded API key to use for authentication." + } + }, + "required": [ + "encodedApiKey" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "EncodedAPIKey" + }, "OnYourDataKeyAndKeyIdAuthenticationOptions": { "type": "object", "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/examples/extensions_chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/examples/extensions_chat_completions.json index dbaca3214431..7df840fc4769 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/examples/extensions_chat_completions.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/examples/extensions_chat_completions.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "key": "{search admin key}", "indexName": "{index name}" } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json index 3a090370b6ec..3ef96eced1cc 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json @@ -1119,7 +1119,7 @@ }, "AzureCognitiveSearchChatExtensionParameters": { "type": "object", - "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.", + "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. The supported authentication types are APIKey, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -2291,14 +2291,54 @@ "default": 1 }, "size": { - "$ref": "#/definitions/ImageSize", + "type": "string", "description": "The desired dimensions for generated images.\nDall-e-2 models support 256x256, 512x512, or 1024x1024.\nDall-e-3 models support 1024x1024, 1792x1024, or 1024x1792.", - "default": "1024x1024" + "default": "1024x1024", + "enum": [ + "256x256", + "512x512" + ], + "x-ms-enum": { + "name": "ImageSize", + "modelAsString": true, + "values": [ + { + "name": "size256x256", + "value": "256x256", + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size512x512", + "value": "512x512", + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." + } + ] + } }, "response_format": { - "$ref": "#/definitions/ImageGenerationResponseFormat", + "type": "string", "description": "The format in which image generation response items should be presented.", "default": "url", + "enum": [ + "url", + "b64_json" + ], + "x-ms-enum": { + "name": "ImageGenerationResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "url", + "value": "url", + "description": "Image generation response items should provide a URL from which the image may be retrieved." + }, + { + "name": "base64", + "value": "b64_json", + "description": "Image generation response items should provide image data as a base64-encoded string." + } + ] + }, "x-ms-client-name": "responseFormat" }, "user": { @@ -2310,30 +2350,6 @@ "prompt" ] }, - "ImageGenerationResponseFormat": { - "type": "string", - "description": "The format in which the generated images are returned.", - "enum": [ - "url", - "b64_json" - ], - "x-ms-enum": { - "name": "ImageGenerationResponseFormat", - "modelAsString": true, - "values": [ - { - "name": "url", - "value": "url", - "description": "Image generation response items should provide a URL from which the image may be retrieved." - }, - { - "name": "base64", - "value": "b64_json", - "description": "Image generation response items should provide image data as a base64-encoded string." - } - ] - } - }, "ImageGenerations": { "type": "object", "description": "The result of a successful image generation operation.", @@ -2357,29 +2373,24 @@ "data" ] }, - "ImageSize": { - "type": "string", - "description": "The desired size of generated images.", - "enum": [ - "256x256", - "512x512" + "OnYourDataAccessTokenAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using access token.", + "properties": { + "accessToken": { + "type": "string", + "description": "The access token to use for authentication." + } + }, + "required": [ + "accessToken" ], - "x-ms-enum": { - "name": "ImageSize", - "modelAsString": true, - "values": [ - { - "name": "size256x256", - "value": "256x256", - "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." - }, - { - "name": "size512x512", - "value": "512x512", - "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." - } - ] - } + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "AccessToken" }, "OnYourDataApiKeyAuthenticationOptions": { "type": "object", @@ -2421,6 +2432,8 @@ "APIKey", "ConnectionString", "KeyAndKeyId", + "EncodedAPIKey", + "AccessToken", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], @@ -2443,6 +2456,16 @@ "value": "KeyAndKeyId", "description": "Authentication via key and key ID pair." }, + { + "name": "encodedApiKey", + "value": "EncodedAPIKey", + "description": "Authentication via encoded API key." + }, + { + "name": "accessToken", + "value": "AccessToken", + "description": "Authentication via access token." + }, { "name": "systemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", @@ -2475,6 +2498,25 @@ ], "x-ms-discriminator-value": "ConnectionString" }, + "OnYourDataEncodedApiKeyAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.", + "properties": { + "encodedApiKey": { + "type": "string", + "description": "The encoded API key to use for authentication." + } + }, + "required": [ + "encodedApiKey" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "EncodedAPIKey" + }, "OnYourDataKeyAndKeyIdAuthenticationOptions": { "type": "object", "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_aml_index.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_aml_index.json index 24d661ad76fd..effee4f8f5a7 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_aml_index.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_aml_index.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_advanced.json index 0968a3dbea37..269dde63613b 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_advanced.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_advanced.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "authentication": { "type": "UserAssignedManagedIdentity", "managedIdentityResourceId": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_image_vector.json index 860e6e9e4b22..5c04637a4eb4 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_image_vector.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_image_vector.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "indexName": "{index name}", "queryType": "vector", "fieldsMapping": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_minimum.json index 6979c66744f7..378e5e33c51e 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_minimum.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_azure_search_minimum.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "AzureCognitiveSearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-search-endpoint.search.windows.net/", "indexName": "{index name}" } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_cosmos_db.json index d2d8295cefa8..6d34d089490b 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_cosmos_db.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_cosmos_db.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -32,6 +28,9 @@ "deploymentName": "{embedding deployment name}" }, "fieldsMapping": { + "contentFields": [ + "content" + ], "vectorFields": [ "contentvector" ] diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_elasticsearch.json index 01680301b679..db3ea789f8d5 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_elasticsearch.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_elasticsearch.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -20,7 +16,7 @@ { "type": "Elasticsearch", "parameters": { - "endpoint": "{search endpoint}", + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", "indexName": "{index name}", "authentication": { "type": "KeyAndKeyId", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_pinecone.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_pinecone.json index 2cbd35ec2ab5..3cac930b509b 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_pinecone.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions_pinecone.json @@ -7,10 +7,6 @@ "deploymentId": "", "body": { "messages": [ - { - "role": "system", - "content": "you are a helpful assistant that talks like a pirate" - }, { "role": "user", "content": "can you tell me how to care for a parrot?" @@ -22,7 +18,7 @@ "parameters": { "authentication": { "type": "APIKey", - "apiKey": "{api key}" + "key": "{api key}" }, "environment": "{environment name}", "indexName": "{index name}", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/generated.json index 786ed8ecd433..74add800f99a 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/generated.json @@ -1167,7 +1167,7 @@ }, "AzureCognitiveSearchChatExtensionParameters": { "type": "object", - "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.", + "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. The supported authentication types are APIKey, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -1315,7 +1315,7 @@ }, "AzureCosmosDBChatExtensionConfiguration": { "type": "object", - "description": "A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat\nextension.", + "description": "A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat\nextension.", "properties": { "parameters": { "$ref": "#/definitions/AzureCosmosDBChatExtensionParameters", @@ -1334,7 +1334,7 @@ }, "AzureCosmosDBChatExtensionParameters": { "type": "object", - "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore.", + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore. The supported authentication type is ConnectionString.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -1385,13 +1385,37 @@ "databaseName", "containerName", "indexName", - "fieldsMapping" + "fieldsMapping", + "embeddingDependency" ] }, "AzureCosmosDBFieldMappingOptions": { "type": "object", "description": "Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource.", "properties": { + "titleField": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "urlField": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepathField": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "contentFields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "contentFieldsSeparator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, "vectorFields": { "type": "array", "description": "The names of fields that represent vector data.", @@ -1401,6 +1425,7 @@ } }, "required": [ + "contentFields", "vectorFields" ] }, @@ -1518,7 +1543,7 @@ }, "AzureMachineLearningIndexChatExtensionParameters": { "type": "object", - "description": "Parameters for the Azure Machine Learning vector index chat extension.", + "description": "Parameters for the Azure Machine Learning vector index chat extension. The supported authentication types are AccessToken, SystemAssignedManagedIdentity and UserAssignedManagedIdentity.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -2637,7 +2662,7 @@ }, "ElasticsearchChatExtensionParameters": { "type": "object", - "description": "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension.", + "description": "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. The supported authentication types are KeyAndKeyId and EncodedAPIKey.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -2919,25 +2944,123 @@ "default": 1 }, "size": { - "$ref": "#/definitions/ImageSize", + "type": "string", "description": "The desired dimensions for generated images.\nDall-e-2 models support 256x256, 512x512, or 1024x1024.\nDall-e-3 models support 1024x1024, 1792x1024, or 1024x1792.", - "default": "1024x1024" + "default": "1024x1024", + "enum": [ + "256x256", + "512x512", + "1024x1024", + "1792x1024", + "1024x1792" + ], + "x-ms-enum": { + "name": "ImageSize", + "modelAsString": true, + "values": [ + { + "name": "size256x256", + "value": "256x256", + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size512x512", + "value": "512x512", + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size1024x1024", + "value": "1024x1024", + "description": "A standard, square image size of 1024x1024 pixels.\nSupported by both dall-e-2 and dall-e-3 models." + }, + { + "name": "size1792x1024", + "value": "1792x1024", + "description": "A wider image size of 1024x1792 pixels.\nOnly supported with dall-e-3 models." + }, + { + "name": "size1024x1792", + "value": "1024x1792", + "description": "A taller image size of 1792x1024 pixels.\nOnly supported with dall-e-3 models." + } + ] + } }, "response_format": { - "$ref": "#/definitions/ImageGenerationResponseFormat", + "type": "string", "description": "The format in which image generation response items should be presented.", "default": "url", + "enum": [ + "url", + "b64_json" + ], + "x-ms-enum": { + "name": "ImageGenerationResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "url", + "value": "url", + "description": "Image generation response items should provide a URL from which the image may be retrieved." + }, + { + "name": "base64", + "value": "b64_json", + "description": "Image generation response items should provide image data as a base64-encoded string." + } + ] + }, "x-ms-client-name": "responseFormat" }, "quality": { - "$ref": "#/definitions/ImageGenerationQuality", + "type": "string", "description": "The desired image generation quality level to use.\nOnly configurable with dall-e-3 models.", - "default": "standard" + "default": "standard", + "enum": [ + "standard", + "hd" + ], + "x-ms-enum": { + "name": "ImageGenerationQuality", + "modelAsString": true, + "values": [ + { + "name": "standard", + "value": "standard", + "description": "Requests image generation with standard, balanced characteristics of quality, cost, and speed." + }, + { + "name": "hd", + "value": "hd", + "description": "Requests image generation with higher quality, higher cost and lower speed relative to standard." + } + ] + } }, "style": { - "$ref": "#/definitions/ImageGenerationStyle", + "type": "string", "description": "The desired image generation style to use.\nOnly configurable with dall-e-3 models.", - "default": "vivid" + "default": "vivid", + "enum": [ + "natural", + "vivid" + ], + "x-ms-enum": { + "name": "ImageGenerationStyle", + "modelAsString": true, + "values": [ + { + "name": "natural", + "value": "natural", + "description": "Requests image generation in a natural style with less preference for dramatic and hyper-realistic characteristics." + }, + { + "name": "vivid", + "value": "vivid", + "description": "Requests image generation in a vivid style with a higher preference for dramatic and hyper-realistic\ncharacteristics." + } + ] + } }, "user": { "type": "string", @@ -2948,78 +3071,6 @@ "prompt" ] }, - "ImageGenerationQuality": { - "type": "string", - "description": "An image generation configuration that specifies how the model should prioritize quality, cost, and speed.\nOnly configurable with dall-e-3 models.", - "enum": [ - "standard", - "hd" - ], - "x-ms-enum": { - "name": "ImageGenerationQuality", - "modelAsString": true, - "values": [ - { - "name": "standard", - "value": "standard", - "description": "Requests image generation with standard, balanced characteristics of quality, cost, and speed." - }, - { - "name": "hd", - "value": "hd", - "description": "Requests image generation with higher quality, higher cost and lower speed relative to standard." - } - ] - } - }, - "ImageGenerationResponseFormat": { - "type": "string", - "description": "The format in which the generated images are returned.", - "enum": [ - "url", - "b64_json" - ], - "x-ms-enum": { - "name": "ImageGenerationResponseFormat", - "modelAsString": true, - "values": [ - { - "name": "url", - "value": "url", - "description": "Image generation response items should provide a URL from which the image may be retrieved." - }, - { - "name": "base64", - "value": "b64_json", - "description": "Image generation response items should provide image data as a base64-encoded string." - } - ] - } - }, - "ImageGenerationStyle": { - "type": "string", - "description": "An image generation configuration that specifies how the model should incorporate realism and other visual characteristics.\nOnly configurable with dall-e-3 models.", - "enum": [ - "natural", - "vivid" - ], - "x-ms-enum": { - "name": "ImageGenerationStyle", - "modelAsString": true, - "values": [ - { - "name": "natural", - "value": "natural", - "description": "Requests image generation in a natural style with less preference for dramatic and hyper-realistic characteristics." - }, - { - "name": "vivid", - "value": "vivid", - "description": "Requests image generation in a vivid style with a higher preference for dramatic and hyper-realistic\ncharacteristics." - } - ] - } - }, "ImageGenerations": { "type": "object", "description": "The result of a successful image generation operation.", @@ -3043,48 +3094,6 @@ "data" ] }, - "ImageSize": { - "type": "string", - "description": "The desired size of generated images.", - "enum": [ - "256x256", - "512x512", - "1024x1024", - "1792x1024", - "1024x1792" - ], - "x-ms-enum": { - "name": "ImageSize", - "modelAsString": true, - "values": [ - { - "name": "size256x256", - "value": "256x256", - "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." - }, - { - "name": "size512x512", - "value": "512x512", - "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." - }, - { - "name": "size1024x1024", - "value": "1024x1024", - "description": "A standard, square image size of 1024x1024 pixels.\nSupported by both dall-e-2 and dall-e-3 models." - }, - { - "name": "size1792x1024", - "value": "1792x1024", - "description": "A wider image size of 1024x1792 pixels.\nOnly supported with dall-e-3 models." - }, - { - "name": "size1024x1792", - "value": "1024x1792", - "description": "A taller image size of 1792x1024 pixels.\nOnly supported with dall-e-3 models." - } - ] - } - }, "MaxTokensFinishDetails": { "type": "object", "description": "A structured representation of a stop reason that signifies a token limit was reached before the model could naturally\ncomplete.", @@ -3095,6 +3104,25 @@ ], "x-ms-discriminator-value": "max_tokens" }, + "OnYourDataAccessTokenAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using access token.", + "properties": { + "accessToken": { + "type": "string", + "description": "The access token to use for authentication." + } + }, + "required": [ + "accessToken" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "AccessToken" + }, "OnYourDataApiKeyAuthenticationOptions": { "type": "object", "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", @@ -3135,6 +3163,8 @@ "APIKey", "ConnectionString", "KeyAndKeyId", + "EncodedAPIKey", + "AccessToken", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], @@ -3157,6 +3187,16 @@ "value": "KeyAndKeyId", "description": "Authentication via key and key ID pair." }, + { + "name": "encodedApiKey", + "value": "EncodedAPIKey", + "description": "Authentication via encoded API key." + }, + { + "name": "accessToken", + "value": "AccessToken", + "description": "Authentication via access token." + }, { "name": "systemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", @@ -3208,6 +3248,25 @@ ], "x-ms-discriminator-value": "DeploymentName" }, + "OnYourDataEncodedApiKeyAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.", + "properties": { + "encodedApiKey": { + "type": "string", + "description": "The encoded API key to use for authentication." + } + }, + "required": [ + "encodedApiKey" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "EncodedAPIKey" + }, "OnYourDataEndpointVectorizationSource": { "type": "object", "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a public Azure OpenAI endpoint call for embeddings.", @@ -3351,7 +3410,7 @@ }, "PineconeChatExtensionConfiguration": { "type": "object", - "description": "A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat\nextension.", + "description": "A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat\nextension.", "properties": { "parameters": { "$ref": "#/definitions/PineconeChatExtensionParameters", @@ -3370,7 +3429,7 @@ }, "PineconeChatExtensionParameters": { "type": "object", - "description": "Parameters for configuring Azure OpenAI Pinecone chat extensions.", + "description": "Parameters for configuring Azure OpenAI Pinecone chat extensions. The supported authentication type is APIKey.", "properties": { "authentication": { "$ref": "#/definitions/OnYourDataAuthenticationOptions", @@ -3416,7 +3475,8 @@ "required": [ "environment", "indexName", - "fieldsMapping" + "fieldsMapping", + "embeddingDependency" ] }, "PineconeFieldMappingOptions": { @@ -3445,22 +3505,11 @@ "contentFieldsSeparator": { "type": "string", "description": "The separator pattern that content fields should use." - }, - "vectorFields": { - "type": "array", - "description": "The names of fields that represent vector data.", - "items": { - "type": "string" - } - }, - "imageVectorFields": { - "type": "array", - "description": "The names of fields that represent image vector data.", - "items": { - "type": "string" - } } - } + }, + "required": [ + "contentFields" + ] }, "StopFinishDetails": { "type": "object", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_speech.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_speech.json new file mode 100644 index 000000000000..6b71ed12426c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_speech.json @@ -0,0 +1,18 @@ +{ + "title": "Synthesizes audio from the provided text.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": { + "input": "Hi! What are you going to make?", + "voice": "fable", + "response_format": "mp3" + } + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_speech.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_speech.yaml new file mode 100644 index 000000000000..5e736d7e8f3d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_speech.yaml @@ -0,0 +1,12 @@ +parameters: + api-version: 2024-02-15-preview + body: + input: Hi! What are you going to make? + response_format: mp3 + voice: fable + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + body: '101010101' +title: Synthesizes audio from the provided text. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_object.json new file mode 100644 index 000000000000..589e96259233 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_object.json @@ -0,0 +1,15 @@ +{ + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_object.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_object.yaml new file mode 100644 index 000000000000..0ca2a9b06f5c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_object.yaml @@ -0,0 +1,9 @@ +parameters: + api-version: 2024-02-15-preview + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + body: + text: A structured object when requesting json or verbose_json +title: Gets transcribed text and associated metadata from provided spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_text.json new file mode 100644 index 000000000000..fcb012365704 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_text.json @@ -0,0 +1,15 @@ +{ + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "type": "string", + "example": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_text.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_text.yaml new file mode 100644 index 000000000000..8228d817e810 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_transcription_text.yaml @@ -0,0 +1,19 @@ +parameters: + api-version: 2024-02-15-preview + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + example: plain text when requesting text, srt, or vtt + type: string +title: Gets transcribed text and associated metadata from provided spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_object.json new file mode 100644 index 000000000000..e0d9eb77b9af --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_object.json @@ -0,0 +1,16 @@ +{ + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_object.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_object.yaml new file mode 100644 index 000000000000..e6ef138b14d0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_object.yaml @@ -0,0 +1,20 @@ +parameters: + api-version: 2024-02-15-preview + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + body: + text: A structured object when requesting json or verbose_json +title: Gets English language transcribed text and associated metadata from provided + spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_text.json new file mode 100644 index 000000000000..24fdbdaf8461 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_text.json @@ -0,0 +1,15 @@ +{ + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "type": "string", + "example": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_text.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_text.yaml new file mode 100644 index 000000000000..853bf7d2bf5a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/audio_translation_text.yaml @@ -0,0 +1,20 @@ +parameters: + api-version: 2024-02-15-preview + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + example: plain text when requesting text, srt, or vtt + type: string +title: Gets English language transcribed text and associated metadata from provided + spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/cancel_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/cancel_run.json new file mode 100644 index 000000000000..1ae47c75eb57 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/cancel_run.json @@ -0,0 +1,37 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_BUf53eW0aua3EjHTyO3P3evb", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106", + "instructions": "You solve math problems.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [], + "metadata": {}, + "usage": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/cancel_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/cancel_run.yaml new file mode 100644 index 000000000000..30cc8c7e8717 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/cancel_run.yaml @@ -0,0 +1,29 @@ +title: | + Cancels a run that is `in_progress`. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q +responses: + '200': + body: + id: run_HsO8tYM4K5AAMAHgK0J3om8Q + object: thread.run + created_at: 1699076126 + assistant_id: asst_BUf53eW0aua3EjHTyO3P3evb + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + status: cancelling + started_at: 1699076126 + expires_at: 1699076726 + cancelled_at: null + failed_at: null + completed_at: null + last_error: null + model: gpt-4-1106 + instructions: You solve math problems. + tools: + - type: code_interpreter + file_ids: [] + metadata: {} + usage: null diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions.json new file mode 100644 index 000000000000..8d0909394bc9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions.json @@ -0,0 +1,43 @@ +{ + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!" + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions.yaml new file mode 100644 index 000000000000..af87d3c50612 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions.yaml @@ -0,0 +1,45 @@ +title: Creates a completion for the provided prompt, parameters and chosen model. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + deployment-id: + body: + messages: + - role: system + content: you are a helpful assistant that talks like a pirate + - role: user + content: can you tell me how to care for a parrot? +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: |- + Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy: + + 1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr! + + 2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh! + + 3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands! + + 4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh! + + 5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr! + + 6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag! + + 7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be. + + 8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners. + + So there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' "Yo-ho-ho" for many years to come! Good luck, sailor, and may the wind be at yer back! + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_aml_index.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_aml_index.json new file mode 100644 index 000000000000..c1ff889c6473 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_aml_index.json @@ -0,0 +1,67 @@ +{ + "title": "Creates a completion for the provided AML index.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_ml_index", + "parameters": { + "project_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-id}", + "name": "gm-cars", + "version": "5", + "authentication": { + "type": "access_token", + "access_token": "{access-token}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "file_path": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intents": [ + "dog care" + ] + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_aml_index.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_aml_index.yaml new file mode 100644 index 000000000000..abed6a93fc27 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_aml_index.yaml @@ -0,0 +1,42 @@ +title: Creates a completion for the provided AML index. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_ml_index + parameters: + project_resource_id: /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-id} + name: gm-cars + version: '5' + authentication: + type: access_token + access_token: '{access-token}' +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + file_path: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: '0' + intents: + - dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..fe47c0bf24a4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_advanced.json @@ -0,0 +1,96 @@ +{ + "title": "Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a cat?" + }, + { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "intent": "cat care" + } + }, + { + "role": "user", + "content": "how about dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "authentication": { + "type": "user_assigned_managed_identity", + "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" + }, + "index_name": "{index name}", + "query_type": "vector", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "in_scope": true, + "top_n_documents": 5, + "strictness": 3, + "role_information": "You are an AI assistant that helps people find information.", + "fields_mapping": { + "content_fields_separator": "\\n", + "content_fields": [ + "content" + ], + "filepath_field": "filepath", + "title_field": "title", + "url_field": "url", + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content 2.", + "title": "Citation Title 2", + "filepath": "contoso2.txt", + "url": "https://contoso.blob.windows.net/container/contoso2.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_advanced.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_advanced.yaml new file mode 100644 index 000000000000..5d47a380ca37 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_advanced.yaml @@ -0,0 +1,63 @@ +title: Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a cat? + - role: assistant + content: Content of the completion [doc1]. + context: + intent: cat care + - role: user + content: how about dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + authentication: + type: user_assigned_managed_identity + managed_identity_resource_id: /subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name} + index_name: '{index name}' + query_type: vector + embedding_dependency: + type: deployment_name + deployment_name: '{embedding deployment name}' + in_scope: true + top_n_documents: 5 + strictness: 3 + role_information: You are an AI assistant that helps people find information. + fields_mapping: + content_fields_separator: \n + content_fields: + - content + filepath_field: filepath + title_field: title + url_field: url + vector_fields: + - contentvector +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content 2. + title: Citation Title 2 + filepath: contoso2.txt + url: https://contoso.blob.windows.net/container/contoso2.txt + chunk_id: '0' + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..1fba1b49e9da --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_image_vector.json @@ -0,0 +1,58 @@ +{ + "title": "Creates a completion based on Azure Search image vector data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "query_type": "vector", + "fields_mapping": { + "image_vector_fields": [ + "image_vector" + ] + }, + "authentication": { + "type": "api_key", + "key": "{api key}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion." + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_image_vector.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_image_vector.yaml new file mode 100644 index 000000000000..9391ebd0cb1d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_image_vector.yaml @@ -0,0 +1,36 @@ +title: Creates a completion based on Azure Search image vector data. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + index_name: '{index name}' + query_type: vector + fields_mapping: + image_vector_fields: + - image_vector + authentication: + type: api_key + key: '{api key}' +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion. + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..9ec638298690 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_minimum.json @@ -0,0 +1,63 @@ +{ + "title": "Creates a completion based on Azure Search data and system-assigned managed identity.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "authentication": { + "type": "system_assigned_managed_identity" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_minimum.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_minimum.yaml new file mode 100644 index 000000000000..bb3466d18172 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_azure_search_minimum.yaml @@ -0,0 +1,39 @@ +title: Creates a completion based on Azure Search data and system-assigned managed identity. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + index_name: '{index name}' + authentication: + type: system_assigned_managed_identity +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: '0' + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_cosmos_db.json new file mode 100644 index 000000000000..d37173e3e4e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_cosmos_db.json @@ -0,0 +1,77 @@ +{ + "title": "Creates a completion for the provided Azure Cosmos DB.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_cosmos_db", + "parameters": { + "authentication": { + "type": "connection_string", + "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" + }, + "database_name": "vectordb", + "container_name": "azuredocs", + "index_name": "azuredocindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_cosmos_db.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_cosmos_db.yaml new file mode 100644 index 000000000000..00f5a791c77e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_cosmos_db.yaml @@ -0,0 +1,49 @@ +title: Creates a completion for the provided Azure Cosmos DB. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_cosmos_db + parameters: + authentication: + type: connection_string + connection_string: mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000 + database_name: vectordb + container_name: azuredocs + index_name: azuredocindex + embedding_dependency: + type: deployment_name + deployment_name: '{embedding deployment name}' + fields_mapping: + content_fields: + - content + vector_fields: + - contentvector +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: '0' + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_elasticsearch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_elasticsearch.json new file mode 100644 index 000000000000..c034629aa929 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_elasticsearch.json @@ -0,0 +1,65 @@ +{ + "title": "Creates a completion for the provided Elasticsearch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "elasticsearch", + "parameters": { + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", + "index_name": "{index name}", + "authentication": { + "type": "key_and_key_id", + "key": "{key}", + "key_id": "{key id}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_elasticsearch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_elasticsearch.yaml new file mode 100644 index 000000000000..6454f05823e1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_elasticsearch.yaml @@ -0,0 +1,41 @@ +title: Creates a completion for the provided Elasticsearch. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: elasticsearch + parameters: + endpoint: https://your-elasticsearch-endpoint.eastus.azurecontainer.io + index_name: '{index name}' + authentication: + type: key_and_key_id + key: '{key}' + key_id: '{key id}' +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: '0' + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_pinecone.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_pinecone.json new file mode 100644 index 000000000000..af0de4fc59aa --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_pinecone.json @@ -0,0 +1,77 @@ +{ + "title": "Creates a completion for the provided Pinecone resource.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "pinecone", + "parameters": { + "authentication": { + "type": "api_key", + "key": "{api key}" + }, + "environment": "{environment name}", + "index_name": "{index name}", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "title_field": "title", + "url_field": "url", + "filepath_field": "filepath", + "content_fields": [ + "content" + ], + "content_fields_separator": "\n" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_pinecone.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_pinecone.yaml new file mode 100644 index 000000000000..4557ce667ea5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/chat_completions_pinecone.yaml @@ -0,0 +1,51 @@ +title: Creates a completion for the provided Pinecone resource. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: pinecone + parameters: + authentication: + type: api_key + key: '{api key}' + environment: '{environment name}' + index_name: '{index name}' + embedding_dependency: + type: deployment_name + deployment_name: '{embedding deployment name}' + fields_mapping: + title_field: title + url_field: url + filepath_field: filepath + content_fields: + - content + content_fields_separator: |+ + +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: '0' + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/completions.json new file mode 100644 index 000000000000..578d3849066a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/completions.json @@ -0,0 +1,38 @@ +{ + "operationId": "GetCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": { + "prompt": [ + "tell me a joke about mango" + ], + "max_tokens": 32, + "temperature": 1.0, + "n": 1 + } + }, + "responses": { + "200": { + "body": { + "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq", + "created": 1686617332, + "choices": [ + { + "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.", + "index": 0, + "finish_reason": "stop", + "logprobs": null + } + ], + "usage": { + "completion_tokens": 20, + "prompt_tokens": 6, + "total_tokens": 26 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant.json new file mode 100644 index 000000000000..cb6924ff4488 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant.json @@ -0,0 +1,42 @@ +{ + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview", + "file_ids": [ + "assistant-0GeMWRaTlEASVHujzBXIcvbo" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [ + "assistant-0GeMWRaTlEASVHujzBXIcvbo" + ], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant.yaml new file mode 100644 index 000000000000..0a0e147099e6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant.yaml @@ -0,0 +1,27 @@ +title: Create an assistant with a model and instructions. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + body: + name: Math Tutor + instructions: When a customer asks about a specific math problem, use Python to evaluate their query. + tools: + - type: code_interpreter + model: gpt-4-1106-preview + file_ids: + - assistant-0GeMWRaTlEASVHujzBXIcvbo +responses: + '200': + body: + id: asst_4nsG2qgNzimRPE7MazXTXbU7 + object: assistant + created_at: 1707295707 + name: Math Tutor + description: null + model: gpt-4-1106-preview + instructions: When a customer asks about a specific math problem, use Python to evaluate their query. + tools: + - type: code_interpreter + file_ids: + - assistant-0GeMWRaTlEASVHujzBXIcvbo + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant_file.json new file mode 100644 index 000000000000..caac97728edc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant_file.json @@ -0,0 +1,21 @@ +{ + "title": "Create an assistant file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "body": { + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + } + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant_file.yaml new file mode 100644 index 000000000000..f2181666df06 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_assistant_file.yaml @@ -0,0 +1,14 @@ +title: Create an assistant file. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + body: + file_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX +responses: + '200': + body: + id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file + created_at: 1707324164 + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_message.json new file mode 100644 index 000000000000..8603319ccfb0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_message.json @@ -0,0 +1,36 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_message.yaml new file mode 100644 index 000000000000..8603319ccfb0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_message.yaml @@ -0,0 +1,36 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_run.json new file mode 100644 index 000000000000..03ae58f607b7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_run.json @@ -0,0 +1,34 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "body": { + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI" + } + }, + "responses": { + "200": { + "body": { + "id": "run_dmC5IgLBfaK8gBy0FKIXGtpr", + "object": "thread.run", + "created_at": 1707301142, + "assistant_id": "asst_w35g5ODgBl2U3KW417deY1QI", + "thread_id": "thread_2CTH1wOJezLOA3QRefyO3wyk", + "status": "queued", + "started_at": null, + "expires_at": 1707301742, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_run.yaml new file mode 100644 index 000000000000..ff9a4f474284 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_run.yaml @@ -0,0 +1,27 @@ +title: Create a run. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_2CTH1wOJezLOA3QRefyO3wyk + body: + assistant_id: asst_w35g5ODgBl2U3KW417deY1QI +responses: + '200': + body: + id: run_dmC5IgLBfaK8gBy0FKIXGtpr + object: thread.run + created_at: 1707301142 + assistant_id: asst_w35g5ODgBl2U3KW417deY1QI + thread_id: thread_2CTH1wOJezLOA3QRefyO3wyk + status: queued + started_at: null + expires_at: 1707301742 + cancelled_at: null + failed_at: null + completed_at: null + last_error: null + model: gpt-4-1106-preview + instructions: You are an AI model that empowers every person and every organization on the planet to achieve more. + tools: [] + file_ids: [] + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread.json new file mode 100644 index 000000000000..a89dea899924 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread.json @@ -0,0 +1,17 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread.yaml new file mode 100644 index 000000000000..205bd57dc6d6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread.yaml @@ -0,0 +1,11 @@ +title: Creates a thread. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview +responses: + '200': + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread + created_at: 1707297136 + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread_and_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread_and_run.json new file mode 100644 index 000000000000..8b7a5ad25176 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread_and_run.json @@ -0,0 +1,33 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "body": { + "assistant_id": "{{assistants.id}}" + } + }, + "responses": { + "200": { + "body": { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "queued", + "started_at": null, + "expires_at": 1707300852, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread_and_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread_and_run.yaml new file mode 100644 index 000000000000..8269b597124b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/create_thread_and_run.yaml @@ -0,0 +1,26 @@ +title: Create a thread and run it in one request. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + body: + assistant_id: '{{assistants.id}}' +responses: + '200': + body: + id: run_jwY1tMUeOjSpq0Swwm6JqSi6 + object: thread.run + created_at: 1707300252 + assistant_id: asst_se10QpYqDv7RQx13zdpskKlz + thread_id: thread_7CJfaYBtuRIOSksocRrYNQGV + status: queued + started_at: null + expires_at: 1707300852 + cancelled_at: null + failed_at: null + completed_at: null + last_error: null + model: gpt-4-1106-preview + instructions: You are an AI model that empowers every person and every organization on the planet to achieve more. + tools: [] + file_ids: [] + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant.json new file mode 100644 index 000000000000..33041a9a2100 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant.yaml new file mode 100644 index 000000000000..5908afa4be56 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant.yaml @@ -0,0 +1,11 @@ +title: Deletes an assistant. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + assistant_id: asst_4nsG2qgNzimRPE7MazXTXbU7 +responses: + '200': + body: + id: asst_4nsG2qgNzimRPE7MazXTXbU7 + object: assistant.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant_file.json new file mode 100644 index 000000000000..39858bd9f0c0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant_file.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an AssistantFile.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant_file.yaml new file mode 100644 index 000000000000..81aa1829f545 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_assistant_file.yaml @@ -0,0 +1,12 @@ +title: Deletes an AssistantFile. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + file_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX +responses: + '200': + body: + id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_thread.json new file mode 100644 index 000000000000..1e40049a8911 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_thread.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_thread.yaml new file mode 100644 index 000000000000..5ab0d3b8b937 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/delete_thread.yaml @@ -0,0 +1,11 @@ +title: Deletes a thread. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx +responses: + '200': + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/embeddings.json new file mode 100644 index 000000000000..b21736616266 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/embeddings.json @@ -0,0 +1,1566 @@ +{ + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "deployment-afa0669ca01e4693ae3a93baf40f26d6", + "body": { + "input": [ + "this is a test" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "index": 0, + "embedding": [ + -0.012838088, + -0.007421397, + -0.017617522, + -0.028278312, + -0.018666342, + 0.01737855, + -0.01821495, + -0.006950092, + -0.009937238, + -0.038580645, + 0.010674067, + 0.02412286, + -0.013647936, + 0.013189907, + 0.0021125758, + 0.012406612, + 0.020790534, + 0.00074595667, + 0.008397198, + -0.00535031, + 0.008968075, + 0.014351576, + -0.014086051, + 0.015055214, + -0.022211088, + -0.025198232, + 0.0065186154, + -0.036350243, + 0.009180495, + -0.009698266, + 0.009446018, + -0.008463579, + -0.0040426035, + -0.03443847, + -0.00091273896, + -0.0019217303, + 0.002349888, + -0.021560553, + 0.016515596, + -0.015572986, + 0.0038666942, + -0.00008432463, + 0.0032178196, + -0.020365695, + -0.009631885, + -0.007647093, + 0.0033837722, + -0.026764825, + -0.010501476, + 0.020219658, + 0.024640633, + -0.0066912062, + -0.036456455, + -0.0040923897, + -0.013966565, + 0.017816665, + 0.005366905, + 0.022835068, + 0.0103488, + -0.0010811808, + -0.028942121, + 0.0074280356, + -0.017033368, + 0.0074877786, + 0.021640211, + 0.002499245, + 0.013316032, + 0.0021524043, + 0.010129742, + 0.0054731146, + 0.03143805, + 0.014856071, + 0.0023366117, + -0.0008243692, + 0.022781964, + 0.003038591, + -0.017617522, + 0.0013309394, + 0.0022154662, + 0.00097414135, + 0.012041516, + -0.027906578, + -0.023817508, + 0.013302756, + -0.003003741, + -0.006890349, + 0.0016744611, + 0.023658194, + -0.015851786, + -0.0045305043, + -0.003038591, + 0.017710455, + 0.019237218, + 0.016037652, + -0.022503164, + 0.025795663, + -0.001129307, + 0.032500144, + -0.008178141, + -0.019940857, + -0.009877495, + 0.00018918588, + 0.023060765, + -0.005692172, + -0.018347712, + -0.011039163, + -0.0062066247, + -0.0000524047, + 0.020126723, + -0.0011691356, + -0.015811957, + 0.020086896, + -0.009114114, + -0.03056182, + 0.0029025099, + -0.006591635, + -0.014046223, + -0.01590489, + -0.02307404, + -0.008861865, + -0.004832538, + 0.010030171, + 0.02311387, + -0.012652221, + 0.024906157, + 0.003860056, + -0.01936998, + -0.02957938, + -0.008357369, + -0.0016371218, + 0.027800368, + 0.0077333883, + 0.021626934, + 0.02140124, + -0.030482162, + 0.026406368, + -0.008277712, + 0.012884554, + -0.043784916, + -0.0145639945, + -0.0070297495, + 0.034889862, + -0.00041508878, + -0.010528029, + -0.009572142, + 0.015692472, + 0.037810627, + -0.0022021902, + 0.008662722, + -0.016794397, + 0.0003090866, + -0.0060506295, + 0.015227805, + 0.0006650548, + 0.01842737, + 0.036801632, + -0.002461076, + -0.0029390194, + -0.0057120863, + -0.012486269, + -0.0046831807, + -0.0017474802, + -0.0036210844, + -0.01178263, + 0.017869769, + 0.039111692, + 0.010946229, + 0.018467197, + 0.0027780454, + -0.005851486, + -0.016489044, + 0.03186289, + -0.040333103, + 0.016648358, + -0.006870435, + 0.0072687212, + 0.000002370982, + 0.006465511, + -0.018201673, + -0.00020526254, + -0.025410652, + 0.02010017, + 0.017537864, + 0.022821793, + 0.0064555537, + -0.0012969191, + 0.02157383, + -0.0053536287, + -0.0087622935, + -0.010952868, + 0.017564416, + 0.02185263, + 0.0004733796, + 0.0018337755, + -0.6954606, + -0.011231667, + 0.02748174, + 0.003929756, + 0.0144843375, + 0.045192193, + 0.01898497, + -0.0070363875, + -0.007813046, + 0.017604245, + -0.017790113, + 0.011165286, + -0.0036376796, + -0.014736585, + 0.0016421003, + -0.019144284, + -0.0072222543, + -0.023127146, + 0.006936816, + 0.025198232, + 0.0030219958, + 0.011722887, + -0.004271618, + -0.0011127117, + -0.0051047, + 0.00077333883, + 0.018599961, + 0.0074877786, + 0.010820106, + 0.0033406245, + -0.015055214, + 0.02384406, + 0.006090458, + 0.00891497, + 0.023366116, + -0.011078991, + -0.019582398, + 0.0011566891, + 0.015413672, + 0.01793615, + -0.014736585, + 0.002492607, + 0.027800368, + 0.023923717, + -0.007421397, + 0.0016105693, + 0.011337877, + -0.015041938, + -0.008768932, + -0.003982861, + 0.002884255, + -0.007832959, + 0.0025457118, + -0.0023548664, + -0.0061767534, + -0.016754568, + 0.0006036523, + 0.0105346665, + 0.0055361767, + 0.01478969, + -0.0011251582, + 0.009605332, + -0.0037140178, + -0.017537864, + -0.021733144, + 0.012897831, + -0.024481317, + 0.022290744, + 0.0056523434, + -0.005366905, + 0.0020412162, + 0.013435517, + -0.003408665, + -0.01705992, + 0.029446619, + 0.022011945, + 0.009226961, + -0.003310753, + -0.007939169, + 0.021308305, + 0.0026718357, + 0.002129171, + -0.020047067, + -0.007474502, + 0.021534001, + -0.0110590765, + -0.018374264, + -0.001664504, + -0.003923118, + 0.015387119, + 0.025516862, + 0.0016421003, + -0.017498035, + -0.01825478, + 0.01451089, + -0.008198055, + -0.011656506, + 0.0044242945, + 0.031491153, + 0.01017621, + -0.010408543, + -0.009034456, + -0.0023283141, + 0.012021601, + 0.015639367, + 0.011736163, + 0.007912617, + 0.02031259, + 0.022104878, + -0.02241023, + 0.00041156227, + -0.009817752, + -0.030880447, + -0.0017823302, + 0.0030933553, + -0.04128899, + -0.0007783174, + 0.012393335, + 0.0122273825, + -0.009087561, + 0.022728859, + -0.002884255, + 0.028065892, + 0.0047396044, + 0.008065294, + 0.015519881, + 0.0133956885, + -0.02279524, + -0.011729525, + 0.0037206558, + -0.0046732235, + 0.003587894, + 0.024401661, + -0.013574918, + 0.012685412, + -0.0041620894, + 0.020578114, + 0.007394845, + 0.014139156, + -0.012512821, + -0.021042781, + 0.022423506, + -0.015360567, + 0.004009413, + 0.0104550095, + -0.024799947, + -0.0081449505, + -0.00063850236, + 0.0070231115, + -0.0009633545, + -0.015705748, + -0.0028942123, + -0.008815398, + 0.007461226, + -0.014417957, + -0.012931022, + 0.0015674217, + -0.02506547, + -0.0063128346, + -0.013422241, + -0.0058614435, + -0.0006007482, + -0.015002109, + 0.0037040606, + -0.008410474, + -0.0016089098, + -0.018653065, + 0.020538285, + -0.016980262, + -0.042244878, + -0.017498035, + 0.006727716, + -0.01877255, + 0.008987989, + 0.00077665783, + -0.0007119364, + -0.0067243967, + 0.0038467797, + -0.018055636, + -0.01440468, + 0.007534245, + 0.0051212953, + 0.002741536, + 0.011523744, + -0.0018603279, + 0.023684746, + 0.016196968, + 0.01731217, + -0.01992758, + 0.009372999, + -0.01982137, + 0.001150051, + -0.014417957, + 0.005672258, + -0.015785405, + 0.0049387473, + -0.0051445286, + 0.012632307, + 0.0011666464, + 0.024587527, + 0.04259006, + -0.0025672857, + 0.02311387, + -0.014524166, + 0.0013848739, + -0.04105002, + -0.010089914, + -0.009087561, + 0.015440224, + 0.009207047, + 0.0128048975, + -0.030216638, + -0.02549031, + 0.00499849, + 0.02737553, + 0.024985814, + -0.015055214, + 0.007580712, + -0.003979542, + 0.0016304837, + 0.0010446712, + 0.0033373055, + 0.0066314633, + -0.011948583, + -0.021281753, + 0.012161002, + 0.030747686, + 0.03555367, + 0.023751127, + -0.03159736, + -0.0110590765, + 0.015758853, + -0.0012197511, + -0.0023249951, + -0.0007488608, + 0.0074877786, + 0.01643594, + -0.008098484, + 0.03730613, + -0.0010056724, + -0.000034798173, + 0.011702972, + 0.039563086, + -0.012280487, + 0.027747264, + 0.018387541, + 0.033057746, + -0.004835857, + -0.00471969, + 0.025450481, + -0.0051146573, + 0.014603823, + 0.00022258384, + 0.00060863094, + 0.015665919, + -0.021626934, + -0.013674489, + 0.0062066247, + 0.018560132, + 0.031942543, + 0.012054792, + 0.004902238, + 0.0028510645, + -0.027667606, + 0.009817752, + -0.002580562, + 0.0069036256, + 0.020047067, + -0.009704905, + -0.012619031, + -0.0056755766, + -0.0036443176, + 0.019383255, + 0.0030701219, + 0.024972538, + 0.009100837, + 0.026353262, + 0.012758431, + 0.029074885, + 0.021202097, + -0.0038102702, + -0.032048754, + 0.003996137, + 0.0029738694, + 0.0032277768, + -0.026127568, + -0.02213143, + 0.0028742978, + 0.0010637557, + 0.000580419, + 0.0021789568, + 0.00083764544, + 0.026924139, + -0.03265946, + 0.0059211864, + 0.021892458, + 0.01178263, + 0.0018188398, + 0.009718181, + -0.020047067, + 0.017989255, + 0.0046035233, + -0.010561219, + -0.010342162, + 0.009505761, + -0.018334435, + -0.00667793, + -0.024534423, + 0.00035347888, + 0.00082561385, + -0.006143563, + 0.016820949, + -0.0013500239, + -0.0069832825, + 0.015347291, + -0.005094743, + 0.001838754, + 0.017073197, + 0.02521151, + 0.006209944, + -0.015612815, + -0.009744733, + -0.019794818, + 0.007786493, + 0.037624758, + 0.017564416, + 0.0076802834, + 0.0026203906, + 0.0022403593, + -0.024560975, + -0.04062518, + -0.016581977, + 0.00789934, + 0.0099305995, + 0.006996559, + 0.011078991, + 0.016236795, + -0.0068969876, + 0.01374087, + 0.014922452, + -0.0042882133, + 0.00022901449, + -0.0006692036, + 0.001359981, + -0.00007581957, + 0.0042616613, + 0.0066381013, + 0.012512821, + 0.021534001, + 0.0032775626, + 0.016913882, + -0.00789934, + -0.009200408, + -0.020286039, + -0.017033368, + 0.014378128, + 0.009233599, + 0.0070828544, + -0.013229736, + 0.025928425, + -0.011862287, + 0.008383922, + 0.012632307, + -0.0003097089, + 0.007593988, + 0.0059079104, + -0.0026369859, + -0.0262205, + 0.003335646, + -0.0067609064, + -0.0042882133, + 0.008549875, + -0.007600626, + -0.012592479, + 0.028623493, + -0.0030502076, + -0.006989921, + -0.015785405, + 0.010050085, + 0.016714739, + -0.023724575, + -0.006346025, + -0.014245366, + -0.032154962, + -0.03388087, + -0.024308728, + -0.002461076, + -0.003733932, + -0.02195884, + -0.021069333, + -0.022144707, + -0.007872788, + -0.017179407, + -0.009034456, + -0.010893124, + -0.02478667, + -0.020153277, + -0.023976821, + 0.014656927, + 0.0005368565, + -0.015878338, + 0.010123105, + -0.0030717815, + 0.01555971, + 0.0018321159, + -0.036244035, + 0.00017176087, + -0.013375774, + -0.010375353, + 0.026512576, + 0.016581977, + 0.013847079, + 0.015719024, + 0.013223098, + 0.004975257, + -0.0010579474, + -0.0034385365, + -0.029048331, + 0.017298892, + -0.022529716, + 0.008463579, + -0.014723309, + -0.005814977, + -0.009027818, + -0.009738095, + -0.0104682855, + -0.005044957, + 0.007905979, + 0.011656506, + 0.003153098, + -0.0005231654, + 0.019954132, + -0.021985391, + -0.005307162, + 0.0021839354, + -0.025184957, + 0.013926737, + -0.0059908866, + 0.0065717204, + 0.009884133, + -0.0062298584, + 0.03388087, + 0.0028577026, + -0.015931444, + 0.0010986058, + -0.025808938, + 0.0022835068, + 0.014152432, + 0.015227805, + 0.013701041, + -0.007872788, + -0.030614924, + -0.026393091, + 0.0010753724, + -0.016940435, + 0.013647936, + -0.007408121, + -0.024308728, + -0.031915992, + -0.018161846, + 0.00072521257, + 0.028862465, + 0.012234021, + -0.019555846, + -0.027641054, + -0.00082810316, + -0.0019150922, + -0.016276624, + -0.01125822, + -0.034146395, + -0.015294186, + 0.006671292, + -0.015533158, + 0.013674489, + -0.0011766035, + -0.017325444, + -0.023233354, + -0.013189907, + 0.0005580154, + -0.03188944, + -0.007056302, + -0.0059942054, + 0.03411984, + 0.04317421, + 0.029420065, + 0.006488744, + -0.0022436783, + 0.013063784, + 0.00012207884, + 0.008118398, + -0.023246631, + 0.0051909955, + -0.00894816, + 0.0081316745, + 0.0023200165, + 0.011510468, + -0.0005770999, + 0.00016979019, + 0.010129742, + 0.015506605, + -0.0073815687, + 0.0031995648, + -0.026578957, + -0.016674912, + 0.0049652997, + 0.0072687212, + -0.016568702, + -0.001964878, + -0.015692472, + -0.0048955996, + 0.027773816, + 0.012864641, + 0.01594472, + 0.008244522, + 0.017139578, + -0.01772373, + -0.0012521119, + 0.011689696, + 0.0111121815, + -0.0036476366, + 0.0012570905, + -0.007826322, + -0.016754568, + 0.011948583, + -0.0045968853, + 0.023963546, + -0.0052739717, + 0.014656927, + 0.009731457, + 0.010727172, + -0.01705992, + -0.0026071144, + 0.010760362, + 0.000919377, + -0.006365939, + -0.03013698, + -0.010554581, + -0.018613236, + 0.013886908, + 0.029420065, + -0.013030593, + 0.016860778, + -0.019237218, + -0.022118153, + 0.007919255, + -0.0004003605, + 0.046546366, + 0.01349526, + 0.006352663, + 0.014258642, + 0.0031813101, + -0.027017072, + 0.0070828544, + -0.020219658, + 0.0037140178, + 0.023366116, + 0.040386207, + -0.016382834, + -0.0023681426, + 0.0064522345, + 0.016528873, + 0.0006804054, + -0.02891557, + -0.0043545947, + 0.01101261, + -0.0014778073, + -0.018055636, + -0.0077001974, + -0.0358723, + 0.003373815, + -0.00071940426, + -0.011822458, + -0.024295451, + -0.009791199, + -0.026565682, + 0.020989677, + -0.035155386, + 0.01832116, + 0.014776413, + -0.028012788, + -0.007262083, + 0.0030402504, + -0.029446619, + 0.00010174965, + 0.009758009, + 0.03767786, + -0.0154535, + 0.009346447, + 0.016077481, + 0.0041189417, + -0.027800368, + 0.01720596, + -0.011158649, + 0.027800368, + -0.03003077, + -0.0072819972, + 0.0014296811, + 0.0145374425, + 0.0043280423, + -0.017086472, + -0.01611731, + -0.01258584, + -0.016927158, + 0.007607264, + 0.018825656, + 0.011331239, + -0.0057784673, + 0.001569911, + -0.013900184, + -0.014776413, + -0.0050814664, + -0.0012454737, + -0.0115967635, + -0.017458206, + -0.013203184, + -0.0063692583, + -0.01244644, + 0.011882202, + 0.0007708495, + -0.02035242, + 0.016250072, + 0.018414093, + -0.029526275, + 0.012751793, + -0.01555971, + 0.0013840442, + -0.019502742, + 0.0063758963, + 0.0037538463, + -0.035686433, + 0.027534844, + -0.016409386, + -0.03247359, + -0.008782208, + -0.0059842486, + 0.014338299, + 0.009233599, + -0.0053171194, + 0.006160158, + 0.0072952732, + 0.01401967, + 0.008815398, + -0.023790956, + 0.013096974, + -0.0031365028, + 0.005044957, + 0.0005356118, + -0.009379637, + 0.0066248253, + -0.00010724682, + 0.010289057, + 0.008815398, + -0.02279524, + -0.019701885, + -0.0027747264, + 0.016183691, + -0.014205537, + -0.003933075, + -0.013375774, + -0.005751915, + -0.010116466, + 0.004988533, + -0.005904591, + -0.008656085, + -0.017431654, + -0.011988411, + -0.01594472, + 0.00660823, + -0.027216217, + 0.0073218257, + -0.029977666, + -0.004593566, + -0.026671892, + -0.028517283, + -0.0050084474, + 0.009844304, + 0.025729282, + -0.013780698, + -0.026751548, + 0.004905557, + -0.035951957, + -0.026738273, + -0.019768266, + 0.0048690476, + 0.005250738, + 0.0014603822, + -0.018892037, + 0.017683903, + 0.0067177587, + 0.027694158, + -0.002618731, + -0.012419888, + 0.01772373, + -0.0032593077, + 0.006611549, + 0.016648358, + -0.03789028, + -0.023100592, + 0.023684746, + 0.0031248862, + 0.016382834, + 0.019967409, + -0.008941523, + -0.02014, + 0.0073882067, + 0.011357792, + -0.0031796505, + -0.0030253148, + -0.0010206081, + -0.017577693, + -0.009598695, + 0.002915786, + 0.001325131, + -0.0029207645, + -0.010780277, + -0.00325101, + -0.00811176, + -0.00073434, + -0.030083876, + -0.012864641, + -0.012745155, + -0.011769353, + 0.018785827, + -0.008264436, + -0.002675155, + 0.024255622, + 0.005483072, + -0.018480474, + -0.005426648, + 0.015095043, + 0.00044392303, + 0.011271496, + -0.0027548121, + 0.0026884312, + -0.00894816, + -0.015161424, + -0.014975557, + -0.024600804, + 0.004457485, + -0.015519881, + -0.012366783, + -0.012579202, + 0.01478969, + 0.0075541595, + -0.017962702, + -0.0017441611, + -0.014059499, + 0.005499667, + -0.0026884312, + 0.0031929268, + 0.0010853296, + -0.008045379, + 0.017471483, + 0.02590187, + -0.018546855, + -0.007826322, + 0.009333171, + 0.0157323, + 0.000086036016, + 0.004776114, + 0.22155327, + 0.006787459, + -0.0017823302, + 0.024919434, + 0.0023449094, + 0.03210186, + 0.0047329664, + -0.010879848, + 0.0044342517, + 0.015334014, + 0.029499723, + 0.019715162, + -0.008569789, + -0.0018901994, + -0.0077400263, + -0.019210665, + -0.005088105, + -0.023153698, + -0.032739118, + -0.029313855, + 0.00082146504, + -0.0212552, + 0.0044309325, + -0.005446562, + 0.018613236, + -0.009751371, + -0.013023955, + -0.001996409, + 0.01915756, + 0.017431654, + -0.031092867, + -0.0070231115, + 0.025330994, + -0.00018099198, + -0.025131851, + -0.011025886, + 0.0116498675, + -0.02506547, + 0.029234199, + -0.012287126, + 0.0069766445, + 0.0018752636, + 0.014271918, + 0.005108019, + -0.0109064, + 0.014391404, + 0.0062597296, + -0.031411495, + 0.00014935728, + 0.013236375, + -0.02891557, + -0.0006671292, + 0.008662722, + 0.012161002, + 0.020963125, + -0.0133691365, + 0.02653913, + -0.017989255, + 0.007978998, + 0.0093398085, + -0.02024621, + 0.03265946, + -0.02846418, + 0.025397375, + -0.024693737, + -0.0027050264, + -0.019330151, + -0.0104417335, + 0.015626092, + -0.006541849, + 0.004653309, + -0.025118576, + 0.0038268655, + 0.004045923, + -0.017564416, + -0.02444149, + 0.030296294, + 0.028756255, + 0.03927101, + 0.010767001, + -0.012034878, + -0.007122683, + -0.022476612, + -0.034942966, + -0.028411074, + -0.03927101, + -0.0037505273, + -0.0038799702, + -0.00037111135, + -0.009718181, + -0.013455432, + -0.015400395, + -0.0066978442, + -0.010760362, + 0.015121595, + 0.03111942, + 0.007992274, + 0.0270569, + -0.003104972, + 0.010056724, + -0.018414093, + 0.006472149, + 0.021281753, + 0.0043579135, + -0.00021490853, + 0.0008546556, + -0.01269205, + -0.003936394, + 0.0008870163, + 0.0009816092, + 0.0054664765, + -0.031278733, + 0.017245788, + 0.00027734818, + 0.005161124, + 0.0048093046, + -0.003923118, + -0.027149836, + 0.006950092, + -0.00615352, + 0.014205537, + 0.0016620146, + 0.0047396044, + 0.0039994563, + -0.015440224, + -0.0055627287, + -0.026273604, + 0.0013276202, + 0.0021009592, + -0.034810204, + 0.0064522345, + 0.00042608313, + 0.02307404, + -0.005957696, + 0.0016869075, + -0.0032775626, + -0.009041094, + -0.01227385, + -0.04349284, + 0.015652644, + 0.013468708, + -0.0023249951, + -0.011171925, + 0.0030352718, + -0.0061203293, + -0.023153698, + 0.046068422, + -0.005582643, + -0.02405648, + 0.005433286, + -0.02814555, + -0.0036874653, + 0.0067841397, + 0.006628144, + 0.029844904, + -0.0044276137, + -0.029127989, + -0.04548427, + 0.022091601, + 0.0038069512, + -0.030269742, + 0.0051578046, + 0.043572497, + -0.0144843375, + -0.02891557, + -0.010461648, + -0.17375894, + 0.029154541, + 0.019648781, + -0.00038335036, + 0.0029572742, + -0.0026469429, + 0.035925403, + -0.012021601, + 0.0015566348, + -0.0033124126, + 0.0010430117, + -0.010620962, + -0.022582822, + 0.00601412, + 0.008364008, + -0.0016586956, + -0.0011102224, + -0.013860356, + 0.022542993, + 0.020564837, + 0.018414093, + -0.008908332, + 0.032951534, + -0.011908754, + 0.010169571, + -0.011198477, + 0.0029108075, + 0.033084296, + 0.0029008503, + -0.0010015236, + -0.019794818, + 0.005844848, + 0.011669782, + 0.0052208668, + 0.010129742, + 0.0037737607, + 0.02880936, + -0.018599961, + -0.015095043, + 0.026578957, + 0.019662056, + 0.006823968, + -0.00045885876, + -0.019396532, + -0.0047993474, + 0.017192682, + 0.039589636, + -0.00874238, + 0.02146762, + -0.007667007, + 0.018785827, + -0.012758431, + -0.010010257, + -0.02052501, + 0.016090758, + 0.0061867107, + -0.0145507185, + 0.008065294, + 0.0104284575, + -0.0022386997, + -0.008324179, + -0.021640211, + 0.01705992, + -0.010541305, + -0.01639611, + -0.0074413116, + -0.034703992, + 0.007016473, + -0.003083398, + 0.0013691084, + -0.005108019, + -0.007886064, + 0.00053270767, + -0.018865485, + 0.025503585, + 0.005101381, + -0.027534844, + 0.015028661, + -0.009286704, + 0.006233177, + 0.00004343289, + 0.036031615, + 0.00957878, + 0.019250493, + 0.0024411618, + 0.0023664832, + -0.0030269742, + -0.007939169, + 0.0058581247, + 0.00587472, + 0.036589216, + -0.035288148, + -0.012997403, + -0.0110989055, + -0.002492607, + 0.008151589, + -0.008085207, + -0.00734174, + -0.0016802694, + 0.008403837, + -0.007793131, + -0.003913161, + -0.025437204, + 0.027123282, + 0.019330151, + -0.008729103, + 0.003943032, + 0.010289057, + 0.029977666, + 0.0014836156, + -0.024282174, + -0.0024361832, + 0.0110325245, + 0.021719867, + 0.012844726, + 0.015002109, + 0.020737428, + -0.013037231, + 0.014802966, + -0.0027332383, + 0.041634172, + -0.00926679, + -0.018759275, + 0.018666342, + 0.005386819, + -0.008822037, + -0.068399, + -0.054804165, + 0.027800368, + 0.04954679, + -0.00437119, + 0.029127989, + 0.03180978, + 0.021321582, + -0.022503164, + 0.010554581, + -0.006823968, + -0.021387963, + -0.021865906, + -0.0074479496, + 0.0037206558, + 0.004132218, + 0.01073381, + -0.0021673401, + -0.0012819833, + 0.041235887, + -0.010202762, + 0.004839176, + 0.0081715025, + -0.030402504, + -0.023764404, + -0.010800191, + -0.018374264, + 0.033641897, + 0.005416691, + -0.0055096243, + -0.0032775626, + -0.018095464, + 0.008563151, + -0.02339267, + -0.013674489, + 0.0023382711, + -0.028411074, + -0.0024063117, + 0.026658615, + -0.012413249, + 0.009333171, + 0.026446195, + -0.009107475, + -0.024560975, + 0.0011085629, + -0.02395027, + 0.0013857037, + 0.01926377, + -0.0020710877, + -0.031278733, + -0.015095043, + 0.0041720467, + -0.012798259, + 0.010162933, + 0.0063128346, + -0.010972782, + 0.045617033, + 0.016874054, + -0.010368714, + -0.0055992384, + -0.0092999805, + 0.0015782086, + -0.013581555, + 0.017843217, + -0.01615714, + 0.0036575939, + -0.027110007, + -0.013621384, + 0.022197811, + 0.0013964906, + -0.007348378, + 0.0145772705, + -0.003996137, + 0.0008364008, + -0.03411984, + 0.013030593, + -0.021454344, + -0.05034336, + 0.021095887, + -0.0055029863, + -0.025623072, + -0.023525432, + 0.007335102, + -0.043413185, + 0.016316453, + 0.016196968, + 0.0093132565, + -0.0110989055, + 0.0154535, + -0.045218747, + 0.0037737607, + 0.01639611, + 0.019887751, + -0.023366116, + -0.024043202, + 0.014258642, + 0.004271618, + -0.006877073, + 0.021387963, + -0.0019781543, + -0.036350243, + -0.009114114, + -0.037359234, + 0.01919739, + 0.011829097, + -0.015665919, + -0.0015591241, + 0.0144843375, + -0.003139822, + -0.024083031, + -0.015307462, + -0.0040990277, + -0.013223098, + 0.0024278855, + -0.008702551, + -0.0033207103, + -0.009804476, + -0.010554581, + 0.031066315, + 0.0044408897, + 0.025370823, + 0.009406189, + 0.025583243, + -0.002066109, + 0.015267633, + 0.008337456, + -0.009426104, + 0.01590489, + -0.011716249, + 0.007713474, + -0.029552827, + -0.013900184, + 0.0050150855, + -0.01650232, + -0.0015757193, + 0.008549875, + -0.020471904, + 0.008397198, + -0.013136802, + 0.021520725, + 0.0060406723, + 0.012858002, + -0.004723009, + -0.029313855, + 0.009240237, + -0.0212552, + -0.028118998, + 0.017803388, + -0.0314646, + 0.012353507, + 0.029632485, + -0.000016128512, + 0.016966987, + 0.009711542, + -0.037253026, + -0.015095043, + 0.013442155, + -0.00905437, + -0.000982439, + -0.0020495139, + 0.008337456, + -0.020644495, + 0.042085562, + -0.000744712, + 0.021135716, + -0.0072886352, + 0.01643594, + 0.013767422, + -0.0044707614, + -0.014763137, + 0.018852208, + -0.03080079, + -0.0049188333, + 0.0058846767, + 0.008330817, + 0.008257798, + 0.024202518, + 0.02307404, + 0.011065715, + 0.00036053188, + -0.00049412367, + 0.036270585, + 0.027043626, + 0.011902116, + -0.027773816, + 0.013289479, + 0.018374264, + -0.0033157317, + 0.0016636741, + 0.0020677685, + -0.012293763, + 0.008184779, + -0.034252603, + 0.010753725, + 0.008675998, + 0.00968499, + -0.003793675, + -0.011218391, + 0.010375353, + -0.0005737809, + 0.019781543, + 0.020591391, + 0.019954132, + -0.00053976063, + -0.0059444197, + -0.022675755, + -0.010003619, + 0.0038467797, + -0.0212552, + -0.033482585, + -0.015572986, + 0.0037737607, + 0.01451089, + 0.0036376796, + 0.007454588, + 0.013979842, + -0.013402327, + 0.014975557, + -0.010435095, + 0.0151747, + -0.030375952, + 0.023166973, + -0.0024760119, + -0.005881358, + 0.019914305, + -0.008596341, + 0.017737007, + -0.0036111271, + 0.012499545, + -0.02647275, + 0.0053901384, + 0.008556513, + 0.019648781, + 0.00874238, + -0.012439802, + -0.028623493, + -0.022330573, + -0.0029340407, + -0.016303178, + 0.007474502, + -0.016555425, + 0.060645696, + 0.0023631642, + -0.012054792, + 0.017604245, + 0.013103612, + 0.026061187, + 0.015533158, + 0.025742557, + 0.00013753316, + -0.013940013, + 0.02880936, + 0.010109829, + -0.0036111271, + -0.012419888, + -0.045457717, + 0.022835068, + -0.014139156, + 0.007819683, + -0.010461648, + -0.012008325, + 0.008895056, + 0.015984548, + 0.024043202, + -0.00059825886, + -0.0036376796, + -0.007939169, + 0.0242689, + -0.022197811, + -0.026313433, + -0.026724996, + 0.010939592, + 0.0023449094, + -0.012074706, + -0.018493751, + 0.017697178, + -0.0052142288, + -0.00360117, + 0.0056058764, + 0.01070062, + 0.0035248317, + 0.023671469, + 0.030880447, + -0.020299314, + -0.0145905465, + 0.018055636, + -0.013727593, + -0.023313012, + 0.013236375, + -0.0020113448 + ] + } + ], + "usage": { + "prompt_tokens": 4, + "total_tokens": 4 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/embeddings.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/embeddings.yaml new file mode 100644 index 000000000000..7a3000fb4a3b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/embeddings.yaml @@ -0,0 +1,1553 @@ +title: Return the embeddings for a given prompt. +parameters: + endpoint: "{endpoint}" + api-version: 2024-02-15-preview + deployment-id: deployment-afa0669ca01e4693ae3a93baf40f26d6 + body: + input: + - this is a test +responses: + '200': + body: + data: + - index: 0 + embedding: + - -0.012838088 + - -0.007421397 + - -0.017617522 + - -0.028278312 + - -0.018666342 + - 0.01737855 + - -0.01821495 + - -0.006950092 + - -0.009937238 + - -0.038580645 + - 0.010674067 + - 0.02412286 + - -0.013647936 + - 0.013189907 + - 0.0021125758 + - 0.012406612 + - 0.020790534 + - 0.00074595667 + - 0.008397198 + - -0.00535031 + - 0.008968075 + - 0.014351576 + - -0.014086051 + - 0.015055214 + - -0.022211088 + - -0.025198232 + - 0.0065186154 + - -0.036350243 + - 0.009180495 + - -0.009698266 + - 0.009446018 + - -0.008463579 + - -0.0040426035 + - -0.03443847 + - -0.00091273896 + - -0.0019217303 + - 0.002349888 + - -0.021560553 + - 0.016515596 + - -0.015572986 + - 0.0038666942 + - -8.432463e-05 + - 0.0032178196 + - -0.020365695 + - -0.009631885 + - -0.007647093 + - 0.0033837722 + - -0.026764825 + - -0.010501476 + - 0.020219658 + - 0.024640633 + - -0.0066912062 + - -0.036456455 + - -0.0040923897 + - -0.013966565 + - 0.017816665 + - 0.005366905 + - 0.022835068 + - 0.0103488 + - -0.0010811808 + - -0.028942121 + - 0.0074280356 + - -0.017033368 + - 0.0074877786 + - 0.021640211 + - 0.002499245 + - 0.013316032 + - 0.0021524043 + - 0.010129742 + - 0.0054731146 + - 0.03143805 + - 0.014856071 + - 0.0023366117 + - -0.0008243692 + - 0.022781964 + - 0.003038591 + - -0.017617522 + - 0.0013309394 + - 0.0022154662 + - 0.00097414135 + - 0.012041516 + - -0.027906578 + - -0.023817508 + - 0.013302756 + - -0.003003741 + - -0.006890349 + - 0.0016744611 + - 0.023658194 + - -0.015851786 + - -0.0045305043 + - -0.003038591 + - 0.017710455 + - 0.019237218 + - 0.016037652 + - -0.022503164 + - 0.025795663 + - -0.001129307 + - 0.032500144 + - -0.008178141 + - -0.019940857 + - -0.009877495 + - 0.00018918588 + - 0.023060765 + - -0.005692172 + - -0.018347712 + - -0.011039163 + - -0.0062066247 + - -5.24047e-05 + - 0.020126723 + - -0.0011691356 + - -0.015811957 + - 0.020086896 + - -0.009114114 + - -0.03056182 + - 0.0029025099 + - -0.006591635 + - -0.014046223 + - -0.01590489 + - -0.02307404 + - -0.008861865 + - -0.004832538 + - 0.010030171 + - 0.02311387 + - -0.012652221 + - 0.024906157 + - 0.003860056 + - -0.01936998 + - -0.02957938 + - -0.008357369 + - -0.0016371218 + - 0.027800368 + - 0.0077333883 + - 0.021626934 + - 0.02140124 + - -0.030482162 + - 0.026406368 + - -0.008277712 + - 0.012884554 + - -0.043784916 + - -0.0145639945 + - -0.0070297495 + - 0.034889862 + - -0.00041508878 + - -0.010528029 + - -0.009572142 + - 0.015692472 + - 0.037810627 + - -0.0022021902 + - 0.008662722 + - -0.016794397 + - 0.0003090866 + - -0.0060506295 + - 0.015227805 + - 0.0006650548 + - 0.01842737 + - 0.036801632 + - -0.002461076 + - -0.0029390194 + - -0.0057120863 + - -0.012486269 + - -0.0046831807 + - -0.0017474802 + - -0.0036210844 + - -0.01178263 + - 0.017869769 + - 0.039111692 + - 0.010946229 + - 0.018467197 + - 0.0027780454 + - -0.005851486 + - -0.016489044 + - 0.03186289 + - -0.040333103 + - 0.016648358 + - -0.006870435 + - 0.0072687212 + - 2.370982e-06 + - 0.006465511 + - -0.018201673 + - -0.00020526254 + - -0.025410652 + - 0.02010017 + - 0.017537864 + - 0.022821793 + - 0.0064555537 + - -0.0012969191 + - 0.02157383 + - -0.0053536287 + - -0.0087622935 + - -0.010952868 + - 0.017564416 + - 0.02185263 + - 0.0004733796 + - 0.0018337755 + - -0.6954606 + - -0.011231667 + - 0.02748174 + - 0.003929756 + - 0.0144843375 + - 0.045192193 + - 0.01898497 + - -0.0070363875 + - -0.007813046 + - 0.017604245 + - -0.017790113 + - 0.011165286 + - -0.0036376796 + - -0.014736585 + - 0.0016421003 + - -0.019144284 + - -0.0072222543 + - -0.023127146 + - 0.006936816 + - 0.025198232 + - 0.0030219958 + - 0.011722887 + - -0.004271618 + - -0.0011127117 + - -0.0051047 + - 0.00077333883 + - 0.018599961 + - 0.0074877786 + - 0.010820106 + - 0.0033406245 + - -0.015055214 + - 0.02384406 + - 0.006090458 + - 0.00891497 + - 0.023366116 + - -0.011078991 + - -0.019582398 + - 0.0011566891 + - 0.015413672 + - 0.01793615 + - -0.014736585 + - 0.002492607 + - 0.027800368 + - 0.023923717 + - -0.007421397 + - 0.0016105693 + - 0.011337877 + - -0.015041938 + - -0.008768932 + - -0.003982861 + - 0.002884255 + - -0.007832959 + - 0.0025457118 + - -0.0023548664 + - -0.0061767534 + - -0.016754568 + - 0.0006036523 + - 0.0105346665 + - 0.0055361767 + - 0.01478969 + - -0.0011251582 + - 0.009605332 + - -0.0037140178 + - -0.017537864 + - -0.021733144 + - 0.012897831 + - -0.024481317 + - 0.022290744 + - 0.0056523434 + - -0.005366905 + - 0.0020412162 + - 0.013435517 + - -0.003408665 + - -0.01705992 + - 0.029446619 + - 0.022011945 + - 0.009226961 + - -0.003310753 + - -0.007939169 + - 0.021308305 + - 0.0026718357 + - 0.002129171 + - -0.020047067 + - -0.007474502 + - 0.021534001 + - -0.0110590765 + - -0.018374264 + - -0.001664504 + - -0.003923118 + - 0.015387119 + - 0.025516862 + - 0.0016421003 + - -0.017498035 + - -0.01825478 + - 0.01451089 + - -0.008198055 + - -0.011656506 + - 0.0044242945 + - 0.031491153 + - 0.01017621 + - -0.010408543 + - -0.009034456 + - -0.0023283141 + - 0.012021601 + - 0.015639367 + - 0.011736163 + - 0.007912617 + - 0.02031259 + - 0.022104878 + - -0.02241023 + - 0.00041156227 + - -0.009817752 + - -0.030880447 + - -0.0017823302 + - 0.0030933553 + - -0.04128899 + - -0.0007783174 + - 0.012393335 + - 0.0122273825 + - -0.009087561 + - 0.022728859 + - -0.002884255 + - 0.028065892 + - 0.0047396044 + - 0.008065294 + - 0.015519881 + - 0.0133956885 + - -0.02279524 + - -0.011729525 + - 0.0037206558 + - -0.0046732235 + - 0.003587894 + - 0.024401661 + - -0.013574918 + - 0.012685412 + - -0.0041620894 + - 0.020578114 + - 0.007394845 + - 0.014139156 + - -0.012512821 + - -0.021042781 + - 0.022423506 + - -0.015360567 + - 0.004009413 + - 0.0104550095 + - -0.024799947 + - -0.0081449505 + - -0.00063850236 + - 0.0070231115 + - -0.0009633545 + - -0.015705748 + - -0.0028942123 + - -0.008815398 + - 0.007461226 + - -0.014417957 + - -0.012931022 + - 0.0015674217 + - -0.02506547 + - -0.0063128346 + - -0.013422241 + - -0.0058614435 + - -0.0006007482 + - -0.015002109 + - 0.0037040606 + - -0.008410474 + - -0.0016089098 + - -0.018653065 + - 0.020538285 + - -0.016980262 + - -0.042244878 + - -0.017498035 + - 0.006727716 + - -0.01877255 + - 0.008987989 + - 0.00077665783 + - -0.0007119364 + - -0.0067243967 + - 0.0038467797 + - -0.018055636 + - -0.01440468 + - 0.007534245 + - 0.0051212953 + - 0.002741536 + - 0.011523744 + - -0.0018603279 + - 0.023684746 + - 0.016196968 + - 0.01731217 + - -0.01992758 + - 0.009372999 + - -0.01982137 + - 0.001150051 + - -0.014417957 + - 0.005672258 + - -0.015785405 + - 0.0049387473 + - -0.0051445286 + - 0.012632307 + - 0.0011666464 + - 0.024587527 + - 0.04259006 + - -0.0025672857 + - 0.02311387 + - -0.014524166 + - 0.0013848739 + - -0.04105002 + - -0.010089914 + - -0.009087561 + - 0.015440224 + - 0.009207047 + - 0.0128048975 + - -0.030216638 + - -0.02549031 + - 0.00499849 + - 0.02737553 + - 0.024985814 + - -0.015055214 + - 0.007580712 + - -0.003979542 + - 0.0016304837 + - 0.0010446712 + - 0.0033373055 + - 0.0066314633 + - -0.011948583 + - -0.021281753 + - 0.012161002 + - 0.030747686 + - 0.03555367 + - 0.023751127 + - -0.03159736 + - -0.0110590765 + - 0.015758853 + - -0.0012197511 + - -0.0023249951 + - -0.0007488608 + - 0.0074877786 + - 0.01643594 + - -0.008098484 + - 0.03730613 + - -0.0010056724 + - -3.4798173e-05 + - 0.011702972 + - 0.039563086 + - -0.012280487 + - 0.027747264 + - 0.018387541 + - 0.033057746 + - -0.004835857 + - -0.00471969 + - 0.025450481 + - -0.0051146573 + - 0.014603823 + - 0.00022258384 + - 0.00060863094 + - 0.015665919 + - -0.021626934 + - -0.013674489 + - 0.0062066247 + - 0.018560132 + - 0.031942543 + - 0.012054792 + - 0.004902238 + - 0.0028510645 + - -0.027667606 + - 0.009817752 + - -0.002580562 + - 0.0069036256 + - 0.020047067 + - -0.009704905 + - -0.012619031 + - -0.0056755766 + - -0.0036443176 + - 0.019383255 + - 0.0030701219 + - 0.024972538 + - 0.009100837 + - 0.026353262 + - 0.012758431 + - 0.029074885 + - 0.021202097 + - -0.0038102702 + - -0.032048754 + - 0.003996137 + - 0.0029738694 + - 0.0032277768 + - -0.026127568 + - -0.02213143 + - 0.0028742978 + - 0.0010637557 + - 0.000580419 + - 0.0021789568 + - 0.00083764544 + - 0.026924139 + - -0.03265946 + - 0.0059211864 + - 0.021892458 + - 0.01178263 + - 0.0018188398 + - 0.009718181 + - -0.020047067 + - 0.017989255 + - 0.0046035233 + - -0.010561219 + - -0.010342162 + - 0.009505761 + - -0.018334435 + - -0.00667793 + - -0.024534423 + - 0.00035347888 + - 0.00082561385 + - -0.006143563 + - 0.016820949 + - -0.0013500239 + - -0.0069832825 + - 0.015347291 + - -0.005094743 + - 0.001838754 + - 0.017073197 + - 0.02521151 + - 0.006209944 + - -0.015612815 + - -0.009744733 + - -0.019794818 + - 0.007786493 + - 0.037624758 + - 0.017564416 + - 0.0076802834 + - 0.0026203906 + - 0.0022403593 + - -0.024560975 + - -0.04062518 + - -0.016581977 + - 0.00789934 + - 0.0099305995 + - 0.006996559 + - 0.011078991 + - 0.016236795 + - -0.0068969876 + - 0.01374087 + - 0.014922452 + - -0.0042882133 + - 0.00022901449 + - -0.0006692036 + - 0.001359981 + - -7.581957e-05 + - 0.0042616613 + - 0.0066381013 + - 0.012512821 + - 0.021534001 + - 0.0032775626 + - 0.016913882 + - -0.00789934 + - -0.009200408 + - -0.020286039 + - -0.017033368 + - 0.014378128 + - 0.009233599 + - 0.0070828544 + - -0.013229736 + - 0.025928425 + - -0.011862287 + - 0.008383922 + - 0.012632307 + - -0.0003097089 + - 0.007593988 + - 0.0059079104 + - -0.0026369859 + - -0.0262205 + - 0.003335646 + - -0.0067609064 + - -0.0042882133 + - 0.008549875 + - -0.007600626 + - -0.012592479 + - 0.028623493 + - -0.0030502076 + - -0.006989921 + - -0.015785405 + - 0.010050085 + - 0.016714739 + - -0.023724575 + - -0.006346025 + - -0.014245366 + - -0.032154962 + - -0.03388087 + - -0.024308728 + - -0.002461076 + - -0.003733932 + - -0.02195884 + - -0.021069333 + - -0.022144707 + - -0.007872788 + - -0.017179407 + - -0.009034456 + - -0.010893124 + - -0.02478667 + - -0.020153277 + - -0.023976821 + - 0.014656927 + - 0.0005368565 + - -0.015878338 + - 0.010123105 + - -0.0030717815 + - 0.01555971 + - 0.0018321159 + - -0.036244035 + - 0.00017176087 + - -0.013375774 + - -0.010375353 + - 0.026512576 + - 0.016581977 + - 0.013847079 + - 0.015719024 + - 0.013223098 + - 0.004975257 + - -0.0010579474 + - -0.0034385365 + - -0.029048331 + - 0.017298892 + - -0.022529716 + - 0.008463579 + - -0.014723309 + - -0.005814977 + - -0.009027818 + - -0.009738095 + - -0.0104682855 + - -0.005044957 + - 0.007905979 + - 0.011656506 + - 0.003153098 + - -0.0005231654 + - 0.019954132 + - -0.021985391 + - -0.005307162 + - 0.0021839354 + - -0.025184957 + - 0.013926737 + - -0.0059908866 + - 0.0065717204 + - 0.009884133 + - -0.0062298584 + - 0.03388087 + - 0.0028577026 + - -0.015931444 + - 0.0010986058 + - -0.025808938 + - 0.0022835068 + - 0.014152432 + - 0.015227805 + - 0.013701041 + - -0.007872788 + - -0.030614924 + - -0.026393091 + - 0.0010753724 + - -0.016940435 + - 0.013647936 + - -0.007408121 + - -0.024308728 + - -0.031915992 + - -0.018161846 + - 0.00072521257 + - 0.028862465 + - 0.012234021 + - -0.019555846 + - -0.027641054 + - -0.00082810316 + - -0.0019150922 + - -0.016276624 + - -0.01125822 + - -0.034146395 + - -0.015294186 + - 0.006671292 + - -0.015533158 + - 0.013674489 + - -0.0011766035 + - -0.017325444 + - -0.023233354 + - -0.013189907 + - 0.0005580154 + - -0.03188944 + - -0.007056302 + - -0.0059942054 + - 0.03411984 + - 0.04317421 + - 0.029420065 + - 0.006488744 + - -0.0022436783 + - 0.013063784 + - 0.00012207884 + - 0.008118398 + - -0.023246631 + - 0.0051909955 + - -0.00894816 + - 0.0081316745 + - 0.0023200165 + - 0.011510468 + - -0.0005770999 + - 0.00016979019 + - 0.010129742 + - 0.015506605 + - -0.0073815687 + - 0.0031995648 + - -0.026578957 + - -0.016674912 + - 0.0049652997 + - 0.0072687212 + - -0.016568702 + - -0.001964878 + - -0.015692472 + - -0.0048955996 + - 0.027773816 + - 0.012864641 + - 0.01594472 + - 0.008244522 + - 0.017139578 + - -0.01772373 + - -0.0012521119 + - 0.011689696 + - 0.0111121815 + - -0.0036476366 + - 0.0012570905 + - -0.007826322 + - -0.016754568 + - 0.011948583 + - -0.0045968853 + - 0.023963546 + - -0.0052739717 + - 0.014656927 + - 0.009731457 + - 0.010727172 + - -0.01705992 + - -0.0026071144 + - 0.010760362 + - 0.000919377 + - -0.006365939 + - -0.03013698 + - -0.010554581 + - -0.018613236 + - 0.013886908 + - 0.029420065 + - -0.013030593 + - 0.016860778 + - -0.019237218 + - -0.022118153 + - 0.007919255 + - -0.0004003605 + - 0.046546366 + - 0.01349526 + - 0.006352663 + - 0.014258642 + - 0.0031813101 + - -0.027017072 + - 0.0070828544 + - -0.020219658 + - 0.0037140178 + - 0.023366116 + - 0.040386207 + - -0.016382834 + - -0.0023681426 + - 0.0064522345 + - 0.016528873 + - 0.0006804054 + - -0.02891557 + - -0.0043545947 + - 0.01101261 + - -0.0014778073 + - -0.018055636 + - -0.0077001974 + - -0.0358723 + - 0.003373815 + - -0.00071940426 + - -0.011822458 + - -0.024295451 + - -0.009791199 + - -0.026565682 + - 0.020989677 + - -0.035155386 + - 0.01832116 + - 0.014776413 + - -0.028012788 + - -0.007262083 + - 0.0030402504 + - -0.029446619 + - 0.00010174965 + - 0.009758009 + - 0.03767786 + - -0.0154535 + - 0.009346447 + - 0.016077481 + - 0.0041189417 + - -0.027800368 + - 0.01720596 + - -0.011158649 + - 0.027800368 + - -0.03003077 + - -0.0072819972 + - 0.0014296811 + - 0.0145374425 + - 0.0043280423 + - -0.017086472 + - -0.01611731 + - -0.01258584 + - -0.016927158 + - 0.007607264 + - 0.018825656 + - 0.011331239 + - -0.0057784673 + - 0.001569911 + - -0.013900184 + - -0.014776413 + - -0.0050814664 + - -0.0012454737 + - -0.0115967635 + - -0.017458206 + - -0.013203184 + - -0.0063692583 + - -0.01244644 + - 0.011882202 + - 0.0007708495 + - -0.02035242 + - 0.016250072 + - 0.018414093 + - -0.029526275 + - 0.012751793 + - -0.01555971 + - 0.0013840442 + - -0.019502742 + - 0.0063758963 + - 0.0037538463 + - -0.035686433 + - 0.027534844 + - -0.016409386 + - -0.03247359 + - -0.008782208 + - -0.0059842486 + - 0.014338299 + - 0.009233599 + - -0.0053171194 + - 0.006160158 + - 0.0072952732 + - 0.01401967 + - 0.008815398 + - -0.023790956 + - 0.013096974 + - -0.0031365028 + - 0.005044957 + - 0.0005356118 + - -0.009379637 + - 0.0066248253 + - -0.00010724682 + - 0.010289057 + - 0.008815398 + - -0.02279524 + - -0.019701885 + - -0.0027747264 + - 0.016183691 + - -0.014205537 + - -0.003933075 + - -0.013375774 + - -0.005751915 + - -0.010116466 + - 0.004988533 + - -0.005904591 + - -0.008656085 + - -0.017431654 + - -0.011988411 + - -0.01594472 + - 0.00660823 + - -0.027216217 + - 0.0073218257 + - -0.029977666 + - -0.004593566 + - -0.026671892 + - -0.028517283 + - -0.0050084474 + - 0.009844304 + - 0.025729282 + - -0.013780698 + - -0.026751548 + - 0.004905557 + - -0.035951957 + - -0.026738273 + - -0.019768266 + - 0.0048690476 + - 0.005250738 + - 0.0014603822 + - -0.018892037 + - 0.017683903 + - 0.0067177587 + - 0.027694158 + - -0.002618731 + - -0.012419888 + - 0.01772373 + - -0.0032593077 + - 0.006611549 + - 0.016648358 + - -0.03789028 + - -0.023100592 + - 0.023684746 + - 0.0031248862 + - 0.016382834 + - 0.019967409 + - -0.008941523 + - -0.02014 + - 0.0073882067 + - 0.011357792 + - -0.0031796505 + - -0.0030253148 + - -0.0010206081 + - -0.017577693 + - -0.009598695 + - 0.002915786 + - 0.001325131 + - -0.0029207645 + - -0.010780277 + - -0.00325101 + - -0.00811176 + - -0.00073434 + - -0.030083876 + - -0.012864641 + - -0.012745155 + - -0.011769353 + - 0.018785827 + - -0.008264436 + - -0.002675155 + - 0.024255622 + - 0.005483072 + - -0.018480474 + - -0.005426648 + - 0.015095043 + - 0.00044392303 + - 0.011271496 + - -0.0027548121 + - 0.0026884312 + - -0.00894816 + - -0.015161424 + - -0.014975557 + - -0.024600804 + - 0.004457485 + - -0.015519881 + - -0.012366783 + - -0.012579202 + - 0.01478969 + - 0.0075541595 + - -0.017962702 + - -0.0017441611 + - -0.014059499 + - 0.005499667 + - -0.0026884312 + - 0.0031929268 + - 0.0010853296 + - -0.008045379 + - 0.017471483 + - 0.02590187 + - -0.018546855 + - -0.007826322 + - 0.009333171 + - 0.0157323 + - 8.6036016e-05 + - 0.004776114 + - 0.22155327 + - 0.006787459 + - -0.0017823302 + - 0.024919434 + - 0.0023449094 + - 0.03210186 + - 0.0047329664 + - -0.010879848 + - 0.0044342517 + - 0.015334014 + - 0.029499723 + - 0.019715162 + - -0.008569789 + - -0.0018901994 + - -0.0077400263 + - -0.019210665 + - -0.005088105 + - -0.023153698 + - -0.032739118 + - -0.029313855 + - 0.00082146504 + - -0.0212552 + - 0.0044309325 + - -0.005446562 + - 0.018613236 + - -0.009751371 + - -0.013023955 + - -0.001996409 + - 0.01915756 + - 0.017431654 + - -0.031092867 + - -0.0070231115 + - 0.025330994 + - -0.00018099198 + - -0.025131851 + - -0.011025886 + - 0.0116498675 + - -0.02506547 + - 0.029234199 + - -0.012287126 + - 0.0069766445 + - 0.0018752636 + - 0.014271918 + - 0.005108019 + - -0.0109064 + - 0.014391404 + - 0.0062597296 + - -0.031411495 + - 0.00014935728 + - 0.013236375 + - -0.02891557 + - -0.0006671292 + - 0.008662722 + - 0.012161002 + - 0.020963125 + - -0.0133691365 + - 0.02653913 + - -0.017989255 + - 0.007978998 + - 0.0093398085 + - -0.02024621 + - 0.03265946 + - -0.02846418 + - 0.025397375 + - -0.024693737 + - -0.0027050264 + - -0.019330151 + - -0.0104417335 + - 0.015626092 + - -0.006541849 + - 0.004653309 + - -0.025118576 + - 0.0038268655 + - 0.004045923 + - -0.017564416 + - -0.02444149 + - 0.030296294 + - 0.028756255 + - 0.03927101 + - 0.010767001 + - -0.012034878 + - -0.007122683 + - -0.022476612 + - -0.034942966 + - -0.028411074 + - -0.03927101 + - -0.0037505273 + - -0.0038799702 + - -0.00037111135 + - -0.009718181 + - -0.013455432 + - -0.015400395 + - -0.0066978442 + - -0.010760362 + - 0.015121595 + - 0.03111942 + - 0.007992274 + - 0.0270569 + - -0.003104972 + - 0.010056724 + - -0.018414093 + - 0.006472149 + - 0.021281753 + - 0.0043579135 + - -0.00021490853 + - 0.0008546556 + - -0.01269205 + - -0.003936394 + - 0.0008870163 + - 0.0009816092 + - 0.0054664765 + - -0.031278733 + - 0.017245788 + - 0.00027734818 + - 0.005161124 + - 0.0048093046 + - -0.003923118 + - -0.027149836 + - 0.006950092 + - -0.00615352 + - 0.014205537 + - 0.0016620146 + - 0.0047396044 + - 0.0039994563 + - -0.015440224 + - -0.0055627287 + - -0.026273604 + - 0.0013276202 + - 0.0021009592 + - -0.034810204 + - 0.0064522345 + - 0.00042608313 + - 0.02307404 + - -0.005957696 + - 0.0016869075 + - -0.0032775626 + - -0.009041094 + - -0.01227385 + - -0.04349284 + - 0.015652644 + - 0.013468708 + - -0.0023249951 + - -0.011171925 + - 0.0030352718 + - -0.0061203293 + - -0.023153698 + - 0.046068422 + - -0.005582643 + - -0.02405648 + - 0.005433286 + - -0.02814555 + - -0.0036874653 + - 0.0067841397 + - 0.006628144 + - 0.029844904 + - -0.0044276137 + - -0.029127989 + - -0.04548427 + - 0.022091601 + - 0.0038069512 + - -0.030269742 + - 0.0051578046 + - 0.043572497 + - -0.0144843375 + - -0.02891557 + - -0.010461648 + - -0.17375894 + - 0.029154541 + - 0.019648781 + - -0.00038335036 + - 0.0029572742 + - -0.0026469429 + - 0.035925403 + - -0.012021601 + - 0.0015566348 + - -0.0033124126 + - 0.0010430117 + - -0.010620962 + - -0.022582822 + - 0.00601412 + - 0.008364008 + - -0.0016586956 + - -0.0011102224 + - -0.013860356 + - 0.022542993 + - 0.020564837 + - 0.018414093 + - -0.008908332 + - 0.032951534 + - -0.011908754 + - 0.010169571 + - -0.011198477 + - 0.0029108075 + - 0.033084296 + - 0.0029008503 + - -0.0010015236 + - -0.019794818 + - 0.005844848 + - 0.011669782 + - 0.0052208668 + - 0.010129742 + - 0.0037737607 + - 0.02880936 + - -0.018599961 + - -0.015095043 + - 0.026578957 + - 0.019662056 + - 0.006823968 + - -0.00045885876 + - -0.019396532 + - -0.0047993474 + - 0.017192682 + - 0.039589636 + - -0.00874238 + - 0.02146762 + - -0.007667007 + - 0.018785827 + - -0.012758431 + - -0.010010257 + - -0.02052501 + - 0.016090758 + - 0.0061867107 + - -0.0145507185 + - 0.008065294 + - 0.0104284575 + - -0.0022386997 + - -0.008324179 + - -0.021640211 + - 0.01705992 + - -0.010541305 + - -0.01639611 + - -0.0074413116 + - -0.034703992 + - 0.007016473 + - -0.003083398 + - 0.0013691084 + - -0.005108019 + - -0.007886064 + - 0.00053270767 + - -0.018865485 + - 0.025503585 + - 0.005101381 + - -0.027534844 + - 0.015028661 + - -0.009286704 + - 0.006233177 + - 4.343289e-05 + - 0.036031615 + - 0.00957878 + - 0.019250493 + - 0.0024411618 + - 0.0023664832 + - -0.0030269742 + - -0.007939169 + - 0.0058581247 + - 0.00587472 + - 0.036589216 + - -0.035288148 + - -0.012997403 + - -0.0110989055 + - -0.002492607 + - 0.008151589 + - -0.008085207 + - -0.00734174 + - -0.0016802694 + - 0.008403837 + - -0.007793131 + - -0.003913161 + - -0.025437204 + - 0.027123282 + - 0.019330151 + - -0.008729103 + - 0.003943032 + - 0.010289057 + - 0.029977666 + - 0.0014836156 + - -0.024282174 + - -0.0024361832 + - 0.0110325245 + - 0.021719867 + - 0.012844726 + - 0.015002109 + - 0.020737428 + - -0.013037231 + - 0.014802966 + - -0.0027332383 + - 0.041634172 + - -0.00926679 + - -0.018759275 + - 0.018666342 + - 0.005386819 + - -0.008822037 + - -0.068399 + - -0.054804165 + - 0.027800368 + - 0.04954679 + - -0.00437119 + - 0.029127989 + - 0.03180978 + - 0.021321582 + - -0.022503164 + - 0.010554581 + - -0.006823968 + - -0.021387963 + - -0.021865906 + - -0.0074479496 + - 0.0037206558 + - 0.004132218 + - 0.01073381 + - -0.0021673401 + - -0.0012819833 + - 0.041235887 + - -0.010202762 + - 0.004839176 + - 0.0081715025 + - -0.030402504 + - -0.023764404 + - -0.010800191 + - -0.018374264 + - 0.033641897 + - 0.005416691 + - -0.0055096243 + - -0.0032775626 + - -0.018095464 + - 0.008563151 + - -0.02339267 + - -0.013674489 + - 0.0023382711 + - -0.028411074 + - -0.0024063117 + - 0.026658615 + - -0.012413249 + - 0.009333171 + - 0.026446195 + - -0.009107475 + - -0.024560975 + - 0.0011085629 + - -0.02395027 + - 0.0013857037 + - 0.01926377 + - -0.0020710877 + - -0.031278733 + - -0.015095043 + - 0.0041720467 + - -0.012798259 + - 0.010162933 + - 0.0063128346 + - -0.010972782 + - 0.045617033 + - 0.016874054 + - -0.010368714 + - -0.0055992384 + - -0.0092999805 + - 0.0015782086 + - -0.013581555 + - 0.017843217 + - -0.01615714 + - 0.0036575939 + - -0.027110007 + - -0.013621384 + - 0.022197811 + - 0.0013964906 + - -0.007348378 + - 0.0145772705 + - -0.003996137 + - 0.0008364008 + - -0.03411984 + - 0.013030593 + - -0.021454344 + - -0.05034336 + - 0.021095887 + - -0.0055029863 + - -0.025623072 + - -0.023525432 + - 0.007335102 + - -0.043413185 + - 0.016316453 + - 0.016196968 + - 0.0093132565 + - -0.0110989055 + - 0.0154535 + - -0.045218747 + - 0.0037737607 + - 0.01639611 + - 0.019887751 + - -0.023366116 + - -0.024043202 + - 0.014258642 + - 0.004271618 + - -0.006877073 + - 0.021387963 + - -0.0019781543 + - -0.036350243 + - -0.009114114 + - -0.037359234 + - 0.01919739 + - 0.011829097 + - -0.015665919 + - -0.0015591241 + - 0.0144843375 + - -0.003139822 + - -0.024083031 + - -0.015307462 + - -0.0040990277 + - -0.013223098 + - 0.0024278855 + - -0.008702551 + - -0.0033207103 + - -0.009804476 + - -0.010554581 + - 0.031066315 + - 0.0044408897 + - 0.025370823 + - 0.009406189 + - 0.025583243 + - -0.002066109 + - 0.015267633 + - 0.008337456 + - -0.009426104 + - 0.01590489 + - -0.011716249 + - 0.007713474 + - -0.029552827 + - -0.013900184 + - 0.0050150855 + - -0.01650232 + - -0.0015757193 + - 0.008549875 + - -0.020471904 + - 0.008397198 + - -0.013136802 + - 0.021520725 + - 0.0060406723 + - 0.012858002 + - -0.004723009 + - -0.029313855 + - 0.009240237 + - -0.0212552 + - -0.028118998 + - 0.017803388 + - -0.0314646 + - 0.012353507 + - 0.029632485 + - -1.6128512e-05 + - 0.016966987 + - 0.009711542 + - -0.037253026 + - -0.015095043 + - 0.013442155 + - -0.00905437 + - -0.000982439 + - -0.0020495139 + - 0.008337456 + - -0.020644495 + - 0.042085562 + - -0.000744712 + - 0.021135716 + - -0.0072886352 + - 0.01643594 + - 0.013767422 + - -0.0044707614 + - -0.014763137 + - 0.018852208 + - -0.03080079 + - -0.0049188333 + - 0.0058846767 + - 0.008330817 + - 0.008257798 + - 0.024202518 + - 0.02307404 + - 0.011065715 + - 0.00036053188 + - -0.00049412367 + - 0.036270585 + - 0.027043626 + - 0.011902116 + - -0.027773816 + - 0.013289479 + - 0.018374264 + - -0.0033157317 + - 0.0016636741 + - 0.0020677685 + - -0.012293763 + - 0.008184779 + - -0.034252603 + - 0.010753725 + - 0.008675998 + - 0.00968499 + - -0.003793675 + - -0.011218391 + - 0.010375353 + - -0.0005737809 + - 0.019781543 + - 0.020591391 + - 0.019954132 + - -0.00053976063 + - -0.0059444197 + - -0.022675755 + - -0.010003619 + - 0.0038467797 + - -0.0212552 + - -0.033482585 + - -0.015572986 + - 0.0037737607 + - 0.01451089 + - 0.0036376796 + - 0.007454588 + - 0.013979842 + - -0.013402327 + - 0.014975557 + - -0.010435095 + - 0.0151747 + - -0.030375952 + - 0.023166973 + - -0.0024760119 + - -0.005881358 + - 0.019914305 + - -0.008596341 + - 0.017737007 + - -0.0036111271 + - 0.012499545 + - -0.02647275 + - 0.0053901384 + - 0.008556513 + - 0.019648781 + - 0.00874238 + - -0.012439802 + - -0.028623493 + - -0.022330573 + - -0.0029340407 + - -0.016303178 + - 0.007474502 + - -0.016555425 + - 0.060645696 + - 0.0023631642 + - -0.012054792 + - 0.017604245 + - 0.013103612 + - 0.026061187 + - 0.015533158 + - 0.025742557 + - 0.00013753316 + - -0.013940013 + - 0.02880936 + - 0.010109829 + - -0.0036111271 + - -0.012419888 + - -0.045457717 + - 0.022835068 + - -0.014139156 + - 0.007819683 + - -0.010461648 + - -0.012008325 + - 0.008895056 + - 0.015984548 + - 0.024043202 + - -0.00059825886 + - -0.0036376796 + - -0.007939169 + - 0.0242689 + - -0.022197811 + - -0.026313433 + - -0.026724996 + - 0.010939592 + - 0.0023449094 + - -0.012074706 + - -0.018493751 + - 0.017697178 + - -0.0052142288 + - -0.00360117 + - 0.0056058764 + - 0.01070062 + - 0.0035248317 + - 0.023671469 + - 0.030880447 + - -0.020299314 + - -0.0145905465 + - 0.018055636 + - -0.013727593 + - -0.023313012 + - 0.013236375 + - -0.0020113448 + usage: + prompt_tokens: 4 + total_tokens: 4 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_assistant_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_assistant_file.json new file mode 100644 index 000000000000..983d370def4b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_assistant_file.json @@ -0,0 +1,19 @@ +{ + "title": "Retrieves an AssistantFile.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_assistant_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_assistant_file.yaml new file mode 100644 index 000000000000..5bd29a9e91ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_assistant_file.yaml @@ -0,0 +1,13 @@ +title: Retrieves an AssistantFile. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + file_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX +responses: + '200': + body: + id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file + created_at: 1707324164 + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message.json new file mode 100644 index 000000000000..f3dfad66bae6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message.json @@ -0,0 +1,33 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message.yaml new file mode 100644 index 000000000000..bd5de1fcf218 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message.yaml @@ -0,0 +1,23 @@ +title: Retrieve a message. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + message_id: msg_as3XIk1tpVP3hdHjWBGg3uG4 +responses: + '200': + body: + id: msg_as3XIk1tpVP3hdHjWBGg3uG4 + object: thread.message + created_at: 1707298421 + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + role: user + content: + - type: text + text: + value: What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces. + annotations: [] + file_ids: [] + assistant_id: null + run_id: null + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message_file.json new file mode 100644 index 000000000000..23b1dd7589d2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message_file.json @@ -0,0 +1,20 @@ +{ + "title": "Retrieves a message file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123", + "file_id": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message_file.yaml new file mode 100644 index 000000000000..83ee9c9ff70a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_message_file.yaml @@ -0,0 +1,14 @@ +title: Retrieves a message file. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_abc123 + message_id: msg_abc123 + file_id: file_abc123 +responses: + '200': + body: + id: file-abc123 + object: thread.message.file + created_at: 1699061776 + message_id: msg_abc123 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run.json new file mode 100644 index 000000000000..634725381947 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run.json @@ -0,0 +1,32 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run.yaml new file mode 100644 index 000000000000..d865e7962a2c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run.yaml @@ -0,0 +1,26 @@ +title: Gets a run. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q +responses: + '200': + body: + id: run_HsO8tYM4K5AAMAHgK0J3om8Q + object: thread.run + created_at: 1707303196 + assistant_id: asst_JtTwHk28cIocgFXZPCBxhOzl + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + status: completed + started_at: 1707303197 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1707303201 + last_error: null + model: gpt-4-1106-preview + instructions: You are an AI model that empowers every person and every organization on the planet to achieve more. + tools: [] + file_ids: [] + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run_step.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run_step.json new file mode 100644 index 000000000000..94d2d0cae97a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run_step.json @@ -0,0 +1,40 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "step_id": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run_step.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run_step.yaml new file mode 100644 index 000000000000..d893c072df2e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/get_run_step.yaml @@ -0,0 +1,31 @@ +title: Retrieves a run step. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q + step_id: step_abc123 +responses: + '200': + body: + id: step_abc123 + object: thread.run.step + created_at: 1699063291 + run_id: run_abc123 + assistant_id: asst_abc123 + thread_id: thread_abc123 + type: message_creation + status: completed + cancelled_at: null + completed_at: 1699063291 + expired_at: null + failed_at: null + last_error: null + step_details: + type: message_creation + message_creation: + message_id: msg_abc123 + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/image_generation.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/image_generation.json new file mode 100644 index 000000000000..fe11b34ae4fb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/image_generation.json @@ -0,0 +1,67 @@ +{ + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "deployment-id": "", + "body": { + "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.", + "n": 1, + "style": "natural", + "quality": "standard" + } + }, + "responses": { + "200": { + "body": { + "created": 1698342300, + "data": [ + { + "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.", + "prompt_filter_results": { + "sexual": { + "severity": "safe", + "filtered": false + }, + "violence": { + "severity": "safe", + "filtered": false + }, + "hate": { + "severity": "safe", + "filtered": false + }, + "self_harm": { + "severity": "safe", + "filtered": false + }, + "profanity": { + "detected": false, + "filtered": false + } + }, + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...", + "content_filter_results": { + "sexual": { + "severity": "safe", + "filtered": false + }, + "violence": { + "severity": "safe", + "filtered": false + }, + "hate": { + "severity": "safe", + "filtered": false + }, + "self_harm": { + "severity": "safe", + "filtered": false + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/image_generation.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/image_generation.yaml new file mode 100644 index 000000000000..178d11c0ccec --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/image_generation.yaml @@ -0,0 +1,46 @@ +title: "Creates images given a prompt." +parameters: + endpoint: "{endpoint}" + api-version: "2024-02-15-preview" + deployment-id: "" + body: + prompt: "In the style of WordArt, Microsoft Clippy wearing a cowboy hat." + n: 1 + style: "natural" + quality: "standard" +responses: + '200': + body: + created: 1698342300 + data: + - revised_prompt: "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat." + prompt_filter_results: + sexual: + severity: "safe" + filtered: false + violence: + severity: "safe" + filtered: false + hate: + severity: "safe" + filtered: false + self_harm: + severity: "safe" + filtered: false + profanity: + detected: false + filtered: false + url: "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&..." + content_filter_results: + sexual: + severity: "safe" + filtered: false + violence: + severity: "safe" + filtered: false + hate: + severity: "safe" + filtered: false + self_harm: + severity: "safe" + filtered: false \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistant_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistant_files.json new file mode 100644 index 000000000000..23421c112439 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistant_files.json @@ -0,0 +1,26 @@ +{ + "title": "Returns a list of assistant files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + ], + "first_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "last_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistant_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistant_files.yaml new file mode 100644 index 000000000000..5d71cc320f66 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistant_files.yaml @@ -0,0 +1,17 @@ +title: Returns a list of assistant files. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA +responses: + '200': + body: + object: list + data: + - id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file + created_at: 1707324164 + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + first_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + last_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistants.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistants.json new file mode 100644 index 000000000000..96a01837c500 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistants.json @@ -0,0 +1,55 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [ + "assistant-mMGvtln6ieqP5DhoFo5vpZge" + ], + "metadata": {} + }, + { + "id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "object": "assistant", + "created_at": 1707249683, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a personal math tutor. Answer questions briefly, in a sentence or less.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [], + "metadata": {} + } + ], + "first_id": "asst_qOKETOiUwLnzEc3i3AGuyDi1", + "last_id": "asst_jBvPFZQ8dMqq4bXb84Gqe8O6", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistants.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistants.yaml new file mode 100644 index 000000000000..2aa5dd2b5aaa --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_assistants.yaml @@ -0,0 +1,37 @@ +title: Returns a list of assistants. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + order: desc + limit: 20 +responses: + '200': + body: + object: list + data: + - id: asst_qOKETOiUwLnzEc3i3AGuyDi1 + object: assistant + created_at: 1707257477 + name: Stock Analyst + description: null + model: gpt-4-1106-preview + instructions: You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs. + tools: + - type: code_interpreter + file_ids: + - assistant-mMGvtln6ieqP5DhoFo5vpZge + metadata: {} + - id: asst_jBvPFZQ8dMqq4bXb84Gqe8O6 + object: assistant + created_at: 1707249683 + name: Math Tutor + description: null + model: gpt-4-1106-preview + instructions: You are a personal math tutor. Answer questions briefly, in a sentence or less. + tools: + - type: code_interpreter + file_ids: [] + metadata: {} + first_id: asst_qOKETOiUwLnzEc3i3AGuyDi1 + last_id: asst_jBvPFZQ8dMqq4bXb84Gqe8O6 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_message_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_message_files.json new file mode 100644 index 000000000000..1736bf7b5c3f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_message_files.json @@ -0,0 +1,33 @@ +{ + "title": "Returns a list of message files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + }, + { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc123", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_message_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_message_files.yaml new file mode 100644 index 000000000000..7741b4cb49ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_message_files.yaml @@ -0,0 +1,22 @@ +title: Returns a list of message files. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_abc123 + message_id: msg_abc123 +responses: + '200': + body: + object: list + data: + - id: file-abc123 + object: thread.message.file + created_at: 1699061776 + message_id: msg_abc123 + - id: file-abc123 + object: thread.message.file + created_at: 1699061776 + message_id: msg_abc123 + first_id: file-abc123 + last_id: file-abc123 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_messages.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_messages.json new file mode 100644 index 000000000000..e2d1fffa2569 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_messages.json @@ -0,0 +1,60 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "object": "thread.message", + "created_at": 1707298439, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "assistant", + "content": [ + { + "type": "text", + "text": { + "value": "The cube root of the sum of the given numbers, rounded to the nearest integer, is 12345.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": "asst_iaScg6I4dkdYWoaPPTPT7EFy", + "run_id": "run_35BhBv0Ry4vVgjF0vO36Ajzf", + "metadata": {} + }, + { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_RPiAkxp7DKb4j7dzokX6itkR", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + ], + "first_id": "msg_UyL3BkA02z74QviiYnkBTG5C", + "last_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_messages.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_messages.yaml new file mode 100644 index 000000000000..245548d64cf2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_messages.yaml @@ -0,0 +1,41 @@ +title: List Messages +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx +responses: + '200': + body: + object: list + data: + - id: msg_UyL3BkA02z74QviiYnkBTG5C + object: thread.message + created_at: 1707298439 + thread_id: thread_RPiAkxp7DKb4j7dzokX6itkR + role: assistant + content: + - type: text + text: + value: The cube root of the sum of the given numbers, rounded to the nearest integer, is 12345. + annotations: [] + file_ids: [] + assistant_id: asst_iaScg6I4dkdYWoaPPTPT7EFy + run_id: run_35BhBv0Ry4vVgjF0vO36Ajzf + metadata: {} + - id: msg_as3XIk1tpVP3hdHjWBGg3uG4 + object: thread.message + created_at: 1707298421 + thread_id: thread_RPiAkxp7DKb4j7dzokX6itkR + role: user + content: + - type: text + text: + value: What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces. + annotations: [] + file_ids: [] + assistant_id: null + run_id: null + metadata: {} + first_id: msg_UyL3BkA02z74QviiYnkBTG5C + last_id: msg_as3XIk1tpVP3hdHjWBGg3uG4 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_run_steps.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_run_steps.json new file mode 100644 index 000000000000..d2b91fdb8038 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_run_steps.json @@ -0,0 +1,47 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_run_steps.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_run_steps.yaml new file mode 100644 index 000000000000..e662c1f2a5d9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_run_steps.yaml @@ -0,0 +1,35 @@ +title: Returns a list of run steps belonging to a run. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q +responses: + '200': + body: + object: list + data: + - id: step_abc123 + object: thread.run.step + created_at: 1699063291 + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q + assistant_id: asst_JtTwHk28cIocgFXZPCBxhOzl + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + type: message_creation + status: completed + cancelled_at: null + completed_at: 1699063291 + expired_at: null + failed_at: null + last_error: null + step_details: + type: message_creation + message_creation: + message_id: msg_abc123 + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + first_id: step_abc123 + last_id: step_abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_runs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_runs.json new file mode 100644 index 000000000000..9628a46faa00 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_runs.json @@ -0,0 +1,39 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "object": "thread.run", + "created_at": 1707300252, + "assistant_id": "asst_se10QpYqDv7RQx13zdpskKlz", + "thread_id": "thread_7CJfaYBtuRIOSksocRrYNQGV", + "status": "completed", + "started_at": 1707300255, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707300267, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + ], + "first_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "last_id": "run_jwY1tMUeOjSpq0Swwm6JqSi6", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_runs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_runs.yaml new file mode 100644 index 000000000000..c6ce9546aa92 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/list_runs.yaml @@ -0,0 +1,30 @@ +title: Returns a list of runs belonging to a thread. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_7CJfaYBtuRIOSksocRrYNQGV +responses: + '200': + body: + object: list + data: + - id: run_jwY1tMUeOjSpq0Swwm6JqSi6 + object: thread.run + created_at: 1707300252 + assistant_id: asst_se10QpYqDv7RQx13zdpskKlz + thread_id: thread_7CJfaYBtuRIOSksocRrYNQGV + status: completed + started_at: 1707300255 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1707300267 + last_error: null + model: gpt-4-1106-preview + instructions: You are an AI model that empowers every person and every organization on the planet to achieve more. + tools: [] + file_ids: [] + metadata: {} + first_id: run_jwY1tMUeOjSpq0Swwm6JqSi6 + last_id: run_jwY1tMUeOjSpq0Swwm6JqSi6 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_assistant.json new file mode 100644 index 000000000000..34a04cc23e0d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_assistant.json @@ -0,0 +1,33 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "body": { + "model": "gpt-35-turbo-1106" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-35-turbo-1106", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [ + "assistant-0GeMWRaTlEASVHujzBXIcvbo" + ], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_assistant.yaml new file mode 100644 index 000000000000..a76e131d1cb5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_assistant.yaml @@ -0,0 +1,22 @@ +title: Modifies an assistant. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + assistant_id: asst_4nsG2qgNzimRPE7MazXTXbU7 + body: + model: gpt-35-turbo-1106 +responses: + '200': + body: + id: asst_4nsG2qgNzimRPE7MazXTXbU7 + object: assistant + created_at: 1707295707 + name: Math Tutor + description: null + model: gpt-35-turbo-1106 + instructions: When a customer asks about a specific math problem, use Python to evaluate their query. + tools: + - type: code_interpreter + file_ids: + - assistant-0GeMWRaTlEASVHujzBXIcvbo + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_message.json new file mode 100644 index 000000000000..7edde508a520 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_message.json @@ -0,0 +1,42 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_message.yaml new file mode 100644 index 000000000000..aea7d40e08b0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_message.yaml @@ -0,0 +1,29 @@ +title: Modify a message. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + message_id: msg_as3XIk1tpVP3hdHjWBGg3uG4 + body: + metadata: + key1: value1 + key2: value2 +responses: + '200': + body: + id: msg_as3XIk1tpVP3hdHjWBGg3uG4 + object: thread.message + created_at: 1707298421 + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + role: user + content: + - type: text + text: + value: What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces. + annotations: [] + file_ids: [] + assistant_id: null + run_id: null + metadata: + key1: value1 + key2: value2 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_run.json new file mode 100644 index 000000000000..968f3e824dd8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_run.json @@ -0,0 +1,41 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": { + "key1": "value1", + "key2": "value2" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_run.yaml new file mode 100644 index 000000000000..d5cf1964bff0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_run.yaml @@ -0,0 +1,32 @@ +title: Modifies a run. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q + body: + metadata: + key1: value1 + key2: value2 +responses: + '200': + body: + id: run_HsO8tYM4K5AAMAHgK0J3om8Q + object: thread.run + created_at: 1707303196 + assistant_id: asst_JtTwHk28cIocgFXZPCBxhOzl + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + status: completed + started_at: 1707303197 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1707303201 + last_error: null + model: gpt-4-1106-preview + instructions: You are an AI model that empowers every person and every organization on the planet to achieve more. + tools: [] + file_ids: [] + metadata: + key1: value1 + key2: value2 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_thread.json new file mode 100644 index 000000000000..f9846880c299 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_thread.json @@ -0,0 +1,27 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_thread.yaml new file mode 100644 index 000000000000..5ba955584e64 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/modify_thread.yaml @@ -0,0 +1,18 @@ +title: Modifies a thread. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + body: + metadata: + modified: 'true' + user: abc123 +responses: + '200': + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread + created_at: 1707297136 + metadata: + modified: 'true' + user: abc123 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_assistant.json new file mode 100644 index 000000000000..9206c6315b09 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_assistant.json @@ -0,0 +1,30 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "file_ids": [ + "assistant-0GeMWRaTlEASVHujzBXIcvbo" + ], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_assistant.yaml new file mode 100644 index 000000000000..7a5d95ac88e2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_assistant.yaml @@ -0,0 +1,20 @@ +title: Retrieves an assistant. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + assistant_id: asst_4nsG2qgNzimRPE7MazXTXbU7 +responses: + '200': + body: + id: asst_4nsG2qgNzimRPE7MazXTXbU7 + object: assistant + created_at: 1707295707 + name: Math Tutor + description: null + model: gpt-4-1106-preview + instructions: When a customer asks about a specific math problem, use Python to evaluate their query. + tools: + - type: code_interpreter + file_ids: + - assistant-0GeMWRaTlEASVHujzBXIcvbo + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_thread.json new file mode 100644 index 000000000000..e0f557584dbe --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_thread.json @@ -0,0 +1,18 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_thread.yaml new file mode 100644 index 000000000000..e0f557584dbe --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/retrieve_thread.yaml @@ -0,0 +1,18 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..802078c38aba --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.json @@ -0,0 +1,68 @@ +{ + "title": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-02-15-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_abc123", + "output": "28C" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_abc123", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4", + "instructions": "You tell the weather.", + "tools": [ + { + "type": "function", + "function": { + "name": "get_weather", + "description": "Determine weather in my location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "c", + "f" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "file_ids": [], + "metadata": {}, + "usage": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.yaml new file mode 100644 index 000000000000..b882ca78509d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/examples/submit_tool_outputs_to_run.yaml @@ -0,0 +1,49 @@ +title: | + When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. +parameters: + endpoint: '{endpoint}' + api-version: 2024-02-15-preview + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q + body: + tool_outputs: + - tool_call_id: call_abc123 + output: 28C +responses: + '200': + body: + id: run_HsO8tYM4K5AAMAHgK0J3om8Q + object: thread.run + created_at: 1699075592 + assistant_id: asst_abc123 + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + status: queued + started_at: 1699075592 + expires_at: 1699076192 + cancelled_at: null + failed_at: null + completed_at: null + last_error: null + model: gpt-4 + instructions: You tell the weather. + tools: + - type: function + function: + name: get_weather + description: Determine weather in my location + parameters: + type: object + properties: + location: + type: string + description: The city and state e.g. San Francisco, CA + unit: + type: string + enum: + - c + - f + required: + - location + file_ids: [] + metadata: {} + usage: null diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.json new file mode 100644 index 000000000000..872fc6aba815 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.json @@ -0,0 +1,7760 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Azure OpenAI Service API", + "description": "Azure OpenAI APIs for completions and search", + "version": "2024-02-15-preview" + }, + "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": "2024-02-15-preview", + "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 + }, + "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 + }, + "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" + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/promptFilterResults" + }, + "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" + } + } + }, + "nullable": true + }, + "finish_reason": { + "type": "string" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterChoiceResults" + } + } + } + }, + "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" + } + } + } + } + }, + "x-ms-examples": { + "Create a completion.": { + "$ref": "./examples/completions.json" + } + } + } + }, + "/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": "2024-02-15-preview", + "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" + } + }, + "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" + ] + } + } + } + } + }, + "x-ms-examples": { + "Create a embeddings.": { + "$ref": "./examples/embeddings.json" + } + } + } + }, + "/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": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createChatCompletionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createChatCompletionResponse" + } + } + }, + "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" + } + } + } + } + }, + "x-ms-examples": { + "Create a chat completion.": { + "$ref": "./examples/chat_completions.json" + }, + "Creates a completion based on Azure Search data and system-assigned managed identity.": { + "$ref": "./examples/chat_completions_azure_search_minimum.json" + }, + "Creates a completion based on Azure Search image vector data.": { + "$ref": "./examples/chat_completions_azure_search_image_vector.json" + }, + "Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.": { + "$ref": "./examples/chat_completions_azure_search_advanced.json" + }, + "Creates a completion for the provided AML index.": { + "$ref": "./examples/chat_completions_aml_index.json" + }, + "Creates a completion for the provided Azure Cosmos DB.": { + "$ref": "./examples/chat_completions_cosmos_db.json" + }, + "Creates a completion for the provided Elasticsearch.": { + "$ref": "./examples/chat_completions_elasticsearch.json" + }, + "Creates a completion for the provided Pinecone resource.": { + "$ref": "./examples/chat_completions_pinecone.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/transcriptions": { + "post": { + "summary": "Transcribes audio into the input language.", + "operationId": "Transcriptions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "whisper", + "description": "Deployment id of the whisper model." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createTranscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "$ref": "#/components/schemas/audioVerboseResponse" + } + ] + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Transcribed text in the output format (when response_format was one of text, vtt or srt)." + } + } + } + } + }, + "x-ms-examples": { + "Create an audio transcription with json response format.": { + "$ref": "./examples/audio_transcription_object.json" + }, + "Create an audio transcription with text response format.": { + "$ref": "./examples/audio_transcription_text.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/translations": { + "post": { + "summary": "Transcribes and translates input audio into English text.", + "operationId": "Translations_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "whisper", + "description": "Deployment id of the whisper model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createTranslationRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "$ref": "#/components/schemas/audioVerboseResponse" + } + ] + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Transcribed text in the output format (when response_format was one of text, vtt or srt)." + } + } + } + } + }, + "x-ms-examples": { + "Create an audio translation with json response format.": { + "$ref": "./examples/audio_translation_object.json" + }, + "Create an audio translation with text response format.": { + "$ref": "./examples/audio_translation_text.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/speech": { + "post": { + "summary": "Generates audio from the input text.", + "operationId": "Speech_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "tts-1", + "description": "Deployment id of the tts model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createSpeechRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + }, + "x-ms-examples": { + "Create an audio from text with response format mp3.": { + "$ref": "./examples/audio_speech.json" + } + } + } + }, + "/deployments/{deployment-id}/images/generations": { + "post": { + "summary": "Generates a batch of images from a text caption on a given DALLE model deployment", + "operationId": "ImageGenerations_Create", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/imageGenerationsRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "dalle-deployment", + "description": "Deployment id of the dalle model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/generateImagesResponse" + } + } + } + }, + "default": { + "description": "An error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dalleErrorResponse" + } + } + } + } + }, + "x-ms-examples": { + "Create an image.": { + "$ref": "./examples/image_generation.json" + } + } + } + }, + "/assistants": { + "get": { + "operationId": "List_Assistants", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of assistants.", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListAssistantsOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listAssistantsResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all assistants.": { + "$ref": "./examples/list_assistants.json" + } + } + }, + "post": { + "operationId": "Create_Assistant", + "tags": [ + "Assistants" + ], + "summary": "Create an assistant with a model and instructions.", + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createAssistantRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantObject" + } + } + } + } + }, + "x-ms-examples": { + "Create an assistant.": { + "$ref": "./examples/create_assistant.json" + } + } + } + }, + "/assistants/{assistant_id}": { + "get": { + "operationId": "Get_Assistant", + "tags": [ + "Assistants" + ], + "summary": "Retrieves an assistant.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieves an assistant.": { + "$ref": "./examples/retrieve_assistant.json" + } + } + }, + "post": { + "operationId": "Modify_Assistant", + "tags": [ + "Assistant" + ], + "summary": "Modifies an assistant.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyAssistantRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantObject" + } + } + } + } + }, + "x-ms-examples": { + "Modifies an assistant.": { + "$ref": "./examples/modify_assistant.json" + } + } + }, + "delete": { + "operationId": "Delete_Assistant", + "tags": [ + "Assistants" + ], + "summary": "Delete an assistant.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteAssistantResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete an assistant.": { + "$ref": "./examples/delete_assistant.json" + } + } + } + }, + "/threads": { + "post": { + "operationId": "Create_Thread", + "tags": [ + "Assistants" + ], + "summary": "Create a thread.", + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createThreadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/threadObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a thread.": { + "$ref": "./examples/create_thread.json" + } + } + } + }, + "/threads/{thread_id}": { + "get": { + "operationId": "Get_Thread", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/threadObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a thread.": { + "$ref": "./examples/retrieve_thread.json" + } + } + }, + "post": { + "operationId": "Modify_Thread", + "tags": [ + "Assistants" + ], + "summary": "Modifies a thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to modify. Only the `metadata` can be modified." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyThreadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/threadObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a thread.": { + "$ref": "./examples/modify_thread.json" + } + } + }, + "delete": { + "operationId": "Delete_Thread", + "tags": [ + "Assistants" + ], + "summary": "Delete a thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteThreadResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete a thread.": { + "$ref": "./examples/delete_thread.json" + } + } + } + }, + "/threads/{thread_id}/messages": { + "get": { + "operationId": "List_Messages", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of messages for a given thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) the messages belong to." + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListMessagesOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listMessagesResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all messages.": { + "$ref": "./examples/list_messages.json" + } + } + }, + "post": { + "operationId": "Create_Message", + "tags": [ + "Assistants" + ], + "summary": "Create a message.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) to create a message for." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createMessageRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a message.": { + "$ref": "./examples/create_message.json" + } + } + } + }, + "/threads/{thread_id}/messages/{message_id}": { + "get": { + "operationId": "Get_Message", + "tags": [ + "Assistants" + ], + "summary": "Retrieve a message.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) to which this message belongs." + }, + { + "in": "path", + "name": "message_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the message to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a message.": { + "$ref": "./examples/get_message.json" + } + } + }, + "post": { + "operationId": "Modify_Message", + "tags": [ + "Assistants" + ], + "summary": "Modifies a message.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which this message belongs." + }, + { + "in": "path", + "name": "message_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the message to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyMessageRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a message.": { + "$ref": "./examples/modify_message.json" + } + } + } + }, + "/threads/runs": { + "post": { + "operationId": "Create_Thread_And_Run", + "tags": [ + "Assistants" + ], + "summary": "Create a thread and run it in one request.", + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createThreadAndRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a thread and run it.": { + "$ref": "./examples/create_thread_and_run.json" + } + } + } + }, + "/threads/{thread_id}/runs": { + "get": { + "operationId": "List_Runs", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of runs belonging to a thread.", + "parameters": [ + { + "name": "thread_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread the run belongs to." + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListRunsOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listRunsResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all runs.": { + "$ref": "./examples/list_runs.json" + } + } + }, + "post": { + "operationId": "Create_Run", + "tags": [ + "Assistants" + ], + "summary": "Create a run.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to run." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a run.": { + "$ref": "./examples/create_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}": { + "get": { + "operationId": "Get_Run", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a run.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) that was run." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a run.": { + "$ref": "./examples/get_run.json" + } + } + }, + "post": { + "operationId": "Modify_Run", + "tags": [ + "Assistants" + ], + "summary": "Modifies a run.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) that was run." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a run.": { + "$ref": "./examples/modify_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/submit_tool_outputs": { + "post": { + "operationId": "Submit_Tool_Outputs_To_Run", + "tags": [ + "Assistants" + ], + "summary": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) to which this run belongs." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run that requires the tool output submission." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/submitToolOutputsRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Submit tool outputs to a run.": { + "$ref": "./examples/submit_tool_outputs_to_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/cancel": { + "post": { + "operationId": "Cancel_Run", + "tags": [ + "Assistants" + ], + "summary": "Cancels a run that is `in_progress`.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which this run belongs." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to cancel." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Cancel a run.": { + "$ref": "./examples/cancel_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/steps": { + "get": { + "operationId": "List_Run_Steps", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of run steps belonging to a run.", + "parameters": [ + { + "name": "thread_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread the run and run steps belong to." + }, + { + "name": "run_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run the run steps belong to." + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListRunStepsOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listRunStepsResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all run steps.": { + "$ref": "./examples/list_run_steps.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/steps/{step_id}": { + "get": { + "operationId": "Get_Run_Step", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a run step.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which the run and run step belongs." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to which the run step belongs." + }, + { + "in": "path", + "name": "step_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run step to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runStepObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a run step.": { + "$ref": "./examples/get_run_step.json" + } + } + } + }, + "/assistants/{assistant_id}/files": { + "get": { + "operationId": "List_Assistant_Files", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of assistant files.", + "parameters": [ + { + "name": "assistant_id", + "in": "path", + "description": "The ID of the assistant the file belongs to.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListAssistantFilesOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listAssistantFilesResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all assistant files.": { + "$ref": "./examples/list_assistant_files.json" + } + } + }, + "post": { + "operationId": "Create_Assistant_File", + "tags": [ + "Assistants" + ], + "summary": "Create an assistant file by attaching a [File](/docs/api-reference/files) to an [assistant](/docs/api-reference/assistants).", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant for which to create a File.\n" + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createAssistantFileRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantFileObject" + } + } + } + } + }, + "x-ms-examples": { + "Create an assistant file.": { + "$ref": "./examples/create_assistant_file.json" + } + } + } + }, + "/assistants/{assistant_id}/files/{file_id}": { + "get": { + "operationId": "Get_Assistant_File", + "tags": [ + "Assistants" + ], + "summary": "Retrieves an AssistantFile.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant who the file belongs to." + }, + { + "in": "path", + "name": "file_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the file we're getting." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantFileObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve an assistant file.": { + "$ref": "./examples/get_assistant_file.json" + } + } + }, + "delete": { + "operationId": "Delete_Assistant_File", + "tags": [ + "Assistants" + ], + "summary": "Delete an assistant file.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant that the file belongs to." + }, + { + "in": "path", + "name": "file_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the file to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteAssistantFileResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete an assistant file.": { + "$ref": "./examples/delete_assistant_file.json" + } + } + } + }, + "/threads/{thread_id}/messages/{message_id}/files": { + "get": { + "operationId": "List_Message_Files", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of message files.", + "parameters": [ + { + "name": "thread_id", + "in": "path", + "description": "The ID of the thread that the message and files belong to.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "message_id", + "in": "path", + "description": "The ID of the message that the files belongs to.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListMessageFilesOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listMessageFilesResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all message files.": { + "$ref": "./examples/list_message_files.json" + } + } + } + }, + "/threads/{thread_id}/messages/{message_id}/files/{file_id}": { + "get": { + "operationId": "Get_Message_File", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a message file.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which the message and File belong." + }, + { + "in": "path", + "name": "message_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the message the file belongs to." + }, + { + "in": "path", + "name": "file_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the file being retrieved." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-02-15-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageFileObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a message file.": { + "$ref": "./examples/get_message_file.json" + } + } + } + } + }, + "components": { + "schemas": { + "errorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/error" + } + } + }, + "errorBase": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "error": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/errorBase" + } + ], + "properties": { + "param": { + "type": "string" + }, + "type": { + "type": "string" + }, + "inner_error": { + "$ref": "#/components/schemas/innerError" + } + } + }, + "innerError": { + "description": "Inner error with additional details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/innerErrorCode" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterPromptResults" + } + } + }, + "innerErrorCode": { + "description": "Error codes for the inner error object.", + "enum": [ + "ResponsibleAIPolicyViolation" + ], + "type": "string", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "ResponsibleAIPolicyViolation", + "description": "The prompt violated one of more content filter rules." + } + ] + } + }, + "dalleErrorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/dalleError" + } + } + }, + "dalleError": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/errorBase" + } + ], + "properties": { + "param": { + "type": "string" + }, + "type": { + "type": "string" + }, + "inner_error": { + "$ref": "#/components/schemas/dalleInnerError" + } + } + }, + "dalleInnerError": { + "description": "Inner error with additional details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/innerErrorCode" + }, + "content_filter_results": { + "$ref": "#/components/schemas/dalleFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The prompt that was used to generate the image, if there was any revision to the prompt." + } + } + }, + "contentFilterResultBase": { + "type": "object", + "properties": { + "filtered": { + "type": "boolean" + } + }, + "required": [ + "filtered" + ] + }, + "contentFilterSeverityResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "severity": { + "type": "string", + "enum": [ + "safe", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "ContentFilterSeverity", + "modelAsString": true, + "values": [ + { + "value": "safe", + "description": "General content or related content in generic or non-harmful contexts." + }, + { + "value": "low", + "description": "Harmful content at a low intensity and risk level." + }, + { + "value": "medium", + "description": "Harmful content at a medium intensity and risk level." + }, + { + "value": "high", + "description": "Harmful content at a high intensity and risk level." + } + ] + } + } + } + } + ], + "required": [ + "severity", + "filtered" + ] + }, + "contentFilterDetectedResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "detected": { + "type": "boolean" + } + } + } + ], + "required": [ + "detected", + "filtered" + ] + }, + "contentFilterDetectedWithCitationResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + { + "properties": { + "citation": { + "type": "object", + "properties": { + "URL": { + "type": "string" + }, + "license": { + "type": "string" + } + } + } + } + } + ], + "required": [ + "detected", + "filtered" + ] + }, + "contentFilterIdResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "id": { + "type": "string" + } + } + } + ], + "required": [ + "id", + "filtered" + ] + }, + "contentFilterResultsBase": { + "type": "object", + "description": "Information about the content filtering results.", + "properties": { + "sexual": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "violence": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "hate": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "self_harm": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "profanity": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "custom_blocklists": { + "items": { + "$ref": "#/components/schemas/contentFilterIdResult" + }, + "type": "array" + }, + "error": { + "$ref": "#/components/schemas/errorBase" + } + } + }, + "contentFilterPromptResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultsBase" + }, + { + "properties": { + "jailbreak": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + } + ] + }, + "contentFilterChoiceResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultsBase" + }, + { + "properties": { + "protected_material_text": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + }, + { + "properties": { + "protected_material_code": { + "$ref": "#/components/schemas/contentFilterDetectedWithCitationResult" + } + } + } + ] + }, + "promptFilterResult": { + "type": "object", + "description": "Content filtering results for a single prompt in the request.", + "properties": { + "prompt_index": { + "type": "integer" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterPromptResults" + } + } + }, + "promptFilterResults": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/components/schemas/promptFilterResult" + } + }, + "dalleContentFilterResults": { + "type": "object", + "description": "Information about the content filtering results.", + "properties": { + "sexual": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "violence": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "hate": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "self_harm": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + } + } + }, + "dalleFilterResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/dalleContentFilterResults" + }, + { + "properties": { + "profanity": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "jailbreak": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + } + ] + }, + "chatCompletionsRequestCommon": { + "type": "object", + "properties": { + "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 + }, + "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": 4096 + }, + "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 + } + } + }, + "createChatCompletionRequest": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionsRequestCommon" + }, + { + "properties": { + "messages": { + "description": "A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb).", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + } + }, + "data_sources": { + "type": "array", + "description": " The configuration entries for Azure OpenAI chat extensions that use them.\n This additional specification is only compatible with Azure OpenAI.", + "items": { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + } + }, + "enhancements": { + "type": "object", + "description": "The type of enhancements needed.", + "properties": { + "grounding": { + "type": "object", + "description": "Request object to specify if grounding enhancement is needed.", + "properties": { + "enabled": { + "type": "boolean", + "default": false + } + } + }, + "ocr": { + "type": "object", + "description": "Request object to specify if ocr enhancement is needed.", + "properties": { + "enabled": { + "type": "boolean", + "default": false + } + } + } + } + }, + "n": { + "type": "integer", + "minimum": 1, + "maximum": 128, + "default": 1, + "example": 1, + "nullable": true, + "description": "How many chat completion choices to generate for each input message." + }, + "seed": { + "type": "integer", + "minimum": -9223372036854775808, + "maximum": 9223372036854775807, + "default": 0, + "example": 1, + "nullable": true, + "description": "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend." + }, + "logprobs": { + "description": "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. This option is currently not available on the `gpt-4-vision-preview` model.", + "type": "boolean", + "default": false, + "nullable": true + }, + "top_logprobs": { + "description": "An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used.", + "type": "integer", + "minimum": 0, + "maximum": 5, + "nullable": true + }, + "response_format": { + "type": "object", + "description": "An object specifying the format that the model must output. Used to enable JSON mode.", + "properties": { + "type": { + "$ref": "#/components/schemas/chatCompletionResponseFormat" + } + } + }, + "tools": { + "description": "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/chatCompletionTool" + } + }, + "tool_choice": { + "$ref": "#/components/schemas/chatCompletionToolChoiceOption" + }, + "functions": { + "description": "Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for.", + "type": "array", + "minItems": 1, + "maxItems": 128, + "items": { + "$ref": "#/components/schemas/chatCompletionFunction" + } + }, + "function_call": { + "description": "Deprecated in favor of `tool_choice`. Controls how the model responds to function calls. \"none\" means the model does not call a function, and responds to the end-user. \"auto\" means the model can pick between an end-user or calling a function. Specifying a particular function via `{\"name\":\\ \"my_function\"}` forces the model to call that function. \"none\" is the default when no functions are present. \"auto\" is the default if functions are present.", + "oneOf": [ + { + "type": "string", + "enum": [ + "none", + "auto" + ], + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function." + }, + { + "type": "object", + "description": "Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + } + ] + } + } + } + ], + "required": [ + "messages" + ] + }, + "chatCompletionResponseFormat": { + "type": "string", + "enum": [ + "text", + "json_object" + ], + "default": "text", + "example": "json_object", + "nullable": true, + "description": "Setting to `json_object` enables JSON mode. This guarantees that the message the model generates is valid JSON.", + "x-ms-enum": { + "name": "ChatCompletionResponseFormat", + "modelAsString": true, + "values": [ + { + "value": "text", + "description": "Response format is a plain text string." + }, + { + "value": "json_object", + "description": "Response format is a JSON object." + } + ] + } + }, + "chatCompletionFunction": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "description": { + "type": "string", + "description": "The description of what the function does." + }, + "parameters": { + "$ref": "#/components/schemas/chatCompletionFunctionParameters" + } + }, + "required": [ + "name" + ] + }, + "chatCompletionFunctionParameters": { + "type": "object", + "description": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/gpt/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.", + "additionalProperties": true + }, + "chatCompletionRequestMessage": { + "type": "object", + "properties": { + "role": { + "$ref": "#/components/schemas/chatCompletionRequestMessageRole" + } + }, + "discriminator": { + "propertyName": "role", + "mapping": { + "system": "#/components/schemas/chatCompletionRequestMessageSystem", + "user": "#/components/schemas/chatCompletionRequestMessageUser", + "assistant": "#/components/schemas/chatCompletionRequestMessageAssistant", + "tool": "#/components/schemas/chatCompletionRequestMessageTool", + "function": "#/components/schemas/chatCompletionRequestMessageFunction" + } + }, + "required": [ + "role" + ] + }, + "chatCompletionRequestMessageRole": { + "type": "string", + "enum": [ + "system", + "user", + "assistant", + "tool", + "function" + ], + "description": "The role of the messages author.", + "x-ms-enum": { + "name": "ChatCompletionRequestMessageRole", + "modelAsString": true, + "values": [ + { + "value": "system", + "description": "The message author role is system." + }, + { + "value": "user", + "description": "The message author role is user." + }, + { + "value": "assistant", + "description": "The message author role is assistant." + }, + { + "value": "tool", + "description": "The message author role is tool." + }, + { + "value": "function", + "description": "Deprecated. The message author role is function." + } + ] + } + }, + "chatCompletionRequestMessageSystem": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "content" + ] + }, + "chatCompletionRequestMessageUser": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "properties": { + "content": { + "oneOf": [ + { + "type": "string", + "description": "The contents of the message." + }, + { + "type": "array", + "description": "An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4-visual-preview` model.", + "minimum": 1, + "items": { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPart" + } + } + ], + "nullable": true + } + } + } + ], + "required": [ + "content" + ] + }, + "chatCompletionRequestMessageContentPart": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "text": "#/components/schemas/chatCompletionRequestMessageContentPartText", + "image_url": "#/components/schemas/chatCompletionRequestMessageContentPartImage" + } + }, + "required": [ + "type" + ] + }, + "chatCompletionRequestMessageContentPartType": { + "type": "string", + "enum": [ + "text", + "image_url" + ], + "description": "The type of the content part.", + "x-ms-enum": { + "name": "ChatCompletionRequestMessageContentPartType", + "modelAsString": true, + "values": [ + { + "value": "text", + "description": "The content part type is text." + }, + { + "value": "image_url", + "description": "The content part type is image_url." + } + ] + } + }, + "chatCompletionRequestMessageContentPartText": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPart" + }, + { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The text content." + } + } + } + ], + "required": [ + "text" + ] + }, + "chatCompletionRequestMessageContentPartImage": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPart" + }, + { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "Either a URL of the image or the base64 encoded image data.", + "format": "uri" + }, + "detail": { + "$ref": "#/components/schemas/imageDetailLevel" + } + } + } + ], + "required": [ + "url" + ] + }, + "imageDetailLevel": { + "type": "string", + "description": "Specifies the detail level of the image.", + "enum": [ + "auto", + "low", + "high" + ], + "default": "auto", + "x-ms-enum": { + "name": "ImageDetailLevel", + "modelAsString": true, + "values": [ + { + "value": "auto", + "description": "The image detail level is auto." + }, + { + "value": "low", + "description": "The image detail level is low." + }, + { + "value": "high", + "description": "The image detail level is high." + } + ] + } + }, + "chatCompletionRequestMessageAssistant": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + }, + "tool_calls": { + "type": "array", + "description": "The tool calls generated by the model, such as function calls.", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCall" + } + }, + "context": { + "$ref": "#/components/schemas/azureChatExtensionsMessageContext" + } + } + } + ], + "required": [ + "content" + ] + }, + "azureChatExtensionConfiguration": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/azureChatExtensionType" + } + }, + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_search": "#/components/schemas/azureSearchChatExtensionConfiguration", + "azure_ml_index": "#/components/schemas/azureMachineLearningIndexChatExtensionConfiguration", + "azure_cosmos_db": "#/components/schemas/azureCosmosDBChatExtensionConfiguration", + "elasticsearch": "#/components/schemas/elasticsearchChatExtensionConfiguration", + "pinecone": "#/components/schemas/pineconeChatExtensionConfiguration" + } + } + }, + "azureChatExtensionType": { + "type": "string", + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "enum": [ + "azure_search", + "azure_ml_index", + "azure_cosmos_db", + "elasticsearch", + "pinecone" + ], + "x-ms-enum": { + "name": "AzureChatExtensionType", + "modelAsString": true, + "values": [ + { + "name": "azureSearch", + "value": "azure_search", + "description": "Represents the use of Azure Search as an Azure OpenAI chat extension." + }, + { + "name": "azureMachineLearningIndex", + "value": "azure_ml_index", + "description": "Represents the use of Azure Machine Learning index as an Azure OpenAI chat extension." + }, + { + "name": "azureCosmosDB", + "value": "azure_cosmos_db", + "description": "Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension." + }, + { + "name": "elasticsearch", + "value": "elasticsearch", + "description": "Represents the use of Elasticsearch® index as an Azure OpenAI chat extension." + }, + { + "name": "pinecone", + "value": "pinecone", + "description": "Represents the use of Pinecone index as an Azure OpenAI chat extension." + } + ] + } + }, + "azureSearchChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureSearchChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_search" + }, + "azureSearchChatExtensionParameters": { + "required": [ + "authentication", + "endpoint", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + } + ] + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "endpoint": { + "type": "string", + "description": "The absolute endpoint path for the Azure Search resource to use.", + "format": "uri" + }, + "index_name": { + "type": "string", + "description": "The name of the index to use as available in the referenced Azure Search resource." + }, + "fields_mapping": { + "$ref": "#/components/schemas/azureSearchIndexFieldMappingOptions" + }, + "query_type": { + "$ref": "#/components/schemas/azureSearchQueryType" + }, + "semantic_configuration": { + "type": "string", + "description": "The additional semantic configuration for the query." + }, + "filter": { + "type": "string", + "description": "Search filter." + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + ] + } + }, + "description": "Parameters for Azure Search when used as an Azure OpenAI chat extension." + }, + "azureSearchIndexFieldMappingOptions": { + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + }, + "image_vector_fields": { + "type": "array", + "description": "The names of fields that represent image vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Azure Search resource." + }, + "azureSearchQueryType": { + "type": "string", + "description": "The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "semantic", + "vector", + "vector_simple_hybrid", + "vector_semantic_hybrid" + ], + "x-ms-enum": { + "name": "AzureSearchQueryType", + "modelAsString": true, + "values": [ + { + "name": "simple", + "value": "simple", + "description": "Represents the default, simple query parser." + }, + { + "name": "semantic", + "value": "semantic", + "description": "Represents the semantic query parser for advanced semantic modeling." + }, + { + "name": "vector", + "value": "vector", + "description": "Represents vector search over computed data." + }, + { + "name": "vectorSimpleHybrid", + "value": "vector_simple_hybrid", + "description": "Represents a combination of the simple query strategy with vector data." + }, + { + "name": "vectorSemanticHybrid", + "value": "vector_semantic_hybrid", + "description": "Represents a combination of semantic search and vector data querying." + } + ] + } + }, + "azureMachineLearningIndexChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Machine Learning vector index when using it as an Azure\nOpenAI chat extension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureMachineLearningIndexChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_ml_index" + }, + "azureMachineLearningIndexChatExtensionParameters": { + "required": [ + "authentication", + "name", + "project_resource_id", + "version" + ], + "type": "object", + "properties": { + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + } + ] + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "project_resource_id": { + "type": "string", + "description": "The resource ID of the Azure Machine Learning project." + }, + "name": { + "type": "string", + "description": "The Azure Machine Learning vector index name." + }, + "version": { + "type": "string", + "description": "The version of the Azure Machine Learning vector index." + }, + "filter": { + "type": "string", + "description": "Search filter. Only supported if the Azure Machine Learning vector index is of type AzureSearch." + } + }, + "description": "Parameters for the Azure Machine Learning vector index chat extension." + }, + "azureCosmosDBChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureCosmosDBChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_cosmos_db" + }, + "azureCosmosDBChatExtensionParameters": { + "required": [ + "authentication", + "container_name", + "database_name", + "embedding_dependency", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "database_name": { + "type": "string", + "description": "The MongoDB vCore database name to use with Azure Cosmos DB." + }, + "container_name": { + "type": "string", + "description": "The name of the Azure Cosmos DB resource container." + }, + "index_name": { + "type": "string", + "description": "The MongoDB vCore index name to use with Azure Cosmos DB." + }, + "fields_mapping": { + "$ref": "#/components/schemas/azureCosmosDBFieldMappingOptions" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + ] + } + }, + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore." + }, + "azureCosmosDBFieldMappingOptions": { + "required": [ + "content_fields", + "vector_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource." + }, + "elasticsearchChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/elasticsearchChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "elasticsearch" + }, + "elasticsearchChatExtensionParameters": { + "required": [ + "authentication", + "endpoint", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions" + } + ] + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "endpoint": { + "type": "string", + "description": "The endpoint of Elasticsearch®.", + "format": "uri" + }, + "index_name": { + "type": "string", + "description": "The index name of Elasticsearch®." + }, + "fields_mapping": { + "$ref": "#/components/schemas/elasticsearchIndexFieldMappingOptions" + }, + "query_type": { + "$ref": "#/components/schemas/elasticsearchQueryType" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataModelIdVectorizationSource" + } + ] + } + }, + "description": "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. " + }, + "elasticsearchIndexFieldMappingOptions": { + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Elasticsearch® resource." + }, + "elasticsearchQueryType": { + "type": "string", + "description": "The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "vector" + ], + "x-ms-enum": { + "name": "ElasticsearchQueryType", + "modelAsString": true, + "values": [ + { + "name": "simple", + "value": "simple", + "description": "Represents the default, simple query parser." + }, + { + "name": "vector", + "value": "vector", + "description": "Represents vector search over computed data." + } + ] + } + }, + "pineconeChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/pineconeChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "pinecone" + }, + "pineconeChatExtensionParameters": { + "required": [ + "authentication", + "embedding_dependency", + "environment", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "environment": { + "type": "string", + "description": "The environment name of Pinecone." + }, + "index_name": { + "type": "string", + "description": "The name of the Pinecone database index." + }, + "fields_mapping": { + "$ref": "#/components/schemas/pineconeFieldMappingOptions" + }, + "embedding_dependency": { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + }, + "description": "Parameters for configuring Azure OpenAI Pinecone chat extensions." + }, + "pineconeFieldMappingOptions": { + "required": [ + "content_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + } + }, + "description": "Optional settings to control how fields are processed when using a configured Pinecone resource." + }, + "onYourDataAuthenticationOptions": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/onYourDataAuthenticationType" + } + }, + "description": "The authentication options for Azure OpenAI On Your Data.", + "discriminator": { + "propertyName": "type", + "mapping": { + "api_key": "#/components/schemas/onYourDataApiKeyAuthenticationOptions", + "connection_string": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions", + "key_and_key_id": "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions", + "encoded_api_key": "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions", + "access_token": "#/components/schemas/onYourDataAccessTokenAuthenticationOptions", + "system_assigned_managed_identity": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions", + "user_assigned_managed_identity": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + } + } + }, + "onYourDataAuthenticationType": { + "type": "string", + "description": "The authentication types supported with Azure OpenAI On Your Data.", + "enum": [ + "api_key", + "connection_string", + "key_and_key_id", + "encoded_api_key", + "access_token", + "system_assigned_managed_identity", + "user_assigned_managed_identity" + ], + "x-ms-enum": { + "name": "OnYourDataAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "api_key", + "description": "Authentication via API key." + }, + { + "name": "connectionString", + "value": "connection_string", + "description": "Authentication via connection string." + }, + { + "name": "keyAndKeyId", + "value": "key_and_key_id", + "description": "Authentication via key and key ID pair." + }, + { + "name": "encodedApiKey", + "value": "encoded_api_key", + "description": "Authentication via encoded API key." + }, + { + "name": "accessToken", + "value": "access_token", + "description": "Authentication via access token." + }, + { + "name": "systemAssignedManagedIdentity", + "value": "system_assigned_managed_identity", + "description": "Authentication via system-assigned managed identity." + }, + { + "name": "userAssignedManagedIdentity", + "value": "user_assigned_managed_identity", + "description": "Authentication via user-assigned managed identity." + } + ] + } + }, + "onYourDataApiKeyAuthenticationOptions": { + "required": [ + "key" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "key": { + "type": "string", + "description": "The API key to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "api_key" + }, + "onYourDataConnectionStringAuthenticationOptions": { + "required": [ + "connection_string" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a connection string.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "connection_string": { + "type": "string", + "description": "The connection string to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "connection_string" + }, + "onYourDataKeyAndKeyIdAuthenticationOptions": { + "required": [ + "key", + "key_id" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "key": { + "type": "string", + "description": "The Elasticsearch key to use for authentication." + }, + "key_id": { + "type": "string", + "description": "The Elasticsearch key ID to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "key_and_key_id" + }, + "onYourDataEncodedApiKeyAuthenticationOptions": { + "required": [ + "encoded_api_key" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "encoded_api_key": { + "type": "string", + "description": "The Elasticsearch encoded API key to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "encoded_api_key" + }, + "onYourDataAccessTokenAuthenticationOptions": { + "required": [ + "access_token" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using access token.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "access_token": { + "type": "string", + "description": "The access token to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "access_token" + }, + "onYourDataSystemAssignedManagedIdentityAuthenticationOptions": { + "description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "system_assigned_managed_identity" + }, + "onYourDataUserAssignedManagedIdentityAuthenticationOptions": { + "required": [ + "managed_identity_resource_id" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "managed_identity_resource_id": { + "type": "string", + "description": "The resource ID of the user-assigned managed identity to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "user_assigned_managed_identity" + }, + "onYourDataVectorizationSource": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/onYourDataVectorizationSourceType" + } + }, + "description": "An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search.", + "discriminator": { + "propertyName": "type", + "mapping": { + "endpoint": "#/components/schemas/onYourDataEndpointVectorizationSource", + "deployment_name": "#/components/schemas/onYourDataDeploymentNameVectorizationSource", + "model_id": "#/components/schemas/onYourDataModelIdVectorizationSource" + } + } + }, + "onYourDataVectorizationSourceType": { + "type": "string", + "description": "Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with\nvector search.", + "enum": [ + "endpoint", + "deployment_name", + "model_id" + ], + "x-ms-enum": { + "name": "OnYourDataVectorizationSourceType", + "modelAsString": true, + "values": [ + { + "name": "endpoint", + "value": "endpoint", + "description": "Represents vectorization performed by public service calls to an Azure OpenAI embedding model." + }, + { + "name": "deploymentName", + "value": "deployment_name", + "description": "Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but\nOn Your Data will use this model deployment via an internal call rather than a public one, which enables vector\nsearch even in private networks." + }, + { + "name": "modelId", + "value": "model_id", + "description": "Represents a specific embedding model ID as defined in the search service.\nCurrently only supported by Elasticsearch®." + } + ] + } + }, + "onYourDataEndpointVectorizationSource": { + "required": [ + "authentication", + "endpoint" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a public Azure OpenAI endpoint call for embeddings.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "endpoint": { + "type": "string", + "description": "Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter is not allowed.", + "format": "uri" + }, + "authentication": { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + } + } + } + ], + "x-ms-discriminator-value": "endpoint" + }, + "onYourDataDeploymentNameVectorizationSource": { + "required": [ + "deployment_name" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non an internal embeddings model deployment name in the same Azure OpenAI resource.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "deployment_name": { + "type": "string", + "description": "Specifies the name of the model deployment to use for vectorization. This model deployment must be in the same Azure OpenAI resource, but On Your Data will use this model deployment via an internal call rather than a public one, which enables vector search even in private networks." + } + } + } + ], + "x-ms-discriminator-value": "deployment_name" + }, + "onYourDataModelIdVectorizationSource": { + "required": [ + "model_id" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a search service model ID. Currently only supported by Elasticsearch®.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "model_id": { + "type": "string", + "description": "Specifies the model ID to use for vectorization. This model ID must be defined in the search service." + } + } + } + ], + "x-ms-discriminator-value": "model_id" + }, + "azureChatExtensionsMessageContext": { + "type": "object", + "properties": { + "citations": { + "type": "array", + "description": "The data source retrieval result, used to generate the assistant message in the response.", + "items": { + "$ref": "#/components/schemas/citation" + }, + "x-ms-identifiers": [] + }, + "intent": { + "type": "string", + "description": "The detected intent from the chat history, used to pass to the next turn to carry over the context." + } + }, + "description": " A representation of the additional context information available when Azure OpenAI chat extensions are involved\n in the generation of a corresponding chat completions response. This context information is only populated when\n using an Azure OpenAI request configured to use a matching extension." + }, + "citation": { + "required": [ + "content" + ], + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the citation." + }, + "title": { + "type": "string", + "description": "The title of the citation." + }, + "url": { + "type": "string", + "description": "The URL of the citation." + }, + "filepath": { + "type": "string", + "description": "The file path of the citation." + }, + "chunk_id": { + "type": "string", + "description": "The chunk ID of the citation." + } + }, + "description": "citation information for a chat completions response message." + }, + "chatCompletionMessageToolCall": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "$ref": "#/components/schemas/toolCallType" + }, + "function": { + "type": "object", + "description": "The function that the model called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + }, + "required": [ + "name", + "arguments" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "toolCallType": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool call, in this case `function`.", + "x-ms-enum": { + "name": "ToolCallType", + "modelAsString": true, + "values": [ + { + "value": "function", + "description": "The tool call type is function." + } + ] + } + }, + "chatCompletionRequestMessageTool": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "nullable": true, + "properties": { + "tool_call_id": { + "type": "string", + "description": "Tool call that this message is responding to." + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "tool_call_id", + "content" + ] + }, + "chatCompletionRequestMessageFunction": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "description": "Deprecated. Message that represents a function.", + "nullable": true, + "properties": { + "role": { + "type": "string", + "enum": [ + "function" + ], + "description": "The role of the messages author, in this case `function`." + }, + "name": { + "type": "string", + "description": "The contents of the message." + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "function_call_id", + "content" + ] + }, + "createChatCompletionResponse": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionsResponseCommon" + }, + { + "properties": { + "prompt_filter_results": { + "$ref": "#/components/schemas/promptFilterResults" + }, + "choices": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionChoiceCommon" + }, + { + "properties": { + "message": { + "$ref": "#/components/schemas/chatCompletionResponseMessage" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterChoiceResults" + }, + "logprobs": { + "$ref": "#/components/schemas/chatCompletionChoiceLogProbs" + }, + "enhancements": { + "description": "The enhancement results returned by the service.", + "$ref": "#/components/schemas/enhancement" + } + } + } + ] + } + } + } + } + ], + "required": [ + "id", + "object", + "created", + "model", + "choices" + ] + }, + "chatCompletionChoiceLogProbs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content" + ] + }, + "chatCompletionTokenLogprob": { + "type": "object", + "properties": { + "token": { + "description": "The token.", + "type": "string" + }, + "logprob": { + "description": "The log probability of this token.", + "type": "number" + }, + "bytes": { + "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", + "type": "array", + "items": { + "type": "integer" + }, + "nullable": true + }, + "top_logprobs": { + "description": "List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.", + "type": "array", + "items": { + "type": "object", + "properties": { + "token": { + "description": "The token.", + "type": "string" + }, + "logprob": { + "description": "The log probability of this token.", + "type": "number" + }, + "bytes": { + "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", + "type": "array", + "items": { + "type": "integer" + }, + "nullable": true + } + }, + "required": [ + "token", + "logprob", + "bytes" + ] + } + } + }, + "required": [ + "token", + "logprob", + "bytes", + "top_logprobs" + ] + }, + "chatCompletionResponseMessage": { + "type": "object", + "description": "A chat completion message generated by the model.", + "properties": { + "role": { + "$ref": "#/components/schemas/chatCompletionResponseMessageRole" + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + }, + "tool_calls": { + "type": "array", + "description": "The tool calls generated by the model, such as function calls.", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCall" + } + }, + "function_call": { + "$ref": "#/components/schemas/chatCompletionFunctionCall" + }, + "context": { + "$ref": "#/components/schemas/azureChatExtensionsMessageContext" + } + } + }, + "chatCompletionResponseMessageRole": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "The role of the author of the response message." + }, + "chatCompletionToolChoiceOption": { + "description": "Controls which (if any) function is called by the model. `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function. Specifying a particular function via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that function.", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.", + "enum": [ + "none", + "auto" + ] + }, + { + "$ref": "#/components/schemas/chatCompletionNamedToolChoice" + } + ] + }, + "chatCompletionNamedToolChoice": { + "type": "object", + "description": "Specifies a tool the model should use. Use to force the model to call a specific function.", + "properties": { + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + } + } + }, + "chatCompletionFunctionCall": { + "type": "object", + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + }, + "required": [ + "name", + "arguments" + ] + }, + "chatCompletionsResponseCommon": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the chat completion." + }, + "object": { + "$ref": "#/components/schemas/chatCompletionResponseObject" + }, + "created": { + "type": "integer", + "format": "unixtime", + "description": "The Unix timestamp (in seconds) of when the chat completion was created." + }, + "model": { + "type": "string", + "description": "The model used for the chat completion." + }, + "usage": { + "$ref": "#/components/schemas/completionUsage" + }, + "system_fingerprint": { + "type": "string", + "description": "Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism." + } + }, + "required": [ + "id", + "object", + "created", + "model" + ] + }, + "chatCompletionResponseObject": { + "type": "string", + "description": "The object type.", + "enum": [ + "chat.completion" + ], + "x-ms-enum": { + "name": "ChatCompletionResponseObject", + "modelAsString": true, + "values": [ + { + "value": "chat.completion", + "description": "The object type is chat completion." + } + ] + } + }, + "completionUsage": { + "type": "object", + "description": "Usage statistics for the completion request.", + "properties": { + "prompt_tokens": { + "type": "integer", + "description": "Number of tokens in the prompt." + }, + "completion_tokens": { + "type": "integer", + "description": "Number of tokens in the generated completion." + }, + "total_tokens": { + "type": "integer", + "description": "Total number of tokens used in the request (prompt + completion)." + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ] + }, + "chatCompletionTool": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/chatCompletionToolType" + }, + "function": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/chatCompletionFunctionParameters" + } + }, + "required": [ + "name", + "parameters" + ] + } + }, + "required": [ + "type", + "function" + ] + }, + "chatCompletionToolType": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported.", + "x-ms-enum": { + "name": "ChatCompletionToolType", + "modelAsString": true, + "values": [ + { + "value": "function", + "description": "The tool type is function." + } + ] + } + }, + "chatCompletionChoiceCommon": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "finish_reason": { + "type": "string" + } + } + }, + "createTranslationRequest": { + "type": "object", + "description": "Translation request.", + "properties": { + "file": { + "type": "string", + "description": "The audio file to translate.", + "format": "binary" + }, + "prompt": { + "type": "string", + "description": "An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English." + }, + "response_format": { + "$ref": "#/components/schemas/audioResponseFormat" + }, + "temperature": { + "type": "number", + "default": 0, + "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + } + }, + "required": [ + "file" + ] + }, + "audioResponse": { + "description": "Translation or transcription response when response_format was json", + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "Translated or transcribed text." + } + }, + "required": [ + "text" + ] + }, + "audioVerboseResponse": { + "description": "Translation or transcription response when response_format was verbose_json", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "properties": { + "task": { + "type": "string", + "description": "Type of audio task.", + "enum": [ + "transcribe", + "translate" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "language": { + "type": "string", + "description": "Language." + }, + "duration": { + "type": "number", + "description": "Duration." + }, + "segments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/audioSegment" + } + } + } + } + ], + "required": [ + "text" + ] + }, + "audioResponseFormat": { + "title": "AudioResponseFormat", + "description": "Defines the format of the output.", + "enum": [ + "json", + "text", + "srt", + "verbose_json", + "vtt" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true + } + }, + "createTranscriptionRequest": { + "type": "object", + "description": "Transcription request.", + "properties": { + "file": { + "type": "string", + "description": "The audio file object to transcribe.", + "format": "binary" + }, + "prompt": { + "type": "string", + "description": "An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language." + }, + "response_format": { + "$ref": "#/components/schemas/audioResponseFormat" + }, + "temperature": { + "type": "number", + "default": 0, + "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + }, + "language": { + "type": "string", + "description": "The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency." + } + }, + "required": [ + "file" + ] + }, + "audioSegment": { + "type": "object", + "description": "Transcription or translation segment.", + "properties": { + "id": { + "type": "integer", + "description": "Segment identifier." + }, + "seek": { + "type": "number", + "description": "Offset of the segment." + }, + "start": { + "type": "number", + "description": "Segment start offset." + }, + "end": { + "type": "number", + "description": "Segment end offset." + }, + "text": { + "type": "string", + "description": "Segment text." + }, + "tokens": { + "type": "array", + "items": { + "type": "number", + "nullable": false + }, + "description": "Tokens of the text." + }, + "temperature": { + "type": "number", + "description": "Temperature." + }, + "avg_logprob": { + "type": "number", + "description": "Average log probability." + }, + "compression_ratio": { + "type": "number", + "description": "Compression ratio." + }, + "no_speech_prob": { + "type": "number", + "description": "Probability of 'no speech'." + } + } + }, + "createSpeechRequest": { + "type": "object", + "description": "Speech request.", + "properties": { + "input": { + "type": "string", + "description": "The text to synthesize audio for. The maximum length is 4096 characters.", + "maxLength": 4096 + }, + "voice": { + "type": "string", + "description": "The voice to use for speech synthesis.", + "enum": [ + "alloy", + "echo", + "fable", + "onyx", + "nova", + "shimmer" + ] + }, + "response_format": { + "type": "string", + "description": "The format to synthesize the audio in.", + "enum": [ + "mp3", + "opus", + "aac", + "flac" + ] + }, + "speed": { + "description": "The speed of the synthesize audio. Select a value from `0.25` to `4.0`. `1.0` is the default.", + "type": "number", + "default": 1.0, + "minimum": 0.25, + "maximum": 4.0 + } + }, + "required": [ + "input", + "voice" + ] + }, + "imageQuality": { + "description": "The quality of the image that will be generated.", + "type": "string", + "enum": [ + "standard", + "hd" + ], + "default": "standard", + "x-ms-enum": { + "name": "Quality", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Standard quality creates images with standard quality.", + "name": "Standard" + }, + { + "value": "hd", + "description": "HD quality creates images with finer details and greater consistency across the image.", + "name": "HD" + } + ] + } + }, + "imagesResponseFormat": { + "description": "The format in which the generated images are returned.", + "type": "string", + "enum": [ + "url", + "b64_json" + ], + "default": "url", + "x-ms-enum": { + "name": "ImagesResponseFormat", + "modelAsString": true, + "values": [ + { + "value": "url", + "description": "The URL that provides temporary access to download the generated images.", + "name": "Url" + }, + { + "value": "b64_json", + "description": "The generated images are returned as base64 encoded string.", + "name": "Base64Json" + } + ] + } + }, + "imageSize": { + "description": "The size of the generated images.", + "type": "string", + "enum": [ + "1792x1024", + "1024x1792", + "1024x1024" + ], + "default": "1024x1024", + "x-ms-enum": { + "name": "Size", + "modelAsString": true, + "values": [ + { + "value": "1792x1024", + "description": "The desired size of the generated image is 1792x1024 pixels.", + "name": "Size1792x1024" + }, + { + "value": "1024x1792", + "description": "The desired size of the generated image is 1024x1792 pixels.", + "name": "Size1024x1792" + }, + { + "value": "1024x1024", + "description": "The desired size of the generated image is 1024x1024 pixels.", + "name": "Size1024x1024" + } + ] + } + }, + "imageStyle": { + "description": "The style of the generated images.", + "type": "string", + "enum": [ + "vivid", + "natural" + ], + "default": "vivid", + "x-ms-enum": { + "name": "Style", + "modelAsString": true, + "values": [ + { + "value": "vivid", + "description": "Vivid creates images that are hyper-realistic and dramatic.", + "name": "Vivid" + }, + { + "value": "natural", + "description": "Natural creates images that are more natural and less hyper-realistic.", + "name": "Natural" + } + ] + } + }, + "imageGenerationsRequest": { + "type": "object", + "properties": { + "prompt": { + "description": "A text description of the desired image(s). The maximum length is 4000 characters.", + "type": "string", + "format": "string", + "example": "a corgi in a field", + "minLength": 1 + }, + "n": { + "description": "The number of images to generate.", + "type": "integer", + "minimum": 1, + "maximum": 1, + "default": 1 + }, + "size": { + "$ref": "#/components/schemas/imageSize" + }, + "response_format": { + "$ref": "#/components/schemas/imagesResponseFormat" + }, + "user": { + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.", + "type": "string", + "format": "string", + "example": "user123456" + }, + "quality": { + "$ref": "#/components/schemas/imageQuality" + }, + "style": { + "$ref": "#/components/schemas/imageStyle" + } + }, + "required": [ + "prompt" + ] + }, + "generateImagesResponse": { + "type": "object", + "properties": { + "created": { + "type": "integer", + "format": "unixtime", + "description": "The unix timestamp when the operation was created.", + "example": "1676540381" + }, + "data": { + "type": "array", + "description": "The result data of the operation, if successful", + "items": { + "$ref": "#/components/schemas/imageResult" + } + } + }, + "required": [ + "created", + "data" + ] + }, + "imageResult": { + "type": "object", + "description": "The image url or encoded image if successful, and an error otherwise.", + "properties": { + "url": { + "type": "string", + "description": "The image url.", + "example": "https://www.contoso.com" + }, + "b64_json": { + "type": "string", + "description": "The base64 encoded image" + }, + "content_filter_results": { + "$ref": "#/components/schemas/dalleContentFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The prompt that was used to generate the image, if there was any revision to the prompt." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/dalleFilterResults" + } + } + }, + "enhancement": { + "type": "object", + "properties": { + "grounding": { + "type": "object", + "description": "The grounding enhancement that returns the bounding box of the objects detected in the image.", + "properties": { + "lines": { + "type": "array", + "items": { + "$ref": "#/components/schemas/line" + } + } + }, + "required": [ + "lines" + ] + } + } + }, + "line": { + "type": "object", + "description": "A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.", + "properties": { + "text": { + "type": "string" + }, + "spans": { + "type": "array", + "description": "An array of spans that represent detected objects and its bounding box information.", + "items": { + "$ref": "#/components/schemas/span" + } + } + }, + "required": [ + "text", + "spans" + ] + }, + "span": { + "type": "object", + "description": "A span object that represents a detected object and its bounding box information.", + "properties": { + "text": { + "type": "string", + "description": "The text content of the span that represents the detected object." + }, + "offset": { + "type": "integer", + "description": "The character offset within the text where the span begins. This offset is defined as the position of the first character of the span, counting from the start of the text as Unicode codepoints." + }, + "length": { + "type": "integer", + "description": "The length of the span in characters, measured in Unicode codepoints." + }, + "polygon": { + "type": "array", + "description": "An array of objects representing points in the polygon that encloses the detected object.", + "items": { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "The x-coordinate of the point." + }, + "y": { + "type": "number", + "description": "The y-coordinate of the point." + } + } + } + } + }, + "required": [ + "text", + "offset", + "length", + "polygon" + ] + }, + "assistantObject": { + "type": "object", + "title": "Assistant", + "description": "Represents an `assistant` that can call the model and use tools.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `assistant`.", + "type": "string", + "enum": [ + "assistant" + ], + "x-ms-enum": { + "name": "AssistantObjectType", + "modelAsString": true, + "values": [ + { + "value": "assistant", + "description": "The object type, which is always assistant" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the assistant was created.", + "type": "integer" + }, + "name": { + "description": "The name of the assistant. The maximum length is 256 characters.\n", + "type": "string", + "maxLength": 256, + "nullable": true + }, + "description": { + "description": "The description of the assistant. The maximum length is 512 characters.\n", + "type": "string", + "maxLength": 512, + "nullable": true + }, + "model": { + "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n", + "type": "string" + }, + "instructions": { + "description": "The system instructions that the assistant uses. The maximum length is 32768 characters.\n", + "type": "string", + "maxLength": 32768, + "nullable": true + }, + "tools": { + "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.\n", + "default": [], + "type": "array", + "maxItems": 128, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsRetrieval" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "file_ids": { + "description": "A list of [file](/docs/api-reference/files) IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order.\n", + "default": [], + "type": "array", + "maxItems": 20, + "items": { + "type": "string" + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "name", + "description", + "model", + "instructions", + "tools", + "file_ids", + "metadata" + ] + }, + "createAssistantRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "model": { + "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n", + "anyOf": [ + { + "type": "string" + } + ] + }, + "name": { + "description": "The name of the assistant. The maximum length is 256 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 256 + }, + "description": { + "description": "The description of the assistant. The maximum length is 512 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 512 + }, + "instructions": { + "description": "The system instructions that the assistant uses. The maximum length is 32768 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 32768 + }, + "tools": { + "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.\n", + "default": [], + "type": "array", + "maxItems": 128, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsRetrieval" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "file_ids": { + "description": "A list of [file](/docs/api-reference/files) IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order.\n", + "default": [], + "maxItems": 20, + "type": "array", + "items": { + "type": "string" + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "model" + ] + }, + "modifyAssistantRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "model": { + "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n", + "anyOf": [ + { + "type": "string" + } + ] + }, + "name": { + "description": "The name of the assistant. The maximum length is 256 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 256 + }, + "description": { + "description": "The description of the assistant. The maximum length is 512 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 512 + }, + "instructions": { + "description": "The system instructions that the assistant uses. The maximum length is 32768 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 32768 + }, + "tools": { + "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.\n", + "default": [], + "type": "array", + "maxItems": 128, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsRetrieval" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "file_ids": { + "description": "A list of [File](/docs/api-reference/files) IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order. If a file was previously attached to the list but does not show up in the list, it will be deleted from the assistant.\n", + "default": [], + "type": "array", + "maxItems": 20, + "items": { + "type": "string" + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "deleteAssistantResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "assistant.deleted" + ], + "x-ms-enum": { + "name": "DeleteAssistantResponseState", + "modelAsString": true, + "values": [ + { + "value": "assistant.deleted", + "description": "The assistant is deleted" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listAssistantsResponse": { + "type": "object", + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/assistantObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "assistantToolsCode": { + "type": "object", + "title": "Code interpreter tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `code_interpreter`", + "enum": [ + "code_interpreter" + ], + "x-ms-enum": { + "name": "assistantToolsCodeType", + "modelAsString": true, + "values": [ + { + "value": "code_interpreter", + "description": "code_interpreter as type of tool being defined" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "assistantToolsRetrieval": { + "type": "object", + "title": "Retrieval tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `retrieval`", + "enum": [ + "retrieval" + ], + "x-ms-enum": { + "name": "assistantToolsRetrievalType", + "modelAsString": true, + "values": [ + { + "value": "retrieval", + "description": "retrieval as type of tool being defined" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "assistantToolsFunction": { + "type": "object", + "title": "Function tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `function`", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "assistantToolsFunction", + "modelAsString": true, + "values": [ + { + "value": "retrieval", + "description": "retrieval as type of tool being defined" + } + ] + } + }, + "function": { + "type": "object", + "description": "The function definition.", + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/chatCompletionFunctionParameters" + } + }, + "required": [ + "name", + "parameters", + "description" + ] + } + }, + "required": [ + "type", + "function" + ] + }, + "runObject": { + "type": "object", + "title": "A run on a thread", + "description": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.run`.", + "type": "string", + "enum": [ + "thread.run" + ], + "x-ms-enum": { + "name": "runObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.run", + "description": "The run object type which is always thread.run" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the run was created.", + "type": "integer" + }, + "thread_id": { + "description": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "type": "string" + }, + "assistant_id": { + "description": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", + "type": "string" + }, + "status": { + "description": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "requires_action", + "cancelling", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "queued", + "description": "The queued state" + }, + { + "value": "in_progress", + "description": "The in_progress state" + }, + { + "value": "requires_action", + "description": "The required_action state" + }, + { + "value": "cancelling", + "description": "The cancelling state" + }, + { + "value": "cancelled", + "description": "The cancelled state" + }, + { + "value": "failed", + "description": "The failed state" + }, + { + "value": "completed", + "description": "The completed state" + }, + { + "value": "expired", + "description": "The expired state" + } + ] + } + }, + "required_action": { + "type": "object", + "description": "Details on the action required to continue the run. Will be `null` if no action is required.", + "nullable": true, + "properties": { + "type": { + "description": "For now, this is always `submit_tool_outputs`.", + "type": "string", + "enum": [ + "submit_tool_outputs" + ] + }, + "submit_tool_outputs": { + "type": "object", + "description": "Details on the tool outputs needed for this run to continue.", + "properties": { + "tool_calls": { + "type": "array", + "description": "A list of the relevant tool calls.", + "items": { + "$ref": "#/components/schemas/runToolCallObject" + } + } + }, + "required": [ + "tool_calls" + ] + } + }, + "required": [ + "type", + "submit_tool_outputs" + ] + }, + "last_error": { + "type": "object", + "description": "The last error associated with this run. Will be `null` if there are no errors.", + "nullable": true, + "properties": { + "code": { + "type": "string", + "description": "One of `server_error` or `rate_limit_exceeded`.", + "enum": [ + "server_error", + "rate_limit_exceeded" + ], + "x-ms-enum": { + "name": "LastErrorCode", + "modelAsString": true, + "values": [ + { + "value": "server_error", + "description": "The server failed to respond to request due to server error" + }, + { + "value": "rate_limit_exceeded", + "description": "The server failed to respond to request due to rate limit exceeded" + } + ] + } + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "expires_at": { + "description": "The Unix timestamp (in seconds) for when the run will expire.", + "type": "integer" + }, + "started_at": { + "description": "The Unix timestamp (in seconds) for when the run was started.", + "type": "integer", + "nullable": true + }, + "cancelled_at": { + "description": "The Unix timestamp (in seconds) for when the run was cancelled.", + "type": "integer", + "nullable": true + }, + "failed_at": { + "description": "The Unix timestamp (in seconds) for when the run failed.", + "type": "integer", + "nullable": true + }, + "completed_at": { + "description": "The Unix timestamp (in seconds) for when the run was completed.", + "type": "integer", + "nullable": true + }, + "model": { + "description": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", + "type": "string" + }, + "instructions": { + "description": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", + "type": "string" + }, + "tools": { + "description": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", + "default": [], + "type": "array", + "maxItems": 20, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsRetrieval" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "file_ids": { + "description": "The list of [File](/docs/api-reference/files) IDs the [assistant](/docs/api-reference/assistants) used for this run.", + "default": [], + "type": "array", + "items": { + "type": "string" + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "thread_id", + "assistant_id", + "status", + "required_action", + "last_error", + "expires_at", + "started_at", + "cancelled_at", + "failed_at", + "completed_at", + "model", + "instructions", + "tools", + "file_ids", + "metadata" + ] + }, + "createRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "assistant_id": { + "description": "The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run.", + "type": "string" + }, + "model": { + "description": "The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", + "type": "string", + "nullable": true + }, + "instructions": { + "description": "Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.", + "type": "string", + "nullable": true + }, + "tools": { + "description": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.", + "nullable": true, + "type": "array", + "maxItems": 20, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsRetrieval" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "thread_id", + "assistant_id" + ] + }, + "listRunsResponse": { + "type": "object", + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "modifyRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "submitToolOutputsRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "tool_outputs": { + "description": "A list of tools for which the outputs are being submitted.", + "type": "array", + "items": { + "type": "object", + "properties": { + "tool_call_id": { + "type": "string", + "description": "The ID of the tool call in the `required_action` object within the run object the output is being submitted for." + }, + "output": { + "type": "string", + "description": "The output of the tool call to be submitted to continue the run." + } + } + } + } + }, + "required": [ + "tool_outputs" + ] + }, + "runToolCallObject": { + "type": "object", + "description": "Tool call objects", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint." + }, + "type": { + "type": "string", + "description": "The type of tool call the output is required for. For now, this is always `function`.", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "RunToolCallObjectType", + "modelAsString": true, + "values": [ + { + "value": "function", + "description": "The type of tool call the output is required for which is always `function` for now" + }, + { + "value": "rate_limit_exceeded", + "description": "The server failed to respond to request due to rate limit exceeded" + } + ] + } + }, + "function": { + "type": "object", + "description": "The function definition.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments that the model expects you to pass to the function." + } + }, + "required": [ + "name", + "arguments" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "createThreadAndRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "assistant_id": { + "description": "The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run.", + "type": "string" + }, + "thread": { + "$ref": "#/components/schemas/createThreadRequest", + "description": "If no thread is provided, an empty thread will be created." + }, + "model": { + "description": "The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", + "type": "string", + "nullable": true + }, + "instructions": { + "description": "Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.", + "type": "string", + "nullable": true + }, + "tools": { + "description": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.", + "nullable": true, + "type": "array", + "maxItems": 20, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsRetrieval" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "thread_id", + "assistant_id" + ] + }, + "threadObject": { + "type": "object", + "title": "Thread", + "description": "Represents a thread that contains [messages](/docs/api-reference/messages).", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread`.", + "type": "string", + "enum": [ + "thread" + ], + "x-ms-enum": { + "name": "ThreadObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread", + "description": "The type of thread object which is always `thread`" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the thread was created.", + "type": "integer" + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "metadata" + ] + }, + "createThreadRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "messages": { + "description": "A list of [messages](/docs/api-reference/messages) to start the thread with.", + "type": "array", + "items": { + "$ref": "#/components/schemas/createMessageRequest" + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "modifyThreadRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "deleteThreadResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "thread.deleted" + ], + "x-ms-enum": { + "name": "DeleteThreadResponseObjectState", + "modelAsString": true, + "values": [ + { + "value": "thread.deleted", + "description": "The delete thread response object state which is `thread.deleted`" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listThreadsResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/threadObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "messageObject": { + "type": "object", + "title": "The message object", + "description": "Represents a message within a [thread](/docs/api-reference/threads).", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.message`.", + "type": "string", + "enum": [ + "thread.message" + ], + "x-ms-enum": { + "name": "MessageObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.message", + "description": "The message object type which is `thread.message`" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the message was created.", + "type": "integer" + }, + "thread_id": { + "description": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", + "type": "string" + }, + "role": { + "description": "The entity that produced the message. One of `user` or `assistant`.", + "type": "string", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "MessageObjectRole", + "modelAsString": true, + "values": [ + { + "value": "user", + "description": "Message object role as `user`" + }, + { + "value": "assistant", + "description": "Message object role as `assistant`" + } + ] + } + }, + "content": { + "description": "The content of the message in array of text and/or images.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageContentImageFileObject" + }, + { + "$ref": "#/components/schemas/messageContentTextObject" + } + ] + } + }, + "assistant_id": { + "description": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", + "type": "string", + "nullable": true + }, + "run_id": { + "description": "If applicable, the ID of the [run](/docs/api-reference/runs) associated with the authoring of this message.", + "type": "string", + "nullable": true + }, + "file_ids": { + "description": "A list of [file](/docs/api-reference/files) IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can access files. A maximum of 10 files can be attached to a message.", + "default": [], + "maxItems": 10, + "type": "array", + "items": { + "type": "string" + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "thread_id", + "role", + "content", + "assistant_id", + "run_id", + "file_ids", + "metadata" + ] + }, + "createMessageRequest": { + "type": "object", + "additionalProperties": false, + "required": [ + "role", + "content" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "user" + ], + "x-ms-enum": { + "name": "CreateMessageRequestRole", + "modelAsString": true, + "values": [ + { + "value": "user", + "description": "The create message role as `user`" + } + ] + }, + "description": "The role of the entity that is creating the message. Currently only `user` is supported." + }, + "content": { + "type": "string", + "minLength": 1, + "maxLength": 32768, + "description": "The content of the message." + }, + "file_ids": { + "description": "A list of [File](/docs/api-reference/files) IDs that the message should use. There can be a maximum of 10 files attached to a message. Useful for tools like `retrieval` and `code_interpreter` that can access and use files.", + "default": [], + "type": "array", + "minItems": 1, + "maxItems": 10, + "items": { + "type": "string" + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "modifyMessageRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "deleteMessageResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "thread.message.deleted" + ], + "x-ms-enum": { + "name": "DeleteMessageResponseObject", + "modelAsString": true, + "values": [ + { + "value": "thread.message.deleted", + "description": "The delete message response object state" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listMessagesResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messageObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "messageContentImageFileObject": { + "title": "Image file", + "type": "object", + "description": "References an image [File](/docs/api-reference/files) in the content of a message.", + "properties": { + "type": { + "description": "Always `image_file`.", + "type": "string", + "enum": [ + "image_file" + ], + "x-ms-enum": { + "name": "MessageContentImageFileObjectType", + "modelAsString": true, + "values": [ + { + "value": "image_file", + "description": "The message content image file type" + } + ] + } + }, + "image_file": { + "type": "object", + "properties": { + "file_id": { + "description": "The [File](/docs/api-reference/files) ID of the image in the message content.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + } + }, + "required": [ + "type", + "image_file" + ] + }, + "messageContentTextObject": { + "title": "Text", + "type": "object", + "description": "The text content that is part of a message.", + "properties": { + "type": { + "description": "Always `text`.", + "type": "string", + "enum": [ + "text" + ], + "x-ms-enum": { + "name": "messageContentTextObjectType", + "modelAsString": true, + "values": [ + { + "value": "text", + "description": "The message content text Object type" + } + ] + } + }, + "text": { + "type": "object", + "properties": { + "value": { + "description": "The data that makes up the text.", + "type": "string" + }, + "annotations": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageContentTextAnnotationsFileCitationObject" + }, + { + "$ref": "#/components/schemas/messageContentTextAnnotationsFilePathObject" + } + ] + } + } + }, + "required": [ + "value", + "annotations" + ] + } + }, + "required": [ + "type", + "text" + ] + }, + "messageContentTextAnnotationsFileCitationObject": { + "title": "File citation", + "type": "object", + "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"retrieval\" tool to search files.", + "properties": { + "type": { + "description": "Always `file_citation`.", + "type": "string", + "enum": [ + "file_citation" + ], + "x-ms-enum": { + "name": "FileCitationObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_citation", + "description": "The file citation object type" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_citation": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the specific File the citation is from.", + "type": "string" + }, + "quote": { + "description": "The specific quote in the file.", + "type": "string" + } + }, + "required": [ + "file_id", + "quote" + ] + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "type", + "text", + "file_citation", + "start_index", + "end_index" + ] + }, + "messageContentTextAnnotationsFilePathObject": { + "title": "File path", + "type": "object", + "description": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", + "properties": { + "type": { + "description": "Always `file_path`.", + "type": "string", + "enum": [ + "file_path" + ], + "x-ms-enum": { + "name": "FilePathObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_path", + "description": "The file path object type" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_path": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the file that was generated.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "type", + "text", + "file_path", + "start_index", + "end_index" + ] + }, + "runStepObject": { + "type": "object", + "title": "Run steps", + "description": "Represents a step in execution of a run.\n", + "properties": { + "id": { + "description": "The identifier of the run step, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `assistant.run.step``.", + "type": "string", + "enum": [ + "assistant.run.step" + ], + "x-ms-enum": { + "name": "RunStepObjectType", + "modelAsString": true, + "values": [ + { + "value": "assistant.run.step", + "description": "The object type, which is always `assistant.run.step`" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the run step was created.", + "type": "integer" + }, + "assistant_id": { + "description": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", + "type": "string" + }, + "thread_id": { + "description": "The ID of the [thread](/docs/api-reference/threads) that was run.", + "type": "string" + }, + "run_id": { + "description": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", + "type": "string" + }, + "type": { + "description": "The type of run step, which can be either `message_creation` or `tool_calls`.", + "type": "string", + "enum": [ + "message_creation", + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepObjectType", + "modelAsString": true, + "values": [ + { + "value": "message_creation", + "description": "The message_creation run step" + }, + { + "value": "tool_calls", + "description": "The tool_calls run step" + } + ] + } + }, + "status": { + "description": "The status of the run, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", + "type": "string", + "enum": [ + "in_progress", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunStepObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress", + "description": "The in_progress run status" + }, + { + "value": "cancelled", + "description": "The cancelled run status" + }, + { + "value": "failed", + "description": "The cancelled run status" + }, + { + "value": "completed", + "description": "The cancelled run status" + }, + { + "value": "expired", + "description": "The cancelled run status" + } + ] + } + }, + "step_details": { + "type": "object", + "description": "The details of the run step.", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDetailsMessageCreationObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsObject" + } + ] + }, + "last_error": { + "type": "object", + "description": "The last error associated with this run step. Will be `null` if there are no errors.", + "nullable": true, + "properties": { + "code": { + "type": "string", + "description": "One of `server_error` or `rate_limit_exceeded`.", + "enum": [ + "server_error", + "rate_limit_exceeded" + ], + "x-ms-enum": { + "name": "LastErrorCode", + "modelAsString": true, + "values": [ + { + "value": "server_error", + "description": "The server_error" + }, + { + "value": "rate_limit_exceeded", + "description": "The rate_limit_exceeded status" + } + ] + } + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "expired_at": { + "description": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", + "type": "integer", + "nullable": true + }, + "cancelled_at": { + "description": "The Unix timestamp (in seconds) for when the run step was cancelled.", + "type": "integer", + "nullable": true + }, + "failed_at": { + "description": "The Unix timestamp (in seconds) for when the run step failed.", + "type": "integer", + "nullable": true + }, + "completed_at": { + "description": "The Unix timestamp (in seconds) for when the run step completed.", + "type": "integer", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "assistant_id", + "thread_id", + "run_id", + "type", + "status", + "step_details", + "last_error", + "expired_at", + "cancelled_at", + "failed_at", + "completed_at", + "metadata" + ] + }, + "listRunStepsResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "runStepDetailsMessageCreationObject": { + "title": "Message creation", + "type": "object", + "description": "Details of the message creation by the run step.", + "properties": { + "type": { + "description": "Always `message_creation``.", + "type": "string", + "enum": [ + "message_creation" + ], + "x-ms-enum": { + "name": "RunStepDetailsMessageCreationObjectType", + "modelAsString": true, + "values": [ + { + "value": "message_creation" + } + ] + } + }, + "message_creation": { + "type": "object", + "properties": { + "message_id": { + "type": "string", + "description": "The ID of the message that was created by this run step." + } + }, + "required": [ + "message_id" + ] + } + }, + "required": [ + "type", + "message_creation" + ] + }, + "runStepDetailsToolCallsObject": { + "title": "Tool calls", + "type": "object", + "description": "Details of the tool call.", + "properties": { + "type": { + "description": "Always `tool_calls`.", + "type": "string", + "enum": [ + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsObjectType", + "modelAsString": true, + "values": [ + { + "value": "tool_calls" + } + ] + } + }, + "tool_calls": { + "type": "array", + "description": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `retrieval`, or `function`.\n", + "items": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDetailsToolCallsCodeObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsRetrievalObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsFunctionObject" + } + ] + } + } + }, + "required": [ + "type", + "tool_calls" + ] + }, + "runStepDetailsToolCallsCodeObject": { + "title": "Code interpreter tool call", + "type": "object", + "description": "Details of the Code Interpreter tool call the run step was involved in.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", + "enum": [ + "code_interpreter" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsCodeObjectType", + "modelAsString": true, + "values": [ + { + "value": "code_interpreter" + } + ] + } + }, + "code_interpreter": { + "type": "object", + "description": "The Code Interpreter tool call definition.", + "required": [ + "input", + "outputs" + ], + "properties": { + "input": { + "type": "string", + "description": "The input to the Code Interpreter tool call." + }, + "outputs": { + "type": "array", + "description": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "items": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDetailsToolCallsCodeOutputLogsObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsCodeOutputImageObject" + } + ] + } + } + } + } + }, + "required": [ + "id", + "type", + "code_interpreter" + ] + }, + "runStepDetailsToolCallsCodeOutputLogsObject": { + "title": "Code interpreter log output", + "type": "object", + "description": "Text output from the Code Interpreter tool call as part of a run step.", + "properties": { + "type": { + "description": "Always `logs`.", + "type": "string", + "enum": [ + "logs" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsCodeOutputLogsObjectType", + "modelAsString": true, + "values": [ + { + "value": "code_interpreter" + } + ] + } + }, + "logs": { + "type": "string", + "description": "The text output from the Code Interpreter tool call." + } + }, + "required": [ + "type", + "logs" + ] + }, + "runStepDetailsToolCallsCodeOutputImageObject": { + "title": "Code interpreter image output", + "type": "object", + "properties": { + "type": { + "description": "Always `image`.", + "type": "string", + "enum": [ + "image" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsCodeOutputImageObjectType", + "modelAsString": true, + "values": [ + { + "value": "image" + } + ] + } + }, + "image": { + "type": "object", + "properties": { + "file_id": { + "description": "The [file](/docs/api-reference/files) ID of the image.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + } + }, + "required": [ + "type", + "image" + ] + }, + "runStepDetailsToolCallsRetrievalObject": { + "title": "Retrieval tool call", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `retrieval` for this type of tool call.", + "enum": [ + "retrieval" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsRetrievalObjectType", + "modelAsString": true, + "values": [ + { + "value": "retrieval" + } + ] + } + }, + "retrieval": { + "type": "object", + "description": "For now, this is always going to be an empty object." + } + }, + "required": [ + "id", + "type", + "retrieval" + ] + }, + "runStepDetailsToolCallsFunctionObject": { + "type": "object", + "title": "Function tool call", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `function` for this type of tool call.", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsFunctionObjectType", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The definition of the function that was called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments passed to the function." + }, + "output": { + "type": "string", + "description": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", + "nullable": true + } + }, + "required": [ + "name", + "arguments", + "output" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "assistantFileObject": { + "type": "object", + "title": "Assistant files", + "description": "A list of [Files](/docs/api-reference/files) attached to an `assistant`.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `assistant.file`.", + "type": "string", + "enum": [ + "assistant.file" + ], + "x-ms-enum": { + "name": "AssistantFileObjectType", + "modelAsString": true, + "values": [ + { + "value": "assistant.file" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the assistant file was created.", + "type": "integer" + }, + "assistant_id": { + "description": "The assistant ID that the file is attached to.", + "type": "string" + } + }, + "required": [ + "id", + "object", + "created_at", + "assistant_id" + ] + }, + "createAssistantFileRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "file_id": { + "description": "A [File](/docs/api-reference/files) ID (with `purpose=\"assistants\"`) that the assistant should use. Useful for tools like `retrieval` and `code_interpreter` that can access files.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + }, + "deleteAssistantFileResponse": { + "type": "object", + "description": "Deletes the association between the assistant and the file, but does not delete the [File](/docs/api-reference/files) object itself.", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "assistant.file.deleted" + ], + "x-ms-enum": { + "name": "DeleteAssistantFileResponseType", + "modelAsString": true, + "values": [ + { + "value": "assistant.file.deleted" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listAssistantFilesResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/assistantFileObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "items", + "first_id", + "last_id", + "has_more" + ] + }, + "messageFileObject": { + "type": "object", + "title": "Message files", + "description": "A list of files attached to a `message`.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.message.file`.", + "type": "string", + "enum": [ + "thread.message.file" + ], + "x-ms-enum": { + "name": "MessageFileObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.message.file" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the message file was created.", + "type": "integer" + }, + "message_id": { + "description": "The ID of the [message](/docs/api-reference/messages) that the [File](/docs/api-reference/files) is attached to.", + "type": "string" + } + }, + "required": [ + "id", + "object", + "created_at", + "message_id" + ] + }, + "listMessageFilesResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messageFileObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "items", + "first_id", + "last_id", + "has_more" + ] + } + }, + "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" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.yaml new file mode 100644 index 000000000000..012c96f6f6ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.yaml @@ -0,0 +1,5293 @@ +openapi: 3.0.0 +info: + title: Azure OpenAI Service API + description: Azure OpenAI APIs for completions and search + version: 2024-02-15-preview +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-12-01-preview + 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. + Note 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. + We 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. + We 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. + Note: 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. + Minimum of 0 and maximum of 5 allowed. + type: integer + default: null + nullable: true + 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: |+ + + nullable: true + - type: array + items: + type: string + example: |+ + + nullable: false + description: Array minimum size of 1 and maximum of 4 + completion_config: + type: string + 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. + When 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. + Note: 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. + + 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 + prompt_filter_results: + $ref: '#/components/schemas/promptFilterResults' + 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 + nullable: true + finish_reason: + type: string + content_filter_results: + $ref: '#/components/schemas/contentFilterChoiceResults' + 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: 2024-02-15-preview + 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. + 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. + 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 + 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 + x-ms-examples: + Create a embeddings.: + $ref: ./examples/embeddings.yaml + /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: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/createChatCompletionRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/createChatCompletionResponse' + 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 + x-ms-examples: + Create a chat completion.: + $ref: ./examples/chat_completions.yaml + Creates a completion based on Azure Search data and system-assigned managed identity.: + $ref: ./examples/chat_completions_azure_search_minimum.yaml + Creates a completion based on Azure Search image vector data.: + $ref: ./examples/chat_completions_azure_search_image_vector.yaml + Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.: + $ref: ./examples/chat_completions_azure_search_advanced.yaml + Creates a completion for the provided AML index.: + $ref: ./examples/chat_completions_aml_index.yaml + Creates a completion for the provided Azure Cosmos DB.: + $ref: ./examples/chat_completions_cosmos_db.yaml + Creates a completion for the provided Elasticsearch.: + $ref: ./examples/chat_completions_elasticsearch.yaml + Creates a completion for the provided Pinecone resource.: + $ref: ./examples/chat_completions_pinecone.yaml + /deployments/{deployment-id}/audio/transcriptions: + post: + summary: Transcribes audio into the input language. + operationId: Transcriptions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: whisper + description: Deployment id of the whisper model. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/createTranscriptionRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/audioResponse' + - $ref: '#/components/schemas/audioVerboseResponse' + text/plain: + schema: + type: string + description: Transcribed text in the output format (when response_format was one of text, vtt or srt). + x-ms-examples: + Create an audio transcription with json response format.: + $ref: ./examples/audio_transcription_object.yaml + Create an audio transcription with text response format.: + $ref: ./examples/audio_transcription_text.yaml + /deployments/{deployment-id}/audio/translations: + post: + summary: Transcribes and translates input audio into English text. + operationId: Translations_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: whisper + description: Deployment id of the whisper model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/createTranslationRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/audioResponse' + - $ref: '#/components/schemas/audioVerboseResponse' + text/plain: + schema: + type: string + description: Transcribed text in the output format (when response_format was one of text, vtt or srt). + x-ms-examples: + Create an audio translation with json response format.: + $ref: ./examples/audio_translation_object.yaml + Create an audio translation with text response format.: + $ref: ./examples/audio_translation_text.yaml + /deployments/{deployment-id}/audio/speech: + post: + summary: Generates audio from the input text. + operationId: Speech_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: tts-1 + description: Deployment id of the tts model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/createSpeechRequest' + responses: + '200': + description: OK + content: + application/octet-stream: + schema: + type: string + format: binary + x-ms-examples: + Create an audio from text with response format mp3.: + $ref: ./examples/audio_speech.yaml + /deployments/{deployment-id}/images/generations: + post: + summary: Generates a batch of images from a text caption on a given DALLE model deployment + operationId: ImageGenerations_Create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/imageGenerationsRequest' + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: dalle-deployment + description: Deployment id of the dalle model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/generateImagesResponse' + default: + description: An error occurred. + content: + application/json: + schema: + $ref: '#/components/schemas/dalleErrorResponse' + x-ms-examples: + Create an image.: + $ref: ./examples/image_generation.yaml + /assistants: + get: + operationId: List_Assistants + tags: + - Assistants + summary: Returns a list of assistants. + parameters: + - name: limit + in: query + description: | + A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: | + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListAssistantsOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: | + A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + description: | + A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/listAssistantsResponse' + x-ms-examples: + Create an image.: + $ref: ./examples/list_assistants.yaml + post: + operationId: Create_Assistant + tags: + - Assistants + summary: Create an assistant with a model and instructions. + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/createAssistantRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/assistantObject' + x-ms-examples: + Create an assistant.: + $ref: ./examples/create_assistant.yaml + /assistants/{assistant_id}: + get: + operationId: Get_Assistant + tags: + - Assistants + summary: Retrieves an assistant. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/assistantObject' + x-ms-examples: + Create an assistant.: + $ref: ./examples/retrieve_assistant.yaml + post: + operationId: Modify_Assistant + tags: + - Assistant + summary: Modifies an assistant. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/modifyAssistantRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/assistantObject' + x-ms-examples: + Create an assistant.: + $ref: ./examples/modify_assistant.yaml + delete: + operationId: Delete_Assistant + tags: + - Assistants + summary: Delete an assistant. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/deleteAssistantResponse' + x-ms-examples: + Create an assistant.: + $ref: ./examples/delete_assistant.yaml + /threads: + post: + operationId: Create_Thread + tags: + - Assistants + summary: Create a thread. + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/createThreadRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/threadObject' + x-ms-examples: + Create a thread.: + $ref: ./examples/create_thread.yaml + /threads/{thread_id}: + get: + operationId: Get_Thread + tags: + - Assistants + summary: Retrieves a thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/threadObject' + x-ms-examples: + Create a thread.: + $ref: ./examples/retrieve_thread.yaml + post: + operationId: Modify_Thread + tags: + - Assistants + summary: Modifies a thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to modify. Only the `metadata` can be modified. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/modifyThreadRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/threadObject' + x-ms-examples: + Modify a thread.: + $ref: ./examples/modify_thread.yaml + delete: + operationId: Delete_Thread + tags: + - Assistants + summary: Delete a thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/deleteThreadResponse' + x-ms-examples: + Delete a thread.: + $ref: ./examples/delete_thread.yaml + /threads/{thread_id}/messages: + get: + operationId: List_Messages + tags: + - Assistants + summary: Returns a list of messages for a given thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) the messages belong to. + - name: limit + in: query + description: | + A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: | + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListMessagesOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: | + A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + description: | + A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/listMessagesResponse' + x-ms-examples: + List messages.: + $ref: ./examples/list_messages.yaml + post: + operationId: Create_Message + tags: + - Assistants + summary: Create a message. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) to create a message for. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/createMessageRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/messageObject' + x-ms-examples: + Create a message.: + $ref: ./examples/create_message.yaml + /threads/{thread_id}/messages/{message_id}: + get: + operationId: Get_Message + tags: + - Assistants + summary: Retrieve a message. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) to which this message belongs. + - in: path + name: message_id + required: true + schema: + type: string + description: The ID of the message to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/messageObject' + x-ms-examples: + Retrieve a message.: + $ref: ./examples/get_message.yaml + post: + operationId: Modify_Message + tags: + - Assistants + summary: Modifies a message. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to which this message belongs. + - in: path + name: message_id + required: true + schema: + type: string + description: The ID of the message to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/modifyMessageRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/messageObject' + x-ms-examples: + Modify a message.: + $ref: ./examples/modify_message.yaml + /threads/runs: + post: + operationId: Create_Thread_And_Run + tags: + - Assistants + summary: Create a thread and run it in one request. + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/createThreadAndRunRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/runObject' + x-ms-examples: + Create a thread and run it.: + $ref: ./examples/create_thread_and_run.yaml + /threads/{thread_id}/runs: + get: + operationId: List_Runs + tags: + - Assistants + summary: Returns a list of runs belonging to a thread. + parameters: + - name: thread_id + in: path + required: true + schema: + type: string + description: The ID of the thread the run belongs to. + - name: limit + in: query + description: | + A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: | + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListRunsOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: | + A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + description: | + A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/listRunsResponse' + x-ms-examples: + List runs.: + $ref: ./examples/list_runs.yaml + post: + operationId: Create_Run + tags: + - Assistants + summary: Create a run. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to run. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/createRunRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/runObject' + x-ms-examples: + Create a run.: + $ref: ./examples/create_run.yaml + /threads/{thread_id}/runs/{run_id}: + get: + operationId: Get_Run + tags: + - Assistants + summary: Retrieves a run. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) that was run. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/runObject' + x-ms-examples: + Retrieve a run.: + $ref: ./examples/get_run.yaml + post: + operationId: Modify_Run + tags: + - Assistants + summary: Modifies a run. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) that was run. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/modifyRunRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/runObject' + x-ms-examples: + Modify a run.: + $ref: ./examples/modify_run.yaml + /threads/{thread_id}/runs/{run_id}/submit_tool_outputs: + post: + operationId: Submit_Tool_Outputs_To_Run + tags: + - Assistants + summary: | + When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) to which this run belongs. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run that requires the tool output submission. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/submitToolOutputsRunRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/runObject' + x-ms-examples: + Submit tool outputs to a run.: + $ref: ./examples/submit_tool_outputs_to_run.yaml + /threads/{thread_id}/runs/{run_id}/cancel: + post: + operationId: Cancel_Run + tags: + - Assistants + summary: Cancels a run that is `in_progress`. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to which this run belongs. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to cancel. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/runObject' + x-ms-examples: + Cancel a run.: + $ref: ./examples/cancel_run.yaml + /threads/{thread_id}/runs/{run_id}/steps: + get: + operationId: List_Run_Steps + tags: + - Assistants + summary: Returns a list of run steps belonging to a run. + parameters: + - name: thread_id + in: path + required: true + schema: + type: string + description: The ID of the thread the run and run steps belong to. + - name: run_id + in: path + required: true + schema: + type: string + description: The ID of the run the run steps belong to. + - name: limit + in: query + description: | + A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: | + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListRunStepsOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: | + A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + description: | + A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/listRunStepsResponse' + x-ms-examples: + List run steps.: + $ref: ./examples/list_run_steps.yaml + /threads/{thread_id}/runs/{run_id}/steps/{step_id}: + get: + operationId: Get_Run_Step + tags: + - Assistants + summary: Retrieves a run step. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to which the run and run step belongs. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to which the run step belongs. + - in: path + name: step_id + required: true + schema: + type: string + description: The ID of the run step to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/runStepObject' + x-ms-examples: + Retrieve a run step.: + $ref: ./examples/get_run_step.yaml + /assistants/{assistant_id}/files: + get: + operationId: List_Assistant_Files + tags: + - Assistants + summary: Returns a list of assistant files. + parameters: + - name: assistant_id + in: path + description: The ID of the assistant the file belongs to. + required: true + schema: + type: string + - name: limit + in: query + description: | + A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: | + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListAssistantFilesOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: | + A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + description: | + A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/listAssistantFilesResponse' + x-ms-examples: + List assistant files.: + $ref: ./examples/list_assistant_files.yaml + post: + operationId: Create_Assistant_File + tags: + - Assistants + summary: Create an assistant file by attaching a [File](/docs/api-reference/files) to an [assistant](/docs/api-reference/assistants). + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + example: file-AF1WoRqd3aJAHsqc9NY7iL8F + description: | + The ID of the assistant for which to create a File. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/createAssistantFileRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/assistantFileObject' + x-ms-examples: + Create an assistant file.: + $ref: ./examples/create_assistant_file.yaml + /assistants/{assistant_id}/files/{file_id}: + get: + operationId: Get_Assistant_File + tags: + - Assistants + summary: Retrieves an AssistantFile. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant who the file belongs to. + - in: path + name: file_id + required: true + schema: + type: string + description: The ID of the file we're getting. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/assistantFileObject' + x-ms-examples: + Retrieve an assistant file.: + $ref: ./examples/get_assistant_file.yaml + delete: + operationId: Delete_Assistant_File + tags: + - Assistants + summary: Delete an assistant file. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant that the file belongs to. + - in: path + name: file_id + required: true + schema: + type: string + description: The ID of the file to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/deleteAssistantFileResponse' + x-ms-examples: + Delete an assistant file.: + $ref: ./examples/delete_assistant_file.yaml + /threads/{thread_id}/messages/{message_id}/files: + get: + operationId: List_Message_Files + tags: + - Assistants + summary: Returns a list of message files. + parameters: + - name: thread_id + in: path + description: The ID of the thread that the message and files belong to. + required: true + schema: + type: string + - name: message_id + in: path + description: The ID of the message that the files belongs to. + required: true + schema: + type: string + - name: limit + in: query + description: | + A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: | + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListMessageFilesOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: | + A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + description: | + A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/listMessageFilesResponse' + x-ms-examples: + List message files.: + $ref: ./examples/list_message_files.yaml + /threads/{thread_id}/messages/{message_id}/files/{file_id}: + get: + operationId: Get_Message_File + tags: + - Assistants + summary: Retrieves a message file. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + example: thread_AF1WoRqd3aJAHsqc9NY7iL8F + description: The ID of the thread to which the message and File belong. + - in: path + name: message_id + required: true + schema: + type: string + example: msg_AF1WoRqd3aJAHsqc9NY7iL8F + description: The ID of the message the file belongs to. + - in: path + name: file_id + required: true + schema: + type: string + example: file-AF1WoRqd3aJAHsqc9NY7iL8F + description: The ID of the file being retrieved. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-02-15-preview + description: api version + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/messageFileObject' + x-ms-examples: + Retrieve a message file.: + $ref: ./examples/get_message_file.yaml +components: + schemas: + errorResponse: + type: object + properties: + error: + $ref: '#/components/schemas/error' + errorBase: + type: object + properties: + code: + type: string + message: + type: string + error: + type: object + allOf: + - $ref: '#/components/schemas/errorBase' + properties: + param: + type: string + type: + type: string + inner_error: + $ref: '#/components/schemas/innerError' + innerError: + description: Inner error with additional details. + type: object + properties: + code: + $ref: '#/components/schemas/innerErrorCode' + content_filter_results: + $ref: '#/components/schemas/contentFilterPromptResults' + innerErrorCode: + description: Error codes for the inner error object. + enum: + - ResponsibleAIPolicyViolation + type: string + x-ms-enum: + name: InnerErrorCode + modelAsString: true + values: + - value: ResponsibleAIPolicyViolation + description: The prompt violated one of more content filter rules. + dalleErrorResponse: + type: object + properties: + error: + $ref: '#/components/schemas/dalleError' + dalleError: + type: object + allOf: + - $ref: '#/components/schemas/errorBase' + properties: + param: + type: string + type: + type: string + inner_error: + $ref: '#/components/schemas/dalleInnerError' + dalleInnerError: + description: Inner error with additional details. + type: object + properties: + code: + $ref: '#/components/schemas/innerErrorCode' + content_filter_results: + $ref: '#/components/schemas/dalleFilterResults' + revised_prompt: + type: string + description: The prompt that was used to generate the image, if there was any revision to the prompt. + contentFilterResultBase: + type: object + properties: + filtered: + type: boolean + required: + - filtered + contentFilterSeverityResult: + type: object + allOf: + - $ref: '#/components/schemas/contentFilterResultBase' + - properties: + severity: + type: string + enum: + - safe + - low + - medium + - high + x-ms-enum: + name: ContentFilterSeverity + modelAsString: true + values: + - value: safe + description: General content or related content in generic or non-harmful contexts. + - value: low + description: Harmful content at a low intensity and risk level. + - value: medium + description: Harmful content at a medium intensity and risk level. + - value: high + description: Harmful content at a high intensity and risk level. + required: + - severity + - filtered + contentFilterDetectedResult: + type: object + allOf: + - $ref: '#/components/schemas/contentFilterResultBase' + - properties: + detected: + type: boolean + required: + - detected + - filtered + contentFilterDetectedWithCitationResult: + type: object + allOf: + - $ref: '#/components/schemas/contentFilterDetectedResult' + - properties: + citation: + type: object + properties: + URL: + type: string + license: + type: string + required: + - detected + - filtered + contentFilterIdResult: + type: object + allOf: + - $ref: '#/components/schemas/contentFilterResultBase' + - properties: + id: + type: string + required: + - id + - filtered + contentFilterResultsBase: + type: object + description: Information about the content filtering results. + properties: + sexual: + $ref: '#/components/schemas/contentFilterSeverityResult' + violence: + $ref: '#/components/schemas/contentFilterSeverityResult' + hate: + $ref: '#/components/schemas/contentFilterSeverityResult' + self_harm: + $ref: '#/components/schemas/contentFilterSeverityResult' + profanity: + $ref: '#/components/schemas/contentFilterDetectedResult' + custom_blocklists: + items: + $ref: '#/components/schemas/contentFilterIdResult' + type: array + error: + $ref: '#/components/schemas/errorBase' + contentFilterPromptResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: '#/components/schemas/contentFilterResultsBase' + - properties: + jailbreak: + $ref: '#/components/schemas/contentFilterDetectedResult' + contentFilterChoiceResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: '#/components/schemas/contentFilterResultsBase' + - properties: + protected_material_text: + $ref: '#/components/schemas/contentFilterDetectedResult' + - properties: + protected_material_code: + $ref: '#/components/schemas/contentFilterDetectedWithCitationResult' + promptFilterResult: + type: object + description: Content filtering results for a single prompt in the request. + properties: + prompt_index: + type: integer + content_filter_results: + $ref: '#/components/schemas/contentFilterPromptResults' + promptFilterResults: + type: array + description: Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders. + items: + $ref: '#/components/schemas/promptFilterResult' + dalleContentFilterResults: + type: object + description: Information about the content filtering results. + properties: + sexual: + $ref: '#/components/schemas/contentFilterSeverityResult' + violence: + $ref: '#/components/schemas/contentFilterSeverityResult' + hate: + $ref: '#/components/schemas/contentFilterSeverityResult' + self_harm: + $ref: '#/components/schemas/contentFilterSeverityResult' + dalleFilterResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: '#/components/schemas/dalleContentFilterResults' + - properties: + profanity: + $ref: '#/components/schemas/contentFilterDetectedResult' + jailbreak: + $ref: '#/components/schemas/contentFilterDetectedResult' + chatCompletionsRequestCommon: + type: object + properties: + 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. + We 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. + We generally recommend altering this or `temperature` but not both. + type: number + minimum: 0 + maximum: 1 + 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: 4096 + 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 + createChatCompletionRequest: + type: object + allOf: + - $ref: '#/components/schemas/chatCompletionsRequestCommon' + - properties: + messages: + description: A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb). + type: array + minItems: 1 + items: + $ref: '#/components/schemas/chatCompletionRequestMessage' + data_sources: + type: array + description: |2- + The configuration entries for Azure OpenAI chat extensions that use them. + This additional specification is only compatible with Azure OpenAI. + items: + $ref: '#/components/schemas/azureChatExtensionConfiguration' + enhancements: + type: object + description: The type of enhancements needed. + properties: + grounding: + type: object + description: Request object to specify if grounding enhancement is needed. + properties: + enabled: + type: boolean + default: false + ocr: + type: object + description: Request object to specify if ocr enhancement is needed. + properties: + enabled: + type: boolean + default: false + 'n': + type: integer + minimum: 1 + maximum: 128 + default: 1 + example: 1 + nullable: true + description: How many chat completion choices to generate for each input message. + seed: + type: integer + minimum: -9223372036854775808 + maximum: 9223372036854775807 + default: 0 + example: 1 + nullable: true + description: If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. + logprobs: + description: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. This option is currently not available on the `gpt-4-vision-preview` model. + type: boolean + default: false + nullable: true + top_logprobs: + description: An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. + type: integer + minimum: 0 + maximum: 5 + nullable: true + response_format: + type: object + description: An object specifying the format that the model must output. Used to enable JSON mode. + properties: + type: + $ref: '#/components/schemas/chatCompletionResponseFormat' + tools: + description: A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. + type: array + minItems: 1 + items: + $ref: '#/components/schemas/chatCompletionTool' + tool_choice: + $ref: '#/components/schemas/chatCompletionToolChoiceOption' + functions: + description: Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for. + type: array + minItems: 1 + maxItems: 128 + items: + $ref: '#/components/schemas/chatCompletionFunction' + function_call: + description: Deprecated in favor of `tool_choice`. Controls how the model responds to function calls. "none" means the model does not call a function, and responds to the end-user. "auto" means the model can pick between an end-user or calling a function. Specifying a particular function via `{"name":\ "my_function"}` forces the model to call that function. "none" is the default when no functions are present. "auto" is the default if functions are present. + oneOf: + - type: string + enum: + - none + - auto + description: '`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.' + - type: object + description: 'Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.' + properties: + name: + type: string + description: The name of the function to call. + required: + - name + required: + - messages + chatCompletionResponseFormat: + type: string + enum: + - text + - json_object + default: text + example: json_object + nullable: true + description: Setting to `json_object` enables JSON mode. This guarantees that the message the model generates is valid JSON. + x-ms-enum: + name: ChatCompletionResponseFormat + modelAsString: true + values: + - value: text + description: Response format is a plain text string. + - value: json_object + description: Response format is a JSON object. + chatCompletionFunction: + type: object + properties: + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + description: + type: string + description: The description of what the function does. + parameters: + $ref: '#/components/schemas/chatCompletionFunctionParameters' + required: + - name + chatCompletionFunctionParameters: + type: object + description: The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/gpt/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. + additionalProperties: true + chatCompletionRequestMessage: + type: object + properties: + role: + $ref: '#/components/schemas/chatCompletionRequestMessageRole' + discriminator: + propertyName: role + mapping: + system: '#/components/schemas/chatCompletionRequestMessageSystem' + user: '#/components/schemas/chatCompletionRequestMessageUser' + assistant: '#/components/schemas/chatCompletionRequestMessageAssistant' + tool: '#/components/schemas/chatCompletionRequestMessageTool' + function: '#/components/schemas/chatCompletionRequestMessageFunction' + required: + - role + chatCompletionRequestMessageRole: + type: string + enum: + - system + - user + - assistant + - tool + - function + description: The role of the messages author. + x-ms-enum: + name: ChatCompletionRequestMessageRole + modelAsString: true + values: + - value: system + description: The message author role is system. + - value: user + description: The message author role is user. + - value: assistant + description: The message author role is assistant. + - value: tool + description: The message author role is tool. + - value: function + description: Deprecated. The message author role is function. + chatCompletionRequestMessageSystem: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessage' + - type: object + properties: + content: + type: string + description: The contents of the message. + nullable: true + required: + - content + chatCompletionRequestMessageUser: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessage' + - type: object + properties: + content: + oneOf: + - type: string + description: The contents of the message. + - type: array + description: An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4-visual-preview` model. + minimum: 1 + items: + $ref: '#/components/schemas/chatCompletionRequestMessageContentPart' + nullable: true + required: + - content + chatCompletionRequestMessageContentPart: + type: object + properties: + type: + $ref: '#/components/schemas/chatCompletionRequestMessageContentPartType' + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/chatCompletionRequestMessageContentPartText' + image_url: '#/components/schemas/chatCompletionRequestMessageContentPartImage' + required: + - type + chatCompletionRequestMessageContentPartType: + type: string + enum: + - text + - image_url + description: The type of the content part. + x-ms-enum: + name: ChatCompletionRequestMessageContentPartType + modelAsString: true + values: + - value: text + description: The content part type is text. + - value: image_url + description: The content part type is image_url. + chatCompletionRequestMessageContentPartText: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessageContentPart' + - type: object + properties: + text: + type: string + description: The text content. + required: + - text + chatCompletionRequestMessageContentPartImage: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessageContentPart' + - type: object + properties: + url: + type: string + description: Either a URL of the image or the base64 encoded image data. + format: uri + detail: + $ref: '#/components/schemas/imageDetailLevel' + required: + - url + imageDetailLevel: + type: string + description: Specifies the detail level of the image. + enum: + - auto + - low + - high + default: auto + x-ms-enum: + name: ImageDetailLevel + modelAsString: true + values: + - value: auto + description: The image detail level is auto. + - value: low + description: The image detail level is low. + - value: high + description: The image detail level is high. + chatCompletionRequestMessageAssistant: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessage' + - type: object + properties: + content: + type: string + description: The contents of the message. + nullable: true + tool_calls: + type: array + description: The tool calls generated by the model, such as function calls. + items: + $ref: '#/components/schemas/chatCompletionMessageToolCall' + context: + $ref: '#/components/schemas/azureChatExtensionsMessageContext' + required: + - content + azureChatExtensionConfiguration: + required: + - type + type: object + properties: + type: + $ref: '#/components/schemas/azureChatExtensionType' + description: |2- + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + discriminator: + propertyName: type + mapping: + azure_search: '#/components/schemas/azureSearchChatExtensionConfiguration' + azure_ml_index: '#/components/schemas/azureMachineLearningIndexChatExtensionConfiguration' + azure_cosmos_db: '#/components/schemas/azureCosmosDBChatExtensionConfiguration' + elasticsearch: '#/components/schemas/elasticsearchChatExtensionConfiguration' + pinecone: '#/components/schemas/pineconeChatExtensionConfiguration' + azureChatExtensionType: + type: string + description: |2- + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + enum: + - azure_search + - azure_ml_index + - azure_cosmos_db + - elasticsearch + - pinecone + x-ms-enum: + name: AzureChatExtensionType + modelAsString: true + values: + - name: azureSearch + value: azure_search + description: Represents the use of Azure Search as an Azure OpenAI chat extension. + - name: azureMachineLearningIndex + value: azure_ml_index + description: Represents the use of Azure Machine Learning index as an Azure OpenAI chat extension. + - name: azureCosmosDB + value: azure_cosmos_db + description: Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension. + - name: elasticsearch + value: elasticsearch + description: Represents the use of Elasticsearch® index as an Azure OpenAI chat extension. + - name: pinecone + value: pinecone + description: Represents the use of Pinecone index as an Azure OpenAI chat extension. + azureSearchChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: '#/components/schemas/azureChatExtensionConfiguration' + - properties: + parameters: + $ref: '#/components/schemas/azureSearchChatExtensionParameters' + x-ms-discriminator-value: azure_search + azureSearchChatExtensionParameters: + required: + - authentication + - endpoint + - index_name + type: object + properties: + authentication: + oneOf: + - $ref: '#/components/schemas/onYourDataApiKeyAuthenticationOptions' + - $ref: '#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions' + - $ref: '#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions' + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + role_information: + type: string + description: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit. + endpoint: + type: string + description: The absolute endpoint path for the Azure Search resource to use. + format: uri + index_name: + type: string + description: The name of the index to use as available in the referenced Azure Search resource. + fields_mapping: + $ref: '#/components/schemas/azureSearchIndexFieldMappingOptions' + query_type: + $ref: '#/components/schemas/azureSearchQueryType' + semantic_configuration: + type: string + description: The additional semantic configuration for the query. + filter: + type: string + description: Search filter. + embedding_dependency: + oneOf: + - $ref: '#/components/schemas/onYourDataEndpointVectorizationSource' + - $ref: '#/components/schemas/onYourDataDeploymentNameVectorizationSource' + description: Parameters for Azure Search when used as an Azure OpenAI chat extension. + azureSearchIndexFieldMappingOptions: + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + image_vector_fields: + type: array + description: The names of fields that represent image vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Azure Search resource. + azureSearchQueryType: + type: string + description: The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension. + enum: + - simple + - semantic + - vector + - vector_simple_hybrid + - vector_semantic_hybrid + x-ms-enum: + name: AzureSearchQueryType + modelAsString: true + values: + - name: simple + value: simple + description: Represents the default, simple query parser. + - name: semantic + value: semantic + description: Represents the semantic query parser for advanced semantic modeling. + - name: vector + value: vector + description: Represents vector search over computed data. + - name: vectorSimpleHybrid + value: vector_simple_hybrid + description: Represents a combination of the simple query strategy with vector data. + - name: vectorSemanticHybrid + value: vector_semantic_hybrid + description: Represents a combination of semantic search and vector data querying. + azureMachineLearningIndexChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Machine Learning vector index when using it as an Azure + OpenAI chat extension. + allOf: + - $ref: '#/components/schemas/azureChatExtensionConfiguration' + - properties: + parameters: + $ref: '#/components/schemas/azureMachineLearningIndexChatExtensionParameters' + x-ms-discriminator-value: azure_ml_index + azureMachineLearningIndexChatExtensionParameters: + required: + - authentication + - name + - project_resource_id + - version + type: object + properties: + authentication: + oneOf: + - $ref: '#/components/schemas/onYourDataAccessTokenAuthenticationOptions' + - $ref: '#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions' + - $ref: '#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions' + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + role_information: + type: string + description: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit. + project_resource_id: + type: string + description: The resource ID of the Azure Machine Learning project. + name: + type: string + description: The Azure Machine Learning vector index name. + version: + type: string + description: The version of the Azure Machine Learning vector index. + filter: + type: string + description: Search filter. Only supported if the Azure Machine Learning vector index is of type AzureSearch. + description: Parameters for the Azure Machine Learning vector index chat extension. + azureCosmosDBChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: '#/components/schemas/azureChatExtensionConfiguration' + - properties: + parameters: + $ref: '#/components/schemas/azureCosmosDBChatExtensionParameters' + x-ms-discriminator-value: azure_cosmos_db + azureCosmosDBChatExtensionParameters: + required: + - authentication + - container_name + - database_name + - embedding_dependency + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: '#/components/schemas/onYourDataConnectionStringAuthenticationOptions' + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + role_information: + type: string + description: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit. + database_name: + type: string + description: The MongoDB vCore database name to use with Azure Cosmos DB. + container_name: + type: string + description: The name of the Azure Cosmos DB resource container. + index_name: + type: string + description: The MongoDB vCore index name to use with Azure Cosmos DB. + fields_mapping: + $ref: '#/components/schemas/azureCosmosDBFieldMappingOptions' + embedding_dependency: + oneOf: + - $ref: '#/components/schemas/onYourDataEndpointVectorizationSource' + - $ref: '#/components/schemas/onYourDataDeploymentNameVectorizationSource' + description: |- + Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for + MongoDB vCore. + azureCosmosDBFieldMappingOptions: + required: + - content_fields + - vector_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource. + elasticsearchChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: '#/components/schemas/azureChatExtensionConfiguration' + - properties: + parameters: + $ref: '#/components/schemas/elasticsearchChatExtensionParameters' + x-ms-discriminator-value: elasticsearch + elasticsearchChatExtensionParameters: + required: + - authentication + - endpoint + - index_name + type: object + properties: + authentication: + oneOf: + - $ref: '#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions' + - $ref: '#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions' + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + role_information: + type: string + description: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit. + endpoint: + type: string + description: The endpoint of Elasticsearch®. + format: uri + index_name: + type: string + description: The index name of Elasticsearch®. + fields_mapping: + $ref: '#/components/schemas/elasticsearchIndexFieldMappingOptions' + query_type: + $ref: '#/components/schemas/elasticsearchQueryType' + embedding_dependency: + oneOf: + - $ref: '#/components/schemas/onYourDataEndpointVectorizationSource' + - $ref: '#/components/schemas/onYourDataDeploymentNameVectorizationSource' + - $ref: '#/components/schemas/onYourDataModelIdVectorizationSource' + description: 'Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. ' + elasticsearchIndexFieldMappingOptions: + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Elasticsearch® resource. + elasticsearchQueryType: + type: string + description: The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension. + enum: + - simple + - vector + x-ms-enum: + name: ElasticsearchQueryType + modelAsString: true + values: + - name: simple + value: simple + description: Represents the default, simple query parser. + - name: vector + value: vector + description: Represents vector search over computed data. + pineconeChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: '#/components/schemas/azureChatExtensionConfiguration' + - properties: + parameters: + $ref: '#/components/schemas/pineconeChatExtensionParameters' + x-ms-discriminator-value: pinecone + pineconeChatExtensionParameters: + required: + - authentication + - embedding_dependency + - environment + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: '#/components/schemas/onYourDataApiKeyAuthenticationOptions' + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + role_information: + type: string + description: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit. + environment: + type: string + description: The environment name of Pinecone. + index_name: + type: string + description: The name of the Pinecone database index. + fields_mapping: + $ref: '#/components/schemas/pineconeFieldMappingOptions' + embedding_dependency: + $ref: '#/components/schemas/onYourDataDeploymentNameVectorizationSource' + description: Parameters for configuring Azure OpenAI Pinecone chat extensions. + pineconeFieldMappingOptions: + required: + - content_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + description: Optional settings to control how fields are processed when using a configured Pinecone resource. + onYourDataAuthenticationOptions: + required: + - type + type: object + properties: + type: + $ref: '#/components/schemas/onYourDataAuthenticationType' + description: The authentication options for Azure OpenAI On Your Data. + discriminator: + propertyName: type + mapping: + api_key: '#/components/schemas/onYourDataApiKeyAuthenticationOptions' + connection_string: '#/components/schemas/onYourDataConnectionStringAuthenticationOptions' + key_and_key_id: '#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions' + encoded_api_key: '#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions' + access_token: '#/components/schemas/onYourDataAccessTokenAuthenticationOptions' + system_assigned_managed_identity: '#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions' + user_assigned_managed_identity: '#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions' + onYourDataAuthenticationType: + type: string + description: The authentication types supported with Azure OpenAI On Your Data. + enum: + - api_key + - connection_string + - key_and_key_id + - encoded_api_key + - access_token + - system_assigned_managed_identity + - user_assigned_managed_identity + x-ms-enum: + name: OnYourDataAuthenticationType + modelAsString: true + values: + - name: apiKey + value: api_key + description: Authentication via API key. + - name: connectionString + value: connection_string + description: Authentication via connection string. + - name: keyAndKeyId + value: key_and_key_id + description: Authentication via key and key ID pair. + - name: encodedApiKey + value: encoded_api_key + description: Authentication via encoded API key. + - name: accessToken + value: access_token + description: Authentication via access token. + - name: systemAssignedManagedIdentity + value: system_assigned_managed_identity + description: Authentication via system-assigned managed identity. + - name: userAssignedManagedIdentity + value: user_assigned_managed_identity + description: Authentication via user-assigned managed identity. + onYourDataApiKeyAuthenticationOptions: + required: + - key + description: The authentication options for Azure OpenAI On Your Data when using an API key. + allOf: + - $ref: '#/components/schemas/onYourDataAuthenticationOptions' + - properties: + key: + type: string + description: The API key to use for authentication. + x-ms-discriminator-value: api_key + onYourDataConnectionStringAuthenticationOptions: + required: + - connection_string + description: The authentication options for Azure OpenAI On Your Data when using a connection string. + allOf: + - $ref: '#/components/schemas/onYourDataAuthenticationOptions' + - properties: + connection_string: + type: string + description: The connection string to use for authentication. + x-ms-discriminator-value: connection_string + onYourDataKeyAndKeyIdAuthenticationOptions: + required: + - key + - key_id + description: The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair. + allOf: + - $ref: '#/components/schemas/onYourDataAuthenticationOptions' + - properties: + key: + type: string + description: The Elasticsearch key to use for authentication. + key_id: + type: string + description: The Elasticsearch key ID to use for authentication. + x-ms-discriminator-value: key_and_key_id + onYourDataEncodedApiKeyAuthenticationOptions: + required: + - encoded_api_key + description: The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key. + allOf: + - $ref: '#/components/schemas/onYourDataAuthenticationOptions' + - properties: + encoded_api_key: + type: string + description: The Elasticsearch encoded API key to use for authentication. + x-ms-discriminator-value: encoded_api_key + onYourDataAccessTokenAuthenticationOptions: + required: + - access_token + description: The authentication options for Azure OpenAI On Your Data when using access token. + allOf: + - $ref: '#/components/schemas/onYourDataAuthenticationOptions' + - properties: + access_token: + type: string + description: The access token to use for authentication. + x-ms-discriminator-value: access_token + onYourDataSystemAssignedManagedIdentityAuthenticationOptions: + description: The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity. + allOf: + - $ref: '#/components/schemas/onYourDataAuthenticationOptions' + x-ms-discriminator-value: system_assigned_managed_identity + onYourDataUserAssignedManagedIdentityAuthenticationOptions: + required: + - managed_identity_resource_id + description: The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity. + allOf: + - $ref: '#/components/schemas/onYourDataAuthenticationOptions' + - properties: + managed_identity_resource_id: + type: string + description: The resource ID of the user-assigned managed identity to use for authentication. + x-ms-discriminator-value: user_assigned_managed_identity + onYourDataVectorizationSource: + required: + - type + type: object + properties: + type: + $ref: '#/components/schemas/onYourDataVectorizationSourceType' + description: An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search. + discriminator: + propertyName: type + mapping: + endpoint: '#/components/schemas/onYourDataEndpointVectorizationSource' + deployment_name: '#/components/schemas/onYourDataDeploymentNameVectorizationSource' + model_id: '#/components/schemas/onYourDataModelIdVectorizationSource' + onYourDataVectorizationSourceType: + type: string + description: |- + Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with + vector search. + enum: + - endpoint + - deployment_name + - model_id + x-ms-enum: + name: OnYourDataVectorizationSourceType + modelAsString: true + values: + - name: endpoint + value: endpoint + description: Represents vectorization performed by public service calls to an Azure OpenAI embedding model. + - name: deploymentName + value: deployment_name + description: |- + Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but + On Your Data will use this model deployment via an internal call rather than a public one, which enables vector + search even in private networks. + - name: modelId + value: model_id + description: |- + Represents a specific embedding model ID as defined in the search service. + Currently only supported by Elasticsearch®. + onYourDataEndpointVectorizationSource: + required: + - authentication + - endpoint + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on a public Azure OpenAI endpoint call for embeddings. + allOf: + - $ref: '#/components/schemas/onYourDataVectorizationSource' + - properties: + endpoint: + type: string + description: Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter is not allowed. + format: uri + authentication: + $ref: '#/components/schemas/onYourDataApiKeyAuthenticationOptions' + x-ms-discriminator-value: endpoint + onYourDataDeploymentNameVectorizationSource: + required: + - deployment_name + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on an internal embeddings model deployment name in the same Azure OpenAI resource. + allOf: + - $ref: '#/components/schemas/onYourDataVectorizationSource' + - properties: + deployment_name: + type: string + description: Specifies the name of the model deployment to use for vectorization. This model deployment must be in the same Azure OpenAI resource, but On Your Data will use this model deployment via an internal call rather than a public one, which enables vector search even in private networks. + x-ms-discriminator-value: deployment_name + onYourDataModelIdVectorizationSource: + required: + - model_id + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on a search service model ID. Currently only supported by Elasticsearch®. + allOf: + - $ref: '#/components/schemas/onYourDataVectorizationSource' + - properties: + model_id: + type: string + description: Specifies the model ID to use for vectorization. This model ID must be defined in the search service. + x-ms-discriminator-value: model_id + azureChatExtensionsMessageContext: + type: object + properties: + citations: + type: array + description: The data source retrieval result, used to generate the assistant message in the response. + items: + $ref: '#/components/schemas/citation' + x-ms-identifiers: [] + intent: + type: string + description: The detected intent from the chat history, used to pass to the next turn to carry over the context. + description: |2- + A representation of the additional context information available when Azure OpenAI chat extensions are involved + in the generation of a corresponding chat completions response. This context information is only populated when + using an Azure OpenAI request configured to use a matching extension. + citation: + required: + - content + type: object + properties: + content: + type: string + description: The content of the citation. + title: + type: string + description: The title of the citation. + url: + type: string + description: The URL of the citation. + filepath: + type: string + description: The file path of the citation. + chunk_id: + type: string + description: The chunk ID of the citation. + description: citation information for a chat completions response message. + chatCompletionMessageToolCall: + type: object + properties: + id: + type: string + description: The ID of the tool call. + type: + $ref: '#/components/schemas/toolCallType' + function: + type: object + description: The function that the model called. + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - name + - arguments + required: + - id + - type + - function + toolCallType: + type: string + enum: + - function + description: The type of the tool call, in this case `function`. + x-ms-enum: + name: ToolCallType + modelAsString: true + values: + - value: function + description: The tool call type is function. + chatCompletionRequestMessageTool: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessage' + - type: object + nullable: true + properties: + tool_call_id: + type: string + description: Tool call that this message is responding to. + content: + type: string + description: The contents of the message. + nullable: true + required: + - tool_call_id + - content + chatCompletionRequestMessageFunction: + allOf: + - $ref: '#/components/schemas/chatCompletionRequestMessage' + - type: object + description: Deprecated. Message that represents a function. + nullable: true + properties: + role: + type: string + enum: + - function + description: The role of the messages author, in this case `function`. + name: + type: string + description: The contents of the message. + content: + type: string + description: The contents of the message. + nullable: true + required: + - function_call_id + - content + createChatCompletionResponse: + type: object + allOf: + - $ref: '#/components/schemas/chatCompletionsResponseCommon' + - properties: + prompt_filter_results: + $ref: '#/components/schemas/promptFilterResults' + choices: + type: array + items: + type: object + allOf: + - $ref: '#/components/schemas/chatCompletionChoiceCommon' + - properties: + message: + $ref: '#/components/schemas/chatCompletionResponseMessage' + content_filter_results: + $ref: '#/components/schemas/contentFilterChoiceResults' + logprobs: + $ref: '#/components/schemas/chatCompletionChoiceLogProbs' + enhancements: + $ref: '#/components/schemas/enhancement' + description: The enhancement results returned by the service. + required: + - id + - object + - created + - model + - choices + chatCompletionChoiceLogProbs: + description: Log probability information for the choice. + type: object + nullable: true + properties: + content: + description: A list of message content tokens with log probability information. + type: array + items: + $ref: '#/components/schemas/chatCompletionTokenLogprob' + nullable: true + required: + - content + chatCompletionTokenLogprob: + type: object + properties: + token: + description: The token. + type: string + logprob: + description: The log probability of this token. + type: number + bytes: + description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. + type: array + items: + type: integer + nullable: true + top_logprobs: + description: List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. + type: array + items: + type: object + properties: + token: + description: The token. + type: string + logprob: + description: The log probability of this token. + type: number + bytes: + description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. + type: array + items: + type: integer + nullable: true + required: + - token + - logprob + - bytes + required: + - token + - logprob + - bytes + - top_logprobs + chatCompletionResponseMessage: + type: object + description: A chat completion message generated by the model. + properties: + role: + $ref: '#/components/schemas/chatCompletionResponseMessageRole' + content: + type: string + description: The contents of the message. + nullable: true + tool_calls: + type: array + description: The tool calls generated by the model, such as function calls. + items: + $ref: '#/components/schemas/chatCompletionMessageToolCall' + function_call: + $ref: '#/components/schemas/chatCompletionFunctionCall' + context: + $ref: '#/components/schemas/azureChatExtensionsMessageContext' + chatCompletionResponseMessageRole: + type: string + enum: + - assistant + description: The role of the author of the response message. + chatCompletionToolChoiceOption: + description: 'Controls which (if any) function is called by the model. `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function. Specifying a particular function via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that function.' + oneOf: + - type: string + description: '`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.' + enum: + - none + - auto + - $ref: '#/components/schemas/chatCompletionNamedToolChoice' + chatCompletionNamedToolChoice: + type: object + description: Specifies a tool the model should use. Use to force the model to call a specific function. + properties: + type: + type: string + enum: + - function + description: The type of the tool. Currently, only `function` is supported. + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + required: + - name + chatCompletionFunctionCall: + type: object + description: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - name + - arguments + chatCompletionsResponseCommon: + type: object + properties: + id: + type: string + description: A unique identifier for the chat completion. + object: + $ref: '#/components/schemas/chatCompletionResponseObject' + created: + type: integer + format: unixtime + description: The Unix timestamp (in seconds) of when the chat completion was created. + model: + type: string + description: The model used for the chat completion. + usage: + $ref: '#/components/schemas/completionUsage' + system_fingerprint: + type: string + description: Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + required: + - id + - object + - created + - model + chatCompletionResponseObject: + type: string + description: The object type. + enum: + - chat.completion + x-ms-enum: + name: ChatCompletionResponseObject + modelAsString: true + values: + - value: chat.completion + description: The object type is chat completion. + completionUsage: + type: object + description: Usage statistics for the completion request. + properties: + prompt_tokens: + type: integer + description: Number of tokens in the prompt. + completion_tokens: + type: integer + description: Number of tokens in the generated completion. + total_tokens: + type: integer + description: Total number of tokens used in the request (prompt + completion). + required: + - prompt_tokens + - completion_tokens + - total_tokens + chatCompletionTool: + type: object + properties: + type: + $ref: '#/components/schemas/chatCompletionToolType' + function: + type: object + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: '#/components/schemas/chatCompletionFunctionParameters' + required: + - name + - parameters + required: + - type + - function + chatCompletionToolType: + type: string + enum: + - function + description: The type of the tool. Currently, only `function` is supported. + x-ms-enum: + name: ChatCompletionToolType + modelAsString: true + values: + - value: function + description: The tool type is function. + chatCompletionChoiceCommon: + type: object + properties: + index: + type: integer + finish_reason: + type: string + createTranslationRequest: + type: object + description: Translation request. + properties: + file: + type: string + description: The audio file to translate. + format: binary + prompt: + type: string + description: An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English. + response_format: + $ref: '#/components/schemas/audioResponseFormat' + temperature: + type: number + default: 0 + description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + required: + - file + audioResponse: + description: Translation or transcription response when response_format was json + type: object + properties: + text: + type: string + description: Translated or transcribed text. + required: + - text + audioVerboseResponse: + description: Translation or transcription response when response_format was verbose_json + type: object + allOf: + - $ref: '#/components/schemas/audioResponse' + - properties: + task: + type: string + description: Type of audio task. + enum: + - transcribe + - translate + x-ms-enum: + modelAsString: true + language: + type: string + description: Language. + duration: + type: number + description: Duration. + segments: + type: array + items: + $ref: '#/components/schemas/audioSegment' + required: + - text + audioResponseFormat: + title: AudioResponseFormat + description: Defines the format of the output. + enum: + - json + - text + - srt + - verbose_json + - vtt + type: string + x-ms-enum: + modelAsString: true + createTranscriptionRequest: + type: object + description: Transcription request. + properties: + file: + type: string + description: The audio file object to transcribe. + format: binary + prompt: + type: string + description: An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. + response_format: + $ref: '#/components/schemas/audioResponseFormat' + temperature: + type: number + default: 0 + description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + language: + type: string + description: The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency. + required: + - file + audioSegment: + type: object + description: Transcription or translation segment. + properties: + id: + type: integer + description: Segment identifier. + seek: + type: number + description: Offset of the segment. + start: + type: number + description: Segment start offset. + end: + type: number + description: Segment end offset. + text: + type: string + description: Segment text. + tokens: + type: array + items: + type: number + nullable: false + description: Tokens of the text. + temperature: + type: number + description: Temperature. + avg_logprob: + type: number + description: Average log probability. + compression_ratio: + type: number + description: Compression ratio. + no_speech_prob: + type: number + description: Probability of 'no speech'. + createSpeechRequest: + type: object + description: Speech request. + properties: + input: + type: string + description: The text to synthesize audio for. The maximum length is 4096 characters. + maxLength: 4096 + voice: + type: string + description: The voice to use for speech synthesis. + enum: + - alloy + - echo + - fable + - onyx + - nova + - shimmer + response_format: + type: string + description: The format to synthesize the audio in. + enum: + - mp3 + - opus + - aac + - flac + speed: + description: The speed of the synthesize audio. Select a value from `0.25` to `4.0`. `1.0` is the default. + type: number + default: 1 + minimum: 0.25 + maximum: 4 + required: + - input + - voice + imageQuality: + description: The quality of the image that will be generated. + type: string + enum: + - standard + - hd + default: standard + x-ms-enum: + name: Quality + modelAsString: true + values: + - value: standard + description: Standard quality creates images with standard quality. + name: Standard + - value: hd + description: HD quality creates images with finer details and greater consistency across the image. + name: HD + imagesResponseFormat: + description: The format in which the generated images are returned. + type: string + enum: + - url + - b64_json + default: url + x-ms-enum: + name: ImagesResponseFormat + modelAsString: true + values: + - value: url + description: The URL that provides temporary access to download the generated images. + name: Url + - value: b64_json + description: The generated images are returned as base64 encoded string. + name: Base64Json + imageSize: + description: The size of the generated images. + type: string + enum: + - 1792x1024 + - 1024x1792 + - 1024x1024 + default: 1024x1024 + x-ms-enum: + name: Size + modelAsString: true + values: + - value: 1792x1024 + description: The desired size of the generated image is 1792x1024 pixels. + name: Size1792x1024 + - value: 1024x1792 + description: The desired size of the generated image is 1024x1792 pixels. + name: Size1024x1792 + - value: 1024x1024 + description: The desired size of the generated image is 1024x1024 pixels. + name: Size1024x1024 + imageStyle: + description: The style of the generated images. + type: string + enum: + - vivid + - natural + default: vivid + x-ms-enum: + name: Style + modelAsString: true + values: + - value: vivid + description: Vivid creates images that are hyper-realistic and dramatic. + name: Vivid + - value: natural + description: Natural creates images that are more natural and less hyper-realistic. + name: Natural + imageGenerationsRequest: + type: object + properties: + prompt: + description: A text description of the desired image(s). The maximum length is 4000 characters. + type: string + format: string + example: a corgi in a field + minLength: 1 + 'n': + description: The number of images to generate. + type: integer + minimum: 1 + maximum: 1 + default: 1 + size: + $ref: '#/components/schemas/imageSize' + response_format: + $ref: '#/components/schemas/imagesResponseFormat' + user: + description: A unique identifier representing your end-user, which can help to monitor and detect abuse. + type: string + format: string + example: user123456 + quality: + $ref: '#/components/schemas/imageQuality' + style: + $ref: '#/components/schemas/imageStyle' + required: + - prompt + generateImagesResponse: + type: object + properties: + created: + type: integer + format: unixtime + description: The unix timestamp when the operation was created. + example: '1676540381' + data: + type: array + description: The result data of the operation, if successful + items: + $ref: '#/components/schemas/imageResult' + required: + - created + - data + imageResult: + type: object + description: The image url or encoded image if successful, and an error otherwise. + properties: + url: + type: string + description: The image url. + example: https://www.contoso.com + b64_json: + type: string + description: The base64 encoded image + content_filter_results: + $ref: '#/components/schemas/dalleContentFilterResults' + revised_prompt: + type: string + description: The prompt that was used to generate the image, if there was any revision to the prompt. + prompt_filter_results: + $ref: '#/components/schemas/dalleFilterResults' + enhancement: + type: object + properties: + grounding: + type: object + description: The grounding enhancement that returns the bounding box of the objects detected in the image. + properties: + lines: + type: array + items: + $ref: '#/components/schemas/line' + required: + - lines + line: + type: object + description: A content line object consisting of an adjacent sequence of content elements, such as words and selection marks. + properties: + text: + type: string + spans: + type: array + description: An array of spans that represent detected objects and its bounding box information. + items: + $ref: '#/components/schemas/span' + required: + - text + - spans + span: + type: object + description: A span object that represents a detected object and its bounding box information. + properties: + text: + type: string + description: The text content of the span that represents the detected object. + offset: + type: integer + description: The character offset within the text where the span begins. This offset is defined as the position of the first character of the span, counting from the start of the text as Unicode codepoints. + length: + type: integer + description: The length of the span in characters, measured in Unicode codepoints. + polygon: + type: array + description: An array of objects representing points in the polygon that encloses the detected object. + items: + type: object + properties: + x: + type: number + description: The x-coordinate of the point. + 'y': + type: number + description: The y-coordinate of the point. + required: + - text + - offset + - length + - polygon + assistantObject: + type: object + title: Assistant + description: Represents an `assistant` that can call the model and use tools. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `assistant`. + type: string + enum: + - assistant + x-ms-enum: + name: AssistantObjectType + modelAsString: true + values: + - value: assistant + description: The object type, which is always assistant + created_at: + description: The Unix timestamp (in seconds) for when the assistant was created. + type: integer + name: + description: | + The name of the assistant. The maximum length is 256 characters. + type: string + maxLength: 256 + nullable: true + description: + description: | + The description of the assistant. The maximum length is 512 characters. + type: string + maxLength: 512 + nullable: true + model: + description: | + ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. + type: string + instructions: + description: | + The system instructions that the assistant uses. The maximum length is 32768 characters. + type: string + maxLength: 32768 + nullable: true + tools: + description: | + A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`. + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: '#/components/schemas/assistantToolsCode' + - $ref: '#/components/schemas/assistantToolsRetrieval' + - $ref: '#/components/schemas/assistantToolsFunction' + file_ids: + description: | + A list of [file](/docs/api-reference/files) IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order. + default: [] + type: array + maxItems: 20 + items: + type: string + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + required: + - id + - object + - created_at + - name + - description + - model + - instructions + - tools + - file_ids + - metadata + createAssistantRequest: + type: object + additionalProperties: false + properties: + model: + description: | + ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. + anyOf: + - type: string + name: + description: | + The name of the assistant. The maximum length is 256 characters. + type: string + nullable: true + maxLength: 256 + description: + description: | + The description of the assistant. The maximum length is 512 characters. + type: string + nullable: true + maxLength: 512 + instructions: + description: | + The system instructions that the assistant uses. The maximum length is 32768 characters. + type: string + nullable: true + maxLength: 32768 + tools: + description: | + A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`. + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: '#/components/schemas/assistantToolsCode' + - $ref: '#/components/schemas/assistantToolsRetrieval' + - $ref: '#/components/schemas/assistantToolsFunction' + file_ids: + description: | + A list of [file](/docs/api-reference/files) IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order. + default: [] + maxItems: 20 + type: array + items: + type: string + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + required: + - model + modifyAssistantRequest: + type: object + additionalProperties: false + properties: + model: + description: | + ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. + anyOf: + - type: string + name: + description: | + The name of the assistant. The maximum length is 256 characters. + type: string + nullable: true + maxLength: 256 + description: + description: | + The description of the assistant. The maximum length is 512 characters. + type: string + nullable: true + maxLength: 512 + instructions: + description: | + The system instructions that the assistant uses. The maximum length is 32768 characters. + type: string + nullable: true + maxLength: 32768 + tools: + description: | + A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`. + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: '#/components/schemas/assistantToolsCode' + - $ref: '#/components/schemas/assistantToolsRetrieval' + - $ref: '#/components/schemas/assistantToolsFunction' + file_ids: + description: | + A list of [File](/docs/api-reference/files) IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order. If a file was previously attached to the list but does not show up in the list, it will be deleted from the assistant. + default: [] + type: array + maxItems: 20 + items: + type: string + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + deleteAssistantResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - assistant.deleted + x-ms-enum: + name: DeleteAssistantResponseState + modelAsString: true + values: + - value: assistant.deleted + description: The assistant is deleted + required: + - id + - object + - deleted + listAssistantsResponse: + type: object + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: '#/components/schemas/assistantObject' + first_id: + type: string + example: asst_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: asst_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + assistantToolsCode: + type: object + title: Code interpreter tool + properties: + type: + type: string + description: 'The type of tool being defined: `code_interpreter`' + enum: + - code_interpreter + x-ms-enum: + name: assistantToolsCodeType + modelAsString: true + values: + - value: code_interpreter + description: code_interpreter as type of tool being defined + required: + - type + assistantToolsRetrieval: + type: object + title: Retrieval tool + properties: + type: + type: string + description: 'The type of tool being defined: `retrieval`' + enum: + - retrieval + x-ms-enum: + name: assistantToolsRetrievalType + modelAsString: true + values: + - value: retrieval + description: retrieval as type of tool being defined + required: + - type + assistantToolsFunction: + type: object + title: Function tool + properties: + type: + type: string + description: 'The type of tool being defined: `function`' + enum: + - function + x-ms-enum: + name: assistantToolsFunction + modelAsString: true + values: + - value: retrieval + description: retrieval as type of tool being defined + function: + type: object + description: The function definition. + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: '#/components/schemas/chatCompletionFunctionParameters' + required: + - name + - parameters + - description + required: + - type + - function + runObject: + type: object + title: A run on a thread + description: Represents an execution run on a [thread](/docs/api-reference/threads). + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.run`. + type: string + enum: + - thread.run + x-ms-enum: + name: runObjectType + modelAsString: true + values: + - value: thread.run + description: The run object type which is always thread.run + created_at: + description: The Unix timestamp (in seconds) for when the run was created. + type: integer + thread_id: + description: The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run. + type: string + assistant_id: + description: The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run. + type: string + status: + description: The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`. + type: string + enum: + - queued + - in_progress + - requires_action + - cancelling + - cancelled + - failed + - completed + - expired + x-ms-enum: + name: RunObjectStatus + modelAsString: true + values: + - value: queued + description: The queued state + - value: in_progress + description: The in_progress state + - value: requires_action + description: The required_action state + - value: cancelling + description: The cancelling state + - value: cancelled + description: The cancelled state + - value: failed + description: The failed state + - value: completed + description: The completed state + - value: expired + description: The expired state + required_action: + type: object + description: Details on the action required to continue the run. Will be `null` if no action is required. + nullable: true + properties: + type: + description: For now, this is always `submit_tool_outputs`. + type: string + enum: + - submit_tool_outputs + submit_tool_outputs: + type: object + description: Details on the tool outputs needed for this run to continue. + properties: + tool_calls: + type: array + description: A list of the relevant tool calls. + items: + $ref: '#/components/schemas/runToolCallObject' + required: + - tool_calls + required: + - type + - submit_tool_outputs + last_error: + type: object + description: The last error associated with this run. Will be `null` if there are no errors. + nullable: true + properties: + code: + type: string + description: One of `server_error` or `rate_limit_exceeded`. + enum: + - server_error + - rate_limit_exceeded + x-ms-enum: + name: LastErrorCode + modelAsString: true + values: + - value: server_error + description: The server failed to respond to request due to server error + - value: rate_limit_exceeded + description: The server failed to respond to request due to rate limit exceeded + message: + type: string + description: A human-readable description of the error. + required: + - code + - message + expires_at: + description: The Unix timestamp (in seconds) for when the run will expire. + type: integer + started_at: + description: The Unix timestamp (in seconds) for when the run was started. + type: integer + nullable: true + cancelled_at: + description: The Unix timestamp (in seconds) for when the run was cancelled. + type: integer + nullable: true + failed_at: + description: The Unix timestamp (in seconds) for when the run failed. + type: integer + nullable: true + completed_at: + description: The Unix timestamp (in seconds) for when the run was completed. + type: integer + nullable: true + model: + description: The model that the [assistant](/docs/api-reference/assistants) used for this run. + type: string + instructions: + description: The instructions that the [assistant](/docs/api-reference/assistants) used for this run. + type: string + tools: + description: The list of tools that the [assistant](/docs/api-reference/assistants) used for this run. + default: [] + type: array + maxItems: 20 + items: + oneOf: + - $ref: '#/components/schemas/assistantToolsCode' + - $ref: '#/components/schemas/assistantToolsRetrieval' + - $ref: '#/components/schemas/assistantToolsFunction' + file_ids: + description: The list of [File](/docs/api-reference/files) IDs the [assistant](/docs/api-reference/assistants) used for this run. + default: [] + type: array + items: + type: string + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + required: + - id + - object + - created_at + - thread_id + - assistant_id + - status + - required_action + - last_error + - expires_at + - started_at + - cancelled_at + - failed_at + - completed_at + - model + - instructions + - tools + - file_ids + - metadata + createRunRequest: + type: object + additionalProperties: false + properties: + assistant_id: + description: The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run. + type: string + model: + description: The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. + type: string + nullable: true + instructions: + description: Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. + type: string + nullable: true + tools: + description: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. + nullable: true + type: array + maxItems: 20 + items: + oneOf: + - $ref: '#/components/schemas/assistantToolsCode' + - $ref: '#/components/schemas/assistantToolsRetrieval' + - $ref: '#/components/schemas/assistantToolsFunction' + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + required: + - thread_id + - assistant_id + listRunsResponse: + type: object + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: '#/components/schemas/runObject' + first_id: + type: string + example: run_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: run_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + modifyRunRequest: + type: object + additionalProperties: false + properties: + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + submitToolOutputsRunRequest: + type: object + additionalProperties: false + properties: + tool_outputs: + description: A list of tools for which the outputs are being submitted. + type: array + items: + type: object + properties: + tool_call_id: + type: string + description: The ID of the tool call in the `required_action` object within the run object the output is being submitted for. + output: + type: string + description: The output of the tool call to be submitted to continue the run. + required: + - tool_outputs + runToolCallObject: + type: object + description: Tool call objects + properties: + id: + type: string + description: The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint. + type: + type: string + description: The type of tool call the output is required for. For now, this is always `function`. + enum: + - function + x-ms-enum: + name: RunToolCallObjectType + modelAsString: true + values: + - value: function + description: The type of tool call the output is required for which is always `function` for now + - value: rate_limit_exceeded + description: The server failed to respond to request due to rate limit exceeded + function: + type: object + description: The function definition. + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments that the model expects you to pass to the function. + required: + - name + - arguments + required: + - id + - type + - function + createThreadAndRunRequest: + type: object + additionalProperties: false + properties: + assistant_id: + description: The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run. + type: string + thread: + $ref: '#/components/schemas/createThreadRequest' + description: If no thread is provided, an empty thread will be created. + model: + description: The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. + type: string + nullable: true + instructions: + description: Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. + type: string + nullable: true + tools: + description: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. + nullable: true + type: array + maxItems: 20 + items: + oneOf: + - $ref: '#/components/schemas/assistantToolsCode' + - $ref: '#/components/schemas/assistantToolsRetrieval' + - $ref: '#/components/schemas/assistantToolsFunction' + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + required: + - thread_id + - assistant_id + threadObject: + type: object + title: Thread + description: Represents a thread that contains [messages](/docs/api-reference/messages). + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread`. + type: string + enum: + - thread + x-ms-enum: + name: ThreadObjectType + modelAsString: true + values: + - value: thread + description: The type of thread object which is always `thread` + created_at: + description: The Unix timestamp (in seconds) for when the thread was created. + type: integer + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + required: + - id + - object + - created_at + - metadata + createThreadRequest: + type: object + additionalProperties: false + properties: + messages: + description: A list of [messages](/docs/api-reference/messages) to start the thread with. + type: array + items: + $ref: '#/components/schemas/createMessageRequest' + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + modifyThreadRequest: + type: object + additionalProperties: false + properties: + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + deleteThreadResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - thread.deleted + x-ms-enum: + name: DeleteThreadResponseObjectState + modelAsString: true + values: + - value: thread.deleted + description: The delete thread response object state which is `thread.deleted` + required: + - id + - object + - deleted + listThreadsResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: '#/components/schemas/threadObject' + first_id: + type: string + example: asst_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: asst_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + messageObject: + type: object + title: The message object + description: Represents a message within a [thread](/docs/api-reference/threads). + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.message`. + type: string + enum: + - thread.message + x-ms-enum: + name: MessageObjectType + modelAsString: true + values: + - value: thread.message + description: The message object type which is `thread.message` + created_at: + description: The Unix timestamp (in seconds) for when the message was created. + type: integer + thread_id: + description: The [thread](/docs/api-reference/threads) ID that this message belongs to. + type: string + role: + description: The entity that produced the message. One of `user` or `assistant`. + type: string + enum: + - user + - assistant + x-ms-enum: + name: MessageObjectRole + modelAsString: true + values: + - value: user + description: Message object role as `user` + - value: assistant + description: Message object role as `assistant` + content: + description: The content of the message in array of text and/or images. + type: array + items: + oneOf: + - $ref: '#/components/schemas/messageContentImageFileObject' + - $ref: '#/components/schemas/messageContentTextObject' + assistant_id: + description: If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message. + type: string + nullable: true + run_id: + description: If applicable, the ID of the [run](/docs/api-reference/runs) associated with the authoring of this message. + type: string + nullable: true + file_ids: + description: A list of [file](/docs/api-reference/files) IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can access files. A maximum of 10 files can be attached to a message. + default: [] + maxItems: 10 + type: array + items: + type: string + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + required: + - id + - object + - created_at + - thread_id + - role + - content + - assistant_id + - run_id + - file_ids + - metadata + createMessageRequest: + type: object + additionalProperties: false + required: + - role + - content + properties: + role: + type: string + enum: + - user + x-ms-enum: + name: CreateMessageRequestRole + modelAsString: true + values: + - value: user + description: The create message role as `user` + description: The role of the entity that is creating the message. Currently only `user` is supported. + content: + type: string + minLength: 1 + maxLength: 32768 + description: The content of the message. + file_ids: + description: A list of [File](/docs/api-reference/files) IDs that the message should use. There can be a maximum of 10 files attached to a message. Useful for tools like `retrieval` and `code_interpreter` that can access and use files. + default: [] + type: array + minItems: 1 + maxItems: 10 + items: + type: string + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + modifyMessageRequest: + type: object + additionalProperties: false + properties: + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + deleteMessageResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - thread.message.deleted + x-ms-enum: + name: DeleteMessageResponseObject + modelAsString: true + values: + - value: thread.message.deleted + description: The delete message response object state + required: + - id + - object + - deleted + listMessagesResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: '#/components/schemas/messageObject' + first_id: + type: string + example: msg_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: msg_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + messageContentImageFileObject: + title: Image file + type: object + description: References an image [File](/docs/api-reference/files) in the content of a message. + properties: + type: + description: Always `image_file`. + type: string + enum: + - image_file + x-ms-enum: + name: MessageContentImageFileObjectType + modelAsString: true + values: + - value: image_file + description: The message content image file type + image_file: + type: object + properties: + file_id: + description: The [File](/docs/api-reference/files) ID of the image in the message content. + type: string + required: + - file_id + required: + - type + - image_file + messageContentTextObject: + title: Text + type: object + description: The text content that is part of a message. + properties: + type: + description: Always `text`. + type: string + enum: + - text + x-ms-enum: + name: messageContentTextObjectType + modelAsString: true + values: + - value: text + description: The message content text Object type + text: + type: object + properties: + value: + description: The data that makes up the text. + type: string + annotations: + type: array + items: + oneOf: + - $ref: '#/components/schemas/messageContentTextAnnotationsFileCitationObject' + - $ref: '#/components/schemas/messageContentTextAnnotationsFilePathObject' + required: + - value + - annotations + required: + - type + - text + messageContentTextAnnotationsFileCitationObject: + title: File citation + type: object + description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "retrieval" tool to search files. + properties: + type: + description: Always `file_citation`. + type: string + enum: + - file_citation + x-ms-enum: + name: FileCitationObjectType + modelAsString: true + values: + - value: file_citation + description: The file citation object type + text: + description: The text in the message content that needs to be replaced. + type: string + file_citation: + type: object + properties: + file_id: + description: The ID of the specific File the citation is from. + type: string + quote: + description: The specific quote in the file. + type: string + required: + - file_id + - quote + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - type + - text + - file_citation + - start_index + - end_index + messageContentTextAnnotationsFilePathObject: + title: File path + type: object + description: A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. + properties: + type: + description: Always `file_path`. + type: string + enum: + - file_path + x-ms-enum: + name: FilePathObjectType + modelAsString: true + values: + - value: file_path + description: The file path object type + text: + description: The text in the message content that needs to be replaced. + type: string + file_path: + type: object + properties: + file_id: + description: The ID of the file that was generated. + type: string + required: + - file_id + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - type + - text + - file_path + - start_index + - end_index + runStepObject: + type: object + title: Run steps + description: | + Represents a step in execution of a run. + properties: + id: + description: The identifier of the run step, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `assistant.run.step``. + type: string + enum: + - assistant.run.step + x-ms-enum: + name: RunStepObjectType + modelAsString: true + values: + - value: assistant.run.step + description: The object type, which is always `assistant.run.step` + created_at: + description: The Unix timestamp (in seconds) for when the run step was created. + type: integer + assistant_id: + description: The ID of the [assistant](/docs/api-reference/assistants) associated with the run step. + type: string + thread_id: + description: The ID of the [thread](/docs/api-reference/threads) that was run. + type: string + run_id: + description: The ID of the [run](/docs/api-reference/runs) that this run step is a part of. + type: string + type: + description: The type of run step, which can be either `message_creation` or `tool_calls`. + type: string + enum: + - message_creation + - tool_calls + x-ms-enum: + name: RunStepObjectType + modelAsString: true + values: + - value: message_creation + description: The message_creation run step + - value: tool_calls + description: The tool_calls run step + status: + description: The status of the run, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. + type: string + enum: + - in_progress + - cancelled + - failed + - completed + - expired + x-ms-enum: + name: RunStepObjectStatus + modelAsString: true + values: + - value: in_progress + description: The in_progress run status + - value: cancelled + description: The cancelled run status + - value: failed + description: The cancelled run status + - value: completed + description: The cancelled run status + - value: expired + description: The cancelled run status + step_details: + type: object + description: The details of the run step. + oneOf: + - $ref: '#/components/schemas/runStepDetailsMessageCreationObject' + - $ref: '#/components/schemas/runStepDetailsToolCallsObject' + last_error: + type: object + description: The last error associated with this run step. Will be `null` if there are no errors. + nullable: true + properties: + code: + type: string + description: One of `server_error` or `rate_limit_exceeded`. + enum: + - server_error + - rate_limit_exceeded + x-ms-enum: + name: LastErrorCode + modelAsString: true + values: + - value: server_error + description: The server_error + - value: rate_limit_exceeded + description: The rate_limit_exceeded status + message: + type: string + description: A human-readable description of the error. + required: + - code + - message + expired_at: + description: The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired. + type: integer + nullable: true + cancelled_at: + description: The Unix timestamp (in seconds) for when the run step was cancelled. + type: integer + nullable: true + failed_at: + description: The Unix timestamp (in seconds) for when the run step failed. + type: integer + nullable: true + completed_at: + description: The Unix timestamp (in seconds) for when the run step completed. + type: integer + nullable: true + metadata: + description: | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + required: + - id + - object + - created_at + - assistant_id + - thread_id + - run_id + - type + - status + - step_details + - last_error + - expired_at + - cancelled_at + - failed_at + - completed_at + - metadata + listRunStepsResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: '#/components/schemas/runStepObject' + first_id: + type: string + example: step_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: step_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + runStepDetailsMessageCreationObject: + title: Message creation + type: object + description: Details of the message creation by the run step. + properties: + type: + description: Always `message_creation``. + type: string + enum: + - message_creation + x-ms-enum: + name: RunStepDetailsMessageCreationObjectType + modelAsString: true + values: + - value: message_creation + message_creation: + type: object + properties: + message_id: + type: string + description: The ID of the message that was created by this run step. + required: + - message_id + required: + - type + - message_creation + runStepDetailsToolCallsObject: + title: Tool calls + type: object + description: Details of the tool call. + properties: + type: + description: Always `tool_calls`. + type: string + enum: + - tool_calls + x-ms-enum: + name: RunStepDetailsToolCallsObjectType + modelAsString: true + values: + - value: tool_calls + tool_calls: + type: array + description: | + An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `retrieval`, or `function`. + items: + type: object + oneOf: + - $ref: '#/components/schemas/runStepDetailsToolCallsCodeObject' + - $ref: '#/components/schemas/runStepDetailsToolCallsRetrievalObject' + - $ref: '#/components/schemas/runStepDetailsToolCallsFunctionObject' + required: + - type + - tool_calls + runStepDetailsToolCallsCodeObject: + title: Code interpreter tool call + type: object + description: Details of the Code Interpreter tool call the run step was involved in. + properties: + id: + type: string + description: The ID of the tool call. + type: + type: string + description: The type of tool call. This is always going to be `code_interpreter` for this type of tool call. + enum: + - code_interpreter + x-ms-enum: + name: RunStepDetailsToolCallsCodeObjectType + modelAsString: true + values: + - value: code_interpreter + code_interpreter: + type: object + description: The Code Interpreter tool call definition. + required: + - input + - outputs + properties: + input: + type: string + description: The input to the Code Interpreter tool call. + outputs: + type: array + description: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type. + items: + type: object + oneOf: + - $ref: '#/components/schemas/runStepDetailsToolCallsCodeOutputLogsObject' + - $ref: '#/components/schemas/runStepDetailsToolCallsCodeOutputImageObject' + required: + - id + - type + - code_interpreter + runStepDetailsToolCallsCodeOutputLogsObject: + title: Code interpreter log output + type: object + description: Text output from the Code Interpreter tool call as part of a run step. + properties: + type: + description: Always `logs`. + type: string + enum: + - logs + x-ms-enum: + name: RunStepDetailsToolCallsCodeOutputLogsObjectType + modelAsString: true + values: + - value: code_interpreter + logs: + type: string + description: The text output from the Code Interpreter tool call. + required: + - type + - logs + runStepDetailsToolCallsCodeOutputImageObject: + title: Code interpreter image output + type: object + properties: + type: + description: Always `image`. + type: string + enum: + - image + x-ms-enum: + name: RunStepDetailsToolCallsCodeOutputImageObjectType + modelAsString: true + values: + - value: image + image: + type: object + properties: + file_id: + description: The [file](/docs/api-reference/files) ID of the image. + type: string + required: + - file_id + required: + - type + - image + runStepDetailsToolCallsRetrievalObject: + title: Retrieval tool call + type: object + properties: + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `retrieval` for this type of tool call. + enum: + - retrieval + x-ms-enum: + name: RunStepDetailsToolCallsRetrievalObjectType + modelAsString: true + values: + - value: retrieval + retrieval: + type: object + description: For now, this is always going to be an empty object. + required: + - id + - type + - retrieval + runStepDetailsToolCallsFunctionObject: + type: object + title: Function tool call + properties: + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `function` for this type of tool call. + enum: + - function + x-ms-enum: + name: RunStepDetailsToolCallsFunctionObjectType + modelAsString: true + values: + - value: function + function: + type: object + description: The definition of the function that was called. + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments passed to the function. + output: + type: string + description: The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet. + nullable: true + required: + - name + - arguments + - output + required: + - id + - type + - function + assistantFileObject: + type: object + title: Assistant files + description: A list of [Files](/docs/api-reference/files) attached to an `assistant`. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `assistant.file`. + type: string + enum: + - assistant.file + x-ms-enum: + name: AssistantFileObjectType + modelAsString: true + values: + - value: assistant.file + created_at: + description: The Unix timestamp (in seconds) for when the assistant file was created. + type: integer + assistant_id: + description: The assistant ID that the file is attached to. + type: string + required: + - id + - object + - created_at + - assistant_id + createAssistantFileRequest: + type: object + additionalProperties: false + properties: + file_id: + description: A [File](/docs/api-reference/files) ID (with `purpose="assistants"`) that the assistant should use. Useful for tools like `retrieval` and `code_interpreter` that can access files. + type: string + required: + - file_id + deleteAssistantFileResponse: + type: object + description: Deletes the association between the assistant and the file, but does not delete the [File](/docs/api-reference/files) object itself. + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - assistant.file.deleted + x-ms-enum: + name: DeleteAssistantFileResponseType + modelAsString: true + values: + - value: assistant.file.deleted + required: + - id + - object + - deleted + listAssistantFilesResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: '#/components/schemas/assistantFileObject' + first_id: + type: string + example: file-hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: file-QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - items + - first_id + - last_id + - has_more + messageFileObject: + type: object + title: Message files + description: A list of files attached to a `message`. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.message.file`. + type: string + enum: + - thread.message.file + x-ms-enum: + name: MessageFileObjectType + modelAsString: true + values: + - value: thread.message.file + created_at: + description: The Unix timestamp (in seconds) for when the message file was created. + type: integer + message_id: + description: The ID of the [message](/docs/api-reference/messages) that the [File](/docs/api-reference/files) is attached to. + type: string + required: + - id + - object + - created_at + - message_id + listMessageFilesResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: '#/components/schemas/messageFileObject' + first_id: + type: string + example: file-hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: file-QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - items + - first_id + - last_id + - has_more + 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 diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-10-15-preview/contentsafety.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-10-15-preview/contentsafety.json index eb8fdc2afe79..be08e80f52de 100644 --- a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-10-15-preview/contentsafety.json +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-10-15-preview/contentsafety.json @@ -703,33 +703,29 @@ } }, "outputType": { - "$ref": "#/definitions/AnalyzeImageOutputType", + "type": "string", "description": "This refers to the type of image analysis output. If no value is assigned, the default value will be \"FourSeverityLevels\".", - "default": "FourSeverityLevels" + "default": "FourSeverityLevels", + "enum": [ + "FourSeverityLevels" + ], + "x-ms-enum": { + "name": "AnalyzeImageOutputType", + "modelAsString": true, + "values": [ + { + "name": "FourSeverityLevels", + "value": "FourSeverityLevels", + "description": "Output severities in four levels, the value could be 0,2,4,6." + } + ] + } } }, "required": [ "image" ] }, - "AnalyzeImageOutputType": { - "type": "string", - "description": "The type of image analysis output.", - "enum": [ - "FourSeverityLevels" - ], - "x-ms-enum": { - "name": "AnalyzeImageOutputType", - "modelAsString": true, - "values": [ - { - "name": "FourSeverityLevels", - "value": "FourSeverityLevels", - "description": "Output severities in four levels, the value could be 0,2,4,6." - } - ] - } - }, "AnalyzeImageResult": { "type": "object", "description": "The image analysis response.", @@ -802,39 +798,35 @@ "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." }, "outputType": { - "$ref": "#/definitions/AnalyzeTextOutputType", + "type": "string", "description": "This refers to the type of text analysis output. If no value is assigned, the default value will be \"FourSeverityLevels\".", - "default": "FourSeverityLevels" + "default": "FourSeverityLevels", + "enum": [ + "FourSeverityLevels", + "EightSeverityLevels" + ], + "x-ms-enum": { + "name": "AnalyzeTextOutputType", + "modelAsString": true, + "values": [ + { + "name": "FourSeverityLevels", + "value": "FourSeverityLevels", + "description": "Output severities in four levels, the value could be 0,2,4,6." + }, + { + "name": "EightSeverityLevels", + "value": "EightSeverityLevels", + "description": "Output severities in eight levels, the value could be 0,1,2,3,4,5,6,7." + } + ] + } } }, "required": [ "text" ] }, - "AnalyzeTextOutputType": { - "type": "string", - "description": "The type of text analysis output.", - "enum": [ - "FourSeverityLevels", - "EightSeverityLevels" - ], - "x-ms-enum": { - "name": "AnalyzeTextOutputType", - "modelAsString": true, - "values": [ - { - "name": "FourSeverityLevels", - "value": "FourSeverityLevels", - "description": "Output severities in four levels, the value could be 0,2,4,6." - }, - { - "name": "EightSeverityLevels", - "value": "EightSeverityLevels", - "description": "Output severities in eight levels, the value could be 0,1,2,3,4,5,6,7." - } - ] - } - }, "AnalyzeTextProtectedMaterialOptions": { "type": "object", "description": "The protected material analysis request.", diff --git a/specification/cognitiveservices/data-plane/ContentSafety/stable/2023-10-01/contentsafety.json b/specification/cognitiveservices/data-plane/ContentSafety/stable/2023-10-01/contentsafety.json index cb948159aa62..27e23e2ac082 100644 --- a/specification/cognitiveservices/data-plane/ContentSafety/stable/2023-10-01/contentsafety.json +++ b/specification/cognitiveservices/data-plane/ContentSafety/stable/2023-10-01/contentsafety.json @@ -611,33 +611,29 @@ } }, "outputType": { - "$ref": "#/definitions/AnalyzeImageOutputType", + "type": "string", "description": "This refers to the type of image analysis output. If no value is assigned, the default value will be \"FourSeverityLevels\".", - "default": "FourSeverityLevels" + "default": "FourSeverityLevels", + "enum": [ + "FourSeverityLevels" + ], + "x-ms-enum": { + "name": "AnalyzeImageOutputType", + "modelAsString": true, + "values": [ + { + "name": "FourSeverityLevels", + "value": "FourSeverityLevels", + "description": "Output severities in four levels, the value could be 0,2,4,6." + } + ] + } } }, "required": [ "image" ] }, - "AnalyzeImageOutputType": { - "type": "string", - "description": "The type of image analysis output.", - "enum": [ - "FourSeverityLevels" - ], - "x-ms-enum": { - "name": "AnalyzeImageOutputType", - "modelAsString": true, - "values": [ - { - "name": "FourSeverityLevels", - "value": "FourSeverityLevels", - "description": "Output severities in four levels, the value could be 0,2,4,6." - } - ] - } - }, "AnalyzeImageResult": { "type": "object", "description": "The image analysis response.", @@ -683,39 +679,35 @@ "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." }, "outputType": { - "$ref": "#/definitions/AnalyzeTextOutputType", + "type": "string", "description": "This refers to the type of text analysis output. If no value is assigned, the default value will be \"FourSeverityLevels\".", - "default": "FourSeverityLevels" + "default": "FourSeverityLevels", + "enum": [ + "FourSeverityLevels", + "EightSeverityLevels" + ], + "x-ms-enum": { + "name": "AnalyzeTextOutputType", + "modelAsString": true, + "values": [ + { + "name": "FourSeverityLevels", + "value": "FourSeverityLevels", + "description": "Output severities in four levels, the value could be 0,2,4,6." + }, + { + "name": "EightSeverityLevels", + "value": "EightSeverityLevels", + "description": "Output severities in eight levels, the value could be 0,1,2,3,4,5,6,7." + } + ] + } } }, "required": [ "text" ] }, - "AnalyzeTextOutputType": { - "type": "string", - "description": "The type of text analysis output.", - "enum": [ - "FourSeverityLevels", - "EightSeverityLevels" - ], - "x-ms-enum": { - "name": "AnalyzeTextOutputType", - "modelAsString": true, - "values": [ - { - "name": "FourSeverityLevels", - "value": "FourSeverityLevels", - "description": "Output severities in four levels, the value could be 0,2,4,6." - }, - { - "name": "EightSeverityLevels", - "value": "EightSeverityLevels", - "description": "Output severities in eight levels, the value could be 0,1,2,3,4,5,6,7." - } - ] - } - }, "AnalyzeTextResult": { "type": "object", "description": "The text analysis response.", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzetext.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzetext.json index c7bf4af33b69..b4a2d5521094 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzetext.json +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzetext.json @@ -4193,14 +4193,81 @@ }, "script": { "type": "string", - "description": "Identifies the script of the input document.", + "description": "Identifies the script of the input document. Maps to the ISO 15924 standard formal name.", "enum": [ - "Latin" + "Arabic", + "Armenian", + "Bangla", + "UnifiedCanadianAboriginalSyllabics", + "Cyrillic", + "Devanagari", + "Ethiopic", + "Georgian", + "Greek", + "Gujarati", + "Gurmukhi", + "Hangul", + "HanSimplified", + "HanTraditional", + "Hebrew", + "Japanese", + "Khmer", + "Kannada", + "Lao", + "Latin", + "Malayalam", + "Myanmar", + "Odia", + "Sinhala", + "Tamil", + "Telugu", + "Thaana", + "Thai", + "Tibetan" ], "x-ms-enum": { "name": "ScriptKind", "modelAsString": true } + }, + "scriptCode": { + "type": "string", + "description": "Identifies the script of the input document. Maps to the ISO 15924 standard script code.", + "enum": [ + "Arab", + "Armn", + "Beng", + "Cans", + "Cyrl", + "Deva", + "Ethi", + "Geor", + "Grek", + "Gujr", + "Guru", + "Hang", + "Hans", + "Hant", + "Hebr", + "Jpan", + "Khmr", + "Knda", + "Laoo", + "Latn", + "Mlym", + "Mymr", + "Orya", + "Sinh", + "Taml", + "Telu", + "Thaa", + "Thai", + "Tibt" + ], + "x-ms-enum": { + "name": "ScriptCode", + "modelAsString": true + } } } }, diff --git a/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json b/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json index 18d87a688293..33bafa9d19ca 100644 --- a/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json +++ b/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json @@ -101,7 +101,7 @@ "tags": [ "Project" ], - "description": "Deletes the project identified by the given ID.", + "description": "Deletes the project identified by the given ID. All data (like consent, training set) in this project will be deleted automatically.", "operationId": "Projects_Delete", "produces": [ "application/json" @@ -114,7 +114,7 @@ "in": "query", "name": "forceDelete", "type": "boolean", - "description": "Set this to true if you want to delete a project with model and endpoint", + "description": "Set this to true if you want to delete a project with model and endpoint. Otherwise, the delete operation will fail.", "default": false }, { @@ -1405,7 +1405,7 @@ "tags": [ "PersonalVoice" ], - "description": "Creates a new personal voice.", + "description": "Creates a new personal voice with audio files in Azure Blob Storage.", "operationId": "PersonalVoices_Create", "consumes": [ "application/json" @@ -1469,7 +1469,7 @@ "tags": [ "PersonalVoice" ], - "description": "Creates a new personal voice.", + "description": "Creates a new personal voice with audio files in the client.", "operationId": "PersonalVoices_Post", "consumes": [ "multipart/form-data" @@ -1607,7 +1607,7 @@ }, "definitions": { "AzureBlobContentSource": { - "description": "Azure Blob Storage content.", + "description": "Azure Blob Storage content. With the examples below, it represents files https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav", "type": "object", "required": [ "containerUrl", @@ -1615,19 +1615,22 @@ ], "properties": { "containerUrl": { - "description": "Azure Blob Storage container URL.", + "description": "Azure Blob Storage container URL with [SAS](https://learn.microsoft.com/azure/storage/common/storage-sas-overview). Need both read and list permissions.", "type": "string", - "format": "url" + "format": "url", + "example": "https://contoso.blob.core.windows.net/voicecontainer?mySasToken" }, "prefix": { "description": "Blob name prefix.", - "type": "string" + "type": "string", + "example": "jessica" }, "extensions": { "description": "File name extensions.", "type": "array", "items": { - "type": "string" + "type": "string", + "example": ".wav" } } } @@ -1699,7 +1702,7 @@ "type": "string" }, "audioUrl": { - "description": "The public accessible URL of the consent audio file.", + "description": "The public accessible URL of the consent audio file. It's recommended to be an Azure blob URL with [SAS](https://learn.microsoft.com/azure/storage/common/storage-sas-overview). This property is only available in request.", "type": "string", "format": "uri" }, @@ -2562,7 +2565,7 @@ "QueryFilter": { "name": "filter", "in": "query", - "description": "Filter condition.\r\n
  • Supported properties:projectId, createdDateTime, locale, kind\r\n
  • Operators:\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for created.\r\n
  • Example:\r\n - ```filter=projectId eq 'Jessica'``` (filter by project ID)\r\n - ```filter=kind eq 'ProfessionalVoice'``` (filter project by kind)\r\n - ```filter=locale eq 'en-US'``` (filter training set and model by locale)\r\n - ```filter=createdDateTime gt 2022-12-30T23:59:59.99Z``` (filter resource created time after 2023-11-01)
", + "description": "Filter condition.\r\n - **Supported properties:** projectId, createdDateTime, locale, kind\r\n - **Operators:**\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - **Example:**\r\n - ```filter=projectId eq 'Jessica'``` (filter by project ID)\r\n - ```filter=kind eq 'ProfessionalVoice'``` (filter project by kind)\r\n - ```filter=locale eq 'en-US'``` (filter training set and model by locale)\r\n - ```filter=createdDateTime gt 2022-12-30T23:59:59.99Z``` (filter resource created time after 2023-11-01)", "required": false, "type": "string", "x-ms-parameter-location": "method" diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/cognitiveservices.json index 4ef5b1998c08..8334e866115c 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/cognitiveservices.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/cognitiveservices.json @@ -2524,7 +2524,7 @@ } }, "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/raiContentFilters": { - "post": { + "get": { "tags": [ "RaiContentFilters" ], @@ -2559,6 +2559,9 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -5538,7 +5541,7 @@ "$ref": "#/definitions/RaiPolicyContentFilter" }, "x-ms-identifiers": [ - "policyName" + "name" ], "description": "The list of Content Filters." } @@ -5560,7 +5563,7 @@ "description": "Azure OpenAI Content Filter.", "type": "object", "properties": { - "policyName": { + "name": { "type": "string", "description": "Name of ContentFilter." }, diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/GetRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/GetRaiPolicy.json index 559741b86bd8..b04d5f571b97 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/GetRaiPolicy.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/GetRaiPolicy.json @@ -17,20 +17,20 @@ "basePolicyName": "112", "contentFilters": [ { - "policyName": "hate", + "name": "hate", "allowedContentLevel": "Low", "blocking": true }, { - "policyName": "sexual", + "name": "sexual", "allowedContentLevel": "Low" }, { - "policyName": "violence", + "name": "violence", "enabled": false }, { - "policyName": "DefaultHateSpeechBlockList", + "name": "DefaultHateSpeechBlockList", "enabled": false } ] diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/ListRaiPolicies.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/ListRaiPolicies.json index 91b8ffea01b5..f316a6870ab6 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/ListRaiPolicies.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/ListRaiPolicies.json @@ -16,20 +16,20 @@ "basePolicyName": "112", "contentFilters": [ { - "policyName": "hate", + "name": "hate", "allowedContentLevel": "Low", "blocking": true }, { - "policyName": "sexual", + "name": "sexual", "allowedContentLevel": "Low" }, { - "policyName": "violence", + "name": "violence", "enabled": false }, { - "policyName": "DefaultHateSpeechBlockList", + "name": "DefaultHateSpeechBlockList", "enabled": false } ] diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/PutRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/PutRaiPolicy.json index 132a541c53e0..bc08137a039c 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/PutRaiPolicy.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2023-10-01-preview/examples/PutRaiPolicy.json @@ -10,20 +10,20 @@ "basePolicyName": "112", "contentFilters": [ { - "policyName": "hate", + "name": "hate", "allowedContentLevel": "Low", "blocking": true }, { - "policyName": "sexual", + "name": "sexual", "allowedContentLevel": "Low" }, { - "policyName": "violence", + "name": "violence", "enabled": false }, { - "policyName": "DefaultHateSpeechBlockList", + "name": "DefaultHateSpeechBlockList", "enabled": false } ] @@ -39,20 +39,20 @@ "basePolicyName": "112", "contentFilters": [ { - "policyName": "hate", + "name": "hate", "allowedContentLevel": "Low", "blocking": true }, { - "policyName": "sexual", + "name": "sexual", "allowedContentLevel": "Low" }, { - "policyName": "violence", + "name": "violence", "enabled": false }, { - "policyName": "DefaultHateSpeechBlockList", + "name": "DefaultHateSpeechBlockList", "enabled": false } ] @@ -67,20 +67,20 @@ "basePolicyName": "112", "contentFilters": [ { - "policyName": "hate", + "name": "hate", "allowedContentLevel": "Low", "blocking": true }, { - "policyName": "sexual", + "name": "sexual", "allowedContentLevel": "Low" }, { - "policyName": "violence", + "name": "violence", "enabled": false }, { - "policyName": "DefaultHateSpeechBlockList", + "name": "DefaultHateSpeechBlockList", "enabled": false } ] diff --git a/specification/common-types/resource-management/v4/types.json b/specification/common-types/resource-management/v4/types.json index 4cc37c07aea0..e9dd5d83ef57 100644 --- a/specification/common-types/resource-management/v4/types.json +++ b/specification/common-types/resource-management/v4/types.json @@ -666,7 +666,6 @@ "type": "string", "description": "The scope at which the operation is performed.", "minLength": 1, - "maxLength": 90, "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true }, diff --git a/specification/common-types/resource-management/v5/types.json b/specification/common-types/resource-management/v5/types.json index b7cea5ec1ba7..aff6214d69d7 100644 --- a/specification/common-types/resource-management/v5/types.json +++ b/specification/common-types/resource-management/v5/types.json @@ -672,7 +672,6 @@ "type": "string", "description": "The scope at which the operation is performed.", "minLength": 1, - "maxLength": 90, "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true }, diff --git a/specification/common-types/resource-management/v6/privatelinks.json b/specification/common-types/resource-management/v6/privatelinks.json new file mode 100644 index 000000000000..7b2346c1033f --- /dev/null +++ b/specification/common-types/resource-management/v6/privatelinks.json @@ -0,0 +1,202 @@ +{ + "swagger": "2.0", + "info": { + "version": "6.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "PrivateEndpoint": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for private endpoint." + } + }, + "description": "The private endpoint resource." + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../v5/types.json#/definitions/Resource" + } + ], + "description": "The private endpoint connection resource." + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "groupIds": { + "description": "The group ids for the private endpoint resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The private endpoint resource." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the private endpoint connection." + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../v5/types.json#/definitions/Resource" + } + ], + "description": "A private link resource." + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + }, + "description": "List of private endpoint connections associated with the specified resource." + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + }, + "description": "A list of private link resources." + } + }, + "parameters": { + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection associated with the Azure resource.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/communication/Communication.JobRouter/tspconfig.yaml b/specification/communication/Communication.JobRouter/tspconfig.yaml index bcce2df033a3..b2c8033b5fae 100644 --- a/specification/communication/Communication.JobRouter/tspconfig.yaml +++ b/specification/communication/Communication.JobRouter/tspconfig.yaml @@ -34,7 +34,6 @@ options: emitter-output-dir: "{csharp-sdk-folder}/sdk/{service-directory-name}/{namespace}/src" namespace: Azure.Communication.JobRouter package-dir: "Azure.Communication.JobRouter" - save-inputs: true "@azure-tools/typespec-python": package-pprint-name: "\"Communication JobRouter\"" emitter-output-dir: "{python-sdk-folder}/sdk/{service-directory-name}/{package-name}" diff --git a/specification/communication/data-plane/Sms/preview/2024-02-05-preview/communicationservicessms.json b/specification/communication/data-plane/Sms/preview/2024-02-05-preview/communicationservicessms.json new file mode 100644 index 000000000000..2c46ced220a9 --- /dev/null +++ b/specification/communication/data-plane/Sms/preview/2024-02-05-preview/communicationservicessms.json @@ -0,0 +1,219 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Communication SMS Service", + "description": "Azure Communication SMS Service", + "version": "2024-02-05-preview" + }, + "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": { + "/sms": { + "post": { + "tags": [ + "Sms" + ], + "summary": "Sends a SMS message from a phone number that belongs to the authenticated account.", + "operationId": "Sms_Send", + "x-ms-examples": { + "SuccessfulSend": { + "$ref": "./examples/send.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "SendMessageRequest", + "description": "Represents the body of the send message request.", + "required": true, + "schema": { + "$ref": "#/definitions/SendMessageRequest" + } + }, + { + "name": "api-version", + "in": "query", + "description": "Version of API to invoke.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/SmsSendResponse" + } + } + } + } + } + }, + "definitions": { + "SmsRecipient": { + "description": "Recipient details for sending SMS messages.", + "required": [ + "to" + ], + "type": "object", + "properties": { + "to": { + "description": "The recipient's phone number in E.164 format.", + "type": "string" + }, + "repeatabilityRequestId": { + "description": "If specified, the client directs that the request is repeatable; that is, the client can make the request multiple times with the same Repeatability-Request-ID and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-ID is an opaque string representing a client-generated, 36-character hexadecimal case-insensitive encoding of a UUID (GUID), identifier for the request.", + "type": "string" + }, + "repeatabilityFirstSent": { + "description": "MUST be sent by clients to specify that a request is repeatable. Repeatability-First-Sent is used to specify the date and time at which the request was first created.eg- Tue, 26 Mar 2019 16:06:51 GMT", + "type": "string" + } + } + }, + "SmsSendOptions": { + "description": "Optional configuration for sending SMS messages.", + "required": [ + "enableDeliveryReport" + ], + "type": "object", + "properties": { + "enableDeliveryReport": { + "description": "Enable this flag to receive a delivery report for this message on the Azure Resource EventGrid.", + "type": "boolean" + }, + "tag": { + "description": "Use this field to provide metadata that will then be sent back in the corresponding Delivery Report.", + "type": "string" + }, + "deliveryReportTimeoutInSeconds": { + "format": "int32", + "description": "Time to wait for a delivery report. After this time a delivery report with timeout error code is generated.", + "maximum": 43200, + "minimum": 60, + "type": "integer" + } + } + }, + "SendMessageRequest": { + "description": "Represents the properties of a send message request.", + "required": [ + "message", + "smsRecipients", + "from" + ], + "type": "object", + "properties": { + "from": { + "description": "The sender's phone number in E.164 format that is owned by the authenticated account.", + "type": "string" + }, + "smsRecipients": { + "description": "The recipient's phone number in E.164 format. In this version, a minimum of 1 and upto 100 recipients in the list are supported.", + "maxLength": 100, + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/SmsRecipient" + } + }, + "message": { + "description": "The contents of the message that will be sent to the recipient. The allowable content is defined by RFC 5724.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "smsSendOptions": { + "$ref": "#/definitions/SmsSendOptions" + } + } + }, + "SmsSendResponse": { + "description": "Response for a successful or multi status send Sms request.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SmsSendResponseItem" + } + } + } + }, + "SmsSendResponseItem": { + "description": "Response for a single recipient.", + "required": [ + "httpStatusCode", + "to", + "successful" + ], + "type": "object", + "properties": { + "to": { + "description": "The recipient's phone number in E.164 format.", + "type": "string" + }, + "messageId": { + "description": "The identifier of the outgoing Sms message. Only present if message processed.", + "type": "string" + }, + "httpStatusCode": { + "format": "int32", + "description": "HTTP Status code.", + "type": "integer" + }, + "repeatabilityResult": { + "description": "The result of a repeatable request with one of the case-insensitive values accepted or rejected.", + "type": "string", + "enum": [ + "accepted", + "rejected" + ] + }, + "successful": { + "description": "Indicates if the message is processed successfully or not.", + "type": "boolean" + }, + "errorMessage": { + "description": "Optional error message in case of 4xx/5xx/repeatable errors.", + "type": "string" + } + } + } + }, + "parameters": {}, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "description": "The communication resource, for example https://my-resource.communication.azure.com", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client", + "format": "url" + } + ] + } +} diff --git a/specification/communication/data-plane/Sms/preview/2024-02-05-preview/examples/send.json b/specification/communication/data-plane/Sms/preview/2024-02-05-preview/examples/send.json new file mode 100644 index 000000000000..1a647f5442fa --- /dev/null +++ b/specification/communication/data-plane/Sms/preview/2024-02-05-preview/examples/send.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "SendMessageRequest": { + "from": "+18001110000", + "smsRecipients": [ + { + "to": "+11234567890" + }, + { + "to": "+11234567891" + }, + { + "to": "+112345678901" + }, + { + "to": "+11234567892" + }, + { + "to": "+11234567893", + "repeatabilityRequestId": "fda6d242-46aa-4247-8bf6-619a1206f9c3", + "repeatabilityFirstSent": "Mon, 01 Apr 2019 06:22:03 GMT" + }, + { + "to": "+11234567894", + "repeatabilityRequestId": "fda6d242-46aa-4247-8bf6-619a1206f9c3" + } + ], + "message": "Hello world!", + "smsSendOptions": { + "enableDeliveryReport": true, + "tag": "testSmsRequest", + "deliveryReportTimeoutInSeconds": 300 + } + }, + "api-version": "2024-02-05-preview", + "endpoint": "https://contoso.communication.azure.com/" + }, + "responses": { + "202": { + "headers": {}, + "body": { + "value": [ + { + "to": "+11234567890", + "messageId": "Outgoing_20200610203725bfd4ba70-70bf-4f77-925d-c0bdb5161bb3", + "httpStatusCode": 202, + "successful": true + }, + { + "to": "+11234567891", + "messageId": "Outgoing_2020061020025100d1-d07e-4b19-b25d-13525d552822", + "httpStatusCode": 202, + "successful": true + }, + { + "to": "+112345678901", + "httpStatusCode": 400, + "errorMessage": "Invalid To phone number format.", + "successful": false + }, + { + "to": "+11234567892", + "httpStatusCode": 503, + "errorMessage": "ServiceUnavailable", + "successful": false + }, + { + "to": "+11234567893", + "messageId": "Outgoing_2020061020025100d1-d07e-4b19-b25d-13525d552822_noam", + "httpStatusCode": 202, + "repeatabilityResult": "accepted", + "successful": true + }, + { + "to": "+11234567894", + "httpStatusCode": 400, + "repeatabilityResult": "rejected", + "errorMessage": "Request sent with Invalid DateTime value for repeatability-first-sent. Expected is DateTime ,RFC1123 pattern.", + "successful": false + } + ] + } + } + } +} diff --git a/specification/communication/data-plane/Sms/readme.md b/specification/communication/data-plane/Sms/readme.md index ab03efbe836a..9c3eea3788a9 100644 --- a/specification/communication/data-plane/Sms/readme.md +++ b/specification/communication/data-plane/Sms/readme.md @@ -26,7 +26,7 @@ These are the global settings for the communicationservices. ```yaml openapi-type: data-plane -tag: package-2024-01-14-preview +tag: package-sms-2024-02-05-preview ``` ### Supression @@ -73,6 +73,17 @@ title: Azure Communication Services ``` +### Tag: package-sms-2024-02-05-preview + +These settings apply only when `--tag=package-sms-2024-02-05-preview` is specified on the command line. + +```yaml $(tag) == 'package-sms-2024-02-05-preview' +input-file: + - preview/2024-02-05-preview/communicationservicessms.json +title: + Azure Communication Services +``` + --- # Code Generation diff --git a/specification/communitytraining/Community.Management/main.tsp b/specification/communitytraining/Community.Management/main.tsp index 4621bc89d768..fb0c43343580 100644 --- a/specification/communitytraining/Community.Management/main.tsp +++ b/specification/communitytraining/Community.Management/main.tsp @@ -36,20 +36,21 @@ model CommunityTraining is TrackedResource { @doc("The status of the current operation.") @Azure.Core.lroStatus -enum ProvisioningState { - ...ResourceProvisioningState, +union ProvisioningState { + string, + ResourceProvisioningState, @doc("Initial provisioning in progress") - Provisioning, + Provisioning: "Provisioning", @doc("Update in progress") - Updating, + Updating: "Updating", @doc("Deletion in progress") - Deleting, + Deleting: "Deleting", @doc("Change accepted for processing") - Accepted, + Accepted: "Accepted", } @doc("Details of the Community CommunityTraining Identity Configuration") diff --git a/specification/communitytraining/resource-manager/Microsoft.Community/stable/2023-11-01/CommunityTrainings.json b/specification/communitytraining/resource-manager/Microsoft.Community/stable/2023-11-01/CommunityTrainings.json index 4b3240c0e379..8fe99663d79a 100644 --- a/specification/communitytraining/resource-manager/Microsoft.Community/stable/2023-11-01/CommunityTrainings.json +++ b/specification/communitytraining/resource-manager/Microsoft.Community/stable/2023-11-01/CommunityTrainings.json @@ -60,7 +60,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -99,7 +99,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CommunityTrainingListResult" } @@ -141,7 +141,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CommunityTrainingListResult" } @@ -191,7 +191,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CommunityTraining" } @@ -316,7 +316,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CommunityTraining" } @@ -396,7 +396,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/communityGallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/communityGallery.json new file mode 100644 index 000000000000..5b4ae1981816 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/communityGallery.json @@ -0,0 +1,615 @@ +{ + "swagger": "2.0", + "info": { + "title": "CommunityGalleryServiceClient", + "description": "Community Gallery Service Client.", + "version": "2023-07-03" + }, + "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.Compute/locations/{location}/communityGalleries/{publicGalleryName}": { + "get": { + "tags": [ + "CommunityGalleries" + ], + "operationId": "CommunityGalleries_Get", + "description": "Get a community gallery by gallery public name.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "#/parameters/PublicGalleryNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommunityGallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a community gallery.": { + "$ref": "./examples/communityGalleryExamples/CommunityGallery_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}": { + "get": { + "tags": [ + "CommunityGalleryImages" + ], + "operationId": "CommunityGalleryImages_Get", + "description": "Get a community gallery image.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PublicGalleryNameParameter" + }, + { + "$ref": "#/parameters/GalleryImageNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommunityGalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a community gallery image.": { + "$ref": "./examples/communityGalleryExamples/CommunityGalleryImage_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}": { + "get": { + "tags": [ + "CommunityGalleryImageVersions" + ], + "operationId": "CommunityGalleryImageVersions_Get", + "description": "Get a community gallery image version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PublicGalleryNameParameter" + }, + { + "$ref": "#/parameters/GalleryImageNameParameter" + }, + { + "$ref": "#/parameters/GalleryImageVersionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommunityGalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a community gallery image version.": { + "$ref": "./examples/communityGalleryExamples/CommunityGalleryImageVersion_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images": { + "get": { + "tags": [ + "CommunityGalleryImages" + ], + "operationId": "CommunityGalleryImages_List", + "description": "List community gallery images inside a gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PublicGalleryNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommunityGalleryImageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List community gallery images.": { + "$ref": "./examples/communityGalleryExamples/CommunityGalleryImage_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}/versions": { + "get": { + "tags": [ + "CommunityGalleryImageVersions" + ], + "operationId": "CommunityGalleryImageVersions_List", + "description": "List community gallery image versions inside an image.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PublicGalleryNameParameter" + }, + { + "$ref": "#/parameters/GalleryImageNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommunityGalleryImageVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List community gallery image versions.": { + "$ref": "./examples/communityGalleryExamples/CommunityGalleryImageVersion_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PirCommunityGalleryResource": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "identifier": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommunityGalleryIdentifier" + } + }, + "description": "Base information about the community gallery resource in azure compute gallery." + }, + "CommunityGalleryArtifactTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The artifact tags of a community gallery resource." + }, + "CommunityGalleryDisclaimer": { + "type": "string", + "properties": { + "disclaimer": { + "readOnly": true, + "type": "string", + "description": "Community gallery disclaimer" + } + }, + "description": "The disclaimer for a community gallery resource." + }, + "CommunityGalleryIdentifier": { + "properties": { + "uniqueId": { + "type": "string", + "description": "The unique id of this community gallery." + } + }, + "description": "The identifier information of community gallery." + }, + "CommunityGalleryMetadata": { + "type": "object", + "properties": { + "publisherUri": { + "format": "uri", + "type": "string", + "description": "The publisher URI of this community gallery." + }, + "publisherContact": { + "type": "string", + "description": "The publisher email id of this community gallery." + }, + "eula": { + "type": "string", + "description": "The end-user license agreement for this community gallery." + }, + "publicNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of public names the gallery has." + }, + "privacyStatementUri": { + "format": "uri", + "type": "string", + "description": "The link for the privacy statement of this community gallery from the gallery publisher." + } + }, + "required": [ + "publisherContact", + "publicNames" + ], + "description": "The metadata of community gallery." + }, + "CommunityGallery": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommunityGalleryProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirCommunityGalleryResource" + } + ], + "description": "Specifies information about the Community Gallery that you want to create or update." + }, + "CommunityGalleryProperties": { + "type": "object", + "properties": { + "disclaimer": { + "$ref": "#/definitions/CommunityGalleryDisclaimer" + }, + "artifactTags": { + "$ref": "#/definitions/CommunityGalleryArtifactTags" + }, + "communityMetadata": { + "$ref": "#/definitions/CommunityGalleryMetadata" + } + }, + "description": "Describes the properties of a community gallery." + }, + "CommunityGalleryImageList": { + "type": "object", + "description": "The List Community Gallery Images operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CommunityGalleryImage" + }, + "x-ms-identifiers": [], + "description": "A list of community gallery images." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of community gallery images. Call ListNext() with this to fetch the next page of community gallery images." + } + }, + "required": [ + "value" + ] + }, + "CommunityGalleryImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommunityGalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirCommunityGalleryResource" + } + ], + "description": "Specifies information about the gallery image definition that you want to create or update." + }, + "CommunityGalleryImageProperties": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "identifier": { + "$ref": "#/definitions/CommunityGalleryImageIdentifier" + }, + "recommended": { + "$ref": "./galleryRPCommon.json#/definitions/RecommendedMachineConfiguration" + }, + "disallowed": { + "$ref": "./galleryRPCommon.json#/definitions/Disallowed" + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "features": { + "type": "array", + "items": { + "$ref": "./galleryRPCommon.json#/definitions/GalleryImageFeature" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of gallery image features." + }, + "purchasePlan": { + "$ref": "./galleryRPCommon.json#/definitions/ImagePurchasePlan" + }, + "architecture": { + "$ref": "./galleryRPCommon.json#/definitions/Architecture" + }, + "privacyStatementUri": { + "type": "string", + "description": "Privacy statement URI for the current community gallery image." + }, + "eula": { + "type": "string", + "description": "The end-user license agreement for the current community gallery image." + }, + "disclaimer": { + "$ref": "#/definitions/CommunityGalleryDisclaimer" + }, + "artifactTags": { + "$ref": "#/definitions/CommunityGalleryArtifactTags" + } + }, + "required": [ + "osType", + "osState", + "identifier" + ], + "description": "Describes the properties of a gallery image definition." + }, + "CommunityGalleryImageVersionList": { + "type": "object", + "description": "The List Community Gallery Image versions operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CommunityGalleryImageVersion" + }, + "x-ms-identifiers": [], + "description": "A list of community gallery image versions." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of community gallery image versions. Call ListNext() with this to fetch the next page of community gallery image versions." + } + }, + "required": [ + "value" + ] + }, + "CommunityGalleryImageVersion": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommunityGalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirCommunityGalleryResource" + } + ], + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "CommunityGalleryImageVersionProperties": { + "properties": { + "publishedDate": { + "type": "string", + "format": "date-time", + "description": "The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "excludeFromLatest": { + "type": "boolean", + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "storageProfile": { + "$ref": "./galleryRPCommon.json#/definitions/SharedGalleryImageVersionStorageProfile", + "description": "Describes the storage profile of the image version." + }, + "disclaimer": { + "$ref": "#/definitions/CommunityGalleryDisclaimer" + }, + "artifactTags": { + "$ref": "#/definitions/CommunityGalleryArtifactTags" + } + }, + "description": "Describes the properties of a gallery image version." + }, + "CommunityGalleryImageIdentifier": { + "properties": { + "publisher": { + "type": "string", + "description": "The name of the gallery image definition publisher." + }, + "offer": { + "type": "string", + "description": "The name of the gallery image definition offer." + }, + "sku": { + "type": "string", + "description": "The name of the gallery image definition SKU." + } + }, + "description": "This is the community gallery image definition identifier." + } + }, + "parameters": { + "PublicGalleryNameParameter": { + "name": "publicGalleryName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The public name of the community gallery." + }, + "GalleryImageNameParameter": { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the community gallery image definition." + }, + "GalleryImageVersionNameParameter": { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the community gallery image version. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_Get.json new file mode 100644 index 000000000000..9a9e0e6a9a6e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2023-07-03", + "publicGalleryName": "publicGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "myGalleryImageVersionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "publishedDate": "2018-03-20T09:12:28Z", + "endOfLifeDate": "2022-03-20T09:12:28Z", + "excludeFromLatest": false, + "storageProfile": { + "osDiskImage": { + "diskSizeGB": 29, + "hostCaching": "None" + } + }, + "artifactTags": { + "ShareTag-CommunityGallery": "CommunityGallery" + }, + "disclaimer": "https://test-uri.com" + }, + "location": "myLocation", + "name": "myGalleryImageVersionName", + "type": "Microsoft.Compute/locations/communityGalleryImageVersion", + "identifier": { + "uniqueId": "/CommunityGalleries/publicGalleryName/Images/myGalleryImageName/Versions/myGalleryImageVersionName" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_List.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_List.json new file mode 100644 index 000000000000..976a42c7b454 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2023-07-03", + "publicGalleryName": "publicGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "publishedDate": "2018-03-20T09:12:28Z", + "endOfLifeDate": "2022-03-20T09:12:28Z", + "excludeFromLatest": false, + "storageProfile": { + "osDiskImage": { + "diskSizeGB": 29, + "hostCaching": "None" + } + }, + "artifactTags": { + "ShareTag-CommunityGallery": "CommunityGallery" + }, + "disclaimer": "https://test-uri.com" + }, + "location": "myLocation", + "name": "myGalleryImageVersionName", + "identifier": { + "uniqueId": "/CommunityGalleries/publicGalleryName/Images/myGalleryImageName/Versions/myGalleryImageVersionName" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscription-Id}/providers/Microsoft.Compute/communityGalleries/publicGalleryName/images/myGalleryImageName/versions?$skiptoken={token}/communityGalleries/publicGalleryName/images/myGalleryImageName/versions/myGalleryImageVersionName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImage_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImage_Get.json new file mode 100644 index 000000000000..d171f82de32e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImage_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2023-07-03", + "publicGalleryName": "publicGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "privacyStatementUri": "https://test-uri.com", + "eula": "https://test-uri.com", + "artifactTags": { + "ShareTag-CommunityGallery": "CommunityGallery" + }, + "disclaimer": "https://test-uri.com" + }, + "location": "myLocation", + "name": "myGalleryImageName", + "type": "Microsoft.Compute/locations/communityGalleryImage", + "identifier": { + "uniqueId": "/CommunityGalleries/publicGalleryName/Images/myGalleryImageName" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImage_List.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImage_List.json new file mode 100644 index 000000000000..90498cccdb45 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGalleryImage_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2023-07-03", + "publicGalleryName": "publicGalleryName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "artifactTags": { + "ShareTag-CommunityGallery": "CommunityGallery" + }, + "disclaimer": "https://test-uri.com" + }, + "location": "myLocation", + "name": "myGalleryImageName", + "identifier": { + "uniqueId": "/CommunityGalleries/publicGalleryName/Images/myGalleryImageName" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscription-Id}/providers/Microsoft.Compute/communityGalleries/publicGalleryName/images?$skiptoken={token}/communityGalleries/publicGalleryName/images/myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGallery_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGallery_Get.json new file mode 100644 index 000000000000..2bf04d06898a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/communityGalleryExamples/CommunityGallery_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2023-07-03", + "publicGalleryName": "publicGalleryName" + }, + "responses": { + "200": { + "body": { + "location": "myLocation", + "name": "publicGalleryName", + "type": "Microsoft.Compute/locations/communityGallery", + "identifier": { + "uniqueId": "/CommunityGalleries/publicGalleryName" + }, + "properties": { + "artifactTags": { + "ShareTag-CommunityGallery": "CommunityGallery" + }, + "disclaimer": "https://test-uri.com", + "communityMetadata": { + "publisherUri": "https://test-uri.com", + "publisherContact": "sameple@email.com", + "eula": "https://test-uri.com", + "publicNames": [ + "prefix-xxxxx" + ], + "privacyStatementUri": "https://test-uri.com" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/CommunityGallery_Create.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/CommunityGallery_Create.json new file mode 100644 index 000000000000..1bd0a9a314f5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/CommunityGallery_Create.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "gallery": { + "location": "West US", + "properties": { + "description": "This is the gallery description.", + "sharingProfile": { + "permissions": "Community", + "communityGalleryInfo": { + "publisherUri": "uri", + "publisherContact": "pir@microsoft.com", + "eula": "eula", + "publicNamePrefix": "PirPublic" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "sharingProfile": { + "permissions": "Community", + "communityGalleryInfo": { + "publisherUri": "uri", + "publisherContact": "pir@microsoft.com", + "eula": "eula", + "publicNamePrefix": "PirPublic" + } + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Creating", + "sharingProfile": { + "permissions": "Community", + "communityGalleryInfo": { + "publisherUri": "uri", + "publisherContact": "pir@microsoft.com", + "eula": "eula", + "publicNamePrefix": "PirPublic" + } + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "sharingProfile": { + "permissions": "Community", + "communityGalleryInfo": { + "publisherUri": "uri", + "publisherContact": "pir@microsoft.com", + "eula": "eula", + "publicNamePrefix": "PirPublic" + } + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/CommunityGallery_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/CommunityGallery_Get.json new file mode 100644 index 000000000000..183705fb7384 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/CommunityGallery_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/communityGalleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded", + "sharingProfile": { + "permissions": "Community", + "communityGalleryInfo": { + "publisherUri": "uri", + "publisherContact": "pir@microsoft.com", + "eula": "eula", + "publicNames": [ + "GalleryPublicName" + ], + "communityGalleryEnabled": true + } + }, + "sharingStatus": { + "aggregatedState": "Succeeded", + "summary": [ + { + "region": "westus", + "state": "Succeeded", + "details": "" + } + ] + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Create.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Create.json new file mode 100644 index 000000000000..24138a74da0e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Create.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0", + "galleryApplicationVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "endOfLifeDate": "2019-07-01T07:00:00Z", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "settings": { + "packageFileName": "package.zip", + "configFileName": "configuration.cfg" + }, + "advancedSettings": { + "timeout": "300", + "user": "root" + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "provisioningState": "Updating" + } + } + }, + "201": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "settings": { + "packageFileName": "package.zip", + "configFileName": "configuration.cfg" + }, + "advancedSettings": { + "timeout": "300", + "user": "root" + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "provisioningState": "Creating" + } + } + }, + "202": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Delete.json new file mode 100644 index 000000000000..2b493fe68f47 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Delete.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-07-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-07-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-07-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-07-01" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-07-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-07-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Get.json new file mode 100644 index 000000000000..1c5405e7e903 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Get_WithReplicationStatus.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Get_WithReplicationStatus.json new file mode 100644 index 000000000000..d22b1a37d93f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Get_WithReplicationStatus.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0", + "$expand": "ReplicationStatus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "settings": { + "packageFileName": "package.zip", + "configFileName": "configuration.cfg" + }, + "advancedSettings": { + "timeout": "300", + "user": "root" + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "replicationStatus": { + "aggregatedState": "Completed", + "summary": [ + { + "region": "West US", + "state": "Completed", + "details": "", + "progress": 100 + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_ListByGalleryApplication.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_ListByGalleryApplication.json new file mode 100644 index 000000000000..c8d430a6b836 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_ListByGalleryApplication.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName/versions?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/applications/myGalleryApplicationName/versions/myGalleryApplicationVersionName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Update.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Update.json new file mode 100644 index 000000000000..4d9437cbd312 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplicationVersion_Update.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0", + "galleryApplicationVersion": { + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "endOfLifeDate": "2019-07-01T07:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS" + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Create.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Create.json new file mode 100644 index 000000000000..50ec08458832 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Create.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplication": { + "location": "West US", + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + }, + "201": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + }, + "202": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Delete.json new file mode 100644 index 000000000000..cc3999a5d5b7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Delete.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-07-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-07-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-07-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-07-01" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-07-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-07-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Get.json new file mode 100644 index 000000000000..57d7d8b7db33 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName", + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "location": "West US", + "name": "myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_ListByGallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_ListByGallery.json new file mode 100644 index 000000000000..47ceed2154bd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_ListByGallery.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName", + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "location": "West US", + "name": "myGalleryApplicationName" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/applications/myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Update.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Update.json new file mode 100644 index 000000000000..1909a9bf2ea7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryApplication_Update.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplication": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create.json new file mode 100644 index 000000000000..08a9d97d4b1e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup//providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup//providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithCommunityImageVersionAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithCommunityImageVersionAsSource.json new file mode 100644 index 000000000000..ddce5d4cac6b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithCommunityImageVersionAsSource.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "source": { + "communityGalleryImageId": "/communityGalleries/{communityGalleryName}/images/{communityGalleryImageName}" + } + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "communityGalleryImageId": "/communityGalleries/{communityGalleryName}/images/{communityGalleryImageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "communityGalleryImageId": "/communityGalleries/{communityGalleryName}/images/{communityGalleryImageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "communityGalleryImageId": "/communityGalleries/{communityGalleryName}/images/{communityGalleryImageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithImageVersionAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithImageVersionAsSource.json new file mode 100644 index 000000000000..774b6bf30073 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithImageVersionAsSource.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionName}" + } + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithShallowReplicationMode.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithShallowReplicationMode.json new file mode 100644 index 000000000000..aa471de2fe52 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithShallowReplicationMode.json @@ -0,0 +1,185 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "excludeFromLatest": false + } + ], + "replicationMode": "Shallow" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS", + "replicationMode": "Shallow" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS", + "replicationMode": "Shallow" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS", + "replicationMode": "Shallow" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json new file mode 100644 index 000000000000..145a697bb4e5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json @@ -0,0 +1,314 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{osSnapshotName}" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/disks/{dataDiskName}" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{osSnapshotName}" + }, + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/disks/{dataDiskName}" + }, + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{osSnapshotName}" + }, + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/disks/{dataDiskName}" + }, + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{osSnapshotName}" + }, + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/disks/{dataDiskName}" + }, + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithTargetExtendedLocations.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithTargetExtendedLocations.json new file mode 100644 index 000000000000..aa20d65d0294 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithTargetExtendedLocations.json @@ -0,0 +1,367 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "targetExtendedLocations": [ + { + "name": "West US", + "extendedLocation": { + "name": "microsoftlosangeles1", + "type": "EdgeZone" + }, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "storageAccountType": "StandardSSD_LRS(default)", + "extendedLocationReplicaCount": 1 + }, + { + "name": "East US", + "extendedLocation": { + "name": "microsoftnewyork1", + "type": "EdgeZone" + }, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "storageAccountType": "StandardSSD_LRS(default)", + "extendedLocationReplicaCount": 1 + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD.json new file mode 100644 index 000000000000..1780a0b0181c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD.json @@ -0,0 +1,272 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet", + "lun": 1 + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD_UefiSettings.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD_UefiSettings.json new file mode 100644 index 000000000000..582a400549bb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD_UefiSettings.json @@ -0,0 +1,404 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet", + "lun": 1 + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "securityProfile": { + "uefiSettings": { + "signatureTemplateNames": [ + "MicrosoftUefiCertificateAuthorityTemplate" + ], + "additionalSignatures": { + "kek": [ + { + "type": "sha256", + "value": [ + "" + ] + } + ], + "db": [ + { + "type": "x509", + "value": [ + "" + ] + } + ], + "dbx": [ + { + "type": "x509", + "value": [ + "" + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "securityProfile": { + "uefiSettings": { + "signatureTemplateNames": [ + "MicrosoftUefiCertificateAuthorityTemplate" + ], + "additionalSignatures": { + "kek": [ + { + "type": "sha256", + "value": [ + "" + ] + } + ], + "db": [ + { + "type": "x509", + "value": [ + "" + ] + } + ], + "dbx": [ + { + "type": "x509", + "value": [ + "" + ] + } + ] + } + } + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "securityProfile": { + "uefiSettings": { + "signatureTemplateNames": [ + "MicrosoftUefiCertificateAuthorityTemplate" + ], + "additionalSignatures": { + "kek": [ + { + "type": "sha256", + "value": [ + "" + ] + } + ], + "db": [ + { + "type": "x509", + "value": [ + "" + ] + } + ], + "dbx": [ + { + "type": "x509", + "value": [ + "" + ] + } + ] + } + } + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "securityProfile": { + "uefiSettings": { + "signatureTemplateNames": [ + "MicrosoftUefiCertificateAuthorityTemplate" + ], + "additionalSignatures": { + "kek": [ + { + "type": "sha256", + "value": [ + "" + ] + } + ], + "db": [ + { + "type": "x509", + "value": [ + "" + ] + } + ], + "dbx": [ + { + "type": "x509", + "value": [ + "" + ] + } + ] + } + } + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithVmAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithVmAsSource.json new file mode 100644 index 000000000000..503a1053858c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Create_WithVmAsSource.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 2, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "source": { + "virtualMachineId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "virtualMachineId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "virtualMachineId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "virtualMachineId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Delete.json new file mode 100644 index 000000000000..e5627c3e550b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Delete.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/westus2/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2022-01-03", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/westus2/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2022-01-03" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/westus2/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2022-01-03", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/westus2/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2022-01-03" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/westus2/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2022-01-03", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/westus2/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2022-01-03" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get.json new file mode 100644 index 000000000000..53f95c8fdc77 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get_WithReplicationStatus.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get_WithReplicationStatus.json new file mode 100644 index 000000000000..c0ffd518d246 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get_WithReplicationStatus.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "$expand": "ReplicationStatus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "replicationStatus": { + "aggregatedState": "Completed", + "summary": [ + { + "region": "West US", + "state": "Completed", + "details": "", + "progress": 100 + }, + { + "region": "East US", + "state": "Completed", + "details": "", + "progress": 100 + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get_WithSnapshotsAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get_WithSnapshotsAsSource.json new file mode 100644 index 000000000000..c36b0942caad --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get_WithSnapshotsAsSource.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{snapshotName}" + }, + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{diskSnapshotName}" + }, + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get_WithVhdAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get_WithVhdAsSource.json new file mode 100644 index 000000000000..74a7a43a5c8a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Get_WithVhdAsSource.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_ListByGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_ListByGalleryImage.json new file mode 100644 index 000000000000..914732f61434 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_ListByGalleryImage.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images/myGalleryImageName/versions?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/images/myGalleryImageName/versions/myGalleryImageVersionName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Update.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Update.json new file mode 100644 index 000000000000..7f150ab9f7cb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Update.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1 + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Update_WithoutSourceId.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Update_WithoutSourceId.json new file mode 100644 index 000000000000..1c571b548fac --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImageVersion_Update_WithoutSourceId.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1 + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ] + }, + "storageProfile": {} + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Create.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Create.json new file mode 100644 index 000000000000..153030733873 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Create.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImage": { + "location": "West US", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Delete.json new file mode 100644 index 000000000000..e61a864afcb0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Delete.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/CentralIndia/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-10-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/CentralIndia/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-10-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/CentralIndia/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-10-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/CentralIndia/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-10-01" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/CentralIndia/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-10-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/CentralIndia/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-10-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Get.json new file mode 100644 index 000000000000..532d2145474a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_ListByGallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_ListByGallery.json new file mode 100644 index 000000000000..c6eb6d567b50 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_ListByGallery.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryImageName" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/images/myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Update.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Update.json new file mode 100644 index 000000000000..383c330739bf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/GalleryImage_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImage": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_AddToSharingProfile.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_AddToSharingProfile.json new file mode 100644 index 000000000000..6b99647d3822 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_AddToSharingProfile.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "sharingUpdate": { + "operationType": "Add", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "operationType": "Add", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/share?api-version=2023-07-03" + }, + "body": { + "operationType": "Add", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Create.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Create.json new file mode 100644 index 000000000000..7b3c00f50838 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Create.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "gallery": { + "location": "West US", + "properties": { + "description": "This is the gallery description." + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Create_SoftDeletionEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Create_SoftDeletionEnabled.json new file mode 100644 index 000000000000..6f68e4583996 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Create_SoftDeletionEnabled.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "gallery": { + "location": "West US", + "properties": { + "description": "This is the gallery description.", + "softDeletePolicy": { + "isSoftDeleteEnabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "softDeletePolicy": { + "isSoftDeleteEnabled": true + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Creating", + "softDeletePolicy": { + "isSoftDeleteEnabled": true + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "softDeletePolicy": { + "isSoftDeleteEnabled": true + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Create_WithSharingProfile.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Create_WithSharingProfile.json new file mode 100644 index 000000000000..d2703d34e8f8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Create_WithSharingProfile.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "gallery": { + "location": "West US", + "properties": { + "description": "This is the gallery description.", + "sharingProfile": { + "permissions": "Groups" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "sharingProfile": { + "permissions": "Groups" + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Creating", + "sharingProfile": { + "permissions": "Groups" + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "sharingProfile": { + "permissions": "Groups" + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Delete.json new file mode 100644 index 000000000000..df9ea370926b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Delete.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2018-06-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2018-06-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2018-06-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2018-06-01" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2018-06-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2018-06-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_EnableCommunityGallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_EnableCommunityGallery.json new file mode 100644 index 000000000000..b233ce674e58 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_EnableCommunityGallery.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "sharingUpdate": { + "operationType": "EnableCommunity" + } + }, + "responses": { + "200": { + "body": { + "operationType": "EnableCommunity" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/share?api-version=2023-07-03" + }, + "body": { + "operationType": "EnableCommunity" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Get.json new file mode 100644 index 000000000000..d75a803dac23 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Get_WithExpandSharingProfileGroups.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Get_WithExpandSharingProfileGroups.json new file mode 100644 index 000000000000..0a74eae726d0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Get_WithExpandSharingProfileGroups.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "$expand": "SharingProfile/Groups" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "sharingProfile": { + "permissions": "Groups", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Get_WithSelectPermissions.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Get_WithSelectPermissions.json new file mode 100644 index 000000000000..a699a355ec80 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Get_WithSelectPermissions.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "$select": "Permissions" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "sharingProfile": { + "permissions": "Groups", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_ListByResourceGroup.json new file mode 100644 index 000000000000..82ce34aae755 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_ListByResourceGroup.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_ListBySubscription.json new file mode 100644 index 000000000000..a8e4efcd6bea --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_ListBySubscription.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2023-07-03" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_ResetSharingProfile.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_ResetSharingProfile.json new file mode 100644 index 000000000000..99ba1492eb70 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_ResetSharingProfile.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "sharingUpdate": { + "operationType": "Reset" + } + }, + "responses": { + "200": { + "body": { + "operationType": "Reset" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/share?api-version=2023-07-03" + }, + "body": { + "operationType": "Reset" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Update.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Update.json new file mode 100644 index 000000000000..f3d507f7d8f8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/galleryExamples/Gallery_Update.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-07-03", + "galleryName": "myGalleryName", + "gallery": { + "properties": { + "description": "This is the gallery description." + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json new file mode 100644 index 000000000000..700c50a428ed --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2023-07-03", + "galleryUniqueName": "galleryUniqueName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "myGalleryImageVersionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "publishedDate": "2018-03-20T09:12:28Z", + "endOfLifeDate": "2022-03-20T09:12:28Z", + "excludeFromLatest": false, + "storageProfile": { + "osDiskImage": { + "diskSizeGB": 29, + "hostCaching": "None" + } + }, + "artifactTags": { + "ShareTag-Official1PGallery": "Official1PGallery" + } + }, + "location": "myLocation", + "name": "myGalleryImageVersionName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName/Versions/myGalleryImageVersionName" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImageVersions_List.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImageVersions_List.json new file mode 100644 index 000000000000..3ad2201f02ec --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImageVersions_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2023-07-03", + "galleryUniqueName": "galleryUniqueName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "publishedDate": "2018-03-20T09:12:28Z", + "endOfLifeDate": "2022-03-20T09:12:28Z", + "excludeFromLatest": false, + "storageProfile": { + "osDiskImage": { + "diskSizeGB": 29, + "hostCaching": "None" + } + }, + "artifactTags": { + "ShareTag-Official1PGallery": "Official1PGallery" + } + }, + "location": "myLocation", + "name": "myGalleryImageVersionName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName/Versions/myGalleryImageVersionName" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscription-Id}/providers/Microsoft.Compute/sharedGalleries/galleryUniqueName/images/myGalleryImageName/versions?$skiptoken={token}/Subscriptions/{subscription-Id}/galleries/galleryUniqueName/images/myGalleryImageName/versions/myGalleryImageVersionName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImage_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImage_Get.json new file mode 100644 index 000000000000..49b11046bfcb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImage_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2023-07-03", + "galleryUniqueName": "galleryUniqueName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "eula": "https://www.microsoft.com/en-us/", + "artifactTags": { + "ShareTag-Official1PGallery": "Official1PGallery" + } + }, + "location": "myLocation", + "name": "myGalleryImageName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImages_List.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImages_List.json new file mode 100644 index 000000000000..e9648dd8a599 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImages_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2023-07-03", + "galleryUniqueName": "galleryUniqueName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "artifactTags": { + "ShareTag-Official1PGallery": "Official1PGallery" + } + }, + "location": "myLocation", + "name": "myGalleryImageName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscription-Id}/providers/Microsoft.Compute/sharedGalleries/galleryUniqueName/images?$skiptoken={token}/Subscriptions/{subscription-Id}/galleries/galleryUniqueName/images/myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGallery_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGallery_Get.json new file mode 100644 index 000000000000..2641bcdf2a24 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGallery_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2023-07-03", + "galleryUniqueName": "galleryUniqueName" + }, + "responses": { + "200": { + "body": { + "location": "myLocation", + "name": "myGalleryName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName" + }, + "properties": { + "artifactTags": { + "ShareTag-Official1PGallery": "Official1PGallery" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGallery_List.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGallery_List.json new file mode 100644 index 000000000000..c5691345390c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGallery_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2023-07-03" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "myLocation", + "name": "galleryUniqueName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName" + }, + "properties": { + "artifactTags": { + "ShareTag-Official1PGallery": "Official1PGallery" + } + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/sharedGalleries?$skiptoken={token}/Subscriptions/{subscriptionId}/galleries/galleryUniqueName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/gallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/gallery.json new file mode 100644 index 000000000000..25a2329bef7a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/gallery.json @@ -0,0 +1,3286 @@ +{ + "swagger": "2.0", + "info": { + "title": "SharedImageGalleryServiceClient", + "description": "Shared Image Gallery Service Client.", + "version": "2023-07-03" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}": { + "put": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_CreateOrUpdate", + "description": "Create or update a Shared Image Gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "gallery", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Gallery" + }, + "description": "Parameters supplied to the create or update Shared Image Gallery operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery.": { + "$ref": "./examples/galleryExamples/Gallery_Create.json" + }, + "Create or update a simple gallery with sharing profile.": { + "$ref": "./examples/galleryExamples/Gallery_Create_WithSharingProfile.json" + }, + "Create or update a simple gallery with soft deletion enabled.": { + "$ref": "./examples/galleryExamples/Gallery_Create_SoftDeletionEnabled.json" + }, + "Create a community gallery.": { + "$ref": "./examples/galleryExamples/CommunityGallery_Create.json" + } + } + }, + "patch": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_Update", + "description": "Update a Shared Image Gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "gallery", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryUpdate" + }, + "description": "Parameters supplied to the update Shared Image Gallery operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery.": { + "$ref": "./examples/galleryExamples/Gallery_Update.json" + } + } + }, + "get": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_Get", + "description": "Retrieves information about a Shared Image Gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The select expression to apply on the operation.", + "enum": [ + "Permissions" + ], + "x-ms-enum": { + "name": "SelectPermissions", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/GalleryODataExpandQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery.": { + "$ref": "./examples/galleryExamples/Gallery_Get.json" + }, + "Get a gallery with select permissions.": { + "$ref": "./examples/galleryExamples/Gallery_Get_WithSelectPermissions.json" + }, + "Get a gallery with expand sharingProfile groups.": { + "$ref": "./examples/galleryExamples/Gallery_Get_WithExpandSharingProfileGroups.json" + }, + "Get a community gallery.": { + "$ref": "./examples/galleryExamples/CommunityGallery_Get.json" + } + } + }, + "delete": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_Delete", + "description": "Delete a Shared Image Gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery to be deleted." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery.": { + "$ref": "./examples/galleryExamples/Gallery_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}": { + "put": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_CreateOrUpdate", + "description": "Create or update a gallery image definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition is to be created." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImage", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImage" + }, + "description": "Parameters supplied to the create or update gallery image operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery image.": { + "$ref": "./examples/galleryExamples/GalleryImage_Create.json" + } + } + }, + "patch": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_Update", + "description": "Update a gallery image definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition is to be updated." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImage", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageUpdate" + }, + "description": "Parameters supplied to the update gallery image operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery image.": { + "$ref": "./examples/galleryExamples/GalleryImage_Update.json" + } + } + }, + "get": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_Get", + "description": "Retrieves information about a gallery image definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery from which the Image Definitions are to be retrieved." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition to be retrieved." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery image.": { + "$ref": "./examples/galleryExamples/GalleryImage_Get.json" + } + } + }, + "delete": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_Delete", + "description": "Delete a gallery image.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition is to be deleted." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition to be deleted." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery image.": { + "$ref": "./examples/galleryExamples/GalleryImage_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}": { + "put": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_CreateOrUpdate", + "description": "Create or update a gallery image version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition in which the Image Version is to be created." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImageVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + }, + "description": "Parameters supplied to the create or update gallery image version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple Gallery Image Version using managed image as source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create.json" + }, + "Create or update a simple Gallery Image Version using snapshots as a source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json" + }, + "Create or update a simple Gallery Image Version using VM as source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithVmAsSource.json" + }, + "Create or update a simple Gallery Image Version using shared image as source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithImageVersionAsSource.json" + }, + "Create or update a simple Gallery Image Version using community gallery image as source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithCommunityImageVersionAsSource.json" + }, + "Create or update a simple Gallery Image Version using mix of disks and snapshots as a source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json" + }, + "Create or update a simple Gallery Image Version using vhd as a source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithVHD.json" + }, + "Create or update a simple Gallery Image Version using shallow replication mode.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithShallowReplicationMode.json" + }, + "Create or update a simple gallery image version with target extended locations specified.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithTargetExtendedLocations.json" + }, + "Create or update a simple Gallery Image Version using vhd as a source with custom UEFI keys.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithVHD_UefiSettings.json" + } + } + }, + "patch": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_Update", + "description": "Update a gallery image version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition in which the Image Version is to be updated." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImageVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageVersionUpdate" + }, + "description": "Parameters supplied to the update gallery image version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple Gallery Image Version (Managed Image as source).": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Update.json" + }, + "Update a simple Gallery Image Version without source id.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Update_WithoutSourceId.json" + } + } + }, + "get": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_Get", + "description": "Retrieves information about a gallery image version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition in which the Image Version resides." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be retrieved." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "ReplicationStatus", + "UefiSettings" + ], + "x-ms-enum": { + "name": "ReplicationStatusTypes", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery image version.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Get.json" + }, + "Get a gallery image version with replication status.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Get_WithReplicationStatus.json" + }, + "Get a gallery image version with snapshots as a source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Get_WithSnapshotsAsSource.json" + }, + "Get a gallery image version with vhd as a source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Get_WithVhdAsSource.json" + } + } + }, + "delete": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_Delete", + "description": "Delete a gallery image version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition in which the Image Version resides." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be deleted." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery image version.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}": { + "put": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_CreateOrUpdate", + "description": "Create or update a gallery Application Definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition is to be created." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplication", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplication" + }, + "description": "Parameters supplied to the create or update gallery Application operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery Application.": { + "$ref": "./examples/galleryExamples/GalleryApplication_Create.json" + } + } + }, + "patch": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_Update", + "description": "Update a gallery Application Definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition is to be updated." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplication", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplicationUpdate" + }, + "description": "Parameters supplied to the update gallery Application operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery Application.": { + "$ref": "./examples/galleryExamples/GalleryApplication_Update.json" + } + } + }, + "get": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_Get", + "description": "Retrieves information about a gallery Application Definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery from which the Application Definitions are to be retrieved." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be retrieved." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery Application.": { + "$ref": "./examples/galleryExamples/GalleryApplication_Get.json" + } + } + }, + "delete": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_Delete", + "description": "Delete a gallery Application.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition is to be deleted." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be deleted." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery Application.": { + "$ref": "./examples/galleryExamples/GalleryApplication_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}": { + "put": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_CreateOrUpdate", + "description": "Create or update a gallery Application Version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version is to be created." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplicationVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + }, + "description": "Parameters supplied to the create or update gallery Application Version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery Application Version.": { + "$ref": "./examples/galleryExamples/GalleryApplicationVersion_Create.json" + } + } + }, + "patch": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_Update", + "description": "Update a gallery Application Version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version is to be updated." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplicationVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplicationVersionUpdate" + }, + "description": "Parameters supplied to the update gallery Application Version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery Application Version.": { + "$ref": "./examples/galleryExamples/GalleryApplicationVersion_Update.json" + } + } + }, + "get": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_Get", + "description": "Retrieves information about a gallery Application Version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version resides." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be retrieved." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "ReplicationStatus", + "UefiSettings" + ], + "x-ms-enum": { + "name": "ReplicationStatusTypes", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery Application Version.": { + "$ref": "./examples/galleryExamples/GalleryApplicationVersion_Get.json" + }, + "Get a gallery Application Version with replication status.": { + "$ref": "./examples/galleryExamples/GalleryApplicationVersion_Get_WithReplicationStatus.json" + } + } + }, + "delete": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_Delete", + "description": "Delete a gallery Application Version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version resides." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be deleted." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery Application Version.": { + "$ref": "./examples/galleryExamples/GalleryApplicationVersion_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries": { + "get": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_ListByResourceGroup", + "description": "List galleries under a resource group.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List galleries in a resource group.": { + "$ref": "./examples/galleryExamples/Gallery_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries": { + "get": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_List", + "description": "List galleries under a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List galleries in a subscription.": { + "$ref": "./examples/galleryExamples/Gallery_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images": { + "get": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_ListByGallery", + "description": "List gallery image definitions in a gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery from which Image Definitions are to be listed." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery images in a gallery.": { + "$ref": "./examples/galleryExamples/GalleryImage_ListByGallery.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions": { + "get": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_ListByGalleryImage", + "description": "List gallery image versions in a gallery image definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery Image Definition from which the Image Versions are to be listed." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery image versions in a gallery image definition.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_ListByGalleryImage.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications": { + "get": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_ListByGallery", + "description": "List gallery Application Definitions in a gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery from which Application Definitions are to be listed." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery Applications in a gallery.": { + "$ref": "./examples/galleryExamples/GalleryApplication_ListByGallery.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions": { + "get": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_ListByGalleryApplication", + "description": "List gallery Application Versions in a gallery Application Definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery Application Definition from which the Application Versions are to be listed." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery Application Versions in a gallery Application Definition.": { + "$ref": "./examples/galleryExamples/GalleryApplicationVersion_ListByGalleryApplication.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/share": { + "post": { + "tags": [ + "GallerySharingUpdate" + ], + "operationId": "GallerySharingProfile_Update", + "description": "Update sharing profile of a gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "sharingUpdate", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SharingUpdate" + }, + "description": "Parameters supplied to the update gallery sharing profile." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharingUpdate" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/SharingUpdate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Add sharing id to the sharing profile of a gallery.": { + "$ref": "./examples/galleryExamples/Gallery_AddToSharingProfile.json" + }, + "share a gallery to community.": { + "$ref": "./examples/galleryExamples/Gallery_EnableCommunityGallery.json" + }, + "reset sharing profile of a gallery.": { + "$ref": "./examples/galleryExamples/Gallery_ResetSharingProfile.json" + } + } + } + } + }, + "definitions": { + "Gallery": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the Shared Image Gallery that you want to create or update." + }, + "GalleryUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the Shared Image Gallery that you want to update." + }, + "GalleryProperties": { + "properties": { + "description": { + "type": "string", + "description": "The description of this Shared Image Gallery resource. This property is updatable." + }, + "identifier": { + "$ref": "#/definitions/GalleryIdentifier" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/GalleryProvisioningState" + }, + "sharingProfile": { + "$ref": "#/definitions/SharingProfile" + }, + "softDeletePolicy": { + "$ref": "#/definitions/SoftDeletePolicy" + }, + "sharingStatus": { + "readOnly": true, + "$ref": "#/definitions/SharingStatus" + } + }, + "description": "Describes the properties of a Shared Image Gallery." + }, + "GalleryIdentifier": { + "properties": { + "uniqueName": { + "readOnly": true, + "type": "string", + "description": "The unique name of the Shared Image Gallery. This name is generated automatically by Azure." + } + }, + "description": "Describes the gallery unique name." + }, + "SharingProfile": { + "description": "Profile for gallery sharing to subscription or tenant", + "properties": { + "permissions": { + "type": "string", + "description": "This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.**", + "enum": [ + "Private", + "Groups", + "Community" + ], + "x-ms-enum": { + "name": "GallerySharingPermissionTypes", + "modelAsString": true + } + }, + "groups": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SharingProfileGroup" + }, + "x-ms-identifiers": [], + "description": "A list of sharing profile groups." + }, + "communityGalleryInfo": { + "$ref": "#/definitions/CommunityGalleryInfo", + "description": "Information of community gallery if current gallery is shared to community." + } + } + }, + "SharingProfileGroup": { + "description": "Group of the gallery sharing profile", + "properties": { + "type": { + "type": "string", + "description": "This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.**", + "enum": [ + "Subscriptions", + "AADTenants" + ], + "x-ms-enum": { + "name": "SharingProfileGroupTypes", + "modelAsString": true + } + }, + "ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of subscription/tenant ids the gallery is aimed to be shared to." + } + } + }, + "CommunityGalleryInfo": { + "type": "object", + "description": "Information of community gallery if current gallery is shared to community", + "properties": { + "publisherUri": { + "type": "string", + "description": "The link to the publisher website. Visible to all users." + }, + "publisherContact": { + "type": "string", + "description": "Community gallery publisher support email. The email address of the publisher. Visible to all users." + }, + "eula": { + "type": "string", + "description": "End-user license agreement for community gallery image." + }, + "publicNamePrefix": { + "type": "string", + "description": "The prefix of the gallery name that will be displayed publicly. Visible to all users." + }, + "communityGalleryEnabled": { + "readOnly": true, + "type": "boolean", + "description": "Contains info about whether community gallery sharing is enabled." + }, + "publicNames": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "Community gallery public name list." + } + } + }, + "SoftDeletePolicy": { + "type": "object", + "properties": { + "isSoftDeleteEnabled": { + "type": "boolean", + "description": "Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time." + } + }, + "description": "Contains information about the soft deletion policy of the gallery." + }, + "SharingStatus": { + "type": "object", + "properties": { + "aggregatedState": { + "type": "string", + "$ref": "#/definitions/SharingState", + "description": "Aggregated sharing state of current gallery." + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/definitions/RegionalSharingStatus" + }, + "x-ms-identifiers": [ + "region" + ], + "description": "Summary of all regional sharing status." + } + }, + "description": "Sharing status of current gallery." + }, + "SharingState": { + "readOnly": true, + "type": "string", + "title": "The sharing state of the gallery.", + "description": "The sharing state of the gallery, which only appears in the response.", + "enum": [ + "Succeeded", + "InProgress", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "SharingState", + "modelAsString": true + } + }, + "RegionalSharingStatus": { + "type": "object", + "description": "Gallery regional sharing status", + "properties": { + "region": { + "type": "string", + "description": "Region name" + }, + "state": { + "type": "string", + "$ref": "#/definitions/SharingState", + "description": "Gallery sharing state in current region" + }, + "details": { + "type": "string", + "description": "Details of gallery regional sharing failure." + } + } + }, + "GalleryApplication": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery Application Definition that you want to create or update." + }, + "GalleryApplicationUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the gallery Application Definition that you want to update." + }, + "GalleryApplicationProperties": { + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery Application Definition resource. This property is updatable." + }, + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery Application Definition." + }, + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "supportedOSType": { + "type": "string", + "description": "This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "customActions": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryApplicationCustomAction" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application." + } + }, + "required": [ + "supportedOSType" + ], + "description": "Describes the properties of a gallery Application Definition." + }, + "GalleryApplicationVersion": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationVersionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery Application Version that you want to create or update." + }, + "GalleryApplicationVersionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the gallery Application Version that you want to update." + }, + "GalleryApplicationVersionProperties": { + "properties": { + "publishingProfile": { + "$ref": "#/definitions/GalleryApplicationVersionPublishingProfile" + }, + "safetyProfile": { + "$ref": "#/definitions/GalleryApplicationVersionSafetyProfile" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/GalleryProvisioningState" + }, + "replicationStatus": { + "readOnly": true, + "$ref": "#/definitions/ReplicationStatus" + } + }, + "required": [ + "publishingProfile" + ], + "description": "Describes the properties of a gallery image version." + }, + "GalleryApplicationVersionPublishingProfile": { + "properties": { + "source": { + "$ref": "#/definitions/UserArtifactSource" + }, + "manageActions": { + "$ref": "#/definitions/UserArtifactManage" + }, + "settings": { + "$ref": "#/definitions/UserArtifactSettings" + }, + "advancedSettings": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only." + }, + "enableHealthCheck": { + "type": "boolean", + "description": "Optional. Whether or not this application reports health." + }, + "customActions": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryApplicationCustomAction" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of custom actions that can be performed with this Gallery Application Version." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactPublishingProfileBase" + } + ], + "required": [ + "source" + ], + "description": "The publishing profile of a gallery image version." + }, + "GalleryApplicationVersionSafetyProfile": { + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactSafetyProfileBase" + } + ], + "description": "The safety profile of the Gallery Application Version." + }, + "GalleryApplicationCustomAction": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the custom action. Must be unique within the Gallery Application Version." + }, + "script": { + "type": "string", + "description": "The script to run when executing this custom action." + }, + "description": { + "type": "string", + "description": "Description to help the users understand what this custom action does." + }, + "parameters": { + "type": "array", + "description": "The parameters that this custom action uses", + "items": { + "$ref": "#/definitions/GalleryApplicationCustomActionParameter" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "required": [ + "name", + "script" + ], + "description": "A custom action that can be performed with a Gallery Application Version." + }, + "GalleryApplicationCustomActionParameter": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the custom action. Must be unique within the Gallery Application Version." + }, + "required": { + "type": "boolean", + "description": "Indicates whether this parameter must be passed when running the custom action." + }, + "type": { + "type": "string", + "description": "Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob", + "enum": [ + "String", + "ConfigurationDataBlob", + "LogOutputBlob" + ], + "x-ms-enum": { + "name": "GalleryApplicationCustomActionParameterType", + "modelAsString": false + } + }, + "defaultValue": { + "type": "string", + "description": "The default value of the parameter. Only applies to string types" + }, + "description": { + "type": "string", + "description": "A description to help users understand what this parameter means" + } + }, + "required": [ + "name" + ], + "description": "The definition of a parameter that can be passed to a custom action of a Gallery Application Version." + }, + "UserArtifactSource": { + "properties": { + "mediaLink": { + "type": "string", + "description": "Required. The mediaLink of the artifact, must be a readable storage page blob." + }, + "defaultConfigurationLink": { + "type": "string", + "description": "Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob." + } + }, + "required": [ + "mediaLink" + ], + "description": "The source image from which the Image Version is going to be created." + }, + "UserArtifactManage": { + "properties": { + "install": { + "type": "string", + "description": "Required. The path and arguments to install the gallery application. This is limited to 4096 characters." + }, + "remove": { + "type": "string", + "description": "Required. The path and arguments to remove the gallery application. This is limited to 4096 characters." + }, + "update": { + "type": "string", + "description": "Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters." + } + }, + "required": [ + "install", + "remove" + ] + }, + "UserArtifactSettings": { + "type": "object", + "properties": { + "packageFileName": { + "type": "string", + "description": "Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name." + }, + "configFileName": { + "type": "string", + "description": "Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with \"_config\"." + } + }, + "description": "Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set." + }, + "GalleryImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery image definition that you want to create or update." + }, + "GalleryImageUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the gallery image definition that you want to update." + }, + "GalleryImageProperties": { + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery image definition resource. This property is updatable." + }, + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery image definition." + }, + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." + }, + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "identifier": { + "$ref": "./galleryRPCommon.json#/definitions/GalleryImageIdentifier" + }, + "recommended": { + "$ref": "./galleryRPCommon.json#/definitions/RecommendedMachineConfiguration" + }, + "disallowed": { + "$ref": "./galleryRPCommon.json#/definitions/Disallowed" + }, + "purchasePlan": { + "$ref": "./galleryRPCommon.json#/definitions/ImagePurchasePlan" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/GalleryProvisioningState" + }, + "features": { + "type": "array", + "items": { + "$ref": "./galleryRPCommon.json#/definitions/GalleryImageFeature" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of gallery image features." + }, + "architecture": { + "$ref": "./galleryRPCommon.json#/definitions/Architecture" + } + }, + "required": [ + "osType", + "osState", + "identifier" + ], + "description": "Describes the properties of a gallery image definition." + }, + "GalleryImageVersion": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "GalleryImageVersionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the gallery image version that you want to update." + }, + "GalleryImageVersionProperties": { + "properties": { + "publishingProfile": { + "$ref": "#/definitions/GalleryImageVersionPublishingProfile" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/GalleryProvisioningState" + }, + "storageProfile": { + "$ref": "#/definitions/GalleryImageVersionStorageProfile" + }, + "safetyProfile": { + "$ref": "#/definitions/GalleryImageVersionSafetyProfile" + }, + "replicationStatus": { + "readOnly": true, + "$ref": "#/definitions/ReplicationStatus" + }, + "securityProfile": { + "$ref": "#/definitions/ImageVersionSecurityProfile" + } + }, + "required": [ + "storageProfile" + ], + "description": "Describes the properties of a gallery image version." + }, + "GalleryArtifactPublishingProfileBase": { + "properties": { + "targetRegions": { + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." + }, + "replicaCount": { + "type": "integer", + "format": "int32", + "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." + }, + "excludeFromLatest": { + "type": "boolean", + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "publishedDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The timestamp for when the gallery image version is published." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable." + }, + "storageAccountType": { + "type": "string", + "description": "Specifies the storage account type to be used to store the image. This property is not updatable.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true + } + }, + "replicationMode": { + "type": "string", + "description": "Optional parameter which specifies the mode to be used for replication. This property is not updatable.", + "enum": [ + "Full", + "Shallow" + ], + "x-ms-enum": { + "name": "ReplicationMode", + "modelAsString": true + } + }, + "targetExtendedLocations": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryTargetExtendedLocation" + }, + "x-ms-identifiers": [ + "name", + "extendedLocation/name" + ], + "description": "The target extended locations where the Image Version is going to be replicated to. This property is updatable." + } + }, + "description": "Describes the basic gallery artifact publishing profile." + }, + "TargetRegion": { + "properties": { + "name": { + "type": "string", + "description": "The name of the region." + }, + "regionalReplicaCount": { + "type": "integer", + "format": "int32", + "description": "The number of replicas of the Image Version to be created per region. This property is updatable." + }, + "storageAccountType": { + "type": "string", + "description": "Specifies the storage account type to be used to store the image. This property is not updatable.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true + } + }, + "encryption": { + "$ref": "#/definitions/EncryptionImages" + }, + "excludeFromLatest": { + "type": "boolean", + "description": "Contains the flag setting to hide an image when users specify version='latest'" + } + }, + "required": [ + "name" + ], + "description": "Describes the target region information." + }, + "GalleryTargetExtendedLocation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the region." + }, + "extendedLocation": { + "$ref": "#/definitions/GalleryExtendedLocation" + }, + "extendedLocationReplicaCount": { + "type": "integer", + "format": "int32", + "description": "The number of replicas of the Image Version to be created per extended location. This property is updatable." + }, + "storageAccountType": { + "type": "string", + "description": "Specifies the storage account type to be used to store the image. This property is not updatable.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "StandardSSD_LRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "EdgeZoneStorageAccountType", + "modelAsString": true + } + }, + "encryption": { + "$ref": "#/definitions/EncryptionImages" + } + } + }, + "GalleryExtendedLocation": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "$ref": "#/definitions/GalleryExtendedLocationType" + } + }, + "description": "The name of the extended location." + }, + "GalleryExtendedLocationType": { + "type": "string", + "enum": [ + "EdgeZone", + "Unknown" + ], + "x-ms-enum": { + "name": "GalleryExtendedLocationType", + "modelAsString": true + }, + "description": "It is type of the extended location." + }, + "EncryptionImages": { + "properties": { + "osDiskImage": { + "$ref": "#/definitions/OSDiskImageEncryption" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImageEncryption" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "A list of encryption specifications for data disk images." + } + }, + "description": "Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact." + }, + "OSDiskImageEncryption": { + "type": "object", + "properties": { + "securityProfile": { + "type": "object", + "$ref": "#/definitions/OSDiskImageSecurityProfile", + "description": "This property specifies the security profile of an OS disk image." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DiskImageEncryption" + } + ], + "description": "Contains encryption settings for an OS disk image." + }, + "OSDiskImageSecurityProfile": { + "type": "object", + "properties": { + "confidentialVMEncryptionType": { + "type": "string", + "description": "confidential VM encryption types", + "enum": [ + "EncryptedVMGuestStateOnlyWithPmk", + "EncryptedWithPmk", + "EncryptedWithCmk", + "NonPersistedTPM" + ], + "x-ms-enum": { + "name": "ConfidentialVMEncryptionType", + "modelAsString": true + } + }, + "secureVMDiskEncryptionSetId": { + "type": "string", + "description": "secure VM disk encryption set id" + } + }, + "description": "Contains security profile for an OS disk image." + }, + "DataDiskImageEncryption": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DiskImageEncryption" + } + ], + "required": [ + "lun" + ], + "description": "Contains encryption settings for a data disk image." + }, + "DiskImageEncryption": { + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "A relative URI containing the resource ID of the disk encryption set." + } + }, + "description": "This is the disk image encryption base class." + }, + "GalleryArtifactSource": { + "properties": { + "managedImage": { + "$ref": "#/definitions/ManagedArtifact" + } + }, + "required": [ + "managedImage" + ], + "description": "The source image from which the Image Version is going to be created." + }, + "ManagedArtifact": { + "properties": { + "id": { + "type": "string", + "description": "The managed artifact id." + } + }, + "required": [ + "id" + ], + "description": "The managed artifact." + }, + "GalleryImageVersionPublishingProfile": { + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactPublishingProfileBase" + } + ], + "description": "The publishing profile of a gallery image Version." + }, + "GalleryImageVersionStorageProfile": { + "properties": { + "source": { + "$ref": "#/definitions/GalleryArtifactVersionFullSource" + }, + "osDiskImage": { + "$ref": "#/definitions/GalleryOSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryDataDiskImage" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "A list of data disk images." + } + }, + "description": "This is the storage profile of a Gallery Image Version." + }, + "GalleryArtifactVersionFullSource": { + "type": "object", + "properties": { + "communityGalleryImageId": { + "type": "string", + "description": "The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source." + }, + "virtualMachineId": { + "type": "string", + "description": "The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactVersionSource" + } + ], + "description": "The source of the gallery artifact version." + }, + "GalleryArtifactVersionSource": { + "properties": { + "id": { + "type": "string", + "description": "The id of the gallery artifact version source." + } + }, + "description": "The gallery artifact version source." + }, + "GalleryOSDiskImage": { + "allOf": [ + { + "$ref": "#/definitions/GalleryDiskImage" + } + ], + "description": "This is the OS disk image." + }, + "GalleryDataDiskImage": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryDiskImage" + } + ], + "required": [ + "lun" + ], + "description": "This is the data disk image." + }, + "GalleryDiskImage": { + "properties": { + "sizeInGB": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "This property indicates the size of the VHD to be created." + }, + "hostCaching": { + "type": "string", + "description": "The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "HostCaching", + "modelAsString": false + } + }, + "source": { + "$ref": "#/definitions/GalleryDiskImageSource" + } + }, + "description": "This is the disk image base class." + }, + "GalleryDiskImageSource": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The uri of the gallery artifact version source. Currently used to specify vhd/blob source." + }, + "storageAccountId": { + "type": "string", + "description": "The Storage Account Id that contains the vhd blob being used as a source for this artifact version." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactVersionSource" + } + ], + "description": "The source for the disk image." + }, + "GalleryArtifactSafetyProfileBase": { + "type": "object", + "properties": { + "allowDeletionOfReplicatedLocations": { + "type": "boolean", + "description": "Indicates whether or not removing this Gallery Image Version from replicated regions is allowed." + } + }, + "description": "This is the safety profile of the Gallery Artifact Version." + }, + "GalleryImageVersionSafetyProfile": { + "type": "object", + "properties": { + "reportedForPolicyViolation": { + "type": "boolean", + "description": "Indicates whether this image has been reported as violating Microsoft's policies.", + "readOnly": true + }, + "policyViolations": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyViolation" + }, + "x-ms-identifiers": [], + "description": "A list of Policy Violations that have been reported for this Gallery Image Version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactSafetyProfileBase" + } + ], + "description": "This is the safety profile of the Gallery Image Version." + }, + "PolicyViolation": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Describes the nature of the policy violation.", + "enum": [ + "Other", + "ImageFlaggedUnsafe", + "CopyrightValidation", + "IpTheft" + ], + "x-ms-enum": { + "name": "PolicyViolationCategory", + "modelAsString": true + } + }, + "details": { + "type": "string", + "description": "Describes specific details about why this policy violation was reported." + } + }, + "description": "A policy violation reported against a gallery artifact." + }, + "ImageVersionSecurityProfile": { + "type": "object", + "description": "The security profile of a gallery image version", + "properties": { + "uefiSettings": { + "$ref": "#/definitions/GalleryImageVersionUefiSettings" + } + } + }, + "ReplicationStatus": { + "properties": { + "aggregatedState": { + "readOnly": true, + "type": "string", + "description": "This is the aggregated replication status based on all the regional replication status flags.", + "enum": [ + "Unknown", + "InProgress", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "AggregatedReplicationState", + "modelAsString": true + } + }, + "summary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RegionalReplicationStatus" + }, + "x-ms-identifiers": [ + "region" + ], + "description": "This is a summary of replication status for each region." + } + }, + "description": "This is the replication status of the gallery image version." + }, + "RegionalReplicationStatus": { + "properties": { + "region": { + "readOnly": true, + "type": "string", + "description": "The region to which the gallery image version is being replicated to." + }, + "state": { + "readOnly": true, + "type": "string", + "description": "This is the regional replication state.", + "enum": [ + "Unknown", + "Replicating", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "ReplicationState", + "modelAsString": true + } + }, + "details": { + "readOnly": true, + "type": "string", + "description": "The details of the replication status." + }, + "progress": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "It indicates progress of the replication job." + } + }, + "description": "This is the regional replication status." + }, + "GalleryList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Gallery" + }, + "description": "A list of galleries." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries." + } + }, + "required": [ + "value" + ], + "description": "The List Galleries operation response." + }, + "GalleryImageList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryImage" + }, + "description": "A list of Shared Image Gallery images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call ListNext() with this to fetch the next page of gallery image definitions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Images operation response." + }, + "GalleryImageVersionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryImageVersion" + }, + "description": "A list of gallery image versions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of gallery image versions. Call ListNext() with this to fetch the next page of gallery image versions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Image version operation response." + }, + "GalleryApplicationList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryApplication" + }, + "description": "A list of Gallery Applications." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Application Definitions in the Application Gallery. Call ListNext() with this to fetch the next page of gallery Application Definitions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Applications operation response." + }, + "GalleryApplicationVersionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryApplicationVersion" + }, + "description": "A list of gallery Application Versions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of gallery Application Versions. Call ListNext() with this to fetch the next page of gallery Application Versions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Application version operation response." + }, + "UpdateResourceDefinition": { + "description": "The Update Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true + }, + "SharingUpdate": { + "description": "Specifies information about the gallery sharing profile update.", + "properties": { + "operationType": { + "type": "string", + "description": "This property allows you to specify the operation type of gallery sharing update. Possible values are: **Add,** **Remove,** **Reset.**", + "enum": [ + "Add", + "Remove", + "Reset", + "EnableCommunity" + ], + "x-ms-enum": { + "name": "SharingUpdateOperationTypes", + "modelAsString": true + } + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/definitions/SharingProfileGroup" + }, + "x-ms-identifiers": [], + "description": "A list of sharing profile groups." + } + }, + "required": [ + "operationType" + ], + "x-ms-azure-resource": true + }, + "GalleryProvisioningState": { + "readOnly": true, + "type": "string", + "title": "The current state of the gallery or gallery artifact.", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Migrating" + ], + "x-ms-enum": { + "name": "GalleryProvisioningState", + "modelAsString": true + } + }, + "LatestGalleryImageVersion": { + "type": "object", + "readOnly": true, + "description": "The gallery image version with latest version in a particular region.", + "properties": { + "latestVersionName": { + "type": "string", + "description": "The name of the latest version in the region." + }, + "location": { + "type": "string", + "description": "region of the Gallery Image Version." + } + } + }, + "GalleryImageVersionUefiSettings": { + "type": "object", + "description": "Contains UEFI settings for the image version.", + "properties": { + "signatureTemplateNames": { + "type": "array", + "description": "The name of the template(s) that contains default UEFI key signatures that will be added to the image.", + "items": { + "$ref": "#/definitions/UefiSignatureTemplateName" + }, + "x-ms-identifiers": [] + }, + "additionalSignatures": { + "$ref": "#/definitions/UefiKeySignatures" + } + } + }, + "UefiSignatureTemplateName": { + "type": "string", + "description": "The name of the signature template that contains default UEFI keys.", + "enum": [ + "NoSignatureTemplate", + "MicrosoftUefiCertificateAuthorityTemplate", + "MicrosoftWindowsTemplate" + ], + "x-ms-enum": { + "name": "UefiSignatureTemplateName", + "modelAsString": true + } + }, + "UefiKeySignatures": { + "type": "object", + "description": "Additional UEFI key signatures that will be added to the image in addition to the signature templates", + "properties": { + "pk": { + "description": "The Platform Key of this image version.", + "$ref": "#/definitions/UefiKey" + }, + "kek": { + "type": "array", + "description": "The Key Encryption Keys of this image version.", + "items": { + "$ref": "#/definitions/UefiKey" + }, + "x-ms-identifiers": [] + }, + "db": { + "type": "array", + "description": "The database of UEFI keys for this image version.", + "items": { + "$ref": "#/definitions/UefiKey" + }, + "x-ms-identifiers": [] + }, + "dbx": { + "type": "array", + "description": "The database of revoked UEFI keys for this image version.", + "items": { + "$ref": "#/definitions/UefiKey" + }, + "x-ms-identifiers": [] + } + } + }, + "UefiKey": { + "type": "object", + "description": "A UEFI key signature.", + "properties": { + "type": { + "type": "string", + "description": "The type of key signature.", + "enum": [ + "sha256", + "x509" + ], + "x-ms-enum": { + "name": "UefiKeyType", + "modelAsString": true + } + }, + "value": { + "type": "array", + "description": "The value of the key signature.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the resource group." + }, + "GalleryODataExpandQueryParameter": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand query option to apply on the operation.", + "enum": [ + "SharingProfile/Groups" + ], + "x-ms-enum": { + "name": "GalleryExpandParams", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/galleryRPCommon.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/galleryRPCommon.json new file mode 100644 index 000000000000..1fc693498d71 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/galleryRPCommon.json @@ -0,0 +1,222 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-07-03" + }, + "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": { + "GalleryImageFeature": { + "properties": { + "name": { + "type": "string", + "description": "The name of the gallery image feature." + }, + "value": { + "type": "string", + "description": "The value of the gallery image feature." + } + }, + "description": "A feature for gallery image." + }, + "GalleryImageIdentifier": { + "properties": { + "publisher": { + "type": "string", + "description": "The name of the gallery image definition publisher." + }, + "offer": { + "type": "string", + "description": "The name of the gallery image definition offer." + }, + "sku": { + "type": "string", + "description": "The name of the gallery image definition SKU." + } + }, + "required": [ + "publisher", + "offer", + "sku" + ], + "description": "This is the gallery image definition identifier." + }, + "RecommendedMachineConfiguration": { + "properties": { + "vCPUs": { + "$ref": "#/definitions/ResourceRange" + }, + "memory": { + "$ref": "#/definitions/ResourceRange" + } + }, + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." + }, + "ResourceRange": { + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum number of the resource." + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum number of the resource." + } + }, + "description": "Describes the resource range." + }, + "Disallowed": { + "properties": { + "diskTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of disk types." + } + }, + "description": "Describes the disallowed disk types." + }, + "ImagePurchasePlan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "The product ID." + } + }, + "description": "Describes the gallery image definition purchase plan. This is used by marketplace images." + }, + "SharedGalleryImageVersionStorageProfile": { + "type": "object", + "properties": { + "osDiskImage": { + "$ref": "#/definitions/SharedGalleryOSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedGalleryDataDiskImage" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "A list of data disk images." + } + }, + "description": "This is the storage profile of a Gallery Image Version." + }, + "SharedGalleryOSDiskImage": { + "allOf": [ + { + "$ref": "#/definitions/SharedGalleryDiskImage" + } + ], + "description": "This is the OS disk image." + }, + "SharedGalleryDataDiskImage": { + "type": "object", + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SharedGalleryDiskImage" + } + ], + "required": [ + "lun" + ], + "description": "This is the data disk image." + }, + "SharedGalleryDiskImage": { + "type": "object", + "properties": { + "diskSizeGB": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "This property indicates the size of the VHD to be created." + }, + "hostCaching": { + "type": "string", + "description": "The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "SharedGalleryHostCaching", + "modelAsString": true + } + } + }, + "description": "This is the disk image base class." + }, + "Architecture": { + "type": "string", + "description": "The architecture of the image. Applicable to OS disks only.", + "enum": [ + "x64", + "Arm64" + ], + "x-ms-enum": { + "name": "Architecture", + "modelAsString": true + } + } + }, + "parameters": { + "LocationNameParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Resource location." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/sharedGallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/sharedGallery.json new file mode 100644 index 000000000000..07249b9649f2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/sharedGallery.json @@ -0,0 +1,660 @@ +{ + "swagger": "2.0", + "info": { + "title": "SharedGalleryServiceClient", + "description": "Shared Gallery Service Client.", + "version": "2023-07-03" + }, + "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.Compute/locations/{location}/sharedGalleries": { + "get": { + "tags": [ + "SharedGalleries" + ], + "operationId": "SharedGalleries_List", + "description": "List shared galleries by subscription id or tenant id.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "sharedTo", + "in": "query", + "required": false, + "type": "string", + "description": "The query parameter to decide what shared galleries to fetch when doing listing operations.", + "enum": [ + "tenant" + ], + "x-ms-enum": { + "name": "SharedToValues", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List shared galleries.": { + "$ref": "./examples/sharedGalleryExamples/SharedGallery_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images": { + "get": { + "tags": [ + "SharedGalleryImages" + ], + "operationId": "SharedGalleryImages_List", + "description": "List shared gallery images by subscription id or tenant id.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "name": "sharedTo", + "in": "query", + "required": false, + "type": "string", + "description": "The query parameter to decide what shared galleries to fetch when doing listing operations.", + "enum": [ + "tenant" + ], + "x-ms-enum": { + "name": "SharedToValues", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryImageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List shared gallery images.": { + "$ref": "./examples/sharedGalleryExamples/SharedGalleryImages_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions": { + "get": { + "tags": [ + "SharedGalleryImageVersions" + ], + "operationId": "SharedGalleryImageVersions_List", + "description": "List shared gallery image versions by subscription id or tenant id.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Gallery Image Definition from which the Image Versions are to be listed." + }, + { + "name": "sharedTo", + "in": "query", + "required": false, + "type": "string", + "description": "The query parameter to decide what shared galleries to fetch when doing listing operations.", + "enum": [ + "tenant" + ], + "x-ms-enum": { + "name": "SharedToValues", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryImageVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List shared gallery image versions.": { + "$ref": "./examples/sharedGalleryExamples/SharedGalleryImageVersions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}": { + "get": { + "tags": [ + "SharedGalleries" + ], + "operationId": "SharedGalleries_Get", + "description": "Get a shared gallery by subscription id or tenant id.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a shared gallery.": { + "$ref": "./examples/sharedGalleryExamples/SharedGallery_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}": { + "get": { + "tags": [ + "SharedGalleryImages" + ], + "operationId": "SharedGalleryImages_Get", + "description": "Get a shared gallery image by subscription id or tenant id.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Gallery Image Definition from which the Image Versions are to be listed." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a shared gallery image.": { + "$ref": "./examples/sharedGalleryExamples/SharedGalleryImage_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions/{galleryImageVersionName}": { + "get": { + "tags": [ + "SharedGalleryImageVersions" + ], + "operationId": "SharedGalleryImageVersions_Get", + "description": "Get a shared gallery image version by subscription id or tenant id.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Gallery Image Definition from which the Image Versions are to be listed." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a shared gallery image version.": { + "$ref": "./examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json" + } + } + } + } + }, + "definitions": { + "PirResource": { + "description": "The Resource model definition.", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + } + } + }, + "PirSharedGalleryResource": { + "properties": { + "identifier": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedGalleryIdentifier" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirResource" + } + ], + "description": "Base information about the shared gallery resource in pir." + }, + "SharedGalleryArtifactTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The artifact tags of a shared gallery resource." + }, + "SharedGalleryIdentifier": { + "properties": { + "uniqueId": { + "type": "string", + "description": "The unique id of this shared gallery." + } + }, + "description": "The identifier information of shared gallery." + }, + "SharedGalleryList": { + "description": "The List Shared Galleries operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedGallery" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of shared galleries." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of shared galleries. Call ListNext() with this to fetch the next page of shared galleries." + } + }, + "required": [ + "value" + ] + }, + "SharedGallery": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedGalleryProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirSharedGalleryResource" + } + ], + "description": "Specifies information about the Shared Gallery that you want to create or update." + }, + "SharedGalleryProperties": { + "type": "object", + "properties": { + "artifactTags": { + "readOnly": true, + "$ref": "#/definitions/SharedGalleryArtifactTags" + } + }, + "description": "Specifies the properties of a shared gallery" + }, + "SharedGalleryImageList": { + "description": "The List Shared Gallery Images operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedGalleryImage" + }, + "x-ms-identifiers": [], + "description": "A list of shared gallery images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of shared gallery images. Call ListNext() with this to fetch the next page of shared gallery images." + } + }, + "required": [ + "value" + ] + }, + "SharedGalleryImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedGalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirSharedGalleryResource" + } + ], + "description": "Specifies information about the gallery image definition that you want to create or update." + }, + "SharedGalleryImageProperties": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "identifier": { + "$ref": "./galleryRPCommon.json#/definitions/GalleryImageIdentifier" + }, + "recommended": { + "$ref": "./galleryRPCommon.json#/definitions/RecommendedMachineConfiguration" + }, + "disallowed": { + "$ref": "./galleryRPCommon.json#/definitions/Disallowed" + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "features": { + "type": "array", + "items": { + "$ref": "./galleryRPCommon.json#/definitions/GalleryImageFeature" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of gallery image features." + }, + "purchasePlan": { + "$ref": "./galleryRPCommon.json#/definitions/ImagePurchasePlan" + }, + "architecture": { + "$ref": "./galleryRPCommon.json#/definitions/Architecture" + }, + "privacyStatementUri": { + "type": "string", + "description": "Privacy statement uri for the current community gallery image." + }, + "eula": { + "type": "string", + "description": "End-user license agreement for the current community gallery image." + }, + "artifactTags": { + "$ref": "#/definitions/SharedGalleryArtifactTags" + } + }, + "required": [ + "osType", + "osState", + "identifier" + ], + "description": "Describes the properties of a gallery image definition." + }, + "SharedGalleryImageVersionList": { + "description": "The List Shared Gallery Image versions operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedGalleryImageVersion" + }, + "x-ms-identifiers": [], + "description": "A list of shared gallery images versions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of shared gallery image versions. Call ListNext() with this to fetch the next page of shared gallery image versions." + } + }, + "required": [ + "value" + ] + }, + "SharedGalleryImageVersion": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedGalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirSharedGalleryResource" + } + ], + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "SharedGalleryImageVersionProperties": { + "properties": { + "publishedDate": { + "type": "string", + "format": "date-time", + "description": "The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "excludeFromLatest": { + "type": "boolean", + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "storageProfile": { + "$ref": "./galleryRPCommon.json#/definitions/SharedGalleryImageVersionStorageProfile", + "description": "Describes the storage profile of the image version." + }, + "artifactTags": { + "$ref": "#/definitions/SharedGalleryArtifactTags" + } + }, + "description": "Describes the properties of a gallery image version." + } + } +} diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index 830ade459cc4..7e947b46e0e8 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -34,7 +34,7 @@ These are the global settings for the Compute API. title: ComputeManagementClient description: Compute Client openapi-type: arm -tag: package-2023-10-02 +tag: package-2023-07-03 directive: - where: @@ -257,6 +257,54 @@ directive: reason: there is no dedicated host naming requirement. It only follows ARM resource naming requirement. ``` +### Tag: package-2023-07-03 + +These settings apply only when `--tag=package-2023-07-03` is specified on the command line. + +``` yaml $(tag) == 'package-2023-07-03' +input-file: + - Microsoft.Compute/common-types/v1/common.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/computeRPCommon.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachine.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineImage.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineExtensionImage.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/availabilitySet.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/proximityPlacementGroup.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/dedicatedHost.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/sshPublicKey.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/image.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/restorePoint.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/capacityReservation.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/logAnalytic.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/runCommand.json + - Microsoft.Compute/DiskRP/stable/2023-10-02/diskRPCommon.json + - Microsoft.Compute/DiskRP/stable/2023-10-02/disk.json + - Microsoft.Compute/DiskRP/stable/2023-10-02/diskAccess.json + - Microsoft.Compute/DiskRP/stable/2023-10-02/diskEncryptionSet.json + - Microsoft.Compute/DiskRP/stable/2023-10-02/diskRestorePoint.json + - Microsoft.Compute/DiskRP/stable/2023-10-02/snapshot.json + - Microsoft.Compute/Skus/stable/2021-07-01/skus.json + - Microsoft.Compute/GalleryRP/stable/2023-07-03/galleryRPCommon.json + - Microsoft.Compute/GalleryRP/stable/2023-07-03/gallery.json + - Microsoft.Compute/GalleryRP/stable/2023-07-03/sharedGallery.json + - Microsoft.Compute/GalleryRP/stable/2023-07-03/communityGallery.json + - Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json +``` + +### Tag: package-2023-07-03-only + +These settings apply only when `--tag=package-2023-07-03-only` is specified on the command line. + +```yaml $(tag) == 'package-2023-07-03-only' +input-file: + - Microsoft.Compute/common-types/v1/common.json + - Microsoft.Compute/GalleryRP/stable/2023-07-03/galleryRPCommon.json + - Microsoft.Compute/GalleryRP/stable/2023-07-03/gallery.json + - Microsoft.Compute/GalleryRP/stable/2023-07-03/sharedGallery.json + - Microsoft.Compute/GalleryRP/stable/2023-07-03/communityGallery.json +``` + ### Tag: package-2023-10-02 These settings apply only when `--tag=package-2023-10-02` is specified on the command line. diff --git a/specification/containerservice/Fleet.Management/fleet.tsp b/specification/containerservice/Fleet.Management/fleet.tsp index 22f2e6df39d6..8500f0e2f024 100644 --- a/specification/containerservice/Fleet.Management/fleet.tsp +++ b/specification/containerservice/Fleet.Management/fleet.tsp @@ -129,17 +129,18 @@ model AgentProfile { @lroStatus @doc("The provisioning state of the last accepted operation.") -enum FleetProvisioningState { - ...ResourceProvisioningState, +union FleetProvisioningState { + string, + ResourceProvisioningState, @doc("The provisioning state of a fleet being created.") - Creating, + Creating: "Creating", @doc("The provisioning state of a fleet being updated.") - Updating, + Updating: "Updating", @doc("The provisioning state of a fleet being deleted.") - Deleting, + Deleting: "Deleting", } @doc("Properties of a Fleet that can be patched.") diff --git a/specification/containerservice/Fleet.Management/fleetmember.tsp b/specification/containerservice/Fleet.Management/fleetmember.tsp index e21a35ffd58e..7e63346ff638 100644 --- a/specification/containerservice/Fleet.Management/fleetmember.tsp +++ b/specification/containerservice/Fleet.Management/fleetmember.tsp @@ -59,17 +59,18 @@ model FleetMemberProperties { @lroStatus @doc("The provisioning state of the last accepted operation.") -enum FleetMemberProvisioningState { - ...ResourceProvisioningState, +union FleetMemberProvisioningState { + string, + ResourceProvisioningState, @doc("The provisioning state of a member joining a fleet.") - Joining, + Joining: "Joining", @doc("The provisioning state of a member leaving a fleet.") - Leaving, + Leaving: "Leaving", @doc("The provisioning state of a member being updated.") - Updating, + Updating: "Updating", } @armResourceOperations diff --git a/specification/containerservice/Fleet.Management/update/run.tsp b/specification/containerservice/Fleet.Management/update/run.tsp index 17965d83db42..a967da73c3ea 100644 --- a/specification/containerservice/Fleet.Management/update/run.tsp +++ b/specification/containerservice/Fleet.Management/update/run.tsp @@ -63,15 +63,15 @@ model UpdateRunProperties { Setting both "updateStrategyId" and "strategy" is invalid. - UpdateRuns created by "updateStrategyId" snapshot the referenced UpdateStrategy at the time of creation and store it in the "strategy" field. - Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate. + UpdateRuns created by "updateStrategyId" snapshot the referenced UpdateStrategy at the time of creation and store it in the "strategy" field. + Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate. UpdateRunStrategy changes can be made directly on the "strategy" field before launching the UpdateRun. """) @added(Versions.v2023_08_15_preview) updateStrategyId?: FleetUpdateStrategyResourceId; @doc(""" -The strategy defines the order in which the clusters will be updated. +The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started. """) diff --git a/specification/containerservice/Fleet.Management/update/strategy.tsp b/specification/containerservice/Fleet.Management/update/strategy.tsp index b190f6d3f9e5..66b018687333 100644 --- a/specification/containerservice/Fleet.Management/update/strategy.tsp +++ b/specification/containerservice/Fleet.Management/update/strategy.tsp @@ -36,8 +36,9 @@ model FleetUpdateStrategy is ProxyResource { } @doc("The provisioning state of the UpdateStrategy resource.") -enum FleetUpdateStrategyProvisioningState { - ...ResourceProvisioningState, +union FleetUpdateStrategyProvisioningState { + string, + ResourceProvisioningState, } @doc("The properties of the UpdateStrategy.") diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsAbortOperation.json new file mode 100644 index 000000000000..0729f967126c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsAbortOperation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2017-08-31", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsAssociate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsAssociate_CRG.json new file mode 100644 index 000000000000..70d44ddf87e8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsAssociate_CRG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json new file mode 100644 index 000000000000..3a36866ae40b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..b8cb50aaca67 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json new file mode 100644 index 000000000000..a1a048ec4804 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableCustomCATrust": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableCustomCATrust": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableCustomCATrust": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..0f6b1d19d7a2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableFIPS.json new file mode 100644 index 000000000000..b7beb1797287 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableFIPS.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..4a7df6371fc5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..21de969bf461 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "kubeletDiskType": "OS", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_GPUMIG.json new file mode 100644 index 000000000000..31c16f8e0a1d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_GPUMIG.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json new file mode 100644 index 000000000000..09a4abb76dcb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "messageOfTheDay": "Zm9vCg==" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "messageOfTheDay": "Zm9vCg==" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "messageOfTheDay": "Zm9vCg==" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_OSSKU.json new file mode 100644 index 000000000000..2e353f111af1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_OSSKU.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..26a162e50866 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Snapshot.json new file mode 100644 index 000000000000..3039566e0f2e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Snapshot.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..ee1d69f27cd4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json new file mode 100644 index 000000000000..a4613cc9f532 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "1.9.6", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "manual": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "count": 5 + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "manual": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "count": 5 + } + ] + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 3 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "manual": [ + { + "sizes": [ + "Standard_D2_v2", + "Standard_D2_v3" + ], + "count": 5 + } + ] + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 3 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..51fa7254be06 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_WasmWasi.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_WasmWasi.json new file mode 100644 index 000000000000..79224f396a39 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_WasmWasi.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json new file mode 100644 index 000000000000..4ce6184b3fb7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json new file mode 100644 index 000000000000..4c86cc964436 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..69a7b1322a55 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsDeleteMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsDeleteMachines.json new file mode 100644 index 000000000000..42c3837e197a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsDeleteMachines.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machines": { + "machineNames": [ + "aks-nodepool1-42263519-vmss00000a", + "aks-nodepool1-42263519-vmss00000b" + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json new file mode 100644 index 000000000000..6032b17ea205 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "ignorePodDisruptionBudget": true + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..6b711eac3073 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..0a5eac1cec03 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..363d18f87e25 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsList.json new file mode 100644 index 000000000000..95c27620e559 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..cef1948c96a8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ContainerService/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2018-07-31" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPools_Start.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPools_Start.json new file mode 100644 index 000000000000..911373d67284 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPools_Start.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Running" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPools_Stop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPools_Stop.json new file mode 100644 index 000000000000..ff970e39411f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPools_Stop.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Stopped" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPools_Update.json new file mode 100644 index 000000000000..a2add9517a0b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/AgentPools_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ContainerServiceGetOSOptions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ContainerServiceGetOSOptions.json new file mode 100644 index 000000000000..0e0941c850e2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ContainerServiceGetOSOptions.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/osOptions/default", + "name": "default", + "type": "Microsoft.ContainerService/locations/osOptions", + "properties": { + "osOptionPropertyList": [ + { + "os-type": "Linux", + "enable-fips-image": false + }, + { + "os-type": "Windows", + "enable-fips-image": false + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/GetGuardrailsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/GetGuardrailsVersions.json new file mode 100644 index 000000000000..fa9c1bcf19d6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/GetGuardrailsVersions.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "version": "v1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/guardrailsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/guardrailsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/GetSafeguardsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/GetSafeguardsVersions.json new file mode 100644 index 000000000000..bd878a9657be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/GetSafeguardsVersions.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "version": "v1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/safeguardsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/safeguardsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/KubernetesVersions_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/KubernetesVersions_List.json new file mode 100644 index 000000000000..ea5a1e47003d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/KubernetesVersions_List.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "values": [ + { + "version": "1.23", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.23.12": { + "upgrades": [ + "1.23.15", + "1.24.6", + "1.24.9" + ] + }, + "1.23.15": { + "upgrades": [ + "1.24.6", + "1.24.9" + ] + } + } + }, + { + "version": "1.24", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.24.6": { + "upgrades": [ + "1.24.9", + "1.25.4", + "1.25.5" + ] + }, + "1.24.9": { + "upgrades": [ + "1.25.4", + "1.25.5" + ] + } + } + }, + { + "version": "1.25", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.25.4": { + "upgrades": [ + "1.25.5", + "1.26.0" + ] + }, + "1.25.5": { + "upgrades": [ + "1.26.0" + ] + } + } + }, + { + "version": "1.26", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.26.0": { + "upgrades": [] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ListGuardrailsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ListGuardrailsVersions.json new file mode 100644 index 000000000000..4042096d99bb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ListGuardrailsVersions.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/guardrailsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/guardrailsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ListSafeguardsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ListSafeguardsVersions.json new file mode 100644 index 000000000000..a88fe41fd969 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ListSafeguardsVersions.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/safeguardsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/safeguardsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MachineGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MachineGet.json new file mode 100644 index 000000000000..54218b7a0fea --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MachineGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machineName": "aks-nodepool1-42263519-vmss00000t" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000", + "name": "aks-nodepool1-25481572-vmss000000", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "properties": { + "network": { + "ipAddresses": [ + { + "ip": "172.20.2.4", + "family": "IPv4" + }, + { + "ip": "10.0.0.1", + "family": "IPv4" + } + ] + }, + "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MachineList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MachineList.json new file mode 100644 index 000000000000..b54b79560bfc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MachineList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000", + "name": "aks-nodepool1-25481572-vmss000000", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "properties": { + "network": { + "ipAddresses": [ + { + "ip": "172.20.2.4", + "family": "IPv4" + }, + { + "ip": "10.0.0.1", + "family": "IPv4" + } + ] + }, + "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0" + } + } + ], + "nextLink": "http://xxxx.azure.com?encodedToken=c2tpcFRva2VuPTE" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsCreate_Update.json new file mode 100644 index 000000000000..8abb427c3af6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsCreate_Update.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default", + "parameters": { + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json new file mode 100644 index 000000000000..06f33c3438e0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedAutoUpgradeSchedule", + "parameters": { + "properties": { + "maintenanceWindow": { + "schedule": { + "relativeMonthly": { + "intervalMonths": 3, + "weekIndex": "First", + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "aksManagedAutoUpgradeSchedule", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "aksManagedAutoUpgradeSchedule", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsDelete.json new file mode 100644 index 000000000000..6b5f0e011587 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json new file mode 100644 index 000000000000..e662428b8f85 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsGet.json new file mode 100644 index 000000000000..5763d1c382d9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json new file mode 100644 index 000000000000..02698b05b019 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "aksManagedNodeOSUpgradeSchedule", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 3 + } + }, + "durationHours": 4, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "09:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsList.json new file mode 100644 index 000000000000..cbd80b0382fb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json new file mode 100644 index 000000000000..44164fdc73c5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 5 + } + }, + "durationHours": 10, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "13:30" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "absoluteMonthly": { + "intervalMonths": 3, + "dayOfMonth": 15 + } + }, + "durationHours": 5, + "utcOffset": "+00:00", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsCreate.json new file mode 100644 index 000000000000..bbd9ab84e1af --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsCreate.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsDelete.json new file mode 100644 index 000000000000..3a02ba755a55 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsGet.json new file mode 100644 index 000000000000..d3898a0e9122 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsList.json new file mode 100644 index 000000000000..b728a7e1595d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..4db4e63de893 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json new file mode 100644 index 000000000000..6f51b7b85ba2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersAbortOperation.json new file mode 100644 index 000000000000..973791ef9b73 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersAbortOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2017-08-31", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersAssociate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersAssociate_CRG.json new file mode 100644 index 000000000000..6d281cd63088 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersAssociate_CRG.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json new file mode 100644 index 000000000000..fd9d4bc90711 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json @@ -0,0 +1,259 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json new file mode 100644 index 000000000000..f5380325aba9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json @@ -0,0 +1,355 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true, + "nodeSelector": { + "istio": "egress" + } + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + } + } + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true, + "nodeSelector": { + "istio": "egress" + } + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true, + "nodeSelector": { + "istio": "egress" + } + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..847035076069 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json new file mode 100644 index 000000000000..0e3834c488f9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json new file mode 100644 index 000000000000..b19d0afede91 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json @@ -0,0 +1,321 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + }, + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json new file mode 100644 index 000000000000..bc67fcc3959f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "aiToolchainOperatorProfile": { + "enabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aiToolchainOperatorProfile": { + "enabled": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aiToolchainOperatorProfile": { + "enabled": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json new file mode 100644 index 000000000000..699b4ba93da5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json @@ -0,0 +1,269 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableCustomCATrust": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "securityProfile": { + "customCATrustCertificates": [ + "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ=" + ] + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableCustomCATrust": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "securityProfile": { + "customCATrustCertificates": [ + "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ=" + ] + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableCustomCATrust": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "securityProfile": { + "customCATrustCertificates": [ + "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ=" + ] + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..c4787646d8ff --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..6241eb6d82d2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json new file mode 100644 index 000000000000..bdbb82cd673d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_GPUMIG.json new file mode 100644 index 000000000000..873d1f509a5a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_GPUMIG.json @@ -0,0 +1,281 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_HTTPProxy.json new file mode 100644 index 000000000000..c267abc669f6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_HTTPProxy.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json new file mode 100644 index 000000000000..9064e76378b8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_MCSnapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_MCSnapshot.json new file mode 100644 index 000000000000..cb01b5b15d39 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_MCSnapshot.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1" + }, + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1" + }, + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1" + }, + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json new file mode 100644 index 000000000000..71d025ff07c0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "managedOutboundIPProfile": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json new file mode 100644 index 000000000000..e86e53bc9f1b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json new file mode 100644 index 000000000000..f8db7a0827fa --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_OSSKU.json new file mode 100644 index 000000000000..2c7bc9dd7b4b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_OSSKU.json @@ -0,0 +1,281 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..f9d144d66870 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PodIdentity.json new file mode 100644 index 000000000000..89a0a3307792 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PodIdentity.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_Premium.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_Premium.json new file mode 100644 index 000000000000..0315450aad02 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_Premium.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json new file mode 100644 index 000000000000..f2cdc6493ce4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json @@ -0,0 +1,264 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json new file mode 100644 index 000000000000..723f597f4890 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json @@ -0,0 +1,268 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_SecurityProfile.json new file mode 100644 index 000000000000..1ac7c80f3c01 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_SecurityProfile.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_Snapshot.json new file mode 100644 index 000000000000..cb1f45009912 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_Snapshot.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..55c57da7bfd4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,315 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json new file mode 100644 index 000000000000..76af74358160 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json @@ -0,0 +1,299 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..09c5de24e9bb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,293 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..7ba697b1a9cb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,282 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json new file mode 100644 index 000000000000..281aae73a2e8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json @@ -0,0 +1,269 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "enableNamespaceResources": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "enableNamespaceResources": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "enableNamespaceResources": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json new file mode 100644 index 000000000000..9b245fe60178 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json @@ -0,0 +1,198 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_VirtualMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_VirtualMachines.json new file mode 100644 index 000000000000..1c07ffeb0daa --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersCreate_VirtualMachines.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachines", + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachines", + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachines", + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..1f9234e0dd73 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..ba03a5b178b0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGet.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..ab47064528f6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "a3ViZUNvbmZpZzE=" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..97f26cbb80b0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json new file mode 100644 index 000000000000..322f1bc90446 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json new file mode 100644 index 000000000000..b88c7556f71c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersList.json new file mode 100644 index 000000000000..334a384213ef --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..ba3e4d0b9555 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersListClusterCredentialResult.json new file mode 100644 index 000000000000..67afd023097e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersListClusterCredentialResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json new file mode 100644 index 000000000000..5d6806ca1d4d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json new file mode 100644 index 000000000000..0ae407481c56 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..60fe867d0c87 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..04a9e43589db --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..1f9234e0dd73 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json new file mode 100644 index 000000000000..1f9234e0dd73 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..1f9234e0dd73 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..1f9234e0dd73 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersStop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..1f3397c4100e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OperationStatusResultGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OperationStatusResultGet.json new file mode 100644 index 000000000000..803a96ea4247 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OperationStatusResultGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "operationId": "00000000-0000-0000-0000-000000000001" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/operations/00000000-0000-0000-0000-000000000001", + "name": "00000000-0000-0000-0000-000000000001", + "status": "InProgress", + "percentComplete": 40, + "startTime": "2023-07-26T12:14:26.3179428Z" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OperationStatusResultGetByAgentPool.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OperationStatusResultGetByAgentPool.json new file mode 100644 index 000000000000..8e5906000bf0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OperationStatusResultGetByAgentPool.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "operationId": "00000000-0000-0000-0000-000000000001" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/operations/00000000-0000-0000-0000-000000000001", + "name": "00000000-0000-0000-0000-000000000001", + "status": "InProgress", + "percentComplete": 40, + "startTime": "2023-07-26T12:14:26.3179428Z" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OperationStatusResultList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OperationStatusResultList.json new file mode 100644 index 000000000000..5a66fb054a20 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OperationStatusResultList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/operations/d11edb09-6e27-429f-9fe5-17baf773bc4a", + "name": "d11edb09-6e27-429f-9fe5-17baf773bc4a", + "status": "InProgress", + "percentComplete": 40, + "startTime": "2023-07-26T12:14:26.3179428Z" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/operations/d11edb09-6e27-429f-9fe5-17baf773bc4b", + "name": "d11edb09-6e27-429f-9fe5-17baf773bc4b", + "status": "Failed", + "startTime": "2023-07-26T12:14:26.3179428Z", + "endTime": "2023-07-26T12:14:50.3179428Z", + "error": { + "code": "ReconcileAgentPoolIdentityError", + "message": "Reconcile agent pool nodepool1 identity failed" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/Operation_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/Operation_List.json new file mode 100644 index 000000000000..df0644408a08 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/Operation_List.json @@ -0,0 +1,3583 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets the status of an asynchronous operation", + "operation": "Get Operation", + "provider": "Microsoft Container Service", + "resource": "Operation" + }, + "name": "Microsoft.ContainerService/locations/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists the supported orchestrators", + "operation": "List Orchestrators", + "provider": "Microsoft Container Service", + "resource": "Orchestrator" + }, + "name": "Microsoft.ContainerService/locations/orchestrators/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets OS options", + "operation": "Get OS Options", + "provider": "Microsoft Container Service", + "resource": "OSOptions" + }, + "name": "Microsoft.ContainerService/locations/osOptions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists operations available on Microsoft.ContainerService resource provider", + "operation": "List Available Container Service Operations", + "provider": "Microsoft Container Service", + "resource": "Available Container Service Operations" + }, + "name": "Microsoft.ContainerService/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Registers Subscription with Microsoft.ContainerService resource provider", + "operation": "Register Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Register Subscription" + }, + "name": "Microsoft.ContainerService/register/action", + "origin": "user,system" + }, + { + "display": { + "description": "Unregisters Subscription with Microsoft.ContainerService resource provider", + "operation": "Unregister Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Unregister Subscription" + }, + "name": "Microsoft.ContainerService/unregister/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the status of an asynchronous operation result", + "operation": "Get Operation Result", + "provider": "Microsoft Container Service", + "resource": "OperationResult" + }, + "name": "Microsoft.ContainerService/locations/operationresults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a container service", + "operation": "Get Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new container service or updates an existing one", + "operation": "Create or Update Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a container service", + "operation": "Delete Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster", + "operation": "Get Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new managed cluster or updates an existing one", + "operation": "Create or Update Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a managed cluster", + "operation": "Delete Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Starts a managed cluster", + "operation": "Start Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/start/action", + "origin": "user,system" + }, + { + "display": { + "description": "Stops a managed cluster", + "operation": "Stop Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/stop/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets a maintenance configuration", + "operation": "Get a maintenance configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new MaintenanceConfiguration or updates an existing one", + "operation": "Create or Update maintenance configuratio", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a maintenance configuration", + "operation": "Delete Maintenance Configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an agent pool", + "operation": "Get Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new agent pool or updates an existing one", + "operation": "Create or Update Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes an agent pool", + "operation": "Delete Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the Agent Pool", + "operation": "Get Agent Pool UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Upgrade the node image version of agent pool", + "operation": "Upgrade agent pool node image version", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeNodeImageVersion/write", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available agent pool versions of the cluster", + "operation": "Get Available Agent Pool Versions", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/availableAgentPoolVersions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name", + "operation": "Get Managed Cluster AccessProfile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name using list credential", + "operation": "Get Managed Cluster AccessProfile by List Credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/listCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the cluster", + "operation": "Get UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "UpgradeProfile" + }, + "name": "Microsoft.ContainerService/managedClusters/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterAdmin credential of a managed cluster", + "operation": "List clusterAdmin credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterAdminCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterUser credential of a managed cluster", + "operation": "List clusterUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterMonitoringUser credential of a managed cluster", + "operation": "List clusterMonitoringUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterMonitoringUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the service principal profile of a managed cluster", + "operation": "Reset service principal profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetServicePrincipalProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Resolve the private link service id of a managed cluster", + "operation": "Resolve private link service id", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resolvePrivateLinkServiceId/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the AAD profile of a managed cluster", + "operation": "Reset AAD profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetAADProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Rotate certificates of a managed cluster", + "operation": "Rotate certificates of the cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/rotateClusterCertificates/action", + "origin": "user,system" + }, + { + "display": { + "description": "Run user issued command against managed kubernetes server.", + "operation": "RunCommand", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/runCommand/action", + "origin": "user,system" + }, + { + "display": { + "description": "Retrieve result from previous issued command.", + "operation": "CommandResult", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/commandResults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get the diagnostic setting for a managed cluster resource", + "operation": "Read Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/read", + "origin": "system" + }, + { + "display": { + "description": "Creates or updates the diagnostic setting for a managed cluster resource", + "operation": "Write Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/write", + "origin": "system" + }, + { + "display": { + "description": "Get Managed Cluster Detector", + "operation": "Get Managed Cluster Detector", + "provider": "Microsoft Container Service", + "resource": "Managed Cluster Detector" + }, + "name": "Microsoft.ContainerService/managedClusters/detectors/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the diagnostics state of the cluster", + "operation": "Get Diagnostics State", + "provider": "Microsoft Container Service", + "resource": "Diagnostics State" + }, + "name": "Microsoft.ContainerService/managedClusters/diagnosticsState/read", + "origin": "user,system" + }, + { + "display": { + "description": "Determines if user is allowed to approve a private endpoint connection", + "operation": "Approve Private Endpoint Connections", + "provider": "Microsoft Container Service", + "resource": "Approve Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnectionsApproval/action", + "origin": "user,system" + }, + { + "display": { + "description": "Get private endpoint connection", + "operation": "Get private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/read", + "origin": "user,system" + }, + { + "display": { + "description": "Approve or Reject a private endpoint connection", + "operation": "Update private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete private endpoint connection", + "operation": "Delete private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an extension addon", + "operation": "Get an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/read", + "origin": "system" + }, + { + "display": { + "description": "Creates a new extension addon or updates an existing one", + "operation": "Create or Update extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/write", + "origin": "system" + }, + { + "display": { + "description": "Deletes an extension addon", + "operation": "Delete an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/delete", + "origin": "system" + }, + { + "display": { + "description": "Get a snapshot", + "operation": "Get Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new snapshot", + "operation": "Create Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a snapshot", + "operation": "Delete Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get eventgrid filter", + "operation": "Get eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/read", + "origin": "system" + }, + { + "display": { + "description": "Create or Update eventgrid filter", + "operation": "Create or Update eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/write", + "origin": "system" + }, + { + "display": { + "description": "Delete an eventgrid filter", + "operation": "Delete an eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/delete", + "origin": "system" + }, + { + "display": { + "description": "Reads initializerconfigurations", + "operation": "Gets/List initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes initializerconfigurations", + "operation": "Creates/Updates initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes/DeletesCollection initializerconfigurations resource", + "operation": "Initializerconfigurations", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads mutatingwebhookconfigurations", + "operation": "Gets/List mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes mutatingwebhookconfigurations", + "operation": "Creates/Updates mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes mutatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads validatingwebhookconfigurations", + "operation": "Gets/List validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes validatingwebhookconfigurations", + "operation": "Creates/Updates validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes validatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads customresourcedefinitions", + "operation": "Gets/List customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes customresourcedefinitions", + "operation": "Creates/Updates customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes customresourcedefinitions", + "operation": "Deletes/DeletesCollection customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservices", + "operation": "Gets/List apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes apiservices", + "operation": "Creates/Updates apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes apiservices", + "operation": "Deletes/DeletesCollection apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads controllerrevisions", + "operation": "Gets/List controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes controllerrevisions", + "operation": "Creates/Updates controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes controllerrevisions", + "operation": "Deletes/DeletesCollection controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads statefulsets", + "operation": "Gets/List statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes statefulsets", + "operation": "Creates/Updates statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes statefulsets", + "operation": "Deletes/DeletesCollection statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes tokenreviews", + "operation": "Creates/Updates tokenreviews resource", + "provider": "Microsoft Container Service", + "resource": "Tokenreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/tokenreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes localsubjectaccessreviews", + "operation": "Creates/Updates localsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Localsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/localsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectaccessreviews", + "operation": "Creates/Updates selfsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectrulesreviews", + "operation": "Creates/Updates selfsubjectrulesreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectrulesreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectrulesreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes subjectaccessreviews", + "operation": "Creates/Updates subjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Subjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/subjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads horizontalpodautoscalers", + "operation": "Gets/List horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes horizontalpodautoscalers", + "operation": "Creates/Updates horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes horizontalpodautoscalers", + "operation": "Deletes/DeletesCollection horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads cronjobs", + "operation": "Gets/List cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes cronjobs", + "operation": "Creates/Updates cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes cronjobs", + "operation": "Deletes/DeletesCollection cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads jobs", + "operation": "Gets/List jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes jobs", + "operation": "Creates/Updates jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes jobs", + "operation": "Deletes/DeletesCollection jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificatesigningrequests", + "operation": "Gets/List certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes certificatesigningrequests", + "operation": "Creates/Updates certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes certificatesigningrequests", + "operation": "Deletes/DeletesCollection certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads leases", + "operation": "Gets/List leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes leases", + "operation": "Creates/Updates leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes leases", + "operation": "Deletes/DeletesCollection leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes bindings", + "operation": "Creates/Updates bindings resource", + "provider": "Microsoft Container Service", + "resource": "Bindings" + }, + "name": "Microsoft.ContainerService/managedClusters/bindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads componentstatuses", + "operation": "Gets/List componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes componentstatuses", + "operation": "Creates/Updates componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes componentstatuses", + "operation": "Deletes/DeletesCollection componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads configmaps", + "operation": "Gets/List configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes configmaps", + "operation": "Creates/Updates configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes configmaps", + "operation": "Deletes/DeletesCollection configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads endpoints", + "operation": "Gets/List endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes endpoints", + "operation": "Creates/Updates endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes endpoints", + "operation": "Deletes/DeletesCollection endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads limitranges", + "operation": "Gets/List limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes limitranges", + "operation": "Creates/Updates limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes limitranges", + "operation": "Deletes/DeletesCollection limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads namespaces", + "operation": "Gets/List namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes namespaces", + "operation": "Creates/Updates namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes namespaces", + "operation": "Deletes/DeletesCollection namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes nodes", + "operation": "Creates/Updates nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes nodes", + "operation": "Deletes/DeletesCollection nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumeclaims", + "operation": "Gets/List persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumeclaims", + "operation": "Creates/Updates persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumeclaims", + "operation": "Deletes/DeletesCollection persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumes", + "operation": "Gets/List persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumes", + "operation": "Creates/Updates persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumes", + "operation": "Deletes/DeletesCollection persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes pods", + "operation": "Creates/Updates pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes pods", + "operation": "Deletes/DeletesCollection pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Exec into pods resource", + "operation": "Exec into pods resource ", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/exec/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podtemplates", + "operation": "Gets/List podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podtemplates", + "operation": "Creates/Updates podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podtemplates", + "operation": "Deletes/DeletesCollection podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicationcontrollers", + "operation": "Gets/List replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicationcontrollers", + "operation": "Creates/Updates replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicationcontrollers", + "operation": "Deletes/DeletesCollection replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resourcequotas", + "operation": "Gets/List resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes resourcequotas", + "operation": "Creates/Updates resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes resourcequotas", + "operation": "Deletes/DeletesCollection resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads secrets", + "operation": "Gets/List secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes secrets", + "operation": "Creates/Updates secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes secrets", + "operation": "Deletes/DeletesCollection secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads serviceaccounts", + "operation": "Gets/List serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes serviceaccounts", + "operation": "Creates/Updates serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes serviceaccounts", + "operation": "Deletes/DeletesCollection serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads services", + "operation": "Gets/List services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes services", + "operation": "Creates/Updates services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes services", + "operation": "Deletes/DeletesCollection services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads runtimeclasses", + "operation": "Gets/List runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes runtimeclasses", + "operation": "Creates/Updates runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes runtimeclasses", + "operation": "Deletes/DeletesCollection runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api", + "operation": "Gets/List api resource", + "provider": "Microsoft Container Service", + "resource": "Api" + }, + "name": "Microsoft.ContainerService/managedClusters/api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api/v1", + "operation": "Gets/List api/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Api/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/api/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apis", + "operation": "Gets/List apis resource", + "provider": "Microsoft Container Service", + "resource": "Apis" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io", + "operation": "Gets/List admissionregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1", + "operation": "Gets/List admissionregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1beta1", + "operation": "Gets/List admissionregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io", + "operation": "Gets/List apiextensions.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1", + "operation": "Gets/List apiextensions.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1beta1", + "operation": "Gets/List apiextensions.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io", + "operation": "Gets/List apiregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1", + "operation": "Gets/List apiregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1beta1", + "operation": "Gets/List apiregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps", + "operation": "Gets/List apps resource", + "provider": "Microsoft Container Service", + "resource": "Apps" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1", + "operation": "Gets/List apps/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta1", + "operation": "Gets/List apps/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta2", + "operation": "Gets/List apps/v1beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io", + "operation": "Gets/List authentication.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1", + "operation": "Gets/List authentication.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1beta1", + "operation": "Gets/List authentication.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io", + "operation": "Gets/List authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1", + "operation": "Gets/List authorization.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1beta1", + "operation": "Gets/List authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling", + "operation": "Gets/List autoscaling resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v1", + "operation": "Gets/List autoscaling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta1", + "operation": "Gets/List autoscaling/v2beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta2", + "operation": "Gets/List autoscaling/v2beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch", + "operation": "Gets/List batch resource", + "provider": "Microsoft Container Service", + "resource": "Batch" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1", + "operation": "Gets/List batch/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1beta1", + "operation": "Gets/List batch/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io", + "operation": "Gets/List certificates.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io/v1beta1", + "operation": "Gets/List certificates.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io", + "operation": "Gets/List coordination.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination/v1", + "operation": "Gets/List coordination/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io/v1beta1", + "operation": "Gets/List coordination.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io", + "operation": "Gets/List events.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io/v1beta1", + "operation": "Gets/List events.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions", + "operation": "Gets/List extensions resource", + "provider": "Microsoft Container Service", + "resource": "Extensions" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions/v1beta1", + "operation": "Gets/List extensions/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Extensions/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io", + "operation": "Gets/List metrics.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io/v1beta1", + "operation": "Gets/List metrics.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io", + "operation": "Gets/List networking.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking/v1", + "operation": "Gets/List networking/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io/v1beta1", + "operation": "Gets/List networking.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io", + "operation": "Gets/List node.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io/v1beta1", + "operation": "Gets/List node.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy", + "operation": "Gets/List policy resource", + "provider": "Microsoft Container Service", + "resource": "Policy" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy/v1beta1", + "operation": "Gets/List policy/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Policy/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io", + "operation": "Gets/List rbac.authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization/v1", + "operation": "Gets/List rbac.authorization/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io/v1beta1", + "operation": "Gets/List rbac.authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io", + "operation": "Gets/List scheduling.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling/v1", + "operation": "Gets/List scheduling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io/v1beta1", + "operation": "Gets/List scheduling.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io", + "operation": "Gets/List storage.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage/v1", + "operation": "Gets/List storage/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io/v1beta1", + "operation": "Gets/List storage.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads healthz", + "operation": "Gets/List healthz resource", + "provider": "Microsoft Container Service", + "resource": "Healthz" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads livez", + "operation": "Gets/List livez resource", + "provider": "Microsoft Container Service", + "resource": "Livez" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads logs", + "operation": "Gets/List logs resource", + "provider": "Microsoft Container Service", + "resource": "Logs" + }, + "name": "Microsoft.ContainerService/managedClusters/logs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics", + "operation": "Gets/List metrics resource", + "provider": "Microsoft Container Service", + "resource": "Metrics" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads v2", + "operation": "Gets/List v2 resource", + "provider": "Microsoft Container Service", + "resource": "Openapi/V2" + }, + "name": "Microsoft.ContainerService/managedClusters/openapi/v2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads readyz", + "operation": "Gets/List readyz resource", + "provider": "Microsoft Container Service", + "resource": "Readyz" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads shutdown", + "operation": "Gets/List shutdown resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Shutdown" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/shutdown/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resetMetrics", + "operation": "Gets/List resetMetrics resource", + "provider": "Microsoft Container Service", + "resource": "Resetmetrics" + }, + "name": "Microsoft.ContainerService/managedClusters/resetMetrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-ui", + "operation": "Gets/List swagger-ui resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-api", + "operation": "Gets/List swagger-api resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Api" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ui", + "operation": "Gets/List ui resource", + "provider": "Microsoft Container Service", + "resource": "Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads version", + "operation": "Gets/List version resource", + "provider": "Microsoft Container Service", + "resource": "Version" + }, + "name": "Microsoft.ContainerService/managedClusters/version/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads poddisruptionbudgets", + "operation": "Gets/List poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes poddisruptionbudgets", + "operation": "Creates/Updates poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes poddisruptionbudgets", + "operation": "Deletes/DeletesCollection poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterrolebindings", + "operation": "Gets/List clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterrolebindings", + "operation": "Creates/Updates clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterrolebindings", + "operation": "Deletes/DeletesCollection clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterroles", + "operation": "Gets/List clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterroles", + "operation": "Creates/Updates clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterroles", + "operation": "Deletes/DeletesCollection clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rolebindings", + "operation": "Gets/List rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes rolebindings", + "operation": "Creates/Updates rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes rolebindings", + "operation": "Deletes/DeletesCollection rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads roles", + "operation": "Gets/List roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes roles", + "operation": "Creates/Updates roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes roles", + "operation": "Deletes/DeletesCollection roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads priorityclasses", + "operation": "Gets/List priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes priorityclasses", + "operation": "Creates/Updates priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes priorityclasses", + "operation": "Deletes/DeletesCollection priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Use action on podsecuritypolicies", + "operation": "Use podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/use/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds clusterroles", + "operation": "Bind clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates", + "operation": "Escalate clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds roles", + "operation": "Bind roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates roles", + "operation": "Escalate roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate serviceaccounts", + "operation": "Impersonate serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate users", + "operation": "Impersonate users resource", + "provider": "Microsoft Container Service", + "resource": "Users" + }, + "name": "Microsoft.ContainerService/managedClusters/users/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate groups", + "operation": "Impersonate groups resource", + "provider": "Microsoft Container Service", + "resource": "Groups" + }, + "name": "Microsoft.ContainerService/managedClusters/groups/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate userextras", + "operation": "Impersonate userextras resource", + "provider": "Microsoft Container Service", + "resource": "Userextras" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/userextras/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storageclasses", + "operation": "Gets/List storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes storageclasses", + "operation": "Creates/Updates storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes storageclasses", + "operation": "Deletes/DeletesCollection storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads volumeattachments", + "operation": "Gets/List volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes volumeattachments", + "operation": "Creates/Updates volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes volumeattachments", + "operation": "Deletes/DeletesCollection volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csidrivers", + "operation": "Gets/List csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csidrivers", + "operation": "Creates/Updates csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csidrivers", + "operation": "Deletes/DeletesCollection csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csinodes", + "operation": "Gets/List csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csinodes", + "operation": "Creates/Updates csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csinodes", + "operation": "Deletes/DeletesCollection csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available metrics for Managed Cluster", + "operation": "Read Managed Cluster metric definitions", + "provider": "Microsoft Container Service", + "resource": "The metric definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/metricDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Gets the available logs for Managed Cluster", + "operation": "Read Managed Cluster log definitions", + "provider": "Microsoft Container Service", + "resource": "The log definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/logDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Get a Open Shift Managed Cluster", + "operation": "Get Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Managed Cluster or updates an existing one", + "operation": "Create or Update Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Managed Cluster", + "operation": "Delete Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a Open Shift Cluster", + "operation": "Get Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Cluster or updates an existing one", + "operation": "Create or Update Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Cluster", + "operation": "Delete Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/delete", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..03fc1c6921f2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "images", + "endpoints": [ + { + "domainName": "mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.data.mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https", + "description": "mcr cdn" + } + ] + } + ] + }, + { + "category": "artifacts", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "acs-mirror.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "time-sync", + "endpoints": [ + { + "domainName": "ntp.ubuntu.com", + "endpointDetails": [ + { + "port": 123, + "protocol": "UDP" + } + ] + } + ] + }, + { + "category": "ubuntu-optional", + "endpoints": [ + { + "domainName": "security.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "changelogs.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "gpu", + "endpoints": [ + { + "domainName": "nvidia.github.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "us.download.nvidia.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "apt.dockerproject.org", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "windows", + "endpoints": [ + { + "domainName": "onegetcdn.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "go.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.mp.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "www.msftconnecttest.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "ctldl.windowsupdate.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "apiserver", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "tunnel-classic", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 9000, + "protocol": "TCP" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..a6dd95a3dbab --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..6777f7c0b4fc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..cb17488cd0b1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..0d91865db7ee --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..9ef29b4accf4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..1e89b2acc8eb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/RunCommandRequest.json new file mode 100644 index 000000000000..2c56efec9099 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/RunCommandRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "requestPayload": { + "command": "kubectl apply -f ns.yaml", + "context": "", + "clusterToken": "" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2023-11-02-preview" + } + }, + "200": { + "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE", + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/RunCommandResultFailed.json new file mode 100644 index 000000000000..1f9c973c95ae --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/RunCommandResultFailed.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2023-11-02-preview" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "failed", + "reason": "ImagePullBackoff" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/RunCommandResultSucceed.json new file mode 100644 index 000000000000..5a3dc1333276 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/RunCommandResultSucceed.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2023-11-02-preview" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsCreate.json new file mode 100644 index 000000000000..e2bca4215269 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsDelete.json new file mode 100644 index 000000000000..3a02ba755a55 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsGet.json new file mode 100644 index 000000000000..9034ec85366b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsList.json new file mode 100644 index 000000000000..f4f0a78b85e4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..a60849e66ccb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsUpdateTags.json new file mode 100644 index 000000000000..3a44353f2f69 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/SnapshotsUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json new file mode 100644 index 000000000000..ac127f36df64 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1", + "trustedAccessRoleBinding": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_Delete.json new file mode 100644 index 000000000000..4fb0ee411306 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_Get.json new file mode 100644 index 000000000000..cb7719da57b9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_List.json new file mode 100644 index 000000000000..1c451d79e2d6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoleBindings_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoles_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoles_List.json new file mode 100644 index 000000000000..02d4c96534e9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/TrustedAccessRoles_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sourceResourceType": "Microsoft.MachineLearningServices/workspaces", + "name": "reader", + "rules": [ + { + "verbs": [ + "get" + ], + "apiGroups": [ + "" + ], + "resources": [ + "pods" + ], + "resourceNames": [], + "nonResourceURLs": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/managedClusters.json new file mode 100644 index 000000000000..b4c6493ceee3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/managedClusters.json @@ -0,0 +1,9438 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2023-11-02-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "Operations_List", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List available operations for the container service resource provider": { + "$ref": "./examples/Operation_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetOSOptions", + "summary": "Gets supported OS options in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ResourceTypeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OSOptionProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Container Service OS Options": { + "$ref": "./examples/ContainerServiceGetOSOptions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListKubernetesVersions", + "summary": "Gets a list of supported Kubernetes versions in the specified subscription.", + "description": "Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubernetesVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Kubernetes Versions": { + "$ref": "./examples/KubernetesVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets the upgrade profile of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Lists the admin credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Lists the user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + }, + { + "$ref": "#/parameters/CredentialFormatParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Lists the cluster monitoring user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The managed cluster to create or update." + } + ], + "responses": { + "200": { + "description": "The existing managed cluster was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "The new managed cluster was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create/Update Managed Cluster with EnableNamespaceResources": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create Managed Cluster with OSSKU": { + "$ref": "./examples/ManagedClustersCreate_OSSKU.json" + }, + "Create Managed Cluster with GPUMIG": { + "$ref": "./examples/ManagedClustersCreate_GPUMIG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + }, + "Create Managed Cluster with EncryptionAtHost enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json" + }, + "Create Managed Cluster with UltraSSD enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json" + }, + "Create Managed Cluster with PodIdentity enabled": { + "$ref": "./examples/ManagedClustersCreate_PodIdentity.json" + }, + "Create Managed Private Cluster with fqdn subdomain specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json" + }, + "Create Managed Private Cluster with Public FQDN specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json" + }, + "Create Managed Cluster with RunCommand disabled": { + "$ref": "./examples/ManagedClustersCreate_DisableRunCommand.json" + }, + "Create Managed Cluster with LongTermSupport": { + "$ref": "./examples/ManagedClustersCreate_Premium.json" + }, + "Create Managed Cluster with Node Public IP Prefix": { + "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json" + }, + "Create Managed Cluster with Azure Key Vault Secrets Provider Addon": { + "$ref": "./examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json" + }, + "Create/Update Managed Cluster with Azure Service Mesh": { + "$ref": "./examples/ManagedClustersCreate_AzureServiceMesh.json" + }, + "Create Managed Cluster with FIPS enabled OS": { + "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json" + }, + "Create Managed Cluster with HTTP proxy configured": { + "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json" + }, + "Create Managed Cluster with Security Profile configured": { + "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json" + }, + "Create Managed Cluster with Web App Routing Ingress Profile configured": { + "$ref": "./examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json" + }, + "Create Managed Cluster with AKS-managed NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json" + }, + "Create Managed Cluster with user-assigned NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json" + }, + "Create Managed Cluster using an agent pool snapshot": { + "$ref": "./examples/ManagedClustersCreate_Snapshot.json" + }, + "Create Managed Cluster using a managed cluster snapshot": { + "$ref": "./examples/ManagedClustersCreate_MCSnapshot.json" + }, + "Create/Update Managed Cluster with Windows gMSA enabled": { + "$ref": "./examples/ManagedClustersCreate_UpdateWindowsGmsa.json" + }, + "Create/Update Managed Cluster with dual-stack networking": { + "$ref": "./examples/ManagedClustersCreate_DualStackNetworking.json" + }, + "Associate Managed Cluster with Capacity Reservation Group": { + "$ref": "./examples/ManagedClustersAssociate_CRG.json" + }, + "Create Managed Cluster with Dedicated Host Group": { + "$ref": "./examples/ManagedClustersCreate_DedicatedHostGroup.json" + }, + "Create Managed Cluster with CustomCATrustCertificates populated and CustomCATrust enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableCustomCATrust.json" + }, + "Create Managed Cluster with VirtualMachines pool type": { + "$ref": "./examples/ManagedClustersCreate_VirtualMachines.json" + }, + "Create Managed Cluster with AI Toolchain Operator enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableAIToolchainOperator.json" + }, + "Create Managed Cluster with Node Auto Provisioning": { + "$ref": "./examples/ManagedClustersCreate_NodeAutoProvisioning.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/IgnorePodDisruptionBudgetParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_ListByManagedCluster", + "summary": "Gets a list of maintenance configurations in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List maintenance configurations by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList.json" + }, + "List maintenance configurations configured with maintenance window by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Get", + "summary": "Gets the specified maintenance configuration of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsGet.json" + }, + "Get Maintenance Configuration Configured With Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsGet_MaintenanceWindow.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "summary": "Creates or updates a maintenance configuration in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The maintenance configuration to create or update." + } + ], + "responses": { + "200": { + "description": "The existing maintenance configuration was successfully updated.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "201": { + "description": "The new maintenance configuration was successfully created.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create/Update Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update.json" + }, + "Create/Update Maintenance Configuration with Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Delete", + "summary": "Deletes a maintenance configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Delete Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsDelete.json" + }, + "Delete Maintenance Configuration For Node OS Upgrade": { + "$ref": "./examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_AbortLatestOperation", + "summary": "Aborts last operation running on agent pool.", + "description": "Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, an error is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on agent pool": { + "$ref": "./examples/AgentPoolsAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the specified managed cluster agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The agent pool to create or update." + } + ], + "responses": { + "200": { + "description": "The existing agent pool was successfully updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "The new agent pool was successfully created.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with OSSKU": { + "$ref": "./examples/AgentPoolsCreate_OSSKU.json" + }, + "Create Agent Pool with Windows OSSKU": { + "$ref": "./examples/AgentPoolsCreate_WindowsOSSKU.json" + }, + "Create Windows Agent Pool with disabling OutboundNAT": { + "$ref": "./examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json" + }, + "Create Agent Pool with GPUMIG": { + "$ref": "./examples/AgentPoolsCreate_GPUMIG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + }, + "Create Agent Pool with KubeletConfig and LinuxOSConfig": { + "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json" + }, + "Create Agent Pool with EncryptionAtHost enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json" + }, + "Create Agent Pool with UltraSSD enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json" + }, + "Create Agent Pool with FIPS enabled OS": { + "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json" + }, + "Create Agent Pool using an agent pool snapshot": { + "$ref": "./examples/AgentPoolsCreate_Snapshot.json" + }, + "Create Agent Pool with Krustlet and the WASI runtime": { + "$ref": "./examples/AgentPoolsCreate_WasmWasi.json" + }, + "Create Agent Pool with Message of the Day": { + "$ref": "./examples/AgentPoolsCreate_MessageOfTheDay.json" + }, + "Stop Agent Pool": { + "$ref": "./examples/AgentPools_Stop.json" + }, + "Start Agent Pool": { + "$ref": "./examples/AgentPools_Start.json" + }, + "Associate Agent Pool with Capacity Reservation Group": { + "$ref": "./examples/AgentPoolsAssociate_CRG.json" + }, + "Create Agent Pool with Dedicated Host Group": { + "$ref": "./examples/AgentPoolsCreate_DedicatedHostGroup.json" + }, + "Create Agent Pool with CustomCATrust enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableCustomCATrust.json" + }, + "Create Agent Pool with VirtualMachines pool type": { + "$ref": "./examples/AgentPoolsCreate_TypeVirtualMachines.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "#/parameters/IgnorePodDisruptionBudgetParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + }, + "Delete Agent Pool by ignoring PodDisruptionBudget": { + "$ref": "./examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets the upgrade profile for an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/deleteMachines": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_DeleteMachines", + "summary": "Deletes specific machines in an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "machines", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPoolDeleteMachinesParameter" + }, + "description": "A list of machines from the agent pool to be deleted." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Specific Machines in an Agent Pool": { + "$ref": "./examples/AgentPoolsDeleteMachines.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines": { + "get": { + "tags": [ + "Machines" + ], + "operationId": "Machines_List", + "summary": "Gets a list of machines in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Machines in an Agentpool by Managed Cluster": { + "$ref": "./examples/MachineList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines/{machineName}": { + "get": { + "tags": [ + "Machines" + ], + "operationId": "Machines_Get", + "summary": "Get a specific machine in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "#/parameters/MachineNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a Machine in an Agent Pools by Managed Cluster": { + "$ref": "./examples/MachineGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.", + "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset the Service Principal Profile of a managed cluster.", + "description": "This action cannot be performed on a cluster that is not using a service principal", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "The service principal profile to set on the managed cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset the AAD Profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "The AAD profile to set on the Managed Cluster" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_AbortLatestOperation", + "summary": "Aborts last operation running on managed cluster.", + "description": "Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, an error is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on managed cluster": { + "$ref": "./examples/ManagedClustersAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotates the certificates of a managed cluster.", + "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateServiceAccountSigningKeys", + "summary": "Rotates the service account signing keys of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Service Account Signing Keys": { + "$ref": "./examples/ManagedClustersRotateServiceAccountSigningKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stops a Managed Cluster", + "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Starts a previously stopped Managed Cluster", + "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the specified private endpoint connection.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The updated private endpoint connection." + } + ], + "responses": { + "200": { + "description": "The existing private endpoint connection was successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The new private endpoint connection was successfully created.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_UpgradeNodeImageVersion", + "summary": "Upgrades the node image version of an agent pool to the latest.", + "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters required in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RunCommand", + "summary": "Submits a command to run against the Managed Cluster.", + "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "requestPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandRequest" + }, + "description": "The run command request" + } + ], + "responses": { + "200": { + "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "submitNewCommand": { + "$ref": "./examples/RunCommandRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetCommandResult", + "summary": "Gets the results of a command which has been run on the Managed Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the command." + } + ], + "responses": { + "200": { + "description": "command finished", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "command running in progress", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "commandSucceedResult": { + "$ref": "./examples/RunCommandResultSucceed.json" + }, + "commandFailedResult": { + "$ref": "./examples/RunCommandResultFailed.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints", + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.", + "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Managed Cluster": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/operations": { + "get": { + "tags": [ + "OperationStatusResult" + ], + "operationId": "OperationStatusResult_List", + "summary": "Gets a list of operations in the specified managedCluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List of OperationStatusResult": { + "$ref": "./examples/OperationStatusResultList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/operations/{operationId}": { + "get": { + "tags": [ + "OperationStatusResult" + ], + "operationId": "OperationStatusResult_Get", + "summary": "Get the status of a specific operation in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatusResult": { + "$ref": "./examples/OperationStatusResultGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/operations/{operationId}": { + "get": { + "tags": [ + "OperationStatusResult" + ], + "operationId": "OperationStatusResult_GetByAgentPool", + "summary": "Get the status of a specific operation in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatusResult": { + "$ref": "./examples/OperationStatusResultGetByAgentPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Gets a list of snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots": { + "$ref": "./examples/SnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "summary": "Lists snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots by Resource Group": { + "$ref": "./examples/SnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Gets a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Snapshot": { + "$ref": "./examples/SnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "summary": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "201": { + "description": "The new snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Snapshot": { + "$ref": "./examples/SnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_UpdateTags", + "summary": "Updates tags on a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Snapshot Tags": { + "$ref": "./examples/SnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Snapshot": { + "$ref": "./examples/SnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedclustersnapshots": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_List", + "summary": "Gets a list of managed cluster snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Cluster Snapshots": { + "$ref": "./examples/ManagedClusterSnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_ListByResourceGroup", + "summary": "Lists managed cluster snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Cluster Snapshots by Resource Group": { + "$ref": "./examples/ManagedClusterSnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots/{resourceName}": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_Get", + "summary": "Gets a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_CreateOrUpdate", + "summary": "Creates or updates a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + }, + "description": "The managed cluster snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing managed cluster snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "201": { + "description": "The new managed cluster snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Managed Cluster Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_UpdateTags", + "summary": "Updates tags on a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update managed cluster snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Managed Cluster Snapshot Tags": { + "$ref": "./examples/ManagedClusterSnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_Delete", + "summary": "Deletes a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Managed Cluster Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoles_List", + "summary": "List supported trusted access roles.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access roles": { + "$ref": "./examples/TrustedAccessRoles_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_List", + "summary": "List trusted access role bindings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBindingListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access role bindings": { + "$ref": "./examples/TrustedAccessRoleBindings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Get", + "summary": "Get a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Get.json" + } + } + }, + "put": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_CreateOrUpdate", + "summary": "Create or update a trusted access role binding", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + }, + { + "name": "trustedAccessRoleBinding", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "A trusted access role binding" + } + ], + "responses": { + "200": { + "description": "The existing trusted access role binding was successfully updated.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "201": { + "description": "The new trusted access role binding was successfully created.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Delete", + "summary": "Delete a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/guardrailsVersions/{version}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetGuardrailsVersions", + "summary": "Gets supported Guardrails version in the specified subscription and location.", + "description": "Contains Guardrails version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/VersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuardrailsAvailableVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get guardrails available versions": { + "$ref": "./examples/GetGuardrailsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/guardrailsVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListGuardrailsVersions", + "summary": "Gets a list of supported Guardrails versions in the specified subscription and location.", + "description": "Contains list of Guardrails version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuardrailsAvailableVersionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Guardrails Versions": { + "$ref": "./examples/ListGuardrailsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions/{version}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetSafeguardsVersions", + "summary": "Gets supported Safeguards version in the specified subscription and location.", + "description": "Contains Safeguards version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/VersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SafeguardsAvailableVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Safeguards available versions": { + "$ref": "./examples/GetSafeguardsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListSafeguardsVersions", + "summary": "Gets a list of supported Safeguards versions in the specified subscription and location.", + "description": "Contains list of Safeguards version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SafeguardsAvailableVersionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Safeguards Versions": { + "$ref": "./examples/ListSafeguardsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshRevisionProfiles", + "summary": "Lists mesh revision profiles for all meshes in the specified location.", + "description": "Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List mesh revision profiles in a location": { + "$ref": "./examples/ManagedClustersList_MeshRevisionProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshRevisionProfile", + "summary": "Gets a mesh revision profile for a specified mesh in the specified location.", + "description": "Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a mesh revision profile for a mesh mode": { + "$ref": "./examples/ManagedClustersGet_MeshRevisionProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshUpgradeProfiles", + "summary": "Lists available upgrades for all service meshes in a specific cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists version compatibility and upgrade profile for all service meshes in a cluster": { + "$ref": "./examples/ManagedClustersList_MeshUpgradeProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshUpgradeProfile", + "summary": "Gets available upgrades for a service mesh in a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets version compatibility and upgrade profile for a service mesh in a cluster": { + "$ref": "./examples/ManagedClustersGet_MeshUpgradeProfile.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "x-ms-identifiers": [], + "description": "The list of operations" + } + }, + "description": "The List Operation response." + }, + "OperationValue": { + "type": "object", + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Operation Value Display." + } + }, + "description": "Describes the properties of a Operation value." + }, + "OperationValueDisplay": { + "type": "object", + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Operation Value Display." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 2048, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ManagedClusterServicePrincipalProfile": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "VirtualMachinesProfile": { + "type": "object", + "properties": { + "scale": { + "$ref": "#/definitions/ScaleProfile", + "description": "Specifications on how to scale a VirtualMachines agent pool." + } + }, + "description": "Specifications on VirtualMachines agent pool." + }, + "ScaleProfile": { + "type": "object", + "properties": { + "manual": { + "type": "array", + "items": { + "$ref": "#/definitions/ManualScaleProfile" + }, + "x-ms-identifiers": [], + "description": "Specifications on how to scale the VirtualMachines agent pool to a fixed size." + } + }, + "description": "Specifications on how to scale a VirtualMachines agent pool." + }, + "ManualScaleProfile": { + "type": "object", + "properties": { + "sizes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of allowed vm sizes. AKS will use the first available one when scaling. If a VM size is unavailable (e.g. due to quota or regional capacity reasons), AKS will use the next size." + }, + "count": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 1000, + "description": "Number of nodes." + } + }, + "description": "Specifications on number of machines." + }, + "VirtualMachineNodesStatus": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineNodes" + }, + "x-ms-identifiers": [], + "description": "The status of nodes in a VirtualMachines agent pool." + }, + "VirtualMachineNodes": { + "type": "object", + "properties": { + "size": { + "type": "string", + "description": "The VM size of the agents used to host this group of nodes." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of nodes." + } + }, + "description": "Current status on a group of nodes of the same vm size." + }, + "ManagedClusterAgentPoolProfileProperties": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "type": "string", + "title": "The size of the agent pool VMs.", + "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "workloadRuntime": { + "$ref": "#/definitions/WorkloadRuntime" + }, + "messageOfTheDay": { + "type": "string", + "title": "Message of the day for Linux nodes, base64-encoded.", + "description": "A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)." + }, + "vnetSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which agent pool nodes and optionally pods will join on startup.", + "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which pods will join when launched.", + "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "scaleDownMode": { + "$ref": "#/definitions/ScaleDownMode", + "title": "The scale down mode to use when scaling the Agent Pool.", + "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete." + }, + "type": { + "$ref": "#/definitions/AgentPoolType" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode" + }, + "orchestratorVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)." + }, + "currentOrchestratorVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes running on the Agent Pool.", + "description": "If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "powerState": { + "title": "Whether the Agent Pool is running or stopped.", + "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'." + }, + "enableNodePublicIP": { + "type": "boolean", + "title": "Whether each node is allocated its own public IP.", + "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false." + }, + "enableCustomCATrust": { + "type": "boolean", + "title": "Whether to enable Custom CA Trust feature.", + "description": "When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "title": "The public IP prefix ID which VM nodes should use IPs from.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "title": "The Virtual Machine Scale Set eviction policy to use.", + "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "nodeInitializationTaints": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Taints added on the nodes during creation that will not be reconciled by AKS.", + "description": "These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example 'key1=value1:NoSchedule' that then can be removed with `kubectl taint nodes node1 key1=value1:NoSchedule-`" + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the agent pool nodes." + }, + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux agent nodes." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "title": "Whether to enable host based OS and data drive encryption.", + "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption" + }, + "enableUltraSSD": { + "type": "boolean", + "description": "Whether to enable UltraSSD" + }, + "enableFIPS": { + "type": "boolean", + "title": "Whether to use a FIPS-enabled OS.", + "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details." + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot." + }, + "capacityReservationGroupID": { + "$ref": "#/definitions/CapacityReservationGroupID", + "description": "AKS will associate the specified agent pool with the Capacity Reservation Group." + }, + "hostGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/hostGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)." + }, + "windowsProfile": { + "$ref": "#/definitions/AgentPoolWindowsProfile", + "description": "The Windows agent pool's specific profile." + }, + "networkProfile": { + "$ref": "#/definitions/AgentPoolNetworkProfile", + "description": "Network-related settings of an agent pool." + }, + "securityProfile": { + "$ref": "#/definitions/AgentPoolSecurityProfile", + "description": "The security settings of an agent pool." + }, + "gpuProfile": { + "$ref": "#/definitions/AgentPoolGPUProfile", + "description": "The GPU settings of an agent pool." + }, + "artifactStreamingProfile": { + "$ref": "#/definitions/AgentPoolArtifactStreamingProfile", + "description": "Configuration for using artifact streaming on AKS." + }, + "virtualMachinesProfile": { + "$ref": "#/definitions/VirtualMachinesProfile" + }, + "virtualMachineNodesStatus": { + "$ref": "#/definitions/VirtualMachineNodesStatus" + } + }, + "description": "Properties for the container service agent pool profile." + }, + "AgentPoolNetworkProfile": { + "type": "object", + "properties": { + "nodePublicIPTags": { + "$ref": "#/definitions/NodePublicIPTags", + "description": "IPTags of instance-level public IPs." + }, + "allowedHostPorts": { + "type": "array", + "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap.", + "items": { + "$ref": "#/definitions/PortRange" + }, + "x-ms-identifiers": [] + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/applicationSecurityGroups" + } + ] + } + }, + "description": "The IDs of the application security groups which agent pool will associate when created." + } + }, + "description": "Network settings of an agent pool." + }, + "NodePublicIPTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IPTag" + }, + "x-ms-identifiers": [], + "description": "The list of tags associated with the node public IP address." + }, + "IPTag": { + "type": "object", + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type. Example: RoutingPreference." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag associated with the public IP. Example: Internet." + } + }, + "description": "Contains the IPTag associated with the object." + }, + "PortRange": { + "type": "object", + "description": "The port range.", + "properties": { + "portStart": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd." + }, + "portEnd": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart." + }, + "protocol": { + "type": "string", + "description": "The network protocol of the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true, + "values": [ + { + "value": "TCP", + "description": "TCP protocol." + }, + { + "value": "UDP", + "description": "UDP protocol." + } + ] + } + } + } + }, + "ManagedClusterAgentPoolProfile": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + } + ], + "properties": { + "name": { + "type": "string", + "title": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "description": "Windows agent pool names must be 6 characters or less.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + }, + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet", + "VirtualMachines" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true, + "values": [ + { + "value": "VirtualMachineScaleSets", + "description": "Create an Agent Pool backed by a Virtual Machine Scale Set." + }, + { + "value": "AvailabilitySet", + "description": "Use of this is strongly discouraged." + }, + { + "value": "VirtualMachines", + "description": "Create an Agent Pool backed by a Single Instance VM orchestration mode." + } + ] + }, + "description": "The type of Agent Pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory." + }, + { + "value": "User", + "description": "User agent pools are primarily for hosting your application pods." + } + ] + }, + "title": "The mode of an agent pool.", + "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools" + }, + "AgentPoolListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "properties": { + "maxSurge": { + "type": "string", + "title": "The maximum number or percentage of nodes that are surged during upgrade.", + "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade" + }, + "drainTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 1440, + "minimum": 1, + "title": "The drain timeout for a node", + "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes." + }, + "nodeSoakDurationInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 30, + "minimum": 0, + "title": "The soak duration for a node", + "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes." + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + }, + "description": "Agent Pool." + }, + "MachineListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [ + "id" + ], + "items": { + "$ref": "#/definitions/Machine" + }, + "description": "The list of Machines in cluster." + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The URL to get the next set of machine results.", + "readOnly": true + } + }, + "description": "The response from the List Machines operation." + }, + "Machine": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MachineProperties", + "description": "The properties of the machine" + } + }, + "description": "A machine. Contains details about the underlying virtual machine. A machine may be visible here but not in kubectl get nodes; if so it may be because the machine has not been registered with the Kubernetes API Server yet." + }, + "MachineProperties": { + "type": "object", + "readOnly": true, + "description": "The properties of the machine", + "properties": { + "network": { + "$ref": "#/definitions/MachineNetworkProperties" + }, + "resourceId": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/virtualMachines" + } + ] + }, + "description": "Arm resource id of the machine. It can be used to GET underlying VM Instance" + } + } + }, + "MachineNetworkProperties": { + "type": "object", + "readOnly": true, + "description": "network properties of the machine", + "properties": { + "ipAddresses": { + "type": "array", + "x-ms-identifiers": [], + "readOnly": true, + "description": "IPv4, IPv6 addresses of the machine", + "items": { + "$ref": "#/definitions/MachineIpAddress" + } + } + } + }, + "MachineIpAddress": { + "type": "object", + "readOnly": true, + "description": "The machine IP address details.", + "properties": { + "ip": { + "type": "string", + "readOnly": true, + "description": "IPv4 or IPv6 address of the machine" + }, + "family": { + "$ref": "#/definitions/ipFamily", + "readOnly": true, + "description": "To determine if address belongs IPv4 or IPv6 family." + } + } + }, + "ipFamily": { + "type": "string", + "description": "To determine if address belongs IPv4 or IPv6 family.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "ipFamily", + "modelAsString": true, + "values": [ + { + "value": "IPv4", + "description": "IPv4 family" + }, + { + "value": "IPv6", + "description": "IPv6 family" + } + ] + } + }, + "ManagedClusterWindowsProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**Restriction:** Cannot end in \".\"

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

**Minimum-length:** 1 character

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

**Minimum-length:** 8 characters

**Max-length:** 123 characters

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

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"" + }, + "licenseType": { + "type": "string", + "enum": [ + "None", + "Windows_Server" + ], + "x-ms-enum": { + "name": "licenseType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No additional licensing is applied." + }, + { + "value": "Windows_Server", + "description": "Enables Azure Hybrid User Benefits for Windows VMs." + } + ] + }, + "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details." + }, + "enableCSIProxy": { + "type": "boolean", + "title": "Whether to enable CSI proxy.", + "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)." + }, + "gmsaProfile": { + "$ref": "#/definitions/WindowsGmsaProfile", + "description": "The Windows gMSA Profile in the Managed Cluster." + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the managed cluster." + }, + "WindowsGmsaProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable Windows gMSA.", + "description": "Specifies whether to enable Windows gMSA in the managed cluster." + }, + "dnsServer": { + "type": "string", + "description": "Specifies the DNS server for Windows gMSA.

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

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + } + }, + "description": "Windows gMSA Profile in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ManagedClusterNodeResourceGroupProfile": { + "type": "object", + "properties": { + "restrictionLevel": { + "type": "string", + "enum": [ + "Unrestricted", + "ReadOnly" + ], + "x-ms-enum": { + "name": "RestrictionLevel", + "modelAsString": true, + "values": [ + { + "value": "Unrestricted", + "description": "All RBAC permissions are allowed on the managed node resource group" + }, + { + "value": "ReadOnly", + "description": "Only */read RBAC permissions allowed on the managed node resource group" + } + ] + }, + "description": "The restriction level applied to the cluster's node resource group" + } + }, + "description": "Node resource group lockdown profile for a managed cluster." + }, + "ContainerServiceNetworkProfile": { + "type": "object", + "properties": { + "networkPlugin": { + "$ref": "#/definitions/NetworkPlugin", + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPluginMode": { + "$ref": "#/definitions/NetworkPluginMode", + "description": "Network plugin mode used for building the Kubernetes network." + }, + "networkPolicy": { + "$ref": "#/definitions/NetworkPolicy", + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "$ref": "#/definitions/NetworkMode", + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "networkDataplane": { + "$ref": "#/definitions/NetworkDataplane", + "description": "Network dataplane used in the Kubernetes cluster." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting", + "managedNATGateway", + "userAssignedNATGateway" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + }, + { + "value": "managedNATGateway", + "description": "The AKS-managed NAT gateway is used for egress." + }, + { + "value": "userAssignedNATGateway", + "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration." + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "$ref": "#/definitions/LoadBalancerSku", + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + }, + "natGatewayProfile": { + "$ref": "#/definitions/ManagedClusterNATGatewayProfile", + "description": "Profile of the cluster NAT gateway." + }, + "podCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign pod IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking." + }, + "serviceCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign service cluster IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges." + }, + "ipFamilies": { + "type": "array", + "items": { + "$ref": "#/definitions/ipFamily", + "description": "The IP version to use for cluster networking and IP assignment." + }, + "title": "The IP families used to specify IP versions available to the cluster.", + "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6." + }, + "kubeProxyConfig": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable on kube-proxy on the cluster (if no 'kubeProxyConfig' exists, kube-proxy is enabled in AKS by default without these customizations)." + }, + "mode": { + "type": "string", + "enum": [ + "IPTABLES", + "IPVS" + ], + "x-ms-enum": { + "name": "mode", + "modelAsString": true, + "values": [ + { + "value": "IPTABLES", + "description": "IPTables proxy mode" + }, + { + "value": "IPVS", + "description": "IPVS proxy mode. Must be using Kubernetes version >= 1.22." + } + ] + }, + "description": "Specify which proxy mode to use ('IPTABLES' or 'IPVS')" + }, + "ipvsConfig": { + "type": "object", + "properties": { + "scheduler": { + "type": "string", + "enum": [ + "RoundRobin", + "LeastConnection" + ], + "x-ms-enum": { + "name": "ipvsScheduler", + "modelAsString": true, + "values": [ + { + "value": "RoundRobin", + "description": "Round Robin" + }, + { + "value": "LeastConnection", + "description": "Least Connection" + } + ] + }, + "description": "IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html." + }, + "tcpTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value." + }, + "tcpFinTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value." + }, + "udpTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value." + } + }, + "description": "Holds configuration customizations for IPVS. May only be specified if 'mode' is set to 'IPVS'." + } + }, + "description": "Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be '1-23'." + }, + "monitoring": { + "$ref": "#/definitions/NetworkMonitoring" + } + }, + "description": "Profile of network configuration." + }, + "MaintenanceConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "MaintenanceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.", + "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "type": "object", + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "title": "Time slots during the week when planned maintenance is allowed to proceed.", + "x-ms-identifiers": [], + "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "x-ms-identifiers": [], + "description": "Time slots on which upgrade is not allowed." + }, + "maintenanceWindow": { + "type": "object", + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window for the maintenance configuration." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "MaintenanceWindow": { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "Recurrence schedule for the maintenance window." + }, + "durationHours": { + "type": "integer", + "format": "int32", + "minimum": 4, + "maximum": 24, + "default": 24, + "description": "Length of maintenance window range from 4 to 24 hours." + }, + "utcOffset": { + "type": "string", + "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$", + "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away." + }, + "startTime": { + "type": "string", + "pattern": "^\\d{2}:\\d{2}$", + "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'." + }, + "notAllowedDates": { + "type": "array", + "items": { + "$ref": "#/definitions/DateSpan" + }, + "x-ms-identifiers": [], + "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time." + } + }, + "description": "Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.", + "required": [ + "schedule", + "durationHours", + "startTime" + ] + }, + "Schedule": { + "type": "object", + "properties": { + "daily": { + "$ref": "#/definitions/DailySchedule" + }, + "weekly": { + "$ref": "#/definitions/WeeklySchedule" + }, + "absoluteMonthly": { + "$ref": "#/definitions/AbsoluteMonthlySchedule" + }, + "relativeMonthly": { + "$ref": "#/definitions/RelativeMonthlySchedule" + } + }, + "description": "One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule." + }, + "DailySchedule": { + "type": "object", + "properties": { + "intervalDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 7, + "description": "Specifies the number of days between each set of occurrences." + } + }, + "description": "For schedules like: 'recur every day' or 'recur every 3 days'.", + "required": [ + "intervalDays" + ] + }, + "WeeklySchedule": { + "type": "object", + "properties": { + "intervalWeeks": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4, + "description": "Specifies the number of weeks between each set of occurrences." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.", + "required": [ + "intervalWeeks", + "dayOfWeek" + ] + }, + "AbsoluteMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "dayOfMonth": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 31, + "description": "The date of the month." + } + }, + "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.", + "required": [ + "intervalMonths", + "dayOfMonth" + ] + }, + "RelativeMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "weekIndex": { + "type": "string", + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "First", + "description": "First." + }, + { + "value": "Second", + "description": "Second." + }, + { + "value": "Third", + "description": "Third." + }, + { + "value": "Fourth", + "description": "Fourth." + }, + { + "value": "Last", + "description": "Last." + } + ] + }, + "title": "The week index.", + "description": "Specifies on which instance of the allowed days specified in daysOfWeek the maintenance occurs." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.", + "required": [ + "intervalMonths", + "weekIndex", + "dayOfWeek" + ] + }, + "DateSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date", + "description": "The start date of the date span." + }, + "end": { + "type": "string", + "format": "date", + "description": "The end date of the date span." + } + }, + "title": "A date range.", + "description": "For example, between '2022-12-23' and '2023-01-05'.", + "required": [ + "start", + "end" + ] + }, + "TimeInWeek": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "title": "A list of hours in the day used to identify a time range.", + "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "title": "A time range.", + "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterNATGatewayProfile": { + "type": "object", + "properties": { + "managedOutboundIPProfile": { + "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile", + "description": "Profile of the managed outbound IP resources of the cluster NAT gateway." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster NAT gateway." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.", + "default": 4 + } + }, + "description": "Profile of the managed cluster NAT gateway." + }, + "ManagedClusterManagedOutboundIPProfile": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 16, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Profile of the managed outbound IP resources of the managed cluster." + }, + "ManagedClusterLoadBalancerProfile": { + "type": "object", + "properties": { + "managedOutboundIPs": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "countIPv6": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0, + "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ", + "default": 0 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "type": "object", + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "type": "object", + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + }, + "enableMultipleStandardLoadBalancers": { + "type": "boolean", + "description": "Enable multiple standard load balancers per AKS cluster or not." + }, + "backendPoolType": { + "type": "string", + "x-ms-enum": { + "name": "BackendPoolType", + "modelAsString": true, + "values": [ + { + "value": "NodeIPConfiguration", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + }, + { + "value": "NodeIP", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + } + ] + }, + "enum": [ + "NodeIPConfiguration", + "NodeIP" + ], + "description": "The type of the managed inbound Load Balancer BackendPool.", + "default": "NodeIPConfiguration" + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "x-ms-identifiers": [], + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + }, + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the cluster will be created/upgraded using a snapshot." + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "title": "The version of Kubernetes the Managed Cluster is requested to run.", + "description": "When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "currentKubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes the Managed Cluster is running." + }, + "dnsPrefix": { + "type": "string", + "title": "The DNS prefix of the Managed Cluster.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "title": "The FQDN subdomain of the private cluster with custom private dns zone.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.", + "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "x-ms-identifiers": [], + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "oidcIssuerProfile": { + "$ref": "#/definitions/ManagedClusterOIDCIssuerProfile", + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "nodeResourceGroupProfile": { + "$ref": "#/definitions/ManagedClusterNodeResourceGroupProfile", + "description": "The node resource group configuration profile." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "supportPlan": { + "$ref": "#/definitions/KubernetesSupportPlan", + "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp." + }, + "enableNamespaceResources": { + "type": "boolean", + "title": "Enable namespace as Azure resource.", + "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "upgradeSettings": { + "$ref": "#/definitions/ClusterUpgradeSettings", + "description": "Settings for upgrading a cluster." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "title": "Detects similar node pools and balances the number of nodes between them.", + "description": "Valid values are 'true' and 'false'" + }, + "daemonset-eviction-for-empty-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from empty nodes", + "description": "If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "daemonset-eviction-for-occupied-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from non-empty nodes", + "description": "If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "ignore-daemonsets-utilization": { + "type": "boolean", + "title": "Should CA ignore DaemonSet pods when calculating resource utilization for scaling down", + "description": "If set to true, the resources used by daemonset will be taken into account when making scaling down decisions." + }, + "expander": { + "type": "string", + "title": "Type of node group expander to be used in scale up. Set to be deprecated, please use 'expanders' flag in the future.", + "description": "Available values are: 'least-waste', 'most-pods', 'priority', 'random'.", + "$ref": "#/definitions/expander" + }, + "max-empty-bulk-delete": { + "type": "string", + "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.", + "description": "The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.", + "description": "The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "title": "The maximum time the autoscaler waits for a node to be provisioned.", + "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.", + "description": "The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "title": "Ignore unscheduled pods before they're a certain age.", + "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.", + "description": "This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "title": "How often cluster is reevaluated for scale up or down.", + "description": "The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "title": "How long after scale up that scale down evaluation resumes", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "title": "How long after node deletion that scale down evaluation resumes.", + "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "title": "How long after scale down failure that scale down evaluation resumes.", + "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "title": "How long a node should be unneeded before it is eligible for scale down.", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "title": "How long an unready node should be unneeded before it is eligible for scale down", + "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", + "description": "The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.", + "description": "The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)", + "description": "The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/diskEncryptionSets" + } + ] + }, + "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Identities associated with the cluster." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "title": "If local accounts should be disabled on the Managed Cluster.", + "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + }, + "securityProfile": { + "$ref": "#/definitions/ManagedClusterSecurityProfile", + "description": "Security profile for the managed cluster." + }, + "storageProfile": { + "$ref": "#/definitions/ManagedClusterStorageProfile", + "description": "Storage profile for the managed cluster." + }, + "ingressProfile": { + "$ref": "#/definitions/ManagedClusterIngressProfile", + "description": "Ingress profile for the managed cluster." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled", + "SecuredByPerimeter" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Inbound/Outbound to the managedCluster is allowed." + }, + { + "value": "Disabled", + "description": "Inbound traffic to managedCluster is disabled, traffic from managedCluster is allowed." + }, + { + "value": "SecuredByPerimeter", + "description": "Inbound/Outbound traffic is managed by Microsoft.Network/NetworkSecurityPerimeters." + } + ] + }, + "title": "PublicNetworkAccess of the managedCluster", + "description": "Allow or deny public network access for AKS" + }, + "workloadAutoScalerProfile": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfile" + }, + "azureMonitorProfile": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfile" + }, + "safeguardsProfile": { + "$ref": "#/definitions/SafeguardsProfile", + "description": "The Safeguards profile holds all the safeguards information for a given cluster" + }, + "serviceMeshProfile": { + "$ref": "#/definitions/ServiceMeshProfile" + }, + "resourceUID": { + "readOnly": true, + "type": "string", + "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)" + }, + "metricsProfile": { + "$ref": "#/definitions/ManagedClusterMetricsProfile", + "description": "Optional cluster metrics configuration." + }, + "aiToolchainOperatorProfile": { + "$ref": "#/definitions/ManagedClusterAIToolchainOperatorProfile", + "description": "AI toolchain operator settings that apply to the whole cluster." + }, + "nodeProvisioningProfile": { + "$ref": "#/definitions/ManagedClusterNodeProvisioningProfile", + "description": "Node provisioning settings that apply to the whole cluster." + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "type": "object", + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "title": "The expander to use when scaling up", + "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "ManagedClusterAPIServerAccessProfile": { + "type": "object", + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the Kubernetes API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "title": "Whether to create the cluster as a private cluster or not.", + "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "title": "The private DNS zone mode for the cluster.", + "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + }, + "disableRunCommand": { + "type": "boolean", + "description": "Whether to disable run command for the cluster or not." + }, + "enableVnetIntegration": { + "type": "boolean", + "description": "Whether to enable apiserver vnet integration for the cluster or not." + }, + "subnetId": { + "type": "string", + "title": "The subnet to be used when apiserver vnet integration is enabled.", + "description": "It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "title": "The type of identity used for the managed cluster.", + "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "delegatedResources": { + "$ref": "../../../../../../common-types/resource-management/v4/managedidentitywithdelegation.json#/definitions/DelegatedResources", + "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.", + "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + }, + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "type": "object", + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "x-ms-identifiers": [], + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "type": "object", + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching" + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "title": "The upgrade channel for auto upgrade. The default is 'none'.", + "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + }, + "nodeOSUpgradeChannel": { + "type": "string", + "enum": [ + "Unmanaged", + "None", + "SecurityPatch", + "NodeImage" + ], + "x-ms-enum": { + "name": "nodeOSUpgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates" + }, + { + "value": "Unmanaged", + "description": "OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially, and will be patched at some later time by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice" + }, + { + "value": "SecurityPatch", + "description": "AKS will update the nodes VHD with patches from the image maintainer labelled \"security only\" on a regular basis. Where possible, patches will also be applied without reimaging to existing nodes. Some patches, such as kernel patches, cannot be applied to existing nodes without disruption. For such patches, the VHD will be updated, and machines will be rolling reimaged to that VHD following maintenance windows and surge settings. This option incurs the extra cost of hosting the VHDs in your node resource group." + }, + { + "value": "NodeImage", + "description": "AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images." + } + ] + }, + "title": "Manner in which the OS on your nodes is updated", + "description": "The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "UpgradeOverrideSettings": { + "type": "object", + "properties": { + "forceUpgrade": { + "type": "boolean", + "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution." + }, + "until": { + "type": "string", + "format": "date-time", + "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect." + } + }, + "description": "Settings for overrides when upgrading a cluster." + }, + "ClusterUpgradeSettings": { + "type": "object", + "properties": { + "overrideSettings": { + "$ref": "#/definitions/UpgradeOverrideSettings", + "description": "Settings for overrides." + } + }, + "description": "Settings for upgrading a cluster." + }, + "ManagedClusterAADProfile": { + "type": "object", + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppID": { + "type": "string", + "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppSecret": { + "type": "string", + "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "title": "AADProfile specifies attributes for Azure Active Directory integration.", + "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "type": "object", + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.", + "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.", + "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + }, + "x-ms-identifiers": [] + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + }, + "x-ms-identifiers": [] + } + }, + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterOIDCIssuerProfile": { + "type": "object", + "properties": { + "issuerURL": { + "readOnly": true, + "type": "string", + "description": "The OIDC issuer url of the Managed Cluster." + }, + "enabled": { + "type": "boolean", + "description": "Whether the OIDC issuer is enabled." + } + }, + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "ManagedClusterUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "type": "object", + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "Ubuntu", + "CBLMariner", + "Mariner", + "AzureLinux", + "Windows2019", + "Windows2022", + "WindowsAnnual" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true, + "values": [ + { + "value": "Ubuntu", + "description": "Use Ubuntu as the OS for node images." + }, + { + "value": "Mariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "AzureLinux", + "description": "Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information." + }, + { + "value": "CBLMariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "Windows2019", + "description": "Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa." + }, + { + "value": "Windows2022", + "description": "Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa." + }, + { + "value": "WindowsAnnual", + "description": "Use Windows Annual Channel version as the OS for node images. Unsupported for system node pools. Details about supported container images and kubernetes versions under different AKS Annual Channel versions could be seen in https://aka.ms/aks/windows-annual-channel-details." + } + ] + }, + "description": "Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "title": "The Virtual Machine Scale Set eviction policy.", + "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ScaleDownMode": { + "type": "string", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleDownMode", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Create new instances during scale up and remove instances during scale down." + }, + { + "value": "Deallocate", + "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down." + } + ] + }, + "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)." + }, + "ProximityPlacementGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/proximityPlacementGroups" + } + ] + }, + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "type": "object", + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "type": "object", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for 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 Container service." + }, + "ManagedClusterSKU": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Base" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true, + "values": [ + { + "value": "Base", + "description": "Base option for the AKS control plane." + } + ] + } + }, + "tier": { + "type": "string", + "title": "The tier of a managed cluster SKU.", + "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details.", + "enum": [ + "Premium", + "Standard", + "Free" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions." + }, + { + "value": "Standard", + "description": "Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Canceled", + "Creating", + "Deleting", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "title": "The OS disk type to be used for machines in the agent pool.", + "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "WorkloadRuntime": { + "type": "string", + "enum": [ + "OCIContainer", + "WasmWasi", + "KataMshvVmIsolation" + ], + "x-ms-enum": { + "name": "WorkloadRuntime", + "modelAsString": true, + "values": [ + { + "value": "OCIContainer", + "description": "Nodes will use Kubelet to run standard OCI container workloads." + }, + { + "value": "WasmWasi", + "description": "Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview)." + }, + { + "value": "KataMshvVmIsolation", + "description": "Nodes can use (Kata + Cloud Hypervisor + Hyper-V) to enable Nested VM-based pods (Preview). Due to the use Hyper-V, AKS node OS itself is a nested VM (the root OS) of Hyper-V. Thus it can only be used with VM series that support Nested Virtualization such as Dv3 series." + } + ] + }, + "description": "Determines the type of workload a node can run." + }, + "KubeletConfig": { + "title": "Kubelet configurations of agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "title": "The CPU Manager policy to use.", + "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.", + "description": "The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "title": "The CPU CFS quota period value.", + "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage after which image garbage collection is always run.", + "description": "To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage before which image garbage collection is never run.", + "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "title": "The Topology Manager policy to use.", + "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + } + } + }, + "LinuxOSConfig": { + "title": "OS configurations of Linux agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "title": "Whether transparent hugepages are enabled.", + "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.", + "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "AgentPoolWindowsProfile": { + "type": "object", + "description": "The Windows agent pool's specific profile.", + "properties": { + "disableOutboundNat": { + "type": "boolean", + "title": "Whether to disable OutboundNAT in windows nodes", + "description": "The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled." + } + } + }, + "AgentPoolSecurityProfile": { + "type": "object", + "properties": { + "sshAccess": { + "$ref": "#/definitions/AgentPoolSSHAccess", + "description": "SSH access method of an agent pool." + }, + "enableVTPM": { + "type": "boolean", + "description": "vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false." + }, + "enableSecureBoot": { + "type": "boolean", + "description": "Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false." + } + }, + "description": "The security settings of an agent pool." + }, + "AgentPoolGPUProfile": { + "type": "object", + "properties": { + "installGPUDriver": { + "type": "boolean", + "title": "Whether to auto install GPU drivers or not.", + "description": "The default value is true when the vmSize of the agent pool contains a GPU, false otherwise. GPU Driver Installation can only be set true when VM has an associated GPU resource. Setting this field to false prevents automatic GPU driver installation. In that case, in order for the GPU to be usable, the user must perform GPU driver installation themselves." + } + } + }, + "AgentPoolArtifactStreamingProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Artifact streaming speeds up the cold-start of containers on a node through on-demand image loading. To use this feature, container images must also enable artifact streaming on ACR. If not specified, the default is false." + } + } + }, + "AgentPoolSSHAccess": { + "type": "string", + "enum": [ + "LocalUser", + "Disabled" + ], + "x-ms-enum": { + "name": "AgentPoolSSHAccess", + "modelAsString": true, + "values": [ + { + "value": "LocalUser", + "description": "Can SSH onto the node as a local user using private key." + }, + { + "value": "Disabled", + "description": "SSH service will be turned off on the node." + } + ] + }, + "description": "SSH access method of an agent pool." + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "minimum": 10, + "maximum": 90, + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "minimum": 131072, + "maximum": 2097152, + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "minimum": 65536, + "maximum": 524288, + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "effectiveNoProxy": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "A read-only list of all endpoints for which traffic should not be sent to the proxy. This list is a superset of noProxy and values injected by AKS." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "OSOptionProperty": { + "type": "object", + "properties": { + "os-type": { + "type": "string", + "description": "The OS type." + }, + "enable-fips-image": { + "type": "boolean", + "description": "Whether the image is FIPS-enabled." + } + }, + "required": [ + "os-type", + "enable-fips-image" + ], + "description": "OS option property." + }, + "OSOptionPropertyList": { + "type": "object", + "properties": { + "osOptionPropertyList": { + "type": "array", + "items": { + "$ref": "#/definitions/OSOptionProperty" + }, + "x-ms-identifiers": [], + "description": "The list of OS options." + } + }, + "required": [ + "osOptionPropertyList" + ], + "description": "The list of OS option properties." + }, + "OSOptionProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the OS option resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the OS option resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the OS option resource." + }, + "properties": { + "$ref": "#/definitions/OSOptionPropertyList", + "description": "The list of OS options.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The OS option profile." + }, + "GuardrailsAvailableVersionsProperties": { + "type": "object", + "description": "Whether the version is default or not and support info.", + "properties": { + "isDefaultVersion": { + "type": "boolean", + "readOnly": true + }, + "support": { + "type": "string", + "enum": [ + "Preview", + "Stable" + ], + "x-ms-enum": { + "name": "GuardrailsSupport", + "modelAsString": true, + "values": [ + { + "value": "Preview", + "description": "The version is preview. It is not recommended to use preview versions on critical production clusters. The preview version may not support all use-cases." + }, + { + "value": "Stable", + "description": "The version is stable and can be used on critical production clusters." + } + ] + }, + "description": "Whether the version is preview or stable.", + "readOnly": true + } + } + }, + "GuardrailsAvailableVersion": { + "type": "object", + "description": "Available Guardrails Version", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/GuardrailsAvailableVersionsProperties" + } + }, + "required": [ + "properties" + ] + }, + "GuardrailsAvailableVersionsList": { + "type": "object", + "description": "Hold values properties, which is array of GuardrailsVersions", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuardrailsAvailableVersion" + }, + "description": "Array of AKS supported Guardrails versions." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next Guardrails available version.", + "readOnly": true + } + } + }, + "SafeguardsAvailableVersionsProperties": { + "type": "object", + "description": "Whether the version is default or not and support info.", + "properties": { + "isDefaultVersion": { + "type": "boolean", + "readOnly": true + }, + "support": { + "type": "string", + "enum": [ + "Preview", + "Stable" + ], + "x-ms-enum": { + "name": "SafeguardsSupport", + "modelAsString": true, + "values": [ + { + "value": "Preview", + "description": "The version is preview. It is not recommended to use preview versions on critical production clusters. The preview version may not support all use-cases." + }, + { + "value": "Stable", + "description": "The version is stable and can be used on critical production clusters." + } + ] + }, + "description": "Whether the version is preview or stable.", + "readOnly": true + } + } + }, + "SafeguardsAvailableVersion": { + "type": "object", + "description": "Available Safeguards Version", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SafeguardsAvailableVersionsProperties" + } + }, + "required": [ + "properties" + ] + }, + "SafeguardsAvailableVersionsList": { + "type": "object", + "description": "Hold values properties, which is array of SafeguardsVersions", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SafeguardsAvailableVersion" + }, + "description": "Array of AKS supported Safeguards versions." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next Safeguards available version.", + "readOnly": true + } + } + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [] + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterSecurityProfile": { + "type": "object", + "properties": { + "defender": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefender", + "description": "Microsoft Defender settings for the security profile." + }, + "azureKeyVaultKms": { + "$ref": "#/definitions/AzureKeyVaultKms", + "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile." + }, + "workloadIdentity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileWorkloadIdentity", + "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details." + }, + "imageCleaner": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageCleaner", + "description": "Image Cleaner settings for the security profile." + }, + "imageIntegrity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageIntegrity", + "description": "Image integrity is a feature that works with Azure Policy to verify image integrity by signature. This will not have any effect unless Azure Policy is applied to enforce image signatures. See https://aka.ms/aks/image-integrity for how to use this feature via policy." + }, + "nodeRestriction": { + "$ref": "#/definitions/ManagedClusterSecurityProfileNodeRestriction", + "description": "[Node Restriction](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#noderestriction) settings for the security profile." + }, + "customCATrustCertificates": { + "$ref": "#/definitions/ManagedClusterSecurityProfileCustomCATrustCertificates", + "description": "A list of up to 10 base64 encoded CAs that will be added to the trust store on nodes with the Custom CA Trust feature enabled. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority)" + } + }, + "description": "Security profile for the container service cluster." + }, + "ManagedClusterSecurityProfileDefender": { + "type": "object", + "properties": { + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty." + }, + "securityMonitoring": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityMonitoring", + "description": "Microsoft Defender threat detection for Cloud settings for the security profile." + } + }, + "description": "Microsoft Defender settings for the security profile." + }, + "ManagedClusterSecurityProfileDefenderSecurityMonitoring": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Defender threat detection" + } + }, + "description": "Microsoft Defender settings for the security profile threat detection." + }, + "ManagedClusterStorageProfile": { + "type": "object", + "properties": { + "diskCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileDiskCSIDriver", + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "fileCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileFileCSIDriver", + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "snapshotController": { + "$ref": "#/definitions/ManagedClusterStorageProfileSnapshotController", + "description": "Snapshot Controller settings for the storage profile." + }, + "blobCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileBlobCSIDriver", + "description": "AzureBlob CSI Driver settings for the storage profile." + } + }, + "description": "Storage profile for the container service cluster." + }, + "AzureKeyVaultKms": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Azure Key Vault key management service. The default is false." + }, + "keyId": { + "type": "string", + "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty." + }, + "keyVaultNetworkAccess": { + "type": "string", + "enum": [ + "Public", + "Private" + ], + "default": "Public", + "x-ms-enum": { + "name": "KeyVaultNetworkAccessTypes", + "modelAsString": true + }, + "title": "Network access of the key vault", + "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`." + }, + "keyVaultResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty." + } + }, + "description": "Azure Key Vault key management service settings for the security profile." + }, + "ManagedClusterIngressProfile": { + "type": "object", + "properties": { + "webAppRouting": { + "$ref": "#/definitions/ManagedClusterIngressProfileWebAppRouting", + "description": "Web App Routing settings for the ingress profile." + } + }, + "description": "Ingress profile for the container service cluster." + }, + "ManagedClusterIngressProfileWebAppRouting": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Web App Routing." + }, + "dnsZoneResourceIds": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/dnszones" + }, + { + "type": "Microsoft.Network/privateDnsZones" + } + ] + } + }, + "maxItems": 5, + "description": "Resource IDs of the DNS zones to be associated with the Web App Routing add-on. Used only when Web App Routing is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group." + }, + "identity": { + "readOnly": true, + "type": "object", + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Managed identity of the Web Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions." + } + }, + "description": "Web App Routing settings for the ingress profile." + }, + "ManagedClusterSecurityProfileWorkloadIdentity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable workload identity." + } + }, + "description": "Workload identity settings for the security profile." + }, + "ManagedClusterSecurityProfileImageCleaner": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Image Cleaner on AKS cluster." + }, + "intervalHours": { + "type": "integer", + "format": "int32", + "description": "Image Cleaner scanning interval in hours." + } + }, + "description": "Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile." + }, + "ManagedClusterSecurityProfileImageIntegrity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable image integrity. The default value is false." + } + }, + "description": "Image integrity related settings for the security profile." + }, + "ManagedClusterSecurityProfileNodeRestriction": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Node Restriction" + } + }, + "description": "Node Restriction settings for the security profile." + }, + "ManagedClusterSecurityProfileCustomCATrustCertificates": { + "type": "array", + "items": { + "type": "string", + "format": "byte" + }, + "minItems": 0, + "maxItems": 10, + "title": "The list of base64 encoded certificate strings that will be added to the node trust store. At most 10 strings can be provided.", + "description": "Certificates will only be added to trust stores on node pools that have enableCustomCATrust field set to true. If updated, the new list of certificates will be installed in the trust store in place of the old certificates. The certificates are applied asynchronously and will be available a short time after the list is updated." + }, + "ManagedClusterStorageProfileDiskCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureDisk CSI Driver. The default value is true." + }, + "version": { + "type": "string", + "description": "The version of AzureDisk CSI Driver. The default value is v1." + } + }, + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileFileCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureFile CSI Driver. The default value is true." + } + }, + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileSnapshotController": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Snapshot Controller. The default value is true." + } + }, + "description": "Snapshot Controller settings for the storage profile." + }, + "ManagedClusterStorageProfileBlobCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureBlob CSI Driver. The default value is false." + } + }, + "description": "AzureBlob CSI Driver settings for the storage profile." + }, + "CreationData": { + "description": "Data used when creating a target resource from a source resource.", + "type": "object", + "properties": { + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "This is the ARM ID of the source object to be used to create the target object." + } + } + }, + "SnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Snapshots operation." + }, + "ManagedClusterSnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterSnapshot" + }, + "description": "The list of managed cluster snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Cluster Snapshots operation." + }, + "Snapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a snapshot.", + "$ref": "#/definitions/SnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A node pool snapshot resource." + }, + "ManagedClusterSnapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a managed cluster snapshot.", + "$ref": "#/definitions/ManagedClusterSnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A managed cluster snapshot resource." + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image." + }, + "osType": { + "readOnly": true, + "$ref": "#/definitions/OSType" + }, + "osSku": { + "readOnly": true, + "$ref": "#/definitions/OSSKU" + }, + "vmSize": { + "readOnly": true, + "type": "string", + "description": "The size of the VM." + }, + "enableFIPS": { + "readOnly": true, + "type": "boolean", + "description": "Whether to use a FIPS-enabled OS." + } + }, + "description": "Properties used to configure a node pool snapshot." + }, + "ManagedClusterSnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "managedClusterPropertiesReadOnly": { + "$ref": "#/definitions/ManagedClusterPropertiesForSnapshot", + "description": "What the properties will be showed when getting managed cluster snapshot. Those properties are read-only." + } + }, + "description": "Properties for a managed cluster snapshot." + }, + "ManagedClusterPropertiesForSnapshot": { + "type": "object", + "readOnly": true, + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The current kubernetes version." + }, + "sku": { + "type": "object", + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The current managed cluster sku." + }, + "enableRbac": { + "type": "boolean", + "description": "Whether the cluster has enabled Kubernetes Role-Based Access Control or not." + }, + "networkProfile": { + "type": "object", + "$ref": "#/definitions/NetworkProfileForSnapshot", + "description": "The current network profile." + } + }, + "description": "managed cluster properties for snapshot, these properties are read only." + }, + "NetworkProfileForSnapshot": { + "type": "object", + "readOnly": true, + "properties": { + "networkPlugin": { + "$ref": "#/definitions/NetworkPlugin", + "description": "networkPlugin for managed cluster snapshot." + }, + "networkPluginMode": { + "$ref": "#/definitions/NetworkPluginMode", + "description": "NetworkPluginMode for managed cluster snapshot." + }, + "networkPolicy": { + "$ref": "#/definitions/NetworkPolicy", + "description": "networkPolicy for managed cluster snapshot." + }, + "networkMode": { + "$ref": "#/definitions/NetworkMode", + "description": "networkMode for managed cluster snapshot." + }, + "loadBalancerSku": { + "$ref": "#/definitions/LoadBalancerSku", + "description": "loadBalancerSku for managed cluster snapshot." + } + }, + "description": "network profile for managed cluster snapshot, these properties are read only." + }, + "NetworkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet", + "none" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + }, + { + "value": "none", + "description": "Do not use a network plugin. A custom CNI will need to be installed after cluster creation for networking functionality." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "NetworkPluginMode": { + "type": "string", + "enum": [ + "overlay" + ], + "x-ms-enum": { + "name": "NetworkPluginMode", + "modelAsString": true, + "values": [ + { + "value": "overlay", + "description": "Pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet reference plugins host-local and bridge." + } + ] + }, + "description": "The mode the network plugin should use." + }, + "NetworkPolicy": { + "type": "string", + "enum": [ + "none", + "calico", + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "none", + "description": "Network policies will not be enforced. This is the default value when NetworkPolicy is not specified." + }, + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "cilium", + "description": "Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "NetworkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "NetworkDataplane": { + "type": "string", + "enum": [ + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "networkDataplane", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use Azure network dataplane." + }, + { + "value": "cilium", + "description": "Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information." + } + ] + }, + "description": "Network dataplane used in the Kubernetes cluster." + }, + "NetworkMonitoring": { + "type": "object", + "description": "This addon can be used to configure network monitoring and generate network monitoring data in Prometheus format", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable the network monitoring plugin on the cluster" + } + } + }, + "LoadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "SnapshotType": { + "type": "string", + "default": "NodePool", + "enum": [ + "NodePool", + "ManagedCluster" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "value": "NodePool", + "description": "The snapshot is a snapshot of a node pool." + }, + { + "value": "ManagedCluster", + "description": "The snapshot is a snapshot of a managed cluster." + } + ] + }, + "description": "The type of a snapshot. The default is NodePool." + }, + "CapacityReservationGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/CapacityReservationGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Capacity Reservation Group to provide virtual machines from a reserved group of Virtual Machines.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Compute/capacityreservationgroups/{capacityReservationGroupName}'. Customers use it to create an agentpool and to update an existing agentpool with a CapacityReservationGroupID. If customers explicitly specify this CapacityReservationGroupID as an empty string, AKS will disassociate the existing CRG from the nodepool. For more information see [Capacity Reservation](https://learn.microsoft.com/en-us/azure/virtual-machines/capacity-reservation-overview)" + }, + "TrustedAccessRoleRule": { + "type": "object", + "description": "Rule for trusted access role", + "properties": { + "verbs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed verbs" + }, + "apiGroups": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed apiGroups" + }, + "resources": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed resources" + }, + "resourceNames": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed names" + }, + "nonResourceURLs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed nonResourceURLs" + } + } + }, + "TrustedAccessRole": { + "type": "object", + "description": "Trusted access role definition.", + "properties": { + "sourceResourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type of Azure resource" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of role, name is unique under a source resource type" + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRoleRule" + }, + "x-ms-identifiers": [], + "description": "List of rules for the role. This maps to 'rules' property of [Kubernetes Cluster Role](https://kubernetes.io/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1/#ClusterRole)." + } + } + }, + "TrustedAccessRoleListResult": { + "type": "object", + "description": "List of trusted access roles", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRole" + }, + "x-ms-identifiers": [ + "sourceResourceType", + "name" + ], + "description": "Role list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "TrustedAccessRoleBindingProperties": { + "type": "object", + "description": "Properties for trusted access role binding", + "required": [ + "sourceResourceId", + "roles" + ], + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of trusted access role binding.", + "enum": [ + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "TrustedAccessRoleBindingProvisioningState", + "modelAsString": true + } + }, + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource ID of source resource that trusted access is configured for." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'." + } + } + }, + "TrustedAccessRoleBinding": { + "type": "object", + "description": "Defines binding between a resource and role", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TrustedAccessRoleBindingProperties", + "x-ms-client-flatten": true + } + } + }, + "TrustedAccessRoleBindingListResult": { + "type": "object", + "description": "List of trusted access role bindings", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "Role binding list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterWorkloadAutoScalerProfile": { + "type": "object", + "description": "Workload Auto-scaler profile for the managed cluster.", + "properties": { + "keda": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileKeda" + }, + "verticalPodAutoscaler": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler" + } + } + }, + "ManagedClusterWorkloadAutoScalerProfileKeda": { + "type": "object", + "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable KEDA." + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable VPA add-on in cluster. Default value is false.", + "default": false + }, + "addonAutoscaling": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "AddonAutoscaling", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Feature to autoscale AKS-managed add-ons is enabled. The default VPA update mode is Initial mode." + }, + { + "value": "Disabled", + "description": "Feature to autoscale AKS-managed add-ons is disabled." + } + ] + }, + "description": "Whether VPA add-on is enabled and configured to scale AKS-managed add-ons.", + "default": "Disabled" + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterAzureMonitorProfile": { + "type": "object", + "description": "Prometheus addon profile for the container service cluster", + "properties": { + "metrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileMetrics" + }, + "logs": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileLogs" + } + } + }, + "ManagedClusterAzureMonitorProfileKubeStateMetrics": { + "type": "object", + "description": "Kube State Metrics for prometheus addon profile for the container service cluster", + "properties": { + "metricLabelsAllowlist": { + "type": "string", + "description": "Comma-separated list of Kubernetes annotations keys that will be used in the resource's labels metric. " + }, + "metricAnnotationsAllowList": { + "type": "string", + "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric." + } + } + }, + "ManagedClusterAzureMonitorProfileMetrics": { + "type": "object", + "description": "Metrics profile for the prometheus service addon", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the Prometheus collector" + }, + "kubeStateMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileKubeStateMetrics" + }, + "appMonitoringOpenTelemetryMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics" + } + }, + "required": [ + "enabled" + ] + }, + "SafeguardsProfile": { + "type": "object", + "properties": { + "systemExcludedNamespaces": { + "readOnly": true, + "type": "array", + "description": "List of namespaces specified by AKS to be excluded from Safeguards", + "items": { + "type": "string" + } + }, + "version": { + "type": "string", + "description": "The version of constraints to use" + }, + "level": { + "type": "string", + "enum": [ + "Off", + "Warning", + "Enforcement" + ], + "x-ms-enum": { + "name": "level", + "modelAsString": true + }, + "description": "The Safeguards level to be used. By default, Safeguards is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces" + }, + "excludedNamespaces": { + "description": "List of namespaces excluded from Safeguards checks", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "level" + ], + "description": "The Safeguards profile." + }, + "ServiceMeshProfile": { + "type": "object", + "description": "Service mesh profile for a managed cluster.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of the service mesh.", + "enum": [ + "Istio", + "Disabled" + ], + "x-ms-enum": { + "name": "ServiceMeshMode", + "modelAsString": true, + "values": [ + { + "value": "Istio", + "description": "Istio deployed as an AKS addon." + }, + { + "value": "Disabled", + "description": "Mesh is disabled." + } + ] + } + }, + "istio": { + "$ref": "#/definitions/IstioServiceMesh" + } + }, + "required": [ + "mode" + ] + }, + "IstioServiceMesh": { + "type": "object", + "description": "Istio service mesh configuration.", + "properties": { + "components": { + "$ref": "#/definitions/IstioComponents" + }, + "certificateAuthority": { + "$ref": "#/definitions/IstioCertificateAuthority" + }, + "revisions": { + "type": "array", + "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade", + "items": { + "type": "string" + }, + "uniqueItems": true, + "maxItems": 2 + } + } + }, + "IstioComponents": { + "type": "object", + "description": "Istio components configuration.", + "properties": { + "ingressGateways": { + "type": "array", + "description": "Istio ingress gateways.", + "items": { + "$ref": "#/definitions/IstioIngressGateway" + }, + "x-ms-identifiers": [] + }, + "egressGateways": { + "type": "array", + "description": "Istio egress gateways.", + "items": { + "$ref": "#/definitions/IstioEgressGateway" + }, + "x-ms-identifiers": [] + } + } + }, + "IstioIngressGateway": { + "type": "object", + "description": "Istio ingress gateway configuration. For now, we support up to one external ingress gateway named `aks-istio-ingressgateway-external` and one internal ingress gateway named `aks-istio-ingressgateway-internal`.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of an ingress gateway.", + "enum": [ + "External", + "Internal" + ], + "x-ms-enum": { + "name": "IstioIngressGatewayMode", + "modelAsString": true, + "values": [ + { + "value": "External", + "description": "The ingress gateway is assigned a public IP address and is publicly accessible." + }, + { + "value": "Internal", + "description": "The ingress gateway is assigned an internal IP address and cannot is accessed publicly." + } + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to enable the ingress gateway." + } + }, + "required": [ + "mode", + "enabled" + ] + }, + "IstioCertificateAuthority": { + "type": "object", + "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca", + "properties": { + "plugin": { + "$ref": "#/definitions/IstioPluginCertificateAuthority" + } + } + }, + "IstioPluginCertificateAuthority": { + "type": "object", + "description": "Plugin certificates information for Service Mesh.", + "properties": { + "keyVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "The resource ID of the Key Vault." + }, + "certObjectName": { + "type": "string", + "description": "Intermediate certificate object name in Azure Key Vault." + }, + "keyObjectName": { + "type": "string", + "description": "Intermediate certificate private key object name in Azure Key Vault." + }, + "rootCertObjectName": { + "type": "string", + "description": "Root certificate object name in Azure Key Vault." + }, + "certChainObjectName": { + "type": "string", + "description": "Certificate chain object name in Azure Key Vault." + } + } + }, + "IstioEgressGateway": { + "type": "object", + "description": "Istio egress gateway configuration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the egress gateway." + }, + "nodeSelector": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "NodeSelector for scheduling the egress gateway." + } + }, + "required": [ + "enabled" + ] + }, + "MeshRevisionProfileList": { + "type": "object", + "description": "Holds an array of MeshRevisionsProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevisionProfile" + }, + "description": "Array of service mesh add-on revision profiles for all supported mesh modes." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh revision profile.", + "readOnly": true + } + } + }, + "MeshRevisionProfile": { + "type": "object", + "description": "Mesh revision profile for a mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshRevisionProfileProperties" + } + } + }, + "MeshRevisionProfileProperties": { + "type": "object", + "description": "Mesh revision profile properties for a mesh", + "properties": { + "meshRevisions": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevision" + } + } + } + }, + "MeshUpgradeProfileList": { + "type": "object", + "description": "Holds an array of MeshUpgradeProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshUpgradeProfile" + }, + "description": "Array of supported service mesh add-on upgrade profiles." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh upgrade profile.", + "readOnly": true + } + } + }, + "MeshUpgradeProfile": { + "type": "object", + "description": "Upgrade profile for given mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshUpgradeProfileProperties" + } + } + }, + "MeshUpgradeProfileProperties": { + "type": "object", + "description": "Mesh upgrade profile properties for a major.minor release.", + "allOf": [ + { + "$ref": "#/definitions/MeshRevision" + } + ] + }, + "MeshRevision": { + "type": "object", + "description": "Holds information on upgrades and compatibility for given major.minor mesh release.", + "properties": { + "revision": { + "type": "string", + "description": "The revision of the mesh release." + }, + "upgrades": { + "type": "array", + "description": "List of revisions available for upgrade of a specific mesh revision", + "items": { + "type": "string", + "description": "An upgradeable mesh revision" + } + }, + "compatibleWith": { + "type": "array", + "description": "List of items this revision of service mesh is compatible with, and their associated versions.", + "items": { + "$ref": "#/definitions/CompatibleVersions" + }, + "x-ms-identifiers": [] + } + } + }, + "CompatibleVersions": { + "type": "object", + "description": "Version information about a product/service that is compatible with a service mesh revision.", + "properties": { + "name": { + "type": "string", + "description": "The product/service name." + }, + "versions": { + "type": "array", + "description": "Product/service versions compatible with a service mesh add-on revision.", + "items": { + "type": "string", + "description": "A compatible product/service version." + } + } + } + }, + "KubernetesSupportPlan": { + "type": "string", + "description": "Different support tiers for AKS managed clusters", + "enum": [ + "KubernetesOfficial", + "AKSLongTermSupport" + ], + "x-ms-enum": { + "name": "KubernetesSupportPlan", + "modelAsString": true, + "values": [ + { + "value": "KubernetesOfficial", + "description": "Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release." + }, + { + "value": "AKSLongTermSupport", + "description": "Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support." + } + ] + } + }, + "KubernetesVersionCapabilities": { + "type": "object", + "description": "Capabilities on this Kubernetes version.", + "properties": { + "supportPlan": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesSupportPlan" + } + } + } + }, + "KubernetesPatchVersion": { + "type": "object", + "description": "Kubernetes patch version profile", + "properties": { + "upgrades": { + "type": "array", + "description": "Possible upgrade path for given patch version", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "KubernetesVersion": { + "type": "object", + "description": "Kubernetes version profile for given major.minor release.", + "properties": { + "version": { + "type": "string", + "description": "major.minor version of Kubernetes release" + }, + "capabilities": { + "$ref": "#/definitions/KubernetesVersionCapabilities", + "description": "Capabilities on this Kubernetes version." + }, + "isPreview": { + "type": "boolean", + "description": "Whether this version is in preview mode." + }, + "patchVersions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KubernetesPatchVersion" + }, + "description": "Patch versions of Kubernetes release" + } + } + }, + "KubernetesVersionListResult": { + "type": "object", + "description": "Hold values properties, which is array of KubernetesVersion", + "properties": { + "values": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesVersion" + }, + "description": "Array of AKS supported Kubernetes versions." + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics": { + "type": "object", + "description": "Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Metrics. Collects OpenTelemetry metrics through auto-instrumentation of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Application Monitoring Open Telemetry Metrics is enabled or not." + } + } + }, + "ManagedClusterAzureMonitorProfileLogs": { + "type": "object", + "description": "Logs profile for the Azure Monitor Infrastructure and Application Logs. Collect out-of-the-box Kubernetes infrastructure & application logs to send to Azure Monitor. See aka.ms/AzureMonitorContainerInsights for an overview.", + "properties": { + "containerInsights": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileContainerInsights" + }, + "appMonitoring": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoring" + } + } + }, + "ManagedClusterAzureMonitorProfileContainerInsights": { + "type": "object", + "description": "Azure Monitor Container Insights Profile for Kubernetes Events, Inventory and Container stdout & stderr logs etc. See aka.ms/AzureMonitorContainerInsights for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Azure Monitor Container Insights Logs Addon is enabled or not." + }, + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Fully Qualified ARM Resource Id of Azure Log Analytics Workspace for storing Azure Monitor Container Insights Logs." + }, + "windowsHostLogs": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileWindowsHostLogs" + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoring": { + "type": "object", + "description": "Application Monitoring Profile for Kubernetes Application Container. Collects application logs, metrics and traces through auto-instrumentation of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Application Monitoring enabled or not." + } + } + }, + "ManagedClusterAzureMonitorProfileWindowsHostLogs": { + "type": "object", + "description": "Windows Host Logs Profile for Kubernetes Windows Nodes Log Collection. Collects ETW, Event Logs and Text logs etc. See aka.ms/AzureMonitorContainerInsights for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Windows Host Log Collection is enabled or not for Azure Monitor Container Insights Logs Addon." + } + } + }, + "ManagedClusterMetricsProfile": { + "type": "object", + "description": "The metrics profile for the ManagedCluster.", + "properties": { + "costAnalysis": { + "$ref": "#/definitions/ManagedClusterCostAnalysis", + "title": "The configuration for detailed per-Kubernetes resource cost analysis." + } + } + }, + "ManagedClusterCostAnalysis": { + "type": "object", + "description": "The cost analysis configuration for the cluster", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable cost analysis", + "description": "The Managed Cluster sku.tier must be set to 'Standard' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis." + } + } + }, + "ManagedClusterAIToolchainOperatorProfile": { + "type": "object", + "description": "When enabling the operator, a set of AKS managed CRDs and controllers will be installed in the cluster. The operator automates the deployment of OSS models for inference and/or training purposes. It provides a set of preset models and enables distributed inference against them.", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable AI toolchain operator to the cluster", + "description": "Indicates if AI toolchain operator enabled or not." + } + } + }, + "ManagedClusterNodeProvisioningProfile": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "enum": [ + "Manual", + "Auto" + ], + "x-ms-enum": { + "name": "NodeProvisioningMode", + "modelAsString": true, + "values": [ + { + "value": "Manual", + "description": "Nodes are provisioned manually by the user" + }, + { + "value": "Auto", + "description": "Nodes are provisioned automatically by AKS using Karpenter. Fixed size Node Pools can still be created, but autoscaling Node Pools cannot be. (See aka.ms/aks/nap for more details)." + } + ] + }, + "title": "The node provisioning mode. If not specified, the default is Manual.", + "description": "Once the mode it set to Auto, it cannot be changed back to Manual." + } + } + }, + "AgentPoolDeleteMachinesParameter": { + "type": "object", + "properties": { + "machineNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The agent pool machine names." + } + }, + "required": [ + "machineNames" + ], + "description": "Specifies a list of machine names from the agent pool to be deleted." + }, + "OperationStatusResultList": { + "description": "The operations list. It contains an URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of operations", + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + } + } + }, + "parameters": { + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "AgentPoolNameParameter": { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + }, + "CredentialFormatParameter": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "exec", + "azure" + ], + "x-ms-enum": { + "name": "format", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Return azure auth-provider kubeconfig. This format is deprecated in v1.22 and will be fully removed in v1.26. See: https://aka.ms/k8s/changes-1-26." + }, + { + "value": "exec", + "description": "Return exec format kubeconfig. This format requires kubelogin binary in the path." + } + ] + }, + "description": "Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.", + "x-ms-parameter-location": "method" + }, + "IgnorePodDisruptionBudgetParameter": { + "name": "ignore-pod-disruption-budget", + "in": "query", + "required": false, + "type": "boolean", + "description": "ignore-pod-disruption-budget=true to delete those pods on a node without considering Pod Disruption Budget", + "x-ms-parameter-location": "method" + }, + "TrustedAccessRoleBindingNameParameter": { + "name": "trustedAccessRoleBindingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of trusted access role binding.", + "pattern": "^([A-Za-z0-9-])+$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "MeshModeParameter": { + "name": "mode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The mode of the mesh.", + "x-ms-parameter-location": "method" + }, + "MachineNameParameter": { + "type": "string", + "description": "host name of the machine", + "name": "machineName", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][-_a-zA-Z0-9]{0,39}$", + "x-ms-parameter-location": "method" + }, + "VersionParameter": { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "description": "Safeguards version", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/scheduledEvents.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/scheduledEvents.json new file mode 100644 index 000000000000..b471170ec182 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/scheduledEvents.json @@ -0,0 +1,136 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2023-11-02-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ScheduledEvent": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Properties for the event.", + "$ref": "#/definitions/ScheduledEventProperties" + } + }, + "description": "Scheduled event." + }, + "ScheduledEventProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the event." + }, + "eventId": { + "type": "string", + "description": "The event id of the event." + }, + "eventSource": { + "type": "string", + "description": "The source of the event." + }, + "eventStatus": { + "type": "string", + "enum": [ + "Scheduled", + "Started", + "Completed", + "Cancelled", + "Failed" + ], + "x-ms-enum": { + "name": "eventStatus", + "modelAsString": true + }, + "description": "The status of the event." + }, + "eventDetails": { + "type": "string", + "description": "The details of the event." + }, + "scheduledTime": { + "type": "string", + "format": "date-time", + "description": "The time of the event is scheduled to start." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time the event actually started." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The last time the state of the event was updated." + }, + "resources": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ContainerService/managedClusters" + }, + { + "type": "Microsoft.ContainerService/managedClusters/agentPools" + } + ] + } + }, + "description": "The list of resources impacted by the event." + }, + "resourceType": { + "type": "string", + "enum": [ + "ManagedCluster", + "AgentPool" + ], + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": true + }, + "description": "The resource type of the event." + } + }, + "description": "Properties for a scheduled event." + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md index 6c6f22fce836..718cc18ddf5d 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md @@ -91,6 +91,34 @@ batch: - tag: package-2023-09 - tag: package-preview-2023-10 - tag: package-2023-10 + - tag: package-preview-2023-11 + - tag: package-2023-11 +``` + +### Tag: package-2023-11 and java + +These settings apply only when `--tag=package-2023-11` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2023-11' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2023_11_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2023_11_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-preview-2023-11 and java + +These settings apply only when `--tag=package-preview-2023-11` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-preview-2023-11' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2023_11_02_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2023_11_02_preview +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2023-10 and java diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md index d1f6b28eaef6..07b44e6c7f39 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md @@ -34,14 +34,32 @@ These are the global settings for the ContainerServices API. ``` yaml openapi-type: arm -tag: package-2023-10 +tag: package-2023-11 +``` + +### Tag: package-2023-11 + +These settings apply only when `--tag=package-2023-11` is specified on the command line. + +```yaml $(tag) == 'package-2023-11' +input-file: + - stable/2023-11-01/managedClusters.json +``` + +### Tag: package-preview-2023-11 + +These settings apply only when `--tag=package-preview-2023-11` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-11' +input-file: + - preview/2023-11-02-preview/managedClusters.json ``` ### Tag: package-2023-10 These settings apply only when `--tag=package-2023-10` is specified on the command line. -```yaml $(tag) == 'package-2023-10' +``` yaml $(tag) == 'package-2023-10' input-file: - stable/2023-10-01/managedClusters.json ``` @@ -50,7 +68,7 @@ input-file: These settings apply only when `--tag=package-preview-2023-10` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-10' +``` yaml $(tag) == 'package-preview-2023-10' input-file: - preview/2023-10-02-preview/managedClusters.json ``` diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md index e36151e91197..4f8dbe4b4689 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md @@ -16,9 +16,11 @@ no-namespace-folders: true Generate all API versions currently shipped for this package ```yaml $(python) -default-api-version: "2023-10-01" +default-api-version: "2023-11-01" multiapi: true batch: + - tag: package-2023-11 + - tag: package-preview-2023-11 - tag: package-2023-10 - tag: package-preview-2023-10 - tag: package-2023-09 @@ -98,6 +100,26 @@ perform-load: false clear-output-folder: false ``` +### Tag: package-2023-11 and python + +These settings apply only when `--tag=package-2023-11 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2023-11' && $(python) +namespace: azure.mgmt.containerservice.v2023_11_01 +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2023_11_01 +``` + +### Tag: package-preview-2023-11 and python + +These settings apply only when `--tag=package-preview-2023-11 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-preview-2023-11' && $(python) +namespace: azure.mgmt.containerservice.v2023_11_02_preview +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2023_11_02_preview +``` + ### Tag: package-2023-10 and python These settings apply only when `--tag=package-2023-10 --python` is specified on the command line. diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsAbortOperation.json new file mode 100644 index 000000000000..b34d4c10bada --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsAbortOperation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2023-11-01" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_CRG.json new file mode 100644 index 000000000000..8ef2f28da7d7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_CRG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_CustomNodeConfig.json new file mode 100644 index 000000000000..a878b5dbeb5e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_CustomNodeConfig.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..d28f5f83bfe3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_DedicatedHostGroup.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..a41b0782c152 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_EnableFIPS.json new file mode 100644 index 000000000000..c0627d9ea2b3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_EnableFIPS.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..a108b79d311b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_EnableUltraSSD.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..fcd8b46e38dc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "kubeletDiskType": "OS", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_GPUMIG.json new file mode 100644 index 000000000000..e84e44070753 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_GPUMIG.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_OSSKU.json new file mode 100644 index 000000000000..4258ad439c39 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_OSSKU.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..10f17f9ced33 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Snapshot.json new file mode 100644 index 000000000000..1afe72a155a8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Snapshot.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..2e02e40860f1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..dd9931ebc97d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_WasmWasi.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_WasmWasi.json new file mode 100644 index 000000000000..ed6207e99e98 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_WasmWasi.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_WindowsOSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_WindowsOSSKU.json new file mode 100644 index 000000000000..d8212c8c05fe --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsCreate_WindowsOSSKU.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..596dd5941c42 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..dec97ee4b563 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..8efba404b6e5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..5ab433fb2540 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsList.json new file mode 100644 index 000000000000..685b7048b4cd --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..90c9db623da2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ContainerService/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2018-07-31" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPools_Start.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPools_Start.json new file mode 100644 index 000000000000..bfa01a21bcc4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPools_Start.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Running" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPools_Stop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPools_Stop.json new file mode 100644 index 000000000000..4186f479fb9a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPools_Stop.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Stopped" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..22d15981ec53 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/AgentPools_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ContainerServiceGetOSOptions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ContainerServiceGetOSOptions.json new file mode 100644 index 000000000000..5dc295156e1f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ContainerServiceGetOSOptions.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/osOptions/default", + "name": "default", + "type": "Microsoft.ContainerService/locations/osOptions", + "properties": { + "osOptionPropertyList": [ + { + "os-type": "Linux", + "enable-fips-image": false + }, + { + "os-type": "Windows", + "enable-fips-image": false + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/KubernetesVersions_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/KubernetesVersions_List.json new file mode 100644 index 000000000000..8e995efdb2d2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/KubernetesVersions_List.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "values": [ + { + "version": "1.23", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.23.12": { + "upgrades": [ + "1.23.15", + "1.24.6", + "1.24.9" + ] + }, + "1.23.15": { + "upgrades": [ + "1.24.6", + "1.24.9" + ] + } + } + }, + { + "version": "1.24", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.24.6": { + "upgrades": [ + "1.24.9", + "1.25.4", + "1.25.5" + ] + }, + "1.24.9": { + "upgrades": [ + "1.25.4", + "1.25.5" + ] + } + } + }, + { + "version": "1.25", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.25.4": { + "upgrades": [ + "1.25.5", + "1.26.0" + ] + }, + "1.25.5": { + "upgrades": [ + "1.26.0" + ] + } + } + }, + { + "version": "1.26", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.26.0": { + "upgrades": [] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsCreate_Update.json new file mode 100644 index 000000000000..daedf496cc5b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsCreate_Update.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default", + "parameters": { + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json new file mode 100644 index 000000000000..918cac3519e3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedAutoUpgradeSchedule", + "parameters": { + "properties": { + "maintenanceWindow": { + "schedule": { + "relativeMonthly": { + "intervalMonths": 3, + "weekIndex": "First", + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsDelete.json new file mode 100644 index 000000000000..77ad0137f3d0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json new file mode 100644 index 000000000000..821979cb2abf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsGet.json new file mode 100644 index 000000000000..fbf7d1794526 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json new file mode 100644 index 000000000000..6c6abede2535 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 3 + } + }, + "durationHours": 4, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "09:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsList.json new file mode 100644 index 000000000000..7f45761ab968 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json new file mode 100644 index 000000000000..39773db801ec --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 5 + } + }, + "durationHours": 10, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "13:30" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "absoluteMonthly": { + "intervalMonths": 3, + "dayOfMonth": 15 + } + }, + "durationHours": 5, + "utcOffset": "+00:00", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersAbortOperation.json new file mode 100644 index 000000000000..50bc5c92f661 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersAbortOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2023-11-01" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json new file mode 100644 index 000000000000..3663180757b4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json @@ -0,0 +1,259 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_AzureServiceMesh.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_AzureServiceMesh.json new file mode 100644 index 000000000000..9bf67369ec3a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_AzureServiceMesh.json @@ -0,0 +1,355 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true, + "nodeSelector": { + "istio": "egress" + } + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + } + } + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true, + "nodeSelector": { + "istio": "egress" + } + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true, + "nodeSelector": { + "istio": "egress" + } + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_CRG.json new file mode 100644 index 000000000000..d83327678374 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_CRG.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..43d2076376de --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_DedicatedHostGroup.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_DisableRunCommand.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_DisableRunCommand.json new file mode 100644 index 000000000000..0cb35814037c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_DisableRunCommand.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_DualStackNetworking.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_DualStackNetworking.json new file mode 100644 index 000000000000..5b1412ed4867 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_DualStackNetworking.json @@ -0,0 +1,323 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + }, + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.22.1", + "currentKubernetesVersion": "1.22.1", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.22.1", + "currentOrchestratorVersion": "1.22.1", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.22.1", + "currentKubernetesVersion": "1.22.1", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.22.1", + "currentOrchestratorVersion": "1.22.1", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..0373f3e50a87 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..35cae895ab22 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_EnableUltraSSD.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_EnabledFIPS.json new file mode 100644 index 000000000000..efaf368e5270 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_EnabledFIPS.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_GPUMIG.json new file mode 100644 index 000000000000..b861bb57093e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_GPUMIG.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_HTTPProxy.json new file mode 100644 index 000000000000..193817bb7234 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_HTTPProxy.json @@ -0,0 +1,280 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_ManagedNATGateway.json new file mode 100644 index 000000000000..0d1f509c2abd --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_ManagedNATGateway.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "managedOutboundIPProfile": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json new file mode 100644 index 000000000000..fcc1aec40bc6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_OSSKU.json new file mode 100644 index 000000000000..5a5a3ff8a2e1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_OSSKU.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..a4e893f4a04c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PodIdentity.json new file mode 100644 index 000000000000..7c888c2d00e7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PodIdentity.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_Premium.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_Premium.json new file mode 100644 index 000000000000..af469a03502c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_Premium.json @@ -0,0 +1,274 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json new file mode 100644 index 000000000000..12e89dd63bec --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json @@ -0,0 +1,266 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json new file mode 100644 index 000000000000..d0b432d780f7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_SecurityProfile.json new file mode 100644 index 000000000000..4f65aa075afe --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_SecurityProfile.json @@ -0,0 +1,262 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_Snapshot.json new file mode 100644 index 000000000000..1d2f39c25bb4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_Snapshot.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..10da6d62b5bd --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,317 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json new file mode 100644 index 000000000000..d5e02e8df6cc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..8d0c0a2c7be0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,295 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..eb831aa74131 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json new file mode 100644 index 000000000000..231723d6c156 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..2945f5794ef4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..fae77eb945a6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGet.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..96043f735a96 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "a3ViZUNvbmZpZzE=" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..044b13096430 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGet_MeshRevisionProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGet_MeshRevisionProfile.json new file mode 100644 index 000000000000..66be11d42c62 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGet_MeshRevisionProfile.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGet_MeshUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGet_MeshUpgradeProfile.json new file mode 100644 index 000000000000..9b05ee7c4bb9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersGet_MeshUpgradeProfile.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersList.json new file mode 100644 index 000000000000..3ba7907c4c67 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersList.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..e91e92b353f2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListClusterAdminCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListClusterAdminCredentials.json new file mode 100644 index 000000000000..909266b432b8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListClusterAdminCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json new file mode 100644 index 000000000000..909266b432b8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListClusterUserCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListClusterUserCredentials.json new file mode 100644 index 000000000000..909266b432b8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersListClusterUserCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersList_MeshRevisionProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersList_MeshRevisionProfiles.json new file mode 100644 index 000000000000..c3cbf43baac0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersList_MeshRevisionProfiles.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersList_MeshUpgradeProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersList_MeshUpgradeProfiles.json new file mode 100644 index 000000000000..d5869618c56c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersList_MeshUpgradeProfiles.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..35011d1cdf8a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..82db57690a68 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..2945f5794ef4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json new file mode 100644 index 000000000000..2945f5794ef4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..2945f5794ef4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..2945f5794ef4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersStop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..1b54f88824dd --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/Operation_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/Operation_List.json new file mode 100644 index 000000000000..46fff2041fb7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/Operation_List.json @@ -0,0 +1,3583 @@ +{ + "parameters": { + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets the status of an asynchronous operation", + "operation": "Get Operation", + "provider": "Microsoft Container Service", + "resource": "Operation" + }, + "name": "Microsoft.ContainerService/locations/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists the supported orchestrators", + "operation": "List Orchestrators", + "provider": "Microsoft Container Service", + "resource": "Orchestrator" + }, + "name": "Microsoft.ContainerService/locations/orchestrators/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets OS options", + "operation": "Get OS Options", + "provider": "Microsoft Container Service", + "resource": "OSOptions" + }, + "name": "Microsoft.ContainerService/locations/osOptions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists operations available on Microsoft.ContainerService resource provider", + "operation": "List Available Container Service Operations", + "provider": "Microsoft Container Service", + "resource": "Available Container Service Operations" + }, + "name": "Microsoft.ContainerService/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Registers Subscription with Microsoft.ContainerService resource provider", + "operation": "Register Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Register Subscription" + }, + "name": "Microsoft.ContainerService/register/action", + "origin": "user,system" + }, + { + "display": { + "description": "Unregisters Subscription with Microsoft.ContainerService resource provider", + "operation": "Unregister Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Unregister Subscription" + }, + "name": "Microsoft.ContainerService/unregister/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the status of an asynchronous operation result", + "operation": "Get Operation Result", + "provider": "Microsoft Container Service", + "resource": "OperationResult" + }, + "name": "Microsoft.ContainerService/locations/operationresults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a container service", + "operation": "Get Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new container service or updates an existing one", + "operation": "Create or Update Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a container service", + "operation": "Delete Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster", + "operation": "Get Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new managed cluster or updates an existing one", + "operation": "Create or Update Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a managed cluster", + "operation": "Delete Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Starts a managed cluster", + "operation": "Start Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/start/action", + "origin": "user,system" + }, + { + "display": { + "description": "Stops a managed cluster", + "operation": "Stop Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/stop/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets a maintenance configuration", + "operation": "Get a maintenance configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new MaintenanceConfiguration or updates an existing one", + "operation": "Create or Update maintenance configuratio", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a maintenance configuration", + "operation": "Delete Maintenance Configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an agent pool", + "operation": "Get Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new agent pool or updates an existing one", + "operation": "Create or Update Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes an agent pool", + "operation": "Delete Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the Agent Pool", + "operation": "Get Agent Pool UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Upgrade the node image version of agent pool", + "operation": "Upgrade agent pool node image version", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeNodeImageVersion/write", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available agent pool versions of the cluster", + "operation": "Get Available Agent Pool Versions", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/availableAgentPoolVersions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name", + "operation": "Get Managed Cluster AccessProfile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name using list credential", + "operation": "Get Managed Cluster AccessProfile by List Credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/listCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the cluster", + "operation": "Get UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "UpgradeProfile" + }, + "name": "Microsoft.ContainerService/managedClusters/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterAdmin credential of a managed cluster", + "operation": "List clusterAdmin credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterAdminCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterUser credential of a managed cluster", + "operation": "List clusterUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterMonitoringUser credential of a managed cluster", + "operation": "List clusterMonitoringUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterMonitoringUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the service principal profile of a managed cluster", + "operation": "Reset service principal profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetServicePrincipalProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Resolve the private link service id of a managed cluster", + "operation": "Resolve private link service id", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resolvePrivateLinkServiceId/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the AAD profile of a managed cluster", + "operation": "Reset AAD profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetAADProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Rotate certificates of a managed cluster", + "operation": "Rotate certificates of the cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/rotateClusterCertificates/action", + "origin": "user,system" + }, + { + "display": { + "description": "Run user issued command against managed kubernetes server.", + "operation": "RunCommand", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/runCommand/action", + "origin": "user,system" + }, + { + "display": { + "description": "Retrieve result from previous issued command.", + "operation": "CommandResult", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/commandResults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get the diagnostic setting for a managed cluster resource", + "operation": "Read Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/read", + "origin": "system" + }, + { + "display": { + "description": "Creates or updates the diagnostic setting for a managed cluster resource", + "operation": "Write Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/write", + "origin": "system" + }, + { + "display": { + "description": "Get Managed Cluster Detector", + "operation": "Get Managed Cluster Detector", + "provider": "Microsoft Container Service", + "resource": "Managed Cluster Detector" + }, + "name": "Microsoft.ContainerService/managedClusters/detectors/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the diagnostics state of the cluster", + "operation": "Get Diagnostics State", + "provider": "Microsoft Container Service", + "resource": "Diagnostics State" + }, + "name": "Microsoft.ContainerService/managedClusters/diagnosticsState/read", + "origin": "user,system" + }, + { + "display": { + "description": "Determines if user is allowed to approve a private endpoint connection", + "operation": "Approve Private Endpoint Connections", + "provider": "Microsoft Container Service", + "resource": "Approve Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnectionsApproval/action", + "origin": "user,system" + }, + { + "display": { + "description": "Get private endpoint connection", + "operation": "Get private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/read", + "origin": "user,system" + }, + { + "display": { + "description": "Approve or Reject a private endpoint connection", + "operation": "Update private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete private endpoint connection", + "operation": "Delete private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an extension addon", + "operation": "Get an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/read", + "origin": "system" + }, + { + "display": { + "description": "Creates a new extension addon or updates an existing one", + "operation": "Create or Update extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/write", + "origin": "system" + }, + { + "display": { + "description": "Deletes an extension addon", + "operation": "Delete an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/delete", + "origin": "system" + }, + { + "display": { + "description": "Get a snapshot", + "operation": "Get Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new snapshot", + "operation": "Create Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a snapshot", + "operation": "Delete Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get eventgrid filter", + "operation": "Get eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/read", + "origin": "system" + }, + { + "display": { + "description": "Create or Update eventgrid filter", + "operation": "Create or Update eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/write", + "origin": "system" + }, + { + "display": { + "description": "Delete an eventgrid filter", + "operation": "Delete an eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/delete", + "origin": "system" + }, + { + "display": { + "description": "Reads initializerconfigurations", + "operation": "Gets/List initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes initializerconfigurations", + "operation": "Creates/Updates initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes/DeletesCollection initializerconfigurations resource", + "operation": "Initializerconfigurations", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads mutatingwebhookconfigurations", + "operation": "Gets/List mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes mutatingwebhookconfigurations", + "operation": "Creates/Updates mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes mutatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads validatingwebhookconfigurations", + "operation": "Gets/List validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes validatingwebhookconfigurations", + "operation": "Creates/Updates validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes validatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads customresourcedefinitions", + "operation": "Gets/List customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes customresourcedefinitions", + "operation": "Creates/Updates customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes customresourcedefinitions", + "operation": "Deletes/DeletesCollection customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservices", + "operation": "Gets/List apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes apiservices", + "operation": "Creates/Updates apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes apiservices", + "operation": "Deletes/DeletesCollection apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads controllerrevisions", + "operation": "Gets/List controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes controllerrevisions", + "operation": "Creates/Updates controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes controllerrevisions", + "operation": "Deletes/DeletesCollection controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads statefulsets", + "operation": "Gets/List statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes statefulsets", + "operation": "Creates/Updates statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes statefulsets", + "operation": "Deletes/DeletesCollection statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes tokenreviews", + "operation": "Creates/Updates tokenreviews resource", + "provider": "Microsoft Container Service", + "resource": "Tokenreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/tokenreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes localsubjectaccessreviews", + "operation": "Creates/Updates localsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Localsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/localsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectaccessreviews", + "operation": "Creates/Updates selfsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectrulesreviews", + "operation": "Creates/Updates selfsubjectrulesreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectrulesreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectrulesreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes subjectaccessreviews", + "operation": "Creates/Updates subjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Subjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/subjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads horizontalpodautoscalers", + "operation": "Gets/List horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes horizontalpodautoscalers", + "operation": "Creates/Updates horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes horizontalpodautoscalers", + "operation": "Deletes/DeletesCollection horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads cronjobs", + "operation": "Gets/List cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes cronjobs", + "operation": "Creates/Updates cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes cronjobs", + "operation": "Deletes/DeletesCollection cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads jobs", + "operation": "Gets/List jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes jobs", + "operation": "Creates/Updates jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes jobs", + "operation": "Deletes/DeletesCollection jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificatesigningrequests", + "operation": "Gets/List certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes certificatesigningrequests", + "operation": "Creates/Updates certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes certificatesigningrequests", + "operation": "Deletes/DeletesCollection certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads leases", + "operation": "Gets/List leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes leases", + "operation": "Creates/Updates leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes leases", + "operation": "Deletes/DeletesCollection leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes bindings", + "operation": "Creates/Updates bindings resource", + "provider": "Microsoft Container Service", + "resource": "Bindings" + }, + "name": "Microsoft.ContainerService/managedClusters/bindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads componentstatuses", + "operation": "Gets/List componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes componentstatuses", + "operation": "Creates/Updates componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes componentstatuses", + "operation": "Deletes/DeletesCollection componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads configmaps", + "operation": "Gets/List configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes configmaps", + "operation": "Creates/Updates configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes configmaps", + "operation": "Deletes/DeletesCollection configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads endpoints", + "operation": "Gets/List endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes endpoints", + "operation": "Creates/Updates endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes endpoints", + "operation": "Deletes/DeletesCollection endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads limitranges", + "operation": "Gets/List limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes limitranges", + "operation": "Creates/Updates limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes limitranges", + "operation": "Deletes/DeletesCollection limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads namespaces", + "operation": "Gets/List namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes namespaces", + "operation": "Creates/Updates namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes namespaces", + "operation": "Deletes/DeletesCollection namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes nodes", + "operation": "Creates/Updates nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes nodes", + "operation": "Deletes/DeletesCollection nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumeclaims", + "operation": "Gets/List persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumeclaims", + "operation": "Creates/Updates persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumeclaims", + "operation": "Deletes/DeletesCollection persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumes", + "operation": "Gets/List persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumes", + "operation": "Creates/Updates persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumes", + "operation": "Deletes/DeletesCollection persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes pods", + "operation": "Creates/Updates pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes pods", + "operation": "Deletes/DeletesCollection pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Exec into pods resource", + "operation": "Exec into pods resource ", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/exec/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podtemplates", + "operation": "Gets/List podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podtemplates", + "operation": "Creates/Updates podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podtemplates", + "operation": "Deletes/DeletesCollection podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicationcontrollers", + "operation": "Gets/List replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicationcontrollers", + "operation": "Creates/Updates replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicationcontrollers", + "operation": "Deletes/DeletesCollection replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resourcequotas", + "operation": "Gets/List resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes resourcequotas", + "operation": "Creates/Updates resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes resourcequotas", + "operation": "Deletes/DeletesCollection resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads secrets", + "operation": "Gets/List secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes secrets", + "operation": "Creates/Updates secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes secrets", + "operation": "Deletes/DeletesCollection secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads serviceaccounts", + "operation": "Gets/List serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes serviceaccounts", + "operation": "Creates/Updates serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes serviceaccounts", + "operation": "Deletes/DeletesCollection serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads services", + "operation": "Gets/List services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes services", + "operation": "Creates/Updates services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes services", + "operation": "Deletes/DeletesCollection services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads runtimeclasses", + "operation": "Gets/List runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes runtimeclasses", + "operation": "Creates/Updates runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes runtimeclasses", + "operation": "Deletes/DeletesCollection runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api", + "operation": "Gets/List api resource", + "provider": "Microsoft Container Service", + "resource": "Api" + }, + "name": "Microsoft.ContainerService/managedClusters/api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api/v1", + "operation": "Gets/List api/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Api/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/api/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apis", + "operation": "Gets/List apis resource", + "provider": "Microsoft Container Service", + "resource": "Apis" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io", + "operation": "Gets/List admissionregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1", + "operation": "Gets/List admissionregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1beta1", + "operation": "Gets/List admissionregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io", + "operation": "Gets/List apiextensions.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1", + "operation": "Gets/List apiextensions.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1beta1", + "operation": "Gets/List apiextensions.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io", + "operation": "Gets/List apiregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1", + "operation": "Gets/List apiregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1beta1", + "operation": "Gets/List apiregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps", + "operation": "Gets/List apps resource", + "provider": "Microsoft Container Service", + "resource": "Apps" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1", + "operation": "Gets/List apps/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta1", + "operation": "Gets/List apps/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta2", + "operation": "Gets/List apps/v1beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io", + "operation": "Gets/List authentication.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1", + "operation": "Gets/List authentication.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1beta1", + "operation": "Gets/List authentication.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io", + "operation": "Gets/List authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1", + "operation": "Gets/List authorization.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1beta1", + "operation": "Gets/List authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling", + "operation": "Gets/List autoscaling resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v1", + "operation": "Gets/List autoscaling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta1", + "operation": "Gets/List autoscaling/v2beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta2", + "operation": "Gets/List autoscaling/v2beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch", + "operation": "Gets/List batch resource", + "provider": "Microsoft Container Service", + "resource": "Batch" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1", + "operation": "Gets/List batch/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1beta1", + "operation": "Gets/List batch/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io", + "operation": "Gets/List certificates.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io/v1beta1", + "operation": "Gets/List certificates.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io", + "operation": "Gets/List coordination.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination/v1", + "operation": "Gets/List coordination/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io/v1beta1", + "operation": "Gets/List coordination.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io", + "operation": "Gets/List events.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io/v1beta1", + "operation": "Gets/List events.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions", + "operation": "Gets/List extensions resource", + "provider": "Microsoft Container Service", + "resource": "Extensions" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions/v1beta1", + "operation": "Gets/List extensions/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Extensions/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io", + "operation": "Gets/List metrics.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io/v1beta1", + "operation": "Gets/List metrics.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io", + "operation": "Gets/List networking.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking/v1", + "operation": "Gets/List networking/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io/v1beta1", + "operation": "Gets/List networking.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io", + "operation": "Gets/List node.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io/v1beta1", + "operation": "Gets/List node.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy", + "operation": "Gets/List policy resource", + "provider": "Microsoft Container Service", + "resource": "Policy" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy/v1beta1", + "operation": "Gets/List policy/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Policy/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io", + "operation": "Gets/List rbac.authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization/v1", + "operation": "Gets/List rbac.authorization/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io/v1beta1", + "operation": "Gets/List rbac.authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io", + "operation": "Gets/List scheduling.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling/v1", + "operation": "Gets/List scheduling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io/v1beta1", + "operation": "Gets/List scheduling.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io", + "operation": "Gets/List storage.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage/v1", + "operation": "Gets/List storage/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io/v1beta1", + "operation": "Gets/List storage.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads healthz", + "operation": "Gets/List healthz resource", + "provider": "Microsoft Container Service", + "resource": "Healthz" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads livez", + "operation": "Gets/List livez resource", + "provider": "Microsoft Container Service", + "resource": "Livez" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads logs", + "operation": "Gets/List logs resource", + "provider": "Microsoft Container Service", + "resource": "Logs" + }, + "name": "Microsoft.ContainerService/managedClusters/logs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics", + "operation": "Gets/List metrics resource", + "provider": "Microsoft Container Service", + "resource": "Metrics" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads v2", + "operation": "Gets/List v2 resource", + "provider": "Microsoft Container Service", + "resource": "Openapi/V2" + }, + "name": "Microsoft.ContainerService/managedClusters/openapi/v2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads readyz", + "operation": "Gets/List readyz resource", + "provider": "Microsoft Container Service", + "resource": "Readyz" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads shutdown", + "operation": "Gets/List shutdown resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Shutdown" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/shutdown/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resetMetrics", + "operation": "Gets/List resetMetrics resource", + "provider": "Microsoft Container Service", + "resource": "Resetmetrics" + }, + "name": "Microsoft.ContainerService/managedClusters/resetMetrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-ui", + "operation": "Gets/List swagger-ui resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-api", + "operation": "Gets/List swagger-api resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Api" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ui", + "operation": "Gets/List ui resource", + "provider": "Microsoft Container Service", + "resource": "Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads version", + "operation": "Gets/List version resource", + "provider": "Microsoft Container Service", + "resource": "Version" + }, + "name": "Microsoft.ContainerService/managedClusters/version/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads poddisruptionbudgets", + "operation": "Gets/List poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes poddisruptionbudgets", + "operation": "Creates/Updates poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes poddisruptionbudgets", + "operation": "Deletes/DeletesCollection poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterrolebindings", + "operation": "Gets/List clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterrolebindings", + "operation": "Creates/Updates clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterrolebindings", + "operation": "Deletes/DeletesCollection clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterroles", + "operation": "Gets/List clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterroles", + "operation": "Creates/Updates clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterroles", + "operation": "Deletes/DeletesCollection clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rolebindings", + "operation": "Gets/List rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes rolebindings", + "operation": "Creates/Updates rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes rolebindings", + "operation": "Deletes/DeletesCollection rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads roles", + "operation": "Gets/List roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes roles", + "operation": "Creates/Updates roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes roles", + "operation": "Deletes/DeletesCollection roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads priorityclasses", + "operation": "Gets/List priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes priorityclasses", + "operation": "Creates/Updates priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes priorityclasses", + "operation": "Deletes/DeletesCollection priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Use action on podsecuritypolicies", + "operation": "Use podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/use/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds clusterroles", + "operation": "Bind clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates", + "operation": "Escalate clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds roles", + "operation": "Bind roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates roles", + "operation": "Escalate roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate serviceaccounts", + "operation": "Impersonate serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate users", + "operation": "Impersonate users resource", + "provider": "Microsoft Container Service", + "resource": "Users" + }, + "name": "Microsoft.ContainerService/managedClusters/users/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate groups", + "operation": "Impersonate groups resource", + "provider": "Microsoft Container Service", + "resource": "Groups" + }, + "name": "Microsoft.ContainerService/managedClusters/groups/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate userextras", + "operation": "Impersonate userextras resource", + "provider": "Microsoft Container Service", + "resource": "Userextras" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/userextras/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storageclasses", + "operation": "Gets/List storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes storageclasses", + "operation": "Creates/Updates storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes storageclasses", + "operation": "Deletes/DeletesCollection storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads volumeattachments", + "operation": "Gets/List volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes volumeattachments", + "operation": "Creates/Updates volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes volumeattachments", + "operation": "Deletes/DeletesCollection volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csidrivers", + "operation": "Gets/List csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csidrivers", + "operation": "Creates/Updates csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csidrivers", + "operation": "Deletes/DeletesCollection csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csinodes", + "operation": "Gets/List csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csinodes", + "operation": "Creates/Updates csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csinodes", + "operation": "Deletes/DeletesCollection csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available metrics for Managed Cluster", + "operation": "Read Managed Cluster metric definitions", + "provider": "Microsoft Container Service", + "resource": "The metric definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/metricDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Gets the available logs for Managed Cluster", + "operation": "Read Managed Cluster log definitions", + "provider": "Microsoft Container Service", + "resource": "The log definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/logDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Get a Open Shift Managed Cluster", + "operation": "Get Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Managed Cluster or updates an existing one", + "operation": "Create or Update Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Managed Cluster", + "operation": "Delete Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a Open Shift Cluster", + "operation": "Get Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Cluster or updates an existing one", + "operation": "Create or Update Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Cluster", + "operation": "Delete Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/delete", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..84e1cd444f21 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "images", + "endpoints": [ + { + "domainName": "mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.data.mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https", + "description": "mcr cdn" + } + ] + } + ] + }, + { + "category": "artifacts", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "acs-mirror.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "time-sync", + "endpoints": [ + { + "domainName": "ntp.ubuntu.com", + "endpointDetails": [ + { + "port": 123, + "protocol": "UDP" + } + ] + } + ] + }, + { + "category": "ubuntu-optional", + "endpoints": [ + { + "domainName": "security.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "changelogs.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "gpu", + "endpoints": [ + { + "domainName": "nvidia.github.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "us.download.nvidia.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "apt.dockerproject.org", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "windows", + "endpoints": [ + { + "domainName": "onegetcdn.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "go.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.mp.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "www.msftconnecttest.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "ctldl.windowsupdate.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "apiserver", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "tunnel-classic", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 9000, + "protocol": "TCP" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..6640bf11181b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..3151e06ba254 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..0c6828501a92 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..42e7d5333393 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..26bee118004f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..f5cf0e858871 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/RunCommandRequest.json new file mode 100644 index 000000000000..94bf7563cf3b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/RunCommandRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "requestPayload": { + "command": "kubectl apply -f ns.yaml", + "context": "", + "clusterToken": "" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2023-11-01" + } + }, + "200": { + "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE", + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/RunCommandResultFailed.json new file mode 100644 index 000000000000..d0da75db6b8f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/RunCommandResultFailed.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2023-11-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "failed", + "reason": "ImagePullBackoff" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/RunCommandResultSucceed.json new file mode 100644 index 000000000000..4d7629c87115 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/RunCommandResultSucceed.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2023-11-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsCreate.json new file mode 100644 index 000000000000..82dd79c0af59 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsDelete.json new file mode 100644 index 000000000000..994a2f6f7bcf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsGet.json new file mode 100644 index 000000000000..f2eeac2c37db --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsList.json new file mode 100644 index 000000000000..21508649d1ef --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..ac1cb9720f16 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsUpdateTags.json new file mode 100644 index 000000000000..a1449a6488fb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/SnapshotsUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json new file mode 100644 index 000000000000..a968b3569378 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1", + "trustedAccessRoleBinding": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_Delete.json new file mode 100644 index 000000000000..87c49ea20d4c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_Get.json new file mode 100644 index 000000000000..50a00e46ebf9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_List.json new file mode 100644 index 000000000000..c05a527ec29b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoleBindings_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoles_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoles_List.json new file mode 100644 index 000000000000..472715b6a69f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/examples/TrustedAccessRoles_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sourceResourceType": "Microsoft.MachineLearningServices/workspaces", + "name": "reader", + "rules": [ + { + "verbs": [ + "get" + ], + "apiGroups": [ + "" + ], + "resources": [ + "pods" + ], + "resourceNames": [], + "nonResourceURLs": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/managedClusters.json new file mode 100644 index 000000000000..9fb58f9a009c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-11-01/managedClusters.json @@ -0,0 +1,7525 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2023-11-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.ContainerService/operations": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "Operations_List", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List available operations for the container service resource provider": { + "$ref": "./examples/Operation_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetOSOptions", + "summary": "Gets supported OS options in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ResourceTypeParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OSOptionProfile" + } + } + }, + "x-ms-examples": { + "Get Container Service OS Options": { + "$ref": "./examples/ContainerServiceGetOSOptions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListKubernetesVersions", + "summary": "Gets a list of supported Kubernetes versions in the specified subscription.", + "description": "Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubernetesVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Kubernetes Versions": { + "$ref": "./examples/KubernetesVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets the upgrade profile of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Lists the admin credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterAdminCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Lists the user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + }, + { + "$ref": "#/parameters/CredentialFormatParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterUserCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Lists the cluster monitoring user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterMonitoringUserCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The managed cluster to create or update." + } + ], + "responses": { + "200": { + "description": "The existing managed cluster was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "The new managed cluster was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create Managed Cluster with OSSKU": { + "$ref": "./examples/ManagedClustersCreate_OSSKU.json" + }, + "Create Managed Cluster with GPUMIG": { + "$ref": "./examples/ManagedClustersCreate_GPUMIG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + }, + "Create Managed Cluster with EncryptionAtHost enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json" + }, + "Create Managed Cluster with UltraSSD enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json" + }, + "Create Managed Cluster with PodIdentity enabled": { + "$ref": "./examples/ManagedClustersCreate_PodIdentity.json" + }, + "Create Managed Private Cluster with fqdn subdomain specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json" + }, + "Create Managed Private Cluster with Public FQDN specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json" + }, + "Create Managed Cluster with RunCommand disabled": { + "$ref": "./examples/ManagedClustersCreate_DisableRunCommand.json" + }, + "Create Managed Cluster with LongTermSupport": { + "$ref": "./examples/ManagedClustersCreate_Premium.json" + }, + "Create Managed Cluster with Node Public IP Prefix": { + "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json" + }, + "Create Managed Cluster with Azure KeyVault Secrets Provider Addon": { + "$ref": "./examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json" + }, + "Create Managed Cluster with FIPS enabled OS": { + "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json" + }, + "Create Managed Cluster with HTTP proxy configured": { + "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json" + }, + "Create Managed Cluster with Security Profile configured": { + "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json" + }, + "Create Managed Cluster with AKS-managed NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json" + }, + "Create Managed Cluster with user-assigned NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json" + }, + "Create Managed Cluster using an agent pool snapshot": { + "$ref": "./examples/ManagedClustersCreate_Snapshot.json" + }, + "Create/Update Managed Cluster with Windows gMSA enabled": { + "$ref": "./examples/ManagedClustersCreate_UpdateWindowsGmsa.json" + }, + "Create/Update Managed Cluster with dual-stack networking": { + "$ref": "./examples/ManagedClustersCreate_DualStackNetworking.json" + }, + "Create Managed Cluster with Capacity Reservation Group": { + "$ref": "./examples/ManagedClustersCreate_CRG.json" + }, + "Create Managed Cluster with Dedicated Host Group": { + "$ref": "./examples/ManagedClustersCreate_DedicatedHostGroup.json" + }, + "Create/Update Managed Cluster with Azure Service Mesh": { + "$ref": "./examples/ManagedClustersCreate_AzureServiceMesh.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_ListByManagedCluster", + "summary": "Gets a list of maintenance configurations in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List maintenance configurations by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList.json" + }, + "List maintenance configurations configured with maintenance window by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Get", + "summary": "Gets the specified maintenance configuration of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsGet.json" + }, + "Get Maintenance Configuration Configured With Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsGet_MaintenanceWindow.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "summary": "Creates or updates a maintenance configuration in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The maintenance configuration to create or update." + } + ], + "responses": { + "200": { + "description": "The existing maintenance configuration was successfully updated.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "201": { + "description": "The new maintenance configuration was successfully created.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create/Update Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update.json" + }, + "Create/Update Maintenance Configuration with Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Delete", + "summary": "Deletes a maintenance configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Delete Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsDelete.json" + }, + "Delete Maintenance Configuration For Node OS Upgrade": { + "$ref": "./examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_AbortLatestOperation", + "summary": "Aborts last operation running on agent pool.", + "description": "Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "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": { + "Abort operation on agent pool": { + "$ref": "./examples/AgentPoolsAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the specified managed cluster agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The agent pool to create or update." + } + ], + "responses": { + "200": { + "description": "The existing agent pool was successfully updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "The new agent pool was successfully created.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with OSSKU": { + "$ref": "./examples/AgentPoolsCreate_OSSKU.json" + }, + "Create Agent Pool with Windows OSSKU": { + "$ref": "./examples/AgentPoolsCreate_WindowsOSSKU.json" + }, + "Create Agent Pool with GPUMIG": { + "$ref": "./examples/AgentPoolsCreate_GPUMIG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + }, + "Create Agent Pool with KubeletConfig and LinuxOSConfig": { + "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json" + }, + "Create Agent Pool with EncryptionAtHost enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json" + }, + "Create Agent Pool with UltraSSD enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json" + }, + "Create Agent Pool with FIPS enabled OS": { + "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json" + }, + "Create Agent Pool using an agent pool snapshot": { + "$ref": "./examples/AgentPoolsCreate_Snapshot.json" + }, + "Create Agent Pool with Krustlet and the WASI runtime": { + "$ref": "./examples/AgentPoolsCreate_WasmWasi.json" + }, + "Stop Agent Pool": { + "$ref": "./examples/AgentPools_Stop.json" + }, + "Start Agent Pool": { + "$ref": "./examples/AgentPools_Start.json" + }, + "Create Agent Pool with Capacity Reservation Group": { + "$ref": "./examples/AgentPoolsCreate_CRG.json" + }, + "Create Agent Pool with Dedicated Host Group": { + "$ref": "./examples/AgentPoolsCreate_DedicatedHostGroup.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets the upgrade profile for an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.", + "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset the Service Principal Profile of a managed cluster.", + "description": "This action cannot be performed on a cluster that is not using a service principal", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "The service principal profile to set on the managed cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset the AAD Profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "The AAD profile to set on the Managed Cluster" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotates the certificates of a managed cluster.", + "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_AbortLatestOperation", + "summary": "Aborts last operation running on managed cluster.", + "description": "Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "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": { + "Abort operation on managed cluster": { + "$ref": "./examples/ManagedClustersAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateServiceAccountSigningKeys", + "summary": "Rotates the service account signing keys of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Service Account Signing Keys": { + "$ref": "./examples/ManagedClustersRotateServiceAccountSigningKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stops a Managed Cluster", + "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Starts a previously stopped Managed Cluster", + "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the specified private endpoint connection.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The updated private endpoint connection." + } + ], + "responses": { + "200": { + "description": "The existing private endpoint connection was successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The new private endpoint connection was successfully created.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_UpgradeNodeImageVersion", + "summary": "Upgrades the node image version of an agent pool to the latest.", + "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters required in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RunCommand", + "summary": "Submits a command to run against the Managed Cluster.", + "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "requestPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandRequest" + }, + "description": "The run command request" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "200": { + "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "submitNewCommand": { + "$ref": "./examples/RunCommandRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetCommandResult", + "summary": "Gets the results of a command which has been run on the Managed Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the command." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "200": { + "description": "command finished", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "commandSucceedResult": { + "$ref": "./examples/RunCommandResultSucceed.json" + }, + "commandFailedResult": { + "$ref": "./examples/RunCommandResultFailed.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints", + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.", + "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Managed Cluster": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Gets a list of snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots": { + "$ref": "./examples/SnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "summary": "Lists snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots by Resource Group": { + "$ref": "./examples/SnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Gets a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Snapshot": { + "$ref": "./examples/SnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "summary": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "201": { + "description": "The new snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Snapshot": { + "$ref": "./examples/SnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_UpdateTags", + "summary": "Updates tags on a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Snapshot Tags": { + "$ref": "./examples/SnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Snapshot": { + "$ref": "./examples/SnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshRevisionProfiles", + "summary": "Lists mesh revision profiles for all meshes in the specified location.", + "description": "Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List mesh revision profiles in a location": { + "$ref": "./examples/ManagedClustersList_MeshRevisionProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshRevisionProfile", + "summary": "Gets a mesh revision profile for a specified mesh in the specified location.", + "description": "Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a mesh revision profile for a mesh mode": { + "$ref": "./examples/ManagedClustersGet_MeshRevisionProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshUpgradeProfiles", + "summary": "Lists available upgrades for all service meshes in a specific cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists version compatibility and upgrade profile for all service meshes in a cluster": { + "$ref": "./examples/ManagedClustersList_MeshUpgradeProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshUpgradeProfile", + "summary": "Gets available upgrades for a service mesh in a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets version compatibility and upgrade profile for a service mesh in a cluster": { + "$ref": "./examples/ManagedClustersGet_MeshUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_List", + "summary": "List trusted access role bindings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBindingListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access role bindings": { + "$ref": "./examples/TrustedAccessRoleBindings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Get", + "summary": "Get a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Get.json" + } + } + }, + "put": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_CreateOrUpdate", + "summary": "Create or update a trusted access role binding", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + }, + { + "name": "trustedAccessRoleBinding", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "A trusted access role binding" + } + ], + "responses": { + "200": { + "description": "The existing trusted access role binding was successfully updated.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "201": { + "description": "The new trusted access role binding was successfully created.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Delete", + "summary": "Delete a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoles_List", + "summary": "List supported trusted access roles.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access roles": { + "$ref": "./examples/TrustedAccessRoles_List.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "x-ms-identifiers": [], + "description": "The list of operations" + } + }, + "description": "The List Operation response." + }, + "OperationValue": { + "type": "object", + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Operation Value Display." + } + }, + "description": "Describes the properties of a Operation value." + }, + "OperationValueDisplay": { + "type": "object", + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Operation Value Display." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 2048, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ManagedClusterServicePrincipalProfile": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "ManagedClusterAgentPoolProfileProperties": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "type": "string", + "title": "The size of the agent pool VMs.", + "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "workloadRuntime": { + "$ref": "#/definitions/WorkloadRuntime" + }, + "vnetSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which agent pool nodes and optionally pods will join on startup.", + "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which pods will join when launched.", + "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "scaleDownMode": { + "$ref": "#/definitions/ScaleDownMode", + "title": "The scale down mode to use when scaling the Agent Pool.", + "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete." + }, + "type": { + "$ref": "#/definitions/AgentPoolType" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode" + }, + "orchestratorVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)." + }, + "currentOrchestratorVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes the Agent Pool is running.", + "description": "If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "powerState": { + "title": "Whether the Agent Pool is running or stopped.", + "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'." + }, + "enableNodePublicIP": { + "type": "boolean", + "title": "Whether each node is allocated its own public IP.", + "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "title": "The public IP prefix ID which VM nodes should use IPs from.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "title": "The Virtual Machine Scale Set eviction policy to use.", + "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the agent pool nodes." + }, + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux agent nodes." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "title": "Whether to enable host based OS and data drive encryption.", + "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption" + }, + "enableUltraSSD": { + "type": "boolean", + "description": "Whether to enable UltraSSD" + }, + "enableFIPS": { + "type": "boolean", + "title": "Whether to use a FIPS-enabled OS.", + "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details." + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot." + }, + "capacityReservationGroupID": { + "$ref": "#/definitions/CapacityReservationGroupID", + "description": "AKS will associate the specified agent pool with the Capacity Reservation Group." + }, + "hostGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/hostGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)." + }, + "networkProfile": { + "$ref": "#/definitions/AgentPoolNetworkProfile", + "description": "Network-related settings of an agent pool." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "AgentPoolNetworkProfile": { + "type": "object", + "properties": { + "nodePublicIPTags": { + "$ref": "#/definitions/NodePublicIPTags", + "description": "IPTags of instance-level public IPs." + }, + "allowedHostPorts": { + "type": "array", + "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap.", + "items": { + "$ref": "#/definitions/PortRange" + }, + "x-ms-identifiers": [] + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/applicationSecurityGroups" + } + ] + } + }, + "description": "The IDs of the application security groups which agent pool will associate when created." + } + }, + "description": "Network settings of an agent pool." + }, + "NodePublicIPTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IPTag" + }, + "x-ms-identifiers": [], + "description": "The list of tags associated with the node public IP address." + }, + "IPTag": { + "type": "object", + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type. Example: RoutingPreference." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag associated with the public IP. Example: Internet." + } + }, + "description": "Contains the IPTag associated with the object." + }, + "PortRange": { + "type": "object", + "description": "The port range.", + "properties": { + "portStart": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd." + }, + "portEnd": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart." + }, + "protocol": { + "type": "string", + "description": "The network protocol of the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true, + "values": [ + { + "value": "TCP", + "description": "TCP protocol." + }, + { + "value": "UDP", + "description": "UDP protocol." + } + ] + } + } + } + }, + "ManagedClusterAgentPoolProfile": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + } + ], + "properties": { + "name": { + "type": "string", + "title": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "description": "Windows agent pool names must be 6 characters or less.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + }, + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true, + "values": [ + { + "value": "VirtualMachineScaleSets", + "description": "Create an Agent Pool backed by a Virtual Machine Scale Set." + }, + { + "value": "AvailabilitySet", + "description": "Use of this is strongly discouraged." + } + ] + }, + "description": "The type of Agent Pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory." + }, + { + "value": "User", + "description": "User agent pools are primarily for hosting your application pods." + } + ] + }, + "title": "The mode of an agent pool.", + "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools" + }, + "AgentPoolListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "properties": { + "maxSurge": { + "type": "string", + "title": "The maximum number or percentage of nodes that are surged during upgrade.", + "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade" + }, + "drainTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 1440, + "minimum": 1, + "title": "The drain timeout for a node", + "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes." + }, + "nodeSoakDurationInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 30, + "minimum": 0, + "title": "The soak duration for a node", + "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes." + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + }, + "description": "Agent Pool." + }, + "ManagedClusterWindowsProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**Restriction:** Cannot end in \".\"

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

**Minimum-length:** 1 character

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

**Minimum-length:** 8 characters

**Max-length:** 123 characters

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

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"" + }, + "licenseType": { + "type": "string", + "enum": [ + "None", + "Windows_Server" + ], + "x-ms-enum": { + "name": "licenseType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No additional licensing is applied." + }, + { + "value": "Windows_Server", + "description": "Enables Azure Hybrid User Benefits for Windows VMs." + } + ] + }, + "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details." + }, + "enableCSIProxy": { + "type": "boolean", + "title": "Whether to enable CSI proxy.", + "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)." + }, + "gmsaProfile": { + "$ref": "#/definitions/WindowsGmsaProfile", + "description": "The Windows gMSA Profile in the Managed Cluster." + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the managed cluster." + }, + "WindowsGmsaProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable Windows gMSA.", + "description": "Specifies whether to enable Windows gMSA in the managed cluster." + }, + "dnsServer": { + "type": "string", + "description": "Specifies the DNS server for Windows gMSA.

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

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + } + }, + "description": "Windows gMSA Profile in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "type": "object", + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet", + "none" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + }, + { + "value": "none", + "description": "No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPluginMode": { + "type": "string", + "enum": [ + "overlay" + ], + "x-ms-enum": { + "name": "NetworkPluginMode", + "modelAsString": true, + "values": [ + { + "value": "overlay", + "description": "Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay." + } + ] + }, + "description": "The mode the network plugin should use." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "calico", + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "cilium", + "description": "Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "networkDataplane": { + "type": "string", + "enum": [ + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "networkDataplane", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use Azure network dataplane." + }, + { + "value": "cilium", + "description": "Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information." + } + ] + }, + "description": "Network dataplane used in the Kubernetes cluster." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting", + "managedNATGateway", + "userAssignedNATGateway" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + }, + { + "value": "managedNATGateway", + "description": "The AKS-managed NAT gateway is used for egress." + }, + { + "value": "userAssignedNATGateway", + "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration." + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + }, + "natGatewayProfile": { + "$ref": "#/definitions/ManagedClusterNATGatewayProfile", + "description": "Profile of the cluster NAT gateway." + }, + "podCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign pod IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking." + }, + "serviceCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign service cluster IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges." + }, + "ipFamilies": { + "type": "array", + "items": { + "type": "string", + "description": "The IP version to use for cluster networking and IP assignment.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "ipFamily", + "modelAsString": true + } + }, + "title": "The IP families used to specify IP versions available to the cluster.", + "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6." + } + }, + "description": "Profile of network configuration." + }, + "MaintenanceConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "MaintenanceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.", + "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "type": "object", + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "x-ms-identifiers": [], + "title": "Time slots during the week when planned maintenance is allowed to proceed.", + "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "x-ms-identifiers": [], + "description": "Time slots on which upgrade is not allowed." + }, + "maintenanceWindow": { + "type": "object", + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window for the maintenance configuration." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "MaintenanceWindow": { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "Recurrence schedule for the maintenance window." + }, + "durationHours": { + "type": "integer", + "format": "int32", + "minimum": 4, + "maximum": 24, + "default": 24, + "description": "Length of maintenance window range from 4 to 24 hours." + }, + "utcOffset": { + "type": "string", + "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$", + "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away." + }, + "startTime": { + "type": "string", + "pattern": "^\\d{2}:\\d{2}$", + "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'." + }, + "notAllowedDates": { + "type": "array", + "items": { + "$ref": "#/definitions/DateSpan" + }, + "x-ms-identifiers": [], + "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time." + } + }, + "description": "Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.", + "required": [ + "schedule", + "durationHours", + "startTime" + ] + }, + "Schedule": { + "type": "object", + "properties": { + "daily": { + "$ref": "#/definitions/DailySchedule" + }, + "weekly": { + "$ref": "#/definitions/WeeklySchedule" + }, + "absoluteMonthly": { + "$ref": "#/definitions/AbsoluteMonthlySchedule" + }, + "relativeMonthly": { + "$ref": "#/definitions/RelativeMonthlySchedule" + } + }, + "description": "One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule." + }, + "DailySchedule": { + "type": "object", + "properties": { + "intervalDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 7, + "description": "Specifies the number of days between each set of occurrences." + } + }, + "description": "For schedules like: 'recur every day' or 'recur every 3 days'.", + "required": [ + "intervalDays" + ] + }, + "WeeklySchedule": { + "type": "object", + "properties": { + "intervalWeeks": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4, + "description": "Specifies the number of weeks between each set of occurrences." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.", + "required": [ + "intervalWeeks", + "dayOfWeek" + ] + }, + "AbsoluteMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "dayOfMonth": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 31, + "description": "The date of the month." + } + }, + "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.", + "required": [ + "intervalMonths", + "dayOfMonth" + ] + }, + "RelativeMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "weekIndex": { + "type": "string", + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "First", + "description": "First week of the month." + }, + { + "value": "Second", + "description": "Second week of the month." + }, + { + "value": "Third", + "description": "Third week of the month." + }, + { + "value": "Fourth", + "description": "Fourth week of the month." + }, + { + "value": "Last", + "description": "Last week of the month." + } + ] + }, + "title": "The week index.", + "description": "Specifies on which week of the month the dayOfWeek applies." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.", + "required": [ + "intervalMonths", + "weekIndex", + "dayOfWeek" + ] + }, + "DateSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date", + "description": "The start date of the date span." + }, + "end": { + "type": "string", + "format": "date", + "description": "The end date of the date span." + } + }, + "title": "A date range.", + "description": "For example, between '2022-12-23' and '2023-01-05'.", + "required": [ + "start", + "end" + ] + }, + "TimeInWeek": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "title": "A list of hours in the day used to identify a time range.", + "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "title": "A time range.", + "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterNATGatewayProfile": { + "type": "object", + "properties": { + "managedOutboundIPProfile": { + "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile", + "description": "Profile of the managed outbound IP resources of the cluster NAT gateway." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster NAT gateway." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.", + "default": 4 + } + }, + "description": "Profile of the managed cluster NAT gateway." + }, + "ManagedClusterManagedOutboundIPProfile": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 16, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Profile of the managed outbound IP resources of the managed cluster." + }, + "ManagedClusterLoadBalancerProfile": { + "type": "object", + "properties": { + "managedOutboundIPs": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "countIPv6": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0, + "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ", + "default": 0 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "type": "object", + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "type": "object", + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + }, + "enableMultipleStandardLoadBalancers": { + "type": "boolean", + "description": "Enable multiple standard load balancers per AKS cluster or not." + }, + "backendPoolType": { + "type": "string", + "x-ms-enum": { + "name": "BackendPoolType", + "modelAsString": true, + "values": [ + { + "value": "NodeIPConfiguration", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + }, + { + "value": "NodeIP", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + } + ] + }, + "enum": [ + "NodeIPConfiguration", + "NodeIP" + ], + "description": "The type of the managed inbound Load Balancer BackendPool.", + "default": "NodeIPConfiguration" + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "x-ms-identifiers": [], + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + }, + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "currentKubernetesVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes the Managed Cluster is running.", + "description": "If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used." + }, + "dnsPrefix": { + "type": "string", + "title": "The DNS prefix of the Managed Cluster.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "title": "The FQDN subdomain of the private cluster with custom private dns zone.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.", + "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "x-ms-identifiers": [], + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "oidcIssuerProfile": { + "$ref": "#/definitions/ManagedClusterOIDCIssuerProfile", + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "supportPlan": { + "$ref": "#/definitions/KubernetesSupportPlan", + "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "upgradeSettings": { + "$ref": "#/definitions/ClusterUpgradeSettings", + "description": "Settings for upgrading a cluster." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "title": "Detects similar node pools and balances the number of nodes between them.", + "description": "Valid values are 'true' and 'false'" + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "title": "The expander to use when scaling up", + "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "max-empty-bulk-delete": { + "type": "string", + "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.", + "description": "The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.", + "description": "The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "title": "The maximum time the autoscaler waits for a node to be provisioned.", + "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.", + "description": "The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "title": "Ignore unscheduled pods before they're a certain age.", + "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.", + "description": "This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "title": "How often cluster is reevaluated for scale up or down.", + "description": "The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "title": "How long after scale up that scale down evaluation resumes", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "title": "How long after node deletion that scale down evaluation resumes.", + "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "title": "How long after scale down failure that scale down evaluation resumes.", + "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "title": "How long a node should be unneeded before it is eligible for scale down.", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "title": "How long an unready node should be unneeded before it is eligible for scale down", + "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", + "description": "The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.", + "description": "The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)", + "description": "The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/diskEncryptionSets" + } + ] + }, + "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Identities associated with the cluster." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "title": "If local accounts should be disabled on the Managed Cluster.", + "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + }, + "securityProfile": { + "$ref": "#/definitions/ManagedClusterSecurityProfile", + "description": "Security profile for the managed cluster." + }, + "storageProfile": { + "$ref": "#/definitions/ManagedClusterStorageProfile", + "description": "Storage profile for the managed cluster." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "title": "PublicNetworkAccess of the managedCluster", + "description": "Allow or deny public network access for AKS" + }, + "workloadAutoScalerProfile": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfile" + }, + "azureMonitorProfile": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfile" + }, + "serviceMeshProfile": { + "$ref": "#/definitions/ServiceMeshProfile" + }, + "resourceUID": { + "readOnly": true, + "type": "string", + "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)" + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "type": "object", + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "ManagedClusterAPIServerAccessProfile": { + "type": "object", + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the Kubernetes API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "title": "Whether to create the cluster as a private cluster or not.", + "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "title": "The private DNS zone mode for the cluster.", + "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + }, + "disableRunCommand": { + "type": "boolean", + "description": "Whether to disable run command for the cluster or not." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "title": "The type of identity used for the managed cluster.", + "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "delegatedResources": { + "$ref": "../../../../../../common-types/resource-management/v4/managedidentitywithdelegation.json#/definitions/DelegatedResources", + "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.", + "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + }, + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "type": "object", + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "x-ms-identifiers": [], + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "type": "object", + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching" + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "title": "The upgrade channel for auto upgrade. The default is 'none'.", + "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + }, + "nodeOSUpgradeChannel": { + "type": "string", + "enum": [ + "Unmanaged", + "None", + "NodeImage" + ], + "x-ms-enum": { + "name": "nodeOSUpgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates" + }, + { + "value": "Unmanaged", + "description": "OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice" + }, + { + "value": "NodeImage", + "description": "AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images." + } + ] + }, + "title": "Node OS Upgrade Channel", + "description": "Manner in which the OS on your nodes is updated. The default is NodeImage." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "UpgradeOverrideSettings": { + "type": "object", + "properties": { + "forceUpgrade": { + "type": "boolean", + "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution." + }, + "until": { + "type": "string", + "format": "date-time", + "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect." + } + }, + "description": "Settings for overrides when upgrading a cluster." + }, + "ClusterUpgradeSettings": { + "type": "object", + "properties": { + "overrideSettings": { + "$ref": "#/definitions/UpgradeOverrideSettings", + "description": "Settings for overrides." + } + }, + "description": "Settings for upgrading a cluster." + }, + "ManagedClusterAADProfile": { + "type": "object", + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppID": { + "type": "string", + "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppSecret": { + "type": "string", + "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "title": "AADProfile specifies attributes for Azure Active Directory integration.", + "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "type": "object", + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.", + "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.", + "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + }, + "x-ms-identifiers": [] + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + }, + "x-ms-identifiers": [] + } + }, + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterOIDCIssuerProfile": { + "type": "object", + "properties": { + "issuerURL": { + "readOnly": true, + "type": "string", + "description": "The OIDC issuer url of the Managed Cluster." + }, + "enabled": { + "type": "boolean", + "description": "Whether the OIDC issuer is enabled." + } + }, + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "ManagedClusterUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "type": "object", + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "Ubuntu", + "CBLMariner", + "AzureLinux", + "Windows2019", + "Windows2022" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true, + "values": [ + { + "value": "Ubuntu", + "description": "Use Ubuntu as the OS for node images." + }, + { + "value": "AzureLinux", + "description": "Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information." + }, + { + "value": "CBLMariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "Windows2019", + "description": "Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa." + }, + { + "value": "Windows2022", + "description": "Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa." + } + ] + }, + "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "title": "The Virtual Machine Scale Set eviction policy.", + "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ScaleDownMode": { + "type": "string", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleDownMode", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Create new instances during scale up and remove instances during scale down." + }, + { + "value": "Deallocate", + "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down." + } + ] + }, + "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)." + }, + "ProximityPlacementGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/proximityPlacementGroups" + } + ] + }, + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "type": "object", + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "type": "object", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for 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 Container service." + }, + "ManagedClusterSKU": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Base" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true, + "values": [ + { + "value": "Base", + "description": "Base option for the AKS control plane." + } + ] + } + }, + "tier": { + "type": "string", + "title": "The tier of a managed cluster SKU.", + "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details.", + "enum": [ + "Standard", + "Free", + "Premium" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions." + }, + { + "value": "Standard", + "description": "Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Canceled", + "Creating", + "Deleting", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "title": "The OS disk type to be used for machines in the agent pool.", + "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "WorkloadRuntime": { + "type": "string", + "enum": [ + "OCIContainer", + "WasmWasi" + ], + "x-ms-enum": { + "name": "WorkloadRuntime", + "modelAsString": true, + "values": [ + { + "value": "OCIContainer", + "description": "Nodes will use Kubelet to run standard OCI container workloads." + }, + { + "value": "WasmWasi", + "description": "Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview)." + } + ] + }, + "description": "Determines the type of workload a node can run." + }, + "KubeletConfig": { + "title": "Kubelet configurations of agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "title": "The CPU Manager policy to use.", + "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.", + "description": "The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "title": "The CPU CFS quota period value.", + "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage after which image garbage collection is always run.", + "description": "To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage before which image garbage collection is never run.", + "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "title": "The Topology Manager policy to use.", + "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + } + } + }, + "LinuxOSConfig": { + "title": "OS configurations of Linux agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "title": "Whether transparent hugepages are enabled.", + "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.", + "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "minimum": 10, + "maximum": 90, + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "minimum": 131072, + "maximum": 2097152, + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "minimum": 65536, + "maximum": 524288, + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "OSOptionProperty": { + "type": "object", + "properties": { + "os-type": { + "type": "string", + "description": "The OS type." + }, + "enable-fips-image": { + "type": "boolean", + "description": "Whether the image is FIPS-enabled." + } + }, + "required": [ + "os-type", + "enable-fips-image" + ], + "description": "OS option property." + }, + "OSOptionPropertyList": { + "type": "object", + "properties": { + "osOptionPropertyList": { + "type": "array", + "items": { + "$ref": "#/definitions/OSOptionProperty" + }, + "x-ms-identifiers": [], + "description": "The list of OS options." + } + }, + "required": [ + "osOptionPropertyList" + ], + "description": "The list of OS option properties." + }, + "OSOptionProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the OS option resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the OS option resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the OS option resource." + }, + "properties": { + "$ref": "#/definitions/OSOptionPropertyList", + "description": "The list of OS options.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The OS option profile." + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [] + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterSecurityProfile": { + "type": "object", + "properties": { + "defender": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefender", + "description": "Microsoft Defender settings for the security profile." + }, + "azureKeyVaultKms": { + "$ref": "#/definitions/AzureKeyVaultKms", + "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile." + }, + "workloadIdentity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileWorkloadIdentity", + "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details." + }, + "imageCleaner": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageCleaner", + "description": "Image Cleaner settings for the security profile." + } + }, + "description": "Security profile for the container service cluster." + }, + "AzureKeyVaultKms": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Azure Key Vault key management service. The default is false." + }, + "keyId": { + "type": "string", + "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty." + }, + "keyVaultNetworkAccess": { + "type": "string", + "enum": [ + "Public", + "Private" + ], + "default": "Public", + "x-ms-enum": { + "name": "KeyVaultNetworkAccessTypes", + "modelAsString": true + }, + "title": "Network access of the key vault", + "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`." + }, + "keyVaultResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty." + } + }, + "description": "Azure Key Vault key management service settings for the security profile." + }, + "ManagedClusterSecurityProfileWorkloadIdentity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable workload identity." + } + }, + "description": "Workload identity settings for the security profile." + }, + "ManagedClusterSecurityProfileImageCleaner": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Image Cleaner on AKS cluster." + }, + "intervalHours": { + "type": "integer", + "format": "int32", + "description": "Image Cleaner scanning interval in hours." + } + }, + "description": "Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile." + }, + "ManagedClusterStorageProfile": { + "type": "object", + "properties": { + "diskCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileDiskCSIDriver", + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "fileCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileFileCSIDriver", + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "snapshotController": { + "$ref": "#/definitions/ManagedClusterStorageProfileSnapshotController", + "description": "Snapshot Controller settings for the storage profile." + }, + "blobCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileBlobCSIDriver", + "description": "AzureBlob CSI Driver settings for the storage profile." + } + }, + "description": "Storage profile for the container service cluster." + }, + "ManagedClusterSecurityProfileDefender": { + "type": "object", + "properties": { + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty." + }, + "securityMonitoring": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityMonitoring", + "description": "Microsoft Defender threat detection for Cloud settings for the security profile." + } + }, + "description": "Microsoft Defender settings for the security profile." + }, + "ManagedClusterSecurityProfileDefenderSecurityMonitoring": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Defender threat detection" + } + }, + "description": "Microsoft Defender settings for the security profile threat detection." + }, + "ManagedClusterStorageProfileDiskCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureDisk CSI Driver. The default value is true." + } + }, + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileFileCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureFile CSI Driver. The default value is true." + } + }, + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileSnapshotController": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Snapshot Controller. The default value is true." + } + }, + "description": "Snapshot Controller settings for the storage profile." + }, + "ManagedClusterStorageProfileBlobCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureBlob CSI Driver. The default value is false." + } + }, + "description": "AzureBlob CSI Driver settings for the storage profile." + }, + "CreationData": { + "description": "Data used when creating a target resource from a source resource.", + "type": "object", + "properties": { + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "This is the ARM ID of the source object to be used to create the target object." + } + } + }, + "SnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Snapshots operation." + }, + "Snapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a snapshot.", + "$ref": "#/definitions/SnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A node pool snapshot resource." + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image." + }, + "osType": { + "readOnly": true, + "$ref": "#/definitions/OSType" + }, + "osSku": { + "readOnly": true, + "$ref": "#/definitions/OSSKU" + }, + "vmSize": { + "readOnly": true, + "type": "string", + "description": "The size of the VM." + }, + "enableFIPS": { + "readOnly": true, + "type": "boolean", + "description": "Whether to use a FIPS-enabled OS." + } + }, + "description": "Properties used to configure a node pool snapshot." + }, + "SnapshotType": { + "type": "string", + "default": "NodePool", + "enum": [ + "NodePool" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "value": "NodePool", + "description": "The snapshot is a snapshot of a node pool." + } + ] + }, + "description": "The type of a snapshot. The default is NodePool." + }, + "ManagedClusterWorkloadAutoScalerProfile": { + "type": "object", + "description": "Workload Auto-scaler profile for the managed cluster.", + "properties": { + "keda": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileKeda" + }, + "verticalPodAutoscaler": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler" + } + } + }, + "ManagedClusterWorkloadAutoScalerProfileKeda": { + "type": "object", + "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable KEDA." + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler": { + "type": "object", + "description": "VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable VPA. Default value is false.", + "default": false + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterAzureMonitorProfile": { + "type": "object", + "description": "Azure Monitor addon profiles for monitoring the managed cluster.", + "properties": { + "metrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileMetrics" + } + } + }, + "ManagedClusterAzureMonitorProfileKubeStateMetrics": { + "type": "object", + "description": "Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details.", + "properties": { + "metricLabelsAllowlist": { + "type": "string", + "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels." + }, + "metricAnnotationsAllowList": { + "type": "string", + "description": "Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels." + } + } + }, + "ManagedClusterAzureMonitorProfileMetrics": { + "type": "object", + "description": "Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling." + }, + "kubeStateMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileKubeStateMetrics" + } + }, + "required": [ + "enabled" + ] + }, + "ServiceMeshProfile": { + "type": "object", + "description": "Service mesh profile for a managed cluster.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of the service mesh.", + "enum": [ + "Istio", + "Disabled" + ], + "x-ms-enum": { + "name": "ServiceMeshMode", + "modelAsString": true, + "values": [ + { + "value": "Istio", + "description": "Istio deployed as an AKS addon." + }, + { + "value": "Disabled", + "description": "Mesh is disabled." + } + ] + } + }, + "istio": { + "$ref": "#/definitions/IstioServiceMesh" + } + }, + "required": [ + "mode" + ] + }, + "IstioServiceMesh": { + "type": "object", + "description": "Istio service mesh configuration.", + "properties": { + "components": { + "$ref": "#/definitions/IstioComponents" + }, + "certificateAuthority": { + "$ref": "#/definitions/IstioCertificateAuthority" + }, + "revisions": { + "type": "array", + "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade", + "items": { + "type": "string" + }, + "uniqueItems": true, + "maxItems": 2 + } + } + }, + "IstioComponents": { + "type": "object", + "description": "Istio components configuration.", + "properties": { + "ingressGateways": { + "type": "array", + "description": "Istio ingress gateways.", + "items": { + "$ref": "#/definitions/IstioIngressGateway" + }, + "x-ms-identifiers": [] + }, + "egressGateways": { + "type": "array", + "description": "Istio egress gateways.", + "items": { + "$ref": "#/definitions/IstioEgressGateway" + }, + "x-ms-identifiers": [] + } + } + }, + "IstioIngressGateway": { + "type": "object", + "description": "Istio ingress gateway configuration. For now, we support up to one external ingress gateway named `aks-istio-ingressgateway-external` and one internal ingress gateway named `aks-istio-ingressgateway-internal`.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of an ingress gateway.", + "enum": [ + "External", + "Internal" + ], + "x-ms-enum": { + "name": "IstioIngressGatewayMode", + "modelAsString": true, + "values": [ + { + "value": "External", + "description": "The ingress gateway is assigned a public IP address and is publicly accessible." + }, + { + "value": "Internal", + "description": "The ingress gateway is assigned an internal IP address and cannot is accessed publicly." + } + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to enable the ingress gateway." + } + }, + "required": [ + "mode", + "enabled" + ] + }, + "IstioCertificateAuthority": { + "type": "object", + "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca", + "properties": { + "plugin": { + "$ref": "#/definitions/IstioPluginCertificateAuthority" + } + } + }, + "IstioPluginCertificateAuthority": { + "type": "object", + "description": "Plugin certificates information for Service Mesh.", + "properties": { + "keyVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "The resource ID of the Key Vault." + }, + "certObjectName": { + "type": "string", + "description": "Intermediate certificate object name in Azure Key Vault." + }, + "keyObjectName": { + "type": "string", + "description": "Intermediate certificate private key object name in Azure Key Vault." + }, + "rootCertObjectName": { + "type": "string", + "description": "Root certificate object name in Azure Key Vault." + }, + "certChainObjectName": { + "type": "string", + "description": "Certificate chain object name in Azure Key Vault." + } + } + }, + "IstioEgressGateway": { + "type": "object", + "description": "Istio egress gateway configuration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the egress gateway." + }, + "nodeSelector": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "NodeSelector for scheduling the egress gateway." + } + }, + "required": [ + "enabled" + ] + }, + "MeshRevisionProfileList": { + "type": "object", + "description": "Holds an array of MeshRevisionsProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevisionProfile" + }, + "description": "Array of service mesh add-on revision profiles for all supported mesh modes." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh revision profile.", + "readOnly": true + } + } + }, + "MeshRevisionProfile": { + "type": "object", + "description": "Mesh revision profile for a mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshRevisionProfileProperties" + } + } + }, + "MeshRevisionProfileProperties": { + "type": "object", + "description": "Mesh revision profile properties for a mesh", + "properties": { + "meshRevisions": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevision" + } + } + } + }, + "MeshUpgradeProfileList": { + "type": "object", + "description": "Holds an array of MeshUpgradeProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshUpgradeProfile" + }, + "description": "Array of supported service mesh add-on upgrade profiles." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh upgrade profile.", + "readOnly": true + } + } + }, + "MeshUpgradeProfile": { + "type": "object", + "description": "Upgrade profile for given mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshUpgradeProfileProperties" + } + } + }, + "MeshUpgradeProfileProperties": { + "type": "object", + "description": "Mesh upgrade profile properties for a major.minor release.", + "allOf": [ + { + "$ref": "#/definitions/MeshRevision" + } + ] + }, + "MeshRevision": { + "type": "object", + "description": "Holds information on upgrades and compatibility for given major.minor mesh release.", + "properties": { + "revision": { + "type": "string", + "description": "The revision of the mesh release." + }, + "upgrades": { + "type": "array", + "description": "List of revisions available for upgrade of a specific mesh revision", + "items": { + "type": "string", + "description": "An upgradeable mesh revision" + } + }, + "compatibleWith": { + "type": "array", + "description": "List of items this revision of service mesh is compatible with, and their associated versions.", + "items": { + "$ref": "#/definitions/CompatibleVersions" + }, + "x-ms-identifiers": [] + } + } + }, + "CompatibleVersions": { + "type": "object", + "description": "Version information about a product/service that is compatible with a service mesh revision.", + "properties": { + "name": { + "type": "string", + "description": "The product/service name." + }, + "versions": { + "type": "array", + "description": "Product/service versions compatible with a service mesh add-on revision.", + "items": { + "type": "string", + "description": "A compatible product/service version." + } + } + } + }, + "KubernetesSupportPlan": { + "type": "string", + "description": "Different support tiers for AKS managed clusters", + "enum": [ + "KubernetesOfficial", + "AKSLongTermSupport" + ], + "x-ms-enum": { + "name": "KubernetesSupportPlan", + "modelAsString": true, + "values": [ + { + "value": "KubernetesOfficial", + "description": "Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release." + }, + { + "value": "AKSLongTermSupport", + "description": "Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support." + } + ] + } + }, + "KubernetesVersionCapabilities": { + "type": "object", + "description": "Capabilities on this Kubernetes version.", + "properties": { + "supportPlan": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesSupportPlan" + } + } + } + }, + "KubernetesPatchVersion": { + "type": "object", + "description": "Kubernetes patch version profile", + "properties": { + "upgrades": { + "type": "array", + "description": "Possible upgrade path for given patch version", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "KubernetesVersion": { + "type": "object", + "description": "Kubernetes version profile for given major.minor release.", + "properties": { + "version": { + "type": "string", + "description": "major.minor version of Kubernetes release" + }, + "capabilities": { + "$ref": "#/definitions/KubernetesVersionCapabilities", + "description": "Capabilities on this Kubernetes version." + }, + "isPreview": { + "type": "boolean", + "description": "Whether this version is in preview mode." + }, + "patchVersions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KubernetesPatchVersion" + }, + "description": "Patch versions of Kubernetes release" + } + } + }, + "KubernetesVersionListResult": { + "type": "object", + "description": "Hold values properties, which is array of KubernetesVersion", + "properties": { + "values": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesVersion" + }, + "description": "Array of AKS supported Kubernetes versions." + } + } + }, + "TrustedAccessRoleRule": { + "type": "object", + "description": "Rule for trusted access role", + "properties": { + "verbs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed verbs" + }, + "apiGroups": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed apiGroups" + }, + "resources": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed resources" + }, + "resourceNames": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed names" + }, + "nonResourceURLs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed nonResourceURLs" + } + } + }, + "TrustedAccessRole": { + "type": "object", + "description": "Trusted access role definition.", + "properties": { + "sourceResourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type of Azure resource" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of role, name is unique under a source resource type" + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRoleRule" + }, + "x-ms-identifiers": [], + "description": "List of rules for the role. This maps to 'rules' property of [Kubernetes Cluster Role](https://kubernetes.io/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1/#ClusterRole)." + } + } + }, + "TrustedAccessRoleBindingProperties": { + "type": "object", + "description": "Properties for trusted access role binding", + "required": [ + "sourceResourceId", + "roles" + ], + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of trusted access role binding.", + "enum": [ + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "TrustedAccessRoleBindingProvisioningState", + "modelAsString": true + } + }, + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource ID of source resource that trusted access is configured for." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'." + } + } + }, + "TrustedAccessRoleBinding": { + "type": "object", + "description": "Defines binding between a resource and role", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TrustedAccessRoleBindingProperties", + "x-ms-client-flatten": true + } + } + }, + "TrustedAccessRoleBindingListResult": { + "type": "object", + "description": "List of trusted access role bindings", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "Role binding list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "TrustedAccessRoleListResult": { + "type": "object", + "description": "List of trusted access roles", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRole" + }, + "x-ms-identifiers": [ + "sourceResourceType", + "name" + ], + "description": "Role list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CapacityReservationGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/CapacityReservationGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Capacity Reservation Group to provide virtual machines from a reserved group of Virtual Machines.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Compute/capacityreservationgroups/{capacityReservationGroupName}' Customers use it to create an agentpool with a specified CRG. For more information see [Capacity Reservation](https://learn.microsoft.com/en-us/azure/virtual-machines/capacity-reservation-overview)" + } + }, + "parameters": { + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "AgentPoolNameParameter": { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + }, + "TrustedAccessRoleBindingNameParameter": { + "name": "trustedAccessRoleBindingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of trusted access role binding.", + "pattern": "^([A-Za-z0-9-])+$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "CredentialFormatParameter": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "exec", + "azure" + ], + "x-ms-enum": { + "name": "format", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Return azure auth-provider kubeconfig. This format is deprecated in v1.22 and will be fully removed in v1.26. See: https://aka.ms/k8s/changes-1-26." + }, + { + "value": "exec", + "description": "Return exec format kubeconfig. This format requires kubelogin binary in the path." + } + ] + }, + "description": "Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.", + "x-ms-parameter-location": "method" + }, + "MeshModeParameter": { + "name": "mode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The mode of the mesh.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json index bdd8e874cfce..bad0c95cc5de 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json @@ -1852,7 +1852,7 @@ }, "strategy": { "$ref": "#/definitions/UpdateRunStrategy", - "description": "The strategy defines the order in which the clusters will be updated. \nIf not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members.\nThe strategy of the UpdateRun can be modified until the run is started." + "description": "The strategy defines the order in which the clusters will be updated.\nIf not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members.\nThe strategy of the UpdateRun can be modified until the run is started." }, "managedClusterUpdate": { "$ref": "#/definitions/ManagedClusterUpdate", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json index 688f92eede15..8d2a74256f2e 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json @@ -2050,7 +2050,7 @@ }, "strategy": { "$ref": "#/definitions/UpdateRunStrategy", - "description": "The strategy defines the order in which the clusters will be updated. \nIf not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members.\nThe strategy of the UpdateRun can be modified until the run is started." + "description": "The strategy defines the order in which the clusters will be updated.\nIf not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members.\nThe strategy of the UpdateRun can be modified until the run is started." }, "managedClusterUpdate": { "$ref": "#/definitions/ManagedClusterUpdate", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json index cba097ededfc..cd53f942c776 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json @@ -2471,11 +2471,11 @@ }, "updateStrategyId": { "$ref": "#/definitions/FleetUpdateStrategyResourceId", - "description": "The resource id of the FleetUpdateStrategy resource to reference.\n\nWhen creating a new run, there are three ways to define a strategy for the run:\n1. Define a new strategy in place: Set the \"strategy\" field.\n2. Use an existing strategy: Set the \"updateStrategyId\" field. (since 2023-08-15-preview)\n3. Use the default strategy to update all the members one by one: Leave both \"updateStrategyId\" and \"strategy\" unset. (since 2023-08-15-preview)\n\nSetting both \"updateStrategyId\" and \"strategy\" is invalid.\n\nUpdateRuns created by \"updateStrategyId\" snapshot the referenced UpdateStrategy at the time of creation and store it in the \"strategy\" field. \nSubsequent changes to the referenced FleetUpdateStrategy resource do not propagate. \nUpdateRunStrategy changes can be made directly on the \"strategy\" field before launching the UpdateRun." + "description": "The resource id of the FleetUpdateStrategy resource to reference.\n\nWhen creating a new run, there are three ways to define a strategy for the run:\n1. Define a new strategy in place: Set the \"strategy\" field.\n2. Use an existing strategy: Set the \"updateStrategyId\" field. (since 2023-08-15-preview)\n3. Use the default strategy to update all the members one by one: Leave both \"updateStrategyId\" and \"strategy\" unset. (since 2023-08-15-preview)\n\nSetting both \"updateStrategyId\" and \"strategy\" is invalid.\n\nUpdateRuns created by \"updateStrategyId\" snapshot the referenced UpdateStrategy at the time of creation and store it in the \"strategy\" field.\nSubsequent changes to the referenced FleetUpdateStrategy resource do not propagate.\nUpdateRunStrategy changes can be made directly on the \"strategy\" field before launching the UpdateRun." }, "strategy": { "$ref": "#/definitions/UpdateRunStrategy", - "description": "The strategy defines the order in which the clusters will be updated. \nIf not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members.\nThe strategy of the UpdateRun can be modified until the run is started." + "description": "The strategy defines the order in which the clusters will be updated.\nIf not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members.\nThe strategy of the UpdateRun can be modified until the run is started." }, "managedClusterUpdate": { "$ref": "#/definitions/ManagedClusterUpdate", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json index 2bcec604a1ea..818e5804a15c 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json @@ -2355,11 +2355,11 @@ }, "updateStrategyId": { "$ref": "#/definitions/FleetUpdateStrategyResourceId", - "description": "The resource id of the FleetUpdateStrategy resource to reference.\n\nWhen creating a new run, there are three ways to define a strategy for the run:\n1. Define a new strategy in place: Set the \"strategy\" field.\n2. Use an existing strategy: Set the \"updateStrategyId\" field. (since 2023-08-15-preview)\n3. Use the default strategy to update all the members one by one: Leave both \"updateStrategyId\" and \"strategy\" unset. (since 2023-08-15-preview)\n\nSetting both \"updateStrategyId\" and \"strategy\" is invalid.\n\nUpdateRuns created by \"updateStrategyId\" snapshot the referenced UpdateStrategy at the time of creation and store it in the \"strategy\" field. \nSubsequent changes to the referenced FleetUpdateStrategy resource do not propagate. \nUpdateRunStrategy changes can be made directly on the \"strategy\" field before launching the UpdateRun." + "description": "The resource id of the FleetUpdateStrategy resource to reference.\n\nWhen creating a new run, there are three ways to define a strategy for the run:\n1. Define a new strategy in place: Set the \"strategy\" field.\n2. Use an existing strategy: Set the \"updateStrategyId\" field. (since 2023-08-15-preview)\n3. Use the default strategy to update all the members one by one: Leave both \"updateStrategyId\" and \"strategy\" unset. (since 2023-08-15-preview)\n\nSetting both \"updateStrategyId\" and \"strategy\" is invalid.\n\nUpdateRuns created by \"updateStrategyId\" snapshot the referenced UpdateStrategy at the time of creation and store it in the \"strategy\" field.\nSubsequent changes to the referenced FleetUpdateStrategy resource do not propagate.\nUpdateRunStrategy changes can be made directly on the \"strategy\" field before launching the UpdateRun." }, "strategy": { "$ref": "#/definitions/UpdateRunStrategy", - "description": "The strategy defines the order in which the clusters will be updated. \nIf not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members.\nThe strategy of the UpdateRun can be modified until the run is started." + "description": "The strategy defines the order in which the clusters will be updated.\nIf not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members.\nThe strategy of the UpdateRun can be modified until the run is started." }, "managedClusterUpdate": { "$ref": "#/definitions/ManagedClusterUpdate", diff --git a/specification/containerstorage/ContainerStorage.Management/main.tsp b/specification/containerstorage/ContainerStorage.Management/main.tsp index 84baa3e5a496..8eac06cd0bba 100644 --- a/specification/containerstorage/ContainerStorage.Management/main.tsp +++ b/specification/containerstorage/ContainerStorage.Management/main.tsp @@ -66,7 +66,9 @@ model PoolProperties { } @doc("Availability Zones") -enum Zone { +union Zone { + string, + @doc("First availability zone.") Zone1: "1", @@ -104,12 +106,14 @@ model PoolType { } @doc("Reclaim policy") -enum ReclaimPolicy { +union ReclaimPolicy { + string, + @doc("Delete resource") - Delete, + "Delete", @doc("Retain resource") - Retain, + "Retain", } @doc("Model for disk for that pool is using") @@ -149,27 +153,29 @@ model AzureDisk { } @doc("SKU of the underlying managed disk") -enum AzureDiskSkuName { +union AzureDiskSkuName { + string, + @doc("Premium_LRS SKU") - Premium_LRS, + "Premium_LRS", @doc("Standard_LRS SKU") - Standard_LRS, + "Standard_LRS", @doc("StandardSSD_LRS SKU") - StandardSSD_LRS, + "StandardSSD_LRS", @doc("UltraSSD_LRS SKU") - UltraSSD_LRS, + "UltraSSD_LRS", @doc("Premium_ZRS SKU") - Premium_ZRS, + "Premium_ZRS", @doc("PremiumV2_LRS SKU") - PremiumV2_LRS, + "PremiumV2_LRS", @doc("StandardSSD_ZRS SKU") - StandardSSD_ZRS, + "StandardSSD_ZRS", } @doc("Encryption key properties for the pool.") @@ -190,12 +196,14 @@ model ElasticSan { /** Sku Name enum type */ @doc("ElasticSAN SKUs") -enum ElasticSanSkuName { +union ElasticSanSkuName { + string, + @doc("Premium_LRS SKU") - Premium_LRS, + "Premium_LRS", @doc("Premium_ZRS SKU") - Premium_ZRS, + "Premium_ZRS", } @doc("Ephemeral Disk Pool Properties") @@ -210,20 +218,21 @@ model EphemeralDisk { @doc("Provisioning state of the resource.") @Azure.Core.lroStatus -enum ProvisioningState { - ...ResourceProvisioningState, +union ProvisioningState { + string, + ResourceProvisioningState, @doc("The resource is being provisioned") - Provisioning, + Provisioning: "Provisioning", @doc("The resource is updating") - Updating, + Updating: "Updating", @doc("The resource is being deleted") - Deleting, + Deleting: "Deleting", @doc("The resource create request has been accepted") - Accepted, + Accepted: "Accepted", } @doc("Status of the resource") @@ -236,15 +245,17 @@ model ResourceOperationalStatus { } @doc("State of the resource.") -enum ResourceOperationStatusState { +union ResourceOperationStatusState { + string, + @doc("The resource is pending.") - Pending, + "Pending", @doc("The resource is available.") - Available, + "Available", @doc("The resource is unavailable.") - Unavailable, + "Unavailable", } // END POOL @@ -353,18 +364,20 @@ model AssignmentStatus { } @doc("Status of the assignment resource") -enum AssignmentStatusState { +union AssignmentStatusState { + string, + @doc("The assignment of the pool to the resource is in progress") - Assigning, + "Assigning", @doc("The assignment to the pool was successful.") - Assigned, + "Assigned", @doc("The pool is being unassigned.") - Unassigning, + "Unassigning", @doc("The operation of assigning or unassigning the pool failed.") - Failed, + "Failed", } scalar AssignmentId diff --git a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json index 4ce50e99d351..e8076a774888 100644 --- a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json +++ b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json @@ -67,7 +67,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -106,7 +106,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PoolListResult" } @@ -154,7 +154,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PoolListResult" } @@ -212,7 +212,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Pool" } @@ -280,7 +280,7 @@ } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Azure create operation completed successfully.", "schema": { "$ref": "#/definitions/Pool" }, @@ -353,7 +353,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Pool" } @@ -438,7 +438,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -488,7 +488,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SnapshotListResult" } @@ -550,7 +550,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Snapshot" } @@ -622,7 +622,7 @@ } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Azure create operation completed successfully.", "schema": { "$ref": "#/definitions/Snapshot" }, @@ -704,7 +704,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -754,7 +754,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VolumeListResult" } @@ -816,7 +816,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Volume" } @@ -888,7 +888,7 @@ } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Azure create operation completed successfully.", "schema": { "$ref": "#/definitions/Volume" }, @@ -965,7 +965,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Volume" } @@ -1054,7 +1054,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -1101,7 +1101,7 @@ "AssignmentId": { "type": "string", "format": "arm-id", - "description": "A type definition that refers the id to an ARM resource.", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", "x-ms-arm-id-details": { "allowedResources": [ { diff --git a/specification/contosowidgetmanager/data-plane/readme.md b/specification/contosowidgetmanager/data-plane/readme.md index ed363973c5bd..60258e3463c2 100644 --- a/specification/contosowidgetmanager/data-plane/readme.md +++ b/specification/contosowidgetmanager/data-plane/readme.md @@ -19,7 +19,7 @@ tag: package-2022-11-01-preview ### Tag: package-2022-11-01-preview -These settings apply only when `--tag=package--2022-11-01-preview` is specified on the command line. +These settings apply only when `--tag=package-2022-11-01-preview` is specified on the command line. ```yaml $(tag) == 'package-2022-11-01-preview' input-file: @@ -51,4 +51,4 @@ suppressions: - code: LroExtension - code: SchemaTypeAndFormat - code: PathParameterSchema -``` \ No newline at end of file +``` diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json new file mode 100644 index 000000000000..0516bacfa235 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json @@ -0,0 +1,12255 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2024-02-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.DocumentDB/databaseAccounts/{accountName}": { + "get": { + "operationId": "DatabaseAccounts_Get", + "x-ms-examples": { + "CosmosDBDatabaseAccountGet": { + "$ref": "./examples/CosmosDBDatabaseAccountGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The database account properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountGetResults" + } + } + } + }, + "patch": { + "operationId": "DatabaseAccounts_Update", + "x-ms-examples": { + "CosmosDBDatabaseAccountPatch": { + "$ref": "./examples/CosmosDBDatabaseAccountPatch.json" + } + }, + "description": "Updates the properties of an existing Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseAccountUpdateParameters" + }, + "description": "The parameters to provide for the current database account." + } + ], + "responses": { + "200": { + "description": "The database account update operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DatabaseAccountGetResults" + } + } + } + }, + "put": { + "operationId": "DatabaseAccounts_CreateOrUpdate", + "x-ms-examples": { + "CosmosDBDatabaseAccountCreateMin": { + "$ref": "./examples/CosmosDBDatabaseAccountCreateMin.json" + }, + "CosmosDBDatabaseAccountCreateMax": { + "$ref": "./examples/CosmosDBDatabaseAccountCreateMax.json" + }, + "CosmosDBRestoreDatabaseAccountCreateUpdate.json": { + "$ref": "./examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json" + } + }, + "description": "Creates or updates an Azure Cosmos DB database account. The \"Update\" method is preferred when performing updates on an account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseAccountCreateUpdateParameters" + }, + "description": "The parameters to provide for the current database account." + } + ], + "responses": { + "200": { + "description": "The database account create or update operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DatabaseAccountGetResults" + } + } + } + }, + "delete": { + "operationId": "DatabaseAccounts_Delete", + "x-ms-examples": { + "CosmosDBDatabaseAccountDelete": { + "$ref": "./examples/CosmosDBDatabaseAccountDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The database account delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The specified account does not exist in the subscription." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/failoverPriorityChange": { + "post": { + "operationId": "DatabaseAccounts_FailoverPriorityChange", + "x-ms-examples": { + "CosmosDBDatabaseAccountFailoverPriorityChange": { + "$ref": "./examples/CosmosDBDatabaseAccountFailoverPriorityChange.json" + } + }, + "description": "Changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "failoverParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FailoverPolicies" + }, + "description": "The new failover policies for the database account." + } + ], + "responses": { + "202": { + "description": "Accepted. The failover policy change operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/databaseAccounts": { + "get": { + "operationId": "DatabaseAccounts_List", + "x-ms-examples": { + "CosmosDBDatabaseAccountList": { + "$ref": "./examples/CosmosDBDatabaseAccountList.json" + } + }, + "description": "Lists all the Azure Cosmos DB database accounts available under the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts": { + "get": { + "operationId": "DatabaseAccounts_ListByResourceGroup", + "x-ms-examples": { + "CosmosDBDatabaseAccountListByResourceGroup": { + "$ref": "./examples/CosmosDBDatabaseAccountListByResourceGroup.json" + } + }, + "description": "Lists all the Azure Cosmos DB database accounts available under the given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys": { + "post": { + "operationId": "DatabaseAccounts_ListKeys", + "x-ms-examples": { + "CosmosDBDatabaseAccountListKeys": { + "$ref": "./examples/CosmosDBDatabaseAccountListKeys.json" + } + }, + "description": "Lists the access keys for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listConnectionStrings": { + "post": { + "operationId": "DatabaseAccounts_ListConnectionStrings", + "x-ms-examples": { + "CosmosDBDatabaseAccountListConnectionStrings": { + "$ref": "./examples/CosmosDBDatabaseAccountListConnectionStrings.json" + }, + "CosmosDBDatabaseAccountListConnectionStringsMongo": { + "$ref": "./examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json" + } + }, + "description": "Lists the connection strings for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListConnectionStringsResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/offlineRegion": { + "post": { + "operationId": "DatabaseAccounts_OfflineRegion", + "x-ms-examples": { + "CosmosDBDatabaseAccountOfflineRegion": { + "$ref": "./examples/CosmosDBDatabaseAccountOfflineRegion.json" + } + }, + "description": "Offline the specified region for the specified Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "regionParameterForOffline", + "in": "body", + "required": true, + "description": "Cosmos DB region to offline for the database account.", + "schema": { + "$ref": "#/definitions/RegionForOnlineOffline" + } + } + ], + "responses": { + "200": { + "description": "The offline region operation is completed successfully." + }, + "202": { + "description": "Accepted. The offline region operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/onlineRegion": { + "post": { + "operationId": "DatabaseAccounts_OnlineRegion", + "x-ms-examples": { + "CosmosDBDatabaseAccountOnlineRegion": { + "$ref": "./examples/CosmosDBDatabaseAccountOnlineRegion.json" + } + }, + "description": "Online the specified region for the specified Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "regionParameterForOnline", + "in": "body", + "required": true, + "description": "Cosmos DB region to online for the database account.", + "schema": { + "$ref": "#/definitions/RegionForOnlineOffline" + } + } + ], + "responses": { + "200": { + "description": "The online region operation is completed successfully." + }, + "202": { + "description": "Accepted. The online region operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys": { + "get": { + "operationId": "DatabaseAccounts_GetReadOnlyKeys", + "x-ms-examples": { + "CosmosDBDatabaseAccountListReadOnlyKeys": { + "$ref": "./examples/CosmosDBDatabaseAccountListReadOnlyKeys.json" + } + }, + "description": "Lists the read-only access keys for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListReadOnlyKeysResult" + } + } + } + }, + "post": { + "operationId": "DatabaseAccounts_ListReadOnlyKeys", + "x-ms-examples": { + "CosmosDBDatabaseAccountListReadOnlyKeys": { + "$ref": "./examples/CosmosDBDatabaseAccountListReadOnlyKeys.json" + } + }, + "description": "Lists the read-only access keys for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListReadOnlyKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/regenerateKey": { + "post": { + "operationId": "DatabaseAccounts_RegenerateKey", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegenerateKey": { + "$ref": "./examples/CosmosDBDatabaseAccountRegenerateKey.json" + } + }, + "description": "Regenerates an access key for the specified Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "keyToRegenerate", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseAccountRegenerateKeyParameters" + }, + "description": "The name of the key to regenerate." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The regenerate key operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + } + } + } + }, + "/providers/Microsoft.DocumentDB/databaseAccountNames/{accountName}": { + "head": { + "operationId": "DatabaseAccounts_CheckNameExists", + "x-ms-examples": { + "CosmosDBDatabaseAccountCheckNameExists": { + "$ref": "./examples/CosmosDBDatabaseAccountCheckNameExists.json" + } + }, + "description": "Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.", + "parameters": [ + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The account name is valid but is already in use." + }, + "404": { + "description": "Not Found. The account name is available and valid." + } + } + } + }, + "/providers/Microsoft.DocumentDB/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Cosmos DB Resource Provider operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "CosmosDBOperationsList": { + "$ref": "./examples/CosmosDBOperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics": { + "get": { + "operationId": "DatabaseAccounts_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountGetMetrics": { + "$ref": "./examples/CosmosDBDatabaseAccountGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metrics": { + "get": { + "operationId": "Database_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseGetMetrics": { + "$ref": "./examples/CosmosDBDatabaseGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account and database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metrics": { + "get": { + "operationId": "Collection_ListMetrics", + "x-ms-examples": { + "CosmosDBCollectionGetMetrics": { + "$ref": "./examples/CosmosDBCollectionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account and collection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/metrics": { + "get": { + "operationId": "CollectionRegion_ListMetrics", + "x-ms-examples": { + "CosmosDBRegionCollectionGetMetrics": { + "$ref": "./examples/CosmosDBRegionCollectionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account, collection and region.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics": { + "get": { + "operationId": "DatabaseAccountRegion_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBDatabaseAccountRegionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account and region.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/metrics": { + "get": { + "operationId": "PercentileSourceTarget_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPercentileSourceTargetGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given account, source and target region. This url is only for PBS and Replication Latency data", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/sourceRegionParameter" + }, + { + "$ref": "#/parameters/targetRegionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The percentile metrics for the account, source and target regions were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PercentileMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics": { + "get": { + "operationId": "PercentileTarget_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPercentileTargetGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/targetRegionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The percentile metrics for the account and target regions were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PercentileMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/percentile/metrics": { + "get": { + "operationId": "Percentile_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPercentileGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The percentile metrics for the account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PercentileMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics": { + "get": { + "operationId": "CollectionPartitionRegion_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBCollectionPartitionRegionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given collection and region, split by partition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The partition-level metrics for the collection and region were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics": { + "get": { + "operationId": "CollectionPartition_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBCollectionPartitionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given collection, split by partition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The partition-level metrics for the collection were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics": { + "get": { + "operationId": "PartitionKeyRangeId_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPKeyRangeIdGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given partition key range id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "#/parameters/partitionKeyRangeIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The partition-level metrics for the partition key range id were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics": { + "get": { + "operationId": "PartitionKeyRangeIdRegion_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPKeyRangeIdRegionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given partition key range id and region.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "#/parameters/partitionKeyRangeIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The partition-level metrics for the partition key range id and region were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages": { + "get": { + "operationId": "DatabaseAccounts_ListUsages", + "x-ms-examples": { + "CosmosDBDatabaseAccountGetUsages": { + "$ref": "./examples/CosmosDBDatabaseAccountGetUsages.json" + } + }, + "description": "Retrieves the usages (most recent data) for the given database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/UsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages": { + "get": { + "operationId": "Database_ListUsages", + "x-ms-examples": { + "CosmosDBDatabaseGetUsages": { + "$ref": "./examples/CosmosDBDatabaseGetUsages.json" + } + }, + "description": "Retrieves the usages (most recent data) for the given database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for the database were retrieved successfully.", + "schema": { + "$ref": "#/definitions/UsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages": { + "get": { + "operationId": "Collection_ListUsages", + "x-ms-examples": { + "CosmosDBCollectionGetUsages": { + "$ref": "./examples/CosmosDBCollectionGetUsages.json" + } + }, + "description": "Retrieves the usages (most recent storage data) for the given collection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for the collection were retrieved successfully.", + "schema": { + "$ref": "#/definitions/UsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages": { + "get": { + "operationId": "CollectionPartition_ListUsages", + "x-ms-examples": { + "CosmosDBCollectionGetUsages": { + "$ref": "./examples/CosmosDBCollectionPartitionGetUsages.json" + } + }, + "description": "Retrieves the usages (most recent storage data) for the given collection, split by partition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for the collection, per partition were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metricDefinitions": { + "get": { + "operationId": "Database_ListMetricDefinitions", + "x-ms-examples": { + "CosmosDBDatabaseGetMetricDefinitions": { + "$ref": "./examples/CosmosDBDatabaseGetMetricDefinitions.json" + } + }, + "description": "Retrieves metric definitions for the given database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric definitions for the database were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricDefinitionsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metricDefinitions": { + "get": { + "operationId": "Collection_ListMetricDefinitions", + "x-ms-examples": { + "CosmosDBCollectionGetMetricDefinitions": { + "$ref": "./examples/CosmosDBCollectionGetMetricDefinitions.json" + } + }, + "description": "Retrieves metric definitions for the given collection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric definitions for the collection were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricDefinitionsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions": { + "get": { + "operationId": "DatabaseAccounts_ListMetricDefinitions", + "x-ms-examples": { + "CosmosDBDatabaseAccountGetMetricDefinitions": { + "$ref": "./examples/CosmosDBDatabaseAccountGetMetricDefinitions.json" + } + }, + "description": "Retrieves metric definitions for the given database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric definitions for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricDefinitionsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs": { + "get": { + "operationId": "GraphResources_ListGraphs", + "x-ms-examples": { + "CosmosDBSqlDatabaseList": { + "$ref": "./examples/CosmosDBGraphResourceList.json" + } + }, + "description": "Lists the graphs under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The graph resource properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/GraphResourcesListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs/{graphName}": { + "get": { + "operationId": "GraphResources_GetGraph", + "x-ms-examples": { + "CosmosDBSqlDatabaseGet": { + "$ref": "./examples/CosmosDBGraphResourceGet.json" + } + }, + "description": "Gets the Graph resource under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/graphResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Graph resource property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/GraphResourceGetResults" + } + } + } + }, + "put": { + "operationId": "GraphResources_CreateUpdateGraph", + "x-ms-examples": { + "CosmosDBGraphCreateUpdate": { + "$ref": "./examples/CosmosDBGraphResourceCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Graph.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/graphResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateGraphParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GraphResourceCreateUpdateParameters" + }, + "description": "The parameters to provide for the current graph." + } + ], + "responses": { + "202": { + "description": "The graph create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Graph create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/GraphResourceGetResults" + } + } + } + }, + "delete": { + "operationId": "GraphResources_DeleteGraphResource", + "x-ms-examples": { + "CosmosDBSqlDatabaseDelete": { + "$ref": "./examples/CosmosDBGraphResourceDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Graph Resource.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/graphResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The graph delete operation was completed successfully." + }, + "202": { + "description": "The graph delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The graph delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases": { + "get": { + "operationId": "SqlResources_ListSqlDatabases", + "x-ms-examples": { + "CosmosDBSqlDatabaseList": { + "$ref": "./examples/CosmosDBSqlDatabaseList.json" + } + }, + "description": "Lists the SQL databases under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL database properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}": { + "get": { + "operationId": "SqlResources_GetSqlDatabase", + "x-ms-examples": { + "CosmosDBSqlDatabaseGet": { + "$ref": "./examples/CosmosDBSqlDatabaseGet.json" + } + }, + "description": "Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL database property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlDatabase", + "x-ms-examples": { + "CosmosDBSqlDatabaseCreateUpdate": { + "$ref": "./examples/CosmosDBSqlDatabaseCreateUpdate.json" + }, + "CosmosDBSqlDatabaseRestore": { + "$ref": "./examples/CosmosDBSqlDatabaseRestore.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlDatabaseParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlDatabaseCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL database." + } + ], + "responses": { + "202": { + "description": "The SQL database create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL database create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlDatabase", + "x-ms-examples": { + "CosmosDBSqlDatabaseDelete": { + "$ref": "./examples/CosmosDBSqlDatabaseDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL database.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL database delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The SQL database delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default": { + "get": { + "operationId": "SqlResources_GetSqlDatabaseThroughput", + "x-ms-examples": { + "CosmosDBSqlDatabaseThroughputGet": { + "$ref": "./examples/CosmosDBSqlDatabaseThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the SQL database was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_UpdateSqlDatabaseThroughput", + "x-ms-examples": { + "CosmosDBSqlDatabaseThroughputUpdate": { + "$ref": "./examples/CosmosDBSqlDatabaseThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB SQL database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The parameters to provide for the RUs per second of the current SQL database." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the SQL database update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the SQL database update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "SqlResources_MigrateSqlDatabaseToAutoscale", + "x-ms-examples": { + "CosmosDBSqlDatabaseMigrateToAutoscale": { + "$ref": "./examples/CosmosDBSqlDatabaseMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL database migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "SqlResources_MigrateSqlDatabaseToManualThroughput", + "x-ms-examples": { + "CosmosDBSqlDatabaseMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL database migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys": { + "get": { + "operationId": "SqlResources_ListClientEncryptionKeys", + "x-ms-examples": { + "CosmosDBClientEncryptionKeysList": { + "$ref": "./examples/CosmosDBSqlClientEncryptionKeysList.json" + } + }, + "description": "Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The ClientEncryptionKeys were retrieved successfully.", + "schema": { + "$ref": "#/definitions/ClientEncryptionKeysListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}": { + "get": { + "operationId": "SqlResources_GetClientEncryptionKey", + "x-ms-examples": { + "CosmosDBClientEncryptionKeyGet": { + "$ref": "./examples/CosmosDBSqlClientEncryptionKeyGet.json" + } + }, + "description": "Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/clientEncryptionKeyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The ClientEncryptionKey was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ClientEncryptionKeyGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateClientEncryptionKey", + "x-ms-examples": { + "CosmosDBClientEncryptionKeyCreateUpdate": { + "$ref": "./examples/CosmosDBSqlClientEncryptionKeyCreateUpdate.json" + } + }, + "description": "Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/clientEncryptionKeyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateClientEncryptionKeyParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClientEncryptionKeyCreateUpdateParameters" + }, + "description": "The parameters to provide for the client encryption key." + } + ], + "responses": { + "202": { + "description": "The client encryption key create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The client encryption key create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ClientEncryptionKeyGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers": { + "get": { + "operationId": "SqlResources_ListSqlContainers", + "x-ms-examples": { + "CosmosDBSqlContainerList": { + "$ref": "./examples/CosmosDBSqlContainerList.json" + } + }, + "description": "Lists the SQL container under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL container properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlContainerListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}": { + "get": { + "operationId": "SqlResources_GetSqlContainer", + "x-ms-examples": { + "CosmosDBSqlContainerGet": { + "$ref": "./examples/CosmosDBSqlContainerGet.json" + } + }, + "description": "Gets the SQL container under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL container property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlContainerGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlContainer", + "x-ms-examples": { + "CosmosDBSqlContainerCreateUpdate": { + "$ref": "./examples/CosmosDBSqlContainerCreateUpdate.json" + }, + "CosmosDBSqlContainerRestore": { + "$ref": "./examples/CosmosDBSqlContainerRestore.json" + }, + "CosmosDBSqlMaterializedViewCreateUpdate": { + "$ref": "./examples/CosmosDBSqlMaterializedViewCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL container", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlContainerParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlContainerCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL container." + } + ], + "responses": { + "202": { + "description": "The SQL container create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL container create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlContainerGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlContainer", + "x-ms-examples": { + "CosmosDBSqlContainerDelete": { + "$ref": "./examples/CosmosDBSqlContainerDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL container.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL container delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The SQL container delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/partitionMerge": { + "post": { + "operationId": "SqlResources_SqlDatabasePartitionMerge", + "x-ms-examples": { + "CosmosDBSqlDatabasePartitionMerge": { + "$ref": "./examples/CosmosDBSqlDatabasePartitionMerge.json" + } + }, + "description": "Merges the partitions of a SQL database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "mergeParameters", + "required": true, + "description": "The parameters for the merge operation.", + "schema": { + "$ref": "#/definitions/MergeParameters" + } + } + ], + "responses": { + "202": { + "description": "The SQL database merge operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL database merge operation was completed successfully.", + "schema": { + "$ref": "#/definitions/PhysicalPartitionStorageInfoCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/partitionMerge": { + "post": { + "operationId": "SqlResources_ListSqlContainerPartitionMerge", + "x-ms-examples": { + "CosmosDBSqlContainerPartitionMerge": { + "$ref": "./examples/CosmosDBSqlContainerPartitionMerge.json" + } + }, + "description": "Merges the partitions of a SQL Container", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "mergeParameters", + "required": true, + "description": "The parameters for the merge operation.", + "schema": { + "$ref": "#/definitions/MergeParameters" + } + } + ], + "responses": { + "202": { + "description": "The SQL container merge operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL container merge operation was completed successfully.", + "schema": { + "$ref": "#/definitions/PhysicalPartitionStorageInfoCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default": { + "get": { + "operationId": "SqlResources_GetSqlContainerThroughput", + "x-ms-examples": { + "CosmosDBSqlContainerThroughputGet": { + "$ref": "./examples/CosmosDBSqlContainerThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the SQL container was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_UpdateSqlContainerThroughput", + "x-ms-examples": { + "CosmosDBSqlContainerThroughputUpdate": { + "$ref": "./examples/CosmosDBSqlContainerThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB SQL container", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The parameters to provide for the RUs per second of the current SQL container." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the SQL container update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the SQL container update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "SqlResources_MigrateSqlContainerToAutoscale", + "x-ms-examples": { + "CosmosDBSqlContainerMigrateToAutoscale": { + "$ref": "./examples/CosmosDBSqlContainerMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL container migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL container migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "SqlResources_MigrateSqlContainerToManualThroughput", + "x-ms-examples": { + "CosmosDBSqlContainerMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBSqlContainerMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL container migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL container migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution": { + "post": { + "operationId": "SqlResources_SqlDatabaseRetrieveThroughputDistribution", + "x-ms-examples": { + "CosmosDBSqlDatabaseRetrieveThroughputDistribution": { + "$ref": "./examples/CosmosDBSqlDatabaseRetrieveThroughputDistribution.json" + } + }, + "description": "Retrieve throughput distribution for an Azure Cosmos DB SQL database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "retrieveThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RetrieveThroughputParameters" + }, + "description": "The parameters to provide for retrieving throughput distribution for the current SQL database." + } + ], + "responses": { + "202": { + "description": "The retrieve throughput distribution for SQL database operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The retrieve throughput distribution for SQL database operation was completed successfully.", + "schema": { + "$ref": "#/definitions/PhysicalPartitionThroughputInfoResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/redistributeThroughput": { + "post": { + "operationId": "SqlResources_SqlDatabaseRedistributeThroughput", + "x-ms-examples": { + "CosmosDBSqlDatabaseRedistributeThroughput": { + "$ref": "./examples/CosmosDBSqlDatabaseRedistributeThroughput.json" + } + }, + "description": "Redistribute throughput for an Azure Cosmos DB SQL database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "redistributeThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedistributeThroughputParameters" + }, + "description": "The parameters to provide for redistributing throughput for the current SQL database." + } + ], + "responses": { + "202": { + "description": "The redistribution throughput for SQL database operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The redistribution throughput for SQL database operation was completed successfully.", + "schema": { + "$ref": "#/definitions/PhysicalPartitionThroughputInfoResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/retrieveThroughputDistribution": { + "post": { + "operationId": "SqlResources_SqlContainerRetrieveThroughputDistribution", + "x-ms-examples": { + "CosmosDBSqlContainerRetrieveThroughputDistribution": { + "$ref": "./examples/CosmosDBSqlContainerRetrieveThroughputDistribution.json" + } + }, + "description": "Retrieve throughput distribution for an Azure Cosmos DB SQL container", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "retrieveThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RetrieveThroughputParameters" + }, + "description": "The parameters to provide for retrieving throughput distribution for the current SQL container." + } + ], + "responses": { + "202": { + "description": "The retrieve throughput distribution for SQL container operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The retrieve throughput distribution for SQL container operation was completed successfully.", + "schema": { + "$ref": "#/definitions/PhysicalPartitionThroughputInfoResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/redistributeThroughput": { + "post": { + "operationId": "SqlResources_SqlContainerRedistributeThroughput", + "x-ms-examples": { + "CosmosDBSqlContainerRedistributeThroughput": { + "$ref": "./examples/CosmosDBSqlContainerRedistributeThroughput.json" + } + }, + "description": "Redistribute throughput for an Azure Cosmos DB SQL container", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "redistributeThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedistributeThroughputParameters" + }, + "description": "The parameters to provide for redistributing throughput for the current SQL container." + } + ], + "responses": { + "202": { + "description": "The redistribution throughput for SQL container operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The redistribution throughput for SQL container operation was completed successfully.", + "schema": { + "$ref": "#/definitions/PhysicalPartitionThroughputInfoResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures": { + "get": { + "operationId": "SqlResources_ListSqlStoredProcedures", + "x-ms-examples": { + "CosmosDBSqlStoredProcedureList": { + "$ref": "./examples/CosmosDBSqlStoredProcedureList.json" + } + }, + "description": "Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL stored procedure properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlStoredProcedureListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}": { + "get": { + "operationId": "SqlResources_GetSqlStoredProcedure", + "x-ms-examples": { + "CosmosDBSqlStoredProcedureGet": { + "$ref": "./examples/CosmosDBSqlStoredProcedureGet.json" + } + }, + "description": "Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/storedProcedureNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL storedProcedure property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlStoredProcedureGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlStoredProcedure", + "x-ms-examples": { + "CosmosDBSqlStoredProcedureCreateUpdate": { + "$ref": "./examples/CosmosDBSqlStoredProcedureCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL storedProcedure", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/storedProcedureNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlStoredProcedureParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlStoredProcedureCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL storedProcedure." + } + ], + "responses": { + "202": { + "description": "The SQL storedProcedure create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL storedProcedure create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlStoredProcedureGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlStoredProcedure", + "x-ms-examples": { + "CosmosDBSqlStoredProcedureDelete": { + "$ref": "./examples/CosmosDBSqlStoredProcedureDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL storedProcedure.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/storedProcedureNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL storedProcedure delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The SQL storedProcedure delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions": { + "get": { + "operationId": "SqlResources_ListSqlUserDefinedFunctions", + "x-ms-examples": { + "CosmosDBSqlUserDefinedFunctionList": { + "$ref": "./examples/CosmosDBSqlUserDefinedFunctionList.json" + } + }, + "description": "Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL userDefinedFunction properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlUserDefinedFunctionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}": { + "get": { + "operationId": "SqlResources_GetSqlUserDefinedFunction", + "x-ms-examples": { + "CosmosDBSqlUserDefinedFunctionGet": { + "$ref": "./examples/CosmosDBSqlUserDefinedFunctionGet.json" + } + }, + "description": "Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/userDefinedFunctionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL userDefinedFunction property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlUserDefinedFunctionGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlUserDefinedFunction", + "x-ms-examples": { + "CosmosDBSqlUserDefinedFunctionCreateUpdate": { + "$ref": "./examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL userDefinedFunction", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/userDefinedFunctionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlUserDefinedFunctionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlUserDefinedFunctionCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL userDefinedFunction." + } + ], + "responses": { + "202": { + "description": "The SQL userDefinedFunction create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL userDefinedFunction create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlUserDefinedFunctionGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlUserDefinedFunction", + "x-ms-examples": { + "CosmosDBSqlUserDefinedFunctionDelete": { + "$ref": "./examples/CosmosDBSqlUserDefinedFunctionDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL userDefinedFunction.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/userDefinedFunctionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL userDefinedFunction delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The SQL userDefinedFunction delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers": { + "get": { + "operationId": "SqlResources_ListSqlTriggers", + "x-ms-examples": { + "CosmosDBSqlTriggerList": { + "$ref": "./examples/CosmosDBSqlTriggerList.json" + } + }, + "description": "Lists the SQL trigger under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL trigger properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlTriggerListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}": { + "get": { + "operationId": "SqlResources_GetSqlTrigger", + "x-ms-examples": { + "CosmosDBSqlTriggerGet": { + "$ref": "./examples/CosmosDBSqlTriggerGet.json" + } + }, + "description": "Gets the SQL trigger under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/triggerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL trigger property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlTriggerGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlTrigger", + "x-ms-examples": { + "CosmosDBSqlTriggerCreateUpdate": { + "$ref": "./examples/CosmosDBSqlTriggerCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL trigger", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/triggerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlTriggerParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlTriggerCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL trigger." + } + ], + "responses": { + "202": { + "description": "The SQL trigger create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL trigger create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlTriggerGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlTrigger", + "x-ms-examples": { + "CosmosDBSqlTriggerDelete": { + "$ref": "./examples/CosmosDBSqlTriggerDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/triggerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL trigger delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The SQL trigger delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases": { + "get": { + "operationId": "MongoDBResources_ListMongoDBDatabases", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseList": { + "$ref": "./examples/CosmosDBMongoDBDatabaseList.json" + } + }, + "description": "Lists the MongoDB databases under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The MongoDB database properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoDBDatabaseListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}": { + "get": { + "operationId": "MongoDBResources_GetMongoDBDatabase", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseGet": { + "$ref": "./examples/CosmosDBMongoDBDatabaseGet.json" + } + }, + "description": "Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The MongoDB database property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoDBDatabaseGetResults" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_CreateUpdateMongoDBDatabase", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseCreateUpdate": { + "$ref": "./examples/CosmosDBMongoDBDatabaseCreateUpdate.json" + }, + "CosmosDBMongoDBDatabaseRestore": { + "$ref": "./examples/CosmosDBMongoDBDatabaseRestore.json" + } + }, + "description": "Create or updates Azure Cosmos DB MongoDB database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateMongoDBDatabaseParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MongoDBDatabaseCreateUpdateParameters" + }, + "description": "The parameters to provide for the current MongoDB database." + } + ], + "responses": { + "202": { + "description": "The MongoDB database create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB database create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/MongoDBDatabaseGetResults" + } + } + } + }, + "delete": { + "operationId": "MongoDBResources_DeleteMongoDBDatabase", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseDelete": { + "$ref": "./examples/CosmosDBMongoDBDatabaseDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB MongoDB database.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB database delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The MongoDB database delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default": { + "get": { + "operationId": "MongoDBResources_GetMongoDBDatabaseThroughput", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseThroughputGet": { + "$ref": "./examples/CosmosDBMongoDBDatabaseThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the MongoDB database was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_UpdateMongoDBDatabaseThroughput", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseThroughputUpdate": { + "$ref": "./examples/CosmosDBMongoDBDatabaseThroughputUpdate.json" + } + }, + "description": "Update RUs per second of the an Azure Cosmos DB MongoDB database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current MongoDB database." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the MongoDB database update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the MongoDB database update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBDatabaseToAutoscale", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseMigrateToAutoscale": { + "$ref": "./examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB database migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBDatabaseToManualThroughput", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB database migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution": { + "post": { + "operationId": "MongoDBResources_MongoDBDatabaseRetrieveThroughputDistribution", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseRetrieveThroughputDistribution": { + "$ref": "./examples/CosmosDBMongoDBDatabaseRetrieveThroughputDistribution.json" + } + }, + "description": "Retrieve throughput distribution for an Azure Cosmos DB MongoDB database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "retrieveThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RetrieveThroughputParameters" + }, + "description": "The parameters to provide for retrieving throughput distribution for the current MongoDB database." + } + ], + "responses": { + "202": { + "description": "The retrieve throughput distribution for MongoDB database operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The retrieve throughput distribution for MongoDB database operation was completed successfully.", + "schema": { + "$ref": "#/definitions/PhysicalPartitionThroughputInfoResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/redistributeThroughput": { + "post": { + "operationId": "MongoDBResources_MongoDBDatabaseRedistributeThroughput", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseRedistributeThroughput": { + "$ref": "./examples/CosmosDBMongoDBDatabaseRedistributeThroughput.json" + } + }, + "description": "Redistribute throughput for an Azure Cosmos DB MongoDB database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "redistributeThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedistributeThroughputParameters" + }, + "description": "The parameters to provide for redistributing throughput for the current MongoDB database." + } + ], + "responses": { + "202": { + "description": "The redistribution throughput for MongoDB database operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The redistribution throughput for MongoDB database operation was completed successfully.", + "schema": { + "$ref": "#/definitions/PhysicalPartitionThroughputInfoResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/retrieveThroughputDistribution": { + "post": { + "operationId": "MongoDBResources_MongoDBContainerRetrieveThroughputDistribution", + "x-ms-examples": { + "CosmosDBMongoDBCollectionRetrieveThroughputDistribution": { + "$ref": "./examples/CosmosDBMongoDBCollectionRetrieveThroughputDistribution.json" + } + }, + "description": "Retrieve throughput distribution for an Azure Cosmos DB MongoDB container", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "retrieveThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RetrieveThroughputParameters" + }, + "description": "The parameters to provide for retrieving throughput distribution for the current MongoDB container." + } + ], + "responses": { + "202": { + "description": "The retrieve throughput distribution for MongoDB container operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The retrieve throughput distribution for MongoDB container operation was completed successfully.", + "schema": { + "$ref": "#/definitions/PhysicalPartitionThroughputInfoResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/redistributeThroughput": { + "post": { + "operationId": "MongoDBResources_MongoDBContainerRedistributeThroughput", + "x-ms-examples": { + "CosmosDBMongoDBCollectionRedistributeThroughput": { + "$ref": "./examples/CosmosDBMongoDBCollectionRedistributeThroughput.json" + } + }, + "description": "Redistribute throughput for an Azure Cosmos DB MongoDB container", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "redistributeThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedistributeThroughputParameters" + }, + "description": "The parameters to provide for redistributing throughput for the current MongoDB container." + } + ], + "responses": { + "202": { + "description": "The redistribution throughput for MongoDB container operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The redistribution throughput for MongoDB container operation was completed successfully.", + "schema": { + "$ref": "#/definitions/PhysicalPartitionThroughputInfoResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections": { + "get": { + "operationId": "MongoDBResources_ListMongoDBCollections", + "x-ms-examples": { + "CosmosDBMongoDBCollectionList": { + "$ref": "./examples/CosmosDBMongoDBCollectionList.json" + } + }, + "description": "Lists the MongoDB collection under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The MongoDB collection properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoDBCollectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}": { + "get": { + "operationId": "MongoDBResources_GetMongoDBCollection", + "x-ms-examples": { + "CosmosDBMongoDBCollectionGet": { + "$ref": "./examples/CosmosDBMongoDBCollectionGet.json" + } + }, + "description": "Gets the MongoDB collection under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The MongoDB collection property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoDBCollectionGetResults" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_CreateUpdateMongoDBCollection", + "x-ms-examples": { + "CosmosDBMongoDBCollectionCreateUpdate": { + "$ref": "./examples/CosmosDBMongoDBCollectionCreateUpdate.json" + }, + "CosmosDBMongoDBCollectionRestore": { + "$ref": "./examples/CosmosDBMongoDBCollectionRestore.json" + } + }, + "description": "Create or update an Azure Cosmos DB MongoDB Collection", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateMongoDBCollectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MongoDBCollectionCreateUpdateParameters" + }, + "description": "The parameters to provide for the current MongoDB Collection." + } + ], + "responses": { + "202": { + "description": "The MongoDB Collection create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB Collection create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/MongoDBCollectionGetResults" + } + } + } + }, + "delete": { + "operationId": "MongoDBResources_DeleteMongoDBCollection", + "x-ms-examples": { + "CosmosDBMongoDBCollectionDelete": { + "$ref": "./examples/CosmosDBMongoDBCollectionDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB MongoDB Collection.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB collection delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The MongoDB collection delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/partitionMerge": { + "post": { + "operationId": "MongoDBResources_MongoDBDatabasePartitionMerge", + "x-ms-examples": { + "CosmosDBMongoDBDatabasePartitionMerge": { + "$ref": "./examples/CosmosDBMongoDBDatabasePartitionMerge.json" + } + }, + "description": "Merges the partitions of a MongoDB database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "mergeParameters", + "required": true, + "description": "The parameters for the merge operation.", + "schema": { + "$ref": "#/definitions/MergeParameters" + } + } + ], + "responses": { + "202": { + "description": "The MongoDB database merge operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB database merge operation was completed successfully.", + "schema": { + "$ref": "#/definitions/PhysicalPartitionStorageInfoCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/partitionMerge": { + "post": { + "operationId": "MongoDBResources_ListMongoDBCollectionPartitionMerge", + "x-ms-examples": { + "CosmosDBMongoDBCollectionPartitionMerge": { + "$ref": "./examples/CosmosDBMongoDBCollectionPartitionMerge.json" + } + }, + "description": "Merges the partitions of a MongoDB Collection", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "mergeParameters", + "required": true, + "description": "The parameters for the merge operation.", + "schema": { + "$ref": "#/definitions/MergeParameters" + } + } + ], + "responses": { + "202": { + "description": "The MongoDB collection merge operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB collection merge operation was completed successfully.", + "schema": { + "$ref": "#/definitions/PhysicalPartitionStorageInfoCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default": { + "get": { + "operationId": "MongoDBResources_GetMongoDBCollectionThroughput", + "x-ms-examples": { + "CosmosDBMongoDBCollectionThroughputGet": { + "$ref": "./examples/CosmosDBMongoDBCollectionThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the MongoDB collection was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_UpdateMongoDBCollectionThroughput", + "x-ms-examples": { + "CosmosDBMongoDBCollectionThroughputUpdate": { + "$ref": "./examples/CosmosDBMongoDBCollectionThroughputUpdate.json" + } + }, + "description": "Update the RUs per second of an Azure Cosmos DB MongoDB collection", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current MongoDB collection." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the MongoDB collection update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the MongoDB collection update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBCollectionToAutoscale", + "x-ms-examples": { + "CosmosDBMongoDBCollectionMigrateToAutoscale": { + "$ref": "./examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB collection migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB collection migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBCollectionToManualThroughput", + "x-ms-examples": { + "CosmosDBMongoDBCollectionMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB collection migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB collection migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables": { + "get": { + "operationId": "TableResources_ListTables", + "x-ms-examples": { + "CosmosDBTableList": { + "$ref": "./examples/CosmosDBTableList.json" + } + }, + "description": "Lists the Tables under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Table properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/TableListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}": { + "get": { + "operationId": "TableResources_GetTable", + "x-ms-examples": { + "CosmosDBTableGet": { + "$ref": "./examples/CosmosDBTableGet.json" + } + }, + "description": "Gets the Tables under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Table property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/TableGetResults" + } + } + } + }, + "put": { + "operationId": "TableResources_CreateUpdateTable", + "x-ms-examples": { + "CosmosDBTableReplace": { + "$ref": "./examples/CosmosDBTableCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Table", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateTableParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TableCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Table." + } + ], + "responses": { + "202": { + "description": "The Table create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Table create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/TableGetResults" + } + } + } + }, + "delete": { + "operationId": "TableResources_DeleteTable", + "x-ms-examples": { + "CosmosDBTableDelete": { + "$ref": "./examples/CosmosDBTableDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Table.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Table delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The Table delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default": { + "get": { + "operationId": "TableResources_GetTableThroughput", + "x-ms-examples": { + "CosmosDBTableThroughputGet": { + "$ref": "./examples/CosmosDBTableThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Table was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "TableResources_UpdateTableThroughput", + "x-ms-examples": { + "CosmosDBTableThroughputUpdate": { + "$ref": "./examples/CosmosDBTableThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Table", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The parameters to provide for the RUs per second of the current Table." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Table update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the Table update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "TableResources_MigrateTableToAutoscale", + "x-ms-examples": { + "CosmosDBTableMigrateToAutoscale": { + "$ref": "./examples/CosmosDBTableMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Table from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Table migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "TableResources_MigrateTableToManualThroughput", + "x-ms-examples": { + "CosmosDBTableMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBTableMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Table from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Table migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces": { + "get": { + "operationId": "CassandraResources_ListCassandraKeyspaces", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceList": { + "$ref": "./examples/CosmosDBCassandraKeyspaceList.json" + } + }, + "description": "Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra keyspace properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraKeyspaceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}": { + "get": { + "operationId": "CassandraResources_GetCassandraKeyspace", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceGet": { + "$ref": "./examples/CosmosDBCassandraKeyspaceGet.json" + } + }, + "description": "Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra keyspace property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraKeyspaceGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_CreateUpdateCassandraKeyspace", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceCreateUpdate": { + "$ref": "./examples/CosmosDBCassandraKeyspaceCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Cassandra keyspace", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateCassandraKeyspaceParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CassandraKeyspaceCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Cassandra keyspace." + } + ], + "responses": { + "202": { + "description": "The Cassandra keyspace create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra keyspace create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/CassandraKeyspaceGetResults" + } + } + } + }, + "delete": { + "operationId": "CassandraResources_DeleteCassandraKeyspace", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceDelete": { + "$ref": "./examples/CosmosDBCassandraKeyspaceDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Cassandra keyspace.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra keyspace delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The Cassandra keyspace delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default": { + "get": { + "operationId": "CassandraResources_GetCassandraKeyspaceThroughput", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceThroughputGet": { + "$ref": "./examples/CosmosDBCassandraKeyspaceThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Cassandra Keyspace was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_UpdateCassandraKeyspaceThroughput", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceThroughputUpdate": { + "$ref": "./examples/CosmosDBCassandraKeyspaceThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Cassandra Keyspace", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Cassandra Keyspace." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Cassandra Keyspace update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the Cassandra Keyspace update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "CassandraResources_MigrateCassandraKeyspaceToAutoscale", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceMigrateToAutoscale": { + "$ref": "./examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra Keyspace migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra Keyspace migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "CassandraResources_MigrateCassandraKeyspaceToManualThroughput", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra Keyspace migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra Keyspace migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables": { + "get": { + "operationId": "CassandraResources_ListCassandraTables", + "x-ms-examples": { + "CosmosDBCassandraTableList": { + "$ref": "./examples/CosmosDBCassandraTableList.json" + } + }, + "description": "Lists the Cassandra table under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra table properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraTableListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}": { + "get": { + "operationId": "CassandraResources_GetCassandraTable", + "x-ms-examples": { + "CosmosDBCassandraTableGet": { + "$ref": "./examples/CosmosDBCassandraTableGet.json" + } + }, + "description": "Gets the Cassandra table under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra table property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraTableGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_CreateUpdateCassandraTable", + "x-ms-examples": { + "CosmosDBCassandraTableCreateUpdate": { + "$ref": "./examples/CosmosDBCassandraTableCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Cassandra Table", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateCassandraTableParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CassandraTableCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Cassandra Table." + } + ], + "responses": { + "202": { + "description": "The Cassandra Table create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra Table create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/CassandraTableGetResults" + } + } + } + }, + "delete": { + "operationId": "CassandraResources_DeleteCassandraTable", + "x-ms-examples": { + "CosmosDBCassandraTableDelete": { + "$ref": "./examples/CosmosDBCassandraTableDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Cassandra table.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra table delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The Cassandra table delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default": { + "get": { + "operationId": "CassandraResources_GetCassandraTableThroughput", + "x-ms-examples": { + "CosmosDBCassandraTableThroughputGet": { + "$ref": "./examples/CosmosDBCassandraTableThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Cassandra table was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_UpdateCassandraTableThroughput", + "x-ms-examples": { + "CosmosDBCassandraTableThroughputUpdate": { + "$ref": "./examples/CosmosDBCassandraTableThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Cassandra table", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Cassandra table." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Cassandra table update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the Cassandra table update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "CassandraResources_MigrateCassandraTableToAutoscale", + "x-ms-examples": { + "CosmosDBCassandraTableMigrateToAutoscale": { + "$ref": "./examples/CosmosDBCassandraTableMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra table migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "CassandraResources_MigrateCassandraTableToManualThroughput", + "x-ms-examples": { + "CosmosDBCassandraTableMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBCassandraTableMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra table migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases": { + "get": { + "operationId": "GremlinResources_ListGremlinDatabases", + "x-ms-examples": { + "CosmosDBGremlinDatabaseList": { + "$ref": "./examples/CosmosDBGremlinDatabaseList.json" + } + }, + "description": "Lists the Gremlin databases under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Gremlin database properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/GremlinDatabaseListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}": { + "get": { + "operationId": "GremlinResources_GetGremlinDatabase", + "x-ms-examples": { + "CosmosDBGremlinDatabaseGet": { + "$ref": "./examples/CosmosDBGremlinDatabaseGet.json" + } + }, + "description": "Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Gremlin database property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/GremlinDatabaseGetResults" + } + } + } + }, + "put": { + "operationId": "GremlinResources_CreateUpdateGremlinDatabase", + "x-ms-examples": { + "CosmosDBGremlinDatabaseCreateUpdate": { + "$ref": "./examples/CosmosDBGremlinDatabaseCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Gremlin database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateGremlinDatabaseParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GremlinDatabaseCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Gremlin database." + } + ], + "responses": { + "202": { + "description": "The Gremlin database create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Gremlin database create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/GremlinDatabaseGetResults" + } + } + } + }, + "delete": { + "operationId": "GremlinResources_DeleteGremlinDatabase", + "x-ms-examples": { + "CosmosDBGremlinDatabaseDelete": { + "$ref": "./examples/CosmosDBGremlinDatabaseDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Gremlin database.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin database delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The Gremlin database delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default": { + "get": { + "operationId": "GremlinResources_GetGremlinDatabaseThroughput", + "x-ms-examples": { + "CosmosDBGremlinDatabaseThroughputGet": { + "$ref": "./examples/CosmosDBGremlinDatabaseThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Gremlin database was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "GremlinResources_UpdateGremlinDatabaseThroughput", + "x-ms-examples": { + "CosmosDBGremlinDatabaseThroughputUpdate": { + "$ref": "./examples/CosmosDBGremlinDatabaseThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Gremlin database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Gremlin database." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Gremlin database update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the Gremlin database update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "GremlinResources_MigrateGremlinDatabaseToAutoscale", + "x-ms-examples": { + "CosmosDBGremlinDatabaseMigrateToAutoscale": { + "$ref": "./examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin database migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Gremlin database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "GremlinResources_MigrateGremlinDatabaseToManualThroughput", + "x-ms-examples": { + "CosmosDBGremlinDatabaseMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin database migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Gremlin database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs": { + "get": { + "operationId": "GremlinResources_ListGremlinGraphs", + "x-ms-examples": { + "CosmosDBGremlinGraphList": { + "$ref": "./examples/CosmosDBGremlinGraphList.json" + } + }, + "description": "Lists the Gremlin graph under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Gremlin graph properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/GremlinGraphListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}": { + "get": { + "operationId": "GremlinResources_GetGremlinGraph", + "x-ms-examples": { + "CosmosDBGremlinGraphGet": { + "$ref": "./examples/CosmosDBGremlinGraphGet.json" + } + }, + "description": "Gets the Gremlin graph under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Gremlin graph property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/GremlinGraphGetResults" + } + } + } + }, + "put": { + "operationId": "GremlinResources_CreateUpdateGremlinGraph", + "x-ms-examples": { + "CosmosDBGremlinGraphCreateUpdate": { + "$ref": "./examples/CosmosDBGremlinGraphCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Gremlin graph", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateGremlinGraphParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GremlinGraphCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Gremlin graph." + } + ], + "responses": { + "202": { + "description": "The Gremlin graph create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Gremlin graph create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/GremlinGraphGetResults" + } + } + } + }, + "delete": { + "operationId": "GremlinResources_DeleteGremlinGraph", + "x-ms-examples": { + "CosmosDBGremlinGraphDelete": { + "$ref": "./examples/CosmosDBGremlinGraphDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Gremlin graph.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin graph delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The Gremlin graph delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default": { + "get": { + "operationId": "GremlinResources_GetGremlinGraphThroughput", + "x-ms-examples": { + "CosmosDBGremlinGraphThroughputGet": { + "$ref": "./examples/CosmosDBGremlinGraphThroughputGet.json" + } + }, + "description": "Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Gremlin graph was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "GremlinResources_UpdateGremlinGraphThroughput", + "x-ms-examples": { + "CosmosDBGremlinGraphThroughputUpdate": { + "$ref": "./examples/CosmosDBGremlinGraphThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Gremlin graph", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Gremlin graph." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Gremlin graph update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the Gremlin graph update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "GremlinResources_MigrateGremlinGraphToAutoscale", + "x-ms-examples": { + "CosmosDBGremlinGraphMigrateToAutoscale": { + "$ref": "./examples/CosmosDBGremlinGraphMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin graph migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Gremlin graph migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "GremlinResources_MigrateGremlinGraphToManualThroughput", + "x-ms-examples": { + "CosmosDBGremlinGraphMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBGremlinGraphMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin graph migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Gremlin graph migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations": { + "get": { + "operationId": "Locations_List", + "x-ms-examples": { + "CosmosDBLocationList": { + "$ref": "./examples/CosmosDBLocationList.json" + } + }, + "description": "List Cosmos DB locations and their properties", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}": { + "get": { + "operationId": "Locations_Get", + "x-ms-examples": { + "CosmosDBLocationGet": { + "$ref": "./examples/CosmosDBLocationGet.json" + } + }, + "description": "Get the properties of an existing Cosmos DB location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "The Cosmos DB location properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/LocationGetResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views": { + "get": { + "operationId": "CassandraResources_ListCassandraViews", + "x-ms-examples": { + "CosmosDBCassandraViewList": { + "$ref": "./examples/CosmosDBCassandraViewList.json" + } + }, + "description": "Lists the Cassandra materialized views under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra view properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraViewListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}": { + "get": { + "operationId": "CassandraResources_GetCassandraView", + "x-ms-examples": { + "CosmosDBCassandraViewGet": { + "$ref": "./examples/CosmosDBCassandraViewGet.json" + } + }, + "description": "Gets the Cassandra view under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra view property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraViewGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_CreateUpdateCassandraView", + "x-ms-examples": { + "CosmosDBCassandraViewCreateUpdate": { + "$ref": "./examples/CosmosDBCassandraViewCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Cassandra View", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateCassandraViewParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CassandraViewCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Cassandra View." + } + ], + "responses": { + "202": { + "description": "The Cassandra View create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra View create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/CassandraViewGetResults" + } + } + } + }, + "delete": { + "operationId": "CassandraResources_DeleteCassandraView", + "x-ms-examples": { + "CosmosDBCassandraViewDelete": { + "$ref": "./examples/CosmosDBCassandraViewDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Cassandra view.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra view delete operation completed successfully." + }, + "202": { + "description": "The Cassandra view delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The Cassandra view delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default": { + "get": { + "operationId": "CassandraResources_GetCassandraViewThroughput", + "x-ms-examples": { + "CosmosDBCassandraViewThroughputGet": { + "$ref": "./examples/CosmosDBCassandraViewThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Cassandra view under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Cassandra view was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_UpdateCassandraViewThroughput", + "x-ms-examples": { + "CosmosDBCassandraViewThroughputUpdate": { + "$ref": "./examples/CosmosDBCassandraViewThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Cassandra view", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Cassandra view." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Cassandra view update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the Cassandra view update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "CassandraResources_MigrateCassandraViewToAutoscale", + "x-ms-examples": { + "CosmosDBCassandraViewMigrateToAutoscale": { + "$ref": "./examples/CosmosDBCassandraViewMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra view from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra view migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra view migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "CassandraResources_MigrateCassandraViewToManualThroughput", + "x-ms-examples": { + "CosmosDBCassandraViewMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBCassandraViewMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra view from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra view migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra view migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ClientEncryptionKeysListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ClientEncryptionKeyGetResults" + }, + "description": "List of client encryption keys and their properties." + } + }, + "description": "The List operation response, that contains the client encryption keys and their properties." + }, + "DatabaseAccountsListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseAccountGetResults" + }, + "description": "List of database account and their properties." + } + }, + "description": "The List operation response, that contains the database accounts and their properties." + }, + "GraphResourcesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/GraphResourceGetResults" + }, + "description": "List of Graph resource and their properties." + } + }, + "description": "The List operation response, that contains the Graph resource and their properties." + }, + "SqlDatabaseListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlDatabaseGetResults" + }, + "description": "List of SQL databases and their properties." + } + }, + "description": "The List operation response, that contains the SQL databases and their properties." + }, + "SqlContainerListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlContainerGetResults" + }, + "description": "List of containers and their properties." + } + }, + "description": "The List operation response, that contains the containers and their properties." + }, + "SqlStoredProcedureListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlStoredProcedureGetResults" + }, + "description": "List of storedProcedures and their properties." + } + }, + "description": "The List operation response, that contains the storedProcedures and their properties." + }, + "SqlUserDefinedFunctionListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlUserDefinedFunctionGetResults" + }, + "description": "List of userDefinedFunctions and their properties." + } + }, + "description": "The List operation response, that contains the userDefinedFunctions and their properties." + }, + "SqlTriggerListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlTriggerGetResults" + }, + "description": "List of triggers and their properties." + } + }, + "description": "The List operation response, that contains the triggers and their properties." + }, + "MongoDBDatabaseListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MongoDBDatabaseGetResults" + }, + "description": "List of MongoDB databases and their properties." + } + }, + "description": "The List operation response, that contains the MongoDB databases and their properties." + }, + "MongoDBCollectionListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MongoDBCollectionGetResults" + }, + "description": "List of MongoDB collections and their properties." + } + }, + "description": "The List operation response, that contains the MongoDB collections and their properties." + }, + "TableListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TableGetResults" + }, + "description": "List of Table and their properties." + } + }, + "description": "The List operation response, that contains the Table and their properties." + }, + "CassandraKeyspaceListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CassandraKeyspaceGetResults" + }, + "description": "List of Cassandra keyspaces and their properties." + } + }, + "description": "The List operation response, that contains the Cassandra keyspaces and their properties." + }, + "CassandraTableListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CassandraTableGetResults" + }, + "description": "List of Cassandra tables and their properties." + } + }, + "description": "The List operation response, that contains the Cassandra tables and their properties." + }, + "GremlinDatabaseListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/GremlinDatabaseGetResults" + }, + "description": "List of Gremlin databases and their properties." + } + }, + "description": "The List operation response, that contains the Gremlin databases and their properties." + }, + "GremlinGraphListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/GremlinGraphGetResults" + }, + "description": "List of graphs and their properties." + } + }, + "description": "The List operation response, that contains the graphs and their properties." + }, + "CassandraViewListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CassandraViewGetResults" + }, + "description": "List of Cassandra views and their properties." + } + }, + "description": "The List operation response, that contains the Cassandra views and their properties." + }, + "ErrorResponse": { + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + }, + "description": "Error Response." + }, + "CloudError": { + "x-ms-external": true, + "description": "An error response from the service.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "FailoverPolicies": { + "properties": { + "failoverPolicies": { + "type": "array", + "description": "List of failover policies.", + "items": { + "$ref": "#/definitions/FailoverPolicy" + } + } + }, + "required": [ + "failoverPolicies" + ], + "description": "The list of new failover policies for the failover priority change." + }, + "FailoverPolicy": { + "type": "object", + "description": "The failover policy for a given region of a database account.", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>." + }, + "locationName": { + "type": "string", + "description": "The name of the region in which the database account exists." + }, + "failoverPriority": { + "type": "integer", + "minimum": 0, + "format": "int32", + "description": "The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists." + } + } + }, + "RegionForOnlineOffline": { + "properties": { + "region": { + "type": "string", + "description": "Cosmos DB region, with spaces between words and each word capitalized." + } + }, + "required": [ + "region" + ], + "description": "Cosmos DB region to online or offline." + }, + "Location": { + "description": "A region in which the Azure Cosmos DB database account is deployed.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The unique identifier of the region within the database account. Example: <accountName>-<locationName>." + }, + "locationName": { + "type": "string", + "description": "The name of the region." + }, + "documentEndpoint": { + "type": "string", + "readOnly": true, + "description": "The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "failoverPriority": { + "description": "The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.", + "format": "int32", + "type": "integer", + "minimum": 0 + }, + "isZoneRedundant": { + "type": "boolean", + "description": "Flag to indicate whether or not this region is an AvailabilityZone region" + } + } + }, + "ARMResourceProperties": { + "type": "object", + "description": "The core properties of ARM resources.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "$ref": "#/definitions/Tags" + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentity" + } + }, + "x-ms-azure-resource": true + }, + "ARMProxyResource": { + "type": "object", + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the database account." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the database account." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + }, + "x-ms-azure-resource": true + }, + "ClientEncryptionKeyCreateUpdateParameters": { + "description": "Parameters to create and update ClientEncryptionKey.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update ClientEncryptionKey.", + "$ref": "#/definitions/ClientEncryptionKeyCreateUpdateProperties" + } + }, + "required": [ + "properties" + ] + }, + "ClientEncryptionKeyCreateUpdateProperties": { + "description": "Properties to create and update ClientEncryptionKey.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a ClientEncryptionKey", + "$ref": "#/definitions/ClientEncryptionKeyResource" + } + }, + "required": [ + "resource" + ] + }, + "ClientEncryptionKeyGetResults": { + "description": "Client Encryption Key.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of a ClientEncryptionKey", + "$ref": "#/definitions/ClientEncryptionKeyGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMProxyResource" + } + ] + }, + "ClientEncryptionKeyGetProperties": { + "description": "The properties of a ClientEncryptionKey resource", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/ClientEncryptionKeyResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "DatabaseAccountGetResults": { + "description": "An Azure Cosmos DB database account.", + "type": "object", + "properties": { + "kind": { + "description": "Indicates the type of database account. This can only be set at database account creation.", + "type": "string", + "default": "GlobalDocumentDB", + "enum": [ + "GlobalDocumentDB", + "MongoDB", + "Parse" + ], + "x-ms-enum": { + "name": "DatabaseAccountKind", + "modelAsString": true + } + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseAccountGetProperties" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "ExtendedResourceProperties": { + "description": "The system generated resource properties associated with SQL databases, SQL containers, Gremlin databases and Gremlin graphs.", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "description": "A system generated property. A unique identifier.", + "readOnly": true + }, + "_ts": { + "type": "number", + "description": "A system generated property that denotes the last updated timestamp of the resource.", + "readOnly": true + }, + "_etag": { + "type": "string", + "description": "A system generated property representing the resource etag required for optimistic concurrency control.", + "readOnly": true + } + } + }, + "ThroughputSettingsGetResults": { + "description": "An Azure Cosmos DB resource throughput.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB resource throughput", + "$ref": "#/definitions/ThroughputSettingsGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "ThroughputSettingsGetProperties": { + "description": "The properties of an Azure Cosmos DB resource throughput", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/ThroughputSettingsResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "SqlDatabaseGetResults": { + "description": "An Azure Cosmos DB SQL database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB SQL database", + "$ref": "#/definitions/SqlDatabaseGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "GraphResourceGetProperties": { + "description": "The properties of an Azure Cosmos DB SQL database", + "type": "object", + "properties": { + "resource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GraphResource" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "GraphResourceGetResults": { + "description": "An Azure Cosmos DB Graph resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Graph resource.", + "$ref": "#/definitions/GraphResourceGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlDatabaseGetProperties": { + "description": "The properties of an Azure Cosmos DB SQL database", + "type": "object", + "properties": { + "resource": { + "properties": { + "_colls": { + "type": "string", + "description": "A system generated property that specified the addressable path of the collections resource." + }, + "_users": { + "type": "string", + "description": "A system generated property that specifies the addressable path of the users resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SqlDatabaseResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "SqlContainerGetResults": { + "description": "An Azure Cosmos DB container.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB container", + "$ref": "#/definitions/SqlContainerGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlContainerGetProperties": { + "description": "The properties of an Azure Cosmos DB container", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/SqlContainerResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "SqlStoredProcedureGetResults": { + "description": "An Azure Cosmos DB storedProcedure.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB storedProcedure", + "$ref": "#/definitions/SqlStoredProcedureGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlStoredProcedureGetProperties": { + "description": "The properties of an Azure Cosmos DB StoredProcedure", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/SqlStoredProcedureResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "SqlUserDefinedFunctionGetResults": { + "description": "An Azure Cosmos DB userDefinedFunction.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB userDefinedFunction", + "$ref": "#/definitions/SqlUserDefinedFunctionGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlUserDefinedFunctionGetProperties": { + "description": "The properties of an Azure Cosmos DB userDefinedFunction", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/SqlUserDefinedFunctionResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "SqlTriggerGetResults": { + "description": "An Azure Cosmos DB trigger.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB trigger", + "$ref": "#/definitions/SqlTriggerGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlTriggerGetProperties": { + "description": "The properties of an Azure Cosmos DB trigger", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/SqlTriggerResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "MongoDBDatabaseGetResults": { + "description": "An Azure Cosmos DB MongoDB database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB MongoDB database", + "$ref": "#/definitions/MongoDBDatabaseGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "MongoDBDatabaseGetProperties": { + "description": "The properties of an Azure Cosmos DB MongoDB database", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/MongoDBDatabaseResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "MongoDBCollectionGetResults": { + "description": "An Azure Cosmos DB MongoDB collection.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB MongoDB collection", + "$ref": "#/definitions/MongoDBCollectionGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "MongoDBCollectionGetProperties": { + "description": "The properties of an Azure Cosmos DB MongoDB collection", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/MongoDBCollectionResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "TableGetResults": { + "description": "An Azure Cosmos DB Table.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Table", + "$ref": "#/definitions/TableGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "TableGetProperties": { + "description": "The properties of an Azure Cosmos Table", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/TableResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "CassandraKeyspaceGetResults": { + "description": "An Azure Cosmos DB Cassandra keyspace.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Cassandra keyspace", + "$ref": "#/definitions/CassandraKeyspaceGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "CassandraKeyspaceGetProperties": { + "description": "The properties of an Azure Cosmos DB Cassandra keyspace", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/CassandraKeyspaceResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "CassandraTableGetResults": { + "description": "An Azure Cosmos DB Cassandra table.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Cassandra table", + "$ref": "#/definitions/CassandraTableGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "CassandraTableGetProperties": { + "description": "The properties of an Azure Cosmos DB Cassandra table", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/CassandraTableResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "GremlinDatabaseGetResults": { + "description": "An Azure Cosmos DB Gremlin database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB SQL database", + "$ref": "#/definitions/GremlinDatabaseGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "GremlinDatabaseGetProperties": { + "description": "The properties of an Azure Cosmos DB SQL database", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/GremlinDatabaseResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "GremlinGraphGetResults": { + "description": "An Azure Cosmos DB Gremlin graph.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Gremlin graph", + "$ref": "#/definitions/GremlinGraphGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "GremlinGraphGetProperties": { + "description": "The properties of an Azure Cosmos DB Gremlin graph", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/GremlinGraphResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "CassandraViewGetResults": { + "description": "An Azure Cosmos DB Cassandra view.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Cassandra view", + "$ref": "#/definitions/CassandraViewGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "CassandraViewGetProperties": { + "description": "The properties of an Azure Cosmos DB Cassandra view", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/CassandraViewResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "ConsistencyPolicy": { + "type": "object", + "description": "The consistency policy for the Cosmos DB database account.", + "properties": { + "defaultConsistencyLevel": { + "description": "The default consistency level and configuration settings of the Cosmos DB account.", + "type": "string", + "enum": [ + "Eventual", + "Session", + "BoundedStaleness", + "Strong", + "ConsistentPrefix" + ], + "x-ms-enum": { + "name": "DefaultConsistencyLevel", + "modelAsString": false + } + }, + "maxStalenessPrefix": { + "description": "When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.", + "type": "integer", + "minimum": 1, + "maximum": 2147483647, + "format": "int64" + }, + "maxIntervalInSeconds": { + "description": "When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.", + "type": "integer", + "minimum": 5, + "maximum": 86400, + "format": "int32" + } + }, + "required": [ + "defaultConsistencyLevel" + ] + }, + "CorsPolicy": { + "type": "object", + "description": "The CORS policy for the Cosmos DB database account.", + "properties": { + "allowedOrigins": { + "description": "The origin domains that are permitted to make a request against the service via CORS.", + "type": "string" + }, + "allowedMethods": { + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request.", + "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": 1, + "maximum": 2147483647, + "format": "int64" + } + }, + "required": [ + "allowedOrigins" + ] + }, + "DatabaseAccountGetProperties": { + "description": "Properties for the database account.", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "documentEndpoint": { + "description": "The connection endpoint for the Cosmos DB database account.", + "type": "string", + "readOnly": true + }, + "databaseAccountOfferType": { + "description": "The offer type for the Cosmos DB database account. Default value: Standard.", + "readOnly": true, + "$ref": "#/definitions/DatabaseAccountOfferType" + }, + "ipRules": { + "description": "List of IpRules.", + "$ref": "#/definitions/IPRules" + }, + "isVirtualNetworkFilterEnabled": { + "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules.", + "type": "boolean" + }, + "enableAutomaticFailover": { + "description": "Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.", + "type": "boolean" + }, + "consistencyPolicy": { + "description": "The consistency policy for the Cosmos DB database account.", + "$ref": "#/definitions/ConsistencyPolicy" + }, + "capabilities": { + "type": "array", + "description": "List of Cosmos DB capabilities for the account", + "items": { + "$ref": "#/definitions/Capability" + } + }, + "writeLocations": { + "type": "array", + "readOnly": true, + "description": "An array that contains the write location for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "readLocations": { + "type": "array", + "readOnly": true, + "description": "An array that contains of the read locations enabled for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "locations": { + "type": "array", + "readOnly": true, + "description": "An array that contains all of the locations enabled for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "failoverPolicies": { + "type": "array", + "readOnly": true, + "description": "An array that contains the regions ordered by their failover priorities.", + "items": { + "$ref": "#/definitions/FailoverPolicy" + } + }, + "virtualNetworkRules": { + "type": "array", + "description": "List of Virtual Network ACL rules configured for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "description": "List of Private Endpoint Connections configured for the Cosmos DB account.", + "items": { + "$ref": "./privateEndpointConnection.json#/definitions/PrivateEndpointConnection" + } + }, + "enableMultipleWriteLocations": { + "description": "Enables the account to write in multiple locations", + "type": "boolean" + }, + "enableCassandraConnector": { + "description": "Enables the cassandra connector on the Cosmos DB C* account", + "type": "boolean" + }, + "connectorOffer": { + "description": "The cassandra connector offer type for the Cosmos DB database C* account.", + "$ref": "#/definitions/ConnectorOffer" + }, + "disableKeyBasedMetadataWriteAccess": { + "description": "Disable write operations on metadata resources (databases, containers, throughput) via account keys", + "type": "boolean" + }, + "keyVaultKeyUri": { + "description": "The URI of the key vault", + "type": "string" + }, + "defaultIdentity": { + "description": "The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be \"FirstPartyIdentity\", \"SystemAssignedIdentity\" and more.", + "type": "string" + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed", + "$ref": "#/definitions/PublicNetworkAccess" + }, + "enableFreeTier": { + "description": "Flag to indicate whether Free Tier is enabled.", + "type": "boolean" + }, + "apiProperties": { + "description": "API specific properties.", + "type": "object", + "$ref": "#/definitions/ApiProperties" + }, + "enableAnalyticalStorage": { + "description": "Flag to indicate whether to enable storage analytics.", + "type": "boolean" + }, + "analyticalStorageConfiguration": { + "description": "Analytical storage specific properties.", + "type": "object", + "$ref": "#/definitions/AnalyticalStorageConfiguration" + }, + "instanceId": { + "description": "A unique identifier assigned to the database account", + "type": "string", + "readOnly": true + }, + "createMode": { + "description": "Enum to indicate the mode of account creation.", + "type": "string", + "default": "Default", + "$ref": "#/definitions/CreateMode" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore.", + "type": "object", + "$ref": "#/definitions/RestoreParameters" + }, + "backupPolicy": { + "description": "The object representing the policy for taking backups on an account.", + "type": "object", + "$ref": "#/definitions/BackupPolicy" + }, + "cors": { + "type": "array", + "description": "The CORS policy for the Cosmos DB database account.", + "items": { + "$ref": "#/definitions/CorsPolicy" + } + }, + "networkAclBypass": { + "description": "Indicates what services are allowed to bypass firewall checks.", + "$ref": "#/definitions/NetworkAclBypass" + }, + "networkAclBypassResourceIds": { + "type": "array", + "description": "An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.", + "items": { + "type": "string", + "format": "arm-id" + } + }, + "diagnosticLogSettings": { + "type": "object", + "description": "The Object representing the different Diagnostic log settings for the Cosmos DB Account.", + "$ref": "#/definitions/DiagnosticLogSettings" + }, + "disableLocalAuth": { + "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.", + "type": "boolean" + }, + "capacity": { + "description": "The object that represents all properties related to capacity enforcement on an account.", + "type": "object", + "$ref": "#/definitions/Capacity" + }, + "enableMaterializedViews": { + "description": "Flag to indicate whether to enable MaterializedViews on the Cosmos DB account", + "type": "boolean" + }, + "keysMetadata": { + "description": "The object that represents the metadata for the Account Keys of the Cosmos DB account.", + "type": "object", + "$ref": "#/definitions/DatabaseAccountKeysMetadata" + }, + "enablePartitionMerge": { + "description": "Flag to indicate enabling/disabling of Partition Merge feature on the account", + "type": "boolean" + }, + "enableBurstCapacity": { + "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "type": "boolean" + }, + "minimalTlsVersion": { + "description": "Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2.", + "type": "string", + "$ref": "#/definitions/MinimalTlsVersion" + }, + "customerManagedKeyStatus": { + "description": "Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.", + "type": "string" + }, + "enablePriorityBasedExecution": { + "description": "Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account", + "type": "boolean" + }, + "defaultPriorityLevel": { + "description": "Enum to indicate default Priority Level of request for Priority Based Execution.", + "type": "string", + "$ref": "#/definitions/DefaultPriorityLevel" + }, + "enablePerRegionPerPartitionAutoscale": { + "description": "Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account", + "type": "boolean" + } + } + }, + "DatabaseAccountCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB database accounts.", + "type": "object", + "properties": { + "consistencyPolicy": { + "description": "The consistency policy for the Cosmos DB account.", + "$ref": "#/definitions/ConsistencyPolicy" + }, + "locations": { + "type": "array", + "description": "An array that contains the georeplication locations enabled for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "databaseAccountOfferType": { + "description": "The offer type for the database", + "$ref": "#/definitions/DatabaseAccountOfferType" + }, + "ipRules": { + "description": "List of IpRules.", + "$ref": "#/definitions/IPRules" + }, + "isVirtualNetworkFilterEnabled": { + "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules.", + "type": "boolean" + }, + "enableAutomaticFailover": { + "description": "Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.", + "type": "boolean" + }, + "capabilities": { + "type": "array", + "description": "List of Cosmos DB capabilities for the account", + "items": { + "$ref": "#/definitions/Capability" + } + }, + "virtualNetworkRules": { + "type": "array", + "description": "List of Virtual Network ACL rules configured for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "enableMultipleWriteLocations": { + "description": "Enables the account to write in multiple locations", + "type": "boolean" + }, + "enableCassandraConnector": { + "description": "Enables the cassandra connector on the Cosmos DB C* account", + "type": "boolean" + }, + "connectorOffer": { + "description": "The cassandra connector offer type for the Cosmos DB database C* account.", + "$ref": "#/definitions/ConnectorOffer" + }, + "disableKeyBasedMetadataWriteAccess": { + "description": "Disable write operations on metadata resources (databases, containers, throughput) via account keys", + "type": "boolean" + }, + "keyVaultKeyUri": { + "description": "The URI of the key vault", + "type": "string" + }, + "defaultIdentity": { + "description": "The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be \"FirstPartyIdentity\", \"SystemAssignedIdentity\" and more.", + "type": "string" + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed", + "$ref": "#/definitions/PublicNetworkAccess" + }, + "enableFreeTier": { + "description": "Flag to indicate whether Free Tier is enabled.", + "type": "boolean" + }, + "apiProperties": { + "description": "API specific properties. Currently, supported only for MongoDB API.", + "type": "object", + "$ref": "#/definitions/ApiProperties" + }, + "enableAnalyticalStorage": { + "description": "Flag to indicate whether to enable storage analytics.", + "type": "boolean" + }, + "analyticalStorageConfiguration": { + "description": "Analytical storage specific properties.", + "type": "object", + "$ref": "#/definitions/AnalyticalStorageConfiguration" + }, + "createMode": { + "description": "Enum to indicate the mode of account creation.", + "type": "string", + "default": "Default", + "$ref": "#/definitions/CreateMode" + }, + "backupPolicy": { + "description": "The object representing the policy for taking backups on an account.", + "type": "object", + "$ref": "#/definitions/BackupPolicy" + }, + "cors": { + "type": "array", + "description": "The CORS policy for the Cosmos DB database account.", + "items": { + "$ref": "#/definitions/CorsPolicy" + } + }, + "networkAclBypass": { + "description": "Indicates what services are allowed to bypass firewall checks.", + "$ref": "#/definitions/NetworkAclBypass" + }, + "networkAclBypassResourceIds": { + "type": "array", + "description": "An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.", + "items": { + "type": "string" + } + }, + "diagnosticLogSettings": { + "type": "object", + "description": "The Object representing the different Diagnostic log settings for the Cosmos DB Account.", + "$ref": "#/definitions/DiagnosticLogSettings" + }, + "disableLocalAuth": { + "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.", + "type": "boolean" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore.", + "type": "object", + "$ref": "#/definitions/RestoreParameters" + }, + "capacity": { + "description": "The object that represents all properties related to capacity enforcement on an account.", + "type": "object", + "$ref": "#/definitions/Capacity" + }, + "enableMaterializedViews": { + "description": "Flag to indicate whether to enable MaterializedViews on the Cosmos DB account", + "type": "boolean" + }, + "keysMetadata": { + "description": "This property is ignored during the update/create operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account.", + "type": "object", + "$ref": "#/definitions/DatabaseAccountKeysMetadata" + }, + "enablePartitionMerge": { + "description": "Flag to indicate enabling/disabling of Partition Merge feature on the account", + "type": "boolean" + }, + "enableBurstCapacity": { + "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "type": "boolean" + }, + "minimalTlsVersion": { + "description": "Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2.", + "type": "string", + "$ref": "#/definitions/MinimalTlsVersion" + }, + "customerManagedKeyStatus": { + "description": "Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.", + "type": "string" + }, + "enablePriorityBasedExecution": { + "description": "Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account", + "type": "boolean" + }, + "defaultPriorityLevel": { + "description": "Enum to indicate default Priority Level of request for Priority Based Execution.", + "type": "string", + "$ref": "#/definitions/DefaultPriorityLevel" + }, + "enablePerRegionPerPartitionAutoscale": { + "description": "Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account", + "type": "boolean" + } + }, + "required": [ + "locations", + "databaseAccountOfferType" + ] + }, + "DatabaseAccountCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB database accounts.", + "type": "object", + "properties": { + "kind": { + "description": "Indicates the type of database account. This can only be set at database account creation.", + "type": "string", + "default": "GlobalDocumentDB", + "enum": [ + "GlobalDocumentDB", + "MongoDB", + "Parse" + ], + "x-ms-enum": { + "name": "DatabaseAccountKind", + "modelAsString": true + } + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseAccountCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "DatabaseAccountUpdateProperties": { + "description": "Properties to update Azure Cosmos DB database accounts.", + "type": "object", + "properties": { + "consistencyPolicy": { + "description": "The consistency policy for the Cosmos DB account.", + "$ref": "#/definitions/ConsistencyPolicy" + }, + "locations": { + "type": "array", + "description": "An array that contains the georeplication locations enabled for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "ipRules": { + "description": "List of IpRules.", + "$ref": "#/definitions/IPRules" + }, + "isVirtualNetworkFilterEnabled": { + "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules.", + "type": "boolean" + }, + "enableAutomaticFailover": { + "description": "Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.", + "type": "boolean" + }, + "capabilities": { + "type": "array", + "description": "List of Cosmos DB capabilities for the account", + "items": { + "$ref": "#/definitions/Capability" + } + }, + "virtualNetworkRules": { + "type": "array", + "description": "List of Virtual Network ACL rules configured for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "enableMultipleWriteLocations": { + "description": "Enables the account to write in multiple locations", + "type": "boolean" + }, + "enableCassandraConnector": { + "description": "Enables the cassandra connector on the Cosmos DB C* account", + "type": "boolean" + }, + "connectorOffer": { + "description": "The cassandra connector offer type for the Cosmos DB database C* account.", + "$ref": "#/definitions/ConnectorOffer" + }, + "disableKeyBasedMetadataWriteAccess": { + "description": "Disable write operations on metadata resources (databases, containers, throughput) via account keys", + "type": "boolean" + }, + "keyVaultKeyUri": { + "description": "The URI of the key vault", + "type": "string" + }, + "defaultIdentity": { + "description": "The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be \"FirstPartyIdentity\", \"SystemAssignedIdentity\" and more.", + "type": "string" + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed", + "$ref": "#/definitions/PublicNetworkAccess" + }, + "enableFreeTier": { + "description": "Flag to indicate whether Free Tier is enabled.", + "type": "boolean" + }, + "apiProperties": { + "description": "API specific properties. Currently, supported only for MongoDB API.", + "type": "object", + "$ref": "#/definitions/ApiProperties" + }, + "enableAnalyticalStorage": { + "description": "Flag to indicate whether to enable storage analytics.", + "type": "boolean" + }, + "analyticalStorageConfiguration": { + "description": "Analytical storage specific properties.", + "type": "object", + "$ref": "#/definitions/AnalyticalStorageConfiguration" + }, + "backupPolicy": { + "description": "The object representing the policy for taking backups on an account.", + "type": "object", + "$ref": "#/definitions/BackupPolicy" + }, + "cors": { + "type": "array", + "description": "The CORS policy for the Cosmos DB database account.", + "items": { + "$ref": "#/definitions/CorsPolicy" + } + }, + "networkAclBypass": { + "description": "Indicates what services are allowed to bypass firewall checks.", + "$ref": "#/definitions/NetworkAclBypass" + }, + "networkAclBypassResourceIds": { + "type": "array", + "description": "An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.", + "items": { + "type": "string" + } + }, + "diagnosticLogSettings": { + "type": "object", + "description": "The Object representing the different Diagnostic log settings for the Cosmos DB Account.", + "$ref": "#/definitions/DiagnosticLogSettings" + }, + "disableLocalAuth": { + "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.", + "type": "boolean" + }, + "capacity": { + "description": "The object that represents all properties related to capacity enforcement on an account.", + "type": "object", + "$ref": "#/definitions/Capacity" + }, + "enableMaterializedViews": { + "description": "Flag to indicate whether to enable MaterializedViews on the Cosmos DB account", + "type": "boolean" + }, + "keysMetadata": { + "description": "This property is ignored during the update operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account.", + "type": "object", + "$ref": "#/definitions/DatabaseAccountKeysMetadata" + }, + "enablePartitionMerge": { + "description": "Flag to indicate enabling/disabling of Partition Merge feature on the account", + "type": "boolean" + }, + "enableBurstCapacity": { + "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "type": "boolean" + }, + "minimalTlsVersion": { + "description": "Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2.", + "type": "string", + "$ref": "#/definitions/MinimalTlsVersion" + }, + "customerManagedKeyStatus": { + "description": "Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.", + "type": "string" + }, + "enablePriorityBasedExecution": { + "description": "Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account", + "type": "boolean" + }, + "defaultPriorityLevel": { + "description": "Enum to indicate default Priority Level of request for Priority Based Execution.", + "type": "string", + "$ref": "#/definitions/DefaultPriorityLevel" + }, + "enablePerRegionPerPartitionAutoscale": { + "description": "Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account", + "type": "boolean" + } + } + }, + "DatabaseAccountUpdateParameters": { + "description": "Parameters for patching Azure Cosmos DB database account properties.", + "type": "object", + "properties": { + "tags": { + "$ref": "#/definitions/Tags" + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseAccountUpdateProperties" + } + } + }, + "DatabaseAccountListReadOnlyKeysResult": { + "description": "The read-only access keys for the given database account.", + "properties": { + "primaryReadonlyMasterKey": { + "readOnly": true, + "type": "string", + "description": "Base 64 encoded value of the primary read-only key." + }, + "secondaryReadonlyMasterKey": { + "readOnly": true, + "type": "string", + "description": "Base 64 encoded value of the secondary read-only key." + } + } + }, + "DatabaseAccountListKeysResult": { + "description": "The access keys for the given database account.", + "properties": { + "primaryMasterKey": { + "readOnly": true, + "type": "string", + "description": "Base 64 encoded value of the primary read-write key." + }, + "secondaryMasterKey": { + "readOnly": true, + "type": "string", + "description": "Base 64 encoded value of the secondary read-write key." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DatabaseAccountListReadOnlyKeysResult" + } + ] + }, + "DatabaseAccountConnectionString": { + "description": "Connection string for the Cosmos DB account", + "properties": { + "connectionString": { + "readOnly": true, + "type": "string", + "description": "Value of the connection string" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description of the connection string" + }, + "keyKind": { + "readOnly": true, + "type": "string", + "description": "Kind of the connection string key", + "enum": [ + "Primary", + "Secondary", + "PrimaryReadonly", + "SecondaryReadonly" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the connection string", + "enum": [ + "Sql", + "Table", + "MongoDB", + "Cassandra", + "CassandraConnectorMetadata", + "Gremlin", + "SqlDedicatedGateway", + "GremlinV2", + "Undefined" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + } + } + }, + "DatabaseAccountListConnectionStringsResult": { + "description": "The connection strings for the given database account.", + "properties": { + "connectionStrings": { + "type": "array", + "description": "An array that contains the connection strings for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/DatabaseAccountConnectionString" + } + } + } + }, + "DatabaseAccountRegenerateKeyParameters": { + "type": "object", + "description": "Parameters to regenerate the keys within the database account.", + "properties": { + "keyKind": { + "type": "string", + "description": "The access key to regenerate.", + "enum": [ + "primary", + "secondary", + "primaryReadonly", + "secondaryReadonly" + ], + "x-ms-enum": { + "name": "KeyKind", + "modelAsString": true + } + } + }, + "required": [ + "keyKind" + ] + }, + "DatabaseAccountOfferType": { + "description": "The offer type for the Cosmos DB database account.", + "type": "string", + "enum": [ + "Standard" + ], + "x-ms-enum": { + "name": "DatabaseAccountOfferType", + "modelAsString": false + } + }, + "ThroughputSettingsUpdateParameters": { + "description": "Parameters to update Cosmos DB resource throughput.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to update Azure Cosmos DB resource throughput.", + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "ThroughputSettingsUpdateProperties": { + "description": "Properties to update Azure Cosmos DB resource throughput.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a resource throughput", + "$ref": "#/definitions/ThroughputSettingsResource" + } + }, + "required": [ + "resource" + ] + }, + "GraphResourceCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Graph resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Graph resource.", + "$ref": "#/definitions/GraphResourceCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "GraphResourceCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Graph resource.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Graph resource", + "$ref": "#/definitions/GraphResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "GraphResource": { + "type": "object", + "description": "Cosmos DB Graph resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Graph" + } + }, + "required": [ + "id" + ] + }, + "SqlDatabaseCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB SQL database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB SQL database.", + "$ref": "#/definitions/SqlDatabaseCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlDatabaseCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB SQL database.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a SQL database", + "$ref": "#/definitions/SqlDatabaseResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "SqlContainerCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB container.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB container.", + "$ref": "#/definitions/SqlContainerCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlContainerCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB container.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a container", + "$ref": "#/definitions/SqlContainerResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "SqlStoredProcedureCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB storedProcedure.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB storedProcedure.", + "$ref": "#/definitions/SqlStoredProcedureCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlStoredProcedureCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB storedProcedure.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a storedProcedure", + "$ref": "#/definitions/SqlStoredProcedureResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "SqlUserDefinedFunctionCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB userDefinedFunction.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB userDefinedFunction.", + "$ref": "#/definitions/SqlUserDefinedFunctionCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlUserDefinedFunctionCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB userDefinedFunction.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a userDefinedFunction", + "$ref": "#/definitions/SqlUserDefinedFunctionResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "SqlTriggerCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB trigger.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB trigger.", + "$ref": "#/definitions/SqlTriggerCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlTriggerCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB trigger.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a trigger", + "$ref": "#/definitions/SqlTriggerResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "MongoDBDatabaseCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB MongoDB database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB MongoDB database.", + "$ref": "#/definitions/MongoDBDatabaseCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "MongoDBDatabaseCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB MongoDB database.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a MongoDB database", + "$ref": "#/definitions/MongoDBDatabaseResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "MongoDBCollectionCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB MongoDB collection.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB MongoDB collection.", + "$ref": "#/definitions/MongoDBCollectionCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "MongoDBCollectionCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB MongoDB collection.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a MongoDB collection", + "$ref": "#/definitions/MongoDBCollectionResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "TableCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Table.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Table.", + "$ref": "#/definitions/TableCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "TableCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Table.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Table", + "$ref": "#/definitions/TableResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "CassandraKeyspaceCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Cassandra keyspace.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace.", + "$ref": "#/definitions/CassandraKeyspaceCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "CassandraKeyspaceCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Cassandra keyspace", + "$ref": "#/definitions/CassandraKeyspaceResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "CassandraTableCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Cassandra table.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Cassandra table.", + "$ref": "#/definitions/CassandraTableCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "CassandraTableCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Cassandra table.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Cassandra table", + "$ref": "#/definitions/CassandraTableResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "GremlinDatabaseCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Gremlin database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Gremlin database.", + "$ref": "#/definitions/GremlinDatabaseCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "GremlinDatabaseCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Gremlin database.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Gremlin database", + "$ref": "#/definitions/GremlinDatabaseResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "GremlinGraphCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Gremlin graph.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Gremlin graph.", + "$ref": "#/definitions/GremlinGraphCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "GremlinGraphCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Gremlin graph.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Gremlin graph", + "$ref": "#/definitions/GremlinGraphResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "CassandraViewCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Cassandra view.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Cassandra view.", + "$ref": "#/definitions/CassandraViewCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "CassandraViewCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Cassandra view.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Cassandra view", + "$ref": "#/definitions/CassandraViewResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "ThroughputSettingsResource": { + "type": "object", + "description": "Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.", + "properties": { + "throughput": { + "type": "integer", + "description": "Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both." + }, + "autoscaleSettings": { + "description": "Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.", + "$ref": "#/definitions/AutoscaleSettingsResource" + }, + "minimumThroughput": { + "type": "string", + "description": "The minimum throughput of the resource", + "readOnly": true + }, + "offerReplacePending": { + "type": "string", + "description": "The throughput replace is pending", + "readOnly": true + }, + "instantMaximumThroughput": { + "type": "string", + "description": "The offer throughput value to instantly scale up without triggering splits", + "readOnly": true + }, + "softAllowedMaximumThroughput": { + "type": "string", + "description": "The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified", + "readOnly": true + } + } + }, + "AutoscaleSettingsResource": { + "type": "object", + "description": "Cosmos DB provisioned throughput settings object", + "properties": { + "maxThroughput": { + "type": "integer", + "description": "Represents maximum throughput container can scale up to." + }, + "autoUpgradePolicy": { + "description": "Cosmos DB resource auto-upgrade policy", + "$ref": "#/definitions/AutoUpgradePolicyResource" + }, + "targetMaxThroughput": { + "type": "integer", + "description": "Represents target maximum throughput container can scale up to once offer is no longer in pending state.", + "readOnly": true + } + }, + "required": [ + "maxThroughput" + ] + }, + "AutoUpgradePolicyResource": { + "type": "object", + "description": "Cosmos DB resource auto-upgrade policy", + "properties": { + "throughputPolicy": { + "description": "Represents throughput policy which service must adhere to for auto-upgrade", + "$ref": "#/definitions/ThroughputPolicyResource" + } + } + }, + "ThroughputPolicyResource": { + "type": "object", + "description": "Cosmos DB resource throughput policy", + "properties": { + "isEnabled": { + "type": "boolean", + "description": "Determines whether the ThroughputPolicy is active or not" + }, + "incrementPercent": { + "type": "integer", + "description": "Represents the percentage by which throughput can increase every time throughput policy kicks in." + } + } + }, + "OptionsResource": { + "type": "object", + "description": "Cosmos DB options resource object", + "readOnly": true, + "properties": { + "throughput": { + "type": "integer", + "description": "Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details." + }, + "autoscaleSettings": { + "type": "object", + "$ref": "#/definitions/AutoscaleSettings", + "description": "Specifies the Autoscale settings." + } + } + }, + "RedistributeThroughputParameters": { + "description": "Cosmos DB redistribute throughput parameters object", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to redistribute throughput parameters object", + "$ref": "#/definitions/RedistributeThroughputProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "RedistributeThroughputProperties": { + "description": "Properties to redistribute throughput for Azure Cosmos DB resource.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a resource throughput", + "$ref": "#/definitions/RedistributeThroughputPropertiesResource" + } + }, + "required": [ + "resource" + ] + }, + "RedistributeThroughputPropertiesResource": { + "type": "object", + "description": "Resource to redistribute throughput for Azure Cosmos DB resource", + "properties": { + "throughputPolicy": { + "description": "ThroughputPolicy to apply for throughput redistribution", + "type": "string", + "enum": [ + "none", + "equal", + "custom" + ], + "x-ms-enum": { + "name": "ThroughputPolicyType", + "modelAsString": true + } + }, + "targetPhysicalPartitionThroughputInfo": { + "type": "array", + "description": "Array of PhysicalPartitionThroughputInfoResource objects.", + "items": { + "$ref": "#/definitions/PhysicalPartitionThroughputInfoResource" + } + }, + "sourcePhysicalPartitionThroughputInfo": { + "type": "array", + "description": "Array of PhysicalPartitionThroughputInfoResource objects.", + "items": { + "$ref": "#/definitions/PhysicalPartitionThroughputInfoResource" + } + } + }, + "required": [ + "throughputPolicy", + "targetPhysicalPartitionThroughputInfo", + "sourcePhysicalPartitionThroughputInfo" + ] + }, + "RetrieveThroughputParameters": { + "description": "Cosmos DB retrieve throughput parameters object", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to retrieve throughput parameters object", + "$ref": "#/definitions/RetrieveThroughputProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "RetrieveThroughputProperties": { + "description": "Properties to retrieve throughput for Azure Cosmos DB resource.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a resource throughput", + "$ref": "#/definitions/RetrieveThroughputPropertiesResource" + } + }, + "required": [ + "resource" + ] + }, + "RetrieveThroughputPropertiesResource": { + "type": "object", + "description": "Resource to retrieve throughput information for Cosmos DB resource", + "properties": { + "physicalPartitionIds": { + "type": "array", + "description": "Array of PhysicalPartitionId objects.", + "items": { + "$ref": "#/definitions/PhysicalPartitionId" + } + } + }, + "required": [ + "physicalPartitionIds" + ] + }, + "PhysicalPartitionId": { + "type": "object", + "description": "PhysicalPartitionId object", + "properties": { + "id": { + "type": "string", + "description": "Id of a physical partition" + } + }, + "required": [ + "id" + ] + }, + "PhysicalPartitionThroughputInfoResult": { + "description": "An Azure Cosmos DB PhysicalPartitionThroughputInfoResult object.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoResult object", + "$ref": "#/definitions/PhysicalPartitionThroughputInfoResultProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "PhysicalPartitionThroughputInfoResultProperties": { + "description": "The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoResult object", + "type": "object", + "properties": { + "resource": { + "description": "properties of physical partition throughput info", + "allOf": [ + { + "$ref": "#/definitions/PhysicalPartitionThroughputInfoProperties" + } + ] + } + } + }, + "PhysicalPartitionThroughputInfoProperties": { + "description": "The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoProperties object", + "type": "object", + "properties": { + "physicalPartitionThroughputInfo": { + "type": "array", + "description": "Array of physical partition throughput info objects", + "items": { + "$ref": "#/definitions/PhysicalPartitionThroughputInfoResource" + } + } + } + }, + "PhysicalPartitionThroughputInfoResource": { + "type": "object", + "description": "PhysicalPartitionThroughputInfo object", + "properties": { + "id": { + "type": "string", + "description": "Id of a physical partition" + }, + "throughput": { + "type": "number", + "format": "double", + "description": "Throughput of a physical partition" + } + }, + "required": [ + "id" + ] + }, + "ClientEncryptionKeyResource": { + "type": "object", + "description": "Cosmos DB client encryption key resource object.", + "properties": { + "id": { + "type": "string", + "description": "Name of the ClientEncryptionKey" + }, + "encryptionAlgorithm": { + "type": "string", + "description": "Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data." + }, + "wrappedDataEncryptionKey": { + "type": "string", + "format": "byte", + "description": "Wrapped (encrypted) form of the key represented as a byte array." + }, + "keyWrapMetadata": { + "description": "Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.", + "$ref": "#/definitions/KeyWrapMetadata" + } + } + }, + "KeyWrapMetadata": { + "type": "object", + "description": "Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key.", + "properties": { + "name": { + "type": "string", + "description": "The name of associated KeyEncryptionKey (aka CustomerManagedKey)." + }, + "type": { + "type": "string", + "description": "ProviderName of KeyStoreProvider." + }, + "value": { + "type": "string", + "description": "Reference / link to the KeyEncryptionKey." + }, + "algorithm": { + "type": "string", + "description": "Algorithm used in wrapping and unwrapping of the data encryption key." + } + } + }, + "SqlDatabaseResource": { + "type": "object", + "description": "Cosmos DB SQL database resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL database" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + } + }, + "required": [ + "id" + ] + }, + "SqlContainerResource": { + "type": "object", + "description": "Cosmos DB SQL container resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL container" + }, + "indexingPolicy": { + "$ref": "#/definitions/IndexingPolicy", + "description": "The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container" + }, + "partitionKey": { + "$ref": "#/definitions/ContainerPartitionKey", + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions" + }, + "defaultTtl": { + "type": "integer", + "description": "Default time to live" + }, + "uniqueKeyPolicy": { + "$ref": "#/definitions/UniqueKeyPolicy", + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service." + }, + "conflictResolutionPolicy": { + "$ref": "#/definitions/ConflictResolutionPolicy", + "description": "The conflict resolution policy for the container." + }, + "clientEncryptionPolicy": { + "$ref": "#/definitions/ClientEncryptionPolicy", + "description": "The client encryption policy for the container." + }, + "analyticalStorageTtl": { + "type": "integer", + "format": "int64", + "description": "Analytical TTL." + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + }, + "materializedViewDefinition": { + "$ref": "#/definitions/MaterializedViewDefinition", + "description": "The configuration for defining Materialized Views. This must be specified only for creating a Materialized View container." + }, + "computedProperties": { + "description": "List of computed properties", + "type": "array", + "items": { + "$ref": "#/definitions/ComputedProperty" + } + } + }, + "required": [ + "id" + ] + }, + "IndexingPolicy": { + "type": "object", + "description": "Cosmos DB indexing policy", + "properties": { + "automatic": { + "type": "boolean", + "description": "Indicates if the indexing policy is automatic" + }, + "indexingMode": { + "description": "Indicates the indexing mode.", + "type": "string", + "default": "consistent", + "enum": [ + "consistent", + "lazy", + "none" + ], + "x-ms-enum": { + "name": "IndexingMode", + "modelAsString": true + } + }, + "includedPaths": { + "description": "List of paths to include in the indexing", + "type": "array", + "items": { + "$ref": "#/definitions/IncludedPath" + } + }, + "excludedPaths": { + "description": "List of paths to exclude from indexing", + "type": "array", + "items": { + "$ref": "#/definitions/ExcludedPath" + } + }, + "compositeIndexes": { + "description": "List of composite path list", + "type": "array", + "items": { + "$ref": "#/definitions/CompositePathList" + } + }, + "spatialIndexes": { + "description": "List of spatial specifics", + "type": "array", + "items": { + "$ref": "#/definitions/SpatialSpec" + } + } + } + }, + "ExcludedPath": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + } + } + }, + "IncludedPath": { + "type": "object", + "description": "The paths that are included in indexing", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + }, + "indexes": { + "description": "List of indexes for this path", + "type": "array", + "items": { + "$ref": "#/definitions/Indexes" + } + } + } + }, + "Indexes": { + "type": "object", + "description": "The indexes for the path.", + "properties": { + "dataType": { + "description": "The datatype for which the indexing behavior is applied to.", + "type": "string", + "default": "String", + "enum": [ + "String", + "Number", + "Point", + "Polygon", + "LineString", + "MultiPolygon" + ], + "x-ms-enum": { + "name": "DataType", + "modelAsString": true + } + }, + "precision": { + "description": "The precision of the index. -1 is maximum precision.", + "type": "integer" + }, + "kind": { + "description": "Indicates the type of index.", + "type": "string", + "default": "Hash", + "enum": [ + "Hash", + "Range", + "Spatial" + ], + "x-ms-enum": { + "name": "IndexKind", + "modelAsString": true + } + } + } + }, + "CompositePathList": { + "description": "List of composite path", + "type": "array", + "items": { + "$ref": "#/definitions/CompositePath" + } + }, + "CompositePath": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + }, + "order": { + "description": "Sort order for composite paths.", + "type": "string", + "enum": [ + "ascending", + "descending" + ], + "x-ms-enum": { + "name": "CompositePathSortOrder", + "modelAsString": true + } + } + } + }, + "SpatialSpec": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + }, + "types": { + "description": "List of path's spatial type", + "type": "array", + "items": { + "$ref": "#/definitions/SpatialType" + } + } + } + }, + "SpatialType": { + "description": "Indicates the spatial type of index.", + "type": "string", + "enum": [ + "Point", + "LineString", + "Polygon", + "MultiPolygon" + ], + "x-ms-enum": { + "name": "SpatialType", + "modelAsString": true + } + }, + "ComputedProperty": { + "type": "object", + "description": "The definition of a computed property", + "properties": { + "name": { + "type": "string", + "description": "The name of a computed property, for example - \"cp_lowerName\"" + }, + "query": { + "type": "string", + "description": "The query that evaluates the value for computed property, for example - \"SELECT VALUE LOWER(c.name) FROM c\"" + } + } + }, + "ContainerPartitionKey": { + "type": "object", + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions", + "properties": { + "paths": { + "description": "List of paths using which data within the container can be partitioned", + "type": "array", + "items": { + "$ref": "#/definitions/Path" + } + }, + "kind": { + "description": "Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create", + "type": "string", + "default": "Hash", + "enum": [ + "Hash", + "Range", + "MultiHash" + ], + "x-ms-enum": { + "name": "PartitionKind", + "modelAsString": true + } + }, + "version": { + "description": "Indicates the version of the partition key definition", + "type": "integer", + "minimum": 1, + "maximum": 2, + "format": "int32" + }, + "systemKey": { + "description": "Indicates if the container is using a system generated partition key", + "type": "boolean", + "readOnly": true + } + } + }, + "Path": { + "type": "string", + "description": "A path. These typically start with root (/path)" + }, + "UniqueKeyPolicy": { + "type": "object", + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.", + "properties": { + "uniqueKeys": { + "description": "List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.", + "type": "array", + "items": { + "$ref": "#/definitions/UniqueKey" + } + } + } + }, + "UniqueKey": { + "type": "object", + "description": "The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.", + "properties": { + "paths": { + "description": "List of paths must be unique for each document in the Azure Cosmos DB service", + "type": "array", + "items": { + "$ref": "#/definitions/Path" + } + } + } + }, + "ConflictResolutionPolicy": { + "type": "object", + "description": "The conflict resolution policy for the container.", + "properties": { + "mode": { + "description": "Indicates the conflict resolution mode.", + "type": "string", + "default": "LastWriterWins", + "enum": [ + "LastWriterWins", + "Custom" + ], + "x-ms-enum": { + "name": "ConflictResolutionMode", + "modelAsString": true + } + }, + "conflictResolutionPath": { + "type": "string", + "description": "The conflict resolution path in the case of LastWriterWins mode." + }, + "conflictResolutionProcedure": { + "type": "string", + "description": "The procedure to resolve conflicts in the case of custom mode." + } + } + }, + "ClientEncryptionPolicy": { + "type": "object", + "description": "Cosmos DB client encryption policy.", + "properties": { + "includedPaths": { + "description": "Paths of the item that need encryption along with path-specific settings.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientEncryptionIncludedPath" + }, + "x-ms-identifiers": [] + }, + "policyFormatVersion": { + "description": "Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption. ", + "type": "integer", + "minimum": 1, + "maximum": 2, + "format": "int32" + } + }, + "required": [ + "includedPaths", + "policyFormatVersion" + ] + }, + "ClientEncryptionIncludedPath": { + "type": "object", + "description": ".", + "properties": { + "path": { + "description": "Path that needs to be encrypted.", + "type": "string" + }, + "clientEncryptionKeyId": { + "description": "The identifier of the Client Encryption Key to be used to encrypt the path.", + "type": "string" + }, + "encryptionType": { + "description": "The type of encryption to be performed. Eg - Deterministic, Randomized.", + "type": "string" + }, + "encryptionAlgorithm": { + "description": "The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.", + "type": "string" + } + }, + "required": [ + "path", + "clientEncryptionKeyId", + "encryptionType", + "encryptionAlgorithm" + ] + }, + "MaterializedViewDefinition": { + "type": "object", + "description": "Materialized View definition for the container.", + "properties": { + "sourceCollectionRid": { + "description": "An unique identifier for the source collection. This is a system generated property.", + "type": "string", + "readOnly": true + }, + "sourceCollectionId": { + "description": "The name of the source container on which the Materialized View will be created.", + "type": "string" + }, + "definition": { + "description": "The definition should be an SQL query which would be used to fetch data from the source container to populate into the Materialized View container.", + "type": "string" + } + }, + "required": [ + "sourceCollectionId", + "definition" + ] + }, + "SqlStoredProcedureResource": { + "type": "object", + "description": "Cosmos DB SQL storedProcedure resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL storedProcedure" + }, + "body": { + "type": "string", + "description": "Body of the Stored Procedure" + } + }, + "required": [ + "id" + ] + }, + "SqlUserDefinedFunctionResource": { + "type": "object", + "description": "Cosmos DB SQL userDefinedFunction resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL userDefinedFunction" + }, + "body": { + "type": "string", + "description": "Body of the User Defined Function" + } + }, + "required": [ + "id" + ] + }, + "SqlTriggerResource": { + "type": "object", + "description": "Cosmos DB SQL trigger resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL trigger" + }, + "body": { + "type": "string", + "description": "Body of the Trigger" + }, + "triggerType": { + "type": "string", + "enum": [ + "Pre", + "Post" + ], + "description": "Type of the Trigger", + "x-ms-enum": { + "name": "triggerType", + "modelAsString": true + } + }, + "triggerOperation": { + "type": "string", + "enum": [ + "All", + "Create", + "Update", + "Delete", + "Replace" + ], + "description": "The operation the trigger is associated with", + "x-ms-enum": { + "name": "triggerOperation", + "modelAsString": true + } + } + }, + "required": [ + "id" + ] + }, + "MongoDBDatabaseResource": { + "type": "object", + "description": "Cosmos DB MongoDB database resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB MongoDB database" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + } + }, + "required": [ + "id" + ] + }, + "MongoDBCollectionResource": { + "type": "object", + "description": "Cosmos DB MongoDB collection resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB MongoDB collection" + }, + "shardKey": { + "description": "A key-value pair of shard keys to be applied for the request.", + "$ref": "#/definitions/ShardKeys" + }, + "indexes": { + "description": "List of index keys", + "type": "array", + "items": { + "$ref": "#/definitions/MongoIndex" + } + }, + "analyticalStorageTtl": { + "type": "integer", + "description": "Analytical TTL." + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + } + }, + "required": [ + "id" + ] + }, + "ShardKeys": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The shard key and partition kind pair, only support \"Hash\" partition kind" + }, + "MongoIndex": { + "type": "object", + "description": "Cosmos DB MongoDB collection index key", + "properties": { + "key": { + "description": "Cosmos DB MongoDB collection index keys", + "$ref": "#/definitions/MongoIndexKeys" + }, + "options": { + "description": "Cosmos DB MongoDB collection index key options", + "$ref": "#/definitions/MongoIndexOptions" + } + } + }, + "MongoIndexKeys": { + "type": "object", + "description": "Cosmos DB MongoDB collection resource object", + "properties": { + "keys": { + "description": "List of keys for each MongoDB collection in the Azure Cosmos DB service", + "type": "array", + "items": { + "$ref": "#/definitions/Key" + } + } + } + }, + "Key": { + "type": "string", + "description": "A Key." + }, + "MongoIndexOptions": { + "type": "object", + "description": "Cosmos DB MongoDB collection index options", + "properties": { + "expireAfterSeconds": { + "description": "Expire after seconds", + "type": "integer" + }, + "unique": { + "description": "Is unique or not", + "type": "boolean" + } + } + }, + "TableResource": { + "type": "object", + "description": "Cosmos DB table resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB table" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + } + }, + "required": [ + "id" + ] + }, + "CassandraKeyspaceResource": { + "type": "object", + "description": "Cosmos DB Cassandra keyspace resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra keyspace" + } + }, + "required": [ + "id" + ] + }, + "CassandraTableResource": { + "type": "object", + "description": "Cosmos DB Cassandra table resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table" + }, + "defaultTtl": { + "type": "integer", + "description": "Time to live of the Cosmos DB Cassandra table" + }, + "schema": { + "description": "Schema of the Cosmos DB Cassandra table", + "$ref": "#/definitions/CassandraSchema" + }, + "analyticalStorageTtl": { + "type": "integer", + "description": "Analytical TTL." + } + }, + "required": [ + "id" + ] + }, + "CassandraSchema": { + "type": "object", + "description": "Cosmos DB Cassandra table schema", + "properties": { + "columns": { + "type": "array", + "items": { + "$ref": "#/definitions/Column" + }, + "description": "List of Cassandra table columns." + }, + "partitionKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/CassandraPartitionKey" + }, + "description": "List of partition key." + }, + "clusterKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ClusterKey" + }, + "description": "List of cluster key." + } + } + }, + "Column": { + "type": "object", + "description": "Cosmos DB Cassandra table column", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table column" + }, + "type": { + "type": "string", + "description": "Type of the Cosmos DB Cassandra table column" + } + } + }, + "CassandraPartitionKey": { + "type": "object", + "description": "Cosmos DB Cassandra table partition key", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table partition key" + } + } + }, + "ClusterKey": { + "type": "object", + "description": "Cosmos DB Cassandra table cluster key", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table cluster key" + }, + "orderBy": { + "type": "string", + "description": "Order of the Cosmos DB Cassandra table cluster key, only support \"Asc\" and \"Desc\"" + } + } + }, + "GremlinDatabaseResource": { + "type": "object", + "description": "Cosmos DB Gremlin database resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Gremlin database" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + } + }, + "required": [ + "id" + ] + }, + "GremlinGraphResource": { + "type": "object", + "description": "Cosmos DB Gremlin graph resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Gremlin graph" + }, + "indexingPolicy": { + "$ref": "#/definitions/IndexingPolicy", + "description": "The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph" + }, + "partitionKey": { + "$ref": "#/definitions/ContainerPartitionKey", + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions" + }, + "defaultTtl": { + "type": "integer", + "description": "Default time to live" + }, + "uniqueKeyPolicy": { + "$ref": "#/definitions/UniqueKeyPolicy", + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service." + }, + "conflictResolutionPolicy": { + "$ref": "#/definitions/ConflictResolutionPolicy", + "description": "The conflict resolution policy for the graph." + }, + "analyticalStorageTtl": { + "type": "integer", + "format": "int64", + "description": "Analytical TTL." + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + } + }, + "required": [ + "id" + ] + }, + "CassandraViewResource": { + "type": "object", + "description": "Cosmos DB Cassandra view resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra view" + }, + "viewDefinition": { + "type": "string", + "description": "View Definition of the Cosmos DB Cassandra view" + } + }, + "required": [ + "id", + "viewDefinition" + ] + }, + "CreateUpdateOptions": { + "type": "object", + "properties": { + "throughput": { + "type": "integer", + "description": "Request Units per second. For example, \"throughput\": 10000." + }, + "autoscaleSettings": { + "$ref": "#/definitions/AutoscaleSettings", + "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both." + } + }, + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + }, + "AutoscaleSettings": { + "type": "object", + "properties": { + "maxThroughput": { + "type": "integer", + "description": "Represents maximum throughput, the resource can scale up to." + } + } + }, + "Capability": { + "type": "object", + "description": "Cosmos DB capability object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB capability. For example, \"name\": \"EnableCassandra\". Current values also include \"EnableTable\" and \"EnableGremlin\"." + } + } + }, + "Capacity": { + "type": "object", + "description": "The object that represents all properties related to capacity enforcement on an account.", + "properties": { + "totalThroughputLimit": { + "type": "integer", + "minimum": -1, + "format": "int32", + "description": "The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput." + } + } + }, + "Tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "ManagedServiceIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with resource. 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 resource." + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed." + }, + "IPRules": { + "type": "array", + "description": "Array of IpAddressOrRange objects.", + "items": { + "$ref": "#/definitions/IpAddressOrRange" + } + }, + "IpAddressOrRange": { + "type": "object", + "description": "IpAddressOrRange object", + "properties": { + "ipAddressOrRange": { + "type": "string", + "description": "A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”." + } + } + }, + "VirtualNetworkRule": { + "type": "object", + "description": "Virtual Network ACL Rule object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}." + }, + "ignoreMissingVNetServiceEndpoint": { + "type": "boolean", + "description": "Create firewall rule before the virtual network has vnet service endpoint enabled." + } + } + }, + "NetworkAclBypass": { + "description": "Indicates what services are allowed to bypass firewall checks.", + "type": "string", + "enum": [ + "None", + "AzureServices" + ], + "x-ms-enum": { + "name": "NetworkAclBypass", + "modelAsString": false + } + }, + "AccountKeyMetadata": { + "description": "The metadata related to an access key for a given database account.", + "type": "object", + "properties": { + "generationTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18." + } + } + }, + "DatabaseAccountKeysMetadata": { + "description": "The metadata related to each access key for the given Cosmos DB database account.", + "type": "object", + "readOnly": true, + "properties": { + "primaryMasterKey": { + "readOnly": true, + "description": "The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.", + "$ref": "#/definitions/AccountKeyMetadata" + }, + "secondaryMasterKey": { + "readOnly": true, + "description": "The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.", + "$ref": "#/definitions/AccountKeyMetadata" + }, + "primaryReadonlyMasterKey": { + "readOnly": true, + "description": "The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.", + "$ref": "#/definitions/AccountKeyMetadata" + }, + "secondaryReadonlyMasterKey": { + "readOnly": true, + "description": "The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.", + "$ref": "#/definitions/AccountKeyMetadata" + } + } + }, + "DiagnosticLogSettings": { + "type": "object", + "description": "Indicates what diagnostic log settings are to be enabled.", + "properties": { + "enableFullTextQuery": { + "description": "Describe the level of detail with which queries are to be logged.", + "type": "string", + "enum": [ + "None", + "True", + "False" + ], + "x-ms-enum": { + "name": "EnableFullTextQuery", + "modelAsString": false + } + } + } + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "Provider": { + "description": "Service provider: Microsoft.ResourceProvider", + "type": "string" + }, + "Resource": { + "description": "Resource on which the operation is performed: Profile, endpoint, etc.", + "type": "string" + }, + "Operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "Description": { + "description": "Description of operation", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of operations supported by the Resource Provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "UsagesResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of usages for the database. A usage is a point in time metric" + } + }, + "description": "The response to a list usage request." + }, + "Usage": { + "properties": { + "unit": { + "description": "The unit of the metric.", + "$ref": "#/definitions/UnitType" + }, + "name": { + "$ref": "#/definitions/MetricName", + "readOnly": true, + "description": "The name information for the metric." + }, + "quotaPeriod": { + "type": "string", + "readOnly": true, + "description": "The quota period used to summarize the usage values." + }, + "limit": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Maximum value for this metric" + }, + "currentValue": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Current value for this metric" + } + }, + "description": "The usage data for a usage request." + }, + "PartitionUsagesResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PartitionUsage" + }, + "description": "The list of partition-level usages for the database. A usage is a point in time metric" + } + }, + "description": "The response to a list partition level usage request." + }, + "PartitionUsage": { + "allOf": [ + { + "$ref": "#/definitions/Usage" + } + ], + "properties": { + "partitionId": { + "readOnly": true, + "type": "string", + "description": "The partition id (GUID identifier) of the usages." + }, + "partitionKeyRangeId": { + "readOnly": true, + "type": "string", + "description": "The partition key range id (integer identifier) of the usages." + } + }, + "description": "The partition level usage data for a usage request." + }, + "MetricDefinitionsListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MetricDefinition" + }, + "description": "The list of metric definitions for the account." + } + }, + "description": "The response to a list metric definitions request." + }, + "MetricDefinition": { + "properties": { + "metricAvailabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MetricAvailability" + }, + "description": "The list of metric availabilities for the account." + }, + "primaryAggregationType": { + "readOnly": true, + "type": "string", + "description": "The primary aggregation type of the metric.", + "enum": [ + "None", + "Average", + "Total", + "Minimum", + "Maximum", + "Last" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PrimaryAggregationType" + } + }, + "unit": { + "description": "The unit of the metric.", + "$ref": "#/definitions/UnitType" + }, + "resourceUri": { + "readOnly": true, + "type": "string", + "description": "The resource uri of the database." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + } + }, + "description": "The definition of a metric." + }, + "MetricAvailability": { + "properties": { + "timeGrain": { + "readOnly": true, + "type": "string", + "description": "The time grain to be used to summarize the metric values." + }, + "retention": { + "readOnly": true, + "type": "string", + "description": "The retention for the metric values." + } + }, + "description": "The availability of the metric." + }, + "MetricListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Metric" + }, + "description": "The list of metrics for the account." + } + }, + "description": "The response to a list metrics request." + }, + "Metric": { + "properties": { + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The start time for the metric (ISO-8601 format)." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The end time for the metric (ISO-8601 format)." + }, + "timeGrain": { + "readOnly": true, + "type": "string", + "description": "The time grain to be used to summarize the metric values." + }, + "unit": { + "$ref": "#/definitions/UnitType", + "description": "The unit of the metric." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + }, + "metricValues": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MetricValue" + }, + "description": "The metric values for the specified time window and timestep." + } + }, + "description": "Metric data" + }, + "MetricName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the metric." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The friendly name of the metric." + } + }, + "description": "A metric name." + }, + "MetricValue": { + "properties": { + "_count": { + "readOnly": true, + "type": "number", + "format": "int32", + "description": "The number of values for the metric." + }, + "average": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The average value of the metric." + }, + "maximum": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The max value of the metric." + }, + "minimum": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The min value of the metric." + }, + "timestamp": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The metric timestamp (ISO-8601 format)." + }, + "total": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The total value of the metric." + } + }, + "description": "Represents metrics values." + }, + "PercentileMetricListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PercentileMetric" + }, + "description": "The list of percentile metrics for the account." + } + }, + "description": "The response to a list percentile metrics request." + }, + "PercentileMetric": { + "properties": { + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The start time for the metric (ISO-8601 format)." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The end time for the metric (ISO-8601 format)." + }, + "timeGrain": { + "readOnly": true, + "type": "string", + "description": "The time grain to be used to summarize the metric values." + }, + "unit": { + "$ref": "#/definitions/UnitType", + "description": "The unit of the metric." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + }, + "metricValues": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PercentileMetricValue" + }, + "description": "The percentile metric values for the specified time window and timestep." + } + }, + "description": "Percentile Metric data" + }, + "PercentileMetricValue": { + "allOf": [ + { + "$ref": "#/definitions/MetricValue" + } + ], + "properties": { + "P10": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 10th percentile value for the metric." + }, + "P25": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 25th percentile value for the metric." + }, + "P50": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 50th percentile value for the metric." + }, + "P75": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 75th percentile value for the metric." + }, + "P90": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 90th percentile value for the metric." + }, + "P95": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 95th percentile value for the metric." + }, + "P99": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 99th percentile value for the metric." + } + }, + "description": "Represents percentile metrics values." + }, + "PartitionMetricListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PartitionMetric" + }, + "description": "The list of partition-level metrics for the account." + } + }, + "description": "The response to a list partition metrics request." + }, + "PartitionMetric": { + "allOf": [ + { + "$ref": "#/definitions/Metric" + } + ], + "properties": { + "partitionId": { + "readOnly": true, + "type": "string", + "description": "The partition id (GUID identifier) of the metric values." + }, + "partitionKeyRangeId": { + "readOnly": true, + "type": "string", + "description": "The partition key range id (integer identifier) of the metric values." + } + }, + "description": "The metric values for a single partition." + }, + "UnitType": { + "type": "string", + "readOnly": true, + "description": "The unit of the metric.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountPerSecond", + "BytesPerSecond", + "Milliseconds" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "UnitType" + } + }, + "ConnectorOffer": { + "description": "The cassandra connector offer type for the Cosmos DB C* database account.", + "type": "string", + "enum": [ + "Small" + ], + "x-ms-enum": { + "name": "ConnectorOffer", + "modelAsString": true + } + }, + "PublicNetworkAccess": { + "type": "string", + "description": "Whether requests from Public Network are allowed", + "enum": [ + "Enabled", + "Disabled", + "SecuredByPerimeter" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "ApiProperties": { + "type": "object", + "properties": { + "serverVersion": { + "type": "string", + "enum": [ + "3.2", + "3.6", + "4.0", + "4.2" + ], + "description": "Describes the ServerVersion of an a MongoDB account.", + "x-ms-enum": { + "modelAsString": true, + "name": "ServerVersion" + } + } + } + }, + "AnalyticalStorageConfiguration": { + "type": "object", + "description": "Analytical storage specific properties.", + "properties": { + "schemaType": { + "type": "string", + "$ref": "#/definitions/AnalyticalStorageSchemaType" + } + } + }, + "AnalyticalStorageSchemaType": { + "type": "string", + "description": "Describes the types of schema for analytical storage.", + "enum": [ + "WellDefined", + "FullFidelity" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AnalyticalStorageSchemaType" + } + }, + "CreateMode": { + "description": "Enum to indicate the mode of account creation.", + "type": "string", + "default": "Default", + "enum": [ + "Default", + "Restore" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + } + }, + "RestoreParameters": { + "type": "object", + "description": "Parameters to indicate the information about the restore.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "restoreMode": { + "type": "string", + "enum": [ + "PointInTime" + ], + "description": "Describes the mode of the restore.", + "x-ms-enum": { + "modelAsString": true, + "name": "RestoreMode" + } + }, + "restoreSource": { + "type": "string", + "description": "The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}" + }, + "restoreTimestampInUtc": { + "type": "string", + "format": "date-time", + "description": "Time to which the account has to be restored (ISO-8601 format)." + }, + "databasesToRestore": { + "type": "array", + "description": "List of specific databases available for restore.", + "items": { + "$ref": "#/definitions/DatabaseRestoreResource" + } + }, + "gremlinDatabasesToRestore": { + "type": "array", + "description": "List of specific gremlin databases available for restore.", + "items": { + "$ref": "#/definitions/GremlinDatabaseRestoreResource" + } + }, + "tablesToRestore": { + "type": "array", + "description": "List of specific tables available for restore.", + "items": { + "$ref": "#/definitions/TableName" + } + }, + "sourceBackupLocation": { + "type": "string", + "description": "The source backup location for restore." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RestoreParametersBase" + } + ] + }, + "RestoreParametersBase": { + "type": "object", + "description": "Parameters to indicate the information about the restore.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "restoreSource": { + "type": "string", + "description": "The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}" + }, + "restoreTimestampInUtc": { + "type": "string", + "format": "date-time", + "description": "Time to which the account has to be restored (ISO-8601 format)." + }, + "restoreWithTtlDisabled": { + "type": "boolean", + "description": "Specifies whether the restored account will have Time-To-Live disabled upon the successful restore." + } + } + }, + "ResourceRestoreParameters": { + "type": "object", + "description": "Parameters to indicate the information about the restore.", + "x-ms-mutability": [ + "read", + "create" + ], + "allOf": [ + { + "$ref": "#/definitions/RestoreParametersBase" + } + ] + }, + "DatabaseRestoreResource": { + "type": "object", + "description": "Specific Databases to restore.", + "properties": { + "databaseName": { + "type": "string", + "description": "The name of the database available for restore." + }, + "collectionNames": { + "type": "array", + "description": "The names of the collections available for restore.", + "items": { + "$ref": "#/definitions/CollectionName" + } + } + } + }, + "GremlinDatabaseRestoreResource": { + "type": "object", + "description": "Specific Gremlin Databases to restore.", + "properties": { + "databaseName": { + "type": "string", + "description": "The name of the gremlin database available for restore." + }, + "graphNames": { + "type": "array", + "description": "The names of the graphs available for restore.", + "items": { + "$ref": "#/definitions/GraphName" + } + } + } + }, + "CollectionName": { + "type": "string", + "description": "The name of the collection." + }, + "GraphName": { + "type": "string", + "description": "The name of the graph." + }, + "TableName": { + "type": "string", + "description": "The name of the table." + }, + "BackupPolicy": { + "type": "object", + "description": "The object representing the policy for taking backups on an account.", + "discriminator": "type", + "properties": { + "type": { + "description": "Describes the mode of backups.", + "type": "string", + "$ref": "#/definitions/BackupPolicyType" + }, + "migrationState": { + "description": "The object representing the state of the migration between the backup policies.", + "type": "object", + "$ref": "#/definitions/BackupPolicyMigrationState" + } + }, + "required": [ + "type" + ] + }, + "BackupPolicyType": { + "description": "Describes the mode of backups.", + "type": "string", + "enum": [ + "Periodic", + "Continuous" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BackupPolicyType" + } + }, + "BackupPolicyMigrationState": { + "type": "object", + "description": "The object representing the state of the migration between the backup policies.", + "properties": { + "status": { + "description": "Describes the status of migration between backup policy types.", + "type": "string", + "$ref": "#/definitions/BackupPolicyMigrationStatus" + }, + "targetType": { + "description": "Describes the target backup policy type of the backup policy migration.", + "type": "string", + "$ref": "#/definitions/BackupPolicyType" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Time at which the backup policy migration started (ISO-8601 format)." + } + } + }, + "BackupPolicyMigrationStatus": { + "description": "Describes the status of migration between backup policy types.", + "type": "string", + "enum": [ + "Invalid", + "InProgress", + "Completed", + "Failed" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BackupPolicyMigrationStatus" + } + }, + "PeriodicModeBackupPolicy": { + "description": "The object representing periodic mode backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupPolicy" + } + ], + "properties": { + "periodicModeProperties": { + "type": "object", + "description": "Configuration values for periodic mode backup", + "$ref": "#/definitions/PeriodicModeProperties" + } + }, + "x-ms-discriminator-value": "Periodic" + }, + "ContinuousModeBackupPolicy": { + "description": "The object representing continuous mode backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupPolicy" + } + ], + "properties": { + "continuousModeProperties": { + "type": "object", + "description": "Configuration values for continuous mode backup", + "$ref": "#/definitions/ContinuousModeProperties" + } + }, + "x-ms-discriminator-value": "Continuous" + }, + "PeriodicModeProperties": { + "type": "object", + "description": "Configuration values for periodic mode backup", + "properties": { + "backupIntervalInMinutes": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "An integer representing the interval in minutes between two backups" + }, + "backupRetentionIntervalInHours": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "An integer representing the time (in hours) that each backup is retained" + }, + "backupStorageRedundancy": { + "description": "Enum to indicate type of backup residency", + "type": "string", + "$ref": "#/definitions/BackupStorageRedundancy" + } + } + }, + "ContinuousModeProperties": { + "type": "object", + "description": "Configuration values for periodic mode backup", + "properties": { + "tier": { + "description": "Enum to indicate type of Continuos backup mode", + "type": "string", + "$ref": "#/definitions/ContinuousTier" + } + } + }, + "MergeParameters": { + "description": "The properties of an Azure Cosmos DB merge operations", + "type": "object", + "properties": { + "isDryRun": { + "type": "boolean", + "description": "Specifies whether the operation is a real merge operation or a simulation." + } + } + }, + "PhysicalPartitionStorageInfoCollection": { + "type": "object", + "description": "List of physical partitions and their properties returned by a merge operation.", + "properties": { + "physicalPartitionStorageInfoCollection": { + "description": "List of physical partitions and their properties.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/physicalPartitionStorageInfo" + } + } + } + }, + "physicalPartitionStorageInfo": { + "description": "The storage of a physical partition", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique identifier of the partition." + }, + "storageInKB": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The storage in KB for the physical partition." + } + } + }, + "LocationListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/LocationGetResult" + }, + "description": "List of Cosmos DB locations and their properties." + } + }, + "description": "The List operation response, that contains Cosmos DB locations and their properties." + }, + "LocationGetResult": { + "description": "Cosmos DB location get result", + "type": "object", + "properties": { + "properties": { + "type": "object", + "description": "Cosmos DB location metadata", + "$ref": "#/definitions/LocationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMProxyResource" + } + ] + }, + "LocationProperties": { + "description": "Cosmos DB location metadata", + "type": "object", + "properties": { + "supportsAvailabilityZone": { + "type": "boolean", + "readOnly": true, + "description": "Flag indicating whether the location supports availability zones or not." + }, + "isResidencyRestricted": { + "type": "boolean", + "readOnly": true, + "description": "Flag indicating whether the location is residency sensitive." + }, + "backupStorageRedundancies": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/BackupStorageRedundancy" + }, + "description": "The properties of available backup storage redundancies." + }, + "isSubscriptionRegionAccessAllowedForRegular": { + "type": "boolean", + "readOnly": true, + "description": "Flag indicating whether the subscription have access in region for Non-Availability Zones." + }, + "isSubscriptionRegionAccessAllowedForAz": { + "type": "boolean", + "readOnly": true, + "description": "Flag indicating whether the subscription have access in region for Availability Zones(Az)." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Enum to indicate current buildout status of the region.", + "enum": [ + "Uninitialized", + "Initializing", + "InternallyReady", + "Online", + "Deleting" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + } + } + }, + "BackupStorageRedundancy": { + "description": "Enum to indicate type of backup storage redundancy.", + "type": "string", + "enum": [ + "Geo", + "Local", + "Zone" + ], + "x-ms-enum": { + "name": "BackupStorageRedundancy", + "modelAsString": true + } + }, + "ContinuousTier": { + "description": "Enum to indicate type of Continuous backup tier.", + "type": "string", + "enum": [ + "Continuous7Days", + "Continuous30Days" + ], + "x-ms-enum": { + "name": "ContinuousTier", + "modelAsString": true + } + }, + "MinimalTlsVersion": { + "description": "Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2.", + "type": "string", + "enum": [ + "Tls", + "Tls11", + "Tls12" + ], + "x-ms-enum": { + "name": "MinimalTlsVersion", + "modelAsString": true + } + }, + "DefaultPriorityLevel": { + "description": "Enum to indicate default priorityLevel of requests", + "type": "string", + "enum": [ + "High", + "Low" + ], + "x-ms-enum": { + "name": "DefaultPriorityLevel", + "modelAsString": true + } + } + }, + "parameters": { + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of an Azure resource group." + }, + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database account name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq." + }, + "usageFilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names)." + }, + "databaseRidParameter": { + "name": "databaseRid", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database rid." + }, + "collectionRidParameter": { + "name": "collectionRid", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB collection rid." + }, + "graphResourceNameParameter": { + "name": "graphName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB graph resource name." + }, + "databaseNameParameter": { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database name." + }, + "clientEncryptionKeyNameParameter": { + "name": "clientEncryptionKeyName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB ClientEncryptionKey name." + }, + "containerNameParameter": { + "name": "containerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB container name." + }, + "storedProcedureNameParameter": { + "name": "storedProcedureName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB storedProcedure name." + }, + "userDefinedFunctionNameParameter": { + "name": "userDefinedFunctionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB userDefinedFunction name." + }, + "triggerNameParameter": { + "name": "triggerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB trigger name." + }, + "tableNameParameter": { + "name": "tableName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB table name." + }, + "collectionNameParameter": { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB collection name." + }, + "keyspaceNameParameter": { + "name": "keyspaceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB keyspace name." + }, + "graphNameParameter": { + "name": "graphName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB graph name." + }, + "regionParameter": { + "name": "region", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB region, with spaces between words and each word capitalized." + }, + "sourceRegionParameter": { + "name": "sourceRegion", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Source region from which data is written. Cosmos DB region, with spaces between words and each word capitalized." + }, + "targetRegionParameter": { + "name": "targetRegion", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized." + }, + "partitionKeyRangeIdParameter": { + "name": "partitionKeyRangeId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Partition Key Range Id for which to get data." + }, + "locationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB region, with spaces between words and each word capitalized." + }, + "viewNameParameter": { + "name": "viewName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB view name." + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/dataTransferService.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/dataTransferService.json new file mode 100644 index 000000000000..efa984b82404 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/dataTransferService.json @@ -0,0 +1,603 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Data Transfer Service Resource Provider REST API", + "version": "2024-02-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.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}": { + "put": { + "operationId": "DataTransferJobs_Create", + "description": "Creates a Data Transfer Job.", + "x-ms-examples": { + "CosmosDBDataTransferJobCreate": { + "$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobCreate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "name": "jobCreateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateJobRequest" + } + } + ], + "responses": { + "200": { + "description": "Successful CreateJob response", + "schema": { + "$ref": "#/definitions/DataTransferJobGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "get": { + "operationId": "DataTransferJobs_Get", + "description": "Get a Data Transfer Job.", + "x-ms-examples": { + "CosmosDBDataTransferJobGet": { + "$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + } + ], + "responses": { + "200": { + "description": "The Data Transfer Job Properties retrieved successfully", + "schema": { + "$ref": "#/definitions/DataTransferJobGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/pause": { + "post": { + "operationId": "DataTransferJobs_Pause", + "description": "Pause a Data Transfer Job.", + "x-ms-examples": { + "CosmosDBDataTransferJobPause": { + "$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobPause.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + } + ], + "responses": { + "200": { + "description": "Successful Pause Job response", + "schema": { + "$ref": "#/definitions/DataTransferJobGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/resume": { + "post": { + "operationId": "DataTransferJobs_Resume", + "description": "Resumes a Data Transfer Job.", + "x-ms-examples": { + "CosmosDBDataTransferJobResume": { + "$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobResume.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + } + ], + "responses": { + "200": { + "description": "Successful Resume Job response", + "schema": { + "$ref": "#/definitions/DataTransferJobGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/cancel": { + "post": { + "operationId": "DataTransferJobs_Cancel", + "description": "Cancels a Data Transfer Job.", + "x-ms-examples": { + "CosmosDBDataTransferJobCancel": { + "$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobCancel.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + } + ], + "responses": { + "200": { + "description": "Successful Cancel Job response", + "schema": { + "$ref": "#/definitions/DataTransferJobGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/complete": { + "post": { + "operationId": "DataTransferJobs_Complete", + "description": "Completes a Data Transfer Online Job.", + "x-ms-examples": { + "CosmosDBDataTransferJobComplete": { + "$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobComplete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + } + ], + "responses": { + "200": { + "description": "Successful Complete Job response", + "schema": { + "$ref": "#/definitions/DataTransferJobGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs": { + "get": { + "operationId": "DataTransferJobs_ListByDatabaseAccount", + "description": "Get a list of Data Transfer jobs.", + "x-ms-examples": { + "CosmosDBDataTransferJobFeed": { + "$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobFeed.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "All Data Transfer Jobs retrieved successfully", + "schema": { + "$ref": "#/definitions/DataTransferJobFeedResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "DataTransferDataSourceSink": { + "type": "object", + "description": "Base class for all DataTransfer source/sink", + "properties": { + "component": { + "type": "string", + "enum": [ + "CosmosDBCassandra", + "CosmosDBMongo", + "CosmosDBSql", + "AzureBlobStorage" + ], + "x-ms-enum": { + "name": "DataTransferComponent", + "modelAsString": true + }, + "default": "CosmosDBCassandra" + } + }, + "discriminator": "component", + "required": [ + "component" + ] + }, + "BaseCosmosDataTransferDataSourceSink": { + "type": "object", + "description": "A base CosmosDB data source/sink", + "properties": { + "remoteAccountName": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DataTransferDataSourceSink" + } + ] + }, + "CosmosCassandraDataTransferDataSourceSink": { + "type": "object", + "description": "A CosmosDB Cassandra API data source/sink", + "properties": { + "keyspaceName": { + "type": "string" + }, + "tableName": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseCosmosDataTransferDataSourceSink" + } + ], + "required": [ + "keyspaceName", + "tableName" + ], + "x-ms-discriminator-value": "CosmosDBCassandra" + }, + "CosmosMongoDataTransferDataSourceSink": { + "type": "object", + "description": "A CosmosDB Mongo API data source/sink", + "properties": { + "databaseName": { + "type": "string" + }, + "collectionName": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseCosmosDataTransferDataSourceSink" + } + ], + "required": [ + "databaseName", + "collectionName" + ], + "x-ms-discriminator-value": "CosmosDBMongo" + }, + "CosmosSqlDataTransferDataSourceSink": { + "type": "object", + "description": "A CosmosDB No Sql API data source/sink", + "properties": { + "databaseName": { + "type": "string" + }, + "containerName": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseCosmosDataTransferDataSourceSink" + } + ], + "required": [ + "databaseName", + "containerName" + ], + "x-ms-discriminator-value": "CosmosDBSql" + }, + "AzureBlobDataTransferDataSourceSink": { + "type": "object", + "description": "An Azure Blob Storage data source/sink", + "allOf": [ + { + "$ref": "#/definitions/DataTransferDataSourceSink" + } + ], + "properties": { + "containerName": { + "type": "string" + }, + "endpointUrl": { + "type": "string" + } + }, + "required": [ + "containerName" + ], + "x-ms-discriminator-value": "AzureBlobStorage" + }, + "DataTransferJobProperties": { + "description": "The properties of a DataTransfer Job", + "type": "object", + "properties": { + "jobName": { + "readOnly": true, + "type": "string", + "description": "Job Name" + }, + "source": { + "$ref": "#/definitions/DataTransferDataSourceSink", + "description": "Source DataStore details" + }, + "destination": { + "$ref": "#/definitions/DataTransferDataSourceSink", + "description": "Destination DataStore details" + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Job Status" + }, + "processedCount": { + "readOnly": true, + "type": "integer", + "description": "Processed Count.", + "format": "int64" + }, + "totalCount": { + "readOnly": true, + "type": "integer", + "description": "Total Count.", + "format": "int64" + }, + "lastUpdatedUtcTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last Updated Time (ISO-8601 format)." + }, + "workerCount": { + "description": "Worker count", + "type": "integer", + "minimum": 0, + "format": "int32" + }, + "error": { + "readOnly": true, + "$ref": "./cosmos-db.json#/definitions/ErrorResponse", + "description": "Error response for Faulted job" + }, + "duration": { + "x-ms-format": "duration-constant", + "description": "Total Duration of Job", + "type": "string", + "readOnly": true + }, + "mode": { + "description": "Mode of job execution", + "type": "string", + "enum": [ + "Offline", + "Online" + ], + "x-ms-enum": { + "name": "DataTransferJobMode", + "modelAsString": true + } + } + }, + "required": [ + "source", + "destination" + ] + }, + "CreateJobRequest": { + "description": "Parameters to create Data Transfer Job", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DataTransferJobProperties", + "description": "Data Transfer Create Job Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "./cosmos-db.json#/definitions/ARMProxyResource" + } + ] + }, + "DataTransferJobGetResults": { + "description": "A Cosmos DB Data Transfer Job", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "$ref": "#/definitions/DataTransferJobProperties" + } + }, + "allOf": [ + { + "$ref": "./cosmos-db.json#/definitions/ARMProxyResource" + } + ] + }, + "DataTransferJobFeedResults": { + "description": "The List operation response, that contains the Data Transfer jobs and their properties.", + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DataTransferJobGetResults" + }, + "description": "List of Data Transfer jobs and their properties." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of Data Transfer job list results if there are any." + } + } + } + }, + "parameters": { + "JobNameParameter": { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Name of the Data Transfer Job" + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceCreateUpdate.json new file mode 100644 index 000000000000..f37fd7f4b69d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceCreateUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "createUpdateCassandraKeyspaceParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "keyspaceName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName", + "name": "keyspaceName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "keyspaceName" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceDelete.json new file mode 100644 index 000000000000..9f007b1271a2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceGet.json new file mode 100644 index 000000000000..c2eb0f68045c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName", + "name": "keyspaceName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "keyspaceName", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceList.json new file mode 100644 index 000000000000..4d5f68c70a02 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName", + "name": "keyspaceName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "keyspaceName" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json new file mode 100644 index 000000000000..dd0935ad84fe --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json new file mode 100644 index 000000000000..eb27b3ec2d5d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceThroughputGet.json new file mode 100644 index 000000000000..7ad2b4612ed7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceThroughputGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceThroughputUpdate.json new file mode 100644 index 000000000000..4aa3c51fe892 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraKeyspaceThroughputUpdate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableCreateUpdate.json new file mode 100644 index 000000000000..6e1506789a0e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableCreateUpdate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName", + "createUpdateCassandraTableParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "defaultTtl": 100, + "analyticalStorageTtl": 500, + "schema": { + "columns": [ + { + "name": "columnA", + "type": "Ascii" + } + ], + "partitionKeys": [ + { + "name": "columnA" + } + ], + "clusterKeys": [ + { + "name": "columnA", + "orderBy": "Asc" + } + ] + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "defaultTtl": 100, + "analyticalStorageTtl": 500, + "schema": { + "columns": [ + { + "name": "columnA", + "type": "Ascii" + } + ], + "partitionKeys": [ + { + "name": "columnA" + } + ], + "clusterKeys": [ + { + "name": "columnA", + "orderBy": "Asc" + } + ] + } + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableDelete.json new file mode 100644 index 000000000000..37a3756f2d87 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableGet.json new file mode 100644 index 000000000000..f040009cb5fc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "defaultTtl": 100, + "analyticalStorageTtl": 500, + "schema": { + "columns": [ + { + "name": "columnA", + "type": "Ascii" + } + ], + "partitionKeys": [ + { + "name": "columnA" + } + ], + "clusterKeys": [ + { + "name": "columnA", + "orderBy": "Asc" + } + ] + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableList.json new file mode 100644 index 000000000000..0f7a86e292fe --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "defaultTtl": 100, + "analyticalStorageTtl": 500, + "schema": { + "columns": [ + { + "name": "columnA", + "type": "Ascii" + } + ], + "partitionKeys": [ + { + "name": "columnA" + } + ], + "clusterKeys": [ + { + "name": "columnA", + "orderBy": "Asc" + } + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableMigrateToAutoscale.json new file mode 100644 index 000000000000..93b83419b990 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableMigrateToAutoscale.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableMigrateToManualThroughput.json new file mode 100644 index 000000000000..55b6d636ebba --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableMigrateToManualThroughput.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableThroughputGet.json new file mode 100644 index 000000000000..9539120873f7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableThroughputGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableThroughputUpdate.json new file mode 100644 index 000000000000..a90411c38352 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraTableThroughputUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables/throughputSettings", + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewCreateUpdate.json new file mode 100644 index 000000000000..0ad0df7dfa59 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewCreateUpdate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspacename", + "viewName": "viewname", + "createUpdateCassandraViewParameters": { + "tags": {}, + "properties": { + "resource": { + "id": "viewname", + "viewDefinition": "SELECT columna, columnb, columnc FROM keyspacename.srctablename WHERE columna IS NOT NULL AND columnc IS NOT NULL PRIMARY (columnc, columna)" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspacename/views/viewname", + "name": "viewname", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views", + "tags": {}, + "properties": { + "resource": { + "id": "viewname", + "viewDefinition": "SELECT columna, columnb, columnc FROM keyspacename.srctablename WHERE columna IS NOT NULL AND columnc IS NOT NULL PRIMARY KEY (columnc, columna)" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewDelete.json new file mode 100644 index 000000000000..512527aeabb7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspacename", + "viewName": "viewname" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewGet.json new file mode 100644 index 000000000000..a192f8d82071 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspacename", + "viewName": "viewname" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspacename/views/viewname", + "name": "viewname", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views", + "tags": {}, + "properties": { + "resource": { + "id": "viewname", + "viewDefinition": "SELECT columna, columnb, columnc FROM keyspacename.srctablename WHERE columna IS NOT NULL AND columnc IS NOT NULL PRIMARY KEY (columnc, columna)" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewList.json new file mode 100644 index 000000000000..4d8a90486b8f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "keyspaceName": "keyspacename" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspacename/views/viewname", + "name": "viewname", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views", + "tags": {}, + "properties": { + "resource": { + "id": "viewname", + "viewDefinition": "SELECT columna, columnb, columnc FROM keyspacename.srctablename WHERE columna IS NOT NULL AND columnc IS NOT NULL PRIMARY KEY (columnc, columna)" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewMigrateToAutoscale.json new file mode 100644 index 000000000000..7c2f78522fdc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewMigrateToAutoscale.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspacename", + "viewName": "viewname" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewMigrateToManualThroughput.json new file mode 100644 index 000000000000..fadd0311546b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewMigrateToManualThroughput.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspacename", + "viewName": "viewname" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "false" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewThroughputGet.json new file mode 100644 index 000000000000..88ab2f7df6bf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewThroughputGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspacename", + "viewName": "viewname" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/views/viewName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewThroughputUpdate.json new file mode 100644 index 000000000000..a2b08e5705ed --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCassandraViewThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspacename", + "viewName": "viewname", + "updateThroughputParameters": { + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/views/viewName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings", + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionGetMetricDefinitions.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionGetMetricDefinitions.json new file mode 100644 index 000000000000..97356a19b918 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionGetMetricDefinitions.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "api-version": "2024-02-15-preview", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "timeGrain": "PT5M", + "retention": "P2D" + }, + { + "timeGrain": "PT1H", + "retention": "P14D" + }, + { + "timeGrain": "P1D", + "retention": "P60D" + } + ], + "primaryAggregationType": "Total", + "unit": "Count", + "resourceUri": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionGetMetrics.json new file mode 100644 index 000000000000..e2a4ee8415cb --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionGetMetrics.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionGetUsages.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionGetUsages.json new file mode 100644 index 000000000000..2a47703be4b0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionGetUsages.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "subscriptionId": "subid", + "$filter": "$filter=name.value eq 'Storage'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Bytes", + "quotaPeriod": "P1D", + "limit": 10737418240, + "currentValue": 0, + "name": { + "value": "Storage", + "localizedValue": "Storage" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionPartitionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionPartitionGetMetrics.json new file mode 100644 index 000000000000..0efc0d1b27f1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionPartitionGetMetrics.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "$filter": "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT1M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T23:58:55.2780000Z", + "unit": "Count", + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:54:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:55:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:56:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:57:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "maximum": 5 + } + ], + "name": { + "value": "Max RUs Per Second", + "localizedValue": "Max RUs Per Second" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionPartitionGetUsages.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionPartitionGetUsages.json new file mode 100644 index 000000000000..cf584c44d343 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionPartitionGetUsages.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "subscriptionId": "subid", + "$filter": "$filter=name.value eq 'Partition Storage'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Bytes", + "quotaPeriod": "P1D", + "limit": 10737418240, + "currentValue": 0, + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "name": { + "value": "Storage", + "localizedValue": "Storage" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionPartitionRegionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionPartitionRegionGetMetrics.json new file mode 100644 index 000000000000..16c4e6336e16 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBCollectionPartitionRegionGetMetrics.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "region": "North Europe", + "$filter": "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT1M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T23:58:55.2780000Z", + "unit": "Count", + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:54:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:55:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:56:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:57:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "maximum": 5 + } + ], + "name": { + "value": "Max RUs Per Second", + "localizedValue": "Max RUs Per Second" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDataTransferServiceCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDataTransferServiceCreate.json new file mode 100644 index 000000000000..60e567b07b05 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDataTransferServiceCreate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "serviceName": "DataTransfer", + "createUpdateParameters": { + "properties": { + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "DataTransfer" + } + } + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/DataTransfer", + "name": "DataTransfer", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "DataTransfer", + "locations": [ + { + "name": "DataTransfer-westus2", + "location": "West US 2", + "status": "Running" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDataTransferServiceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDataTransferServiceDelete.json new file mode 100644 index 000000000000..4f5ccc390b5c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDataTransferServiceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "serviceName": "DataTransfer" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDataTransferServiceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDataTransferServiceGet.json new file mode 100644 index 000000000000..38f859cae0d1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDataTransferServiceGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "serviceName": "DataTransfer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/DataTransfer", + "name": "DataTransfer", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "DataTransfer", + "locations": [ + { + "name": "DataTransfer-westus2", + "location": "West US 2", + "status": "Running" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountCheckNameExists.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountCheckNameExists.json new file mode 100644 index 000000000000..3663a4c99971 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountCheckNameExists.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "accountName": "ddb1", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountCreateMax.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountCreateMax.json new file mode 100644 index 000000000000..665ccf56c6b8 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountCreateMax.json @@ -0,0 +1,248 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "createUpdateParameters": { + "location": "westus", + "tags": {}, + "kind": "MongoDB", + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "databaseAccountOfferType": "Standard", + "ipRules": [ + { + "ipAddressOrRange": "23.43.230.120" + }, + { + "ipAddressOrRange": "110.12.240.0/12" + } + ], + "isVirtualNetworkFilterEnabled": true, + "virtualNetworkRules": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "ignoreMissingVNetServiceEndpoint": false + } + ], + "publicNetworkAccess": "Enabled", + "locations": [ + { + "failoverPriority": 0, + "locationName": "southcentralus", + "isZoneRedundant": false + }, + { + "failoverPriority": 1, + "locationName": "eastus", + "isZoneRedundant": false + } + ], + "createMode": "Default", + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "keyVaultKeyUri": "https://myKeyVault.vault.azure.net", + "defaultIdentity": "FirstPartyIdentity", + "enableFreeTier": false, + "apiProperties": { + "serverVersion": "3.2" + }, + "enableAnalyticalStorage": true, + "analyticalStorageConfiguration": { + "schemaType": "WellDefined" + }, + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 8, + "backupStorageRedundancy": "Geo" + } + }, + "cors": [ + { + "allowedOrigins": "https://test" + } + ], + "networkAclBypass": "AzureServices", + "networkAclBypassResourceIds": [ + "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName" + ], + "capacity": { + "totalThroughputLimit": 2000 + }, + "enableMaterializedViews": false, + "enableBurstCapacity": true, + "minimalTlsVersion": "Tls12", + "enablePriorityBasedExecution": true, + "defaultPriorityLevel": "Low", + "enablePerRegionPerPartitionAutoscale": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "MongoDB", + "tags": {}, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656", + "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Initializing", + "isVirtualNetworkFilterEnabled": true, + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "writeLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "readLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + }, + { + "id": "ddb1-eastus", + "locationName": "East US", + "provisioningState": "Initializing", + "failoverPriority": 1, + "isZoneRedundant": false + } + ], + "locations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + }, + { + "id": "ddb1-eastus", + "locationName": "East US", + "provisioningState": "Initializing", + "failoverPriority": 1, + "isZoneRedundant": false + } + ], + "failoverPolicies": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "failoverPriority": 0 + }, + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 1 + } + ], + "virtualNetworkRules": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + ], + "publicNetworkAccess": "Enabled", + "keyVaultKeyUri": "https://myKeyVault.vault.azure.net", + "defaultIdentity": "FirstPartyIdentity", + "enableFreeTier": false, + "ipRules": [ + { + "ipAddressOrRange": "23.43.230.120" + }, + { + "ipAddressOrRange": "110.12.240.0/12" + } + ], + "apiProperties": { + "serverVersion": "3.2" + }, + "enableAnalyticalStorage": true, + "analyticalStorageConfiguration": { + "schemaType": "WellDefined" + }, + "createMode": "Default", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 8, + "backupStorageRedundancy": "Geo" + } + }, + "cors": [ + { + "allowedOrigins": "https://test" + } + ], + "networkAclBypass": "AzureServices", + "networkAclBypassResourceIds": [ + "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName" + ], + "capacity": { + "totalThroughputLimit": 2000 + }, + "enableMaterializedViews": false, + "enableBurstCapacity": true, + "minimalTlsVersion": "Tls12", + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + } + }, + "enablePriorityBasedExecution": true, + "defaultPriorityLevel": "Low", + "enablePerRegionPerPartitionAutoscale": true + }, + "systemData": { + "createdAt": "2021-03-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountCreateMin.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountCreateMin.json new file mode 100644 index 000000000000..8e605f8ea00c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountCreateMin.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "createUpdateParameters": { + "location": "westus", + "properties": { + "databaseAccountOfferType": "Standard", + "locations": [ + { + "failoverPriority": 0, + "locationName": "southcentralus", + "isZoneRedundant": false + } + ], + "createMode": "Default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Initializing", + "ipRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "readLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "locations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "failoverPolicies": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "failoverPriority": 0 + } + ], + "cors": [], + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": false, + "analyticalStorageConfiguration": null, + "networkAclBypass": "None", + "networkAclBypassResourceIds": [], + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720, + "backupStorageRedundancy": "Geo" + } + }, + "enableMaterializedViews": false, + "minimalTlsVersion": "Tls", + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + } + } + }, + "systemData": { + "createdAt": "2021-03-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountDelete.json new file mode 100644 index 000000000000..d21977b02659 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json new file mode 100644 index 000000000000..34a29d76f013 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1-failover", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "failoverParameters": { + "failoverPolicies": [ + { + "locationName": "eastus", + "failoverPriority": 0 + }, + { + "locationName": "westus", + "failoverPriority": 1 + } + ] + } + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGet.json new file mode 100644 index 000000000000..208175702318 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGet.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "documentEndpoint": "https://ddb1.documents.azure.com:443/", + "ipRules": [], + "isVirtualNetworkFilterEnabled": false, + "virtualNetworkRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "defaultIdentity": "FirstPartyIdentity", + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "readLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "locations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "failoverPolicies": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 0 + } + ], + "privateEndpointConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "cors": [], + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": true, + "analyticalStorageConfiguration": { + "schemaType": "WellDefined" + }, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 8, + "backupStorageRedundancy": "Geo" + }, + "migrationState": { + "status": "InProgress", + "targetType": "Continuous", + "startTime": "2021-06-09T21:07:16Z" + } + }, + "networkAclBypass": "None", + "networkAclBypassResourceIds": [], + "enablePartitionMerge": true, + "enableBurstCapacity": true, + "minimalTlsVersion": "Tls", + "diagnosticLogSettings": { + "enableFullTextQuery": "False" + }, + "enableMaterializedViews": false, + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + } + }, + "enablePriorityBasedExecution": true, + "defaultPriorityLevel": "Low", + "enablePerRegionPerPartitionAutoscale": true + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656", + "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d" + } + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGetMetricDefinitions.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGetMetricDefinitions.json new file mode 100644 index 000000000000..082cad28311c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGetMetricDefinitions.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "timeGrain": "PT5M", + "retention": "P2D" + }, + { + "timeGrain": "PT1H", + "retention": "P14D" + }, + { + "timeGrain": "P1D", + "retention": "P60D" + } + ], + "primaryAggregationType": "Total", + "unit": "Count", + "resourceUri": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGetMetrics.json new file mode 100644 index 000000000000..e6a675323b9f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGetMetrics.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGetUsages.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGetUsages.json new file mode 100644 index 000000000000..82558eae67bf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGetUsages.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "$filter": "$filter=name.value eq 'Storage'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Bytes", + "quotaPeriod": "P1D", + "limit": 10737418240, + "currentValue": 0, + "name": { + "value": "Storage", + "localizedValue": "Storage" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountList.json new file mode 100644 index 000000000000..c0c3e398007d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountList.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "documentEndpoint": "https://ddb1.documents.azure.com:443/", + "ipRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "readLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "locations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "failoverPolicies": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 0 + } + ], + "privateEndpointConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "cors": [], + "defaultIdentity": "FirstPartyIdentity", + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": true, + "analyticalStorageConfiguration": { + "schemaType": "WellDefined" + }, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720, + "backupStorageRedundancy": "Geo" + } + }, + "networkAclBypass": "None", + "networkAclBypassResourceIds": [], + "enablePartitionMerge": true, + "enableBurstCapacity": true, + "minimalTlsVersion": "Tls", + "enableMaterializedViews": false, + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + } + }, + "enablePriorityBasedExecution": true, + "defaultPriorityLevel": "Low", + "enablePerRegionPerPartitionAutoscale": true + }, + "systemData": { + "createdAt": "2021-03-12T22:05:09Z" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656", + "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListByResourceGroup.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListByResourceGroup.json new file mode 100644 index 000000000000..3ca30559f5ae --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListByResourceGroup.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "documentEndpoint": "https://ddb1.documents.azure.com:443/", + "ipRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "readLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "locations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "failoverPolicies": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 0 + } + ], + "cors": [], + "enableFreeTier": false, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "defaultIdentity": "FirstPartyIdentity", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720, + "backupStorageRedundancy": "Geo" + } + }, + "networkAclBypass": "None", + "networkAclBypassResourceIds": [], + "enableMaterializedViews": false, + "minimalTlsVersion": "Tls", + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + } + } + }, + "systemData": { + "createdAt": "2021-03-12T22:05:09Z" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656", + "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListConnectionStrings.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListConnectionStrings.json new file mode 100644 index 000000000000..56b0a9f969fc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListConnectionStrings.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "connectionStrings": [ + { + "connectionString": "connection-string", + "description": "Primary SQL Connection String", + "keyKind": "Primary", + "type": "Sql" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json new file mode 100644 index 000000000000..744ca783f19c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "mongo-ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "connectionStrings": [ + { + "connectionString": "connection-string", + "description": "Name of the connection string" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListKeys.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListKeys.json new file mode 100644 index 000000000000..e5efa1a0d3fa --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryMasterKey": "primaryMasterKey", + "secondaryMasterKey": "secondaryMasterKey", + "primaryReadonlyMasterKey": "primaryReadonlyMasterKey", + "secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListReadOnlyKeys.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListReadOnlyKeys.json new file mode 100644 index 000000000000..62067f670410 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountListReadOnlyKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryReadonlyMasterKey": "primaryReadonlyMasterKey", + "secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountOfflineRegion.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountOfflineRegion.json new file mode 100644 index 000000000000..e572bdb7c9f2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountOfflineRegion.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "region": "North Europe", + "regionParameterForOffline": { + "region": "North Europe" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountOnlineRegion.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountOnlineRegion.json new file mode 100644 index 000000000000..b970782dc800 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountOnlineRegion.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "region": "North Europe", + "regionParameterForOnline": { + "region": "North Europe" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountPatch.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountPatch.json new file mode 100644 index 000000000000..c5f04c6f4848 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountPatch.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "updateParameters": { + "location": "westus", + "tags": { + "dept": "finance" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "ipRules": [ + { + "ipAddressOrRange": "23.43.230.120" + }, + { + "ipAddressOrRange": "110.12.240.0/12" + } + ], + "isVirtualNetworkFilterEnabled": true, + "virtualNetworkRules": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "ignoreMissingVNetServiceEndpoint": false + } + ], + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "defaultIdentity": "FirstPartyIdentity", + "enableFreeTier": false, + "enableAnalyticalStorage": true, + "analyticalStorageConfiguration": { + "schemaType": "WellDefined" + }, + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720, + "backupStorageRedundancy": "Geo" + } + }, + "networkAclBypass": "AzureServices", + "networkAclBypassResourceIds": [ + "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName" + ], + "capacity": { + "totalThroughputLimit": 2000 + }, + "diagnosticLogSettings": { + "enableFullTextQuery": "True" + }, + "enablePartitionMerge": true, + "enableBurstCapacity": true, + "minimalTlsVersion": "Tls", + "enablePriorityBasedExecution": true, + "defaultPriorityLevel": "Low", + "enablePerRegionPerPartitionAutoscale": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": { + "dept": "finance" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656", + "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "documentEndpoint": "https://ddb1.documents.azure.com:443/", + "databaseAccountOfferType": "Standard", + "ipRules": [ + { + "ipAddressOrRange": "23.43.230.120" + }, + { + "ipAddressOrRange": "110.12.240.0/12" + } + ], + "isVirtualNetworkFilterEnabled": true, + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "writeLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "readLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "locations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "failoverPolicies": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 0 + } + ], + "cors": [], + "virtualNetworkRules": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "ignoreMissingVNetServiceEndpoint": false + } + ], + "privateEndpointConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "defaultIdentity": "FirstPartyIdentity", + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": true, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "analyticalStorageConfiguration": { + "schemaType": "WellDefined" + }, + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720, + "backupStorageRedundancy": "Geo" + } + }, + "networkAclBypass": "AzureServices", + "networkAclBypassResourceIds": [ + "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName" + ], + "capacity": { + "totalThroughputLimit": 2000 + }, + "diagnosticLogSettings": { + "enableFullTextQuery": "True" + }, + "enableMaterializedViews": false, + "enableBurstCapacity": true, + "minimalTlsVersion": "Tls", + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + } + }, + "enablePriorityBasedExecution": true, + "defaultPriorityLevel": "Low", + "enablePerRegionPerPartitionAutoscale": true + }, + "systemData": { + "createdAt": "2021-03-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountRegenerateKey.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountRegenerateKey.json new file mode 100644 index 000000000000..fc5478d170d9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountRegenerateKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "keyToRegenerate": { + "keyKind": "primary" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountRegionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountRegionGetMetrics.json new file mode 100644 index 000000000000..3c092fe2edac --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountRegionGetMetrics.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "region": "North Europe", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseGetMetricDefinitions.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseGetMetricDefinitions.json new file mode 100644 index 000000000000..4910e1301ea3 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseGetMetricDefinitions.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "api-version": "2024-02-15-preview", + "databaseRid": "databaseRid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "timeGrain": "PT5M", + "retention": "P2D" + }, + { + "timeGrain": "PT1H", + "retention": "P14D" + }, + { + "timeGrain": "P1D", + "retention": "P60D" + } + ], + "primaryAggregationType": "Total", + "unit": "Count", + "resourceUri": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseGetMetrics.json new file mode 100644 index 000000000000..3d733d1da32f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseGetMetrics.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseRid": "rid", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseGetUsages.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseGetUsages.json new file mode 100644 index 000000000000..97cd58e0ff4d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseGetUsages.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "databaseRid": "databaseRid", + "subscriptionId": "subid", + "$filter": "$filter=name.value eq 'Storage'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Bytes", + "quotaPeriod": "P1D", + "limit": 10737418240, + "currentValue": 0, + "name": { + "value": "Storage", + "localizedValue": "Storage" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphAPIComputeServiceCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphAPIComputeServiceCreate.json new file mode 100644 index 000000000000..be4b308d060a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphAPIComputeServiceCreate.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "serviceName": "GraphAPICompute", + "createUpdateParameters": { + "properties": { + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "GraphAPICompute" + } + } + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/GraphAPICompute", + "name": "GraphAPICompute", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "GraphAPICompute", + "graphApiComputeEndpoint": "https://graphAPICompute.gremlin.cosmos.windows-int.net/", + "locations": [ + { + "name": "GraphAPICompute-westus2", + "location": "West US 2", + "status": "Running", + "graphApiComputeEndpoint": "https://graphAPICompute-westus.gremlin.cosmos.windows-int.net/" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphAPIComputeServiceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphAPIComputeServiceDelete.json new file mode 100644 index 000000000000..bb9d37be4526 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphAPIComputeServiceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "serviceName": "GraphAPICompute" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphAPIComputeServiceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphAPIComputeServiceGet.json new file mode 100644 index 000000000000..a56e50365030 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphAPIComputeServiceGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "serviceName": "GraphAPICompute" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/GraphAPICompute", + "name": "GraphAPICompute", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "GraphAPICompute", + "graphApiComputeEndpoint": "https://graphAPICompute.gremlin.cosmos.windows-int.net/", + "locations": [ + { + "name": "GraphAPICompute-westus2", + "location": "West US 2", + "status": "Running", + "graphApiComputeEndpoint": "https://graphAPICompute-westus.gremlin.cosmos.windows-int.net/" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceCreateUpdate.json new file mode 100644 index 000000000000..246576780fd7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceCreateUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "graphName": "graphName", + "createUpdateGraphParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "graphName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/graphs/graphName", + "name": "graphName", + "type": "Microsoft.DocumentDB/databaseAccounts/graphs", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "graphName" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceDelete.json new file mode 100644 index 000000000000..8b1b0a0125aa --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "graphName": "graphName" + }, + "responses": { + "204": {}, + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceGet.json new file mode 100644 index 000000000000..837cb0a7051e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/graphs/graphName", + "name": "graphName", + "type": "Microsoft.DocumentDB/databaseAccounts/graphs", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "graphName" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceList.json new file mode 100644 index 000000000000..4f7b377ebb5c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGraphResourceList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/graphs/graphName", + "name": "graphName", + "type": "Microsoft.DocumentDB/databaseAccounts/graphs", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "graphName" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseCreateUpdate.json new file mode 100644 index 000000000000..cbcaabddd880 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseCreateUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "createUpdateGremlinDatabaseParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseDelete.json new file mode 100644 index 000000000000..61f3516fad3b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseGet.json new file mode 100644 index 000000000000..45da9f80e084 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseList.json new file mode 100644 index 000000000000..d66d60687583 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json new file mode 100644 index 000000000000..ffd50aad863a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json new file mode 100644 index 000000000000..7d6a6114ef4a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseThroughputGet.json new file mode 100644 index 000000000000..6446a11cde7e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseThroughputGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseThroughputUpdate.json new file mode 100644 index 000000000000..bdf306280a39 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinDatabaseThroughputUpdate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphBackupInformation.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphBackupInformation.json new file mode 100644 index 000000000000..c037997e70a9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphBackupInformation.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "graphName": "graphName", + "location": { + "location": "North Europe" + } + }, + "responses": { + "200": { + "body": { + "continuousBackupInformation": { + "latestRestorableTimestamp": "2021-02-05T02:40:50Z" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphCreateUpdate.json new file mode 100644 index 000000000000..30674ffed449 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphCreateUpdate.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName", + "createUpdateGremlinGraphParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "graphName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/gremlinGraphs/graphName", + "name": "graphName", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/gremlinGraphs", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "graphName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphDelete.json new file mode 100644 index 000000000000..5dd09b07036f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphGet.json new file mode 100644 index 000000000000..c17647018bd5 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphGet.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "id": "graphName", + "name": "graphName", + "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs", + "properties": { + "resource": { + "id": "graphName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphList.json new file mode 100644 index 000000000000..161671b77668 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphList.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "testgrf", + "name": "testgrf", + "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs", + "properties": { + "resource": { + "id": "testgrf", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphMigrateToAutoscale.json new file mode 100644 index 000000000000..f473eabb0947 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphMigrateToAutoscale.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json new file mode 100644 index 000000000000..76ee31de430b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphThroughputGet.json new file mode 100644 index 000000000000..67f5a532808c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphThroughputGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/gremlinGraphs/graphName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphThroughputUpdate.json new file mode 100644 index 000000000000..b0b0c27544ea --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBGremlinGraphThroughputUpdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/gremlinGraphs/graphName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBLocationGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBLocationGet.json new file mode 100644 index 000000000000..b8bd61a5a3ae --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBLocationGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus", + "type": "Microsoft.DocumentDB/locations", + "name": "westus", + "properties": { + "supportsAvailabilityZone": true, + "isResidencyRestricted": true, + "backupStorageRedundancies": [ + "Local", + "Geo" + ], + "isSubscriptionRegionAccessAllowedForRegular": true, + "isSubscriptionRegionAccessAllowedForAz": true, + "status": "Online" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBLocationList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBLocationList.json new file mode 100644 index 000000000000..08dacb6ed251 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBLocationList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus", + "type": "Microsoft.DocumentDB/locations", + "name": "westus", + "properties": { + "supportsAvailabilityZone": false, + "isResidencyRestricted": false, + "backupStorageRedundancies": [ + "Local", + "Geo" + ], + "isSubscriptionRegionAccessAllowedForRegular": true, + "isSubscriptionRegionAccessAllowedForAz": false, + "status": "Online" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/centralus", + "type": "Microsoft.DocumentDB/locations", + "name": "centralus", + "properties": { + "supportsAvailabilityZone": true, + "isResidencyRestricted": false, + "backupStorageRedundancies": [ + "Zone", + "Geo" + ], + "isSubscriptionRegionAccessAllowedForRegular": false, + "isSubscriptionRegionAccessAllowedForAz": true, + "status": "Online" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraBackup.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraBackup.json new file mode 100644 index 000000000000..51391619925f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraBackup.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod", + "backupId": "1611250348" + }, + "responses": { + "200": { + "body": { + "backupId": "2517222704776158383", + "backupState": "Succeeded", + "backupStartTimestamp": "2023-03-28T19:05:22.3841617+00:00", + "backupStopTimestamp": "2023-03-28T19:05:22.3841617+00:00", + "backupExpiryTimestamp": "2023-03-28T20:05:22.3841617+00:00" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraBackupsList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraBackupsList.json new file mode 100644 index 000000000000..4eb0c5fe3043 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraBackupsList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "backupId": "2517222701827037570", + "backupState": "Initiated", + "backupStartTimestamp": "2023-03-28T19:10:17.2962429+00:00", + "backupExpiryTimestamp": "2023-03-28T20:10:17.2962429+00:00" + }, + { + "backupId": "2517222704776158382", + "backupState": "InProgress", + "backupStartTimestamp": "2023-03-28T19:05:22.3841617+00:00", + "backupExpiryTimestamp": "2023-03-28T20:05:22.3841617+00:00" + }, + { + "backupId": "2517222704776158383", + "backupState": "Succeeded", + "backupStartTimestamp": "2023-03-28T19:05:22.3841617+00:00", + "backupStopTimestamp": "2023-03-28T19:05:22.3841617+00:00", + "backupExpiryTimestamp": "2023-03-28T20:05:22.3841617+00:00" + }, + { + "backupId": "2517222704776158384", + "backupState": "Failed", + "backupStartTimestamp": "2023-03-28T19:05:22.3841617+00:00", + "backupStopTimestamp": "2023-03-28T19:05:22.3841617+00:00", + "backupExpiryTimestamp": "2023-03-28T20:05:22.3841617+00:00" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterCreate.json new file mode 100644 index 000000000000..c155aa5ad854 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterCreate.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod", + "body": { + "location": "West US", + "tags": {}, + "properties": { + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "initialCassandraAdminPassword": "mypassword", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + }, + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "gossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterDeallocate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterDeallocate.json new file mode 100644 index 000000000000..4c7681808da1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterDeallocate.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterDelete.json new file mode 100644 index 000000000000..6d428d8d7fb0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterGet.json new file mode 100644 index 000000000000..e0762c9925be --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterGet.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + }, + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "gossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterListByResourceGroup.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterListByResourceGroup.json new file mode 100644 index 000000000000..875a3c7a64b1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterListByResourceGroup.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + }, + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "gossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterListBySubscription.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterListBySubscription.json new file mode 100644 index 000000000000..3fb81dbc0c8e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterListBySubscription.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/cassandraClusters", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + }, + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "gossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterPatch.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterPatch.json new file mode 100644 index 000000000000..cea70c1f6b95 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterPatch.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod", + "body": { + "tags": { + "owner": "mike" + }, + "properties": { + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "hoursBetweenBackups": 12, + "authenticationMethod": "None" + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2024-02-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": { + "owner": "mike" + }, + "properties": { + "provisioningState": "Updating", + "delegatedManagementSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + }, + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "gossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "delegatedManagementSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + }, + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "gossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterStart.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterStart.json new file mode 100644 index 000000000000..a3b378441529 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraClusterStart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westeurope/operationResults/1d4397b9-0453-43b6-bccd-d9cea304f297?api-version=2021-10-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommand.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommand.json new file mode 100644 index 000000000000..775a04fee840 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommand.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod", + "body": { + "command": "nodetool", + "arguments": { + "status": "" + }, + "host": "10.0.1.12" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westeurope/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2024-02-15-preview" + }, + "body": { + "commandOutput": "Datacenter: datacenter1\n=======================\n" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommandAsync.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommandAsync.json new file mode 100644 index 000000000000..840a95d757c5 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommandAsync.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod", + "body": { + "command": "nodetool", + "arguments": { + "status": "" + }, + "host": "10.0.1.12" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westeurope/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2023-03-15-preview", + "x-ms-request-id": "318653d0-3da5-4814-b8f6-429f2af0b2a4" + } + }, + "200": { + "body": { + "command": "nodetool", + "outputFile": "301fc7c1-397f-4e4a-89db-478f61f89d67", + "arguments": { + "status": "" + }, + "host": "10.0.1.12", + "isAdmin": false, + "readWrite": false, + "cassandraStopStart": false + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommandResult.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommandResult.json new file mode 100644 index 000000000000..747fec7fc986 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommandResult.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod", + "commandId": "318653d0-3da5-4814-b8f6-429f2af0b2a4" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westeurope/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2023-03-15-preview", + "x-ms-request-id": "318653d0-3da5-4814-b8f6-429f2af0b2a4" + }, + "body": { + "value": [ + { + "command": "nodetool", + "outputFile": "318653d0-3da5-4814-b8f6-429f2af0b2a4", + "arguments": { + "status": "" + }, + "host": "10.0.1.12", + "isAdmin": false, + "readWrite": false, + "cassandraStopStart": false, + "result": "{\"exitCode\":0, \"CommandOutput\":\"RESULT\"}" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommandResultList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommandResultList.json new file mode 100644 index 000000000000..d9b555421e31 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraCommandResultList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod", + "commandId": "all" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westeurope/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2023-03-15-preview", + "x-ms-request-id": "318653d0-3da5-4814-b8f6-429f2af0b2a4" + }, + "body": { + "value": [ + { + "command": "nodetool", + "outputFile": "318653d0-3da5-4814-b8f6-429f2af0b2a4", + "arguments": { + "status": "" + }, + "host": "10.0.1.12", + "isAdmin": false, + "readWrite": true, + "cassandraStopStart": false, + "result": "{\"exitCode\":0, \"CommandOutput\":\"RESULT\"}" + }, + { + "command": "get-cassandra-yaml", + "outputFile": "314g6hd0-wvhn-3fds-2svb-6yhd2af02dvg", + "arguments": { + "status": "" + }, + "host": "10.0.1.12", + "isAdmin": false, + "readWrite": false, + "cassandraStopStart": false, + "result": "{\"exitCode\":0, \"CommandOutput\":\"yaml setting result.\"}" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterCreate.json new file mode 100644 index 000000000000..c0a3275be158 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterCreate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod", + "dataCenterName": "dc1", + "body": { + "properties": { + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1-subnet", + "nodeCount": 9, + "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1", + "name": "dc1", + "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters", + "properties": { + "provisioningState": "Succeeded", + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1", + "nodeCount": 9, + "seedNodes": [ + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1", + "name": "dc1", + "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters", + "properties": { + "provisioningState": "Creating", + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1", + "nodeCount": 9, + "seedNodes": [] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterDelete.json new file mode 100644 index 000000000000..45731008be43 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod", + "dataCenterName": "dc1" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterGet.json new file mode 100644 index 000000000000..b0fdcc417ea2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod", + "dataCenterName": "dc1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1", + "name": "dc1", + "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters", + "properties": { + "provisioningState": "Succeeded", + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1", + "nodeCount": 9, + "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=", + "seedNodes": [ + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterList.json new file mode 100644 index 000000000000..f90e1aee7b4a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters", + "name": "dc1", + "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters", + "properties": { + "provisioningState": "Succeeded", + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1", + "nodeCount": 9, + "seedNodes": [ + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterPatch.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterPatch.json new file mode 100644 index 000000000000..03d3e252d714 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraDataCenterPatch.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod", + "dataCenterName": "dc1", + "body": { + "properties": { + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1-subnet", + "nodeCount": 9, + "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=" + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus2/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2024-02-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1", + "name": "dc1", + "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters", + "properties": { + "provisioningState": "Updating", + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1", + "nodeCount": 9, + "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=", + "seedNodes": [ + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1", + "name": "dc1", + "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters", + "properties": { + "provisioningState": "Succeeded", + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1", + "nodeCount": 9, + "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=", + "seedNodes": [ + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraListCommand.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraListCommand.json new file mode 100644 index 000000000000..90f35dd932de --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraListCommand.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "command": "nodetool", + "commandId": "1234", + "status": "Enqueued", + "arguments": { + "status": "" + }, + "host": "10.0.1.12", + "readWrite": true, + "cassandraStopStart": false + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraStatus.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraStatus.json new file mode 100644 index 000000000000..748e71d0313c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBManagedCassandraStatus.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2024-02-15-preview", + "clusterName": "cassandra-prod" + }, + "responses": { + "200": { + "body": { + "eTag": "A350A2CE7E91B6D5A102A5E5EC222B882D981092", + "reaperStatus": { + "healthy": true, + "repairRunIds": {}, + "repairSchedules": { + "00000000-0000-0001-0000-000000000000": "ACTIVE" + } + }, + "connectionErrors": [], + "dataCenters": [ + { + "name": "cassandra-westus2-vmss", + "seedNodes": [ + "10.0.8.10", + "10.0.8.11", + "10.0.8.12" + ], + "nodes": [ + { + "address": "10.0.8.10", + "state": "Normal", + "status": "Up", + "cassandraProcessStatus": "Running", + "load": "84.61 MiB", + "tokens": [ + "-7785254003841681178", + "-6756518164561476165", + "-4269720020504480060", + "-2697657908817852783", + "-2622387897201218249", + "-2177258200443022948", + "-129203941752875603", + "1738406920822650025", + "2598053056312400240", + "3227346424117996872", + "3644347038875498376", + "4823546474906050895", + "5293156680707616627", + "5485806686603256557", + "6250058817756969464", + "7991328665766267709" + ], + "size": 16, + "hostID": "8ccc00a7-9e22-4ac2-aa63-e5327aa0dc51", + "rack": "rack1", + "timestamp": "10/05/2021, 14:35:20.028", + "diskUsedKB": 749836, + "diskFreeKB": 1001260056, + "memoryUsedKB": 11061032, + "memoryBuffersAndCachedKB": 10817580, + "memoryFreeKB": 35731832, + "memoryTotalKB": 57610444, + "cpuUsage": 0.9 + }, + { + "address": "10.0.8.11", + "state": "Normal", + "status": "Up", + "cassandraProcessStatus": "Running", + "load": "59.67 MiB", + "tokens": [ + "-8726238055665903210", + "-6687985003871487470", + "-5269140854976433359", + "-3989177686905645288", + "-3957362495277148220", + "-2539287458896988944", + "-2460716365393303466", + "-1848370030729221440", + "137707733677015122", + "579467328507000597", + "1698264534774619627", + "1904235159942090722", + "3312208865519999146", + "4035940456270983993", + "4412314431151736777", + "8232565668795426078" + ], + "size": 16, + "hostID": "14092117-4f77-4ec0-8984-c5b860b88a47", + "rack": "rack2", + "timestamp": "10/05/2021, 14:35:20.028", + "diskUsedKB": 726864, + "diskFreeKB": 1001283028, + "memoryUsedKB": 11055676, + "memoryBuffersAndCachedKB": 10691520, + "memoryFreeKB": 35863248, + "memoryTotalKB": 57610444, + "cpuUsage": 1.2 + }, + { + "address": "10.0.8.12", + "state": "Normal", + "status": "Up", + "cassandraProcessStatus": "Running", + "load": "93.2 MiB", + "tokens": [ + "-5679481051867296621", + "-4574115287969297989", + "-3444578133211470522", + "-2755931580714972271", + "-2304431590844389550", + "-1961946736975068713", + "-940120277889446704", + "554469308917912318", + "1030447162050118004", + "2745632329542596589", + "4564547712926446283", + "5185613478135944116", + "7280237939830623824", + "7504213835759531710", + "7631994478195429959", + "8139769477321226157" + ], + "size": 16, + "hostID": "e16ada14-39db-462b-9f9e-5b5f6beb8bbd", + "rack": "rack3", + "timestamp": "10/05/2021, 14:35:20.028", + "diskUsedKB": 757540, + "diskFreeKB": 1001252352, + "memoryUsedKB": 11051608, + "memoryBuffersAndCachedKB": 10453856, + "memoryFreeKB": 36104980, + "memoryTotalKB": 57610444, + "cpuUsage": 0.4, + "isLatestModel": true + } + ] + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMaterializedViewsBuilderServiceCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMaterializedViewsBuilderServiceCreate.json new file mode 100644 index 000000000000..751c529d1d05 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMaterializedViewsBuilderServiceCreate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "serviceName": "MaterializedViewsBuilder", + "createUpdateParameters": { + "properties": { + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "MaterializedViewsBuilder" + } + } + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/MaterializedViewsBuilder", + "name": "MaterializedViewsBuilder", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "MaterializedViewsBuilder", + "locations": [ + { + "name": "MaterializedViewsBuilder-westus2", + "location": "West US 2", + "status": "Running" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMaterializedViewsBuilderServiceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMaterializedViewsBuilderServiceDelete.json new file mode 100644 index 000000000000..3fb708e7e8fc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMaterializedViewsBuilderServiceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "serviceName": "MaterializedViewsBuilder" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMaterializedViewsBuilderServiceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMaterializedViewsBuilderServiceGet.json new file mode 100644 index 000000000000..777f9a9bf6da --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMaterializedViewsBuilderServiceGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "serviceName": "MaterializedViewsBuilder" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/MaterializedViewsBuilder", + "name": "MaterializedViewsBuilder", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "MaterializedViewsBuilder", + "locations": [ + { + "name": "MaterializedViewsBuilder-westus2", + "location": "West US 2", + "status": "Running" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionBackupInformation.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionBackupInformation.json new file mode 100644 index 000000000000..8a9634ef55a9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionBackupInformation.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "collectionName": "collectionName", + "location": { + "location": "North Europe" + } + }, + "responses": { + "200": { + "body": { + "continuousBackupInformation": { + "latestRestorableTimestamp": "2021-02-05T02:40:50Z" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionCreateUpdate.json new file mode 100644 index 000000000000..8e3945f3b5e5 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionCreateUpdate.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName", + "createUpdateMongoDBCollectionParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "collectionName", + "indexes": [ + { + "key": { + "keys": [ + "_ts" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + }, + { + "key": { + "keys": [ + "_id" + ] + } + } + ], + "shardKey": { + "testKey": "Hash" + }, + "analyticalStorageTtl": 500 + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName", + "name": "collectionName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "collectionName", + "indexes": [ + { + "key": { + "keys": [ + "_ts" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + }, + { + "key": { + "keys": [ + "_id" + ] + } + } + ], + "shardKey": { + "testKey": "Hash" + }, + "analyticalStorageTtl": 500 + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionDelete.json new file mode 100644 index 000000000000..f63286379df7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionGet.json new file mode 100644 index 000000000000..7a9c9b1b549d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionGet.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName", + "name": "collectionName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testcoll", + "indexes": [ + { + "key": { + "keys": [ + "testKey" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + } + ], + "shardKey": { + "testKey": "Hash" + }, + "analyticalStorageTtl": 500, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionList.json new file mode 100644 index 000000000000..2d449e829127 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName", + "name": "collectionName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testcoll", + "indexes": [ + { + "key": { + "keys": [ + "testKey" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + } + ], + "shardKey": { + "testKey": "Hash" + }, + "analyticalStorageTtl": 500 + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json new file mode 100644 index 000000000000..fac47acfe834 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json new file mode 100644 index 000000000000..562731009870 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionPartitionMerge.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionPartitionMerge.json new file mode 100644 index 000000000000..501b56c3309d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionPartitionMerge.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "collectionName": "collectionName", + "mergeParameters": { + "isDryRun": false + } + }, + "responses": { + "200": { + "body": { + "physicalPartitionStorageInfoCollection": [ + { + "storageInKB": 333.0, + "id": "0" + }, + { + "storageInKB": 305.0, + "id": "1" + }, + { + "storageInKB": 368.0, + "id": "177" + }, + { + "storageInKB": 96313.0, + "id": "178" + }, + { + "storageInKB": 194.0, + "id": "5" + }, + { + "storageInKB": 331.0, + "id": "6" + }, + { + "storageInKB": 384.0, + "id": "7" + }, + { + "storageInKB": 246.0, + "id": "8" + } + ] + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionRedistributeThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionRedistributeThroughput.json new file mode 100644 index 000000000000..70cdf6c714a4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionRedistributeThroughput.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName", + "redistributeThroughputParameters": { + "properties": { + "resource": { + "throughputPolicy": "custom", + "targetPhysicalPartitionThroughputInfo": [ + { + "id": "0", + "throughput": 5000 + }, + { + "id": "1", + "throughput": 5000 + } + ], + "sourcePhysicalPartitionThroughputInfo": [ + { + "id": "2", + "throughput": 5000 + }, + { + "id": "3" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "physicalPartitionThroughputInfo": [ + { + "id": "0", + "throughput": 5000 + }, + { + "id": "1", + "throughput": 5000 + }, + { + "id": "2", + "throughput": 5000 + }, + { + "id": "3", + "throughput": 3000 + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionRestore.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionRestore.json new file mode 100644 index 000000000000..df9315563947 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionRestore.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName", + "createUpdateMongoDBCollectionParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "collectionName", + "createMode": "Restore", + "restoreParameters": { + "restoreTimestampInUtc": "2022-07-20T18:28:00Z", + "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/restorableDatabaseAccountId", + "restoreWithTtlDisabled": false + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName", + "name": "collectionName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "collectionName", + "indexes": [ + { + "key": { + "keys": [ + "_ts" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + }, + { + "key": { + "keys": [ + "_id" + ] + } + } + ], + "shardKey": { + "testKey": "Hash" + }, + "analyticalStorageTtl": 500 + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionRetrieveThroughputDistribution.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionRetrieveThroughputDistribution.json new file mode 100644 index 000000000000..3df74ac66305 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionRetrieveThroughputDistribution.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName", + "retrieveThroughputParameters": { + "properties": { + "resource": { + "physicalPartitionIds": [ + { + "id": "0" + }, + { + "id": "1" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "physicalPartitionThroughputInfo": [ + { + "id": "0", + "throughput": 5000 + }, + { + "id": "1", + "throughput": 5000 + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionThroughputGet.json new file mode 100644 index 000000000000..b9b1112fce65 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionThroughputGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionThroughputUpdate.json new file mode 100644 index 000000000000..c07e51093d75 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBCollectionThroughputUpdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseCreateUpdate.json new file mode 100644 index 000000000000..d456040a859c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseCreateUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "createUpdateMongoDBDatabaseParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "updatedDatabaseName" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseDelete.json new file mode 100644 index 000000000000..61f3516fad3b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseGet.json new file mode 100644 index 000000000000..18ee49bd89c3 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseList.json new file mode 100644 index 000000000000..bddd7362496d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json new file mode 100644 index 000000000000..ffd50aad863a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json new file mode 100644 index 000000000000..7d6a6114ef4a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabasePartitionMerge.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabasePartitionMerge.json new file mode 100644 index 000000000000..04c612d790ee --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabasePartitionMerge.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "mergeParameters": { + "isDryRun": false + } + }, + "responses": { + "200": { + "body": { + "physicalPartitionStorageInfoCollection": [ + { + "storageInKB": 333.0, + "id": "0" + }, + { + "storageInKB": 305.0, + "id": "1" + }, + { + "storageInKB": 368.0, + "id": "177" + }, + { + "storageInKB": 96313.0, + "id": "178" + }, + { + "storageInKB": 194.0, + "id": "5" + }, + { + "storageInKB": 331.0, + "id": "6" + }, + { + "storageInKB": 384.0, + "id": "7" + }, + { + "storageInKB": 246.0, + "id": "8" + } + ] + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseRedistributeThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseRedistributeThroughput.json new file mode 100644 index 000000000000..0897e7f93569 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseRedistributeThroughput.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "redistributeThroughputParameters": { + "properties": { + "resource": { + "throughputPolicy": "custom", + "targetPhysicalPartitionThroughputInfo": [ + { + "id": "0", + "throughput": 5000 + }, + { + "id": "1", + "throughput": 5000 + } + ], + "sourcePhysicalPartitionThroughputInfo": [ + { + "id": "2", + "throughput": 5000 + }, + { + "id": "3" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "physicalPartitionThroughputInfo": [ + { + "id": "0", + "throughput": 5000 + }, + { + "id": "1", + "throughput": 5000 + }, + { + "id": "2", + "throughput": 5000 + }, + { + "id": "3", + "throughput": 3000 + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseRestore.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseRestore.json new file mode 100644 index 000000000000..dd15bd931880 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseRestore.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "createUpdateMongoDBDatabaseParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "createMode": "Restore", + "restoreParameters": { + "restoreTimestampInUtc": "2022-07-20T18:28:00Z", + "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/restorableDatabaseAccountId", + "restoreWithTtlDisabled": false + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "updatedDatabaseName" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseRetrieveThroughputDistribution.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseRetrieveThroughputDistribution.json new file mode 100644 index 000000000000..6908018e0d36 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseRetrieveThroughputDistribution.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "retrieveThroughputParameters": { + "properties": { + "resource": { + "physicalPartitionIds": [ + { + "id": "0" + }, + { + "id": "1" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "physicalPartitionThroughputInfo": [ + { + "id": "0", + "throughput": 5000 + }, + { + "id": "1", + "throughput": 5000 + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseThroughputGet.json new file mode 100644 index 000000000000..edb1ba971766 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseThroughputGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json new file mode 100644 index 000000000000..d4958734a504 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json new file mode 100644 index 000000000000..520f0178f79f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "mongoRoleDefinitionId": "myMongoRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview", + "createUpdateMongoRoleDefinitionParameters": { + "properties": { + "roleName": "myRoleName", + "databaseName": "sales", + "privileges": [ + { + "resource": { + "db": "sales", + "collection": "sales" + }, + "actions": [ + "insert", + "find" + ] + } + ], + "roles": [ + { + "role": "myInheritedRole", + "db": "sales" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbRoleDefinitions/myMongoDbRoleDefinitionId", + "name": "myMongoDbRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/mongoDbRoleDefinitionId", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "databaseName": "sales", + "privileges": [ + { + "resource": { + "db": "sales", + "collection": "coll" + }, + "actions": [ + "find", + "insert" + ] + } + ], + "roles": [ + { + "db": "sales", + "role": "myReadRole" + } + ] + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionDelete.json new file mode 100644 index 000000000000..93c587b5beb1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "mongoRoleDefinitionId": "myMongoRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json new file mode 100644 index 000000000000..fd5438fc2635 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "mongoRoleDefinitionId": "myMongoRoleDefinitionId", + "databaseName": "sales", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbRoleDefinitions/myMongoDbRoleDefinitionId", + "name": "myMongoRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "databaseName": "sales", + "privileges": [ + { + "resource": { + "db": "sales", + "collection": "coll" + }, + "actions": [ + "find", + "insert" + ] + } + ], + "roles": [ + { + "db": "sales", + "role": "myReadRole" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionList.json new file mode 100644 index 000000000000..d9f7e4dbbc5c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBRoleDefinitionList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbRoleDefinitions/myRoleDefinitionId", + "name": "myRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "databaseName": "sales", + "privileges": [ + { + "resource": { + "db": "sales", + "collection": "coll" + }, + "actions": [ + "find", + "insert" + ] + } + ], + "roles": [ + { + "db": "sales", + "role": "myReadRole" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionCreateUpdate.json new file mode 100644 index 000000000000..d468b6efd33b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionCreateUpdate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "mongoUserDefinitionId": "myMongoUserDefinitionId", + "databaseName": "sales", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview", + "createUpdateMongoUserDefinitionParameters": { + "properties": { + "userName": "myUserName", + "password": "myPassword", + "databaseName": "sales", + "customData": "My custom data", + "roles": [ + { + "role": "myReadRole", + "db": "sales" + } + ], + "mechanisms": "SCRAM-SHA-256" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbUserDefinitions/myUserId", + "name": "myUserName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions", + "properties": { + "userName": "myUserName", + "databaseName": "sales", + "customData": "My custom data", + "roles": [ + { + "db": "sales", + "role": "myReadRole" + } + ], + "mechanisms": "SCRAM-SHA-256" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionDelete.json new file mode 100644 index 000000000000..8c164eb6067b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "mongoUserDefinitionId": "myMongoUserDefinitionId", + "databaseName": "sales", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionGet.json new file mode 100644 index 000000000000..1b2e47b09eb9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "mongoUserDefinitionId": "myMongoUserDefinitionId", + "databaseName": "sales", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbUserDefinitions/myUserId", + "name": "myUserId", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions", + "properties": { + "userName": "myUserName", + "databaseName": "sales", + "customData": "My custom data", + "roles": [ + { + "db": "sales", + "role": "myReadRole" + } + ], + "mechanisms": "SCRAM-SHA-256" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionList.json new file mode 100644 index 000000000000..cf69ed797fc0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBMongoDBUserDefinitionList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbUserDefinitions/myUserId", + "name": "myUserId", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions", + "properties": { + "userName": "myUserName", + "databaseName": "sales", + "customData": "My custom data", + "roles": [ + { + "db": "sales", + "role": "myReadRole" + } + ], + "mechanisms": "SCRAM-SHA-256" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceCreate.json new file mode 100644 index 000000000000..24806ea53806 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceCreate.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default", + "notebookCreateUpdateParameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces", + "properties": { + "notebookServerEndpoint": "endpoint", + "status": "Online" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceDelete.json new file mode 100644 index 000000000000..f106b744ab80 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "notebookWorkspaceName": "default" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceGet.json new file mode 100644 index 000000000000..603e5b3abe02 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces", + "properties": { + "notebookServerEndpoint": "endpoint", + "status": "Online" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceList.json new file mode 100644 index 000000000000..2109869b60b8 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces", + "properties": { + "notebookServerEndpoint": "endpoint", + "status": "Online" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json new file mode 100644 index 000000000000..a981445cc4c7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default" + }, + "responses": { + "200": { + "body": { + "authToken": "auth-token", + "notebookServerEndpoint": "notebook endpoint" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json new file mode 100644 index 000000000000..f0be4abe06f2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceStart.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceStart.json new file mode 100644 index 000000000000..f0be4abe06f2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBNotebookWorkspaceStart.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBOperationsList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBOperationsList.json new file mode 100644 index 000000000000..f7cd03d0ab2f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBOperationsList.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "operationName", + "display": { + "Provider": "providerName", + "Resource": "resourceName", + "Operation": "operationName", + "Description": "description" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPKeyRangeIdGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPKeyRangeIdGetMetrics.json new file mode 100644 index 000000000000..818b3cb874bd --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPKeyRangeIdGetMetrics.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "partitionKeyRangeId": "0", + "$filter": "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT1M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T23:58:55.2780000Z", + "unit": "Count", + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:54:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:55:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:56:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:57:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "maximum": 5 + } + ], + "name": { + "value": "Max RUs Per Second", + "localizedValue": "Max RUs Per Second" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPKeyRangeIdRegionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPKeyRangeIdRegionGetMetrics.json new file mode 100644 index 000000000000..92fb33beae2c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPKeyRangeIdRegionGetMetrics.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "partitionKeyRangeId": "0", + "region": "West US", + "$filter": "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT1M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T23:58:55.2780000Z", + "unit": "Count", + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:54:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:55:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:56:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:57:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "maximum": 5 + } + ], + "name": { + "value": "Max RUs Per Second", + "localizedValue": "Max RUs Per Second" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPercentileGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPercentileGetMetrics.json new file mode 100644 index 000000000000..cd9f6b2081fb --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPercentileGetMetrics.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "$filter": "$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West Central US-T-East US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-East US" + } + }, + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West Central US-T-West US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-West US" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPercentileSourceTargetGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPercentileSourceTargetGetMetrics.json new file mode 100644 index 000000000000..b9a410fc96ac --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPercentileSourceTargetGetMetrics.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "sourceRegion": "West Central US", + "targetRegion": "East US", + "$filter": "$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West Central US-T-East US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-East US" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPercentileTargetGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPercentileTargetGetMetrics.json new file mode 100644 index 000000000000..edc0977c6ab6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPercentileTargetGetMetrics.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "targetRegion": "East US", + "$filter": "$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West Central US-T-East US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-East US" + } + }, + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West US-T-East US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-West US" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..003b85ee8315 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "api-version": "2024-02-15-preview", + "privateEndpointConnectionName": "privateEndpointConnectionName" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..fe3898c8cb03 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "api-version": "2024-02-15-preview", + "privateEndpointConnectionName": "privateEndpointConnectionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.DocumentDb/databaseAccounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + }, + "groupId": "Sql", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionListGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionListGet.json new file mode 100644 index 000000000000..3e778f01a760 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionListGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.DocumentDb/databaseAccounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + }, + "groupId": "Sql", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName2", + "name": "privateEndpointConnectionName", + "type": "Microsoft.DocumentDb/databaseAccounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + }, + "groupId": "Sql", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..477fe273fff7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateEndpointConnectionUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "api-version": "2024-02-15-preview", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.DocumentDb/databaseAccounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + }, + "groupId": "Sql", + "provisioningState": "Succeeded" + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateLinkResourceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateLinkResourceGet.json new file mode 100644 index 000000000000..c7412c006678 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateLinkResourceGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "api-version": "2024-02-15-preview", + "groupName": "sql" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateLinkResources/sql", + "name": "sql", + "type": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources", + "properties": { + "groupId": "sql", + "requiredMembers": [ + "ddb1", + "ddb1-westus" + ], + "requiredZoneNames": [ + "privatelink.documents.azure.net" + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateLinkResourceListGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateLinkResourceListGet.json new file mode 100644 index 000000000000..ecd32ec4940f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBPrivateLinkResourceListGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateLinkResources/sql", + "name": "sql", + "type": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources", + "properties": { + "groupId": "sql", + "requiredMembers": [ + "ddb1", + "ddb1-westus" + ], + "requiredZoneNames": [ + "privatelink.documents.azure.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRegionCollectionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRegionCollectionGetMetrics.json new file mode 100644 index 000000000000..4e0ea875830c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRegionCollectionGetMetrics.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "region": "North Europe", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableDatabaseAccountGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableDatabaseAccountGet.json new file mode 100644 index 000000000000..20de6cd1f284 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableDatabaseAccountGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "location": "West US", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d", + "name": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "location": "West US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb1", + "creationTime": "2020-04-11T21:56:15Z", + "deletionTime": "2021-03-12T22:05:09Z", + "oldestRestorableTime": "2021-03-01T22:05:09Z", + "apiType": "Sql", + "restorableLocations": [ + { + "locationName": "South Central US", + "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" + }, + { + "locationName": "West US", + "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", + "creationTime": "2020-10-30T21:13:10Z" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableDatabaseAccountList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableDatabaseAccountList.json new file mode 100644 index 000000000000..6d13afc5007f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableDatabaseAccountList.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "location": "West US" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d", + "name": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "location": "West US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb1", + "creationTime": "2020-04-11T21:56:15Z", + "deletionTime": "2021-03-12T22:05:09Z", + "oldestRestorableTime": "2021-03-01T22:05:09Z", + "apiType": "Sql", + "restorableLocations": [ + { + "locationName": "South Central US", + "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" + }, + { + "locationName": "West US", + "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", + "creationTime": "2020-10-30T21:13:10Z" + } + ] + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/4f9e6ace-ac7a-446c-98bc-194c502a06b4", + "name": "4f9e6ace-ac7a-446c-98bc-194c502a06b4", + "location": "West US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb2", + "creationTime": "2020-05-01T08:05:18Z", + "oldestRestorableTime": "2021-03-01T22:05:09Z", + "apiType": "Sql", + "restorableLocations": [ + { + "locationName": "South Central US", + "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" + }, + { + "locationName": "West US", + "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", + "creationTime": "2020-10-30T21:13:10Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json new file mode 100644 index 000000000000..e170eb495bb7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d", + "name": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "location": "West US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb1", + "creationTime": "2020-04-11T21:56:15Z", + "deletionTime": "2021-03-12T22:05:09Z", + "oldestRestorableTime": "2021-03-01T22:05:09Z", + "apiType": "Sql", + "restorableLocations": [ + { + "locationName": "South Central US", + "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" + }, + { + "locationName": "West US", + "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", + "creationTime": "2020-10-30T21:13:10Z" + } + ] + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/4f9e6ace-ac7a-446c-98bc-194c502a06b4", + "name": "4f9e6ace-ac7a-446c-98bc-194c502a06b4", + "location": "East US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb2", + "creationTime": "2020-05-01T08:05:18Z", + "oldestRestorableTime": "2021-03-01T22:05:09Z", + "apiType": "Sql", + "restorableLocations": [ + { + "locationName": "South Central US", + "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" + }, + { + "locationName": "West US", + "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", + "creationTime": "2020-10-30T21:13:10Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableGremlinDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableGremlinDatabaseList.json new file mode 100644 index 000000000000..da079d42fa16 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableGremlinDatabaseList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableGremlinDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinDatabases", + "name": "59c21367-b98b-4a8e-abb7-b6f46600decc", + "properties": { + "resource": { + "_rid": "DLB14gAAAA==", + "eventTimestamp": "2020-09-02T19:45:03Z", + "ownerId": "Database1", + "ownerResourceId": "PD5DALigDgw=", + "operationType": "Create", + "canUndelete": "invalid" + } + } + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinDatabases", + "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257", + "properties": { + "resource": { + "_rid": "ESXNLAAAAA==", + "eventTimestamp": "2020-09-02T19:53:42Z", + "ownerId": "Database1", + "ownerResourceId": "PD5DALigDgw=", + "operationType": "Delete", + "canUndelete": "notRestorable", + "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account." + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableGremlinGraphList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableGremlinGraphList.json new file mode 100644 index 000000000000..aba8faf9ea5b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableGremlinGraphList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "location": "WestUS", + "instanceId": "98a570f2-63db-4117-91f0-366327b7b353", + "restorableGremlinDatabaseRid": "PD5DALigDgw=" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableGraphs/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGraphs", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Graph1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Create", + "canUndelete": "invalid" + } + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableGraphs/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGraphs", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Graph1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Delete", + "canUndelete": "notRestorable", + "canUndeleteReason": "Individual shared database collections restore is not supported. Please restore shared database to restore its collections that share the throughput." + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableGremlinResourceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableGremlinResourceList.json new file mode 100644 index 000000000000..05f38a1b8cc9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableGremlinResourceList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "restoreLocation": "WestUS", + "restoreTimestampInUtc": "06/01/2022 4:56" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database1", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources", + "name": "Database1", + "databaseName": "Database1", + "graphNames": [ + "Graph1" + ] + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database2", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources", + "name": "Database2", + "databaseName": "Database2", + "graphNames": [ + "Graph1", + "Graph2" + ] + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database3", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources", + "name": "Database3", + "databaseName": "Database3", + "graphNames": [] + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableMongodbCollectionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableMongodbCollectionList.json new file mode 100644 index 000000000000..202b084483e4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableMongodbCollectionList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "location": "WestUS", + "instanceId": "98a570f2-63db-4117-91f0-366327b7b353", + "restorableMongodbDatabaseRid": "PD5DALigDgw=" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableMongodbCollections/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbCollections", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Collection1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Create", + "canUndelete": "invalid" + } + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableMongodbCollections/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbCollections", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Collection1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Delete", + "canUndelete": "notRestorable", + "canUndeleteReason": "Individual shared database collections restore is not supported. Please restore shared database to restore its collections that share the throughput." + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableMongodbDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableMongodbDatabaseList.json new file mode 100644 index 000000000000..fbd891095a57 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableMongodbDatabaseList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableMongodbDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbDatabases", + "name": "59c21367-b98b-4a8e-abb7-b6f46600decc", + "properties": { + "resource": { + "_rid": "DLB14gAAAA==", + "eventTimestamp": "2020-09-02T19:45:03Z", + "ownerId": "Database1", + "ownerResourceId": "PD5DALigDgw=", + "operationType": "Create", + "canUndelete": "invalid" + } + } + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableMongodbDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbDatabases", + "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257", + "properties": { + "resource": { + "_rid": "ESXNLAAAAA==", + "eventTimestamp": "2020-09-02T19:53:42Z", + "ownerId": "Database1", + "ownerResourceId": "PD5DALigDgw=", + "operationType": "Delete", + "canUndelete": "notRestorable", + "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account." + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableMongodbResourceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableMongodbResourceList.json new file mode 100644 index 000000000000..2a0e352251ad --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableMongodbResourceList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "restoreLocation": "WestUS", + "restoreTimestampInUtc": "06/01/2022 4:56" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablemongodbresources/Database1", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablemongodbresources", + "name": "Database1", + "databaseName": "Database1", + "collectionNames": [ + "Collection1" + ] + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablemongodbresources/Database2", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablemongodbresources", + "name": "Database2", + "databaseName": "Database2", + "collectionNames": [ + "Collection1", + "Collection2" + ] + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablemongodbresources/Database3", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablemongodbresources", + "name": "Database3", + "databaseName": "Database3", + "collectionNames": [] + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableSqlContainerList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableSqlContainerList.json new file mode 100644 index 000000000000..d8308103f5e3 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableSqlContainerList.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "location": "WestUS", + "instanceId": "98a570f2-63db-4117-91f0-366327b7b353", + "restorableSqlDatabaseRid": "3fu-hg==" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Container1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Create", + "canUndelete": "invalid", + "container": { + "id": "Container1", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*" + }, + { + "path": "/\"_ts\"/?" + } + ], + "excludedPaths": [ + { + "path": "/\"_etag\"/?" + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/_ts", + "conflictResolutionProcedure": "" + }, + "_rid": "V18LoLrv-qA=", + "_self": "dbs/V18LoA==/colls/V18LoLrv-qA=/", + "_etag": "\"00003e00-0000-0700-0000-5f85338a0000\"" + } + } + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/e85298a1-c631-4726-825e-a7ca092e9098", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers", + "name": "e85298a1-c631-4726-825e-a7ca092e9098", + "properties": { + "resource": { + "_rid": "PrArcgAAAA==", + "eventTimestamp": "2020-10-13T05:03:27Z", + "ownerId": "Container1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Replace", + "canUndelete": "invalid", + "container": { + "id": "Container1", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*" + }, + { + "path": "/\"_ts\"/?" + } + ], + "excludedPaths": [ + { + "path": "/\"_etag\"/?" + } + ] + }, + "defaultTtl": 12345, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/_ts", + "conflictResolutionProcedure": "" + }, + "_rid": "V18LoLrv-qA=", + "_self": "dbs/V18LoA==/colls/V18LoLrv-qA=/", + "_etag": "\"00004400-0000-0700-0000-5f85351f0000\"" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableSqlDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableSqlDatabaseList.json new file mode 100644 index 000000000000..56db8ccfe1ef --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableSqlDatabaseList.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableSqlDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases", + "name": "59c21367-b98b-4a8e-abb7-b6f46600decc", + "properties": { + "resource": { + "_rid": "DLB14gAAAA==", + "eventTimestamp": "2020-09-02T19:45:03Z", + "ownerId": "Database1", + "ownerResourceId": "3fu-hg==", + "operationType": "Create", + "canUndelete": "invalid", + "database": { + "id": "Database1", + "_rid": "3fu-hg==", + "_self": "dbs/3fu-hg==/", + "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"", + "_colls": "colls/", + "_users": "users/" + } + } + } + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases", + "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257", + "properties": { + "resource": { + "_rid": "ESXNLAAAAA==", + "eventTimestamp": "2020-09-02T19:53:42Z", + "ownerId": "Database1", + "ownerResourceId": "3fu-hg==", + "database": { + "id": "Database1", + "_rid": "3fu-hg==", + "_self": "dbs/3fu-hg==/", + "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"", + "_colls": "colls/", + "_users": "users/", + "_ts": 1599075903 + }, + "operationType": "Delete", + "canUndelete": "notRestorable", + "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account." + } + } + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/2c07991b-9c7c-4e85-be68-b18c1f2ff326", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases", + "name": "2c07991b-9c7c-4e85-be68-b18c1f2ff326", + "properties": { + "resource": { + "_rid": "aXFqUQAAAA==", + "eventTimestamp": "2020-09-02T19:53:15Z", + "ownerId": "Database2", + "ownerResourceId": "0SziSg==", + "database": { + "id": "Database2", + "_rid": "0SziSg==", + "_self": "dbs/0SziSg==/", + "_etag": "\"0000ca0a-0000-0700-0000-5f4ff82b0000\"", + "_colls": "colls/", + "_users": "users/" + }, + "operationType": "Create", + "canUndelete": "invalid" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableSqlResourceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableSqlResourceList.json new file mode 100644 index 000000000000..b2d4f6782181 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableSqlResourceList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "restoreLocation": "WestUS", + "restoreTimestampInUtc": "06/01/2022 4:56" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database1", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources", + "name": "Database1", + "databaseName": "Database1", + "collectionNames": [ + "Container1" + ] + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database2", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources", + "name": "Database2", + "databaseName": "Database2", + "collectionNames": [ + "Container1", + "Container2" + ] + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database3", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources", + "name": "Database3", + "databaseName": "Database3", + "collectionNames": [] + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableTableList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableTableList.json new file mode 100644 index 000000000000..e8b26dde63a0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableTableList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "location": "WestUS", + "instanceId": "98a570f2-63db-4117-91f0-366327b7b353" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableTables/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableTables", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Table1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Create", + "canUndelete": "invalid" + } + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableTables/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableTables", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Table1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Delete", + "canUndelete": "notRestorable", + "canUndeleteReason": "Collection with same name already exist as live collection." + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableTableResourceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableTableResourceList.json new file mode 100644 index 000000000000..22cd39b28163 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestorableTableResourceList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "restoreLocation": "WestUS", + "restoreTimestampInUtc": "06/01/2022 4:56" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorabletableresources/table1", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources", + "name": "table1" + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorabletableresources/table2", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources", + "name": "table2" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json new file mode 100644 index 000000000000..3495f4a49e9a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "createUpdateParameters": { + "location": "westus", + "tags": {}, + "kind": "GlobalDocumentDB", + "properties": { + "databaseAccountOfferType": "Standard", + "locations": [ + { + "failoverPriority": 0, + "locationName": "southcentralus", + "isZoneRedundant": false + } + ], + "createMode": "Restore", + "restoreParameters": { + "restoreMode": "PointInTime", + "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc", + "restoreTimestampInUtc": "2021-03-11T22:05:09Z", + "restoreWithTtlDisabled": false, + "databasesToRestore": [ + { + "databaseName": "db1", + "collectionNames": [ + "collection1", + "collection2" + ] + }, + { + "databaseName": "db2", + "collectionNames": [ + "collection3", + "collection4" + ] + } + ], + "sourceBackupLocation": "westus" + }, + "backupPolicy": { + "type": "Continuous", + "continuousModeProperties": { + "tier": "Continuous30Days" + } + }, + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "keyVaultKeyUri": "https://myKeyVault.vault.azure.net", + "enableFreeTier": false, + "apiProperties": { + "serverVersion": "3.2" + }, + "enableAnalyticalStorage": true, + "enableMaterializedViews": false, + "minimalTlsVersion": "Tls" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Initializing", + "ipRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Restore", + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "readLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "locations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "failoverPolicies": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "failoverPriority": 0 + } + ], + "backupPolicy": { + "type": "Continuous", + "continuousModeProperties": { + "tier": "Continuous30Days" + } + }, + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": false, + "minimalTlsVersion": "Tls", + "analyticalStorageConfiguration": null, + "networkAclBypass": "None", + "networkAclBypassResourceIds": [], + "enableMaterializedViews": false, + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + } + } + }, + "systemData": { + "createdAt": "2021-03-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBServicesList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBServicesList.json new file mode 100644 index 000000000000..dd519bea6dfb --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBServicesList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/sqlDedicatedGateway", + "name": "sqlDedicatedGateway", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "SqlDedicatedGateway", + "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway.sqlx.cosmos.windows-int.net/", + "locations": [ + { + "name": "sqlDedicatedGateway-westus2", + "location": "West US 2", + "status": "Running", + "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway-westus.sqlx.cosmos.windows-int.net/" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlClientEncryptionKeyCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlClientEncryptionKeyCreateUpdate.json new file mode 100644 index 000000000000..5f9998cc8324 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlClientEncryptionKeyCreateUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "accountName": "accountName", + "databaseName": "databaseName", + "clientEncryptionKeyName": "cekName", + "createUpdateClientEncryptionKeyParameters": { + "properties": { + "resource": { + "id": "cekName", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "wrappedDataEncryptionKey": "VGhpcyBpcyBhY3R1YWxseSBhbiBhcnJheSBvZiBieXRlcy4gVGhpcyByZXF1ZXN0L3Jlc3BvbnNlIGlzIGJlaW5nIHByZXNlbnRlZCBhcyBhIHN0cmluZyBmb3IgcmVhZGFiaWxpdHkgaW4gdGhlIGV4YW1wbGU=", + "keyWrapMetadata": { + "name": "customerManagedKey", + "type": "AzureKeyVault", + "value": "AzureKeyVault Key URL", + "algorithm": "RSA-OAEP" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlDatabases/databaseName/clientEncryptionKeys/cekName", + "name": "cekName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKey", + "properties": { + "resource": { + "id": "cekName", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "wrappedDataEncryptionKey": "VGhpcyBpcyBhY3R1YWxseSBhbiBhcnJheSBvZiBieXRlcy4gVGhpcyByZXF1ZXN0L3Jlc3BvbnNlIGlzIGJlaW5nIHByZXNlbnRlZCBhcyBhIHN0cmluZyBmb3IgcmVhZGFiaWxpdHkgaW4gdGhlIGV4YW1wbGU=", + "keyWrapMetadata": { + "name": "customerManagedKey", + "type": "AzureKeyVault", + "value": "AzureKeyVault Key URL", + "algorithm": "RSA-OAEP" + }, + "_rid": "tNc4AAAAAAAQkjzWAgAAAA==", + "_ts": 1626425552, + "_etag": "00000000-0000-0000-7a1f-bc0828e801d7" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlClientEncryptionKeyGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlClientEncryptionKeyGet.json new file mode 100644 index 000000000000..2eca33e8cf4e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlClientEncryptionKeyGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "accountName": "accountName", + "databaseName": "databaseName", + "clientEncryptionKeyName": "cekName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlDatabases/databaseName/clientEncryptionKeys/cekName", + "name": "cekName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKey", + "properties": { + "resource": { + "id": "cekName", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "wrappedDataEncryptionKey": "VGhpcyBpcyBhY3R1YWxseSBhbiBhcnJheSBvZiBieXRlcy4gVGhpcyByZXF1ZXN0L3Jlc3BvbnNlIGlzIGJlaW5nIHByZXNlbnRlZCBhcyBhIHN0cmluZyBmb3IgcmVhZGFiaWxpdHkgaW4gdGhlIGV4YW1wbGU=", + "keyWrapMetadata": { + "name": "customerManagedKey", + "type": "AzureKeyVault", + "value": "AzureKeyVault Key URL", + "algorithm": "RSA-OAEP" + }, + "_rid": "tNc4AAAAAAAQkjzWAgAAAA==", + "_ts": 1626425552, + "_etag": "00000000-0000-0000-7a1f-bc0828e801d7" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlClientEncryptionKeysList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlClientEncryptionKeysList.json new file mode 100644 index 000000000000..bcf83d914e38 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlClientEncryptionKeysList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "accountName": "accountName", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlDatabases/databaseName/clientEncryptionKeys/cekName1", + "name": "cekName1", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKey", + "properties": { + "resource": { + "id": "cekName1", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "wrappedDataEncryptionKey": "VGhpcyBpcyBhY3R1YWxseSBhbiBhcnJheSBvZiBieXRlcy4gVGhpcyByZXF1ZXN0L3Jlc3BvbnNlIGlzIGJlaW5nIHByZXNlbnRlZCBhcyBhIHN0cmluZyBmb3IgcmVhZGFiaWxpdHkgaW4gdGhlIGV4YW1wbGU=", + "keyWrapMetadata": { + "name": "customerManagedKey1", + "type": "AzureKeyVault", + "value": "AzureKeyVault Key URL for customerManagedKey1", + "algorithm": "RSA-OAEP" + }, + "_rid": "nAMyAAAAAADPw1kKAgAAAA==", + "_ts": 1626425552, + "_etag": "00000000-0000-0000-7a1f-bc0828e801d7" + } + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlDatabases/databaseName/clientEncryptionKeys/cekName2", + "name": "cekName2", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKey", + "properties": { + "resource": { + "id": "cekName2", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "wrappedDataEncryptionKey": "VGhpcyBpcyBhY3R1YWxseSBhbiBhcnJheSBvZiBieXRlcy4gVGhpcyByZXF1ZXN0L3Jlc3BvbnNlIGlzIGJlaW5nIHByZXNlbnRlZCBhcyBhIHN0cmluZyBmb3IgcmVhZGFiaWxpdHkgaW4gdGhlIGV4YW1wbGU=", + "keyWrapMetadata": { + "name": "customerManagedKey2", + "type": "AzureKeyVault", + "value": "AzureKeyVault Key URL for customerManagedKey2", + "algorithm": "RSA-OAEP" + }, + "_rid": "nAMyAAAAAAAWWfxHAgAAAA==", + "_ts": 1626425631, + "_etag": "00000000-0000-0000-7a21-7788a38c01d7" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerBackupInformation.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerBackupInformation.json new file mode 100644 index 000000000000..bbe3616c29df --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerBackupInformation.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName", + "location": { + "location": "North Europe" + } + }, + "responses": { + "200": { + "body": { + "continuousBackupInformation": { + "latestRestorableTimestamp": "2021-02-05T02:40:50Z" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerCreateUpdate.json new file mode 100644 index 000000000000..f435f0b828a8 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerCreateUpdate.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "createUpdateSqlContainerParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "containerName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 2 + }, + "computedProperties": [ + { + "name": "cp_lowerName", + "query": "SELECT VALUE LOWER(c.name) FROM c" + } + ] + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/containerName", + "name": "containerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "containerName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 1 + }, + "computedProperties": [ + { + "name": "cp_lowerName", + "query": "SELECT VALUE LOWER(c.name) FROM c" + } + ], + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerDelete.json new file mode 100644 index 000000000000..ea4f65879dde --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerGet.json new file mode 100644 index 000000000000..ebb33842d3d4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerGet.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/containerName", + "name": "containerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "containerName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 1 + }, + "computedProperties": [ + { + "name": "cp_lowerName", + "query": "SELECT VALUE LOWER(c.name) FROM c" + } + ], + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + }, + "options": { + "throughput": 400 + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerList.json new file mode 100644 index 000000000000..d9963de3b3ec --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerList.json @@ -0,0 +1,232 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/containerName", + "name": "containerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testctn", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 1 + }, + "computedProperties": [ + { + "name": "cp_lowerName", + "query": "SELECT VALUE LOWER(c.name) FROM c" + } + ], + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName1", + "name": "containerName1", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testctn1", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber", + "/AccountLocation" + ], + "kind": "MultiHash", + "version": 2 + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 1 + }, + "computedProperties": [], + "_rid": "PD5DALigDiw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName2", + "name": "containerName2", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testctn2", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/_partitionKey" + ], + "kind": "Hash", + "version": 2, + "systemKey": true + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 1 + }, + "_rid": "PD5DALigDhw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerMigrateToAutoscale.json new file mode 100644 index 000000000000..2f267aa21018 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerMigrateToAutoscale.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerMigrateToManualThroughput.json new file mode 100644 index 000000000000..53fcacc8d0e2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerMigrateToManualThroughput.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerPartitionMerge.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerPartitionMerge.json new file mode 100644 index 000000000000..cb37fb4c427e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerPartitionMerge.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName", + "mergeParameters": { + "isDryRun": false + } + }, + "responses": { + "200": { + "body": { + "physicalPartitionStorageInfoCollection": [ + { + "storageInKB": 333.0, + "id": "0" + }, + { + "storageInKB": 305.0, + "id": "1" + }, + { + "storageInKB": 368.0, + "id": "177" + }, + { + "storageInKB": 96313.0, + "id": "178" + }, + { + "storageInKB": 194.0, + "id": "5" + }, + { + "storageInKB": 331.0, + "id": "6" + } + ] + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerRedistributeThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerRedistributeThroughput.json new file mode 100644 index 000000000000..afb2d7a76a25 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerRedistributeThroughput.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "redistributeThroughputParameters": { + "properties": { + "resource": { + "throughputPolicy": "custom", + "targetPhysicalPartitionThroughputInfo": [ + { + "id": "0", + "throughput": 5000 + }, + { + "id": "1", + "throughput": 5000 + } + ], + "sourcePhysicalPartitionThroughputInfo": [ + { + "id": "2", + "throughput": 5000 + }, + { + "id": "3" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "physicalPartitionThroughputInfo": [ + { + "id": "0", + "throughput": 5000 + }, + { + "id": "1", + "throughput": 5000 + }, + { + "id": "2", + "throughput": 5000 + }, + { + "id": "3", + "throughput": 3000 + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerRestore.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerRestore.json new file mode 100644 index 000000000000..777a99fee912 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerRestore.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "createUpdateSqlContainerParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "containerName", + "createMode": "Restore", + "restoreParameters": { + "restoreTimestampInUtc": "2022-07-20T18:28:00Z", + "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/restorableDatabaseAccountId", + "restoreWithTtlDisabled": true + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/containerName", + "name": "containerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "containerName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 1 + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerRetrieveThroughputDistribution.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerRetrieveThroughputDistribution.json new file mode 100644 index 000000000000..e1e932774015 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerRetrieveThroughputDistribution.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "retrieveThroughputParameters": { + "properties": { + "resource": { + "physicalPartitionIds": [ + { + "id": "0" + }, + { + "id": "1" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "physicalPartitionThroughputInfo": [ + { + "id": "0", + "throughput": 5000 + }, + { + "id": "1", + "throughput": 5000 + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerThroughputGet.json new file mode 100644 index 000000000000..5ce72a52cc13 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerThroughputGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerThroughputUpdate.json new file mode 100644 index 000000000000..08010e07bfa2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlContainerThroughputUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseCreateUpdate.json new file mode 100644 index 000000000000..7c28059330a2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseCreateUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "createUpdateSqlDatabaseParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseDelete.json new file mode 100644 index 000000000000..61f3516fad3b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseGet.json new file mode 100644 index 000000000000..06562352d2f3 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"", + "_colls": "colls/", + "_users": "users/" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseList.json new file mode 100644 index 000000000000..ce17074565a9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"", + "_colls": "colls/", + "_users": "users/" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json new file mode 100644 index 000000000000..ffd50aad863a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json new file mode 100644 index 000000000000..7d6a6114ef4a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabasePartitionMerge.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabasePartitionMerge.json new file mode 100644 index 000000000000..1f3caefe3be0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabasePartitionMerge.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "mergeParameters": { + "isDryRun": false + } + }, + "responses": { + "200": { + "body": { + "physicalPartitionStorageInfoCollection": [ + { + "storageInKB": 333.0, + "id": "0" + }, + { + "storageInKB": 305.0, + "id": "1" + }, + { + "storageInKB": 368.0, + "id": "177" + }, + { + "storageInKB": 96313.0, + "id": "178" + }, + { + "storageInKB": 194.0, + "id": "5" + }, + { + "storageInKB": 331.0, + "id": "6" + } + ] + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2022-11-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2022-11-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseRedistributeThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseRedistributeThroughput.json new file mode 100644 index 000000000000..0897e7f93569 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseRedistributeThroughput.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "redistributeThroughputParameters": { + "properties": { + "resource": { + "throughputPolicy": "custom", + "targetPhysicalPartitionThroughputInfo": [ + { + "id": "0", + "throughput": 5000 + }, + { + "id": "1", + "throughput": 5000 + } + ], + "sourcePhysicalPartitionThroughputInfo": [ + { + "id": "2", + "throughput": 5000 + }, + { + "id": "3" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "physicalPartitionThroughputInfo": [ + { + "id": "0", + "throughput": 5000 + }, + { + "id": "1", + "throughput": 5000 + }, + { + "id": "2", + "throughput": 5000 + }, + { + "id": "3", + "throughput": 3000 + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseRestore.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseRestore.json new file mode 100644 index 000000000000..727bf40ed20d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseRestore.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "createUpdateSqlDatabaseParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "createMode": "Restore", + "restoreParameters": { + "restoreTimestampInUtc": "2022-07-20T18:28:00Z", + "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/restorableDatabaseAccountId", + "restoreWithTtlDisabled": true + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseRetrieveThroughputDistribution.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseRetrieveThroughputDistribution.json new file mode 100644 index 000000000000..6908018e0d36 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseRetrieveThroughputDistribution.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "retrieveThroughputParameters": { + "properties": { + "resource": { + "physicalPartitionIds": [ + { + "id": "0" + }, + { + "id": "1" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "physicalPartitionThroughputInfo": [ + { + "id": "0", + "throughput": 5000 + }, + { + "id": "1", + "throughput": 5000 + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseThroughputGet.json new file mode 100644 index 000000000000..764c25871b14 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseThroughputGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseThroughputUpdate.json new file mode 100644 index 000000000000..521feaacfdf0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDatabaseThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDedicatedGatewayServiceCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDedicatedGatewayServiceCreate.json new file mode 100644 index 000000000000..17a536efc8d9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDedicatedGatewayServiceCreate.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "serviceName": "SqlDedicatedGateway", + "createUpdateParameters": { + "properties": { + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "SqlDedicatedGateway" + } + } + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/SqlDedicatedGateway", + "name": "SqlDedicatedGateway", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "SqlDedicatedGateway", + "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway.sqlx.cosmos.windows-int.net/", + "locations": [ + { + "name": "SqlDedicatedGateway-westus2", + "location": "West US 2", + "status": "Running", + "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway-westus.sqlx.cosmos.windows-int.net/" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDedicatedGatewayServiceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDedicatedGatewayServiceDelete.json new file mode 100644 index 000000000000..419c5d944ba2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDedicatedGatewayServiceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "serviceName": "SqlDedicatedGateway" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDedicatedGatewayServiceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDedicatedGatewayServiceGet.json new file mode 100644 index 000000000000..a4c8b4f0d9dd --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlDedicatedGatewayServiceGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "serviceName": "SqlDedicatedGateway" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/SqlDedicatedGateway", + "name": "SqlDedicatedGateway", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "SqlDedicatedGateway", + "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway.sqlx.cosmos.windows-int.net/", + "locations": [ + { + "name": "SqlDedicatedGateway-westus2", + "location": "West US 2", + "status": "Running", + "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway-westus.sqlx.cosmos.windows-int.net/" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlMaterializedViewCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlMaterializedViewCreateUpdate.json new file mode 100644 index 000000000000..f2e469ab5e1c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlMaterializedViewCreateUpdate.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "mvContainerName", + "createUpdateSqlContainerParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "mvContainerName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/mvpk" + ], + "kind": "Hash" + }, + "materializedViewDefinition": { + "sourceCollectionId": "sourceContainerName", + "definition": "select * from ROOT" + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/mvContainerName", + "name": "mvContainerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "mvContainerName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*" + } + ], + "excludedPaths": [ + { + "path": "/\"_etag\"/?" + } + ] + }, + "partitionKey": { + "paths": [ + "/mvpk" + ], + "kind": "Hash" + }, + "defaultTtl": -1, + "uniqueKeyPolicy": { + "uniqueKeys": [] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/_ts", + "conflictResolutionProcedure": "" + }, + "materializedViewDefinition": { + "sourceCollectionRid": "vb0sn6nEu9A=", + "sourceCollectionId": "sourceContainerName", + "definition": "select * from ROOT" + }, + "_rid": "vb0sn8MDxLw=", + "_ts": 1671427656, + "_etag": "\"00000800-0000-0200-0000-639ff6480000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentCreateUpdate.json new file mode 100644 index 000000000000..68906722aabf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentCreateUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "roleAssignmentId": "myRoleAssignmentId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview", + "createUpdateSqlRoleAssignmentParameters": { + "properties": { + "roleDefinitionId": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "scope": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases", + "principalId": "myPrincipalId" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleAssignments/myRoleAssignmentId", + "name": "myRoleAssignmentId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments", + "properties": { + "roleDefinitionId": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "scope": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases", + "principalId": "myPrincipalId" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentDelete.json new file mode 100644 index 000000000000..a76732bc0525 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "roleAssignmentId": "myRoleAssignmentId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentGet.json new file mode 100644 index 000000000000..0599af242ad4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "roleAssignmentId": "myRoleAssignmentId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleAssignments/myRoleAssignmentId", + "name": "myRoleAssignmentId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments", + "properties": { + "roleDefinitionId": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "scope": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases", + "principalId": "myPrincipalId" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentList.json new file mode 100644 index 000000000000..fd0b7b3ec799 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleAssignmentList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleAssignments/myRoleAssignmentId", + "name": "myRoleAssignmentId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments", + "properties": { + "roleDefinitionId": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "scope": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases", + "principalId": "myPrincipalId" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionCreateUpdate.json new file mode 100644 index 000000000000..7fec557d6264 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionCreateUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "roleDefinitionId": "myRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview", + "createUpdateSqlRoleDefinitionParameters": { + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "assignableScopes": [ + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales", + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" + ], + "notDataActions": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "name": "myRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "assignableScopes": [ + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales", + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" + ] + } + ] + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionDelete.json new file mode 100644 index 000000000000..7b44df336dbf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "roleDefinitionId": "myRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionGet.json new file mode 100644 index 000000000000..96d82cf0a0af --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "roleDefinitionId": "myRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "name": "myRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "assignableScopes": [ + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales", + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" + ], + "notDataActions": [] + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionList.json new file mode 100644 index 000000000000..f8c20b764757 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlRoleDefinitionList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "name": "myRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "assignableScopes": [ + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales", + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" + ], + "notDataActions": [] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureCreateUpdate.json new file mode 100644 index 000000000000..94a6c5c6d2b3 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureCreateUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "storedProcedureName": "storedProcedureName", + "createUpdateSqlStoredProcedureParameters": { + "properties": { + "resource": { + "id": "storedProcedureName", + "body": "body" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlStoredProcedures/storedProcedureName", + "name": "storedProcedureName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlStoredProcedures", + "properties": { + "resource": { + "id": "storedProcedureName", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureDelete.json new file mode 100644 index 000000000000..a76b74d6cede --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "storedProcedureName": "storedProcedureName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureGet.json new file mode 100644 index 000000000000..da7827f29769 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName", + "storedProcedureName": "storedProcedureName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlStoredProcedures/storedProcedureName", + "name": "storedProcedureName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlStoredProcedures", + "properties": { + "resource": { + "id": "storedProcedureName", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureList.json new file mode 100644 index 000000000000..bff41777f31c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlStoredProcedureList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlStoredProcedures/storedProcedureName", + "name": "testctn", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlStoredProcedures", + "properties": { + "resource": { + "id": "testctn", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerCreateUpdate.json new file mode 100644 index 000000000000..b47c7a7ad277 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerCreateUpdate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "triggerName": "triggerName", + "createUpdateSqlTriggerParameters": { + "properties": { + "resource": { + "id": "triggerName", + "body": "body", + "triggerType": "triggerType", + "triggerOperation": "triggerOperation" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlTriggers/triggerName", + "name": "triggerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlTriggers", + "properties": { + "resource": { + "id": "triggerName", + "body": "body", + "triggerType": "triggerType", + "triggerOperation": "triggerOperation", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerDelete.json new file mode 100644 index 000000000000..6519cc8cbb24 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "triggerName": "triggerName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerGet.json new file mode 100644 index 000000000000..273a275c8048 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName", + "triggerName": "triggerName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlTriggers/triggerName", + "name": "triggerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlTriggers", + "properties": { + "resource": { + "id": "triggerName", + "body": "body", + "triggerType": "triggerType", + "triggerOperation": "triggerOperation", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerList.json new file mode 100644 index 000000000000..526cb134b589 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlTriggerList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlTriggers/triggerName", + "name": "testctn", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlTriggers", + "properties": { + "resource": { + "id": "testctn", + "body": "body", + "triggerType": "triggerType", + "triggerOperation": "triggerOperation", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json new file mode 100644 index 000000000000..d5eca3413ba0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "userDefinedFunctionName": "userDefinedFunctionName", + "createUpdateSqlUserDefinedFunctionParameters": { + "properties": { + "resource": { + "id": "userDefinedFunctionName", + "body": "body" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlUserDefinedFunctions/userDefinedFunctionName", + "name": "userDefinedFunctionName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlUserDefinedFunctions", + "properties": { + "resource": { + "id": "userDefinedFunctionName", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionDelete.json new file mode 100644 index 000000000000..56fccc359d82 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "userDefinedFunctionName": "userDefinedFunctionName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionGet.json new file mode 100644 index 000000000000..439538ebb0a4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName", + "userDefinedFunctionName": "userDefinedFunctionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlUserDefinedFunctions/userDefinedFunctionName", + "name": "userDefinedFunctionName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlUserDefinedFunctions", + "properties": { + "resource": { + "id": "userDefinedFunctionName", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionList.json new file mode 100644 index 000000000000..ba33b877cff7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBSqlUserDefinedFunctionList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlUserDefinedFunctions/userDefinedFunctionName", + "name": "testctn", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlUserDefinedFunctions", + "properties": { + "resource": { + "id": "testctn", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableBackupInformation.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableBackupInformation.json new file mode 100644 index 000000000000..beebf2e479cf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableBackupInformation.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "tableName": "tableName1", + "location": { + "location": "North Europe" + } + }, + "responses": { + "200": { + "body": { + "continuousBackupInformation": { + "latestRestorableTimestamp": "2021-02-05T02:40:50Z" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableCreateUpdate.json new file mode 100644 index 000000000000..dcd45cfe8de0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableCreateUpdate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "tableName": "tableName", + "createUpdateTableParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/tables", + "location": "West US", + "properties": { + "resource": { + "id": "tableName" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableDelete.json new file mode 100644 index 000000000000..ba84fcc19bbc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableGet.json new file mode 100644 index 000000000000..82361a4cc68d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/tables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableList.json new file mode 100644 index 000000000000..e7e674d97ad5 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/tables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableMigrateToAutoscale.json new file mode 100644 index 000000000000..5579cde08650 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableMigrateToAutoscale.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableMigrateToManualThroughput.json new file mode 100644 index 000000000000..a89d5aaa6a22 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableMigrateToManualThroughput.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableThroughputGet.json new file mode 100644 index 000000000000..4ca9f9bacdb4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableThroughputGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableThroughputUpdate.json new file mode 100644 index 000000000000..41cd6e0f73a2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBTableThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "tableName": "tableName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobCancel.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobCancel.json new file mode 100644 index 000000000000..889124f42d28 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobCancel.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "jobName": "j1" + }, + "responses": { + "200": { + "body": { + "id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16", + "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs", + "properties": { + "jobName": "j1", + "source": { + "tableName": "table", + "keyspaceName": "keyspace", + "component": "CosmosDBCassandra" + }, + "destination": { + "component": "AzureBlobStorage", + "containerName": "blob_container", + "endpointUrl": "https://blob.windows.net" + }, + "status": "Cancelled", + "processedCount": 20, + "totalCount": 100, + "lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z", + "duration": "00:34:10" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobComplete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobComplete.json new file mode 100644 index 000000000000..0a79f4e7bcc8 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobComplete.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "e35cc6eb-c8e3-447b-8de6-b83328cd0098", + "jobName": "j1" + }, + "responses": { + "200": { + "body": { + "id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16", + "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs", + "properties": { + "jobName": "j1", + "source": { + "tableName": "table", + "keyspaceName": "keyspace", + "component": "CosmosDBCassandra" + }, + "destination": { + "component": "AzureBlobStorage", + "containerName": "blob_container", + "endpointUrl": "https://blob.windows.net" + }, + "status": "Completed", + "processedCount": 20, + "totalCount": 100, + "lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z", + "duration": "00:34:10" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobCreate.json new file mode 100644 index 000000000000..5082fd86dade --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobCreate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "jobName": "j1", + "jobCreateParameters": { + "properties": { + "source": { + "component": "CosmosDBCassandra", + "keyspaceName": "keyspace", + "tableName": "table" + }, + "destination": { + "component": "AzureBlobStorage", + "containerName": "blob_container", + "endpointUrl": "https://blob.windows.net" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16", + "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs", + "properties": { + "jobName": "j1", + "source": { + "tableName": "table", + "keyspaceName": "keyspace", + "component": "CosmosDBCassandra" + }, + "destination": { + "component": "AzureBlobStorage", + "containerName": "blob_container", + "endpointUrl": "https://blob.windows.net" + }, + "status": "Running", + "processedCount": 0, + "totalCount": 0, + "lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z", + "duration": "00:00:00" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobFeed.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobFeed.json new file mode 100644 index 000000000000..286dc012a140 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobFeed.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16", + "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs", + "properties": { + "jobName": "j1", + "source": { + "tableName": "table", + "keyspaceName": "keyspace", + "component": "CosmosDBCassandra" + }, + "destination": { + "component": "AzureBlobStorage", + "endpointUrl": "https://blob.windows.net", + "containerName": "blob_container" + }, + "status": "Completed", + "processedCount": 100, + "totalCount": 100, + "lastUpdatedUtcTime": "2021-06-12T12:04:23.1530000Z", + "duration": "00:00:00" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobGet.json new file mode 100644 index 000000000000..c2cbe1f40f27 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "jobName": "j1" + }, + "responses": { + "200": { + "body": { + "id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16", + "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs", + "properties": { + "jobName": "j1", + "source": { + "tableName": "table", + "keyspaceName": "keyspace", + "component": "CosmosDBCassandra" + }, + "destination": { + "component": "AzureBlobStorage", + "endpointUrl": "https://blob.windows.net", + "containerName": "blob_container" + }, + "status": "Completed", + "processedCount": 50, + "totalCount": 50, + "lastUpdatedUtcTime": "2021-06-12T12:04:23.1530000Z", + "duration": "01:23:56" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobPause.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobPause.json new file mode 100644 index 000000000000..e72220cd5197 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobPause.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "jobName": "j1" + }, + "responses": { + "200": { + "body": { + "id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16", + "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs", + "properties": { + "jobName": "j1", + "source": { + "tableName": "table", + "keyspaceName": "keyspace", + "component": "CosmosDBCassandra" + }, + "destination": { + "component": "AzureBlobStorage", + "containerName": "blob_container", + "endpointUrl": "https://blob.windows.net" + }, + "status": "Paused", + "processedCount": 20, + "totalCount": 100, + "lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z", + "duration": "00:11:25" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobResume.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobResume.json new file mode 100644 index 000000000000..b564d5f643ae --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobResume.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2024-02-15-preview", + "subscriptionId": "subid", + "jobName": "j1" + }, + "responses": { + "200": { + "body": { + "id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16", + "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs", + "properties": { + "jobName": "j1", + "source": { + "tableName": "table", + "keyspaceName": "keyspace", + "component": "CosmosDBCassandra" + }, + "destination": { + "component": "AzureBlobStorage", + "containerName": "blob_container", + "endpointUrl": "https://blob.windows.net" + }, + "status": "Pending", + "processedCount": 20, + "totalCount": 100, + "lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z", + "duration": "00:21:50" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterAddNode.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterAddNode.json new file mode 100644 index 000000000000..4c5b0d1d8830 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterAddNode.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestResourceGroup", + "mongoClusterName": "myMongoCluster", + "api-version": "2024-02-15-preview", + "parameters": { + "properties": { + "nodeGroupSpecs": [ + { + "kind": "Shard", + "nodeCount": 4 + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster", + "name": "myMongoCluster", + "type": "/Microsoft.DocumentDB/mongoClusters", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "administratorLogin": "mongoAdmin", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M30", + "diskSizeGB": 128, + "enableHa": true, + "nodeCount": 4 + } + ], + "connectionString": "mongodb+srv://:@myMongoCluster.mongocluster.cosmos.azure.com", + "earliestRestoreTime": "2023-01-13T20:07:35Z" + }, + "location": "westus2" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/locations/westus2/operationResults/f6a27306-3ee3-4e6b-997d-3ba2024b85e6?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterCreate.json new file mode 100644 index 000000000000..525cfb7eb310 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterCreate.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestResourceGroup", + "mongoClusterName": "myMongoCluster", + "api-version": "2024-02-15-preview", + "parameters": { + "location": "westus2", + "properties": { + "administratorLogin": "mongoAdmin", + "administratorLoginPassword": "password", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M30", + "diskSizeGB": 128, + "enableHa": true, + "nodeCount": 3 + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster", + "name": "myMongoCluster", + "type": "/Microsoft.DocumentDB/mongoClusters", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "administratorLogin": "mongoAdmin", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M30", + "diskSizeGB": 128, + "enableHa": true, + "nodeCount": 3 + } + ], + "connectionString": "mongodb+srv://:@myMongoCluster.mongocluster.cosmos.azure.com", + "earliestRestoreTime": "2023-01-13T20:07:35Z" + }, + "location": "westus2" + } + }, + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster", + "name": "myMongoCluster", + "type": "/Microsoft.DocumentDB/mongoClusters", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "InProgress", + "administratorLogin": "mongoAdmin", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M30", + "diskSizeGB": 128, + "enableHa": true, + "nodeCount": 3 + } + ], + "connectionString": "mongodb+srv://:@myMongoCluster.mongocluster.cosmos.azure.com", + "earliestRestoreTime": "2023-01-13T20:07:35Z" + }, + "location": "westus2" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterCreatePITR.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterCreatePITR.json new file mode 100644 index 000000000000..0cf4d332a790 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterCreatePITR.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestResourceGroup", + "mongoClusterName": "myMongoCluster", + "api-version": "2024-02-15-preview", + "parameters": { + "location": "westus2", + "properties": { + "createMode": "PointInTimeRestore", + "restoreParameters": { + "pointInTimeUTC": "2023-01-13T20:07:35Z", + "sourceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster", + "name": "myMongoCluster", + "type": "/Microsoft.DocumentDB/mongoClusters", + "properties": { + "provisioningState": "Succeeded", + "administratorLogin": "mongoAdmin", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M30", + "diskSizeGB": 128, + "enableHa": true, + "nodeCount": 3 + } + ], + "connectionString": "mongodb+srv://:@myMongoCluster.mongocluster.cosmos.azure.com", + "earliestRestoreTime": "2023-01-13T20:07:35Z" + }, + "location": "westus2" + } + }, + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster", + "name": "myMongoCluster", + "type": "/Microsoft.DocumentDB/mongoClusters", + "properties": { + "provisioningState": "Succeeded", + "administratorLogin": "mongoAdmin", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M30", + "diskSizeGB": 128, + "enableHa": true, + "nodeCount": 3 + } + ], + "connectionString": "mongodb+srv://:@myMongoCluster.mongocluster.cosmos.azure.com", + "earliestRestoreTime": "2023-01-13T20:07:35Z" + }, + "location": "westus2" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterDelete.json new file mode 100644 index 000000000000..a8f14c03952c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestResourceGroup", + "mongoClusterName": "myMongoCluster", + "api-version": "2024-02-15-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/locations/westus2/operationResults/f6a27306-3ee3-4e6b-997d-3ba2024b85e6?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleCreate.json new file mode 100644 index 000000000000..0cdfe9e187e2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleCreate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestGroup", + "mongoClusterName": "myMongoCluster", + "firewallRuleName": "rule1", + "api-version": "2024-02-15-preview", + "parameters": { + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster/firewallRules/rule1", + "name": "rule1", + "type": "/Microsoft.DocumentDB/mongoClusters/firewallRules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster/firewallRules/rule1", + "name": "rule1", + "type": "/Microsoft.DocumentDB/mongoClusters/firewallRules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "InProgress", + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleDelete.json new file mode 100644 index 000000000000..fb44bac32d74 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestGroup", + "mongoClusterName": "myMongoCluster", + "firewallRuleName": "rule1", + "api-version": "2024-02-15-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/locations/westus2/operationResults/f6a27306-3ee3-4e6b-997d-3ba2024b85e6?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleGet.json new file mode 100644 index 000000000000..516983e22961 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestGroup", + "mongoClusterName": "myMongoCluster", + "firewallRuleName": "rule1", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster/firewallRules/rule1", + "name": "rule1", + "type": "/Microsoft.DocumentDB/mongoClusters/firewallRules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleList.json new file mode 100644 index 000000000000..710cf35afc80 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestGroup", + "mongoClusterName": "myMongoCluster", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster/firewallRules?api-version=2024-02-15-preview&$top=3&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster/firewallRules/rule1", + "name": "rule1", + "type": "/Microsoft.DocumentDB/mongoClusters/firewallRules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster/firewallRules/rule2", + "name": "rule2", + "type": "/Microsoft.DocumentDB/mongoClusters/firewallRules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "startIpAddress": "1.0.0.0", + "endIpAddress": "255.0.0.0" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterGet.json new file mode 100644 index 000000000000..b32575035099 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestResourceGroup", + "mongoClusterName": "myMongoCluster", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster", + "name": "myMongoCluster", + "type": "/Microsoft.DocumentDB/mongoClusters", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "administratorLogin": "mongoAdmin", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M30", + "diskSizeGB": 128, + "enableHa": true, + "nodeCount": 4 + } + ], + "connectionString": "mongodb+srv://:@myMongoCluster.mongocluster.cosmos.azure.com", + "earliestRestoreTime": "2023-01-13T20:07:35Z" + }, + "location": "westus2" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterList.json new file mode 100644 index 000000000000..1444595b726f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterList.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//providers/Microsoft.DocumentDB/mongoClusters?api-version=2024-02-15-preview&$top=3&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster", + "name": "myMongoCluster", + "type": "/Microsoft.DocumentDB/mongoClusters", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "administratorLogin": "mongoAdmin", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M30", + "diskSizeGB": 128, + "enableHa": true, + "nodeCount": 4 + } + ], + "connectionString": "mongodb+srv://:@myMongoCluster.mongocluster.cosmos.azure.com", + "earliestRestoreTime": "2023-01-13T20:07:35Z" + }, + "location": "westus2" + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster2", + "name": "myMongoCluster2", + "type": "/Microsoft.DocumentDB/mongoClusters", + "tags": { + "additionalProp1": "string" + }, + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "administratorLogin": "mongoAdmin", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M40", + "diskSizeGB": 256, + "enableHa": true, + "nodeCount": 2 + } + ], + "connectionString": "mongodb+srv://:@myMongoCluster.mongocluster.cosmos.azure.com", + "earliestRestoreTime": "2023-01-10T20:07:35Z" + }, + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterListByResourceGroup.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterListByResourceGroup.json new file mode 100644 index 000000000000..ee94386ec9dc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterListByResourceGroup.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestResourceGroup", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//providers/Microsoft.DocumentDB/mongoClusters?api-version=2024-02-15-preview&$top=3&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster", + "name": "myMongoCluster", + "type": "/Microsoft.DocumentDB/mongoClusters", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "administratorLogin": "mongoAdmin", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M30", + "diskSizeGB": 128, + "enableHa": true, + "nodeCount": 4 + } + ], + "connectionString": "mongodb+srv://:@myMongoCluster.mongocluster.cosmos.azure.com", + "earliestRestoreTime": "2023-01-13T20:07:35Z" + }, + "location": "westus2" + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster2", + "name": "myMongoCluster2", + "type": "/Microsoft.DocumentDB/mongoClusters", + "tags": { + "additionalProp1": "string" + }, + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "administratorLogin": "mongoAdmin", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M40", + "diskSizeGB": 256, + "enableHa": true, + "nodeCount": 2 + } + ], + "connectionString": "mongodb+srv://:@myMongoCluster2.mongocluster.cosmos.azure.com", + "earliestRestoreTime": "2023-01-10T20:07:35Z" + }, + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterListConnectionStrings.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterListConnectionStrings.json new file mode 100644 index 000000000000..679d5fb46dd4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterListConnectionStrings.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestGroup", + "mongoClusterName": "myMongoCluster", + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "connectionStrings": [ + { + "connectionString": "mongodb+srv://:@myMongoCluster.mongocluster.cosmos.azure.com", + "description": "default connection string" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterNameAvailability.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterNameAvailability.json new file mode 100644 index 000000000000..6d3e44c6f98c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestResourceGroup", + "location": "westus2", + "api-version": "2024-02-15-preview", + "parameters": { + "name": "newmongocluster", + "type": "Microsoft.DocumentDB/mongoClusters" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterNameAvailability_AlreadyExists.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterNameAvailability_AlreadyExists.json new file mode 100644 index 000000000000..52d5cae217c7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterNameAvailability_AlreadyExists.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestResourceGroup", + "location": "westus2", + "api-version": "2024-02-15-preview", + "parameters": { + "name": "existingmongocluster", + "type": "Microsoft.DocumentDB/mongoClusters" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Cluster name 'existingmongocluster' is already in use." + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterUpdate.json new file mode 100644 index 000000000000..fa2f29225cd7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/mongo-cluster/CosmosDBMongoClusterUpdate.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestResourceGroup", + "mongoClusterName": "myMongoCluster", + "api-version": "2024-02-15-preview", + "parameters": { + "properties": { + "administratorLogin": "mongoAdmin", + "administratorLoginPassword": "password", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M50", + "diskSizeGB": 256, + "enableHa": true, + "nodeCount": 4 + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myMongoCluster", + "name": "myMongoCluster", + "type": "/Microsoft.DocumentDB/mongoClusters", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "administratorLogin": "mongoAdmin", + "serverVersion": "5.0", + "nodeGroupSpecs": [ + { + "kind": "Shard", + "sku": "M50", + "diskSizeGB": 256, + "enableHa": true, + "nodeCount": 4 + } + ], + "connectionString": "mongodb+srv://:@myMongoCluster.mongocluster.cosmos.azure.com", + "earliestRestoreTime": "2023-01-13T20:07:35Z" + }, + "location": "westus2" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/locations/westus2/operationResults/f6a27306-3ee3-4e6b-997d-3ba2024b85e6?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountCreate.json new file mode 100644 index 000000000000..191ec21e59d6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountCreate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rg1", + "throughputPoolName": "tp1", + "throughputPoolAccountName": "db1", + "body": { + "properties": { + "accountLocation": "West US", + "accountResourceIdentifier": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/resourceGroup/rg1/databaseAccounts/db1/" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1/throughputPoolAccounts/db1", + "properties": { + "provisioningState": "Succeeded", + "accountResourceIdentifier": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/db1", + "accountLocation": "west us", + "accountInstanceId": "{instance-id1}" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1/throughputPoolAccounts/db1", + "properties": { + "provisioningState": "Succeeded", + "accountResourceIdentifier": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/db1", + "accountLocation": "west us", + "accountInstanceId": "{instance-id1}" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountDelete.json new file mode 100644 index 000000000000..07255bb1864a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgName", + "throughputPoolName": "tp1", + "throughputPoolAccountName": "db1" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountGet.json new file mode 100644 index 000000000000..26fc52a7a569 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgName", + "throughputPoolName": "tp1", + "throughputPoolAccountName": "db1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1/throughputPoolAccounts/db1", + "properties": { + "provisioningState": "Succeeded", + "accountResourceIdentifier": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/db1", + "accountLocation": "west us", + "accountInstanceId": "{instance-id}" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountsList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountsList.json new file mode 100644 index 000000000000..9826fda91cda --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolAccountsList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgName", + "throughputPoolName": "tp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1/throughputPoolAccounts/db1", + "properties": { + "accountResourceIdentifier": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/db1", + "accountLocation": "west us", + "accountInstanceId": "{instance-id1}" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1/throughputPoolAccounts/db2", + "properties": { + "accountResourceIdentifier": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/db2", + "accountLocation": "west us", + "accountInstanceId": "{instance-id2}" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolCreate.json new file mode 100644 index 000000000000..4727d60b8619 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolCreate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rg1", + "throughputPoolName": "tp1", + "body": { + "location": "westus2", + "tags": {}, + "properties": { + "maxThroughput": 10000 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1", + "name": "tp1", + "type": "/Microsoft.DocumentDB/throughputPools", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "location": "westus2", + "properties": { + "provisioningState": "Succeeded", + "maxThroughput": 10000 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1", + "name": "tp1", + "type": "/Microsoft.DocumentDB/throughputPools", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "location": "westus2", + "properties": { + "provisioningState": "Succeeded", + "maxThroughput": 10000 + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolDelete.json new file mode 100644 index 000000000000..fcc0e7f9912c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgName", + "throughputPoolName": "tp1" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolGet.json new file mode 100644 index 000000000000..1a0a271f18d2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgName", + "throughputPoolName": "tp1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1", + "name": "tp1", + "type": "/Microsoft.DocumentDB/throughputPools", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "location": "west us", + "properties": { + "maxThroughput": 10000 + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolList.json new file mode 100644 index 000000000000..0eacbad4c815 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1", + "name": "tp1", + "type": "/Microsoft.DocumentDB/throughputPools", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "location": "west us", + "properties": { + "maxThroughput": 10000 + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp2", + "name": "tp2", + "type": "/Microsoft.DocumentDB/throughputPools", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "location": "west us", + "properties": { + "maxThroughput": 10000 + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolUpdate.json new file mode 100644 index 000000000000..ecc9d14f360a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/throughputPool/CosmosDBThroughputPoolUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rg1", + "throughputPoolName": "tp1", + "body": { + "properties": { + "maxThroughput": 10000 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1", + "name": "tp1", + "type": "/Microsoft.DocumentDB/throughputPools", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "location": "westus2", + "properties": { + "provisioningState": "Succeeded", + "maxThroughput": 10000 + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2024-02-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json new file mode 100644 index 000000000000..388c33029d09 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json @@ -0,0 +1,1873 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB - Managed Cassandra", + "description": "Azure Cosmos DB Database Service Managed Cassandra REST API", + "version": "2024-02-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.DocumentDB/cassandraClusters": { + "get": { + "operationId": "CassandraClusters_ListBySubscription", + "description": "List all managed Cassandra clusters in this subscription.", + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "CosmosDBManagedCassandraClusterListBySubscription": { + "$ref": "./examples/CosmosDBManagedCassandraClusterListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of managed Cassandra clusters.", + "schema": { + "$ref": "#/definitions/ListClusters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters": { + "get": { + "operationId": "CassandraClusters_ListByResourceGroup", + "description": "List all managed Cassandra clusters in this resource group.", + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "CosmosDBManagedCassandraClusterListByResourceGroup": { + "$ref": "./examples/CosmosDBManagedCassandraClusterListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of managed Cassandra clusters.", + "schema": { + "$ref": "#/definitions/ListClusters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}": { + "get": { + "operationId": "CassandraClusters_Get", + "description": "Get the properties of a managed Cassandra cluster.", + "x-ms-examples": { + "CosmosDBManagedCassandraClusterGet": { + "$ref": "./examples/CosmosDBManagedCassandraClusterGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of the managed Cassandra cluster were retrieved successfully.", + "schema": { + "$ref": "#/definitions/ClusterResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "CassandraClusters_Delete", + "description": "Deletes a managed Cassandra cluster.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CosmosDBManagedCassandraClusterDelete": { + "$ref": "./examples/CosmosDBManagedCassandraClusterDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The managed Cassandra cluster will be deleted asynchronously." + }, + "204": { + "description": "No such cluster to delete." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "CassandraClusters_CreateUpdate", + "description": "Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.", + "x-ms-examples": { + "CosmosDBManagedCassandraClusterCreate": { + "$ref": "./examples/CosmosDBManagedCassandraClusterCreate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterResource" + }, + "description": "The properties specifying the desired state of the managed Cassandra cluster." + } + ], + "responses": { + "200": { + "description": "The managed Cassandra cluster is being updated. Poll for provisioningState=Succeeded to find when creation completes.", + "schema": { + "$ref": "#/definitions/ClusterResource" + } + }, + "201": { + "description": "The managed Cassandra cluster is being created. Poll for provisioningState=Succeeded to find when creation completes.", + "schema": { + "$ref": "#/definitions/ClusterResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "operationId": "CassandraClusters_Update", + "description": "Updates some of the properties of a managed Cassandra cluster.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CosmosDBManagedCassandraClusterPatch": { + "$ref": "./examples/CosmosDBManagedCassandraClusterPatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterResource" + }, + "description": "Parameters to provide for specifying the managed Cassandra cluster." + } + ], + "responses": { + "202": { + "description": "The managed Cassandra cluster is being updated. Poll the provided operation for completion.", + "schema": { + "$ref": "#/definitions/ClusterResource" + } + }, + "200": { + "description": "Completed synchronously. This will only happen if the fields changed by patch require no changes to the actual Cassandra data center.", + "schema": { + "$ref": "#/definitions/ClusterResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/invokeCommand": { + "post": { + "operationId": "CassandraClusters_InvokeCommand", + "description": "Invoke a command like nodetool for cassandra maintenance ", + "x-ms-examples": { + "CosmosDBManagedCassandraCommand": { + "$ref": "./examples/CosmosDBManagedCassandraCommand.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommandPostBody" + }, + "description": "Specification which command to run where" + } + ], + "responses": { + "202": { + "description": "Success. The command operation will begin as soon as possible.", + "schema": { + "$ref": "#/definitions/CommandOutput" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/invokeCommandAsync": { + "post": { + "operationId": "CassandraClusters_InvokeCommandAsync", + "description": "Invoke a command like nodetool for cassandra maintenance asynchronously", + "x-ms-examples": { + "CosmosDBManagedCassandraCommandAsync": { + "$ref": "./examples/CosmosDBManagedCassandraCommandAsync.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommandPostBody" + }, + "description": "Specification which command to run where" + } + ], + "responses": { + "200": { + "description": "The command operation was completed successfully.", + "schema": { + "$ref": "#/definitions/CommandPublicResource" + } + }, + "202": { + "description": "Success. The command operation will begin as soon as possible.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/commands": { + "get": { + "operationId": "CassandraClusters_ListCommand", + "description": "List all commands currently running on ring info", + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "CosmosDBManagedCassandraListCommand": { + "$ref": "./examples/CosmosDBManagedCassandraListCommand.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of shell commands.", + "schema": { + "$ref": "#/definitions/ListCommands" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/commands/{commandId}": { + "get": { + "operationId": "CassandraClusters_GetCommandAsync", + "description": "Get details about a specified command that was run asynchronously.", + "x-ms-examples": { + "CosmosDBManagedCassandraCommandResult": { + "$ref": "./examples/CosmosDBManagedCassandraCommandResult.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/commandId" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. Return a command resource.", + "schema": { + "$ref": "#/definitions/ListCommands" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups": { + "get": { + "operationId": "CassandraClusters_ListBackups", + "description": "List the backups of this cluster that are available to restore.", + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "CosmosDBManagedCassandraBackupsList": { + "$ref": "./examples/CosmosDBManagedCassandraBackupsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of restorable backups for this Cassandra cluster.", + "schema": { + "$ref": "#/definitions/ListBackups" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups/{backupId}": { + "get": { + "operationId": "CassandraClusters_GetBackup", + "description": "Get the properties of an individual backup of this cluster that is available to restore.", + "x-ms-examples": { + "CosmosDBManagedCassandraBackup": { + "$ref": "./examples/CosmosDBManagedCassandraBackup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/backupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the properties of the backup.", + "schema": { + "$ref": "#/definitions/BackupResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters": { + "get": { + "operationId": "CassandraDataCenters_List", + "description": "List all data centers in a particular managed Cassandra cluster.", + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "CosmosDBManagedCassandraDataCenterList": { + "$ref": "./examples/CosmosDBManagedCassandraDataCenterList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of managed Cassandra data centers.", + "schema": { + "$ref": "#/definitions/ListDataCenters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}": { + "get": { + "operationId": "CassandraDataCenters_Get", + "description": "Get the properties of a managed Cassandra data center.", + "x-ms-examples": { + "CosmosDBManagedCassandraDataCenterGet": { + "$ref": "./examples/CosmosDBManagedCassandraDataCenterGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/dataCenterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of the managed Cassandra data center were retrieved successfully.", + "schema": { + "$ref": "#/definitions/DataCenterResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "CassandraDataCenters_Delete", + "description": "Delete a managed Cassandra data center.", + "x-ms-examples": { + "CosmosDBManagedCassandraDataCenterDelete": { + "$ref": "./examples/CosmosDBManagedCassandraDataCenterDelete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/dataCenterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Deletion will complete asynchronously." + }, + "204": { + "description": "Cassandra cluster with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "CassandraDataCenters_CreateUpdate", + "description": "Create or update a managed Cassandra data center. When updating, overwrite all properties. To update only some properties, use PATCH.", + "x-ms-examples": { + "CosmosDBManagedCassandraDataCenterCreate": { + "$ref": "./examples/CosmosDBManagedCassandraDataCenterCreate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/dataCenterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataCenterResource" + }, + "description": "Parameters specifying the managed Cassandra data center." + } + ], + "responses": { + "201": { + "description": "Accepted. The data center will be created asynchronously.", + "schema": { + "$ref": "#/definitions/DataCenterResource" + } + }, + "200": { + "description": "Accepted. The data center will be updated asynchronously.", + "schema": { + "$ref": "#/definitions/DataCenterResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "operationId": "CassandraDataCenters_Update", + "description": "Update some of the properties of a managed Cassandra data center.", + "x-ms-examples": { + "CosmosDBManagedCassandraDataCenterUpdate": { + "$ref": "./examples/CosmosDBManagedCassandraDataCenterPatch.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/dataCenterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataCenterResource" + }, + "description": "Parameters to provide for specifying the managed Cassandra data center." + } + ], + "responses": { + "202": { + "description": "Accepted. Update will proceed asynchronously.", + "schema": { + "$ref": "#/definitions/DataCenterResource" + } + }, + "200": { + "description": "Completed synchronously. This will only happen if the fields changed by patch require no changes to the actual Cassandra cluster, such as editing the tags.", + "schema": { + "$ref": "#/definitions/DataCenterResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/deallocate": { + "post": { + "operationId": "CassandraClusters_Deallocate", + "description": "Deallocate the Managed Cassandra Cluster and Associated Data Centers. Deallocation will deallocate the host virtual machine of this cluster, and reserved the data disk. This won't do anything on an already deallocated cluster. Use Start to restart the cluster.", + "x-ms-examples": { + "CosmosDBManagedCassandraClusterDeallocate": { + "$ref": "./examples/CosmosDBManagedCassandraClusterDeallocate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/forceDeallocate" + } + ], + "responses": { + "202": { + "description": "Cluster deallocated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/start": { + "post": { + "operationId": "CassandraClusters_Start", + "description": "Start the Managed Cassandra Cluster and Associated Data Centers. Start will start the host virtual machine of this cluster with reserved data disk. This won't do anything on an already running cluster. Use Deallocate to deallocate the cluster.", + "x-ms-examples": { + "CosmosDBManagedCassandraClusterStart": { + "$ref": "./examples/CosmosDBManagedCassandraClusterStart.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Enqueued Operation to start the cluster." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/status": { + "get": { + "operationId": "CassandraClusters_Status", + "description": "Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.", + "x-ms-examples": { + "CosmosDBManagedCassandraStatus": { + "$ref": "./examples/CosmosDBManagedCassandraStatus.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully fetched the usage statistics of all nodes in the cluster.", + "schema": { + "$ref": "#/definitions/CassandraClusterPublicStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Managed Cassandra cluster name.", + "minLength": 1, + "maxLength": 100, + "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$" + }, + "commandId": { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Managed Cassandra cluster command id.", + "minLength": 1, + "maxLength": 100, + "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$" + }, + "forceDeallocate": { + "name": "x-ms-force-deallocate", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Force to deallocate a cluster of Cluster Type Production. Force to deallocate a cluster of Cluster Type Production might cause data loss" + }, + "dataCenterNameParameter": { + "name": "dataCenterName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Data center name in a managed Cassandra cluster.", + "minLength": 1, + "maxLength": 100, + "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$" + }, + "backupNameParameter": { + "name": "backupId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Id of a restorable backup of a Cassandra cluster.", + "minLength": 1, + "maxLength": 15, + "pattern": "^[0-9]+$" + } + }, + "definitions": { + "ListClusters": { + "description": "List of managed Cassandra clusters.", + "readOnly": true, + "type": "object", + "properties": { + "value": { + "description": "Container for the array of clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterResource" + } + } + } + }, + "ManagedCassandraARMResourceProperties": { + "type": "object", + "description": "The core properties of ARM resources.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "$ref": "cosmos-db.json#/definitions/Tags" + }, + "identity": { + "$ref": "#/definitions/ManagedCassandraManagedServiceIdentity" + } + }, + "x-ms-azure-resource": true + }, + "ManagedCassandraManagedServiceIdentity": { + "description": "Identity for the resource.", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The object id of the identity resource." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the resource." + }, + "type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ManagedCassandraResourceIdentityType", + "modelAsString": true + } + } + } + }, + "ManagedCassandraProvisioningState": { + "description": "The status of the resource at the time the operation was called.", + "type": "string", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ManagedCassandraProvisioningState", + "modelAsString": true + } + }, + "ClusterResource": { + "description": "Representation of a managed Cassandra cluster.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedCassandraARMResourceProperties" + } + ], + "properties": { + "properties": { + "type": "object", + "description": "Properties of a managed Cassandra cluster.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ManagedCassandraProvisioningState" + }, + "restoreFromBackupId": { + "type": "string", + "x-ms-mutability": [ + "create" + ], + "description": "To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup." + }, + "delegatedManagementSubnetId": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "description": "Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'" + }, + "cassandraVersion": { + "type": "string", + "description": "Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version." + }, + "clusterNameOverride": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "description": "If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property." + }, + "authenticationMethod": { + "type": "string", + "description": "Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.", + "enum": [ + "None", + "Cassandra", + "Ldap" + ], + "x-ms-enum": { + "name": "AuthenticationMethod", + "modelAsString": true + } + }, + "initialCassandraAdminPassword": { + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true, + "description": "Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.", + "type": "string" + }, + "prometheusEndpoint": { + "$ref": "#/definitions/SeedNode", + "description": "Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached." + }, + "repairEnabled": { + "type": "boolean", + "description": "Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs." + }, + "autoReplicate": { + "type": "string", + "description": "The form of AutoReplicate that is being used by this cluster.", + "enum": [ + "None", + "SystemKeyspaces", + "AllKeyspaces" + ], + "x-ms-enum": { + "name": "AutoReplicate", + "modelAsString": true + } + }, + "clientCertificates": { + "description": "List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.", + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "externalGossipCertificates": { + "description": "List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.", + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "gossipCertificates": { + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "description": "List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.", + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "externalSeedNodes": { + "type": "array", + "description": "List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.", + "items": { + "$ref": "#/definitions/SeedNode" + } + }, + "seedNodes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SeedNode" + }, + "description": "List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes." + }, + "externalDataCenters": { + "type": "array", + "description": "List of the data center names for unmanaged data centers in this cluster to be included in auto-replication.", + "items": { + "type": "string" + } + }, + "hoursBetweenBackups": { + "type": "integer", + "format": "int32", + "description": "(Deprecated) Number of hours to wait between taking a backup of the cluster." + }, + "deallocated": { + "type": "boolean", + "description": "Whether the cluster and associated data centers has been deallocated." + }, + "cassandraAuditLoggingEnabled": { + "type": "boolean", + "description": "Whether Cassandra audit logging is enabled" + }, + "clusterType": { + "type": "string", + "description": "Type of the cluster. If set to Production, some operations might not be permitted on cluster.", + "enum": [ + "Production", + "NonProduction" + ], + "x-ms-enum": { + "name": "ClusterType", + "modelAsString": true + } + }, + "provisionError": { + "$ref": "#/definitions/CassandraError", + "description": "Error related to resource provisioning." + }, + "extensions": { + "type": "array", + "description": "Extensions to be added or updated on cluster.", + "items": { + "type": "string" + } + }, + "backupSchedules": { + "type": "array", + "items": { + "$ref": "#/definitions/BackupSchedule" + }, + "description": "List of backup schedules that define when you want to back up your data." + }, + "scheduledEventStrategy": { + "type": "string", + "description": "How the nodes in the cluster react to scheduled events", + "enum": [ + "Ignore", + "StopAny", + "StopByRack" + ], + "x-ms-enum": { + "name": "ScheduledEventStrategy", + "modelAsString": true + } + }, + "azureConnectionMethod": { + "type": "string", + "description": "How to connect to the azure services needed for running the cluster", + "enum": [ + "None", + "VPN" + ], + "x-ms-enum": { + "name": "AzureConnectionType", + "modelAsString": true + } + }, + "privateLinkResourceId": { + "type": "string", + "readOnly": true, + "description": "If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to." + } + } + } + } + }, + "ManagedCassandraNodeStatus": { + "type": "string", + "description": "Indicates whether the node is functioning or not.", + "enum": [ + "Up", + "Down" + ], + "x-ms-enum": { + "name": "NodeStatus", + "modelAsString": true + } + }, + "ManagedCassandraNodeState": { + "type": "string", + "description": "The state of the node in Cassandra ring.", + "enum": [ + "Normal", + "Leaving", + "Joining", + "Moving", + "Stopped" + ], + "x-ms-enum": { + "name": "NodeState", + "modelAsString": true + } + }, + "CassandraClusterPublicStatus": { + "type": "object", + "description": "Properties of a managed Cassandra cluster public status.", + "properties": { + "eTag": { + "type": "string" + }, + "reaperStatus": { + "$ref": "#/definitions/ManagedCassandraReaperStatus" + }, + "connectionErrors": { + "type": "array", + "description": "List relevant information about any connection errors to the Datacenters.", + "items": { + "$ref": "#/definitions/ConnectionError" + } + }, + "errors": { + "type": "array", + "description": "List relevant information about any errors about cluster, data center and connection error.", + "items": { + "$ref": "#/definitions/CassandraError" + } + }, + "dataCenters": { + "type": "array", + "description": "List of the status of each datacenter in this cluster.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of this Datacenter." + }, + "seedNodes": { + "type": "array", + "description": "A list of all seed nodes in the cluster, managed and unmanaged.", + "items": { + "type": "string" + } + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { + "type": "string", + "description": "The node's IP address." + }, + "state": { + "$ref": "#/definitions/ManagedCassandraNodeState" + }, + "status": { + "type": "string" + }, + "cassandraProcessStatus": { + "type": "string", + "description": "Cassandra service status on this node" + }, + "load": { + "type": "string", + "description": "The amount of file system data in the data directory (e.g., 47.66 kB), excluding all content in the snapshots subdirectories. Because all SSTable data files are included, any data that is not cleaned up (such as TTL-expired cells or tombstones) is counted." + }, + "tokens": { + "type": "array", + "description": "List of tokens this node covers.", + "items": { + "type": "string" + } + }, + "size": { + "type": "integer", + "format": "int32" + }, + "hostID": { + "description": "The network ID of the node.", + "type": "string" + }, + "rack": { + "description": "The rack this node is part of.", + "type": "string" + }, + "timestamp": { + "description": "The timestamp when these statistics were captured.", + "type": "string" + }, + "diskUsedKB": { + "description": "The amount of disk used, in kB, of the directory /var/lib/cassandra.", + "type": "integer", + "format": "int64" + }, + "diskFreeKB": { + "description": "The amount of disk free, in kB, of the directory /var/lib/cassandra.", + "type": "integer", + "format": "int64" + }, + "memoryUsedKB": { + "description": "Used memory (calculated as total - free - buffers - cache), in kB.", + "type": "integer", + "format": "int64" + }, + "memoryBuffersAndCachedKB": { + "description": "Memory used by kernel buffers (Buffers in /proc/meminfo) and page cache and slabs (Cached and SReclaimable in /proc/meminfo), in kB.", + "type": "integer", + "format": "int64" + }, + "memoryFreeKB": { + "description": "Unused memory (MemFree and SwapFree in /proc/meminfo), in kB.", + "type": "integer", + "format": "int64" + }, + "memoryTotalKB": { + "description": "Total installed memory (MemTotal and SwapTotal in /proc/meminfo), in kB.", + "type": "integer", + "format": "int64" + }, + "cpuUsage": { + "description": "A float representing the current system-wide CPU utilization as a percentage.", + "type": "number", + "format": "double" + }, + "isLatestModel": { + "type": "boolean", + "description": "If node has been updated to latest model" + } + } + } + } + } + } + } + } + }, + "ManagedCassandraReaperStatus": { + "type": "object", + "properties": { + "healthy": { + "type": "boolean" + }, + "repairRunIds": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repairSchedules": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ConnectionError": { + "type": "object", + "properties": { + "connectionState": { + "description": "The kind of connection error that occurred.", + "type": "string", + "enum": [ + "Unknown", + "OK", + "OperatorToDataCenterNetworkError", + "DatacenterToDatacenterNetworkError", + "InternalOperatorToDataCenterCertificateError", + "InternalError" + ], + "x-ms-enum": { + "name": "ConnectionState", + "modelAsString": true + } + }, + "iPFrom": { + "description": "The IP of host that originated the failed connection.", + "type": "string" + }, + "iPTo": { + "description": "The IP that the connection attempted to reach.", + "type": "string" + }, + "port": { + "description": "The TCP port the connection was attempted on.", + "type": "integer", + "format": "int32" + }, + "exception": { + "description": "Detailed error message about the failed connection.", + "type": "string" + } + } + }, + "CassandraError": { + "type": "object", + "properties": { + "code": { + "description": "The code of error that occurred.", + "type": "string" + }, + "message": { + "description": "The message of the error.", + "type": "string" + }, + "target": { + "description": "The target resource of the error.", + "type": "string" + }, + "additionalErrorInfo": { + "description": "Additional information about the error.", + "type": "string" + } + } + }, + "CommandPostBody": { + "description": "Specification of which command to run where", + "type": "object", + "required": [ + "command", + "host" + ], + "properties": { + "command": { + "type": "string", + "description": "The command which should be run" + }, + "arguments": { + "type": "object", + "description": "The arguments for the command to be run" + }, + "host": { + "type": "string", + "description": "IP address of the cassandra host to run the command on" + }, + "cassandra-stop-start": { + "type": "boolean", + "description": "If true, stops cassandra before executing the command and then start it again" + }, + "readWrite": { + "type": "boolean", + "description": "If true, allows the command to *write* to the cassandra directory, otherwise read-only." + } + } + }, + "CommandPublicResource": { + "description": "resource representing a command", + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command which should be run" + }, + "commandId": { + "type": "string", + "description": "The unique id of command" + }, + "arguments": { + "type": "object", + "description": "The arguments for the command to be run" + }, + "host": { + "type": "string", + "description": "IP address of the cassandra host to run the command on" + }, + "isAdmin": { + "type": "boolean", + "description": "Whether command has admin privileges" + }, + "cassandraStopStart": { + "type": "boolean", + "description": "If true, stops cassandra before executing the command and then start it again" + }, + "readWrite": { + "type": "boolean", + "description": "If true, allows the command to *write* to the cassandra directory, otherwise read-only." + }, + "result": { + "type": "string", + "description": "Result output of the command." + }, + "status": { + "type": "string", + "description": "Status of the command.", + "enum": [ + "Done", + "Running", + "Enqueue", + "Processing", + "Finished", + "Failed" + ], + "x-ms-enum": { + "name": "CommandStatus", + "modelAsString": true + } + }, + "outputFile": { + "type": "string", + "description": "The name of the file where the result is written." + } + } + }, + "ListCommands": { + "description": "List of commands for cluster.", + "type": "object", + "properties": { + "value": { + "description": "Container for array of commands.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CommandPublicResource" + } + } + } + }, + "CommandOutput": { + "description": "Response of /command api", + "type": "object", + "properties": { + "commandOutput": { + "type": "string", + "description": "Output of the command." + } + } + }, + "ListDataCenters": { + "description": "List of managed Cassandra data centers and their properties.", + "type": "object", + "properties": { + "value": { + "description": "Container for array of data centers.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/DataCenterResource" + } + } + } + }, + "BackupResource": { + "description": "A restorable backup of a Cassandra cluster.", + "type": "object", + "properties": { + "backupId": { + "description": "The unique identifier of backup.", + "type": "string" + }, + "backupState": { + "description": "The current state of the backup.", + "type": "string", + "enum": [ + "Initiated", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "BackupState", + "modelAsString": true + } + }, + "backupStartTimestamp": { + "description": "The time at which the backup process begins.", + "type": "string", + "format": "date-time" + }, + "backupStopTimestamp": { + "description": "The time at which the backup process ends.", + "type": "string", + "format": "date-time" + }, + "backupExpiryTimestamp": { + "description": "The time at which the backup will expire.", + "type": "string", + "format": "date-time" + } + } + }, + "ListBackups": { + "description": "List of restorable backups for a Cassandra cluster.", + "type": "object", + "properties": { + "value": { + "description": "Container for array of backups.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BackupResource" + } + } + } + }, + "SeedNode": { + "type": "object", + "properties": { + "ipAddress": { + "description": "IP address of this seed node.", + "type": "string" + } + } + }, + "Certificate": { + "type": "object", + "properties": { + "pem": { + "description": "PEM formatted public key.", + "type": "string" + } + } + }, + "BackupSchedule": { + "type": "object", + "properties": { + "scheduleName": { + "description": "The unique identifier of backup schedule.", + "type": "string" + }, + "cronExpression": { + "description": "The cron expression that defines when you want to back up your data.", + "type": "string" + }, + "retentionInHours": { + "description": "The retention period (hours) of the backups. If you want to retain data forever, set retention to 0.", + "type": "integer", + "format": "int32" + } + } + }, + "DataCenterResource": { + "description": "A managed Cassandra data center.", + "type": "object", + "allOf": [ + { + "$ref": "cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "properties": { + "properties": { + "description": "Properties of a managed Cassandra data center.", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ManagedCassandraProvisioningState" + }, + "dataCenterLocation": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "description": "The region this data center should be created in." + }, + "delegatedSubnetId": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "description": "Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'." + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster." + }, + "seedNodes": { + "readOnly": true, + "type": "array", + "description": "IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster.", + "items": { + "$ref": "#/definitions/SeedNode" + } + }, + "base64EncodedCassandraYamlFragment": { + "type": "string", + "description": "A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed." + }, + "managedDiskCustomerKeyUri": { + "type": "string", + "description": "Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key." + }, + "backupStorageCustomerKeyUri": { + "type": "string", + "description": "Indicates the Key Uri of the customer key to use for encryption of the backup storage account." + }, + "sku": { + "type": "string", + "description": "Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2" + }, + "diskSku": { + "type": "string", + "description": "Disk SKU used for data centers. Default value is P30." + }, + "diskCapacity": { + "type": "integer", + "format": "int32", + "description": "Number of disks attached to each node. Default is 4." + }, + "availabilityZone": { + "type": "boolean", + "description": "If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines." + }, + "authenticationMethodLdapProperties": { + "$ref": "#/definitions/AuthenticationMethodLdapProperties" + }, + "deallocated": { + "type": "boolean", + "description": "Whether the data center has been deallocated." + }, + "provisionError": { + "$ref": "#/definitions/CassandraError", + "description": "Error related to resource provisioning." + }, + "privateEndpointIpAddress": { + "type": "string", + "description": "Ip of the VPN Endpoint for this data center." + } + } + } + } + }, + "AuthenticationMethodLdapProperties": { + "type": "object", + "description": "Ldap authentication method properties. This feature is in preview.", + "properties": { + "serverHostname": { + "description": "Hostname of the LDAP server.", + "type": "string" + }, + "serverPort": { + "description": "Port of the LDAP server.", + "type": "integer", + "format": "int32" + }, + "serviceUserDistinguishedName": { + "description": "Distinguished name of the look up user account, who can look up user details on authentication.", + "type": "string" + }, + "serviceUserPassword": { + "description": "Password of the look up user.", + "type": "string" + }, + "searchBaseDistinguishedName": { + "description": "Distinguished name of the object to start the recursive search of users from.", + "type": "string" + }, + "searchFilterTemplate": { + "description": "Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.", + "type": "string" + }, + "serverCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "connectionTimeoutInMs": { + "description": "Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.", + "type": "integer", + "format": "int32" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/mongoCluster.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/mongoCluster.json new file mode 100644 index 000000000000..78507b55043b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/mongoCluster.json @@ -0,0 +1,988 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Cosmos DB for MongoDB vCore", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules.", + "version": "2024-02-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.DocumentDB/mongoClusters": { + "get": { + "tags": [ + "MongoClusters" + ], + "operationId": "MongoClusters_List", + "x-ms-examples": { + "List all the mongo clusters": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterList.json" + } + }, + "description": "List all the mongo clusters in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The mongo clusters were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters": { + "get": { + "tags": [ + "MongoClusters" + ], + "operationId": "MongoClusters_ListByResourceGroup", + "x-ms-examples": { + "List the mongo clusters by resource group": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterListByResourceGroup.json" + } + }, + "description": "List all the mongo clusters in a given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The mongo clusters were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}": { + "put": { + "description": "Create or update a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.", + "tags": [ + "MongoClusters" + ], + "operationId": "MongoClusters_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create a new mongo cluster": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterCreate.json" + }, + "Create a new mongo cluster with point in time restore": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterCreatePITR.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MongoClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MongoCluster" + }, + "description": "The required parameters for creating or updating a mongo cluster." + } + ], + "responses": { + "200": { + "description": "OK. The mongo cluster request has no updates for the resource.", + "schema": { + "$ref": "#/definitions/MongoCluster" + } + }, + "201": { + "description": "The mongo cluster is being created or updated asynchronously. Poll for provisioningState=Succeeded to find when the operation completes.", + "schema": { + "$ref": "#/definitions/MongoCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "description": "Gets information about a mongo cluster.", + "tags": [ + "MongoClusters" + ], + "operationId": "MongoClusters_Get", + "x-ms-examples": { + "Get the mongo cluster": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MongoClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The mongo cluster properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "description": "Deletes a mongo cluster.", + "tags": [ + "MongoClusters" + ], + "operationId": "MongoClusters_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete the mongo cluster": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MongoClusterNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The mongo cluster is being deleted asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The mongo cluster does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "description": "Updates an existing mongo cluster. The request body can contain one to many of the properties present in the normal mongo cluster definition.", + "tags": [ + "MongoClusters" + ], + "operationId": "MongoClusters_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Update the mongo cluster": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterUpdate.json" + }, + "Add new shard nodes": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterAddNode.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MongoClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MongoClusterUpdate" + }, + "description": "The parameters for updating a mongo cluster." + } + ], + "responses": { + "200": { + "description": "OK. The request has no changes for the mongo cluster.", + "schema": { + "$ref": "#/definitions/MongoCluster" + } + }, + "202": { + "description": "Accepted. The mongo cluster update will be completed asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName}": { + "put": { + "description": "Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.", + "tags": [ + "FirewallRules" + ], + "operationId": "MongoClusters_CreateOrUpdateFirewallRule", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create a firewall rule of the mongo cluster": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleCreate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MongoClusterNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The required parameters for creating or updating a firewall rule." + } + ], + "responses": { + "200": { + "description": "OK. The firewall request has no updates for the resource.", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "201": { + "description": "The firewall rule is being created or updated asynchronously. Poll for provisioningState=Succeeded to find when the operation completes.", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "description": "Deletes a mongo cluster firewall rule.", + "tags": [ + "FirewallRules" + ], + "operationId": "MongoClusters_DeleteFirewallRule", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete the firewall rule of the mongo cluster": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MongoClusterNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "204": { + "description": "No Content. The firewall rule does not exist." + }, + "202": { + "description": "Accepted. The firewall rule is being deleted asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "description": "Gets information about a mongo cluster firewall rule.", + "tags": [ + "FirewallRules" + ], + "operationId": "MongoClusters_GetFirewallRule", + "x-ms-examples": { + "Get the firewall rule of the mongo cluster": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MongoClusterNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The firewall rule was retrieved successfully", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules": { + "get": { + "description": "List all the firewall rules in a given mongo cluster.", + "tags": [ + "FirewallRules" + ], + "operationId": "MongoClusters_ListFirewallRules", + "x-ms-examples": { + "List firewall rules of the mongo cluster": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterFirewallRuleList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MongoClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The firewall rules were retrieved successfully", + "schema": { + "$ref": "#/definitions/FirewallRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/checkMongoClusterNameAvailability": { + "post": { + "description": "Check the availability of name for resource", + "tags": [ + "MongoClusters" + ], + "operationId": "MongoClusters_CheckNameAvailability", + "x-ms-examples": { + "Check name availability": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterNameAvailability.json" + }, + "Check name availability already exists result": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterNameAvailability_AlreadyExists.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK. Check availability returned successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/listConnectionStrings": { + "post": { + "description": "List mongo cluster connection strings. This includes the default connection string using SCRAM-SHA-256, as well as other connection strings supported by the cluster.", + "tags": [ + "MongoClusterOperations" + ], + "operationId": "MongoClusters_ListConnectionStrings", + "x-ms-examples": { + "Get connection string": { + "$ref": "./examples/mongo-cluster/CosmosDBMongoClusterListConnectionStrings.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MongoClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ListConnectionStringsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ProvisioningState": { + "description": "The provisioning state of the resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress", + "Updating", + "Dropping" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "MongoClusterStatus": { + "description": "The status of the resource at the time the operation was called.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Updating", + "Starting", + "Stopping", + "Stopped", + "Dropping" + ], + "x-ms-enum": { + "name": "MongoClusterStatus", + "modelAsString": true + }, + "readOnly": true + }, + "MongoClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MongoCluster" + }, + "description": "The list of mongo clusters" + }, + "nextLink": { + "description": "The link used to get the next page of results.", + "type": "string", + "readOnly": true + } + }, + "description": "A list of mongo clusters." + }, + "MongoCluster": { + "type": "object", + "description": "Represents a mongo cluster resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MongoClusterProperties", + "x-ms-client-flatten": true, + "description": "Properties of the mongo cluster." + } + } + }, + "MongoClusterUpdate": { + "type": "object", + "description": "Represents a mongo cluster resource for updates.", + "properties": { + "properties": { + "$ref": "#/definitions/MongoClusterProperties", + "x-ms-client-flatten": true, + "description": "Properties of the mongo cluster." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + } + }, + "MongoClusterProperties": { + "type": "object", + "description": "The properties of a mongo cluster.", + "properties": { + "createMode": { + "type": "string", + "description": "The mode to create a mongo cluster.", + "enum": [ + "Default", + "PointInTimeRestore" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "create" + ], + "default": "Default" + }, + "restoreParameters": { + "$ref": "#/definitions/MongoClusterRestoreParameters", + "description": "Parameters used for restore operations", + "x-ms-mutability": [ + "create" + ] + }, + "administratorLogin": { + "type": "string", + "description": "The administrator's login for the mongo cluster.", + "x-ms-mutability": [ + "create", + "update", + "read" + ] + }, + "administratorLoginPassword": { + "type": "string", + "x-ms-secret": true, + "format": "password", + "x-ms-mutability": [ + "create", + "update" + ], + "description": "The password of the administrator login." + }, + "serverVersion": { + "type": "string", + "description": "The Mongo DB server version. Defaults to the latest available version if not specified." + }, + "connectionString": { + "type": "string", + "readOnly": true, + "description": "The default mongo connection string for the cluster." + }, + "earliestRestoreTime": { + "type": "string", + "readOnly": true, + "description": "Earliest restore timestamp in UTC ISO8601 format." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "A provisioning state of the mongo cluster.", + "readOnly": true + }, + "clusterStatus": { + "$ref": "#/definitions/MongoClusterStatus", + "description": "A status of the mongo cluster." + }, + "nodeGroupSpecs": { + "$ref": "#/definitions/NodeGroupSpecList", + "description": "The list of node group specs in the cluster." + } + } + }, + "NodeGroupSpecList": { + "type": "array", + "description": "The list of node group specifications for the cluster. Must include one node group spec with kind = 'Shard'.", + "items": { + "$ref": "#/definitions/NodeGroupSpec" + }, + "x-ms-identifiers": [], + "minItems": 1 + }, + "NodeGroupSpec": { + "type": "object", + "description": "Specification for a node group.", + "allOf": [ + { + "$ref": "#/definitions/NodeGroupProperties" + } + ], + "properties": { + "kind": { + "$ref": "#/definitions/NodeKind", + "description": "The node type deployed in the node group." + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the node group." + } + } + }, + "NodeKind": { + "type": "string", + "description": "The kind of a node in the mongo cluster.", + "enum": [ + "Shard" + ], + "x-ms-enum": { + "name": "NodeKind", + "modelAsString": true + } + }, + "NodeGroupProperties": { + "type": "object", + "description": "The properties of the node group on a cluster.", + "properties": { + "sku": { + "type": "string", + "description": "The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'." + }, + "diskSizeGB": { + "type": "integer", + "format": "int64", + "description": "The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024." + }, + "enableHa": { + "type": "boolean", + "description": "Whether high availability is enabled on the node group." + } + } + }, + "FirewallRuleProperties": { + "type": "object", + "description": "The properties of a mongo cluster firewall rule.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the firewall rule.", + "readOnly": true + }, + "startIpAddress": { + "type": "string", + "description": "The start IP address of the mongo cluster firewall rule. Must be IPv4 format.", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + }, + "endIpAddress": { + "type": "string", + "description": "The end IP address of the mongo cluster firewall rule. Must be IPv4 format.", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + } + }, + "required": [ + "startIpAddress", + "endIpAddress" + ] + }, + "FirewallRule": { + "type": "object", + "description": "Represents a mongo cluster firewall rule.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FirewallRuleProperties", + "x-ms-client-flatten": true, + "description": "The properties of a firewall rule." + } + }, + "required": [ + "properties" + ] + }, + "FirewallRuleListResult": { + "type": "object", + "description": "A list of firewall rules.", + "properties": { + "value": { + "type": "array", + "description": "The list of firewall rules in a mongo cluster.", + "items": { + "$ref": "#/definitions/FirewallRule" + } + }, + "nextLink": { + "description": "The link used to get the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ConnectionString": { + "type": "object", + "description": "Connection string for the mongo cluster", + "properties": { + "connectionString": { + "readOnly": true, + "type": "string", + "description": "Value of the connection string" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description of the connection string" + } + } + }, + "ListConnectionStringsResult": { + "type": "object", + "description": "The connection strings for the given mongo cluster.", + "properties": { + "connectionStrings": { + "readOnly": true, + "type": "array", + "description": "An array that contains the connection strings for a mongo cluster.", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ConnectionString" + } + } + } + }, + "MongoClusterRestoreParameters": { + "type": "object", + "description": "Parameters used for restore operations", + "properties": { + "pointInTimeUTC": { + "type": "string", + "format": "date-time", + "description": "UTC point in time to restore a mongo cluster" + }, + "sourceResourceId": { + "type": "string", + "description": "Resource ID to locate the source cluster to restore" + } + } + } + }, + "parameters": { + "MongoClusterNameParameter": { + "name": "mongoClusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the mongo cluster.", + "minLength": 3, + "maxLength": 40, + "x-ms-parameter-location": "method", + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "FirewallRuleNameParameter": { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[a-zA-Z0-9][-_.a-zA-Z0-9]*", + "description": "The name of the mongo cluster firewall rule.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/mongorbac.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/mongorbac.json new file mode 100644 index 000000000000..05925b159e7f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/mongorbac.json @@ -0,0 +1,616 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB API for MongoDB Role Based Access Control Resource Provider REST API", + "version": "2024-02-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.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}": { + "get": { + "operationId": "MongoDBResources_GetMongoRoleDefinition", + "x-ms-examples": { + "CosmosDBMongoRoleDefinitionGet": { + "$ref": "./examples/CosmosDBMongoDBRoleDefinitionGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.", + "parameters": [ + { + "$ref": "#/parameters/mongoRoleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Mongo Role Definition was successfully retrieved.", + "schema": { + "$ref": "#/definitions/MongoRoleDefinitionGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_CreateUpdateMongoRoleDefinition", + "x-ms-examples": { + "CosmosDBMongoDBRoleDefinitionCreateUpdate": { + "$ref": "./examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Creates or updates an Azure Cosmos DB Mongo Role Definition.", + "parameters": [ + { + "$ref": "#/parameters/mongoRoleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateMongoRoleDefinitionParameters", + "in": "body", + "required": true, + "description": "The properties required to create or update a Role Definition.", + "schema": { + "$ref": "#/definitions/MongoRoleDefinitionCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Mongo Role Definition create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/MongoRoleDefinitionGetResults" + } + }, + "202": { + "description": "The Mongo Role Definition create or update request was accepted and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "MongoDBResources_DeleteMongoRoleDefinition", + "x-ms-examples": { + "CosmosDBMongoDBRoleDefinitionDelete": { + "$ref": "./examples/CosmosDBMongoDBRoleDefinitionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes an existing Azure Cosmos DB Mongo Role Definition.", + "parameters": [ + { + "$ref": "#/parameters/mongoRoleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Mongo Role Definition delete operation was completed successfully." + }, + "202": { + "description": "The Mongo Role Definition delete request was accepted and will complete asynchronously." + }, + "204": { + "description": "The requested Mongo Role Definition does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions": { + "get": { + "operationId": "MongoDBResources_ListMongoRoleDefinitions", + "x-ms-examples": { + "CosmosDBMongoDBRoleDefinitionList": { + "$ref": "./examples/CosmosDBMongoDBRoleDefinitionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the list of all Azure Cosmos DB Mongo Role Definitions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list operation completed successfully.", + "schema": { + "$ref": "#/definitions/MongoRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}": { + "get": { + "operationId": "MongoDBResources_GetMongoUserDefinition", + "x-ms-examples": { + "CosmosDBMongoDBUserDefinitionGet": { + "$ref": "./examples/CosmosDBMongoDBUserDefinitionGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.", + "parameters": [ + { + "$ref": "#/parameters/mongoUserDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The User Definition was successfully retrieved.", + "schema": { + "$ref": "#/definitions/MongoUserDefinitionGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_CreateUpdateMongoUserDefinition", + "x-ms-examples": { + "CosmosDBMongoDBUserDefinitionCreateUpdate": { + "$ref": "./examples/CosmosDBMongoDBUserDefinitionCreateUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Creates or updates an Azure Cosmos DB Mongo User Definition.", + "parameters": [ + { + "$ref": "#/parameters/mongoUserDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateMongoUserDefinitionParameters", + "in": "body", + "required": true, + "description": "The properties required to create or update a User Definition.", + "schema": { + "$ref": "#/definitions/MongoUserDefinitionCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The User Definition create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/MongoUserDefinitionGetResults" + } + }, + "202": { + "description": "The User Definition create or update request was accepted and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "MongoDBResources_DeleteMongoUserDefinition", + "x-ms-examples": { + "CosmosDBMongoDBUserDefinitionDelete": { + "$ref": "./examples/CosmosDBMongoDBUserDefinitionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes an existing Azure Cosmos DB Mongo User Definition.", + "parameters": [ + { + "$ref": "#/parameters/mongoUserDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The User Definition delete operation was completed successfully." + }, + "202": { + "description": "The User Definition delete request was accepted and will complete asynchronously." + }, + "204": { + "description": "The requested User Definition does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions": { + "get": { + "operationId": "MongoDBResources_ListMongoUserDefinitions", + "x-ms-examples": { + "CosmosDBMongoDBUserDefinitionList": { + "$ref": "./examples/CosmosDBMongoDBUserDefinitionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the list of all Azure Cosmos DB Mongo User Definition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list operation completed successfully.", + "schema": { + "$ref": "#/definitions/MongoUserDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "MongoRoleDefinitionResource": { + "type": "object", + "properties": { + "roleName": { + "type": "string", + "description": "A user-friendly name for the Role Definition. Must be unique for the database account." + }, + "type": { + "type": "string", + "enum": [ + "BuiltInRole", + "CustomRole" + ], + "description": "Indicates whether the Role Definition was built-in or user created.", + "x-ms-enum": { + "name": "MongoRoleDefinitionType", + "modelAsString": false + } + }, + "databaseName": { + "type": "string", + "description": "The database name for which access is being granted for this Role Definition." + }, + "privileges": { + "type": "array", + "items": { + "$ref": "#/definitions/Privilege" + }, + "description": "A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege." + }, + "roles": { + "type": "array", + "items": { + "$ref": "#/definitions/Role" + }, + "description": "The set of roles inherited by this Role Definition." + } + }, + "description": "Azure Cosmos DB Mongo Role Definition resource object." + }, + "MongoRoleDefinitionCreateUpdateParameters": { + "description": "Parameters to create and update an Azure Cosmos DB Mongo Role Definition.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update an Azure Cosmos DB Mongo Role Definition.", + "$ref": "#/definitions/MongoRoleDefinitionResource" + } + } + }, + "MongoRoleDefinitionGetResults": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoRoleDefinitionResource", + "description": "Properties related to the Mongo Role Definition." + } + }, + "allOf": [ + { + "$ref": "cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "description": "An Azure Cosmos DB Mongo Role Definition." + }, + "Privilege": { + "type": "object", + "properties": { + "resource": { + "type": "object", + "properties": { + "db": { + "type": "string", + "description": "The database name the role is applied." + }, + "collection": { + "type": "string", + "description": "The collection name the role is applied." + } + }, + "description": "An Azure Cosmos DB Mongo DB Resource." + }, + "actions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of actions that are allowed." + } + }, + "description": "The set of data plane operations permitted through this Role Definition." + }, + "Role": { + "type": "object", + "properties": { + "db": { + "type": "string", + "description": "The database name the role is applied." + }, + "role": { + "type": "string", + "description": "The role name." + } + }, + "description": "The set of roles permitted through this Role Definition." + }, + "MongoRoleDefinitionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MongoRoleDefinitionGetResults" + }, + "description": "List of Mongo Role Definitions and their properties." + } + }, + "description": "The relevant Mongo Role Definitions." + }, + "MongoUserDefinitionResource": { + "type": "object", + "properties": { + "userName": { + "type": "string", + "description": "The user name for User Definition." + }, + "password": { + "type": "string", + "description": "The password for User Definition. Response does not contain user password." + }, + "databaseName": { + "type": "string", + "description": "The database name for which access is being granted for this User Definition." + }, + "customData": { + "type": "string", + "description": "A custom definition for the USer Definition." + }, + "roles": { + "type": "array", + "items": { + "$ref": "#/definitions/Role" + }, + "description": "The set of roles inherited by the User Definition." + }, + "mechanisms": { + "type": "string", + "description": "The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256." + } + }, + "description": "Azure Cosmos DB Mongo User Definition resource object." + }, + "MongoUserDefinitionCreateUpdateParameters": { + "description": "Parameters to create and update an Azure Cosmos DB Mongo User Definition.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update an Azure Cosmos DB Mongo User Definition.", + "$ref": "#/definitions/MongoUserDefinitionResource" + } + } + }, + "MongoUserDefinitionGetResults": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoUserDefinitionResource", + "description": "Properties related to the User Definition." + } + }, + "allOf": [ + { + "$ref": "cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "description": "An Azure Cosmos DB User Definition" + }, + "MongoUserDefinitionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MongoUserDefinitionGetResults" + }, + "description": "List of User Definition and their properties" + } + }, + "description": "The relevant User Definition." + } + }, + "parameters": { + "mongoRoleDefinitionIdParameter": { + "name": "mongoRoleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The ID for the Role Definition {dbName.roleName}." + }, + "mongoUserDefinitionIdParameter": { + "name": "mongoUserDefinitionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The ID for the User Definition {dbName.userName}." + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/notebook.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/notebook.json new file mode 100644 index 000000000000..95bf7fc347ea --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/notebook.json @@ -0,0 +1,461 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2024-02-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.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces": { + "get": { + "tags": [ + "NotebookWorkspacesResource" + ], + "description": "Gets the notebook workspace resources of an existing Cosmos DB account.", + "operationId": "NotebookWorkspaces_ListByDatabaseAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved notebook workspace resources.", + "schema": { + "$ref": "#/definitions/NotebookWorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceList": { + "$ref": "./examples/CosmosDBNotebookWorkspaceList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}": { + "get": { + "tags": [ + "NotebookWorkspacesResource" + ], + "description": "Gets the notebook workspace for a Cosmos DB account.", + "operationId": "NotebookWorkspaces_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified notebook workspace resource.", + "schema": { + "$ref": "#/definitions/NotebookWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceGet": { + "$ref": "./examples/CosmosDBNotebookWorkspaceGet.json" + } + } + }, + "put": { + "tags": [ + "NotebookWorkspacesResource" + ], + "description": "Creates the notebook workspace for a Cosmos DB account.", + "operationId": "NotebookWorkspaces_CreateOrUpdate", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + }, + { + "name": "notebookCreateUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NotebookWorkspaceCreateUpdateParameters" + }, + "description": "The notebook workspace to create for the current database account." + } + ], + "responses": { + "200": { + "description": "Creation of notebook workspace will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NotebookWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceCreate": { + "$ref": "./examples/CosmosDBNotebookWorkspaceCreate.json" + } + } + }, + "delete": { + "tags": [ + "NotebookWorkspacesResource" + ], + "description": "Deletes the notebook workspace for a Cosmos DB account.", + "operationId": "NotebookWorkspaces_Delete", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "202": { + "description": "The notebook workspace delete operation will complete asynchronously." + }, + "204": { + "description": "The specified notebook workspace does not exist in the database account." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceDelete": { + "$ref": "./examples/CosmosDBNotebookWorkspaceDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/listConnectionInfo": { + "post": { + "tags": [ + "NotebookWorkspacesResource" + ], + "operationId": "NotebookWorkspaces_ListConnectionInfo", + "x-ms-examples": { + "CosmosDBNotebookWorkspaceListConnectionInfo": { + "$ref": "./examples/CosmosDBNotebookWorkspaceListConnectionInfo.json" + } + }, + "description": "Retrieves the connection info for the notebook workspace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NotebookWorkspaceConnectionInfoResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cosmos-db.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/regenerateAuthToken": { + "post": { + "tags": [ + "NotebookWorkspacesResource" + ], + "operationId": "NotebookWorkspaces_RegenerateAuthToken", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceRegenerateAuthToken": { + "$ref": "./examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json" + } + }, + "description": "Regenerates the auth token for the notebook workspace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The regenerate auth token operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cosmos-db.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/start": { + "post": { + "tags": [ + "NotebookWorkspacesResource" + ], + "operationId": "NotebookWorkspaces_Start", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceStart": { + "$ref": "./examples/CosmosDBNotebookWorkspaceStart.json" + } + }, + "description": "Starts the notebook workspace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The start operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cosmos-db.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "NotebookWorkspaceCreateUpdateParameters": { + "description": "Parameters to create a notebook workspace resource", + "type": "object", + "allOf": [ + { + "$ref": "./cosmos-db.json#/definitions/ARMProxyResource" + } + ] + }, + "NotebookWorkspaceListResult": { + "description": "A list of notebook workspace resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of notebook workspace resources", + "items": { + "$ref": "#/definitions/NotebookWorkspace" + } + } + } + }, + "NotebookWorkspace": { + "description": "A notebook workspace resource", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/NotebookWorkspaceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "./cosmos-db.json#/definitions/ARMProxyResource" + } + ] + }, + "NotebookWorkspaceProperties": { + "description": "Properties of a notebook workspace resource.", + "type": "object", + "properties": { + "notebookServerEndpoint": { + "description": "Specifies the endpoint of Notebook server.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.", + "type": "string", + "readOnly": true + } + } + }, + "NotebookWorkspaceConnectionInfoResult": { + "description": "The connection info for the given notebook workspace", + "properties": { + "authToken": { + "type": "string", + "description": "Specifies auth token used for connecting to Notebook server (uses token-based auth).", + "readOnly": true + }, + "notebookServerEndpoint": { + "type": "string", + "description": "Specifies the endpoint of Notebook server.", + "readOnly": true + } + } + } + }, + "parameters": { + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database account name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "NotebookWorkspaceNameParameter": { + "name": "notebookWorkspaceName", + "in": "path", + "description": "The name of the notebook workspace resource.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "NotebookWorkspaceName", + "modelAsString": true + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/privateEndpointConnection.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/privateEndpointConnection.json new file mode 100644 index 000000000000..6d744b72a42d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/privateEndpointConnection.json @@ -0,0 +1,318 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2024-02-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.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "List all private endpoint connections on a Cosmos DB account.", + "operationId": "PrivateEndpointConnections_ListByDatabaseAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/CosmosDBPrivateEndpointConnectionListGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/CosmosDBPrivateEndpointConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Approve or reject a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted. The private endpoint connection update will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Approve or reject a private endpoint connection with a given name.": { + "$ref": "./examples/CosmosDBPrivateEndpointConnectionUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The private endpoint connection delete will complete asynchronously." + }, + "204": { + "description": "Private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a private endpoint connection with a given name.": { + "$ref": "./examples/CosmosDBPrivateEndpointConnectionDelete.json" + } + } + } + } + }, + "definitions": { + "PrivateEndpointConnectionListResult": { + "description": "A list of private endpoint connections", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "Properties of a private endpoint connection.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpointProperty", + "description": "Private endpoint which the connection belongs to." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStateProperty", + "description": "Connection State of the Private Endpoint Connection." + }, + "groupId": { + "type": "string", + "description": "Group id of the private endpoint." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the private endpoint." + } + } + }, + "PrivateEndpointProperty": { + "type": "object", + "description": "Private endpoint which the connection belongs to.", + "properties": { + "id": { + "type": "string", + "description": "Resource id of the private endpoint." + } + } + }, + "PrivateLinkServiceConnectionStateProperty": { + "type": "object", + "description": "Connection State of the Private Endpoint Connection.", + "properties": { + "status": { + "type": "string", + "description": "The private link service connection status." + }, + "description": { + "type": "string", + "description": "The private link service connection description." + }, + "actionsRequired": { + "type": "string", + "description": "Any action that is required beyond basic workflow (approve/ reject/ disconnect)", + "readOnly": true + } + } + } + }, + "parameters": { + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database account name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the private endpoint connection." + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/privateLinkResources.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/privateLinkResources.json new file mode 100644 index 000000000000..17a58a42a18f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/privateLinkResources.json @@ -0,0 +1,195 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2024-02-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.DocumentDB/databaseAccounts/{accountName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Cosmos DB account.", + "operationId": "PrivateLinkResources_ListByDatabaseAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/CosmosDBPrivateLinkResourceListGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Cosmos DB account.", + "operationId": "PrivateLinkResources_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/GroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private link resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/CosmosDBPrivateLinkResourceGet.json" + } + } + } + } + }, + "definitions": { + "PrivateLinkResourceListResult": { + "description": "A list of private link resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "./cosmos-db.json#/definitions/ARMProxyResource" + } + ] + }, + "PrivateLinkResourceProperties": { + "description": "Properties of a private link resource.", + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "description": "The private link resource required zone names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database account name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "GroupNameParameter": { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/rbac.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/rbac.json new file mode 100644 index 000000000000..e8810a8e8c76 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/rbac.json @@ -0,0 +1,573 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Role Based Access Control Resource Provider REST API", + "version": "2024-02-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.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}": { + "get": { + "operationId": "SqlResources_GetSqlRoleDefinition", + "x-ms-examples": { + "CosmosDBSqlRoleDefinitionGet": { + "$ref": "./examples/CosmosDBSqlRoleDefinitionGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.", + "parameters": [ + { + "$ref": "#/parameters/roleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Role Definition was successfully retrieved.", + "schema": { + "$ref": "#/definitions/SqlRoleDefinitionGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlRoleDefinition", + "x-ms-examples": { + "CosmosDBSqlRoleDefinitionCreateUpdate": { + "$ref": "./examples/CosmosDBSqlRoleDefinitionCreateUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Creates or updates an Azure Cosmos DB SQL Role Definition.", + "parameters": [ + { + "$ref": "#/parameters/roleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlRoleDefinitionParameters", + "in": "body", + "required": true, + "description": "The properties required to create or update a Role Definition.", + "schema": { + "$ref": "#/definitions/SqlRoleDefinitionCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Role Definition create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRoleDefinitionGetResults" + } + }, + "202": { + "description": "The Role Definition create or update request was accepted and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlRoleDefinition", + "x-ms-examples": { + "CosmosDBSqlRoleDefinitionDelete": { + "$ref": "./examples/CosmosDBSqlRoleDefinitionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes an existing Azure Cosmos DB SQL Role Definition.", + "parameters": [ + { + "$ref": "#/parameters/roleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Role Definition delete operation was completed successfully." + }, + "202": { + "description": "The Role Definition delete request was accepted and will complete asynchronously." + }, + "204": { + "description": "The requested Role Definition does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions": { + "get": { + "operationId": "SqlResources_ListSqlRoleDefinitions", + "x-ms-examples": { + "CosmosDBSqlRoleDefinitionList": { + "$ref": "./examples/CosmosDBSqlRoleDefinitionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the list of all Azure Cosmos DB SQL Role Definitions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}": { + "get": { + "operationId": "SqlResources_GetSqlRoleAssignment", + "x-ms-examples": { + "CosmosDBSqlRoleAssignmentGet": { + "$ref": "./examples/CosmosDBSqlRoleAssignmentGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.", + "parameters": [ + { + "$ref": "#/parameters/roleAssignmentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Role Assignment was successfully retrieved.", + "schema": { + "$ref": "#/definitions/SqlRoleAssignmentGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlRoleAssignment", + "x-ms-examples": { + "CosmosDBSqlRoleAssignmentCreateUpdate": { + "$ref": "./examples/CosmosDBSqlRoleAssignmentCreateUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Creates or updates an Azure Cosmos DB SQL Role Assignment.", + "parameters": [ + { + "$ref": "#/parameters/roleAssignmentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlRoleAssignmentParameters", + "in": "body", + "required": true, + "description": "The properties required to create or update a Role Assignment.", + "schema": { + "$ref": "#/definitions/SqlRoleAssignmentCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Role Assignment create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRoleAssignmentGetResults" + } + }, + "202": { + "description": "The Role Assignment create or update request was accepted and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlRoleAssignment", + "x-ms-examples": { + "CosmosDBSqlRoleAssignmentDelete": { + "$ref": "./examples/CosmosDBSqlRoleAssignmentDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes an existing Azure Cosmos DB SQL Role Assignment.", + "parameters": [ + { + "$ref": "#/parameters/roleAssignmentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Role Assignment delete operation was completed successfully." + }, + "202": { + "description": "The Role Assignment delete request was accepted and will complete asynchronously." + }, + "204": { + "description": "The requested Role Assignment does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments": { + "get": { + "operationId": "SqlResources_ListSqlRoleAssignments", + "x-ms-examples": { + "CosmosDBSqlRoleAssignmentList": { + "$ref": "./examples/CosmosDBSqlRoleAssignmentList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the list of all Azure Cosmos DB SQL Role Assignments.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "SqlRoleDefinitionResource": { + "properties": { + "roleName": { + "type": "string", + "description": "A user-friendly name for the Role Definition. Must be unique for the database account." + }, + "type": { + "type": "string", + "enum": [ + "BuiltInRole", + "CustomRole" + ], + "description": "Indicates whether the Role Definition was built-in or user created.", + "x-ms-enum": { + "name": "RoleDefinitionType", + "modelAsString": false + } + }, + "assignableScopes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist." + }, + "permissions": { + "type": "array", + "items": { + "$ref": "#/definitions/Permission" + }, + "description": "The set of operations allowed through this Role Definition." + } + }, + "description": "Azure Cosmos DB SQL Role Definition resource object." + }, + "SqlRoleDefinitionCreateUpdateParameters": { + "description": "Parameters to create and update an Azure Cosmos DB SQL Role Definition.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update an Azure Cosmos DB SQL Role Definition.", + "$ref": "#/definitions/SqlRoleDefinitionResource" + } + } + }, + "SqlRoleDefinitionGetResults": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlRoleDefinitionResource", + "description": "Properties related to the Role Definition." + } + }, + "allOf": [ + { + "$ref": "cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "description": "An Azure Cosmos DB SQL Role Definition." + }, + "Permission": { + "type": "object", + "properties": { + "dataActions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of data actions that are allowed." + }, + "notDataActions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of data actions that are denied." + } + }, + "description": "The set of data plane operations permitted through this Role Definition." + }, + "SqlRoleDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SqlRoleDefinitionGetResults" + }, + "description": "List of Role Definitions and their properties." + } + }, + "description": "The relevant Role Definitions." + }, + "SqlRoleAssignmentResource": { + "type": "object", + "properties": { + "roleDefinitionId": { + "type": "string", + "description": "The unique identifier for the associated Role Definition." + }, + "scope": { + "type": "string", + "description": "The data plane resource path for which access is being granted through this Role Assignment." + }, + "principalId": { + "type": "string", + "description": "The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription." + } + }, + "description": "Azure Cosmos DB SQL Role Assignment resource object." + }, + "SqlRoleAssignmentCreateUpdateParameters": { + "description": "Parameters to create and update an Azure Cosmos DB SQL Role Assignment.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update an Azure Cosmos DB SQL Role Assignment.", + "$ref": "#/definitions/SqlRoleAssignmentResource" + } + } + }, + "SqlRoleAssignmentGetResults": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlRoleAssignmentResource", + "description": "Properties related to the Role Assignment." + } + }, + "allOf": [ + { + "$ref": "cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "description": "An Azure Cosmos DB Role Assignment" + }, + "SqlRoleAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SqlRoleAssignmentGetResults" + }, + "description": "List of Role Assignments and their properties" + } + }, + "description": "The relevant Role Assignments." + } + }, + "parameters": { + "roleDefinitionIdParameter": { + "name": "roleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The GUID for the Role Definition." + }, + "roleAssignmentIdParameter": { + "name": "roleAssignmentId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The GUID for the Role Assignment." + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/restorable.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/restorable.json new file mode 100644 index 000000000000..6c17b0bf2b06 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/restorable.json @@ -0,0 +1,2073 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2024-02-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.DocumentDB/locations/{location}/restorableDatabaseAccounts": { + "get": { + "operationId": "RestorableDatabaseAccounts_ListByLocation", + "x-ms-examples": { + "CosmosDBRestorableDatabaseAccountList": { + "$ref": "./examples/CosmosDBRestorableDatabaseAccountList.json" + } + }, + "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableDatabaseAccountsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/restorableDatabaseAccounts": { + "get": { + "operationId": "RestorableDatabaseAccounts_List", + "x-ms-examples": { + "CosmosDBRestorableDatabaseAccountNoLocationList": { + "$ref": "./examples/CosmosDBRestorableDatabaseAccountNoLocationList.json" + } + }, + "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableDatabaseAccountsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}": { + "get": { + "operationId": "RestorableDatabaseAccounts_GetByLocation", + "x-ms-examples": { + "CosmosDBRestorableDatabaseAccountGet": { + "$ref": "./examples/CosmosDBRestorableDatabaseAccountGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + } + ], + "responses": { + "200": { + "description": "The restorable database account properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/RestorableDatabaseAccountGetResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/retrieveContinuousBackupInformation": { + "post": { + "operationId": "SqlResources_RetrieveContinuousBackupInformation", + "x-ms-examples": { + "CosmosDBSqlContainerBackupInformation": { + "$ref": "./examples/CosmosDBSqlContainerBackupInformation.json" + } + }, + "description": "Retrieves continuous backup information for a container resource.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/databaseNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "location", + "required": true, + "description": "The name of the continuous backup restore location.", + "schema": { + "$ref": "#/definitions/ContinuousBackupRestoreLocation" + } + } + ], + "responses": { + "200": { + "description": "The Sql container retrieve backup information operation completed successfully.", + "schema": { + "$ref": "#/definitions/BackupInformation" + } + }, + "202": { + "description": "The sql container retrieve backup information operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlDatabases": { + "get": { + "operationId": "RestorableSqlDatabases_List", + "x-ms-examples": { + "CosmosDBRestorableSqlDatabaseList": { + "$ref": "./examples/CosmosDBRestorableSqlDatabaseList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB SQL databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableSqlDatabasesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers": { + "get": { + "operationId": "RestorableSqlContainers_List", + "x-ms-examples": { + "CosmosDBRestorableSqlContainerList": { + "$ref": "./examples/CosmosDBRestorableSqlContainerList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB SQL containers under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restorableSqlDatabaseRidParameter" + }, + { + "$ref": "#/parameters/restorableSqlContainersEventFeedStartTime" + }, + { + "$ref": "#/parameters/restorableSqlContainersEventFeedEndTime" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableSqlContainersListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlResources": { + "get": { + "operationId": "RestorableSqlResources_List", + "x-ms-examples": { + "CosmosDBRestorableSqlResourceList": { + "$ref": "./examples/CosmosDBRestorableSqlResourceList.json" + } + }, + "description": "Return a list of database and container combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restoreLocationParameter" + }, + { + "$ref": "#/parameters/restoreTimestampInUtcParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableSqlResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/retrieveContinuousBackupInformation": { + "post": { + "operationId": "MongoDBResources_RetrieveContinuousBackupInformation", + "x-ms-examples": { + "CosmosDBMongoDBCollectionBackupInformation": { + "$ref": "./examples/CosmosDBMongoDBCollectionBackupInformation.json" + } + }, + "description": "Retrieves continuous backup information for a Mongodb collection.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/databaseNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "location", + "required": true, + "description": "The name of the continuous backup restore location.", + "schema": { + "$ref": "#/definitions/ContinuousBackupRestoreLocation" + } + } + ], + "responses": { + "200": { + "description": "The Mongodb collection retrieve backup information operation completed successfully.", + "schema": { + "$ref": "#/definitions/BackupInformation" + } + }, + "202": { + "description": "The Mongodb collection retrieve backup information operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbDatabases": { + "get": { + "operationId": "RestorableMongodbDatabases_List", + "x-ms-examples": { + "CosmosDBRestorableMongodbDatabaseList": { + "$ref": "./examples/CosmosDBRestorableMongodbDatabaseList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableMongodbDatabasesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbCollections": { + "get": { + "operationId": "RestorableMongodbCollections_List", + "x-ms-examples": { + "CosmosDBRestorableMongodbCollectionList": { + "$ref": "./examples/CosmosDBRestorableMongodbCollectionList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB collections under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restorableMongodbDatabaseRidParameter" + }, + { + "$ref": "#/parameters/restorableMongoDBCollectionsEventFeedStartTime" + }, + { + "$ref": "#/parameters/restorableMongoDBCollectionsEventFeedEndTime" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableMongodbCollectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbResources": { + "get": { + "operationId": "RestorableMongodbResources_List", + "x-ms-examples": { + "CosmosDBRestorableMongodbResourceList": { + "$ref": "./examples/CosmosDBRestorableMongodbResourceList.json" + } + }, + "description": "Return a list of database and collection combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restoreLocationParameter" + }, + { + "$ref": "#/parameters/restoreTimestampInUtcParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableMongodbResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/retrieveContinuousBackupInformation": { + "post": { + "operationId": "GremlinResources_RetrieveContinuousBackupInformation", + "x-ms-examples": { + "CosmosDBGremlinGraphBackupInformation": { + "$ref": "./examples/CosmosDBGremlinGraphBackupInformation.json" + } + }, + "description": "Retrieves continuous backup information for a gremlin graph.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/databaseNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "location", + "required": true, + "description": "The name of the continuous backup restore location.", + "schema": { + "$ref": "#/definitions/ContinuousBackupRestoreLocation" + } + } + ], + "responses": { + "200": { + "description": "The Gremlin graph retrieve backup information operation completed successfully.", + "schema": { + "$ref": "#/definitions/BackupInformation" + } + }, + "202": { + "description": "The Gremlin graph retrieve backup information operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinDatabases": { + "get": { + "operationId": "RestorableGremlinDatabases_List", + "x-ms-examples": { + "CosmosDBRestorableGremlinDatabaseList": { + "$ref": "./examples/CosmosDBRestorableGremlinDatabaseList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableGremlinDatabasesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGraphs": { + "get": { + "operationId": "RestorableGremlinGraphs_List", + "x-ms-examples": { + "CosmosDBRestorableGremlinGraphList": { + "$ref": "./examples/CosmosDBRestorableGremlinGraphList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin graphs under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restorableGremlinDatabaseRidParameter" + }, + { + "$ref": "#/parameters/restorableGremlinGraphsEventFeedStartTime" + }, + { + "$ref": "#/parameters/restorableGremlinGraphsEventFeedEndTime" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableGremlinGraphsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinResources": { + "get": { + "operationId": "RestorableGremlinResources_List", + "x-ms-examples": { + "CosmosDBRestorableGremlinResourceList": { + "$ref": "./examples/CosmosDBRestorableGremlinResourceList.json" + } + }, + "description": "Return a list of gremlin database and graphs combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restoreLocationParameter" + }, + { + "$ref": "#/parameters/restoreTimestampInUtcParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableGremlinResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/retrieveContinuousBackupInformation": { + "post": { + "operationId": "TableResources_RetrieveContinuousBackupInformation", + "x-ms-examples": { + "CosmosDBTableCollectionBackupInformation": { + "$ref": "./examples/CosmosDBTableBackupInformation.json" + } + }, + "description": "Retrieves continuous backup information for a table.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "location", + "required": true, + "description": "The name of the continuous backup restore location.", + "schema": { + "$ref": "#/definitions/ContinuousBackupRestoreLocation" + } + } + ], + "responses": { + "200": { + "description": "The Table retrieve backup information operation completed successfully.", + "schema": { + "$ref": "#/definitions/BackupInformation" + } + }, + "202": { + "description": "The Table retrieve backup information operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableTables": { + "get": { + "operationId": "RestorableTables_List", + "x-ms-examples": { + "CosmosDBRestorableTableList": { + "$ref": "./examples/CosmosDBRestorableTableList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB Tables. This helps in scenario where table was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restorableTablesEventFeedStartTime" + }, + { + "$ref": "#/parameters/restorableTablesEventFeedEndTime" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableTablesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableTableResources": { + "get": { + "operationId": "RestorableTableResources_List", + "x-ms-examples": { + "CosmosDBRestorableTableResourceList": { + "$ref": "./examples/CosmosDBRestorableTableResourceList.json" + } + }, + "description": "Return a list of tables that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restoreLocationParameter" + }, + { + "$ref": "#/parameters/restoreTimestampInUtcParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableTableResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "RestorableDatabaseAccountsListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableDatabaseAccountGetResult" + }, + "description": "List of restorable database accounts and their properties." + } + }, + "description": "The List operation response, that contains the restorable database accounts and their properties." + }, + "RestorableDatabaseAccountGetResult": { + "description": "A Azure Cosmos DB restorable database account.", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a restorable database account.", + "$ref": "#/definitions/RestorableDatabaseAccountProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + } + } + }, + "RestorableDatabaseAccountProperties": { + "type": "object", + "description": "The properties of a restorable database account.", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the global database account" + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The creation time of the restorable database account (ISO-8601 format)." + }, + "oldestRestorableTime": { + "type": "string", + "format": "date-time", + "description": "The least recent time at which the database account can be restored to (ISO-8601 format)." + }, + "deletionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the restorable database account has been deleted (ISO-8601 format)." + }, + "apiType": { + "type": "string", + "readOnly": true, + "description": "The API type of the restorable database account.", + "$ref": "#/definitions/ApiType" + }, + "restorableLocations": { + "type": "array", + "readOnly": true, + "description": "List of regions where the of the database account can be restored from.", + "items": { + "$ref": "#/definitions/RestorableLocationResource" + } + } + } + }, + "ApiType": { + "description": "Enum to indicate the API type of the restorable database account.", + "type": "string", + "readOnly": true, + "enum": [ + "MongoDB", + "Gremlin", + "Cassandra", + "Table", + "Sql", + "GremlinV2" + ], + "x-ms-enum": { + "name": "ApiType", + "modelAsString": true + } + }, + "RestorableLocationResource": { + "type": "object", + "description": "Properties of the regional restorable account.", + "properties": { + "locationName": { + "type": "string", + "readOnly": true, + "description": "The location of the regional restorable account." + }, + "regionalDatabaseAccountInstanceId": { + "type": "string", + "readOnly": true, + "description": "The instance id of the regional restorable account." + }, + "creationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The creation time of the regional restorable database account (ISO-8601 format)." + }, + "deletionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time at which the regional restorable database account has been deleted (ISO-8601 format)." + } + } + }, + "RestorableSqlDatabasesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableSqlDatabaseGetResult" + }, + "description": "List of SQL database events and their properties." + } + }, + "description": "The List operation response, that contains the SQL database events and their properties." + }, + "RestorableSqlDatabaseGetResult": { + "description": "An Azure Cosmos DB SQL database event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a SQL database event.", + "$ref": "#/definitions/RestorableSqlDatabaseProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableSqlDatabaseProperties": { + "description": "The properties of an Azure Cosmos DB SQL database event", + "type": "object", + "properties": { + "resource": { + "type": "object", + "description": "The resource of an Azure Cosmos DB SQL database event", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this database event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this database to identify if this database is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this database can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The time when this database event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of the SQL database." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of the SQL database." + }, + "database": { + "type": "object", + "description": "Cosmos DB SQL database resource object", + "properties": { + "_colls": { + "type": "string", + "readOnly": true, + "description": "A system generated property that specified the addressable path of the collections resource." + }, + "_users": { + "type": "string", + "readOnly": true, + "description": "A system generated property that specifies the addressable path of the users resource." + }, + "_self": { + "type": "string", + "readOnly": true, + "description": "A system generated property that specifies the addressable path of the database resource." + } + }, + "allOf": [ + { + "$ref": "./cosmos-db.json#/definitions/SqlDatabaseResource" + }, + { + "$ref": "./cosmos-db.json#/definitions/ExtendedResourceProperties" + } + ] + } + } + } + } + }, + "RestorableSqlContainersListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableSqlContainerGetResult" + }, + "description": "List of SQL container events and their properties." + } + }, + "description": "The List operation response, that contains the SQL container events and their properties." + }, + "RestorableSqlContainerGetResult": { + "description": "An Azure Cosmos DB SQL container event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a SQL container event.", + "$ref": "#/definitions/RestorableSqlContainerProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableSqlContainerProperties": { + "description": "The properties of an Azure Cosmos DB SQL container event", + "type": "object", + "properties": { + "resource": { + "description": "The resource of an Azure Cosmos DB SQL container event", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this container event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this container to identify if this container is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this container can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The when this container event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of this SQL container." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of this SQL container." + }, + "container": { + "type": "object", + "description": "Cosmos DB SQL container resource object", + "properties": { + "_self": { + "type": "string", + "readOnly": true, + "description": "A system generated property that specifies the addressable path of the container resource." + } + }, + "allOf": [ + { + "$ref": "./cosmos-db.json#/definitions/SqlContainerResource" + }, + { + "$ref": "./cosmos-db.json#/definitions/ExtendedResourceProperties" + } + ] + } + } + } + } + }, + "RestorableSqlResourcesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableSqlResourcesGetResult" + }, + "description": "List of restorable SQL resources, including the database and collection names." + } + }, + "description": "The List operation response, that contains the restorable SQL resources." + }, + "RestorableSqlResourcesGetResult": { + "type": "object", + "description": "Specific Databases to restore.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "databaseName": { + "type": "string", + "description": "The name of the database available for restore." + }, + "collectionNames": { + "type": "array", + "description": "The names of the collections available for restore.", + "items": { + "$ref": "cosmos-db.json#/definitions/CollectionName" + } + } + } + }, + "RestorableMongodbDatabasesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableMongodbDatabaseGetResult" + }, + "description": "List of MongoDB database events and their properties." + } + }, + "description": "The List operation response, that contains the MongoDB database events and their properties." + }, + "RestorableMongodbDatabaseGetResult": { + "description": "An Azure Cosmos DB MongoDB database event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a MongoDB database event.", + "$ref": "#/definitions/RestorableMongodbDatabaseProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableMongodbDatabaseProperties": { + "description": "The properties of an Azure Cosmos DB MongoDB database event", + "type": "object", + "properties": { + "resource": { + "description": "The resource of an Azure Cosmos DB MongoDB database event", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this database event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this database to identify if this database is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this database can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The time when this database event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of this MongoDB database." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of this MongoDB database." + } + } + } + } + }, + "RestorableMongodbCollectionsListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableMongodbCollectionGetResult" + }, + "description": "List of MongoDB collection events and their properties." + } + }, + "description": "The List operation response, that contains the MongoDB collection events and their properties." + }, + "RestorableMongodbCollectionGetResult": { + "description": "An Azure Cosmos DB MongoDB collection event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a MongoDB collection event.", + "$ref": "#/definitions/RestorableMongodbCollectionProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableMongodbCollectionProperties": { + "description": "The properties of an Azure Cosmos DB MongoDB collection event", + "type": "object", + "properties": { + "resource": { + "description": "The resource of an Azure Cosmos DB MongoDB collection event", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this collection event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this collection to identify if this container is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this collection can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The time when this collection event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of this MongoDB collection." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of this MongoDB collection." + } + } + } + } + }, + "RestorableMongodbResourcesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableMongodbResourcesGetResult" + }, + "description": "List of restorable MongoDB resources, including the database and collection names." + } + }, + "description": "The List operation response, that contains the restorable MongoDB resources." + }, + "RestorableMongodbResourcesGetResult": { + "type": "object", + "description": "Specific Databases to restore.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "databaseName": { + "type": "string", + "description": "The name of the database available for restore." + }, + "collectionNames": { + "type": "array", + "description": "The names of the collections available for restore.", + "items": { + "$ref": "cosmos-db.json#/definitions/CollectionName" + } + } + } + }, + "RestorableGremlinDatabasesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableGremlinDatabaseGetResult" + }, + "description": "List of Gremlin database events and their properties." + } + }, + "description": "The List operation response, that contains the Gremlin database events and their properties." + }, + "RestorableGremlinDatabaseGetResult": { + "description": "An Azure Cosmos DB Gremlin database event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a Gremlin database event.", + "$ref": "#/definitions/RestorableGremlinDatabaseProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableGremlinDatabaseProperties": { + "description": "The properties of an Azure Cosmos DB Gremlin database event", + "type": "object", + "properties": { + "resource": { + "description": "The resource of an Azure Cosmos DB Gremlin database event", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this database event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this database to identify if this database is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this database can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The time when this database event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of this Gremlin database." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of this Gremlin database." + } + } + } + } + }, + "RestorableGremlinGraphsListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableGremlinGraphGetResult" + }, + "description": "List of Gremlin graph events and their properties." + } + }, + "description": "The List operation response, that contains the Gremlin graph events and their properties." + }, + "RestorableGremlinGraphGetResult": { + "description": "An Azure Cosmos DB Gremlin graph event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a Gremlin graph event.", + "$ref": "#/definitions/RestorableGremlinGraphProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableGremlinGraphProperties": { + "description": "The properties of an Azure Cosmos DB Gremlin graph event", + "type": "object", + "properties": { + "resource": { + "description": "The resource of an Azure Cosmos DB Gremlin graph event", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this graph event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this graph to identify if this graph is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this graph can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The time when this graph event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of this Gremlin graph." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of this Gremlin graph." + } + } + } + } + }, + "RestorableGremlinResourcesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableGremlinResourcesGetResult" + }, + "description": "List of restorable Gremlin resources, including the gremlin database and graph names." + } + }, + "description": "The List operation response, that contains the restorable Gremlin resources." + }, + "RestorableGremlinResourcesGetResult": { + "type": "object", + "description": "Specific Databases to restore.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "databaseName": { + "type": "string", + "description": "The name of the gremlin database available for restore." + }, + "graphNames": { + "type": "array", + "description": "The names of the graphs available for restore.", + "items": { + "$ref": "cosmos-db.json#/definitions/GraphName" + } + } + } + }, + "RestorableTablesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableTableGetResult" + }, + "description": "List of Table events and their properties." + } + }, + "description": "The List operation response, that contains the Table events and their properties." + }, + "RestorableTableGetResult": { + "description": "An Azure Cosmos DB Table event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a Table event.", + "$ref": "#/definitions/RestorableTableProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableTableProperties": { + "description": "The properties of an Azure Cosmos DB Table event", + "type": "object", + "properties": { + "resource": { + "description": "The resource of an Azure Cosmos DB Table event", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this table event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this table to identify if this table is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this table can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The time when this table event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of this Table." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of this Table." + } + } + } + } + }, + "RestorableTableResourcesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableTableResourcesGetResult" + }, + "description": "List of restorable table names." + } + }, + "description": "List of restorable table names." + }, + "RestorableTableResourcesGetResult": { + "type": "object", + "description": "Specific Databases to restore.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the Table." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "OperationType": { + "description": "Enum to indicate the operation type of the event.", + "type": "string", + "readOnly": true, + "enum": [ + "Create", + "Replace", + "Delete", + "Recreate", + "SystemOperation" + ], + "x-ms-enum": { + "name": "OperationType", + "modelAsString": true + } + }, + "ContinuousBackupRestoreLocation": { + "type": "object", + "description": "Properties of the regional restorable account.", + "properties": { + "location": { + "type": "string", + "description": "The name of the continuous backup restore location." + } + } + }, + "BackupInformation": { + "description": "Backup information of a resource.", + "type": "object", + "properties": { + "continuousBackupInformation": { + "description": "Information about the status of continuous backups.", + "type": "object", + "$ref": "#/definitions/ContinuousBackupInformation" + } + } + }, + "ContinuousBackupInformation": { + "description": "Information about the status of continuous backups.", + "type": "object", + "readOnly": true, + "properties": { + "latestRestorableTimestamp": { + "type": "string", + "description": "The latest restorable timestamp for a resource." + } + } + } + }, + "parameters": { + "restorableSqlDatabaseRidParameter": { + "name": "restorableSqlDatabaseRid", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource ID of the SQL database." + }, + "restorableMongodbDatabaseRidParameter": { + "name": "restorableMongodbDatabaseRid", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource ID of the MongoDB database." + }, + "restoreLocationParameter": { + "name": "restoreLocation", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The location where the restorable resources are located." + }, + "restoreTimestampInUtcParameter": { + "name": "restoreTimestampInUtc", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The timestamp when the restorable resources existed." + }, + "restorableSqlContainersEventFeedStartTime": { + "name": "startTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable Sql containers event feed start time." + }, + "restorableSqlContainersEventFeedEndTime": { + "name": "endTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable Sql containers event feed end time." + }, + "restorableMongoDBCollectionsEventFeedStartTime": { + "name": "startTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable MongoDB collections event feed start time." + }, + "restorableMongoDBCollectionsEventFeedEndTime": { + "name": "endTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable MongoDB collections event feed end time." + }, + "restorableGremlinGraphsEventFeedStartTime": { + "name": "startTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable Gremlin graphs event feed start time." + }, + "restorableGremlinGraphsEventFeedEndTime": { + "name": "endTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable Gremlin graphs event feed end time." + }, + "restorableTablesEventFeedStartTime": { + "name": "startTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable Tables event feed start time." + }, + "restorableTablesEventFeedEndTime": { + "name": "endTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable Tables event feed end time." + }, + "restoreStartTime": { + "name": "startTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The snapshot create timestamp after which snapshots need to be listed." + }, + "restoreEndTime": { + "name": "endTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The snapshot create timestamp before which snapshots need to be listed." + }, + "locationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB region, with spaces between words and each word capitalized." + }, + "instanceIdParameter": { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The instanceId GUID of a restorable database account." + }, + "restorableGremlinDatabaseRidParameter": { + "name": "restorableGremlinDatabaseRid", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource ID of the Gremlin database." + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/services.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/services.json new file mode 100644 index 000000000000..fb4a43b4ea41 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/services.json @@ -0,0 +1,632 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2024-02-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.DocumentDB/databaseAccounts/{accountName}/services": { + "get": { + "x-ms-examples": { + "CosmosDBServicesList": { + "$ref": "./examples/CosmosDBServicesList.json" + } + }, + "operationId": "Service_List", + "description": "Gets the status of service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The ServiceResource.", + "schema": { + "$ref": "#/definitions/ServiceResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": ".../../cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}": { + "put": { + "tags": [ + "DataTransfer", + "SqlDedicatedGateway", + "GraphAPICompute", + "MaterializedViewsBuilder" + ], + "x-ms-examples": { + "DataTransferServiceCreate": { + "$ref": "./examples/CosmosDBDataTransferServiceCreate.json" + }, + "SqlDedicatedGatewayServiceCreate": { + "$ref": "./examples/CosmosDBSqlDedicatedGatewayServiceCreate.json" + }, + "GraphAPIComputeServiceCreate": { + "$ref": "./examples/CosmosDBGraphAPIComputeServiceCreate.json" + }, + "MaterializedViewsBuilderServiceCreate": { + "$ref": "./examples/CosmosDBMaterializedViewsBuilderServiceCreate.json" + } + }, + "operationId": "Service_Create", + "description": "Creates a service.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/serviceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResourceCreateUpdateParameters" + }, + "description": "The Service resource parameters." + } + ], + "responses": { + "200": { + "description": "The service status.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "202": { + "description": "The job will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": ".../../cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "DataTransfer", + "SqlDedicatedGateway", + "GraphAPICompute", + "MaterializedViewsBuilder" + ], + "x-ms-examples": { + "DataTransferServiceGet": { + "$ref": "./examples/CosmosDBDataTransferServiceGet.json" + }, + "GraphAPIComputeServiceGet": { + "$ref": "./examples/CosmosDBGraphAPIComputeServiceGet.json" + }, + "SqlDedicatedGatewayServiceGet": { + "$ref": "./examples/CosmosDBSqlDedicatedGatewayServiceGet.json" + }, + "MaterializedViewsBuilderServiceGet": { + "$ref": "./examples/CosmosDBMaterializedViewsBuilderServiceGet.json" + } + }, + "operationId": "Service_Get", + "description": "Gets the status of service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/serviceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The ServiceResource.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": ".../../cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "DataTransfer", + "SqlDedicatedGateway", + "GraphAPICompute", + "MaterializedViewsBuilder" + ], + "x-ms-examples": { + "DataTransferServiceDelete": { + "$ref": "./examples/CosmosDBDataTransferServiceDelete.json" + }, + "SqlDedicatedGatewayServiceDelete": { + "$ref": "./examples/CosmosDBSqlDedicatedGatewayServiceDelete.json" + }, + "GraphAPIComputeServiceDelete": { + "$ref": "./examples/CosmosDBGraphAPIComputeServiceDelete.json" + }, + "MaterializedViewsBuilderServiceDelete": { + "$ref": "./examples/CosmosDBMaterializedViewsBuilderServiceDelete.json" + } + }, + "operationId": "Service_Delete", + "description": "Deletes service with the given serviceName.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/serviceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The job will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The response for service deletion." + }, + "200": { + "description": "The response for service deletion." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": ".../../cosmos-db.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ServiceResourceProperties": { + "description": "Services response resource.", + "type": "object", + "discriminator": "serviceType", + "properties": { + "creationTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Time of the last state change (ISO-8601 format)." + }, + "instanceSize": { + "$ref": "#/definitions/ServiceResourceInstanceSize" + }, + "instanceCount": { + "description": "Instance count for the service.", + "type": "integer", + "minimum": 0, + "format": "int32" + }, + "serviceType": { + "$ref": "#/definitions/ServiceType" + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ServiceResourceStatus" + } + }, + "additionalProperties": true, + "required": [ + "serviceType" + ] + }, + "ServiceResourceCreateUpdateParameters": { + "description": "Parameters for Create or Update Request for ServiceResource", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceResourceCreateUpdateProperties" + } + } + }, + "ServiceResourceCreateUpdateProperties": { + "description": "Properties in ServiceResourceCreateUpdateParameters.", + "type": "object", + "properties": { + "instanceSize": { + "$ref": "#/definitions/ServiceResourceInstanceSize" + }, + "instanceCount": { + "description": "Instance count for the service.", + "type": "integer", + "minimum": 0, + "format": "int32" + }, + "serviceType": { + "$ref": "#/definitions/ServiceType" + } + } + }, + "ServiceResource": { + "description": "Properties for the database account.", + "type": "object", + "allOf": [ + { + "$ref": ".../../cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/ServiceResourceProperties" + } + } + }, + "ServiceResourceListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResource" + }, + "description": "List of Service Resource and their properties." + } + }, + "description": "The List operation response, that contains the Service Resource and their properties." + }, + "DataTransferServiceResource": { + "description": "Describes the service response property.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/DataTransferServiceResourceProperties" + } + } + }, + "DataTransferServiceResourceProperties": { + "description": "Properties for DataTransferServiceResource.", + "type": "object", + "x-ms-discriminator-value": "DataTransfer", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "properties": { + "locations": { + "type": "array", + "readOnly": true, + "description": "An array that contains all of the locations for the service.", + "items": { + "$ref": "#/definitions/DataTransferRegionalServiceResource" + } + } + } + }, + "SqlDedicatedGatewayServiceResource": { + "description": "Describes the service response property for SqlDedicatedGateway.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/SqlDedicatedGatewayServiceResourceProperties" + } + } + }, + "SqlDedicatedGatewayServiceResourceProperties": { + "description": "Properties for SqlDedicatedGatewayServiceResource.", + "type": "object", + "x-ms-discriminator-value": "SqlDedicatedGateway", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "properties": { + "sqlDedicatedGatewayEndpoint": { + "type": "string", + "description": "SqlDedicatedGateway endpoint for the service." + }, + "locations": { + "type": "array", + "readOnly": true, + "description": "An array that contains all of the locations for the service.", + "items": { + "$ref": "#/definitions/SqlDedicatedGatewayRegionalServiceResource" + } + } + } + }, + "GraphAPIComputeServiceResource": { + "description": "Describes the service response property for GraphAPICompute.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/GraphAPIComputeServiceResourceProperties" + } + } + }, + "GraphAPIComputeServiceResourceProperties": { + "description": "Properties for GraphAPIComputeServiceResource.", + "type": "object", + "x-ms-discriminator-value": "GraphAPICompute", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "properties": { + "graphApiComputeEndpoint": { + "type": "string", + "description": "GraphAPICompute endpoint for the service." + }, + "locations": { + "type": "array", + "readOnly": true, + "description": "An array that contains all of the locations for the service.", + "items": { + "$ref": "#/definitions/GraphAPIComputeRegionalServiceResource" + } + } + } + }, + "MaterializedViewsBuilderServiceResource": { + "description": "Describes the service response property for MaterializedViewsBuilder.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/MaterializedViewsBuilderServiceResourceProperties" + } + } + }, + "MaterializedViewsBuilderServiceResourceProperties": { + "description": "Properties for MaterializedViewsBuilderServiceResource.", + "type": "object", + "x-ms-discriminator-value": "MaterializedViewsBuilder", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "properties": { + "locations": { + "type": "array", + "readOnly": true, + "description": "An array that contains all of the locations for the service.", + "items": { + "$ref": "#/definitions/MaterializedViewsBuilderRegionalServiceResource" + } + } + } + }, + "RegionalServiceResource": { + "description": "Resource for a regional service location.", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The regional service name." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The location name." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ServiceResourceStatus" + } + } + }, + "SqlDedicatedGatewayRegionalServiceResource": { + "description": "Resource for a regional service location.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RegionalServiceResource" + } + ], + "properties": { + "sqlDedicatedGatewayEndpoint": { + "readOnly": true, + "type": "string", + "description": "The regional endpoint for SqlDedicatedGateway." + } + } + }, + "GraphAPIComputeRegionalServiceResource": { + "description": "Resource for a regional service location.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RegionalServiceResource" + } + ], + "properties": { + "graphApiComputeEndpoint": { + "readOnly": true, + "type": "string", + "description": "The regional endpoint for GraphAPICompute." + } + } + }, + "DataTransferRegionalServiceResource": { + "description": "Resource for a regional service location.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RegionalServiceResource" + } + ] + }, + "MaterializedViewsBuilderRegionalServiceResource": { + "description": "Resource for a regional service location.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RegionalServiceResource" + } + ] + }, + "ServiceResourceStatus": { + "type": "string", + "enum": [ + "Creating", + "Running", + "Updating", + "Deleting", + "Error", + "Stopped" + ], + "readOnly": true, + "description": "Describes the status of a service.", + "x-ms-enum": { + "modelAsString": true, + "name": "ServiceStatus" + } + }, + "ServiceResourceInstanceSize": { + "type": "string", + "enum": [ + "Cosmos.D4s", + "Cosmos.D8s", + "Cosmos.D16s" + ], + "description": "Instance type for the service.", + "x-ms-enum": { + "modelAsString": true, + "name": "ServiceSize" + } + }, + "ServiceType": { + "type": "string", + "enum": [ + "SqlDedicatedGateway", + "DataTransfer", + "GraphAPICompute", + "MaterializedViewsBuilder" + ], + "description": "ServiceType for the service.", + "x-ms-enum": { + "modelAsString": true, + "name": "ServiceType" + } + } + }, + "parameters": { + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database account name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "serviceNameParameter": { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB service name.", + "minLength": 3, + "maxLength": 50 + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/throughputpool.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/throughputpool.json new file mode 100644 index 000000000000..6396937295f6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/throughputpool.json @@ -0,0 +1,717 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Throughput Pool REST API", + "version": "2024-02-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.DocumentDB/throughputPools": { + "get": { + "operationId": "ThroughputPools_List", + "x-ms-examples": { + "CosmosDB ThroughputPool List": { + "$ref": "./examples/throughputPool/CosmosDBThroughputPoolList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "description": "Lists all the Azure Cosmos DB Throughput Pools available under the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputPoolsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools": { + "get": { + "tags": [ + "ThroughputPools" + ], + "operationId": "ThroughputPools_ListByResourceGroup", + "x-ms-examples": { + "CosmosDB ThroughputPool List by Resource Group": { + "$ref": "./examples/throughputPool/CosmosDBThroughputPoolList.json" + } + }, + "description": "List all the ThroughputPools in a given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputPoolsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}": { + "get": { + "operationId": "ThroughputPool_Get", + "x-ms-examples": { + "CosmosDB ThroughputPool Get": { + "$ref": "./examples/throughputPool/CosmosDBThroughputPoolGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB Throughput Pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ThroughputPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Throughput Pool properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputPoolResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "operationId": "ThroughputPool_CreateOrUpdate", + "x-ms-examples": { + "CosmosDB ThroughputPool Create": { + "$ref": "./examples/throughputPool/CosmosDBThroughputPoolCreate.json" + } + }, + "description": "Creates or updates an Azure Cosmos DB ThroughputPool account. The \"Update\" method is preferred when performing updates on an account.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ThroughputPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputPoolResource" + }, + "description": "The parameters to provide for the current ThroughputPool." + } + ], + "responses": { + "200": { + "description": "Completed synchronously. This will only happen if the fields changed by patch require no changes to the actual ThroughputPool.", + "schema": { + "$ref": "#/definitions/ThroughputPoolResource" + } + }, + "201": { + "description": "The throughput pool is being created or updated asynchronously. Poll for status=Succeeded to find when the operation completes.", + "schema": { + "$ref": "#/definitions/ThroughputPoolResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "operationId": "ThroughputPool_Update", + "x-ms-examples": { + "CosmosDB ThroughputPool Update": { + "$ref": "./examples/throughputPool/CosmosDBThroughputPoolUpdate.json" + } + }, + "description": "Updates the properties of an existing Azure Cosmos DB Throughput Pool.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ThroughputPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ThroughputPoolUpdate" + }, + "description": "The parameters to provide for the current Throughput Pool." + } + ], + "responses": { + "200": { + "description": "Completed synchronously. This will only happen if the fields changed by patch require no changes to the actual ThroughputPool.", + "schema": { + "$ref": "#/definitions/ThroughputPoolResource" + } + }, + "202": { + "description": "The ThroughputPool update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "operationId": "ThroughputPool_Delete", + "x-ms-examples": { + "CosmosDB ThroughputPool Delete": { + "$ref": "./examples/throughputPool/CosmosDBThroughputPoolDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Throughput Pool.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ThroughputPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Throughput Pool delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The specified Throughput Pool does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts": { + "get": { + "operationId": "ThroughputPoolAccounts_List", + "x-ms-examples": { + "CosmosDB ThroughputPool Account List": { + "$ref": "./examples/throughputPool/CosmosDBThroughputPoolAccountsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "description": "Lists all the Azure Cosmos DB accounts available under the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ThroughputPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputPoolAccountsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}": { + "get": { + "operationId": "ThroughputPoolAccount_Get", + "x-ms-examples": { + "CosmosDB ThroughputPool Account Get": { + "$ref": "./examples/throughputPool/CosmosDBThroughputPoolAccountGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB Throughput Pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ThroughputPoolNameParameter" + }, + { + "$ref": "#/parameters/ThroughputPoolAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Throughput Pool properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputPoolAccountResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "operationId": "ThroughputPoolAccount_Create", + "description": "Creates or updates an Azure Cosmos DB ThroughputPool account. The \"Update\" method is preferred when performing updates on an account.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "CosmosDB ThroughputPool Account Create": { + "$ref": "./examples/throughputPool/CosmosDBThroughputPoolAccountCreate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ThroughputPoolNameParameter" + }, + { + "$ref": "#/parameters/ThroughputPoolAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputPoolAccountResource" + }, + "description": "The parameters to provide for the current ThroughputPoolAccount." + } + ], + "responses": { + "200": { + "description": "The Throughput Pool account resource was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputPoolAccountResource" + } + }, + "201": { + "description": "The throughput pool account is being created or updated asynchronously. Poll for status=Succeeded to find when the operation completes.", + "schema": { + "$ref": "#/definitions/ThroughputPoolAccountResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "operationId": "ThroughputPoolAccount_Delete", + "x-ms-examples": { + "CosmosDB ThroughputPool Account Delete": { + "$ref": "./examples/throughputPool/CosmosDBThroughputPoolAccountDelete.json" + } + }, + "description": "Removes an existing Azure Cosmos DB database account from a throughput pool.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ThroughputPoolNameParameter" + }, + { + "$ref": "#/parameters/ThroughputPoolAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Throughput Pool delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The specified Throughput Pool does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ProvisioningState": { + "description": "The provisioning state of the resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + }, + "readOnly": true + }, + "ThroughputPoolsListResult": { + "description": "The List operation response, that contains the throughput pools and their properties.", + "type": "object", + "properties": { + "value": { + "description": "List of throughput pools and their properties.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ThroughputPoolResource" + } + }, + "nextLink": { + "description": "The link used to get the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ThroughputPoolResource": { + "description": "An Azure Cosmos DB Throughputpool.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ThroughputPoolProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ThroughputPoolUpdate": { + "type": "object", + "description": "Represents a throughput pool resource for updates.", + "properties": { + "properties": { + "$ref": "#/definitions/ThroughputPoolProperties", + "x-ms-client-flatten": true, + "description": "Properties of the throughput pool." + } + } + }, + "ThroughputPoolProperties": { + "description": "Properties to update Azure Cosmos DB throughput pool.", + "type": "object", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "A provisioning state of the ThroughputPool." + }, + "maxThroughput": { + "type": "integer", + "format": "int32", + "description": "Value for throughput to be shared among CosmosDB resources in the pool." + } + } + }, + "ThroughputPoolAccountsListResult": { + "description": "The List operation response, that contains the global database accounts and their properties.", + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ThroughputPoolAccountResource" + }, + "description": "List of global database accounts in a throughput pool and their properties." + }, + "nextLink": { + "description": "The link used to get the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ThroughputPoolAccountCreateParameters": { + "description": "Parameters for creating a Azure Cosmos DB throughput pool account.", + "type": "object", + "x-ms-mutability": [ + "create" + ], + "properties": { + "tags": { + "$ref": "cosmos-db.json#/definitions/Tags" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ThroughputPoolAccountCreateProperties" + } + } + }, + "ThroughputPoolAccountCreateProperties": { + "description": "Properties to update Azure Cosmos DB throughput pool.", + "type": "object", + "x-ms-mutability": [ + "create" + ], + "properties": { + "accountResourceIdentifier": { + "description": "The resource identifier of global database account in the throughputPool.", + "type": "string" + }, + "accountLocation": { + "description": "The location of global database account in the throughputPool.", + "type": "string" + } + } + }, + "ThroughputPoolAccountResource": { + "description": "An Azure Cosmos DB Throughputpool Account", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ThroughputPoolAccountProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ThroughputPoolAccountProperties": { + "description": "An Azure Cosmos DB Global Database Account which is part of a Throughputpool.", + "type": "object", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "A provisioning state of the ThroughputPool Account." + }, + "accountResourceIdentifier": { + "description": "The resource identifier of global database account in the throughputPool.", + "type": "string" + }, + "accountLocation": { + "description": "The location of global database account in the throughputPool.", + "type": "string" + }, + "accountInstanceId": { + "description": "The instance id of global database account in the throughputPool.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ThroughputPoolNameParameter": { + "name": "throughputPoolName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB Throughput Pool name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "ThroughputPoolAccountNameParameter": { + "name": "throughputPoolAccountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB global database account in a Throughput Pool", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + } + } +} diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md index aa1fdf2a1d99..cec3b00fd0bd 100644 --- a/specification/cosmos-db/resource-manager/readme.md +++ b/specification/cosmos-db/resource-manager/readme.md @@ -27,15 +27,34 @@ These are the global settings for the Cosmos-DB API. ``` yaml title: CosmosDBManagementClient openapi-type: arm -tag: package-preview-2023-11 +tag: package-preview-2024-02 ``` +### Tag: package-preview-2024-02 + +These settings apply only when `--tag=package-preview-2024-02` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-02' +input-file: + - Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json + - Microsoft.DocumentDB/preview/2024-02-15-preview/dataTransferService.json + - Microsoft.DocumentDB/preview/2024-02-15-preview/managedCassandra.json + - Microsoft.DocumentDB/preview/2024-02-15-preview/mongoCluster.json + - Microsoft.DocumentDB/preview/2024-02-15-preview/mongorbac.json + - Microsoft.DocumentDB/preview/2024-02-15-preview/notebook.json + - Microsoft.DocumentDB/preview/2024-02-15-preview/privateEndpointConnection.json + - Microsoft.DocumentDB/preview/2024-02-15-preview/privateLinkResources.json + - Microsoft.DocumentDB/preview/2024-02-15-preview/rbac.json + - Microsoft.DocumentDB/preview/2024-02-15-preview/restorable.json + - Microsoft.DocumentDB/preview/2024-02-15-preview/services.json + - Microsoft.DocumentDB/preview/2024-02-15-preview/throughputpool.json +``` ### Tag: package-preview-2023-11 These settings apply only when `--tag=package-preview-2023-11` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-11' +``` yaml $(tag) == 'package-preview-2023-11' input-file: - Microsoft.DocumentDB/preview/2023-11-15-preview/cosmos-db.json - Microsoft.DocumentDB/preview/2023-11-15-preview/dataTransferService.json @@ -55,7 +74,7 @@ input-file: These settings apply only when `--tag=package-2023-11` is specified on the command line. -```yaml $(tag) == 'package-2023-11' +``` yaml $(tag) == 'package-2023-11' input-file: - Microsoft.DocumentDB/stable/2023-11-15/cosmos-db.json - Microsoft.DocumentDB/stable/2023-11-15/managedCassandra.json diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/databox.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/databox.json new file mode 100644 index 000000000000..f4d4c2b5ed94 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/databox.json @@ -0,0 +1,7215 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-01-preview", + "title": "DataBoxManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.DataBox/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "This method gets all the operations.", + "operationId": "Operations_List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The supported operations list.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OperationsGet": { + "$ref": "./examples/OperationsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "description": "Lists all the jobs available under the subscription.", + "operationId": "Jobs_List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of jobs available under the subscription.", + "schema": { + "$ref": "#/definitions/JobResourceList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "JobsList": { + "$ref": "./examples/JobsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/mitigate": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Request to mitigate for a given job", + "operationId": "Mitigate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "mitigateJobRequest", + "in": "body", + "description": "Mitigation Request", + "required": true, + "schema": { + "$ref": "#/definitions/MitigateJobRequest" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "Mitigate": { + "$ref": "./examples/JobMitigate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/markDevicesShipped": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Request to mark devices for a given job as shipped", + "operationId": "Jobs_MarkDevicesShipped", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "markDevicesShippedRequest", + "in": "body", + "description": "Mark Devices Shipped Request", + "required": true, + "schema": { + "$ref": "#/definitions/MarkDevicesShippedRequest" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "MarkDevicesShipped": { + "$ref": "./examples/MarkDevicesShipped.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/availableSkus": { + "post": { + "tags": [ + "Service" + ], + "description": "This method provides the list of available skus for the given subscription, resource group and location.", + "operationId": "Service_ListAvailableSkusByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "availableSkuRequest", + "in": "body", + "description": "Filters for showing the available skus.", + "required": true, + "schema": { + "$ref": "#/definitions/AvailableSkuRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of available skus under Resource group.", + "schema": { + "$ref": "#/definitions/AvailableSkusResult" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvailableSkusPost": { + "$ref": "./examples/AvailableSkusPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress": { + "post": { + "tags": [ + "Service" + ], + "description": "[DEPRECATED NOTICE: This operation will soon be removed]. This method validates the customer shipping address and provide alternate addresses if any.", + "operationId": "Service_ValidateAddress", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "validateAddress", + "in": "body", + "description": "Shipping address of the customer.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateAddress" + } + } + ], + "responses": { + "200": { + "description": "The valid and alternate addresses.", + "schema": { + "$ref": "#/definitions/AddressValidationOutput" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ValidateAddressPost": { + "$ref": "./examples/ValidateAddressPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/validateInputs": { + "post": { + "tags": [ + "Service" + ], + "description": "This method does all necessary pre-job creation validation under resource group.", + "operationId": "Service_ValidateInputsByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "validationRequest", + "in": "body", + "description": "Inputs of the customer.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidationRequest" + } + } + ], + "responses": { + "200": { + "description": "The validation status and responses of each validating parameter.", + "schema": { + "$ref": "#/definitions/ValidationResponse" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "ValidateInputsByResourceGroup": { + "$ref": "./examples/ValidateInputsByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateInputs": { + "post": { + "tags": [ + "Service" + ], + "description": "This method does all necessary pre-job creation validation under subscription.", + "operationId": "Service_ValidateInputs", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "validationRequest", + "in": "body", + "description": "Inputs of the customer.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidationRequest" + } + } + ], + "responses": { + "200": { + "description": "The validation status and responses of each validating parameter.", + "schema": { + "$ref": "#/definitions/ValidationResponse" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "ValidateInputs": { + "$ref": "./examples/ValidateInputs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "description": "Lists all the jobs available under the given resource group.", + "operationId": "Jobs_ListByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of jobs by resource group.", + "schema": { + "$ref": "#/definitions/JobResourceList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "JobsListByResourceGroup": { + "$ref": "./examples/JobsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}": { + "get": { + "tags": [ + "Jobs" + ], + "description": "Gets information about the specified job.", + "operationId": "Jobs_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on details parameter for job, which provides details on the job stages.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Job object.", + "schema": { + "$ref": "#/definitions/JobResource" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "JobsGet": { + "$ref": "./examples/JobsGet.json" + }, + "JobsGetCmk": { + "$ref": "./examples/JobsGetCmk.json" + }, + "JobsGetExport": { + "$ref": "./examples/JobsGetExport.json" + }, + "JobsGetCopyStuck": { + "$ref": "./examples/JobsGetCopyStuck.json" + }, + "JobsGetWaitingForAction": { + "$ref": "./examples/JobsGetWaitingForAction.json" + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "description": "Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.", + "operationId": "Jobs_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "jobResource", + "in": "body", + "description": "Job details from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/JobResource" + } + } + ], + "responses": { + "200": { + "description": "Job object.", + "schema": { + "$ref": "#/definitions/JobResource" + } + }, + "202": { + "description": "Accepted request for create Job." + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "JobsCreate": { + "$ref": "./examples/JobsCreate.json" + }, + "JobsCreateDevicePassword": { + "$ref": "./examples/JobsCreateDevicePassword.json" + }, + "JobsCreateExport": { + "$ref": "./examples/JobsCreateExport.json" + }, + "JobsCreateDoubleEncryption": { + "$ref": "./examples/JobsCreateDoubleEncryption.json" + }, + "JobsCreateWithUserAssignedIdentity": { + "$ref": "./examples/JobsCreateWithUserAssignedIdentity.json" + } + } + }, + "delete": { + "tags": [ + "Jobs" + ], + "description": "Deletes a job.", + "operationId": "Jobs_Delete", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Just for swagger we are adding this status code." + }, + "202": { + "description": "Accepted request for delete Job.", + "headers": { + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "Job deleted." + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "JobsDelete": { + "$ref": "./examples/JobsDelete.json" + } + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "description": "Updates the properties of an existing job.", + "operationId": "Jobs_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.", + "type": "string" + }, + { + "name": "jobResourceUpdateParameter", + "in": "body", + "description": "Job update parameters from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/JobResourceUpdateParameter" + } + } + ], + "responses": { + "200": { + "description": "Job object.", + "schema": { + "$ref": "#/definitions/JobResource" + } + }, + "202": { + "description": "Accepted request for job updated.", + "headers": { + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "JobsPatch": { + "$ref": "./examples/JobsPatch.json" + }, + "JobsPatchCmk": { + "$ref": "./examples/JobsPatchCmk.json" + }, + "JobsPatchSystemAssignedToUserAssigned": { + "$ref": "./examples/JobsPatchSystemAssignedToUserAssigned.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Book shipment pick up.", + "operationId": "Jobs_BookShipmentPickUp", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "shipmentPickUpRequest", + "in": "body", + "description": "Details of shipment pick up request.", + "required": true, + "schema": { + "$ref": "#/definitions/ShipmentPickUpRequest" + } + } + ], + "responses": { + "200": { + "description": "Booked shipment pick up successfully.", + "schema": { + "$ref": "#/definitions/ShipmentPickUpResponse" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "BookShipmentPickupPost": { + "$ref": "./examples/BookShipmentPickupPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel": { + "post": { + "tags": [ + "Jobs" + ], + "description": "CancelJob.", + "operationId": "Jobs_Cancel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "cancellationReason", + "in": "body", + "description": "Reason for cancellation.", + "required": true, + "schema": { + "$ref": "#/definitions/CancellationReason" + } + } + ], + "responses": { + "204": { + "description": "Job cancelled." + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "JobsCancelPost": { + "$ref": "./examples/JobsCancelPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials": { + "post": { + "tags": [ + "Jobs" + ], + "description": "This method gets the unencrypted secrets related to the job.", + "operationId": "Jobs_ListCredentials", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of unencrypted credentials of the job.", + "schema": { + "$ref": "#/definitions/UnencryptedCredentialsList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "JobsListCredentials": { + "$ref": "./examples/JobsListCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration": { + "post": { + "tags": [ + "Service" + ], + "description": "This API provides configuration details specific to given region/location at Subscription level.", + "operationId": "Service_RegionConfiguration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "regionConfigurationRequest", + "in": "body", + "description": "Request body to get the configuration for the region.", + "required": true, + "schema": { + "$ref": "#/definitions/RegionConfigurationRequest" + } + } + ], + "responses": { + "200": { + "description": "Region configuration response.", + "schema": { + "$ref": "#/definitions/RegionConfigurationResponse" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "RegionConfiguration": { + "$ref": "./examples/RegionConfiguration.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration": { + "post": { + "tags": [ + "Service" + ], + "description": "This API provides configuration details specific to given region/location at Resource group level.", + "operationId": "Service_RegionConfigurationByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "regionConfigurationRequest", + "in": "body", + "description": "Request body to get the configuration for the region at resource group level.", + "required": true, + "schema": { + "$ref": "#/definitions/RegionConfigurationRequest" + } + } + ], + "responses": { + "200": { + "description": "Region configuration response.", + "schema": { + "$ref": "#/definitions/RegionConfigurationResponse" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "RegionConfigurationByResourceGroup": { + "$ref": "./examples/RegionConfigurationByResourceGroup.json" + } + } + } + } + }, + "definitions": { + "AccountCredentialDetails": { + "description": "Credential details of the account.", + "type": "object", + "properties": { + "accountName": { + "description": "Name of the account.", + "type": "string", + "readOnly": true + }, + "dataAccountType": { + "description": "Type of the account.", + "enum": [ + "StorageAccount", + "ManagedDisk" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DataAccountType", + "modelAsExtensible": true, + "values": [ + { + "value": "StorageAccount", + "description": "Storage Accounts ." + }, + { + "value": "ManagedDisk", + "description": "Azure Managed disk storage." + } + ] + } + }, + "accountConnectionString": { + "description": "Connection string of the account endpoint to use the account as a storage endpoint on the device.", + "type": "string", + "readOnly": true + }, + "shareCredentialDetails": { + "description": "Per share level unencrypted access credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/ShareCredentialDetails" + }, + "readOnly": true + } + } + }, + "AdditionalErrorInfo": { + "description": "This class represents additional info which Resource Providers pass when an error occurs.", + "properties": { + "info": { + "description": "Additional information of the type of error.", + "type": "object" + }, + "type": { + "description": "Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation).", + "type": "string" + } + }, + "type": "object" + }, + "AddressValidationOutput": { + "description": "Output of the address validation api.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddressValidationProperties", + "description": "The address validation properties.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "AddressValidationProperties": { + "description": "The address validation output.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputResponse" + } + ], + "properties": { + "validationStatus": { + "description": "The address validation status.", + "enum": [ + "Valid", + "Invalid", + "Ambiguous" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AddressValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Valid", + "description": "Address provided is valid." + }, + { + "value": "Invalid", + "description": "Address provided is invalid or not supported." + }, + { + "value": "Ambiguous", + "description": "Address provided is ambiguous, please choose one of the alternate addresses returned." + } + ] + } + }, + "alternateAddresses": { + "description": "List of alternate addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/ShippingAddress" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "ValidateAddress" + }, + "ApiError": { + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "ApplianceNetworkConfiguration": { + "description": "The Network Adapter configuration of a DataBox.", + "type": "object", + "properties": { + "name": { + "description": "Name of the network.", + "type": "string", + "readOnly": true + }, + "macAddress": { + "description": "Mac Address.", + "type": "string", + "readOnly": true + } + } + }, + "ArmBaseObject": { + "description": "Base class for all objects under resource.", + "type": "object", + "properties": { + "name": { + "description": "Name of the object.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the object.", + "type": "string", + "readOnly": true + } + } + }, + "AvailableSkuRequest": { + "description": "The filters for showing the available skus.", + "required": [ + "transferType", + "country", + "location" + ], + "type": "object", + "properties": { + "transferType": { + "description": "Type of the transfer.", + "enum": [ + "ImportToAzure", + "ExportFromAzure" + ], + "type": "string", + "x-ms-enum": { + "name": "TransferType", + "modelAsExtensible": true, + "values": [ + { + "value": "ImportToAzure", + "description": "Import data to azure." + }, + { + "value": "ExportFromAzure", + "description": "Export data from azure." + } + ] + } + }, + "country": { + "description": "ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements", + "type": "string" + }, + "location": { + "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", + "type": "string" + }, + "skuNames": { + "description": "Sku Names to filter for available skus", + "type": "array", + "items": { + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk" + } + ] + } + } + } + } + }, + "AvailableSkusResult": { + "description": "The available skus operation response.", + "type": "object", + "properties": { + "value": { + "description": "List of available skus.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuInformation" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link for the next set of skus.", + "type": "string" + } + } + }, + "AzureFileFilterDetails": { + "description": "Filter details to transfer Azure files", + "type": "object", + "properties": { + "filePrefixList": { + "description": "Prefix list of the Azure files to be transferred.", + "type": "array", + "items": { + "type": "string" + } + }, + "filePathList": { + "description": "List of full path of the files to be transferred.", + "type": "array", + "items": { + "type": "string" + } + }, + "fileShareList": { + "description": "List of file shares to be transferred.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "BlobFilterDetails": { + "description": "Filter details to transfer Azure Blobs", + "type": "object", + "properties": { + "blobPrefixList": { + "description": "Prefix list of the Azure blobs to be transferred.", + "type": "array", + "items": { + "type": "string" + } + }, + "blobPathList": { + "description": "List of full path of the blobs to be transferred.", + "type": "array", + "items": { + "type": "string" + } + }, + "containerList": { + "description": "List of blob containers to be transferred.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CancellationReason": { + "description": "Reason for cancellation.", + "required": [ + "reason" + ], + "type": "object", + "properties": { + "reason": { + "description": "Reason for cancellation.", + "type": "string" + } + } + }, + "CloudError": { + "description": "Provides additional information about an http error response.", + "properties": { + "additionalInfo": { + "description": "Gets or sets additional error info.", + "items": { + "$ref": "#/definitions/AdditionalErrorInfo" + }, + "readOnly": true, + "type": "array" + }, + "code": { + "description": "Error code.", + "type": "string" + }, + "details": { + "description": "Gets or sets details for the error.", + "items": { + "$ref": "#/definitions/CloudError" + }, + "readOnly": true, + "type": "array" + }, + "message": { + "description": "The error message parsed from the body of the http error response.", + "type": "string" + }, + "target": { + "description": "Gets or sets the target of the error.", + "type": "string" + } + }, + "type": "object" + }, + "ContactDetails": { + "description": "Contact Details.", + "required": [ + "contactName", + "phone", + "emailList" + ], + "type": "object", + "properties": { + "contactName": { + "description": "Contact name of the person.", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact person.", + "type": "string" + }, + "phoneExtension": { + "description": "Phone extension number of the contact person.", + "type": "string" + }, + "mobile": { + "description": "Mobile number of the contact person.", + "type": "string" + }, + "emailList": { + "description": "List of Email-ids to be notified about job progress.", + "type": "array", + "items": { + "type": "string" + } + }, + "notificationPreference": { + "description": "Notification preference for a job stage.", + "type": "array", + "items": { + "$ref": "#/definitions/NotificationPreference" + } + } + } + }, + "ContactInfo": { + "description": "Contact Info.", + "required": [ + "contactName", + "phone" + ], + "type": "object", + "properties": { + "contactName": { + "description": "Contact name of the person.", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number of the contact person.", + "minLength": 1, + "type": "string" + }, + "phoneExtension": { + "description": "Phone extension number of the contact person.", + "type": "string" + }, + "mobile": { + "description": "Mobile number of the contact person.", + "type": "string" + } + } + }, + "CopyLogDetails": { + "description": "Details for log generated during copy.", + "required": [ + "copyLogDetailsType" + ], + "type": "object", + "properties": { + "copyLogDetailsType": { + "description": "Indicates the type of job details.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsExtensible": false, + "values": [ + { + "value": "DataBox", + "description": "Data Box orders." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk orders." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy orders." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk orders." + } + ] + } + } + }, + "discriminator": "copyLogDetailsType" + }, + "GranularCopyLogDetails": { + "description": "Granular Details for log generated during copy.", + "required": [ + "copyLogDetailsType" + ], + "type": "object", + "properties": { + "copyLogDetailsType": { + "description": "Indicates the type of job details.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsExtensible": false, + "values": [ + { + "value": "DataBox", + "description": "Data Box orders." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk orders." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy orders." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk orders." + } + ] + } + } + }, + "discriminator": "copyLogDetailsType" + }, + "DataBoxCustomerDiskCopyProgress": { + "description": "DataBox CustomerDisk Copy Progress", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyProgress" + } + ], + "properties": { + "serialNumber": { + "description": "Disk Serial Number.", + "type": "string", + "readOnly": true + }, + "copyStatus": { + "description": "The Status of the copy", + "enum": [ + "NotStarted", + "InProgress", + "Completed", + "CompletedWithErrors", + "Failed", + "NotReturned", + "HardwareError", + "DeviceFormatted", + "DeviceMetadataModified", + "StorageAccountNotAccessible", + "UnsupportedData", + "DriveNotReceived", + "UnsupportedDrive", + "OtherServiceError", + "OtherUserError", + "DriveNotDetected", + "DriveCorrupted", + "MetadataFilesModifiedOrRemoved" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CopyStatus", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "Data copy hasn't started yet." + }, + { + "value": "InProgress", + "description": "Data copy is in progress." + }, + { + "value": "Completed", + "description": "Data copy completed." + }, + { + "value": "CompletedWithErrors", + "description": "Data copy completed with errors." + }, + { + "value": "Failed", + "description": "Data copy failed. No data was copied." + }, + { + "value": "NotReturned", + "description": "No copy triggered as device was not returned." + }, + { + "value": "HardwareError", + "description": "The Device has hit hardware issues." + }, + { + "value": "DeviceFormatted", + "description": "Data copy failed. The Device was formatted by user." + }, + { + "value": "DeviceMetadataModified", + "description": "Data copy failed. Device metadata was modified by user." + }, + { + "value": "StorageAccountNotAccessible", + "description": "Data copy failed. Storage Account was not accessible during copy." + }, + { + "value": "UnsupportedData", + "description": "Data copy failed. The Device data content is not supported." + }, + { + "value": "DriveNotReceived", + "description": "No copy triggered as device was not received." + }, + { + "value": "UnsupportedDrive", + "description": "No copy triggered as device type is not supported." + }, + { + "value": "OtherServiceError", + "description": "Copy failed due to service error." + }, + { + "value": "OtherUserError", + "description": "Copy failed due to user error." + }, + { + "value": "DriveNotDetected", + "description": "Copy failed due to disk detection error." + }, + { + "value": "DriveCorrupted", + "description": "Copy failed due to corrupted drive." + }, + { + "value": "MetadataFilesModifiedOrRemoved", + "description": "Copy failed due to modified or removed metadata files." + } + ] + } + } + } + }, + "DeviceErasureDetails": { + "description": "Device erasure details with erasure completion status and erasureordestructionlog sas key", + "type": "object", + "properties": { + "deviceErasureStatus": { + "description": "Holds the device erasure completion status", + "enum": [ + "None", + "InProgress", + "Succeeded", + "Failed", + "Cancelled", + "Cancelling", + "SucceededWithErrors", + "WaitingForCustomerAction", + "SucceededWithWarnings", + "WaitingForCustomerActionForKek", + "WaitingForCustomerActionForCleanUp", + "CustomerActionPerformedForCleanUp", + "CustomerActionPerformed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No status available yet." + }, + { + "value": "InProgress", + "description": "Stage is in progress." + }, + { + "value": "Succeeded", + "description": "Stage has succeeded." + }, + { + "value": "Failed", + "description": "Stage has failed." + }, + { + "value": "Cancelled", + "description": "Stage has been cancelled." + }, + { + "value": "Cancelling", + "description": "Stage is cancelling." + }, + { + "value": "SucceededWithErrors", + "description": "Stage has succeeded with errors." + }, + { + "value": "WaitingForCustomerAction", + "description": "Stage is stuck until customer takes some action." + }, + { + "value": "SucceededWithWarnings", + "description": "Stage has succeeded with warnings." + }, + { + "value": "WaitingForCustomerActionForKek", + "description": "Stage is waiting for customer action for kek action items." + }, + { + "value": "WaitingForCustomerActionForCleanUp", + "description": "Stage is waiting for customer action for clean up." + }, + { + "value": "CustomerActionPerformedForCleanUp", + "description": "Stage has performed customer action for clean up." + }, + { + "value": "CustomerActionPerformed", + "description": "Stage has performed customer action for clean up." + } + ] + } + }, + "erasureOrDestructionCertificateSasKey": { + "description": "Shared access key to download cleanup or destruction certificate for device", + "type": "string", + "readOnly": true + } + } + }, + "CopyProgress": { + "description": "Copy progress.", + "type": "object", + "properties": { + "storageAccountName": { + "description": "Name of the storage account. This will be empty for data account types other than storage account.", + "type": "string", + "readOnly": true + }, + "transferType": { + "description": "Transfer type of data", + "enum": [ + "ImportToAzure", + "ExportFromAzure" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TransferType", + "modelAsExtensible": true, + "values": [ + { + "value": "ImportToAzure", + "description": "Import data to azure." + }, + { + "value": "ExportFromAzure", + "description": "Export data from azure." + } + ] + } + }, + "dataAccountType": { + "description": "Data Account Type.", + "enum": [ + "StorageAccount", + "ManagedDisk" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DataAccountType", + "modelAsExtensible": true, + "values": [ + { + "value": "StorageAccount", + "description": "Storage Accounts ." + }, + { + "value": "ManagedDisk", + "description": "Azure Managed disk storage." + } + ] + } + }, + "accountId": { + "description": "Id of the account where the data needs to be uploaded.", + "type": "string", + "readOnly": true + }, + "bytesProcessed": { + "format": "int64", + "description": "To indicate bytes transferred.", + "type": "integer", + "readOnly": true + }, + "totalBytesToProcess": { + "format": "int64", + "description": "Total amount of data to be processed by the job.", + "type": "integer", + "readOnly": true + }, + "filesProcessed": { + "format": "int64", + "description": "Number of files processed", + "type": "integer", + "readOnly": true + }, + "totalFilesToProcess": { + "format": "int64", + "description": "Total files to process", + "type": "integer", + "readOnly": true + }, + "invalidFilesProcessed": { + "format": "int64", + "description": "Number of files not adhering to azure naming conventions which were processed by automatic renaming", + "type": "integer", + "readOnly": true + }, + "invalidFileBytesUploaded": { + "format": "int64", + "description": "Total amount of data not adhering to azure naming conventions which were processed by automatic renaming", + "type": "integer", + "readOnly": true + }, + "renamedContainerCount": { + "format": "int64", + "description": "Number of folders not adhering to azure naming conventions which were processed by automatic renaming", + "type": "integer", + "readOnly": true + }, + "filesErroredOut": { + "format": "int64", + "description": "Number of files which could not be copied", + "type": "integer", + "readOnly": true + }, + "directoriesErroredOut": { + "format": "int64", + "description": "To indicate directories errored out in the job.", + "type": "integer", + "readOnly": true + }, + "invalidDirectoriesProcessed": { + "format": "int64", + "description": "To indicate directories renamed", + "type": "integer", + "readOnly": true + }, + "isEnumerationInProgress": { + "description": "To indicate if enumeration of data is in progress. \r\nUntil this is true, the TotalBytesToProcess may not be valid.", + "type": "boolean", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/CloudError", + "description": "Error, if any, in the stage", + "readOnly": true + }, + "actions": { + "description": "Available actions on the job.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "None", + "MoveToCleanUpDevice", + "Resume", + "Restart", + "ReachOutToOperation" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomerResolutionCode", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No Resolution Yet" + }, + { + "value": "MoveToCleanUpDevice", + "description": "Clean the device" + }, + { + "value": "Resume", + "description": "Resume the job to same stage" + }, + { + "description": "Restart whole action.", + "value": "Restart" + }, + { + "description": "Reach out to operation for further action.", + "value": "ReachOutToOperation" + } + ] + } + }, + "readOnly": true + } + } + }, + "GranularCopyProgress": { + "description": "Granular Copy progress.", + "type": "object", + "properties": { + "storageAccountName": { + "description": "Name of the storage account. This will be empty for data account types other than storage account.", + "type": "string", + "readOnly": true + }, + "transferType": { + "description": "Transfer type of data", + "enum": [ + "ImportToAzure", + "ExportFromAzure" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TransferType", + "modelAsExtensible": true, + "values": [ + { + "value": "ImportToAzure", + "description": "Import data to azure." + }, + { + "value": "ExportFromAzure", + "description": "Export data from azure." + } + ] + } + }, + "dataAccountType": { + "description": "Data Account Type.", + "enum": [ + "StorageAccount", + "ManagedDisk" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DataAccountType", + "modelAsExtensible": true, + "values": [ + { + "value": "StorageAccount", + "description": "Storage Accounts ." + }, + { + "value": "ManagedDisk", + "description": "Azure Managed disk storage." + } + ] + } + }, + "accountId": { + "description": "Id of the account where the data needs to be uploaded.", + "type": "string", + "readOnly": true + }, + "bytesProcessed": { + "format": "int64", + "description": "To indicate bytes transferred.", + "type": "integer", + "readOnly": true + }, + "totalBytesToProcess": { + "format": "int64", + "description": "Total amount of data to be processed by the job.", + "type": "integer", + "readOnly": true + }, + "filesProcessed": { + "format": "int64", + "description": "Number of files processed", + "type": "integer", + "readOnly": true + }, + "totalFilesToProcess": { + "format": "int64", + "description": "Total files to process", + "type": "integer", + "readOnly": true + }, + "invalidFilesProcessed": { + "format": "int64", + "description": "Number of files not adhering to azure naming conventions which were processed by automatic renaming", + "type": "integer", + "readOnly": true + }, + "invalidFileBytesUploaded": { + "format": "int64", + "description": "Total amount of data not adhering to azure naming conventions which were processed by automatic renaming", + "type": "integer", + "readOnly": true + }, + "renamedContainerCount": { + "format": "int64", + "description": "Number of folders not adhering to azure naming conventions which were processed by automatic renaming", + "type": "integer", + "readOnly": true + }, + "filesErroredOut": { + "format": "int64", + "description": "Number of files which could not be copied", + "type": "integer", + "readOnly": true + }, + "directoriesErroredOut": { + "format": "int64", + "description": "To indicate directories errored out in the job.", + "type": "integer", + "readOnly": true + }, + "invalidDirectoriesProcessed": { + "format": "int64", + "description": "To indicate directories renamed", + "type": "integer", + "readOnly": true + }, + "isEnumerationInProgress": { + "description": "To indicate if enumeration of data is in progress. \r\nUntil this is true, the TotalBytesToProcess may not be valid.", + "type": "boolean", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/CloudError", + "description": "Error, if any, in the stage", + "readOnly": true + }, + "actions": { + "description": "Available actions on the job.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "None", + "MoveToCleanUpDevice", + "Resume", + "Restart", + "ReachOutToOperation" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomerResolutionCode", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No Resolution Yet" + }, + { + "value": "MoveToCleanUpDevice", + "description": "Clean the device" + }, + { + "value": "Resume", + "description": "Resume the job to same stage" + }, + { + "description": "Restart whole action.", + "value": "Restart" + }, + { + "description": "Reach out to operation for further action.", + "value": "ReachOutToOperation" + } + ] + } + }, + "readOnly": true + } + } + }, + "CreateJobValidations": { + "description": "It does all pre-job creation validations.", + "required": [ + "validationCategory", + "individualRequestDetails" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationRequest" + } + ], + "properties": {}, + "x-ms-discriminator-value": "JobCreationValidation" + }, + "CreateOrderLimitForSubscriptionValidationRequest": { + "description": "Request to validate create order limit for current subscription.", + "required": [ + "deviceType", + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputRequest" + } + ], + "properties": { + "deviceType": { + "description": "Device type to be used for the job.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk." + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidateCreateOrderLimit" + }, + "CreateOrderLimitForSubscriptionValidationResponseProperties": { + "description": "Properties of create order limit for subscription validation response.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputResponse" + } + ], + "properties": { + "status": { + "description": "Create order limit validation status.", + "enum": [ + "Valid", + "Invalid", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Valid", + "description": "Validation is successful" + }, + { + "value": "Invalid", + "description": "Validation is not successful" + }, + { + "value": "Skipped", + "description": "Validation is skipped" + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidateCreateOrderLimit" + }, + "DataBoxCustomerDiskJobDetails": { + "description": "Customer disk job details.", + "required": [ + "jobDetailsType", + "returnToCustomerPackageDetails" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "importDiskDetailsCollection": { + "description": "Contains the map of disk serial number to the disk details for import jobs.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ImportDiskDetails" + } + }, + "exportDiskDetailsCollection": { + "description": "Contains the map of disk serial number to the disk details for export jobs.", + "type": "object", + "readOnly": true, + "additionalProperties": { + "$ref": "#/definitions/ExportDiskDetails" + } + }, + "copyProgress": { + "description": "Copy progress per disk.", + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxCustomerDiskCopyProgress" + }, + "readOnly": true + }, + "deliverToDcPackageDetails": { + "description": "Delivery package shipping details.", + "$ref": "#/definitions/PackageCarrierInfo", + "readOnly": true + }, + "returnToCustomerPackageDetails": { + "description": "Return package shipping details.", + "$ref": "#/definitions/PackageCarrierDetails" + }, + "enableManifestBackup": { + "description": "Flag to indicate if disk manifest should be backed-up in the Storage Account.", + "type": "boolean", + "default": false + } + }, + "x-ms-discriminator-value": "DataBoxCustomerDisk" + }, + "CustomerDiskJobSecrets": { + "description": "The secrets related to customer disk job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "diskSecrets": { + "description": "Contains the list of secrets object for that device.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskSecret" + }, + "readOnly": true + }, + "carrierAccountNumber": { + "description": "Carrier Account Number of the customer", + "type": "string", + "readOnly": true, + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "DataBoxCustomerDisk" + }, + "DataAccountDetails": { + "description": "Account details of the data to be transferred", + "required": [ + "dataAccountType" + ], + "type": "object", + "properties": { + "dataAccountType": { + "description": "Account Type of the data to be transferred.", + "enum": [ + "StorageAccount", + "ManagedDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "DataAccountType", + "modelAsExtensible": true, + "values": [ + { + "value": "StorageAccount", + "description": "Storage Accounts ." + }, + { + "value": "ManagedDisk", + "description": "Azure Managed disk storage." + } + ] + }, + "default": "StorageAccount" + }, + "sharePassword": { + "description": "Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\\-$%^!+=;:_()]+", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create" + ] + } + }, + "discriminator": "dataAccountType" + }, + "DatacenterAddressInstructionResponse": { + "description": "Datacenter instruction for given storage location.", + "required": [ + "datacenterAddressType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatacenterAddressResponse" + } + ], + "properties": { + "communicationInstruction": { + "description": "Data center communication instruction", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "DatacenterAddressInstruction" + }, + "DatacenterAddressLocationResponse": { + "description": "Datacenter address for given storage location.", + "required": [ + "datacenterAddressType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatacenterAddressResponse" + } + ], + "properties": { + "contactPersonName": { + "description": "Contact person name", + "type": "string", + "readOnly": true + }, + "company": { + "description": "Company name", + "type": "string", + "readOnly": true + }, + "street1": { + "description": "Street address line 1", + "type": "string", + "readOnly": true + }, + "street2": { + "description": "Street address line 2", + "type": "string", + "readOnly": true + }, + "street3": { + "description": "Street address line 3", + "type": "string", + "readOnly": true + }, + "city": { + "description": "City name", + "type": "string", + "readOnly": true + }, + "state": { + "description": "name of the state", + "type": "string", + "readOnly": true + }, + "zip": { + "description": "Zip code", + "type": "string", + "readOnly": true + }, + "country": { + "description": "name of the country", + "type": "string", + "readOnly": true + }, + "phone": { + "description": "Phone number", + "type": "string", + "readOnly": true + }, + "phoneExtension": { + "description": "Phone extension", + "type": "string", + "readOnly": true + }, + "addressType": { + "description": "Address type", + "type": "string", + "readOnly": true + }, + "additionalShippingInformation": { + "description": "Special instruction for shipping", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "DatacenterAddressLocation" + }, + "DatacenterAddressRequest": { + "description": "Request body to get the datacenter address.", + "required": [ + "storageLocation", + "skuName" + ], + "type": "object", + "properties": { + "storageLocation": { + "description": "Storage location. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", + "type": "string" + }, + "skuName": { + "description": "Sku Name for which the data center address requested.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk." + } + ] + } + } + } + }, + "DatacenterAddressResponse": { + "description": "Datacenter address for given storage location.", + "required": [ + "datacenterAddressType" + ], + "type": "object", + "properties": { + "datacenterAddressType": { + "description": "Data center address type", + "enum": [ + "DatacenterAddressLocation", + "DatacenterAddressInstruction" + ], + "type": "string", + "x-ms-enum": { + "name": "DatacenterAddressType", + "modelAsExtensible": false, + "values": [ + { + "value": "DatacenterAddressLocation", + "description": "Data center address location." + }, + { + "value": "DatacenterAddressInstruction", + "description": "Data center address instruction." + } + ] + } + }, + "supportedCarriersForReturnShipment": { + "description": "List of supported carriers for return shipment.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "dataCenterAzureLocation": { + "description": "Azure Location where the Data Center serves primarily.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "datacenterAddressType" + }, + "DataBoxAccountCopyLogDetails": { + "description": "Copy log details for a storage account of a DataBox job", + "required": [ + "copyLogDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyLogDetails" + } + ], + "properties": { + "accountName": { + "description": "Account name.", + "type": "string", + "readOnly": true + }, + "copyLogLink": { + "description": "Link for copy logs.", + "type": "string", + "readOnly": true + }, + "copyVerboseLogLink": { + "description": "Link for copy verbose logs. This will be set only when LogCollectionLevel is set to Verbose.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "DataBox" + }, + "DataBoxCustomerDiskCopyLogDetails": { + "description": "Copy Log Details for customer disk", + "required": [ + "copyLogDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyLogDetails" + } + ], + "properties": { + "serialNumber": { + "description": "Disk Serial Number.", + "type": "string", + "readOnly": true + }, + "errorLogLink": { + "description": "Link for copy error logs.", + "type": "string", + "readOnly": true + }, + "verboseLogLink": { + "description": "Link for copy verbose logs.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "DataBoxCustomerDisk" + }, + "DataBoxDiskCopyLogDetails": { + "description": "Copy Log Details for a disk", + "required": [ + "copyLogDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyLogDetails" + } + ], + "properties": { + "diskSerialNumber": { + "description": "Disk Serial Number.", + "type": "string", + "readOnly": true + }, + "errorLogLink": { + "description": "Link for copy error logs.", + "type": "string", + "readOnly": true + }, + "verboseLogLink": { + "description": "Link for copy verbose logs.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "DataBoxDisk" + }, + "DataBoxDiskGranularCopyLogDetails": { + "description": "Granular Copy Log Details for customer disk", + "required": [ + "copyLogDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GranularCopyLogDetails" + } + ], + "properties": { + "serialNumber": { + "description": "Disk Serial Number.", + "type": "string", + "readOnly": true + }, + "accountId": { + "description": "Account id.", + "type": "string", + "readOnly": true + }, + "errorLogLink": { + "description": "Link for copy error logs.", + "type": "string", + "readOnly": true + }, + "verboseLogLink": { + "description": "Link for copy verbose logs.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "DataBoxCustomerDisk" + }, + "DataBoxDiskCopyProgress": { + "description": "DataBox Disk Copy Progress", + "type": "object", + "properties": { + "serialNumber": { + "description": "The serial number of the disk", + "type": "string", + "readOnly": true + }, + "bytesCopied": { + "format": "int64", + "description": "Bytes copied during the copy of disk.", + "type": "integer", + "readOnly": true + }, + "percentComplete": { + "format": "int32", + "description": "Indicates the percentage completed for the copy of the disk.", + "type": "integer", + "readOnly": true + }, + "status": { + "description": "The Status of the copy", + "enum": [ + "NotStarted", + "InProgress", + "Completed", + "CompletedWithErrors", + "Failed", + "NotReturned", + "HardwareError", + "DeviceFormatted", + "DeviceMetadataModified", + "StorageAccountNotAccessible", + "UnsupportedData", + "DriveNotReceived", + "UnsupportedDrive", + "OtherServiceError", + "OtherUserError", + "DriveNotDetected", + "DriveCorrupted", + "MetadataFilesModifiedOrRemoved" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CopyStatus", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "Data copy hasn't started yet." + }, + { + "value": "InProgress", + "description": "Data copy is in progress." + }, + { + "value": "Completed", + "description": "Data copy completed." + }, + { + "value": "CompletedWithErrors", + "description": "Data copy completed with errors." + }, + { + "value": "Failed", + "description": "Data copy failed. No data was copied." + }, + { + "value": "NotReturned", + "description": "No copy triggered as device was not returned." + }, + { + "value": "HardwareError", + "description": "The Device has hit hardware issues." + }, + { + "value": "DeviceFormatted", + "description": "Data copy failed. The Device was formatted by user." + }, + { + "value": "DeviceMetadataModified", + "description": "Data copy failed. Device metadata was modified by user." + }, + { + "value": "StorageAccountNotAccessible", + "description": "Data copy failed. Storage Account was not accessible during copy." + }, + { + "value": "UnsupportedData", + "description": "Data copy failed. The Device data content is not supported." + }, + { + "value": "DriveNotReceived", + "description": "No copy triggered as device was not received." + }, + { + "value": "UnsupportedDrive", + "description": "No copy triggered as device type is not supported." + }, + { + "value": "OtherServiceError", + "description": "Copy failed due to service error." + }, + { + "value": "OtherUserError", + "description": "Copy failed due to user error." + }, + { + "value": "DriveNotDetected", + "description": "Copy failed due to disk detection error." + }, + { + "value": "DriveCorrupted", + "description": "Copy failed due to corrupted drive." + }, + { + "value": "MetadataFilesModifiedOrRemoved", + "description": "Copy failed due to modified or removed metadata files." + } + ] + } + }, + "error": { + "$ref": "#/definitions/CloudError", + "description": "Error, if any, in the stage", + "readOnly": true + }, + "actions": { + "description": "Available actions on the job.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "None", + "MoveToCleanUpDevice", + "Resume", + "Restart", + "ReachOutToOperation" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomerResolutionCode", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No Resolution Yet" + }, + { + "value": "MoveToCleanUpDevice", + "description": "Clean the device" + }, + { + "value": "Resume", + "description": "Resume the job to same stage" + }, + { + "description": "Restart whole action.", + "value": "Restart" + }, + { + "description": "Reach out to operation for further action.", + "value": "ReachOutToOperation" + } + ] + } + }, + "readOnly": true + } + } + }, + "DataBoxDiskGranularCopyProgress": { + "description": "DataBox Disk Granular Copy Progress", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GranularCopyProgress" + } + ], + "properties": { + "serialNumber": { + "description": "Disk Serial Number.", + "type": "string", + "readOnly": true + }, + "copyStatus": { + "description": "The Status of the copy", + "enum": [ + "NotStarted", + "InProgress", + "Completed", + "CompletedWithErrors", + "Failed", + "NotReturned", + "HardwareError", + "DeviceFormatted", + "DeviceMetadataModified", + "StorageAccountNotAccessible", + "UnsupportedData", + "DriveNotReceived", + "UnsupportedDrive", + "OtherServiceError", + "OtherUserError", + "DriveNotDetected", + "DriveCorrupted", + "MetadataFilesModifiedOrRemoved" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CopyStatus", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "Data copy hasn't started yet." + }, + { + "value": "InProgress", + "description": "Data copy is in progress." + }, + { + "value": "Completed", + "description": "Data copy completed." + }, + { + "value": "CompletedWithErrors", + "description": "Data copy completed with errors." + }, + { + "value": "Failed", + "description": "Data copy failed. No data was copied." + }, + { + "value": "NotReturned", + "description": "No copy triggered as device was not returned." + }, + { + "value": "HardwareError", + "description": "The Device has hit hardware issues." + }, + { + "value": "DeviceFormatted", + "description": "Data copy failed. The Device was formatted by user." + }, + { + "value": "DeviceMetadataModified", + "description": "Data copy failed. Device metadata was modified by user." + }, + { + "value": "StorageAccountNotAccessible", + "description": "Data copy failed. Storage Account was not accessible during copy." + }, + { + "value": "UnsupportedData", + "description": "Data copy failed. The Device data content is not supported." + }, + { + "value": "DriveNotReceived", + "description": "No copy triggered as device was not received." + }, + { + "value": "UnsupportedDrive", + "description": "No copy triggered as device type is not supported." + }, + { + "value": "OtherServiceError", + "description": "Copy failed due to service error." + }, + { + "value": "OtherUserError", + "description": "Copy failed due to user error." + }, + { + "value": "DriveNotDetected", + "description": "Copy failed due to disk detection error." + }, + { + "value": "DriveCorrupted", + "description": "Copy failed due to corrupted drive." + }, + { + "value": "MetadataFilesModifiedOrRemoved", + "description": "Copy failed due to modified or removed metadata files." + } + ] + } + } + } + }, + "DataBoxDiskJobDetails": { + "description": "DataBox Disk Job Details.", + "required": [ + "contactDetails", + "jobDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "preferredDisks": { + "description": "User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + }, + "copyProgress": { + "description": "Copy progress per disk.", + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxDiskCopyProgress" + }, + "readOnly": true + }, + "granularCopyProgress": { + "description": "Copy progress per disk.", + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxDiskGranularCopyProgress" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "granularCopyLogDetails": { + "description": "Copy progress per disk.", + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxDiskGranularCopyLogDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disksAndSizeDetails": { + "description": "Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "passkey": { + "description": "User entered passkey for DataBox Disk job.", + "type": "string" + } + }, + "x-ms-discriminator-value": "DataBoxDisk" + }, + "DataBoxDiskJobSecrets": { + "description": "The secrets related to disk job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "diskSecrets": { + "description": "Contains the list of secrets object for that device.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskSecret" + }, + "readOnly": true + }, + "passKey": { + "description": "PassKey for the disk Job.", + "type": "string", + "readOnly": true + }, + "isPasskeyUserDefined": { + "description": "Whether passkey was provided by user.", + "type": "boolean", + "readOnly": true + } + }, + "x-ms-discriminator-value": "DataBoxDisk" + }, + "DataBoxHeavyAccountCopyLogDetails": { + "description": "Copy log details for a storage account for Databox heavy", + "required": [ + "copyLogDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyLogDetails" + } + ], + "properties": { + "accountName": { + "description": "Account name.", + "type": "string", + "readOnly": true + }, + "copyLogLink": { + "description": "Link for copy logs.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "copyVerboseLogLink": { + "description": "Link for copy verbose logs. This will be set only when the LogCollectionLevel is set to verbose.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "DataBoxHeavy" + }, + "DataBoxHeavyJobDetails": { + "description": "Databox Heavy Device Job Details", + "required": [ + "contactDetails", + "jobDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "copyProgress": { + "description": "Copy progress per account.", + "type": "array", + "items": { + "$ref": "#/definitions/CopyProgress" + }, + "readOnly": true + }, + "devicePassword": { + "description": "Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\\-$%^!+=;:_()]+", + "type": "string" + } + }, + "x-ms-discriminator-value": "DataBoxHeavy" + }, + "DataBoxHeavyJobSecrets": { + "description": "The secrets related to a databox heavy job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "cabinetPodSecrets": { + "description": "Contains the list of secret objects for a databox heavy job.", + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxHeavySecret" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "DataBoxHeavy" + }, + "DataBoxHeavySecret": { + "description": "The secrets related to a databox heavy.", + "type": "object", + "properties": { + "deviceSerialNumber": { + "description": "Serial number of the assigned device.", + "type": "string", + "readOnly": true + }, + "devicePassword": { + "description": "Password for out of the box experience on device.", + "type": "string", + "readOnly": true + }, + "networkConfigurations": { + "description": "Network configuration of the appliance.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplianceNetworkConfiguration" + }, + "readOnly": true + }, + "encodedValidationCertPubKey": { + "description": "The base 64 encoded public key to authenticate with the device", + "type": "string", + "readOnly": true + }, + "accountCredentialDetails": { + "description": "Per account level access credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/AccountCredentialDetails" + }, + "readOnly": true + } + } + }, + "DataBoxJobDetails": { + "description": "Databox Job Details", + "required": [ + "contactDetails", + "jobDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "copyProgress": { + "description": "Copy progress per storage account.", + "type": "array", + "items": { + "$ref": "#/definitions/CopyProgress" + }, + "readOnly": true + }, + "devicePassword": { + "description": "Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\\-$%^!+=;:_()]+", + "type": "string" + } + }, + "x-ms-discriminator-value": "DataBox" + }, + "DataboxJobSecrets": { + "description": "The secrets related to a databox job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "podSecrets": { + "description": "Contains the list of secret objects for a job.", + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxSecret" + } + } + }, + "x-ms-discriminator-value": "DataBox" + }, + "DataBoxScheduleAvailabilityRequest": { + "description": "Request body to get the availability for scheduling data box orders orders.", + "required": [ + "storageLocation", + "skuName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleAvailabilityRequest" + } + ], + "properties": {}, + "x-ms-discriminator-value": "DataBox" + }, + "DataBoxSecret": { + "description": "The secrets related to a DataBox.", + "type": "object", + "properties": { + "deviceSerialNumber": { + "description": "Serial number of the assigned device.", + "type": "string", + "readOnly": true + }, + "devicePassword": { + "description": "Password for out of the box experience on device.", + "type": "string", + "readOnly": true + }, + "networkConfigurations": { + "description": "Network configuration of the appliance.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplianceNetworkConfiguration" + }, + "readOnly": true + }, + "encodedValidationCertPubKey": { + "description": "The base 64 encoded public key to authenticate with the device", + "type": "string", + "readOnly": true + }, + "accountCredentialDetails": { + "description": "Per account level access credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/AccountCredentialDetails" + }, + "readOnly": true + } + } + }, + "DataExportDetails": { + "description": "Details of the data to be used for exporting data from azure.", + "required": [ + "transferConfiguration", + "accountDetails" + ], + "type": "object", + "properties": { + "transferConfiguration": { + "$ref": "#/definitions/TransferConfiguration", + "description": "Configuration for the data transfer." + }, + "logCollectionLevel": { + "description": "Level of the logs to be collected.", + "enum": [ + "Error", + "Verbose" + ], + "type": "string", + "x-ms-enum": { + "name": "LogCollectionLevel", + "modelAsExtensible": true, + "values": [ + { + "value": "Error", + "description": "Only Errors will be collected in the logs." + }, + { + "value": "Verbose", + "description": "Verbose logging (includes Errors, CRC, size information and others)." + } + ] + }, + "default": "Error" + }, + "accountDetails": { + "$ref": "#/definitions/DataAccountDetails", + "description": "Account details of the data to be transferred" + } + } + }, + "DataImportDetails": { + "description": "Details of the data to be used for importing data to azure.", + "required": [ + "accountDetails" + ], + "type": "object", + "properties": { + "accountDetails": { + "$ref": "#/definitions/DataAccountDetails", + "description": "Account details of the data to be transferred" + }, + "logCollectionLevel": { + "description": "Level of the logs to be collected.", + "enum": [ + "Error", + "Verbose" + ], + "type": "string", + "x-ms-enum": { + "name": "LogCollectionLevel", + "modelAsExtensible": true, + "values": [ + { + "value": "Error", + "description": "Only Errors will be collected in the logs." + }, + { + "value": "Verbose", + "description": "Verbose logging (includes Errors, CRC, size information and others)." + } + ] + }, + "default": "Error" + } + } + }, + "DataLocationToServiceLocationMap": { + "description": "Map of data location to service location", + "type": "object", + "properties": { + "dataLocation": { + "description": "Location of the data.", + "type": "string", + "readOnly": true + }, + "serviceLocation": { + "description": "Location of the service.", + "type": "string", + "readOnly": true + } + } + }, + "DataTransferDetailsValidationRequest": { + "description": "Request to validate export and import data details.", + "required": [ + "deviceType", + "transferType", + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputRequest" + } + ], + "properties": { + "dataExportDetails": { + "description": "List of DataTransfer details to be used to export data from azure.", + "type": "array", + "items": { + "$ref": "#/definitions/DataExportDetails" + } + }, + "dataImportDetails": { + "description": "List of DataTransfer details to be used to import data to azure.", + "type": "array", + "items": { + "$ref": "#/definitions/DataImportDetails" + } + }, + "deviceType": { + "description": "Device type.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk." + } + ] + } + }, + "transferType": { + "description": "Type of the transfer.", + "enum": [ + "ImportToAzure", + "ExportFromAzure" + ], + "type": "string", + "x-ms-enum": { + "name": "TransferType", + "modelAsExtensible": true, + "values": [ + { + "value": "ImportToAzure", + "description": "Import data to azure." + }, + { + "value": "ExportFromAzure", + "description": "Export data from azure." + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidateDataTransferDetails" + }, + "DataTransferDetailsValidationResponseProperties": { + "description": "Properties of data transfer details validation response.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputResponse" + } + ], + "properties": { + "status": { + "description": "Data transfer details validation status.", + "enum": [ + "Valid", + "Invalid", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Valid", + "description": "Validation is successful" + }, + { + "value": "Invalid", + "description": "Validation is not successful" + }, + { + "value": "Skipped", + "description": "Validation is skipped" + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidateDataTransferDetails" + }, + "DcAccessSecurityCode": { + "description": "Dc access security code", + "type": "object", + "properties": { + "reverseDCAccessCode": { + "description": "Reverse Dc access security code.", + "type": "string" + }, + "forwardDCAccessCode": { + "description": "Forward Dc access security code.", + "type": "string" + } + } + }, + "Details": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "DeviceCapabilityDetails": { + "description": "Device capability details for a given sku for a given region.", + "type": "object", + "properties": { + "hardwareEncryption": { + "description": "Hardware encryption support for a given sku for a given region.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HardwareEncryption", + "modelAsExtensible": true, + "values": [ + { + "value": "Enabled", + "description": "Hardware-based encryption is enabled." + }, + { + "value": "Disabled", + "description": "Hardware-based encryption is disabled." + } + ] + } + } + } + }, + "DeviceCapabilityRequest": { + "description": "Request body to get the device capabilities for given sku.", + "type": "object", + "properties": { + "skuName": { + "description": "Type of the device.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk." + } + ] + } + } + } + }, + "DeviceCapabilityResponse": { + "description": "Device capabilities for given sku in a region", + "type": "object", + "properties": { + "deviceCapabilityDetails": { + "description": "List of device capabilities available for a given region and a given sku", + "type": "array", + "items": { + "$ref": "#/definitions/DeviceCapabilityDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "DiskScheduleAvailabilityRequest": { + "description": "Request body to get the availability for scheduling disk orders.", + "required": [ + "storageLocation", + "skuName", + "expectedDataSizeInTeraBytes" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleAvailabilityRequest" + } + ], + "properties": { + "expectedDataSizeInTeraBytes": { + "format": "int32", + "description": "The expected size of the data, which needs to be transferred in this job, in terabytes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "DataBoxDisk" + }, + "DiskSecret": { + "description": "Contains all the secrets of a Disk.", + "type": "object", + "properties": { + "diskSerialNumber": { + "description": "Serial number of the assigned disk.", + "type": "string", + "readOnly": true + }, + "bitLockerKey": { + "description": "Bit Locker key of the disk which can be used to unlock the disk to copy data.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionPreferences": { + "description": "Preferences related to the Encryption.", + "type": "object", + "properties": { + "doubleEncryption": { + "description": "Defines secondary layer of software-based encryption enablement.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DoubleEncryption", + "modelAsExtensible": true, + "values": [ + { + "value": "Enabled", + "description": "Software-based encryption is enabled." + }, + { + "value": "Disabled", + "description": "Software-based encryption is disabled." + } + ] + }, + "default": "Disabled" + }, + "hardwareEncryption": { + "description": "Defines Hardware level encryption (Only for disk)", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "HardwareEncryption", + "modelAsExtensible": true, + "values": [ + { + "value": "Enabled", + "description": "Hardware-based encryption is enabled." + }, + { + "value": "Disabled", + "description": "Hardware-based encryption is enabled." + } + ] + } + } + } + }, + "ErrorDetail": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/Details" + } + }, + "target": { + "type": "string" + } + } + }, + "ExportDiskDetails": { + "description": "Export disk details", + "type": "object", + "properties": { + "manifestFile": { + "description": "The relative path of the manifest file on the disk.", + "type": "string", + "readOnly": true + }, + "manifestHash": { + "description": "The Base16-encoded MD5 hash of the manifest file on the disk.", + "type": "string", + "readOnly": true + }, + "backupManifestCloudPath": { + "description": "Path to backed up manifest, only returned if enableManifestBackup is true.", + "type": "string", + "readOnly": true + } + } + }, + "FilterFileDetails": { + "description": "Details of the filter files to be used for data transfer.", + "required": [ + "filterFileType", + "filterFilePath" + ], + "type": "object", + "properties": { + "filterFileType": { + "description": "Type of the filter file.", + "enum": [ + "AzureBlob", + "AzureFile" + ], + "type": "string", + "x-ms-enum": { + "name": "FilterFileType", + "modelAsExtensible": true, + "values": [ + { + "value": "AzureBlob", + "description": "Filter file is of the type AzureBlob." + }, + { + "value": "AzureFile", + "description": "Filter file is of the type AzureFiles." + } + ] + } + }, + "filterFilePath": { + "description": "Path of the file that contains the details of all items to transfer.", + "type": "string" + } + } + }, + "HeavyScheduleAvailabilityRequest": { + "description": "Request body to get the availability for scheduling heavy orders.", + "required": [ + "storageLocation", + "skuName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleAvailabilityRequest" + } + ], + "properties": {}, + "x-ms-discriminator-value": "DataBoxHeavy" + }, + "IdentityProperties": { + "description": "Managed identity properties.", + "type": "object", + "properties": { + "type": { + "description": "Managed service identity type.", + "type": "string" + }, + "userAssigned": { + "$ref": "#/definitions/UserAssignedProperties", + "description": "User assigned identity properties." + } + } + }, + "ImportDiskDetails": { + "description": "Import disk details", + "required": [ + "manifestFile", + "manifestHash", + "bitLockerKey" + ], + "type": "object", + "properties": { + "manifestFile": { + "description": "The relative path of the manifest file on the disk.", + "type": "string" + }, + "manifestHash": { + "description": "The Base16-encoded MD5 hash of the manifest file on the disk.", + "type": "string" + }, + "bitLockerKey": { + "description": "BitLocker key used to encrypt the disk.", + "type": "string", + "x-ms-secret": true + }, + "backupManifestCloudPath": { + "description": "Path to backed up manifest, only returned if enableManifestBackup is true.", + "type": "string", + "readOnly": true + } + } + }, + "JobDeliveryInfo": { + "description": "Additional delivery info.", + "type": "object", + "properties": { + "scheduledDateTime": { + "format": "date-time", + "description": "Scheduled date time.", + "type": "string" + } + } + }, + "JobDelayDetails": { + "description": "Job Delay Notification details", + "type": "object", + "properties": { + "status": { + "description": "Status of notification", + "enum": [ + "Active", + "Resolved" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DelayNotificationStatus", + "modelAsString": true, + "values": [ + { + "value": "Active", + "description": "Delay is still active" + }, + { + "value": "Resolved", + "description": "Delay has been resolved" + } + ] + } + }, + "errorCode": { + "description": "Delay Error code", + "enum": [ + "InternalIssueDelay", + "ActiveOrderLimitBreachedDelay", + "HighDemandDelay", + "LargeNumberOfFilesDelay" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PortalDelayErrorCode", + "modelAsString": true, + "values": [ + { + "value": "InternalIssueDelay", + "description": "Delay due to any internal reasons" + }, + { + "value": "ActiveOrderLimitBreachedDelay", + "description": "Active Order limit breached." + }, + { + "value": "ActiveOrderLimitBreachedDelay", + "description": "High demand" + }, + { + "value": "ActiveOrderLimitBreachedDelay", + "description": "Slow copy due to large number of files" + } + ] + } + }, + "description": { + "description": "Description of the delay.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Timestamp when the delay notification was created.", + "type": "string", + "readOnly": true + }, + "resolutionTime": { + "format": "date-time", + "description": "Timestamp when the delay notification was resolved.", + "type": "string", + "readOnly": true + } + } + }, + "JobDetails": { + "description": "Job details.", + "required": [ + "contactDetails", + "jobDetailsType" + ], + "type": "object", + "properties": { + "jobStages": { + "description": "List of stages that run in the job.", + "type": "array", + "items": { + "$ref": "#/definitions/JobStages" + }, + "readOnly": true + }, + "contactDetails": { + "$ref": "#/definitions/ContactDetails", + "description": "Contact details for notification and shipping." + }, + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping address of the customer." + }, + "deliveryPackage": { + "$ref": "#/definitions/PackageShippingDetails", + "description": "Delivery package shipping details.", + "readOnly": true + }, + "returnPackage": { + "$ref": "#/definitions/PackageShippingDetails", + "description": "Return package shipping details.", + "readOnly": true + }, + "dataImportDetails": { + "description": "Details of the data to be imported into azure.", + "type": "array", + "items": { + "$ref": "#/definitions/DataImportDetails" + } + }, + "dataExportDetails": { + "description": "Details of the data to be exported from azure.", + "type": "array", + "items": { + "$ref": "#/definitions/DataExportDetails" + } + }, + "jobDetailsType": { + "description": "Indicates the type of job details.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsExtensible": false, + "values": [ + { + "value": "DataBox", + "description": "Data Box orders." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk orders." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy orders." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk orders." + } + ] + } + }, + "preferences": { + "$ref": "#/definitions/Preferences", + "description": "Preferences for the order." + }, + "reverseShippingDetails": { + "$ref": "#/definitions/ReverseShippingDetails", + "description": "Optional Reverse Shipping details for order." + }, + "copyLogDetails": { + "description": "List of copy log details.", + "type": "array", + "items": { + "$ref": "#/definitions/CopyLogDetails" + }, + "readOnly": true + }, + "reverseShipmentLabelSasKey": { + "description": "Shared access key to download the return shipment label", + "type": "string", + "readOnly": true + }, + "chainOfCustodySasKey": { + "description": "Shared access key to download the chain of custody logs", + "type": "string", + "readOnly": true + }, + "deviceErasureDetails": { + "$ref": "#/definitions/DeviceErasureDetails", + "description": "Holds device data erasure details", + "readOnly": true + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyEncryptionKey", + "description": "Details about which key encryption type is being used." + }, + "expectedDataSizeInTeraBytes": { + "format": "int32", + "description": "The expected size of the data, which needs to be transferred in this job, in terabytes.", + "type": "integer" + }, + "actions": { + "description": "Available actions on the job.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "None", + "MoveToCleanUpDevice", + "Resume", + "Restart", + "ReachOutToOperation" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomerResolutionCode", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No Resolution Yet" + }, + { + "value": "MoveToCleanUpDevice", + "description": "Clean the device" + }, + { + "value": "Resume", + "description": "Resume the job to same stage" + }, + { + "description": "Restart whole action.", + "value": "Restart" + }, + { + "description": "Reach out to operation for further action.", + "value": "ReachOutToOperation" + } + ] + } + }, + "readOnly": true + }, + "lastMitigationActionOnJob": { + "$ref": "#/definitions/LastMitigationActionOnJob", + "description": "Last mitigation action performed on the job.", + "readOnly": true + }, + "datacenterAddress": { + "$ref": "#/definitions/DatacenterAddressResponse", + "description": "Datacenter address to ship to, for the given sku and storage location.", + "readOnly": true + }, + "dataCenterCode": { + "description": "DataCenter code.", + "enum": [ + "Invalid", + "BY2", + "BY1", + "ORK70", + "AM2", + "AMS20", + "BY21", + "BY24", + "MWH01", + "AMS06", + "SSE90", + "SYD03", + "SYD23", + "CBR20", + "YTO20", + "CWL20", + "LON24", + "BOM01", + "BL20", + "BL7", + "SEL20", + "TYO01", + "BN1", + "SN5", + "CYS04", + "TYO22", + "YTO21", + "YQB20", + "FRA22", + "MAA01", + "CPQ02", + "CPQ20", + "SIN20", + "HKG20", + "SG2", + "MEL23", + "SEL21", + "OSA20", + "SHA03", + "BJB", + "JNB22", + "JNB21", + "MNZ21", + "SN8", + "AUH20", + "ZRH20", + "PUS20", + "AdHoc", + "CH1", + "DSM05", + "DUB07", + "PNQ01", + "SVG20", + "OSA02", + "OSA22", + "PAR22", + "BN7", + "SN6", + "BJS20", + "BL24", + "IDC5", + "TYO23", + "NTG20", + "DXB23", + "DSM11", + "AMS25", + "CPQ21", + "OSA23" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DataCenterCode", + "modelAsString": true, + "values": [ + { + "value": "Invalid" + }, + { + "value": "BY2" + }, + { + "value": "BY1" + }, + { + "value": "ORK70" + }, + { + "value": "AM2" + }, + { + "value": "AMS20" + }, + { + "value": "BY21" + }, + { + "value": "BY24" + }, + { + "value": "MWH01" + }, + { + "value": "AMS06" + }, + { + "value": "SSE90" + }, + { + "value": "SYD03" + }, + { + "value": "SYD23" + }, + { + "value": "CBR20" + }, + { + "value": "YTO20" + }, + { + "value": "CWL20" + }, + { + "value": "LON24" + }, + { + "value": "BOM01" + }, + { + "value": "BL20" + }, + { + "value": "BL7" + }, + { + "value": "SEL20" + }, + { + "value": "TYO01" + }, + { + "value": "BN1" + }, + { + "value": "SN5" + }, + { + "value": "CYS04" + }, + { + "value": "TYO22" + }, + { + "value": "YTO21" + }, + { + "value": "YQB20" + }, + { + "value": "FRA22" + }, + { + "value": "MAA01" + }, + { + "value": "CPQ02" + }, + { + "value": "CPQ20" + }, + { + "value": "SIN20" + }, + { + "value": "HKG20" + }, + { + "value": "SG2" + }, + { + "value": "MEL23" + }, + { + "value": "SEL21" + }, + { + "value": "OSA20" + }, + { + "value": "SHA03" + }, + { + "value": "BJB" + }, + { + "value": "JNB22" + }, + { + "value": "JNB21" + }, + { + "value": "MNZ21" + }, + { + "value": "SN8" + }, + { + "value": "AUH20" + }, + { + "value": "ZRH20" + }, + { + "value": "PUS20" + }, + { + "value": "AdHoc" + }, + { + "value": "CH1" + }, + { + "value": "DSM05" + }, + { + "value": "DUB07" + }, + { + "value": "PNQ01" + }, + { + "value": "SVG20" + }, + { + "value": "OSA02" + }, + { + "value": "OSA22" + }, + { + "value": "PAR22" + }, + { + "value": "BN7" + }, + { + "value": "SN6" + }, + { + "value": "BJS20" + }, + { + "value": "BL24" + }, + { + "value": "IDC5" + }, + { + "value": "TYO23" + }, + { + "value": "CPQ21" + }, + { + "value": "NTG20" + }, + { + "value": "DXB23" + }, + { + "value": "DSM11" + }, + { + "value": "OSA23" + }, + { + "value": "AMS25" + } + ] + } + } + }, + "discriminator": "jobDetailsType" + }, + "JobProperties": { + "description": "Job Properties", + "required": [ + "transferType" + ], + "type": "object", + "properties": { + "transferType": { + "description": "Type of the data transfer.", + "enum": [ + "ImportToAzure", + "ExportFromAzure" + ], + "type": "string", + "x-ms-enum": { + "name": "TransferType", + "modelAsExtensible": true, + "values": [ + { + "value": "ImportToAzure", + "description": "Import data to azure." + }, + { + "value": "ExportFromAzure", + "description": "Export data from azure." + } + ] + } + }, + "isCancellable": { + "description": "Describes whether the job is cancellable or not.", + "type": "boolean", + "readOnly": true + }, + "isDeletable": { + "description": "Describes whether the job is deletable or not.", + "type": "boolean", + "readOnly": true + }, + "isShippingAddressEditable": { + "description": "Describes whether the shipping address is editable or not.", + "type": "boolean", + "readOnly": true + }, + "reverseShippingDetailsUpdate": { + "description": "The Editable status for Reverse Shipping Address and Contact Info", + "enum": [ + "Enabled", + "Disabled", + "NotSupported" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ReverseShippingDetailsEditStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Enabled", + "description": "Reverse shipping details can be edited." + }, + { + "value": "Disabled", + "description": "Edit is disabled for Reverse shipping details." + }, + { + "value": "NotSupported", + "description": "Edit is not supported for Reverse shipping details. Either subscription feature is not available or SKU doesn't support this feature." + } + ] + } + }, + "reverseTransportPreferenceUpdate": { + "description": "The Editable status for Reverse Transport preferences", + "enum": [ + "Enabled", + "Disabled", + "NotSupported" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ReverseTransportPreferenceEditStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Enabled", + "description": "Reverse Transport Preferences can be edited." + }, + { + "value": "Disabled", + "description": "Edit is disabled for Reverse Transport Preferences." + }, + { + "value": "NotSupported", + "description": "Edit is not supported for Reverse Transport Preferences. Either subscription feature is not available or SKU doesn't support this feature." + } + ] + } + }, + "isPrepareToShipEnabled": { + "description": "Is Prepare To Ship Enabled on this job", + "type": "boolean", + "readOnly": true + }, + "status": { + "description": "Name of the stage which is in progress.", + "enum": [ + "DeviceOrdered", + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy", + "Completed", + "CompletedWithErrors", + "Cancelled", + "Failed_IssueReportedAtCustomer", + "Failed_IssueDetectedAtAzureDC", + "Aborted", + "CompletedWithWarnings", + "ReadyToDispatchFromAzureDC", + "ReadyToReceiveAtAzureDC", + "Created", + "ShippedToAzureDC", + "AwaitingShipmentDetails", + "PreparingToShipFromAzureDC", + "ShippedToCustomer" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageName", + "modelAsString": true, + "values": [ + { + "value": "DeviceOrdered", + "description": "An order has been created." + }, + { + "value": "DevicePrepared", + "description": "A device has been prepared for the order." + }, + { + "value": "Dispatched", + "description": "Device has been dispatched to the user of the order." + }, + { + "value": "Delivered", + "description": "Device has been delivered to the user of the order." + }, + { + "value": "PickedUp", + "description": "Device has been picked up from user and in transit to Azure datacenter." + }, + { + "value": "AtAzureDC", + "description": "Device has been received at Azure datacenter from the user." + }, + { + "value": "DataCopy", + "description": "Data copy from the device at Azure datacenter." + }, + { + "value": "Completed", + "description": "Order has completed." + }, + { + "value": "CompletedWithErrors", + "description": "Order has completed with errors." + }, + { + "value": "Cancelled", + "description": "Order has been cancelled." + }, + { + "value": "Failed_IssueReportedAtCustomer", + "description": "Order has failed due to issue reported by user." + }, + { + "value": "Failed_IssueDetectedAtAzureDC", + "description": "Order has failed due to issue detected at Azure datacenter." + }, + { + "value": "Aborted", + "description": "Order has been aborted." + }, + { + "value": "CompletedWithWarnings", + "description": "Order has completed with warnings." + }, + { + "value": "ReadyToDispatchFromAzureDC", + "description": "Device is ready to be handed to customer from Azure DC." + }, + { + "value": "ReadyToReceiveAtAzureDC", + "description": "Device can be dropped off at Azure DC." + }, + { + "value": "Created", + "description": "Job created by the customer." + }, + { + "value": "ShippedToAzureDC", + "description": "User shipped the device to AzureDC." + }, + { + "value": "AwaitingShipmentDetails", + "description": "Awaiting shipment details of device from customer." + }, + { + "value": "PreparingToShipFromAzureDC", + "description": "Preparing the device to ship to customer." + }, + { + "value": "ShippedToCustomer", + "description": "Shipped the device to customer." + } + ] + } + }, + "delayedStage": { + "description": "Name of the stage where delay might be present.", + "enum": [ + "DeviceOrdered", + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy", + "Completed", + "CompletedWithErrors", + "Cancelled", + "Failed_IssueReportedAtCustomer", + "Failed_IssueDetectedAtAzureDC", + "Aborted", + "CompletedWithWarnings", + "ReadyToDispatchFromAzureDC", + "ReadyToReceiveAtAzureDC", + "Created", + "ShippedToAzureDC", + "AwaitingShipmentDetails", + "PreparingToShipFromAzureDC", + "ShippedToCustomer" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageName", + "modelAsString": true, + "values": [ + { + "value": "DeviceOrdered", + "description": "An order has been created." + }, + { + "value": "DevicePrepared", + "description": "A device has been prepared for the order." + }, + { + "value": "Dispatched", + "description": "Device has been dispatched to the user of the order." + }, + { + "value": "Delivered", + "description": "Device has been delivered to the user of the order." + }, + { + "value": "PickedUp", + "description": "Device has been picked up from user and in transit to Azure datacenter." + }, + { + "value": "AtAzureDC", + "description": "Device has been received at Azure datacenter from the user." + }, + { + "value": "DataCopy", + "description": "Data copy from the device at Azure datacenter." + }, + { + "value": "Completed", + "description": "Order has completed." + }, + { + "value": "CompletedWithErrors", + "description": "Order has completed with errors." + }, + { + "value": "Cancelled", + "description": "Order has been cancelled." + }, + { + "value": "Failed_IssueReportedAtCustomer", + "description": "Order has failed due to issue reported by user." + }, + { + "value": "Failed_IssueDetectedAtAzureDC", + "description": "Order has failed due to issue detected at Azure datacenter." + }, + { + "value": "Aborted", + "description": "Order has been aborted." + }, + { + "value": "CompletedWithWarnings", + "description": "Order has completed with warnings." + }, + { + "value": "ReadyToDispatchFromAzureDC", + "description": "Device is ready to be handed to customer from Azure DC." + }, + { + "value": "ReadyToReceiveAtAzureDC", + "description": "Device can be dropped off at Azure DC." + }, + { + "value": "Created", + "description": "Job created by the customer." + }, + { + "value": "ShippedToAzureDC", + "description": "User shipped the device to AzureDC." + }, + { + "value": "AwaitingShipmentDetails", + "description": "Awaiting shipment details of device from customer." + }, + { + "value": "PreparingToShipFromAzureDC", + "description": "Preparing the device to ship to customer." + }, + { + "value": "ShippedToCustomer", + "description": "Shipped the device to customer." + } + ] + } + }, + "startTime": { + "format": "date-time", + "description": "Time at which the job was started in UTC ISO 8601 format.", + "type": "string", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/CloudError", + "description": "Top level error for the job.", + "readOnly": true + }, + "details": { + "$ref": "#/definitions/JobDetails", + "description": "Details of a job run. This field will only be sent for expand details filter." + }, + "cancellationReason": { + "description": "Reason for cancellation.", + "type": "string", + "readOnly": true + }, + "deliveryType": { + "description": "Delivery type of Job.", + "enum": [ + "NonScheduled", + "Scheduled" + ], + "type": "string", + "x-ms-enum": { + "name": "JobDeliveryType", + "modelAsExtensible": true, + "values": [ + { + "value": "NonScheduled", + "description": "Non Scheduled job." + }, + { + "value": "Scheduled", + "description": "Scheduled job." + } + ] + }, + "default": "NonScheduled" + }, + "deliveryInfo": { + "$ref": "#/definitions/JobDeliveryInfo", + "description": "Delivery Info of Job." + }, + "isCancellableWithoutFee": { + "description": "Flag to indicate cancellation of scheduled job.", + "type": "boolean", + "readOnly": true + }, + "allDevicesLost": { + "description": "Flag to indicate if all devices associated with the job are lost.", + "type": "boolean", + "readOnly": true + } + } + }, + "JobResource": { + "description": "Job Resource.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "Properties of a job.", + "x-ms-client-flatten": true + }, + "name": { + "description": "Name of the object.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the object.", + "type": "string", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + } + }, + "JobResourceList": { + "description": "Job Resource Collection", + "type": "object", + "properties": { + "value": { + "description": "List of job resources.", + "type": "array", + "items": { + "$ref": "#/definitions/JobResource" + } + }, + "nextLink": { + "description": "Link for the next set of job resources.", + "type": "string" + } + } + }, + "JobResourceUpdateParameter": { + "description": "The JobResourceUpdateParameter.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateJobProperties", + "description": "Properties of a job to be updated.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Msi identity of the resource" + } + } + }, + "JobSecrets": { + "description": "The base class for the secrets", + "required": [ + "jobSecretsType" + ], + "type": "object", + "properties": { + "jobSecretsType": { + "description": "Used to indicate what type of job secrets object.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsExtensible": false, + "values": [ + { + "value": "DataBox", + "description": "Data Box orders." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk orders." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy orders." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk orders." + } + ] + } + }, + "dcAccessSecurityCode": { + "$ref": "#/definitions/DcAccessSecurityCode", + "description": "Dc Access Security Code for Customer Managed Shipping", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/CloudError", + "description": "Error while fetching the secrets.", + "readOnly": true + } + }, + "discriminator": "jobSecretsType" + }, + "JobStages": { + "description": "Job stages.", + "type": "object", + "properties": { + "stageName": { + "description": "Name of the job stage.", + "enum": [ + "DeviceOrdered", + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy", + "Completed", + "CompletedWithErrors", + "Cancelled", + "Failed_IssueReportedAtCustomer", + "Failed_IssueDetectedAtAzureDC", + "Aborted", + "CompletedWithWarnings", + "ReadyToDispatchFromAzureDC", + "ReadyToReceiveAtAzureDC", + "Created", + "ShippedToAzureDC", + "AwaitingShipmentDetails", + "PreparingToShipFromAzureDC", + "ShippedToCustomer" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageName", + "modelAsString": true, + "values": [ + { + "value": "DeviceOrdered", + "description": "An order has been created." + }, + { + "value": "DevicePrepared", + "description": "A device has been prepared for the order." + }, + { + "value": "Dispatched", + "description": "Device has been dispatched to the user of the order." + }, + { + "value": "Delivered", + "description": "Device has been delivered to the user of the order." + }, + { + "value": "PickedUp", + "description": "Device has been picked up from user and in transit to Azure datacenter." + }, + { + "value": "AtAzureDC", + "description": "Device has been received at Azure datacenter from the user." + }, + { + "value": "DataCopy", + "description": "Data copy from the device at Azure datacenter." + }, + { + "value": "Completed", + "description": "Order has completed." + }, + { + "value": "CompletedWithErrors", + "description": "Order has completed with errors." + }, + { + "value": "Cancelled", + "description": "Order has been cancelled." + }, + { + "value": "Failed_IssueReportedAtCustomer", + "description": "Order has failed due to issue reported by user." + }, + { + "value": "Failed_IssueDetectedAtAzureDC", + "description": "Order has failed due to issue detected at Azure datacenter." + }, + { + "value": "Aborted", + "description": "Order has been aborted." + }, + { + "value": "CompletedWithWarnings", + "description": "Order has completed with warnings." + }, + { + "value": "ReadyToDispatchFromAzureDC", + "description": "Device is ready to be handed to customer from Azure DC." + }, + { + "value": "ReadyToReceiveAtAzureDC", + "description": "Device can be dropped off at Azure DC." + }, + { + "value": "Created", + "description": "Job created by the customer." + }, + { + "value": "ShippedToAzureDC", + "description": "User shipped the device to AzureDC." + }, + { + "value": "AwaitingShipmentDetails", + "description": "Awaiting shipment details of device from customer." + }, + { + "value": "PreparingToShipFromAzureDC", + "description": "Preparing the device to ship to customer." + }, + { + "value": "ShippedToCustomer", + "description": "Shipped the device to customer." + } + ] + } + }, + "displayName": { + "description": "Display name of the job stage.", + "type": "string", + "readOnly": true + }, + "stageStatus": { + "description": "Status of the job stage.", + "enum": [ + "None", + "InProgress", + "Succeeded", + "Failed", + "Cancelled", + "Cancelling", + "SucceededWithErrors", + "WaitingForCustomerAction", + "SucceededWithWarnings", + "WaitingForCustomerActionForKek", + "WaitingForCustomerActionForCleanUp", + "CustomerActionPerformedForCleanUp", + "CustomerActionPerformed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No status available yet." + }, + { + "value": "InProgress", + "description": "Stage is in progress." + }, + { + "value": "Succeeded", + "description": "Stage has succeeded." + }, + { + "value": "Failed", + "description": "Stage has failed." + }, + { + "value": "Cancelled", + "description": "Stage has been cancelled." + }, + { + "value": "Cancelling", + "description": "Stage is cancelling." + }, + { + "value": "SucceededWithErrors", + "description": "Stage has succeeded with errors." + }, + { + "value": "WaitingForCustomerAction", + "description": "Stage is stuck until customer takes some action." + }, + { + "value": "SucceededWithWarnings", + "description": "Stage has succeeded with warnings." + }, + { + "value": "WaitingForCustomerActionForKek", + "description": "Stage is waiting for customer action for kek action items." + }, + { + "value": "WaitingForCustomerActionForCleanUp", + "description": "Stage is waiting for customer action for clean up." + }, + { + "value": "CustomerActionPerformedForCleanUp", + "description": "Stage has performed customer action for clean up." + }, + { + "value": "CustomerActionPerformed", + "description": "Stage has performed customer action." + } + ] + } + }, + "stageTime": { + "format": "date-time", + "description": "Time for the job stage in UTC ISO 8601 format.", + "type": "string", + "readOnly": true + }, + "jobStageDetails": { + "description": "Job Stage Details", + "type": "object", + "readOnly": true + }, + "delayInformation": { + "description": "Delay information for the job stages.", + "type": "array", + "items": { + "$ref": "#/definitions/JobDelayDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "KeyEncryptionKey": { + "description": "Encryption key containing details about key to encrypt different keys.", + "required": [ + "kekType" + ], + "type": "object", + "properties": { + "kekType": { + "description": "Type of encryption key used for key encryption.", + "enum": [ + "MicrosoftManaged", + "CustomerManaged" + ], + "type": "string", + "x-ms-enum": { + "name": "KekType", + "modelAsExtensible": true, + "values": [ + { + "value": "MicrosoftManaged", + "description": "Key encryption key is managed by Microsoft." + }, + { + "value": "CustomerManaged", + "description": "Key encryption key is managed by the Customer." + } + ] + }, + "default": "MicrosoftManaged" + }, + "identityProperties": { + "$ref": "#/definitions/IdentityProperties", + "description": "Managed identity properties used for key encryption." + }, + "kekUrl": { + "description": "Key encryption key. It is required in case of Customer managed KekType.", + "type": "string" + }, + "kekVaultResourceID": { + "description": "Kek vault resource id. It is required in case of Customer managed KekType.", + "type": "string" + } + } + }, + "ManagedDiskDetails": { + "description": "Details of the managed disks.", + "required": [ + "resourceGroupId", + "stagingStorageAccountId", + "dataAccountType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataAccountDetails" + } + ], + "properties": { + "resourceGroupId": { + "description": "Resource Group Id of the compute disks.", + "type": "string" + }, + "stagingStorageAccountId": { + "description": "Resource Id of the storage account that can be used to copy the vhd for staging.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ManagedDisk" + }, + "MarkDevicesShippedRequest": { + "description": "The request body to provide the delivery package details of job", + "required": [ + "deliverToDcPackageDetails" + ], + "type": "object", + "properties": { + "deliverToDcPackageDetails": { + "$ref": "#/definitions/PackageCarrierInfo", + "description": "Delivery package details" + } + } + }, + "LastMitigationActionOnJob": { + "description": "Last Mitigation Action Performed On Job", + "type": "object", + "properties": { + "actionDateTimeInUtc": { + "format": "date-time", + "description": "Action performed date time", + "type": "string" + }, + "isPerformedByCustomer": { + "description": "Action performed by customer,\r\npossibility is that mitigation might happen by customer or service or by ops", + "type": "boolean" + }, + "customerResolution": { + "description": "Resolution code provided by customer", + "enum": [ + "None", + "MoveToCleanUpDevice", + "Resume", + "Restart", + "ReachOutToOperation" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomerResolutionCode", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No Resolution Yet" + }, + { + "value": "MoveToCleanUpDevice", + "description": "Clean the device" + }, + { + "value": "Resume", + "description": "Resume the job to same stage" + }, + { + "description": "Restart whole action.", + "value": "Restart" + }, + { + "description": "Reach out to operation for further action.", + "value": "ReachOutToOperation" + } + ] + } + } + } + }, + "MitigateJobRequest": { + "description": "The Mitigate Job captured from request body for Mitigate API", + "type": "object", + "properties": { + "customerResolutionCode": { + "description": "Resolution code for the job", + "enum": [ + "None", + "MoveToCleanUpDevice", + "Resume", + "Restart", + "ReachOutToOperation" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomerResolutionCode", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No Resolution Yet" + }, + { + "value": "MoveToCleanUpDevice", + "description": "Clean the device" + }, + { + "value": "Resume", + "description": "Resume the job to same stage" + }, + { + "description": "Restart whole action.", + "value": "Restart" + }, + { + "description": "Reach out to operation for further action.", + "value": "ReachOutToOperation" + } + ] + } + }, + "serialNumberCustomerResolutionMap": { + "description": "Serial number and the customer resolution code corresponding to each serial number", + "type": "object", + "additionalProperties": { + "format": "int32", + "description": "Available customer resolution codes on a job", + "enum": [ + "None", + "MoveToCleanUpDevice", + "Resume", + "Restart", + "ReachOutToOperation" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomerResolutionCode", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No Resolution Yet" + }, + { + "value": "MoveToCleanUpDevice", + "description": "Clean the device" + }, + { + "value": "Resume", + "description": "Resume the job" + }, + { + "value": "Restart", + "description": "Restart whole action" + }, + { + "value": "ReachOutToOperation", + "description": "Reach out to operation for further action" + } + ] + } + } + } + } + }, + "NotificationPreference": { + "description": "Notification preference for a job stage.", + "required": [ + "stageName", + "sendNotification" + ], + "type": "object", + "properties": { + "stageName": { + "description": "Name of the stage.", + "enum": [ + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy", + "Created", + "ShippedToCustomer" + ], + "type": "string", + "x-ms-enum": { + "name": "NotificationStageName", + "modelAsString": true, + "values": [ + { + "value": "DevicePrepared", + "description": "Notification at device prepared stage." + }, + { + "value": "Dispatched", + "description": "Notification at device dispatched stage." + }, + { + "value": "Delivered", + "description": "Notification at device delivered stage." + }, + { + "value": "PickedUp", + "description": "Notification at device picked up from user stage." + }, + { + "value": "AtAzureDC", + "description": "Notification at device received at Azure datacenter stage." + }, + { + "value": "DataCopy", + "description": "Notification at data copy started stage." + }, + { + "value": "Created", + "description": "Notification at job created stage." + }, + { + "value": "ShippedToCustomer", + "description": "Notification at shipped devices to customer stage." + } + ] + } + }, + "sendNotification": { + "description": "Notification is required or not.", + "type": "boolean", + "default": true + } + } + }, + "Operation": { + "description": "Operation entity.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation. Format: {resourceProviderNamespace}/{resourceType}/{read|write|delete|action}", + "type": "string", + "readOnly": true + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Operation display values.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Operation properties.", + "readOnly": true, + "x-ms-client-flatten": true + }, + "origin": { + "description": "Origin of the operation. Can be : user|system|user,system", + "type": "string", + "readOnly": true + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + } + }, + "OperationDisplay": { + "description": "Operation display", + "type": "object", + "properties": { + "provider": { + "description": "Provider name.", + "type": "string" + }, + "resource": { + "description": "Resource name.", + "type": "string" + }, + "operation": { + "description": "Localized name of the operation for display purpose.", + "type": "string" + }, + "description": { + "description": "Localized description of the operation for display purpose.", + "type": "string" + } + } + }, + "OperationList": { + "description": "Operation Collection.", + "type": "object", + "properties": { + "value": { + "description": "List of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link for the next set of operations.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Operation properties.", + "type": "object", + "properties": {} + }, + "PackageCarrierDetails": { + "description": "Package carrier details.", + "type": "object", + "properties": { + "carrierAccountNumber": { + "description": "Carrier Account Number of customer for customer disk.", + "type": "string", + "x-ms-secret": true + }, + "carrierName": { + "description": "Name of the carrier.", + "type": "string" + }, + "trackingId": { + "description": "Tracking Id of shipment.", + "type": "string" + } + } + }, + "PackageCarrierInfo": { + "description": "package carrier info", + "type": "object", + "properties": { + "carrierName": { + "description": "Name of the carrier.", + "type": "string" + }, + "trackingId": { + "description": "Tracking Id of shipment.", + "type": "string" + } + } + }, + "PackageShippingDetails": { + "description": "package shipping details", + "type": "object", + "properties": { + "trackingUrl": { + "description": "Url where shipment can be tracked.", + "type": "string", + "readOnly": true + }, + "carrierName": { + "description": "Name of the carrier.", + "type": "string", + "readOnly": true + }, + "trackingId": { + "description": "Tracking Id of shipment.", + "type": "string", + "readOnly": true + } + } + }, + "Preferences": { + "description": "Preferences related to the order", + "type": "object", + "properties": { + "preferredDataCenterRegion": { + "description": "Preferred data center region.", + "type": "array", + "items": { + "type": "string" + } + }, + "transportPreferences": { + "$ref": "#/definitions/TransportPreferences", + "description": "Preferences related to the shipment logistics of the sku." + }, + "reverseTransportPreferences": { + "$ref": "#/definitions/TransportPreferences", + "description": "Optional Preferences related to the reverse shipment logistics of the sku." + }, + "encryptionPreferences": { + "$ref": "#/definitions/EncryptionPreferences", + "description": "Preferences related to the Encryption." + }, + "storageAccountAccessTierPreferences": { + "description": "Preferences related to the Access Tier of storage accounts.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "Archive" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageAccountAccessTier", + "modelAsExtensible": true, + "values": [ + { + "value": "Archive", + "description": "Archive Access Tier shares requested by the customer." + } + ] + } + } + } + } + }, + "PreferencesValidationRequest": { + "description": "Request to validate preference of transport and data center.", + "required": [ + "deviceType", + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputRequest" + } + ], + "properties": { + "preference": { + "description": "Preference of transport and data center.", + "$ref": "#/definitions/Preferences" + }, + "deviceType": { + "description": "Device type to be used for the job.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk." + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidatePreferences" + }, + "PreferencesValidationResponseProperties": { + "description": "Properties of data center and transport preference validation response.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputResponse" + } + ], + "properties": { + "status": { + "description": "Validation status of requested data center and transport.", + "enum": [ + "Valid", + "Invalid", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Valid", + "description": "Validation is successful" + }, + { + "value": "Invalid", + "description": "Validation is not successful" + }, + { + "value": "Skipped", + "description": "Validation is skipped" + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidatePreferences" + }, + "RegionConfigurationRequest": { + "description": "Request body to get the configuration for the region.", + "type": "object", + "properties": { + "scheduleAvailabilityRequest": { + "$ref": "#/definitions/ScheduleAvailabilityRequest", + "description": "Request body to get the availability for scheduling orders." + }, + "transportAvailabilityRequest": { + "$ref": "#/definitions/TransportAvailabilityRequest", + "description": "Request body to get the transport availability for given sku." + }, + "datacenterAddressRequest": { + "$ref": "#/definitions/DatacenterAddressRequest", + "description": "Request body to get the datacenter address for given sku." + }, + "deviceCapabilityRequest": { + "$ref": "#/definitions/DeviceCapabilityRequest", + "description": "Request body to get the device capabilities for a given sku." + } + } + }, + "RegionConfigurationResponse": { + "description": "Configuration response specific to a region.", + "type": "object", + "properties": { + "scheduleAvailabilityResponse": { + "$ref": "#/definitions/ScheduleAvailabilityResponse", + "description": "Schedule availability for given sku in a region.", + "readOnly": true + }, + "transportAvailabilityResponse": { + "$ref": "#/definitions/TransportAvailabilityResponse", + "description": "Transport options available for given sku in a region.", + "readOnly": true + }, + "datacenterAddressResponse": { + "$ref": "#/definitions/DatacenterAddressResponse", + "description": "Datacenter address for given sku in a region.", + "readOnly": true + }, + "deviceCapabilityResponse": { + "$ref": "#/definitions/DeviceCapabilityResponse", + "description": "Device capabilities available for a given sku in a region.", + "readOnly": true + } + } + }, + "Resource": { + "description": "Model of the Resource.", + "required": [ + "location", + "sku" + ], + "type": "object", + "properties": { + "location": { + "description": "The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku type." + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Msi identity of the resource" + } + }, + "x-ms-azure-resource": true + }, + "ResourceIdentity": { + "description": "Msi identity details of the resource", + "type": "object", + "properties": { + "type": { + "description": "Identity type", + "type": "string", + "default": "None" + }, + "principalId": { + "description": "Service Principal Id backing the Msi", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Home Tenant Id", + "type": "string", + "readOnly": true + }, + "userAssignedIdentities": { + "description": "User Assigned Identities", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + } + } + }, + "ReverseShippingDetails": { + "description": "Reverse Shipping Address and contact details for a job.", + "type": "object", + "properties": { + "contactDetails": { + "$ref": "#/definitions/ContactInfo" + }, + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress" + }, + "isUpdated": { + "description": "A flag to indicate whether Reverse Shipping details are updated or not after device has been prepared.\r\nRead only field", + "type": "boolean", + "readOnly": true + } + } + }, + "ScheduleAvailabilityRequest": { + "description": "Request body to get the availability for scheduling orders.", + "required": [ + "storageLocation", + "skuName" + ], + "type": "object", + "properties": { + "storageLocation": { + "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", + "type": "string" + }, + "skuName": { + "description": "Sku Name for which the order is to be scheduled.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk." + } + ] + } + }, + "country": { + "description": "Country in which storage location should be supported.", + "type": "string" + } + }, + "discriminator": "skuName" + }, + "ScheduleAvailabilityResponse": { + "description": "Schedule availability for given sku in a region.", + "type": "object", + "properties": { + "availableDates": { + "description": "List of dates available to schedule", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + }, + "readOnly": true + } + } + }, + "ShareCredentialDetails": { + "description": "Credential details of the shares in account.", + "type": "object", + "properties": { + "shareName": { + "description": "Name of the share.", + "type": "string", + "readOnly": true + }, + "shareType": { + "description": "Type of the share.", + "enum": [ + "UnknownType", + "HCS", + "BlockBlob", + "PageBlob", + "AzureFile", + "ManagedDisk" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ShareDestinationFormatType", + "modelAsExtensible": true, + "values": [ + { + "value": "UnknownType", + "description": "Unknown format." + }, + { + "value": "HCS", + "description": "Storsimple data format." + }, + { + "value": "BlockBlob", + "description": "Azure storage block blob format." + }, + { + "value": "PageBlob", + "description": "Azure storage page blob format." + }, + { + "value": "AzureFile", + "description": "Azure storage file format." + }, + { + "value": "ManagedDisk", + "description": "Azure Compute Disk." + } + ] + } + }, + "userName": { + "description": "User name for the share.", + "type": "string", + "readOnly": true + }, + "password": { + "description": "Password for the share.", + "type": "string", + "readOnly": true + }, + "supportedAccessProtocols": { + "description": "Access protocols supported on the device.", + "type": "array", + "items": { + "enum": [ + "SMB", + "NFS" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessProtocol", + "modelAsExtensible": true, + "values": [ + { + "value": "SMB", + "description": "Server Message Block protocol(SMB)." + }, + { + "value": "NFS", + "description": "Network File System protocol(NFS)." + } + ] + } + }, + "readOnly": true + } + } + }, + "ShipmentPickUpRequest": { + "description": "Shipment pick up request details.", + "required": [ + "startTime", + "endTime", + "shipmentLocation" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Minimum date after which the pick up should commence, this must be in local time of pick up area.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "Maximum date before which the pick up should commence, this must be in local time of pick up area.", + "type": "string" + }, + "shipmentLocation": { + "description": "Shipment Location in the pickup place. Eg.front desk", + "type": "string" + } + } + }, + "ShipmentPickUpResponse": { + "description": "Shipment pick up response.", + "type": "object", + "properties": { + "confirmationNumber": { + "description": "Confirmation number for the pick up request.", + "type": "string", + "readOnly": true + }, + "readyByTime": { + "format": "date-time", + "description": "Time by which shipment should be ready for pick up, this is in local time of pick up area.", + "type": "string", + "readOnly": true + } + } + }, + "ShippingAddress": { + "description": "Shipping address where customer wishes to receive the device.", + "required": [ + "streetAddress1", + "country" + ], + "type": "object", + "properties": { + "streetAddress1": { + "description": "Street Address line 1.", + "type": "string" + }, + "streetAddress2": { + "description": "Street Address line 2.", + "type": "string" + }, + "streetAddress3": { + "description": "Street Address line 3.", + "type": "string" + }, + "city": { + "description": "Name of the City.", + "type": "string" + }, + "stateOrProvince": { + "description": "Name of the State or Province.", + "type": "string" + }, + "country": { + "description": "Name of the Country.", + "type": "string" + }, + "postalCode": { + "description": "Postal code.", + "type": "string" + }, + "zipExtendedCode": { + "description": "Extended Zip Code.", + "type": "string" + }, + "companyName": { + "description": "Name of the company.", + "type": "string" + }, + "addressType": { + "description": "Type of address.", + "enum": [ + "None", + "Residential", + "Commercial" + ], + "type": "string", + "x-ms-enum": { + "name": "AddressType", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "Address type not known." + }, + { + "value": "Residential", + "description": "Residential Address." + }, + { + "value": "Commercial", + "description": "Commercial Address." + } + ] + }, + "default": "None" + }, + "skipAddressValidation": { + "type": "boolean", + "description": "Flag to indicate if customer has chosen to skip default address validation" + }, + "taxIdentificationNumber": { + "type": "string", + "description": "Tax Identification Number" + } + } + }, + "Sku": { + "description": "The Sku.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The sku name.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk." + } + ] + } + }, + "displayName": { + "description": "The display name of the sku.", + "type": "string" + }, + "family": { + "description": "The sku family.", + "type": "string" + } + } + }, + "SkuAvailabilityValidationRequest": { + "description": "Request to validate sku availability.", + "required": [ + "deviceType", + "transferType", + "country", + "location", + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputRequest" + } + ], + "properties": { + "deviceType": { + "description": "Device type to be used for the job.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk." + } + ] + } + }, + "transferType": { + "description": "Type of the transfer.", + "enum": [ + "ImportToAzure", + "ExportFromAzure" + ], + "type": "string", + "x-ms-enum": { + "name": "TransferType", + "modelAsExtensible": true, + "values": [ + { + "value": "ImportToAzure", + "description": "Import data to azure." + }, + { + "value": "ExportFromAzure", + "description": "Export data from azure." + } + ] + } + }, + "country": { + "description": "ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements", + "type": "string" + }, + "location": { + "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", + "type": "string" + } + }, + "x-ms-discriminator-value": "ValidateSkuAvailability" + }, + "SkuAvailabilityValidationResponseProperties": { + "description": "Properties of sku availability validation response.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputResponse" + } + ], + "properties": { + "status": { + "description": "Sku availability validation status.", + "enum": [ + "Valid", + "Invalid", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Valid", + "description": "Validation is successful" + }, + { + "value": "Invalid", + "description": "Validation is not successful" + }, + { + "value": "Skipped", + "description": "Validation is skipped" + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidateSkuAvailability" + }, + "SkuCapacity": { + "description": "Capacity of the sku.", + "type": "object", + "properties": { + "usable": { + "description": "Usable capacity in TB.", + "type": "string", + "readOnly": true + }, + "maximum": { + "description": "Maximum capacity in TB.", + "type": "string", + "readOnly": true + } + } + }, + "SkuCost": { + "description": "Describes metadata for retrieving price info.", + "type": "object", + "properties": { + "meterId": { + "description": "Meter id of the Sku.", + "type": "string", + "readOnly": true + }, + "meterType": { + "description": "The type of the meter.", + "type": "string", + "readOnly": true + }, + "multiplier": { + "format": "double", + "description": "Multiplier specifies the region specific value to be multiplied with 1$ guid. Eg: Our new regions will be using 1$ shipping guid with appropriate multiplier specific to region.", + "type": "number", + "readOnly": true + } + } + }, + "SkuInformation": { + "description": "Information of the sku.", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The Sku.", + "readOnly": true + }, + "enabled": { + "description": "The sku is enabled or not.", + "type": "boolean", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SkuProperties", + "description": "Properties of the sku.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "SkuProperties": { + "description": "Properties of the sku.", + "type": "object", + "properties": { + "dataLocationToServiceLocationMap": { + "description": "The map of data location to service location.", + "type": "array", + "items": { + "$ref": "#/definitions/DataLocationToServiceLocationMap" + }, + "readOnly": true + }, + "capacity": { + "$ref": "#/definitions/SkuCapacity", + "description": "Capacity of the Sku.", + "readOnly": true + }, + "costs": { + "description": "Cost of the Sku.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuCost" + }, + "readOnly": true + }, + "apiVersions": { + "description": "Api versions that support this Sku.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "disabledReason": { + "description": "Reason why the Sku is disabled.", + "enum": [ + "None", + "Country", + "Region", + "Feature", + "OfferType", + "NoSubscriptionInfo" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuDisabledReason", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "SKU is not disabled." + }, + { + "value": "Country", + "description": "SKU is not available in the requested country." + }, + { + "value": "Region", + "description": "SKU is not available to push data to the requested Azure region." + }, + { + "value": "Feature", + "description": "Required features are not enabled for the SKU." + }, + { + "value": "OfferType", + "description": "Subscription does not have required offer types for the SKU." + }, + { + "value": "NoSubscriptionInfo", + "description": "Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification." + } + ] + } + }, + "disabledReasonMessage": { + "description": "Message for why the Sku is disabled.", + "type": "string", + "readOnly": true + }, + "requiredFeature": { + "description": "Required feature to access the sku.", + "type": "string", + "readOnly": true + }, + "countriesWithinCommerceBoundary": { + "description": "List of all the Countries in the SKU specific commerce boundary", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "StorageAccountDetails": { + "description": "Details for the storage account.", + "required": [ + "storageAccountId", + "dataAccountType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataAccountDetails" + } + ], + "properties": { + "storageAccountId": { + "description": "Storage Account Resource Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "StorageAccount" + }, + "SubscriptionIsAllowedToCreateJobValidationRequest": { + "description": "Request to validate subscription permission to create jobs.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputRequest" + } + ], + "properties": {}, + "x-ms-discriminator-value": "ValidateSubscriptionIsAllowedToCreateJob" + }, + "SubscriptionIsAllowedToCreateJobValidationResponseProperties": { + "description": "Properties of subscription permission to create job validation response.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputResponse" + } + ], + "properties": { + "status": { + "description": "Validation status of subscription permission to create job.", + "enum": [ + "Valid", + "Invalid", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Valid", + "description": "Validation is successful" + }, + { + "value": "Invalid", + "description": "Validation is not successful" + }, + { + "value": "Skipped", + "description": "Validation is skipped" + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidateSubscriptionIsAllowedToCreateJob" + }, + "systemData": { + "description": "Provides details about resource creation and update time", + "type": "object", + "properties": { + "createdBy": { + "description": "A string identifier for the identity that created the resource", + "type": "string", + "readOnly": true + }, + "createdByType": { + "description": "The type of identity that created the resource: user, application, managedIdentity", + "type": "string", + "readOnly": true + }, + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC)", + "type": "string", + "readOnly": true + }, + "lastModifiedBy": { + "description": "A string identifier for the identity that last modified the resource", + "type": "string", + "readOnly": true + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource: user, application, managedIdentity", + "type": "string", + "readOnly": true + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)", + "type": "string", + "readOnly": true + } + } + }, + "TransferAllDetails": { + "description": "Details to transfer all data.", + "required": [ + "dataAccountType" + ], + "type": "object", + "properties": { + "dataAccountType": { + "description": "Type of the account of data", + "enum": [ + "StorageAccount", + "ManagedDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "DataAccountType", + "modelAsExtensible": true, + "values": [ + { + "value": "StorageAccount", + "description": "Storage Accounts ." + }, + { + "value": "ManagedDisk", + "description": "Azure Managed disk storage." + } + ] + }, + "default": "StorageAccount" + }, + "transferAllBlobs": { + "description": "To indicate if all Azure blobs have to be transferred", + "type": "boolean" + }, + "transferAllFiles": { + "description": "To indicate if all Azure Files have to be transferred", + "type": "boolean" + } + } + }, + "TransferConfiguration": { + "description": "Configuration for defining the transfer of data.", + "required": [ + "transferConfigurationType" + ], + "type": "object", + "properties": { + "transferConfigurationType": { + "description": "Type of the configuration for transfer.", + "enum": [ + "TransferAll", + "TransferUsingFilter" + ], + "type": "string", + "x-ms-enum": { + "name": "TransferConfigurationType", + "modelAsExtensible": true, + "values": [ + { + "value": "TransferAll", + "description": "Transfer all the data." + }, + { + "value": "TransferUsingFilter", + "description": "Transfer using filter." + } + ] + } + }, + "transferFilterDetails": { + "description": "Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter.", + "type": "object", + "properties": { + "include": { + "description": "Details of the filtering the transfer of data.", + "$ref": "#/definitions/TransferFilterDetails" + } + } + }, + "transferAllDetails": { + "description": "Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll", + "type": "object", + "properties": { + "include": { + "description": "Details to transfer all data.", + "$ref": "#/definitions/TransferAllDetails" + } + } + } + } + }, + "TransferFilterDetails": { + "description": "Details of the filtering the transfer of data.", + "required": [ + "dataAccountType" + ], + "type": "object", + "properties": { + "dataAccountType": { + "description": "Type of the account of data.", + "enum": [ + "StorageAccount", + "ManagedDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "DataAccountType", + "modelAsExtensible": true, + "values": [ + { + "value": "StorageAccount", + "description": "Storage Accounts ." + }, + { + "value": "ManagedDisk", + "description": "Azure Managed disk storage." + } + ] + }, + "default": "StorageAccount" + }, + "blobFilterDetails": { + "$ref": "#/definitions/BlobFilterDetails", + "description": "Filter details to transfer blobs." + }, + "azureFileFilterDetails": { + "$ref": "#/definitions/AzureFileFilterDetails", + "description": "Filter details to transfer Azure files." + }, + "filterFileDetails": { + "description": "Details of the filter files to be used for data transfer.", + "type": "array", + "items": { + "$ref": "#/definitions/FilterFileDetails" + } + } + } + }, + "TransportAvailabilityDetails": { + "description": "Transport options availability details for given region.", + "type": "object", + "properties": { + "shipmentType": { + "description": "Transport Shipment Type supported for given region.", + "enum": [ + "CustomerManaged", + "MicrosoftManaged" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TransportShipmentTypes", + "modelAsExtensible": true, + "values": [ + { + "value": "CustomerManaged", + "description": "Shipment Logistics is handled by the customer." + }, + { + "value": "MicrosoftManaged", + "description": "Shipment Logistics is handled by Microsoft." + } + ] + } + } + } + }, + "TransportAvailabilityRequest": { + "description": "Request body to get the transport availability for given sku.", + "type": "object", + "properties": { + "skuName": { + "description": "Type of the device.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk." + } + ] + } + } + } + }, + "TransportAvailabilityResponse": { + "description": "Transport options available for given sku in a region.", + "type": "object", + "properties": { + "transportAvailabilityDetails": { + "description": "List of transport availability details for given region", + "type": "array", + "items": { + "$ref": "#/definitions/TransportAvailabilityDetails" + }, + "readOnly": true + } + } + }, + "TransportPreferences": { + "description": "Preferences related to the shipment logistics of the sku", + "required": [ + "preferredShipmentType" + ], + "type": "object", + "properties": { + "preferredShipmentType": { + "description": "Indicates Shipment Logistics type that the customer preferred.", + "enum": [ + "CustomerManaged", + "MicrosoftManaged" + ], + "type": "string", + "x-ms-enum": { + "name": "TransportShipmentTypes", + "modelAsExtensible": true, + "values": [ + { + "value": "CustomerManaged", + "description": "Shipment Logistics is handled by the customer." + }, + { + "value": "MicrosoftManaged", + "description": "Shipment Logistics is handled by Microsoft." + } + ] + } + }, + "isUpdated": { + "description": "Read only property which indicates whether transport preferences has been updated or not after device is prepared.", + "type": "boolean", + "readOnly": true + } + } + }, + "UnencryptedCredentials": { + "description": "Unencrypted credentials for accessing device.", + "type": "object", + "properties": { + "jobName": { + "description": "Name of the job.", + "type": "string", + "readOnly": true + }, + "jobSecrets": { + "$ref": "#/definitions/JobSecrets", + "description": "Secrets related to this job.", + "readOnly": true + } + } + }, + "UnencryptedCredentialsList": { + "description": "List of unencrypted credentials for accessing device.", + "type": "object", + "properties": { + "value": { + "description": "List of unencrypted credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/UnencryptedCredentials" + } + }, + "nextLink": { + "description": "Link for the next set of unencrypted credentials.", + "type": "string" + } + } + }, + "UpdateJobDetails": { + "description": "Job details for update.", + "type": "object", + "properties": { + "contactDetails": { + "$ref": "#/definitions/ContactDetails", + "description": "Contact details for notification and shipping." + }, + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping address of the customer." + }, + "reverseShippingDetails": { + "$ref": "#/definitions/ReverseShippingDetails" + }, + "preferences": { + "$ref": "#/definitions/Preferences" + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyEncryptionKey", + "description": "Key encryption key for the job." + }, + "returnToCustomerPackageDetails": { + "$ref": "#/definitions/PackageCarrierDetails", + "description": "Return package details of job." + } + } + }, + "UpdateJobProperties": { + "description": "Job Properties for update", + "type": "object", + "properties": { + "details": { + "$ref": "#/definitions/UpdateJobDetails", + "description": "Details of a job to be updated." + } + } + }, + "UserAssignedIdentity": { + "description": "Class defining User assigned identity details.", + "type": "object", + "properties": { + "principalId": { + "description": "The principal id of user assigned identity.", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client id of user assigned identity.", + "type": "string", + "readOnly": true + } + } + }, + "UserAssignedProperties": { + "description": "User assigned identity properties.", + "type": "object", + "properties": { + "resourceId": { + "description": "Arm resource id for user assigned identity to be used to fetch MSI token.", + "type": "string" + } + } + }, + "ValidateAddress": { + "description": "The requirements to validate customer address where the device needs to be shipped.", + "required": [ + "shippingAddress", + "deviceType", + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputRequest" + } + ], + "properties": { + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping address of the customer." + }, + "deviceType": { + "description": "Device type to be used for the job.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk." + } + ] + } + }, + "transportPreferences": { + "$ref": "#/definitions/TransportPreferences", + "description": "Preferences related to the shipment logistics of the sku." + } + }, + "x-ms-discriminator-value": "ValidateAddress" + }, + "ValidationInputRequest": { + "description": "Minimum fields that must be present in any type of validation request.", + "required": [ + "validationType" + ], + "type": "object", + "properties": { + "validationType": { + "description": "Identifies the type of validation request.", + "enum": [ + "ValidateAddress", + "ValidateSubscriptionIsAllowedToCreateJob", + "ValidatePreferences", + "ValidateCreateOrderLimit", + "ValidateSkuAvailability", + "ValidateDataTransferDetails" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationInputDiscriminator", + "modelAsExtensible": true, + "values": [ + { + "value": "ValidateAddress", + "description": "Identify request and response of address validation." + }, + { + "value": "ValidateSubscriptionIsAllowedToCreateJob", + "description": "Identify request and response for validation of subscription permission to create job." + }, + { + "value": "ValidatePreferences", + "description": "Identify request and response of preference validation." + }, + { + "value": "ValidateCreateOrderLimit", + "description": "Identify request and response of create order limit for subscription validation." + }, + { + "value": "ValidateSkuAvailability", + "description": "Identify request and response of active job limit for sku availability." + }, + { + "value": "ValidateDataTransferDetails", + "description": "Identify request and response of data transfer details validation." + } + ] + } + } + }, + "discriminator": "validationType" + }, + "ValidationInputResponse": { + "description": "Minimum properties that should be present in each individual validation response.", + "required": [ + "validationType" + ], + "type": "object", + "properties": { + "validationType": { + "description": "Identifies the type of validation response.", + "enum": [ + "ValidateAddress", + "ValidateSubscriptionIsAllowedToCreateJob", + "ValidatePreferences", + "ValidateCreateOrderLimit", + "ValidateSkuAvailability", + "ValidateDataTransferDetails" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationInputDiscriminator", + "modelAsExtensible": true, + "values": [ + { + "value": "ValidateAddress", + "description": "Identify request and response of address validation." + }, + { + "value": "ValidateSubscriptionIsAllowedToCreateJob", + "description": "Identify request and response for validation of subscription permission to create job." + }, + { + "value": "ValidatePreferences", + "description": "Identify request and response of preference validation." + }, + { + "value": "ValidateCreateOrderLimit", + "description": "Identify request and response of create order limit for subscription validation." + }, + { + "value": "ValidateSkuAvailability", + "description": "Identify request and response of active job limit for sku availability." + }, + { + "value": "ValidateDataTransferDetails", + "description": "Identify request and response of data transfer details validation." + } + ] + } + }, + "error": { + "$ref": "#/definitions/CloudError", + "description": "Error code and message of validation response.", + "readOnly": true + } + }, + "discriminator": "validationType" + }, + "ValidationRequest": { + "description": "Minimum request requirement of any validation category.", + "required": [ + "validationCategory", + "individualRequestDetails" + ], + "type": "object", + "properties": { + "validationCategory": { + "description": "Identify the nature of validation.", + "enum": [ + "JobCreationValidation" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationCategory", + "modelAsExtensible": true, + "values": [ + { + "value": "JobCreationValidation", + "description": "Identify request of pre-job creation validations." + } + ] + } + }, + "individualRequestDetails": { + "description": "List of request details contain validationType and its request as key and value respectively.", + "type": "array", + "items": { + "$ref": "#/definitions/ValidationInputRequest" + } + } + }, + "discriminator": "validationCategory" + }, + "ValidationResponse": { + "description": "Response of pre job creation validations.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ValidationResponseProperties", + "description": "Properties of pre job creation validation response.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ValidationResponseProperties": { + "description": "Properties of pre job creation validation response.", + "type": "object", + "properties": { + "status": { + "description": "Overall validation status.", + "enum": [ + "AllValidToProceed", + "InputsRevisitRequired", + "CertainInputValidationsSkipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OverallValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "AllValidToProceed", + "description": "Every input request is valid." + }, + { + "value": "InputsRevisitRequired", + "description": "Some input requests are not valid." + }, + { + "value": "CertainInputValidationsSkipped", + "description": "Certain input validations skipped." + } + ] + } + }, + "individualResponseDetails": { + "description": "List of response details contain validationType and its response as key and value respectively.", + "type": "array", + "items": { + "$ref": "#/definitions/ValidationInputResponse" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API Version", + "required": true, + "type": "string" + }, + "jobNameParameter": { + "name": "jobName", + "in": "path", + "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only", + "required": true, + "type": "string", + "maxLength": 24, + "minLength": 3, + "pattern": "^[-\\w\\.]+$", + "x-ms-parameter-location": "method" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "The location of the resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The Resource Group Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Subscription Id", + "required": true, + "type": "string" + } + }, + "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/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/AvailableSkusPost.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/AvailableSkusPost.json new file mode 100644 index 000000000000..ad383d82ecf0 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/AvailableSkusPost.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "location": "westus", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "84" + ], + "availableSkuRequest": { + "transferType": "ImportToAzure", + "country": "XX", + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "DataBox" + }, + "enabled": true, + "properties": { + "dataLocationToServiceLocationMap": [ + { + "dataLocation": "westus", + "serviceLocation": "westus" + }, + { + "dataLocation": "centralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "eastus", + "serviceLocation": "westus" + }, + { + "dataLocation": "eastus2", + "serviceLocation": "westus" + }, + { + "dataLocation": "northcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "southcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "westcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "westus2", + "serviceLocation": "westus" + }, + { + "dataLocation": "centraluseuap", + "serviceLocation": "centraluseuap" + }, + { + "dataLocation": "eastus2euap", + "serviceLocation": "eastus2euap" + } + ], + "capacity": { + "usable": "80", + "maximum": "100" + }, + "costs": [ + { + "meterId": "0cf23ffc-0b64-49e6-9bdd-1db885349042", + "meterType": "DataBoxServiceFee", + "multiplier": 1 + }, + { + "meterId": "a701f058-119b-4713-a923-bed7da4b7801", + "meterType": "DataBoxShippingFee", + "multiplier": 1 + }, + { + "meterId": "049fa331-0a48-4a81-9991-a6bef3c79fed", + "meterType": "DataBoxExtraDayFee", + "multiplier": 1 + }, + { + "meterId": "c3ea978d-6a0a-4632-b094-4fffcafcb057", + "meterType": "DataBoxLostOrDamagedDeviceFee", + "multiplier": 1 + } + ], + "apiVersions": [ + "2018-01-01" + ], + "disabledReason": "None", + "countriesWithinCommerceBoundary": [ + "XX" + ] + } + }, + { + "sku": { + "name": "DataBoxDisk" + }, + "enabled": true, + "properties": { + "dataLocationToServiceLocationMap": [ + { + "dataLocation": "westus", + "serviceLocation": "westus" + }, + { + "dataLocation": "centralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "eastus", + "serviceLocation": "westus" + }, + { + "dataLocation": "eastus2", + "serviceLocation": "westus" + }, + { + "dataLocation": "northcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "southcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "westcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "westus2", + "serviceLocation": "westus" + }, + { + "dataLocation": "centraluseuap", + "serviceLocation": "centraluseuap" + }, + { + "dataLocation": "eastus2euap", + "serviceLocation": "eastus2euap" + } + ], + "capacity": { + "usable": "35", + "maximum": "40" + }, + "costs": [ + { + "meterId": "d95cd8b5-b6f1-4cd9-ae86-a016d1945d6f", + "meterType": "DataBoxDiskServiceFee", + "multiplier": 1 + }, + { + "meterId": "4b8cf572-cb04-4ef3-9528-2cda4e9b544e", + "meterType": "DataBoxDiskShippingFee", + "multiplier": 1 + }, + { + "meterId": "b6ae9bbf-815d-49dd-bb2b-77c497b72ba4", + "meterType": "DataBoxDiskDailyUsageFee", + "multiplier": 1 + }, + { + "meterId": "08bc0ea1-6c82-421b-b953-2a7a65810d2e", + "meterType": "DataBoxDiskLostDeviceFee", + "multiplier": 1 + } + ], + "apiVersions": [ + "2018-01-01" + ], + "disabledReason": "None", + "countriesWithinCommerceBoundary": [ + "XX" + ] + } + }, + { + "sku": { + "name": "DataBoxHeavy" + }, + "enabled": true, + "properties": { + "dataLocationToServiceLocationMap": [ + { + "dataLocation": "westus", + "serviceLocation": "westus" + }, + { + "dataLocation": "centralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "eastus", + "serviceLocation": "westus" + }, + { + "dataLocation": "eastus2", + "serviceLocation": "westus" + }, + { + "dataLocation": "northcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "southcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "westcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "westus2", + "serviceLocation": "westus" + }, + { + "dataLocation": "centraluseuap", + "serviceLocation": "centraluseuap" + }, + { + "dataLocation": "eastus2euap", + "serviceLocation": "eastus2euap" + } + ], + "capacity": { + "usable": "800", + "maximum": "1000" + }, + "costs": [ + { + "meterId": "d0dccaaf-3de9-4c7a-ba97-f83551b90126", + "meterType": "DataBoxHeavyServiceFee", + "multiplier": 1 + }, + { + "meterId": "7b49d11f-d4f7-4029-a197-04998fd282f9", + "meterType": "DataBoxHeavyShippingFee", + "multiplier": 1 + }, + { + "meterId": "c2c66d53-11b4-4f11-9642-43c7c336f0b7", + "meterType": "DataBoxHeavyExtraDayFee", + "multiplier": 1 + }, + { + "meterId": "188dcd7e-fbd7-4a41-aa42-162b81b0510f", + "meterType": "DataBoxHeavyLostOrDamagedDeviceFee", + "multiplier": 1 + } + ], + "apiVersions": [ + "2018-01-01" + ], + "disabledReason": "None", + "requiredFeature": "HeavyCreateAccess", + "countriesWithinCommerceBoundary": [ + "XX" + ] + } + } + ] + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/BookShipmentPickupPost.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/BookShipmentPickupPost.json new file mode 100644 index 000000000000..bd6c689855a0 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/BookShipmentPickupPost.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "118" + ], + "shipmentPickUpRequest": { + "startTime": "2019-09-20T18:30:00Z", + "endTime": "2019-09-22T18:30:00Z", + "shipmentLocation": "Front desk" + } + }, + "responses": { + "200": { + "body": { + "confirmationNumber": "XXXXXXXXXXX", + "readyByTime": "2019-09-20T18:30:00Z" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobMitigate.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobMitigate.json new file mode 100644 index 000000000000..48c2f276a406 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobMitigate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "$expand": "details", + "accept-language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "60" + ], + "mitigateJobRequest": { + "serialNumberCustomerResolutionMap": { + "testDISK-1": "MoveToCleanUpDevice", + "testDISK-2": "Resume" + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCancelPost.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCancelPost.json new file mode 100644 index 000000000000..c0add2ef86cc --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCancelPost.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "$expand": "details", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "30" + ], + "cancellationReason": { + "reason": "CancelTest" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreate.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreate.json new file mode 100644 index 000000000000..02e2ca9e2da7 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreate.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1064" + ], + "jobResource": { + "properties": { + "transferType": "ImportToAzure", + "details": { + "jobDetailsType": "DataBox", + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "dataImportDetails": [ + { + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/YourSubscriptionId/resourcegroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName" + } + } + ] + } + }, + "location": "westus", + "sku": { + "name": "DataBox" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://xxx.xxx.xx" + } + }, + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2019-09-21T14:49:49.0027611+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2019-09-21T14:49:52.3995743+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "jobDetailsType": "DataBox", + "copyLogDetails": [] + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateDevicePassword.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateDevicePassword.json new file mode 100644 index 000000000000..c99521eeae59 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateDevicePassword.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1168" + ], + "jobResource": { + "properties": { + "transferType": "ImportToAzure", + "details": { + "jobDetailsType": "DataBox", + "devicePassword": "", + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "dataImportDetails": [ + { + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName", + "sharePassword": "" + } + } + ] + } + }, + "location": "westus", + "sku": { + "name": "DataBox" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://xxx.xxx.xx" + } + }, + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2019-09-21T14:49:49.0027611+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2019-09-21T14:49:52.3995743+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "jobDetailsType": "DataBox", + "copyLogDetails": [] + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateDoubleEncryption.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateDoubleEncryption.json new file mode 100644 index 000000000000..1af5774e9bc2 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateDoubleEncryption.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1186" + ], + "jobResource": { + "properties": { + "transferType": "ImportToAzure", + "details": { + "jobDetailsType": "DataBox", + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "dataImportDetails": [ + { + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/YourSubscriptionId/resourcegroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName" + } + } + ], + "preferences": { + "encryptionPreferences": { + "doubleEncryption": "Enabled" + } + } + } + }, + "location": "westus", + "sku": { + "name": "DataBox" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://xxx.xxx.xx" + } + }, + "200": { + "body": { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2019-09-21T14:49:49.0027611+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2019-09-21T14:49:52.3995743+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "jobDetailsType": "DataBox", + "copyLogDetails": [] + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateExport.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateExport.json new file mode 100644 index 000000000000..0b6d81c7aad6 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateExport.json @@ -0,0 +1,192 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1395" + ], + "jobResource": { + "properties": { + "transferType": "ExportFromAzure", + "details": { + "jobDetailsType": "DataBox", + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "dataExportDetails": [ + { + "transferConfiguration": { + "transferConfigurationType": "TransferAll", + "transferAllDetails": { + "include": { + "dataAccountType": "StorageAccount", + "transferAllBlobs": true, + "transferAllFiles": true + } + } + }, + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName" + } + } + ] + } + }, + "location": "westus", + "sku": { + "name": "DataBox" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://xxx.xxx.xx" + } + }, + "200": { + "body": { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2019-09-21T14:49:49.0027611+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2019-09-21T14:49:52.3995743+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "jobDetailsType": "DataBox", + "copyLogDetails": [] + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateWithUserAssignedIdentity.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateWithUserAssignedIdentity.json new file mode 100644 index 000000000000..21657f5c6e0b --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsCreateWithUserAssignedIdentity.json @@ -0,0 +1,188 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1318" + ], + "jobResource": { + "properties": { + "transferType": "ImportToAzure", + "details": { + "jobDetailsType": "DataBox", + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "dataImportDetails": [ + { + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName" + } + } + ] + } + }, + "location": "westus", + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testIdentity": {} + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://xxx.xxx.xx" + } + }, + "200": { + "body": { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2019-09-21T14:49:49.0027611+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2019-09-21T14:49:52.3995743+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "jobDetailsType": "DataBox", + "copyLogDetails": [] + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsDelete.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsDelete.json new file mode 100644 index 000000000000..711b88c66c2a --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsDelete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "$expand": "details", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://xxx.xxx.xx" + } + }, + "204": {} + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGet.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGet.json new file mode 100644 index 000000000000..955cc1925397 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGet.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "$expand": "details", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "allDevicesLost": false, + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": true, + "status": "DeviceOrdered", + "startTime": "2020-08-07T10:50:36.3341513+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2020-08-07T10:50:40.1872217+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "Succeeded", + "stageTime": "2020-08-07T12:50:40.1872217+05:30" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "Succeeded", + "stageTime": "2020-08-08T10:50:40.1872217+05:30" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "Succeeded", + "stageTime": "2020-08-09T10:50:40.1872217+05:30" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "dataImportDetails": [ + { + "accountDetails": { + "storageAccountId": "/subscriptions/YourSubscriptionId/resourcegroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName", + "dataAccountType": "StorageAccount" + } + } + ], + "jobDetailsType": "DataBox", + "copyLogDetails": [], + "reverseShipmentLabelSasKey": "https://xxx.xxx.xx", + "keyEncryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "cancellationReason": "Issue reported by you. All device/s lost.", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetCmk.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetCmk.json new file mode 100644 index 000000000000..6630ef153e67 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetCmk.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "$expand": "details", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": true, + "status": "DeviceOrdered", + "startTime": "2020-08-07T10:47:42.0009935+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2020-08-07T10:47:44.8736499+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "dataImportDetails": [ + { + "accountDetails": { + "storageAccountId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName", + "dataAccountType": "StorageAccount" + } + } + ], + "jobDetailsType": "DataBox", + "copyLogDetails": [], + "reverseShipmentLabelSasKey": "https://xxx.xxx.xx", + "keyEncryptionKey": { + "kekType": "CustomerManaged", + "kekUrl": "https://xxx.xxx.xx", + "kekVaultResourceID": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.KeyVault/vaults/YourKeyVaultName" + } + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "tenantId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetCopyStuck.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetCopyStuck.json new file mode 100644 index 000000000000..239e2089db5f --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetCopyStuck.json @@ -0,0 +1,197 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "$expand": "details", + "accept-language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": true, + "status": "CompletedWithWarnings", + "startTime": "2021-03-05T12:56:12.6384315+05:30", + "details": { + "copyProgress": [ + { + "storageAccountName": "YourStorageAccountName", + "transferType": "ImportToAzure", + "dataAccountType": "StorageAccount", + "accountId": "/subscriptions/YourSubscriptionId/resourcegroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName", + "bytesProcessed": 2000, + "totalBytesToProcess": 2000, + "filesProcessed": 100, + "totalFilesToProcess": 110, + "invalidFilesProcessed": 10, + "invalidFileBytesUploaded": 10, + "renamedContainerCount": 60, + "filesErroredOut": 0, + "directoriesErroredOut": 0, + "invalidDirectoriesProcessed": 0, + "isEnumerationInProgress": false + } + ], + "expectedDataSizeInTeraBytes": 0, + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T12:56:25.3911023+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T13:07:49.676421+05:30" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T02:21:06+05:30" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T02:21:13+05:30" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T02:23:10+05:30" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T02:23:17+05:30" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T13:34:20.1497635+05:30" + }, + { + "stageName": "CompletedWithWarnings", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T14:08:38.250614+05:30" + } + ], + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "164 TOWNSEND ST", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "None" + }, + "deliveryPackage": { + "trackingUrl": "https://xxx.xxx.xx", + "carrierName": "Ups", + "trackingId": "5fb6965e-0b80-4f38-b21a-32673fed2d84" + }, + "returnPackage": { + "trackingUrl": "https://xxx.xxx.xx", + "carrierName": "Ups", + "trackingId": "b3875a34-aad6-4dbe-83a9-3f39cb21b0e8" + }, + "dataImportDetails": [ + { + "accountDetails": { + "storageAccountId": "/subscriptions/YourSubscriptionId/resourcegroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName", + "dataAccountType": "StorageAccount" + } + } + ], + "jobDetailsType": "DataBox", + "preferences": {}, + "copyLogDetails": [ + { + "accountName": "YourStorageAccountName", + "copyLogLink": "databoxcopylog/xxx.xml", + "copyLogDetailsType": "DataBox" + } + ], + "reverseShipmentLabelSasKey": "http://xxx.xxx.xxx", + "keyEncryptionKey": { + "kekType": "MicrosoftManaged" + }, + "actions": [], + "lastMitigationActionOnJob": { + "actionDateTimeInUtc": "2021-03-05T08:28:18.8107951Z", + "isPerformedByCustomer": true, + "customerResolution": "MoveToCleanUpDevice" + } + }, + "deliveryType": "NonScheduled", + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": { + "defaultTagsKey": "defaultTagsValue" + }, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetExport.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetExport.json new file mode 100644 index 000000000000..7edeac0b4cae --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetExport.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "$expand": "details", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": true, + "status": "Cancelled", + "startTime": "2020-08-07T10:49:08.7195419+05:30", + "details": { + "copyProgress": [ + { + "storageAccountName": "YourStorageAccountName", + "transferType": "ExportFromAzure", + "dataAccountType": "StorageAccount", + "accountId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName", + "bytesProcessed": 0, + "totalBytesToProcess": 0, + "isEnumerationInProgress": false + } + ], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2020-08-07T10:49:12.7675644+05:30" + }, + { + "stageName": "Cancelled", + "displayName": "Canceled", + "stageStatus": "Succeeded", + "stageTime": "2020-08-07T10:49:57.2572438+05:30" + } + ], + "contactDetails": { + "contactName": " ", + "emailList": [], + "phone": "0000000000", + "phoneExtension": "", + "notificationPreference": [] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "dataImportDetails": [], + "dataExportDetails": [ + { + "transferConfiguration": { + "transferConfigurationType": "TransferAll", + "transferFilterDetails": {}, + "transferAllDetails": { + "include": { + "dataAccountType": "StorageAccount", + "transferAllBlobs": true, + "transferAllFiles": true + } + } + }, + "logCollectionLevel": "Error", + "accountDetails": { + "storageAccountId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName", + "dataAccountType": "StorageAccount" + } + } + ], + "jobDetailsType": "DataBox", + "copyLogDetails": [], + "reverseShipmentLabelSasKey": "https://xxx.xxx.xx", + "chainOfCustodySasKey": "https://xxx.xxx.xx", + "keyEncryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "cancellationReason": "CancelTest", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetWaitingForAction.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetWaitingForAction.json new file mode 100644 index 000000000000..32ab230fd5b2 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsGetWaitingForAction.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "$expand": "details", + "accept-language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": false, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": true, + "status": "DataCopy", + "startTime": "2021-03-14T23:49:49.5177298+00:00", + "error": { + "code": "SsemUserCopyErrorWaitingForAction", + "message": "Job has an error in copy stage and is waiting for customer action. Please review the error and select one of the actions provided in the job's properties.details.actions", + "target": "CopyIntervention", + "details": [], + "additionalInfo": [] + }, + "details": { + "copyProgress": [ + { + "storageAccountName": "YourStorageAccountName", + "transferType": "ImportToAzure", + "dataAccountType": "StorageAccount", + "accountId": "/subscriptions/YourSubscriptionId/resourcegroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName", + "bytesProcessed": 2000, + "totalBytesToProcess": 2000, + "filesProcessed": 100, + "totalFilesToProcess": 110, + "invalidFilesProcessed": 10, + "invalidFileBytesUploaded": 10, + "renamedContainerCount": 60, + "filesErroredOut": 0, + "directoriesErroredOut": 0, + "invalidDirectoriesProcessed": 0, + "isEnumerationInProgress": false + }, + { + "transferType": "ImportToAzure", + "dataAccountType": "ManagedDisk", + "accountId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName", + "bytesProcessed": 2000, + "totalBytesToProcess": 2000, + "filesProcessed": 100, + "totalFilesToProcess": 110, + "invalidFilesProcessed": 10, + "invalidFileBytesUploaded": 10, + "renamedContainerCount": 60, + "filesErroredOut": 0, + "directoriesErroredOut": 0, + "invalidDirectoriesProcessed": 0, + "isEnumerationInProgress": false + } + ], + "expectedDataSizeInTeraBytes": 0, + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2021-03-14T23:49:53.81509+00:00" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "Succeeded", + "stageTime": "2021-03-15T00:05:18.7350971+00:00" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "Succeeded", + "stageTime": "2021-03-15T00:25:19+00:00" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "Succeeded", + "stageTime": "2021-03-15T00:25:26+00:00" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "Succeeded", + "stageTime": "2021-03-15T00:30:22+00:00" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "Succeeded", + "stageTime": "2021-03-15T00:30:29+00:00" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "WaitingForCustomerAction", + "stageTime": "2021-03-15T00:45:26.2679756+00:00" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "164 TOWNSEND ST", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "None" + }, + "deliveryPackage": { + "trackingUrl": "https://xxx.xxx.xx", + "carrierName": "Ups", + "trackingId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + }, + "returnPackage": { + "trackingUrl": "https://xxx.xxx.xx", + "carrierName": "Ups", + "trackingId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + }, + "dataImportDetails": [ + { + "accountDetails": { + "storageAccountId": "/subscriptions/YourSubscriptionId/resourcegroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName", + "dataAccountType": "StorageAccount" + } + }, + { + "accountDetails": { + "resourceGroupId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName", + "stagingStorageAccountId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName", + "dataAccountType": "ManagedDisk" + } + } + ], + "jobDetailsType": "DataBox", + "preferences": { + "encryptionPreferences": { + "doubleEncryption": "Disabled" + } + }, + "copyLogDetails": [ + { + "accountName": "YourStorageAccountName", + "copyLogLink": "databoxcopylog/xxx.xml", + "copyLogDetailsType": "DataBox" + }, + { + "accountName": "YourResourceGroupName", + "copyLogLink": "databoxcopylog/xxx.xml", + "copyLogDetailsType": "DataBox" + } + ], + "reverseShipmentLabelSasKey": "https://xxx.xxx.xx", + "keyEncryptionKey": { + "kekType": "MicrosoftManaged" + }, + "actions": [ + "MoveToCleanUpDevice" + ], + "lastMitigationActionOnJob": { + "actionDateTimeInUtc": "2021-05-12T05:00:22.5047578Z", + "isPerformedByCustomer": true, + "customerResolution": "MoveToCleanUpDevice" + } + }, + "deliveryType": "NonScheduled", + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": { + "defaultTagsKey": "defaultTagsValue" + }, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsList.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsList.json new file mode 100644 index 000000000000..9cd4ec6de51d --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsList.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "api-version": "2024-02-01-preview", + "$expand": "details", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2018-08-30T14:44:39.77401+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "australiaeast", + "tags": {}, + "sku": { + "name": "DataBoxDisk" + }, + "identity": { + "type": "None" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourcegroups/TestResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2018-09-10T18:03:22.2578238+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "australiaeast", + "tags": {}, + "sku": { + "name": "DataBoxDisk" + }, + "identity": { + "type": "None" + }, + "name": "TestJobName2", + "id": "/subscriptions/YourSubscriptionId/resourcegroups/TestResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName2", + "type": "Microsoft.DataBox/jobs" + } + ], + "nextLink": "https://xxx.xxx.xx" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsListByResourceGroup.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsListByResourceGroup.json new file mode 100644 index 000000000000..3edee5dbea05 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "api-version": "2024-02-01-preview", + "$expand": "details", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": true, + "status": "DeviceOrdered", + "startTime": "2020-07-03T11:55:54.463792+05:30", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "tenantId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": true, + "status": "DeviceOrdered", + "startTime": "2020-08-07T10:50:36.3341513+05:30", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "TestJobName2", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName2", + "type": "Microsoft.DataBox/jobs" + } + ] + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsListCredentials.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsListCredentials.json new file mode 100644 index 000000000000..1d8157d0e58f --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsListCredentials.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobName": "TestJobName1", + "jobSecrets": { + "podSecrets": [ + { + "deviceSerialNumber": "testserialnumber", + "devicePassword": "", + "networkConfigurations": [ + { + "name": "DataPort3", + "macAddress": "XXXXXXXXXXXX" + }, + { + "name": "DataPort1", + "macAddress": "XXXXXXXXXXXX" + }, + { + "name": "DataPort2", + "macAddress": "XXXXXXXXXXXX" + } + ], + "encodedValidationCertPubKey": "xxxxxxxxxx", + "accountCredentialDetails": [ + { + "accountName": "YourStorageAccountName", + "dataAccountType": "StorageAccount", + "accountConnectionString": "", + "shareCredentialDetails": [ + { + "shareName": "testsharename_PageBlob", + "shareType": "PageBlob", + "userName": "testusername", + "password": "", + "supportedAccessProtocols": [ + "SMB" + ] + }, + { + "shareName": "testsharename_BlockBlob", + "shareType": "BlockBlob", + "userName": "testusername", + "password": "", + "supportedAccessProtocols": [ + "SMB" + ] + }, + { + "shareName": "testsharename_AzFile", + "shareType": "AzureFile", + "userName": "testusername", + "password": "", + "supportedAccessProtocols": [ + "SMB" + ] + } + ] + } + ] + } + ], + "jobSecretsType": "DataBox", + "dcAccessSecurityCode": {} + } + } + ] + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsPatch.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsPatch.json new file mode 100644 index 000000000000..623aa5589d05 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsPatch.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "$expand": "details", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "584" + ], + "jobResourceUpdateParameter": { + "properties": { + "details": { + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + } + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://xxx.xxx.xx" + } + }, + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30" + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsPatchCmk.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsPatchCmk.json new file mode 100644 index 000000000000..05a513e0c3ea --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsPatchCmk.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "358" + ], + "jobResourceUpdateParameter": { + "properties": { + "details": { + "keyEncryptionKey": { + "kekType": "CustomerManaged", + "kekUrl": "https://xxx.xxx.xx", + "kekVaultResourceID": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.KeyVault/vaults/YourKeyVaultName" + } + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://xxx.xxx.xx" + } + }, + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30" + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsPatchSystemAssignedToUserAssigned.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsPatchSystemAssignedToUserAssigned.json new file mode 100644 index 000000000000..7605f613df1c --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/JobsPatchSystemAssignedToUserAssigned.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "923" + ], + "jobResourceUpdateParameter": { + "properties": { + "details": { + "keyEncryptionKey": { + "kekType": "CustomerManaged", + "identityProperties": { + "type": "UserAssigned", + "userAssigned": { + "resourceId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testIdentity" + } + }, + "kekUrl": "https://xxx.xxx.xx", + "kekVaultResourceID": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.KeyVault/vaults/YourKeyVaultName" + } + } + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testIdentity": {} + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://xxx.xxx.xx" + } + }, + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30" + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "TestJobName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.DataBox/jobs/TestJobName1", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/MarkDevicesShipped.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/MarkDevicesShipped.json new file mode 100644 index 000000000000..8493cc73375a --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/MarkDevicesShipped.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "jobName": "TestJobName1", + "api-version": "2024-02-01-preview", + "accept-language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "60" + ], + "markDevicesShippedRequest": { + "deliverToDcPackageDetails": { + "carrierName": "testCarrier", + "trackingId": "000000" + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/OperationsGet.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/OperationsGet.json new file mode 100644 index 000000000000..36a854e18179 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/OperationsGet.json @@ -0,0 +1,206 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataBox/locations/operationResults/read", + "display": { + "provider": "Azure Data Box", + "resource": "Operation Results", + "operation": "List Operation Results", + "description": "List or get the Operation Results" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/cancel/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Cancel", + "description": "Cancels an order in progress." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/bookShipmentPickUp/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Book Shipment Pick Up", + "description": "Allows to book a pick up for return shipments." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/read", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "List Orders", + "description": "List or get the Orders" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/delete", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Delete Orders", + "description": "Delete the Orders" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/write", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Create or Update Orders", + "description": "Create or update the Orders" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/listCredentials/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "List Credentials", + "description": "Lists the unencrypted credentials related to the order." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/validateInputs/action", + "display": { + "provider": "Azure Data Box", + "resource": "Validate Inputs", + "operation": "Validate Inputs", + "description": "This method does all type of validations." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/validateAddress/action", + "display": { + "provider": "Azure Data Box", + "resource": "Validate Address", + "operation": "Validate Address", + "description": "Validates the shipping address and provides alternate addresses if any." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/subscriptions/resourceGroups/moveResources/action", + "display": { + "provider": "Azure Data Box", + "resource": "Move Resource", + "operation": "Move Resource", + "description": "This method performs the resource move." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/subscriptions/resourceGroups/validateMoveResources/action", + "display": { + "provider": "Azure Data Box", + "resource": "Move Resource", + "operation": "Validate Move Resource Request", + "description": "This method validates whether resource move is allowed or not." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/availableSkus/action", + "display": { + "provider": "Azure Data Box", + "resource": "Available Skus", + "operation": "Availabe Skus", + "description": "This method returns the list of available skus." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/regionConfiguration/action", + "display": { + "provider": "Azure Data Box", + "resource": "Region Configuration", + "operation": "Region Configuration", + "description": "This method returns the configurations for the region." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/availableSkus/read", + "display": { + "provider": "Azure Data Box", + "resource": "Available Skus", + "operation": "List Available Skus", + "description": "List or get the Available Skus" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/register/action", + "display": { + "provider": "Azure Data Box", + "resource": "Register Microsoft.Databox", + "operation": "Register Microsoft.Databox", + "description": "Register Provider Microsoft.Databox" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/unregister/action", + "display": { + "provider": "Azure Data Box", + "resource": "Register Microsoft.Databox", + "operation": "Un-Register Microsoft.Databox", + "description": "Un-Register Provider Microsoft.Databox" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/operations/read", + "display": { + "provider": "Azure Data Box", + "resource": "Operations", + "operation": "List Operations", + "description": "List or get the Operations" + }, + "properties": {}, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/RegionConfiguration.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/RegionConfiguration.json new file mode 100644 index 000000000000..1279d9e9e97f --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/RegionConfiguration.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "location": "westus", + "api-version": "2024-02-01-preview", + "regionConfigurationRequest": { + "scheduleAvailabilityRequest": { + "storageLocation": "westus", + "skuName": "DataBox" + }, + "deviceCapabilityRequest": { + "skuName": "DataBoxDisk" + } + } + }, + "responses": { + "200": { + "body": { + "scheduleAvailabilityResponse": { + "availableDates": [ + "2019-07-11T00:00:00+00:00", + "2019-07-12T00:00:00+00:00", + "2019-07-13T00:00:00+00:00", + "2019-07-14T00:00:00+00:00", + "2019-07-15T00:00:00+00:00", + "2019-07-16T00:00:00+00:00", + "2019-07-17T00:00:00+00:00", + "2019-07-18T00:00:00+00:00", + "2019-07-19T00:00:00+00:00", + "2019-07-20T00:00:00+00:00", + "2019-07-21T00:00:00+00:00", + "2019-07-22T00:00:00+00:00", + "2019-07-23T00:00:00+00:00", + "2019-07-24T00:00:00+00:00", + "2019-07-25T00:00:00+00:00", + "2019-07-26T00:00:00+00:00", + "2019-07-27T00:00:00+00:00", + "2019-07-28T00:00:00+00:00", + "2019-07-29T00:00:00+00:00", + "2019-07-30T00:00:00+00:00", + "2019-07-31T00:00:00+00:00" + ] + }, + "deviceCapabilityResponse": { + "deviceCapabilityDetails": [ + { + "hardwareEncryption": "Enabled" + } + ] + } + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/RegionConfigurationByResourceGroup.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/RegionConfigurationByResourceGroup.json new file mode 100644 index 000000000000..60bf5726af12 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/RegionConfigurationByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "location": "westus", + "api-version": "2024-02-01-preview", + "regionConfigurationRequest": { + "scheduleAvailabilityRequest": { + "storageLocation": "westus", + "skuName": "DataBox" + }, + "deviceCapabilityRequest": { + "skuName": "DataBoxDisk" + } + } + }, + "responses": { + "200": { + "body": { + "scheduleAvailabilityResponse": { + "availableDates": [ + "2019-07-11T00:00:00+00:00", + "2019-07-12T00:00:00+00:00", + "2019-07-13T00:00:00+00:00", + "2019-07-14T00:00:00+00:00", + "2019-07-15T00:00:00+00:00", + "2019-07-16T00:00:00+00:00", + "2019-07-17T00:00:00+00:00", + "2019-07-18T00:00:00+00:00", + "2019-07-19T00:00:00+00:00", + "2019-07-20T00:00:00+00:00", + "2019-07-21T00:00:00+00:00", + "2019-07-22T00:00:00+00:00", + "2019-07-23T00:00:00+00:00", + "2019-07-24T00:00:00+00:00", + "2019-07-25T00:00:00+00:00", + "2019-07-26T00:00:00+00:00", + "2019-07-27T00:00:00+00:00", + "2019-07-28T00:00:00+00:00", + "2019-07-29T00:00:00+00:00", + "2019-07-30T00:00:00+00:00", + "2019-07-31T00:00:00+00:00" + ] + }, + "deviceCapabilityResponse": { + "deviceCapabilityDetails": [ + { + "hardwareEncryption": "Enabled" + } + ] + } + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/ValidateAddressPost.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/ValidateAddressPost.json new file mode 100644 index 000000000000..df9cfbba9e77 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/ValidateAddressPost.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "location": "westus", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "351" + ], + "validateAddress": { + "validationType": "ValidateAddress", + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "deviceType": "DataBox" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "validationStatus": "Valid", + "alternateAddresses": [ + { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "streetAddress3": "", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "addressType": "None" + } + ], + "validationType": "ValidateAddress" + } + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/ValidateInputs.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/ValidateInputs.json new file mode 100644 index 000000000000..3319a41c7861 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/ValidateInputs.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "location": "westus", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1675" + ], + "validationRequest": { + "validationCategory": "JobCreationValidation", + "individualRequestDetails": [ + { + "validationType": "ValidateDataTransferDetails", + "dataImportDetails": [ + { + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/YourSubscriptionId/resourcegroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName" + } + } + ], + "deviceType": "DataBox", + "transferType": "ImportToAzure" + }, + { + "validationType": "ValidateAddress", + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "deviceType": "DataBox", + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + { + "validationType": "ValidateSubscriptionIsAllowedToCreateJob" + }, + { + "validationType": "ValidateSkuAvailability", + "deviceType": "DataBox", + "transferType": "ImportToAzure", + "country": "XX", + "location": "westus" + }, + { + "validationType": "ValidateCreateOrderLimit", + "deviceType": "DataBox" + }, + { + "validationType": "ValidatePreferences", + "preference": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "deviceType": "DataBox" + } + ] + } + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "AllValidToProceed", + "individualResponseDetails": [ + { + "status": "Valid", + "validationType": "ValidateDataTransferDetails", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "validationStatus": "Valid", + "alternateAddresses": [ + { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "streetAddress3": "", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "addressType": "None" + } + ], + "validationType": "ValidateAddress", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidateSubscriptionIsAllowedToCreateJob", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidateSkuAvailability", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidateCreateOrderLimit", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidatePreferences", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + } + ] + } + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/ValidateInputsByResourceGroup.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/ValidateInputsByResourceGroup.json new file mode 100644 index 000000000000..c1f6ea1c953a --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2024-02-01-preview/examples/ValidateInputsByResourceGroup.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "location": "westus", + "api-version": "2024-02-01-preview", + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "vscode-restclient" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1675" + ], + "validationRequest": { + "validationCategory": "JobCreationValidation", + "individualRequestDetails": [ + { + "validationType": "ValidateDataTransferDetails", + "dataImportDetails": [ + { + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/YourSubscriptionId/resourcegroups/YourResourceGroupName/providers/Microsoft.Storage/storageAccounts/YourStorageAccountName" + } + } + ], + "deviceType": "DataBox", + "transferType": "ImportToAzure" + }, + { + "validationType": "ValidateAddress", + "shippingAddress": { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "companyName": "XXXX XXXX", + "addressType": "Commercial" + }, + "deviceType": "DataBox", + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + { + "validationType": "ValidateSubscriptionIsAllowedToCreateJob" + }, + { + "validationType": "ValidateSkuAvailability", + "deviceType": "DataBox", + "transferType": "ImportToAzure", + "country": "XX", + "location": "westus" + }, + { + "validationType": "ValidateCreateOrderLimit", + "deviceType": "DataBox" + }, + { + "validationType": "ValidatePreferences", + "preference": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "deviceType": "DataBox" + } + ] + } + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "AllValidToProceed", + "individualResponseDetails": [ + { + "status": "Valid", + "validationType": "ValidateDataTransferDetails", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "validationStatus": "Valid", + "alternateAddresses": [ + { + "streetAddress1": "XXXX XXXX", + "streetAddress2": "XXXX XXXX", + "streetAddress3": "", + "city": "XXXX XXXX", + "stateOrProvince": "XX", + "country": "XX", + "postalCode": "00000", + "addressType": "None" + } + ], + "validationType": "ValidateAddress", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidateSubscriptionIsAllowedToCreateJob", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidateSkuAvailability", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidateCreateOrderLimit", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidatePreferences", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + } + ] + } + } + } + } +} diff --git a/specification/databox/resource-manager/readme.go.md b/specification/databox/resource-manager/readme.go.md index 6802e94211fd..e1e32f8091c3 100644 --- a/specification/databox/resource-manager/readme.go.md +++ b/specification/databox/resource-manager/readme.go.md @@ -45,6 +45,7 @@ batch: - tag: package-2022-12 - tag: package-2023-03 - tag: package-2023-12 + - tag: package-2024-02-preview ``` ### Tag: package-2018-01 and go @@ -171,4 +172,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '2024-02-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2024-02-01-preview/$(namespace) ``` \ No newline at end of file diff --git a/specification/databox/resource-manager/readme.java.md b/specification/databox/resource-manager/readme.java.md index 37e41c628db0..eeedb7412242 100644 --- a/specification/databox/resource-manager/readme.java.md +++ b/specification/databox/resource-manager/readme.java.md @@ -31,6 +31,7 @@ batch: - tag: package-2022-12 - tag: package-2023-03 - tag: package-2023-12 + - tag: package-2024-02-preview ``` ### Tag: package-2018-01 and java @@ -213,4 +214,17 @@ java: output-folder: $(azure-libraries-for-java-folder)/sdk/databox/mgmt-v2023_12_01 regenerate-manager: true generate-interface: true +``` + +### Tag: package-2024-02-preview and java + +These settings apply only when `--tag=package-2024-02-preview-java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2024-02-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.databox.v2024_02-01-preview + output-folder: $(azure-libraries-for-java-folder)/sdk/databox/mgmt-v2024_02_01_preview +regenerate-manager: true +generate-interface: true ``` \ No newline at end of file diff --git a/specification/databox/resource-manager/readme.md b/specification/databox/resource-manager/readme.md index 43c4c8f47a7f..9f70dc7e0f3b 100644 --- a/specification/databox/resource-manager/readme.md +++ b/specification/databox/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the DataBox API. ``` yaml openapi-type: arm -tag: package-2023-12 +tag: package-2024-02-preview +``` + +### Tag: package-2024-02-preview + +These settings apply only when `--tag=package-2024-02-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-02-preview' +input-file: +- Microsoft.DataBox/preview/2024-02-01-preview/databox.json ``` ### Tag: package-2023-12 diff --git a/specification/databox/resource-manager/readme.python.md b/specification/databox/resource-manager/readme.python.md index c3336c977b5d..3728b6e88d18 100644 --- a/specification/databox/resource-manager/readme.python.md +++ b/specification/databox/resource-manager/readme.python.md @@ -24,6 +24,7 @@ Generate all API versions currently shipped for this package multiapi: true default-api-version: "2023-03-01" batch: + - tag: package-2024-02-preview - tag: package-2023-12 - tag: package-2023-03 - tag: package-2022-12 @@ -46,6 +47,16 @@ output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/datab perform-load: false ``` +### Tag: package-2024-02-preview and python + +These settings apply only when `--tag=package-2024-02-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-02-preview' && $(python) +namespace: azure.mgmt.databox.v2024_02_01_preview +output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2024_02_01_preview +``` + ### Tag: package-2023-12 and python These settings apply only when `--tag=package-2023-12 --python` is specified on the command line. diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/databoxedge.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/databoxedge.json new file mode 100644 index 000000000000..53c2dc51f0c8 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/databoxedge.json @@ -0,0 +1,9757 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-12-01", + "title": "DataBoxEdgeManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.DataBoxEdge/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "List all the supported operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of supported operations.", + "schema": { + "$ref": "#/definitions/OperationsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OperationsGet": { + "$ref": "./examples/OperationsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/availableSkus": { + "get": { + "tags": [ + "AvailableSkus" + ], + "summary": "List all the available Skus and information related to them.", + "operationId": "AvailableSkus_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Lists the available Skus and information related to them.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeSkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvailableSkus": { + "$ref": "./examples/AvailableSkusList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": { + "get": { + "tags": [ + "Devices" + ], + "description": "Gets all the Data Box Edge/Data Box Gateway devices in a subscription.", + "operationId": "Devices_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The collection of Data Box Edge/Data Box Gateway devices.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetBySubscription": { + "$ref": "./examples/DataBoxEdgeDeviceGetBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": { + "get": { + "tags": [ + "Devices" + ], + "description": "Gets all the Data Box Edge/Data Box Gateway devices in a resource group.", + "operationId": "Devices_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The collection of Data Box Edge/Data Box Gateway devices.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetByResourceGroup": { + "$ref": "./examples/DataBoxEdgeDeviceGetByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}": { + "get": { + "tags": [ + "Devices" + ], + "description": "Gets the properties of the Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Data Box Edge/Data Box Gateway device.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetByName": { + "$ref": "./examples/DataBoxEdgeDeviceGetByName.json" + }, + "DataBoxEdgeDeviceGetByNameWithDataResidency": { + "$ref": "./examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json" + } + } + }, + "put": { + "tags": [ + "Devices" + ], + "description": "Creates or updates a Data Box Edge/Data Box Gateway resource.", + "operationId": "Devices_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "dataBoxEdgeDevice", + "in": "body", + "description": "The resource object.", + "required": true, + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevice" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the resource.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DataBoxEdgeDevicePut": { + "$ref": "./examples/DataBoxEdgeDevicePut.json" + }, + "DataBoxEdgeDevicePutWithDataResidency": { + "$ref": "./examples/DataBoxEdgeDevicePutWithDataResidency.json" + } + } + }, + "delete": { + "tags": [ + "Devices" + ], + "description": "Deletes the Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the resource." + }, + "202": { + "description": "Accepted the request to delete the resource." + }, + "204": { + "description": "The resource is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DataBoxEdgeDeviceDelete": { + "$ref": "./examples/DataBoxEdgeDeviceDelete.json" + } + } + }, + "patch": { + "tags": [ + "Devices" + ], + "description": "Modifies a Data Box Edge/Data Box Gateway resource.", + "operationId": "Devices_Update", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The resource parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevicePatch" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the resource.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DataBoxEdgeDevicePatch": { + "$ref": "./examples/DataBoxEdgeDevicePatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "description": "Gets all the alerts for a Data Box Edge/Data Box Gateway device.", + "operationId": "Alerts_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of alerts.", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AlertGetAllInDevice": { + "$ref": "./examples/AlertGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}": { + "get": { + "tags": [ + "Alerts" + ], + "summary": "Gets an alert by name.", + "operationId": "Alerts_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The alert name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The alert details.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AlertGet": { + "$ref": "./examples/AlertGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules": { + "get": { + "tags": [ + "BandwidthSchedules" + ], + "description": "Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.", + "operationId": "BandwidthSchedules_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of bandwidth schedules.", + "schema": { + "$ref": "#/definitions/BandwidthSchedulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BandwidthScheduleGetAllInDevice": { + "$ref": "./examples/BandwidthScheduleGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}": { + "get": { + "tags": [ + "BandwidthSchedules" + ], + "description": "Gets the properties of the specified bandwidth schedule.", + "operationId": "BandwidthSchedules_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The bandwidth schedule.", + "schema": { + "$ref": "#/definitions/BandwidthSchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BandwidthScheduleGet": { + "$ref": "./examples/BandwidthScheduleGet.json" + } + } + }, + "put": { + "tags": [ + "BandwidthSchedules" + ], + "description": "Creates or updates a bandwidth schedule.", + "operationId": "BandwidthSchedules_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name which needs to be added/updated.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The bandwidth schedule to be added or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/BandwidthSchedule" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the bandwidth schedule.", + "schema": { + "$ref": "#/definitions/BandwidthSchedule" + } + }, + "202": { + "description": "Accepted the request to create or update the bandwidth schedule." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BandwidthSchedulePut": { + "$ref": "./examples/BandwidthSchedulePut.json" + } + } + }, + "delete": { + "tags": [ + "BandwidthSchedules" + ], + "description": "Deletes the specified bandwidth schedule.", + "operationId": "BandwidthSchedules_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted the request to delete the bandwidth schedule." + }, + "204": { + "description": "Successfully deleted the bandwidth schedule." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BandwidthScheduleDelete": { + "$ref": "./examples/BandwidthScheduleDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityCheck": { + "post": { + "tags": [ + "DeviceCapacityCheck" + ], + "description": "Posts the device capacity request info to check feasibility.", + "operationId": "DeviceCapacityCheck_CheckResourceCreationFeasibility", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "deviceCapacityRequestInfo", + "in": "body", + "description": "The device capacity request info.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceCapacityRequestInfo" + } + }, + { + "name": "capacityName", + "in": "query", + "description": "The capacity name.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted the request to check the feasibility of resource creation." + }, + "200": { + "description": "Successfully checked the feasibility of resource creation." + }, + "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": "azure-async-operation" + }, + "x-ms-examples": { + "DeviceCapacityRequestPost": { + "$ref": "./examples/DeviceCapacityRequestPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityInfo/default": { + "get": { + "tags": [ + "DeviceCapacityInfo" + ], + "description": "Gets the properties of the specified device capacity info.", + "operationId": "DeviceCapacityInfo_GetDeviceCapacityInfo", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The device capacity info result.", + "schema": { + "$ref": "#/definitions/DeviceCapacityInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeviceCapacityGet": { + "$ref": "./examples/DeviceCapacityGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticProactiveLogCollectionSettings/default": { + "get": { + "tags": [ + "DiagnosticSettings" + ], + "description": "Gets the proactive log collection settings of the specified Data Box Edge/Data Box Gateway device.", + "operationId": "DiagnosticSettings_GetDiagnosticProactiveLogCollectionSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The diagnostic proactive log collection settings.", + "schema": { + "$ref": "#/definitions/DiagnosticProactiveLogCollectionSettings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetDiagnosticProactiveLogCollectionSettings": { + "$ref": "./examples/GetDiagnosticProactiveLogCollectionSettings.json" + } + } + }, + "put": { + "tags": [ + "DiagnosticSettings" + ], + "description": "Updates the proactive log collection settings on a Data Box Edge/Data Box Gateway device.", + "operationId": "DiagnosticSettings_UpdateDiagnosticProactiveLogCollectionSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "proactiveLogCollectionSettings", + "in": "body", + "description": "The proactive log collection settings.", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticProactiveLogCollectionSettings" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the proactive log collection settings.", + "schema": { + "$ref": "#/definitions/DiagnosticProactiveLogCollectionSettings" + } + }, + "202": { + "description": "Accepted the request to update the proactive log collection settings." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UpdateDiagnosticProactiveLogCollectionSettings": { + "$ref": "./examples/UpdateDiagnosticProactiveLogCollectionSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticRemoteSupportSettings/default": { + "get": { + "tags": [ + "DiagnosticSettings" + ], + "description": "Gets the diagnostic remote support settings of the specified Data Box Edge/Data Box Gateway device.", + "operationId": "DiagnosticSettings_GetDiagnosticRemoteSupportSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The diagnostic remote support settings.", + "schema": { + "$ref": "#/definitions/DiagnosticRemoteSupportSettings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetDiagnosticRemoteSupportSettings": { + "$ref": "./examples/GetDiagnosticRemoteSupportSettings.json" + } + } + }, + "put": { + "tags": [ + "DiagnosticSettings" + ], + "description": "Updates the diagnostic remote support settings on a Data Box Edge/Data Box Gateway device.", + "operationId": "DiagnosticSettings_UpdateDiagnosticRemoteSupportSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "diagnosticRemoteSupportSettings", + "in": "body", + "description": "The diagnostic remote support settings.", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticRemoteSupportSettings" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted the request to update the diagnostic remote support settings." + }, + "200": { + "description": "Successfully updated the diagnostic remote support settings.", + "schema": { + "$ref": "#/definitions/DiagnosticRemoteSupportSettings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UpdateDiagnosticRemoteSupportSettings": { + "$ref": "./examples/UpdateDiagnosticRemoteSupportSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates": { + "post": { + "tags": [ + "Devices" + ], + "summary": "Downloads the updates on a Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_DownloadUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully downloaded the updates on the device." + }, + "202": { + "description": "Accepted the request to download the updates on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DownloadUpdatesPost": { + "$ref": "./examples/DownloadUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/generateCertificate": { + "post": { + "tags": [ + "Devices" + ], + "description": "Generates certificate for activation key.", + "operationId": "Devices_GenerateCertificate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully generated self signed certificate.", + "schema": { + "$ref": "#/definitions/GenerateCertResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateCertificate": { + "$ref": "./examples/GenerateCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation": { + "post": { + "tags": [ + "Devices" + ], + "description": "Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.", + "operationId": "Devices_GetExtendedInformation", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The additional information.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExtendedInfoPost": { + "$ref": "./examples/ExtendedInfoPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates": { + "post": { + "tags": [ + "Devices" + ], + "summary": "Installs the updates on the Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_InstallUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully installed updates on the device." + }, + "202": { + "description": "Accepted the request to install updates on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "InstallUpdatesPost": { + "$ref": "./examples/InstallUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.", + "operationId": "Jobs_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The job name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The job details.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "JobsGet": { + "$ref": "./examples/JobsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default": { + "get": { + "tags": [ + "Devices" + ], + "description": "Gets the network settings of the specified Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_GetNetworkSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The device network settings.", + "schema": { + "$ref": "#/definitions/NetworkSettings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkSettingsGet": { + "$ref": "./examples/NetworkSettingsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/nodes": { + "get": { + "tags": [ + "Nodes" + ], + "description": "Gets all the nodes currently configured under this Data Box Edge device", + "operationId": "Nodes_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of all nodes on the device.", + "schema": { + "$ref": "#/definitions/NodeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NodesGetAllInDevice": { + "$ref": "./examples/NodeGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}": { + "get": { + "tags": [ + "OperationsStatus" + ], + "summary": "Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.", + "operationId": "OperationsStatus_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The job name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The job details.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "OperationsStatusGet": { + "$ref": "./examples/OperationsStatusGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders": { + "get": { + "tags": [ + "Orders" + ], + "summary": "Lists all the orders related to a Data Box Edge/Data Box Gateway device.", + "operationId": "Orders_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Lists all the orders for the Data Box Edge Device", + "schema": { + "$ref": "#/definitions/OrderList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OrderGetAllInDevice": { + "$ref": "./examples/OrderGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default": { + "get": { + "tags": [ + "Orders" + ], + "summary": "Gets a specific order by name.", + "operationId": "Orders_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The order details of a device.", + "schema": { + "$ref": "#/definitions/Order" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "OrderGet": { + "$ref": "./examples/OrderGet.json" + } + } + }, + "put": { + "tags": [ + "Orders" + ], + "summary": "Creates or updates an order.", + "operationId": "Orders_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The order details of a device.", + "required": true, + "type": "string" + }, + { + "name": "order", + "in": "body", + "description": "The order to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Order" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the order.", + "schema": { + "$ref": "#/definitions/Order" + } + }, + "202": { + "description": "Accepted the request to create or update the order." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "OrderPut": { + "$ref": "./examples/OrderPut.json" + } + } + }, + "delete": { + "tags": [ + "Orders" + ], + "summary": "Deletes the order related to the device.", + "operationId": "Orders_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the order." + }, + "202": { + "description": "Accepted the request to delete the order." + }, + "204": { + "description": "The order is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "OrderDelete": { + "$ref": "./examples/OrderDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default/listDCAccessCode": { + "post": { + "tags": [ + "Orders" + ], + "summary": "Gets the DCAccess Code", + "operationId": "Orders_ListDCAccessCode", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "DC Access code for the device", + "schema": { + "$ref": "#/definitions/DCAccessCode" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetDCAccessCode": { + "$ref": "./examples/GetDCAccessCode.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles": { + "get": { + "tags": [ + "Roles" + ], + "description": "Lists all the roles configured in a Data Box Edge/Data Box Gateway device.", + "operationId": "Roles_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all the roles configured in the device.", + "schema": { + "$ref": "#/definitions/RoleList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "RoleGetAllInDevice": { + "$ref": "./examples/RoleGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}": { + "get": { + "tags": [ + "Roles" + ], + "description": "Gets a specific role by name.", + "operationId": "Roles_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The role with the specified name in the given device.", + "schema": { + "$ref": "#/definitions/Role" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "RoleGet": { + "$ref": "./examples/RoleGet.json" + } + } + }, + "put": { + "tags": [ + "Roles" + ], + "description": "Create or update a role.", + "operationId": "Roles_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "name": "role", + "in": "body", + "description": "The role properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Role" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the role.", + "schema": { + "$ref": "#/definitions/Role" + } + }, + "202": { + "description": "Accepted the request to create or update the role." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RolePut": { + "$ref": "./examples/RolePut.json" + } + } + }, + "delete": { + "tags": [ + "Roles" + ], + "description": "Deletes the role on the device.", + "operationId": "Roles_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the role." + }, + "202": { + "description": "Accepted the request to delete the role." + }, + "204": { + "description": "The role is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RoleDelete": { + "$ref": "./examples/RoleDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons": { + "get": { + "tags": [ + "Addons" + ], + "description": "Lists all the addons configured in the role.", + "operationId": "Addons_ListByRole", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all the addons configured in the role.", + "schema": { + "$ref": "#/definitions/AddonList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "RoleListAddOns": { + "$ref": "./examples/RoleListAddOns.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}": { + "get": { + "tags": [ + "Addons" + ], + "description": "Gets a specific addon by name.", + "operationId": "Addons_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "name": "addonName", + "in": "path", + "description": "The addon name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The addon with the specified name in the role.", + "schema": { + "$ref": "#/definitions/Addon" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetAddOns": { + "$ref": "./examples/GetAddons.json" + } + } + }, + "put": { + "tags": [ + "Addons" + ], + "description": "Create or update a addon.", + "operationId": "Addons_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "name": "addonName", + "in": "path", + "description": "The addon name.", + "required": true, + "type": "string" + }, + { + "name": "addon", + "in": "body", + "description": "The addon properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Addon" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the addon.", + "schema": { + "$ref": "#/definitions/Addon" + } + }, + "202": { + "description": "Accepted the request to create or update the addon." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PutAddOns": { + "$ref": "./examples/PutAddons.json" + } + } + }, + "delete": { + "tags": [ + "Addons" + ], + "description": "Deletes the addon on the device.", + "operationId": "Addons_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "name": "addonName", + "in": "path", + "description": "The addon name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the addon." + }, + "202": { + "description": "Accepted the request to delete the addon." + }, + "204": { + "description": "The addon is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DeleteAddOns": { + "$ref": "./examples/DeleteAddons.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig": { + "get": { + "tags": [ + "MonitoringConfig" + ], + "summary": "Lists metric configurations in a role.", + "operationId": "MonitoringConfig_List", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The monitoring config details.", + "schema": { + "$ref": "#/definitions/MonitoringMetricConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListMonitoringConfig": { + "$ref": "./examples/ListMonitoringConfig.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default": { + "get": { + "tags": [ + "MonitoringConfig" + ], + "summary": "Gets a metric configuration of a role.", + "operationId": "MonitoringConfig_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The monitoring config details.", + "schema": { + "$ref": "#/definitions/MonitoringMetricConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetMonitoringConfig": { + "$ref": "./examples/GetMonitoringConfig.json" + } + } + }, + "put": { + "tags": [ + "MonitoringConfig" + ], + "summary": "Creates a new metric configuration or updates an existing one for a role.", + "operationId": "MonitoringConfig_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "name": "monitoringMetricConfiguration", + "in": "body", + "description": "The metric configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/MonitoringMetricConfiguration" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the metrics configuration.", + "schema": { + "$ref": "#/definitions/MonitoringMetricConfiguration" + } + }, + "202": { + "description": "Accepted the request to create or update the metrics configuration." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PutMonitoringConfig": { + "$ref": "./examples/PutMonitoringConfig.json" + } + } + }, + "delete": { + "tags": [ + "MonitoringConfig" + ], + "summary": "deletes a new metric configuration for a role.", + "operationId": "MonitoringConfig_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the metrics configuration." + }, + "202": { + "description": "Accepted the request to delete the metrics configuration." + }, + "204": { + "description": "The metrics configuration is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DeleteMonitoringConfig": { + "$ref": "./examples/DeleteMonitoringConfig.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates": { + "post": { + "tags": [ + "Devices" + ], + "summary": "Scans for updates on a Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_ScanForUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully scanned the device for updates." + }, + "202": { + "description": "Accepted the request to scan for updates on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ScanForUpdatesPost": { + "$ref": "./examples/ScanForUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update": { + "post": { + "tags": [ + "Devices" + ], + "description": "Updates the security settings on a Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_CreateOrUpdateSecuritySettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "securitySettings", + "in": "body", + "description": "The security settings.", + "required": true, + "schema": { + "$ref": "#/definitions/SecuritySettings" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted the request to update the security settings." + }, + "204": { + "description": "Updated the security settings." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CreateOrUpdateSecuritySettings": { + "$ref": "./examples/SecuritySettingsUpdatePost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares": { + "get": { + "tags": [ + "Shares" + ], + "summary": "Lists all the shares in a Data Box Edge/Data Box Gateway device.", + "operationId": "Shares_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of all the shares on the device.", + "schema": { + "$ref": "#/definitions/ShareList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ShareGetAllInDevice": { + "$ref": "./examples/ShareGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}": { + "get": { + "tags": [ + "Shares" + ], + "summary": "Gets a share by name.", + "operationId": "Shares_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The share name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The share details.", + "schema": { + "$ref": "#/definitions/Share" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ShareGet": { + "$ref": "./examples/ShareGet.json" + } + } + }, + "put": { + "tags": [ + "Shares" + ], + "summary": "Creates a new share or updates an existing share on the device.", + "operationId": "Shares_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The share name.", + "required": true, + "type": "string" + }, + { + "name": "share", + "in": "body", + "description": "The share properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Share" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the share.", + "schema": { + "$ref": "#/definitions/Share" + } + }, + "202": { + "description": "Accepted the request to create or update the share." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SharePut": { + "$ref": "./examples/SharePut.json" + } + } + }, + "delete": { + "tags": [ + "Shares" + ], + "description": "Deletes the share on the Data Box Edge/Data Box Gateway device.", + "operationId": "Shares_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The share name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the share." + }, + "202": { + "description": "Accepted the request to delete the share." + }, + "204": { + "description": "The share is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ShareDelete": { + "$ref": "./examples/ShareDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh": { + "post": { + "tags": [ + "Shares" + ], + "summary": "Refreshes the share metadata with the data from the cloud.", + "operationId": "Shares_Refresh", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The share name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully refreshed the share on the device." + }, + "202": { + "description": "Accepted the request to refresh the share on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ShareRefreshPost": { + "$ref": "./examples/ShareRefreshPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials": { + "get": { + "tags": [ + "StorageAccountCredentials" + ], + "summary": "Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.", + "operationId": "StorageAccountCredentials_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of storage account credentials.", + "schema": { + "$ref": "#/definitions/StorageAccountCredentialList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SACGetAllInDevice": { + "$ref": "./examples/SACGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}": { + "get": { + "tags": [ + "StorageAccountCredentials" + ], + "description": "Gets the properties of the specified storage account credential.", + "operationId": "StorageAccountCredentials_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The storage account credential name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The storage account credential properties.", + "schema": { + "$ref": "#/definitions/StorageAccountCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SACGet": { + "$ref": "./examples/SACGet.json" + } + } + }, + "put": { + "tags": [ + "StorageAccountCredentials" + ], + "description": "Creates or updates the storage account credential.", + "operationId": "StorageAccountCredentials_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The storage account credential name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountCredential", + "in": "body", + "description": "The storage account credential.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCredential" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the storage account credential.", + "schema": { + "$ref": "#/definitions/StorageAccountCredential" + } + }, + "202": { + "description": "Accepted the request to create or update the storage account credential." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SACPut": { + "$ref": "./examples/SACPut.json" + } + } + }, + "delete": { + "tags": [ + "StorageAccountCredentials" + ], + "description": "Deletes the storage account credential.", + "operationId": "StorageAccountCredentials_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The storage account credential name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the storage account credential." + }, + "202": { + "description": "Accepted the request to delete the storage account credential." + }, + "204": { + "description": "The storage account credential is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SACDelete": { + "$ref": "./examples/SACDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "summary": "Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device.", + "operationId": "StorageAccounts_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of all the StorageAccounts on the device.", + "schema": { + "$ref": "#/definitions/StorageAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "StorageAccountGetAllInDevice": { + "$ref": "./examples/StorageAccountGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}": { + "get": { + "tags": [ + "StorageAccounts" + ], + "summary": "Gets a StorageAccount by name.", + "operationId": "StorageAccounts_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The storage account name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The storage account details.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageAccountGet": { + "$ref": "./examples/StorageAccountGet.json" + } + } + }, + "put": { + "tags": [ + "StorageAccounts" + ], + "summary": "Creates a new StorageAccount or updates an existing StorageAccount on the device.", + "operationId": "StorageAccounts_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The StorageAccount name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccount", + "in": "body", + "description": "The StorageAccount properties.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the StorageAccount.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "202": { + "description": "Accepted the request to create or update the StorageAccount." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "StorageAccountPut": { + "$ref": "./examples/StorageAccountPut.json" + } + } + }, + "delete": { + "tags": [ + "StorageAccounts" + ], + "description": "Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device.", + "operationId": "StorageAccounts_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The StorageAccount name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted the request to delete the StorageAccount." + }, + "204": { + "description": "The StorageAccount is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "StorageAccountDelete": { + "$ref": "./examples/StorageAccountDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers": { + "get": { + "tags": [ + "Containers" + ], + "summary": "Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.", + "operationId": "Containers_ListByStorageAccount", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The storage Account name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of all the containers on the device.", + "schema": { + "$ref": "#/definitions/ContainerList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ContainerListAllInDevice": { + "$ref": "./examples/ContainerListAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}": { + "get": { + "tags": [ + "Containers" + ], + "summary": "Gets a container by name.", + "operationId": "Containers_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The Storage Account Name", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "The container Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The container details.", + "schema": { + "$ref": "#/definitions/Container" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ContainerGet": { + "$ref": "./examples/ContainerGet.json" + } + } + }, + "put": { + "tags": [ + "Containers" + ], + "summary": "Creates a new container or updates an existing container on the device.", + "operationId": "Containers_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The Storage Account Name", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "The container name.", + "required": true, + "type": "string" + }, + { + "name": "container", + "in": "body", + "description": "The container properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Container" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the container.", + "schema": { + "$ref": "#/definitions/Container" + } + }, + "202": { + "description": "Accepted the request to create or update the container." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerPut": { + "$ref": "./examples/ContainerPut.json" + } + } + }, + "delete": { + "tags": [ + "Containers" + ], + "description": "Deletes the container on the Data Box Edge/Data Box Gateway device.", + "operationId": "Containers_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The Storage Account Name", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "The container name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted the request to delete the container." + }, + "204": { + "description": "The container is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerDelete": { + "$ref": "./examples/ContainerDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}/refresh": { + "post": { + "tags": [ + "Containers" + ], + "summary": "Refreshes the container metadata with the data from the cloud.", + "operationId": "Containers_Refresh", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The Storage Account Name", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "The container name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully refreshed the container on the device." + }, + "202": { + "description": "Accepted the request to refresh the container on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerRefresh": { + "$ref": "./examples/ContainerRefresh.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers": { + "get": { + "tags": [ + "Triggers" + ], + "description": "Lists all the triggers configured in the device.", + "operationId": "Triggers_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Specify $filter='CustomContextTag eq ' to filter on custom context tag property", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all the triggers configured in the device", + "schema": { + "$ref": "#/definitions/TriggerList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TriggerGetAllInDevice": { + "$ref": "./examples/TriggerGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}": { + "get": { + "tags": [ + "Triggers" + ], + "description": "Get a specific trigger by name.", + "operationId": "Triggers_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The trigger name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The trigger.", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "TriggerGet": { + "$ref": "./examples/TriggerGet.json" + } + } + }, + "put": { + "tags": [ + "Triggers" + ], + "description": "Creates or updates a trigger.", + "operationId": "Triggers_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Creates or updates a trigger", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The trigger name.", + "required": true, + "type": "string" + }, + { + "name": "trigger", + "in": "body", + "description": "The trigger.", + "required": true, + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the trigger.", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "202": { + "description": "Accepted the request to create or update the trigger." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TriggerPut": { + "$ref": "./examples/TriggerPut.json" + } + } + }, + "delete": { + "tags": [ + "Triggers" + ], + "description": "Deletes the trigger on the gateway device.", + "operationId": "Triggers_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The trigger name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the trigger." + }, + "202": { + "description": "Accepted the request to delete the trigger." + }, + "204": { + "description": "The trigger is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TriggerDelete": { + "$ref": "./examples/TriggerDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggerSupportPackage": { + "post": { + "tags": [ + "SupportPackages" + ], + "summary": "Triggers support package on the device", + "operationId": "SupportPackages_TriggerSupportPackage", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "triggerSupportPackageRequest", + "in": "body", + "description": "The trigger support package request object", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerSupportPackageRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully triggered support package on the device." + }, + "202": { + "description": "Accepted the request to trigger support package on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TriggerSupportPackage": { + "$ref": "./examples/TriggerSupportPackage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateExtendedInformation": { + "post": { + "tags": [ + "Devices" + ], + "description": "Gets additional information for the specified Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_UpdateExtendedInformation", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The patch object.", + "required": true, + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoPatch" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Modify additional information.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetUpdateExtendedInfo": { + "$ref": "./examples/GetUpdateExtendedInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default": { + "get": { + "tags": [ + "Devices" + ], + "summary": "Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.", + "operationId": "Devices_GetUpdateSummary", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The update summary.", + "schema": { + "$ref": "#/definitions/UpdateSummary" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateSummaryGet": { + "$ref": "./examples/UpdateSummaryGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate": { + "post": { + "tags": [ + "Devices" + ], + "description": "Uploads registration certificate for the device.", + "operationId": "Devices_UploadCertificate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The upload certificate request.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadCertificateRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully uploaded the registration certificate.", + "schema": { + "$ref": "#/definitions/UploadCertificateResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UploadCertificatePost": { + "$ref": "./examples/UploadCertificatePost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users": { + "get": { + "tags": [ + "Users" + ], + "description": "Gets all the users registered on a Data Box Edge/Data Box Gateway device.", + "operationId": "Users_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Specify $filter='Type eq ' to filter on user type property", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The collection of all users on the device.", + "schema": { + "$ref": "#/definitions/UserList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "UserGetAllInDevice": { + "$ref": "./examples/UserGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}": { + "get": { + "tags": [ + "Users" + ], + "description": "Gets the properties of the specified user.", + "operationId": "Users_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The user name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The user details.", + "schema": { + "$ref": "#/definitions/User" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UserGet": { + "$ref": "./examples/UserGet.json" + } + } + }, + "put": { + "tags": [ + "Users" + ], + "description": "Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.", + "operationId": "Users_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The user name.", + "required": true, + "type": "string" + }, + { + "name": "user", + "in": "body", + "description": "The user details.", + "required": true, + "schema": { + "$ref": "#/definitions/User" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the user.", + "schema": { + "$ref": "#/definitions/User" + } + }, + "202": { + "description": "Accepted the request to create or update the user." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UserPut": { + "$ref": "./examples/UserPut.json" + } + } + }, + "delete": { + "tags": [ + "Users" + ], + "description": "Deletes the user on a databox edge/gateway device.", + "operationId": "Users_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The user name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the user." + }, + "202": { + "description": "Accepted the request to delete the user." + }, + "204": { + "description": "The user is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UserDelete": { + "$ref": "./examples/UserDelete.json" + } + } + } + } + }, + "definitions": { + "Addon": { + "description": "Role Addon", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "kind": { + "description": "Addon type.", + "enum": [ + "IotEdge", + "ArcForKubernetes" + ], + "type": "string", + "x-ms-enum": { + "name": "AddonType", + "modelAsString": true + } + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of Addon", + "readOnly": true + } + }, + "discriminator": "kind" + }, + "AddonList": { + "description": "Collection of all the Role addon on the Azure Stack Edge device.", + "type": "object", + "properties": { + "value": { + "description": "The Value.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Addon" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Address": { + "description": "The shipping address of the customer.", + "required": [ + "country" + ], + "type": "object", + "properties": { + "addressLine1": { + "description": "The address line1.", + "type": "string" + }, + "addressLine2": { + "description": "The address line2.", + "type": "string" + }, + "addressLine3": { + "description": "The address line3.", + "type": "string" + }, + "postalCode": { + "description": "The postal code.", + "type": "string" + }, + "city": { + "description": "The city name.", + "type": "string" + }, + "state": { + "description": "The state name.", + "type": "string" + }, + "country": { + "description": "The country name.", + "type": "string" + } + } + }, + "Alert": { + "description": "Alert on the data box edge/gateway device.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AlertProperties", + "description": "Properties of alert.", + "readOnly": true, + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of Alert", + "readOnly": true + } + } + }, + "AlertErrorDetails": { + "description": "Error details for the alert.", + "type": "object", + "properties": { + "errorCode": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "Error Message.", + "type": "string", + "readOnly": true + }, + "occurrences": { + "format": "int32", + "description": "Number of occurrences.", + "type": "integer", + "readOnly": true + } + } + }, + "AlertList": { + "description": "Collection of alerts.", + "type": "object", + "properties": { + "value": { + "description": "The value.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "AlertProperties": { + "description": "Properties of alert.", + "type": "object", + "properties": { + "title": { + "description": "Alert title.", + "type": "string", + "readOnly": true + }, + "alertType": { + "description": "Alert type.", + "type": "string", + "readOnly": true + }, + "appearedAtDateTime": { + "format": "date-time", + "description": "UTC time when the alert appeared.", + "type": "string", + "readOnly": true + }, + "recommendation": { + "description": "Alert recommendation.", + "type": "string", + "readOnly": true + }, + "severity": { + "description": "Severity of the alert.", + "enum": [ + "Informational", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AlertSeverity", + "modelAsString": true + } + }, + "errorDetails": { + "$ref": "#/definitions/AlertErrorDetails", + "description": "Error details of the alert.", + "readOnly": true + }, + "detailedInformation": { + "description": "Alert details.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "ArcAddon": { + "description": "Arc Addon.", + "required": [ + "properties", + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Addon" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ArcAddonProperties", + "description": "Properties specific to Arc addon.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "ArcForKubernetes" + }, + "ArcAddonProperties": { + "description": "Arc addon properties.", + "required": [ + "subscriptionId", + "resourceGroupName", + "resourceName", + "resourceLocation" + ], + "type": "object", + "properties": { + "subscriptionId": { + "description": "Arc resource subscription Id", + "type": "string" + }, + "resourceGroupName": { + "description": "Arc resource group name", + "type": "string" + }, + "resourceName": { + "description": "Arc resource Name", + "type": "string" + }, + "resourceLocation": { + "description": "Arc resource location", + "type": "string" + }, + "version": { + "description": "Arc resource version", + "type": "string", + "readOnly": true + }, + "hostPlatform": { + "description": "Host OS supported by the Arc addon.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PlatformType", + "modelAsString": true + } + }, + "hostPlatformType": { + "description": "Platform where the runtime is hosted.", + "enum": [ + "KubernetesCluster", + "LinuxVM" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HostPlatformType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Addon Provisioning State", + "enum": [ + "Invalid", + "Creating", + "Created", + "Updating", + "Reconfiguring", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AddonState", + "modelAsString": true + } + } + } + }, + "ARMBaseModel": { + "description": "Represents the base class for all object models.", + "type": "object", + "properties": { + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "AsymmetricEncryptedSecret": { + "description": "Represent the secrets intended for encryption with asymmetric key pair.", + "required": [ + "value", + "encryptionAlgorithm" + ], + "type": "object", + "properties": { + "value": { + "description": "The value of the secret.", + "type": "string" + }, + "encryptionCertThumbprint": { + "description": "Thumbprint certificate used to encrypt \\\"Value\\\". If the value is unencrypted, it will be null.", + "x-ms-secret": true, + "type": "string" + }, + "encryptionAlgorithm": { + "description": "The algorithm used to encrypt \"Value\".", + "enum": [ + "None", + "AES256", + "RSAES_PKCS1_v_1_5" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionAlgorithm", + "modelAsString": true + } + } + } + }, + "Authentication": { + "description": "Authentication mechanism for IoT devices.", + "type": "object", + "properties": { + "symmetricKey": { + "$ref": "#/definitions/SymmetricKey", + "description": "Symmetric key for authentication." + } + } + }, + "AzureContainerInfo": { + "description": "Azure container mapping of the endpoint.", + "required": [ + "storageAccountCredentialId", + "containerName", + "dataFormat" + ], + "type": "object", + "properties": { + "storageAccountCredentialId": { + "description": "ID of the storage account credential used to access storage.", + "type": "string" + }, + "containerName": { + "description": "Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).", + "type": "string" + }, + "dataFormat": { + "description": "Storage format used for the file represented by the share.", + "enum": [ + "BlockBlob", + "PageBlob", + "AzureFile" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureContainerDataFormat", + "modelAsString": true + } + } + } + }, + "BandwidthSchedule": { + "description": "The bandwidth schedule details.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BandwidthScheduleProperties", + "description": "The properties of the bandwidth schedule.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of BandwidthSchedule", + "readOnly": true + } + } + }, + "BandwidthScheduleProperties": { + "description": "The properties of the bandwidth schedule.", + "required": [ + "start", + "stop", + "rateInMbps", + "days" + ], + "type": "object", + "properties": { + "start": { + "description": "The start time of the schedule in UTC.", + "type": "string" + }, + "stop": { + "description": "The stop time of the schedule in UTC.", + "type": "string" + }, + "rateInMbps": { + "format": "int32", + "description": "The bandwidth rate in Mbps.", + "type": "integer" + }, + "days": { + "description": "The days of the week when this schedule is applicable.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + }, + "x-ms-identifiers": [] + } + } + } + }, + "BandwidthSchedulesList": { + "description": "The collection of bandwidth schedules.", + "type": "object", + "properties": { + "value": { + "description": "The list of bandwidth schedules.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BandwidthSchedule" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ClientAccessRight": { + "description": "The mapping between a particular client IP and the type of access client has on the NFS share.", + "required": [ + "client", + "accessPermission" + ], + "type": "object", + "properties": { + "client": { + "description": "IP of the client.", + "type": "string" + }, + "accessPermission": { + "description": "Type of access to be allowed for the client.", + "enum": [ + "NoAccess", + "ReadOnly", + "ReadWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientPermissionType", + "modelAsString": true + } + } + } + }, + "CloudEdgeManagementRole": { + "description": "The preview of Virtual Machine Cloud Management from the Azure supports deploying and managing VMs on your Azure Stack Edge device from Azure Portal. \r\nFor more information, refer to: https://docs.microsoft.com/en-us/azure/databox-online/azure-stack-edge-gpu-virtual-machine-overview\r\nBy using this feature, you agree to the preview legal terms. See the https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/ for additional details.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CloudEdgeManagementRoleProperties", + "description": "Properties specific to CloudEdgeManagementRole role.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "CloudEdgeManagement" + }, + "CloudEdgeManagementRoleProperties": { + "description": "CloudEdgeManagement Role properties.", + "required": [ + "roleStatus" + ], + "type": "object", + "properties": { + "localManagementStatus": { + "description": "Local Edge Management Status", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + }, + "edgeProfile": { + "$ref": "#/definitions/EdgeProfile", + "description": "Edge Profile of the resource", + "readOnly": true + }, + "roleStatus": { + "description": "Role status.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + } + } + }, + "CloudError": { + "description": "An error response from the service.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "The error details." + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "An error response from the service.", + "type": "object", + "properties": { + "code": { + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", + "type": "string" + }, + "message": { + "description": "A message describing the error, intended to be suitable for display in a user interface.", + "type": "string" + }, + "details": { + "description": "A list of additional details about the error.", + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-external": true + }, + "ClusterCapacityViewData": { + "description": "Cluster Compute Data.", + "type": "object", + "properties": { + "fqdn": { + "description": "The FQDN of the cluster.", + "type": "string" + }, + "gpuCapacity": { + "$ref": "#/definitions/ClusterGpuCapacity", + "description": "The cluster's GPU capacity." + }, + "memoryCapacity": { + "$ref": "#/definitions/ClusterMemoryCapacity", + "description": "The cluster's memory capacity." + }, + "lastRefreshedTime": { + "format": "date-time", + "description": "The last time at which the ClusterCapacityViewData was set.", + "type": "string" + }, + "totalProvisionedNonHpnCores": { + "format": "int64", + "description": "The total # of vCPUs provisioned by non-HPN VM per appliance.", + "type": "integer" + } + } + }, + "ClusterGpuCapacity": { + "description": "Cluster GPU Data.", + "type": "object", + "properties": { + "gpuType": { + "description": "The cluster GPU Type.", + "type": "string" + }, + "gpuUsedUnitsCount": { + "format": "int32", + "description": "The used GPU units count in the cluster.", + "type": "integer" + }, + "gpuFreeUnitsCount": { + "format": "int32", + "description": "The free GPU units count in the cluster.", + "type": "integer" + }, + "gpuReservedForFailoverUnitsCount": { + "format": "int32", + "description": "The GPU units count reserved for failover in the cluster.", + "type": "integer" + }, + "gpuTotalUnitsCount": { + "format": "int32", + "description": "The total GPU units count in the cluster.", + "type": "integer" + } + } + }, + "ClusterMemoryCapacity": { + "description": "NodeCapacityInfo defines the required information to determine the placement of a VM.", + "type": "object", + "properties": { + "clusterFreeMemoryMb": { + "format": "double", + "description": "The free memory in the cluster in MB.", + "type": "number" + }, + "clusterUsedMemoryMb": { + "format": "double", + "description": "The used memory in the cluster in MB.", + "type": "number" + }, + "clusterFailoverMemoryMb": { + "format": "double", + "description": "The failover memory in the cluster in MB.", + "type": "number" + }, + "clusterFragmentationMemoryMb": { + "format": "double", + "description": "The fragmentation memory in the cluster in MB.", + "type": "number" + }, + "clusterHypervReserveMemoryMb": { + "format": "double", + "description": "The memory reserved for Hyper-V in the cluster in MB.", + "type": "number" + }, + "clusterInfraVmMemoryMb": { + "format": "double", + "description": "The memory of the Infra VM in the cluster in MB.", + "type": "number" + }, + "clusterTotalMemoryMb": { + "format": "double", + "description": "The total memory in the cluster in MB.", + "type": "number" + }, + "clusterNonFailoverVmMb": { + "format": "double", + "description": "The non-failover memory in the cluster in MB.", + "type": "number" + }, + "clusterMemoryUsedByVmsMb": { + "format": "double", + "description": "The memory used by VMs in the cluster in MB.", + "type": "number" + } + } + }, + "ClusterStorageViewData": { + "description": "Cluster Storage Data.", + "type": "object", + "properties": { + "clusterTotalStorageMb": { + "format": "double", + "description": "Total storage on the cluster in MB.", + "type": "number" + }, + "clusterFreeStorageMb": { + "format": "double", + "description": "The available or free storage on the cluster in MB.", + "type": "number" + } + } + }, + "CniConfig": { + "description": "Cni configuration", + "type": "object", + "properties": { + "type": { + "description": "Cni type", + "type": "string", + "readOnly": true + }, + "version": { + "description": "Cni version", + "type": "string", + "readOnly": true + }, + "podSubnet": { + "description": "Pod Subnet", + "type": "string", + "readOnly": true + }, + "serviceSubnet": { + "description": "Service subnet", + "type": "string", + "readOnly": true + } + } + }, + "ComputeResource": { + "description": "Compute infrastructure Resource", + "required": [ + "processorCount", + "memoryInGB" + ], + "type": "object", + "properties": { + "processorCount": { + "format": "int32", + "description": "Processor count", + "type": "integer" + }, + "memoryInGB": { + "format": "int64", + "description": "Memory in GB", + "type": "integer" + } + } + }, + "ContactDetails": { + "description": "Contains all the contact details of the customer.", + "required": [ + "contactPerson", + "companyName", + "phone", + "emailList" + ], + "type": "object", + "properties": { + "contactPerson": { + "description": "The contact person name.", + "type": "string" + }, + "companyName": { + "description": "The name of the company.", + "type": "string" + }, + "phone": { + "description": "The phone number.", + "type": "string" + }, + "emailList": { + "description": "The email list.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "Container": { + "description": "Represents a container on the Data Box Edge/Gateway device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ContainerProperties", + "description": "The container properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of Container", + "readOnly": true + } + } + }, + "ContainerList": { + "description": "Collection of all the containers on the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "value": { + "description": "The list of containers.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ContainerProperties": { + "description": "The container properties.", + "required": [ + "dataFormat" + ], + "type": "object", + "properties": { + "containerStatus": { + "description": "Current status of the container.", + "enum": [ + "OK", + "Offline", + "Unknown", + "Updating", + "NeedsAttention" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ContainerStatus", + "modelAsString": true + } + }, + "dataFormat": { + "description": "DataFormat for Container", + "enum": [ + "BlockBlob", + "PageBlob", + "AzureFile" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureContainerDataFormat", + "modelAsString": true + } + }, + "refreshDetails": { + "$ref": "#/definitions/RefreshDetails", + "description": "Details of the refresh job on this container.", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "The UTC time when container got created.", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDevice": { + "description": "The Data Box Edge/Gateway device.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "location": { + "description": "The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU type." + }, + "etag": { + "description": "The etag for the devices.", + "type": "string" + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Msi identity of the resource" + }, + "kind": { + "description": "The kind of the device.", + "enum": [ + "AzureDataBoxGateway", + "AzureStackEdge", + "AzureStackHub", + "AzureModularDataCentre" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DataBoxEdgeDeviceKind", + "modelAsString": true + } + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "DataBoxEdge Resource", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/DataBoxEdgeDeviceProperties", + "description": "The properties of the Data Box Edge/Gateway device.", + "x-ms-client-flatten": true + } + } + }, + "DataBoxEdgeDeviceExtendedInfo": { + "description": "The extended Info of the Data Box Edge/Gateway device.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoProperties", + "description": "The extended info properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of DataBoxEdgeDevice", + "readOnly": true + } + } + }, + "DataBoxEdgeDeviceExtendedInfoPatch": { + "description": "The Data Box Edge/Gateway device extended info patch.", + "type": "object", + "properties": { + "clientSecretStoreId": { + "description": "The Key Vault ARM Id for client secrets", + "type": "string" + }, + "clientSecretStoreUrl": { + "description": "The url to access the Client Key Vault", + "type": "string" + }, + "channelIntegrityKeyName": { + "description": "The name for Channel Integrity Key stored in the Client Key Vault", + "type": "string" + }, + "channelIntegrityKeyVersion": { + "description": "The version of Channel Integrity Key stored in the Client Key Vault", + "type": "string" + }, + "syncStatus": { + "description": "For changing or to initiate the resync to key-vault set the status to KeyVaultSyncPending, rest of the status will not be applicable.", + "enum": [ + "KeyVaultSynced", + "KeyVaultSyncFailed", + "KeyVaultNotConfigured", + "KeyVaultSyncPending", + "KeyVaultSyncing", + "KeyVaultNotSynced" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyVaultSyncStatus", + "modelAsString": true + } + } + } + }, + "DataBoxEdgeDeviceExtendedInfoProperties": { + "description": "The properties of the Data Box Edge/Gateway device extended info.", + "type": "object", + "properties": { + "encryptionKeyThumbprint": { + "description": "The digital signature of encrypted certificate.", + "type": "string" + }, + "encryptionKey": { + "description": "The public part of the encryption certificate. Client uses this to encrypt any secret.", + "type": "string" + }, + "resourceKey": { + "description": "The Resource ID of the Resource.", + "type": "string", + "readOnly": true + }, + "clientSecretStoreId": { + "description": "The Key Vault ARM Id for client secrets", + "type": "string" + }, + "clientSecretStoreUrl": { + "description": "The url to access the Client Key Vault", + "type": "string" + }, + "channelIntegrityKeyName": { + "description": "The name of Channel Integrity Key stored in the Client Key Vault", + "type": "string" + }, + "channelIntegrityKeyVersion": { + "description": "The version of Channel Integrity Key stored in the Client Key Vault", + "type": "string" + }, + "keyVaultSyncStatus": { + "description": "Key vault sync status", + "enum": [ + "KeyVaultSynced", + "KeyVaultSyncFailed", + "KeyVaultNotConfigured", + "KeyVaultSyncPending", + "KeyVaultSyncing", + "KeyVaultNotSynced" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyVaultSyncStatus", + "modelAsString": true + } + }, + "deviceSecrets": { + "description": "Device secrets, will be returned only with ODataFilter $expand=deviceSecrets", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Secret" + }, + "readOnly": true + }, + "clusterWitnessType": { + "description": "Cluster Witness Type", + "enum": [ + "None", + "Cloud", + "FileShare" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ClusterWitnessType", + "modelAsString": true + } + }, + "fileShareWitnessLocation": { + "description": "The witness location of file share.", + "type": "string", + "readOnly": true + }, + "fileShareWitnessUsername": { + "description": "The username of file share.", + "type": "string", + "readOnly": true + }, + "cloudWitnessStorageAccountName": { + "description": "The Cloud Witness Storage account name.", + "type": "string", + "readOnly": true + }, + "cloudWitnessContainerName": { + "description": "The Container for cloud witness in the storage account.", + "type": "string", + "readOnly": true + }, + "cloudWitnessStorageEndpoint": { + "description": "The Azure service endpoint of the cloud witness storage account.", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDeviceList": { + "description": "The collection of Data Box Edge/Gateway devices.", + "type": "object", + "properties": { + "value": { + "description": "The list of Data Box Edge/Gateway devices.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxEdgeDevice" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDevicePatch": { + "description": "The Data Box Edge/Gateway device patch.", + "type": "object", + "properties": { + "tags": { + "description": "The tags attached to the Data Box Edge/Gateway resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Msi identity of the resource" + }, + "properties": { + "$ref": "#/definitions/DataBoxEdgeDevicePropertiesPatch", + "description": "The properties associated with the Data Box Edge/Gateway resource", + "x-ms-client-flatten": true + } + } + }, + "DataBoxEdgeDeviceProperties": { + "description": "The properties of the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "DataBoxEdge Device Properties", + "readOnly": true + }, + "dataBoxEdgeDeviceStatus": { + "description": "The status of the Data Box Edge/Gateway device.", + "enum": [ + "ReadyToSetup", + "Online", + "Offline", + "NeedsAttention", + "Disconnected", + "PartiallyDisconnected", + "Maintenance" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DataBoxEdgeDeviceStatus", + "modelAsString": true + } + }, + "serialNumber": { + "description": "The Serial Number of Data Box Edge/Gateway device.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The Description of the Data Box Edge/Gateway device.", + "type": "string", + "readOnly": true + }, + "modelDescription": { + "description": "The description of the Data Box Edge/Gateway device model.", + "type": "string", + "readOnly": true + }, + "deviceType": { + "description": "The type of the Data Box Edge/Gateway device.", + "enum": [ + "DataBoxEdgeDevice" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": true + } + }, + "friendlyName": { + "description": "The Data Box Edge/Gateway device name.", + "type": "string", + "readOnly": true + }, + "culture": { + "description": "The Data Box Edge/Gateway device culture.", + "type": "string", + "readOnly": true + }, + "deviceModel": { + "description": "The Data Box Edge/Gateway device model.", + "type": "string", + "readOnly": true + }, + "deviceSoftwareVersion": { + "description": "The Data Box Edge/Gateway device software version.", + "type": "string", + "readOnly": true + }, + "deviceLocalCapacity": { + "format": "int64", + "description": "The Data Box Edge/Gateway device local capacity in MB.", + "type": "integer", + "readOnly": true + }, + "timeZone": { + "description": "The Data Box Edge/Gateway device timezone.", + "type": "string", + "readOnly": true + }, + "deviceHcsVersion": { + "description": "The device software version number of the device (eg: 1.2.18105.6).", + "type": "string", + "readOnly": true + }, + "configuredRoleTypes": { + "description": "Type of compute roles configured.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "IOT", + "ASA", + "Functions", + "Cognitive", + "MEC", + "CloudEdgeManagement", + "Kubernetes" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + }, + "x-ms-identifiers": [] + }, + "readOnly": true + }, + "nodeCount": { + "format": "int32", + "description": "The number of nodes in the cluster.", + "type": "integer", + "readOnly": true + }, + "resourceMoveDetails": { + "$ref": "#/definitions/ResourceMoveDetails", + "description": "The details of the move operation on this resource.", + "readOnly": true + }, + "edgeProfile": { + "$ref": "#/definitions/EdgeProfile", + "description": "The details of Edge Profile for this resource", + "readOnly": true + }, + "dataResidency": { + "$ref": "#/definitions/DataResidency", + "description": "The details of data-residency related properties for this resource" + }, + "kubernetesWorkloadProfile": { + "description": "Kubernetes Workload Profile", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDevicePropertiesPatch": { + "description": "The Data Box Edge/Gateway device properties patch.", + "type": "object", + "properties": { + "edgeProfile": { + "$ref": "#/definitions/EdgeProfilePatch", + "description": "Edge Profile property of the Data Box Edge/Gateway device" + } + } + }, + "DataBoxEdgeMoveRequest": { + "description": "Resource Move details", + "required": [ + "targetResourceGroup", + "resources" + ], + "type": "object", + "properties": { + "targetResourceGroup": { + "description": "Target resource group ARMId", + "type": "string" + }, + "resources": { + "description": "List of resources to be moved", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "DataBoxEdgeSku": { + "description": "The Sku information.", + "type": "object", + "properties": { + "resourceType": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Sku name.", + "enum": [ + "Gateway", + "Edge", + "TEA_1Node", + "TEA_1Node_UPS", + "TEA_1Node_Heater", + "TEA_1Node_UPS_Heater", + "TEA_4Node_Heater", + "TEA_4Node_UPS_Heater", + "TMA", + "TDC", + "TCA_Small", + "GPU", + "TCA_Large", + "EdgeP_Base", + "EdgeP_High", + "EdgePR_Base", + "EdgePR_Base_UPS", + "EP2_64_1VPU_W", + "EP2_128_1T4_Mx1_W", + "EP2_256_2T4_W", + "EdgeMR_Mini", + "RCA_Small", + "RCA_Large", + "RDC", + "Management", + "EP2_64_Mx1_W", + "EP2_128_GPU1_Mx1_W", + "EP2_256_GPU2_Mx1", + "EdgeMR_TCP" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "kind": { + "description": "The Sku kind.", + "type": "string", + "readOnly": true + }, + "tier": { + "description": "The Sku tier.", + "enum": [ + "Standard" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + }, + "size": { + "description": "The Sku kind.", + "type": "string", + "readOnly": true + }, + "family": { + "description": "The Sku family.", + "type": "string", + "readOnly": true + }, + "locations": { + "description": "Availability of the Sku for the region.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "apiVersions": { + "description": "The API versions in which Sku is available.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "locationInfo": { + "description": "Availability of the Sku for the location/zone/site.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SkuLocationInfo" + }, + "x-ms-identifiers": [ + "location" + ], + "readOnly": true + }, + "costs": { + "description": "The pricing info of the Sku.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SkuCost" + }, + "x-ms-identifiers": [ + "meterId" + ], + "readOnly": true + }, + "signupOption": { + "description": "Sku can be signed up by customer or not.", + "enum": [ + "None", + "Available" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuSignupOption", + "modelAsString": true + } + }, + "version": { + "description": "Availability of the Sku as preview/stable.", + "enum": [ + "Stable", + "Preview" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuVersion", + "modelAsString": true + } + }, + "availability": { + "description": "Links to the next set of results", + "enum": [ + "Available", + "Unavailable" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuAvailability", + "modelAsString": true + } + }, + "shipmentTypes": { + "description": "List of Shipment Types supported by this SKU", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "NotApplicable", + "ShippedToCustomer", + "SelfPickup" + ], + "type": "string", + "x-ms-enum": { + "name": "ShipmentType", + "modelAsString": true + } + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "capabilities": { + "description": "The capability info of the SKU.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SkuCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + } + } + }, + "DataBoxEdgeSkuList": { + "description": "List of SKU Information objects.", + "type": "object", + "properties": { + "value": { + "description": "List of ResourceType Sku", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxEdgeSku" + }, + "x-ms-identifiers": [ + "name", + "resourceType" + ], + "readOnly": true + }, + "nextLink": { + "description": "Links to the next set of results", + "type": "string", + "readOnly": true + } + } + }, + "DataResidency": { + "description": "Wraps data-residency related information for edge-resource and this should be used with ARM layer.", + "type": "object", + "properties": { + "type": { + "description": "DataResidencyType enum", + "enum": [ + "GeoZoneReplication", + "ZoneReplication" + ], + "type": "string", + "x-ms-enum": { + "name": "DataResidencyType", + "modelAsString": true + } + } + } + }, + "DCAccessCode": { + "description": "DC Access code in the case of Self Managed Shipping.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DCAccessCodeProperties", + "description": "DCAccessCode properties.", + "x-ms-client-flatten": true + } + } + }, + "DCAccessCodeProperties": { + "description": "DCAccessCode Properties.", + "type": "object", + "properties": { + "authCode": { + "description": "DCAccess Code for the Self Managed shipment.", + "type": "string" + } + } + }, + "DeviceCapacityInfo": { + "description": "Object for Capturing DeviceCapacityInfo", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DeviceCapacityInfoProperties", + "description": "The device capacity properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to device capacity info.", + "readOnly": true + } + } + }, + "DeviceCapacityInfoProperties": { + "description": "The properties of Device Capacity Info", + "type": "object", + "properties": { + "timeStamp": { + "format": "date-time", + "description": "Timestamp of request in UTC", + "type": "string" + }, + "clusterStorageCapacityInfo": { + "$ref": "#/definitions/ClusterStorageViewData", + "description": "Cluster capacity data for storage resources (CSV)." + }, + "clusterComputeCapacityInfo": { + "$ref": "#/definitions/ClusterCapacityViewData", + "description": "Cluster capacity data for compute resources (Memory and GPU)." + }, + "nodeCapacityInfos": { + "description": "The dictionary of individual node names and node capacities in the cluster.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/HostCapacity" + } + } + } + }, + "DeviceCapacityRequestInfo": { + "description": "Object for Capturing DeviceCapacityRequestInfo", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DeviceCapacityRequestInfoProperties", + "description": "The properties of the Device Capacity Request.", + "x-ms-client-flatten": true + } + } + }, + "DeviceCapacityRequestInfoProperties": { + "description": "Properties of Device Capacity Request Info containing VM's to be checked and their corresponding results.", + "required": [ + "vmPlacementQuery" + ], + "type": "object", + "properties": { + "vmPlacementQuery": { + "description": "Array containing the sizes of the VMs for checking if its feasible to create them on the appliance.", + "uniqueItems": false, + "type": "array", + "items": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "x-ms-identifiers": [] + }, + "vmPlacementResults": { + "description": "Array of the VMs of the sizes in VmSizes can be provisioned on the appliance.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/VmPlacementRequestResult" + }, + "x-ms-identifiers": [] + } + } + }, + "DiagnosticProactiveLogCollectionSettings": { + "description": "The diagnostic proactive log collection settings of a device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProactiveLogCollectionSettingsProperties", + "description": "Properties of the diagnostic proactive log collection settings.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of DiagnosticProactiveLogCollectionSettings", + "readOnly": true + } + } + }, + "DiagnosticRemoteSupportSettings": { + "description": "The remote support settings of a device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DiagnosticRemoteSupportSettingsProperties", + "description": "Properties of the remote support settings.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Represents resource creation and updation time", + "readOnly": true + } + } + }, + "DiagnosticRemoteSupportSettingsProperties": { + "description": "The properties of remote support settings.", + "type": "object", + "properties": { + "remoteSupportSettingsList": { + "description": "Remote support settings list according to the RemoteApplicationType", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/RemoteSupportSettings" + }, + "x-ms-identifiers": [ + "remoteApplicationType" + ] + } + } + }, + "EdgeProfile": { + "description": "Details about Edge Profile for the resource", + "type": "object", + "properties": { + "subscription": { + "$ref": "#/definitions/EdgeProfileSubscription", + "description": "Edge Profile Subscription" + } + } + }, + "EdgeProfilePatch": { + "description": "The Data Box Edge/Gateway Edge Profile patch.", + "type": "object", + "properties": { + "subscription": { + "$ref": "#/definitions/EdgeProfileSubscriptionPatch", + "description": "The Data Box Edge/Gateway Edge Profile Subscription patch" + } + } + }, + "EdgeProfileSubscription": { + "description": "Subscription details for the Edge Profile", + "type": "object", + "properties": { + "registrationId": { + "description": "Edge Subscription Registration ID", + "type": "string" + }, + "id": { + "description": "ARM ID of the subscription", + "type": "string" + }, + "state": { + "enum": [ + "Registered", + "Warned", + "Suspended", + "Deleted", + "Unregistered" + ], + "type": "string", + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": true + } + }, + "registrationDate": { + "type": "string" + }, + "subscriptionId": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/SubscriptionProperties", + "x-ms-client-flatten": true + } + } + }, + "EdgeProfileSubscriptionPatch": { + "description": "The Data Box Edge/Gateway Edge Profile Subscription patch.", + "type": "object", + "properties": { + "id": { + "description": "The path ID that uniquely identifies the subscription of the edge profile.", + "type": "string" + } + } + }, + "EtcdInfo": { + "description": "Etcd configuration", + "type": "object", + "properties": { + "type": { + "description": "Etcd type", + "type": "string", + "readOnly": true + }, + "version": { + "description": "Etcd version", + "type": "string", + "readOnly": true + } + } + }, + "FileEventTrigger": { + "description": "Trigger details.", + "required": [ + "properties", + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FileTriggerProperties", + "description": "File trigger properties.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "FileEvent" + }, + "FileSourceInfo": { + "description": "File source details.", + "required": [ + "shareId" + ], + "type": "object", + "properties": { + "shareId": { + "description": "File share ID.", + "type": "string" + } + } + }, + "FileTriggerProperties": { + "description": "File trigger properties.", + "required": [ + "sourceInfo", + "sinkInfo" + ], + "type": "object", + "properties": { + "sourceInfo": { + "$ref": "#/definitions/FileSourceInfo", + "description": "File event source details." + }, + "sinkInfo": { + "$ref": "#/definitions/RoleSinkInfo", + "description": "Role sink info." + }, + "customContextTag": { + "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.", + "maxLength": 192, + "type": "string" + } + } + }, + "GenerateCertResponse": { + "description": "Used in activation key generation flow.", + "type": "object", + "properties": { + "publicKey": { + "description": "Gets or sets base64 encoded certificate raw data,\r\nthis is the public part needed to be uploaded to cert vault", + "type": "string" + }, + "privateKey": { + "description": "Gets or sets base64 encoded private part of the certificate,\r\nneeded to form the activation key", + "type": "string", + "x-ms-secret": true + }, + "expiryTimeInUTC": { + "description": "Gets or sets expiry time in UTC", + "type": "string" + } + } + }, + "HostCapacity": { + "description": "Host Capacity Data.", + "type": "object", + "properties": { + "hostName": { + "description": "The name of the host.", + "type": "string" + }, + "effectiveAvailableMemoryMbOnHost": { + "format": "int64", + "description": "The available memory on the host accounting for VM placement size and any host VM reservations.", + "type": "integer" + }, + "availableGpuCount": { + "format": "int32", + "description": "The available amount of GPUs on the host to use after accounting for GPUS used by reservations on the host.", + "type": "integer" + }, + "vmUsedMemory": { + "description": "The VM used memory per VmId.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/VmMemory" + } + }, + "gpuType": { + "description": "The GPU type of the VM.", + "type": "string" + }, + "numaNodesData": { + "description": "The numa nodes information for Hpn VMs.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/NumaNodeData" + }, + "x-ms-identifiers": [] + } + } + }, + "ImageRepositoryCredential": { + "description": "Image repository credential.", + "required": [ + "imageRepositoryUrl", + "userName" + ], + "type": "object", + "properties": { + "imageRepositoryUrl": { + "description": "Image repository url (e.g.: mcr.microsoft.com).", + "type": "string" + }, + "userName": { + "description": "Repository user name.", + "type": "string" + }, + "password": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Repository user password." + } + } + }, + "IoTAddon": { + "description": "IoT Addon.", + "required": [ + "properties", + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Addon" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/IoTAddonProperties", + "description": "Properties specific to IOT addon.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "IotEdge" + }, + "IoTAddonProperties": { + "description": "IoT addon properties.", + "required": [ + "ioTDeviceDetails", + "ioTEdgeDeviceDetails" + ], + "type": "object", + "properties": { + "ioTDeviceDetails": { + "$ref": "#/definitions/IoTDeviceInfo", + "description": "IoT device metadata to which appliance needs to be connected." + }, + "ioTEdgeDeviceDetails": { + "$ref": "#/definitions/IoTDeviceInfo", + "description": "IoT edge device to which the IoT Addon needs to be configured." + }, + "version": { + "description": "Version of IoT running on the appliance.", + "type": "string", + "readOnly": true + }, + "hostPlatform": { + "description": "Host OS supported by the IoT addon.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PlatformType", + "modelAsString": true + } + }, + "hostPlatformType": { + "description": "Platform where the runtime is hosted.", + "enum": [ + "KubernetesCluster", + "LinuxVM" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HostPlatformType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Addon Provisioning State", + "enum": [ + "Invalid", + "Creating", + "Created", + "Updating", + "Reconfiguring", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AddonState", + "modelAsString": true + } + } + } + }, + "IoTDeviceInfo": { + "description": "Metadata of IoT device/IoT Edge device to be configured.", + "required": [ + "deviceId", + "ioTHostHub" + ], + "type": "object", + "properties": { + "deviceId": { + "description": "ID of the IoT device/edge device.", + "type": "string" + }, + "ioTHostHub": { + "description": "Host name for the IoT hub associated to the device.", + "type": "string" + }, + "ioTHostHubId": { + "description": "Id for the IoT hub associated to the device.", + "type": "string" + }, + "authentication": { + "$ref": "#/definitions/Authentication", + "description": "Encrypted IoT device/IoT edge device connection string." + } + } + }, + "IoTEdgeAgentInfo": { + "description": "IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified.", + "required": [ + "imageName", + "tag" + ], + "type": "object", + "properties": { + "imageName": { + "description": "Name of the IoT edge agent image.", + "type": "string" + }, + "tag": { + "description": "Image Tag.", + "type": "string" + }, + "imageRepository": { + "$ref": "#/definitions/ImageRepositoryCredential", + "description": "Image repository details." + } + } + }, + "IoTRole": { + "description": "Compute role.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/IoTRoleProperties", + "description": "Properties specific to IoT role.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "IOT" + }, + "IoTRoleProperties": { + "description": "IoT role properties.", + "required": [ + "hostPlatform", + "ioTDeviceDetails", + "ioTEdgeDeviceDetails", + "roleStatus" + ], + "type": "object", + "properties": { + "hostPlatform": { + "description": "Host OS supported by the IoT role.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "x-ms-enum": { + "name": "PlatformType", + "modelAsString": true + } + }, + "ioTDeviceDetails": { + "$ref": "#/definitions/IoTDeviceInfo", + "description": "IoT device metadata to which data box edge device needs to be connected." + }, + "ioTEdgeDeviceDetails": { + "$ref": "#/definitions/IoTDeviceInfo", + "description": "IoT edge device to which the IoT role needs to be configured." + }, + "shareMappings": { + "description": "Mount points of shares in role(s).", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MountPointMap" + }, + "x-ms-identifiers": [ + "shareId" + ] + }, + "ioTEdgeAgentInfo": { + "$ref": "#/definitions/IoTEdgeAgentInfo", + "description": "Iot edge agent details to download the agent and bootstrap iot runtime." + }, + "hostPlatformType": { + "description": "Platform where the Iot runtime is hosted.", + "enum": [ + "KubernetesCluster", + "LinuxVM" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HostPlatformType", + "modelAsString": true + } + }, + "computeResource": { + "$ref": "#/definitions/ComputeResource", + "description": "Resource allocation" + }, + "roleStatus": { + "description": "Role status.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + } + } + }, + "Ipv4Config": { + "description": "Details related to the IPv4 address configuration.", + "type": "object", + "properties": { + "ipAddress": { + "description": "The IPv4 address of the network adapter.", + "type": "string", + "readOnly": true + }, + "subnet": { + "description": "The IPv4 subnet of the network adapter.", + "type": "string", + "readOnly": true + }, + "gateway": { + "description": "The IPv4 gateway of the network adapter.", + "type": "string", + "readOnly": true + } + } + }, + "Ipv6Config": { + "description": "Details related to the IPv6 address configuration.", + "type": "object", + "properties": { + "ipAddress": { + "description": "The IPv6 address of the network adapter.", + "type": "string", + "readOnly": true + }, + "prefixLength": { + "format": "int32", + "description": "The IPv6 prefix of the network adapter.", + "type": "integer", + "readOnly": true + }, + "gateway": { + "description": "The IPv6 gateway of the network adapter.", + "type": "string", + "readOnly": true + } + } + }, + "Job": { + "description": "A device job.", + "type": "object", + "properties": { + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The current status of the job.", + "enum": [ + "Invalid", + "Running", + "Succeeded", + "Failed", + "Canceled", + "Paused", + "Scheduled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "startTime": { + "format": "date-time", + "description": "The UTC date and time at which the job started.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "The UTC date and time at which the job completed.", + "type": "string", + "readOnly": true + }, + "percentComplete": { + "format": "int32", + "description": "The percentage of the job that is complete.", + "type": "integer", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/JobErrorDetails", + "description": "The error details.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The properties of the job.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "JobErrorDetails": { + "description": "The job error information containing the list of job errors.", + "type": "object", + "properties": { + "errorDetails": { + "description": "The error details.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorItem" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "code": { + "description": "The code intended for programmatic access.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message that describes the error in detail.", + "type": "string", + "readOnly": true + } + } + }, + "JobErrorItem": { + "description": "The job error items.", + "type": "object", + "properties": { + "recommendations": { + "description": "The recommended actions.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "code": { + "description": "The code intended for programmatic access.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message that describes the error in detail.", + "type": "string", + "readOnly": true + } + } + }, + "JobProperties": { + "description": "The properties for the job.", + "type": "object", + "properties": { + "jobType": { + "description": "The type of the job.", + "enum": [ + "Invalid", + "ScanForUpdates", + "DownloadUpdates", + "InstallUpdates", + "RefreshShare", + "RefreshContainer", + "Backup", + "Restore", + "TriggerSupportPackage" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "currentStage": { + "description": "Current stage of the update operation.", + "enum": [ + "Unknown", + "Initial", + "ScanStarted", + "ScanComplete", + "ScanFailed", + "DownloadStarted", + "DownloadComplete", + "DownloadFailed", + "InstallStarted", + "InstallComplete", + "InstallFailed", + "RebootInitiated", + "Success", + "Failure", + "RescanStarted", + "RescanComplete", + "RescanFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UpdateOperationStage", + "modelAsString": true + } + }, + "downloadProgress": { + "$ref": "#/definitions/UpdateDownloadProgress", + "description": "The download progress.", + "readOnly": true + }, + "installProgress": { + "$ref": "#/definitions/UpdateInstallProgress", + "description": "The install progress.", + "readOnly": true + }, + "totalRefreshErrors": { + "format": "int32", + "description": "Total number of errors encountered during the refresh process.", + "type": "integer", + "readOnly": true + }, + "errorManifestFile": { + "description": "Local share/remote container relative path to the error manifest file of the refresh.", + "type": "string", + "readOnly": true + }, + "refreshedEntityId": { + "description": "ARM ID of the entity that was refreshed.", + "type": "string", + "readOnly": true + }, + "folder": { + "description": "If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.)", + "type": "string" + } + } + }, + "KubernetesClusterInfo": { + "description": "Kubernetes cluster configuration", + "required": [ + "version" + ], + "type": "object", + "properties": { + "etcdInfo": { + "$ref": "#/definitions/EtcdInfo", + "description": "Etcd configuration", + "readOnly": true + }, + "nodes": { + "description": "Kubernetes cluster nodes", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/NodeInfo" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "readOnly": true + }, + "version": { + "description": "Kubernetes cluster version", + "type": "string" + } + } + }, + "KubernetesIPConfiguration": { + "description": "Kubernetes node IP configuration", + "type": "object", + "properties": { + "port": { + "description": "Port of the Kubernetes node.", + "type": "string", + "readOnly": true + }, + "ipAddress": { + "description": "IP address of the Kubernetes node.", + "type": "string" + } + } + }, + "KubernetesRole": { + "description": "The limited preview of Kubernetes Cluster Management from the Azure supports:\r\n1. Using a simple turn-key option in Azure Portal, deploy a Kubernetes cluster on your Azure Stack Edge device. \r\n2. Configure Kubernetes cluster running on your device with Arc enabled Kubernetes with a click of a button in the Azure Portal. \r\n Azure Arc enables organizations to view, manage, and govern their on-premises Kubernetes clusters using the Azure Portal, command line tools, and APIs.\r\n3. Easily configure Persistent Volumes using SMB and NFS shares for storing container data. \r\n For more information, refer to the document here: https://databoxupdatepackages.blob.core.windows.net/documentation/Microsoft-Azure-Stack-Edge-K8-Cloud-Management-20210323.pdf \r\n Or Demo: https://databoxupdatepackages.blob.core.windows.net/documentation/Microsoft-Azure-Stack-Edge-K8S-Cloud-Management-20210323.mp4\r\n By using this feature, you agree to the preview legal terms. See the https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/KubernetesRoleProperties", + "description": "Properties specific to Kubernetes role.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "Kubernetes" + }, + "KubernetesRoleCompute": { + "description": "Kubernetes role compute resource", + "required": [ + "vmProfile" + ], + "type": "object", + "properties": { + "vmProfile": { + "description": "VM profile", + "type": "string" + }, + "memoryInBytes": { + "format": "int64", + "description": "Memory in bytes", + "type": "integer", + "readOnly": true + }, + "processorCount": { + "format": "int32", + "description": "Processor count", + "type": "integer", + "readOnly": true + } + } + }, + "KubernetesRoleNetwork": { + "description": "Kubernetes role network resource", + "type": "object", + "properties": { + "cniConfig": { + "$ref": "#/definitions/CniConfig", + "description": "Cni configuration", + "readOnly": true + }, + "loadBalancerConfig": { + "$ref": "#/definitions/LoadBalancerConfig", + "description": "Load balancer configuration", + "readOnly": true + } + } + }, + "KubernetesRoleProperties": { + "description": "Kubernetes role properties.", + "required": [ + "hostPlatform", + "kubernetesClusterInfo", + "kubernetesRoleResources", + "roleStatus" + ], + "type": "object", + "properties": { + "hostPlatform": { + "description": "Host OS supported by the Kubernetes role.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "x-ms-enum": { + "name": "PlatformType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "State of Kubernetes deployment", + "enum": [ + "Invalid", + "Creating", + "Created", + "Updating", + "Reconfiguring", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "KubernetesState", + "modelAsString": true + } + }, + "hostPlatformType": { + "description": "Platform where the runtime is hosted.", + "enum": [ + "KubernetesCluster", + "LinuxVM" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HostPlatformType", + "modelAsString": true + } + }, + "kubernetesClusterInfo": { + "$ref": "#/definitions/KubernetesClusterInfo", + "description": "Kubernetes cluster configuration" + }, + "kubernetesRoleResources": { + "$ref": "#/definitions/KubernetesRoleResources", + "description": "Kubernetes role resources" + }, + "roleStatus": { + "description": "Role status.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + } + } + }, + "KubernetesRoleResources": { + "description": "Kubernetes role resources", + "required": [ + "compute" + ], + "type": "object", + "properties": { + "storage": { + "$ref": "#/definitions/KubernetesRoleStorage", + "description": "Kubernetes role storage resource" + }, + "compute": { + "$ref": "#/definitions/KubernetesRoleCompute", + "description": "Kubernetes role compute resource" + }, + "network": { + "$ref": "#/definitions/KubernetesRoleNetwork", + "description": "Kubernetes role network resource", + "readOnly": true + } + } + }, + "KubernetesRoleStorage": { + "description": "Kubernetes role storage resource", + "type": "object", + "properties": { + "storageClasses": { + "description": "Kubernetes storage class info.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesRoleStorageClassInfo" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "readOnly": true + }, + "endpoints": { + "description": "Mount points of shares in role(s).", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MountPointMap" + }, + "x-ms-identifiers": [ + "shareId" + ] + } + } + }, + "KubernetesRoleStorageClassInfo": { + "description": "Kubernetes storage class info.", + "type": "object", + "properties": { + "name": { + "description": "Storage class name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Storage class type.", + "type": "string", + "readOnly": true + }, + "posixCompliant": { + "description": "If provisioned storage is posix compliant.", + "enum": [ + "Invalid", + "Enabled", + "Disabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PosixComplianceStatus", + "modelAsString": true + } + } + } + }, + "LoadBalancerConfig": { + "description": "Load balancer configuration", + "type": "object", + "properties": { + "type": { + "description": "Load balancer type", + "type": "string", + "readOnly": true + }, + "version": { + "description": "Load balancer version", + "type": "string", + "readOnly": true + }, + "ipRange": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Load balancer ipconfig" + } + } + }, + "MECRole": { + "description": "MEC role.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MECRoleProperties", + "description": "Properties specific to MEC role.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "MEC" + }, + "MECRoleProperties": { + "description": "MEC role properties.", + "required": [ + "roleStatus" + ], + "type": "object", + "properties": { + "connectionString": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Activation key of the MEC." + }, + "controllerEndpoint": { + "description": "Controller Endpoint.", + "type": "string" + }, + "resourceUniqueId": { + "description": "Unique Id of the Resource.", + "type": "string" + }, + "roleStatus": { + "description": "Role status.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + } + } + }, + "MetricConfiguration": { + "description": "Metric configuration.", + "required": [ + "resourceId", + "counterSets" + ], + "type": "object", + "properties": { + "resourceId": { + "description": "The Resource ID on which the metrics should be pushed.", + "type": "string" + }, + "mdmAccount": { + "description": "The MDM account to which the counters should be pushed.", + "type": "string" + }, + "metricNameSpace": { + "description": "The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified", + "type": "string" + }, + "counterSets": { + "description": "Host name for the IoT hub associated to the device.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricCounterSet" + }, + "x-ms-identifiers": [] + } + } + }, + "MetricCounter": { + "description": "The metric counter", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The counter name.", + "type": "string" + }, + "instance": { + "description": "The instance from which counter should be collected.", + "type": "string" + }, + "dimensionFilter": { + "description": "The dimension filter.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "x-ms-identifiers": [ + "sourceName" + ] + }, + "additionalDimensions": { + "description": "The additional dimensions to be added to metric.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "x-ms-identifiers": [ + "sourceName" + ] + } + } + }, + "MetricCounterSet": { + "description": "The metric counter set", + "required": [ + "counters" + ], + "type": "object", + "properties": { + "counters": { + "description": "The counters that should be collected in this set.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricCounter" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "MetricDimension": { + "description": "The metric dimension", + "required": [ + "sourceType", + "sourceName" + ], + "type": "object", + "properties": { + "sourceType": { + "description": "The dimension type.", + "type": "string" + }, + "sourceName": { + "description": "The dimension value.", + "type": "string" + } + } + }, + "MetricDimension_V1": { + "description": "Metric Dimension v1.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metrics dimension.", + "type": "string" + }, + "displayName": { + "description": "Display name of the metrics dimension.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "To be exported to shoe box.", + "type": "boolean" + } + } + }, + "MetricSpecification_V1": { + "description": "Metric specification version 1.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Description of the metric to be displayed.", + "type": "string" + }, + "unit": { + "description": "Metric units.", + "enum": [ + "NotSpecified", + "Percent", + "Count", + "Seconds", + "Milliseconds", + "Bytes", + "BytesPerSecond", + "CountPerSecond" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true + } + }, + "aggregationType": { + "description": "Metric aggregation type.", + "enum": [ + "NotSpecified", + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + }, + "dimensions": { + "description": "Metric dimensions, other than default dimension which is resource.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension_V1" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "fillGapWithZero": { + "description": "Set true to fill the gaps with zero.", + "type": "boolean" + }, + "category": { + "description": "Metric category.", + "enum": [ + "Capacity", + "Transaction" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricCategory", + "modelAsString": true + } + }, + "resourceIdDimensionNameOverride": { + "description": "Resource name override.", + "type": "string" + }, + "supportedTimeGrainTypes": { + "description": "Support granularity of metrics.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "PT1M", + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "PT1D" + ], + "type": "string", + "x-ms-enum": { + "name": "TimeGrain", + "modelAsString": true + } + } + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "NotSpecified", + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + } + } + }, + "MonitoringMetricConfiguration": { + "description": "The metric setting details for the role", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MonitoringMetricConfigurationProperties", + "description": "The metric setting properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of MonitoringConfiguration", + "readOnly": true + } + } + }, + "MonitoringMetricConfigurationList": { + "description": "Collection of metric configurations.", + "type": "object", + "properties": { + "value": { + "description": "The list of metric configurations.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MonitoringMetricConfiguration" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "MonitoringMetricConfigurationProperties": { + "description": "Metrics properties", + "required": [ + "metricConfigurations" + ], + "type": "object", + "properties": { + "metricConfigurations": { + "description": "The metrics configuration details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "MountPointMap": { + "description": "The share mount point.", + "required": [ + "shareId" + ], + "type": "object", + "properties": { + "shareId": { + "description": "ID of the share mounted to the role VM.", + "type": "string" + }, + "roleId": { + "description": "ID of the role to which share is mounted.", + "type": "string", + "readOnly": true + }, + "mountPoint": { + "description": "Mount point for the share.", + "type": "string", + "readOnly": true + }, + "mountType": { + "description": "Mounting type.", + "enum": [ + "Volume", + "HostPath" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MountType", + "modelAsString": true + } + }, + "roleType": { + "description": "Role type.", + "enum": [ + "IOT", + "ASA", + "Functions", + "Cognitive", + "MEC", + "CloudEdgeManagement", + "Kubernetes" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + } + } + }, + "NetworkAdapter": { + "description": "Represents the networkAdapter on a device.", + "type": "object", + "properties": { + "adapterId": { + "description": "Instance ID of network adapter.", + "type": "string", + "readOnly": true + }, + "adapterPosition": { + "$ref": "#/definitions/NetworkAdapterPosition", + "description": "Hardware position of network adapter.", + "readOnly": true + }, + "index": { + "format": "int32", + "description": "Logical index of the adapter.", + "type": "integer", + "readOnly": true + }, + "nodeId": { + "description": "Node ID of the network adapter.", + "type": "string", + "readOnly": true + }, + "networkAdapterName": { + "description": "Network adapter name.", + "type": "string", + "readOnly": true + }, + "label": { + "description": "Hardware label for the adapter.", + "type": "string", + "readOnly": true + }, + "macAddress": { + "description": "MAC address.", + "type": "string", + "readOnly": true + }, + "linkSpeed": { + "format": "int64", + "description": "Link speed.", + "type": "integer", + "readOnly": true + }, + "status": { + "description": "Value indicating whether this adapter is valid.", + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NetworkAdapterStatus", + "modelAsString": true + } + }, + "rdmaStatus": { + "description": "Value indicating whether this adapter is RDMA capable.", + "enum": [ + "Incapable", + "Capable" + ], + "type": "string", + "x-ms-enum": { + "name": "NetworkAdapterRDMAStatus", + "modelAsString": true + } + }, + "dhcpStatus": { + "description": "Value indicating whether this adapter has DHCP enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "NetworkAdapterDHCPStatus", + "modelAsString": true + } + }, + "ipv4Configuration": { + "$ref": "#/definitions/Ipv4Config", + "description": "The IPv4 configuration of the network adapter.", + "readOnly": true + }, + "ipv6Configuration": { + "$ref": "#/definitions/Ipv6Config", + "description": "The IPv6 configuration of the network adapter.", + "readOnly": true + }, + "ipv6LinkLocalAddress": { + "description": "The IPv6 local address.", + "type": "string", + "readOnly": true + }, + "dnsServers": { + "description": "The list of DNS Servers of the device.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "NetworkAdapterPosition": { + "description": "The network adapter position.", + "type": "object", + "properties": { + "networkGroup": { + "description": "The network group.", + "enum": [ + "None", + "NonRDMA", + "RDMA" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NetworkGroup", + "modelAsString": true + } + }, + "port": { + "format": "int32", + "description": "The port.", + "type": "integer", + "readOnly": true + } + } + }, + "NetworkSettings": { + "description": "The network settings of a device.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSettingsProperties", + "description": "The properties of network settings of a device.", + "readOnly": true, + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of NetworkSettings", + "readOnly": true + } + } + }, + "NetworkSettingsProperties": { + "description": "The properties of network settings.", + "type": "object", + "properties": { + "networkAdapters": { + "description": "The network adapter list on the device.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/NetworkAdapter" + }, + "x-ms-identifiers": [ + "adapterId" + ], + "readOnly": true + } + } + }, + "Node": { + "description": "Represents a single node in a Data box Edge/Gateway device\r\nGateway devices, standalone Edge devices and a single node cluster Edge device will all have 1 node\r\nMulti-node Edge devices will have more than 1 nodes", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NodeProperties", + "description": "The properties of the node", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "NodeInfo": { + "description": "Kubernetes node info", + "type": "object", + "properties": { + "name": { + "description": "Node name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Node type - Master/Worker", + "enum": [ + "Invalid", + "Master", + "Worker" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "KubernetesNodeType", + "modelAsString": true + } + }, + "ipConfiguration": { + "description": "IP Configuration of the Kubernetes node.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesIPConfiguration" + }, + "x-ms-identifiers": [ + "ipAddress", + "port" + ] + } + } + }, + "NodeList": { + "description": "Collection of Nodes.", + "type": "object", + "properties": { + "value": { + "description": "The list of Nodes.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Node" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "NodeProperties": { + "description": "This class represents the nodes in a highly available cluster", + "type": "object", + "properties": { + "nodeStatus": { + "description": "The current status of the individual node", + "enum": [ + "Unknown", + "Up", + "Down", + "Rebooting", + "ShuttingDown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NodeStatus", + "modelAsString": true + } + }, + "nodeChassisSerialNumber": { + "description": "Serial number of the Chassis", + "type": "string", + "readOnly": true + }, + "nodeSerialNumber": { + "description": "Serial number of the individual node", + "type": "string", + "readOnly": true + }, + "nodeDisplayName": { + "description": "Display Name of the individual node", + "type": "string", + "readOnly": true + }, + "nodeFriendlySoftwareVersion": { + "description": "Friendly software version name that is currently installed on the node", + "type": "string", + "readOnly": true + }, + "nodeHcsVersion": { + "description": "HCS version that is currently installed on the node", + "type": "string", + "readOnly": true + }, + "nodeInstanceId": { + "description": "Guid instance id of the node", + "type": "string", + "readOnly": true + } + } + }, + "NumaNodeData": { + "description": "NUMA node data.", + "type": "object", + "properties": { + "numaNodeIndex": { + "format": "int32", + "description": "The NUMA node index.", + "type": "integer" + }, + "totalMemoryInMb": { + "format": "int64", + "description": "The total memory on the NUMA node.", + "type": "integer" + }, + "logicalCoreCountPerCore": { + "format": "int32", + "description": "The logical cores per core count.", + "type": "integer" + }, + "effectiveAvailableMemoryInMb": { + "format": "int64", + "description": "The effective available memory on the NUMA node in MB.", + "type": "integer" + }, + "freeVCpuIndexesForHpn": { + "description": "The free VCPU indices for the Hpn VMs.", + "uniqueItems": false, + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "vCpuIndexesForHpn": { + "description": "The VCPU indices for Hpn VMs", + "uniqueItems": false, + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "vCpuIndexesForRoot": { + "description": "The VCPU indices for the root.", + "uniqueItems": false, + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + } + } + }, + "Operation": { + "description": "Operations.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation.", + "type": "string" + }, + "isDataAction": { + "description": "Is data action.", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Properties displayed for the operation." + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Operation properties.", + "x-ms-client-flatten": true + } + } + }, + "OperationDisplay": { + "description": "Operation display properties.", + "type": "object", + "properties": { + "provider": { + "description": "Provider name.", + "type": "string" + }, + "resource": { + "description": "The type of resource in which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation to be performed on the resource.", + "type": "string" + }, + "description": { + "description": "Description of the operation to be performed.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "Service specification." + } + } + }, + "OperationsList": { + "description": "The list of operations used for the discovery of available provider operations.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "The value.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string" + } + } + }, + "Order": { + "description": "The order details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "kind": { + "description": "It specify the order api version.", + "type": "string", + "readOnly": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of Order", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OrderProperties", + "description": "The order properties.", + "x-ms-client-flatten": true + } + } + }, + "OrderList": { + "description": "List of order entities.", + "type": "object", + "properties": { + "value": { + "description": "The list of orders.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Order" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "OrderProperties": { + "description": "Order properties.", + "type": "object", + "required": [ + "contactInformation" + ], + "properties": { + "orderId": { + "description": "It specify the order resource id.", + "type": "string", + "readOnly": true + }, + "contactInformation": { + "$ref": "#/definitions/ContactDetails", + "description": "The contact details." + }, + "shippingAddress": { + "$ref": "#/definitions/Address", + "description": "The shipping address." + }, + "currentStatus": { + "$ref": "#/definitions/OrderStatus", + "description": "Current status of the order.", + "readOnly": true + }, + "orderHistory": { + "description": "List of status changes in the order.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OrderStatus" + }, + "x-ms-identifiers": [ + "trackingInformation/serialNumber" + ], + "readOnly": true + }, + "serialNumber": { + "description": "Serial number of the device.", + "type": "string", + "readOnly": true + }, + "deliveryTrackingInfo": { + "description": "Tracking information for the package delivered to the customer whether it has an original or a replacement device.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/TrackingInfo" + }, + "x-ms-identifiers": [ + "serialNumber" + ], + "readOnly": true + }, + "returnTrackingInfo": { + "description": "Tracking information for the package returned from the customer whether it has an original or a replacement device.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/TrackingInfo" + }, + "x-ms-identifiers": [ + "serialNumber" + ], + "readOnly": true + }, + "shipmentType": { + "description": "ShipmentType of the order", + "enum": [ + "NotApplicable", + "ShippedToCustomer", + "SelfPickup" + ], + "type": "string", + "x-ms-enum": { + "name": "ShipmentType", + "modelAsString": true + } + } + } + }, + "OrderStatus": { + "description": "Represents a single status change.", + "required": [ + "status" + ], + "type": "object", + "properties": { + "status": { + "description": "Status of the order as per the allowed status types.", + "enum": [ + "Untracked", + "AwaitingFulfillment", + "AwaitingPreparation", + "AwaitingShipment", + "Shipped", + "Arriving", + "Delivered", + "ReplacementRequested", + "LostDevice", + "Declined", + "ReturnInitiated", + "AwaitingReturnShipment", + "ShippedBack", + "CollectedAtMicrosoft", + "AwaitingPickup", + "PickupCompleted", + "AwaitingDrop" + ], + "type": "string", + "x-ms-enum": { + "name": "OrderState", + "modelAsString": true + } + }, + "updateDateTime": { + "format": "date-time", + "description": "Time of status update.", + "type": "string", + "readOnly": true + }, + "comments": { + "description": "Comments related to this status change.", + "type": "string" + }, + "trackingInformation": { + "$ref": "#/definitions/TrackingInfo", + "description": "Tracking information related to the state in the ordering flow", + "readOnly": true + }, + "additionalOrderDetails": { + "description": "Dictionary to hold generic information which is not stored\r\nby the already existing properties", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PeriodicTimerEventTrigger": { + "description": "Trigger details.", + "required": [ + "properties", + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PeriodicTimerProperties", + "description": "Periodic timer trigger properties.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "PeriodicTimerEvent" + }, + "PeriodicTimerProperties": { + "description": "Periodic timer trigger properties.", + "required": [ + "sourceInfo", + "sinkInfo" + ], + "type": "object", + "properties": { + "sourceInfo": { + "$ref": "#/definitions/PeriodicTimerSourceInfo", + "description": "Periodic timer details." + }, + "sinkInfo": { + "$ref": "#/definitions/RoleSinkInfo", + "description": "Role Sink information." + }, + "customContextTag": { + "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.", + "maxLength": 192, + "type": "string" + } + } + }, + "PeriodicTimerSourceInfo": { + "description": "Periodic timer event source.", + "required": [ + "startTime", + "schedule" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time.", + "type": "string" + }, + "schedule": { + "description": "Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds.", + "type": "string" + }, + "topic": { + "description": "Topic where periodic events are published to IoT device.", + "type": "string" + } + } + }, + "ProactiveLogCollectionSettingsProperties": { + "description": "The properties of proactive log collection settings.", + "required": [ + "userConsent" + ], + "type": "object", + "properties": { + "userConsent": { + "description": "Proactive diagnostic collection consent flag", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ProactiveDiagnosticsConsent", + "modelAsString": true + } + } + } + }, + "RawCertificateData": { + "description": "Raw Certificate Data.", + "required": [ + "certificate" + ], + "type": "object", + "properties": { + "authenticationType": { + "description": "The authentication type.", + "enum": [ + "Invalid", + "AzureActiveDirectory" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "certificate": { + "description": "The base64 encoded certificate raw data.", + "type": "string" + } + } + }, + "RefreshDetails": { + "description": "Fields for tracking refresh job on the share or container.", + "type": "object", + "properties": { + "inProgressRefreshJobId": { + "description": "If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.", + "type": "string" + }, + "lastCompletedRefreshJobTimeInUTC": { + "format": "date-time", + "description": "Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.", + "type": "string" + }, + "errorManifestFile": { + "description": "Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.", + "type": "string" + }, + "lastJob": { + "description": "Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.", + "type": "string" + } + } + }, + "RemoteSupportSettings": { + "description": "RemoteApplicationType for which remote support settings is being modified", + "type": "object", + "properties": { + "remoteApplicationType": { + "description": "Remote application type", + "enum": [ + "Powershell", + "WAC", + "LocalUI", + "AllApplications" + ], + "type": "string", + "x-ms-enum": { + "name": "RemoteApplicationType", + "modelAsString": true + } + }, + "accessLevel": { + "description": "Access level allowed for this remote application type", + "enum": [ + "None", + "ReadOnly", + "ReadWrite", + "FullAccess" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessLevel", + "modelAsString": true + } + }, + "expirationTimeStampInUTC": { + "format": "date-time", + "description": "Expiration time stamp", + "type": "string" + } + } + }, + "ResourceIdentity": { + "description": "Msi identity details of the resource", + "type": "object", + "properties": { + "type": { + "description": "Identity type", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "MsiIdentityType", + "modelAsString": true + } + }, + "principalId": { + "description": "Service Principal Id backing the Msi", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Home Tenant Id", + "type": "string", + "readOnly": true + } + } + }, + "ResourceMoveDetails": { + "description": "Fields for tracking resource move", + "type": "object", + "properties": { + "operationInProgress": { + "description": "Denotes whether move operation is in progress", + "enum": [ + "None", + "ResourceMoveInProgress", + "ResourceMoveFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceMoveStatus", + "modelAsString": true + } + }, + "operationInProgressLockTimeoutInUTC": { + "format": "date-time", + "description": "Denotes the timeout of the operation to finish", + "type": "string" + } + } + }, + "Role": { + "description": "Compute role.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "kind": { + "description": "Role type.", + "enum": [ + "IOT", + "ASA", + "Functions", + "Cognitive", + "MEC", + "CloudEdgeManagement", + "Kubernetes" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of Role", + "readOnly": true + } + }, + "discriminator": "kind" + }, + "RoleList": { + "description": "Collection of all the roles on the Data Box Edge device.", + "type": "object", + "properties": { + "value": { + "description": "The Value.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Role" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "RoleSinkInfo": { + "description": "Compute role against which events will be raised.", + "required": [ + "roleId" + ], + "type": "object", + "properties": { + "roleId": { + "description": "Compute role ID.", + "type": "string" + } + } + }, + "Secret": { + "description": "Holds device secret either as a KeyVault reference or as an encrypted value.", + "type": "object", + "properties": { + "encryptedSecret": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Encrypted (using device public key) secret value." + }, + "keyVaultId": { + "description": "Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).", + "type": "string" + } + } + }, + "SecuritySettings": { + "description": "The security settings of a device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecuritySettingsProperties", + "description": "Properties of the security settings.", + "x-ms-client-flatten": true + } + } + }, + "SecuritySettingsProperties": { + "description": "The properties of security settings.", + "required": [ + "deviceAdminPassword" + ], + "type": "object", + "properties": { + "deviceAdminPassword": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the local web UI of the device. The Actual password should have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters." + } + } + }, + "ServiceSpecification": { + "description": "Service specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Metric specification as defined by shoebox.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification_V1" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Share": { + "description": "Represents a share on the Data Box Edge/Gateway device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ShareProperties", + "description": "The share properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of Share", + "readOnly": true + } + } + }, + "ShareAccessRight": { + "description": "Specifies the mapping between this particular user and the type of access he has on shares on this device.", + "required": [ + "shareId", + "accessType" + ], + "type": "object", + "properties": { + "shareId": { + "description": "The share ID.", + "type": "string" + }, + "accessType": { + "description": "Type of access to be allowed on the share for this user.", + "enum": [ + "Change", + "Read", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessType", + "modelAsString": true + } + } + } + }, + "ShareList": { + "description": "Collection of all the shares on the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "value": { + "description": "The list of shares.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Share" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ShareProperties": { + "description": "The share properties.", + "required": [ + "shareStatus", + "monitoringStatus", + "accessProtocol" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the share.", + "type": "string" + }, + "shareStatus": { + "description": "Current status of the share.", + "enum": [ + "Offline", + "Unknown", + "OK", + "Updating", + "NeedsAttention" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareStatus", + "modelAsString": true + } + }, + "monitoringStatus": { + "description": "Current monitoring status of the share.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringStatus", + "modelAsString": true + } + }, + "azureContainerInfo": { + "$ref": "#/definitions/AzureContainerInfo", + "description": "Azure container mapping for the share." + }, + "accessProtocol": { + "description": "Access protocol to be used by the share.", + "enum": [ + "SMB", + "NFS" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessProtocol", + "modelAsString": true + } + }, + "userAccessRights": { + "description": "Mapping of users and corresponding access rights on the share (required for SMB protocol).", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/UserAccessRight" + }, + "x-ms-identifiers": [ + "userId" + ] + }, + "clientAccessRights": { + "description": "List of IP addresses and corresponding access rights on the share(required for NFS protocol).", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ClientAccessRight" + }, + "x-ms-identifiers": [ + "client" + ] + }, + "refreshDetails": { + "$ref": "#/definitions/RefreshDetails", + "description": "Details of the refresh job on this share." + }, + "shareMappings": { + "description": "Share mount point to the role.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MountPointMap" + }, + "x-ms-identifiers": [ + "shareId" + ], + "readOnly": true + }, + "dataPolicy": { + "description": "Data policy of the share.", + "enum": [ + "Cloud", + "Local" + ], + "type": "string", + "x-ms-enum": { + "name": "DataPolicy", + "modelAsString": true + } + } + } + }, + "Sku": { + "description": "The SKU type.", + "type": "object", + "properties": { + "name": { + "description": "SKU name.", + "enum": [ + "Gateway", + "Edge", + "TEA_1Node", + "TEA_1Node_UPS", + "TEA_1Node_Heater", + "TEA_1Node_UPS_Heater", + "TEA_4Node_Heater", + "TEA_4Node_UPS_Heater", + "TMA", + "TDC", + "TCA_Small", + "GPU", + "TCA_Large", + "EdgeP_Base", + "EdgeP_High", + "EdgePR_Base", + "EdgePR_Base_UPS", + "EP2_64_1VPU_W", + "EP2_128_1T4_Mx1_W", + "EP2_256_2T4_W", + "EdgeMR_Mini", + "RCA_Small", + "RCA_Large", + "RDC", + "Management", + "EP2_64_Mx1_W", + "EP2_128_GPU1_Mx1_W", + "EP2_256_GPU2_Mx1", + "EdgeMR_TCP" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "description": "The SKU tier. This is based on the SKU name.", + "enum": [ + "Standard" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + } + }, + "SkuCapability": { + "description": "The metadata to describe the capability.", + "type": "object", + "properties": { + "name": { + "description": "An invariant to describe the feature.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "An invariant if the feature is measured by quantity.", + "type": "string", + "readOnly": true + } + } + }, + "SkuCost": { + "description": "The metadata for retrieving price info.", + "type": "object", + "properties": { + "meterId": { + "description": "Used for querying price from commerce.", + "type": "string", + "readOnly": true + }, + "quantity": { + "format": "int64", + "description": "The cost quantity.", + "type": "integer", + "readOnly": true + }, + "extendedUnit": { + "description": "The extended unit.", + "type": "string", + "readOnly": true + } + } + }, + "SkuLocationInfo": { + "description": "The location info.", + "type": "object", + "properties": { + "location": { + "description": "The location.", + "type": "string", + "readOnly": true + }, + "zones": { + "description": "The zones.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sites": { + "description": "The sites.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "StorageAccount": { + "description": "Represents a Storage Account on the Data Box Edge/Gateway device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageAccountProperties", + "description": "The Storage Account properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of StorageAccount", + "readOnly": true + } + } + }, + "StorageAccountCredential": { + "description": "The storage account credential.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageAccountCredentialProperties", + "description": "The storage account credential properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of StorageAccountCredential", + "readOnly": true + } + } + }, + "StorageAccountCredentialList": { + "description": "The collection of storage account credentials.", + "type": "object", + "properties": { + "value": { + "description": "The value.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountCredential" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "StorageAccountCredentialProperties": { + "description": "The storage account credential properties.", + "required": [ + "alias", + "sslStatus", + "accountType" + ], + "type": "object", + "properties": { + "alias": { + "description": "Alias for the storage account.", + "type": "string" + }, + "userName": { + "description": "Username for the storage account.", + "type": "string" + }, + "accountKey": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Encrypted storage key." + }, + "connectionString": { + "description": "Connection string for the storage account. Use this string if username and account key are not specified.", + "type": "string" + }, + "sslStatus": { + "description": "Signifies whether SSL needs to be enabled or not.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SSLStatus", + "modelAsString": true + } + }, + "blobDomainName": { + "description": "Blob end point for private clouds.", + "type": "string" + }, + "accountType": { + "description": "Type of storage accessed on the storage account.", + "enum": [ + "GeneralPurposeStorage", + "BlobStorage" + ], + "type": "string", + "x-ms-enum": { + "name": "AccountType", + "modelAsString": true + } + }, + "storageAccountId": { + "description": "Id of the storage account.", + "type": "string" + } + } + }, + "StorageAccountList": { + "description": "Collection of all the Storage Accounts on the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "value": { + "description": "The list of storageAccounts.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "StorageAccountProperties": { + "description": "The storage account properties.", + "required": [ + "dataPolicy" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the storage Account.", + "type": "string" + }, + "storageAccountStatus": { + "description": "Current status of the storage account", + "enum": [ + "OK", + "Offline", + "Unknown", + "Updating", + "NeedsAttention" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageAccountStatus", + "modelAsString": true + } + }, + "dataPolicy": { + "description": "Data policy of the storage Account.", + "enum": [ + "Cloud", + "Local" + ], + "type": "string", + "x-ms-enum": { + "name": "DataPolicy", + "modelAsString": true + } + }, + "storageAccountCredentialId": { + "description": "Storage Account Credential Id", + "type": "string" + }, + "blobEndpoint": { + "description": "BlobEndpoint of Storage Account", + "type": "string", + "readOnly": true + }, + "containerCount": { + "format": "int32", + "description": "The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud.", + "type": "integer", + "readOnly": true + } + } + }, + "SubscriptionProperties": { + "type": "object", + "properties": { + "tenantId": { + "type": "string" + }, + "locationPlacementId": { + "type": "string" + }, + "quotaId": { + "type": "string" + }, + "serializedDetails": { + "type": "string" + }, + "registeredFeatures": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionRegisteredFeatures" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "SubscriptionRegisteredFeatures": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "state": { + "type": "string" + } + } + }, + "SupportPackageRequestProperties": { + "description": "The share properties.", + "type": "object", + "properties": { + "minimumTimeStamp": { + "format": "date-time", + "description": "MinimumTimeStamp from where logs need to be collected", + "type": "string" + }, + "maximumTimeStamp": { + "format": "date-time", + "description": "Start of the timespan of the log collection", + "type": "string" + }, + "include": { + "description": "Type of files, which need to be included in the logs\r\nThis will contain the type of logs (Default/DefaultWithDumps/None/All/DefaultWithArchived)\r\nor a comma separated list of log types that are required", + "type": "string" + } + } + }, + "SymmetricKey": { + "description": "Symmetric key for authentication.", + "type": "object", + "properties": { + "connectionString": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Connection string based on the symmetric key." + } + } + }, + "TrackingInfo": { + "description": "Tracking courier information.", + "type": "object", + "properties": { + "serialNumber": { + "description": "Serial number of the device being tracked.", + "type": "string" + }, + "carrierName": { + "description": "Name of the carrier used in the delivery.", + "type": "string" + }, + "trackingId": { + "description": "Tracking ID of the shipment.", + "type": "string" + }, + "trackingUrl": { + "description": "Tracking URL of the shipment.", + "type": "string" + } + } + }, + "Trigger": { + "description": "Trigger details.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "kind": { + "description": "Trigger Kind.", + "enum": [ + "FileEvent", + "PeriodicTimerEvent" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerEventType", + "modelAsString": true + } + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of Trigger", + "readOnly": true + } + }, + "discriminator": "kind" + }, + "TriggerList": { + "description": "Collection of all trigger on the data box edge device.", + "type": "object", + "properties": { + "value": { + "description": "The list of triggers.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Trigger" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "TriggerSupportPackageRequest": { + "description": "The request object for trigger support package.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SupportPackageRequestProperties", + "description": "The TriggerSupportPackageRequest properties.", + "x-ms-client-flatten": true + } + } + }, + "UpdateDetails": { + "description": "Update Specific attributes", + "type": "object", + "properties": { + "updateTitle": { + "description": "Title of the Update", + "type": "string" + }, + "updateSize": { + "format": "double", + "description": "Size of the update(In Bytes)", + "type": "number" + }, + "updateType": { + "description": "Type of the Update", + "enum": [ + "Software", + "Kubernetes", + "Firmware" + ], + "type": "string", + "x-ms-enum": { + "name": "UpdateType", + "modelAsString": true + } + }, + "targetVersion": { + "description": "Target Version number", + "type": "string" + }, + "friendlyVersionNumber": { + "description": "Friendly Version Number", + "type": "string" + }, + "estimatedInstallTimeInMins": { + "format": "int32", + "description": "Estimated Install Time for the update", + "type": "integer" + }, + "rebootBehavior": { + "description": "Indicates if updates are available and at least one of the updates needs a reboot.", + "enum": [ + "NeverReboots", + "RequiresReboot", + "RequestReboot" + ], + "type": "string", + "x-ms-enum": { + "name": "InstallRebootBehavior", + "modelAsString": true + } + }, + "installationImpact": { + "description": "Impact of Installing an updateType", + "enum": [ + "None", + "DeviceRebooted", + "KubernetesWorkloadsDown" + ], + "type": "string", + "x-ms-enum": { + "name": "InstallationImpact", + "modelAsString": true + } + }, + "status": { + "description": "Status of the update.", + "enum": [ + "DownloadPending", + "DownloadStarted", + "DownloadCompleted", + "InstallStarted", + "InstallCompleted" + ], + "type": "string", + "x-ms-enum": { + "name": "UpdateStatus", + "modelAsString": true + } + } + } + }, + "UpdateDownloadProgress": { + "description": "Details about the download progress of update.", + "type": "object", + "properties": { + "downloadPhase": { + "description": "The download phase.", + "enum": [ + "Unknown", + "Initializing", + "Downloading", + "Verifying" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DownloadPhase", + "modelAsString": true + } + }, + "percentComplete": { + "format": "int32", + "description": "Percentage of completion.", + "type": "integer", + "readOnly": true + }, + "totalBytesToDownload": { + "format": "double", + "description": "Total bytes to download.", + "type": "number", + "readOnly": true + }, + "totalBytesDownloaded": { + "format": "double", + "description": "Total bytes downloaded.", + "type": "number", + "readOnly": true + }, + "numberOfUpdatesToDownload": { + "format": "int32", + "description": "Number of updates to download.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesDownloaded": { + "format": "int32", + "description": "Number of updates downloaded.", + "type": "integer", + "readOnly": true + } + } + }, + "UpdateInstallProgress": { + "description": "Progress details during installation of updates.", + "type": "object", + "properties": { + "percentComplete": { + "format": "int32", + "description": "Percentage completed.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesToInstall": { + "format": "int32", + "description": "Number of updates to install.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesInstalled": { + "format": "int32", + "description": "Number of updates installed.", + "type": "integer", + "readOnly": true + } + } + }, + "UpdateSummary": { + "description": "Details about ongoing updates and availability of updates on the device.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/UpdateSummaryProperties", + "description": "The device update information summary.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of UpdateSummary", + "readOnly": true + } + } + }, + "UpdateSummaryProperties": { + "description": "The device update information summary.", + "type": "object", + "properties": { + "deviceVersionNumber": { + "description": "The current version of the device in format: 1.2.17312.13.\",", + "type": "string" + }, + "friendlyDeviceVersionName": { + "description": "The current version of the device in text format.", + "type": "string" + }, + "deviceLastScannedDateTime": { + "format": "date-time", + "description": "The last time when a scan was done on the device.", + "type": "string" + }, + "lastCompletedScanJobDateTime": { + "format": "date-time", + "description": "The time when the last scan job was completed (success/cancelled/failed) on the appliance.", + "type": "string" + }, + "lastSuccessfulScanJobTime": { + "format": "date-time", + "description": "Time when the last scan job is successfully completed.", + "type": "string" + }, + "lastCompletedDownloadJobDateTime": { + "format": "date-time", + "description": "The time when the last Download job was completed (success/cancelled/failed) on the appliance.", + "type": "string", + "readOnly": true + }, + "lastCompletedDownloadJobId": { + "description": "JobId of the last ran download job.(Can be success/cancelled/failed)", + "type": "string", + "readOnly": true + }, + "lastDownloadJobStatus": { + "description": "JobStatus of the last ran download job.", + "enum": [ + "Invalid", + "Running", + "Succeeded", + "Failed", + "Canceled", + "Paused", + "Scheduled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "lastSuccessfulInstallJobDateTime": { + "format": "date-time", + "description": "The time when the Last Install job was completed successfully on the appliance", + "type": "string" + }, + "lastCompletedInstallJobDateTime": { + "format": "date-time", + "description": "The time when the last Install job was completed (success/cancelled/failed) on the appliance.", + "type": "string", + "readOnly": true + }, + "lastCompletedInstallJobId": { + "description": "JobId of the last ran install job.(Can be success/cancelled/failed)", + "type": "string", + "readOnly": true + }, + "lastInstallJobStatus": { + "description": "JobStatus of the last ran install job.", + "enum": [ + "Invalid", + "Running", + "Succeeded", + "Failed", + "Canceled", + "Paused", + "Scheduled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "totalNumberOfUpdatesAvailable": { + "format": "int32", + "description": "The number of updates available for the current device version as per the last device scan.", + "type": "integer", + "readOnly": true + }, + "totalNumberOfUpdatesPendingDownload": { + "format": "int32", + "description": "The total number of items pending download.", + "type": "integer", + "readOnly": true + }, + "totalNumberOfUpdatesPendingInstall": { + "format": "int32", + "description": "The total number of items pending install.", + "type": "integer", + "readOnly": true + }, + "rebootBehavior": { + "description": "Indicates if updates are available and at least one of the updates needs a reboot.", + "enum": [ + "NeverReboots", + "RequiresReboot", + "RequestReboot" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "InstallRebootBehavior", + "modelAsString": true + } + }, + "ongoingUpdateOperation": { + "description": "The current update operation.", + "enum": [ + "None", + "Scan", + "Download", + "Install" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UpdateOperation", + "modelAsString": true + } + }, + "inProgressDownloadJobId": { + "description": "The job ID of the download job in progress.", + "type": "string", + "readOnly": true + }, + "inProgressInstallJobId": { + "description": "The job ID of the install job in progress.", + "type": "string", + "readOnly": true + }, + "inProgressDownloadJobStartedDateTime": { + "format": "date-time", + "description": "The time when the currently running download (if any) started.", + "type": "string", + "readOnly": true + }, + "inProgressInstallJobStartedDateTime": { + "format": "date-time", + "description": "The time when the currently running install (if any) started.", + "type": "string", + "readOnly": true + }, + "updateTitles": { + "description": "The list of updates available for install.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "updates": { + "description": "The list of updates available for install.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/UpdateDetails" + }, + "x-ms-identifiers": [ + "updateTitle" + ], + "readOnly": true + }, + "totalUpdateSizeInBytes": { + "format": "double", + "description": "The total size of updates available for download in bytes.", + "type": "number", + "readOnly": true + }, + "totalTimeInMinutes": { + "format": "int32", + "description": "The total time in Minutes", + "type": "integer", + "readOnly": true + } + } + }, + "UploadCertificateRequest": { + "description": "The upload certificate request.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RawCertificateData", + "description": "The Base 64 encoded certificate raw data.", + "x-ms-client-flatten": true + } + } + }, + "UploadCertificateResponse": { + "description": "The upload registration certificate response.", + "type": "object", + "properties": { + "authType": { + "description": "Specifies authentication type.", + "enum": [ + "Invalid", + "AzureActiveDirectory" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "resourceId": { + "description": "The resource ID of the Data Box Edge/Gateway device.", + "type": "string", + "readOnly": true + }, + "aadAuthority": { + "description": "Azure Active Directory tenant authority.", + "type": "string", + "readOnly": true + }, + "aadTenantId": { + "description": "Azure Active Directory tenant ID.", + "type": "string", + "readOnly": true + }, + "servicePrincipalClientId": { + "description": "Azure Active Directory service principal client ID.", + "type": "string", + "readOnly": true + }, + "servicePrincipalObjectId": { + "description": "Azure Active Directory service principal object ID.", + "type": "string", + "readOnly": true + }, + "azureManagementEndpointAudience": { + "description": "The azure management endpoint audience.", + "type": "string", + "readOnly": true + }, + "aadAudience": { + "description": "Identifier of the target resource that is the recipient of the requested token.", + "type": "string", + "readOnly": true + } + } + }, + "User": { + "description": "Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/UserProperties", + "description": "The storage account credential properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of User", + "readOnly": true + } + } + }, + "UserAccessRight": { + "description": "The mapping between a particular user and the access type on the SMB share.", + "required": [ + "userId", + "accessType" + ], + "type": "object", + "properties": { + "userId": { + "description": "User ID (already existing in the device).", + "type": "string" + }, + "accessType": { + "description": "Type of access to be allowed for the user.", + "enum": [ + "Change", + "Read", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessType", + "modelAsString": true + } + } + } + }, + "UserList": { + "description": "Collection of users.", + "type": "object", + "properties": { + "value": { + "description": "The list of users.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/User" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UserProperties": { + "description": "The user properties.", + "required": [ + "userType" + ], + "type": "object", + "properties": { + "encryptedPassword": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "The password details." + }, + "shareAccessRights": { + "description": "List of shares that the user has rights on. This field should not be specified during user creation.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ShareAccessRight" + }, + "x-ms-identifiers": [ + "shareId" + ], + "readOnly": true + }, + "userType": { + "description": "Type of the user.", + "enum": [ + "Share", + "LocalManagement", + "ARM" + ], + "type": "string", + "x-ms-enum": { + "name": "UserType", + "modelAsString": true + } + } + } + }, + "VmMemory": { + "description": "VmMemory Data.", + "type": "object", + "properties": { + "startupMemoryMB": { + "format": "int64", + "description": "The total amount of RAM in the virtual machine, as seen by the guest operating system. For a virtual machine with dynamic memory enabled, this represents the initial memory available at startup.", + "type": "integer" + }, + "currentMemoryUsageMB": { + "format": "int64", + "description": "The current memory used by the virtual machine.", + "type": "integer" + } + } + }, + "VmPlacementRequestResult": { + "description": "List of VM sizes being checked for creation on appliance along with corresponding result.", + "type": "object", + "properties": { + "vmSize": { + "description": "List of VM sizes being checked.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "isFeasible": { + "description": "Boolean value indicating if the VM(s) in VmSize can be created.", + "type": "boolean" + }, + "messageCode": { + "description": "MessageCode indicating reason for success or failure.", + "type": "string" + }, + "message": { + "description": "Localized message to be displayed to the user to explain the check result.", + "type": "string" + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version.", + "required": true, + "type": "string" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "The location of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "tags": [] +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/AlertGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/AlertGet.json new file mode 100644 index 000000000000..02d40be7887d --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/AlertGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.", + "alertType": "UpdateScanFailedEvent", + "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z", + "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.", + "severity": "Critical", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 1 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "type": "dataBoxEdgeDevices/alerts" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/AlertGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/AlertGetAllInDevice.json new file mode 100644 index 000000000000..6216fb502b41 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/AlertGetAllInDevice.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "title": "Device password has changed", + "alertType": "PasswordChangedEvent", + "appearedAtDateTime": "2018-12-18T02:29:15.2325577Z", + "recommendation": "The device administrator password has changed. This is a required action as part of the first time device setup or regular password reset. No further action is required.", + "severity": "Informational", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 2 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/83eccd0b-134b-40b0-ad62-b5f124d03790", + "name": "83eccd0b-134b-40b0-ad62-b5f124d03790", + "type": "dataBoxEdgeDevices/alerts" + }, + { + "properties": { + "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.", + "alertType": "UpdateScanFailedEvent", + "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z", + "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.", + "severity": "Critical", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 1 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "type": "dataBoxEdgeDevices/alerts" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/AvailableSkusList.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/AvailableSkusList.json new file mode 100644 index 000000000000..0821d21191c2 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/AvailableSkusList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "location": "westus", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "dataBoxEdgeDevices", + "name": "Gateway", + "availability": "Available", + "tier": "Standard", + "kind": "AzureDataBoxGateway", + "version": "Stable", + "signupOption": "Available", + "locations": [ + "West US" + ], + "locationInfo": [ + { + "location": "West US" + } + ] + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthScheduleDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthScheduleDelete.json new file mode 100644 index 000000000000..2729621da6b0 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthScheduleDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/BandwidthSchdeuleDelete" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthScheduleGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthScheduleGet.json new file mode 100644 index 000000000000..777c3b5605eb --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthScheduleGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthScheduleGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthScheduleGetAllInDevice.json new file mode 100644 index 000000000000..f90033d337e2 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthScheduleGetAllInDevice.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthSchedulePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthSchedulePut.json new file mode 100644 index 000000000000..9ff8f9f4ec6a --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/BandwidthSchedulePut.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "start": "0:0:0", + "stop": "13:59:0", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerDelete.json new file mode 100644 index 000000000000..1670c0ed064d --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerDelete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "containerName": "blobcontainer1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/ContainreDelte" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerGet.json new file mode 100644 index 000000000000..4ba7aac40e83 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "containerName": "blobcontainer1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:13:27.8545799Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1", + "name": "blobcontainer1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerListAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerListAllInDevice.json new file mode 100644 index 000000000000..65d0c79c6512 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerListAllInDevice.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:14:32.3016929Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer1", + "name": "blobcontainer1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + }, + { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:15:38.0077675Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer2", + "name": "blobcontainer2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + }, + { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:13:27.8545799Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer3", + "name": "blobcontainer3", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerPut.json new file mode 100644 index 000000000000..cf3801f8e4b0 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerPut.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "containerName": "blobcontainer1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "container": { + "properties": { + "dataFormat": "BlockBlob" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:13:27.8545799Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1", + "name": "blobcontainer-5e155efe", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerRefresh.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerRefresh.json new file mode 100644 index 000000000000..b55385daf556 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ContainerRefresh.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "containerName": "blobcontainer1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/ContanierRefresh" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceDelete.json new file mode 100644 index 000000000000..a2abd9fefed9 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceDelete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/BandwidthSchdeuleDelete" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetByName.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetByName.json new file mode 100644 index 000000000000..d2796ecd5853 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetByName.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureStackEdge", + "properties": { + "dataBoxEdgeDeviceStatus": "Offline", + "serialNumber": "1D6QHQ2", + "deviceType": "DataBoxEdgeDevice", + "friendlyName": "DBE-1D6QHQ2", + "deviceModel": "Physical", + "deviceSoftwareVersion": "Azure Stack Edge 2009", + "deviceLocalCapacity": 8042259, + "timeZone": "Pacific Standard Time", + "deviceHcsVersion": "2.1.1361.23408", + "configuredRoleTypes": [ + "CloudEdgeManagement" + ], + "nodeCount": 1, + "edgeProfile": { + "subscription": { + "registrationId": "91d8753b-af42-4908-9a5e-2a61f08b20de", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16", + "state": "Registered" + } + } + }, + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource", + "name": "EdgeTestPassResource", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json new file mode 100644 index 000000000000..a58b24a8c7e6 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureStackEdge", + "properties": { + "dataBoxEdgeDeviceStatus": "Offline", + "serialNumber": "1D6QHQ2", + "deviceType": "DataBoxEdgeDevice", + "friendlyName": "DBE-1D6QHQ2", + "deviceModel": "Physical", + "deviceSoftwareVersion": "Azure Stack Edge 2009", + "deviceLocalCapacity": 8042259, + "timeZone": "Pacific Standard Time", + "deviceHcsVersion": "2.1.1361.23408", + "configuredRoleTypes": [ + "CloudEdgeManagement" + ], + "nodeCount": 1, + "edgeProfile": { + "subscription": { + "registrationId": "91d8753b-af42-4908-9a5e-2a61f08b20de", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16", + "state": "Registered" + } + }, + "dataResidency": { + "type": "ZoneReplication" + } + }, + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource", + "name": "EdgeTestPassResource", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json new file mode 100644 index 000000000000..40ff12934496 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureStackEdge", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource", + "name": "EdgeTestPassResource", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "centraluseuap", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-11-18T23%3A31%3A30.3266766Z'\"_W/\"datetime'2020-11-18T23%3A31%3A30.3326804Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "d97a6de5-f5c0-485a-8f5e-b7f705d2dbc4", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureStackEdge", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/FPGAResource", + "name": "FPGAResource", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "centraluseuap", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-11-18T23%3A31%3A23.1715672Z'\"_W/\"datetime'2020-11-18T23%3A31%3A23.2396152Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "6f2b341b-aded-4ec2-a1bd-d09438d6cc8f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureStackEdge", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/TestVMEdgeResource", + "name": "TestVMEdgeResource", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetBySubscription.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetBySubscription.json new file mode 100644 index 000000000000..5a3f2bf7be39 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDeviceGetBySubscription.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Gateway", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-11-19T01%3A39%3A55.1270082Z'\"_W/\"datetime'2020-11-19T01%3A39%3A55.1320118Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "083df009-06d9-4e3c-ae72-f9249a814334", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureDataBoxGateway", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/linksub01", + "name": "linksub01", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Gateway", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-11-19T01%3A40%3A05.9246966Z'\"_W/\"datetime'2020-11-19T01%3A40%3A05.9317011Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "8536db30-78d2-4759-95b7-896a66e14c24", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureDataBoxGateway", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/mergeazstest", + "name": "mergeazstest", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Gateway", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-11-19T01%3A40%3A06.496102Z'\"_W/\"datetime'2020-11-19T01%3A40%3A06.503107Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "fc4c1205-35c8-4f35-abc7-f5a78945f676", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureDataBoxGateway", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/mergeazstest2", + "name": "mergeazstest2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDevicePatch.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDevicePatch.json new file mode 100644 index 000000000000..488792b24f93 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDevicePatch.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "edgeProfile": { + "subscription": { + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/rapvs-rg/providers/Microsoft.AzureStack/linkedSubscriptions/ca014ddc-5cf2-45f8-b390-e901e4a0ae87" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-11-19T04%3A43%3A38.6457308Z'\"_W/\"datetime'2020-11-19T04%3A43%3A38.6507339Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureStackEdge", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0, + "timeZone": "Pacific Standard Time", + "nodeCount": 0, + "resourceMoveDetails": { + "operationInProgress": "None" + }, + "edgeProfile": { + "subscription": { + "registrationId": "91d8753b-af42-4908-9a5e-2a61f08b20de", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16", + "state": "Registered" + } + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDevicePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDevicePut.json new file mode 100644 index 000000000000..5a6a88f0008e --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDevicePut.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "dataBoxEdgeDevice": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "id": "foo/bar/id", + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "name": "testedgedevice" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDevicePutWithDataResidency.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDevicePutWithDataResidency.json new file mode 100644 index 000000000000..0c82f01ff905 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DataBoxEdgeDevicePutWithDataResidency.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "dataBoxEdgeDevice": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "properties": { + "dataResidency": { + "type": "ZoneReplication" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "foo/bar/id", + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "name": "testedgedevice", + "properties": { + "dataResidency": { + "type": "ZoneReplication" + } + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeleteAddons.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeleteAddons.json new file mode 100644 index 000000000000..41a574f6c8b0 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeleteAddons.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "KubernetesRole", + "addonName": "arcName", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/BandwidthSchdeuleDelete" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeleteMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeleteMonitoringConfig.json new file mode 100644 index 000000000000..cdfd10be46ff --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeleteMonitoringConfig.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "testrole", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/DeleteMonitoringConfig" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeviceCapacityGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeviceCapacityGet.json new file mode 100644 index 000000000000..4b25f142ca77 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeviceCapacityGet.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "timeStamp": "2022-02-28T19:35:34.5585067Z", + "clusterStorageCapacityInfo": { + "clusterTotalStorageMb": 5368642.0, + "clusterFreeStorageMb": 5284151.0 + }, + "clusterComputeCapacityInfo": { + "fqdn": "3V78B03CL", + "gpuCapacity": { + "gpuType": "NvidiaTeslaT4", + "gpuUsedUnitsCount": 0, + "gpuFreeUnitsCount": 1, + "gpuReservedForFailoverUnitsCount": 0, + "gpuTotalUnitsCount": 1 + }, + "memoryCapacity": { + "clusterFreeMemoryMb": 20978.64, + "clusterUsedMemoryMb": 109711.36, + "clusterFailoverMemoryMb": 0.0, + "clusterFragmentationMemoryMb": 0.0, + "clusterHypervReserveMemoryMb": 19599.36, + "clusterInfraVmMemoryMb": 0.0, + "clusterTotalMemoryMb": 130690.0, + "clusterNonFailoverVmMb": 0.0, + "clusterMemoryUsedByVmsMb": 90112.0 + }, + "lastRefreshedTime": "2022-02-28T19:35:23.82Z", + "totalProvisionedNonHpnCores": 5 + }, + "nodeCapacityInfos": { + "3V78B03": { + "hostName": "3V78B03", + "effectiveAvailableMemoryMbOnHost": 45818, + "availableGpuCount": 1, + "vmUsedMemory": { + "2e867196-e44b-49b7-9cb3-46c25973b762": { + "startupMemoryMB": 3584, + "currentMemoryUsageMB": 3584 + }, + "23ddd5ea-bda9-467a-803f-1a7e2888d1fa": { + "startupMemoryMB": 24576, + "currentMemoryUsageMB": 24576 + }, + "853efe82-58f1-4f94-8f9c-7752dab6767c": { + "startupMemoryMB": 24576, + "currentMemoryUsageMB": 24576 + }, + "4c4261f0-eac5-4ff6-95ef-2cb70e09d3f6": { + "startupMemoryMB": 3584, + "currentMemoryUsageMB": 3584 + }, + "48034ac1-04ce-48e1-89fd-15a6d71fd623": { + "startupMemoryMB": 2048, + "currentMemoryUsageMB": 2048 + }, + "dc3d20b2-8581-41cb-9ca3-1bbc1a8a2fe4": { + "startupMemoryMB": 3584, + "currentMemoryUsageMB": 3584 + }, + "c1023a57-d6a0-4a77-9308-48b320bfedbd": { + "startupMemoryMB": 3584, + "currentMemoryUsageMB": 3584 + }, + "6b1817d5-4003-4f17-8423-51c33d9de88c": { + "startupMemoryMB": 24576, + "currentMemoryUsageMB": 0 + } + }, + "gpuType": "NvidiaTeslaT4", + "numaNodesData": [ + { + "numaNodeIndex": 0, + "totalMemoryInMb": 65154, + "logicalCoreCountPerCore": 2, + "effectiveAvailableMemoryInMb": 30182, + "freeVCpuIndexesForHpn": [], + "vCpuIndexesForHpn": [], + "vCpuIndexesForRoot": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19 + ] + }, + { + "numaNodeIndex": 1, + "totalMemoryInMb": 65536, + "logicalCoreCountPerCore": 2, + "effectiveAvailableMemoryInMb": 19493, + "freeVCpuIndexesForHpn": [], + "vCpuIndexesForHpn": [], + "vCpuIndexesForRoot": [ + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39 + ] + } + ] + } + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/deviceCapacityInfo/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/deviceCapacityInfo" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeviceCapacityRequestPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeviceCapacityRequestPost.json new file mode 100644 index 000000000000..aa2d746b2982 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DeviceCapacityRequestPost.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "deviceCapacityRequestInfo": { + "properties": { + "vmPlacementQuery": [ + [ + "Standard_D2_v2" + ] + ] + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/BandwidthSchdeuleDelete" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DownloadUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DownloadUpdatesPost.json new file mode 100644 index 000000000000..f1e22ab2d5db --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/DownloadUpdatesPost.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/DownloadUpdatesPost" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ExtendedInfoPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ExtendedInfoPost.json new file mode 100644 index 000000000000..39f4bd39b43b --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ExtendedInfoPost.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "resourceKey": "3482840729935603111", + "encryptionKeyThumbprint": "", + "encryptionKey": "" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GenerateCertificate.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GenerateCertificate.json new file mode 100644 index 000000000000..7f6446143745 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GenerateCertificate.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "publicKey": "MIIEDjCCAnagAwIBAgIQEW4wrxj9+JdA4kFLDgegTTANBgkqhkiG9w0BAQUFADBDMUEwPwYDVQQDHjgAQwBCAF8AUABvAHIAdABhAGwAXwA2ADMANwA0ADEAMwA1ADkAMQA4ADAAMAA3ADAAOQAxADcANTAeFw0yMDExMTkwNDU2MjBaFw0yMDExMjIwNTA2MjBaMEMxQTA/BgNVBAMeOABDAEIAXwBQAG8AcgB0AGEAbABfADYAMwA3ADQAMQAzADUAOQAxADgAMAAwADcAMAA5ADEANwA1MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAqG617KAUc4gOoht527o6FGE/c97W/wZIXqKbx4G8vifljXWw3NGDDuSQfidE3MqSMMJ/AAlDhBH/Deo/PAgUWuWB2WgM+KFWrDS0oDBvLVeIIeiMx4LOsbz4J8IbcKrGWf+ulQyum7dE/yBLzPXcPTjhJP0oMfhGOMlVVWbiKaP78/WZk2PmBQaVv7PxAQnJAPqETH2qAyuc9bd0TaMlIER56WhX9+nzsoI0u7RmBEs8+BaudVroiiK/GpEczy73TCRlpVXGChdBHg+NvYRYz91ltCV9Ijo1bdvcUjdgDJZ4Tz7G8XVCQmxbd9ml6OBLgxQUpd9HSGTcIfFiv+rTUwHR7YkY+1UGHsDPOYnBVDTXs3RFm+c5uNnCKvtyTExDJgabT+FTNb3eyD/BSYsy6b/YZBRqPiO8BRFUsIhWhXtPaUjWOEx6XMeZRnGeF4Hi8iH8TR79kEJhfYy3piSPAc3JrhgoglpyyfZOgyPOje+8tAWS9FHUNyVXKKeksDoZAgMBAAEwDQYJKoZIhvcNAQEFBQADggGBACpfQt34mgr+WlFtY0tqaPAoF6XnVzyKB6XsVAoj1uKFTSCQnr0mWvUMWKSRFTu1bV1VdDokV5I+h92kBcO4ddtHhWtkt16j9XFDsGdDvoUWJeqecZVr9fBPC69wF/9R/2E6iJporR46Pui7gcilYGqb3IjJlh8RT/XBPamQrfDbS7G8eTe91ST5cHr89R6EtDwfyhyTZr2sRrvQrxY2AjEmdH5Zcl9q2Xf8DholZhZ9vwnuYBFfl6VCXWaDAzQWiPdxo1wgXxEpNNDstGFWJKnsnz9UCohNAiPf47B+csPqxjcTLVMhcGLdU/lwpzzkEOciijpYILscvPoU3IM6DmFROgU2z6CForpgwHPDJktyWU1MC7lFdfrSzwu/5b3ZAEQhnJf7rvrybULoYBQWJEuj26Is1S6kXpNUaHAc5HIyIoc2V2eRjasbPIqsU0smjPLS/1egjHxtw9u+v4qDDvDuOjhFJtC3NkPl06TfNgO9+5LgiB1JppXnkLyCQ9RQgw==", + "privateKey": null, + "expiryTimeInUTC": "2020-11-22T05:06:20.000Z" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetAddons.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetAddons.json new file mode 100644 index 000000000000..a90745496504 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetAddons.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "KubernetesRole", + "addonName": "arcName", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "resourceName": "testedgedevice", + "resourceLocation": "EastUS", + "version": "0.2.18", + "hostPlatform": "Linux", + "hostPlatformType": "KubernetesCluster", + "provisioningState": "Created" + }, + "kind": "ArcForKubernetes", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName", + "name": "arcName", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetDCAccessCode.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetDCAccessCode.json new file mode 100644 index 000000000000..96a777b61dec --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetDCAccessCode.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "authCode": "_sv7-NY2" + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetDiagnosticProactiveLogCollectionSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetDiagnosticProactiveLogCollectionSettings.json new file mode 100644 index 000000000000..d57917b4319c --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetDiagnosticProactiveLogCollectionSettings.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "diagnosticProactiveLogCollectionSettings": { + "properties": { + "userConsent": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "userConsent": "Enabled" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/diagnosticProactiveLogCollectionSettings/default", + "name": "default", + "type": "dataBoxEdgeDevices/diagnosticSettings" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetDiagnosticRemoteSupportSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetDiagnosticRemoteSupportSettings.json new file mode 100644 index 000000000000..945ecad6ad33 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetDiagnosticRemoteSupportSettings.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "remoteSupportSettingsList": [ + { + "accessLevel": "ReadWrite", + "expirationTimeStampInUTC": "2021-07-07T00:00:00+00:00", + "remoteApplicationType": "LocalUI" + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/diagnosticRemoteSupportSettings/default", + "name": "default", + "type": "dataBoxEdgeDevices/diagnosticSettings" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetMonitoringConfig.json new file mode 100644 index 000000000000..17b5ac723569 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetMonitoringConfig.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "testrole", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "foo/bar/id", + "properties": { + "metricConfigurations": [ + { + "resourceId": "test", + "mdmAccount": "test", + "metricNameSpace": "test", + "counterSets": [ + { + "counters": [ + { + "name": "test" + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetUpdateExtendedInfo.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetUpdateExtendedInfo.json new file mode 100644 index 000000000000..1492931431f1 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/GetUpdateExtendedInfo.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "parameters": {}, + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "clientSecretStoreId": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/arja-rg/providers/Microsoft.KeyVault/vaults/test-keyvault-ccy-523", + "clientSecretStoreUrl": "https://test-keyvault-ccy-523.vault.azure.net", + "channelIntegrityKeyName": "ase-cik-ab861822-21ea-4d31-96ec-89aa066f9a59", + "channelIntegrityKeyVersion": "95e9b619e65f433d82c9e1ead48214b9", + "keyVaultSyncStatus": "KeyVaultSynced", + "deviceSecrets": { + "HcsDataVolumeBitLockerExternalKey": { + "keyVaultId": "Id" + }, + "HcsInternalVolumeBitLockerExternalKey": { + "keyVaultId": "Id" + }, + "SystemVolumeBitLockerRecoveryKey": { + "keyVaultId": "Id" + }, + "SEDEncryptionExternalKeyId": {}, + "SEDEncryptionExternalKey": {}, + "BMCDefaultUserPassword": {}, + "RotateKeyForDataVolumeBitlocker": {}, + "RotateKeysForSedDrivesSerialized": {} + } + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/InstallUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/InstallUpdatesPost.json new file mode 100644 index 000000000000..f91b07d485ce --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/InstallUpdatesPost.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/InstalllUpdatesPost" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/JobsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/JobsGet.json new file mode 100644 index 000000000000..ee65a3802eec --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/JobsGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/id/locations/westus/jobs/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "status": "Succeeded", + "startTime": "2018-12-18T02:18:51.4270267Z", + "endTime": "2018-12-18T03:18:51.4270267Z", + "percentComplete": 100, + "properties": { + "jobType": "DownloadUpdates", + "currentStage": "Success" + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ListMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ListMonitoringConfig.json new file mode 100644 index 000000000000..4fbbb65daaa8 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ListMonitoringConfig.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "testrole", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "foo/bar/id", + "properties": { + "metricConfigurations": [ + { + "resourceId": "test", + "mdmAccount": "test", + "metricNameSpace": "test", + "counterSets": [ + { + "counters": [ + { + "name": "test" + } + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/NetworkSettingsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/NetworkSettingsGet.json new file mode 100644 index 000000000000..1e9fee4e7fca --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/NetworkSettingsGet.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "networkAdapters": [ + { + "adapterId": "{47D0D0EC-AA8A-4221-AA2A-355B58082BA5}", + "adapterPosition": { + "networkGroup": "NonRDMA", + "port": 0 + }, + "index": 1, + "nodeId": "3fd54d9e-f7a0-45bf-bdf1-39b0977d1984", + "networkAdapterName": "DATA1", + "label": "DATA1", + "macAddress": "00155D4E265B", + "linkSpeed": 10000000000, + "status": "Inactive", + "rdmaStatus": "Incapable", + "dhcpStatus": "Disabled", + "ipv4Configuration": { + "ipAddress": "10.150.78.56", + "subnet": "255.255.252.0", + "gateway": "10.150.76.1" + }, + "ipv6Configuration": { + "ipAddress": "2404:f801:4800:1e:d5c6:50a1:465b:1bbf", + "prefixLength": 64, + "gateway": "fe80::12f3:11ff:fe36:994b%5" + }, + "ipv6LinkLocalAddress": "fe80::d5c6:50a1:465b:1bbf%5", + "dnsServers": [ + "10.50.50.50", + "10.50.10.50" + ] + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/networkSettings/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/NodeGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/NodeGetAllInDevice.json new file mode 100644 index 000000000000..e6970521944f --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/NodeGetAllInDevice.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "nodeStatus": "Unknown", + "nodeChassisSerialNumber": "1D6QHQ2", + "nodeSerialNumber": "1D6QHQ2", + "nodeDisplayName": "Controller 1", + "nodeFriendlySoftwareVersion": "Data Box Edge 1908", + "nodeHcsVersion": "1.6.961.8307", + "nodeInstanceId": "ad051874-7d27-4ac4-a7b1-b6f231d8a035" + }, + "id": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/nodes/1D6QHQ2", + "name": "1D6QHQ2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/nodes" + }, + { + "properties": { + "nodeStatus": "Unknown", + "nodeChassisSerialNumber": "1D6QHQ2", + "nodeSerialNumber": "1DCNHQ2", + "nodeDisplayName": "Controller 1", + "nodeFriendlySoftwareVersion": "Data Box Edge 1908", + "nodeHcsVersion": "1.6.961.8307", + "nodeInstanceId": "ddf3a76d-ada4-44af-99c6-a69a0e21bcb6" + }, + "id": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/nodes/1DCNHQ2", + "name": "1DCNHQ2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/nodes" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OperationsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OperationsGet.json new file mode 100644 index 000000000000..faf2461d0a83 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OperationsGet.json @@ -0,0 +1,675 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "List share users", + "description": "Lists or gets the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "List share users", + "description": "Lists or gets the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "Creates or updates share users", + "description": "Creates or updates the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "Delete share users", + "description": "Deletes the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "List bandwidth schedules", + "description": "Lists or gets the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "List bandwidth schedules", + "description": "Lists or gets the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "Creates or updates bandwidth schedules", + "description": "Creates or updates the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "Delete bandwidth schedules", + "description": "Deletes the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "List ArmApiRes_roles", + "description": "Lists or gets the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "List ArmApiRes_roles", + "description": "Lists or gets the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "Creates or updates ArmApiRes_roles", + "description": "Creates or updates the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "Delete ArmApiRes_roles", + "description": "Deletes the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "List shares", + "description": "Lists or gets the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "List shares", + "description": "Lists or gets the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "Creates or updates shares", + "description": "Creates or updates the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/refresh/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "ArmApiOp_action_refresh_shares", + "description": "ArmApiDesc_action_refresh_shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "Delete shares", + "description": "Deletes the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/uploadCertificate/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Upload certificates", + "description": "Upload certificate for device registration" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Creates or updates Data Box Edge devices", + "description": "Creates or updates the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Delete Data Box Edge devices", + "description": "Deletes the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Creates or updates Data Box Edge devices", + "description": "Creates or updates the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/getExtendedInformation/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "ArmApiOp_action_getExtendedInformation_dataBoxEdgeDevices", + "description": "ArmApiDesc_action_getExtendedInformation_dataBoxEdgeDevices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/extendedInformation/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Gets resource extended information", + "description": "Retrieves resource extended information" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Device network settings", + "operation": "List Device network settings", + "description": "Lists or gets the Device network settings" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/securitySettings/update/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Device security settings", + "operation": "Update security settings", + "description": "Update security settings" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "update summary", + "operation": "List update summary", + "description": "Lists or gets the update summary" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/scanForUpdates/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Scan for updates", + "description": "Scan for updates" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/downloadUpdates/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Download Updates", + "description": "Download Updates in device" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/installUpdates/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Install Updates", + "description": "Install Updates on device" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/jobs/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "jobs", + "operation": "List jobs", + "description": "Lists or gets the jobs" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "Creates or updates storage account credentials", + "description": "Creates or updates the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "List storage account credentials", + "description": "Lists or gets the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "List storage account credentials", + "description": "Lists or gets the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "Delete storage account credentials", + "description": "Deletes the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "alerts", + "operation": "List alerts", + "description": "Lists or gets the alerts" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "alerts", + "operation": "List alerts", + "description": "Lists or gets the alerts" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Read Data Box Edge device metric definition", + "description": "Gets the available Data Box Edge device level metrics" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "NICReadThroughput", + "displayName": "Read Throughput (Network)", + "displayDescription": "The read throughput of the network interface on the device in the reporting period for all volumes in the gateway.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "InstanceName", + "displayName": "Name", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "NICWriteThroughput", + "displayName": "Write Throughput (Network)", + "displayDescription": "The write throughput of the network interface on the device in the reporting period for all volumes in the gateway.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "InstanceName", + "displayName": "Name", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudReadThroughputPerShare", + "displayName": "Cloud Download Throughput (Share)", + "displayDescription": "The download throughput to Azure from a share during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudUploadThroughputPerShare", + "displayName": "Cloud Upload Throughput (Share)", + "displayDescription": "The upload throughput to Azure from a share during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "BytesUploadedToCloudPerShare", + "displayName": "Cloud Bytes Uploaded (Share)", + "displayDescription": "The total number of bytes that is uploaded to Azure from a share during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "TotalCapacity", + "displayName": "Total Capacity", + "displayDescription": "Total Capacity", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Capacity", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "AvailableCapacity", + "displayName": "Available Capacity", + "displayDescription": "The available capacity in bytes during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Capacity", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudUploadThroughput", + "displayName": "Cloud Upload Throughput", + "displayDescription": "The cloud upload throughput during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudReadThroughput", + "displayName": "Cloud Read Throughput", + "displayDescription": "The cloud download throughput during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "BytesUploadedToCloud", + "displayName": "Cloud Bytes Uploaded (Device)", + "displayDescription": "The total number of bytes that is uploaded to Azure from a device during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + } + ] + } + } + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Write diagnostics setting", + "description": "Creates or updates the diagnostics setting for the resource" + }, + "origin": "system" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Read diagnostics setting", + "description": "Gets the diagnostic setting for the resource" + }, + "origin": "system" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OperationsStatusGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OperationsStatusGet.json new file mode 100644 index 000000000000..ed577d9c3c66 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OperationsStatusGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/id/locations/westus/operationsStatus/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "status": "Succeeded", + "startTime": "2018-12-18T02:18:51.4270267Z", + "endTime": "2018-12-18T03:18:51.4270267Z", + "percentComplete": 100, + "properties": { + "jobType": "DownloadUpdates", + "currentStage": "Success" + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderDelete.json new file mode 100644 index 000000000000..f431b87e4aef --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderDelete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/OrderDelete" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderGet.json new file mode 100644 index 000000000000..f9d794d6870e --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "currentStatus": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [], + "returnTrackingInfo": [] + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderGetAllInDevice.json new file mode 100644 index 000000000000..bb6ad8e93377 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderGetAllInDevice.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "currentStatus": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [], + "returnTrackingInfo": [] + } + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderPut.json new file mode 100644 index 000000000000..d6c96b2c14d3 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/OrderPut.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "order": { + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "currentStatus": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [], + "returnTrackingInfo": [] + } + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/PutAddons.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/PutAddons.json new file mode 100644 index 000000000000..f8594d78cb5a --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/PutAddons.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "KubernetesRole", + "addonName": "arcName", + "addon": { + "kind": "ArcForKubernetes", + "properties": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "resourceName": "testedgedevice", + "resourceLocation": "EastUS" + } + }, + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "resourceName": "testedgedevice", + "resourceLocation": "EastUS", + "version": "0.2.18", + "hostPlatform": "Linux", + "hostPlatformType": "KubernetesCluster", + "provisioningState": "Created" + }, + "kind": "ArcForKubernetes", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName", + "name": "arcName", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/PutMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/PutMonitoringConfig.json new file mode 100644 index 000000000000..223f01c45648 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/PutMonitoringConfig.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "testrole", + "monitoringMetricConfiguration": { + "properties": { + "metricConfigurations": [ + { + "resourceId": "test", + "mdmAccount": "test", + "metricNameSpace": "test", + "counterSets": [ + { + "counters": [ + { + "name": "test" + } + ] + } + ] + } + ] + } + }, + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "foo/bar/id", + "properties": { + "metricConfigurations": [ + { + "resourceId": "test", + "mdmAccount": "test", + "metricNameSpace": "test", + "counterSets": [ + { + "counters": [ + { + "name": "test" + } + ] + } + ] + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/BandwidthSchdeuleDelete" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleDelete.json new file mode 100644 index 000000000000..98a4cd6e8342 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/BandwidthSchdeuleDelete" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleGet.json new file mode 100644 index 000000000000..700e9dc01467 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "kind": "IOT", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleGetAllInDevice.json new file mode 100644 index 000000000000..7b8f723f58ed --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleGetAllInDevice.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "kind": "IOT", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleListAddOns.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleListAddOns.json new file mode 100644 index 000000000000..5c09167d6054 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RoleListAddOns.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "IoTRole1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29", + "resourceGroupName": "testrg1", + "resourceName": "testresource1", + "resourceLocation": "EastUS", + "version": "0.2.18", + "hostPlatform": "Linux", + "hostPlatformType": "KubernetesCluster", + "provisioningState": "Created" + }, + "kind": "ArcForKubernetes", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/prpare/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName", + "name": "arcName", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RolePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RolePut.json new file mode 100644 index 000000000000..4c1037de43f8 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/RolePut.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "role": { + "kind": "IOT", + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": { + "connectionString": { + "value": "Encrypted<>", + "encryptionCertThumbprint": "348586569999244", + "encryptionAlgorithm": "AES256" + } + } + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": { + "connectionString": { + "value": "Encrypted<>", + "encryptionCertThumbprint": "1245475856069999244", + "encryptionAlgorithm": "AES256" + } + } + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "kind": "IOT", + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACDelete.json new file mode 100644 index 000000000000..22df0cf597c6 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACDelete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/SACDelete" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACGet.json new file mode 100644 index 000000000000..8c4f13d80735 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "name": "sac1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACGetAllInDevice.json new file mode 100644 index 000000000000..b119b181cf1b --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACGetAllInDevice.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "alias": "sac1128180128323", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "GeneralPurposeStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128323", + "name": "sac1128180128323", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + }, + { + "properties": { + "alias": "sac1128180128312", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128312", + "name": "sac1128180128312", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACPut.json new file mode 100644 index 000000000000..8b3504e23c6b --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SACPut.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "storageAccountCredential": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "accountKey": { + "value": "lAeZEYi6rNP1/EyNaVUYmTSZEYyaIaWmwUsGwek0+xiZj54GM9Ue9/UA2ed/ClC03wuSit2XzM/cLRU5eYiFBwks23rGwiQOr3sruEL2a74EjPD050xYjA6M1I2hu/w2yjVHhn5j+DbXS4Xzi+rHHNZK3DgfDO3PkbECjPck+PbpSBjy9+6Mrjcld5DIZhUAeMlMHrFlg+WKRKB14o/og56u5/xX6WKlrMLEQ+y6E18dUwvWs2elTNoVO8PBE8SM/CfooX4AMNvaNdSObNBPdP+F6Lzc556nFNWXrBLRt0vC7s9qTiVRO4x/qCNaK/B4y7IqXMllwQFf4Np9UQ2ECA==", + "encryptionCertThumbprint": "2A9D8D6BE51574B5461230AEF02F162C5F01AD31", + "encryptionAlgorithm": "AES256" + }, + "sslStatus": "Disabled", + "accountType": "BlobStorage" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "name": "sac1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ScanForUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ScanForUpdatesPost.json new file mode 100644 index 000000000000..9b1b00d91e52 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ScanForUpdatesPost.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/BandwidthSchdeuleDelete" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SecuritySettingsUpdatePost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SecuritySettingsUpdatePost.json new file mode 100644 index 000000000000..45d81badceff --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SecuritySettingsUpdatePost.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "AzureVM", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "securitySettings": { + "properties": { + "deviceAdminPassword": { + "value": "", + "encryptionAlgorithm": "AES256", + "encryptionCertThumbprint": "" + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/BandwidthSchdeuleDelete" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareDelete.json new file mode 100644 index 000000000000..7700053efcb0 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareDelete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "smbshare", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/ShareDelete" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareGet.json new file mode 100644 index 000000000000..7fab33f349e0 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "smbshare", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare", + "name": "smbshare", + "type": "dataBoxEdgeDevices/shares" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareGetAllInDevice.json new file mode 100644 index 000000000000..a66e2bf1e147 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareGetAllInDevice.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare", + "name": "smbshare", + "type": "dataBoxEdgeDevices/shares" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SharePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SharePut.json new file mode 100644 index 000000000000..a767101adeff --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/SharePut.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "smbshare", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "share": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Enabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "dataPolicy": "Cloud" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare", + "name": "smbshare", + "type": "dataBoxEdgeDevices/shares" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareRefreshPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareRefreshPost.json new file mode 100644 index 000000000000..76bcaa619626 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/ShareRefreshPost.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "smbshare", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/ShareRefreshPost" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountDelete.json new file mode 100644 index 000000000000..c655102c1fae --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountDelete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/StorageAccountDelete" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountGet.json new file mode 100644 index 000000000000..aa1726734405 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "blobstorageaccount1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "It's an awesome storage account", + "storageAccountStatus": "OK", + "dataPolicy": "Cloud", + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt", + "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/", + "containerCount": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1", + "name": "blobstorageaccount1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountGetAllInDevice.json new file mode 100644 index 000000000000..e9f91fe8a24c --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountGetAllInDevice.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "It's an awesome storage account", + "storageAccountStatus": "OK", + "dataPolicy": "Cloud", + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt", + "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/", + "containerCount": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1", + "name": "blobstorageaccount1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountPut.json new file mode 100644 index 000000000000..de51854024ef --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/StorageAccountPut.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "blobstorageaccount1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "storageAccount": { + "properties": { + "description": "It's an awesome storage account", + "storageAccountStatus": "OK", + "dataPolicy": "Cloud", + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "It's an awesome storage account", + "storageAccountStatus": "OK", + "dataPolicy": "Cloud", + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt", + "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/", + "containerCount": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1", + "name": "blobstorageaccount1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerDelete.json new file mode 100644 index 000000000000..4031c3137ab2 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerDelete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/TriggerDelete" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerGet.json new file mode 100644 index 000000000000..b1aa2740dd62 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerGetAllInDevice.json new file mode 100644 index 000000000000..49547dd50790 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerGetAllInDevice.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerPut.json new file mode 100644 index 000000000000..9f501b1f88d4 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerPut.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "trigger": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "kind": "FileEvent" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerSupportPackage.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerSupportPackage.json new file mode 100644 index 000000000000..6534772a9e3e --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/TriggerSupportPackage.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "triggerSupportPackageRequest": { + "properties": { + "minimumTimeStamp": "2018-12-18T02:18:51.4270267Z", + "maximumTimeStamp": "2018-12-18T02:19:51.4270267Z", + "include": "DefaultWithDumps" + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/TriggerSupportPackage" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UpdateDiagnosticProactiveLogCollectionSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UpdateDiagnosticProactiveLogCollectionSettings.json new file mode 100644 index 000000000000..4838ce203419 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UpdateDiagnosticProactiveLogCollectionSettings.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "proactiveLogCollectionSettings": { + "properties": { + "userConsent": "Enabled" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "properties": { + "userConsent": "Disabled" + }, + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/dbe-autobot-5428209/diagnosticProactiveLogCollectionSettings/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticSettings" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UpdateDiagnosticRemoteSupportSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UpdateDiagnosticRemoteSupportSettings.json new file mode 100644 index 000000000000..1d95bdd771ed --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UpdateDiagnosticRemoteSupportSettings.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "diagnosticRemoteSupportSettings": { + "properties": { + "remoteSupportSettingsList": [ + { + "accessLevel": "ReadWrite", + "expirationTimeStampInUTC": "2021-07-07T00:00:00+00:00", + "remoteApplicationType": "Powershell" + } + ] + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "properties": { + "remoteSupportSettingsList": [ + { + "remoteApplicationType": "Powershell", + "accessLevel": "ReadWrite", + "expirationTimeStampInUTC": "2500-09-14T00:00:00+00:00" + } + ] + }, + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/dbe-autobot-154c8a4/diagnosticRemoteSupportSettings/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticSettings" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UpdateSummaryGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UpdateSummaryGet.json new file mode 100644 index 000000000000..1910da5cca95 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UpdateSummaryGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw==" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "deviceVersionNumber": "2.1.1377.2170", + "friendlyDeviceVersionName": "Azure Stack Edge 2010", + "deviceLastScannedDateTime": "2021-03-17T19:51:51.7864634Z", + "lastCompletedScanJobDateTime": "2021-03-17T19:47:46.1595547Z", + "lastDownloadJobStatus": "Invalid", + "lastInstallJobStatus": "Invalid", + "totalNumberOfUpdatesAvailable": 1, + "totalNumberOfUpdatesPendingDownload": 1, + "totalNumberOfUpdatesPendingInstall": 1, + "rebootBehavior": "NeverReboots", + "ongoingUpdateOperation": "Install", + "updateTitles": [ + "Azure Stack Edge Update 2101 Package 1 of 2 for Pro-GPU, Pro R, Mini R" + ], + "totalUpdateSizeInBytes": 4260898192.0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UploadCertificatePost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UploadCertificatePost.json new file mode 100644 index 000000000000..516d9f36fa4d --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UploadCertificatePost.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw==" + } + } + }, + "responses": { + "200": { + "body": { + "authType": "AzureActiveDirectory", + "resourceId": "392799901267771", + "aadAuthority": "https://login.windows.net", + "aadTenantId": "100b019d-4626-4a9e-a83c-9cff8fe41909", + "servicePrincipalClientId": "ffd8a688-82b1-4e5a-a4c1-7ede8c928e68", + "servicePrincipalObjectId": "cef6d40c-24e6-4a6f-bb9e-3ec60b4adec4", + "azureManagementEndpointAudience": "https://wus-bvtgateway.ext.trafficmanager.net/" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserDelete.json new file mode 100644 index 000000000000..49fb4e7a9f7b --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserDelete.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/UserDelete" + } + }, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserGet.json new file mode 100644 index 000000000000..c8032c68ac55 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "userType": "Share" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + }, + "202": {} + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserGetAllInDevice.json new file mode 100644 index 000000000000..7363eaa1c297 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserGetAllInDevice.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "userType": "Share" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "name": "user2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + }, + { + "properties": { + "userType": "Share" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserPut.json new file mode 100644 index 000000000000..28ab157f662f --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/examples/UserPut.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "user": { + "properties": { + "encryptedPassword": { + "value": "", + "encryptionAlgorithm": "None", + "encryptionCertThumbprint": "blah" + }, + "userType": "Share" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "userType": "Share" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/readme.md b/specification/databoxedge/resource-manager/readme.md index 1f2e714ee6f5..97bd38ebf707 100644 --- a/specification/databoxedge/resource-manager/readme.md +++ b/specification/databoxedge/resource-manager/readme.md @@ -26,10 +26,17 @@ These are the global settings for the DataBox Edge API. ``` yaml openapi-type: arm -tag: package-2023-07 +tag: package-2023-12-01 ``` +### Tag: package-2023-12-01 +These settings apply only when `--tag=package-2023-12-01` is specified on the command line. + +```yaml $(tag) == 'package-2023-12-01' +input-file: + - Microsoft.DataBoxEdge/stable/2023-12-01/databoxedge.json +``` ### Tag: package-2023-07 These settings apply only when `--tag=package-2023-07` is specified on the command line. diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/databricks.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/databricks.json new file mode 100644 index 000000000000..5af079beff53 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/databricks.json @@ -0,0 +1,1997 @@ +{ + "swagger": "2.0", + "info": { + "title": "AzureDatabricksManagementClient", + "version": "2024-02-01-preview", + "description": "These APIs allow end users to operate on Azure Databricks Workspace resources." + }, + "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.Databricks/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Get", + "description": "Gets the workspace.", + "x-ms-examples": { + "Get a workspace": { + "$ref": "./examples/WorkspaceGet.json" + }, + "Get a workspace with custom parameters": { + "$ref": "./examples/WorkspaceGetParameters.json" + }, + "Get a workspace with Customer-Managed Key (CMK) encryption for Managed Disks": { + "$ref": "./examples/WorkspaceManagedDiskEncryptionGet.json" + }, + "Get a workspace with Enhanced Security & Compliance Add-On": { + "$ref": "./examples/WorkspaceEnhancedSecurityComplianceGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Delete", + "description": "Deletes the workspace.", + "x-ms-examples": { + "Delete a workspace": { + "$ref": "./examples/WorkspaceDelete.json" + }, + "Delete a workspace with retainUcData parameter": { + "$ref": "./examples/WorkspaceDeleteRetainUcData.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "retainUcData", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to retain default unity catalog data. By default the data will retained if Uc is enabled on the workspace." + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_CreateOrUpdate", + "description": "Creates a new workspace.", + "x-ms-examples": { + "Create or update workspace": { + "$ref": "./examples/WorkspaceCreate.json" + }, + "Create or update workspace with custom parameters": { + "$ref": "./examples/WorkspaceCreateWithParameters.json" + }, + "Create a workspace which is ready for Customer-Managed Key (CMK) encryption": { + "$ref": "./examples/PrepareEncryption.json" + }, + "Enable Customer-Managed Key (CMK) encryption on a workspace which is prepared for encryption": { + "$ref": "./examples/EnableEncryption.json" + }, + "Revert Customer-Managed Key (CMK) encryption to Microsoft Managed Keys encryption on a workspace": { + "$ref": "./examples/DisableEncryption.json" + }, + "Create a workspace with Customer-Managed Key (CMK) encryption for Managed Disks": { + "$ref": "./examples/WorkspaceManagedDiskEncryptionCreate.json" + }, + "Update a workspace with Customer-Managed Key (CMK) encryption for Managed Disks": { + "$ref": "./examples/WorkspaceManagedDiskEncryptionUpdate.json" + }, + "Create or update a workspace with Enhanced Security & Compliance Add-On": { + "$ref": "./examples/WorkspaceEnhancedSecurityComplianceCreateOrUpdate.json" + } + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "Parameters supplied to the create or update a workspace." + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Created - Returns information about the workspace, including provisioning status.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Created - Returns information about the workspace, including provisioning status.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Update", + "description": "Updates a workspace.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdate" + }, + "description": "The update to the workspace." + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a workspace's tags.": { + "$ref": "./examples/WorkspaceUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_ListByResourceGroup", + "description": "Gets all the workspaces within a resource group.", + "x-ms-examples": { + "Lists workspaces": { + "$ref": "./examples/WorkspacesListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of workspaces.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Databricks/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_ListBySubscription", + "description": "Gets all the workspaces within a subscription.", + "x-ms-examples": { + "Lists workspaces": { + "$ref": "./examples/WorkspacesListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of workspaces.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Databricks/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available RP operations.", + "x-ms-examples": { + "Operations": { + "$ref": "./examples/OperationsList.json" + } + }, + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "summary": "List private link resources", + "description": "List private link resources for a given workspace", + "operationId": "PrivateLinkResources_List", + "x-ms-examples": { + "List private link resources": { + "$ref": "./examples/ListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of private link resources", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesList" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "summary": "Get the specified private link resource", + "description": "Get the specified private link resource for the given group id (sub-resource)", + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "Get a private link resource": { + "$ref": "./examples/PrivateLinkResourcesGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/GroupId" + } + ], + "responses": { + "200": { + "description": "OK - Returns the specified of private link resource", + "schema": { + "$ref": "#/definitions/GroupIdInformation" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "List private endpoint connections", + "description": "List private endpoint connections of the workspace", + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "List private endpoint connections": { + "$ref": "./examples/ListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns list of private endpoint connections for a workspace", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionsList" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Get private endpoint connection", + "description": "Get a private endpoint connection properties for a workspace", + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "Get a private endpoint connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK - Returns the private endpoint connection properties of a workspace", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PUT", + "PrivateEndpointConnections" + ], + "summary": "Update private endpoint connection status", + "description": "Update the status of a private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Create", + "x-ms-examples": { + "Update a private endpoint connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection with updated properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted - This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DELETE", + "PrivateEndpointConnections" + ], + "summary": "Remove private endpoint connection", + "description": "Remove private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "Remove a private endpoint connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "202": { + "description": "Accepted - This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation." + }, + "200": { + "description": "OK - Returns the status of polling request for the delete operation." + }, + "204": { + "description": "No Content - PrivateEndpoint does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "OutboundNetworkDependenciesEndpoints" + ], + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified Workspace.", + "description": "Gets the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. You must configure outbound access with these endpoints. For more information, see https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr", + "operationId": "OutboundNetworkDependenciesEndpoints_List", + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Workspace": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response contains list of outbound network dependency endpoints", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Workspace": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties", + "description": "The workspace properties." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the resource." + }, + "systemData": { + "description": "The system metadata relating to this resource", + "type": "object", + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Information about workspace." + }, + "WorkspaceProperties": { + "properties": { + "managedResourceGroupId": { + "type": "string", + "description": "The managed resource group Id." + }, + "parameters": { + "$ref": "#/definitions/WorkspaceCustomParameters", + "description": "The workspace's custom parameters." + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The workspace provisioning state." + }, + "uiDefinitionUri": { + "type": "string", + "description": "The blob URI where the UI definition file is located." + }, + "authorizations": { + "description": "The workspace provider authorizations.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/WorkspaceProviderAuthorization" + } + }, + "createdBy": { + "description": "Indicates the Object ID, PUID and Application ID of entity that created the workspace.", + "$ref": "#/definitions/CreatedBy" + }, + "updatedBy": { + "description": "Indicates the Object ID, PUID and Application ID of entity that last updated the workspace.", + "$ref": "#/definitions/CreatedBy" + }, + "createdDateTime": { + "description": "Specifies the date and time when the workspace is created.", + "$ref": "#/definitions/CreatedDateTime" + }, + "workspaceId": { + "readOnly": true, + "description": "The unique identifier of the databricks workspace in databricks control plane.", + "type": "string" + }, + "workspaceUrl": { + "readOnly": true, + "description": "The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'", + "type": "string" + }, + "storageAccountIdentity": { + "description": "The details of Managed Identity of Storage Account", + "$ref": "#/definitions/ManagedIdentityConfiguration" + }, + "managedDiskIdentity": { + "description": "The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption", + "$ref": "#/definitions/ManagedIdentityConfiguration" + }, + "diskEncryptionSetId": { + "readOnly": true, + "type": "string", + "description": "The resource Id of the managed disk encryption set." + }, + "encryption": { + "type": "object", + "description": "Encryption properties for databricks workspace", + "properties": { + "entities": { + "$ref": "#/definitions/EncryptionEntitiesDefinition", + "description": "Encryption entities definition for the workspace." + } + }, + "required": [ + "entities" + ] + }, + "enhancedSecurityCompliance": { + "description": "Contains settings related to the Enhanced Security and Compliance Add-On.", + "$ref": "#/definitions/EnhancedSecurityComplianceDefinition" + }, + "privateEndpointConnections": { + "readOnly": true, + "description": "Private endpoint connections created on the workspace", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "publicNetworkAccess": { + "type": "string", + "description": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "requiredNsgRules": { + "type": "string", + "description": "Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only.", + "enum": [ + "AllRules", + "NoAzureDatabricksRules", + "NoAzureServiceRules" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RequiredNsgRules" + } + }, + "defaultCatalog": { + "description": "Properties for Default Catalog configuration during workspace creation.", + "$ref": "#/definitions/DefaultCatalogProperties" + }, + "isUcEnabled": { + "readOnly": true, + "description": "Indicates whether unity catalog enabled for the workspace or not.", + "type": "boolean" + }, + "accessConnector": { + "description": "Access Connector Resource that is going to be associated with Databricks Workspace", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of Azure Databricks Access Connector Resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Databricks/accessConnectors" + } + ] + } + }, + "identityType": { + "type": "string", + "description": "The identity type of the Access Connector Resource.", + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "IdentityType" + } + }, + "userAssignedIdentityId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + } + } + }, + "required": [ + "id", + "identityType" + ] + }, + "privateDbfsAccess": { + "description": "Gets or Sets Private DBFS Access configuration information", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "PrivateDbfsAccess" + } + } + }, + "required": [ + "managedResourceGroupId" + ], + "description": "The workspace properties." + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "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" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "Resource": { + "description": "The core properties of ARM 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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + } + }, + "x-ms-azure-resource": true + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The SKU name." + }, + "tier": { + "type": "string", + "description": "The SKU tier." + } + }, + "required": [ + "name" + ], + "description": "SKU for the resource." + }, + "ProvisioningState": { + "description": "Provisioning status of the workspace.", + "readOnly": true, + "enum": [ + "Accepted", + "Running", + "Ready", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "Updating" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "PeeringProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PeeringProvisioningState", + "modelAsString": true + } + }, + "ManagedIdentityConfiguration": { + "description": "The Managed Identity details for storage account.", + "properties": { + "principalId": { + "type": "string", + "format": "uuid", + "description": "The objectId of the Managed Identity that is linked to the Managed Storage account.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The tenant Id where the Managed Identity is created.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of Identity created. It can be either SystemAssigned or UserAssigned.", + "readOnly": true + } + } + }, + "EnhancedSecurityComplianceDefinition": { + "type": "object", + "description": "Status of settings related to the Enhanced Security and Compliance Add-On.", + "properties": { + "automaticClusterUpdate": { + "type": "string", + "description": "Status of automated cluster updates feature.", + "$ref": "#/definitions/AutomaticClusterUpdateDefinition" + }, + "complianceSecurityProfile": { + "type": "object", + "description": "Status of Compliance Security Profile feature.", + "$ref": "#/definitions/ComplianceSecurityProfileDefinition" + }, + "enhancedSecurityMonitoring": { + "type": "object", + "description": "Status of Enhanced Security Monitoring feature.", + "$ref": "#/definitions/EnhancedSecurityMonitoringDefinition" + } + } + }, + "AutomaticClusterUpdateDefinition": { + "type": "object", + "description": "Status of automated cluster updates feature.", + "properties": { + "value": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AutomaticClusterUpdateValue" + } + } + } + }, + "EnhancedSecurityMonitoringDefinition": { + "type": "object", + "description": "Status of Enhanced Security Monitoring feature.", + "properties": { + "value": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "EnhancedSecurityMonitoringValue" + } + } + } + }, + "ComplianceSecurityProfileDefinition": { + "type": "object", + "description": "Status of Compliance Security Profile feature.", + "properties": { + "complianceStandards": { + "description": "Compliance standards associated with the workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/ComplianceStandardDefinition" + } + }, + "value": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ComplianceSecurityProfileValue" + } + } + } + }, + "ComplianceStandardDefinition": { + "description": "Compliance standard that can be associated with a workspace.", + "type": "string", + "enum": [ + "NONE", + "HIPAA", + "PCI_DSS" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ComplianceStandard" + } + }, + "WorkspaceCustomParameterType": { + "description": "Provisioning status of the workspace.", + "readOnly": true, + "enum": [ + "Bool", + "Object", + "String" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomParameterType", + "modelAsString": true + } + }, + "WorkspaceCustomBooleanParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "type": "boolean", + "description": "The value which should be used for this field." + } + }, + "required": [ + "value" + ], + "description": "The value which should be used for this field." + }, + "WorkspaceCustomObjectParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "type": "object", + "description": "The value which should be used for this field." + } + }, + "required": [ + "value" + ], + "description": "The value which should be used for this field." + }, + "WorkspaceCustomStringParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "type": "string", + "description": "The value which should be used for this field." + } + }, + "required": [ + "value" + ], + "description": "The Value." + }, + "WorkspaceCustomParameters": { + "properties": { + "amlWorkspaceId": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "The ID of a Azure Machine Learning workspace to link with Databricks workspace" + }, + "customVirtualNetworkId": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "The ID of a Virtual Network where this Databricks Cluster should be created" + }, + "customPublicSubnetName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "The name of a Public Subnet within the Virtual Network" + }, + "customPrivateSubnetName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "The name of the Private Subnet within the Virtual Network" + }, + "enableNoPublicIp": { + "$ref": "#/definitions/WorkspaceCustomBooleanParameter", + "description": "Should the Public IP be Disabled?" + }, + "loadBalancerBackendPoolName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP)." + }, + "loadBalancerId": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace." + }, + "natGatewayName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets." + }, + "publicIpName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Name of the Public IP for No Public IP workspace with managed vNet." + }, + "prepareEncryption": { + "$ref": "#/definitions/WorkspaceCustomBooleanParameter", + "description": "Prepare the workspace for encryption. Enables the Managed Identity for managed storage account." + }, + "encryption": { + "$ref": "#/definitions/WorkspaceEncryptionParameter", + "description": "Contains the encryption details for Customer-Managed Key (CMK) enabled workspace." + }, + "requireInfrastructureEncryption": { + "$ref": "#/definitions/WorkspaceCustomBooleanParameter", + "description": "A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest." + }, + "storageAccountName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Default DBFS storage account name." + }, + "storageAccountSkuName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs." + }, + "vnetAddressPrefix": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Address prefix for Managed virtual network. Default value for this input is 10.139." + }, + "resourceTags": { + "$ref": "#/definitions/WorkspaceCustomObjectParameter", + "readOnly": true, + "description": "Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level." + } + }, + "description": "Custom Parameters used for Cluster Creation." + }, + "CreatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time stamp when the workspace was created.", + "readOnly": true + }, + "CreatedBy": { + "properties": { + "oid": { + "type": "string", + "format": "uuid", + "description": "The Object ID that created the workspace.", + "readOnly": true + }, + "puid": { + "type": "string", + "description": "The Personal Object ID corresponding to the object ID above", + "readOnly": true + }, + "applicationId": { + "type": "string", + "format": "uuid", + "description": "The application ID of the application that initiated the creation of the workspace. For example, Azure Portal.", + "readOnly": true + } + }, + "description": "Provides details of the entity that created/updated the workspace." + }, + "WorkspaceEncryptionParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "$ref": "#/definitions/Encryption", + "description": "The value which should be used for this field." + } + }, + "description": "The object that contains details of encryption used on the workspace." + }, + "Encryption": { + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault", + "enum": [ + "Default", + "Microsoft.Keyvault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true + }, + "default": "Default" + }, + "KeyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyversion": { + "type": "string", + "description": "The version of KeyVault key.", + "x-ms-client-name": "KeyVersion" + }, + "keyvaulturi": { + "type": "string", + "description": "The Uri of KeyVault.", + "x-ms-client-name": "KeyVaultUri" + } + }, + "description": "The object that contains details of encryption used on the workspace." + }, + "DefaultCatalogProperties": { + "type": "object", + "properties": { + "initialType": { + "type": "string", + "description": "Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog", + "enum": [ + "HiveMetastore", + "UnityCatalog" + ], + "x-ms-enum": { + "name": "initialType", + "modelAsString": true + }, + "default": "HiveMetastore" + }, + "initialName": { + "type": "string", + "description": "Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used." + } + }, + "description": "These properties lets user specify default catalog properties during workspace creation." + }, + "EncryptionEntitiesDefinition": { + "properties": { + "managedServices": { + "type": "object", + "description": "Encryption properties for the databricks managed services.", + "$ref": "#/definitions/EncryptionV2" + }, + "managedDisk": { + "type": "object", + "description": "Encryption properties for the databricks managed disks.", + "$ref": "#/definitions/ManagedDiskEncryption" + } + }, + "description": "Encryption entities for databricks workspace resource." + }, + "EncryptionV2": { + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault", + "enum": [ + "Microsoft.Keyvault" + ], + "x-ms-enum": { + "name": "EncryptionKeySource", + "modelAsString": true + } + }, + "keyVaultProperties": { + "properties": { + "keyVaultUri": { + "type": "string", + "description": "The Uri of KeyVault." + }, + "keyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyVersion": { + "type": "string", + "description": "The version of KeyVault key." + } + }, + "required": [ + "keyVaultUri", + "keyName", + "keyVersion" + ], + "description": "Key Vault input properties for encryption." + } + }, + "required": [ + "keySource" + ], + "description": "The object that contains details of encryption used on the workspace." + }, + "ManagedDiskEncryption": { + "type": "object", + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault", + "enum": [ + "Microsoft.Keyvault" + ], + "x-ms-enum": { + "name": "EncryptionKeySource", + "modelAsString": true + } + }, + "keyVaultProperties": { + "type": "object", + "properties": { + "keyVaultUri": { + "type": "string", + "description": "The URI of KeyVault." + }, + "keyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyVersion": { + "type": "string", + "description": "The version of KeyVault key." + } + }, + "required": [ + "keyVaultUri", + "keyName", + "keyVersion" + ], + "description": "Key Vault input properties for encryption." + }, + "rotationToLatestKeyVersionEnabled": { + "type": "boolean", + "description": "Indicate whether the latest key version should be automatically used for Managed Disk Encryption." + } + }, + "required": [ + "keySource", + "keyVaultProperties" + ], + "description": "The object that contains details of encryption used on the workspace." + }, + "WorkspaceProviderAuthorization": { + "properties": { + "principalId": { + "type": "string", + "format": "uuid", + "description": "The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources." + }, + "roleDefinitionId": { + "type": "string", + "format": "uuid", + "description": "The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group." + } + }, + "required": [ + "principalId", + "roleDefinitionId" + ], + "description": "The workspace provider authorization." + }, + "WorkspaceUpdate": { + "description": "An update to a workspace.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ErrorDetail": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorInfo": { + "title": "The code and message for an error.", + "type": "object", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + }, + "innererror": { + "description": "Inner error details if they exist.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorResponse": { + "title": "Error response.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/ErrorInfo" + } + }, + "required": [ + "error" + ] + }, + "WorkspaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + }, + "description": "The array of workspaces." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of workspaces." + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: ex Microsoft.Databricks", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description for the resource operation.", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Resource Provider operations supported by the Resource Provider resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "PrivateLinkResourcesList": { + "description": "The available private link resources for a workspace", + "type": "object", + "properties": { + "value": { + "description": "The list of available private link resources for a workspace", + "type": "array", + "items": { + "$ref": "#/definitions/GroupIdInformation" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of private link resources." + } + } + }, + "GroupIdInformation": { + "description": "The group information for creating a private endpoint on a workspace", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "description": "The group id properties.", + "type": "object", + "x-ms-client-flatten": false, + "$ref": "#/definitions/GroupIdInformationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "properties" + ] + }, + "GroupIdInformationProperties": { + "description": "The properties for a group information object", + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The group id" + }, + "requiredMembers": { + "description": "The required members for a specific group id", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The required DNS zones for a specific group id", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateEndpointConnectionsList": { + "description": "List of private link connections.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of returned private endpoint connection." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of endpoint connections." + } + } + }, + "PrivateEndpointConnection": { + "description": "The private endpoint connection of a workspace", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "type": "object", + "description": "The private endpoint connection properties.", + "x-ms-client-flatten": false, + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + }, + "required": [ + "properties" + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "The properties of a private endpoint connection", + "type": "object", + "properties": { + "privateEndpoint": { + "title": "Private endpoint", + "description": "Private endpoint", + "$ref": "#/definitions/PrivateEndpoint" + }, + "groupIds": { + "type": "array", + "description": "GroupIds from the private link service resource.", + "items": { + "type": "string" + } + }, + "privateLinkServiceConnectionState": { + "title": "Private link service service connection state", + "description": "Private endpoint connection state", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "Provisioning state of the private endpoint connection." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "type": "object", + "properties": { + "status": { + "description": "The status of a private endpoint connection", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The description for the current state of a private endpoint connection" + }, + "actionsRequired": { + "type": "string", + "description": "Actions required for a private endpoint connection" + } + }, + "required": [ + "status" + ] + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "EndpointDependency": { + "description": "A domain name or IP address the Workspace is reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports used when connecting to domainName.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/EndpointDetail" + } + } + } + }, + "EndpointDetail": { + "description": "Connect information from the Workspace to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "latency": { + "format": "double", + "description": "The time in milliseconds it takes for the connection to be created from the Workspace to this IpAddress at this Port.", + "type": "number" + }, + "isAccessible": { + "description": "Whether it is possible to create a connection from the Workspace to this IpAddress at this Port.", + "type": "boolean" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which Workspace connects to for common purposes.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the Workspace, e.g. azure-storage, azure-mysql, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that Workspace connect to", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/EndpointDependency" + } + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of outbound network dependency endpoints", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "WorkspaceName": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace.", + "minLength": 3, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "PeeringNameParameter": { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace vNet peering.", + "x-ms-parameter-location": "method" + }, + "GroupId": { + "name": "groupId", + "in": "path", + "description": "The name of the private link resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/DisableEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/DisableEncryption.json new file mode 100644 index 000000000000..24505ae6db65 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/DisableEncryption.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "encryption": { + "value": { + "keySource": "Default" + } + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "PrivateBob" + }, + "customPublicSubnetName": { + "type": "String", + "value": "PublicSarah" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + }, + "prepareEncryption": { + "type": "Bool", + "value": true + }, + "encryption": { + "type": "Object", + "value": { + "keySource": "Default" + } + } + }, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/EnableEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/EnableEncryption.json new file mode 100644 index 000000000000..1e383c7151f9 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/EnableEncryption.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "prepareEncryption": { + "value": true + }, + "encryption": { + "value": { + "keySource": "Microsoft.Keyvault", + "keyvaulturi": "https://myKeyVault.vault.azure.net/", + "KeyName": "myKeyName", + "keyversion": "00000000000000000000000000000000" + } + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "PrivateBob" + }, + "customPublicSubnetName": { + "type": "String", + "value": "PublicSarah" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + }, + "prepareEncryption": { + "type": "Bool", + "value": true + }, + "encryption": { + "type": "Object", + "value": { + "keySource": "Microsoft.Keyvault", + "keyvaulturi": "https://myKeyVault.vault.azure.net/", + "KeyName": "myKeyName", + "keyversion": "00000000000000000000000000000000" + } + } + }, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/ListPrivateEndpointConnections.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/ListPrivateEndpointConnections.json new file mode 100644 index 000000000000..37ebbb2a8bd8 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/ListPrivateEndpointConnections.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-02-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/ListPrivateLinkResources.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/ListPrivateLinkResources.json new file mode 100644 index 000000000000..691969c2fb52 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/ListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-02-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateLinkResources/databricks_ui_api", + "name": "databricks_ui_api", + "type": "Microsoft.Databricks/workspaces/PrivateLinkResources", + "properties": { + "groupId": "databricks_ui_api", + "requiredMembers": [ + "databricks_ui_api" + ], + "requiredZoneNames": [ + "privatelink.azuredatabricks.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/OperationsList.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..23010522bd44 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/OperationsList.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "body": [ + { + "name": "Microsoft.Databricks/workspaces/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Workspace", + "operation": "List Workspaces", + "description": "Retrieves a list of workspaces." + } + }, + { + "name": "Microsoft.Databricks/workspaces/write", + "display": { + "provider": "Microsoft Databricks", + "resource": "Workspace", + "operation": "Create Workspace", + "description": "Creates an workspace." + } + }, + { + "name": "Microsoft.Databricks/workspaces/delete", + "display": { + "provider": "Microsoft Databricks", + "resource": "Workspace", + "operation": "Remove Workspace", + "description": "Removes an workspace." + } + }, + { + "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Virtual Network Peering", + "operation": "Get Virtual Network Peering", + "description": "Gets the virtual network peering." + } + }, + { + "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings/write", + "display": { + "provider": "Microsoft Databricks", + "resource": "Virtual Network Peering", + "operation": "Add Virtual Network Peering", + "description": "Add or modify virtual network peering" + } + }, + { + "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings/delete", + "display": { + "provider": "Microsoft Databricks", + "resource": "Virtual Network Peering", + "operation": "Delete Virtual Network Peering", + "description": "Deletes a virtual network peering" + } + }, + { + "name": "Microsoft.Databricks/workspaces/PrivateLinkResources/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Private Link Resources", + "operation": "List Private Link Resources", + "description": "Retrieve List of Private Link Resources" + } + }, + { + "name": "Microsoft.Databricks/workspaces/PrivateEndpointConnections/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Private Endpoint Connection", + "operation": "List Private Endpoint Connections", + "description": "Retrieve List of Private Endpoint Connections" + } + }, + { + "name": "Microsoft.Databricks/workspaces/PrivateEndpointConnections/write", + "display": { + "provider": "Microsoft Databricks", + "resource": "Private Endpoint Connection", + "operation": "Update Private Endpoint Connection", + "description": "Update a virtual network peering" + } + }, + { + "name": "Microsoft.Databricks/workspaces/PrivateEndpointConnections/delete", + "display": { + "provider": "Microsoft Databricks", + "resource": "Private Endpoint Connection", + "operation": "Delete Private Endpoint Connection", + "description": "Delete a Private Endpoint Connection" + } + }, + { + "name": "Microsoft.Databricks/accessConnectors/read", + "display": { + "provider": "Azure Databricks", + "resource": "AccessConnector", + "operation": "List Azure Databricks Access Connector", + "description": "Retrieves a list of Azure Databricks Access Connector." + } + }, + { + "name": "Microsoft.Databricks/accessConnectors/write", + "display": { + "provider": "Azure Databricks", + "resource": "AccessConnector", + "operation": "Create Azure Databricks Access Connector", + "description": "Creates an Azure Databricks Access Connector." + } + }, + { + "name": "Microsoft.Databricks/accessConnectors/delete", + "display": { + "provider": "Azure Databricks", + "resource": "AccessConnector", + "operation": "Remove Azure Databricks Access Connector", + "description": "Removes Azure Databricks Access Connector." + } + } + ] + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..a829cc8d3a3d --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-02-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": [ + { + "category": "Webapp", + "endpoints": [ + { + "endpointDetails": [ + { + "ipAddress": "11.111.111.11/11", + "port": 123 + }, + { + "ipAddress": "22.222.222.22/22", + "port": 123 + } + ] + } + ] + }, + { + "category": "Control Plane NAT", + "endpoints": [ + { + "endpointDetails": [ + { + "ipAddress": "33.33.333.333/33", + "port": 123 + } + ] + } + ] + }, + { + "category": "Extended infrastructure", + "endpoints": [ + { + "endpointDetails": [ + { + "ipAddress": "44.44.44.44/44", + "port": 123 + } + ] + } + ] + }, + { + "category": "Azure Storage", + "endpoints": [ + { + "domainName": "xxx.blob.core.windows.net", + "endpointDetails": [ + { + "port": 123 + } + ] + }, + { + "domainName": "yyy.blob.core.windows.net", + "endpointDetails": [ + { + "port": 123 + } + ] + }, + { + "domainName": "zzz.blob.core.windows.net", + "endpointDetails": [ + { + "port": 123 + } + ] + } + ] + }, + { + "category": "Azure My SQL", + "endpoints": [ + { + "domainName": "xxx.mysql.database.azure.com", + "endpointDetails": [ + { + "port": 1234 + } + ] + }, + { + "domainName": "yyy.mysql.database.azure.com", + "endpointDetails": [ + { + "port": 1234 + } + ] + } + ] + }, + { + "category": "Azure Servicebus", + "endpoints": [ + { + "domainName": "xxx.servicebus.windows.net", + "endpointDetails": [ + { + "port": 1234 + } + ] + } + ] + } + ] + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrepareEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrepareEncryption.json new file mode 100644 index 000000000000..9f8b8465b052 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrepareEncryption.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "prepareEncryption": { + "value": true + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + } + }, + "201": { + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateEndpointConnectionsDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..3bce69e26479 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-02-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "privateEndpointConnectionName": "myWorkspace.23456789-1111-1111-1111-111111111111" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/locations/exampleLocation/operationStatuses/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-02-01-preview", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/locations/exampleLocation/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-02-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateEndpointConnectionsGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..2be1f79cd0b4 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-02-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "privateEndpointConnectionName": "myWorkspace.23456789-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateEndpointConnectionsUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..963708bbe82e --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-02-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "privateEndpointConnectionName": "myWorkspace.23456789-1111-1111-1111-111111111111", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by databricksadmin@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by databricksadmin@contoso.com", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by databricksadmin@contoso.com", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateLinkResourcesGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateLinkResourcesGet.json new file mode 100644 index 000000000000..208671af98e9 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/PrivateLinkResourcesGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "groupId": "databricks_ui_api" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateLinkResources/databricks_ui_api", + "name": "databricks_ui_api", + "type": "Microsoft.Databricks/workspaces/PrivateLinkResources", + "properties": { + "groupId": "databricks_ui_api", + "requiredMembers": [ + "databricks_ui_api" + ], + "requiredZoneNames": [ + "privatelink.azuredatabricks.net" + ] + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceCreate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceCreate.json new file mode 100644 index 000000000000..9f2022f41742 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceCreate.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "defaultCatalog": { + "initialType": "UnityCatalog", + "initialName": "" + }, + "accessConnector": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "identityType": "SystemAssigned" + }, + "privateDbfsAccess": "Enabled" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "accessConnector": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "identityType": "SystemAssigned" + }, + "privateDbfsAccess": "Enabled", + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "defaultCatalog": { + "initialType": "UnityCatalog", + "initialName": "" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "accessConnector": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "identityType": "SystemAssigned" + }, + "privateDbfsAccess": "Enabled", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceCreateWithParameters.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceCreateWithParameters.json new file mode 100644 index 000000000000..6896cafc4cc2 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceCreateWithParameters.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "defaultCatalog": { + "initialType": "HiveMetastore", + "initialName": "" + }, + "accessConnector": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "identityType": "UserAssigned", + "userAssignedIdentityId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + }, + "privateDbfsAccess": "Enabled", + "parameters": { + "customVirtualNetworkId": { + "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + }, + "customPublicSubnetName": { + "value": "myPublicSubnet" + }, + "customPrivateSubnetName": { + "value": "myPrivateSubnet" + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "myPrivateSubnet" + }, + "customPublicSubnetName": { + "type": "String", + "value": "myPublicSubnet" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + } + }, + "accessConnector": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "identityType": "UserAssigned", + "userAssignedIdentityId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + }, + "privateDbfsAccess": "Enabled", + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "defaultCatalog": { + "initialType": "HiveMetastore", + "initialName": "" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "isUcEnabled": true, + "accessConnector": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector", + "identityType": "UserAssigned", + "userAssignedIdentityId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + }, + "privateDbfsAccess": "Enabled", + "defaultCatalog": { + "initialType": "HiveMetastore", + "initialName": "" + } + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceDelete.json new file mode 100644 index 000000000000..d1fbc8f3b1b0 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "rg", + "api-version": "2024-02-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-02-01-preview", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-02-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceDeleteRetainUcData.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceDeleteRetainUcData.json new file mode 100644 index 000000000000..9637365a32bc --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceDeleteRetainUcData.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "rg", + "api-version": "2024-02-01-preview", + "subscriptionId": "subid", + "retainUcData": "false" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-02-01-preview", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-02-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceEnhancedSecurityComplianceCreateOrUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceEnhancedSecurityComplianceCreateOrUpdate.json new file mode 100644 index 000000000000..7ad3f3b43ca9 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceEnhancedSecurityComplianceCreateOrUpdate.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "enhancedSecurityCompliance": { + "automaticClusterUpdate": { + "value": "Enabled" + }, + "complianceSecurityProfile": { + "value": "Enabled", + "complianceStandards": [ + "PCI_DSS", + "HIPAA" + ] + }, + "enhancedSecurityMonitoring": { + "value": "Enabled" + } + } + }, + "location": "eastus2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "enhancedSecurityCompliance": { + "automaticClusterUpdate": { + "value": "Enabled" + }, + "complianceSecurityProfile": { + "value": "Enabled", + "complianceStandards": [ + "PCI_DSS", + "HIPAA" + ] + }, + "enhancedSecurityMonitoring": { + "value": "Enabled" + } + }, + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2023-08-24T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "enhancedSecurityCompliance": { + "automaticClusterUpdate": { + "value": "Enabled" + }, + "complianceSecurityProfile": { + "value": "Enabled", + "complianceStandards": [ + "PCI_DSS", + "HIPAA" + ] + }, + "enhancedSecurityMonitoring": { + "value": "Enabled" + } + }, + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2023-08-24T00:10:29.2858439Z", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceEnhancedSecurityComplianceGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceEnhancedSecurityComplianceGet.json new file mode 100644 index 000000000000..b4d5249004d4 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceEnhancedSecurityComplianceGet.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "enhancedSecurityCompliance": { + "automaticClusterUpdate": { + "value": "Enabled" + }, + "complianceSecurityProfile": { + "value": "Enabled", + "complianceStandards": [ + "PCI_DSS", + "HIPAA" + ] + }, + "enhancedSecurityMonitoring": { + "value": "Enabled" + } + }, + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2023-08-24T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceGet.json new file mode 100644 index 000000000000..52f779d4151c --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceGetParameters.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceGetParameters.json new file mode 100644 index 000000000000..d3ce612ff603 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceGetParameters.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "PrivateBob" + }, + "customPublicSubnetName": { + "type": "String", + "value": "PublicSarah" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + } + }, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "privateEndpointConnections": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace/privateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subscriptionId/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + ], + "publicNetworkAccess": "Disabled", + "requiredNsgRules": "NoAzureDatabricksRules", + "isUcEnabled": false + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceManagedDiskEncryptionCreate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceManagedDiskEncryptionCreate.json new file mode 100644 index 000000000000..2ec2c85cf379 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceManagedDiskEncryptionCreate.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "managedDiskIdentity": { + "principalId": "22222222-2222-2222-2222-222222222222", + "tenantId": "44444444-4444-4444-4444-444444444444", + "type": "SystemAssigned" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "managedDiskIdentity": { + "principalId": "22222222-2222-2222-2222-222222222222", + "tenantId": "44444444-4444-4444-4444-444444444444", + "type": "SystemAssigned" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceManagedDiskEncryptionGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceManagedDiskEncryptionGet.json new file mode 100644 index 000000000000..d6044e762e65 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceManagedDiskEncryptionGet.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "managedDiskIdentity": { + "principalId": "22222222-2222-2222-2222-222222222222", + "tenantId": "44444444-4444-4444-4444-444444444444", + "type": "SystemAssigned" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceManagedDiskEncryptionUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceManagedDiskEncryptionUpdate.json new file mode 100644 index 000000000000..75b98ec82aa5 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceManagedDiskEncryptionUpdate.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + } + }, + "location": "westus", + "tags": { + "mytag1": "myvalue1" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "mytag1": "myvalue1" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "managedDiskIdentity": { + "principalId": "22222222-2222-2222-2222-222222222222", + "tenantId": "44444444-4444-4444-4444-444444444444", + "type": "SystemAssigned" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "mytag1": "myvalue1" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "encryption": { + "entities": { + "managedDisk": { + "keySource": "Microsoft.Keyvault", + "keyVaultProperties": { + "keyVaultUri": "https://test-vault-name.vault.azure.net/", + "keyName": "test-cmk-key", + "keyVersion": "00000000000000000000000000000000" + }, + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "managedDiskIdentity": { + "principalId": "22222222-2222-2222-2222-222222222222", + "tenantId": "44444444-4444-4444-4444-444444444444", + "type": "SystemAssigned" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net", + "isUcEnabled": true + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceUpdate.json new file mode 100644 index 000000000000..de44222a9f2f --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceUpdate.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview", + "parameters": { + "tags": { + "mytag1": "myvalue1" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "mytag1": "myvalue1" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net", + "isUcEnabled": true + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-02-01-preview", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-02-01-preview" + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetPeeringGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetPeeringGet.json new file mode 100644 index 000000000000..d6b81cef19ed --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetPeeringGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "peeringName": "vNetPeering", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest", + "name": "vNetPeeringTest", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "10.203.0.0/16" + ] + }, + "databricksVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet" + }, + "databricksAddressSpace": { + "addressPrefixes": [ + "10.139.0.0/16" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + }, + "204": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetPeeringList.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetPeeringList.json new file mode 100644 index 000000000000..323b29b6ab70 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetPeeringList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest", + "name": "vNetPeeringTest", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "10.203.0.0/16" + ] + }, + "databricksVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet" + }, + "databricksAddressSpace": { + "addressPrefixes": [ + "10.139.0.0/16" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json new file mode 100644 index 000000000000..816ce6102c70 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "peeringName": "vNetPeeringTest", + "api-version": "2024-02-01-preview", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "allowVirtualNetworkAccess": true, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "useRemoteGateways": false + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest", + "name": "vNetPeeringTest", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "10.203.0.0/16" + ] + }, + "databricksVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet" + }, + "databricksAddressSpace": { + "addressPrefixes": [ + "10.139.0.0/16" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Updating" + } + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest", + "name": "vNetPeeringTest", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "10.203.0.0/16" + ] + }, + "databricksVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet" + }, + "databricksAddressSpace": { + "addressPrefixes": [ + "10.139.0.0/16" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetworkPeeringDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetworkPeeringDelete.json new file mode 100644 index 000000000000..d3121948e5af --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspaceVirtualNetworkPeeringDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "peeringName": "vNetPeering", + "api-version": "2024-02-01-preview" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/providers/Microsoft.Network/locations/exampleLocation/operations/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-02-01-preview", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/providers/Microsoft.Network/locations/exampleLocation/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2024-02-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspacesListByResourceGroup.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspacesListByResourceGroup.json new file mode 100644 index 000000000000..6bb562a95356 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspacesListByResourceGroup.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "myWorkspace1", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace1", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + }, + { + "name": "myWorkspace2", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace2", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "standard" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net", + "isUcEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspacesListBySubscription.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspacesListBySubscription.json new file mode 100644 index 000000000000..da7836b22f9c --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/examples/WorkspacesListBySubscription.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "myWorkspace1", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace1", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "isUcEnabled": true + } + }, + { + "name": "myWorkspace2", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace2", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "standard" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net", + "isUcEnabled": false + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/vnetpeering.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/vnetpeering.json new file mode 100644 index 000000000000..48c06f3d0eb1 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2024-02-01-preview/vnetpeering.json @@ -0,0 +1,490 @@ +{ + "swagger": "2.0", + "info": { + "title": "DatabricksClient", + "version": "2024-02-01-preview", + "description": "ARM Databricks" + }, + "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.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName}": { + "get": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_Get", + "description": "Gets the workspace vNet Peering.", + "x-ms-examples": { + "Get a workspace with vNet Peering Configured": { + "$ref": "./examples/WorkspaceVirtualNetPeeringGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PeeringNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "204": { + "description": "OK - NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_Delete", + "description": "Deletes the workspace vNetPeering.", + "x-ms-examples": { + "Delete a workspace vNet Peering": { + "$ref": "./examples/WorkspaceVirtualNetworkPeeringDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PeeringNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "204": { + "description": "NoContent" + }, + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_CreateOrUpdate", + "description": "Creates vNet Peering for workspace.", + "x-ms-examples": { + "Create vNet Peering for Workspace": { + "$ref": "./examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json" + } + }, + "parameters": [ + { + "name": "VirtualNetworkPeeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "Parameters supplied to the create workspace vNet Peering." + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PeeringNameParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the workspace vNet peering, including provisioning status.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "200": { + "description": "Update succeeded - Returns information about the workspace vNet peering.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings": { + "get": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_ListByWorkspace", + "description": "Lists the workspace vNet Peerings.", + "x-ms-examples": { + "List all vNet Peerings for the workspace": { + "$ref": "./examples/WorkspaceVirtualNetPeeringList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List succeeded. Returns the resulting resource objects in response body.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeeringList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ErrorDetail": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorInfo": { + "title": "The code and message for an error.", + "type": "object", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + }, + "innererror": { + "description": "Inner error details if they exist.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorResponse": { + "title": "Error response.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/ErrorInfo" + } + }, + "required": [ + "error" + ] + }, + "VirtualNetworkPeeringList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "List of virtual network peerings on workspace." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of virtual network peering list results if there are any." + } + }, + "description": "Gets all virtual network peerings under a workspace." + }, + "VirtualNetworkPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat", + "description": "List of properties for vNet Peering" + }, + "name": { + "type": "string", + "description": "Name of the virtual network peering resource", + "readOnly": true + }, + "id": { + "type": "string", + "description": "Resource ID.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "type of the virtual network peering resource", + "readOnly": true + } + }, + "required": [ + "properties" + ], + "description": "Peerings in a VirtualNetwork resource", + "x-ms-azure-resource": true + }, + "VirtualNetworkPeeringPropertiesFormat": { + "properties": { + "allowVirtualNetworkAccess": { + "type": "boolean", + "description": "Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space." + }, + "allowForwardedTraffic": { + "type": "boolean", + "description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network." + }, + "allowGatewayTransit": { + "type": "boolean", + "description": "If gateway links can be used in remote virtual networking to link to this virtual network." + }, + "useRemoteGateways": { + "type": "boolean", + "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway." + }, + "databricksVirtualNetwork": { + "properties": { + "id": { + "type": "string", + "description": "The Id of the databricks virtual network." + } + }, + "description": " The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)." + }, + "databricksAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the databricks virtual network address space." + }, + "remoteVirtualNetwork": { + "properties": { + "id": { + "type": "string", + "description": "The Id of the remote virtual network." + } + }, + "description": " The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)." + }, + "remoteAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the remote virtual network address space." + }, + "peeringState": { + "type": "string", + "description": "The status of the virtual network peering.", + "enum": [ + "Initiated", + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "peeringState", + "modelAsString": true + }, + "readOnly": true + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/PeeringProvisioningState", + "description": "The provisioning state of the virtual network peering resource." + } + }, + "required": [ + "remoteVirtualNetwork" + ], + "description": "Properties of the virtual network peering." + }, + "PeeringProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PeeringProvisioningState", + "modelAsString": true + } + }, + "AddressSpace": { + "properties": { + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of address blocks reserved for this virtual network in CIDR notation." + } + }, + "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "WorkspaceName": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace.", + "minLength": 3, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "PeeringNameParameter": { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace vNet peering.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/databricks/resource-manager/readme.md b/specification/databricks/resource-manager/readme.md index c8d58ca4b178..10a89e5d767b 100644 --- a/specification/databricks/resource-manager/readme.md +++ b/specification/databricks/resource-manager/readme.md @@ -10,6 +10,7 @@ This is the AutoRest configuration file for Databricks. ``` yaml $(java) && $(multiapi) batch: + - tag: package-2024-02-01-preview - tag: package-2023-09-15-preview - tag: package-2023-02-01 - tag: package-2022-04-01-preview @@ -18,6 +19,20 @@ batch: - tag: package-2023-05-01 ``` + +### Tag: package-2024-02-01-preview and java + +These settings apply only when `--tag=package-2024-02-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2024-02-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.databricks.v2024_02_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/databricks/mgmt-v2024_02_01_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2023-09-15-preview and java These settings apply only when `--tag=package-2023-09-15-preview --java` is specified on the command line. @@ -118,7 +133,7 @@ These are the global settings for the Databricks API. title: AzureDatabricksManagementClient description: The Microsoft Azure management APIs allow end users to operate on Azure Databricks Workspace / Access Connector resources. openapi-type: arm -tag: package-preview-2023-09 +tag: package-2024-02-01-preview ``` ### Tag: package-2018-04-01 @@ -176,7 +191,7 @@ input-file: ### Tag: package-2023-09-15-preview -These settings apply only when `--tag=package-2023-05-01` is specified on the command line. +These settings apply only when `--tag=package-2023-09-15-preview` is specified on the command line. ``` yaml $(tag) == 'package-2023-09-15-preview' input-file: @@ -185,6 +200,17 @@ input-file: - Microsoft.Databricks/stable/2023-05-01/accessconnector.json ``` +### Tag: package-2024-02-01-preview + +These settings apply only when `--tag=package-2024-02-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-02-01-preview' +input-file: +- Microsoft.Databricks/preview/2024-02-01-preview/databricks.json +- Microsoft.Databricks/preview/2024-02-01-preview/vnetpeering.json +- Microsoft.Databricks/stable/2023-05-01/accessconnector.json +``` + --- # Suppressions diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index 076007013dcb..095719aeb127 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -38,7 +38,7 @@ }, "schema": { "type": "object", - "x-ms-format": "dfe-object", + "x-ms-format": "dfe-list-generic", "x-ms-format-element-type": "DatasetSchemaDataElement", "description": "Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement." }, @@ -3523,6 +3523,26 @@ "typeProperties" ] }, + "SnowflakeV2Dataset": { + "x-ms-discriminator-value": "SnowflakeV2Table", + "description": "The snowflake dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Snowflake dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnowflakeDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, "SnowflakeDatasetTypeProperties": { "description": "Snowflake dataset properties.", "properties": { 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 7663163766cf..f7d66156c8e6 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 @@ -7452,6 +7452,106 @@ "connectionString" ] }, + "SnowflakeV2LinkedService": { + "x-ms-discriminator-value": "SnowflakeV2", + "description": "Snowflake linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Snowflake linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnowflakeLinkedV2ServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SnowflakeLinkedV2ServiceTypeProperties": { + "description": "Snowflake linked service properties.", + "type": "object", + "properties": { + "accountIdentifier": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure" + }, + "user": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name of the Snowflake user." + }, + "password": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "The Azure key vault secret reference of password in connection string." + }, + "database": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name of the Snowflake database." + }, + "warehouse": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name of the Snowflake warehouse." + }, + "authenticationType": { + "x-ms-enum": { + "name": "SnowflakeAuthenticationType", + "modelAsString": true + }, + "enum": [ + "Basic", + "KeyPair", + "AADServicePrincipal" + ], + "type": "string", + "default": "Basic", + "description": "The type used for authentication. Type: string." + }, + "clientId": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication." + }, + "clientSecret": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "The Azure key vault secret reference of client secret for AADServicePrincipal authentication." + }, + "tenantId": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication." + }, + "scope": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication." + }, + "privateKey": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "The Azure key vault secret reference of privateKey for KeyPair auth." + }, + "privateKeyPassphrase": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key." + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." + } + }, + "required": [ + "accountIdentifier", + "database", + "warehouse" + ] + }, "SharePointOnlineListLinkedService": { "x-ms-discriminator-value": "SharePointOnlineList", "description": "SharePoint Online List linked service.", @@ -7643,6 +7743,11 @@ "x-ms-format": "dfe-string", "description": "The URL of Salesforce instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." }, + "authenticationType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value" + }, "clientId": { "type": "object", "x-ms-format": "dfe-string", @@ -7692,6 +7797,11 @@ "x-ms-format": "dfe-string", "description": "The URL of Salesforce Service Cloud instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." }, + "authenticationType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value" + }, "clientId": { "type": "object", "x-ms-format": "dfe-string", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 2df9f6468e1f..662f071f4f8d 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -4293,6 +4293,29 @@ "exportSettings" ] }, + "SnowflakeV2Source": { + "description": "A copy activity snowflake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Snowflake Sql query. Type: string (or Expression with resultType string)." + }, + "exportSettings": { + "$ref": "#/definitions/SnowflakeExportCopyCommand", + "description": "Snowflake export settings." + } + }, + "required": [ + "exportSettings" + ] + }, "ExportSettings": { "description": "Export command settings.", "discriminator": "type", @@ -5233,6 +5256,26 @@ } } }, + "SnowflakeV2Sink": { + "description": "A copy activity snowflake sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "importSettings": { + "$ref": "#/definitions/SnowflakeImportCopyCommand", + "description": "Snowflake import settings." + } + } + }, "ImportSettings": { "description": "Import command settings.", "discriminator": "type", @@ -7090,8 +7133,11 @@ }, "headers": { "type": "object", - "x-ms-format": "dfe-key-value-pairs", - "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: dictionary (or Expression with resultType dictionary)." + "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string).", + "additionalProperties": { + "type": "string", + "x-ms-format": "dfe-string" + } }, "body": { "type": "object", @@ -8128,8 +8174,11 @@ }, "headers": { "type": "object", - "x-ms-format": "dfe-key-value-pairs", - "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: dictionary (or Expression with resultType dictionary)." + "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string).", + "additionalProperties": { + "type": "string", + "x-ms-format": "dfe-string" + } }, "body": { "type": "object", @@ -8194,8 +8243,11 @@ }, "headers": { "type": "object", - "x-ms-format": "dfe-key-value-pairs", - "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: dictionary (or Expression with resultType dictionary)." + "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string).", + "additionalProperties": { + "type": "string", + "x-ms-format": "dfe-string" + } }, "body": { "type": "object", @@ -9013,10 +9065,10 @@ "x-ms-format": "dfe-string", "description": "Database query. Type: string (or Expression with resultType string)." }, - "readBehavior": { - "description": "The read behavior for the operation. Default is query. Allowed values: query/queryAll. Type: string (or Expression with resultType string).", + "includeDeletedObjects": { + "description": "This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean).", "type": "object", - "x-ms-format": "dfe-string" + "x-ms-format": "dfe-bool" } } }, @@ -9034,10 +9086,10 @@ "x-ms-format": "dfe-string", "description": "Database query. Type: string (or Expression with resultType string)." }, - "readBehavior": { - "description": "The read behavior for the operation. Default is query. Allowed values: query/queryAll. Type: string (or Expression with resultType string).", + "includeDeletedObjects": { + "description": "This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean).", "type": "object", - "x-ms-format": "dfe-string" + "x-ms-format": "dfe-bool" }, "additionalColumns": { "type": "object", @@ -9045,18 +9097,6 @@ } } }, - "SalesforceV2SourceReadBehavior": { - "description": "The Salesforce read behavior for the operation", - "type": "string", - "enum": [ - "query", - "queryAll" - ], - "x-ms-enum": { - "name": "SalesforceV2SourceReadBehavior", - "modelAsString": true - } - }, "SalesforceV2Sink": { "description": "A copy activity Salesforce V2 sink.", "type": "object", diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json deleted file mode 100644 index ee21a3664bbf..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json +++ /dev/null @@ -1,1871 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2018-09-01-preview", - "title": "AzureDeploymentManager", - "description": "REST APIs for orchestrating deployments using the Azure Deployment Manager (ADM). See https://docs.microsoft.com/azure/azure-resource-manager/deployment-manager-overview for more information." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}": { - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "put": { - "tags": [ - "ServiceTopologies" - ], - "operationId": "ServiceTopologies_CreateOrUpdate", - "summary": "Creates or updates a service topology.", - "description": "Synchronously creates a new service topology or updates an existing service topology.", - "x-ms-examples": { - "Create a topology with Artifact Source": { - "$ref": "./examples/servicetopology_createorupdate.json" - }, - "Create a topology without Artifact Source": { - "$ref": "./examples/servicetopology_createorupdate_noartifactsource.json" - } - }, - "parameters": [ - { - "in": "body", - "name": "serviceTopologyInfo", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceTopologyResource" - }, - "description": "Source topology object defines the resource." - } - ], - "responses": { - "201": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceTopologyResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard Error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "ServiceTopologies" - ], - "operationId": "ServiceTopologies_Get", - "summary": "Gets the service topology.", - "x-ms-examples": { - "Get topology": { - "$ref": "./examples/servicetopology_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceTopologyResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "ServiceTopologies" - ], - "operationId": "ServiceTopologies_Delete", - "summary": "Deletes the service topology.", - "x-ms-examples": { - "Delete topology": { - "$ref": "./examples/servicetopology_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The topology was successfully deleted." - }, - "204": { - "description": "The topology was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}": { - "put": { - "tags": [ - "Services" - ], - "operationId": "Services_CreateOrUpdate", - "summary": "Creates or updates a service in the service topology.", - "description": "Synchronously creates a new service or updates an existing service.", - "x-ms-examples": { - "Create service": { - "$ref": "./examples/service_createorupdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "serviceInfo", - "description": "The service object", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceResource" - } - } - ], - "responses": { - "201": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "Services" - ], - "operationId": "Services_Get", - "summary": "Gets the service.", - "x-ms-examples": { - "Get service": { - "$ref": "./examples/service_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Services" - ], - "operationId": "Services_Delete", - "summary": "Deletes the service.", - "x-ms-examples": { - "Delete service": { - "$ref": "./examples/service_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The service was successfully deleted." - }, - "204": { - "description": "The service was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}/serviceUnits/{serviceUnitName}": { - "put": { - "tags": [ - "ServiceUnits" - ], - "operationId": "ServiceUnits_CreateOrUpdate", - "x-ms-long-running-operation": true, - "summary": "Creates or updates a service unit under the service in the service topology.", - "description": "This is an asynchronous operation and can be polled to completion using the operation resource returned by this operation.", - "x-ms-examples": { - "Create service unit using relative paths into the artifact source": { - "$ref": "./examples/serviceunit_createorupdate.json" - }, - "Create service unit using SAS URIs": { - "$ref": "./examples/serviceunit_createorupdate_noartifactsource.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/serviceUnitName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "serviceUnitInfo", - "description": "The service unit resource object.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceUnitResource" - } - } - ], - "responses": { - "201": { - "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.", - "headers": { - "Azure-AsyncOperation": { - "type": "string", - "description": "Contains the status URL on which clients are expected to poll the status of the operation." - } - }, - "schema": { - "$ref": "#/definitions/ServiceUnitResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "ServiceUnits" - ], - "operationId": "ServiceUnits_Get", - "summary": "Gets the service unit.", - "x-ms-examples": { - "Get service unit": { - "$ref": "./examples/serviceunit_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/serviceUnitName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceUnitResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "ServiceUnits" - ], - "operationId": "ServiceUnits_Delete", - "summary": "Deletes the service unit.", - "x-ms-examples": { - "Delete service unit": { - "$ref": "./examples/serviceunit_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/serviceUnitName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The service unit was successfully deleted." - }, - "204": { - "description": "The service unit was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/steps/{stepName}": { - "put": { - "tags": [ - "Steps" - ], - "operationId": "Steps_CreateOrUpdate", - "summary": "Creates or updates a rollout step with the given step properties.", - "description": "Synchronously creates a new step or updates an existing step.", - "x-ms-examples": { - "Create deployment step": { - "$ref": "./examples/step_createorupdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/stepName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "stepInfo", - "description": "The step object.", - "schema": { - "$ref": "#/definitions/StepResource" - } - } - ], - "responses": { - "201": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StepResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "Steps" - ], - "operationId": "Steps_Get", - "summary": "Gets the step.", - "x-ms-examples": { - "Get deployment step": { - "$ref": "./examples/step_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/stepName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StepResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Steps" - ], - "operationId": "Steps_Delete", - "summary": "Deletes the step.", - "x-ms-examples": { - "Delete deployment step": { - "$ref": "./examples/step_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/stepName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The step was successfully deleted." - }, - "204": { - "description": "The step was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts/{rolloutName}": { - "put": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_CreateOrUpdate", - "x-ms-long-running-operation": true, - "summary": "Creates or updates a rollout.", - "description": "This is an asynchronous operation and can be polled to completion using the location header returned by this operation.", - "x-ms-examples": { - "Create or update rollout": { - "$ref": "./examples/rollout_createorupdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "rolloutRequest", - "description": "Source rollout request object that defines the rollout.", - "schema": { - "$ref": "#/definitions/RolloutRequest" - } - } - ], - "responses": { - "201": { - "description": "This is a long running operation. The operation returns a 201 if the request was successfully registered and basic validation is successful. The response includes an Azure-AsyncOperation header that contains the operation status URL. Clients are expected to poll the status URL for the status of the operation.", - "headers": { - "Azure-AsyncOperation": { - "type": "string", - "description": "Contains the status URL on which clients are expected to poll the status of the operation." - } - }, - "schema": { - "$ref": "#/definitions/RolloutRequest" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_Get", - "summary": "Gets detailed information of a rollout.", - "x-ms-examples": { - "Get rollout": { - "$ref": "./examples/rollout_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/retryAttempt" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Rollout" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_Delete", - "summary": "Deletes a rollout resource.", - "description": "Only rollouts in terminal state can be deleted.", - "x-ms-examples": { - "Delete rollout": { - "$ref": "./examples/rollout_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The rollout was successfully deleted." - }, - "204": { - "description": "The rollout was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts/{rolloutName}/cancel": { - "post": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_Cancel", - "summary": "Stops a running rollout.", - "description": "Only running rollouts can be canceled.", - "x-ms-examples": { - "Cancel rollout": { - "$ref": "./examples/rollout_post_cancel.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Rollout" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts/{rolloutName}/restart": { - "post": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_Restart", - "summary": "Restarts a failed rollout and optionally skips all succeeded steps.", - "description": "Only failed rollouts can be restarted.", - "x-ms-examples": { - "Restart rollout": { - "$ref": "./examples/rollout_post_restart.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "name": "skipSucceeded", - "in": "query", - "required": false, - "type": "boolean", - "description": "If true, will skip all succeeded steps so far in the rollout. If false, will execute the entire rollout again regardless of the current state of individual resources. Defaults to false if not specified." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Rollout" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/artifactSources/{artifactSourceName}": { - "put": { - "tags": [ - "ArtifactSources" - ], - "operationId": "ArtifactSources_CreateOrUpdate", - "summary": "Creates or updates an artifact source.", - "description": "Synchronously creates a new artifact source or updates an existing artifact source.", - "x-ms-examples": { - "Create artifact source": { - "$ref": "./examples/artifactsource_createorupdate.json" - }, - "Create artifact source with artifact root, an offset into the storage container": { - "$ref": "./examples/artifactsource_createorupdate_artifactroot.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/artifactSourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "artifactSourceInfo", - "description": "Source object that defines the resource.", - "schema": { - "$ref": "#/definitions/ArtifactSource" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ArtifactSource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "ArtifactSources" - ], - "operationId": "ArtifactSources_Get", - "summary": "Gets an artifact source.", - "x-ms-examples": { - "Get artifact source": { - "$ref": "./examples/artifactsource_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/artifactSourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ArtifactSource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "ArtifactSources" - ], - "operationId": "ArtifactSources_Delete", - "summary": "Deletes an artifact source.", - "x-ms-examples": { - "Delete artifact source": { - "$ref": "./examples/artifactsource_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/artifactSourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The artifact source was successfully deleted." - }, - "204": { - "description": "The artifact source was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DeploymentManager/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_Get", - "summary": "Gets an operation resource.", - "x-ms-examples": { - "Get operations": { - "$ref": "./examples/operations_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The operation details are successfully returned. The response code does not determine if the request which this operation corresponds to is successful. Check the response content for the status and any error information on failures.", - "schema": { - "$ref": "#/definitions/OperationsList" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "Identity": { - "description": "Identity for the resource.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The identity type.", - "example": "userAssigned" - }, - "identityIds": { - "type": "array", - "items": { - "type": "string", - "example": "/subscriptions/mySubId/resourcegroups/myRG/providers/Microsoft.ManagedIdentity/userassignedidentities/myIdentity" - }, - "description": "The list of identities." - } - }, - "required": [ - "type", - "identityIds" - ] - }, - "RolloutRequest": { - "description": "Defines the PUT rollout request body.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "identity": { - "description": "Identity for the resource.", - "$ref": "#/definitions/Identity" - }, - "properties": { - "description": "Defines the properties that make up a rollout request.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/RolloutRequestProperties" - } - }, - "required": [ - "identity", - "properties" - ] - }, - "RolloutRequestProperties": { - "description": "The properties for defining a rollout.", - "properties": { - "buildVersion": { - "type": "string", - "description": "The version of the build being deployed.", - "example": "1.0.0.1" - }, - "artifactSourceId": { - "type": "string", - "description": "The reference to the artifact source resource Id where the payload is located.", - "example": "Microsoft.DeploymentManager/artifactSources/payloadStore1" - }, - "targetServiceTopologyId": { - "type": "string", - "description": "The resource Id of the service topology from which service units are being referenced in step groups to be deployed.", - "example": "Microsoft.DeploymentManager/serviceTopologies/myServiceTopology" - }, - "stepGroups": { - "description": "The list of step groups that define the orchestration.", - "type": "array", - "items": { - "$ref": "#/definitions/Step" - } - } - }, - "required": [ - "stepGroups", - "targetServiceTopologyId", - "buildVersion" - ] - }, - "Step": { - "description": "The properties that define an Azure Deployment Manager step.", - "properties": { - "name": { - "description": "The name of the step group.", - "type": "string" - }, - "dependsOnStepGroups": { - "description": "The list of step group names on which this step group depends on.", - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "stepGroup1", - "stepGroup2" - ] - }, - "preDeploymentSteps": { - "description": "The list of steps to be run before deploying the target.", - "type": "array", - "items": { - "$ref": "#/definitions/PrePostStep" - } - }, - "deploymentTargetId": { - "description": "The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId", - "type": "string", - "example": "Microsoft.DeploymentManager/serviceTopologies/myServiceTopology/services/myService/serviceUnits/database" - }, - "postDeploymentSteps": { - "description": "The list of steps to be run after deploying the target.", - "type": "array", - "items": { - "$ref": "#/definitions/PrePostStep" - } - } - }, - "required": [ - "deploymentTargetId", - "name" - ] - }, - "PrePostStep": { - "description": "The properties that define a step.", - "properties": { - "stepId": { - "type": "string", - "description": "The resource Id of the step to be run.", - "example": "Microsoft.DeploymentManager/steps/healthCheckStep1" - } - }, - "required": [ - "stepId" - ] - }, - "ArtifactSource": { - "description": "The resource that defines the source location where the artifacts are located.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties that define the artifact source.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ArtifactSourceProperties" - } - ] - } - } - }, - "ArtifactSourceProperties": { - "description": "The properties that define the source location where the artifacts are located.", - "properties": { - "sourceType": { - "type": "string", - "description": "The type of artifact source used.", - "example": "AzureStorage" - }, - "artifactRoot": { - "type": "string", - "description": "The path from the location that the 'authentication' property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.", - "example": "binaries/2018.09.24" - }, - "authentication": { - "description": "The authentication method to use to access the artifact source.", - "$ref": "#/definitions/Authentication" - } - }, - "required": [ - "sourceType", - "authentication" - ] - }, - "Authentication": { - "description": "Defines the authentication method and properties to access the artifacts.", - "type": "object", - "discriminator": "type", - "properties": { - "type": { - "type": "string", - "description": "The authentication type" - } - }, - "required": [ - "type" - ] - }, - "SasAuthentication": { - "x-ms-discriminator-value": "Sas", - "type": "object", - "description": "Defines the properties to access the artifacts using an Azure Storage SAS URI.", - "allOf": [ - { - "$ref": "#/definitions/Authentication" - } - ], - "properties": { - "properties": { - "description": "The SAS properties", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SasProperties" - } - } - }, - "SasProperties": { - "description": "The properties that define SAS authentication.", - "properties": { - "sasUri": { - "type": "string", - "description": "The SAS URI to the Azure Storage blob container. Any offset from the root of the container to where the artifacts are located can be defined in the artifactRoot." - } - }, - "required": [ - "sasUri" - ] - }, - "Rollout": { - "description": "Defines the rollout.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "identity": { - "description": "Identity for the resource.", - "$ref": "#/definitions/Identity" - }, - "properties": { - "description": "The properties that define a rollout.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/RolloutRequestProperties" - }, - { - "$ref": "#/definitions/RolloutProperties" - } - ] - } - } - }, - "RolloutProperties": { - "description": "Defines the properties of a rollout.", - "properties": { - "status": { - "type": "string", - "readOnly": true, - "description": "The current status of the rollout." - }, - "totalRetryAttempts": { - "type": "integer", - "format": "int32", - "readOnly": true, - "description": "The cardinal count of total number of retries performed on the rollout at a given time." - }, - "operationInfo": { - "readOnly": true, - "$ref": "#/definitions/RolloutOperationInfo", - "description": "Operational information of the rollout." - }, - "services": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Service" - }, - "description": "The detailed information on the services being deployed." - } - } - }, - "RolloutOperationInfo": { - "description": "Detailed runtime information of the rollout.", - "properties": { - "retryAttempt": { - "type": "integer", - "format": "int32", - "readOnly": true, - "description": "The ordinal count of the number of retry attempts on a rollout. 0 if no retries of the rollout have been performed. If the rollout is updated with a PUT, this count is reset to 0." - }, - "skipSucceededOnRetry": { - "type": "boolean", - "readOnly": true, - "description": "True, if all steps that succeeded on the previous run/attempt were chosen to be skipped in this retry attempt. False, otherwise." - }, - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The start time of the rollout in UTC." - }, - "endTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The start time of the rollout in UTC. This property will not be set if the rollout has not completed yet." - }, - "error": { - "description": "The detailed error information for any failure.", - "readOnly": true, - "$ref": "#/definitions/CloudErrorBody" - } - } - }, - "ServiceTopologyResource": { - "description": "The resource representation of a service topology.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties that define the service topology.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ServiceTopologyProperties" - } - ] - } - }, - "required": [ - "properties" - ] - }, - "ServiceTopologyProperties": { - "description": "The properties of a service topology.", - "properties": { - "artifactSourceId": { - "type": "string", - "description": "The resource Id of the artifact source that contains the artifacts that can be referenced in the service units." - } - } - }, - "ServiceResource": { - "description": "The resource representation of a service in a service topology.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties that define a service in a service topology.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ServiceProperties" - } - ] - } - }, - "required": [ - "properties" - ] - }, - "Service": { - "description": "Defines a service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceProperties" - } - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the service." - }, - "serviceUnits": { - "description": "The detailed information about the units that make up the service.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceUnit" - } - } - } - }, - "ServiceProperties": { - "description": "The properties of a service.", - "properties": { - "targetLocation": { - "type": "string", - "description": "The Azure location to which the resources in the service belong to or should be deployed to." - }, - "targetSubscriptionId": { - "type": "string", - "description": "The subscription to which the resources in the service belong to or should be deployed to." - } - }, - "required": [ - "targetLocation", - "targetSubscriptionId" - ] - }, - "ServiceUnitResource": { - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "description": "Represents the response of a service unit resource.", - "properties": { - "properties": { - "description": "The properties that define the service unit.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ServiceUnitProperties" - } - ] - } - }, - "required": [ - "properties" - ] - }, - "ServiceUnit": { - "description": "Defines a service unit.", - "allOf": [ - { - "$ref": "#/definitions/ServiceUnitProperties" - } - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the service unit." - }, - "steps": { - "type": "array", - "items": { - "$ref": "#/definitions/RolloutStep" - }, - "description": "Detailed step information, if present." - } - } - }, - "ServiceUnitProperties": { - "description": "Defines the properties of a service unit.", - "properties": { - "targetResourceGroup": { - "type": "string", - "description": "The Azure Resource Group to which the resources in the service unit belong to or should be deployed to." - }, - "deploymentMode": { - "type": "string", - "enum": [ - "Incremental", - "Complete" - ], - "x-ms-enum": { - "name": "DeploymentMode", - "modelAsString": false - }, - "description": "Describes the type of ARM deployment to be performed on the resource." - }, - "artifacts": { - "type": "object", - "description": "The artifacts for the service unit.", - "$ref": "#/definitions/ServiceUnitArtifacts" - } - }, - "required": [ - "targetResourceGroup", - "deploymentMode" - ] - }, - "ServiceUnitArtifacts": { - "description": "Defines the artifacts of a service unit.", - "properties": { - "templateUri": { - "type": "string", - "description": "The full URI of the ARM template file with the SAS token.", - "example": "https://teststore.blob.core.windows.net/payloadcontainer/template.json?sasUri" - }, - "parametersUri": { - "type": "string", - "description": "The full URI of the ARM parameters file with the SAS token.", - "example": "https://teststore.blob.core.windows.net/payloadcontainer/parameters.json?sasUri" - }, - "templateArtifactSourceRelativePath": { - "type": "string", - "description": "The path to the ARM template file relative to the artifact source.", - "example": "/templates/resource1.template.json" - }, - "parametersArtifactSourceRelativePath": { - "type": "string", - "description": "The path to the ARM parameters file relative to the artifact source.", - "example": "/parameters/resource1.parameters.json" - } - } - }, - "RolloutStep": { - "description": "Defines a specific step on a target service unit.", - "properties": { - "name": { - "type": "string", - "description": "Name of the step." - }, - "status": { - "type": "string", - "readOnly": true, - "description": "Current state of the step." - }, - "stepGroup": { - "type": "string", - "description": "The step group the current step is part of." - }, - "operationInfo": { - "readOnly": true, - "$ref": "#/definitions/StepOperationInfo", - "description": "Detailed information of specific action execution." - }, - "resourceOperations": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ResourceOperation" - }, - "description": "Set of resource operations that were performed, if any, on an Azure resource." - }, - "messages": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Message" - }, - "description": "Supplementary informative messages during rollout." - } - }, - "required": [ - "name" - ] - }, - "StepOperationInfo": { - "description": "Detailed information of a specific step run.", - "properties": { - "deploymentName": { - "type": "string", - "readOnly": true, - "description": "The name of the ARM deployment initiated as part of the step." - }, - "correlationId": { - "type": "string", - "readOnly": true, - "description": "Unique identifier to track the request for ARM-based resources." - }, - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Start time of the action in UTC." - }, - "endTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "End time of the action in UTC." - }, - "lastUpdatedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Last time in UTC this operation was updated." - }, - "error": { - "description": "The errors, if any, for the action.", - "$ref": "#/definitions/CloudErrorBody" - } - } - }, - "ResourceOperation": { - "description": "Individual resource operation information.", - "properties": { - "resourceName": { - "type": "string", - "description": "Name of the resource as specified in the artifacts. For ARM resources, this is the name of the resource specified in the template." - }, - "operationId": { - "type": "string", - "readOnly": true, - "description": "Unique identifier of the operation. For ARM resources, this is the operationId obtained from ARM service." - }, - "resourceType": { - "type": "string", - "description": "Type of the resource as specified in the artifacts. For ARM resources, this is the type of the resource specified in the template." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "State of the resource deployment. For ARM resources, this is the current provisioning state of the resource." - }, - "statusMessage": { - "type": "string", - "readOnly": true, - "description": "Descriptive information of the resource operation." - }, - "statusCode": { - "type": "string", - "readOnly": true, - "description": "Http status code of the operation." - } - } - }, - "Message": { - "description": "Supplementary contextual messages during a rollout.", - "properties": { - "timeStamp": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Time in UTC this message was provided." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "The actual message text." - } - } - }, - "CloudError": { - "description": "The error information object.", - "x-ms-external": true, - "properties": { - "error": { - "description": "The properties that define the error.", - "$ref": "#/definitions/CloudErrorBody" - } - } - }, - "CloudErrorBody": { - "description": "Detailed error information of any failure.", - "properties": { - "code": { - "type": "string", - "readOnly": true, - "description": "Error code string." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "Descriptive error information." - }, - "target": { - "type": "string", - "description": "Error target" - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/CloudErrorBody" - }, - "description": "More detailed error information." - } - } - }, - "OperationsList": { - "description": "The list of supported operations.", - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - } - }, - "Operation": { - "description": "Represents an operation that can be performed on the service.", - "properties": { - "name": { - "type": "string", - "description": "The name of the operation." - }, - "display": { - "description": "The display name of the operation.", - "$ref": "#/definitions/OperationDetail" - }, - "origin": { - "type": "string", - "description": "The origin of the operation." - }, - "properties": { - "description": "The properties of the operation.", - "type": "object", - "x-ms-client-flatten": true - } - } - }, - "OperationDetail": { - "description": "The detail about an operation.", - "properties": { - "provider": { - "type": "string", - "description": "The name of the provider that supports the operation." - }, - "resource": { - "type": "string", - "description": "The resource type on which this operation can be performed." - }, - "operation": { - "type": "string", - "description": "The name of the operation." - }, - "description": { - "type": "string", - "description": "The description of the operation." - } - } - }, - "StepResource": { - "description": "The resource representation of a rollout step.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties that define the step.", - "$ref": "#/definitions/StepProperties" - } - }, - "required": [ - "properties" - ] - }, - "StepProperties": { - "description": "The properties of a step resource.", - "type": "object", - "discriminator": "stepType", - "properties": { - "stepType": { - "type": "string", - "description": "The type of step.", - "example": "Wait" - } - }, - "required": [ - "stepType" - ] - }, - "WaitStepProperties": { - "x-ms-discriminator-value": "Wait", - "type": "object", - "description": "Defines the properties of a Wait step.", - "allOf": [ - { - "$ref": "#/definitions/StepProperties" - } - ], - "properties": { - "attributes": { - "description": "The Wait attributes", - "$ref": "#/definitions/WaitStepAttributes" - } - } - }, - "WaitStepAttributes": { - "type": "object", - "description": "The parameters for the wait step.", - "properties": { - "duration": { - "type": "string", - "description": "The duration in ISO 8601 format of how long the wait should be.", - "example": "PT30M" - } - }, - "required": [ - "duration" - ] - } - }, - "parameters": { - "artifactSourceName": { - "description": "The name of the artifact source.", - "name": "artifactSourceName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "serviceTopologyName": { - "name": "serviceTopologyName", - "in": "path", - "description": "The name of the service topology .", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "serviceName": { - "name": "serviceName", - "in": "path", - "description": "The name of the service resource.", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "serviceUnitName": { - "name": "serviceUnitName", - "in": "path", - "description": "The name of the service unit resource.", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "stepName": { - "name": "stepName", - "in": "path", - "description": "The name of the deployment step.", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "type": "string", - "required": true, - "x-ms-parameter-location": "client" - }, - "resourceGroupName": { - "description": "The name of the resource group. The name is case insensitive.", - "name": "resourceGroupName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90 - }, - "rolloutName": { - "description": "The rollout name.", - "name": "rolloutName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "retryAttempt": { - "name": "retryAttempt", - "in": "query", - "required": false, - "type": "integer", - "description": "Rollout retry attempt ordinal to get the result of. If not specified, result of the latest attempt will be returned.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for this operation.", - "x-ms-parameter-location": "client" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate.json deleted file mode 100644 index 788dbbe69641..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "artifactSourceName": "myArtifactSource", - "api-version": "2018-09-01-preview", - "artifactSourceInfo": { - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "myArtifactSource", - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate_artifactroot.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate_artifactroot.json deleted file mode 100644 index ee73497e34b2..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate_artifactroot.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "artifactSourceName": "myArtifactSource", - "api-version": "2018-09-01-preview", - "artifactSourceInfo": { - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "artifactRoot": "1.0.0.0", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "myArtifactSource", - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_delete.json deleted file mode 100644 index f54fbd95c977..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "artifactSourceName": "myArtifactSource", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_get.json deleted file mode 100644 index d617ffb2e601..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_get.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "artifactSourceName": "myArtifactSource", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myArtifactSource", - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/operations_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/operations_get.json deleted file mode 100644 index 9f0fdd2fad40..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/operations_get.json +++ /dev/null @@ -1,165 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": [ - { - "name": "Microsoft.DeploymentManager/serviceTopologies/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceTopology", - "operation": "View service topology", - "description": "View the properties of a service topology" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceTopology", - "operation": "Update the service topology", - "description": "Create a new topology or update the properties of an existing topology" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceTopology", - "operation": "Delete service topology", - "description": "Deletes an existing topology." - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Service", - "operation": "View service in a topology", - "description": "View the properties of a service in a service topology" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Service", - "operation": "Update the service in a topology", - "description": "Create a new service or update the properties of an existing service" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Service", - "operation": "Delete service", - "description": "Deletes an existing service in a service topology." - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceUnit", - "operation": "View service unit", - "description": "View the properties of a service unit" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceUnit", - "operation": "Update the service unit", - "description": "Create a new service unit or update the properties of an existing service unit" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceUnit", - "operation": "Delete service unit", - "description": "Deletes an existing service unit." - } - }, - { - "name": "Microsoft.DeploymentManager/artifactSources/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ArtifactSource", - "operation": "View artifact source", - "description": "View the properties of an artifact source." - } - }, - { - "name": "Microsoft.DeploymentManager/artifactSources/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ArtifactSource", - "operation": "Update the artifact source", - "description": "Create a new artifact source or updates the properties of an existing artifact source." - } - }, - { - "name": "Microsoft.DeploymentManager/artifactSources/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ArtifactSource", - "operation": "Delete artifact source", - "description": "Deletes an existing artifact source." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "View rollout", - "description": "View the properties of rollout." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "Create or update a rollout.", - "description": "Create a new rollout or update an existing rollout." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/restart", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "Restart a rollout", - "description": "Restarts a failed rollout." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/cancel", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "Cancel a rollout", - "description": "Cancel a rollout in progress." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "Delete rollout", - "description": "Deletes an existing rollout." - } - } - ] - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_createorupdate.json deleted file mode 100644 index ae49f2a3832d..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_createorupdate.json +++ /dev/null @@ -1,123 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "api-version": "2018-09-01-preview", - "rolloutRequest": { - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ] - } - } - }, - "responses": { - "201": { - "body": { - "name": "myRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ] - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_delete.json deleted file mode 100644 index c98dc8b929c9..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_get.json deleted file mode 100644 index 0ff4939e9727..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_get.json +++ /dev/null @@ -1,124 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "status": "Running", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "retryAttempt": 0 - }, - "totalRetryAttempts": 0, - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ], - "services": [ - { - "name": "myService1", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7", - "targetLocation": "centralus", - "serviceUnits": [ - { - "name": "myTopologyUni1", - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "steps": [ - { - "name": "preDeploymentStep1", - "status": "succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "endTime": "2018-08-28T03:35:28.556Z" - } - }, - { - "name": "preDeploymentStep2", - "status": "succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:36:56.386Z", - "endTime": "2018-08-28T03:37:28.556Z" - } - }, - { - "name": "deploy", - "status": "running", - "operationInfo": { - "startTime": "2018-08-28T03:38:56.386Z", - "lastUpdatedTime": "2018-08-28T03:39:28.556Z" - }, - "resourceOperations": [ - { - "resourceName": "keyVaultcentralus", - "operationId": "20FC5A21382DA306", - "resourceType": "Microsoft.KeyVault/vaults", - "provisioningState": "Succeeded", - "statusMessage": "", - "statusCode": "OK" - } - ] - } - ] - } - ] - } - ] - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_cancel.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_cancel.json deleted file mode 100644 index 5c5ad1cc9d98..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_cancel.json +++ /dev/null @@ -1,124 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "status": "Canceling", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "retryAttempt": 0 - }, - "totalRetryAttempts": 0, - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ], - "services": [ - { - "name": "myService1", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7", - "targetLocation": "centralus", - "serviceUnits": [ - { - "name": "myTopologyUni1", - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "steps": [ - { - "name": "preDeploymentStep1", - "status": "succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "endTime": "2018-08-28T03:35:28.556Z" - } - }, - { - "name": "preDeploymentStep2", - "status": "succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:36:56.386Z", - "endTime": "2018-08-28T03:37:28.556Z" - } - }, - { - "name": "deploy", - "status": "running", - "operationInfo": { - "startTime": "2018-08-28T03:38:56.386Z", - "lastUpdatedTime": "2018-08-28T03:39:28.556Z" - }, - "resourceOperations": [ - { - "resourceName": "keyVaultcentralus", - "operationId": "20FC5A21382DA306", - "resourceType": "Microsoft.KeyVault/vaults", - "provisioningState": "Succeeded", - "statusMessage": "", - "statusCode": "OK" - } - ] - } - ] - } - ] - } - ] - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_restart.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_restart.json deleted file mode 100644 index c30b9f3e5e2d..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_restart.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "skipSucceeded": true, - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "status": "Running", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "retryAttempt": 1 - }, - "totalRetryAttempts": 1, - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ] - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_createorupdate.json deleted file mode 100644 index 731c76610fa8..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_createorupdate.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "api-version": "2018-09-01-preview", - "serviceInfo": { - "type": "Microsoft.DeploymentManager/serviceTopologies/services", - "location": "centralus", - "tags": {}, - "properties": { - "targetLocation": "centralus", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" - } - } - }, - "responses": { - "201": { - "body": { - "name": "myService", - "type": "Microsoft.DeploymentManager/serviceTopologies/services", - "location": "centralus", - "tags": {}, - "properties": { - "targetLocation": "centralus", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_delete.json deleted file mode 100644 index b038a2f1ca6b..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_delete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_get.json deleted file mode 100644 index 7e24a6809f61..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_get.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myService", - "type": "Microsoft.DeploymentManager/serviceTopologies/services", - "location": "centralus", - "tags": {}, - "properties": { - "targetLocation": "centralus", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate.json deleted file mode 100644 index f5987d3445e8..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2018-09-01-preview", - "serviceTopologyInfo": { - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": { - "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/myArtifactSource" - } - } - }, - "responses": { - "201": { - "body": { - "name": "myTopology", - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": { - "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/myArtifactSource" - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate_noartifactsource.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate_noartifactsource.json deleted file mode 100644 index f0084c906414..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate_noartifactsource.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2018-09-01-preview", - "serviceTopologyInfo": { - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": {} - } - }, - "responses": { - "201": { - "body": { - "name": "myTopology", - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": {} - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_delete.json deleted file mode 100644 index 33fd145d5ee2..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_get.json deleted file mode 100644 index 3a277209a73e..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_get.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myTopology", - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": { - "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/myArtifactSource" - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate.json deleted file mode 100644 index d783e76b208f..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "serviceUnitName": "myServiceUnit", - "api-version": "2018-09-01-preview", - "serviceUnitInfo": { - "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateArtifactSourceRelativePath": "templates/myTopologyUnit.template.json", - "parametersArtifactSourceRelativePath": "parameter/myTopologyUnit.parameters.json" - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "myServiceUnit", - "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateArtifactSourceRelativePath": "templates/myTopologyUnit.template.json", - "parametersArtifactSourceRelativePath": "parameter/myTopologyUnit.parameters.json" - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate_noartifactsource.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate_noartifactsource.json deleted file mode 100644 index 5bd26dac5071..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate_noartifactsource.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "serviceUnitName": "myServiceUnit", - "api-version": "2018-09-01-preview", - "serviceUnitInfo": { - "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/templates/myTopologyUnit.template.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D", - "parametersUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/parameter/myTopologyUnit.parameters.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "myServiceUnit", - "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/templates/myTopologyUnit.template.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D", - "parametersUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/parameter/myTopologyUnit.parameters.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_delete.json deleted file mode 100644 index eabb7ab834fa..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_delete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "serviceUnitName": "myServiceUnit", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_get.json deleted file mode 100644 index 3af095cbfb23..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_get.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "serviceUnitName": "myServiceUnit", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myServiceUnit", - "type": "Microsoft.DeploymentManager/servicetopologies/services/serviceunits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateArtifactSourceRelativePath": "templates/myTopologyUnit.template.json", - "parametersArtifactSourceRelativePath": "parameter/myTopologyUnit.parameters.json" - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_createorupdate.json deleted file mode 100644 index 040a478071a3..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_createorupdate.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "stepName": "deploymentStep1", - "api-version": "2018-09-01-preview", - "stepInfo": { - "type": "Microsoft.DeploymentManager/steps", - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "Wait", - "attributes": { - "duration": "PT20M" - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "deploymentStep1", - "type": "Microsoft.DeploymentManager/steps", - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "Wait", - "attributes": { - "duration": "PT20M" - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_delete.json deleted file mode 100644 index 9ea55bc13fe5..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "stepName": "deploymentStep1", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_get.json deleted file mode 100644 index 166bdff57786..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_get.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "stepName": "deploymentStep1", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "deploymentStep1", - "type": "Microsoft.DeploymentManager/steps", - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "Wait", - "attributes": { - "duration": "PT20M" - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/deploymentmanager.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/deploymentmanager.json deleted file mode 100644 index 2114072b8b8f..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/deploymentmanager.json +++ /dev/null @@ -1,2421 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2019-11-01-preview", - "title": "AzureDeploymentManager", - "description": "REST APIs for orchestrating deployments using the Azure Deployment Manager (ADM). See https://docs.microsoft.com/en-us/azure-resource-manager/deployment-manager-overview for more information." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}": { - "put": { - "tags": [ - "ServiceTopologies" - ], - "operationId": "ServiceTopologies_CreateOrUpdate", - "summary": "Creates or updates a service topology.", - "description": "Synchronously creates a new service topology or updates an existing service topology.", - "x-ms-examples": { - "Create a topology with Artifact Source": { - "$ref": "./examples/servicetopology_createorupdate.json" - }, - "Create a topology without Artifact Source": { - "$ref": "./examples/servicetopology_createorupdate_noartifactsource.json" - } - }, - "parameters": [ - { - "in": "body", - "name": "serviceTopologyInfo", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceTopologyResource" - }, - "description": "Source topology object defines the resource." - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "201": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceTopologyResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard Error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "ServiceTopologies" - ], - "operationId": "ServiceTopologies_Get", - "summary": "Gets the service topology.", - "x-ms-examples": { - "Get topology": { - "$ref": "./examples/servicetopology_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceTopologyResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "ServiceTopologies" - ], - "operationId": "ServiceTopologies_Delete", - "summary": "Deletes the service topology.", - "x-ms-examples": { - "Delete topology": { - "$ref": "./examples/servicetopology_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The topology was successfully deleted." - }, - "204": { - "description": "The topology was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies": { - "get": { - "tags": [ - "ServiceTopologies" - ], - "operationId": "ServiceTopologies_List", - "summary": "Lists the service topologies in the resource group.", - "x-ms-examples": { - "List topologies": { - "$ref": "./examples/servicetopologies_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceTopologiesListResult" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}": { - "put": { - "tags": [ - "Services" - ], - "operationId": "Services_CreateOrUpdate", - "summary": "Creates or updates a service in the service topology.", - "description": "Synchronously creates a new service or updates an existing service.", - "x-ms-examples": { - "Create service": { - "$ref": "./examples/service_createorupdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "serviceInfo", - "description": "The service object", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceResource" - } - } - ], - "responses": { - "201": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "Services" - ], - "operationId": "Services_Get", - "summary": "Gets the service.", - "x-ms-examples": { - "Get service": { - "$ref": "./examples/service_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Services" - ], - "operationId": "Services_Delete", - "summary": "Deletes the service.", - "x-ms-examples": { - "Delete service": { - "$ref": "./examples/service_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The service was successfully deleted." - }, - "204": { - "description": "The service was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services": { - "get": { - "tags": [ - "Services" - ], - "operationId": "Services_List", - "summary": "Lists the services in the service topology.", - "x-ms-examples": { - "List services": { - "$ref": "./examples/services_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceListResult" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}/serviceUnits/{serviceUnitName}": { - "put": { - "tags": [ - "ServiceUnits" - ], - "operationId": "ServiceUnits_CreateOrUpdate", - "x-ms-long-running-operation": true, - "summary": "Creates or updates a service unit under the service in the service topology.", - "description": "This is an asynchronous operation and can be polled to completion using the operation resource returned by this operation.", - "x-ms-examples": { - "Create service unit using relative paths into the artifact source": { - "$ref": "./examples/serviceunit_createorupdate.json" - }, - "Create service unit using SAS URIs": { - "$ref": "./examples/serviceunit_createorupdate_noartifactsource.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/serviceUnitName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "serviceUnitInfo", - "description": "The service unit resource object.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceUnitResource" - } - } - ], - "responses": { - "201": { - "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.", - "headers": { - "Azure-AsyncOperation": { - "type": "string", - "description": "Contains the status URL on which clients are expected to poll the status of the operation." - } - }, - "schema": { - "$ref": "#/definitions/ServiceUnitResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "ServiceUnits" - ], - "operationId": "ServiceUnits_Get", - "summary": "Gets the service unit.", - "x-ms-examples": { - "Get service unit": { - "$ref": "./examples/serviceunit_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/serviceUnitName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceUnitResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "ServiceUnits" - ], - "operationId": "ServiceUnits_Delete", - "summary": "Deletes the service unit.", - "x-ms-examples": { - "Delete service unit": { - "$ref": "./examples/serviceunit_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/serviceUnitName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The service unit was successfully deleted." - }, - "204": { - "description": "The service unit was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}/serviceUnits": { - "get": { - "tags": [ - "ServiceUnits" - ], - "operationId": "ServiceUnits_List", - "summary": "Lists the service units under a service in the service topology.", - "x-ms-examples": { - "List service units": { - "$ref": "./examples/serviceunits_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceUnitListResult" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/steps/{stepName}": { - "put": { - "tags": [ - "Steps" - ], - "operationId": "Steps_CreateOrUpdate", - "summary": "Creates or updates a rollout step with the given step properties.", - "description": "Synchronously creates a new step or updates an existing step.", - "x-ms-examples": { - "Create wait step": { - "$ref": "./examples/step_wait_createorupdate.json" - }, - "Create health check step": { - "$ref": "./examples/step_health_check_createorupdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/stepName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "stepInfo", - "description": "The step object.", - "schema": { - "$ref": "#/definitions/StepResource" - } - } - ], - "responses": { - "201": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StepResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "Steps" - ], - "operationId": "Steps_Get", - "summary": "Gets the step.", - "x-ms-examples": { - "Get deployment step": { - "$ref": "./examples/step_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/stepName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StepResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Steps" - ], - "operationId": "Steps_Delete", - "summary": "Deletes the step.", - "x-ms-examples": { - "Delete deployment step": { - "$ref": "./examples/step_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/stepName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The step was successfully deleted." - }, - "204": { - "description": "The step was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/steps": { - "get": { - "tags": [ - "Steps" - ], - "operationId": "Steps_List", - "summary": "Lists the steps in a resource group.", - "x-ms-examples": { - "List steps": { - "$ref": "./examples/steps_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StepResourceListResult" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts/{rolloutName}": { - "put": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_CreateOrUpdate", - "x-ms-long-running-operation": true, - "summary": "Creates or updates a rollout.", - "description": "This is an asynchronous operation and can be polled to completion using the location header returned by this operation.", - "x-ms-examples": { - "Create or update rollout": { - "$ref": "./examples/rollout_createorupdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "rolloutRequest", - "description": "Source rollout request object that defines the rollout.", - "schema": { - "$ref": "#/definitions/RolloutRequest" - } - } - ], - "responses": { - "201": { - "description": "This is a long running operation. The operation returns a 201 if the request was successfully registered and basic validation is successful. The response includes an Azure-AsyncOperation header that contains the operation status URL. Clients are expected to poll the status URL for the status of the operation.", - "headers": { - "Azure-AsyncOperation": { - "type": "string", - "description": "Contains the status URL on which clients are expected to poll the status of the operation." - } - }, - "schema": { - "$ref": "#/definitions/RolloutRequest" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_Get", - "summary": "Gets detailed information of a rollout.", - "x-ms-examples": { - "Get rollout": { - "$ref": "./examples/rollout_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/retryAttempt" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Rollout" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_Delete", - "summary": "Deletes a rollout resource.", - "description": "Only rollouts in terminal state can be deleted.", - "x-ms-examples": { - "Delete rollout": { - "$ref": "./examples/rollout_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The rollout was successfully deleted." - }, - "204": { - "description": "The rollout was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts/{rolloutName}/cancel": { - "post": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_Cancel", - "summary": "Stops a running rollout.", - "description": "Only running rollouts can be canceled.", - "x-ms-examples": { - "Cancel rollout": { - "$ref": "./examples/rollout_post_cancel.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Rollout" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts/{rolloutName}/restart": { - "post": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_Restart", - "summary": "Restarts a failed rollout and optionally skips all succeeded steps.", - "description": "Only failed rollouts can be restarted.", - "x-ms-examples": { - "Restart rollout": { - "$ref": "./examples/rollout_post_restart.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "name": "skipSucceeded", - "in": "query", - "required": false, - "type": "boolean", - "description": "If true, will skip all succeeded steps so far in the rollout. If false, will execute the entire rollout again regardless of the current state of individual resources. Defaults to false if not specified." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Rollout" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts": { - "get": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_List", - "summary": "Lists the rollouts in a resource group.", - "x-ms-examples": { - "List rollouts by resource group": { - "$ref": "./examples/rollouts_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RolloutListResult" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/artifactSources/{artifactSourceName}": { - "put": { - "tags": [ - "ArtifactSources" - ], - "operationId": "ArtifactSources_CreateOrUpdate", - "summary": "Creates or updates an artifact source.", - "description": "Synchronously creates a new artifact source or updates an existing artifact source.", - "x-ms-examples": { - "Create artifact source": { - "$ref": "./examples/artifactsource_createorupdate.json" - }, - "Create artifact source with artifact root, an offset into the storage container": { - "$ref": "./examples/artifactsource_createorupdate_artifactroot.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/artifactSourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "artifactSourceInfo", - "description": "Source object that defines the resource.", - "schema": { - "$ref": "#/definitions/ArtifactSource" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ArtifactSource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "ArtifactSources" - ], - "operationId": "ArtifactSources_Get", - "summary": "Gets an artifact source.", - "x-ms-examples": { - "Get artifact source": { - "$ref": "./examples/artifactsource_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/artifactSourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ArtifactSource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "ArtifactSources" - ], - "operationId": "ArtifactSources_Delete", - "summary": "Deletes an artifact source.", - "x-ms-examples": { - "Delete artifact source": { - "$ref": "./examples/artifactsource_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/artifactSourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The artifact source was successfully deleted." - }, - "204": { - "description": "The artifact source was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/artifactSources": { - "get": { - "tags": [ - "ArtifactSources" - ], - "operationId": "ArtifactSources_List", - "summary": "Lists the artifact sources in a resource group.", - "x-ms-examples": { - "List steps": { - "$ref": "./examples/artifactsources_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ArtifactSourceListResult" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/providers/Microsoft.DeploymentManager/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "summary": "Lists the supported operations.", - "x-ms-examples": { - "Get operations": { - "$ref": "./examples/operations_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The operations are successfully returned. The response code does not determine if the request which this operation corresponds to is successful. Check the response content for the status and any error information on failures.", - "schema": { - "$ref": "#/definitions/OperationsList" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "Identity": { - "description": "Identity for the resource.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The identity type.", - "example": "userAssigned" - }, - "identityIds": { - "type": "array", - "items": { - "type": "string", - "example": "/subscriptions/mySubId/resourcegroups/myRG/providers/Microsoft.ManagedIdentity/userassignedidentities/myIdentity" - }, - "description": "The list of identities." - } - }, - "required": [ - "type", - "identityIds" - ] - }, - "RolloutRequest": { - "description": "Defines the PUT rollout request body.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "identity": { - "description": "Identity for the resource.", - "$ref": "#/definitions/Identity" - }, - "properties": { - "description": "Defines the properties that make up a rollout request.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/RolloutRequestProperties" - } - }, - "required": [ - "identity", - "properties" - ] - }, - "RolloutRequestProperties": { - "description": "The properties for defining a rollout.", - "properties": { - "buildVersion": { - "type": "string", - "description": "The version of the build being deployed.", - "example": "1.0.0.1" - }, - "artifactSourceId": { - "type": "string", - "description": "The reference to the artifact source resource Id where the payload is located.", - "example": "Microsoft.DeploymentManager/artifactSources/payloadStore1" - }, - "targetServiceTopologyId": { - "type": "string", - "description": "The resource Id of the service topology from which service units are being referenced in step groups to be deployed.", - "example": "Microsoft.DeploymentManager/serviceTopologies/myServiceTopology" - }, - "stepGroups": { - "description": "The list of step groups that define the orchestration.", - "type": "array", - "items": { - "$ref": "#/definitions/StepGroup" - } - } - }, - "required": [ - "stepGroups", - "targetServiceTopologyId", - "buildVersion" - ] - }, - "StepGroup": { - "description": "The properties that define a Step group in a rollout.", - "properties": { - "name": { - "description": "The name of the step group.", - "type": "string" - }, - "dependsOnStepGroups": { - "description": "The list of step group names on which this step group depends on.", - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "stepGroup1", - "stepGroup2" - ] - }, - "preDeploymentSteps": { - "description": "The list of steps to be run before deploying the target.", - "type": "array", - "items": { - "$ref": "#/definitions/PrePostStep" - } - }, - "deploymentTargetId": { - "description": "The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId", - "type": "string", - "example": "Microsoft.DeploymentManager/serviceTopologies/myServiceTopology/services/myService/serviceUnits/database" - }, - "postDeploymentSteps": { - "description": "The list of steps to be run after deploying the target.", - "type": "array", - "items": { - "$ref": "#/definitions/PrePostStep" - } - } - }, - "required": [ - "deploymentTargetId", - "name" - ] - }, - "PrePostStep": { - "description": "The properties that define a step.", - "properties": { - "stepId": { - "type": "string", - "description": "The resource Id of the step to be run.", - "example": "Microsoft.DeploymentManager/steps/healthCheckStep1" - } - }, - "required": [ - "stepId" - ] - }, - "ArtifactSource": { - "description": "The resource that defines the source location where the artifacts are located.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties that define the artifact source.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ArtifactSourceProperties" - } - ] - } - } - }, - "ArtifactSourceProperties": { - "description": "The properties that define the source location where the artifacts are located.", - "properties": { - "sourceType": { - "type": "string", - "description": "The type of artifact source used.", - "example": "AzureStorage" - }, - "artifactRoot": { - "type": "string", - "description": "The path from the location that the 'authentication' property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.", - "example": "binaries/2018.09.24" - }, - "authentication": { - "description": "The authentication method to use to access the artifact source.", - "$ref": "#/definitions/Authentication" - } - }, - "required": [ - "sourceType", - "authentication" - ] - }, - "Authentication": { - "description": "Defines the authentication method and properties to access the artifacts.", - "type": "object", - "discriminator": "type", - "properties": { - "type": { - "type": "string", - "description": "The authentication type" - } - }, - "required": [ - "type" - ] - }, - "SasAuthentication": { - "x-ms-discriminator-value": "Sas", - "type": "object", - "description": "Defines the properties to access the artifacts using an Azure Storage SAS URI.", - "allOf": [ - { - "$ref": "#/definitions/Authentication" - } - ], - "properties": { - "properties": { - "description": "The SAS properties", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SasProperties" - } - } - }, - "SasProperties": { - "description": "The properties that define SAS authentication.", - "properties": { - "sasUri": { - "type": "string", - "description": "The SAS URI to the Azure Storage blob container. Any offset from the root of the container to where the artifacts are located can be defined in the artifactRoot." - } - }, - "required": [ - "sasUri" - ] - }, - "Rollout": { - "description": "Defines the rollout.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "identity": { - "description": "Identity for the resource.", - "$ref": "#/definitions/Identity" - }, - "properties": { - "description": "The properties that define a rollout.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/RolloutRequestProperties" - }, - { - "$ref": "#/definitions/RolloutProperties" - } - ] - } - } - }, - "RolloutProperties": { - "description": "Defines the properties of a rollout.", - "properties": { - "status": { - "type": "string", - "readOnly": true, - "description": "The current status of the rollout." - }, - "totalRetryAttempts": { - "type": "integer", - "format": "int32", - "readOnly": true, - "description": "The cardinal count of total number of retries performed on the rollout at a given time." - }, - "operationInfo": { - "readOnly": true, - "$ref": "#/definitions/RolloutOperationInfo", - "description": "Operational information of the rollout." - }, - "services": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Service" - }, - "description": "The detailed information on the services being deployed." - } - } - }, - "RolloutOperationInfo": { - "description": "Detailed runtime information of the rollout.", - "properties": { - "retryAttempt": { - "type": "integer", - "format": "int32", - "readOnly": true, - "description": "The ordinal count of the number of retry attempts on a rollout. 0 if no retries of the rollout have been performed. If the rollout is updated with a PUT, this count is reset to 0." - }, - "skipSucceededOnRetry": { - "type": "boolean", - "readOnly": true, - "description": "True, if all steps that succeeded on the previous run/attempt were chosen to be skipped in this retry attempt. False, otherwise." - }, - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The start time of the rollout in UTC." - }, - "endTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The start time of the rollout in UTC. This property will not be set if the rollout has not completed yet." - }, - "error": { - "description": "The detailed error information for any failure.", - "readOnly": true, - "$ref": "#/definitions/CloudErrorBody" - } - } - }, - "ServiceTopologyResource": { - "description": "The resource representation of a service topology.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties that define the service topology.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ServiceTopologyProperties" - } - ] - } - }, - "required": [ - "properties" - ] - }, - "ServiceTopologyProperties": { - "description": "The properties of a service topology.", - "properties": { - "artifactSourceId": { - "type": "string", - "description": "The resource Id of the artifact source that contains the artifacts that can be referenced in the service units." - } - } - }, - "ServiceResource": { - "description": "The resource representation of a service in a service topology.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties that define a service in a service topology.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ServiceProperties" - } - ] - } - }, - "required": [ - "properties" - ] - }, - "Service": { - "description": "Defines a service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceProperties" - } - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the service." - }, - "serviceUnits": { - "description": "The detailed information about the units that make up the service.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceUnit" - } - } - } - }, - "ServiceProperties": { - "description": "The properties of a service.", - "properties": { - "targetLocation": { - "type": "string", - "description": "The Azure location to which the resources in the service belong to or should be deployed to." - }, - "targetSubscriptionId": { - "type": "string", - "description": "The subscription to which the resources in the service belong to or should be deployed to." - } - }, - "required": [ - "targetLocation", - "targetSubscriptionId" - ] - }, - "ServiceUnitResource": { - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "description": "Represents the response of a service unit resource.", - "properties": { - "properties": { - "description": "The properties that define the service unit.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ServiceUnitProperties" - } - ] - } - }, - "required": [ - "properties" - ] - }, - "ServiceUnit": { - "description": "Defines a service unit.", - "allOf": [ - { - "$ref": "#/definitions/ServiceUnitProperties" - } - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the service unit." - }, - "steps": { - "type": "array", - "items": { - "$ref": "#/definitions/RolloutStep" - }, - "description": "Detailed step information, if present." - } - } - }, - "ServiceUnitProperties": { - "description": "Defines the properties of a service unit.", - "properties": { - "targetResourceGroup": { - "type": "string", - "description": "The Azure Resource Group to which the resources in the service unit belong to or should be deployed to." - }, - "deploymentMode": { - "type": "string", - "enum": [ - "Incremental", - "Complete" - ], - "x-ms-enum": { - "name": "DeploymentMode", - "modelAsString": false - }, - "description": "Describes the type of ARM deployment to be performed on the resource." - }, - "artifacts": { - "type": "object", - "description": "The artifacts for the service unit.", - "$ref": "#/definitions/ServiceUnitArtifacts" - } - }, - "required": [ - "targetResourceGroup", - "deploymentMode" - ] - }, - "ServiceUnitArtifacts": { - "description": "Defines the artifacts of a service unit.", - "properties": { - "templateUri": { - "type": "string", - "description": "The full URI of the ARM template file with the SAS token.", - "example": "https://teststore.blob.core.windows.net/payloadcontainer/template.json?sasUri" - }, - "parametersUri": { - "type": "string", - "description": "The full URI of the ARM parameters file with the SAS token.", - "example": "https://teststore.blob.core.windows.net/payloadcontainer/parameters.json?sasUri" - }, - "templateArtifactSourceRelativePath": { - "type": "string", - "description": "The path to the ARM template file relative to the artifact source.", - "example": "/templates/resource1.template.json" - }, - "parametersArtifactSourceRelativePath": { - "type": "string", - "description": "The path to the ARM parameters file relative to the artifact source.", - "example": "/parameters/resource1.parameters.json" - } - } - }, - "RolloutStep": { - "description": "Defines a specific step on a target service unit.", - "properties": { - "name": { - "type": "string", - "description": "Name of the step." - }, - "status": { - "type": "string", - "readOnly": true, - "description": "Current state of the step." - }, - "stepGroup": { - "type": "string", - "description": "The step group the current step is part of." - }, - "operationInfo": { - "readOnly": true, - "$ref": "#/definitions/StepOperationInfo", - "description": "Detailed information of specific action execution." - }, - "resourceOperations": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ResourceOperation" - }, - "description": "Set of resource operations that were performed, if any, on an Azure resource." - }, - "messages": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Message" - }, - "description": "Supplementary informative messages during rollout." - } - }, - "required": [ - "name" - ] - }, - "StepOperationInfo": { - "description": "Detailed information of a specific step run.", - "properties": { - "deploymentName": { - "type": "string", - "readOnly": true, - "description": "The name of the ARM deployment initiated as part of the step." - }, - "correlationId": { - "type": "string", - "readOnly": true, - "description": "Unique identifier to track the request for ARM-based resources." - }, - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Start time of the action in UTC." - }, - "endTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "End time of the action in UTC." - }, - "lastUpdatedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Last time in UTC this operation was updated." - }, - "error": { - "description": "The errors, if any, for the action.", - "$ref": "#/definitions/CloudErrorBody" - } - } - }, - "ResourceOperation": { - "description": "Individual resource operation information.", - "properties": { - "resourceName": { - "type": "string", - "description": "Name of the resource as specified in the artifacts. For ARM resources, this is the name of the resource specified in the template." - }, - "operationId": { - "type": "string", - "readOnly": true, - "description": "Unique identifier of the operation. For ARM resources, this is the operationId obtained from ARM service." - }, - "resourceType": { - "type": "string", - "description": "Type of the resource as specified in the artifacts. For ARM resources, this is the type of the resource specified in the template." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "State of the resource deployment. For ARM resources, this is the current provisioning state of the resource." - }, - "statusMessage": { - "type": "string", - "readOnly": true, - "description": "Descriptive information of the resource operation." - }, - "statusCode": { - "type": "string", - "readOnly": true, - "description": "Http status code of the operation." - } - } - }, - "Message": { - "description": "Supplementary contextual messages during a rollout.", - "properties": { - "timeStamp": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Time in UTC this message was provided." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "The actual message text." - } - } - }, - "CloudError": { - "description": "The error information object.", - "x-ms-external": true, - "properties": { - "error": { - "description": "The properties that define the error.", - "$ref": "#/definitions/CloudErrorBody" - } - } - }, - "CloudErrorBody": { - "description": "Detailed error information of any failure.", - "properties": { - "code": { - "type": "string", - "readOnly": true, - "description": "Error code string." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "Descriptive error information." - }, - "target": { - "type": "string", - "description": "Error target" - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/CloudErrorBody" - }, - "description": "More detailed error information." - } - } - }, - "OperationsList": { - "description": "The operations response.", - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "The list of supported operations", - "$ref": "#/definitions/Operation" - } - } - }, - "Operation": { - "description": "Represents an operation that can be performed on the service.", - "properties": { - "name": { - "type": "string", - "description": "The name of the operation." - }, - "display": { - "description": "The display name of the operation.", - "$ref": "#/definitions/OperationDetail" - }, - "origin": { - "type": "string", - "description": "The origin of the operation." - }, - "properties": { - "description": "The properties of the operation.", - "type": "object", - "x-ms-client-flatten": true - } - } - }, - "OperationDetail": { - "description": "The detail about an operation.", - "properties": { - "provider": { - "type": "string", - "description": "The name of the provider that supports the operation." - }, - "resource": { - "type": "string", - "description": "The resource type on which this operation can be performed." - }, - "operation": { - "type": "string", - "description": "The name of the operation." - }, - "description": { - "type": "string", - "description": "The description of the operation." - } - } - }, - "StepResource": { - "description": "The resource representation of a rollout step.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties that define the step.", - "$ref": "#/definitions/StepProperties" - } - }, - "required": [ - "properties" - ] - }, - "StepProperties": { - "description": "The properties of a step resource.", - "type": "object", - "discriminator": "stepType", - "properties": { - "stepType": { - "type": "string", - "description": "The type of step.", - "enum": [ - "Wait", - "HealthCheck" - ], - "x-ms-enum": { - "name": "StepType", - "modelAsString": false - } - } - }, - "required": [ - "stepType" - ] - }, - "HealthCheckStepProperties": { - "x-ms-discriminator-value": "HealthCheck", - "type": "object", - "description": "Defines the properties of a health check step.", - "allOf": [ - { - "$ref": "#/definitions/StepProperties" - } - ], - "properties": { - "attributes": { - "description": "The health check step attributes", - "$ref": "#/definitions/HealthCheckStepAttributes" - } - }, - "required": [ - "attributes" - ] - }, - "HealthCheckStepAttributes": { - "type": "object", - "description": "The attributes for the health check step.", - "discriminator": "type", - "properties": { - "type": { - "type": "string", - "description": "The type of health check.", - "example": "REST" - }, - "waitDuration": { - "type": "string", - "description": "The duration in ISO 8601 format for which health check waits idly without any checks.", - "example": "PT15M" - }, - "maxElasticDuration": { - "type": "string", - "description": "The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.", - "example": "PT30M" - }, - "healthyStateDuration": { - "type": "string", - "description": "The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.", - "example": "PT60M" - } - }, - "required": [ - "type", - "healthyStateDuration" - ] - }, - "RestHealthCheckStepAttributes": { - "x-ms-discriminator-value": "REST", - "type": "object", - "description": "Defines the REST health check step properties.", - "allOf": [ - { - "$ref": "#/definitions/HealthCheckStepAttributes" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "The REST health check parameters.", - "$ref": "#/definitions/RestParameters" - } - } - }, - "RestParameters": { - "type": "object", - "description": "The parameters for the REST health check.", - "properties": { - "healthChecks": { - "type": "array", - "items": { - "$ref": "#/definitions/RestHealthCheck" - }, - "description": "The list of checks that form the health check step." - } - }, - "required": [ - "healthChecks" - ] - }, - "RestHealthCheck": { - "type": "object", - "description": "A REST based health check", - "properties": { - "name": { - "type": "string", - "description": "A unique name for this check." - }, - "request": { - "description": "The request to the health provider.", - "$ref": "#/definitions/RestRequest" - }, - "response": { - "description": "The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.", - "$ref": "#/definitions/RestResponse" - } - }, - "required": [ - "name", - "request" - ] - }, - "RestRequest": { - "type": "object", - "description": "The properties that make up a REST request", - "properties": { - "method": { - "type": "string", - "description": "The HTTP method to use for the request.", - "enum": [ - "GET", - "POST" - ], - "x-ms-enum": { - "name": "RestRequestMethod", - "modelAsString": false - } - }, - "uri": { - "type": "string", - "description": "The HTTP URI to use for the request." - }, - "authentication": { - "description": "The authentication information required in the request to the health provider.", - "$ref": "#/definitions/RestRequestAuthentication" - } - }, - "required": [ - "method", - "uri", - "authentication" - ] - }, - "RestRequestAuthentication": { - "type": "object", - "description": "The authentication information required in the REST health check request to the health provider.", - "discriminator": "type", - "properties": { - "type": { - "type": "string", - "description": "The authentication type.", - "example": "ApiKey", - "enum": [ - "ApiKey", - "RolloutIdentity" - ], - "x-ms-enum": { - "name": "RestAuthType", - "modelAsString": false - } - } - }, - "required": [ - "type" - ] - }, - "RolloutIdentityAuthentication": { - "x-ms-discriminator-value": "RolloutIdentity", - "description": "RolloutIdentity uses the user-assigned managed identity authentication context specified in the Identity property during rollout creation.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/RestRequestAuthentication" - } - ] - }, - "ApiKeyAuthentication": { - "x-ms-discriminator-value": "ApiKey", - "description": "ApiKey authentication gives a name and a value that can be included in either the request header or query parameters.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/RestRequestAuthentication" - } - ], - "properties": { - "name": { - "type": "string", - "description": "The key name of the authentication key/value pair." - }, - "in": { - "type": "string", - "description": "The location of the authentication key/value pair in the request.", - "enum": [ - "Query", - "Header" - ], - "x-ms-enum": { - "name": "RestAuthLocation", - "modelAsString": false - } - }, - "value": { - "type": "string", - "description": "The value of the authentication key/value pair." - } - }, - "required": [ - "name", - "in", - "value" - ] - }, - "RestResponse": { - "type": "object", - "description": "The properties that make up the expected REST response", - "properties": { - "successStatusCodes": { - "type": "array", - "description": "The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.", - "items": { - "type": "string" - }, - "example": [ - "Ok", - "No Content" - ] - }, - "regex": { - "type": "object", - "description": "The regular expressions to match the response content with.", - "properties": { - "matches": { - "type": "array", - "description": "The list of regular expressions.", - "items": { - "type": "string" - }, - "example": [ - "Contoso-Service-EndToEnd", - "(?i)\"health_status\":((.|\n)*)\"(green|yellow)\"", - "(?mi)^(\"application_host\": 94781052)$" - ] - }, - "matchQuantifier": { - "type": "string", - "description": "Indicates whether any or all of the expressions should match with the response content.", - "enum": [ - "All", - "Any" - ], - "x-ms-enum": { - "name": "RestMatchQuantifier", - "modelAsString": false - } - } - } - } - } - }, - "WaitStepProperties": { - "x-ms-discriminator-value": "Wait", - "type": "object", - "description": "Defines the properties of a Wait step.", - "allOf": [ - { - "$ref": "#/definitions/StepProperties" - } - ], - "properties": { - "attributes": { - "description": "The Wait attributes", - "$ref": "#/definitions/WaitStepAttributes" - } - }, - "required": [ - "attributes" - ] - }, - "WaitStepAttributes": { - "type": "object", - "description": "The parameters for the wait step.", - "properties": { - "duration": { - "type": "string", - "description": "The duration in ISO 8601 format of how long the wait should be.", - "example": "PT30M" - } - }, - "required": [ - "duration" - ] - }, - "ServiceTopologiesListResult": { - "description": "The list of service topologies.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceTopologyResource" - } - }, - "ServiceListResult": { - "description": "The list of services.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceResource" - } - }, - "ServiceUnitListResult": { - "description": "The list of service units.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceUnitResource" - } - }, - "StepResourceListResult": { - "description": "The list of steps.", - "type": "array", - "items": { - "$ref": "#/definitions/StepResource" - } - }, - "ArtifactSourceListResult": { - "description": "The list of artifact sources.", - "type": "array", - "items": { - "$ref": "#/definitions/ArtifactSource" - } - }, - "RolloutListResult": { - "description": "The list of rollouts.", - "type": "array", - "items": { - "$ref": "#/definitions/Rollout" - } - } - }, - "parameters": { - "artifactSourceName": { - "description": "The name of the artifact source.", - "name": "artifactSourceName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "serviceTopologyName": { - "name": "serviceTopologyName", - "in": "path", - "description": "The name of the service topology .", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "serviceName": { - "name": "serviceName", - "in": "path", - "description": "The name of the service resource.", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "serviceUnitName": { - "name": "serviceUnitName", - "in": "path", - "description": "The name of the service unit resource.", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "stepName": { - "name": "stepName", - "in": "path", - "description": "The name of the deployment step.", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "type": "string", - "required": true, - "x-ms-parameter-location": "client" - }, - "resourceGroupName": { - "description": "The name of the resource group. The name is case insensitive.", - "name": "resourceGroupName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90 - }, - "rolloutName": { - "description": "The rollout name.", - "name": "rolloutName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "retryAttempt": { - "name": "retryAttempt", - "in": "query", - "required": false, - "type": "integer", - "description": "Rollout retry attempt ordinal to get the result of. If not specified, result of the latest attempt will be returned.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for this operation.", - "x-ms-parameter-location": "client" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_createorupdate.json deleted file mode 100644 index 33fc29f32d8e..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_createorupdate.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "artifactSourceName": "myArtifactSource", - "api-version": "2019-11-01-preview", - "artifactSourceInfo": { - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "myArtifactSource", - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_createorupdate_artifactroot.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_createorupdate_artifactroot.json deleted file mode 100644 index 35571cebc988..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_createorupdate_artifactroot.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "artifactSourceName": "myArtifactSource", - "api-version": "2019-11-01-preview", - "artifactSourceInfo": { - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "artifactRoot": "1.0.0.0", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "myArtifactSource", - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_delete.json deleted file mode 100644 index 0b1a1669cd5b..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "artifactSourceName": "myArtifactSource", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_get.json deleted file mode 100644 index 10b2de4cbe8f..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsource_get.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "artifactSourceName": "myArtifactSource", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myArtifactSource", - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsources_list.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsources_list.json deleted file mode 100644 index 0b269f9f6f25..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/artifactsources_list.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": [ - { - "name": "TemplatesArtifactSource", - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/templates?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - }, - { - "name": "BinariesArtifactSource", - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "artifactRoot": "builds/1.0.0.1", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/binaries?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - ] - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/operations_list.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/operations_list.json deleted file mode 100644 index 4eead345f910..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/operations_list.json +++ /dev/null @@ -1,166 +0,0 @@ -{ - "parameters": { - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.DeploymentManager/serviceTopologies/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceTopology", - "operation": "View service topology", - "description": "View the properties of a service topology" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceTopology", - "operation": "Update the service topology", - "description": "Create a new topology or update the properties of an existing topology" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceTopology", - "operation": "Delete service topology", - "description": "Deletes an existing topology." - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Service", - "operation": "View service in a topology", - "description": "View the properties of a service in a service topology" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Service", - "operation": "Update the service in a topology", - "description": "Create a new service or update the properties of an existing service" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Service", - "operation": "Delete service", - "description": "Deletes an existing service in a service topology." - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceUnit", - "operation": "View service unit", - "description": "View the properties of a service unit" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceUnit", - "operation": "Update the service unit", - "description": "Create a new service unit or update the properties of an existing service unit" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceUnit", - "operation": "Delete service unit", - "description": "Deletes an existing service unit." - } - }, - { - "name": "Microsoft.DeploymentManager/artifactSources/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ArtifactSource", - "operation": "View artifact source", - "description": "View the properties of an artifact source." - } - }, - { - "name": "Microsoft.DeploymentManager/artifactSources/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ArtifactSource", - "operation": "Update the artifact source", - "description": "Create a new artifact source or updates the properties of an existing artifact source." - } - }, - { - "name": "Microsoft.DeploymentManager/artifactSources/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ArtifactSource", - "operation": "Delete artifact source", - "description": "Deletes an existing artifact source." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "View rollout", - "description": "View the properties of rollout." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "Create or update a rollout.", - "description": "Create a new rollout or update an existing rollout." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/restart", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "Restart a rollout", - "description": "Restarts a failed rollout." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/cancel", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "Cancel a rollout", - "description": "Cancel a rollout in progress." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "Delete rollout", - "description": "Deletes an existing rollout." - } - } - ] - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_createorupdate.json deleted file mode 100644 index 613903aa42a3..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_createorupdate.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "api-version": "2019-11-01-preview", - "rolloutRequest": { - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ] - } - } - }, - "responses": { - "201": { - "body": { - "name": "myRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ] - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_delete.json deleted file mode 100644 index f333360355b2..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_get.json deleted file mode 100644 index 1792416c65a1..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_get.json +++ /dev/null @@ -1,124 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "status": "Running", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "retryAttempt": 0 - }, - "totalRetryAttempts": 0, - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ], - "services": [ - { - "name": "myService1", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7", - "targetLocation": "centralus", - "serviceUnits": [ - { - "name": "myTopologyUni1", - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "steps": [ - { - "name": "preDeploymentStep1", - "status": "succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "endTime": "2018-08-28T03:35:28.556Z" - } - }, - { - "name": "preDeploymentStep2", - "status": "succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:36:56.386Z", - "endTime": "2018-08-28T03:37:28.556Z" - } - }, - { - "name": "deploy", - "status": "running", - "operationInfo": { - "startTime": "2018-08-28T03:38:56.386Z", - "lastUpdatedTime": "2018-08-28T03:39:28.556Z" - }, - "resourceOperations": [ - { - "resourceName": "keyVaultcentralus", - "operationId": "20FC5A21382DA306", - "resourceType": "Microsoft.KeyVault/vaults", - "provisioningState": "Succeeded", - "statusMessage": "", - "statusCode": "OK" - } - ] - } - ] - } - ] - } - ] - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_post_cancel.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_post_cancel.json deleted file mode 100644 index 0c70c7ad973e..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_post_cancel.json +++ /dev/null @@ -1,124 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "status": "Canceling", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "retryAttempt": 0 - }, - "totalRetryAttempts": 0, - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ], - "services": [ - { - "name": "myService1", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7", - "targetLocation": "centralus", - "serviceUnits": [ - { - "name": "myTopologyUni1", - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "steps": [ - { - "name": "preDeploymentStep1", - "status": "succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "endTime": "2018-08-28T03:35:28.556Z" - } - }, - { - "name": "preDeploymentStep2", - "status": "succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:36:56.386Z", - "endTime": "2018-08-28T03:37:28.556Z" - } - }, - { - "name": "deploy", - "status": "running", - "operationInfo": { - "startTime": "2018-08-28T03:38:56.386Z", - "lastUpdatedTime": "2018-08-28T03:39:28.556Z" - }, - "resourceOperations": [ - { - "resourceName": "keyVaultcentralus", - "operationId": "20FC5A21382DA306", - "resourceType": "Microsoft.KeyVault/vaults", - "provisioningState": "Succeeded", - "statusMessage": "", - "statusCode": "OK" - } - ] - } - ] - } - ] - } - ] - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_post_restart.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_post_restart.json deleted file mode 100644 index a31926654dd9..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollout_post_restart.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "skipSucceeded": true, - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "status": "Running", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "retryAttempt": 1 - }, - "totalRetryAttempts": 1, - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ] - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollouts_list.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollouts_list.json deleted file mode 100644 index 1649daa12071..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/rollouts_list.json +++ /dev/null @@ -1,101 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": [ - { - "name": "CanaryRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "status": "Succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "endTime": "2018-08-28T03:43:55.010Z", - "retryAttempt": 0 - }, - "totalRetryAttempts": 0, - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/binariesArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - } - ] - } - }, - { - "name": "ProdRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "status": "Running", - "operationInfo": { - "startTime": "2019-05-02T03:33:56.386Z", - "retryAttempt": 0 - }, - "totalRetryAttempts": 0, - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/binariesArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "ProdRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep3" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ] - } - } - ] - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/service_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/service_createorupdate.json deleted file mode 100644 index e61a5441d174..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/service_createorupdate.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "api-version": "2019-11-01-preview", - "serviceInfo": { - "location": "centralus", - "tags": {}, - "properties": { - "targetLocation": "centralus", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" - } - } - }, - "responses": { - "201": { - "body": { - "name": "myService", - "type": "Microsoft.DeploymentManager/serviceTopologies/services", - "location": "centralus", - "tags": {}, - "properties": { - "targetLocation": "centralus", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/service_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/service_delete.json deleted file mode 100644 index 1a5bf772f1da..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/service_delete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/service_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/service_get.json deleted file mode 100644 index e0b301b255f0..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/service_get.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myService", - "type": "Microsoft.DeploymentManager/serviceTopologies/services", - "location": "centralus", - "tags": {}, - "properties": { - "targetLocation": "centralus", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/services_list.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/services_list.json deleted file mode 100644 index 1c0e781d0ec2..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/services_list.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": [ - { - "name": "Service East", - "type": "Microsoft.DeploymentManager/serviceTopologies/services", - "location": "centralus", - "tags": {}, - "properties": { - "targetLocation": "eastus", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" - } - }, - { - "name": "Service West", - "type": "Microsoft.DeploymentManager/serviceTopologies/services", - "location": "centralus", - "tags": {}, - "properties": { - "targetLocation": "westus", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" - } - } - ] - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopologies_list.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopologies_list.json deleted file mode 100644 index f9ffda6feb65..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopologies_list.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": [ - { - "name": "ContosoSvc1Topology", - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": { - "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/contoso1ArtifactSource" - } - }, - { - "name": "ContosoSvc2Topology", - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": { - "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/contoso2ArtifactSource" - } - } - ] - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_createorupdate.json deleted file mode 100644 index fdc32d53fffb..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_createorupdate.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2019-11-01-preview", - "serviceTopologyInfo": { - "location": "centralus", - "tags": {}, - "properties": { - "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/myArtifactSource" - } - } - }, - "responses": { - "201": { - "body": { - "name": "myTopology", - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": { - "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/myArtifactSource" - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_createorupdate_noartifactsource.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_createorupdate_noartifactsource.json deleted file mode 100644 index 792c63cf4fbf..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_createorupdate_noartifactsource.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2019-11-01-preview", - "serviceTopologyInfo": { - "location": "centralus", - "tags": {}, - "properties": {} - } - }, - "responses": { - "201": { - "body": { - "name": "myTopology", - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": {} - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_delete.json deleted file mode 100644 index 475c1dd213d6..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_get.json deleted file mode 100644 index 1c1d32c3031e..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/servicetopology_get.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myTopology", - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": { - "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/myArtifactSource" - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_createorupdate.json deleted file mode 100644 index e1b0f0af48c8..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_createorupdate.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "serviceUnitName": "myServiceUnit", - "api-version": "2019-11-01-preview", - "serviceUnitInfo": { - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateArtifactSourceRelativePath": "templates/myTopologyUnit.template.json", - "parametersArtifactSourceRelativePath": "parameter/myTopologyUnit.parameters.json" - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "myServiceUnit", - "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateArtifactSourceRelativePath": "templates/myTopologyUnit.template.json", - "parametersArtifactSourceRelativePath": "parameter/myTopologyUnit.parameters.json" - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_createorupdate_noartifactsource.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_createorupdate_noartifactsource.json deleted file mode 100644 index 6db5d722105b..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_createorupdate_noartifactsource.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "serviceUnitName": "myServiceUnit", - "api-version": "2019-11-01-preview", - "serviceUnitInfo": { - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/templates/myTopologyUnit.template.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D", - "parametersUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/parameter/myTopologyUnit.parameters.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "myServiceUnit", - "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/templates/myTopologyUnit.template.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D", - "parametersUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/parameter/myTopologyUnit.parameters.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_delete.json deleted file mode 100644 index d01b54bd7666..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_delete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "serviceUnitName": "myServiceUnit", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_get.json deleted file mode 100644 index 39d26d54d6ca..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunit_get.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "serviceUnitName": "myServiceUnit", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myServiceUnit", - "type": "Microsoft.DeploymentManager/servicetopologies/services/serviceunits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateArtifactSourceRelativePath": "templates/myTopologyUnit.template.json", - "parametersArtifactSourceRelativePath": "parameter/myTopologyUnit.parameters.json" - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunits_list.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunits_list.json deleted file mode 100644 index 7a3348c56b35..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/serviceunits_list.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": [ - { - "name": "BackEndServiceUnit", - "type": "Microsoft.DeploymentManager/servicetopologies/services/serviceunits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateArtifactSourceRelativePath": "templates/backend.template.json", - "parametersArtifactSourceRelativePath": "parameter/backend.parameters.json" - } - } - }, - { - "name": "FrontEndServiceUnit", - "type": "Microsoft.DeploymentManager/servicetopologies/services/serviceunits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Complete", - "artifacts": { - "templateArtifactSourceRelativePath": "templates/frontend.template.json", - "parametersArtifactSourceRelativePath": "parameter/frontend.parameters.json" - } - } - } - ] - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_delete.json deleted file mode 100644 index a15bc6d95257..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "stepName": "deploymentStep1", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_get.json deleted file mode 100644 index 9003d66939ed..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_get.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "stepName": "waitStep", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "deploymentStep1", - "type": "Microsoft.DeploymentManager/steps", - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "Wait", - "attributes": { - "duration": "PT20M" - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_health_check_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_health_check_createorupdate.json deleted file mode 100644 index b7c5e8bd2b2a..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_health_check_createorupdate.json +++ /dev/null @@ -1,150 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "stepName": "healthCheckStep", - "api-version": "2019-11-01-preview", - "stepInfo": { - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "HealthCheck", - "attributes": { - "waitDuration": "PT15M", - "maxElasticDuration": "PT30M", - "healthyStateDuration": "PT2H", - "type": "REST", - "properties": { - "healthChecks": [ - { - "name": "appHealth", - "request": { - "method": "GET", - "uri": "https://resthealth.healthservice.com/api/applications/contosoApp/healthStatus", - "authentication": { - "type": "ApiKey", - "name": "Code", - "in": "Query", - "value": "NBCapiMOBQyAAbCkeytoPadnvO0eGHmidwFz5rXpappznKp3Jt7LLg==" - } - }, - "response": { - "successStatusCodes": [ - "OK" - ], - "regex": { - "matchQuantifier": "All", - "matches": [ - "(?i)Contoso-App", - "(?i)\"health_status\":((.|\n)*)\"(green|yellow)\"", - "(?mi)^(\"application_host\": 94781052)$" - ] - } - } - }, - { - "name": "serviceHealth", - "request": { - "method": "GET", - "uri": "https://resthealth.healthservice.com/api/services/contosoService/healthStatus", - "authentication": { - "type": "ApiKey", - "name": "code", - "in": "Header", - "value": "NBCapiMOBQyAAbCkeytoPadnvO0eGHmidwFz5rXpappznKp3Jt7LLg==" - } - }, - "response": { - "successStatusCodes": [ - "OK" - ], - "regex": { - "matchQuantifier": "All", - "matches": [ - "(?i)Contoso-Service-EndToEnd", - "(?i)\"health_status\":((.|\n)*)\"(green)\"" - ] - } - } - } - ] - } - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "healthCheckStep", - "type": "Microsoft.DeploymentManager/steps", - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "HealthCheck", - "attributes": { - "waitDuration": "PT15M", - "maxElasticDuration": "PT30M", - "healthyStateDuration": "PT2H", - "type": "REST", - "properties": { - "healthChecks": [ - { - "name": "appHealth", - "request": { - "method": "GET", - "uri": "https://resthealth.healthservice.com/api/applications/contosoApp/healthStatus", - "authentication": { - "type": "ApiKey", - "name": "Code", - "in": "Query", - "value": "NBCapiMOBQyAAbCkeytoPadnvO0eGHmidwFz5rXpappznKp3Jt7LLg==" - } - }, - "response": { - "successStatusCodes": [ - "OK" - ], - "regex": { - "matchQuantifier": "All", - "matches": [ - "(?i)Contoso-App", - "(?i)\"health_status\":((.|\n)*)\"(green|yellow)\"", - "(?mi)^(\"application_host\": 94781052)$" - ] - } - } - }, - { - "name": "serviceHealth", - "request": { - "method": "GET", - "uri": "https://resthealth.healthservice.com/api/services/contosoService/healthStatus", - "authentication": { - "type": "ApiKey", - "name": "code", - "in": "Header", - "value": "NBCapiMOBQyAAbCkeytoPadnvO0eGHmidwFz5rXpappznKp3Jt7LLg==" - } - }, - "response": { - "successStatusCodes": [ - "OK" - ], - "regex": { - "matchQuantifier": "All", - "matches": [ - "(?i)Contoso-Service-EndToEnd", - "(?i)\"health_status\":((.|\n)*)\"(green)\"" - ] - } - } - } - ] - } - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_wait_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_wait_createorupdate.json deleted file mode 100644 index b296e83f2281..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/step_wait_createorupdate.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "stepName": "waitStep", - "api-version": "2019-11-01-preview", - "stepInfo": { - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "Wait", - "attributes": { - "duration": "PT20M" - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "waitStep", - "type": "Microsoft.DeploymentManager/steps", - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "Wait", - "attributes": { - "duration": "PT20M" - } - } - } - } - } -} diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/steps_list.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/steps_list.json deleted file mode 100644 index 6990300763ab..000000000000 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/examples/steps_list.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": [ - { - "name": "waitStepfrontEnd", - "type": "Microsoft.DeploymentManager/steps", - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "Wait", - "attributes": { - "duration": "PT10M" - } - } - }, - { - "name": "waitStepBackEnd", - "type": "Microsoft.DeploymentManager/steps", - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "Wait", - "attributes": { - "duration": "PT30M" - } - } - } - ] - } - } -} diff --git a/specification/deploymentmanager/resource-manager/readme.go.md b/specification/deploymentmanager/resource-manager/readme.go.md deleted file mode 100644 index f9b1d3abede5..000000000000 --- a/specification/deploymentmanager/resource-manager/readme.go.md +++ /dev/null @@ -1,44 +0,0 @@ -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) && !$(track2) -go: - license-header: MICROSOFT_MIT_NO_VERSION - namespace: deploymentmanager - clear-output-folder: true -``` - -``` yaml $(go) && $(track2) -license-header: MICROSOFT_MIT_NO_VERSION -module-name: sdk/resourcemanager/deploymentmanager/armdeploymentmanager -module: github.com/Azure/azure-sdk-for-go/$(module-name) -output-folder: $(go-sdk-folder)/$(module-name) -azure-arm: true -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: package-2019-11-01-preview - - tag: package-2018-09-01-preview -``` - -### Tag: package-2019-11-01-preview and go - -These settings apply only when `--tag=package-2019-11-01-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2019-11-01-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-11-01-preview/$(namespace) -``` - -### Tag: package-2018-09-01-preview and go - -These settings apply only when `--tag=package-2018-09-01-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2018-09-01-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-01-preview/$(namespace) -``` \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/readme.md b/specification/deploymentmanager/resource-manager/readme.md deleted file mode 100644 index c255cf45742a..000000000000 --- a/specification/deploymentmanager/resource-manager/readme.md +++ /dev/null @@ -1,182 +0,0 @@ -# Azure Deployment Manager - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Deployment Manager. - - ---- -## Getting Started -To build the SDK for Deployment Manager, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - -### Basic Information -These are the global settings for the DeploymentManager API. - -``` yaml -openapi-type: arm -tag: package-2019-11-01-preview -``` - -### Tag: package-2019-11-01-preview - -These settings apply only when `package-2019-11-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2019-11-01-preview' -input-file: -- Microsoft.DeploymentManager/preview/2019-11-01-preview/deploymentmanager.json -directive: - - suppress: EnumInsteadOfBoolean - reason: The boolean properties in the specification are actually boolean values in the Deployment Manager application model. - from: deploymentmanager.json - - suppress: TrackedResourceListByImmediateParent - reason: Not available during preview. - - suppress: TrackedResourcePatchOperation - reason: Not available at this time. - from: deploymentmanager.json - - suppress: TrackedResourceListBySubscription - reason: Not available at this time. - from: deploymentmanager.json - - suppress: TrackedResourceListByResourceGroup - reason: Not available at this time. - from: deploymentmanager.json - - suppress: PageableOperation - reason: List operations returns a static list of supported operations for each API version and does not need paging. - from: deploymentmanager.json - - suppress: TrackedResourceGetOperation - reason: The rollout resource has a get operation. The request and response types are separated for clarity. - where: $.definitions.RolloutRequest - - suppress: DescriptionAndTitleMissing - reason: Common types warning. - where: $.definitions.Resource - - suppress: AvoidNestedProperties - reason: Nesting had to be avoided to have the autogenerated classes compose the required polymorphic 'properties' property in the StepResource. - where: $.definitions.StepResource.properties.properties -``` - -### Tag: package-2018-09-01-preview - -These settings apply only when `package-2018-09-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-09-01-preview' -input-file: -- Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json -directive: - - suppress: EnumInsteadOfBoolean - reason: The boolean properties in the specification are actually boolean values in the Deployment Manager application model. - from: deploymentmanager.json - - suppress: TrackedResourceListByImmediateParent - reason: Not available during preview. - - suppress: TrackedResourcePatchOperation - reason: Not available at this time. - from: deploymentmanager.json - - suppress: TrackedResourceListBySubscription - reason: Not available at this time. - from: deploymentmanager.json - - suppress: TrackedResourceListByResourceGroup - reason: Not available at this time. - from: deploymentmanager.json - - suppress: TrackedResourceGetOperation - reason: The rollout resource has a get operation. The request and response types are separated for clarity. - where: $.definitions.RolloutRequest - - suppress: DescriptionAndTitleMissing - reason: Common types warning. - where: $.definitions.Resource - - suppress: AvoidNestedProperties - reason: Nesting had to be avoided to have the autogenerated classes compose the required polymorphic 'properties' property in the StepResource. - where: $.definitions.StepResource.properties.properties -``` - ---- -# Code Generation - - -## Swagger to SDK -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-net-track2 - - repo: azure-sdk-for-python-track2 - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_deploymentmanager'] - - repo: azure-resource-manager-schemas - - repo: azure-powershell -``` - -## C# -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.DeploymentManager - payload-flattening-threshold: 2 - output-folder: $(csharp-sdks-folder)/deploymentmanager/Microsoft.Azure.Management.DeploymentManager/src/Generated - clear-output-folder: true -``` - - -## Python - -See configuration in [readme.python.md](./readme.pyhon.md) - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.deploymentmanager -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 2 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-deploymentmanager - -service-name: Deployment -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2019-11-01-preview -``` - -### Tag: package-2019-11-01-preview and java - -These settings apply only when `--tag=package-2019-11-01-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2019-11-01-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.deploymentmanager.v2019_11_01_preview - output-folder: $(azure-libraries-for-java-folder)/sdk/deploymentmanager/mgmt-v2019_11_01_preview -regenerate-manager: true -generate-interface: true -``` - - - diff --git a/specification/deploymentmanager/resource-manager/readme.nodejs.md b/specification/deploymentmanager/resource-manager/readme.nodejs.md deleted file mode 100644 index 1a824f997569..000000000000 --- a/specification/deploymentmanager/resource-manager/readme.nodejs.md +++ /dev/null @@ -1,14 +0,0 @@ -## Node.js - -These settings apply only when `--nodejs` is specified on the command line. -Please also specify `--node-sdks-folder=`. - -``` yaml $(nodejs) -nodejs: - azure-arm: true - package-name: azure-arm-deploymentmanager - output-folder: $(node-sdks-folder)/lib/services/deploymentmanagerManagement - generate-license-txt: true - generate-package-json: true - generate-readme-md: true -``` diff --git a/specification/deploymentmanager/resource-manager/readme.python.md b/specification/deploymentmanager/resource-manager/readme.python.md deleted file mode 100644 index 68c7f5c85c4f..000000000000 --- a/specification/deploymentmanager/resource-manager/readme.python.md +++ /dev/null @@ -1,20 +0,0 @@ -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -namespace: azure.mgmt.deploymentmanager -package-name: azure-mgmt-deploymentmanager -package-version: 0.9.1 -clear-output-folder: true -modelerfour: - lenient-model-deduplication: true -``` -``` yaml $(python) -no-namespace-folders: true -output-folder: $(python-sdks-folder)/deploymentmanager/azure-mgmt-deploymentmanager/azure/mgmt/deploymentmanager -``` diff --git a/specification/deploymentmanager/resource-manager/readme.ruby.md b/specification/deploymentmanager/resource-manager/readme.ruby.md deleted file mode 100644 index 9d3c8a2ad44c..000000000000 --- a/specification/deploymentmanager/resource-manager/readme.ruby.md +++ /dev/null @@ -1,27 +0,0 @@ -## Ruby - -These settings apply only when `--ruby` is specified on the command line. - -``` yaml -package-name: azure_mgmt_deploymentmanager -package-version: "0.9.0" -azure-arm: true -``` - -### Ruby multi-api - -``` yaml $(ruby) && $(multiapi) -batch: - - tag: package-2019-11-01-preview -``` - -### Tag: package-2019-11-01-preview and ruby - -These settings apply only when `--tag=package-2019-11-01-preview --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-11-01-preview' && $(ruby) -namespace: "Azure::DeploymentManager::Mgmt::V2019-11-01-preview" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_deploymentmanager/lib -``` - diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/desktopvirtualization.json new file mode 100644 index 000000000000..3b6ce015f75d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/desktopvirtualization.json @@ -0,0 +1,10235 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-16-preview", + "title": "Desktop Virtualization API Client" + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "host": "management.azure.com", + "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.DesktopVirtualization/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "List all of the available operations the Desktop Virtualization resource provider supports.", + "x-ms-examples": { + "OperationDescription_List": { + "$ref": "./examples/OperationDescription_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Get", + "description": "Get a workspace.", + "x-ms-examples": { + "Workspace_Get": { + "$ref": "./examples/Workspace_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_CreateOrUpdate", + "description": "Create or update a workspace.", + "x-ms-examples": { + "Workspace_Create": { + "$ref": "./examples/Workspace_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/WorkspaceNameParameter" + }, + { + "name": "workspace", + "description": "Object containing Workspace definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Successfully created workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Delete", + "description": "Remove a workspace.", + "x-ms-examples": { + "Workspace_Delete": { + "$ref": "./examples/Workspace_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted workspace." + }, + "204": { + "description": "Workspace does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Update", + "description": "Update a workspace.", + "x-ms-examples": { + "Workspace_Update": { + "$ref": "./examples/Workspace_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/WorkspaceNameParameter" + }, + { + "name": "workspace", + "description": "Object containing Workspace definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/WorkspacePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_ListByWorkspace", + "description": "List private endpoint connections.", + "x-ms-examples": { + "PrivateEndpointConnection_ListByWorkspace": { + "$ref": "./examples/PrivateEndpointConnection_ListByWorkspace.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/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved connection list.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_GetByWorkspace", + "description": "Get a private endpoint connection.", + "x-ms-examples": { + "PrivateEndpointConnection_GetByWorkspace": { + "$ref": "./examples/PrivateEndpointConnection_GetByWorkspace.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/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_DeleteByWorkspace", + "description": "Remove a connection.", + "x-ms-examples": { + "PrivateEndpointConnection_DeleteByWorkspace": { + "$ref": "./examples/PrivateEndpointConnection_DeleteByWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Successfully removed." + }, + "204": { + "description": "Connection does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_UpdateByWorkspace", + "description": "Approve or reject a private endpoint connection.", + "x-ms-examples": { + "PrivateEndpointConnection_UpdateByWorkspace": { + "$ref": "./examples/PrivateEndpointConnection_UpdateByWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "connection", + "description": "Object containing the updated connection.", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateLinkResources_ListByWorkspace", + "description": "List the private link resources available for this workspace.", + "x-ms-examples": { + "PrivateLinkResources_ListByWorkspace": { + "$ref": "./examples/PrivateLinkResources_ListByWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/WorkspaceNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListByResourceGroup", + "description": "List workspaces.", + "x-ms-examples": { + "Workspace_ListByResourceGroup": { + "$ref": "./examples/Workspace_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspaces in resource group.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListBySubscription", + "description": "List workspaces in subscription.", + "x-ms-examples": { + "Workspace_ListBySubscription": { + "$ref": "./examples/Workspace_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspaces in subscription.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}": { + "get": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_Get", + "description": "Get a scaling plan.", + "x-ms-examples": { + "ScalingPlans_Get": { + "$ref": "./examples/ScalingPlan_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scaling plan.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_Create", + "description": "Create or update a scaling plan.", + "x-ms-examples": { + "ScalingPlans_Create": { + "$ref": "./examples/ScalingPlan_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + }, + { + "name": "scalingPlan", + "description": "Object containing scaling plan definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated scaling plan.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "201": { + "description": "Successfully created scaling plan.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_Delete", + "description": "Remove a scaling plan.", + "x-ms-examples": { + "ScalingPlans_Delete": { + "$ref": "./examples/ScalingPlan_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted scaling plan." + }, + "204": { + "description": "Scaling plan does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_Update", + "description": "Update a scaling plan.", + "x-ms-examples": { + "ScalingPlans_Update": { + "$ref": "./examples/ScalingPlan_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + }, + { + "name": "scalingPlan", + "description": "Object containing scaling plan definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated scaling plan.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans": { + "get": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_ListByResourceGroup", + "description": "List scaling plans.", + "x-ms-examples": { + "ScalingPlans_ListByResourceGroup": { + "$ref": "./examples/ScalingPlan_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scaling plans in resource group.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}": { + "get": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_Get", + "description": "Get a ScalingPlanPooledSchedule.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_Get": { + "$ref": "./examples/ScalingPlanPooledSchedule_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved ScalingPlanPooledSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_Create", + "description": "Create or update a ScalingPlanPooledSchedule.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_Create": { + "$ref": "./examples/ScalingPlanPooledSchedule_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + }, + { + "name": "scalingPlanSchedule", + "description": "Object containing ScalingPlanPooledSchedule definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated ScalingPlanPooledSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "201": { + "description": "Successfully created ScalingPlanPooledSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_Delete", + "description": "Remove a ScalingPlanPooledSchedule.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_Delete": { + "$ref": "./examples/ScalingPlanPooledSchedule_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed ScalingPlanPooledSchedule." + }, + "204": { + "description": "ScalingPlanPooledSchedule does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_Update", + "description": "Update a ScalingPlanPooledSchedule.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_Update": { + "$ref": "./examples/ScalingPlanPooledSchedule_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + }, + { + "name": "scalingPlanSchedule", + "description": "Object containing ScalingPlanPooledSchedule definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedulePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated ScalingPlanPooledSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules": { + "get": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_List", + "description": "List ScalingPlanPooledSchedules.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_List": { + "$ref": "./examples/ScalingPlanPooledSchedule_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved ScalingPlanPooledSchedules.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledScheduleList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}": { + "get": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_Get", + "description": "Get a ScalingPlanPersonalSchedule.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Get": { + "$ref": "./examples/ScalingPlanPersonalSchedule_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved ScalingPlanPersonalSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_Create", + "description": "Create or update a ScalingPlanPersonalSchedule.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Create": { + "$ref": "./examples/ScalingPlanPersonalSchedule_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + }, + { + "name": "scalingPlanSchedule", + "description": "Object containing ScalingPlanPersonalSchedule definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated ScalingPlanPersonalSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "201": { + "description": "Successfully created ScalingPlanPersonalSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_Delete", + "description": "Remove a ScalingPlanPersonalSchedule.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Delete": { + "$ref": "./examples/ScalingPlanPersonalSchedule_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed ScalingPlanPersonalSchedule." + }, + "204": { + "description": "ScalingPlanPersonalSchedule does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_Update", + "description": "Update a ScalingPlanPersonalSchedule.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Update": { + "$ref": "./examples/ScalingPlanPersonalSchedule_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + }, + { + "name": "scalingPlanSchedule", + "description": "Object containing ScalingPlanPersonalSchedule definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedulePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated ScalingPlanPersonalSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules": { + "get": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_List", + "description": "List ScalingPlanPersonalSchedules.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_List": { + "$ref": "./examples/ScalingPlanPersonalSchedule_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ScalingPlanNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved ScalingPlanPersonalSchedules.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalScheduleList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/scalingPlans": { + "get": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_ListBySubscription", + "description": "List scaling plans in subscription.", + "x-ms-examples": { + "ScalingPlans_ListBySubscription": { + "$ref": "./examples/ScalingPlan_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scaling plans in subscription.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Get", + "description": "Get an application group.", + "x-ms-examples": { + "ApplicationGroup_Get": { + "$ref": "./examples/ApplicationGroup_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_CreateOrUpdate", + "description": "Create or update an applicationGroup.", + "x-ms-examples": { + "ApplicationGroup_Create": { + "$ref": "./examples/ApplicationGroup_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + }, + { + "name": "applicationGroup", + "description": "Object containing ApplicationGroup definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "201": { + "description": "Successfully created application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Delete", + "description": "Remove an applicationGroup.", + "x-ms-examples": { + "ApplicationGroup_Delete": { + "$ref": "./examples/ApplicationGroup_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed application group." + }, + "204": { + "description": "Application group does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Update", + "description": "Update an applicationGroup.", + "x-ms-examples": { + "ApplicationGroups_Update": { + "$ref": "./examples/ApplicationGroup_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + }, + { + "name": "applicationGroup", + "description": "Object containing ApplicationGroup definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationGroupPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_ListByResourceGroup", + "description": "List applicationGroups.", + "x-ms-examples": { + "ApplicationGroup_ListByResourceGroup": { + "$ref": "./examples/ApplicationGroup_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType." + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application groups in resource group.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_ListBySubscription", + "description": "List applicationGroups in subscription.", + "x-ms-examples": { + "ApplicationGroup_List": { + "$ref": "./examples/ApplicationGroup_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application groups in subscription.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems": { + "get": { + "tags": [ + "StartMenuItem" + ], + "operationId": "StartMenuItems_List", + "description": "List start menu items in the given application group.", + "x-ms-examples": { + "StartMenuItem_List": { + "$ref": "./examples/StartMenuItem_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved start menu items in application group.", + "schema": { + "$ref": "#/definitions/StartMenuItemList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_Get", + "description": "Get an application.", + "x-ms-examples": { + "Application_Get": { + "$ref": "./examples/Application_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Applications_CreateOrUpdate", + "description": "Create or update an application.", + "x-ms-examples": { + "Application_Create": { + "$ref": "./examples/Application_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "application", + "description": "Object containing Application definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "201": { + "description": "Successfully created application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Applications_Delete", + "description": "Remove an application.", + "x-ms-examples": { + "Application_Delete": { + "$ref": "./examples/Application_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed application." + }, + "204": { + "description": "Application does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Applications_Update", + "description": "Update an application.", + "x-ms-examples": { + "Application_Update": { + "$ref": "./examples/Application_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "application", + "description": "Object containing Application definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_List", + "description": "List applications.", + "x-ms-examples": { + "Applications_List": { + "$ref": "./examples/Application_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved applications in application group.", + "schema": { + "$ref": "#/definitions/ApplicationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}": { + "get": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_Get", + "description": "Get a desktop.", + "x-ms-examples": { + "Desktop_Get": { + "$ref": "./examples/Desktop_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/DesktopNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved desktop.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_Update", + "description": "Update a desktop.", + "x-ms-examples": { + "Desktop_Update": { + "$ref": "./examples/Desktop_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/DesktopNameParameter" + }, + { + "name": "desktop", + "description": "Object containing Desktop definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DesktopPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated desktop.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops": { + "get": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_List", + "description": "List desktops.", + "x-ms-examples": { + "Desktop_List": { + "$ref": "./examples/Desktop_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ApplicationGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved desktops in application group.", + "schema": { + "$ref": "#/definitions/DesktopList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Get", + "description": "Get a host pool.", + "x-ms-examples": { + "HostPool_Get": { + "$ref": "./examples/HostPool_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_CreateOrUpdate", + "description": "Create or update a host pool.", + "x-ms-examples": { + "HostPool_Create": { + "$ref": "./examples/HostPool_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "name": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HostPool" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "201": { + "description": "Successfully created host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Delete", + "description": "Remove a host pool.", + "x-ms-examples": { + "HostPool_Delete": { + "$ref": "./examples/HostPool_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to delete sessionHost." + } + ], + "responses": { + "200": { + "description": "Successfully removed host pool." + }, + "204": { + "description": "Host pool does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Update", + "description": "Update a host pool.", + "x-ms-examples": { + "HostPool_Update": { + "$ref": "./examples/HostPool_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "name": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/HostPoolPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_ListByResourceGroup", + "description": "List hostPools.", + "x-ms-examples": { + "HostPool_ListByResourceGroup": { + "$ref": "./examples/HostPool_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in resource group.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_List", + "description": "List hostPools in subscription.", + "x-ms-examples": { + "HostPool_List": { + "$ref": "./examples/HostPool_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in subscription.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default": { + "get": { + "tags": [ + "SessionHostManagements" + ], + "operationId": "SessionHostManagements_Get", + "description": "Get a SessionHostManagement.", + "x-ms-examples": { + "SessionHostManagements_Get": { + "$ref": "./examples/SessionHostManagements_Get.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/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved sessionHostManagement.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "SessionHostManagements_CreateOrUpdate", + "description": "Create or update a SessionHostManagement.", + "x-ms-examples": { + "SessionHostManagements_Create": { + "$ref": "./examples/SessionHostManagements_Create.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/HostPoolNameParameter" + }, + { + "name": "sessionHostManagement", + "description": "Object containing SessionHostManagement definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated SessionHostManagement.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "201": { + "description": "Successfully created SessionHostManagement.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "SessionHostManagements_Update", + "description": "Update a SessionHostManagement.", + "x-ms-examples": { + "SessionHostManagements_Update": { + "$ref": "./examples/SessionHostManagements_Update.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/HostPoolNameParameter" + }, + { + "name": "sessionHostManagement", + "description": "Object containing SessionHostManagement definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostManagementPatch" + } + } + ], + "responses": { + "200": { + "description": "Update SessionHostManagement success.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements": { + "get": { + "tags": [ + "SessionHostManagements" + ], + "operationId": "SessionHostManagements_ListByHostPool", + "description": "List SessionHostManagements by hostPool.", + "x-ms-examples": { + "SessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/SessionHostManagements_ListByHostPool.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/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved SessionHostManagements in HostPool.", + "schema": { + "$ref": "#/definitions/SessionHostManagementList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/initiateSessionHostUpdate": { + "post": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "InitiateSessionHostUpdate_Post", + "description": "Initiates a hostpool update or schedule an update for the future.", + "x-ms-examples": { + "HostPools_Update_Post": { + "$ref": "./examples/SessionHostManagements_UpdateSessionHosts_Post.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/HostPoolNameParameter" + }, + { + "name": "updateSessionHostsRequestBody", + "description": "Object containing the definition for properties to be used in the sessionHostUpdate validation.", + "in": "body", + "schema": { + "$ref": "#/definitions/UpdateSessionHostsRequestBody" + } + } + ], + "responses": { + "202": { + "description": "Successfully initiated hostpool update.", + "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": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/controlSessionHostUpdate": { + "post": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "ControlSessionHostUpdate_Post", + "description": "Control update of a hostpool.", + "x-ms-examples": { + "SessionHostManagements_ControlUpdate_Post": { + "$ref": "./examples/SessionHostManagements_ControlSessionHostUpdate_Post.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/HostPoolNameParameter" + }, + { + "name": "hostPoolControlParameter", + "description": "Object containing control action for hostpool update.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HostPoolControlParameter" + } + } + ], + "responses": { + "202": { + "description": "Successfully controlled hostpool update.", + "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": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/operationStatuses/{operationId}": { + "get": { + "tags": [ + "SessionHostManagements" + ], + "operationId": "SessionHostManagementsOperationStatus_Get", + "description": "Get Operation status for SessionHostManagement", + "x-ms-examples": { + "SessionHostManagementsOperationStatus_Get": { + "$ref": "./examples/SessionHostManagementsOperationStatus_Get.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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operation status.", + "schema": { + "$ref": "#/definitions/SessionHostManagementOperationStatus" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/operationStatuses": { + "get": { + "tags": [ + "SessionHostManagements" + ], + "operationId": "SessionHostManagementsOperationStatus_List", + "description": "Get Operation status for SessionHostManagement", + "x-ms-examples": { + "SessionHostManagementsOperationStatus_List": { + "$ref": "./examples/SessionHostManagementsOperationStatus_List.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/HostPoolNameParameter" + }, + { + "name": "isLatest", + "in": "query", + "required": false, + "type": "boolean", + "description": "Returns the most recent sessionHostManagement operation." + }, + { + "name": "type", + "in": "query", + "required": false, + "type": "string", + "description": "Filter based on the type of sessionHostManagement operation. Valid values are 'InitiateSessionHostUpdate' and 'ValidateSessionHostUpdate'" + }, + { + "name": "isNonTerminal", + "in": "query", + "required": false, + "type": "boolean", + "description": "Returns currently running operations. Ignored if 'isLatest' is true" + }, + { + "name": "correlationId", + "in": "query", + "required": false, + "type": "string", + "description": "CorrelationId of the sessionHostManagement operations to be returned." + }, + { + "name": "action", + "in": "query", + "required": false, + "type": "string", + "description": "Action type for the Operation Status list to be filtered on. Valid actions are: start | retry | pause | resume | cancel)." + }, + { + "name": "isInitiatingOperation", + "in": "query", + "required": false, + "type": "boolean", + "description": "Filter option to only return operations that initiated a sessionHostManagement operation." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operation status.", + "schema": { + "$ref": "#/definitions/SessionHostManagementOperationStatusList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default": { + "put": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_CreateOrUpdate", + "description": "Create or update a SessionHostConfiguration.", + "x-ms-examples": { + "SessionHostConfigurations_Create": { + "$ref": "./examples/SessionHostConfigurations_Create.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/HostPoolNameParameter" + }, + { + "name": "sessionHostConfiguration", + "description": "Object containing SessionHostConfiguration definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Successfully initiated SessionHostConfiguration Update validation.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "201": { + "description": "Successfully created Session Host Configuration.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_Update", + "description": "Update a SessionHostConfiguration.", + "x-ms-examples": { + "SessionHostConfigurations_Update": { + "$ref": "./examples/SessionHostConfigurations_Update.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/HostPoolNameParameter" + }, + { + "name": "sessionHostConfiguration", + "description": "Object containing SessionHostConfiguration definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostConfigurationPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully created SessionHostConfiguration.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "202": { + "description": "Successfully created SessionHostConfiguration.", + "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": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_Get", + "description": "Get a SessionHostConfiguration.", + "x-ms-examples": { + "SessionHostConfigurations_Get": { + "$ref": "./examples/SessionHostConfigurations_Get.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/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved sessionHostConfiguration.", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations": { + "get": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_ListByHostPool", + "description": "List sessionHostConfigurations.", + "x-ms-examples": { + "SessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/SessionHostConfigurations_ListByHostPool.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/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved sessionHostConfigurations in HostPool.", + "schema": { + "$ref": "#/definitions/SessionHostConfigurationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default/operationStatuses/{operationId}": { + "get": { + "tags": [ + "SessionHostConfigurations" + ], + "operationId": "SessionHostConfigurationsOperationStatus_Get", + "description": "Get Operation status for SessionHostManagement", + "x-ms-examples": { + "SessionHostConfigurationsOperationStatus_Get": { + "$ref": "./examples/SessionHostConfigurationsOperationStatus_Get.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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operation status.", + "schema": { + "$ref": "#/definitions/SessionHostConfigurationOperationStatus" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default/operationStatuses": { + "get": { + "tags": [ + "SessionHostConfigurations" + ], + "operationId": "SessionHostConfigurationsOperationStatus_List", + "description": "Get Operation status for SessionHostConfiguration", + "x-ms-examples": { + "SessionHostConfigurationsOperationStatus_List": { + "$ref": "./examples/SessionHostConfigurationsOperationStatus_List.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/HostPoolNameParameter" + }, + { + "name": "isLatest", + "in": "query", + "required": false, + "type": "boolean", + "description": "Returns the most recent sessionHostConfiguration operation." + }, + { + "name": "isNonTerminal", + "in": "query", + "required": false, + "type": "boolean", + "description": "Returns currently running operations. Ignored if 'isLatest' is true" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operation status.", + "schema": { + "$ref": "#/definitions/SessionHostConfigurationOperationStatusList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations/default": { + "get": { + "tags": [ + "ActiveSessionHostConfiguration" + ], + "operationId": "ActiveSessionHostConfigurations_Get", + "description": "Get the ActiveSessionHostConfiguration for the hostPool that is currently being used for update operations.", + "x-ms-examples": { + "SessionHostConfigurations_Get": { + "$ref": "./examples/ActiveSessionHostConfigurations_Get.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/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved activeSessionHostConfiguration.", + "schema": { + "$ref": "#/definitions/ActiveSessionHostConfiguration" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations": { + "get": { + "tags": [ + "ActiveSessionHostConfiguration" + ], + "operationId": "ActiveSessionHostConfigurations_ListByHostPool", + "description": "List activeSessionHostConfigurations.", + "x-ms-examples": { + "SessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/ActiveSessionHostConfigurations_ListByHostPool.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/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved activeSessionHostConfigurations in HostPool.", + "schema": { + "$ref": "#/definitions/ActiveSessionHostConfigurationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateLinkResources_ListByHostPool", + "description": "List the private link resources available for this hostpool.", + "x-ms-examples": { + "PrivateLinkResources_ListByHostPool": { + "$ref": "./examples/PrivateLinkResources_ListByHostPool.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/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/retrieveRegistrationToken": { + "post": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_RetrieveRegistrationToken", + "description": "Registration token of the host pool.", + "x-ms-examples": { + "HostPools_RetrieveRegistrationToken_Post": { + "$ref": "./examples/HostPools_RetrieveRegistrationToken_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in resource group.", + "schema": { + "$ref": "#/definitions/RegistrationInfo" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_ListByHostPool", + "description": "List userSessions.", + "x-ms-examples": { + "UserSession_ListByHostPool": { + "$ref": "./examples/UserSession_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user sessions in host pool.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}": { + "get": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Get", + "description": "Get a session host.", + "x-ms-examples": { + "SessionHost_Get": { + "$ref": "./examples/SessionHost_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved session host.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Delete", + "description": "Remove a SessionHost.", + "x-ms-examples": { + "SessionHost_Delete": { + "$ref": "./examples/SessionHost_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to force sessionHost deletion even when userSession exists." + } + ], + "responses": { + "200": { + "description": "Successfully removed session host." + }, + "204": { + "description": "Session host does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Update", + "description": "Update a session host.", + "x-ms-examples": { + "SessionHost_Update": { + "$ref": "./examples/SessionHost_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "sessionHost", + "description": "Object containing SessionHost definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostPatch" + } + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to update assign, unassign or reassign personal desktop." + } + ], + "responses": { + "200": { + "description": "Successfully updated session host.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts": { + "get": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_List", + "description": "List sessionHosts.", + "x-ms-examples": { + "SessionHost_List": { + "$ref": "./examples/SessionHost_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved session hosts in host pool.", + "schema": { + "$ref": "#/definitions/SessionHostList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/retryProvisioning": { + "post": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHost_RetryProvisioning", + "description": "Retry provisioning on a SessionHost.", + "x-ms-examples": { + "SessionHost_RetryProvisioning_Post": { + "$ref": "./examples/SessionHost_RetryProvisioning_Post.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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully started provisioning retry on the sessionHost." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}": { + "get": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_Get", + "description": "Get a msixpackage.", + "x-ms-examples": { + "MSIXPackage_Get": { + "$ref": "./examples/MsixPackage_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/MSIXPackageFullNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved MSIX Package.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_CreateOrUpdate", + "description": "Create or update a MSIX package.", + "x-ms-examples": { + "MSIXPackage_Create": { + "$ref": "./examples/MsixPackage_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/MSIXPackageFullNameParameter" + }, + { + "name": "msixPackage", + "description": "Object containing MSIX Package definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated MSIX Package.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "201": { + "description": "Successfully created MSIX Package.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_Delete", + "description": "Remove an MSIX Package.", + "x-ms-examples": { + "MSIXPackage_Delete": { + "$ref": "./examples/MsixPackage_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/MSIXPackageFullNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed MSIX Package." + }, + "204": { + "description": "MSIX Package does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_Update", + "description": "Update an MSIX Package.", + "x-ms-examples": { + "MSIXPackage_Update": { + "$ref": "./examples/MsixPackage_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/MSIXPackageFullNameParameter" + }, + { + "name": "msixPackage", + "description": "Object containing MSIX Package definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/MSIXPackagePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated MSIX Package.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages": { + "get": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_List", + "description": "List MSIX packages in hostpool.", + "x-ms-examples": { + "MSIXPackage_List": { + "$ref": "./examples/MsixPackage_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved MSIX Packages in hostpool.", + "schema": { + "$ref": "#/definitions/MSIXPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/importAppAttachPackageInfo": { + "post": { + "tags": [ + "AppAttachPackageInfo" + ], + "operationId": "AppAttachPackageInfo_Import", + "description": "Gets information from a package given the path to the package.", + "x-ms-examples": { + "AppAttachPackageInfo_Import": { + "$ref": "./examples/AppAttachPackageInfo_Import_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "importPackageInfoRequest", + "description": "Object containing URI to package image and other optional properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImportPackageInfoRequest" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved packages in specified Image Path.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/expandMsixImage": { + "post": { + "tags": [ + "MsixImage" + ], + "operationId": "MsixImages_Expand", + "description": "Expands and Lists MSIX packages in an Image, given the Image Path.", + "x-ms-examples": { + "MsixImage_Expand": { + "$ref": "./examples/MsixImage_Expand_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "name": "msixImageURI", + "description": "Object containing URI to MSIX Image", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MSIXImageURI" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved MSIX packages in specified Image Path.", + "schema": { + "$ref": "#/definitions/ExpandMsixImageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}": { + "get": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_Get", + "description": "Get an app attach package.", + "x-ms-examples": { + "AppAttachPackage_Get": { + "$ref": "./examples/AppAttachPackage_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_CreateOrUpdate", + "description": "Create or update an App Attach package.", + "x-ms-examples": { + "AppAttachPackage_Create": { + "$ref": "./examples/AppAttachPackage_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + }, + { + "name": "appAttachPackage", + "description": "Object containing App Attach Package definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "201": { + "description": "Successfully created App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_Delete", + "description": "Remove an App Attach Package.", + "x-ms-examples": { + "AppAttachPackage_Delete": { + "$ref": "./examples/AppAttachPackage_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to delete App Attach package." + } + ], + "responses": { + "200": { + "description": "Successfully deleted App Attach Package." + }, + "204": { + "description": "App Attach Package does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_Update", + "description": "Update an App Attach Package", + "x-ms-examples": { + "AppAttachPackage_Update": { + "$ref": "./examples/AppAttachPackage_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + }, + { + "name": "appAttachPackagePatch", + "description": "Object containing App Attach Package definition.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/AppAttachPackagePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages": { + "get": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_ListByResourceGroup", + "description": "List App Attach packages in resource group.", + "x-ms-examples": { + "AppAttachPackage_ListByResourceGroup": { + "$ref": "./examples/AppAttachPackage_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are package name and host pool." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved App Attach Packages in resource group.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/appAttachPackages": { + "get": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_ListBySubscription", + "description": "List App Attach packages in subscription.", + "x-ms-examples": { + "AppAttachPackage_ListBySubscription": { + "$ref": "./examples/AppAttachPackage_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are package name, host pool, and resource group." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved App Attach Packages in subscription.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Get", + "description": "Get a userSession.", + "x-ms-examples": { + "UserSession_Get": { + "$ref": "./examples/UserSession_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user session.", + "schema": { + "$ref": "#/definitions/UserSession" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Delete", + "description": "Remove a userSession.", + "x-ms-examples": { + "UserSession_Delete": { + "$ref": "./examples/UserSession_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to login off userSession." + } + ], + "responses": { + "200": { + "description": "Successfully removed user session." + }, + "204": { + "description": "User session does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_List", + "description": "List userSessions.", + "x-ms-examples": { + "UserSession_List": { + "$ref": "./examples/UserSession_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user sessions in session host.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect": { + "post": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Disconnect", + "description": "Disconnect a userSession.", + "x-ms-examples": { + "UserSession_Disconnect_Post": { + "$ref": "./examples/UserSession_Disconnect_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully disconnected user session." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage": { + "post": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_SendMessage", + "description": "Send a message to a user.", + "x-ms-examples": { + "UserSession_SendMessage_Post": { + "$ref": "./examples/UserSession_SendMessage_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + }, + { + "name": "sendMessage", + "description": "Object containing message includes title and message body", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SendMessage" + } + } + ], + "responses": { + "200": { + "description": "Successfully sent message to user session." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/scalingPlans": { + "get": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_ListByHostPool", + "description": "List scaling plan associated with hostpool.", + "x-ms-examples": { + "ScalingPlan_ListByHostPool": { + "$ref": "./examples/ScalingPlan_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scaling plan associated with hostpool.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_ListByHostPool", + "description": "List private endpoint connections associated with hostpool.", + "x-ms-examples": { + "PrivateEndpointConnection_ListByHostPool": { + "$ref": "./examples/PrivateEndpointConnection_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved connection list.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_GetByHostPool", + "description": "Get a private endpoint connection.", + "x-ms-examples": { + "PrivateEndpointConnection_GetByHostPool": { + "$ref": "./examples/PrivateEndpointConnection_GetByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_DeleteByHostPool", + "description": "Remove a connection.", + "x-ms-examples": { + "PrivateEndpointConnection_DeleteByHostPool": { + "$ref": "./examples/PrivateEndpointConnection_DeleteByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Successfully removed." + }, + "204": { + "description": "Connection does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_UpdateByHostPool", + "description": "Approve or reject a private endpoint connection.", + "x-ms-examples": { + "PrivateEndpointConnection_UpdateByHostPool": { + "$ref": "./examples/PrivateEndpointConnection_UpdateByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/HostPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "connection", + "description": "Object containing the updated connection.", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CloudError": { + "description": "Cloud error object.", + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorProperties" + } + } + }, + "CloudErrorProperties": { + "description": "Cloud error object properties.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "ResourceProviderOperationList": { + "type": "object", + "description": "Result of the request to list operations.", + "readOnly": true, + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperation" + }, + "description": "List of operations supported by this resource provider." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ResourceProviderOperation": { + "type": "object", + "description": "Supported operation of this resource provider.", + "readOnly": true, + "properties": { + "name": { + "description": "Operation name, in format of {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "type": "object", + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Resource provider: Microsoft Desktop Virtualization.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of this operation.", + "type": "string" + } + } + }, + "isDataAction": { + "description": "Is a data action.", + "type": "boolean" + }, + "properties": { + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of the operation", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification" + } + } + }, + "ServiceSpecification": { + "description": "Service specification payload", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Specifications of the Log for Azure Monitoring", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + } + } + }, + "LogSpecification": { + "description": "Specifications of the Log for Azure Monitoring", + "type": "object", + "properties": { + "name": { + "description": "Name of the log", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the log", + "type": "string" + }, + "blobDuration": { + "description": "Blob duration of the log", + "type": "string" + } + } + }, + "Workspace": { + "type": "object", + "description": "Represents a Workspace definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties" + } + } + }, + "WorkspaceProperties": { + "description": "Schema for Workspace properties.", + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Workspace. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup resource Ids.", + "items": { + "type": "string" + } + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints", + "x-nullable": false + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connection associated with the specified resource" + } + } + }, + "WorkspaceList": { + "type": "object", + "title": "WorkspaceList", + "description": "List of Workspace definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Workspace definitions.", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "WorkspacePatch": { + "type": "object", + "description": "Workspace properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspacePatchProperties" + } + } + }, + "WorkspacePatchProperties": { + "description": "Workspace properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + } + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled to allow this resource to be access from the public network" + } + } + }, + "ApplicationGroup": { + "type": "object", + "description": "Represents a ApplicationGroup definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for ApplicationGroup", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGroupProperties", + "x-nullable": false + } + } + }, + "ApplicationGroupProperties": { + "description": "Schema for ApplicationGroup properties.", + "type": "object", + "required": [ + "hostPoolArmPath", + "applicationGroupType" + ], + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of ApplicationGroup. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "hostPoolArmPath": { + "type": "string", + "description": "HostPool arm path of ApplicationGroup.", + "x-nullable": false + }, + "workspaceArmPath": { + "type": "string", + "description": "Workspace arm path of ApplicationGroup.", + "readOnly": true + }, + "applicationGroupType": { + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationGroupType", + "modelAsString": true + }, + "type": "string", + "description": "Resource Type of ApplicationGroup.", + "x-nullable": false + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + }, + "showInFeed": { + "type": "boolean", + "description": "Boolean representing whether the applicationGroup is show in the feed." + } + } + }, + "ApplicationGroupPatch": { + "type": "object", + "description": "ApplicationGroup properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "ApplicationGroup properties that can be patched.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGroupPatchProperties" + } + } + }, + "ApplicationGroupPatchProperties": { + "description": "ApplicationGroup properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "showInFeed": { + "type": "boolean", + "description": "Boolean representing whether the applicationGroup is show in the feed." + } + } + }, + "ApplicationGroupList": { + "type": "object", + "title": "ApplicationGroupList", + "description": "List of ApplicationGroup definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ApplicationGroup definitions.", + "items": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "HostPool": { + "type": "object", + "description": "Represents a HostPool definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for HostPool", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolProperties", + "x-nullable": false + } + } + }, + "HostPoolProperties": { + "description": "Properties of HostPool.", + "type": "object", + "required": [ + "hostPoolType", + "loadBalancerType", + "preferredAppGroupType" + ], + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of HostPool. (internal use)", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "hostPoolType": { + "enum": [ + "Personal", + "Pooled", + "BYODesktop" + ], + "x-ms-enum": { + "name": "HostPoolType", + "modelAsString": true, + "values": [ + { + "value": "Personal", + "description": "Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost." + }, + { + "value": "Pooled", + "description": "Users get a new (random) SessionHost every time it connects to the HostPool." + }, + { + "value": "BYODesktop", + "description": "Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct." + } + ] + }, + "type": "string", + "description": "HostPool type for desktop.", + "x-nullable": false + }, + "personalDesktopAssignmentType": { + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true + }, + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool." + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "format": "int32", + "description": "The max session limit of HostPool." + }, + "loadBalancerType": { + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + }, + "type": "string", + "description": "The type of the load balancer.", + "x-nullable": false + }, + "ring": { + "type": "integer", + "format": "int32", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfo", + "description": "The registration info of HostPool." + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "managementType": { + "enum": [ + "Automated", + "Standard" + ], + "x-ms-enum": { + "name": "ManagementType", + "modelAsString": true + }, + "type": "string", + "description": "The type of management for this hostpool, Automated or Standard. The default value is Automated.", + "x-nullable": false + }, + "applicationGroupReferences": { + "readOnly": true, + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + } + }, + "appAttachPackageReferences": { + "readOnly": true, + "type": "array", + "description": "List of App Attach Package links.", + "items": { + "type": "string" + } + }, + "ssoadfsAuthority": { + "type": "string", + "description": "URL to customer ADFS server for signing WVD SSO certificates." + }, + "ssoClientId": { + "type": "string", + "description": "ClientId for the registered Relying Party used to issue WVD SSO certificates." + }, + "ssoClientSecretKeyVaultPath": { + "type": "string", + "description": "Path to Azure KeyVault storing the secret used for communication to ADFS." + }, + "ssoSecretType": { + "enum": [ + "SharedKey", + "Certificate", + "SharedKeyInKeyVault", + "CertificateInKeyVault" + ], + "x-ms-enum": { + "name": "SSOSecretType", + "modelAsString": true + }, + "type": "string", + "description": "The type of single sign on Secret Type." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group", + "x-nullable": false + }, + "startVMOnConnect": { + "type": "boolean", + "description": "The flag to turn on/off StartVMOnConnect feature." + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled", + "EnabledForSessionHostsOnly", + "EnabledForClientsOnly" + ], + "x-ms-enum": { + "name": "HostpoolPublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints", + "x-nullable": false + }, + "agentUpdate": { + "$ref": "#/definitions/AgentUpdateProperties", + "description": "The session host configuration for updating agent, monitoring agent, and stack component." + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connection associated with the specified resource" + }, + "managedPrivateUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ManagedPrivateUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + }, + "directUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DirectUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + }, + "publicUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + }, + "relayUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "RelayUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + } + } + }, + "HostPoolPatch": { + "type": "object", + "description": "HostPool properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "HostPool properties that can be patched.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolPatchProperties" + } + } + }, + "HostPoolPatchProperties": { + "description": "Properties of HostPool.", + "type": "object", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "format": "int32", + "description": "The max session limit of HostPool." + }, + "personalDesktopAssignmentType": { + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true + }, + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool." + }, + "loadBalancerType": { + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + }, + "type": "string", + "description": "The type of the load balancer." + }, + "ring": { + "type": "integer", + "format": "int32", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfoPatch", + "description": "The registration info of HostPool." + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "ssoadfsAuthority": { + "type": "string", + "description": "URL to customer ADFS server for signing WVD SSO certificates." + }, + "ssoClientId": { + "type": "string", + "description": "ClientId for the registered Relying Party used to issue WVD SSO certificates." + }, + "ssoClientSecretKeyVaultPath": { + "type": "string", + "description": "Path to Azure KeyVault storing the secret used for communication to ADFS." + }, + "ssoSecretType": { + "enum": [ + "SharedKey", + "Certificate", + "SharedKeyInKeyVault", + "CertificateInKeyVault" + ], + "x-ms-enum": { + "name": "SSOSecretType", + "modelAsString": true + }, + "type": "string", + "description": "The type of single sign on Secret Type." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group" + }, + "startVMOnConnect": { + "type": "boolean", + "description": "The flag to turn on/off StartVMOnConnect feature." + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled", + "EnabledForSessionHostsOnly", + "EnabledForClientsOnly" + ], + "x-ms-enum": { + "name": "HostpoolPublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled to allow this resource to be access from the public network" + }, + "agentUpdate": { + "$ref": "#/definitions/AgentUpdatePatchProperties", + "description": "The session host configuration for updating agent, monitoring agent, and stack component." + }, + "managedPrivateUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ManagedPrivateUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + }, + "directUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DirectUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + }, + "publicUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + }, + "relayUDP": { + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "RelayUDP", + "modelAsString": true + }, + "type": "string", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections", + "x-nullable": false + } + } + }, + "SessionHostManagementList": { + "type": "object", + "title": "SessionHostManagementList", + "description": "List of SessionHostManagement definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHostManagement definitions.", + "items": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "SessionHostManagement": { + "type": "object", + "description": "Represents a SessionHostManagement definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for SessionHostManagement", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostManagementProperties" + } + } + }, + "SessionHostManagementProperties": { + "description": "Session host Managements of HostPool.", + "type": "object", + "required": [ + "scheduledDateTimeZone", + "update" + ], + "properties": { + "scheduledDateTimeZone": { + "type": "string", + "description": "Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true." + }, + "update": { + "$ref": "#/definitions/HostPoolUpdateConfigurationProperties", + "description": "Parameters for a hostpool update." + } + } + }, + "SessionHostManagementPatch": { + "type": "object", + "description": "Represents a SessionHostManagementPatch definition.", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for SessionHostManagementPatch", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostManagementPatchProperties" + } + } + }, + "SessionHostManagementPatchProperties": { + "description": "Session host Managements of HostPool.", + "type": "object", + "properties": { + "scheduledDateTimeZone": { + "type": "string", + "description": "Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true." + }, + "update": { + "$ref": "#/definitions/HostPoolUpdateConfigurationPatchProperties", + "description": "Parameters for a hostpool update." + } + } + }, + "HostPoolUpdateConfigurationProperties": { + "description": "The configurations of a hostpool update.", + "type": "object", + "required": [ + "maxVmsRemoved", + "logOffDelayMinutes" + ], + "properties": { + "deleteOriginalVm": { + "type": "boolean", + "description": "Whether not to save original disk. False by default." + }, + "maxVmsRemoved": { + "type": "integer", + "format": "int32", + "description": "The maximum number of virtual machines to be removed during hostpool update.", + "minimum": 1 + }, + "logOffDelayMinutes": { + "type": "integer", + "format": "int32", + "description": "Grace period before logging off users in minutes." + }, + "logOffMessage": { + "type": "string", + "description": "Log off message sent to user for logoff. Default value is an empty string.", + "maxLength": 260, + "default": "" + } + } + }, + "HostPoolUpdateConfigurationPatchProperties": { + "description": "The configurations of a hostpool update.", + "type": "object", + "properties": { + "deleteOriginalVm": { + "type": "boolean", + "description": "Whether not to save original disk. False by default." + }, + "maxVmsRemoved": { + "type": "integer", + "format": "int32", + "description": "The maximum number of virtual machines to be removed during hostpool update.", + "minimum": 1 + }, + "logOffDelayMinutes": { + "type": "integer", + "format": "int32", + "description": "Grace period before logging off users in minutes." + }, + "logOffMessage": { + "type": "string", + "description": "Log off message sent to user for logoff.", + "maxLength": 260 + } + } + }, + "HostPoolControlParameter": { + "description": "Represents properties for a hostpool update.", + "type": "object", + "required": [ + "action" + ], + "properties": { + "action": { + "enum": [ + "Start", + "Pause", + "Cancel", + "Retry", + "Resume" + ], + "x-ms-enum": { + "name": "HostPoolUpdateAction", + "modelAsString": true, + "values": [ + { + "value": "Start", + "description": "Start the hostpool update." + }, + { + "value": "Pause", + "description": "Pause the hostpool update." + }, + { + "value": "Cancel", + "description": "Cancel the hostpool update." + }, + { + "value": "Retry", + "description": "Retry the hostpool update." + }, + { + "value": "Resume", + "description": "Resume the hostpool update." + } + ] + }, + "type": "string", + "description": "Action types for controlling hostpool update.", + "x-nullable": false + }, + "cancelMessage": { + "type": "string", + "description": "The cancel message sent to the user on the session host. This is can only be specified if the action is 'Cancel'.", + "maxLength": 260 + } + } + }, + "HostPoolUpdateFault": { + "description": "Hostpool update fault information.", + "type": "object", + "properties": { + "faultType": { + "type": "string", + "description": "Hostpool update fault type.", + "enum": [ + "ServiceError", + "UserError" + ], + "x-ms-enum": { + "name": "faultType", + "modelAsString": true, + "values": [ + { + "value": "ServiceError", + "description": "Fault caused by service error." + }, + { + "value": "UserError", + "description": "Fault caused by user error." + } + ] + } + }, + "faultCode": { + "type": "string", + "description": "Hostpool update fault code." + }, + "faultText": { + "type": "string", + "description": "Hostpool update fault text." + }, + "faultContext": { + "type": "string", + "description": "Hostpool update fault context." + } + } + }, + "SessionHostManagementOperationStatusList": { + "type": "object", + "title": "SessionHostManagementOperationStatusList", + "description": "List of SessionHostManagementOperationStatus definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHostManagementOperationStatus definitions.", + "items": { + "$ref": "#/definitions/SessionHostManagementOperationStatus" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "SessionHostManagementOperationStatus": { + "description": "The current status of an async operation.", + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "description": "Fully qualified ID for the async operation.", + "type": "string" + }, + "name": { + "description": "Name of the async operation.", + "type": "string" + }, + "status": { + "description": "Operation status. Current defined values are < Scheduled | UpdatingSessionHosts | ValidatingSessionHostUpdate | Paused | Pausing | Cancelling | Resuming | Starting > | Succeeded | Failed | Canceled", + "type": "string" + }, + "percentComplete": { + "description": "Percent of the operation that is complete.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation.", + "type": "string", + "format": "date-time" + }, + "operations": { + "description": "The operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionHostManagementOperationStatus" + } + }, + "error": { + "description": "If present, details of the operation error.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + }, + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "The custom properties of the OperationStatus.", + "$ref": "#/definitions/SessionHostManagementOperationStatusProperties" + } + } + }, + "SessionHostManagementOperationStatusProperties": { + "description": "Properties bag to hold custom RP properties for sessionHostManagement Operation Statuses.", + "type": "object", + "properties": { + "correlationId": { + "type": "string", + "description": "The Log Analytics." + }, + "type": { + "description": "Type of sessionHostManagement operation.", + "$ref": "#/definitions/SessionHostManagementOperationType" + }, + "action": { + "description": "Action type of the current sessionHostManagement operation.", + "enum": [ + "Start", + "Retry", + "Pause", + "Resume", + "Cancel" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationActionSHM", + "modelAsString": true + } + }, + "progress": { + "description": "Progress information on the sessionHostManagement operation.", + "$ref": "#/definitions/SessionHostManagementOperationProgress" + }, + "scheduledDateTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp that the update is scheduled for." + }, + "sessionHostManagement": { + "description": "SessionHostManagement properties used for the operation.", + "$ref": "#/definitions/SessionHostManagement" + }, + "parentId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the operation that started this process." + } + } + }, + "SessionHostManagementOperationType": { + "enum": [ + "InitiateSessionHostUpdate", + "ValidateSessionHostUpdate" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationTypeSHM", + "modelAsString": true + } + }, + "SessionHostManagementOperationProgress": { + "type": "object", + "description": "SessionHostManagement Operation Progress information.", + "properties": { + "executionStartTime": { + "format": "date-time", + "type": "string", + "description": "Time that the sessionHostManagement operation was created." + }, + "totalSessionHosts": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts to be started in the sessionHostManagement operation." + }, + "sessionHostsInProgress": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts in progress in the sessionHostManagement operation." + }, + "sessionHostsCompleted": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts completed in the sessionHostManagement operation." + }, + "sessionHostsRollbackFailed": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts rollback failed in the sessionHostManagement operation." + } + } + }, + "SessionHostManagementProgressError": { + "description": "SessionHostManagement operation fault information.", + "type": "object", + "properties": { + "faultType": { + "type": "string", + "description": "SessionHostManagement operation fault type.", + "enum": [ + "ServiceError", + "UserError" + ], + "x-ms-enum": { + "name": "faultType", + "modelAsString": true, + "values": [ + { + "value": "ServiceError", + "description": "Fault caused by service error." + }, + { + "value": "UserError", + "description": "Fault caused by user error." + } + ] + } + }, + "faultCode": { + "type": "string", + "description": "SessionHostManagement operation fault code." + }, + "faultText": { + "type": "string", + "description": "SessionHostManagement operation fault text." + }, + "faultContext": { + "type": "string", + "description": "SessionHostManagement operation fault context." + } + } + }, + "UpdateSessionHostsRequestBody": { + "description": "Object containing the definition for properties to be used for a sessionHostUpdate operation.", + "type": "object", + "properties": { + "scheduledDateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp that the update validation is scheduled for. If none is provided, the update will be executed immediately" + }, + "scheduledDateTimeZone": { + "type": "string", + "description": "The timeZone as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid." + }, + "update": { + "description": "settings for management information for the hostpool update operation. If none is provided the update will use the settings saved in the sessionHostManagement object.", + "$ref": "#/definitions/HostPoolUpdateConfigurationPatchProperties" + } + } + }, + "SessionHostConfigurationOperationStatus": { + "description": "The current status of an async operation.", + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "description": "Fully qualified ID for the async operation.", + "type": "string" + }, + "name": { + "description": "Name of the async operation.", + "type": "string" + }, + "status": { + "description": "Operation status. Current defined values are ", + "type": "string" + }, + "percentComplete": { + "description": "Percent of the operation that is complete.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation.", + "type": "string", + "format": "date-time" + }, + "operations": { + "description": "The operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionHostConfigurationOperationStatus" + } + }, + "error": { + "description": "If present, details of the operation error.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + } + } + }, + "SessionHostConfigurationOperationStatusList": { + "type": "object", + "title": "OperationStatusList", + "description": "List of OperationStatus definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of OperationStatus definitions.", + "items": { + "$ref": "#/definitions/SessionHostConfigurationOperationStatus" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ActiveSessionHostConfigurationList": { + "type": "object", + "title": "ActiveSessionHostConfigurationList", + "description": "List of ActiveSessionHostConfiguration definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ActiveSessionHostConfiguration definitions.", + "items": { + "$ref": "#/definitions/ActiveSessionHostConfiguration" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ActiveSessionHostConfiguration": { + "type": "object", + "description": "Represents a ActiveSessionHostConfiguration definition. This has all of the sessionHostConfiguration properties except provisioningState", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for SessionHostConfiguration", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ActiveSessionHostConfigurationProperties" + } + } + }, + "ActiveSessionHostConfigurationProperties": { + "description": "Session host configurations of HostPool.", + "type": "object", + "required": [ + "vmNamePrefix", + "networkInfo", + "vmSizeId", + "diskInfo", + "imageInfo", + "domainInfo", + "vmAdminCredentials" + ], + "properties": { + "version": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "vmTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Hashtable that lists key/value pair tags to apply to the VMs" + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided." + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3]." + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool." + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoProperties", + "description": "Disk information." + }, + "customConfigurationScriptUrl": { + "type": "string", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning." + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoProperties", + "description": "Security information." + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Local Admin credentials for session hosts." + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoProperties", + "description": "Boot Diagnostics information." + } + } + }, + "SessionHostConfigurationList": { + "type": "object", + "title": "SessionHostConfigurationList", + "description": "List of SessionHostConfiguration definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHostConfiguration definitions.", + "items": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "SessionHostConfiguration": { + "type": "object", + "description": "Represents a SessionHostConfiguration definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for SessionHostConfiguration", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostConfigurationProperties" + } + } + }, + "SessionHostConfigurationProperties": { + "description": "Session host configurations of HostPool.", + "type": "object", + "required": [ + "vmNamePrefix", + "networkInfo", + "vmSizeId", + "diskInfo", + "imageInfo", + "domainInfo", + "vmAdminCredentials" + ], + "properties": { + "version": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "provisioningState": { + "description": "Provisioning state of the Session Host Configuration.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningStateSHC", + "modelAsString": true + } + }, + "vmTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Hashtable that lists key/value pair tags to apply to the VMs" + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided." + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3]." + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool." + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoProperties", + "description": "Disk information." + }, + "customConfigurationScriptUrl": { + "type": "string", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning." + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoProperties", + "description": "Security information." + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Local Admin credentials for session hosts." + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoProperties", + "description": "Boot Diagnostics information." + } + } + }, + "SessionHostConfigurationPatch": { + "type": "object", + "description": "Represents a SessionHostConfigurationPatch definition.", + "properties": { + "properties": { + "description": "Detailed properties for SessionHostConfigurationPatch", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostConfigurationPatchProperties" + } + } + }, + "SessionHostConfigurationPatchProperties": { + "description": "Session host configurations of HostPool.", + "type": "object", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "vmTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Hashtable that lists key/value pair tags to apply to the VMs" + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in" + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3]." + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool." + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoPatchProperties", + "description": "Disk information." + }, + "customConfigurationScriptUrl": { + "type": "string", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning.", + "maxLength": 260 + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoPatchProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoPatchProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoPatchProperties", + "description": "Security information." + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsPatchProperties", + "description": "Local Admin credentials for session hosts." + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoPatchProperties", + "description": "Boot Diagnostics information." + } + } + }, + "DiskInfoProperties": { + "description": "Disk information.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "x-ms-enum": { + "name": "VirtualMachineDiskType", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + } + ] + }, + "description": "The disk type used by virtual machine in hostpool session host." + } + } + }, + "DiskInfoPatchProperties": { + "description": "Disk information.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "x-ms-enum": { + "name": "VirtualMachineDiskType", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + } + ] + }, + "description": "The disk type used by virtual machine in hostpool session host." + } + } + }, + "ImageInfoProperties": { + "description": "Image configurations of session host in a HostPool.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "enum": [ + "Marketplace", + "Custom" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "Marketplace", + "description": "Using default marketplace images offered by Azure Marketplace." + }, + { + "value": "Custom", + "description": "Using a custom image." + } + ] + }, + "type": "string", + "description": "The type of image session hosts use in the hostpool.", + "x-nullable": false + }, + "marketplaceInfo": { + "$ref": "#/definitions/MarketplaceInfoProperties", + "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type." + }, + "customInfo": { + "$ref": "#/definitions/CustomInfoProperties", + "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type." + } + } + }, + "ImageInfoPatchProperties": { + "description": "Image configurations of session host in a HostPool.", + "type": "object", + "properties": { + "type": { + "enum": [ + "Marketplace", + "Custom" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "Marketplace", + "description": "Using default marketplace images offered by Azure Marketplace." + }, + { + "value": "Custom", + "description": "Using a custom image." + } + ] + }, + "type": "string", + "description": "The type of image session hosts use in the hostpool.", + "x-nullable": false + }, + "marketplaceInfo": { + "$ref": "#/definitions/MarketplaceInfoPatchProperties", + "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type." + }, + "customInfo": { + "$ref": "#/definitions/CustomInfoPatchProperties", + "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type." + } + } + }, + "MarketplaceInfoProperties": { + "description": "Marketplace image information.", + "type": "object", + "required": [ + "offer", + "publisher", + "sku", + "exactVersion" + ], + "properties": { + "offer": { + "type": "string", + "description": "The offer of the image." + }, + "publisher": { + "type": "string", + "description": "The publisher of the image." + }, + "sku": { + "type": "string", + "description": "The sku of the image." + }, + "exactVersion": { + "type": "string", + "description": "The exact version of the image." + } + } + }, + "MarketplaceInfoPatchProperties": { + "description": "Marketplace image information.", + "type": "object", + "properties": { + "offer": { + "type": "string", + "description": "The offer of the image." + }, + "publisher": { + "type": "string", + "description": "The publisher of the image." + }, + "sku": { + "type": "string", + "description": "The sku of the image." + }, + "exactVersion": { + "type": "string", + "description": "The exact version of the image." + } + } + }, + "CustomInfoProperties": { + "description": "Custom image information.", + "type": "object", + "required": [ + "resourceId" + ], + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the custom image." + } + } + }, + "CustomInfoPatchProperties": { + "description": "Custom image information.", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the custom image." + } + } + }, + "DomainInfoProperties": { + "description": "Domain configurations of session hosts.", + "type": "object", + "required": [ + "joinType" + ], + "properties": { + "joinType": { + "enum": [ + "ActiveDirectory", + "AzureActiveDirectory" + ], + "x-ms-enum": { + "name": "DomainJoinType", + "modelAsString": true, + "values": [ + { + "value": "ActiveDirectory", + "description": "Using microsoft active directory." + }, + { + "value": "AzureActiveDirectory", + "description": "Using microsoft azure active directory." + } + ] + }, + "type": "string", + "description": "The type of domain join done by the virtual machine.", + "x-nullable": false + }, + "activeDirectoryInfo": { + "$ref": "#/definitions/ActiveDirectoryInfoProperties", + "description": "Active directory info. Only one should be populated based on the join type." + }, + "azureActiveDirectoryInfo": { + "$ref": "#/definitions/AzureActiveDirectoryInfoProperties", + "description": "Azure active directory info. Only one should be populated based on the join type." + } + } + }, + "DomainInfoPatchProperties": { + "description": "Domain configurations of session hosts.", + "type": "object", + "properties": { + "activeDirectoryInfo": { + "$ref": "#/definitions/ActiveDirectoryInfoPatchProperties", + "description": "Active directory info. Only one should be populated based on the join type." + } + } + }, + "ActiveDirectoryInfoProperties": { + "description": "Active directory info. Only one should be populated based on the join type.", + "type": "object", + "required": [ + "domainCredentials", + "ouPath" + ], + "properties": { + "domainCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Credentials needed to create the virtual machine." + }, + "ouPath": { + "type": "string", + "description": "The ou path." + }, + "domainName": { + "type": "string", + "description": "The domain a virtual machine connected to a hostpool will join." + } + } + }, + "ActiveDirectoryInfoPatchProperties": { + "description": "Active directory info. Only one should be populated based on the join type.", + "type": "object", + "properties": { + "domainCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsPatchProperties", + "description": "Credentials needed to create the virtual machine." + } + } + }, + "AzureActiveDirectoryInfoProperties": { + "description": "Azure Active directory info. Only one should be populated based on the join type.", + "type": "object", + "required": [ + "mdmProviderGuid" + ], + "properties": { + "mdmProviderGuid": { + "type": "string", + "description": "The mdm guid." + } + } + }, + "KeyVaultCredentialsProperties": { + "description": "Credentials kept in the keyvault.", + "type": "object", + "required": [ + "usernameKeyVaultSecretUri", + "passwordKeyVaultSecretUri" + ], + "properties": { + "usernameKeyVaultSecretUri": { + "type": "string", + "description": "The uri to access the secret that the username is stored in." + }, + "passwordKeyVaultSecretUri": { + "type": "string", + "description": "The uri to access the secret that the password is stored in." + } + } + }, + "KeyVaultCredentialsPatchProperties": { + "description": "Credentials kept in the keyvault.", + "type": "object", + "properties": { + "usernameKeyVaultSecretUri": { + "type": "string", + "description": "The uri to access the secret that the username is stored in." + }, + "passwordKeyVaultSecretUri": { + "type": "string", + "description": "The uri to access the secret that the password is stored in." + } + } + }, + "NetworkInfoProperties": { + "description": "Network information.", + "type": "object", + "required": [ + "subnetId" + ], + "properties": { + "subnetId": { + "type": "string", + "description": "The resource ID of the subnet." + }, + "securityGroupId": { + "type": "string", + "description": "The resource ID of the security group. Any allowable/open ports should be specified in the NSG." + } + } + }, + "NetworkInfoPatchProperties": { + "description": "Network information.", + "type": "object", + "properties": { + "subnetId": { + "type": "string", + "description": "The resource ID of the subnet." + }, + "securityGroupId": { + "type": "string", + "description": "The resource ID of the security group. Any allowable/open ports should be specified in the NSG." + } + } + }, + "SecurityInfoProperties": { + "description": "Security information.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Standard", + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "VirtualMachineSecurityType", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard security protocol. No additional parameters" + }, + { + "value": "TrustedLaunch", + "description": "TrustedLaunch allows for secure boot adn vTPM" + }, + { + "value": "ConfidentialVM", + "description": "Confidential Virtual Machine security protocol" + } + ] + }, + "default": "Standard", + "description": "The security type used by virtual machine in hostpool session host. Default is Standard." + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Whether to use secureBoot on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Whether to use vTPM on the virtual machine." + } + } + }, + "SecurityInfoPatchProperties": { + "description": "Security information.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Standard", + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "VirtualMachineSecurityType", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard security protocol. No additional parameters" + }, + { + "value": "TrustedLaunch", + "description": "TrustedLaunch allows for secure boot adn vTPM" + }, + { + "value": "ConfidentialVM", + "description": "Confidential Virtual Machine security protocol" + } + ] + }, + "description": "The security type used by virtual machine in hostpool session host." + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Whether to use secureBoot on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Whether to use vTPM on the virtual machine." + } + } + }, + "BootDiagnosticsInfoProperties": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "BootDiagnosticsInfoPatchProperties": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "RegistrationInfo": { + "description": "Represents a RegistrationInfo definition.", + "type": "object", + "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token." + }, + "token": { + "type": "string", + "description": "The registration token base64 encoded string." + }, + "registrationTokenOperation": { + "enum": [ + "Delete", + "None", + "Update" + ], + "x-ms-enum": { + "name": "RegistrationTokenOperation", + "modelAsString": true + }, + "type": "string", + "description": "The type of resetting the token.", + "x-nullable": false + } + } + }, + "RegistrationInfoPatch": { + "description": "Represents a RegistrationInfo definition.", + "type": "object", + "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token." + }, + "registrationTokenOperation": { + "enum": [ + "Delete", + "None", + "Update" + ], + "x-ms-enum": { + "name": "RegistrationTokenOperation", + "modelAsString": true + }, + "type": "string", + "description": "The type of resetting the token." + } + } + }, + "AgentUpdateProperties": { + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of maintenance for session host components.", + "enum": [ + "Default", + "Scheduled" + ], + "x-ms-enum": { + "name": "SessionHostComponentUpdateType", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Agent and other agent side components are delivery schedule is controlled by WVD Infra." + }, + { + "value": "Scheduled", + "description": "TenantAdmin have opted in for Scheduled Component Update feature." + } + ] + } + }, + "useSessionHostLocalTime": { + "type": "boolean", + "description": "Whether to use localTime of the virtual machine." + }, + "maintenanceWindowTimeZone": { + "type": "string", + "description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true." + }, + "maintenanceWindows": { + "type": "array", + "description": "List of maintenance windows. Maintenance windows are 2 hours long.", + "items": { + "$ref": "#/definitions/MaintenanceWindowProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "MaintenanceWindowProperties": { + "description": "Maintenance window starting hour and day of week.", + "type": "object", + "properties": { + "hour": { + "format": "int32", + "type": "integer", + "description": "The update start hour of the day. (0 - 23)" + }, + "dayOfWeek": { + "type": "string", + "description": "Day of the week.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + } + }, + "AgentUpdatePatchProperties": { + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of maintenance for session host components.", + "enum": [ + "Default", + "Scheduled" + ], + "x-ms-enum": { + "name": "SessionHostComponentUpdateType", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Agent and other agent side components are delivery schedule is controlled by WVD Infra." + }, + { + "value": "Scheduled", + "description": "TenantAdmin have opted in for Scheduled Component Update feature." + } + ] + } + }, + "useSessionHostLocalTime": { + "type": "boolean", + "description": "Whether to use localTime of the virtual machine." + }, + "maintenanceWindowTimeZone": { + "type": "string", + "description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true." + }, + "maintenanceWindows": { + "type": "array", + "description": "List of maintenance windows. Maintenance windows are 2 hours long.", + "items": { + "$ref": "#/definitions/MaintenanceWindowPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "MaintenanceWindowPatchProperties": { + "description": "Maintenance window starting hour and day of week.", + "type": "object", + "properties": { + "hour": { + "format": "int32", + "type": "integer", + "description": "The update start hour of the day. (0 - 23)" + }, + "dayOfWeek": { + "type": "string", + "description": "Day of the week.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + } + }, + "SendMessage": { + "description": "Represents message sent to a UserSession.", + "type": "object", + "properties": { + "messageTitle": { + "type": "string", + "description": "Title of message." + }, + "messageBody": { + "type": "string", + "description": "Body of message." + } + } + }, + "HostPoolList": { + "type": "object", + "title": "HostPoolList", + "description": "List of HostPool definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of HostPool definitions.", + "items": { + "$ref": "#/definitions/HostPool" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "MSIXPackage": { + "description": "Schema for MSIX Package properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for MSIX Package", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MSIXPackageProperties", + "x-nullable": false + } + } + }, + "MSIXPackageProperties": { + "description": "Schema for MSIX Package properties.", + "type": "object", + "properties": { + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share.", + "x-nullable": false + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml. ", + "x-nullable": false + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ", + "x-nullable": false + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal. ", + "x-nullable": true + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image. ", + "x-nullable": false + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed.", + "x-nullable": false + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool. ", + "x-nullable": false + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies. ", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + } + }, + "version": { + "type": "string", + "description": "Package Version found in the appxmanifest.xml. ", + "x-nullable": false + }, + "lastUpdated": { + "format": "date-time", + "type": "string", + "description": "Date Package was last updated, found in the appxmanifest.xml. ", + "x-nullable": false + }, + "packageApplications": { + "type": "array", + "description": "List of package applications. ", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-nullable": false + } + } + }, + "MSIXPackagePatch": { + "type": "object", + "description": "MSIX Package properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for MSIX Package", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MSIXPackagePatchProperties" + } + } + }, + "MSIXPackagePatchProperties": { + "description": "MSIX Package properties that can be patched.", + "type": "object", + "properties": { + "isActive": { + "type": "boolean", + "description": "Set a version of the package to be active across hostpool. " + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Set Registration mode. Regular or Delayed." + }, + "displayName": { + "type": "string", + "description": "Display name for MSIX Package." + } + } + }, + "MsixPackageApplications": { + "description": "Schema for MSIX Package Application properties.", + "type": "object", + "properties": { + "appId": { + "type": "string", + "description": "Package Application Id, found in appxmanifest.xml.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Description of Package Application.", + "x-nullable": false + }, + "appUserModelID": { + "type": "string", + "description": "Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml.", + "x-nullable": false + }, + "friendlyName": { + "type": "string", + "description": "User friendly name.", + "x-nullable": false + }, + "iconImageName": { + "type": "string", + "description": "User friendly name.", + "x-nullable": false + }, + "rawIcon": { + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + }, + "rawPng": { + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + } + } + }, + "MsixPackageDependencies": { + "description": "Schema for MSIX Package Dependencies properties.", + "type": "object", + "properties": { + "dependencyName": { + "type": "string", + "description": "Name of package dependency.", + "x-nullable": false + }, + "publisher": { + "type": "string", + "description": "Name of dependency publisher.", + "x-nullable": false + }, + "minVersion": { + "type": "string", + "description": "Dependency version required.", + "x-nullable": false + } + } + }, + "MSIXPackageList": { + "type": "object", + "title": "MsixPackageList", + "description": "List of MSIX Package definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of MSIX Package definitions.", + "items": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "AppAttachPackage": { + "description": "Schema for App Attach Package properties.", + "type": "object", + "x-ms-client-flatten": false, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackageProperties", + "x-nullable": false + } + } + }, + "AppAttachPackagePatch": { + "description": "Schema for patchable App Attach Package properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackagePatchProperties", + "x-ms-client-flatten": false, + "x-nullable": false + } + } + }, + "AppAttachPackageList": { + "type": "object", + "title": "AppAttachPackageList", + "description": "List of App Attach Package definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of App Attach Package definitions.", + "items": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "AppAttachPackageProperties": { + "description": "Schema for App Attach Package properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the App Attach Package." + }, + "image": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackageInfoProperties", + "x-nullable": false + }, + "hostPoolReferences": { + "type": "array", + "description": "List of Hostpool resource Ids.", + "items": { + "type": "string" + } + }, + "keyVaultURL": { + "type": "string", + "description": "URL of keyvault location to store certificate" + }, + "failHealthCheckOnStagingFailure": { + "$ref": "#/definitions/FailHealthCheckOnStagingFailureEnum", + "description": "Parameter indicating how the health check should behave if this package fails staging" + } + } + }, + "AppAttachPackagePatchProperties": { + "description": "Schema for patchable fields on an App Attach Package.", + "type": "object", + "properties": { + "image": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackageInfoProperties" + }, + "hostPoolReferences": { + "type": "array", + "description": "List of Hostpool resource Ids.", + "items": { + "type": "string" + } + }, + "keyVaultURL": { + "type": "string", + "description": "URL of keyvault location to store certificate" + }, + "failHealthCheckOnStagingFailure": { + "$ref": "#/definitions/FailHealthCheckOnStagingFailureEnum", + "description": "Parameter indicating how the health check should behave if this package fails staging" + } + } + }, + "AppAttachPackageInfoProperties": { + "description": "Schema for Import Package Information properties.", + "type": "object", + "properties": { + "packageAlias": { + "type": "string", + "description": "Alias of App Attach Package. Assigned at import time" + }, + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share.", + "x-nullable": false + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml. ", + "x-nullable": false + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ", + "x-nullable": false + }, + "packageFullName": { + "type": "string", + "description": "Package Full Name from appxmanifest.xml. ", + "x-nullable": false + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal. ", + "x-nullable": true + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image. ", + "x-nullable": false + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed.", + "x-nullable": false + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool. ", + "x-nullable": false + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies. ", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-ms-identifiers": [], + "x-nullable": true + }, + "version": { + "type": "string", + "description": "Package Version found in the appxmanifest.xml. ", + "x-nullable": false + }, + "lastUpdated": { + "format": "date-time", + "type": "string", + "description": "Date Package was last updated, found in the appxmanifest.xml. ", + "x-nullable": false + }, + "packageApplications": { + "type": "array", + "description": "List of package applications. ", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-ms-identifiers": [], + "x-nullable": false + }, + "certificateName": { + "type": "string", + "description": "Certificate name found in the appxmanifest.xml. ", + "x-nullable": true + }, + "certificateExpiry": { + "format": "date-time", + "type": "string", + "description": "Date certificate expires, found in the appxmanifest.xml. ", + "x-nullable": true + }, + "isPackageTimestamped": { + "enum": [ + "Timestamped", + "NotTimestamped" + ], + "x-ms-enum": { + "name": "packageTimestamped", + "modelAsString": true + }, + "type": "string", + "description": "Is package timestamped so it can ignore the certificate expiry date", + "x-nullable": true + } + } + }, + "ImportPackageInfoRequest": { + "description": "Information to import app attach package", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "URI to Image" + }, + "packageArchitecture": { + "enum": [ + "ARM", + "ARM64", + "x86", + "x64", + "Neutral", + "x86a64", + "ALL" + ], + "x-ms-enum": { + "name": "AppAttachPackageArchitectures", + "modelAsString": true + }, + "type": "string", + "description": "Possible device architectures that an app attach package can be configured for", + "x-nullable": true + } + } + }, + "FailHealthCheckOnStagingFailureEnum": { + "enum": [ + "Unhealthy", + "NeedsAssistance", + "DoNotFail" + ], + "x-ms-enum": { + "name": "failHealthCheckOnStagingFailure", + "modelAsString": true + }, + "type": "string", + "description": "Parameter indicating how the health check should behave if this package fails staging" + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Provisioning", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "Application": { + "description": "Schema for Application properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for Application", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties", + "x-nullable": false + } + } + }, + "ApplicationProperties": { + "description": "Schema for Application properties.", + "type": "object", + "required": [ + "commandLineSetting" + ], + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Application. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "msixPackageFamilyName": { + "type": "string", + "description": "Specifies the package family name for MSIX applications", + "x-nullable": true, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "msixPackageApplicationId": { + "type": "string", + "description": "Specifies the package application Id for MSIX applications", + "x-nullable": true, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "applicationType": { + "enum": [ + "InBuilt", + "MsixApplication" + ], + "x-ms-enum": { + "name": "RemoteApplicationType", + "modelAsString": true + }, + "type": "string", + "description": "Resource Type of Application.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "commandLineSetting": { + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true + }, + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.", + "x-nullable": false + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + }, + "iconHash": { + "readOnly": true, + "type": "string", + "description": "Hash of the icon." + }, + "iconContent": { + "readOnly": true, + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + } + } + }, + "ApplicationList": { + "type": "object", + "title": "ApplicationList", + "description": "List of Application definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Application definitions.", + "items": { + "$ref": "#/definitions/Application" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ApplicationPatch": { + "type": "object", + "description": "Application properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Application", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationPatchProperties" + } + } + }, + "ApplicationPatchProperties": { + "description": "Application properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "commandLineSetting": { + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true + }, + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + }, + "msixPackageFamilyName": { + "type": "string", + "description": "Specifies the package family name for MSIX applications", + "x-nullable": true + }, + "msixPackageApplicationId": { + "type": "string", + "description": "Specifies the package application Id for MSIX applications", + "x-nullable": true + }, + "applicationType": { + "enum": [ + "InBuilt", + "MsixApplication" + ], + "x-ms-enum": { + "name": "RemoteApplicationType", + "modelAsString": true + }, + "type": "string", + "description": "Resource Type of Application." + } + } + }, + "Desktop": { + "description": "Schema for Desktop properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DesktopProperties" + } + } + }, + "DesktopProperties": { + "description": "Schema for Desktop properties.", + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Desktop. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + }, + "iconHash": { + "readOnly": true, + "type": "string", + "description": "Hash of the icon." + }, + "iconContent": { + "readOnly": true, + "type": "string", + "format": "byte", + "description": "The icon a 64 bit string as a byte array." + } + } + }, + "DesktopList": { + "type": "object", + "title": "DesktopList", + "description": "List of Desktop definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Desktop definitions.", + "items": { + "$ref": "#/definitions/Desktop" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "DesktopPatch": { + "type": "object", + "description": "Desktop properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DesktopPatchProperties" + } + } + }, + "DesktopPatchProperties": { + "description": "Desktop properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + } + } + }, + "StartMenuItemProperties": { + "description": "Schema for StartMenuItem properties.", + "type": "object", + "properties": { + "appAlias": { + "type": "string", + "description": "Alias of StartMenuItem." + }, + "filePath": { + "type": "string", + "description": "Path to the file of StartMenuItem." + }, + "commandLineArguments": { + "type": "string", + "description": "Command line arguments for StartMenuItem." + }, + "iconPath": { + "type": "string", + "description": "Path to the icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + } + } + }, + "StartMenuItem": { + "type": "object", + "description": "Represents a StartMenuItem definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for StartMenuItem", + "x-ms-client-flatten": true, + "$ref": "#/definitions/StartMenuItemProperties" + } + } + }, + "StartMenuItemList": { + "type": "object", + "title": "StartMenuItemList", + "description": "List of StartMenuItem definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of StartMenuItem definitions.", + "items": { + "$ref": "#/definitions/StartMenuItem" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ExpandMsixImageProperties": { + "description": "Schema for Expand MSIX Image properties.", + "type": "object", + "properties": { + "packageAlias": { + "type": "string", + "description": "Alias of MSIX Package." + }, + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share.", + "x-nullable": false + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml. ", + "x-nullable": false + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ", + "x-nullable": false + }, + "packageFullName": { + "type": "string", + "description": "Package Full Name from appxmanifest.xml. ", + "x-nullable": false + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal. ", + "x-nullable": true + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image. ", + "x-nullable": false + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed.", + "x-nullable": false + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool. ", + "x-nullable": false + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies. ", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-nullable": true + }, + "version": { + "type": "string", + "description": "Package Version found in the appxmanifest.xml. ", + "x-nullable": false + }, + "lastUpdated": { + "format": "date-time", + "type": "string", + "description": "Date Package was last updated, found in the appxmanifest.xml. ", + "x-nullable": false + }, + "packageApplications": { + "type": "array", + "description": "List of package applications. ", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-nullable": false + }, + "certificateName": { + "type": "string", + "description": "Certificate name found in the appxmanifest.xml. ", + "x-nullable": true + }, + "certificateExpiry": { + "format": "date-time", + "type": "string", + "description": "Date certificate expires, found in the appxmanifest.xml. ", + "x-nullable": true + } + } + }, + "ExpandMsixImage": { + "type": "object", + "description": "Represents the definition of contents retrieved after expanding the MSIX Image. ", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for ExpandMsixImage", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpandMsixImageProperties" + } + } + }, + "ExpandMsixImageList": { + "type": "object", + "title": "ExpandMsixImageList", + "description": "List of MSIX package properties retrieved from MSIX Image expansion.", + "properties": { + "value": { + "type": "array", + "description": "List of MSIX package properties from give MSIX Image.", + "items": { + "$ref": "#/definitions/ExpandMsixImage" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "MSIXImageURI": { + "description": "Represents URI referring to MSIX Image", + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "URI to Image" + } + } + }, + "SessionHost": { + "type": "object", + "description": "Represents a SessionHost definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostProperties" + } + } + }, + "SessionHostProperties": { + "description": "Schema for SessionHost properties.", + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of SessionHost. (internal use)", + "readOnly": true + }, + "lastHeartBeat": { + "format": "date-time", + "type": "string", + "description": "Last heart beat from SessionHost." + }, + "sessions": { + "type": "integer", + "format": "int32", + "description": "Number of sessions on SessionHost." + }, + "agentVersion": { + "type": "string", + "description": "Version of agent on SessionHost." + }, + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "virtualMachineId": { + "type": "string", + "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "Resource Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of SessionHost" + }, + "status": { + "enum": [ + "Available", + "Unavailable", + "Shutdown", + "Disconnected", + "Upgrading", + "UpgradeFailed", + "NoHeartbeat", + "NotJoinedToDomain", + "DomainTrustRelationshipLost", + "SxSStackListenerNotReady", + "FSLogixNotHealthy", + "NeedsAssistance" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "value": "Available", + "description": "Session Host has passed all the health checks and is available to handle connections." + }, + { + "value": "Unavailable", + "description": "Session Host is either turned off or has failed critical health checks which is causing service not to be able to route connections to this session host. Note this replaces previous 'NoHeartBeat' status." + }, + { + "value": "Shutdown", + "description": "Session Host is shutdown - RD Agent reported session host to be stopped or deallocated." + }, + { + "value": "Disconnected", + "description": "The Session Host is unavailable because it is currently disconnected." + }, + { + "value": "Upgrading", + "description": "Session Host is unavailable because currently an upgrade of RDAgent/side-by-side stack is in progress. Note: this state will be removed once the upgrade completes and the host is able to accept connections." + }, + { + "value": "UpgradeFailed", + "description": "Session Host is unavailable because the critical component upgrade (agent, side-by-side stack, etc.) failed." + }, + { + "value": "NoHeartbeat", + "description": "The Session Host is not heart beating." + }, + { + "value": "NotJoinedToDomain", + "description": "SessionHost is not joined to domain." + }, + { + "value": "DomainTrustRelationshipLost", + "description": "SessionHost's domain trust relationship lost" + }, + { + "value": "SxSStackListenerNotReady", + "description": "SxS stack installed on the SessionHost is not ready to receive connections." + }, + { + "value": "FSLogixNotHealthy", + "description": "FSLogix is in an unhealthy state on the session host." + }, + { + "value": "NeedsAssistance", + "description": "New status to inform admins that the health on their endpoint needs to be fixed. The connections might not fail, as these issues are not fatal." + } + ] + }, + "type": "string", + "description": "Status for a SessionHost." + }, + "statusTimestamp": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the status.", + "readOnly": true + }, + "osVersion": { + "type": "string", + "description": "The version of the OS on the session host." + }, + "sxSStackVersion": { + "type": "string", + "description": "The version of the side by side stack on the session host." + }, + "updateState": { + "enum": [ + "Initial", + "Pending", + "Started", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "UpdateState", + "modelAsString": true + }, + "type": "string", + "description": "Update state of a SessionHost." + }, + "lastUpdateTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "updateErrorMessage": { + "type": "string", + "description": "The error message." + }, + "lastSessionHostUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The last time update was completed.", + "readOnly": true + }, + "sessionHostConfiguration": { + "type": "string", + "description": "SessionHostConfiguration version reference at the time the update is initiated, in the format of date time.", + "readOnly": true + }, + "sessionHostHealthCheckResults": { + "type": "array", + "readOnly": true, + "description": "List of SessionHostHealthCheckReports", + "items": { + "$ref": "#/definitions/SessionHostHealthCheckReport" + } + } + } + }, + "SessionHostHealthCheckReport": { + "type": "object", + "description": "The report for session host information.", + "properties": { + "healthCheckName": { + "enum": [ + "DomainJoinedCheck", + "DomainTrustCheck", + "FSLogixHealthCheck", + "SxSStackListenerCheck", + "UrlsAccessibleCheck", + "MonitoringAgentCheck", + "DomainReachable", + "WebRTCRedirectorCheck", + "SupportedEncryptionCheck", + "MetaDataServiceCheck", + "AppAttachHealthCheck" + ], + "x-ms-enum": { + "name": "HealthCheckName", + "modelAsString": true, + "values": [ + { + "value": "DomainJoinedCheck", + "description": "Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)" + }, + { + "value": "DomainTrustCheck", + "description": "Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)" + }, + { + "value": "FSLogixHealthCheck", + "description": "Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)" + }, + { + "value": "SxSStackListenerCheck", + "description": "Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)" + }, + { + "value": "UrlsAccessibleCheck", + "description": "Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled)" + }, + { + "value": "MonitoringAgentCheck", + "description": "Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)" + }, + { + "value": "DomainReachable", + "description": "Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)" + }, + { + "value": "WebRTCRedirectorCheck", + "description": "Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)" + }, + { + "value": "SupportedEncryptionCheck", + "description": "Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)" + }, + { + "value": "MetaDataServiceCheck", + "description": "Verifies the metadata service is accessible and return compute properties. (Currently Enabled)" + }, + { + "value": "AppAttachHealthCheck", + "description": "Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual deregistration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)" + } + ] + }, + "type": "string", + "description": "Represents the name of the health check operation performed.", + "readOnly": true + }, + "healthCheckResult": { + "enum": [ + "Unknown", + "HealthCheckSucceeded", + "HealthCheckFailed", + "SessionHostShutdown" + ], + "x-ms-enum": { + "name": "HealthCheckResult", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Health check result is not currently known." + }, + { + "value": "HealthCheckSucceeded", + "description": "Health check passed." + }, + { + "value": "HealthCheckFailed", + "description": "Health check failed." + }, + { + "value": "SessionHostShutdown", + "description": "We received a Shutdown notification." + } + ] + }, + "type": "string", + "description": "Represents the Health state of the health check we performed.", + "readOnly": true + }, + "additionalFailureDetails": { + "$ref": "#/definitions/SessionHostHealthCheckFailureDetails", + "description": "Additional detailed information on the failure.", + "readOnly": true + } + } + }, + "SessionHostHealthCheckFailureDetails": { + "type": "object", + "description": "Contains details on the failure.", + "properties": { + "message": { + "type": "string", + "description": "Failure message: hints on what is wrong and how to recover.", + "readOnly": true + }, + "errorCode": { + "type": "integer", + "format": "int32", + "description": "Error code corresponding for the failure.", + "readOnly": true + }, + "lastHealthCheckDateTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + } + } + }, + "SessionHostPatch": { + "type": "object", + "description": "SessionHost properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostPatchProperties" + } + } + }, + "SessionHostPatchProperties": { + "description": "SessionHost properties that can be patched.", + "type": "object", + "properties": { + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of SessionHost" + } + } + }, + "SessionHostList": { + "type": "object", + "title": "SessionHostList", + "description": "List of SessionHost definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHost definitions.", + "items": { + "$ref": "#/definitions/SessionHost" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "UserSession": { + "type": "object", + "description": "Represents a UserSession definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for UserSession", + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserSessionProperties" + } + } + }, + "UserSessionProperties": { + "description": "Schema for UserSession properties.", + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of user session. (internal use)", + "readOnly": true + }, + "userPrincipalName": { + "type": "string", + "description": "The user principal name." + }, + "applicationType": { + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "type": "string", + "description": "Application type of application." + }, + "sessionState": { + "enum": [ + "Unknown", + "Active", + "Disconnected", + "Pending", + "LogOff", + "UserProfileDiskMounted" + ], + "x-ms-enum": { + "name": "SessionState", + "modelAsString": true + }, + "type": "string", + "description": "State of user session." + }, + "activeDirectoryUserName": { + "type": "string", + "description": "The active directory user name." + }, + "createTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the user session create." + } + } + }, + "UserSessionList": { + "type": "object", + "title": "UserSessionList", + "description": "List of UserSession definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of UserSession definitions.", + "items": { + "$ref": "#/definitions/UserSession" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ScalingPlan": { + "type": "object", + "title": "ScalingPlan", + "description": "Represents a scaling plan definition.", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for scaling plan.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanProperties", + "x-nullable": false + } + } + }, + "ScalingPlanProperties": { + "type": "object", + "description": "Scaling plan properties.", + "required": [ + "timeZone" + ], + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of scaling plan. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of scaling plan." + }, + "friendlyName": { + "type": "string", + "description": "User friendly name of scaling plan." + }, + "timeZone": { + "type": "string", + "description": "Timezone of the scaling plan." + }, + "hostPoolType": { + "enum": [ + "Pooled" + ], + "x-ms-enum": { + "name": "ScalingHostPoolType", + "modelAsString": true, + "values": [ + { + "value": "Pooled", + "description": "Users get a new (random) SessionHost every time it connects to the HostPool." + } + ] + }, + "default": "Pooled", + "type": "string", + "description": "HostPool type for desktop.", + "x-nullable": false + }, + "exclusionTag": { + "type": "string", + "description": "Exclusion tag for scaling plan." + }, + "schedules": { + "type": "array", + "description": "List of ScalingPlanPooledSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingSchedule" + } + }, + "hostPoolReferences": { + "type": "array", + "description": "List of ScalingHostPoolReference definitions.", + "items": { + "$ref": "#/definitions/ScalingHostPoolReference" + } + } + } + }, + "ScalingSchedule": { + "description": "A ScalingPlanPooledSchedule.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the ScalingPlanPooledSchedule." + }, + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string" + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for ramp up period." + }, + "rampUpMinimumHostsPct": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Minimum host percentage for ramp up period." + }, + "rampUpCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "description": "Capacity threshold for ramp up period." + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for ramp down period." + }, + "rampDownMinimumHostsPct": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Minimum host percentage for ramp down period." + }, + "rampDownCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "description": "Capacity threshold for ramp down period." + }, + "rampDownForceLogoffUsers": { + "type": "boolean", + "description": "Should users be logged off forcefully from hosts." + }, + "rampDownStopHostsWhen": { + "enum": [ + "ZeroSessions", + "ZeroActiveSessions" + ], + "x-ms-enum": { + "name": "StopHostsWhen", + "modelAsString": true + }, + "type": "string", + "description": "Specifies when to stop hosts during ramp down period." + }, + "rampDownWaitTimeMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes to wait to stop hosts during ramp down period." + }, + "rampDownNotificationMessage": { + "type": "string", + "description": "Notification message for users during ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for off-peak period." + } + } + }, + "ScalingPlanPooledSchedulePatch": { + "type": "object", + "description": "ScalingPlanPooledSchedule properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for ScalingPlanPooledSchedule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPooledScheduleProperties" + } + } + }, + "ScalingPlanPooledScheduleList": { + "type": "object", + "title": "ScalingPlanPooledScheduleList", + "description": "List of ScalingPlanPooledSchedule definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ScalingPlanPooledSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ScalingPlanPooledSchedule": { + "type": "object", + "description": "Represents a ScalingPlanPooledSchedule definition.", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for ScalingPlanPooledSchedule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPooledScheduleProperties", + "x-nullable": false + } + } + }, + "ScalingPlanPooledScheduleProperties": { + "description": "A ScalingPlanPooledSchedule.", + "type": "object", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + } + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for ramp up period." + }, + "rampUpMinimumHostsPct": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Minimum host percentage for ramp up period." + }, + "rampUpCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "description": "Capacity threshold for ramp up period." + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for ramp down period." + }, + "rampDownMinimumHostsPct": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Minimum host percentage for ramp down period." + }, + "rampDownCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "description": "Capacity threshold for ramp down period." + }, + "rampDownForceLogoffUsers": { + "type": "boolean", + "description": "Should users be logged off forcefully from hosts." + }, + "rampDownStopHostsWhen": { + "enum": [ + "ZeroSessions", + "ZeroActiveSessions" + ], + "x-ms-enum": { + "name": "StopHostsWhen", + "modelAsString": true + }, + "type": "string", + "description": "Specifies when to stop hosts during ramp down period." + }, + "rampDownWaitTimeMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes to wait to stop hosts during ramp down period." + }, + "rampDownNotificationMessage": { + "type": "string", + "description": "Notification message for users during ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for off-peak period." + } + } + }, + "Time": { + "description": "The time for a scaling action to occur.", + "required": [ + "hour", + "minute" + ], + "type": "object", + "properties": { + "hour": { + "format": "int32", + "description": "The hour.", + "maximum": 23, + "minimum": 0, + "type": "integer" + }, + "minute": { + "format": "int32", + "description": "The minute.", + "maximum": 59, + "minimum": 0, + "type": "integer" + } + } + }, + "ScalingHostPoolReference": { + "description": "Scaling plan reference to hostpool.", + "type": "object", + "properties": { + "hostPoolArmPath": { + "type": "string", + "description": "Arm path of referenced hostpool." + }, + "scalingPlanEnabled": { + "type": "boolean", + "description": "Is the scaling plan enabled for this hostpool." + } + } + }, + "ScalingPlanList": { + "type": "object", + "title": "ScalingPlanList", + "description": "List of scaling plan definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of scaling plan definitions.", + "items": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ScalingPlanPatch": { + "type": "object", + "description": "Scaling plan properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for scaling plan", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPatchProperties" + } + } + }, + "ScalingPlanPatchProperties": { + "type": "object", + "description": "Scaling plan properties.", + "properties": { + "description": { + "type": "string", + "description": "Description of scaling plan." + }, + "friendlyName": { + "type": "string", + "description": "User friendly name of scaling plan." + }, + "timeZone": { + "type": "string", + "description": "Timezone of the scaling plan." + }, + "exclusionTag": { + "type": "string", + "description": "Exclusion tag for scaling plan." + }, + "schedules": { + "type": "array", + "description": "List of ScalingSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingSchedule" + } + }, + "hostPoolReferences": { + "type": "array", + "description": "List of ScalingHostPoolReference definitions.", + "items": { + "$ref": "#/definitions/ScalingHostPoolReference" + } + } + } + }, + "PrivateEndpointConnectionWithSystemData": { + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpointConnectionListResultWithSystemData": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + }, + "description": "List of private endpoint connection associated with the specified storage account" + }, + "ScalingPlanPersonalSchedulePatch": { + "type": "object", + "description": "ScalingPlanPersonalSchedule properties that can be patched.", + "properties": { + "properties": { + "description": "Detailed properties for ScalingPlanPersonalSchedule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPersonalScheduleProperties" + } + } + }, + "ScalingPlanPersonalScheduleList": { + "type": "object", + "title": "ScalingPlanPersonalScheduleList", + "description": "List of ScalingPlanPersonalSchedule definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ScalingPlanPersonalSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ScalingPlanPersonalSchedule": { + "type": "object", + "description": "Represents a ScalingPlanPersonalSchedule definition.", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for ScalingPlanPersonalSchedule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPersonalScheduleProperties", + "x-nullable": false + } + } + }, + "ScalingPlanPersonalScheduleProperties": { + "description": "A ScalingPlanPersonalSchedule.", + "type": "object", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + } + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpAutoStartHosts": { + "enum": [ + "None", + "WithAssignedUser", + "All" + ], + "x-ms-enum": { + "name": "StartupBehavior", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts." + }, + { + "value": "WithAssignedUser", + "description": "Session hosts with an assigned user will be started during Ramp Up" + }, + { + "value": "All", + "description": "All personal session hosts in the hostpool will be started during ramp up." + } + ] + }, + "type": "string", + "description": "The desired startup behavior during the ramp up period for personal vms in the hostpool." + }, + "rampUpStartVMOnConnect": { + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true + }, + "default": "Enable", + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually." + }, + "rampUpActionOnDisconnect": { + "enum": [ + "None", + "Deallocate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a user disconnect during the ramp up period." + }, + "rampUpMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period." + }, + "rampUpActionOnLogoff": { + "enum": [ + "None", + "Deallocate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a logoff during the ramp up period." + }, + "rampUpMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period." + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakStartVMOnConnect": { + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true + }, + "default": "Enable", + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the peak phase." + }, + "peakActionOnDisconnect": { + "enum": [ + "None", + "Deallocate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a user disconnect during the peak period." + }, + "peakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period." + }, + "peakActionOnLogoff": { + "enum": [ + "None", + "Deallocate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a logoff during the peak period." + }, + "peakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownStartVMOnConnect": { + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true + }, + "default": "Enable", + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp down phase." + }, + "rampDownActionOnDisconnect": { + "enum": [ + "None", + "Deallocate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a user disconnect during the ramp down period." + }, + "rampDownMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period." + }, + "rampDownActionOnLogoff": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a logoff during the ramp down period." + }, + "rampDownMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakStartVMOnConnect": { + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true + }, + "default": "Enable", + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the off-peak phase." + }, + "offPeakActionOnDisconnect": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a user disconnect during the off-peak period." + }, + "offPeakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period." + }, + "offPeakActionOnLogoff": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a logoff during the off-peak period." + }, + "offPeakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period." + } + } + } + }, + "parameters": { + "HostPoolNameParameter": { + "name": "hostPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the host pool within the specified resource group", + "maxLength": 64, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "MSIXPackageFullNameParameter": { + "name": "msixPackageFullName", + "in": "path", + "required": true, + "type": "string", + "description": "The version specific package full name of the MSIX package within specified hostpool", + "maxLength": 100, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "AppAttachPackageNameParameter": { + "name": "appAttachPackageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the App Attach package arm object", + "maxLength": 100, + "minLength": 3, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$", + "x-ms-parameter-location": "method" + }, + "ApplicationGroupNameParameter": { + "name": "applicationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application group", + "maxLength": 64, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application within the specified application group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "DesktopNameParameter": { + "name": "desktopName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the desktop within the specified desktop group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace", + "maxLength": 64, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "SessionHostNameParameter": { + "name": "sessionHostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the session host within the specified host pool", + "maxLength": 48, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "UserSessionIdParameter": { + "name": "userSessionId", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user session within the specified session host", + "maxLength": 24, + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "StartMenuItemNameParameter": { + "name": "startMenuItemName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the start menu item within the specified host pool", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "MSIXImageURIParameter": { + "name": "msixImageURI", + "in": "path", + "required": true, + "type": "string", + "description": "URI to the MSIX Image (VHD/CIM).", + "maxLength": 100, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ScalingPlanNameParameter": { + "name": "scalingPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the scaling plan.", + "maxLength": 64, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ScalingPlanScheduleNameParameter": { + "name": "scalingPlanScheduleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ScalingPlanSchedule", + "maxLength": 64, + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The Guid of the operation.", + "maxLength": 36, + "minLength": 36, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ActiveSessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ActiveSessionHostConfigurations_Get.json new file mode 100644 index 000000000000..194633ec6272 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ActiveSessionHostConfigurations_Get.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..0e0f1f150703 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackageInfo_Import_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackageInfo_Import_Post.json new file mode 100644 index 000000000000..9824ec81ae7a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackageInfo_Import_Post.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-01-16-preview", + "importPackageInfoRequest": { + "path": "imagepath", + "packageArchitecture": "x64" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Create.json new file mode 100644 index 000000000000..a7f8c9958f2d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Create.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-01-16-preview", + "appAttachPackageName": "msixpackagefullname", + "appAttachPackage": { + "location": "southcentralus", + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + }, + "201": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Delete.json new file mode 100644 index 000000000000..299413897b83 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Delete.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-01-16-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Get.json new file mode 100644 index 000000000000..a9910dcfc460 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-01-16-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_ListByResourceGroup.json new file mode 100644 index 000000000000..dc5c568380a2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_ListByResourceGroup.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-01-16-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_ListBySubscription.json new file mode 100644 index 000000000000..95d9175caec2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_ListBySubscription.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2024-01-16-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Update.json new file mode 100644 index 000000000000..7089b921fc98 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/AppAttachPackage_Update.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-01-16-preview", + "appAttachPackageName": "msixpackagefullname", + "appAttachPackage": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [ + "hostpool1", + "hostpool2" + ], + "keyVaultURL": "url", + "failHealthCheckOnStagingFailure": false + } + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Create.json new file mode 100644 index 000000000000..e4424052ac76 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Create.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-01-16-preview", + "applicationGroup": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "applicationGroupType": "RemoteApp", + "showInFeed": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + }, + "201": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Delete.json new file mode 100644 index 000000000000..847f40ebb484 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Delete.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Get.json new file mode 100644 index 000000000000..90611e5d4c39 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_ListByResourceGroup.json new file mode 100644 index 000000000000..bfc8edef8b5c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_ListByResourceGroup.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-01-16-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_ListBySubscription.json new file mode 100644 index 000000000000..d43a3877dbd9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_ListBySubscription.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2024-01-16-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Update.json new file mode 100644 index 000000000000..a64a03a3ac65 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ApplicationGroup_Update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-01-16-preview", + "applicationGroup": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "showInFeed": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Create.json new file mode 100644 index 000000000000..e76cd8585935 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Create.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2024-01-16-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "201": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Delete.json new file mode 100644 index 000000000000..31bad00e3e9a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Delete.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Get.json new file mode 100644 index 000000000000..6c0305becd74 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_List.json new file mode 100644 index 000000000000..607cf3e6dd25 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + { + "name": "applicationGroup1/application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des2", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Update.json new file mode 100644 index 000000000000..7299666909db --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Application_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2024-01-16-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Desktop_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Desktop_Get.json new file mode 100644 index 000000000000..68dfd06297ec --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Desktop_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Desktop_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Desktop_List.json new file mode 100644 index 000000000000..fbc151a9b0ec --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Desktop_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Desktop_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Desktop_Update.json new file mode 100644 index 000000000000..7f8d7db9bb3b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Desktop_Update.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2024-01-16-preview", + "desktop": { + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Create.json new file mode 100644 index 000000000000..6b1ce3adf559 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Create.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "hostPool": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + }, + "201": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Delete.json new file mode 100644 index 000000000000..ea4a2d07eeef --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Delete.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "force": true + }, + "responses": { + "200": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Get.json new file mode 100644 index 000000000000..f7d2dcf1cea9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Get.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default" + } + } + }, + "default": { + "body": { + "error": { + "code": "hostPoolDoesNotExist", + "message": "Host Pool Does Not Exist" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_List.json new file mode 100644 index 000000000000..0a18b531b5f1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_List.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_ListByResourceGroup.json new file mode 100644 index 000000000000..d626b371e8c1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_ListByResourceGroup.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Update.json new file mode 100644 index 000000000000..1dd657c674fa --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPool_Update.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "hostPool": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "personalDesktopAssignmentType": "Automatic", + "registrationInfo": { + "expirationTime": "2020-10-01T15:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPools_RetrieveRegistrationToken_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPools_RetrieveRegistrationToken_Post.json new file mode 100644 index 000000000000..02ec5276cdb6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/HostPools_RetrieveRegistrationToken_Post.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixImage_Expand_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixImage_Expand_Post.json new file mode 100644 index 000000000000..882d9d1befcd --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixImage_Expand_Post.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-01-16-preview", + "msixImageURI": { + "uri": "imagepath" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias2", + "imagePath": "imagepath", + "packageName": "MsixPackageName2", + "packageFamilyName": "MsixPackage_FamilyName2", + "packageFullName": "MsixPackage_FullName2", + "displayName": "displayname2", + "packageRelativePath": "packagerelativepath2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackageDependency1", + "publisher": "PublisherName1", + "minVersion": "ver1" + }, + { + "dependencyName": "MsixPackageDependency2", + "publisher": "PublisherName2", + "minVersion": "ver2" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId1", + "description": "PackageApplicationDescription1", + "appUserModelID": "AppUserModelId1", + "friendlyName": "FriendlyName1", + "iconImageName": "Iconimagename1", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + }, + { + "appId": "AppId2", + "description": "PackageApplicationDescription2", + "appUserModelID": "AppUserModelId2", + "friendlyName": "FriendlyName2", + "iconImageName": "Iconimagename2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Create.json new file mode 100644 index 000000000000..ced78d61beb2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Create.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-01-16-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "description": "application-desc", + "appId": "ApplicationId", + "appUserModelID": "AppUserModelId", + "friendlyName": "friendlyname", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixTest_Dependency_Name", + "minVersion": "version", + "publisher": "PublishedName" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageName": "MsixPackage_name", + "packageRelativePath": "packagerelativepath", + "version": "version" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + }, + "201": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Delete.json new file mode 100644 index 000000000000..932f4dfbfc16 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Delete.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-01-16-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Get.json new file mode 100644 index 000000000000..7c4a17069695 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-01-16-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_List.json new file mode 100644 index 000000000000..48e464f92331 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_List.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/MsixPackageFullName2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName2", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath2", + "packageName": "MsixPackage_Name2", + "packageFamilyName": "MsixPackage_FamilyName2", + "displayName": "dis2", + "packageRelativePath": "MsixPackage_RelativePackageRoot2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name2", + "publisher": "MsixPackage_Dependency_Publisher2", + "minVersion": "packageDep_version2" + } + ], + "version": "version2", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id2", + "description": "desc2", + "appUserModelID": "Application_ModelID2", + "friendlyName": "fri2", + "iconImageName": "Apptile2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Update.json new file mode 100644 index 000000000000..8220f1c330fb --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/MsixPackage_Update.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2024-01-16-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "isActive": true, + "isRegularRegistration": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/OperationDescription_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/OperationDescription_List.json new file mode 100644 index 000000000000..b65cc34dcef6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/OperationDescription_List.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DesktopVirtualization/hostpools/read", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "hostpools", + "operation": "Read hostpool", + "description": "Read hostpool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.DesktopVirtualization/hostpools/write", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "hostpools", + "operation": "Write hostpool", + "description": "Write hostpool" + }, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "", + "displayName": "" + }, + { + "name": "", + "displayName": "" + }, + { + "name": "", + "displayName": "" + } + ] + } + }, + "isDataAction": false + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json new file mode 100644 index 000000000000..525ab3d569dd --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json new file mode 100644 index 000000000000..fde737b47503 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_GetByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_GetByHostPool.json new file mode 100644 index 000000000000..18aa5bb73896 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_GetByHostPool.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_GetByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_GetByWorkspace.json new file mode 100644 index 000000000000..80e5bb5fb9a9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_GetByWorkspace.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_ListByHostPool.json new file mode 100644 index 000000000000..3d044959cb22 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_ListByHostPool.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_ListByWorkspace.json new file mode 100644 index 000000000000..d0b10d7bb99c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_ListByWorkspace.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json new file mode 100644 index 000000000000..5696ce2b069f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2024-01-16-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json new file mode 100644 index 000000000000..8126d370ee2c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2024-01-16-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateLinkResources_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateLinkResources_ListByHostPool.json new file mode 100644 index 000000000000..5ba9728890b8 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateLinkResources_ListByHostPool.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateLinkResources/hostpool", + "type": "Microsoft.DesktopVirtualization/hostpools/privateLinkResources", + "properties": { + "groupId": "hostpool", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateLinkResources_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateLinkResources_ListByWorkspace.json new file mode 100644 index 000000000000..3e48b3217b5c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/PrivateLinkResources_ListByWorkspace.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateLinkResources/workspace", + "type": "Microsoft.DesktopVirtualization/workspaces/privateLinkResources", + "properties": { + "groupId": "workspace", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Create.json new file mode 100644 index 000000000000..8fd75255526f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Create.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-01-16-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Delete.json new file mode 100644 index 000000000000..c13eb2858807 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Get.json new file mode 100644 index 000000000000..252f880e7947 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Get.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "PersonalScalingPlan1", + "scalingPlanScheduleName": "PersonalScalingPlanSchedule", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "PersonalScalingPlanSchedule", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/PersonalScalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_List.json new file mode 100644 index 000000000000..6443dfa6345d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_List.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekday", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + }, + { + "name": "scalingPlanScheduleWeekend", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 10, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 14, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "Deallocate", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 16, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "Deallocate", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Update.json new file mode 100644 index 000000000000..ec12466e875c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPersonalSchedule_Update.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-01-16-preview", + "scalingPlanSchedule": { + "properties": { + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Create.json new file mode 100644 index 000000000000..fb64b608f4ea --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Create.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-01-16-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Delete.json new file mode 100644 index 000000000000..c13eb2858807 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Get.json new file mode 100644 index 000000000000..520737996fc4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_List.json new file mode 100644 index 000000000000..f7605542b434 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_List.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + }, + { + "name": "scalingPlanScheduleWeekends1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 10, + "rampUpCapacityThresholdPct": 90, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 0, + "rampDownCapacityThresholdPct": 100, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Update.json new file mode 100644 index 000000000000..06d8ff5622b5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlanPooledSchedule_Update.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2024-01-16-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownWaitTimeMinutes": 30 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Create.json new file mode 100644 index 000000000000..b3326c1b3634 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Create.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2024-01-16-preview", + "scalingPlan": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "201": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Delete.json new file mode 100644 index 000000000000..a494107095b2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Delete.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Get.json new file mode 100644 index 000000000000..09ba8d48c7e0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Get.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of scaling plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_ListByHostPool.json new file mode 100644 index 000000000000..05dc40fb9994 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_ListByHostPool.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_ListByResourceGroup.json new file mode 100644 index 000000000000..72408a723578 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_ListByResourceGroup.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_ListBySubscription.json new file mode 100644 index 000000000000..de8dc34b9420 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_ListBySubscription.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroActiveSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Update.json new file mode 100644 index 000000000000..a77ec74cb745 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/ScalingPlan_Update.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2024-01-16-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurationsOperationStatus_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurationsOperationStatus_Get.json new file mode 100644 index 000000000000..2974da4b811e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurationsOperationStatus_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "operationId": "55582798-3f6e-4cda-9371-8723b27bd664" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationresults/30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "operations": [], + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurationsOperationStatus_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurationsOperationStatus_List.json new file mode 100644 index 000000000000..a13532ace680 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurationsOperationStatus_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "isLatest": true, + "isNonTerminal": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationresults/30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "operations": [], + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_Create.json new file mode 100644 index 000000000000..8e07a6808091 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_Create.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_Get.json new file mode 100644 index 000000000000..db16dc4178f4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_Get.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..64e6d57d2ce3 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_Update.json new file mode 100644 index 000000000000..1a18334c68b7 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostConfigurations_Update.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "Second Version, Updated Location", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + } + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagementsOperationStatus_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagementsOperationStatus_Get.json new file mode 100644 index 000000000000..4afa6595e1e0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagementsOperationStatus_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "operationId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/12345678-1234-1234-1234-123456789012", + "name": "12345678-1234-1234-1234-123456789012", + "status": "Failed", + "startTime": "2020-07-10T15:00:00.000Z", + "endTime": "2020-07-11T15:00:00.000Z", + "percentComplete": 0.0, + "operations": [], + "error": { + "code": "ProvisioningError", + "message": "Provision 200 session hosts. \nTime Stamp: '2008-09-22T14:01:54.9571247Z' \nRequests: 120, 80. \nCanary Succeeded. \n120 successful. \n80 failed. \nSession Host Configuration Version '2008-09-22T14:01:54.9571247Z'. \n'Error code 'AADJoinFailed'. Message: User name or password is incorrect. Session Hosts: 'brman-abc1.mycompany.azure.com, brman- abc3.mycompany.azure.com, brman-abc4.mycompany.azure.com ...' \nError code 'RDAgentInstallationFailed'. Message: Failed to download RDAgent installer. Session Hosts: 'brman-abc6.mycompany.azure.com, brman-abc7.mycompany.azure.com, brman-abc8.mycompany.azure.com ...'" + }, + "properties": { + "correlationId": "2fa5c06c-2771-448b-a71e-e1124f44907f", + "type": "InitiateSessionHostUpdate | ValidateSessionHostUpdate", + "action": "Start | Retry | Pause | Resume | Cancel", + "progress": { + "executionStartTime": "2020-10-01T14:01:54.9571247Z", + "totalSessionHosts": 1, + "sessionHostsInProgress": 1, + "sessionHostsCompleted": 1, + "sessionHostsRollbackFailed": 1 + }, + "scheduledDateTime": "2020-10-01T14:01:54.9571247Z", + "sessionHostManagement": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "Logging off for host pool update" + } + } + }, + "parentId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/0000000-1234-1234-1234-000000000" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagementsOperationStatus_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagementsOperationStatus_List.json new file mode 100644 index 000000000000..27456efe3b05 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagementsOperationStatus_List.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "isLatest": false, + "type": "InitiateSessionHostUpdate", + "isNonTerminal": true, + "correlationId": "2fa5c06c-2771-448b-a71e-e1124f44907f", + "action": "", + "isInitiatingOperation": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/12345678-1234-1234-1234-123456789012", + "name": "12345678-1234-1234-1234-123456789012", + "status": "Failed", + "startTime": "2020-07-10T15:00:00.000Z", + "endTime": "2020-07-11T15:00:00.000Z", + "percentComplete": 0.0, + "operations": [], + "error": { + "code": "ProvisioningError", + "message": "Provision 200 session hosts. \nTime Stamp: '2008-09-22T14:01:54.9571247Z' \nRequests: 120, 80. \nCanary Succeeded. \n120 successful. \n80 failed. \nSession Host Configuration Version '2008-09-22T14:01:54.9571247Z'. \n'Error code 'AADJoinFailed'. Message: User name or password is incorrect. Session Hosts: 'brman-abc1.mycompany.azure.com, brman- abc3.mycompany.azure.com, brman-abc4.mycompany.azure.com ...' \nError code 'RDAgentInstallationFailed'. Message: Failed to download RDAgent installer. Session Hosts: 'brman-abc6.mycompany.azure.com, brman-abc7.mycompany.azure.com, brman-abc8.mycompany.azure.com ...'" + }, + "properties": { + "correlationId": "2fa5c06c-2771-448b-a71e-e1124f44907f", + "type": "InitiateSessionHostUpdate | ValidateSessionHostUpdate", + "action": "Start | Retry | Pause | Resume | Cancel", + "progress": { + "executionStartTime": "2020-10-01T14:01:54.9571247Z", + "totalSessionHosts": 1, + "sessionHostsInProgress": 1, + "sessionHostsCompleted": 1, + "sessionHostsRollbackFailed": 1 + }, + "scheduledDateTime": "2020-10-01T14:01:54.9571247Z", + "sessionHostManagement": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "Logging off for host pool update" + } + } + }, + "parentId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/0000000-1234-1234-1234-000000000" + } + }, + { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/2fa5c06c-2771-448b-a71e-e1124f44907f", + "name": "2fa5c06c-2771-448b-a71e-e1124f44907f", + "status": "Failed", + "startTime": "2020-07-10T15:00:00.000Z", + "endTime": "2020-07-11T15:00:00.000Z", + "percentComplete": 0.0, + "operations": [], + "error": { + "code": "ProvisioningError", + "message": "Provision 200 session hosts. \nTime Stamp: '2008-09-22T14:01:54.9571247Z' \nRequests: 120, 80. \nCanary Succeeded. \n120 successful. \n80 failed. \nSession Host Configuration Version '2008-09-22T14:01:54.9571247Z'. \n'Error code 'AADJoinFailed'. Message: User name or password is incorrect. Session Hosts: 'brman-abc1.mycompany.azure.com, brman- abc3.mycompany.azure.com, brman-abc4.mycompany.azure.com ...' \nError code 'RDAgentInstallationFailed'. Message: Failed to download RDAgent installer. Session Hosts: 'brman-abc6.mycompany.azure.com, brman-abc7.mycompany.azure.com, brman-abc8.mycompany.azure.com ...'" + }, + "properties": { + "correlationId": "2fa5c06c-2771-448b-a71e-e1124f44907f", + "type": "InitiateSessionHostUpdate | ValidateSessionHostUpdate", + "action": "Start | Retry | Pause | Resume | Cancel", + "progress": { + "executionStartTime": "2020-10-01T14:01:54.9571247Z", + "totalSessionHosts": 1, + "sessionHostsInProgress": 1, + "sessionHostsCompleted": 1, + "sessionHostsRollbackFailed": 1 + }, + "scheduledDateTime": "2020-10-01T14:01:54.9571247Z", + "sessionHostManagement": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "Logging off for host pool update" + } + } + }, + "parentId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/0000000-1234-1234-1234-000000000" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json new file mode 100644 index 000000000000..ad4f3d8cc545 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "hostPoolControlParameter": { + "action": "Start", + "cancelMessage": "Host pool update started" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_Create.json new file mode 100644 index 000000000000..f7cd965338f9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_Create.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_Get.json new file mode 100644 index 000000000000..b3d83214407c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_ListByHostPool.json new file mode 100644 index 000000000000..e31d01d02ae5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_ListByHostPool.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_Update.json new file mode 100644 index 000000000000..8ac8fde3e0db --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_Update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json new file mode 100644 index 000000000000..061ad0ea61d5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "updateSessionHostsRequestBody": { + "scheduledDateTime": "2008-09-22T14:01:54.9571247Z", + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_Delete.json new file mode 100644 index 000000000000..41c90613d3a2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_Delete.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2024-01-16-preview", + "force": true + }, + "responses": { + "200": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_Get.json new file mode 100644 index 000000000000..94c997f8eddb --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_List.json new file mode 100644 index 000000000000..a5d6b5aa2cd8 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_List.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + { + "name": "sessionHost2.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user2@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_RetryProvisioning_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_RetryProvisioning_Post.json new file mode 100644 index 000000000000..63b8cfe027ac --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_RetryProvisioning_Post.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_Update.json new file mode 100644 index 000000000000..f97b49ed8fbe --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/SessionHost_Update.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2024-01-16-preview", + "force": true, + "sessionHost": { + "properties": { + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2019-01-24T20:00:08.2893033Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/StartMenuItem_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/StartMenuItem_List.json new file mode 100644 index 000000000000..4b6032a5c3df --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/StartMenuItem_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "word", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + }, + { + "name": "application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "excel", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_Delete.json new file mode 100644 index 000000000000..4f70eae243c6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_Delete.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2024-01-16-preview", + "force": true + }, + "responses": { + "200": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_Disconnect_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_Disconnect_Post.json new file mode 100644 index 000000000000..50e9aefd9d44 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_Disconnect_Post.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_Get.json new file mode 100644 index 000000000000..449167a9f36a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_List.json new file mode 100644 index 000000000000..05ed33fbff79 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_List.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_ListByHostPool.json new file mode 100644 index 000000000000..0ae0f5ed8036 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_ListByHostPool.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2024-01-16-preview", + "$filter": "userPrincipalName eq 'user1@microsoft.com' and state eq 'active'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_SendMessage_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_SendMessage_Post.json new file mode 100644 index 000000000000..57a7774928ef --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/UserSession_SendMessage_Post.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2024-01-16-preview", + "sendMessage": { + "messageTitle": "title", + "messageBody": "body" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Create.json new file mode 100644 index 000000000000..209f34474e16 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Create.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2024-01-16-preview", + "workspace": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + }, + "201": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Delete.json new file mode 100644 index 000000000000..bc35b74998a6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Delete.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Get.json new file mode 100644 index 000000000000..4585a47cd8b3 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2024-01-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_ListByResourceGroup.json new file mode 100644 index 000000000000..c43906e1e826 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_ListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_ListBySubscription.json new file mode 100644 index 000000000000..2b8dc2d3a9e0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_ListBySubscription.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2024-01-16-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Update.json new file mode 100644 index 000000000000..592e6f3419a3 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-01-16-preview/examples/Workspace_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2024-01-16-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/readme.md b/specification/desktopvirtualization/resource-manager/readme.md index a45e559605e9..d68a561014e3 100644 --- a/specification/desktopvirtualization/resource-manager/readme.md +++ b/specification/desktopvirtualization/resource-manager/readme.md @@ -26,15 +26,27 @@ These are the global settings for the DesktopVirtualizationClient API. ``` yaml openapi-type: arm -tag: package-preview-2023-11 +tag: package-preview-2024-01 ``` +### Tag: package-preview-2024-01 + +These settings apply only when `--tag=package-preview-2024-01` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-01' +input-file: + - Microsoft.DesktopVirtualization/preview/2024-01-16-preview/desktopvirtualization.json +suppressions: + - code: ResourceNameRestriction + from: desktopvirtualization.json + reason: Pattern restriction will be a breaking change. Update for next stable version. Work item to fix https://microsoft.visualstudio.com/OS/_workitems/edit/47527278 +``` ### Tag: package-preview-2023-11 These settings apply only when `--tag=package-preview-2023-11` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-11' +``` yaml $(tag) == 'package-preview-2023-11' input-file: - Microsoft.DesktopVirtualization/preview/2023-11-01-preview/desktopvirtualization.json suppressions: @@ -42,6 +54,7 @@ suppressions: from: desktopvirtualization.json reason: Pattern restriction will be a breaking change. Update for next stable version. Work item to fix https://microsoft.visualstudio.com/OS/_workitems/edit/47527278 ``` + ### Tag: package-preview-2023-10 These settings apply only when `--tag=package-preview-2023-10` is specified on the command line. diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/devbox.json new file mode 100644 index 000000000000..5834591c4e1d --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/devbox.json @@ -0,0 +1,2370 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-01", + "title": "DevCenter", + "description": "DevBox API." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "devcenter.json#/parameters/EndpointParameter" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "AADToken": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "AADToken": { + "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": { + "/projects/{projectName}/pools": { + "get": { + "tags": [ + "Pools" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + } + ], + "description": "Lists available pools", + "operationId": "DevBoxes_ListPools", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_ListPools": { + "$ref": "./examples/Pools_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Pool" + } + }, + "/projects/{projectName}/pools/{poolName}": { + "get": { + "tags": [ + "Pools" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + } + ], + "description": "Gets a pool", + "operationId": "DevBoxes_GetPool", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_GetPool": { + "$ref": "./examples/Pools_Get.json" + } + } + } + }, + "/projects/{projectName}/schedules": { + "get": { + "tags": [ + "Schedules" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + } + ], + "description": "Lists all schedules within a project that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByProject", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_ListSchedulesByProject": { + "$ref": "./examples/Schedules_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Schedule" + } + }, + "/projects/{projectName}/pools/{poolName}/schedules": { + "get": { + "tags": [ + "Schedules" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + } + ], + "description": "Lists all schedules within a pool that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByPool", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_ListSchedulesByPool": { + "$ref": "./examples/Schedules_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Schedule" + } + }, + "/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}": { + "get": { + "tags": [ + "Schedules" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ScheduleNameParameter" + } + ], + "description": "Gets a schedule.", + "operationId": "DevBoxes_GetScheduleByPool", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_GetScheduleByPool": { + "$ref": "./examples/Schedules_Get.json" + } + } + } + }, + "/devboxes": { + "get": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + } + ], + "description": "Lists Dev Boxes that the caller has access to in the DevCenter.", + "operationId": "DevCenter_ListAllDevBoxes", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevCenter_ListAllDevBoxes": { + "$ref": "./examples/DevBoxes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DevBox" + } + }, + "/users/{userId}/devboxes": { + "get": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + } + ], + "description": "Lists Dev Boxes in the Dev Center for a particular user.", + "operationId": "DevCenter_ListAllDevBoxesByUser", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevCenter_ListAllDevBoxesByUser": { + "$ref": "./examples/DevBoxes_ListByUserByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DevBox" + } + }, + "/projects/{projectName}/users/{userId}/devboxes": { + "get": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + } + ], + "description": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListDevBoxesByUser", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_ListDevBoxesByUser": { + "$ref": "./examples/DevBoxes_ListByUserByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DevBox" + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}": { + "get": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Gets a Dev Box", + "operationId": "DevBoxes_GetDevBoxByUser", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBox" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_GetDevBoxByUser": { + "$ref": "./examples/DevBoxes_Get.json" + } + } + }, + "put": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a environment.", + "required": true, + "schema": { + "$ref": "#/definitions/DevBox" + } + } + ], + "description": "Creates or replaces a Dev Box.", + "operationId": "DevBoxes_CreateDevBox", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBox" + } + }, + "201": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBox" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_CreateDevBox": { + "$ref": "./examples/DevBoxes_Create.json" + } + } + }, + "delete": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Deletes a Dev Box.", + "operationId": "DevBoxes_DeleteDevBox", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location" + }, + "responses": { + "202": { + "description": "The request was accepted.", + "schema": { + "$ref": "devcenter.json#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_DeleteDevBox": { + "$ref": "./examples/DevBoxes_Delete.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:start": { + "post": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Starts a Dev Box", + "operationId": "DevBoxes_StartDevBox", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location" + }, + "responses": { + "202": { + "description": "The request was accepted.", + "schema": { + "$ref": "devcenter.json#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_StartDevBox": { + "$ref": "./examples/DevBoxes_Start.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:stop": { + "post": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/HibernateParameter" + } + ], + "description": "Stops a Dev Box", + "operationId": "DevBoxes_StopDevBox", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location" + }, + "responses": { + "202": { + "description": "The request was accepted.", + "schema": { + "$ref": "devcenter.json#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_StopDevBox": { + "$ref": "./examples/DevBoxes_Stop.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restart": { + "post": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Restarts a Dev Box", + "operationId": "DevBoxes_RestartDevBox", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location" + }, + "responses": { + "202": { + "description": "The request was accepted.", + "schema": { + "$ref": "devcenter.json#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_StartDevBox": { + "$ref": "./examples/DevBoxes_Restart.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:repair": { + "post": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.", + "operationId": "DevBoxes_RepairDevBox", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location" + }, + "responses": { + "202": { + "description": "The request was accepted.", + "schema": { + "$ref": "devcenter.json#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_RepairDevBox": { + "$ref": "./examples/DevBoxes_Repair.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/remoteConnection": { + "get": { + "tags": [ + "Dev Boxes" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Gets RDP Connection info", + "operationId": "DevBoxes_GetRemoteConnection", + "responses": { + "200": { + "description": "The request completed successfully.", + "schema": { + "$ref": "#/definitions/RemoteConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_GetRemoteConnection": { + "$ref": "./examples/DevBoxes_GetRemoteConnection.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions": { + "get": { + "tags": [ + "DevBoxActions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "description": "Lists actions on a Dev Box.", + "operationId": "DevBoxes_ListActions", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxActionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_ListActions": { + "$ref": "./examples/DevBoxActions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DevBoxAction" + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}": { + "get": { + "tags": [ + "DevBoxActions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/DevBoxActionNameParameter" + } + ], + "description": "Gets an action.", + "operationId": "DevBoxes_GetAction", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_GetAction": { + "$ref": "./examples/DevBoxActions_Get.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:skip": { + "post": { + "tags": [ + "DevBoxActions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/DevBoxActionNameParameter" + } + ], + "description": "Skips an occurrence of an action.", + "operationId": "DevBoxes_SkipAction", + "responses": { + "204": { + "description": "No content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_SkipAction": { + "$ref": "./examples/DevBoxActions_Skip.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:delay": { + "post": { + "tags": [ + "DevBoxActions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/DevBoxActionNameParameter" + }, + { + "$ref": "#/parameters/DevBoxActionDelayUntilParameter" + } + ], + "description": "Delays the occurrence of an action.", + "operationId": "DevBoxes_DelayAction", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_DelayAction": { + "$ref": "./examples/DevBoxActions_Delay.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions:delay": { + "post": { + "tags": [ + "DevBoxActions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/DevBoxActionDelayUntilParameter" + } + ], + "description": "Delays all actions.", + "operationId": "DevBoxes_DelayActions", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DevBoxActionsDelayMultipleResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxes_DelayActions": { + "$ref": "./examples/DevBoxActions_DelayMultiple.json" + }, + "DevBoxes_DelayActionsWithError": { + "$ref": "./examples/DevBoxActions_DelayMultipleWithError.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DevBoxActionDelayResult" + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations": { + "get": { + "tags": [ + "DevBoxOperations" + ], + "description": "Lists operations on the Dev Box which have occurred within the past 90 days.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "operationId": "DevBoxes_ListOperations", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxOperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxOperations_List": { + "$ref": "./examples/DevBoxOperations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DevBoxOperation" + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations/{operationId}": { + "get": { + "tags": [ + "DevBoxOperations" + ], + "description": "Gets an operation on a Dev Box.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "$ref": "#/parameters/DevBoxOperationIdParameter" + } + ], + "operationId": "DevBoxes_GetOperation", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "DevBoxOperations_Get": { + "$ref": "./examples/DevBoxOperations_Get.json" + } + } + } + } + }, + "definitions": { + "PoolListResult": { + "type": "object", + "description": "The Pool list result", + "properties": { + "value": { + "description": "Current page of results", + "type": "array", + "items": { + "$ref": "#/definitions/Pool" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "Pool": { + "type": "object", + "description": "A pool of Dev Boxes.", + "properties": { + "uri": { + "description": "The unique URI of the pool", + "type": "string" + }, + "name": { + "type": "string", + "description": "Pool name" + }, + "location": { + "description": "Azure region where Dev Boxes in the pool are located", + "type": "string" + }, + "osType": { + "description": "The operating system type of Dev Boxes in this pool", + "$ref": "#/definitions/OsType" + }, + "hardwareProfile": { + "description": "Hardware settings for the Dev Boxes created in this pool", + "$ref": "#/definitions/HardwareProfile" + }, + "hibernateSupport": { + "description": "Indicates whether hibernate is enabled/disabled or unknown.", + "$ref": "#/definitions/HibernateSupport" + }, + "storageProfile": { + "description": "Storage settings for Dev Box created in this pool", + "$ref": "#/definitions/StorageProfile" + }, + "imageReference": { + "description": "Image settings for Dev Boxes create in this pool", + "$ref": "#/definitions/ImageReference" + }, + "localAdministrator": { + "description": "Indicates whether owners of Dev Boxes in this pool are local administrators on the Dev Boxes.", + "$ref": "#/definitions/LocalAdminStatus" + }, + "stopOnDisconnect": { + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "$ref": "#/definitions/StopOnDisconnectConfiguration" + }, + "healthStatus": { + "description": "Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.", + "$ref": "#/definitions/PoolHealthStatus" + }, + "displayName": { + "type": "string", + "description": "Display name of the pool." + } + }, + "required": [ + "uri", + "name", + "location", + "healthStatus" + ] + }, + "PoolHealthStatus": { + "description": "Pool status indicating whether a pool is available to create Dev Boxes.", + "enum": [ + "Unknown", + "Pending", + "Healthy", + "Warning", + "Unhealthy" + ], + "type": "string", + "x-ms-enum": { + "name": "PoolHealthStatus", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "The pool health status is not known." + }, + { + "value": "Pending", + "description": "The pool health status waiting for health checks to run." + }, + { + "value": "Healthy", + "description": "The pool health status is healthy." + }, + { + "value": "Warning", + "description": "The pool health status has one or more warnings." + }, + { + "value": "Unhealthy", + "description": "The pool health status is not healthy." + } + ] + } + }, + "HibernateSupport": { + "description": "Indicates whether hibernate is supported and enabled, disabled, or unsupported by the operating system. Unknown hibernate support is represented as null.", + "enum": [ + "Enabled", + "Disabled", + "OsUnsupported" + ], + "type": "string", + "x-ms-enum": { + "name": "HibernateSupport", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Hibernate is enabled." + }, + { + "value": "Disabled", + "description": "Hibernate is not enabled." + }, + { + "value": "OsUnsupported", + "description": "Hibernate is not supported by the operating system." + } + ] + } + }, + "LocalAdminStatus": { + "description": "Indicates whether owners of Dev Boxes in a pool are local administrators on the Dev Boxes.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "LocalAdminStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Owners of Dev Boxes in the pool are local administrators on the Dev Boxes." + }, + { + "value": "Disabled", + "description": "Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes." + } + ] + } + }, + "StopOnDisconnectEnableStatus": { + "description": "Indicates whether the feature to stop the devbox on disconnect once the grace period has lapsed is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "StopOnDisconnectEnableStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Stop on disconnect is enabled on the Dev Box." + }, + { + "value": "Disabled", + "description": "Stop on disconnect is not enabled on the Dev Box." + } + ] + } + }, + "ScheduleListResult": { + "type": "object", + "description": "The Schedule list result", + "properties": { + "value": { + "description": "Current page of results", + "type": "array", + "items": { + "$ref": "#/definitions/Schedule" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "Schedule": { + "type": "object", + "description": "A Schedule to execute action.", + "properties": { + "uri": { + "description": "The unique URI of the schedule", + "type": "string" + }, + "name": { + "description": "Display name for the Schedule", + "type": "string" + }, + "sourceUri": { + "description": "The URI of the resource that this schedule belongs to", + "type": "string" + }, + "sourceType": { + "description": "The type of the resource that this schedule belongs to", + "$ref": "#/definitions/ScheduleSourceType" + }, + "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" + } + }, + "required": [ + "uri", + "name", + "sourceUri", + "sourceType", + "type", + "frequency", + "time", + "timeZone" + ] + }, + "ScheduledType": { + "description": "The supported types for a scheduled task.", + "enum": [ + "StopDevBox" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledType", + "modelAsString": true, + "values": [ + { + "value": "StopDevBox", + "description": "The scheduled task will stop impacted Dev Boxes." + } + ] + } + }, + "ScheduledFrequency": { + "description": "The frequency of task execution.", + "enum": [ + "Daily" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledFrequency", + "modelAsString": true, + "values": [ + { + "value": "Daily", + "description": "The scheduled task will run every day." + } + ] + } + }, + "DevBoxListResult": { + "type": "object", + "description": "The Dev Box list result", + "properties": { + "value": { + "description": "The list of DevBox Dev Boxes", + "type": "array", + "items": { + "$ref": "#/definitions/DevBox" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "DevBox": { + "type": "object", + "description": "A Dev Box", + "properties": { + "uri": { + "description": "The unique URI of the dev box", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Display name for the Dev Box", + "type": "string", + "readOnly": true + }, + "projectName": { + "description": "Name of the project this Dev Box belongs to", + "type": "string", + "readOnly": true + }, + "poolName": { + "description": "The name of the Dev Box pool this machine belongs to.", + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hibernateSupport": { + "description": "Indicates whether hibernate is enabled/disabled or unknown.", + "$ref": "#/definitions/HibernateSupport", + "readOnly": true + }, + "provisioningState": { + "description": "The current provisioning state of the Dev Box.", + "type": "string", + "readOnly": true + }, + "actionState": { + "description": "The current action state of the Dev Box. This is state is based on previous action performed by user.", + "type": "string", + "readOnly": true + }, + "powerState": { + "description": "The current power state of the Dev Box.", + "$ref": "#/definitions/PowerState", + "readOnly": true + }, + "uniqueId": { + "description": "A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "type": "string", + "readOnly": true + }, + "error": { + "description": "Provisioning or action error details. Populated only for error states.", + "readOnly": true, + "$ref": "devcenter.json#/definitions/CloudErrorBody" + }, + "location": { + "description": "Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The operating system type of this Dev Box.", + "$ref": "#/definitions/OsType", + "readOnly": true + }, + "user": { + "type": "string", + "description": "The AAD object id of the user this Dev Box is assigned to.", + "readOnly": true + }, + "hardwareProfile": { + "description": "Information about the Dev Box's hardware resources", + "$ref": "#/definitions/HardwareProfile", + "readOnly": true + }, + "storageProfile": { + "description": "Storage settings for this Dev Box", + "$ref": "#/definitions/StorageProfile", + "readOnly": true + }, + "imageReference": { + "description": "Information about the image used for this Dev Box", + "$ref": "#/definitions/ImageReference", + "readOnly": true + }, + "createdTime": { + "description": "Creation time of this Dev Box", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "localAdministrator": { + "description": "Indicates whether the owner of the Dev Box is a local administrator.", + "$ref": "#/definitions/LocalAdminStatus" + } + }, + "required": [ + "poolName" + ] + }, + "OsType": { + "type": "string", + "enum": [ + "Windows" + ], + "description": "The operating system type.", + "x-ms-enum": { + "name": "OsType", + "modelAsString": true, + "values": [ + { + "value": "Windows", + "description": "The Windows operating system." + } + ] + } + }, + "HardwareProfile": { + "description": "Hardware specifications for the Dev Box.", + "type": "object", + "properties": { + "skuName": { + "description": "The name of the SKU", + "type": "string", + "readOnly": true + }, + "vCPUs": { + "description": "The number of vCPUs available for the Dev Box.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "memoryGB": { + "description": "The amount of memory available for the Dev Box.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "StorageProfile": { + "type": "object", + "description": "Storage settings for the Dev Box's disks", + "properties": { + "osDisk": { + "$ref": "#/definitions/OSDisk" + } + } + }, + "OSDisk": { + "type": "object", + "description": "Settings for the operating system disk.", + "properties": { + "diskSizeGB": { + "description": "The size of the OS Disk in gigabytes.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "ImageReference": { + "description": "Specifies information about the image used", + "type": "object", + "properties": { + "name": { + "description": "The name of the image used.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version of the image.", + "type": "string", + "readOnly": true + }, + "operatingSystem": { + "description": "The operating system of the image.", + "type": "string", + "readOnly": true + }, + "osBuildNumber": { + "description": "The operating system build number of the image.", + "type": "string", + "readOnly": true + }, + "publishedDate": { + "description": "The datetime that the backing image version was published.", + "type": "string", + "readOnly": true, + "format": "date-time" + } + } + }, + "RemoteConnection": { + "description": "Provides remote connection information for a Dev Box.", + "type": "object", + "properties": { + "webUrl": { + "description": "URL to open a browser based RDP session.", + "type": "string" + }, + "rdpConnectionUrl": { + "description": "Link to open a Remote Desktop session.", + "type": "string" + } + } + }, + "PowerState": { + "type": "string", + "enum": [ + "Unknown", + "Running", + "Deallocated", + "PoweredOff", + "Hibernated" + ], + "description": "The power states of a Dev Box.", + "x-ms-enum": { + "name": "PowerState", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "The Dev Box power state is not known." + }, + { + "value": "Running", + "description": "The Dev Box is running." + }, + { + "value": "Deallocated", + "description": "The Dev Box is deallocated." + }, + { + "value": "PoweredOff", + "description": "The Dev Box is powered off." + }, + { + "value": "Hibernated", + "description": "The Dev Box is hibernated." + } + ] + } + }, + "StopOnDisconnectConfiguration": { + "type": "object", + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "description": "Indicates whether the feature to stop the devbox 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" + } + }, + "required": [ + "status" + ] + }, + "DevBoxActionsDelayMultipleResult": { + "type": "object", + "description": "The actions list result", + "properties": { + "value": { + "description": "Current page of results", + "type": "array", + "items": { + "$ref": "#/definitions/DevBoxActionDelayResult" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "DevBoxActionDelayResult": { + "type": "object", + "description": "The action delay result", + "properties": { + "uri": { + "type": "string", + "description": "The unique URI of the action." + }, + "name": { + "type": "string", + "description": "The name of the action." + }, + "result": { + "$ref": "#/definitions/DevBoxActionDelayResultStatus", + "description": "The result of the delay operation on this action." + }, + "action": { + "description": "The delayed action", + "type": "object", + "$ref": "#/definitions/DevBoxAction" + }, + "error": { + "description": "Information about the error that occurred. Only populated on error.", + "type": "object", + "$ref": "devcenter.json#/definitions/CloudErrorBody" + } + }, + "required": [ + "name", + "uri", + "result" + ] + }, + "DevBoxActionDelayResultStatus": { + "type": "string", + "enum": [ + "Succeeded", + "Failed" + ], + "description": "The result of the delay operation on this action.", + "x-ms-enum": { + "name": "DevBoxActionDelayResultStatus", + "modelAsString": true, + "values": [ + { + "value": "Succeeded", + "description": "The delay operation succeeded." + }, + { + "value": "Failed", + "description": "The delay operation failed." + } + ] + } + }, + "DevBoxActionsListResult": { + "type": "object", + "description": "The actions list result", + "properties": { + "value": { + "description": "Current page of results", + "type": "array", + "items": { + "$ref": "#/definitions/DevBoxAction" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "DevBoxAction": { + "type": "object", + "description": "An action which will take place on a Dev Box.", + "properties": { + "uri": { + "description": "The unique URI for the Dev Box action.", + "type": "string" + }, + "name": { + "description": "The name of the action.", + "type": "string" + }, + "actionType": { + "description": "The action that will be taken.", + "$ref": "#/definitions/DevBoxActionType" + }, + "sourceId": { + "description": "The id of the resource which triggered this action", + "type": "string" + }, + "sourceUri": { + "description": "The URI of the resource which triggered this action", + "type": "string" + }, + "sourceType": { + "description": "The type of the resource which triggered this action", + "$ref": "#/definitions/DevBoxActionSourceType" + }, + "suspendedUntil": { + "description": "The earliest time that the action could occur (UTC).", + "type": "string", + "format": "date-time" + }, + "next": { + "description": "Details about the next run of this action.", + "$ref": "#/definitions/DevBoxNextAction" + } + }, + "required": [ + "name", + "uri", + "actionType", + "sourceId", + "sourceUri", + "sourceType" + ] + }, + "DevBoxActionType": { + "description": "The type of action which will take place on a Dev Box.", + "type": "string", + "enum": [ + "Stop" + ], + "x-ms-enum": { + "name": "DevBoxActionType", + "modelAsString": true, + "values": [ + { + "value": "Stop", + "description": "The action will stop the Dev Box." + } + ] + } + }, + "DevBoxNextAction": { + "description": "Details about the next run of an action.", + "type": "object", + "properties": { + "scheduledTime": { + "description": "The time the action will be triggered (UTC).", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "scheduledTime" + ] + }, + "DevBoxOperationListResult": { + "type": "object", + "description": "The result of listing operations on a Dev Box.", + "properties": { + "value": { + "description": "The current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/DevBoxOperation" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "DevBoxOperation": { + "type": "object", + "description": "Information about an operation on a Dev Box.", + "discriminator": "kind", + "properties": { + "uri": { + "description": "The unique URI for the Dev Box operation.", + "type": "string" + }, + "operationId": { + "description": "Unique identifier for the Dev Box operation.", + "type": "string" + }, + "kind": { + "description": "The kind of operation that occurred.", + "$ref": "#/definitions/DevBoxOperationKind" + }, + "status": { + "description": "The operation status.", + "$ref": "#/definitions/DevBoxOperationStatus" + }, + "createdByObjectId": { + "description": "The object ID of the actor which initiated the operation.", + "type": "string" + }, + "startTime": { + "description": "The time the operation started.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished.", + "type": "string", + "format": "date-time" + }, + "error": { + "description": "Provisioning or operation error details. Populated only for error states.", + "$ref": "devcenter.json#/definitions/CloudErrorBody" + } + }, + "required": [ + "uri", + "operationId", + "kind", + "status" + ] + }, + "DevBoxStartOperation": { + "type": "object", + "description": "Information about a start operation on a Dev Box.", + "x-ms-discriminator-value": "Start", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ] + }, + "DevBoxStopOperation": { + "type": "object", + "description": "Information about a stop operation on a Dev Box.", + "x-ms-discriminator-value": "Stop", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ] + }, + "DevBoxRestartOperation": { + "type": "object", + "description": "Information about a restart operation on a Dev Box.", + "x-ms-discriminator-value": "Restart", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ] + }, + "DevBoxRepairOperation": { + "type": "object", + "description": "Information about a repair operation on a Dev Box.", + "x-ms-discriminator-value": "Repair", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "properties": { + "result": { + "description": "The result of the repair operation.", + "$ref": "#/definitions/DevBoxRepairOperationResult" + } + } + }, + "DevBoxRepairOperationResult": { + "description": "Information about the result of a repair operation on a Dev Box.", + "type": "object", + "properties": { + "repairOutcome": { + "description": "The outcome of the repair operation.", + "$ref": "#/definitions/DevBoxRepairOutcome" + }, + "code": { + "description": "The result code associated with the repair operation.", + "type": "string" + }, + "message": { + "description": "The result message associated with the repair operation.", + "type": "string" + } + } + }, + "DevBoxRepairOutcome": { + "type": "string", + "enum": [ + "FixApplied", + "IssuesDetected", + "NoIssuesDetected" + ], + "description": "The action taken during a repair operation.", + "x-ms-enum": { + "name": "DevBoxRepairOutcome", + "modelAsString": true, + "values": [ + { + "value": "FixApplied", + "description": "A fix for an issue was automatically applied to the Dev Box." + }, + { + "value": "IssuesDetected", + "description": "One or more issues was detected on the Dev Box, but they could not be fixed automatically." + }, + { + "value": "NoIssuesDetected", + "description": "The service did not identify any issues on the Dev Box." + } + ] + } + }, + "DevBoxOperationKind": { + "type": "string", + "enum": [ + "Start", + "Stop", + "Restart", + "Repair" + ], + "description": "The type of Dev Box operation.", + "x-ms-enum": { + "name": "DevBoxOperationKind", + "modelAsString": true, + "values": [ + { + "value": "Start", + "description": "The operation represents a Dev Box start." + }, + { + "value": "Stop", + "description": "The operation represents a Dev Box stop." + }, + { + "value": "Restart", + "description": "The operation represents a Dev Box restart." + }, + { + "value": "Repair", + "description": "The operation represents a Dev Box repair." + } + ] + } + }, + "DevBoxOperationStatus": { + "type": "string", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Canceled", + "Failed" + ], + "description": "The status of a Dev Box operation.", + "x-ms-enum": { + "name": "DevBoxOperationStatus", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "The operation has not started." + }, + { + "value": "Running", + "description": "The operation is running." + }, + { + "value": "Succeeded", + "description": "The operation succeeded." + }, + { + "value": "Canceled", + "description": "The operation was canceled." + }, + { + "value": "Failed", + "description": "The operation failed." + } + ] + } + }, + "ScheduleSourceType": { + "type": "string", + "enum": [ + "Pool" + ], + "description": "The type of the resource that this schedule belongs to.", + "x-ms-enum": { + "name": "ScheduleSourceType", + "modelAsString": true, + "values": [ + { + "value": "Pool", + "description": "The schedule source is a Dev Box pool." + } + ] + } + }, + "DevBoxActionSourceType": { + "type": "string", + "enum": [ + "Pool", + "Schedule" + ], + "description": "The type of the resource which triggered the action.", + "x-ms-enum": { + "name": "DevBoxActionSourceType", + "modelAsString": true, + "values": [ + { + "value": "Pool", + "description": "The action was triggered by a Dev Box pool." + }, + { + "value": "Schedule", + "description": "The action was triggered by a Dev Box schedule." + } + ] + } + } + }, + "parameters": { + "PoolNameParameter": { + "name": "poolName", + "description": "The name of a pool of Dev Boxes.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "in": "path", + "x-ms-parameter-location": "method" + }, + "ScheduleNameParameter": { + "name": "scheduleName", + "description": "The name of a schedule.", + "required": true, + "type": "string", + "in": "path", + "x-ms-parameter-location": "method" + }, + "DevBoxNameParameter": { + "name": "devBoxName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The name of a Dev Box.", + "x-ms-parameter-location": "method" + }, + "HibernateParameter": { + "name": "hibernate", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to hibernate the dev box.", + "x-ms-parameter-location": "method" + }, + "DevBoxActionNameParameter": { + "name": "actionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The name of an action that will take place on a Dev Box.", + "x-ms-parameter-location": "method" + }, + "DevBoxActionDelayUntilParameter": { + "name": "until", + "description": "The time to delay the Dev Box action or actions until.", + "required": true, + "type": "string", + "format": "date-time", + "in": "query", + "x-ms-parameter-location": "method" + }, + "DevBoxOperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The id of the operation on a Dev Box.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/devcenter.json new file mode 100644 index 000000000000..f240a194fb66 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/devcenter.json @@ -0,0 +1,361 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-01", + "title": "DevCenter" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "devcenter.json#/parameters/EndpointParameter" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "AADToken": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "AADToken": { + "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": { + "/projects": { + "get": { + "tags": [ + "Projects" + ], + "description": "Lists all projects.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "operationId": "DevCenter_ListProjects", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevCenter_ListProjects": { + "$ref": "./examples/Projects_ListByDevCenter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}": { + "get": { + "tags": [ + "Projects" + ], + "description": "Gets a project.", + "parameters": [ + { + "$ref": "#/parameters/ProjectNameMethodParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "operationId": "DevCenter_GetProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevCenter_GetProject": { + "$ref": "./examples/Projects_Get.json" + } + } + } + } + }, + "definitions": { + "ProjectListResult": { + "description": "Results of the project list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Project" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "Project": { + "description": "Project details.", + "type": "object", + "properties": { + "uri": { + "description": "The unique URI of the project", + "type": "string" + }, + "name": { + "type": "string", + "description": "Name of the project" + }, + "description": { + "type": "string", + "description": "Description of the project." + }, + "maxDevBoxesPerUser": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "When specified, indicates the maximum number of Dev Boxes a single user can create across all pools in the project." + }, + "displayName": { + "type": "string", + "description": "Display name of the project." + } + }, + "required": [ + "uri", + "name" + ] + }, + "CloudError": { + "x-ms-external": true, + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "description": "Error body", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "description": "An error response from the service.", + "type": "object", + "required": [ + "code", + "message" + ], + "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" + }, + "description": "A list of additional details about the error." + } + } + }, + "OperationStatus": { + "description": "The current status of an async operation", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified ID for the operation status.", + "type": "string" + }, + "name": { + "description": "The operation id name", + "type": "string" + }, + "status": { + "description": "Provisioning state of the resource.", + "type": "string" + }, + "resourceId": { + "description": "The id of the resource.", + "type": "string" + }, + "startTime": { + "description": "The start time of the operation", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation", + "type": "string", + "format": "date-time" + }, + "percentComplete": { + "description": "Percent of the operation that is complete", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "properties": { + "description": "Custom operation properties, populated only for a successful operation.", + "type": "object" + }, + "error": { + "description": "Operation Error message", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + } + }, + "required": [ + "status" + ] + } + }, + "parameters": { + "ProjectNameParameter": { + "name": "projectName", + "description": "The DevCenter Project upon which to execute operations.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "in": "path", + "x-ms-parameter-location": "client" + }, + "ProjectNameMethodParameter": { + "name": "projectName", + "description": "The DevCenter Project upon which to execute operations.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,62}$", + "minLength": 3, + "maxLength": 63, + "in": "path", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request.", + "x-ms-parameter-location": "client" + }, + "FilterParameter": { + "name": "filter", + "in": "query", + "description": "An OData filter clause to apply to the operation.", + "type": "string", + "required": false, + "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" + }, + "UserIdParameter": { + "name": "userId", + "in": "path", + "required": true, + "x-ms-client-default": "me", + "type": "string", + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$", + "minLength": 2, + "maxLength": 36, + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "description": "The DevCenter-specific URI to operate on.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "CatalogNameParameter": { + "name": "catalogName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The name of the catalog", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/environments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/environments.json new file mode 100644 index 000000000000..e888402051d8 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/environments.json @@ -0,0 +1,1828 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-01", + "title": "DevCenter", + "description": "Deployment Environments API." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "devcenter.json#/parameters/EndpointParameter" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "AADToken": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "AADToken": { + "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": { + "/projects/{projectName}/environments": { + "get": { + "tags": [ + "Environments" + ], + "description": "Lists the environments for a project.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + } + ], + "operationId": "Environments_ListEnvironments", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListEnvironments": { + "$ref": "./examples/Environments_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments": { + "get": { + "tags": [ + "Environments" + ], + "description": "Lists the environments for a project and user.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + } + ], + "operationId": "Environments_ListEnvironmentsByUser", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListEnvironmentsByUser": { + "$ref": "./examples/Environments_ListByProjectByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}": { + "get": { + "tags": [ + "Environments" + ], + "description": "Gets an environment", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + } + ], + "operationId": "Environments_GetEnvironmentByUser", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Environment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_GetEnvironmentByUser": { + "$ref": "./examples/Environments_Get.json" + } + } + }, + "put": { + "tags": [ + "Environments" + ], + "description": "Creates or updates an environment.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an environment.", + "required": true, + "schema": { + "$ref": "#/definitions/Environment" + } + } + ], + "operationId": "Environments_CreateOrReplaceEnvironment", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "responses": { + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Environment" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_CreateByEnvironmentDefinition": { + "$ref": "./examples/Environments_CreateByEnvironmentDefinition.json" + } + } + }, + "patch": { + "tags": [ + "Environments" + ], + "description": "Partially updates an environment", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable environment properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Environment" + } + } + ], + "operationId": "Environments_PatchEnvironment", + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Environment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_PatchEnvironment": { + "$ref": "./examples/Environments_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Environments" + ], + "description": "Deletes an environment and all its associated resources", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + } + ], + "operationId": "Environments_DeleteEnvironment", + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "devcenter.json#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "Deletion was successful or resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_DeleteEnvironment": { + "$ref": "./examples/Environments_Delete.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/outputs": { + "get": { + "tags": [ + "Environments" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + } + ], + "description": "Gets Outputs from the environment", + "operationId": "Environments_GetOutputs", + "responses": { + "200": { + "description": "The request completed successfully.", + "schema": { + "$ref": "#/definitions/EnvironmentOutputs" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_GetOutputs": { + "$ref": "./examples/Environments_GetOutputs.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations": { + "get": { + "tags": [ + "EnvironmentOperations", + "Environments" + ], + "description": "Lists operations on the environment which have occurred within the past 90 days", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/FilterParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + } + ], + "operationId": "Environments_ListOperations", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentOperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "EnvironmentOperations_ListByEnvironment": { + "$ref": "./examples/EnvironmentOperations_ListByEnvironment.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}": { + "get": { + "tags": [ + "EnvironmentOperations", + "Environments" + ], + "description": "Gets an environment action result.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentOperationIdParameter" + } + ], + "operationId": "Environments_GetOperation", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "EnvironmentOperations_GetByEnvironment": { + "$ref": "./examples/EnvironmentOperations_GetByEnvironment.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs": { + "get": { + "tags": [ + "EnvironmentOperations", + "Environments" + ], + "description": "Gets the logs for an operation on an environment.", + "produces": [ + "text/plain" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentOperationIdParameter" + } + ], + "operationId": "Environments_GetLogsByOperation", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "EnvironmentOperations_GetLogs": { + "$ref": "./examples/EnvironmentOperations_GetLogs.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions": { + "get": { + "tags": [ + "Environment Actions" + ], + "description": "Get all scheduled actions for a user within an environment.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + } + ], + "operationId": "Environments_ListActions", + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/EnvironmentActionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListActions": { + "$ref": "./examples/EnvironmentActions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/EnvironmentAction" + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}": { + "get": { + "tags": [ + "Environment Actions" + ], + "description": "Retrieve a specific environment action.", + "operationId": "Environments_GetAction", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentActionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/EnvironmentAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_GetAction": { + "$ref": "./examples/EnvironmentActions_Get.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}:skip": { + "post": { + "tags": [ + "Environment Actions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentActionNameParameter" + } + ], + "description": "Skips an occurrence of an action.", + "operationId": "Environments_SkipAction", + "responses": { + "204": { + "description": "No content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_SkipAction": { + "$ref": "./examples/EnvironmentActions_Skip.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}:delay": { + "post": { + "tags": [ + "Environment Actions" + ], + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentActionNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentActionDelayUntilParameter" + } + ], + "description": "Delays the occurrence of an action.", + "operationId": "Environments_DelayAction", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EnvironmentAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_DelayAction": { + "$ref": "./examples/EnvironmentActions_Delay.json" + } + } + } + }, + "/projects/{projectName}/catalogs": { + "get": { + "tags": [ + "Catalogs" + ], + "description": "Lists all of the catalogs available for a project.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + } + ], + "operationId": "Environments_ListCatalogsByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListCatalogsByProject": { + "$ref": "./examples/Catalogs_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}": { + "get": { + "tags": [ + "Catalogs" + ], + "description": "Gets the specified catalog within the project", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/CatalogNameParameter" + } + ], + "operationId": "Environments_GetCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_GetCatalog": { + "$ref": "./examples/Catalogs_Get.json" + } + } + } + }, + "/projects/{projectName}/environmentDefinitions": { + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Lists all environment definitions available for a project.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + } + ], + "operationId": "Environments_ListEnvironmentDefinitionsByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListEnvironmentDefinitions": { + "$ref": "./examples/EnvironmentDefinitions_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions": { + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Lists all environment definitions available within a catalog.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + }, + { + "$ref": "devcenter.json#/parameters/CatalogNameParameter" + } + ], + "operationId": "Environments_ListEnvironmentDefinitionsByCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListEnvironmentDefinitionsByCatalog": { + "$ref": "./examples/EnvironmentDefinitions_ListByCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{definitionName}": { + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Get an environment definition from a catalog.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "operationId": "Environments_GetEnvironmentDefinition", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_GetEnvironmentDefinition": { + "$ref": "./examples/EnvironmentDefinitions_Get.json" + } + } + } + }, + "/projects/{projectName}/environmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists all environment types configured for a project.", + "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "devcenter.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "devcenter.json#/parameters/TopParameter" + } + ], + "operationId": "Environments_ListEnvironmentTypes", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "devcenter.json#/definitions/CloudError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Environments_ListEnvironmentTypes": { + "$ref": "./examples/EnvironmentTypes_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "EnvironmentUpdateProperties": { + "description": "Properties of an environment. These properties can be updated after the resource has been created.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentPatchProperties" + } + ], + "properties": { + "parameters": { + "type": "object", + "description": "Parameters object for the environment. Can only be updated via create or replace." + } + } + }, + "EnvironmentPatchProperties": { + "description": "Properties of an environment. These properties can be updated via PATCH after the resource has been created.", + "type": "object", + "properties": { + "expirationDate": { + "description": "The time the expiration date will be triggered (UTC), after which the environment and associated resources will be deleted.", + "type": "string", + "format": "date-time" + } + } + }, + "Environment": { + "description": "Properties of an environment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentUpdateProperties" + } + ], + "properties": { + "uri": { + "description": "The unique URI of the environment", + "type": "string", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Environment name.", + "readOnly": true + }, + "environmentType": { + "type": "string", + "description": "The name of the environment type. Cannot be updated after creation.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "user": { + "type": "string", + "description": "The AAD object id of the owner of this Environment.", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the environment.", + "type": "string", + "readOnly": true + }, + "resourceGroupId": { + "description": "The identifier of the resource group containing the environment's resources.", + "type": "string", + "readOnly": true + }, + "catalogName": { + "type": "string", + "description": "The name of the catalog. Cannot be updated after creation.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "environmentDefinitionName": { + "type": "string", + "description": "The name of the environment definition. Cannot be updated after creation.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "error": { + "description": "Provisioning error details. Populated only for error states.", + "readOnly": true, + "$ref": "devcenter.json#/definitions/CloudErrorBody" + } + }, + "required": [ + "environmentType", + "catalogName", + "environmentDefinitionName" + ] + }, + "EnvironmentOutputs": { + "description": "Outputs from environment deployment.", + "type": "object", + "properties": { + "outputs": { + "type": "object", + "description": "The outputs Names and Values", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentOutput" + } + } + } + }, + "EnvironmentOutput": { + "description": "Output from environment deployment.", + "type": "object", + "properties": { + "type": { + "description": "Type of the output value", + "type": "string", + "enum": [ + "string", + "array", + "boolean", + "number", + "object" + ], + "x-ms-enum": { + "name": "EnvironmentOutputType", + "modelAsString": true, + "values": [ + { + "value": "array", + "description": "The output is an array of values." + }, + { + "value": "boolean", + "description": "The output is a boolean value." + }, + { + "value": "number", + "description": "The output is a number value." + }, + { + "value": "object", + "description": "The output is an object value." + }, + { + "value": "string", + "description": "The output is a string value." + } + ] + } + }, + "value": { + "description": "The output value", + "type": "object" + }, + "sensitive": { + "description": "Indicates if the value is sensitive.", + "type": "boolean" + } + } + }, + "EnvironmentActionType": { + "description": "The scheduled action types.", + "type": "string", + "enum": [ + "Delete" + ], + "x-ms-enum": { + "name": "EnvironmentActionType", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "The action will delete the environment and associated resources." + } + ] + } + }, + "EnvironmentNextAction": { + "description": "Details about the next run of an action.", + "type": "object", + "properties": { + "scheduledTime": { + "description": "The time the action will be triggered (UTC).", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "scheduledTime" + ] + }, + "EnvironmentActionsListResult": { + "type": "object", + "description": "The actions list result", + "properties": { + "value": { + "description": "Current page of results", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentAction" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "EnvironmentAction": { + "type": "object", + "description": "An upcoming Environment Action.", + "properties": { + "name": { + "description": "Uniquely identifies the action.", + "type": "string", + "readOnly": true + }, + "uri": { + "description": "Uri of the action resource.", + "type": "string", + "readOnly": true + }, + "actionType": { + "description": "The action that will be taken.", + "$ref": "#/definitions/EnvironmentActionType", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "next": { + "description": "Details about the next run of this action.", + "$ref": "#/definitions/EnvironmentNextAction" + }, + "lastModifiedBy": { + "description": "Object Id of the user who last modified the action.", + "type": "string", + "readOnly": true + }, + "lastModifiedAt": { + "description": "time the object was last modified.", + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "actionType", + "next" + ] + }, + "EnvironmentListResult": { + "description": "Results of the environment list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Environment" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "CatalogListResult": { + "description": "Results of the catalog list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Catalog" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "Catalog": { + "description": "A catalog.", + "type": "object", + "properties": { + "uri": { + "description": "The unique URI of the catalog", + "type": "string" + }, + "name": { + "description": "Name of the catalog.", + "type": "string" + } + }, + "required": [ + "uri", + "name" + ] + }, + "EnvironmentDefinitionListResult": { + "description": "Results of the environment definition list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "EnvironmentDefinition": { + "description": "An environment definition.", + "type": "object", + "properties": { + "uri": { + "description": "The unique URI of the environment definition", + "type": "string" + }, + "id": { + "description": "The ID of the environment definition.", + "type": "string" + }, + "name": { + "description": "Name of the environment definition.", + "type": "string" + }, + "catalogName": { + "description": "Name of the catalog.", + "type": "string" + }, + "description": { + "description": "A short description of the environment definition.", + "type": "string" + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentDefinitionParameter" + }, + "description": "Input parameters passed to an environment." + }, + "parametersSchema": { + "type": "string", + "description": "JSON schema defining the parameters object passed to an environment." + }, + "templatePath": { + "description": "Path to the Environment Definition entrypoint file.", + "type": "string" + } + }, + "required": [ + "name", + "uri", + "catalogName", + "id" + ] + }, + "EnvironmentDefinitionParameter": { + "type": "object", + "description": "Properties of an Environment Definition parameter", + "properties": { + "id": { + "type": "string", + "description": "Unique ID of the parameter" + }, + "name": { + "type": "string", + "description": "Display name of the parameter" + }, + "description": { + "type": "string", + "description": "Description of the parameter" + }, + "default": { + "type": "string", + "description": "Default value of the parameter" + }, + "type": { + "description": "A string of one of the basic JSON types (number, integer, array, object, boolean, string)", + "$ref": "#/definitions/ParameterType" + }, + "readOnly": { + "type": "boolean", + "description": "Whether or not this parameter is read-only. If true, default should have a value." + }, + "required": { + "type": "boolean", + "description": "Whether or not this parameter is required" + }, + "allowed": { + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1, + "uniqueItems": true, + "description": "An array of allowed values" + } + }, + "required": [ + "id", + "type", + "required" + ] + }, + "EnvironmentTypeListResult": { + "description": "Result of the environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "EnvironmentType": { + "description": "Properties of an environment type.", + "type": "object", + "properties": { + "uri": { + "description": "The unique URI of the environment type", + "type": "string" + }, + "name": { + "description": "Name of the environment type", + "type": "string" + }, + "deploymentTargetId": { + "description": "The ID of a subscription or management group that the environment type will be mapped to. The environment's resources will be deployed into this subscription or management group.", + "type": "string" + }, + "status": { + "description": "Indicates whether this environment type is enabled for use in this project.", + "$ref": "#/definitions/EnvironmentTypeEnableStatus" + }, + "displayName": { + "type": "string", + "description": "Display name of the environment type." + } + }, + "required": [ + "uri", + "name", + "deploymentTargetId", + "status" + ] + }, + "EnvironmentTypeEnableStatus": { + "description": "Indicates whether an environment type is enabled for use in a project.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnvironmentTypeEnableStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "The environment type is enabled for use in the project." + }, + { + "value": "Disabled", + "description": "The environment type is not enabled for use in the project." + } + ] + } + }, + "ParameterType": { + "type": "string", + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string" + ], + "description": "The type of data a parameter accepts.", + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true, + "values": [ + { + "value": "array", + "description": "The parameter accepts an array of values." + }, + { + "value": "boolean", + "description": "The parameter accepts a boolean value." + }, + { + "value": "integer", + "description": "The parameter accepts an integer value." + }, + { + "value": "number", + "description": "The parameter accepts a number value." + }, + { + "value": "object", + "description": "The parameter accepts an object value." + }, + { + "value": "string", + "description": "The parameter accepts a string value." + } + ] + } + }, + "EnvironmentOperationListResult": { + "type": "object", + "description": "The action results list result.", + "properties": { + "value": { + "description": "The current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentOperation" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "required": [ + "value" + ] + }, + "EnvironmentOperation": { + "type": "object", + "description": "Information about an operation on an environment.", + "discriminator": "kind", + "properties": { + "uri": { + "description": "The unique URI for the environment operation.", + "type": "string" + }, + "operationId": { + "description": "Unique identifier for the environment operation.", + "type": "string" + }, + "kind": { + "description": "The kind of operation that occurred.", + "$ref": "#/definitions/EnvironmentOperationKind" + }, + "status": { + "description": "The operation status.", + "$ref": "#/definitions/EnvironmentOperationStatus" + }, + "createdByObjectId": { + "description": "The object ID of the actor which initiated the operation.", + "type": "string" + }, + "startTime": { + "description": "The time the operation started.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The time the operation finished.", + "type": "string", + "format": "date-time" + }, + "environmentParameters": { + "type": "object", + "description": "Parameters object for the environment at the time of the operation." + }, + "error": { + "description": "Provisioning or operation error details. Populated only for error states.", + "$ref": "devcenter.json#/definitions/CloudErrorBody" + } + }, + "required": [ + "uri", + "operationId", + "kind", + "status" + ] + }, + "EnvironmentOperationKind": { + "type": "string", + "enum": [ + "Deploy", + "Delete" + ], + "description": "The type of environment operation.", + "x-ms-enum": { + "name": "EnvironmentOperationKind", + "modelAsString": true, + "values": [ + { + "value": "Deploy", + "description": "The operation represents a deployment." + }, + { + "value": "Delete", + "description": "The operation represents a delete." + } + ] + } + }, + "EnvironmentOperationStatus": { + "type": "string", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Canceled", + "Failed" + ], + "description": "The status of an environment operation.", + "x-ms-enum": { + "name": "EnvironmentOperationStatus", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "The operation has not started." + }, + { + "value": "Running", + "description": "The operation is running." + }, + { + "value": "Succeeded", + "description": "The operation succeeded." + }, + { + "value": "Canceled", + "description": "The operation was canceled." + }, + { + "value": "Failed", + "description": "The operation failed." + } + ] + } + }, + "EnvironmentDeployOperation": { + "type": "object", + "description": "Information about a deploy operation on an environment.", + "x-ms-discriminator-value": "Deploy", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentOperation" + } + ] + }, + "EnvironmentDeleteOperation": { + "type": "object", + "description": "Information about a delete operation on an environment.", + "x-ms-discriminator-value": "Delete", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentOperation" + } + ] + } + }, + "parameters": { + "EnvironmentNameParameter": { + "name": "environmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The name of the environment.", + "x-ms-parameter-location": "method" + }, + "EnvironmentDefinitionNameParameter": { + "name": "definitionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The name of the environment definition", + "x-ms-parameter-location": "method" + }, + "EnvironmentOperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The id of the operation on an environment.", + "x-ms-parameter-location": "method" + }, + "EnvironmentActionNameParameter": { + "name": "actionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63, + "description": "The name of an action that will take place on an Environment.", + "x-ms-parameter-location": "method" + }, + "EnvironmentActionDelayUntilParameter": { + "name": "until", + "description": "The time to delay the Environment action until.", + "required": true, + "type": "string", + "format": "date-time", + "in": "query", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Catalogs_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Catalogs_Get.json new file mode 100644 index 000000000000..7f91dec79ef1 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Catalogs_Get.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "catalogName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Catalogs_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Catalogs_ListByProject.json new file mode 100644 index 000000000000..bc6309474401 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Catalogs_ListByProject.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_Delay.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_Delay.json new file mode 100644 index 000000000000..27665e2b769e --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_Delay.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_DelayMultiple.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_DelayMultiple.json new file mode 100644 index 000000000000..f690fcb6d23a --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_DelayMultiple.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_DelayMultipleWithError.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_DelayMultipleWithError.json new file mode 100644 index 000000000000..e1114e6d379f --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_DelayMultipleWithError.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "result": "Failed", + "error": { + "code": "DelayOverMaxTime", + "message": "The schedule cannot be delayed more than 8 hours from the original invocation time." + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_Get.json new file mode 100644 index 000000000000..c1babb03feef --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_List.json new file mode 100644 index 000000000000..b513c7e29d6b --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "next": { + "scheduledTime": "2022-09-30T15:23:00Z" + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_Skip.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_Skip.json new file mode 100644 index 000000000000..e6b9b046a6c8 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxActions_Skip.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxOperations_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxOperations_Get.json new file mode 100644 index 000000000000..f0c3a25c3554 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxOperations_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxOperations_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxOperations_List.json new file mode 100644 index 000000000000..c075dcc3bba8 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxOperations_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/a6eb12ee-daa1-2215-9c44-63618dc2a781", + "operationId": "a6eb12ee-daa1-2215-9c44-63618dc2a781", + "status": "Succeeded", + "kind": "Repair", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-10T19:31:20.7229492+00:00", + "endTime": "2022-09-10T19:57:41.7229492+00:00", + "result": { + "code": "ConnectivityFixApplied", + "message": "We resolved some connectivity issues with your Dev Box.", + "repairOutcome": "FixApplied" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Create.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Create.json new file mode 100644 index 000000000000..8329c5c20ef8 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Create.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "body": { + "poolName": "LargeDevWorkStationPool" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + }, + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Creating", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Delete.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Delete.json new file mode 100644 index 000000000000..b957d3b2f4a6 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Get.json new file mode 100644 index 000000000000..112b53a275b8 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_GetRemoteConnection.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_GetRemoteConnection.json new file mode 100644 index 000000000000..0be242281c8d --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_GetRemoteConnection.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "webUrl": "https://connectionUrl" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_List.json new file mode 100644 index 000000000000..b4c578255bb8 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_ListByUserByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_ListByUserByProject.json new file mode 100644 index 000000000000..0e1201c583b9 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_ListByUserByProject.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Repair.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Repair.json new file mode 100644 index 000000000000..5a061b9e3db5 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Repair.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Restart.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Restart.json new file mode 100644 index 000000000000..5a061b9e3db5 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Restart.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Start.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Start.json new file mode 100644 index 000000000000..5a061b9e3db5 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Start.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Stop.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Stop.json new file mode 100644 index 000000000000..1eff046d0827 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/DevBoxes_Stop.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "hibernate": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_Delay.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_Delay.json new file mode 100644 index 000000000000..fbc08d677c42 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_Delay.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnv", + "actionName": "default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_Get.json new file mode 100644 index 000000000000..c1990e648722 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "actionName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_List.json new file mode 100644 index 000000000000..d97cb066fa41 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/expire", + "name": "expire", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-10-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-20T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_Skip.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_Skip.json new file mode 100644 index 000000000000..a61f86394afd --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentActions_Skip.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentName": "myEnv", + "userId": "me", + "actionName": "default", + "body": { + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentDefinitions_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentDefinitions_Get.json new file mode 100644 index 000000000000..5a57202f6d71 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentDefinitions_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "catalogName": "myCatalog", + "definitionName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentDefinitions_ListByCatalog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentDefinitions_ListByCatalog.json new file mode 100644 index 000000000000..64e24ce5b947 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentDefinitions_ListByCatalog.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentDefinitions_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentDefinitions_ListByProject.json new file mode 100644 index 000000000000..06d11d265583 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentDefinitions_ListByProject.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myOtherCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myOtherCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentOperations_GetByEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentOperations_GetByEnvironment.json new file mode 100644 index 000000000000..f0c849dde9d6 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentOperations_GetByEnvironment.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentOperations_GetLogs.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentOperations_GetLogs.json new file mode 100644 index 000000000000..0d5e6ad7b0d6 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentOperations_GetLogs.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": "{file}" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentOperations_ListByEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentOperations_ListByEnvironment.json new file mode 100644 index 000000000000..4653fc40a9a1 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentOperations_ListByEnvironment.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentTypes_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentTypes_ListByProject.json new file mode 100644 index 000000000000..a764fd7761dc --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/EnvironmentTypes_ListByProject.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_CreateByEnvironmentDefinition.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_CreateByEnvironmentDefinition.json new file mode 100644 index 000000000000..1354649c3adb --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_CreateByEnvironmentDefinition.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Creating", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_Delete.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_Delete.json new file mode 100644 index 000000000000..46495850ff55 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_Get.json new file mode 100644 index 000000000000..d9e50a5311b1 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_GetOutputs.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_GetOutputs.json new file mode 100644 index 000000000000..30f132695df8 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_GetOutputs.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "outputs": { + "stringOutput": { + "type": "string", + "value": "Output1 value", + "sensitive": false + }, + "arrayOutput": { + "type": "array", + "value": [ + 1, + 2, + 3 + ], + "sensitive": false + }, + "boolOutput": { + "type": "bool", + "value": true, + "sensitive": false + }, + "intOutput": { + "type": "int", + "value": 1, + "sensitive": false + }, + "objectOutput": { + "type": "object", + "value": { + "name": "name", + "id": "id" + }, + "sensitive": false + } + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_ListByProject.json new file mode 100644 index 000000000000..49625071f33d --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_ListByProject.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_ListByProjectByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_ListByProjectByUser.json new file mode 100644 index 000000000000..d6c2235df765 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_ListByProjectByUser.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_Patch.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_Patch.json new file mode 100644 index 000000000000..1e2076be4ec5 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Environments_Patch.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Pools_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Pools_Get.json new file mode 100644 index 000000000000..a71ac7a5ee59 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Pools_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-02-01", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Pools_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Pools_List.json new file mode 100644 index 000000000000..eecc02fdd3df --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Pools_List.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/SQLDevelopmentMachinePool", + "name": "SQLDevelopmentMachinePool", + "location": "southcentralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 16, + "memoryGB": 128 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "SqlDevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "displayName": "SQLPool" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Projects_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Projects_Get.json new file mode 100644 index 000000000000..8ebea78c0b3f --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Projects_Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/DevDiv", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Projects_ListByDevCenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Projects_ListByDevCenter.json new file mode 100644 index 000000000000..0f2e50e69cb0 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Projects_ListByDevCenter.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Schedules_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Schedules_Get.json new file mode 100644 index 000000000000..3a779d0a7025 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Schedules_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-02-01", + "poolName": "DevPool", + "scheduleName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Schedules_List.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Schedules_List.json new file mode 100644 index 000000000000..6fab1ae11be0 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Schedules_List.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "poolName": "DevPool", + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Schedules_ListByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Schedules_ListByProject.json new file mode 100644 index 000000000000..e06d2e0c2247 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/examples/Schedules_ListByProject.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/readme.md b/specification/devcenter/data-plane/readme.md index 22adcddd87c2..7464490abe4c 100644 --- a/specification/devcenter/data-plane/readme.md +++ b/specification/devcenter/data-plane/readme.md @@ -27,9 +27,23 @@ These are the global settings for the devcenter. ``` yaml openapi-type: data-plane azure-arm: false -tag: package-2023-10-01-preview +tag: package-2024-02-01 ``` +### Tag: 2024-02-01 + +These settings apply only when `--tag=package-2024-02-01` is specified on the command line. + +``` yaml $(tag) == 'package-2024-02-01' +input-file: + - Microsoft.DevCenter/stable/2024-02-01/devbox.json + - Microsoft.DevCenter/stable/2024-02-01/devcenter.json + - Microsoft.DevCenter/stable/2024-02-01/environments.json + +directive: + - suppress: HostParametersValidation + reason: Requires URL format for endpoint params, which violates R2003 and causes problems with codegen +``` ### Tag: package-2023-10-01-preview diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp index a0f100167fa7..f2dbd99cb074 100644 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/main.tsp @@ -106,15 +106,17 @@ model AzureDevOpsPermissionProfile { groups?: string[]; } @doc("Determines who has admin permissions to the Azure DevOps pool.") -enum AzureDevOpsPermissionType { +union AzureDevOpsPermissionType { + string, + @doc("Pool will inherit permissions from the project or organization.") - Inherit, + "Inherit", @doc("Only the pool creator will be an admin of the pool.") - CreatorOnly, + "CreatorOnly", @doc("Only the specified accounts will be admins of the pool.") - SpecificAccounts, + "SpecificAccounts", } @doc("Defines the type of fabric the agent will run on.") @@ -154,15 +156,17 @@ model StorageProfile { } @doc("The storage account type of the OS disk.") -enum OsDiskStorageAccountType { +union OsDiskStorageAccountType { + string, + @doc("Standard OS disk type.") - Standard, + "Standard", @doc("Premium OS disk type.") - Premium, + "Premium", @doc("Standard SSD OS disk type.") - StandardSSD, + "StandardSSD", } @doc("The VM image of the machines in the pool.") @@ -196,12 +200,14 @@ model SecretsManagementSettings { keyExportable: boolean; } @doc("Determines how the service should be run.") -enum LogonType { +union LogonType { + string, + @doc("Run as a service.") - Service, + "Service", @doc("Run in interactive mode.") - Interactive, + "Interactive", } @doc("The network profile of the machines in the pool.") @@ -233,27 +239,29 @@ model Stateful extends AgentProfile { model ResourcePredictions {} @doc("The status of the current operation.") -enum ProvisioningState { +union ProvisioningState { + string, + /** Represents a succeeded operation. */ - Succeeded, + Succeeded: "Succeeded", /** Represents a failed operation. */ - Failed, + Failed: "Failed", /** Represents a canceled operation. */ - Canceled, + Canceled: "Canceled", /** Represents a pending operation. */ - Provisioning, + Provisioning: "Provisioning", /** Represents a pending operation. */ - Updating, + Updating: "Updating", /** Represents an operation under deletion. */ - Deleting, + Deleting: "Deleting", /** Represents an accepted operation. */ - Accepted, + Accepted: "Accepted", } interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2023-12-13-preview/devopsinfrastructure.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2023-12-13-preview/devopsinfrastructure.json index 8dc7e7ae31b5..6061d44dd5bb 100644 --- a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2023-12-13-preview/devopsinfrastructure.json +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/preview/2023-12-13-preview/devopsinfrastructure.json @@ -60,7 +60,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -99,7 +99,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PoolListResult" } @@ -141,7 +141,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PoolListResult" } @@ -191,7 +191,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Pool" } @@ -316,7 +316,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Pool" } @@ -393,7 +393,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", diff --git a/specification/edgemarketplace/resource-manager/readme.java.md b/specification/edgemarketplace/resource-manager/readme.java.md index 545dacee55fc..985e706f8988 100644 --- a/specification/edgemarketplace/resource-manager/readme.java.md +++ b/specification/edgemarketplace/resource-manager/readme.java.md @@ -4,12 +4,7 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.edgemarketplace -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-edgemarketplace +client-flattened-annotation-target: disabled directive: - from: arcSettings.json where: $.definitions.ArcSetting.properties.systemData @@ -24,26 +19,3 @@ directive: transform: $['x-ms-client-flatten'] = false reason: systemData should not be flattened ``` - -# Validation - - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2023-08 -``` - -### Tag: package-2023-08 and java - -These settings apply only when `--tag=package-2023-08 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2023-08' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.edgemarketplace.v2023_08_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/edgemarketplace/mgmt-v2023_08_01 -regenerate-manager: true -generate-interface: true -``` diff --git a/specification/edgemarketplace/resource-manager/readme.md b/specification/edgemarketplace/resource-manager/readme.md index c1af3dc628a0..f5af188d40de 100644 --- a/specification/edgemarketplace/resource-manager/readme.md +++ b/specification/edgemarketplace/resource-manager/readme.md @@ -32,6 +32,11 @@ openapi-subtype: rpaas tag: package-2023-08-01 ``` +``` yaml +modelerfour: + flatten-models: false +``` + ### Tag: package-2023-08-01-preview These settings apply only when `--tag=package-2023-08-01-preview` is specified on the command line. diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/edgeorder.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/edgeorder.json new file mode 100644 index 000000000000..e8f0fd931c76 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/edgeorder.json @@ -0,0 +1,4361 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-01", + "title": "Edge Ordering Service-Customer" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.EdgeOrder/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "List all the supported operations.", + "operationId": "Operations_List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The supported operations list.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListOperations": { + "$ref": "./examples/ListOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/addresses": { + "get": { + "tags": [ + "Addresses" + ], + "description": "List all the addresses available under the subscription.", + "operationId": "Addresses_ListBySubscription", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "$filter is supported to filter based on shipping address properties. Filter supports only equals operation.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of addresses, which provides the next page in the list of addresses.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "List of addresses available under the subscription.", + "schema": { + "$ref": "#/definitions/AddressResourceList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListAddressesAtSubscriptionLevel": { + "$ref": "./examples/ListAddressesAtSubscriptionLevel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listConfigurations": { + "post": { + "tags": [ + "ProductsAndConfigurations" + ], + "description": "List configurations for the given product family, product line and product for the given subscription.", + "operationId": "ProductsAndConfigurations_ListConfigurations", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on list of configurations, which provides the next page in the list of configurations.", + "required": false, + "type": "string" + }, + { + "name": "configurationsRequest", + "in": "body", + "description": "Filters for showing the configurations.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationsRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of configurations for the given product family, product line and product for the given subscription.", + "schema": { + "$ref": "#/definitions/Configurations" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListConfigurations": { + "$ref": "./examples/ListConfigurations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listProductFamilies": { + "post": { + "tags": [ + "ProductsAndConfigurations" + ], + "description": "List product families for the given subscription.", + "operationId": "ProductsAndConfigurations_ListProductFamilies", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on configurations parameter for product, which provides details on the configurations for the product.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on list of product families, which provides the next page in the list of product families.", + "required": false, + "type": "string" + }, + { + "name": "productFamiliesRequest", + "in": "body", + "description": "Filters for showing the product families.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductFamiliesRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of available product families for the given subscription.", + "schema": { + "$ref": "#/definitions/ProductFamilies" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListProductFamilies": { + "$ref": "./examples/ListProductFamilies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orderItems": { + "get": { + "tags": [ + "OrderItems" + ], + "description": "List order items at subscription level.", + "operationId": "OrderItems_ListBySubscription", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "$filter is supported to filter based on order id and order Item Type. Filter supports only equals operation.", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of order items, which provides the next page in the list of order items.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "List of order items available under the subscription.", + "schema": { + "$ref": "#/definitions/OrderItemResourceList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListOrderItemsAtSubscriptionLevel": { + "$ref": "./examples/ListOrderItemsAtSubscriptionLevel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orders": { + "get": { + "tags": [ + "Order" + ], + "description": "List orders at subscription level.", + "operationId": "Orders_ListBySubscription", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of orders, which provides the next page in the list of orders.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "List of orders available under the subscription.", + "schema": { + "$ref": "#/definitions/OrderResourceList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListOrderAtSubscriptionLevel": { + "$ref": "./examples/ListOrderAtSubscriptionLevel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/productFamiliesMetadata": { + "post": { + "tags": [ + "ProductFamilyMetadata" + ], + "description": "List product families metadata for the given subscription.", + "operationId": "ProductsAndConfigurations_ListProductFamiliesMetadata", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on list of product families metadata, which provides the next page in the list of product families metadata.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The list of available product families for the given subscription.", + "schema": { + "$ref": "#/definitions/ProductFamiliesMetadata" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListProductFamiliesMetadata": { + "$ref": "./examples/ListProductFamiliesMetadata.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses": { + "get": { + "tags": [ + "Addresses" + ], + "description": "List all the addresses available under the given resource group.", + "operationId": "Addresses_ListByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "$filter is supported to filter based on shipping address properties. Filter supports only equals operation.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of addresses, which provides the next page in the list of addresses.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "List of addresses available under the resource group.", + "schema": { + "$ref": "#/definitions/AddressResourceList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListAddressesAtResourceGroupLevel": { + "$ref": "./examples/ListAddressesAtResourceGroupLevel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}": { + "get": { + "tags": [ + "Addresses" + ], + "description": "Get information about the specified address.", + "operationId": "Addresses_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/addressNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Address object.", + "schema": { + "$ref": "#/definitions/AddressResource" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAddressByName": { + "$ref": "./examples/GetAddressByName.json" + } + } + }, + "put": { + "tags": [ + "Addresses" + ], + "description": "Create a new address with the specified parameters. Existing address cannot be updated with this API and should\r\ninstead be updated with the Update address API.", + "operationId": "Addresses_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/addressNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "addressResource", + "in": "body", + "description": "Address details from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/AddressResource" + } + } + ], + "responses": { + "200": { + "description": "Address resource object.", + "schema": { + "$ref": "#/definitions/AddressResource" + } + }, + "202": { + "description": "Accepted request for create Address.", + "headers": { + "Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CreateAddress": { + "$ref": "./examples/CreateAddress.json" + } + } + }, + "delete": { + "tags": [ + "Addresses" + ], + "description": "Delete an address.", + "operationId": "Addresses_Delete", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/addressNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted request for delete address.", + "headers": { + "Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "204": { + "description": "No content. Address deleted." + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DeleteAddressByName": { + "$ref": "./examples/DeleteAddressByName.json" + } + } + }, + "patch": { + "tags": [ + "Addresses" + ], + "description": "Update the properties of an existing address.", + "operationId": "Addresses_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/addressNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.", + "required": false, + "type": "string" + }, + { + "name": "addressUpdateParameter", + "in": "body", + "description": "Address update parameters from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/AddressUpdateParameter" + } + } + ], + "responses": { + "202": { + "description": "Accepted request for address update.", + "headers": { + "Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "200": { + "description": "Address resource object.", + "schema": { + "$ref": "#/definitions/AddressResource" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UpdateAddress": { + "$ref": "./examples/UpdateAddress.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/locations/{location}/orders/{orderName}": { + "get": { + "tags": [ + "Order" + ], + "description": "Get an order.", + "operationId": "Orders_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/orderNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Order resource object.", + "schema": { + "$ref": "#/definitions/OrderResource" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetOrderByName": { + "$ref": "./examples/GetOrderByName.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems": { + "get": { + "tags": [ + "OrderItems" + ], + "description": "List order items at resource group level.", + "operationId": "OrderItems_ListByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "$filter is supported to filter based on order id and order Item Type. Filter supports only equals operation.", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of order items, which provides the next page in the list of order items.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "List of order items available under the resource group.", + "schema": { + "$ref": "#/definitions/OrderItemResourceList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListOrderItemsAtResourceGroupLevel": { + "$ref": "./examples/ListOrderItemsAtResourceGroupLevel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}": { + "get": { + "tags": [ + "OrderItems" + ], + "description": "Get an order item.", + "operationId": "OrderItems_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/orderItemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Order item object.", + "schema": { + "$ref": "#/definitions/OrderItemResource" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetOrderItemByName": { + "$ref": "./examples/GetOrderItemByName.json" + } + } + }, + "put": { + "tags": [ + "OrderItems" + ], + "description": "Create an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item\r\nAPI.", + "operationId": "OrderItems_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/orderItemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "orderItemResource", + "in": "body", + "description": "Order item details from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/OrderItemResource" + } + } + ], + "responses": { + "200": { + "description": "Order resource object.", + "schema": { + "$ref": "#/definitions/OrderItemResource" + } + }, + "202": { + "description": "Accepted request to create order item.", + "headers": { + "Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CreateOrderItem": { + "$ref": "./examples/CreateOrderItem.json" + } + } + }, + "delete": { + "tags": [ + "OrderItems" + ], + "description": "Delete an order item.", + "operationId": "OrderItems_Delete", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/orderItemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted delete request for an order item.", + "headers": { + "Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "204": { + "description": "No content. Order item deleted." + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DeleteOrderItemByName": { + "$ref": "./examples/DeleteOrderItemByName.json" + } + } + }, + "patch": { + "tags": [ + "OrderItems" + ], + "description": "Update the properties of an existing order item.", + "operationId": "OrderItems_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/orderItemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "Defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value.", + "required": false, + "type": "string" + }, + { + "name": "orderItemUpdateParameter", + "in": "body", + "description": "Order item update parameters from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/OrderItemUpdateParameter" + } + } + ], + "responses": { + "202": { + "description": "Accepted request for order item update.", + "headers": { + "Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "200": { + "description": "Order item resource object.", + "schema": { + "$ref": "#/definitions/OrderItemResource" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UpdateOrderItem": { + "$ref": "./examples/UpdateOrderItem.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/cancel": { + "post": { + "tags": [ + "OrderItems" + ], + "description": "Cancel order item.", + "operationId": "OrderItems_Cancel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/orderItemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "cancellationReason", + "in": "body", + "description": "Reason for cancellation.", + "required": true, + "schema": { + "$ref": "#/definitions/CancellationReason" + } + } + ], + "responses": { + "200": { + "description": "Order item cancelled." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CancelOrderItem": { + "$ref": "./examples/CancelOrderItem.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/return": { + "post": { + "tags": [ + "OrderItems" + ], + "description": "Return order item.", + "operationId": "OrderItems_Return", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/orderItemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "returnOrderItemDetails", + "in": "body", + "description": "Return order item details.", + "required": true, + "schema": { + "$ref": "#/definitions/ReturnOrderItemDetails" + } + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Return order item request accepted.", + "headers": { + "Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ReturnOrderItem": { + "$ref": "./examples/ReturnOrderItem.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orders": { + "get": { + "tags": [ + "Order" + ], + "description": "List orders at resource group level.", + "operationId": "Orders_ListByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of orders, which provides the next page in the list of orders.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "List of orders available under the resource group.", + "schema": { + "$ref": "#/definitions/OrderResourceList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListOrderAtResourceGroupLevel": { + "$ref": "./examples/ListOrderAtResourceGroupLevel.json" + } + } + } + } + }, + "definitions": { + "AdditionalConfiguration": { + "description": "Additional Configuration details.", + "required": [ + "hierarchyInformation", + "quantity" + ], + "type": "object", + "properties": { + "hierarchyInformation": { + "$ref": "#/definitions/HierarchyInformation", + "description": "Hierarchy of the product which uniquely identifies the configuration." + }, + "quantity": { + "format": "int32", + "description": "Quantity of the product.", + "type": "integer" + }, + "provisioningDetails": { + "description": "List Provisioning Details for Devices in Additional Config.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ProvisioningDetails" + }, + "x-ms-identifiers": [] + } + } + }, + "AddressClassification": { + "description": "Type of address based on its usage context.", + "enum": [ + "Shipping", + "Site" + ], + "type": "string", + "x-ms-enum": { + "name": "AddressClassification", + "modelAsString": true, + "values": [ + { + "value": "Shipping", + "description": "Shipping address for the order." + }, + { + "value": "Site", + "description": "Site Address." + } + ] + } + }, + "AddressDetails": { + "description": "Address details for an order item.", + "required": [ + "forwardAddress" + ], + "type": "object", + "properties": { + "forwardAddress": { + "$ref": "#/definitions/AddressProperties", + "description": "Customer address and contact details." + }, + "returnAddress": { + "$ref": "#/definitions/AddressProperties", + "description": "Return shipping address.", + "readOnly": true + } + } + }, + "AddressProperties": { + "description": "Address Properties.", + "type": "object", + "properties": { + "addressClassification": { + "$ref": "#/definitions/AddressClassification", + "description": "Type of address based on its usage context." + }, + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping details for the address." + }, + "contactDetails": { + "$ref": "#/definitions/ContactDetails", + "description": "Contact details for the address." + }, + "addressValidationStatus": { + "description": "Status of address validation.", + "enum": [ + "Valid", + "Invalid", + "Ambiguous" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AddressValidationStatus", + "modelAsString": true, + "values": [ + { + "value": "Valid", + "description": "Address provided is valid." + }, + { + "value": "Invalid", + "description": "Address provided is invalid or not supported." + }, + { + "value": "Ambiguous", + "description": "Address provided is ambiguous, please choose one of the alternate addresses returned." + } + ] + } + }, + "provisioningState": { + "description": "Provisioning state", + "$ref": "#/definitions/ProvisioningState" + } + } + }, + "AddressResource": { + "description": "Address Resource.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AddressProperties", + "description": "Properties of an address.", + "x-ms-client-flatten": true + } + } + }, + "AddressResourceList": { + "description": "Address Resource Collection.", + "type": "object", + "properties": { + "value": { + "description": "List of address resources.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/AddressResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link for the next set of job resources.", + "type": "string" + } + } + }, + "AddressUpdateParameter": { + "description": "The Address update parameters.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddressUpdateProperties", + "description": "Properties of an address to be updated.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AddressUpdateProperties": { + "description": "Address Update Properties.", + "type": "object", + "properties": { + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping details for the address." + }, + "contactDetails": { + "$ref": "#/definitions/ContactDetails", + "description": "Contact details for the address." + } + } + }, + "AutoProvisioningStatus": { + "description": "Auto Provisioning Details.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProvisioningStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location." + }, + { + "value": "Disabled", + "description": "Provisioning Disabled." + } + ] + } + }, + "AvailabilityInformation": { + "description": "Availability information of a product system.", + "type": "object", + "properties": { + "availabilityStage": { + "description": "Current availability stage of the product.", + "enum": [ + "Available", + "Preview", + "Signup", + "Discoverable", + "ComingSoon", + "Unavailable", + "Deprecated" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AvailabilityStage", + "modelAsString": true, + "values": [ + { + "value": "Available", + "description": "Product is available." + }, + { + "value": "Preview", + "description": "Product is in preview." + }, + { + "value": "Signup", + "description": "Product is available only on signup." + }, + { + "value": "Discoverable", + "description": "Product is not available in our service but can be discovered from other sources." + }, + { + "value": "ComingSoon", + "description": "Product is coming soon." + }, + { + "value": "Unavailable", + "description": "Product is not available." + }, + { + "value": "Deprecated", + "description": "Product is deprecated." + } + ] + } + }, + "disabledReason": { + "description": "Reason why the product is disabled.", + "enum": [ + "None", + "Country", + "Region", + "Feature", + "OfferType", + "NoSubscriptionInfo", + "NotAvailable", + "OutOfStock" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DisabledReason", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Not disabled." + }, + { + "value": "Country", + "description": "Not available in the requested country." + }, + { + "value": "Region", + "description": "Not available to push data to the requested Azure region." + }, + { + "value": "Feature", + "description": "Required features are not enabled." + }, + { + "value": "OfferType", + "description": "Subscription does not have required offer types." + }, + { + "value": "NoSubscriptionInfo", + "description": "Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification." + }, + { + "value": "NotAvailable", + "description": "The product is not yet available." + }, + { + "value": "OutOfStock", + "description": "The product is out of stock." + } + ] + } + }, + "disabledReasonMessage": { + "description": "Message for why the product is disabled.", + "type": "string", + "readOnly": true + } + } + }, + "BasicInformation": { + "description": "Basic information for any product system.", + "type": "object", + "properties": { + "displayName": { + "description": "Display Name for the product system.", + "type": "string", + "readOnly": true + }, + "description": { + "$ref": "#/definitions/Description", + "description": "Description related to the product system.", + "readOnly": true + }, + "imageInformation": { + "description": "Image information for the product system.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ImageInformation" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "costInformation": { + "$ref": "#/definitions/CostInformation", + "description": "Cost information for the product system.", + "readOnly": true + }, + "availabilityInformation": { + "$ref": "#/definitions/AvailabilityInformation", + "description": "Availability information of the product system.", + "readOnly": true + }, + "hierarchyInformation": { + "$ref": "#/definitions/HierarchyInformation", + "description": "Hierarchy information of a product.", + "readOnly": true + }, + "fulfilledBy": { + "description": "The entity responsible for fulfillment of the item at the given hierarchy level.", + "enum": [ + "Microsoft", + "External" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FulfillmentType", + "modelAsString": true, + "values": [ + { + "value": "Microsoft", + "description": "The fulfillment (the whole journey of the product offering) is handled by microsoft." + }, + { + "value": "External", + "description": "The fulfillment (the whole journey of the product offering) is handled by external third party entities." + } + ] + } + } + } + }, + "BillingMeterDetails": { + "description": "Holds billing meter details for each type of billing.", + "type": "object", + "properties": { + "name": { + "description": "Represents Billing type name.", + "type": "string", + "readOnly": true + }, + "meterDetails": { + "$ref": "#/definitions/MeterDetails", + "description": "Represents MeterDetails.", + "readOnly": true + }, + "meteringType": { + "description": "Represents Metering type (eg one-time or recurrent).", + "enum": [ + "OneTime", + "Recurring", + "Adhoc" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MeteringType", + "modelAsString": true, + "values": [ + { + "value": "OneTime", + "description": "One time billing." + }, + { + "value": "Recurring", + "description": "Recurring billing." + }, + { + "value": "Adhoc", + "description": "Adhoc billing." + } + ] + } + }, + "frequency": { + "description": "Frequency of recurrence.", + "type": "string", + "readOnly": true + }, + "termTypeDetails": { + "description": "Represent Term Type details.", + "$ref": "#/definitions/TermTypeDetails", + "readOnly": true + } + } + }, + "CancellationReason": { + "description": "Reason for cancellation.", + "required": [ + "reason" + ], + "type": "object", + "properties": { + "reason": { + "description": "Reason for cancellation.", + "type": "string" + } + } + }, + "CategoryInformation": { + "description": "Category related properties of a child configuration.", + "type": "object", + "properties": { + "categoryName": { + "description": "Category name of the child configuration.", + "type": "string" + }, + "categoryDisplayName": { + "description": "Category display name of the child configuration.", + "type": "string" + }, + "description": { + "description": "Description text for the category.", + "type": "string" + }, + "links": { + "description": "Links for the category.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Link" + }, + "x-ms-identifiers": [] + } + } + }, + "ChildConfiguration": { + "description": "Child configuration object.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ChildConfigurationProperties", + "description": "Properties of child configuration.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ChildConfigurationFilter": { + "description": "Child configuration filter.", + "type": "object", + "properties": { + "hierarchyInformations": { + "description": "The list of child configuration hierarchy customer wants to filter for the given configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/HierarchyInformation" + }, + "x-ms-identifiers": [] + }, + "childConfigurationTypes": { + "description": "Filter to fetch all child configurations belonging to the given list of configuration types.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "DeviceConfiguration", + "AdditionalConfiguration" + ], + "type": "string", + "x-ms-enum": { + "name": "ChildConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "DeviceConfiguration", + "description": "Child configuration is a device configuration." + }, + { + "value": "AdditionalConfiguration", + "description": "Child configuration is an additional configuration." + } + ] + } + } + } + } + }, + "ChildConfigurationProperties": { + "description": "Properties of child configuration.", + "type": "object", + "properties": { + "childConfigurationType": { + "description": "Child configuration type.", + "enum": [ + "DeviceConfiguration", + "AdditionalConfiguration" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ChildConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "DeviceConfiguration", + "description": "Child configuration is a device configuration." + }, + { + "value": "AdditionalConfiguration", + "description": "Child configuration is an additional configuration." + } + ] + } + }, + "isPartOfBaseConfiguration": { + "description": "Flag to indicate if the child configuration is part of the base configuration, which means the customer need not pass this configuration in OptInAdditionalConfigurations while placing an order, it will be shipped by default.", + "type": "boolean", + "readOnly": true + }, + "minimumQuantity": { + "format": "int32", + "description": "Minimum quantity a customer can order while choosing this configuration.", + "type": "integer", + "readOnly": true + }, + "maximumQuantity": { + "format": "int32", + "description": "Maximum quantity a customer can order while choosing this configuration.", + "type": "integer", + "readOnly": true + }, + "specifications": { + "description": "Specifications of the configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Specification" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "dimensions": { + "$ref": "#/definitions/Dimensions", + "description": "Dimensions of the configuration.", + "readOnly": true + }, + "provisioningSupport": { + "description": "Determining nature of provisioning that the configuration supports.", + "$ref": "#/definitions/ProvisioningSupport", + "readOnly": true + }, + "childConfigurationTypes": { + "description": "Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "DeviceConfiguration", + "AdditionalConfiguration" + ], + "type": "string", + "x-ms-enum": { + "name": "ChildConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "DeviceConfiguration", + "description": "Child configuration is a device configuration." + }, + { + "value": "AdditionalConfiguration", + "description": "Child configuration is an additional configuration." + } + ] + } + }, + "readOnly": true + }, + "groupedChildConfigurations": { + "description": "Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GroupedChildConfigurations" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "supportedTermCommitmentDurations": { + "description": "The Term Commitment Durations that are supported for a configuration.", + "type": "array", + "items": { + "type": "string", + "format": "duration" + }, + "readOnly": true + }, + "filterableProperties": { + "description": "List of filters supported for a product.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/FilterableProperty" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "displayName": { + "description": "Display Name for the product system.", + "type": "string", + "readOnly": true + }, + "description": { + "$ref": "#/definitions/Description", + "description": "Description related to the product system.", + "readOnly": true + }, + "imageInformation": { + "description": "Image information for the product system.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ImageInformation" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "costInformation": { + "$ref": "#/definitions/CostInformation", + "description": "Cost information for the product system.", + "readOnly": true + }, + "availabilityInformation": { + "$ref": "#/definitions/AvailabilityInformation", + "description": "Availability information of the product system.", + "readOnly": true + }, + "hierarchyInformation": { + "$ref": "#/definitions/HierarchyInformation", + "description": "Hierarchy information of a product.", + "readOnly": true + }, + "fulfilledBy": { + "description": "The entity responsible for fulfillment of the item at the given hierarchy level.", + "enum": [ + "Microsoft", + "External" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FulfillmentType", + "modelAsString": true, + "values": [ + { + "value": "Microsoft", + "description": "The fulfillment (the whole journey of the product offering) is handled by microsoft." + }, + { + "value": "External", + "description": "The fulfillment (the whole journey of the product offering) is handled by external third party entities." + } + ] + } + } + } + }, + "CommonProperties": { + "description": "Represents common properties across product hierarchy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BasicInformation" + } + ], + "properties": { + "filterableProperties": { + "description": "List of filters supported for a product.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/FilterableProperty" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "Configuration": { + "description": "Configuration object.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "description": "Properties of configuration.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ConfigurationDeviceDetails": { + "description": "Device details for configuration.", + "type": "object", + "properties": { + "displayInfo": { + "$ref": "#/definitions/DisplayInfo", + "description": "Display details of the product." + }, + "hierarchyInformation": { + "$ref": "#/definitions/HierarchyInformation", + "description": "Hierarchy of the product which uniquely identifies the configuration.", + "readOnly": true + }, + "quantity": { + "format": "int32", + "description": "Quantity of the product.", + "type": "integer", + "readOnly": true + }, + "identificationType": { + "description": "Identification type of the configuration.", + "enum": [ + "NotSupported", + "SerialNumber" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IdentificationType", + "modelAsString": true, + "values": [ + { + "value": "NotSupported", + "description": "Product does not have any explicit identifier." + }, + { + "value": "SerialNumber", + "description": "Product is identifiable by serial number." + } + ] + } + }, + "deviceDetails": { + "description": "List of device details.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DeviceDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "termCommitmentInformation": { + "description": "Term Commitment Information of the Device.", + "$ref": "#/definitions/TermCommitmentInformation", + "readOnly": true + } + } + }, + "ConfigurationFilter": { + "description": "Configuration filters.", + "required": [ + "hierarchyInformation" + ], + "type": "object", + "properties": { + "hierarchyInformation": { + "$ref": "#/definitions/HierarchyInformation", + "description": "Product hierarchy information." + }, + "filterableProperty": { + "description": "Filters specific to product.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/FilterableProperty" + }, + "x-ms-identifiers": [] + }, + "childConfigurationFilter": { + "$ref": "#/definitions/ChildConfigurationFilter", + "description": "Filter to fetch specific child configurations that exist in the configuration. This must be passed to either fetch a list of specific child configurations, or all child configurations of specific types of child configurations." + } + } + }, + "ConfigurationProperties": { + "description": "Properties of configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonProperties" + } + ], + "properties": { + "specifications": { + "description": "Specifications of the configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Specification" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "dimensions": { + "$ref": "#/definitions/Dimensions", + "description": "Dimensions of the configuration.", + "readOnly": true + }, + "provisioningSupport": { + "description": "Determining nature of provisioning that the configuration supports.", + "$ref": "#/definitions/ProvisioningSupport", + "readOnly": true + }, + "childConfigurationTypes": { + "description": "Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "DeviceConfiguration", + "AdditionalConfiguration" + ], + "type": "string", + "x-ms-enum": { + "name": "ChildConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "DeviceConfiguration", + "description": "Child configuration is a device configuration." + }, + { + "value": "AdditionalConfiguration", + "description": "Child configuration is an additional configuration." + } + ] + } + }, + "readOnly": true + }, + "groupedChildConfigurations": { + "description": "Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GroupedChildConfigurations" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "supportedTermCommitmentDurations": { + "description": "The Term Commitment Durations that are supported for a configuration.", + "type": "array", + "items": { + "type": "string", + "format": "duration" + }, + "readOnly": true + } + } + }, + "Configurations": { + "description": "The list of configurations.", + "type": "object", + "properties": { + "value": { + "description": "List of configurations.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link for the next set of configurations.", + "type": "string" + } + } + }, + "ConfigurationsRequest": { + "description": "Configuration request object.", + "type": "object", + "properties": { + "configurationFilter": { + "$ref": "#/definitions/ConfigurationFilter", + "description": "Holds details about product hierarchy information and filterable property." + }, + "customerSubscriptionDetails": { + "$ref": "#/definitions/CustomerSubscriptionDetails", + "description": "Customer subscription properties. Clients can display available products to unregistered customers by explicitly passing subscription details." + } + } + }, + "ContactDetails": { + "description": "Contact Details.", + "type": "object", + "properties": { + "contactName": { + "description": "Contact name of the person.", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact person.", + "type": "string" + }, + "phoneExtension": { + "description": "Phone extension number of the contact person.", + "type": "string" + }, + "mobile": { + "description": "Mobile number of the contact person.", + "type": "string" + }, + "emailList": { + "description": "List of Email-ids to be notified about job progress.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CostInformation": { + "description": "Cost information for the product system.", + "type": "object", + "properties": { + "billingMeterDetails": { + "description": "Details on the various billing aspects for the product system.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BillingMeterDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "billingInfoUrl": { + "description": "Default url to display billing information.", + "type": "string", + "readOnly": true + } + } + }, + "CustomerSubscriptionDetails": { + "description": "Holds Customer subscription details. Clients can display available products to unregistered customers by explicitly passing subscription details.", + "required": [ + "quotaId" + ], + "type": "object", + "properties": { + "registeredFeatures": { + "description": "List of registered feature flags for subscription.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/CustomerSubscriptionRegisteredFeatures" + }, + "x-ms-identifiers": [] + }, + "locationPlacementId": { + "description": "Location placement Id of a subscription.", + "type": "string" + }, + "quotaId": { + "description": "Quota ID of a subscription.", + "type": "string" + } + } + }, + "CustomerSubscriptionRegisteredFeatures": { + "description": "Represents subscription registered features.", + "type": "object", + "properties": { + "name": { + "description": "Name of subscription registered feature.", + "type": "string" + }, + "state": { + "description": "State of subscription registered feature.", + "type": "string" + } + } + }, + "Description": { + "description": "Description related properties of a product system.", + "type": "object", + "properties": { + "descriptionType": { + "description": "Type of description.", + "enum": [ + "Base" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DescriptionType", + "modelAsString": true, + "values": [ + { + "value": "Base", + "description": "Base description." + } + ] + } + }, + "shortDescription": { + "description": "Short description of the product system.", + "type": "string", + "readOnly": true + }, + "longDescription": { + "description": "Long description of the product system.", + "type": "string", + "readOnly": true + }, + "keywords": { + "description": "Keywords for the product system.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "attributes": { + "description": "Attributes for the product system.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "links": { + "description": "Links for the product system.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Link" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "DeviceDetails": { + "description": "Device details.", + "type": "object", + "properties": { + "serialNumber": { + "description": "Device serial number.", + "type": "string", + "readOnly": true + }, + "displaySerialNumber": { + "description": "Device serial number to be displayed.", + "type": "string", + "readOnly": true + }, + "managementResourceId": { + "description": "Management Resource Id.", + "type": "string", + "readOnly": true + }, + "managementResourceTenantId": { + "description": "Management Resource Tenant ID.", + "type": "string", + "readOnly": true + }, + "provisioningSupport": { + "description": "Determining nature of provisioning that the configuration supports.", + "$ref": "#/definitions/ProvisioningSupport", + "readOnly": true + }, + "provisioningDetails": { + "$ref": "#/definitions/ProvisioningDetails", + "description": "Provisioning Details for the device.", + "readOnly": true + } + } + }, + "DevicePresenceVerificationDetails": { + "description": "Proof of possession details.", + "type": "object", + "properties": { + "status": { + "description": "Proof of possession status.", + "$ref": "#/definitions/DevicePresenceVerificationStatus", + "readOnly": true + }, + "message": { + "description": "Insights on current status.", + "type": "string", + "readOnly": true + } + } + }, + "DevicePresenceVerificationStatus": { + "description": "Proof of possession status.", + "enum": [ + "NotInitiated", + "Completed" + ], + "type": "string", + "x-ms-enum": { + "name": "DevicePresenceVerificationStatus", + "modelAsString": true, + "values": [ + { + "value": "NotInitiated", + "description": "The device has not yet been verified to be with the right edge operator or at the right location." + }, + { + "value": "Completed", + "description": "Confirms that the device is verified to be with the right edge operator or at the right location." + } + ] + } + }, + "Dimensions": { + "description": "Dimensions of a configuration.", + "type": "object", + "properties": { + "length": { + "format": "double", + "description": "Length of the device.", + "type": "number", + "readOnly": true + }, + "height": { + "format": "double", + "description": "Height of the device.", + "type": "number", + "readOnly": true + }, + "width": { + "format": "double", + "description": "Width of the device.", + "type": "number", + "readOnly": true + }, + "lengthHeightUnit": { + "description": "Unit for the dimensions of length, height and width.", + "enum": [ + "IN", + "CM" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "LengthHeightUnit", + "modelAsString": true, + "values": [ + { + "value": "IN", + "description": "Inch, applicable for West US." + }, + { + "value": "CM", + "description": "Centimeter." + } + ] + } + }, + "weight": { + "format": "double", + "description": "Weight of the device.", + "type": "number", + "readOnly": true + }, + "depth": { + "format": "double", + "description": "Depth of the device.", + "type": "number", + "readOnly": true + }, + "weightUnit": { + "description": "Unit for the dimensions of weight.", + "enum": [ + "LBS", + "KGS" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "WeightMeasurementUnit", + "modelAsString": true, + "values": [ + { + "value": "LBS", + "description": "Pounds." + }, + { + "value": "KGS", + "description": "Kilograms." + } + ] + } + } + } + }, + "DisplayInfo": { + "description": "Describes product display information.", + "type": "object", + "properties": { + "productFamilyDisplayName": { + "description": "Product family display name.", + "type": "string", + "readOnly": true + }, + "configurationDisplayName": { + "description": "Configuration display name.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionPreferences": { + "description": "Preferences related to the double encryption.", + "type": "object", + "properties": { + "doubleEncryptionStatus": { + "description": "Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DoubleEncryptionStatus", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "Double encryption is disabled." + }, + { + "value": "Enabled", + "description": "Double encryption is enabled." + } + ] + } + } + } + }, + "FilterableProperty": { + "description": "Different types of filters supported and its values.", + "required": [ + "type", + "supportedValues" + ], + "type": "object", + "properties": { + "type": { + "description": "Type of product filter.", + "enum": [ + "ShipToCountries", + "DoubleEncryptionStatus" + ], + "type": "string", + "x-ms-enum": { + "name": "SupportedFilterTypes", + "modelAsString": true, + "values": [ + { + "value": "ShipToCountries", + "description": "Ship to country." + }, + { + "value": "DoubleEncryptionStatus", + "description": "Double encryption status." + } + ] + } + }, + "supportedValues": { + "description": "Values to be filtered.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ForwardShippingDetails": { + "description": "Forward shipment details.", + "type": "object", + "properties": { + "carrierName": { + "description": "Name of the carrier.", + "type": "string", + "readOnly": true + }, + "carrierDisplayName": { + "description": "Carrier Name for display purpose. Not to be used for any processing.", + "type": "string", + "readOnly": true + }, + "trackingId": { + "description": "TrackingId of the package.", + "type": "string", + "readOnly": true + }, + "trackingUrl": { + "description": "TrackingUrl of the package.", + "type": "string", + "readOnly": true + } + } + }, + "GroupedChildConfigurations": { + "description": "Grouped child configuration object.", + "type": "object", + "properties": { + "categoryInformation": { + "$ref": "#/definitions/CategoryInformation", + "description": "Category information.", + "readOnly": true + }, + "childConfigurations": { + "description": "List of child configurations.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ChildConfiguration" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "HierarchyInformation": { + "description": "Holds details about product hierarchy information.", + "type": "object", + "properties": { + "productFamilyName": { + "description": "Represents product family name that uniquely identifies product family.", + "type": "string" + }, + "productLineName": { + "description": "Represents product line name that uniquely identifies product line.", + "type": "string" + }, + "productName": { + "description": "Represents product name that uniquely identifies product.", + "type": "string" + }, + "configurationName": { + "description": "Represents configuration name that uniquely identifies configuration.", + "type": "string" + }, + "configurationIdDisplayName": { + "description": "Represents Model Display Name.", + "type": "string" + } + } + }, + "ImageInformation": { + "description": "Image for the product.", + "type": "object", + "properties": { + "imageType": { + "description": "Type of the image.", + "enum": [ + "MainImage", + "BulletImage", + "GenericImage" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ImageType", + "modelAsString": true, + "values": [ + { + "value": "MainImage", + "description": "Main image." + }, + { + "value": "BulletImage", + "description": "Bullet image." + }, + { + "value": "GenericImage", + "description": "Generic image." + } + ] + } + }, + "imageUrl": { + "description": "Url of the image.", + "type": "string", + "readOnly": true + } + } + }, + "Link": { + "description": "Returns link related to the product.", + "type": "object", + "properties": { + "linkType": { + "description": "Type of link.", + "enum": [ + "Generic", + "TermsAndConditions", + "Specification", + "Documentation", + "KnowMore", + "SignUp", + "Discoverable" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "LinkType", + "modelAsString": true, + "values": [ + { + "value": "Generic", + "description": "Generic link." + }, + { + "value": "TermsAndConditions", + "description": "Terms and conditions link." + }, + { + "value": "Specification", + "description": "Link to product specification." + }, + { + "value": "Documentation", + "description": "Link to product documentation." + }, + { + "value": "KnowMore", + "description": "Link to know more." + }, + { + "value": "SignUp", + "description": "Link to sign up for products." + }, + { + "value": "Discoverable", + "description": "Link to order the product from another source and not from Azure Edge Hardware Center." + } + ] + } + }, + "linkUrl": { + "description": "Url of the link.", + "type": "string", + "readOnly": true + } + } + }, + "ManagementResourcePreferences": { + "description": "Management resource preference to link device.", + "type": "object", + "properties": { + "preferredManagementResourceId": { + "description": "Customer preferred Management resource ARM ID.", + "type": "string" + } + } + }, + "MeterDetails": { + "description": "Holds details about billing type and its meter guids.", + "required": [ + "billingType" + ], + "type": "object", + "properties": { + "billingType": { + "description": "Represents billing type.", + "enum": [ + "Pav2", + "Purchase" + ], + "type": "string", + "x-ms-enum": { + "name": "BillingType", + "modelAsString": true, + "values": [ + { + "value": "Pav2", + "description": "PaV2 billing." + }, + { + "value": "Purchase", + "description": "Purchase billing." + } + ] + } + }, + "multiplier": { + "format": "double", + "description": "Billing unit applicable for Pav2 billing.", + "type": "number", + "readOnly": true + }, + "chargingType": { + "description": "Charging type.", + "enum": [ + "PerOrder", + "PerDevice" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ChargingType", + "modelAsString": true, + "values": [ + { + "value": "PerOrder", + "description": "Per order charging type." + }, + { + "value": "PerDevice", + "description": "Per device charging type." + } + ] + } + } + }, + "discriminator": "billingType" + }, + "NotificationPreference": { + "description": "Notification preference for a job stage.", + "required": [ + "stageName", + "sendNotification" + ], + "type": "object", + "properties": { + "stageName": { + "description": "Name of the stage.", + "enum": [ + "Shipped", + "Delivered" + ], + "type": "string", + "x-ms-enum": { + "name": "NotificationStageName", + "modelAsString": true, + "values": [ + { + "value": "Shipped", + "description": "Notification at order item shipped from microsoft datacenter." + }, + { + "value": "Delivered", + "description": "Notification at order item delivered to customer." + } + ] + } + }, + "sendNotification": { + "description": "Notification is required or not.", + "type": "boolean" + } + } + }, + "OrderItemDetails": { + "description": "Order item details.", + "required": [ + "productDetails", + "orderItemType" + ], + "type": "object", + "properties": { + "productDetails": { + "$ref": "#/definitions/ProductDetails", + "description": "Represents product details." + }, + "orderItemType": { + "description": "Order item type.", + "enum": [ + "Purchase", + "Rental", + "External" + ], + "type": "string", + "x-ms-enum": { + "name": "OrderItemType", + "modelAsString": true, + "values": [ + { + "value": "Purchase", + "description": "Purchase OrderItem." + }, + { + "value": "Rental", + "description": "Rental OrderItem." + }, + { + "value": "External", + "description": "Orders placed outside of azure." + } + ] + } + }, + "orderItemMode": { + "description": "Defines the mode of the Order item.", + "enum": [ + "Default", + "DoNotFulfill" + ], + "type": "string", + "x-ms-enum": { + "name": "OrderMode", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Default Order mode." + }, + { + "value": "DoNotFulfill", + "description": "Mode in which the Order will not be fulfilled." + } + ] + } + }, + "siteDetails": { + "$ref": "#/definitions/SiteDetails", + "description": "Site Related Details." + }, + "currentStage": { + "$ref": "#/definitions/StageDetails", + "description": "Current Order item Status.", + "readOnly": true + }, + "orderItemStageHistory": { + "description": "Order item status history.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/StageDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "preferences": { + "$ref": "#/definitions/Preferences", + "description": "Customer notification Preferences." + }, + "forwardShippingDetails": { + "$ref": "#/definitions/ForwardShippingDetails", + "description": "Forward Package Shipping details.", + "readOnly": true + }, + "reverseShippingDetails": { + "$ref": "#/definitions/ReverseShippingDetails", + "description": "Reverse Package Shipping details.", + "readOnly": true + }, + "notificationEmailList": { + "description": "Additional notification email list.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "cancellationReason": { + "description": "Cancellation reason.", + "type": "string", + "readOnly": true + }, + "cancellationStatus": { + "description": "Describes whether the order item is cancellable or not.", + "enum": [ + "Cancellable", + "CancellableWithFee", + "NotCancellable" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OrderItemCancellationEnum", + "modelAsString": true, + "values": [ + { + "value": "Cancellable", + "description": "Order item can be cancelled without fee." + }, + { + "value": "CancellableWithFee", + "description": "Order item can be cancelled with fee." + }, + { + "value": "NotCancellable", + "description": "Order item not cancellable." + } + ] + } + }, + "deletionStatus": { + "description": "Describes whether the order item is deletable or not.", + "enum": [ + "Allowed", + "NotAllowed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ActionStatusEnum", + "modelAsString": true, + "values": [ + { + "value": "Allowed", + "description": "Allowed flag." + }, + { + "value": "NotAllowed", + "description": "Not Allowed flag." + } + ] + } + }, + "returnReason": { + "description": "Return reason.", + "type": "string", + "readOnly": true + }, + "returnStatus": { + "description": "Describes whether the order item is returnable or not.", + "enum": [ + "Returnable", + "ReturnableWithFee", + "NotReturnable" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OrderItemReturnEnum", + "modelAsString": true, + "values": [ + { + "value": "Returnable", + "description": "Order item can be returned without fee." + }, + { + "value": "ReturnableWithFee", + "description": "Order item can be returned with fee." + }, + { + "value": "NotReturnable", + "description": "Order item not returnable." + } + ] + } + }, + "managementRpDetailsList": { + "description": "List of parent RP details supported for configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "Top level error for the job.", + "readOnly": true + } + } + }, + "OrderItemDetailsUpdateParameter": { + "description": "Order item details Patchable Properties.", + "type": "object", + "properties": { + "productDetails": { + "$ref": "#/definitions/ProductDetailsUpdateParameter", + "description": "Represents product details." + }, + "siteDetails": { + "$ref": "#/definitions/SiteDetails", + "description": "Site Related Details." + } + } + }, + "OrderItemProperties": { + "description": "Represents order item properties.", + "required": [ + "orderItemDetails", + "orderId" + ], + "type": "object", + "properties": { + "orderItemDetails": { + "$ref": "#/definitions/OrderItemDetails", + "description": "Represents order item details." + }, + "addressDetails": { + "$ref": "#/definitions/AddressDetails", + "description": "Represents shipping and return address for order item." + }, + "startTime": { + "format": "date-time", + "description": "Start time of order item.", + "type": "string", + "readOnly": true + }, + "orderId": { + "description": "Id of the order to which order item belongs to.", + "type": "string" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state", + "readOnly": true + } + } + }, + "OrderItemResource": { + "description": "Represents order item resource.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OrderItemProperties", + "description": "Order item properties.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Msi identity of the resource" + } + } + }, + "OrderItemResourceList": { + "description": "List of order items.", + "type": "object", + "properties": { + "value": { + "description": "List of order item resources.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OrderItemResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link for the next set of order item resources.", + "type": "string" + } + } + }, + "OrderItemUpdateParameter": { + "description": "Updates order item parameters.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/OrderItemUpdateProperties", + "description": "Order item update properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Msi identity of the resource" + } + } + }, + "OrderItemUpdateProperties": { + "description": "Order item update properties.", + "type": "object", + "properties": { + "forwardAddress": { + "$ref": "#/definitions/AddressProperties", + "description": "Updates forward shipping address and contact details." + }, + "preferences": { + "$ref": "#/definitions/Preferences", + "description": "Customer preference." + }, + "notificationEmailList": { + "description": "Additional notification email list.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "orderItemDetails": { + "$ref": "#/definitions/OrderItemDetailsUpdateParameter", + "description": "Represents order item details." + } + } + }, + "OrderProperties": { + "description": "Represents order details.", + "type": "object", + "properties": { + "orderItemIds": { + "description": "List of order item ARM Ids which are part of an order.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "currentStage": { + "$ref": "#/definitions/StageDetails", + "description": "Order current status.", + "readOnly": true + }, + "orderStageHistory": { + "description": "Order status history.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/StageDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "orderMode": { + "description": "Order mode.", + "enum": [ + "Default", + "DoNotFulfill" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OrderMode", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Default Order mode." + }, + { + "value": "DoNotFulfill", + "description": "Mode in which the Order will not be fulfilled." + } + ] + } + } + } + }, + "OrderResource": { + "description": "Specifies the properties or parameters for an order. Order is a grouping of one or more order items.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OrderProperties", + "description": "Order properties.", + "x-ms-client-flatten": true + } + } + }, + "OrderResourceList": { + "description": "List of orders.", + "type": "object", + "properties": { + "value": { + "description": "List of order resources.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OrderResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link for the next set of order resources.", + "type": "string" + } + } + }, + "Pav2MeterDetails": { + "description": "Billing type PAV2 meter details.", + "required": [ + "billingType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MeterDetails" + } + ], + "properties": { + "meterGuid": { + "description": "Validation status of requested data center and transport.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "Pav2" + }, + "Preferences": { + "description": "Preferences related to the order.", + "type": "object", + "properties": { + "notificationPreferences": { + "description": "Notification preferences.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/NotificationPreference" + }, + "x-ms-identifiers": [] + }, + "transportPreferences": { + "$ref": "#/definitions/TransportPreferences", + "description": "Preferences related to the shipment logistics of the order." + }, + "encryptionPreferences": { + "$ref": "#/definitions/EncryptionPreferences", + "description": "Preferences related to the Encryption." + }, + "managementResourcePreferences": { + "$ref": "#/definitions/ManagementResourcePreferences", + "description": "Preferences related to the Management resource." + }, + "termCommitmentPreferences": { + "$ref": "#/definitions/TermCommitmentPreferences", + "description": "Preferences related to the Term commitment." + } + } + }, + "Product": { + "description": "Represents a product.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ProductProperties", + "description": "Properties of product.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ProductDetails": { + "description": "Represents product details.", + "required": [ + "hierarchyInformation" + ], + "type": "object", + "properties": { + "displayInfo": { + "$ref": "#/definitions/DisplayInfo", + "description": "Display details of the product." + }, + "hierarchyInformation": { + "$ref": "#/definitions/HierarchyInformation", + "description": "Hierarchy of the product which uniquely identifies the product." + }, + "productDoubleEncryptionStatus": { + "description": "Double encryption status of the configuration. Read-only field.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DoubleEncryptionStatus", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "Double encryption is disabled." + }, + { + "value": "Enabled", + "description": "Double encryption is enabled." + } + ] + } + }, + "identificationType": { + "description": "Identification type of the configuration.", + "enum": [ + "NotSupported", + "SerialNumber" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IdentificationType", + "modelAsString": true, + "values": [ + { + "value": "NotSupported", + "description": "Product does not have any explicit identifier." + }, + { + "value": "SerialNumber", + "description": "Product is identifiable by serial number." + } + ] + } + }, + "parentDeviceDetails": { + "$ref": "#/definitions/DeviceDetails", + "description": "Device details of the parent configuration.", + "readOnly": true + }, + "parentProvisioningDetails": { + "$ref": "#/definitions/ProvisioningDetails", + "description": "Device Provisioning Details for Parent." + }, + "optInAdditionalConfigurations": { + "description": "List of additional configurations customer wants in the order item apart from the ones included in the base configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalConfiguration" + }, + "x-ms-identifiers": [] + }, + "childConfigurationDeviceDetails": { + "description": "Details of all child configurations that are part of the order item.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationDeviceDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "termCommitmentInformation": { + "description": "Term Commitment Information of the Device.", + "$ref": "#/definitions/TermCommitmentInformation", + "readOnly": true + } + } + }, + "ProductDetailsUpdateParameter": { + "description": "Represents product details patchable properties.", + "type": "object", + "properties": { + "parentProvisioningDetails": { + "$ref": "#/definitions/ProvisioningDetails", + "description": "Device Provisioning Details for Parent." + } + } + }, + "ProvisioningDetails": { + "description": "Details Related To Provision Resource.", + "type": "object", + "properties": { + "quantity": { + "format": "int32", + "description": "Quantity of the devices.", + "type": "integer", + "minimum": 0, + "default": 0 + }, + "provisioningArmId": { + "description": "Provisioning Resource Arm ID.", + "type": "string", + "format": "arm-id" + }, + "provisioningEndPoint": { + "description": "Provisioning End Point.", + "type": "string" + }, + "serialNumber": { + "description": "Serial Number for the Device.", + "type": "string" + }, + "vendorName": { + "description": "Vendor Name for the Device , (for 1P devices - Microsoft).", + "type": "string" + }, + "readyToConnectArmId": { + "description": "Arc Enabled Resource Arm id.", + "type": "string", + "format": "arm-id" + }, + "managementResourceArmId": { + "description": "Management Resource ArmId.", + "type": "string", + "format": "arm-id" + }, + "uniqueDeviceIdentifier": { + "description": "Unique Identity for a Device.", + "type": "string", + "readOnly": true + }, + "autoProvisioningStatus": { + "description": "Auto Provisioning Details.", + "$ref": "#/definitions/AutoProvisioningStatus" + }, + "devicePresenceVerification": { + "description": "Proof of possession details.", + "$ref": "#/definitions/DevicePresenceVerificationDetails" + } + } + }, + "SiteDetails": { + "description": "Represents Site Related Details.", + "required": [ + "siteId" + ], + "type": "object", + "properties": { + "siteId": { + "description": "Unique Id, Identifying A Site.", + "type": "string" + } + } + }, + "ProductFamilies": { + "description": "The list of product families.", + "type": "object", + "properties": { + "value": { + "description": "List of product families.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ProductFamily" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link for the next set of product families.", + "type": "string" + } + } + }, + "ProductFamiliesMetadata": { + "description": "Holds details about product family metadata.", + "type": "object", + "properties": { + "value": { + "description": "List of product family metadata details.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ProductFamiliesMetadataDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link for the next set of product families.", + "type": "string", + "readOnly": true + } + } + }, + "ProductFamiliesMetadataDetails": { + "description": "Product families metadata details.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ProductFamilyProperties", + "description": "Product family properties.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ProductFamiliesRequest": { + "description": "The filters for showing the product families.", + "required": [ + "filterableProperties" + ], + "type": "object", + "properties": { + "filterableProperties": { + "description": "Dictionary of filterable properties on product family.", + "type": "object", + "additionalProperties": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/FilterableProperty" + }, + "x-ms-identifiers": [] + } + }, + "customerSubscriptionDetails": { + "$ref": "#/definitions/CustomerSubscriptionDetails", + "description": "Customer subscription properties. Clients can display available products to unregistered customers by explicitly passing subscription details." + } + } + }, + "ProductFamily": { + "description": "Product Family.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ProductFamilyProperties", + "description": "Properties of product family.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ProductFamilyProperties": { + "description": "Properties of product family.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonProperties" + } + ], + "properties": { + "productLines": { + "description": "List of product lines supported in the product family.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ProductLine" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "resourceProviderDetails": { + "description": "Contains details related to resource provider.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderDetails" + }, + "x-ms-identifiers": [] + } + } + }, + "ProductLine": { + "description": "Product line.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ProductLineProperties", + "description": "Properties of product line.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ProductLineProperties": { + "description": "Properties of product line.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonProperties" + } + ], + "properties": { + "products": { + "description": "List of products in the product line.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Product" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ProductProperties": { + "description": "Properties of product.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonProperties" + } + ], + "properties": { + "configurations": { + "description": "List of configurations for the product.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ProvisioningState": { + "description": "Provisioning state", + "type": "string", + "enum": [ + "Creating", + "Succeeded", + "Failed", + "Canceled" + ], + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating", + "description": "Creating state." + }, + { + "value": "Succeeded", + "description": "Succeeded state." + }, + { + "value": "Failed", + "description": "Failed state." + }, + { + "value": "Canceled", + "description": "Canceled state." + } + ] + } + }, + "ProvisioningSupport": { + "description": "Determining nature of provisioning that the configuration supports.", + "enum": [ + "CloudBased", + "Manual" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningSupport", + "modelAsString": true, + "values": [ + { + "value": "CloudBased", + "description": "The configuration can be provisioned from the cloud." + }, + { + "value": "Manual", + "description": "The configuration need to be provisioned manually by the end user." + } + ] + } + }, + "PurchaseMeterDetails": { + "description": "Billing type Purchase meter details.", + "required": [ + "billingType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MeterDetails" + } + ], + "properties": { + "productId": { + "description": "Product Id.", + "type": "string", + "readOnly": true + }, + "skuId": { + "description": "Sku Id.", + "type": "string", + "readOnly": true + }, + "termId": { + "description": "Term Id.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "Purchase" + }, + "ResourceIdentity": { + "description": "Msi identity details of the resource", + "type": "object", + "properties": { + "type": { + "description": "Identity type", + "type": "string", + "default": "None" + }, + "principalId": { + "description": "Service Principal Id backing the Msi", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Home Tenant Id", + "type": "string", + "readOnly": true + }, + "userAssignedIdentities": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentities", + "description": "User Assigned Identities" + } + } + }, + "ResourceMoveRequest": { + "description": "Resource move request body.", + "type": "object", + "properties": { + "targetResourceGroup": { + "type": "string" + }, + "resources": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ResourceProviderDetails": { + "description": "Management RP details.", + "type": "object", + "properties": { + "resourceProviderNamespace": { + "description": "Resource provider namespace.", + "type": "string", + "readOnly": true + } + } + }, + "ReturnOrderItemDetails": { + "description": "Return order item request body.", + "required": [ + "returnReason" + ], + "type": "object", + "properties": { + "returnAddress": { + "$ref": "#/definitions/AddressProperties", + "description": "Customer return address." + }, + "returnReason": { + "description": "Return Reason.", + "type": "string" + }, + "serviceTag": { + "description": "Service tag (located on the bottom-right corner of the device).", + "type": "string" + }, + "shippingBoxRequired": { + "description": "Shipping Box required.", + "default": false, + "type": "boolean" + } + } + }, + "ReverseShippingDetails": { + "description": "Reverse shipment details.", + "type": "object", + "properties": { + "sasKeyForLabel": { + "description": "SAS key to download the reverse shipment label of the package.", + "type": "string", + "readOnly": true + }, + "carrierName": { + "description": "Name of the carrier.", + "type": "string", + "readOnly": true + }, + "carrierDisplayName": { + "description": "Carrier Name for display purpose. Not to be used for any processing.", + "type": "string", + "readOnly": true + }, + "trackingId": { + "description": "TrackingId of the package.", + "type": "string", + "readOnly": true + }, + "trackingUrl": { + "description": "TrackingUrl of the package.", + "type": "string", + "readOnly": true + } + } + }, + "ShippingAddress": { + "description": "Shipping address where customer wishes to receive the device.", + "required": [ + "country" + ], + "type": "object", + "properties": { + "streetAddress1": { + "description": "Street Address line 1.", + "type": "string" + }, + "streetAddress2": { + "description": "Street Address line 2.", + "type": "string" + }, + "streetAddress3": { + "description": "Street Address line 3.", + "type": "string" + }, + "city": { + "description": "Name of the City.", + "type": "string" + }, + "stateOrProvince": { + "description": "Name of the State or Province.", + "type": "string" + }, + "country": { + "description": "Name of the Country.", + "type": "string" + }, + "postalCode": { + "description": "Postal code.", + "type": "string" + }, + "zipExtendedCode": { + "description": "Extended Zip Code.", + "type": "string" + }, + "companyName": { + "description": "Name of the company.", + "type": "string" + }, + "addressType": { + "description": "Type of address.", + "enum": [ + "None", + "Residential", + "Commercial" + ], + "type": "string", + "x-ms-enum": { + "name": "AddressType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Address type not known." + }, + { + "value": "Residential", + "description": "Residential Address." + }, + { + "value": "Commercial", + "description": "Commercial Address." + } + ] + } + } + } + }, + "Specification": { + "description": "Specification of the configurations.", + "type": "object", + "properties": { + "name": { + "description": "Name of the specification.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Value of the specification.", + "type": "string", + "readOnly": true + } + } + }, + "StageDetails": { + "description": "Resource stage details.", + "type": "object", + "properties": { + "stageStatus": { + "description": "Stage status.", + "enum": [ + "None", + "InProgress", + "Succeeded", + "Failed", + "Cancelled", + "Cancelling" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageStatus", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No status available yet." + }, + { + "value": "InProgress", + "description": "Stage is in progress." + }, + { + "value": "Succeeded", + "description": "Stage has succeeded." + }, + { + "value": "Failed", + "description": "Stage has failed." + }, + { + "value": "Cancelled", + "description": "Stage has been cancelled." + }, + { + "value": "Cancelling", + "description": "Stage is cancelling." + } + ] + } + }, + "stageName": { + "description": "Stage name.", + "enum": [ + "Placed", + "InReview", + "Confirmed", + "ReadyToShip", + "Shipped", + "Delivered", + "ReadyToSetup", + "InUse", + "ReturnInitiated", + "ReturnPickedUp", + "ReturnedToMicrosoft", + "ReturnCompleted", + "Cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageName", + "modelAsString": true, + "values": [ + { + "value": "Placed", + "description": "Currently in draft mode and can still be cancelled." + }, + { + "value": "InReview", + "description": "Order is currently in draft mode and can still be cancelled." + }, + { + "value": "Confirmed", + "description": "Order is confirmed." + }, + { + "value": "ReadyToShip", + "description": "Order is ready to ship." + }, + { + "value": "Shipped", + "description": "Order is in transit to customer." + }, + { + "value": "Delivered", + "description": "Order is delivered to customer." + }, + { + "value": "ReadyToSetup", + "description": "Order is ready to get cloud connected." + }, + { + "value": "InUse", + "description": "Order is in use at customer site." + }, + { + "value": "ReturnInitiated", + "description": "Return has been initiated by customer." + }, + { + "value": "ReturnPickedUp", + "description": "Order is in transit from customer to Microsoft." + }, + { + "value": "ReturnedToMicrosoft", + "description": "Order has been received back to Microsoft." + }, + { + "value": "ReturnCompleted", + "description": "Return has now completed." + }, + { + "value": "Cancelled", + "description": "Order has been cancelled." + } + ] + } + }, + "displayName": { + "description": "Display name of the resource stage.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Stage start time.", + "type": "string", + "readOnly": true + } + } + }, + "TermCommitmentInformation": { + "description": "Term Commitment Information.", + "required": [ + "termCommitmentType" + ], + "type": "object", + "properties": { + "termCommitmentType": { + "description": "Term Commitment Type", + "$ref": "#/definitions/TermCommitmentType" + }, + "termCommitmentTypeDuration": { + "description": "Term Commitment Duration. Currently Supporting P365D, P1095D", + "type": "string", + "format": "duration", + "readOnly": true + }, + "pendingDaysForTerm": { + "format": "int32", + "description": "Number of Days Pending for Term Commitment", + "type": "integer", + "minimum": 0, + "default": 0, + "readOnly": true + } + } + }, + "TermCommitmentPreferences": { + "description": "Term Commitment preference received from customer.", + "required": [ + "preferredTermCommitmentType" + ], + "type": "object", + "properties": { + "preferredTermCommitmentType": { + "description": "Term Commitment Type", + "$ref": "#/definitions/TermCommitmentType" + }, + "preferredTermCommitmentDuration": { + "description": "Customer preferred Term Duration.", + "type": "string", + "format": "duration" + } + } + }, + "TermCommitmentType": { + "description": "Term Commitment Type", + "enum": [ + "None", + "Trial", + "Timed" + ], + "type": "string", + "x-ms-enum": { + "name": "TermCommitmentType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Pay as you go Term Commitment Model." + }, + { + "value": "Trial", + "description": "Trial Term Commitment Model." + }, + { + "value": "Timed", + "description": "Time based Term Commitment Model." + } + ] + } + }, + "TermTypeDetails": { + "description": "Holds details about term type and duration.", + "required": [ + "termType", + "termTypeDuration" + ], + "type": "object", + "properties": { + "termType": { + "description": "Term Commitment Type", + "$ref": "#/definitions/TermCommitmentType" + }, + "termTypeDuration": { + "description": "Duration for the term type.", + "type": "string", + "format": "duration" + } + } + }, + "TransportPreferences": { + "description": "Preferences related to the shipment logistics of the sku.", + "required": [ + "preferredShipmentType" + ], + "type": "object", + "properties": { + "preferredShipmentType": { + "description": "Indicates Shipment Logistics type that the customer preferred.", + "enum": [ + "CustomerManaged", + "MicrosoftManaged" + ], + "type": "string", + "x-ms-enum": { + "name": "TransportShipmentTypes", + "modelAsString": true, + "values": [ + { + "value": "CustomerManaged", + "description": "Shipment Logistics is handled by the customer." + }, + { + "value": "MicrosoftManaged", + "description": "Shipment Logistics is handled by Microsoft." + } + ] + } + } + } + } + }, + "parameters": { + "addressNameParameter": { + "name": "addressName", + "in": "path", + "description": "The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.", + "required": true, + "type": "string", + "maxLength": 24, + "minLength": 3, + "pattern": "^[-\\w\\.]+$", + "x-ms-parameter-location": "method" + }, + "orderItemNameParameter": { + "name": "orderItemName", + "in": "path", + "description": "The name of the order item.", + "required": true, + "type": "string", + "maxLength": 63, + "minLength": 3, + "pattern": "^[A-Za-z0-9][-A-Za-z0-9]*[A-Za-z0-9]$|^[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + }, + "orderNameParameter": { + "name": "orderName", + "in": "path", + "description": "The name of the order.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "tags": [] +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/CancelOrderItem.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/CancelOrderItem.json new file mode 100644 index 000000000000..6761c0b8baf9 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/CancelOrderItem.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "orderItemName": "TestOrderItemName3", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3/cancel?api-version=2024-02-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "34" + ], + "cancellationReason": { + "reason": "Order cancelled" + } + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/CreateAddress.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/CreateAddress.json new file mode 100644 index 000000000000..81b9d5ef544f --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/CreateAddress.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "addressName": "TestAddressName2", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2?api-version=2024-02-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "527" + ], + "addressResource": { + "properties": { + "addressClassification": "Shipping", + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "addressClassification": "Shipping", + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestAddressName2", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", + "type": "Microsoft.EdgeOrder/addresses" + } + }, + "202": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/CreateOrderItem.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/CreateOrderItem.json new file mode 100644 index 000000000000..93c6bd6c6841 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/CreateOrderItem.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "orderItemName": "TestOrderItemName2", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2?api-version=2024-02-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1228" + ], + "orderItemResource": { + "properties": { + "orderItemDetails": { + "orderItemType": "Purchase", + "productDetails": { + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + } + }, + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + } + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + } + } + }, + "orderId": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "InProgress", + "stageName": "Placed", + "startTime": "2022-03-04T10:58:27.5824859+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "None", + "stageName": "Placed" + }, + { + "stageStatus": "None", + "stageName": "Confirmed" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "Cancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T10:58:27.5824859+05:30", + "orderId": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName2", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2", + "type": "Microsoft.EdgeOrder/orderItems" + } + }, + "202": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/DeleteAddressByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/DeleteAddressByName.json new file mode 100644 index 000000000000..59aa051a3541 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/DeleteAddressByName.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "addressName": "TestAddressName1", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1?api-version=2024-02-01" + ] + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/locations/westus/operationResults/operationid?api-version=2024-02-01" + } + }, + "204": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/DeleteOrderItemByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/DeleteOrderItemByName.json new file mode 100644 index 000000000000..b61608e59dff --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/DeleteOrderItemByName.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "orderItemName": "TestOrderItemName3", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3?api-version=2024-02-01" + ] + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/locations/westus/operationResults/operationid?api-version=2024-02-01" + } + }, + "204": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/GetAddressByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/GetAddressByName.json new file mode 100644 index 000000000000..0ec3f5feefc3 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/GetAddressByName.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "addressName": "TestAddressName1", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1?api-version=2024-02-01" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "addressClassification": "Shipping", + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestAddressName1", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1", + "type": "Microsoft.EdgeOrder/addresses" + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/GetOrderByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/GetOrderByName.json new file mode 100644 index 000000000000..307b75a32d46 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/GetOrderByName.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "location": "eastus", + "orderName": "TestOrderName3", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3?api-version=2024-02-01" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "orderItemIds": [ + "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3" + ], + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "InReview", + "startTime": "2022-03-04T11:35:20.8521455+05:30" + }, + "orderStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T11:30:30.2717243+05:30" + }, + { + "stageStatus": "Succeeded", + "stageName": "InReview", + "startTime": "2022-03-04T11:35:20.8521455+05:30" + } + ] + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "name": "TestOrderName3", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3", + "type": "Microsoft.EdgeOrder/orders" + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/GetOrderItemByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/GetOrderItemByName.json new file mode 100644 index 000000000000..469d8cd121f0 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/GetOrderItemByName.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "orderItemName": "TestOrderItemName1", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1?api-version=2024-02-01" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:05:00.3575338+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:54.3427968+05:30" + }, + { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:05:00.3575338+05:30" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "NotCancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T10:55:10.2820482+05:30", + "orderId": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName1", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1", + "type": "Microsoft.EdgeOrder/orderItems" + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListAddressesAtResourceGroupLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListAddressesAtResourceGroupLevel.json new file mode 100644 index 000000000000..307e2792055a --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListAddressesAtResourceGroupLevel.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses?api-version=2024-02-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "addressClassification": "Shipping", + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestAddressName1", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1", + "type": "Microsoft.EdgeOrder/addresses" + }, + { + "properties": { + "addressClassification": "Shipping", + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "YYYY YYYY", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "TestAddressName2", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", + "type": "Microsoft.EdgeOrder/addresses" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListAddressesAtSubscriptionLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListAddressesAtSubscriptionLevel.json new file mode 100644 index 000000000000..5aaee907c09b --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListAddressesAtSubscriptionLevel.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/addresses?api-version=2024-02-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "addressClassification": "Shipping", + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestAddressName1", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1", + "type": "Microsoft.EdgeOrder/addresses" + }, + { + "properties": { + "addressClassification": "Shipping", + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestAddressName2", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", + "type": "Microsoft.EdgeOrder/addresses" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListConfigurations.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListConfigurations.json new file mode 100644 index 000000000000..b5646eee0b02 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListConfigurations.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/listConfigurations?api-version=2024-02-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "360" + ], + "configurationsRequest": { + "configurationFilter": { + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu" + }, + "filterableProperty": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "specifications": [ + { + "name": "Usable compute", + "value": "40 vCPU" + }, + { + "name": "Usable memory", + "value": "102 GB" + }, + { + "name": "Usable storage", + "value": "4.2 TB" + } + ], + "dimensions": { + "length": 50, + "height": 15, + "width": 5, + "lengthHeightUnit": "IN", + "weight": 50, + "depth": 2, + "weightUnit": "LBS" + }, + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + } + ], + "displayName": "Azure Stack Edge Pro - 1 GPU", + "description": { + "descriptionType": "Base", + "shortDescription": "", + "longDescription": "", + "keywords": [ + "GPU" + ], + "attributes": [], + "links": [] + }, + "imageInformation": [], + "costInformation": { + "billingMeterDetails": [] + }, + "availabilityInformation": { + "availabilityStage": "Available", + "disabledReason": "None" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + } + } + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOperations.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOperations.json new file mode 100644 index 000000000000..28e6cce7663c --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOperations.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/providers/Microsoft.EdgeOrder/operations?api-version=2024-02-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.EdgeOrder/addresses/read", + "display": { + "provider": "Edge Ordering", + "resource": "Addresses", + "operation": "List or Get Addresses", + "description": "List or get the Addresses" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/addresses/delete", + "display": { + "provider": "Edge Ordering", + "resource": "Addresses", + "operation": "Delete Addresses", + "description": "Delete the Addresses" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/addresses/write", + "display": { + "provider": "Edge Ordering", + "resource": "Addresses", + "operation": "Create or Update Addresses", + "description": "Create or update the Addresses" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/locations/operationResults/read", + "display": { + "provider": "Edge Ordering", + "resource": "Operation Results", + "operation": "List or Get Operation Results", + "description": "List or get the Operation Results" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/operations/read", + "display": { + "provider": "Edge Ordering", + "resource": "Operations", + "operation": "List or Get Operations", + "description": "List or get the Operations" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/locations/orders/read", + "display": { + "provider": "Edge Ordering", + "resource": "Order", + "operation": "List or Get Order", + "description": "List or get the Order" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/orders/read", + "display": { + "provider": "Edge Ordering", + "resource": "Order", + "operation": "List or Get Order", + "description": "List or get the Order" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/orderItems/cancel/action", + "display": { + "provider": "Edge Ordering", + "resource": "OrderItem", + "operation": "Cancel OrderItem", + "description": "Cancels an OrderItem in progress." + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/orderItems/return/action", + "display": { + "provider": "Edge Ordering", + "resource": "OrderItem", + "operation": "Return OrderItem", + "description": "Return an OrderItem." + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/orderItems/read", + "display": { + "provider": "Edge Ordering", + "resource": "OrderItem", + "operation": "List or Get OrderItem", + "description": "List or get the OrderItem" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/orderItems/delete", + "display": { + "provider": "Edge Ordering", + "resource": "OrderItem", + "operation": "Delete OrderItem", + "description": "Delete the OrderItem" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/orderItems/write", + "display": { + "provider": "Edge Ordering", + "resource": "OrderItem", + "operation": "Create or Update OrderItem", + "description": "Create or update the OrderItem" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/productFamiliesMetadata/action", + "display": { + "provider": "Edge Ordering", + "resource": "ArmApiRes_Microsoft.EdgeOrder", + "operation": "List or Get product families metadata", + "description": "This method lists or gets the product families metadata." + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/listProductFamilies/read", + "display": { + "provider": "Edge Ordering", + "resource": "ArmApiRes_Microsoft.EdgeOrder", + "operation": "List Product Families", + "description": "This method returns list of product families." + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/listConfigurations/action", + "display": { + "provider": "Edge Ordering", + "resource": "ArmApiRes_Microsoft.EdgeOrder", + "operation": "List Product Configurations", + "description": "This method returns list of product configurations." + }, + "origin": "user", + "isDataAction": false + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderAtResourceGroupLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderAtResourceGroupLevel.json new file mode 100644 index 000000000000..aab51073231f --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderAtResourceGroupLevel.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orders?api-version=2024-02-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "orderItemIds": [ + "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1" + ], + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:46.9437439+05:30" + }, + "orderStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:46.9437439+05:30" + }, + { + "stageStatus": "None", + "stageName": "InReview" + } + ] + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "name": "TestOrderItemName1", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1", + "type": "Microsoft.EdgeOrder/orders" + }, + { + "properties": { + "orderItemIds": [ + "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2" + ], + "currentStage": { + "stageStatus": "InProgress", + "stageName": "Placed", + "startTime": "2022-03-04T10:58:46.5241979+05:30" + }, + "orderStageHistory": [ + { + "stageStatus": "None", + "stageName": "Placed" + }, + { + "stageStatus": "None", + "stageName": "InReview" + } + ] + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "name": "TestOrderItemName2", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2", + "type": "Microsoft.EdgeOrder/orders" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderAtSubscriptionLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderAtSubscriptionLevel.json new file mode 100644 index 000000000000..bcb3dda93296 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderAtSubscriptionLevel.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/orders?api-version=2024-02-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "orderItemIds": [ + "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1" + ], + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:46.9437439+05:30" + }, + "orderStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:46.9437439+05:30" + }, + { + "stageStatus": "None", + "stageName": "InReview" + } + ] + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "name": "TestOrderItemName1", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1", + "type": "Microsoft.EdgeOrder/orders" + }, + { + "properties": { + "orderItemIds": [ + "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2" + ], + "currentStage": { + "stageStatus": "InProgress", + "stageName": "Placed", + "startTime": "2022-03-04T10:58:46.5241979+05:30" + }, + "orderStageHistory": [ + { + "stageStatus": "None", + "stageName": "Placed" + }, + { + "stageStatus": "None", + "stageName": "InReview" + } + ] + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "name": "TestOrderItemName2", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2", + "type": "Microsoft.EdgeOrder/orders" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderItemsAtResourceGroupLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderItemsAtResourceGroupLevel.json new file mode 100644 index 000000000000..a30b0f67dd05 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderItemsAtResourceGroupLevel.json @@ -0,0 +1,223 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems?api-version=2024-02-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:05:00.3575338+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:54.3427968+05:30" + }, + { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:05:00.3575338+05:30" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "NotCancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T10:55:10.2820482+05:30", + "orderId": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName1", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1", + "type": "Microsoft.EdgeOrder/orderItems" + }, + { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:07:29.9896685+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:59:04.9701334+05:30" + }, + { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:07:29.9896685+05:30" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "NotCancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T10:58:27.5824859+05:30", + "orderId": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName2", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2", + "type": "Microsoft.EdgeOrder/orderItems" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderItemsAtSubscriptionLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderItemsAtSubscriptionLevel.json new file mode 100644 index 000000000000..b349ea91bccd --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListOrderItemsAtSubscriptionLevel.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/orderItems?api-version=2024-02-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:05:00.3575338+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:54.3427968+05:30" + }, + { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:05:00.3575338+05:30" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "NotCancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T10:55:10.2820482+05:30", + "orderId": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName1", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1", + "type": "Microsoft.EdgeOrder/orderItems" + }, + { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:07:29.9896685+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:59:04.9701334+05:30" + }, + { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:07:29.9896685+05:30" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "NotCancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T10:58:27.5824859+05:30", + "orderId": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName2", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2", + "type": "Microsoft.EdgeOrder/orderItems" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListProductFamilies.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListProductFamilies.json new file mode 100644 index 000000000000..126e01f23105 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListProductFamilies.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "api-version": "2024-02-01", + "$expand": "configurations", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/listProductFamilies?api-version=2024-02-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "159" + ], + "productFamiliesRequest": { + "filterableProperties": { + "azurestackedge": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "productLines": [ + { + "properties": { + "products": [ + { + "properties": { + "configurations": [ + { + "properties": { + "specifications": [ + { + "name": "Usable compute", + "value": "40 vCPU" + }, + { + "name": "Usable memory", + "value": "102 GB" + }, + { + "name": "Usable storage", + "value": "4.2 TB" + } + ], + "dimensions": { + "length": 50, + "height": 15, + "width": 5, + "lengthHeightUnit": "IN", + "weight": 50, + "depth": 2, + "weightUnit": "LBS" + }, + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + } + ], + "displayName": "Azure Stack Edge Pro - 1 GPU", + "description": { + "descriptionType": "Base", + "shortDescription": "", + "longDescription": "", + "keywords": [ + "GPU" + ], + "attributes": [], + "links": [] + }, + "imageInformation": [], + "costInformation": { + "billingMeterDetails": [] + }, + "availabilityInformation": { + "availabilityStage": "Available", + "disabledReason": "None" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + } + } + } + ], + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + } + ], + "displayName": "Azure Stack Edge Pro - GPU", + "description": { + "descriptionType": "Base", + "shortDescription": "Azure managed physical edge compute device", + "longDescription": "Azure Stack Edge Pro is an AI-enabled edge computing device with network data transfer capabilities. The device is powered with NVIDIA T4 GPUs to provide accelerated AI inferencing at the edge. You can choose from the following configurations based upon your business need", + "keywords": [ + "GPU" + ], + "attributes": [ + "1U rack mount device with network data transfer capabilities", + "Hardware accelerated ML using Nvidia T4 GPU", + "Azure Private Edge Zones enabled" + ], + "links": [ + { + "linkType": "Specification", + "linkUrl": "https://aka.ms/edgeHWcenter-asepro-devicespec" + }, + { + "linkType": "Generic", + "linkUrl": "https://aka.ms/ase-gpu-billing" + }, + { + "linkType": "TermsAndConditions", + "linkUrl": "https://aka.ms/ase-gpu-product-terms" + }, + { + "linkType": "KnowMore", + "linkUrl": "https://aka.ms/edgeHWcenter-asepro-documentation" + } + ] + }, + "imageInformation": [], + "availabilityInformation": { + "availabilityStage": "Available", + "disabledReason": "None" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "" + } + } + } + ], + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + }, + { + "type": "DoubleEncryptionStatus", + "supportedValues": [ + "Enabled" + ] + } + ], + "displayName": "Azure Stack Edge", + "description": { + "descriptionType": "Base", + "keywords": [], + "attributes": [], + "links": [] + }, + "imageInformation": [], + "availabilityInformation": { + "availabilityStage": "Available", + "disabledReason": "None" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "", + "configurationName": "" + } + } + } + ], + "resourceProviderDetails": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ], + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + }, + { + "type": "DoubleEncryptionStatus", + "supportedValues": [ + "Enabled" + ] + } + ], + "displayName": "Azure Stack Edge", + "description": { + "descriptionType": "Base", + "shortDescription": "Azure managed physical edge compute device", + "keywords": [], + "attributes": [], + "links": [] + }, + "imageInformation": [], + "availabilityInformation": { + "availabilityStage": "Available", + "disabledReason": "None" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "", + "productName": "", + "configurationName": "" + } + } + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListProductFamiliesMetadata.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListProductFamiliesMetadata.json new file mode 100644 index 000000000000..d952885aba78 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ListProductFamiliesMetadata.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/productFamiliesMetadata?api-version=2024-02-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "productLines": [], + "resourceProviderDetails": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ], + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + }, + { + "type": "DoubleEncryptionStatus", + "supportedValues": [ + "Enabled" + ] + } + ], + "displayName": "Azure Stack Edge", + "description": { + "descriptionType": "Base", + "shortDescription": "Azure managed physical edge compute device", + "keywords": [], + "attributes": [], + "links": [] + }, + "imageInformation": [], + "availabilityInformation": { + "availabilityStage": "Available", + "disabledReason": "None" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "", + "productName": "", + "configurationName": "" + } + } + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ReturnOrderItem.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ReturnOrderItem.json new file mode 100644 index 000000000000..b7a9aa6115d7 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/ReturnOrderItem.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "orderItemName": "TestOrderName4", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName4/return?api-version=2024-02-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "39" + ], + "returnOrderItemDetails": { + "returnReason": "Order returned" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/locations/westus/operationResults/operationid?api-version=2024-02-01" + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/UpdateAddress.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/UpdateAddress.json new file mode 100644 index 000000000000..ce63500cbb40 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/UpdateAddress.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "addressName": "TestAddressName2", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2?api-version=2024-02-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "517" + ], + "addressUpdateParameter": { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "YYYY YYYY", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "YYYY YYYY", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "TestAddressName2", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", + "type": "Microsoft.EdgeOrder/addresses" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/locations/westus/operationResults/operationid?api-version=2024-02-01" + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/UpdateOrderItem.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/UpdateOrderItem.json new file mode 100644 index 000000000000..a49c684311d6 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/examples/UpdateOrderItem.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "subscriptionId": "eb5dc900-6186-49d8-b7d7-febd866fdc1d", + "resourceGroupName": "YourResourceGroupName", + "orderItemName": "TestOrderItemName3", + "api-version": "2024-02-01", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3?api-version=2024-02-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "175" + ], + "orderItemUpdateParameter": { + "properties": { + "preferences": { + "transportPreferences": { + "preferredShipmentType": "CustomerManaged" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T11:30:31.5838042+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T11:30:31.5838042+05:30" + }, + { + "stageStatus": "None", + "stageName": "Confirmed" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "CustomerManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "Cancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T11:29:47.3483197+05:30", + "orderId": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName3", + "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3", + "type": "Microsoft.EdgeOrder/orderItems" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/locations/westus/operationResults/operationid?api-version=2024-02-01" + } + } + } +} diff --git a/specification/edgeorder/resource-manager/readme.md b/specification/edgeorder/resource-manager/readme.md index 1faf90147d9b..68ca38d236ae 100644 --- a/specification/edgeorder/resource-manager/readme.md +++ b/specification/edgeorder/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for EdgeOrder. - - --- + ## Getting Started + To build the SDK for EdgeOrder, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,22 +15,31 @@ To build the SDK for EdgeOrder, 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 EdgeOrder API. ``` yaml title: EdgeOrderManagementClient description: Edge Order API's openapi-type: arm -tag: package-2022-05-preview +tag: package-2024-02 ``` + +### Tag: package-2024-02 + +These settings apply only when `--tag=package-2024-02` is specified on the command line. + +```yaml $(tag) == 'package-2024-02' +input-file: + - Microsoft.EdgeOrder/stable/2024-02-01/edgeorder.json +``` ### Tag: package-2022-05-preview These settings apply only when `--tag=package-2022-05-preview` is specified on the command line. @@ -39,6 +48,7 @@ These settings apply only when `--tag=package-2022-05-preview` is specified on t input-file: - Microsoft.EdgeOrder/preview/2022-05-01-preview/edgeorder.json ``` + --- ### Tag: package-2021-12 @@ -49,6 +59,7 @@ These settings apply only when `--tag=package-2021-12` is specified on the comma input-file: - Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json ``` + --- ### Tag: package-2020-12-preview @@ -59,11 +70,11 @@ These settings apply only when `--tag=package-2020-12-preview` is specified on t input-file: - Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json ``` + --- # Code Generation - ## Swagger to SDK This section describes what SDK should be generated by the automatic system. @@ -97,4 +108,4 @@ See configuration in [readme.python.md](./readme.python.md) ## Go -See configuration in [readme.go.md](./readme.go.md) \ No newline at end of file +See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/elastic.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/elastic.json new file mode 100644 index 000000000000..8e32224b2340 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/elastic.json @@ -0,0 +1,3147 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Elastic", + "version": "2024-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Microsoft Entra ID OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Elastic/operations": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all operations provided by Microsoft.Elastic.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified subscription.", + "operationId": "Monitors_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_List": { + "$ref": "./examples/Monitors_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/elasticVersions": { + "get": { + "tags": [ + "ElasticVersions" + ], + "summary": "Get a list of available versions for a region.", + "operationId": "ElasticVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "query", + "name": "region", + "description": "Region where elastic deployment will take place.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticVersionsListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ElasticVersions_List": { + "$ref": "./examples/ElasticVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified resource group.", + "operationId": "Monitors_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListByResourceGroup": { + "$ref": "./examples/Monitors_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "Get the properties of a specific monitor resource.", + "operationId": "Monitors_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Get": { + "$ref": "./examples/Monitors_Get.json" + } + } + }, + "put": { + "tags": [ + "MonitorsResource" + ], + "summary": "Create a monitor resource.", + "operationId": "Monitors_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic monitor resource model", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Monitors_Create": { + "$ref": "./examples/Monitors_Create.json" + } + } + }, + "patch": { + "tags": [ + "MonitorsResource" + ], + "summary": "Update a monitor resource.", + "operationId": "Monitors_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic resource model update parameters.", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Update": { + "$ref": "./examples/Monitors_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitorsResource" + ], + "summary": "Delete a monitor resource.", + "operationId": "Monitors_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_Delete": { + "$ref": "./examples/Monitors_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listMonitoredResources": { + "post": { + "tags": [ + "MonitoredResources" + ], + "summary": "List the resources currently being monitored by the Elastic monitor resource.", + "operationId": "MonitoredResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MonitoredResources_List": { + "$ref": "./examples/MonitoredResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listDeploymentInfo": { + "post": { + "tags": [ + "DeploymentInfo" + ], + "summary": "Fetch information regarding Elastic cloud deployment corresponding to the Elastic monitor resource.", + "operationId": "DeploymentInfo_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentInfoResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "DeploymentInfo_List": { + "$ref": "./examples/DeploymentInfo_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createOrUpdateExternalUser": { + "post": { + "tags": [ + "DeploymentInfo" + ], + "summary": "Create User inside elastic deployment which are used by customers to perform operations on the elastic deployment", + "operationId": "ExternalUser_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic External User Creation Parameters", + "schema": { + "$ref": "#/definitions/ExternalUserInfo" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExternalUserCreationResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalUser_CreateOrUpdate": { + "$ref": "./examples/ExternalUserInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/getBillingInfo": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "Get marketplace and organization info mapped to the given monitor.", + "operationId": "BillingInfo_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BillingInfoResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingInfo_Get": { + "$ref": "./examples/BillingInfo_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listConnectedPartnerResources": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "List of all active deployments that are associated with the marketplace subscription linked to the given monitor.", + "operationId": "ConnectedPartnerResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ConnectedPartnerResourcesListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConnectedPartnerResources_List": { + "$ref": "./examples/ConnectedPartnerResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations": { + "get": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "List OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModelListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OpenAI_List": { + "$ref": "./examples/OpenAI_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations/{integrationName}": { + "get": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Get OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_Get": { + "$ref": "./examples/OpenAI_Get.json" + } + } + }, + "put": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Create or update a OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_CreateOrUpdate": { + "$ref": "./examples/OpenAI_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Delete OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_Delete": { + "$ref": "./examples/OpenAI_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations/{integrationName}/getStatus": { + "post": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Get OpenAI integration status for a given integration.", + "operationId": "OpenAI_GetStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationStatusResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_GetStatus": { + "$ref": "./examples/OpenAI_GetStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules": { + "get": { + "tags": [ + "Rules" + ], + "summary": "List the tag rules for a given monitor resource.", + "operationId": "TagRules_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRulesListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TagRules_List": { + "$ref": "./examples/TagRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules/{ruleSetName}": { + "put": { + "tags": [ + "Rules" + ], + "summary": "Create or update a tag rule set for a given monitor resource.", + "operationId": "TagRules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + }, + { + "description": "request body of MonitoringTagRules", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_CreateOrUpdate": { + "$ref": "./examples/TagRules_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Rules" + ], + "summary": "Get a tag rule set for a given monitor resource.", + "operationId": "TagRules_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Get": { + "$ref": "./examples/TagRules_Get.json" + } + } + }, + "delete": { + "tags": [ + "Rules" + ], + "summary": "Delete a tag rule set for a given monitor resource.", + "operationId": "TagRules_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TagRules_Delete": { + "$ref": "./examples/TagRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listVMHost": { + "post": { + "tags": [ + "VMHHostList" + ], + "summary": "List the vm resources currently being monitored by the Elastic monitor resource.", + "operationId": "VMHost_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/VMHostListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VMHost_List": { + "$ref": "./examples/VMHost_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/vmIngestionDetails": { + "post": { + "tags": [ + "VMIngestionDetails" + ], + "summary": "List the vm ingestion details that will be monitored by the Elastic monitor resource.", + "operationId": "VMIngestion_Details", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/VMIngestionDetailsResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "VMIngestion_Details": { + "$ref": "./examples/VMIngestion_Details.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/vmCollectionUpdate": { + "post": { + "tags": [ + "VMCollectionUpdate" + ], + "summary": "Update the vm details that will be monitored by the Elastic monitor resource.", + "operationId": "VMCollection_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "VM resource Id", + "schema": { + "$ref": "#/definitions/VMCollectionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "VMCollection_Update": { + "$ref": "./examples/VMCollection_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listUpgradableVersions": { + "post": { + "tags": [ + "MonitorUpgradableVersions" + ], + "summary": "List of upgradable versions for a given monitor resource.", + "operationId": "UpgradableVersions_Details", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UpgradableVersionsList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "UpgradableVersions_Details": { + "$ref": "./examples/UpgradableVersions_Details.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/upgrade": { + "post": { + "tags": [ + "DeploymentUpdate" + ], + "summary": "Upgradable version for a monitor resource.", + "operationId": "Monitor_Upgrade", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic Monitor Upgrade Parameters", + "schema": { + "$ref": "#/definitions/ElasticMonitorUpgrade" + } + } + ], + "responses": { + "202": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitor_Upgrade": { + "$ref": "./examples/Monitor_Upgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listAllTrafficFilters": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Get the list of all traffic filters for the account.", + "operationId": "AllTrafficFilters_list", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticTrafficFilterResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "AllTrafficFilters_list": { + "$ref": "./examples/AllTrafficFilters_list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listAssociatedTrafficFilters": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Get the list of all associated traffic filters for the given deployment.", + "operationId": "listAssociatedTrafficFilters_list", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticTrafficFilterResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "listAssociatedTrafficFilters_list": { + "$ref": "./examples/AssociatedFiltersForDeployment_list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createAndAssociateIPFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Create and Associate IP traffic filter for the given deployment.", + "operationId": "createAndAssociateIPFilter_Create", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "ips", + "description": "List of ips", + "type": "string" + }, + { + "in": "query", + "name": "name", + "description": "Name of the traffic filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "createAndAssociateIPFilter_Create": { + "$ref": "./examples/IPTrafficFilter_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createAndAssociatePLFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Create and Associate private link traffic filter for the given deployment.", + "operationId": "createAndAssociatePLFilter_Create", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "name", + "description": "Name of the traffic filter", + "type": "string" + }, + { + "in": "query", + "name": "privateEndpointGuid", + "description": "Guid of the private endpoint", + "type": "string" + }, + { + "in": "query", + "name": "privateEndpointName", + "description": "Name of the private endpoint", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "createAndAssociatePLFilter_Create": { + "$ref": "./examples/PrivateLinkTrafficFilters_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/associateTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Associate traffic filter for the given deployment.", + "operationId": "AssociateTrafficFilter_Associate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "AssociateTrafficFilter_Associate": { + "$ref": "./examples/AssociateTrafficFilter_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/detachAndDeleteTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Detach and Delete traffic filter from the given deployment.", + "operationId": "DetachAndDeleteTrafficFilter_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "DetachAndDeleteTrafficFilter_Delete": { + "$ref": "./examples/DetachAndDeleteTrafficFilter_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/detachTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Detach traffic filter for the given deployment.", + "operationId": "DetachTrafficFilter_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "DetachTrafficFilter_Update": { + "$ref": "./examples/DetachTrafficFilters_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/deleteTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Delete traffic filter from the account.", + "operationId": "TrafficFilters_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TrafficFilters_Delete": { + "$ref": "./examples/TrafficFilters_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getOrganizationApiKey": { + "post": { + "tags": [ + "ApiKey" + ], + "summary": "Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.", + "description": "Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.", + "operationId": "Organizations_GetApiKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "body", + "name": "body", + "description": "Email Id parameter of the User Organization, of which the API Key must be returned", + "schema": { + "$ref": "#/definitions/UserEmailId" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UserApiKeyResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_GetApiKey": { + "$ref": "./examples/Organizations_GetApiKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getElasticOrganizationToAzureSubscriptionMapping": { + "post": { + "tags": [ + "UserOrganization" + ], + "summary": "Get Elastic Organization To Azure Subscription Mapping details for the logged-in user.", + "description": "Get Elastic Organization To Azure Subscription Mapping details for the logged-in user.", + "operationId": "Organizations_GetElasticToAzureSubscriptionMapping", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticOrganizationToAzureSubscriptionMappingResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_GetElasticToAzureSubscriptionMapping": { + "$ref": "./examples/Organizations_GetElasticToAzureSubscriptionMapping.json" + } + } + } + } + }, + "definitions": { + "ErrorResponseBody": { + "description": "Error response body.", + "title": "ErrorResponseBody", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "target": { + "description": "Error target.", + "type": "string" + }, + "details": { + "description": "Error details.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + } + }, + "ResourceProviderDefaultErrorResponse": { + "description": "RP default error response.", + "type": "object", + "properties": { + "error": { + "description": "Response body of Error", + "readOnly": true, + "$ref": "#/definitions/ErrorResponseBody" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider, i.e., Microsoft.Elastic.", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'monitors'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write monitors'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "A Microsoft.Elastic REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name, i.e., {provider}/{resource}/{operation}.", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list the Microsoft.Elastic operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the Microsoft.Elastic provider.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "ResourceSku": { + "description": "Microsoft.Elastic SKU.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the SKU.", + "type": "string" + } + } + }, + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "type": "string", + "description": "Provisioning state of Elastic resource.", + "title": "ProvisioningState", + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + } + }, + "MonitoringStatus": { + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MonitoringStatus" + } + }, + "ElasticCloudUser": { + "description": "Details of the user's elastic account.", + "type": "object", + "properties": { + "emailAddress": { + "description": "Email of the Elastic User Account.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "User Id of the elastic account of the User.", + "type": "string", + "readOnly": true + }, + "elasticCloudSsoDefaultUrl": { + "description": "Elastic cloud default dashboard sso URL of the Elastic user account.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticCloudDeployment": { + "description": "Details of the user's elastic deployment associated with the monitor resource.", + "type": "object", + "properties": { + "name": { + "description": "Elastic deployment name", + "type": "string", + "readOnly": true + }, + "deploymentId": { + "description": "Elastic deployment Id", + "type": "string", + "readOnly": true + }, + "azureSubscriptionId": { + "description": "Associated Azure subscription Id for the elastic deployment.", + "type": "string", + "readOnly": true + }, + "elasticsearchRegion": { + "description": "Region where Deployment at Elastic side took place.", + "type": "string", + "readOnly": true + }, + "elasticsearchServiceUrl": { + "description": "Elasticsearch ingestion endpoint of the Elastic deployment.", + "type": "string", + "readOnly": true + }, + "kibanaServiceUrl": { + "description": "Kibana endpoint of the Elastic deployment.", + "type": "string", + "readOnly": true + }, + "kibanaSsoUrl": { + "description": "Kibana dashboard sso URL of the Elastic deployment.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticProperties": { + "description": "Elastic Resource Properties.", + "type": "object", + "properties": { + "elasticCloudUser": { + "description": "Details of the user's elastic account.", + "$ref": "#/definitions/ElasticCloudUser" + }, + "elasticCloudDeployment": { + "description": "Details of the elastic cloud deployment.", + "$ref": "#/definitions/ElasticCloudDeployment" + } + } + }, + "CompanyInfo": { + "description": "Company information of the user to be passed to partners.", + "type": "object", + "properties": { + "domain": { + "description": "Domain of the company", + "maxLength": 250, + "type": "string" + }, + "business": { + "description": "Business of the company", + "maxLength": 64, + "type": "string" + }, + "employeesNumber": { + "description": "Number of employees in the company", + "maxLength": 20, + "type": "string" + }, + "state": { + "description": "State of the company location.", + "maxLength": 64, + "type": "string" + }, + "country": { + "description": "Country of the company location.", + "maxLength": 64, + "type": "string" + } + } + }, + "UserInfo": { + "description": "User Information to be passed to partners.", + "type": "object", + "properties": { + "firstName": { + "description": "First name of the user", + "maxLength": 50, + "type": "string" + }, + "lastName": { + "description": "Last name of the user", + "maxLength": 50, + "type": "string" + }, + "companyName": { + "description": "Company name of the user", + "maxLength": 64, + "type": "string" + }, + "emailAddress": { + "description": "Email of the user used by Elastic for contacting them if needed", + "pattern": "^([^<>()\\[\\]\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\.,;:\\s@\"]+)*)@(([a-zA-Z-_0-9]+\\.)+[a-zA-Z]{2,})$", + "type": "string" + }, + "companyInfo": { + "description": "Company information of the user to be passed to partners.", + "$ref": "#/definitions/CompanyInfo" + } + } + }, + "PlanDetails": { + "description": "Plan details of the monitor resource.", + "type": "object", + "properties": { + "offerID": { + "description": "Offer ID of the plan", + "type": "string" + }, + "publisherID": { + "description": "Publisher ID of the plan", + "type": "string" + }, + "termID": { + "description": "Term ID of the plan", + "type": "string" + }, + "planID": { + "description": "Plan ID", + "type": "string" + }, + "planName": { + "description": "Plan Name", + "type": "string" + } + } + }, + "LiftrResourceCategories": { + "enum": [ + "Unknown", + "MonitorLogs" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "LiftrResourceCategories" + }, + "readOnly": true + }, + "MonitorProperties": { + "description": "Properties specific to the monitor resource.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the monitor resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "monitoringStatus": { + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "$ref": "#/definitions/MonitoringStatus" + }, + "elasticProperties": { + "description": "Elastic cloud properties.", + "$ref": "#/definitions/ElasticProperties" + }, + "userInfo": { + "description": "User information.", + "$ref": "#/definitions/UserInfo", + "x-ms-mutability": [ + "create" + ] + }, + "planDetails": { + "description": "Plan details of the monitor resource.", + "$ref": "#/definitions/PlanDetails" + }, + "version": { + "description": "Version of elastic of the monitor resource", + "type": "string" + }, + "subscriptionState": { + "description": "State of the Azure Subscription containing the monitor resource", + "type": "string" + }, + "saaSAzureSubscriptionStatus": { + "description": "Status of Azure Subscription where Marketplace SaaS is located.", + "type": "string" + }, + "sourceCampaignName": { + "description": "Name of the marketing campaign.", + "type": "string" + }, + "sourceCampaignId": { + "description": "A unique identifier associated with the campaign.", + "type": "string" + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories" + }, + "liftrResourcePreference": { + "description": "The priority of the resource.", + "format": "int32", + "type": "integer", + "readOnly": true + }, + "generateApiKey": { + "description": "Flag to determine if User API Key has to be generated and shared.", + "type": "boolean" + } + } + }, + "ManagedIdentityTypes": { + "enum": [ + "SystemAssigned" + ], + "type": "string", + "description": "Managed Identity types.", + "x-ms-enum": { + "modelAsString": true, + "name": "ManagedIdentityTypes" + } + }, + "IdentityProperties": { + "description": "Identity properties.", + "type": "object", + "properties": { + "principalId": { + "description": "The identity ID.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant ID of resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Managed identity type.", + "$ref": "#/definitions/ManagedIdentityTypes" + } + } + }, + "ElasticMonitorResource": { + "description": "Monitor resource.", + "required": [ + "location" + ], + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the monitor resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the monitor resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitor resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "SKU of the monitor resource.", + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "description": "Properties of the monitor resource.", + "$ref": "#/definitions/MonitorProperties", + "x-ms-client-flatten": false + }, + "identity": { + "description": "Identity properties of the monitor resource.", + "$ref": "#/definitions/IdentityProperties" + }, + "tags": { + "description": "The tags of the monitor resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "location": { + "description": "The location of the monitor resource", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "systemData": { + "readOnly": true, + "description": "The system metadata relating to this resource", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + } + } + }, + "ElasticMonitorResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ElasticMonitorResourceUpdateParameters": { + "description": "Monitor resource update parameters.", + "type": "object", + "properties": { + "tags": { + "description": "elastic monitor resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SendingLogs": { + "enum": [ + "True", + "False" + ], + "type": "string", + "description": "Flag indicating the status of the resource for sending logs operation to Elastic.", + "title": "SendingLogs", + "x-ms-enum": { + "modelAsString": true, + "name": "SendingLogs" + } + }, + "MonitoredResource": { + "description": "The properties of a resource currently being monitored by the Elastic monitor resource.", + "type": "object", + "properties": { + "id": { + "description": "The ARM id of the resource.", + "type": "string" + }, + "sendingLogs": { + "description": "Flag indicating the status of the resource for sending logs operation to Elastic.", + "$ref": "#/definitions/SendingLogs" + }, + "reasonForLogsStatus": { + "description": "Reason for why the resource is sending logs (or why it is not sending).", + "type": "string" + } + } + }, + "MonitoredResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MonitoredResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "TagAction": { + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion.", + "enum": [ + "Include", + "Exclude" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TagAction" + } + }, + "FilteringTag": { + "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.", + "type": "object", + "properties": { + "name": { + "description": "The name (also known as the key) of the tag.", + "type": "string" + }, + "value": { + "description": "The value of the tag.", + "type": "string" + }, + "action": { + "description": "Valid actions for a filtering tag.", + "$ref": "#/definitions/TagAction" + } + } + }, + "ElasticVersionListFormat": { + "description": "Elastic Version List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticVersionListProperties" + } + } + }, + "ElasticVersionListProperties": { + "description": "Elastic Version Properties", + "type": "object", + "properties": { + "version": { + "description": "Available elastic version of the given region", + "type": "string" + } + } + }, + "ElasticVersionsListResponse": { + "description": "List of elastic versions available in a region.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [ + "properties/version" + ], + "items": { + "$ref": "#/definitions/ElasticVersionListFormat" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "LogRules": { + "description": "Set of rules for sending logs for the Monitor resource.", + "type": "object", + "properties": { + "sendAadLogs": { + "description": "Flag specifying if AAD logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendSubscriptionLogs": { + "description": "Flag specifying if subscription logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendActivityLogs": { + "description": "Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.", + "type": "boolean" + }, + "filteringTags": { + "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "MonitoringTagRulesProperties": { + "description": "Definition of the properties for a TagRules resource.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the monitoring tag rules.", + "$ref": "#/definitions/ProvisioningState" + }, + "logRules": { + "description": "Rules for sending logs.", + "$ref": "#/definitions/LogRules" + } + } + }, + "MonitoringTagRules": { + "description": "Capture logs and metrics of Azure resources based on ARM tags.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the rule set.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the rule set.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the rule set.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the monitoring tag rules.", + "$ref": "#/definitions/MonitoringTagRulesProperties", + "x-ms-client-flatten": false + }, + "systemData": { + "readOnly": true, + "description": "The system metadata relating to this resource", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + } + } + }, + "MonitoringTagRulesListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "OpenAIIntegrationProperties": { + "description": "Open AI Integration details.", + "type": "object", + "properties": { + "openAIResourceId": { + "description": "The resource id of Open AI resource", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "openAIResourceEndpoint": { + "description": "The API endpoint for Open AI resource", + "type": "string", + "readOnly": true + }, + "key": { + "description": "Value of API key for Open AI resource", + "type": "string", + "x-ms-secret": true + }, + "lastRefreshAt": { + "format": "date-time", + "description": "Last Update Timestamp for key updation", + "type": "string", + "readOnly": true + } + } + }, + "OpenAIIntegrationRPModel": { + "description": "Capture properties of Open AI resource Integration.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the integration.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the integration.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the integration.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OpenAIIntegrationProperties" + } + } + }, + "OpenAIIntegrationRPModelListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "OpenAIIntegrationStatusResponse": { + "description": "Status of the OpenAI Integration", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/OpenAIIntegrationStatusResponseProperties" + } + } + }, + "OpenAIIntegrationStatusResponseProperties": { + "description": "Status of the OpenAI Integration", + "type": "object", + "properties": { + "status": { + "description": "Status of the OpenAI Integration", + "type": "string" + } + } + }, + "BillingInfoResponse": { + "description": "Marketplace Subscription and Organization details to which resource gets billed into.", + "type": "object", + "properties": { + "marketplaceSaasInfo": { + "description": "Marketplace Subscription details", + "$ref": "#/definitions/MarketplaceSaaSInfo" + }, + "partnerBillingEntity": { + "description": "Partner Billing Entity details: Organization Info", + "$ref": "#/definitions/PartnerBillingEntity" + } + } + }, + "MarketplaceSaaSInfo": { + "description": "Marketplace SAAS Info of the resource.", + "type": "object", + "properties": { + "marketplaceSubscription": { + "description": "Marketplace Subscription", + "type": "object", + "properties": { + "id": { + "description": "Marketplace Subscription Id. This is a GUID-formatted string.", + "type": "string" + } + } + }, + "marketplaceName": { + "description": "Marketplace Subscription Details: SAAS Name", + "type": "string" + }, + "marketplaceResourceId": { + "description": "Marketplace Subscription Details: Resource URI", + "type": "string" + }, + "marketplaceStatus": { + "description": "Marketplace Subscription Details: SaaS Subscription Status", + "type": "string" + }, + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into.", + "type": "string" + }, + "subscribed": { + "description": "Flag specifying if the Marketplace status is subscribed or not.", + "type": "boolean" + } + } + }, + "PartnerBillingEntity": { + "description": "Partner Billing details associated with the resource.", + "type": "object", + "properties": { + "id": { + "description": "The Elastic Organization Id.", + "type": "string" + }, + "name": { + "description": "The Elastic Organization Name.", + "type": "string" + }, + "partnerEntityUri": { + "description": "Link to the elastic organization page", + "type": "string" + } + } + }, + "ConnectedPartnerResourceProperties": { + "description": "Connected Partner Resource Properties", + "type": "object", + "properties": { + "partnerDeploymentName": { + "description": "Elastic deployment name", + "type": "string" + }, + "partnerDeploymentUri": { + "description": "Deployment URL of the elasticsearch in Elastic cloud deployment.", + "type": "string" + }, + "azureResourceId": { + "description": "The azure resource Id of the deployment.", + "type": "string" + }, + "location": { + "description": "The location of the deployment.", + "type": "string" + } + } + }, + "ConnectedPartnerResourcesListFormat": { + "description": "Connected Partner Resources List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConnectedPartnerResourceProperties" + } + } + }, + "ConnectedPartnerResourcesListResponse": { + "description": " List of all active elastic deployments.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [ + "properties/azureResourceId" + ], + "items": { + "$ref": "#/definitions/ConnectedPartnerResourcesListFormat" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ElasticDeploymentStatus": { + "description": "Flag specifying if the Elastic deployment status is healthy or not.", + "enum": [ + "Healthy", + "Unhealthy" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ElasticDeploymentStatus" + } + }, + "DeploymentInfoResponse": { + "description": "The properties of deployment in Elastic cloud corresponding to the Elastic monitor resource.", + "type": "object", + "properties": { + "status": { + "description": "The Elastic deployment status.", + "$ref": "#/definitions/ElasticDeploymentStatus", + "readOnly": true + }, + "version": { + "description": "Version of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "memoryCapacity": { + "description": "RAM capacity of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "diskCapacity": { + "description": "Disk capacity of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "elasticsearchEndPoint": { + "description": "Elasticsearch endpoint in Elastic cloud deployment. This is either the aliased_endpoint if available, or the service_url otherwise.", + "type": "string", + "readOnly": true + }, + "deploymentUrl": { + "description": "Deployment URL of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "marketplaceSaasInfo": { + "description": "Marketplace SaaS Info of the resource.", + "$ref": "#/definitions/MarketplaceSaaSInfo", + "readOnly": true + } + } + }, + "ExternalUserCreationResponse": { + "description": "The properties of the response we got from elastic while creating external user", + "type": "object", + "properties": { + "created": { + "description": "Shows if user is created or updated", + "type": "boolean", + "readOnly": true + } + } + }, + "ExternalUserInfo": { + "description": "The properties of the request required for creating user on elastic side", + "type": "object", + "properties": { + "userName": { + "description": "Username of the user to be created or updated", + "type": "string" + }, + "fullName": { + "description": "Full name of the user to be created or updated", + "type": "string" + }, + "password": { + "x-ms-secret": true, + "description": "Password of the user to be created or updated", + "type": "string" + }, + "emailId": { + "description": "Email id of the user to be created or updated", + "type": "string" + }, + "roles": { + "description": "Roles to be assigned for created or updated user", + "type": "array", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "VMHostListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/VMResources" + } + }, + "nextLink": { + "description": "Link to the next Vm resource Id, if any.", + "type": "string" + } + } + }, + "VMResources": { + "description": "The vm resource properties that is currently being monitored by the Elastic monitor resource.", + "type": "object", + "properties": { + "vmResourceId": { + "description": "The ARM id of the VM resource.", + "type": "string" + } + } + }, + "VMIngestionDetailsResponse": { + "description": "The vm ingestion details to install an agent.", + "type": "object", + "properties": { + "cloudId": { + "description": "The cloudId of given Elastic monitor resource.", + "type": "string" + }, + "ingestionKey": { + "description": "Ingestion details to install agent on given VM.", + "type": "string", + "x-ms-secret": true + } + } + }, + "OperationName": { + "enum": [ + "Add", + "Delete" + ], + "type": "string", + "description": "Operation to be performed on the given vm resource id.", + "title": "OperationName", + "x-ms-enum": { + "modelAsString": true, + "name": "OperationName" + } + }, + "VMCollectionUpdate": { + "description": "Update VM resource collection.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "vmResourceId": { + "description": "ARM id of the VM resource.", + "type": "string" + }, + "operationName": { + "description": "Operation to be performed for given VM.", + "$ref": "#/definitions/OperationName" + } + } + }, + "UpgradableVersionsList": { + "description": "Stack Versions that this version can upgrade to", + "type": "object", + "properties": { + "currentVersion": { + "type": "string", + "description": "Current version of the elastic monitor" + }, + "upgradableVersions": { + "type": "array", + "x-ms-identifiers": [], + "description": "Stack Versions that this version can upgrade to", + "items": { + "type": "string" + } + } + } + }, + "ElasticTrafficFilterResponse": { + "description": "List of elastic traffic filters in the account", + "type": "object", + "properties": { + "rulesets": { + "type": "array", + "x-ms-identifiers": [], + "description": "List of elastic traffic filters in the account", + "items": { + "$ref": "#/definitions/ElasticTrafficFilter" + } + } + } + }, + "ElasticTrafficFilter": { + "description": "Elastic traffic filter object", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the elastic filter" + }, + "name": { + "type": "string", + "description": "Name of the elastic filter" + }, + "description": { + "type": "string", + "description": "Description of the elastic filter" + }, + "region": { + "type": "string", + "description": "Region of the elastic filter" + }, + "type": { + "enum": [ + "ip", + "azure_private_endpoint" + ], + "type": "string", + "description": "Type of the elastic filter", + "x-ms-enum": { + "modelAsString": true, + "name": "type" + } + }, + "includeByDefault": { + "type": "boolean", + "description": "IncludeByDefault for the elastic filter" + }, + "rules": { + "type": "array", + "description": "Rules in the elastic filter", + "items": { + "$ref": "#/definitions/ElasticTrafficFilterRule" + } + } + } + }, + "ElasticTrafficFilterRule": { + "description": "Elastic traffic filter rule object", + "type": "object", + "properties": { + "source": { + "type": "string", + "description": "IP of the elastic filter rule" + }, + "description": { + "type": "string", + "description": "Description of the elastic filter rule" + }, + "azureEndpointGuid": { + "type": "string", + "description": "Guid of Private Endpoint in the elastic filter rule" + }, + "azureEndpointName": { + "type": "string", + "description": "Name of the Private Endpoint in the elastic filter rule" + }, + "id": { + "type": "string", + "description": "Id of the elastic filter rule" + } + } + }, + "ElasticMonitorUpgrade": { + "description": "Upgrade elastic monitor version", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Version to which the elastic monitor should be upgraded to" + } + } + }, + "UserEmailId": { + "description": "Email Id of the User Organization, of which the API Key must be returned", + "type": "object", + "properties": { + "emailId": { + "type": "string", + "description": "The User email Id" + } + } + }, + "UserApiKeyResponse": { + "description": "The User Api Key created for the Organization associated with the User Email Id that was passed in the request", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UserApiKeyResponseProperties" + } + } + }, + "UserApiKeyResponseProperties": { + "type": "object", + "properties": { + "apiKey": { + "description": "The User Api Key Generated based on GenerateApiKey flag. This is applicable for non-Portal clients only.", + "type": "string", + "x-ms-secret": true + } + } + }, + "ElasticOrganizationToAzureSubscriptionMappingResponse": { + "description": "The Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticOrganizationToAzureSubscriptionMappingResponseProperties" + } + } + }, + "ElasticOrganizationToAzureSubscriptionMappingResponseProperties": { + "description": "The properties of Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.", + "type": "object", + "properties": { + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Organization belongs and gets billed into. This is empty for a new user OR a user without an Elastic Organization.", + "type": "string" + }, + "marketplaceSaasInfo": { + "description": "Marketplace SaaS Info of the resource.", + "$ref": "#/definitions/MarketplaceSaaSInfo", + "readOnly": true + }, + "elasticOrganizationId": { + "description": "The Elastic Organization Id.", + "type": "string" + }, + "elasticOrganizationName": { + "description": "The Elastic Organization Name.", + "type": "string" + } + } + } + }, + "parameters": { + "MonitorNameParameter": { + "in": "path", + "name": "monitorName", + "description": "Monitor resource name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RuleSetNameParameter": { + "in": "path", + "name": "ruleSetName", + "description": "Tag Rule Set resource name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "OpenAIIntegrationNameParameter": { + "in": "path", + "name": "integrationName", + "description": "OpenAI Integration name", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/AllTrafficFilters_list.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/AllTrafficFilters_list.json new file mode 100644 index 000000000000..e163e8afde90 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/AllTrafficFilters_list.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "rulesets": [ + { + "id": "31d91b5afb6f4c2eaaf104c97b1991dd", + "name": "IPFromApi", + "description": "created from azure", + "type": "ip", + "includeByDefault": false, + "region": "azure-eastus", + "rules": [ + { + "id": "f0297dad72af4a5e964cddf817f35e65", + "description": "Allow inbound traffic from IP address 192.168.131.0", + "source": "192.168.131.0" + }, + { + "id": "f9c00169f0e54931ae72aabde326b589", + "description": "Allow inbound traffic from IP address block 192.168.132.6/22", + "source": "192.168.132.6/22" + } + ] + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/AssociateTrafficFilter_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/AssociateTrafficFilter_Update.json new file mode 100644 index 000000000000..aea5617c3f99 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/AssociateTrafficFilter_Update.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/associateTrafficFilter?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/AssociatedFiltersForDeployment_list.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/AssociatedFiltersForDeployment_list.json new file mode 100644 index 000000000000..e163e8afde90 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/AssociatedFiltersForDeployment_list.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "rulesets": [ + { + "id": "31d91b5afb6f4c2eaaf104c97b1991dd", + "name": "IPFromApi", + "description": "created from azure", + "type": "ip", + "includeByDefault": false, + "region": "azure-eastus", + "rules": [ + { + "id": "f0297dad72af4a5e964cddf817f35e65", + "description": "Allow inbound traffic from IP address 192.168.131.0", + "source": "192.168.131.0" + }, + { + "id": "f9c00169f0e54931ae72aabde326b589", + "description": "Allow inbound traffic from IP address block 192.168.132.6/22", + "source": "192.168.132.6/22" + } + ] + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/BillingInfo_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/BillingInfo_Get.json new file mode 100644 index 000000000000..15d11c7776fb --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/BillingInfo_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status", + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "subscribed": true + }, + "partnerBillingEntity": { + "id": "1234567890", + "name": "elasticOrganizationName", + "partnerEntityUri": "https://example.com" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/ConnectedPartnerResources_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/ConnectedPartnerResources_List.json new file mode 100644 index 000000000000..19e3d3fe4d19 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/ConnectedPartnerResources_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "partnerDeploymentName": "deploymentname", + "partnerDeploymentUri": "https://examplessourl.com", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US 2" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/DeploymentInfo_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/DeploymentInfo_List.json new file mode 100644 index 000000000000..17acef9dacf6 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/DeploymentInfo_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "status": "Healthy", + "version": "7.9.3", + "memoryCapacity": "1024", + "diskCapacity": "245760", + "elasticsearchEndPoint": "alias.es.eastus2.staging.azure.foundit.no", + "deploymentUrl": "https://endpoint.eastus.kb.azure.elastic-cloud.com:9243", + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/DetachAndDeleteTrafficFilter_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/DetachAndDeleteTrafficFilter_Delete.json new file mode 100644 index 000000000000..e1a83a5c749f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/DetachAndDeleteTrafficFilter_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/DetachTrafficFilters_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/DetachTrafficFilters_Update.json new file mode 100644 index 000000000000..6de561a6acdf --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/DetachTrafficFilters_Update.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/detachTrafficFilter?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/ElasticVersions_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/ElasticVersions_List.json new file mode 100644 index 000000000000..5e2326ddcf57 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/ElasticVersions_List.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "region": "myregion", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "version1" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/ExternalUserInfo.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/ExternalUserInfo.json new file mode 100644 index 000000000000..027e42f732cf --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/ExternalUserInfo.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "UserName": "newuser", + "FullName": "fullname", + "Password": "Password", + "EmailId": "myemail@outlook.com", + "Roles": [ + "admin", + "other_role1" + ] + } + }, + "responses": { + "200": { + "body": { + "created": true + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/IPTrafficFilter_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/IPTrafficFilter_Create.json new file mode 100644 index 000000000000..c9e44e674d4f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/IPTrafficFilter_Create.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd", + "ips": "192.168.131.0, 192.168.132.6/22" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/createAndAssociateIPFilter?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitor_Upgrade.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitor_Upgrade.json new file mode 100644 index 000000000000..07092abdffb3 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitor_Upgrade.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "version": "7.15.1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/upgrade?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/MonitoredResources_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/MonitoredResources_List.json new file mode 100644 index 000000000000..fca064f36870 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/MonitoredResources_List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "sendingLogs": "True", + "reasonForLogsStatus": "CapturedByRules" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Create.json new file mode 100644 index 000000000000..788a384b3c57 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Create.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "name": "myMonitor", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "userInfo": { + "firstName": "Alice", + "lastName": "Bob", + "companyName": "Microsoft", + "emailAddress": "alice@microsoft.com", + "companyInfo": { + "domain": "microsoft.com", + "business": "Technology", + "employeeNumber": "10000", + "state": "WA", + "country": "US" + } + }, + "planDetails": { + "offerID": "00000", + "publisherID": "1234", + "termID": "free_Monthly", + "planID": "xxxyyy", + "planName": "myPlan" + }, + "subscriptionState": "Suspended", + "saaSAzureSubscriptionStatus": "Subscribed", + "sourceCampaignName": "Elastic", + "sourceCampaignId": "0000" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Delete.json new file mode 100644 index 000000000000..ef255dfb6611 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname?api-version=2022-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Get.json new file mode 100644 index 000000000000..c39850e793f1 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_List.json new file mode 100644 index 000000000000..ca53ee74530c --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_ListByResourceGroup.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_ListByResourceGroup.json new file mode 100644 index 000000000000..cd8608801bb4 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_ListByResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Update.json new file mode 100644 index 000000000000..9de2d12dc1cb --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Monitors_Update.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "name": "myMonitor", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bob", + "companyName": "Microsoft", + "emailAddress": "alice@microsoft.com", + "companyInfo": { + "domain": "microsoft.com", + "business": "Technology", + "employeeNumber": "10000", + "state": "WA", + "country": "US" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_CreateOrUpdate.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_CreateOrUpdate.json new file mode 100644 index 000000000000..3f488a33c4b3 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_CreateOrUpdate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default", + "requestBody": { + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "key": "**" + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_Delete.json new file mode 100644 index 000000000000..0aa172ca8edf --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_Get.json new file mode 100644 index 000000000000..40fba518c053 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_GetStatus.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_GetStatus.json new file mode 100644 index 000000000000..fbec48626f59 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_GetStatus.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "Succeeded" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_List.json new file mode 100644 index 000000000000..389b15096632 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/OpenAI_List.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Operations_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..11a190fb88bd --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Operations_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Elastic/monitors/write", + "display": { + "provider": "Microsoft.Elastic", + "resource": "monitors", + "operation": "write", + "description": "Write monitors resource" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Organizations_GetApiKey.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Organizations_GetApiKey.json new file mode 100644 index 000000000000..587c1f70ad54 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Organizations_GetApiKey.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "requestBody": { + "emailId": "myemail@outlook.com" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "apiKey": "AbCdEfGhIjKlMnOpQrStUvWxYz" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json new file mode 100644 index 000000000000..ae238303d230 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "properties": { + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status" + }, + "elasticOrganizationId": "1234567890", + "elasticOrganizationName": "elasticOrganizationName" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/PrivateLinkTrafficFilters_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/PrivateLinkTrafficFilters_Create.json new file mode 100644 index 000000000000..3da7d03d2d3e --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/PrivateLinkTrafficFilters_Create.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd", + "privateEndpointName": "myPrivateEndpoint", + "privateEndpointGuid": "fdb54d3b-e85e-4d08-8958-0d2f7g523df9" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/createAndAssociatePLFilter?api-version=2022-07-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_CreateOrUpdate.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_CreateOrUpdate.json new file mode 100644 index 000000000000..bd04f9748912 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_CreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default", + "requestBody": { + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_Delete.json new file mode 100644 index 000000000000..50196c52c3a2 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/tagRules/tagRuleName?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_Get.json new file mode 100644 index 000000000000..a38399305b4c --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_List.json new file mode 100644 index 000000000000..ab5306d625f2 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TagRules_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TrafficFilters_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TrafficFilters_Delete.json new file mode 100644 index 000000000000..e1a83a5c749f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/TrafficFilters_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/UpgradableVersions_Details.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/UpgradableVersions_Details.json new file mode 100644 index 000000000000..aa6bba3aaf85 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/UpgradableVersions_Details.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "currentVersion": "7.15.0", + "upgradableVersions": [ + "7.15.1", + "7.16.0" + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/VMCollection_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/VMCollection_Update.json new file mode 100644 index 000000000000..6a5de13c121d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/VMCollection_Update.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "vmResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualmachines/myVM", + "operationName": "Add" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/VMHost_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/VMHost_List.json new file mode 100644 index 000000000000..468f33dfbe42 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/VMHost_List.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vmResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualmachines/myVM" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/VMIngestion_Details.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/VMIngestion_Details.json new file mode 100644 index 000000000000..8bb395f02878 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-01-01-preview/examples/VMIngestion_Details.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "cloudId": "myid123", + "ingestionKey": "Vmingeationkey" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/elastic.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/elastic.json new file mode 100644 index 000000000000..cdf531dfe54a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/elastic.json @@ -0,0 +1,3147 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Elastic", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Microsoft Entra ID OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Elastic/operations": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all operations provided by Microsoft.Elastic.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified subscription.", + "operationId": "Monitors_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_List": { + "$ref": "./examples/Monitors_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/elasticVersions": { + "get": { + "tags": [ + "ElasticVersions" + ], + "summary": "Get a list of available versions for a region.", + "operationId": "ElasticVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "query", + "name": "region", + "description": "Region where elastic deployment will take place.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticVersionsListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ElasticVersions_List": { + "$ref": "./examples/ElasticVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified resource group.", + "operationId": "Monitors_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListByResourceGroup": { + "$ref": "./examples/Monitors_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "Get the properties of a specific monitor resource.", + "operationId": "Monitors_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Get": { + "$ref": "./examples/Monitors_Get.json" + } + } + }, + "put": { + "tags": [ + "MonitorsResource" + ], + "summary": "Create a monitor resource.", + "operationId": "Monitors_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic monitor resource model", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Monitors_Create": { + "$ref": "./examples/Monitors_Create.json" + } + } + }, + "patch": { + "tags": [ + "MonitorsResource" + ], + "summary": "Update a monitor resource.", + "operationId": "Monitors_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic resource model update parameters.", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Update": { + "$ref": "./examples/Monitors_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitorsResource" + ], + "summary": "Delete a monitor resource.", + "operationId": "Monitors_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_Delete": { + "$ref": "./examples/Monitors_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listMonitoredResources": { + "post": { + "tags": [ + "MonitoredResources" + ], + "summary": "List the resources currently being monitored by the Elastic monitor resource.", + "operationId": "MonitoredResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MonitoredResources_List": { + "$ref": "./examples/MonitoredResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listDeploymentInfo": { + "post": { + "tags": [ + "DeploymentInfo" + ], + "summary": "Fetch information regarding Elastic cloud deployment corresponding to the Elastic monitor resource.", + "operationId": "DeploymentInfo_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentInfoResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "DeploymentInfo_List": { + "$ref": "./examples/DeploymentInfo_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createOrUpdateExternalUser": { + "post": { + "tags": [ + "DeploymentInfo" + ], + "summary": "Create User inside elastic deployment which are used by customers to perform operations on the elastic deployment", + "operationId": "ExternalUser_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic External User Creation Parameters", + "schema": { + "$ref": "#/definitions/ExternalUserInfo" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExternalUserCreationResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalUser_CreateOrUpdate": { + "$ref": "./examples/ExternalUserInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/getBillingInfo": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "Get marketplace and organization info mapped to the given monitor.", + "operationId": "BillingInfo_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BillingInfoResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingInfo_Get": { + "$ref": "./examples/BillingInfo_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listConnectedPartnerResources": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "List of all active deployments that are associated with the marketplace subscription linked to the given monitor.", + "operationId": "ConnectedPartnerResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ConnectedPartnerResourcesListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConnectedPartnerResources_List": { + "$ref": "./examples/ConnectedPartnerResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations": { + "get": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "List OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModelListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OpenAI_List": { + "$ref": "./examples/OpenAI_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations/{integrationName}": { + "get": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Get OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_Get": { + "$ref": "./examples/OpenAI_Get.json" + } + } + }, + "put": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Create or update a OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_CreateOrUpdate": { + "$ref": "./examples/OpenAI_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Delete OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_Delete": { + "$ref": "./examples/OpenAI_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations/{integrationName}/getStatus": { + "post": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Get OpenAI integration status for a given integration.", + "operationId": "OpenAI_GetStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationStatusResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_GetStatus": { + "$ref": "./examples/OpenAI_GetStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules": { + "get": { + "tags": [ + "Rules" + ], + "summary": "List the tag rules for a given monitor resource.", + "operationId": "TagRules_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRulesListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TagRules_List": { + "$ref": "./examples/TagRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules/{ruleSetName}": { + "put": { + "tags": [ + "Rules" + ], + "summary": "Create or update a tag rule set for a given monitor resource.", + "operationId": "TagRules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + }, + { + "description": "request body of MonitoringTagRules", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_CreateOrUpdate": { + "$ref": "./examples/TagRules_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Rules" + ], + "summary": "Get a tag rule set for a given monitor resource.", + "operationId": "TagRules_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Get": { + "$ref": "./examples/TagRules_Get.json" + } + } + }, + "delete": { + "tags": [ + "Rules" + ], + "summary": "Delete a tag rule set for a given monitor resource.", + "operationId": "TagRules_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TagRules_Delete": { + "$ref": "./examples/TagRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listVMHost": { + "post": { + "tags": [ + "VMHHostList" + ], + "summary": "List the vm resources currently being monitored by the Elastic monitor resource.", + "operationId": "VMHost_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/VMHostListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VMHost_List": { + "$ref": "./examples/VMHost_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/vmIngestionDetails": { + "post": { + "tags": [ + "VMIngestionDetails" + ], + "summary": "List the vm ingestion details that will be monitored by the Elastic monitor resource.", + "operationId": "VMIngestion_Details", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/VMIngestionDetailsResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "VMIngestion_Details": { + "$ref": "./examples/VMIngestion_Details.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/vmCollectionUpdate": { + "post": { + "tags": [ + "VMCollectionUpdate" + ], + "summary": "Update the vm details that will be monitored by the Elastic monitor resource.", + "operationId": "VMCollection_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "VM resource Id", + "schema": { + "$ref": "#/definitions/VMCollectionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "VMCollection_Update": { + "$ref": "./examples/VMCollection_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listUpgradableVersions": { + "post": { + "tags": [ + "MonitorUpgradableVersions" + ], + "summary": "List of upgradable versions for a given monitor resource.", + "operationId": "UpgradableVersions_Details", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UpgradableVersionsList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "UpgradableVersions_Details": { + "$ref": "./examples/UpgradableVersions_Details.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/upgrade": { + "post": { + "tags": [ + "DeploymentUpdate" + ], + "summary": "Upgradable version for a monitor resource.", + "operationId": "Monitor_Upgrade", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic Monitor Upgrade Parameters", + "schema": { + "$ref": "#/definitions/ElasticMonitorUpgrade" + } + } + ], + "responses": { + "202": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitor_Upgrade": { + "$ref": "./examples/Monitor_Upgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listAllTrafficFilters": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Get the list of all traffic filters for the account.", + "operationId": "AllTrafficFilters_list", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticTrafficFilterResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "AllTrafficFilters_list": { + "$ref": "./examples/AllTrafficFilters_list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listAssociatedTrafficFilters": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Get the list of all associated traffic filters for the given deployment.", + "operationId": "listAssociatedTrafficFilters_list", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticTrafficFilterResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "listAssociatedTrafficFilters_list": { + "$ref": "./examples/AssociatedFiltersForDeployment_list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createAndAssociateIPFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Create and Associate IP traffic filter for the given deployment.", + "operationId": "createAndAssociateIPFilter_Create", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "ips", + "description": "List of ips", + "type": "string" + }, + { + "in": "query", + "name": "name", + "description": "Name of the traffic filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "createAndAssociateIPFilter_Create": { + "$ref": "./examples/IPTrafficFilter_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createAndAssociatePLFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Create and Associate private link traffic filter for the given deployment.", + "operationId": "createAndAssociatePLFilter_Create", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "name", + "description": "Name of the traffic filter", + "type": "string" + }, + { + "in": "query", + "name": "privateEndpointGuid", + "description": "Guid of the private endpoint", + "type": "string" + }, + { + "in": "query", + "name": "privateEndpointName", + "description": "Name of the private endpoint", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "createAndAssociatePLFilter_Create": { + "$ref": "./examples/PrivateLinkTrafficFilters_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/associateTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Associate traffic filter for the given deployment.", + "operationId": "AssociateTrafficFilter_Associate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "AssociateTrafficFilter_Associate": { + "$ref": "./examples/AssociateTrafficFilter_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/detachAndDeleteTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Detach and Delete traffic filter from the given deployment.", + "operationId": "DetachAndDeleteTrafficFilter_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "DetachAndDeleteTrafficFilter_Delete": { + "$ref": "./examples/DetachAndDeleteTrafficFilter_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/detachTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Detach traffic filter for the given deployment.", + "operationId": "DetachTrafficFilter_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "DetachTrafficFilter_Update": { + "$ref": "./examples/DetachTrafficFilters_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/deleteTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Delete traffic filter from the account.", + "operationId": "TrafficFilters_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TrafficFilters_Delete": { + "$ref": "./examples/TrafficFilters_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getOrganizationApiKey": { + "post": { + "tags": [ + "ApiKey" + ], + "summary": "Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.", + "description": "Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.", + "operationId": "Organizations_GetApiKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "body", + "name": "body", + "description": "Email Id parameter of the User Organization, of which the API Key must be returned", + "schema": { + "$ref": "#/definitions/UserEmailId" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UserApiKeyResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_GetApiKey": { + "$ref": "./examples/Organizations_GetApiKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getElasticOrganizationToAzureSubscriptionMapping": { + "post": { + "tags": [ + "UserOrganization" + ], + "summary": "Get Elastic Organization To Azure Subscription Mapping details for the logged-in user.", + "description": "Get Elastic Organization To Azure Subscription Mapping details for the logged-in user.", + "operationId": "Organizations_GetElasticToAzureSubscriptionMapping", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticOrganizationToAzureSubscriptionMappingResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_GetElasticToAzureSubscriptionMapping": { + "$ref": "./examples/Organizations_GetElasticToAzureSubscriptionMapping.json" + } + } + } + } + }, + "definitions": { + "ErrorResponseBody": { + "description": "Error response body.", + "title": "ErrorResponseBody", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "target": { + "description": "Error target.", + "type": "string" + }, + "details": { + "description": "Error details.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + } + }, + "ResourceProviderDefaultErrorResponse": { + "description": "RP default error response.", + "type": "object", + "properties": { + "error": { + "description": "Response body of Error", + "readOnly": true, + "$ref": "#/definitions/ErrorResponseBody" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider, i.e., Microsoft.Elastic.", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'monitors'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write monitors'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "A Microsoft.Elastic REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name, i.e., {provider}/{resource}/{operation}.", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list the Microsoft.Elastic operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the Microsoft.Elastic provider.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "ResourceSku": { + "description": "Microsoft.Elastic SKU.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the SKU.", + "type": "string" + } + } + }, + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "type": "string", + "description": "Provisioning state of Elastic resource.", + "title": "ProvisioningState", + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + } + }, + "MonitoringStatus": { + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MonitoringStatus" + } + }, + "ElasticCloudUser": { + "description": "Details of the user's elastic account.", + "type": "object", + "properties": { + "emailAddress": { + "description": "Email of the Elastic User Account.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "User Id of the elastic account of the User.", + "type": "string", + "readOnly": true + }, + "elasticCloudSsoDefaultUrl": { + "description": "Elastic cloud default dashboard sso URL of the Elastic user account.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticCloudDeployment": { + "description": "Details of the user's elastic deployment associated with the monitor resource.", + "type": "object", + "properties": { + "name": { + "description": "Elastic deployment name", + "type": "string", + "readOnly": true + }, + "deploymentId": { + "description": "Elastic deployment Id", + "type": "string", + "readOnly": true + }, + "azureSubscriptionId": { + "description": "Associated Azure subscription Id for the elastic deployment.", + "type": "string", + "readOnly": true + }, + "elasticsearchRegion": { + "description": "Region where Deployment at Elastic side took place.", + "type": "string", + "readOnly": true + }, + "elasticsearchServiceUrl": { + "description": "Elasticsearch ingestion endpoint of the Elastic deployment.", + "type": "string", + "readOnly": true + }, + "kibanaServiceUrl": { + "description": "Kibana endpoint of the Elastic deployment.", + "type": "string", + "readOnly": true + }, + "kibanaSsoUrl": { + "description": "Kibana dashboard sso URL of the Elastic deployment.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticProperties": { + "description": "Elastic Resource Properties.", + "type": "object", + "properties": { + "elasticCloudUser": { + "description": "Details of the user's elastic account.", + "$ref": "#/definitions/ElasticCloudUser" + }, + "elasticCloudDeployment": { + "description": "Details of the elastic cloud deployment.", + "$ref": "#/definitions/ElasticCloudDeployment" + } + } + }, + "CompanyInfo": { + "description": "Company information of the user to be passed to partners.", + "type": "object", + "properties": { + "domain": { + "description": "Domain of the company", + "maxLength": 250, + "type": "string" + }, + "business": { + "description": "Business of the company", + "maxLength": 64, + "type": "string" + }, + "employeesNumber": { + "description": "Number of employees in the company", + "maxLength": 20, + "type": "string" + }, + "state": { + "description": "State of the company location.", + "maxLength": 64, + "type": "string" + }, + "country": { + "description": "Country of the company location.", + "maxLength": 64, + "type": "string" + } + } + }, + "UserInfo": { + "description": "User Information to be passed to partners.", + "type": "object", + "properties": { + "firstName": { + "description": "First name of the user", + "maxLength": 50, + "type": "string" + }, + "lastName": { + "description": "Last name of the user", + "maxLength": 50, + "type": "string" + }, + "companyName": { + "description": "Company name of the user", + "maxLength": 64, + "type": "string" + }, + "emailAddress": { + "description": "Email of the user used by Elastic for contacting them if needed", + "pattern": "^([^<>()\\[\\]\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\.,;:\\s@\"]+)*)@(([a-zA-Z-_0-9]+\\.)+[a-zA-Z]{2,})$", + "type": "string" + }, + "companyInfo": { + "description": "Company information of the user to be passed to partners.", + "$ref": "#/definitions/CompanyInfo" + } + } + }, + "PlanDetails": { + "description": "Plan details of the monitor resource.", + "type": "object", + "properties": { + "offerID": { + "description": "Offer ID of the plan", + "type": "string" + }, + "publisherID": { + "description": "Publisher ID of the plan", + "type": "string" + }, + "termID": { + "description": "Term ID of the plan", + "type": "string" + }, + "planID": { + "description": "Plan ID", + "type": "string" + }, + "planName": { + "description": "Plan Name", + "type": "string" + } + } + }, + "LiftrResourceCategories": { + "enum": [ + "Unknown", + "MonitorLogs" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "LiftrResourceCategories" + }, + "readOnly": true + }, + "MonitorProperties": { + "description": "Properties specific to the monitor resource.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the monitor resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "monitoringStatus": { + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "$ref": "#/definitions/MonitoringStatus" + }, + "elasticProperties": { + "description": "Elastic cloud properties.", + "$ref": "#/definitions/ElasticProperties" + }, + "userInfo": { + "description": "User information.", + "$ref": "#/definitions/UserInfo", + "x-ms-mutability": [ + "create" + ] + }, + "planDetails": { + "description": "Plan details of the monitor resource.", + "$ref": "#/definitions/PlanDetails" + }, + "version": { + "description": "Version of elastic of the monitor resource", + "type": "string" + }, + "subscriptionState": { + "description": "State of the Azure Subscription containing the monitor resource", + "type": "string" + }, + "saaSAzureSubscriptionStatus": { + "description": "Status of Azure Subscription where Marketplace SaaS is located.", + "type": "string" + }, + "sourceCampaignName": { + "description": "Name of the marketing campaign.", + "type": "string" + }, + "sourceCampaignId": { + "description": "A unique identifier associated with the campaign.", + "type": "string" + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories" + }, + "liftrResourcePreference": { + "description": "The priority of the resource.", + "format": "int32", + "type": "integer", + "readOnly": true + }, + "generateApiKey": { + "description": "Flag to determine if User API Key has to be generated and shared.", + "type": "boolean" + } + } + }, + "ManagedIdentityTypes": { + "enum": [ + "SystemAssigned" + ], + "type": "string", + "description": "Managed Identity types.", + "x-ms-enum": { + "modelAsString": true, + "name": "ManagedIdentityTypes" + } + }, + "IdentityProperties": { + "description": "Identity properties.", + "type": "object", + "properties": { + "principalId": { + "description": "The identity ID.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant ID of resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Managed identity type.", + "$ref": "#/definitions/ManagedIdentityTypes" + } + } + }, + "ElasticMonitorResource": { + "description": "Monitor resource.", + "required": [ + "location" + ], + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the monitor resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the monitor resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitor resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "SKU of the monitor resource.", + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "description": "Properties of the monitor resource.", + "$ref": "#/definitions/MonitorProperties", + "x-ms-client-flatten": false + }, + "identity": { + "description": "Identity properties of the monitor resource.", + "$ref": "#/definitions/IdentityProperties" + }, + "tags": { + "description": "The tags of the monitor resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "location": { + "description": "The location of the monitor resource", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "systemData": { + "readOnly": true, + "description": "The system metadata relating to this resource", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + } + } + }, + "ElasticMonitorResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ElasticMonitorResourceUpdateParameters": { + "description": "Monitor resource update parameters.", + "type": "object", + "properties": { + "tags": { + "description": "elastic monitor resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SendingLogs": { + "enum": [ + "True", + "False" + ], + "type": "string", + "description": "Flag indicating the status of the resource for sending logs operation to Elastic.", + "title": "SendingLogs", + "x-ms-enum": { + "modelAsString": true, + "name": "SendingLogs" + } + }, + "MonitoredResource": { + "description": "The properties of a resource currently being monitored by the Elastic monitor resource.", + "type": "object", + "properties": { + "id": { + "description": "The ARM id of the resource.", + "type": "string" + }, + "sendingLogs": { + "description": "Flag indicating the status of the resource for sending logs operation to Elastic.", + "$ref": "#/definitions/SendingLogs" + }, + "reasonForLogsStatus": { + "description": "Reason for why the resource is sending logs (or why it is not sending).", + "type": "string" + } + } + }, + "MonitoredResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MonitoredResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "TagAction": { + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion.", + "enum": [ + "Include", + "Exclude" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TagAction" + } + }, + "FilteringTag": { + "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.", + "type": "object", + "properties": { + "name": { + "description": "The name (also known as the key) of the tag.", + "type": "string" + }, + "value": { + "description": "The value of the tag.", + "type": "string" + }, + "action": { + "description": "Valid actions for a filtering tag.", + "$ref": "#/definitions/TagAction" + } + } + }, + "ElasticVersionListFormat": { + "description": "Elastic Version List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticVersionListProperties" + } + } + }, + "ElasticVersionListProperties": { + "description": "Elastic Version Properties", + "type": "object", + "properties": { + "version": { + "description": "Available elastic version of the given region", + "type": "string" + } + } + }, + "ElasticVersionsListResponse": { + "description": "List of elastic versions available in a region.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [ + "properties/version" + ], + "items": { + "$ref": "#/definitions/ElasticVersionListFormat" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "LogRules": { + "description": "Set of rules for sending logs for the Monitor resource.", + "type": "object", + "properties": { + "sendAadLogs": { + "description": "Flag specifying if AAD logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendSubscriptionLogs": { + "description": "Flag specifying if subscription logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendActivityLogs": { + "description": "Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.", + "type": "boolean" + }, + "filteringTags": { + "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "MonitoringTagRulesProperties": { + "description": "Definition of the properties for a TagRules resource.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the monitoring tag rules.", + "$ref": "#/definitions/ProvisioningState" + }, + "logRules": { + "description": "Rules for sending logs.", + "$ref": "#/definitions/LogRules" + } + } + }, + "MonitoringTagRules": { + "description": "Capture logs and metrics of Azure resources based on ARM tags.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the rule set.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the rule set.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the rule set.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the monitoring tag rules.", + "$ref": "#/definitions/MonitoringTagRulesProperties", + "x-ms-client-flatten": false + }, + "systemData": { + "readOnly": true, + "description": "The system metadata relating to this resource", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + } + } + }, + "MonitoringTagRulesListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "OpenAIIntegrationProperties": { + "description": "Open AI Integration details.", + "type": "object", + "properties": { + "openAIResourceId": { + "description": "The resource id of Open AI resource", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "openAIResourceEndpoint": { + "description": "The API endpoint for Open AI resource", + "type": "string", + "readOnly": true + }, + "key": { + "description": "Value of API key for Open AI resource", + "type": "string", + "x-ms-secret": true + }, + "lastRefreshAt": { + "format": "date-time", + "description": "Last Update Timestamp for key updation", + "type": "string", + "readOnly": true + } + } + }, + "OpenAIIntegrationRPModel": { + "description": "Capture properties of Open AI resource Integration.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the integration.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the integration.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the integration.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OpenAIIntegrationProperties" + } + } + }, + "OpenAIIntegrationRPModelListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "OpenAIIntegrationStatusResponse": { + "description": "Status of the OpenAI Integration", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/OpenAIIntegrationStatusResponseProperties" + } + } + }, + "OpenAIIntegrationStatusResponseProperties": { + "description": "Status of the OpenAI Integration", + "type": "object", + "properties": { + "status": { + "description": "Status of the OpenAI Integration", + "type": "string" + } + } + }, + "BillingInfoResponse": { + "description": "Marketplace Subscription and Organization details to which resource gets billed into.", + "type": "object", + "properties": { + "marketplaceSaasInfo": { + "description": "Marketplace Subscription details", + "$ref": "#/definitions/MarketplaceSaaSInfo" + }, + "partnerBillingEntity": { + "description": "Partner Billing Entity details: Organization Info", + "$ref": "#/definitions/PartnerBillingEntity" + } + } + }, + "MarketplaceSaaSInfo": { + "description": "Marketplace SAAS Info of the resource.", + "type": "object", + "properties": { + "marketplaceSubscription": { + "description": "Marketplace Subscription", + "type": "object", + "properties": { + "id": { + "description": "Marketplace Subscription Id. This is a GUID-formatted string.", + "type": "string" + } + } + }, + "marketplaceName": { + "description": "Marketplace Subscription Details: SAAS Name", + "type": "string" + }, + "marketplaceResourceId": { + "description": "Marketplace Subscription Details: Resource URI", + "type": "string" + }, + "marketplaceStatus": { + "description": "Marketplace Subscription Details: SaaS Subscription Status", + "type": "string" + }, + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into.", + "type": "string" + }, + "subscribed": { + "description": "Flag specifying if the Marketplace status is subscribed or not.", + "type": "boolean" + } + } + }, + "PartnerBillingEntity": { + "description": "Partner Billing details associated with the resource.", + "type": "object", + "properties": { + "id": { + "description": "The Elastic Organization Id.", + "type": "string" + }, + "name": { + "description": "The Elastic Organization Name.", + "type": "string" + }, + "partnerEntityUri": { + "description": "Link to the elastic organization page", + "type": "string" + } + } + }, + "ConnectedPartnerResourceProperties": { + "description": "Connected Partner Resource Properties", + "type": "object", + "properties": { + "partnerDeploymentName": { + "description": "Elastic deployment name", + "type": "string" + }, + "partnerDeploymentUri": { + "description": "Deployment URL of the elasticsearch in Elastic cloud deployment.", + "type": "string" + }, + "azureResourceId": { + "description": "The azure resource Id of the deployment.", + "type": "string" + }, + "location": { + "description": "The location of the deployment.", + "type": "string" + } + } + }, + "ConnectedPartnerResourcesListFormat": { + "description": "Connected Partner Resources List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConnectedPartnerResourceProperties" + } + } + }, + "ConnectedPartnerResourcesListResponse": { + "description": " List of all active elastic deployments.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [ + "properties/azureResourceId" + ], + "items": { + "$ref": "#/definitions/ConnectedPartnerResourcesListFormat" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ElasticDeploymentStatus": { + "description": "Flag specifying if the Elastic deployment status is healthy or not.", + "enum": [ + "Healthy", + "Unhealthy" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ElasticDeploymentStatus" + } + }, + "DeploymentInfoResponse": { + "description": "The properties of deployment in Elastic cloud corresponding to the Elastic monitor resource.", + "type": "object", + "properties": { + "status": { + "description": "The Elastic deployment status.", + "$ref": "#/definitions/ElasticDeploymentStatus", + "readOnly": true + }, + "version": { + "description": "Version of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "memoryCapacity": { + "description": "RAM capacity of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "diskCapacity": { + "description": "Disk capacity of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "elasticsearchEndPoint": { + "description": "Elasticsearch endpoint in Elastic cloud deployment. This is either the aliased_endpoint if available, or the service_url otherwise.", + "type": "string", + "readOnly": true + }, + "deploymentUrl": { + "description": "Deployment URL of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "marketplaceSaasInfo": { + "description": "Marketplace SaaS Info of the resource.", + "$ref": "#/definitions/MarketplaceSaaSInfo", + "readOnly": true + } + } + }, + "ExternalUserCreationResponse": { + "description": "The properties of the response we got from elastic while creating external user", + "type": "object", + "properties": { + "created": { + "description": "Shows if user is created or updated", + "type": "boolean", + "readOnly": true + } + } + }, + "ExternalUserInfo": { + "description": "The properties of the request required for creating user on elastic side", + "type": "object", + "properties": { + "userName": { + "description": "Username of the user to be created or updated", + "type": "string" + }, + "fullName": { + "description": "Full name of the user to be created or updated", + "type": "string" + }, + "password": { + "x-ms-secret": true, + "description": "Password of the user to be created or updated", + "type": "string" + }, + "emailId": { + "description": "Email id of the user to be created or updated", + "type": "string" + }, + "roles": { + "description": "Roles to be assigned for created or updated user", + "type": "array", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "VMHostListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/VMResources" + } + }, + "nextLink": { + "description": "Link to the next Vm resource Id, if any.", + "type": "string" + } + } + }, + "VMResources": { + "description": "The vm resource properties that is currently being monitored by the Elastic monitor resource.", + "type": "object", + "properties": { + "vmResourceId": { + "description": "The ARM id of the VM resource.", + "type": "string" + } + } + }, + "VMIngestionDetailsResponse": { + "description": "The vm ingestion details to install an agent.", + "type": "object", + "properties": { + "cloudId": { + "description": "The cloudId of given Elastic monitor resource.", + "type": "string" + }, + "ingestionKey": { + "description": "Ingestion details to install agent on given VM.", + "type": "string", + "x-ms-secret": true + } + } + }, + "OperationName": { + "enum": [ + "Add", + "Delete" + ], + "type": "string", + "description": "Operation to be performed on the given vm resource id.", + "title": "OperationName", + "x-ms-enum": { + "modelAsString": true, + "name": "OperationName" + } + }, + "VMCollectionUpdate": { + "description": "Update VM resource collection.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "vmResourceId": { + "description": "ARM id of the VM resource.", + "type": "string" + }, + "operationName": { + "description": "Operation to be performed for given VM.", + "$ref": "#/definitions/OperationName" + } + } + }, + "UpgradableVersionsList": { + "description": "Stack Versions that this version can upgrade to", + "type": "object", + "properties": { + "currentVersion": { + "type": "string", + "description": "Current version of the elastic monitor" + }, + "upgradableVersions": { + "type": "array", + "x-ms-identifiers": [], + "description": "Stack Versions that this version can upgrade to", + "items": { + "type": "string" + } + } + } + }, + "ElasticTrafficFilterResponse": { + "description": "List of elastic traffic filters in the account", + "type": "object", + "properties": { + "rulesets": { + "type": "array", + "x-ms-identifiers": [], + "description": "List of elastic traffic filters in the account", + "items": { + "$ref": "#/definitions/ElasticTrafficFilter" + } + } + } + }, + "ElasticTrafficFilter": { + "description": "Elastic traffic filter object", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the elastic filter" + }, + "name": { + "type": "string", + "description": "Name of the elastic filter" + }, + "description": { + "type": "string", + "description": "Description of the elastic filter" + }, + "region": { + "type": "string", + "description": "Region of the elastic filter" + }, + "type": { + "enum": [ + "ip", + "azure_private_endpoint" + ], + "type": "string", + "description": "Type of the elastic filter", + "x-ms-enum": { + "modelAsString": true, + "name": "type" + } + }, + "includeByDefault": { + "type": "boolean", + "description": "IncludeByDefault for the elastic filter" + }, + "rules": { + "type": "array", + "description": "Rules in the elastic filter", + "items": { + "$ref": "#/definitions/ElasticTrafficFilterRule" + } + } + } + }, + "ElasticTrafficFilterRule": { + "description": "Elastic traffic filter rule object", + "type": "object", + "properties": { + "source": { + "type": "string", + "description": "IP of the elastic filter rule" + }, + "description": { + "type": "string", + "description": "Description of the elastic filter rule" + }, + "azureEndpointGuid": { + "type": "string", + "description": "Guid of Private Endpoint in the elastic filter rule" + }, + "azureEndpointName": { + "type": "string", + "description": "Name of the Private Endpoint in the elastic filter rule" + }, + "id": { + "type": "string", + "description": "Id of the elastic filter rule" + } + } + }, + "ElasticMonitorUpgrade": { + "description": "Upgrade elastic monitor version", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Version to which the elastic monitor should be upgraded to" + } + } + }, + "UserEmailId": { + "description": "Email Id of the User Organization, of which the API Key must be returned", + "type": "object", + "properties": { + "emailId": { + "type": "string", + "description": "The User email Id" + } + } + }, + "UserApiKeyResponse": { + "description": "The User Api Key created for the Organization associated with the User Email Id that was passed in the request", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UserApiKeyResponseProperties" + } + } + }, + "UserApiKeyResponseProperties": { + "type": "object", + "properties": { + "apiKey": { + "description": "The User Api Key Generated based on GenerateApiKey flag. This is applicable for non-Portal clients only.", + "type": "string", + "x-ms-secret": true + } + } + }, + "ElasticOrganizationToAzureSubscriptionMappingResponse": { + "description": "The Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticOrganizationToAzureSubscriptionMappingResponseProperties" + } + } + }, + "ElasticOrganizationToAzureSubscriptionMappingResponseProperties": { + "description": "The properties of Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.", + "type": "object", + "properties": { + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Organization belongs and gets billed into. This is empty for a new user OR a user without an Elastic Organization.", + "type": "string" + }, + "marketplaceSaasInfo": { + "description": "Marketplace SaaS Info of the resource.", + "$ref": "#/definitions/MarketplaceSaaSInfo", + "readOnly": true + }, + "elasticOrganizationId": { + "description": "The Elastic Organization Id.", + "type": "string" + }, + "elasticOrganizationName": { + "description": "The Elastic Organization Name.", + "type": "string" + } + } + } + }, + "parameters": { + "MonitorNameParameter": { + "in": "path", + "name": "monitorName", + "description": "Monitor resource name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RuleSetNameParameter": { + "in": "path", + "name": "ruleSetName", + "description": "Tag Rule Set resource name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "OpenAIIntegrationNameParameter": { + "in": "path", + "name": "integrationName", + "description": "OpenAI Integration name", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/AllTrafficFilters_list.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/AllTrafficFilters_list.json new file mode 100644 index 000000000000..484cbcc0fc1e --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/AllTrafficFilters_list.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "rulesets": [ + { + "id": "31d91b5afb6f4c2eaaf104c97b1991dd", + "name": "IPFromApi", + "description": "created from azure", + "type": "ip", + "includeByDefault": false, + "region": "azure-eastus", + "rules": [ + { + "id": "f0297dad72af4a5e964cddf817f35e65", + "description": "Allow inbound traffic from IP address 192.168.131.0", + "source": "192.168.131.0" + }, + { + "id": "f9c00169f0e54931ae72aabde326b589", + "description": "Allow inbound traffic from IP address block 192.168.132.6/22", + "source": "192.168.132.6/22" + } + ] + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/AssociateTrafficFilter_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/AssociateTrafficFilter_Update.json new file mode 100644 index 000000000000..2fa3dd032540 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/AssociateTrafficFilter_Update.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/associateTrafficFilter?api-version=2024-03-01" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/AssociatedFiltersForDeployment_list.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/AssociatedFiltersForDeployment_list.json new file mode 100644 index 000000000000..484cbcc0fc1e --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/AssociatedFiltersForDeployment_list.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "rulesets": [ + { + "id": "31d91b5afb6f4c2eaaf104c97b1991dd", + "name": "IPFromApi", + "description": "created from azure", + "type": "ip", + "includeByDefault": false, + "region": "azure-eastus", + "rules": [ + { + "id": "f0297dad72af4a5e964cddf817f35e65", + "description": "Allow inbound traffic from IP address 192.168.131.0", + "source": "192.168.131.0" + }, + { + "id": "f9c00169f0e54931ae72aabde326b589", + "description": "Allow inbound traffic from IP address block 192.168.132.6/22", + "source": "192.168.132.6/22" + } + ] + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/BillingInfo_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/BillingInfo_Get.json new file mode 100644 index 000000000000..d50d70e10fba --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/BillingInfo_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status", + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "subscribed": true + }, + "partnerBillingEntity": { + "id": "1234567890", + "name": "elasticOrganizationName", + "partnerEntityUri": "https://example.com" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/ConnectedPartnerResources_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/ConnectedPartnerResources_List.json new file mode 100644 index 000000000000..1cc37fd6930d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/ConnectedPartnerResources_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "partnerDeploymentName": "deploymentname", + "partnerDeploymentUri": "https://examplessourl.com", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US 2" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/DeploymentInfo_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/DeploymentInfo_List.json new file mode 100644 index 000000000000..0cd1d5db4db3 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/DeploymentInfo_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "status": "Healthy", + "version": "7.9.3", + "memoryCapacity": "1024", + "diskCapacity": "245760", + "elasticsearchEndPoint": "alias.es.eastus2.staging.azure.foundit.no", + "deploymentUrl": "https://endpoint.eastus.kb.azure.elastic-cloud.com:9243", + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/DetachAndDeleteTrafficFilter_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/DetachAndDeleteTrafficFilter_Delete.json new file mode 100644 index 000000000000..d29f8c4eb86d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/DetachAndDeleteTrafficFilter_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/DetachTrafficFilters_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/DetachTrafficFilters_Update.json new file mode 100644 index 000000000000..8b2270a7c8ed --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/DetachTrafficFilters_Update.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/detachTrafficFilter?api-version=2024-03-01" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/ElasticVersions_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/ElasticVersions_List.json new file mode 100644 index 000000000000..ae3b2e29cc5a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/ElasticVersions_List.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "region": "myregion", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "version1" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/ExternalUserInfo.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/ExternalUserInfo.json new file mode 100644 index 000000000000..3162069f3d0d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/ExternalUserInfo.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "UserName": "newuser", + "FullName": "fullname", + "Password": "Password", + "EmailId": "myemail@outlook.com", + "Roles": [ + "admin", + "other_role1" + ] + } + }, + "responses": { + "200": { + "body": { + "created": true + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/IPTrafficFilter_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/IPTrafficFilter_Create.json new file mode 100644 index 000000000000..23b98b38efe2 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/IPTrafficFilter_Create.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd", + "ips": "192.168.131.0, 192.168.132.6/22" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/createAndAssociateIPFilter?api-version=2024-03-01" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitor_Upgrade.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitor_Upgrade.json new file mode 100644 index 000000000000..fc26b379d1b9 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitor_Upgrade.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "version": "7.15.1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/upgrade?api-version=2024-03-01" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/MonitoredResources_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/MonitoredResources_List.json new file mode 100644 index 000000000000..28d08f52c102 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/MonitoredResources_List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "sendingLogs": "True", + "reasonForLogsStatus": "CapturedByRules" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Create.json new file mode 100644 index 000000000000..cec27d7c2bef --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Create.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "name": "myMonitor", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "userInfo": { + "firstName": "Alice", + "lastName": "Bob", + "companyName": "Microsoft", + "emailAddress": "alice@microsoft.com", + "companyInfo": { + "domain": "microsoft.com", + "business": "Technology", + "employeeNumber": "10000", + "state": "WA", + "country": "US" + } + }, + "planDetails": { + "offerID": "00000", + "publisherID": "1234", + "termID": "free_Monthly", + "planID": "xxxyyy", + "planName": "myPlan" + }, + "subscriptionState": "Suspended", + "saaSAzureSubscriptionStatus": "Subscribed", + "sourceCampaignName": "Elastic", + "sourceCampaignId": "0000" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Delete.json new file mode 100644 index 000000000000..797b066096c5 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname?api-version=2022-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Get.json new file mode 100644 index 000000000000..23f6fb5baa9f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_List.json new file mode 100644 index 000000000000..1ac50b95f00a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_ListByResourceGroup.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_ListByResourceGroup.json new file mode 100644 index 000000000000..63fe45c68dc8 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_ListByResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Update.json new file mode 100644 index 000000000000..2bbad9ef7bbc --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Monitors_Update.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "name": "myMonitor", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bob", + "companyName": "Microsoft", + "emailAddress": "alice@microsoft.com", + "companyInfo": { + "domain": "microsoft.com", + "business": "Technology", + "employeeNumber": "10000", + "state": "WA", + "country": "US" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_CreateOrUpdate.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_CreateOrUpdate.json new file mode 100644 index 000000000000..2b17e50986e9 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_CreateOrUpdate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default", + "requestBody": { + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "key": "**" + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_Delete.json new file mode 100644 index 000000000000..1b0b6fc7da41 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_Get.json new file mode 100644 index 000000000000..85ebecb3d2b3 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_GetStatus.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_GetStatus.json new file mode 100644 index 000000000000..95d425e29209 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_GetStatus.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "Succeeded" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_List.json new file mode 100644 index 000000000000..b263d3e139da --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/OpenAI_List.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Operations_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Operations_List.json new file mode 100644 index 000000000000..4384fd18aae2 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Operations_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Elastic/monitors/write", + "display": { + "provider": "Microsoft.Elastic", + "resource": "monitors", + "operation": "write", + "description": "Write monitors resource" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Organizations_GetApiKey.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Organizations_GetApiKey.json new file mode 100644 index 000000000000..4742b7af132f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Organizations_GetApiKey.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "requestBody": { + "emailId": "myemail@outlook.com" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "apiKey": "AbCdEfGhIjKlMnOpQrStUvWxYz" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Organizations_GetElasticToAzureSubscriptionMapping.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Organizations_GetElasticToAzureSubscriptionMapping.json new file mode 100644 index 000000000000..021920393510 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/Organizations_GetElasticToAzureSubscriptionMapping.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "properties": { + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status" + }, + "elasticOrganizationId": "1234567890", + "elasticOrganizationName": "elasticOrganizationName" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/PrivateLinkTrafficFilters_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/PrivateLinkTrafficFilters_Create.json new file mode 100644 index 000000000000..c6b4591c529c --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/PrivateLinkTrafficFilters_Create.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd", + "privateEndpointName": "myPrivateEndpoint", + "privateEndpointGuid": "fdb54d3b-e85e-4d08-8958-0d2f7g523df9" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/createAndAssociatePLFilter?api-version=2022-07-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_CreateOrUpdate.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_CreateOrUpdate.json new file mode 100644 index 000000000000..bac9b0c46d75 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_CreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default", + "requestBody": { + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_Delete.json new file mode 100644 index 000000000000..9b9c4aeb6bdb --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/tagRules/tagRuleName?api-version=2024-03-01" + } + }, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_Get.json new file mode 100644 index 000000000000..fffb2142d235 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_List.json new file mode 100644 index 000000000000..23fa54b3a72e --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TagRules_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TrafficFilters_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TrafficFilters_Delete.json new file mode 100644 index 000000000000..d29f8c4eb86d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/TrafficFilters_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/UpgradableVersions_Details.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/UpgradableVersions_Details.json new file mode 100644 index 000000000000..36991a50b2e7 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/UpgradableVersions_Details.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "currentVersion": "7.15.0", + "upgradableVersions": [ + "7.15.1", + "7.16.0" + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/VMCollection_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/VMCollection_Update.json new file mode 100644 index 000000000000..0a32b486b31a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/VMCollection_Update.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "vmResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualmachines/myVM", + "operationName": "Add" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/VMHost_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/VMHost_List.json new file mode 100644 index 000000000000..f330882b3e54 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/VMHost_List.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vmResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualmachines/myVM" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/VMIngestion_Details.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/VMIngestion_Details.json new file mode 100644 index 000000000000..7b19838d7e34 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2024-03-01/examples/VMIngestion_Details.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "cloudId": "myid123", + "ingestionKey": "Vmingeationkey" + } + } + } +} diff --git a/specification/elastic/resource-manager/readme.md b/specification/elastic/resource-manager/readme.md index d81ca937061a..f27cb395e391 100644 --- a/specification/elastic/resource-manager/readme.md +++ b/specification/elastic/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the elastic. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-11-01-preview +tag: package-2024-03-01 ``` ### Tag: package-2021-09-01-preview @@ -156,6 +156,32 @@ input-file: - Microsoft.Elastic/preview/2023-11-01-preview/elastic.json ``` +### Tag: package-2024-01-01-preview + +These settings apply only when `--tag=package-2024-01-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-01-01-preview' +input-file: + - Microsoft.Elastic/preview/2024-01-01-preview/elastic.json +suppressions: + - code: ResourceNameRestriction + from: elastic.json + reason: Addition of Pattern restriction will cause a breaking change as there is no restriction in previous api versions. +``` + +### Tag: package-2024-03-01 + +These settings apply only when `--tag=package-2024-03-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-03-01' +input-file: + - Microsoft.Elastic/stable/2024-03-01/elastic.json +suppressions: + - code: ResourceNameRestriction + from: elastic.json + reason: Addition of Pattern restriction will cause a breaking change as there is no restriction in previous api versions. +``` + --- # Code Generation @@ -216,6 +242,12 @@ directive: where: - $.definitions.VMIngestionDetailsResponse.properties.ingestionKey reason: Secrets are OK to return in a POST response. + - suppress: ResourceNameRestriction + from: + - Microsoft.Elastic/preview/2024-01-01/elastic.json + where: + - $.definitions.parameters.MonitorNameParameter + reason: Addition of Pattern restriction will cause a breaking change as there is no restriction in previous api versions ``` diff --git a/specification/elasticsan/resource-manager/readme.python.md b/specification/elasticsan/resource-manager/readme.python.md index e79873f42beb..f38a0f44cda3 100644 --- a/specification/elasticsan/resource-manager/readme.python.md +++ b/specification/elasticsan/resource-manager/readme.python.md @@ -17,3 +17,8 @@ clear-output-folder: true no-namespace-folders: true output-folder: $(python-sdks-folder)/elasticsan/azure-mgmt-elasticsan/azure/mgmt/elasticsan ``` + +``` yaml $(python) +modelerfour: + flatten-models: false +``` diff --git a/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/PrivateCloud.json b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/PrivateCloud.json new file mode 100644 index 000000000000..e756614f0572 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/PrivateCloud.json @@ -0,0 +1,216 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-01-01", + "title": "Schema of Azure VMware Solution events published to Azure Event Grid", + "description": "Describes the schema of the Azure VMware Solution events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent." + }, + "paths": {}, + "definitions": { + "AvsPrivateCloudUpdatingEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdating event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsPrivateCloudEventData" + } + ], + "properties": {} + }, + "AvsPrivateCloudUpdatedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdated event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsPrivateCloudEventData" + } + ], + "properties": {} + }, + "AvsPrivateCloudFailedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudFailed event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsPrivateCloudEventData" + } + ], + "properties": { + "failureMessage": { + "description": "Failure reason of an event.", + "type": "string" + } + } + }, + "AvsClusterCreatedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterCreated event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ], + "properties": {} + }, + "AvsClusterDeletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterDeleted event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ], + "properties": {} + }, + "AvsClusterUpdatingEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdating event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ], + "properties": {} + }, + "AvsClusterUpdatedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdated event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ], + "properties": {} + }, + "AvsClusterFailedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterFailed event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ], + "properties": { + "failureMessage": { + "description": "Failure reason of an event.", + "type": "string" + } + } + }, + "AvsScriptExecutionStartedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionStarted event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ], + "properties": {} + }, + "AvsScriptExecutionFinishedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFinished event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ], + "properties": { + "namedOutputs": { + "description": "Named outputs of completed execution, if any.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AvsScriptExecutionCancelledEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionCancelled event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ], + "properties": {} + }, + "AvsScriptExecutionFailedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFailed event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ], + "properties": { + "failureMessage": { + "description": "Failure reason of an event.", + "type": "string" + } + } + }, + "AvsPrivateCloudEventData": { + "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/privateClouds events.", + "type": "object", + "properties": { + "operationId": { + "description": "Id of the operation that caused this event.", + "type": "string" + } + } + }, + "AvsClusterEventData": { + "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/clusters events.", + "type": "object", + "properties": { + "operationId": { + "description": "Id of the operation that caused this event.", + "type": "string" + }, + "addedHostNames": { + "description": "Hosts added to the cluster in this event, if any.", + "type": "array", + "items": { + "type": "string" + } + }, + "removedHostNames": { + "description": "Hosts removed to the cluster in this event, if any.", + "type": "array", + "items": { + "type": "string" + } + }, + "inMaintenanceHostNames": { + "description": "Hosts in Maintenance mode in the cluster, if any.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AvsScriptExecutionEventData": { + "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/scriptExecutions events.", + "type": "object", + "properties": { + "operationId": { + "description": "Id of the operation that caused this event.", + "type": "string" + }, + "cmdletId": { + "description": "Cmdlet referenced in the execution that caused this event.", + "type": "string" + }, + "output": { + "description": "Stdout outputs from the execution, if any.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } +} diff --git a/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/cloud-events-schema/cluster_updated.json b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/cloud-events-schema/cluster_updated.json new file mode 100644 index 000000000000..2adbf6f6aef2 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/cloud-events-schema/cluster_updated.json @@ -0,0 +1,20 @@ +{ + "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.AVS/privateClouds/{sddc_name}", + "subject": "/clusters/{cluster_name}", + "type": "Microsoft.AVS.ClusterUpdated", + "time": "2023-12-09T16:50:19.9995668-05:00", + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "data": { + "addedHostNames": [ + "esx17-r04.p01.431cc…" + ], + "removedHostNames": [ + "esx15-r01.p01.431cc…" + ], + "inMaintenanceHostNames": [ + "esx01-r03.p01.431cc…" + ], + "operationId": "c8c0b304-2db3-402b-8a6b-06065e0e1755" + }, + "specVersion": "1.0" +} diff --git a/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/cloud-events-schema/privatecloud_updating.json b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/cloud-events-schema/privatecloud_updating.json new file mode 100644 index 000000000000..46fc2a5f5f55 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/cloud-events-schema/privatecloud_updating.json @@ -0,0 +1,11 @@ +{ + "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.AVS/privateClouds/{sddc_name}", + "subject": "", + "type": "Microsoft.AVS.PrivateCloudUpdating", + "time": "2023-12-09T16:50:19.9995668-05:00", + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "data": { + "operationId": "6dcd7db8-0679-40d9-bb8a-6f2a684395e2" + }, + "specVersion": "1.0" +} diff --git a/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/cloud-events-schema/script_execution_failed.json b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/cloud-events-schema/script_execution_failed.json new file mode 100644 index 000000000000..c0dd518b9012 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/cloud-events-schema/script_execution_failed.json @@ -0,0 +1,14 @@ +{ + "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.AVS/privateClouds/{sddc_name}", + "subject": "/scriptExecutions/{execution_name}", + "type": "Microsoft.AVS.ScriptExecutionFailed", + "time": "2023-12-09T16:50:19.9995668-05:00", + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "data": { + "operationId": "fe1cb595-71c8-47d7-b505-60d39a44d53d", + "failureMessage": "05/04/2023 03:15:40 Get-SpbmStoragePolicy SpbmStoragePolicy with name ' RAID-5 FTT-1' was not found using the specified filter(s).", + "cmdletId": "Microsoft.AVS.Management@5.3.70/Set-LocationStoragePolicy", + "output": [] + }, + "specVersion": "1.0" +} diff --git a/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/event-grid-schema/cluster_updated.json b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/event-grid-schema/cluster_updated.json new file mode 100644 index 000000000000..8e8bf8e22b1d --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/event-grid-schema/cluster_updated.json @@ -0,0 +1,21 @@ +{ + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "eventType": "Microsoft.AVS.ClusterUpdated", + "topic": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.AVS/privateClouds/{sddc_name}", + "data": { + "addedHostNames": [ + "esx17-r04.p01.431cc…" + ], + "removedHostNames": [ + "esx15-r01.p01.431cc…" + ], + "inMaintenanceHostNames": [ + "esx01-r03.p01.431cc…" + ], + "operationId": "c8c0b304-2db3-402b-8a6b-06065e0e1755" + }, + "subject": "/clusters/{cluster_name}", + "dataversion": "1.0", + "metadataVersion": "1", + "eventTime": "2023-12-09T21:50:19.9995668+00:00" +} diff --git a/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/event-grid-schema/privatecloud_updating.json b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/event-grid-schema/privatecloud_updating.json new file mode 100644 index 000000000000..18ffc9c55306 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/event-grid-schema/privatecloud_updating.json @@ -0,0 +1,12 @@ +{ + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "eventType": "Microsoft.AVS.PrivateCloudUpdating", + "topic": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.AVS/privateClouds/{sddc_name}", + "data": { + "operationId": "6dcd7db8-0679-40d9-bb8a-6f2a684395e2" + }, + "subject": "", + "dataversion": "1.0", + "metadataVersion": "1", + "eventTime": "2023-12-09T21:50:19.9995668+00:00" +} diff --git a/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/event-grid-schema/script_execution_failed.json b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/event-grid-schema/script_execution_failed.json new file mode 100644 index 000000000000..82d310f42ec0 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/examples/event-grid-schema/script_execution_failed.json @@ -0,0 +1,15 @@ +{ + "id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b", + "eventType": "Microsoft.AVS.ScriptExecutionFailed", + "topic": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.AVS/privateClouds/{sddc_name}", + "data": { + "operationId": "fe1cb595-71c8-47d7-b505-60d39a44d53d", + "failureMessage": "05/04/2023 03:15:40 Get-SpbmStoragePolicy SpbmStoragePolicy with name ' RAID-5 FTT-1' was not found using the specified filter(s).", + "cmdletId": "Microsoft.AVS.Management@5.3.70/Set-LocationStoragePolicy", + "output": [] + }, + "subject": "/scriptExecutions/{execution_name}", + "dataversion": "1.0", + "metadataVersion": "1", + "eventTime": "2023-12-09T21:50:19.9995668+00:00" +} 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 f9c27dc6c67b..3ce639610677 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 @@ -1000,6 +1000,13 @@ "type": "object" } }, + "metadata": { + "description": "The chat thread created metadata", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "participants": { "description": "The list of properties of participants who are part of the thread", "type": "array", 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 a2c4912aeec3..73dc72814eb0 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 @@ -15,6 +15,9 @@ "properties": { "topic": "Talk about new Thread Events in commuication services" }, + "metadata": { + "key": "value" + }, "createTime": "2021-02-19T16:00:40.126-08:00", "version": 1613779447695, "threadId": "19:9e8eefe67b3c470a8187b4c2b00240bc@thread.v2", diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json index 12f99a19ac06..2e4f9a09a584 100644 --- a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json @@ -491,6 +491,76 @@ "$ref": "./examples/event-grid-schema/storage_task_completed.json" } } + }, + "StorageTaskAssignmentQueuedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentQueued event.", + "type": "object", + "properties": { + "queuedDateTime": { + "description": "The time at which a storage task was queued.", + "format": "date-time", + "type": "string", + "x-ms-client-name": "queuedOn" + }, + "taskExecutionId": { + "description": "The execution id for a storage task.", + "type": "string" + } + }, + "x-ms-examples": { + "StorageTaskAssignmentQueuedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/storage_task_assignment_queued.json" + }, + "StorageTaskAssignmentQueuedEventGridSchema": { + "$ref": "./examples/event-grid-schema/storage_task_assignment_queued.json" + } + } + }, + "StorageTaskAssignmentCompletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentCompleted event.", + "type": "object", + "properties": { + "status": { + "description": "The status for a storage task.", + "type": "string", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "StorageTaskAssignmentCompletedStatus", + "modelAsString": true + } + }, + "completedDateTime": { + "description": "The time at which a storage task was completed.", + "format": "date-time", + "type": "string", + "x-ms-client-name": "completedOn" + }, + "taskExecutionId": { + "description": "The execution id for a storage task.", + "type": "string" + }, + "taskName": { + "description": "The task name for a storage task.", + "type": "string" + }, + "summaryReportBlobUrl": { + "description": "The summary report blob url for a storage task", + "format": "url", + "type": "string", + "x-ms-client-name": "summaryReportBlobUri" + } + }, + "x-ms-examples": { + "StorageTaskAssignmentCompletedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/storage_task_assignment_completed.json" + }, + "StorageTaskAssignmentCompletedEventGridSchema": { + "$ref": "./examples/event-grid-schema/storage_task_assignment_completed.json" + } + } } } } diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/storage_task_assignment_completed.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/storage_task_assignment_completed.json new file mode 100644 index 000000000000..9d1912550bd3 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/storage_task_assignment_completed.json @@ -0,0 +1,15 @@ +{ + "source": "/subscriptions/c86a9c18-8373-41fa-92d4-1d7bdc16977b/resourceGroups/shubhajTestRG/providers/Microsoft.Storage/storageAccounts/canaryfns", + "subject": "DataManagement/StorageActions/StorageTaskAssignments", + "type": "Microsoft.Storage.StorageTaskAssignmentCompleted", + "time": "2023-11-27T23:09:21Z", + "id": "dd17c35c-e68a-437d be15-5417820310d2", + "data": { + "status": "Succeeded", + "completedDateTime": "2023-11-27T23:09:21Z", + "taskExecutionId": "testtest2-2023-11-27T21:16:43.4491131Z", + "taskName": "dizbbcanary2", + "summaryReportBlobUrl": "https://canaryfns.blob.core.windows.net/reports/dizbbcanary2/testtest2/2023-11-27T21:17:53/SummaryReport.json" + }, + "specversion": "1.0" +} diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/storage_task_assignment_queued.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/storage_task_assignment_queued.json new file mode 100644 index 000000000000..8eee1b30cbdd --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/storage_task_assignment_queued.json @@ -0,0 +1,12 @@ +{ + "source": "/subscriptions/c86a9c18-8373-41fa-92d4-1d7bdc16977b/resourceGroups/shubhajTestRG/providers/Microsoft.Storage/storageAccounts/canaryfns", + "subject": "DataManagement/StorageActions/StorageTaskAssignments", + "type": "Microsoft.Storage.StorageTaskAssignmentQueued", + "time": "2023-11-27T21:17:53Z", + "id": "59ff3f6f-696c-4cd2-a206-8012fc1a73f2", + "data": { + "queuedDateTime": "2023-11-27T21:17:53Z", + "taskExecutionId": "testtest2-2023-11-27T21:16:43.4491131Z" + }, + "specversion": "1.0" +} diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/event-grid-schema/storage_task_assignment_completed.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/event-grid-schema/storage_task_assignment_completed.json new file mode 100644 index 000000000000..e33b827af9c4 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/event-grid-schema/storage_task_assignment_completed.json @@ -0,0 +1,16 @@ +{ + "topic": "/subscriptions/c86a9c18-8373-41fa-92d4-1d7bdc16977b/resourceGroups/shubhajTestRG/providers/Microsoft.Storage/storageAccounts/canaryfns", + "subject": "DataManagement/StorageActions/StorageTaskAssignments", + "eventType": "Microsoft.Storage.StorageTaskAssignmentCompleted", + "id": "dd17c35c-e68a-437d be15-5417820310d2", + "data": { + "status": "Succeeded", + "completedDateTime": "2023-11-27T23:09:21Z", + "taskExecutionId": "testtest2-2023-11-27T21:16:43.4491131Z", + "taskName": "dizbbcanary2", + "summaryReportBlobUrl": "https://canaryfns.blob.core.windows.net/reports/dizbbcanary2/testtest2/2023-11-27T21:17:53/SummaryReport.json" + }, + "dataVersion": "1.0", + "metadataVersion": "1", + "eventTime": "2023-11-27T23:09:21Z" +} diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/event-grid-schema/storage_task_assignment_queued.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/event-grid-schema/storage_task_assignment_queued.json new file mode 100644 index 000000000000..bab3cfb08295 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/event-grid-schema/storage_task_assignment_queued.json @@ -0,0 +1,13 @@ +{ + "topic": "/subscriptions/c86a9c18-8373-41fa-92d4-1d7bdc16977b/resourceGroups/shubhajTestRG/providers/Microsoft.Storage/storageAccounts/canaryfns", + "subject": "DataManagement/StorageActions/StorageTaskAssignments", + "eventType": "Microsoft.Storage.StorageTaskAssignmentQueued", + "id": "59ff3f6f-696c-4cd2-a206-8012fc1a73f2", + "data": { + "queuedDateTime": "2023-11-27T21:17:53Z", + "taskExecutionId": "testtest2-2023-11-27T21:16:43.4491131Z" + }, + "dataVersion": "1.0", + "metadataVersion": "1", + "eventTime": "2023-11-27T21:17:53Z" +} diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index 5459d39db65e..58f44dc6168d 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -143,6 +143,7 @@ input-file: - Microsoft.ResourceNotifications/stable/2018-01-01/common.json - Microsoft.ResourceNotifications/stable/2018-01-01/HealthResources.json - Microsoft.ResourceNotifications/stable/2018-01-01/Resources.json +- Microsoft.AVS/stable/2018-01-01/PrivateCloud.json ``` ### Tag: package-2023-06-01-preview @@ -177,6 +178,7 @@ input-file: - Microsoft.ResourceNotifications/stable/2018-01-01/common.json - Microsoft.ResourceNotifications/stable/2018-01-01/HealthResources.json - Microsoft.ResourceNotifications/stable/2018-01-01/Resources.json +- Microsoft.AVS/stable/2018-01-01/PrivateCloud.json ``` ### Tag: package-2023-10-01-preview @@ -207,6 +209,7 @@ input-file: - Microsoft.ContainerService/stable/2018-01-01/ContainerService.json - Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json - Microsoft.HealthcareApis/stable/2018-01-01/HealthcareApis.json +- Microsoft.AVS/stable/2018-01-01/PrivateCloud.json ``` @@ -238,6 +241,7 @@ input-file: - Microsoft.ContainerService/stable/2018-01-01/ContainerService.json - Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json - Microsoft.HealthcareApis/stable/2018-01-01/HealthcareApis.json +- Microsoft.AVS/stable/2018-01-01/PrivateCloud.json ``` @@ -333,6 +337,7 @@ input-file: - $(this-folder)/Microsoft.ResourceNotifications/stable/2018-01-01/common.json - $(this-folder)/Microsoft.ResourceNotifications/stable/2018-01-01/HealthResources.json - $(this-folder)/Microsoft.ResourceNotifications/stable/2018-01-01/Resources.json + - $(this-folder)/Microsoft.AVS/stable/2018-01-01/PrivateCloud.json ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/binaryHardeningResults.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/binaryHardeningResults.json new file mode 100644 index 000000000000..e1199c24bf37 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/binaryHardeningResults.json @@ -0,0 +1,195 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-10", + "title": "IoT Firmware Defense", + "description": "Firmware & IoT Security REST 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/binaryHardeningResults": { + "get": { + "tags": [ + "BinaryHardening" + ], + "operationId": "BinaryHardening_ListByFirmware", + "description": "Lists binary hardening analysis results of a firmware.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BinaryHardeningListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BinaryHardening_ListByFirmware_MaximumSet_Gen": { + "$ref": "./examples/BinaryHardening_ListByFirmware_MaximumSet_Gen.json" + }, + "BinaryHardening_ListByFirmware_MinimumSet_Gen": { + "$ref": "./examples/BinaryHardening_ListByFirmware_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "BinaryHardeningFeatures": { + "type": "object", + "properties": { + "nx": { + "description": "NX (no-execute) flag.", + "type": "boolean" + }, + "pie": { + "description": "PIE (position independent executable) flag.", + "type": "boolean" + }, + "relro": { + "description": "RELRO (relocation read-only) flag.", + "type": "boolean" + }, + "canary": { + "description": "Canary (stack canaries) flag.", + "type": "boolean" + }, + "stripped": { + "description": "Stripped flag.", + "type": "boolean" + } + }, + "description": "Binary hardening features." + }, + "BinaryHardeningResult": { + "type": "object", + "properties": { + "binaryHardeningId": { + "description": "ID for the binary hardening result.", + "type": "string", + "x-nullable": true + }, + "features": { + "title": "BinaryHardeningFeatures", + "description": "Binary hardening features.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BinaryHardeningFeatures" + }, + "architecture": { + "description": "The architecture of the uploaded firmware.", + "type": "string", + "x-nullable": true + }, + "filePath": { + "description": "The executable path.", + "type": "string", + "x-nullable": true + }, + "class": { + "description": "The executable class to indicate 32 or 64 bit.", + "type": "string", + "x-nullable": true + }, + "runpath": { + "description": "The runpath of the uploaded firmware.", + "type": "string", + "x-nullable": true + }, + "rpath": { + "description": "The rpath of the uploaded firmware.", + "type": "string", + "x-nullable": true + } + }, + "description": "Binary hardening of a firmware." + }, + "BinaryHardeningResource": { + "type": "object", + "description": "binary hardening analysis result resource", + "properties": { + "properties": { + "title": "binary hardening result properties", + "description": "The properties of a binary hardening result found within a firmware image", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BinaryHardeningResult" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ] + }, + "BinaryHardeningListResult": { + "type": "object", + "description": "List of binary hardening results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BinaryHardeningResource" + }, + "description": "The list of binary hardening results." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of resources." + } + } + } + }, + "parameters": {} +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/common.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/common.json new file mode 100644 index 000000000000..3244130dcdd3 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/common.json @@ -0,0 +1,84 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-10", + "title": "IoT Firmware Defense", + "description": "The definitions and parameters in this swagger specification will be used to manage the IoT Firmware Defense resources." + }, + "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": { + "UrlToken": { + "type": "object", + "properties": { + "url": { + "description": "SAS URL for creating or accessing a blob file.", + "type": "string", + "format": "uri", + "readOnly": true + } + }, + "description": "Url data for creating or accessing a blob file." + }, + "PairedKey": { + "type": "object", + "description": "Details of a matching paired key or certificate.", + "properties": { + "id": { + "type": "string", + "description": "ID of the paired key or certificate." + }, + "type": { + "type": "string", + "description": "The type indicating whether the paired object is a key or certificate." + } + } + } + }, + "parameters": { + "FirmwareIdParameter": { + "name": "firmwareId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the firmware.", + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firmware analysis workspace.", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cryptoCertificates.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cryptoCertificates.json new file mode 100644 index 000000000000..1543a83cfb94 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cryptoCertificates.json @@ -0,0 +1,274 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-10", + "title": "IoT Firmware Defense", + "description": "Firmware & IoT Security REST 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/cryptoCertificates": { + "get": { + "tags": [ + "CryptoCertificates" + ], + "operationId": "CryptoCertificates_ListByFirmware", + "description": "Lists cryptographic certificate analysis results found in a firmware.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CryptoCertificateListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CryptoCertificates_ListByFirmware_MaximumSet_Gen": { + "$ref": "./examples/CryptoCertificates_ListByFirmware_MaximumSet_Gen.json" + }, + "CryptoCertificates_ListByFirmware_MinimumSet_Gen": { + "$ref": "./examples/CryptoCertificates_ListByFirmware_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "CryptoCertificateEntity": { + "type": "object", + "description": "Information on an entity (distinguished name) in a cryptographic certificate.", + "properties": { + "commonName": { + "description": "Common name of the certificate entity.", + "type": "string", + "x-nullable": true + }, + "organization": { + "description": "Organization of the certificate entity.", + "type": "string", + "x-nullable": true + }, + "organizationalUnit": { + "description": "The organizational unit of the certificate entity.", + "type": "string", + "x-nullable": true + }, + "state": { + "description": "Geographical state or province of the certificate entity.", + "type": "string", + "x-nullable": true + }, + "country": { + "description": "Country code of the certificate entity.", + "type": "string", + "x-nullable": true + } + } + }, + "CryptoCertificate": { + "type": "object", + "properties": { + "cryptoCertId": { + "description": "ID for the certificate result.", + "type": "string", + "x-nullable": true + }, + "name": { + "description": "Name of the certificate.", + "type": "string", + "x-nullable": true + }, + "subject": { + "description": "Subject information of the certificate.", + "$ref": "#/definitions/CryptoCertificateEntity", + "x-nullable": true + }, + "issuer": { + "description": "Issuer information of the certificate.", + "$ref": "#/definitions/CryptoCertificateEntity", + "x-nullable": true + }, + "issuedDate": { + "type": "string", + "format": "date-time", + "description": "Issue date for the certificate.", + "x-nullable": true + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Expiration date for the certificate.", + "x-nullable": true + }, + "role": { + "description": "Role of the certificate (Root CA, etc)", + "type": "string", + "x-nullable": true + }, + "signatureAlgorithm": { + "description": "The signature algorithm used in the certificate.", + "type": "string", + "x-nullable": true + }, + "keySize": { + "description": "Size of the certificate's key in bits", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "keyAlgorithm": { + "description": "Key algorithm used in the certificate.", + "type": "string", + "x-nullable": true + }, + "encoding": { + "description": "Encoding used for the certificate.", + "type": "string", + "x-nullable": true + }, + "serialNumber": { + "description": "Serial number of the certificate.", + "type": "string", + "x-nullable": true + }, + "fingerprint": { + "description": "Fingerprint of the certificate.", + "type": "string", + "x-nullable": true + }, + "usage": { + "description": "List of functions the certificate can fulfill.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "filePaths": { + "type": "array", + "readOnly": true, + "description": "List of files where this certificate was found.", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "pairedKey": { + "description": "A matching paired private key.", + "$ref": "./common.json#/definitions/PairedKey", + "x-nullable": true + }, + "isExpired": { + "description": "Indicates if the certificate is expired.", + "type": "boolean", + "x-nullable": true + }, + "isSelfSigned": { + "description": "Indicates if the certificate is self-signed.", + "type": "boolean", + "x-nullable": true + }, + "isWeakSignature": { + "description": "Indicates the signature algorithm used is insecure.", + "type": "boolean", + "x-nullable": true + }, + "isShortKeySize": { + "description": "Indicates the certificate's key size is considered too small to be secure for the key algorithm.", + "type": "boolean", + "x-nullable": true + } + }, + "description": "Crypto certificate properties" + }, + "CryptoCertificateResource": { + "type": "object", + "description": "Crypto certificate resource", + "properties": { + "properties": { + "title": "Crypto certificate properties", + "description": "The properties of a crypto certificate found within a firmware image", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CryptoCertificate" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ] + }, + "CryptoCertificateListResult": { + "type": "object", + "description": "List of crypto certificates.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CryptoCertificateResource" + }, + "description": "The list of crypto certificate results." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of resources." + } + } + } + }, + "parameters": {} +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cryptoKeys.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cryptoKeys.json new file mode 100644 index 000000000000..f0eaf5dc1dbb --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cryptoKeys.json @@ -0,0 +1,181 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-10", + "title": "IoT Firmware Defense", + "description": "Firmware & IoT Security REST 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/cryptoKeys": { + "get": { + "tags": [ + "CryptoKeys" + ], + "operationId": "CryptoKeys_ListByFirmware", + "description": "Lists cryptographic key analysis results found in a firmware.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CryptoKeyListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CryptoKeys_ListByFirmware_MaximumSet_Gen": { + "$ref": "./examples/CryptoKeys_ListByFirmware_MaximumSet_Gen.json" + }, + "CryptoKeys_ListByFirmware_MinimumSet_Gen": { + "$ref": "./examples/CryptoKeys_ListByFirmware_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "CryptoKey": { + "type": "object", + "properties": { + "cryptoKeyId": { + "description": "ID for the key result.", + "type": "string", + "x-nullable": true + }, + "keyType": { + "description": "Type of the key (public or private).", + "type": "string", + "x-nullable": true + }, + "keySize": { + "description": "Size of the key in bits.", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "keyAlgorithm": { + "description": "Key algorithm name.", + "type": "string", + "x-nullable": true + }, + "usage": { + "description": "Functions the key can fulfill.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "filePaths": { + "type": "array", + "readOnly": true, + "description": "List of files where this key was found.", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "pairedKey": { + "description": "A matching paired key or certificate.", + "$ref": "./common.json#/definitions/PairedKey", + "x-nullable": true + }, + "isShortKeySize": { + "description": "Indicates the key size is considered too small to be secure for the algorithm.", + "type": "boolean", + "x-nullable": true + } + }, + "description": "Crypto key properties" + }, + "CryptoKeyResource": { + "type": "object", + "description": "Crypto key resource", + "properties": { + "properties": { + "title": "Crypto key properties", + "description": "The properties of a crypto key found within a firmware image", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CryptoKey" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ] + }, + "CryptoKeyListResult": { + "type": "object", + "description": "List of crypto keys.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CryptoKeyResource" + }, + "description": "The list of crypto key results." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of resources." + } + } + } + }, + "parameters": {} +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cves.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cves.json new file mode 100644 index 000000000000..770131559841 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cves.json @@ -0,0 +1,221 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-10", + "title": "IoT Firmware Defense", + "description": "Firmware & IoT Security REST 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/cves": { + "get": { + "tags": [ + "CVEs" + ], + "operationId": "Cves_ListByFirmware", + "description": "Lists CVE analysis results of a firmware.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CveListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Cves_ListByFirmware_MaximumSet_Gen": { + "$ref": "./examples/Cves_ListByFirmware_MaximumSet_Gen.json" + }, + "Cves_ListByFirmware_MinimumSet_Gen": { + "$ref": "./examples/Cves_ListByFirmware_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "CveLink": { + "type": "object", + "description": "Properties of a reference link for a CVE.", + "properties": { + "href": { + "description": "The destination of the reference link.", + "type": "string", + "format": "uri", + "x-nullable": true + }, + "label": { + "description": "The label of the reference link.", + "type": "string", + "x-nullable": true + } + } + }, + "CveComponent": { + "type": "object", + "description": "Properties of the SBOM component for a CVE.", + "properties": { + "componentId": { + "description": "ID of the SBOM component", + "type": "string" + }, + "name": { + "description": "Name of the SBOM component", + "type": "string" + }, + "version": { + "description": "Version of the SBOM component.", + "type": "string" + } + } + }, + "CveResult": { + "type": "object", + "properties": { + "cveId": { + "description": "ID of the CVE result.", + "type": "string", + "x-nullable": true + }, + "component": { + "description": "The SBOM component for the CVE.", + "$ref": "#/definitions/CveComponent", + "x-nullable": true + }, + "severity": { + "description": "Severity of the CVE.", + "type": "string", + "x-nullable": true + }, + "name": { + "description": "Name of the CVE.", + "type": "string" + }, + "cvssScore": { + "description": "A single CVSS score to represent the CVE. If a V3 score is specified, then it will use the V3 score. Otherwise if the V2 score is specified it will be the V2 score.", + "type": "string", + "x-nullable": true + }, + "cvssVersion": { + "description": "CVSS version of the CVE.", + "type": "string", + "x-nullable": true + }, + "cvssV2Score": { + "description": "CVSS V2 score of the CVE.", + "type": "string", + "x-nullable": true + }, + "cvssV3Score": { + "description": "CVSS V3 score of the CVE.", + "type": "string", + "x-nullable": true + }, + "links": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CveLink" + }, + "description": "The list of reference links for the CVE.", + "x-ms-identifiers": [] + }, + "description": { + "description": "The CVE description.", + "type": "string", + "x-nullable": true + } + }, + "description": "Details of a CVE detected in firmware." + }, + "CveResource": { + "type": "object", + "description": "CVE analysis result resource", + "properties": { + "properties": { + "title": "CVE result properties", + "description": "The properties of a CVE result found within a firmware image", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CveResult" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ] + }, + "CveListResult": { + "type": "object", + "description": "List of CVE results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CveResource" + }, + "description": "The list of CVE results." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of resources." + } + } + } + }, + "parameters": {} +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/BinaryHardening_ListByFirmware_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/BinaryHardening_ListByFirmware_MaximumSet_Gen.json new file mode 100644 index 000000000000..a8cecdb82a5c --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/BinaryHardening_ListByFirmware_MaximumSet_Gen.json @@ -0,0 +1,58 @@ +{ + "title": "BinaryHardening_ListByFirmware", + "operationId": "BinaryHardening_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "binaryHardeningId": "cd31ca40-6772-44f8-9180-000000000000", + "architecture": "ARM", + "class": "Bit32", + "filePath": "/path/to/squashfs-root/bin/bcm_boot_launcher", + "rpath": "no", + "features": { + "nx": true, + "pie": false, + "relro": true, + "canary": false, + "stripped": true + } + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/binaryHardeningResults/cd31ca40-6772-44f8-9180-000000000000", + "name": "cd31ca40-6772-44f8-9180-000000000000", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/binaryHardeningResults" + }, + { + "properties": { + "binaryHardeningId": "5924e71d-5f38-444e-8b08-000000000000", + "architecture": "ARM", + "class": "Bit32", + "filePath": "/path/to/squashfs-root/bin/archerctl", + "rpath": "no", + "features": { + "nx": true, + "pie": false, + "relro": true, + "canary": false, + "stripped": true + } + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/binaryHardeningResults/5924e71d-5f38-444e-8b08-000000000000", + "name": "5924e71d-5f38-444e-8b08-000000000000", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/binaryHardeningResults" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/BinaryHardening_ListByFirmware_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/BinaryHardening_ListByFirmware_MinimumSet_Gen.json new file mode 100644 index 000000000000..cad4e037d6d7 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/BinaryHardening_ListByFirmware_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "BinaryHardening_ListByFirmware", + "operationId": "BinaryHardening_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoCertificates_ListByFirmware_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoCertificates_ListByFirmware_MaximumSet_Gen.json new file mode 100644 index 000000000000..d5a85e8a7049 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoCertificates_ListByFirmware_MaximumSet_Gen.json @@ -0,0 +1,108 @@ +{ + "title": "CryptoCertificates_ListByFirmware", + "operationId": "CryptoCertificates_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "cryptoCertId": "d402993a-eca1-4ef4-a13d-000000000000", + "name": "PolarSSL Test Client 2", + "issuedDate": "2023-09-24T15:52:04Z", + "expirationDate": "2035-09-22T15:52:04Z", + "role": "Non-CA", + "signatureAlgorithm": "sha256ECDSA", + "keyAlgorithm": "ECC", + "keySize": 256, + "encoding": "DER", + "serialNumber": "0D", + "fingerprint": "EA:70:F9:B4:45:F3:41:BC:33:22:34:A4:98:DD:69:04:1D:E8:82:05", + "usage": [], + "filePaths": [ + "/path/to/keys-certs/ntgr_ra_aws" + ], + "pairedKey": { + "type": "Private", + "id": "cd1bdece-0576-4ff5-8039-000000000000" + }, + "isExpired": false, + "isSelfSigned": false, + "isShortKeySize": false, + "subject": { + "commonName": "PolarSSL Test Client 2", + "organization": "PolarSSL", + "organizationalUnit": "", + "country": "NL", + "state": "" + }, + "issuer": { + "commonName": "Polarssl Test EC CA", + "organization": "PolarSSL", + "organizationalUnit": "", + "country": "NL", + "state": "" + } + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/cryptoCertificates/d402993a-eca1-4ef4-a13d-000000000000", + "name": "d402993a-eca1-4ef4-a13d-000000000000", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/cryptoCertificates" + }, + { + "properties": { + "cryptoCertId": "78fd7929-fac1-45cd-bfc6-000000000000", + "name": "DigiCert SHA2 Secure Server CA", + "issuedDate": "2013-03-08T12:00:00Z", + "expirationDate": "2023-03-08T12:00:00Z", + "role": "Intermediate", + "signatureAlgorithm": "sha256RSA", + "keyAlgorithm": "RSA", + "keySize": 2048, + "encoding": "DER", + "serialNumber": "01:FD:A3:EB:6E:CA:75:C8:88:43:8B:72:4B:CF:BC:91", + "fingerprint": "1F:B8:6B:11:68:EC:74:31:54:06:2E:8C:9C:C5:B1:71:A4:B7:CC:B4", + "usage": [ + "CrlSign", + "KeyCertSign", + "DigitalSignature" + ], + "filePaths": [ + "/path/to/keys-certs/revoke.pem", + "/path/to/keys-certs/sample.crt" + ], + "pairedKey": {}, + "isExpired": true, + "isSelfSigned": false, + "isShortKeySize": false, + "subject": { + "commonName": "DigiCert SHA2 Secure Server CA", + "organization": "DigiCert Inc", + "organizationalUnit": "", + "country": "US", + "state": "" + }, + "issuer": { + "commonName": "DigiCert Global Root CA", + "organization": "DigiCert Inc", + "organizationalUnit": "www.digicert.com", + "country": "US", + "state": "" + } + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/cryptoCertificates/78fd7929-fac1-45cd-bfc6-000000000000", + "name": "78fd7929-fac1-45cd-bfc6-000000000000", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/cryptoCertificates" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoCertificates_ListByFirmware_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoCertificates_ListByFirmware_MinimumSet_Gen.json new file mode 100644 index 000000000000..6429efa21375 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoCertificates_ListByFirmware_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "CryptoCertificates_ListByFirmware", + "operationId": "CryptoCertificates_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoKeys_ListByFirmware_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoKeys_ListByFirmware_MaximumSet_Gen.json new file mode 100644 index 000000000000..1a6e6e4f38a2 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoKeys_ListByFirmware_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "CryptoKeys_ListByFirmware", + "operationId": "CryptoKeys_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "cryptoKeyId": "cd1bdece-0576-4ff5-8039-000000000000", + "keyType": "Private", + "keySize": 256, + "usage": [], + "keyAlgorithm": "ECDsa", + "filePaths": [ + "/path/to/keys-certs/ntgr_ra_aws" + ], + "pairedKey": { + "type": "Public", + "id": "95f41328-cc3b-41a1-bd70-000000000000" + }, + "isShortKeySize": false + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/cryptoKeys/cd1bdece-0576-4ff5-8039-000000000000", + "name": "cd1bdece-0576-4ff5-8039-000000000000", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/cryptoKeys" + }, + { + "properties": { + "cryptoKeyId": "5adeaa85-f30a-4295-9b4a-000000000000", + "keyType": "Public", + "keySize": 1024, + "usage": [], + "keyAlgorithm": "RSA", + "filePaths": [ + "/path/to/keys-certs/addon.key" + ], + "pairedKey": {}, + "isShortKeySize": true + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/cryptoKeys/5adeaa85-f30a-4295-9b4a-000000000000", + "name": "5adeaa85-f30a-4295-9b4a-000000000000", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/cryptoKeys" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoKeys_ListByFirmware_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoKeys_ListByFirmware_MinimumSet_Gen.json new file mode 100644 index 000000000000..75702abee36e --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/CryptoKeys_ListByFirmware_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "CryptoKeys_ListByFirmware", + "operationId": "CryptoKeys_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Cves_ListByFirmware_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Cves_ListByFirmware_MaximumSet_Gen.json new file mode 100644 index 000000000000..476daa715d63 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Cves_ListByFirmware_MaximumSet_Gen.json @@ -0,0 +1,79 @@ +{ + "title": "Cves_ListByFirmware", + "operationId": "Cves_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "cveId": "7496e8a7-537e-40e4-a43b-000000000000", + "component": {}, + "severity": "High", + "name": "CVE-2018-1000500", + "cvssV2Score": "6.8", + "cvssV3Score": "8.1", + "links": [ + { + "label": "http://lists.busybox.net/pipermail/busybox/2018-May/086462.html", + "href": "http://lists.busybox.net/pipermail/busybox/2018-May/086462.html" + }, + { + "label": "https://git.busybox.net/busybox/commit/?id=45fa3f18adf57ef9d743038743d9c90573aeeb91", + "href": "https://git.busybox.net/busybox/commit/?id=45fa3f18adf57ef9d743038743d9c90573aeeb91" + }, + { + "href": "https://usn.ubuntu.com/4531-1/" + } + ], + "description": "Busybox contains a Missing SSL certificate validation vulnerability in The \"busybox wget\" applet that can result in arbitrary code execution. This attack appear to be exploitable via Simply download any file over HTTPS using \"busybox wget https://compromised-domain.com/important-file\".", + "cvssScore": "8.1", + "cvssVersion": "3" + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/cves/7496e8a7-537e-40e4-a43b-000000000000", + "name": "7496e8a7-537e-40e4-a43b-000000000000", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/cves" + }, + { + "properties": { + "cveId": "fad414da-0055-4dfb-a3d4-000000000000", + "component": {}, + "severity": "High", + "name": "CVE-2022-28391", + "cvssV2Score": "6.8", + "cvssV3Score": "8.8", + "links": [ + { + "label": "https://git.alpinelinux.org/aports/plain/main/busybox/0002-nslookup-sanitize-all-printed-strings-with-printable.patch", + "href": "https://git.alpinelinux.org/aports/plain/main/busybox/0002-nslookup-sanitize-all-printed-strings-with-printable.patch" + }, + { + "label": "https://gitlab.alpinelinux.org/alpine/aports/-/issues/13661", + "href": "https://gitlab.alpinelinux.org/alpine/aports/-/issues/13661" + }, + { + "label": "https://git.alpinelinux.org/aports/plain/main/busybox/0001-libbb-sockaddr2str-ensure-only-printable-characters-.patch", + "href": "https://git.alpinelinux.org/aports/plain/main/busybox/0001-libbb-sockaddr2str-ensure-only-printable-characters-.patch" + } + ], + "description": "BusyBox through 1.35.0 allows remote attackers to execute arbitrary code if netstat is used to print a DNS PTR record's value to a VT compatible terminal. Alternatively, the attacker could choose to change the terminal's colors.", + "cvssScore": "8.8", + "cvssVersion": "3" + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/cves/fad414da-0055-4dfb-a3d4-000000000000", + "name": "fad414da-0055-4dfb-a3d4-000000000000", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/cves" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Cves_ListByFirmware_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Cves_ListByFirmware_MinimumSet_Gen.json new file mode 100644 index 000000000000..562739f349e3 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Cves_ListByFirmware_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "Cves_ListByFirmware", + "operationId": "Cves_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Create_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..58ac1f536111 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Create_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "Firmwares_Create", + "operationId": "Firmwares_Create", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "firmwareId": "umrkdttp", + "api-version": "2024-01-10", + "firmware": { + "properties": { + "fileName": "wresexxulcdsdd", + "vendor": "vycmdhgtmepcptyoubztiuudpkcpd", + "model": "f", + "version": "s", + "description": "uz", + "fileSize": 17, + "status": "Pending", + "statusMessages": [ + { + "message": "ulvhmhokezathzzauiitu" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "fileName": "wresexxulcdsdd", + "vendor": "vycmdhgtmepcptyoubztiuudpkcpd", + "model": "f", + "version": "s", + "description": "uz", + "fileSize": 17, + "status": "Pending", + "statusMessages": [ + { + "message": "ulvhmhokezathzzauiitu" + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/firmwares/blah", + "name": "brmvnojpmxsgckdviynhxhftvcvbw", + "type": "vlxhdbrphhnttmxvawwwewza", + "systemData": { + "createdBy": "aylilpicryidesowemwnl", + "createdByType": "User", + "createdAt": "2023-02-19T06:40:29.228Z", + "lastModifiedBy": "bgtifu", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-02-19T06:40:29.228Z" + } + } + }, + "201": { + "body": { + "properties": { + "fileName": "wresexxulcdsdd", + "vendor": "vycmdhgtmepcptyoubztiuudpkcpd", + "model": "f", + "version": "s", + "description": "uz", + "fileSize": 17, + "status": "Pending", + "statusMessages": [ + { + "message": "ulvhmhokezathzzauiitu" + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/firmwares/blah", + "name": "brmvnojpmxsgckdviynhxhftvcvbw", + "type": "vlxhdbrphhnttmxvawwwewza", + "systemData": { + "createdBy": "aylilpicryidesowemwnl", + "createdByType": "User", + "createdAt": "2023-02-19T06:40:29.228Z", + "lastModifiedBy": "bgtifu", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-02-19T06:40:29.228Z" + } + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Create_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..185765d95cf2 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Create_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Firmwares_Create", + "operationId": "Firmwares_Create", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "firmwareId": "umrkdttp", + "api-version": "2024-01-10", + "firmware": {} + }, + "responses": { + "200": { + "body": {} + }, + "201": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Delete_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..29d4d084e725 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "Firmwares_Delete", + "operationId": "Firmwares_Delete", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "firmwareId": "umrkdttp", + "api-version": "2024-01-10" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Delete_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..29d4d084e725 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Delete_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "Firmwares_Delete", + "operationId": "Firmwares_Delete", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "firmwareId": "umrkdttp", + "api-version": "2024-01-10" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateDownloadUrl_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateDownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..7f0bb6f0979c --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateDownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Firmwares_GenerateDownloadUrl", + "operationId": "Firmwares_GenerateDownloadUrl", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "firmwareId": "umrkdttp", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "url": "https://i/am/a/sas/token" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateDownloadUrl_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateDownloadUrl_MinimumSet_Gen.json new file mode 100644 index 000000000000..d3009dbf622b --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateDownloadUrl_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "Firmwares_GenerateDownloadUrl", + "operationId": "Firmwares_GenerateDownloadUrl", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "firmwareId": "umrkdttp", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateFilesystemDownloadUrl_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateFilesystemDownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..1e8739477d90 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateFilesystemDownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Firmwares_GenerateFilesystemDownloadUrl", + "operationId": "Firmwares_GenerateFilesystemDownloadUrl", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "firmwareId": "umrkdttp", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "url": "https://i/am/a/sas/token" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateFilesystemDownloadUrl_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateFilesystemDownloadUrl_MinimumSet_Gen.json new file mode 100644 index 000000000000..bb42440d3f5a --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_GenerateFilesystemDownloadUrl_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "Firmwares_GenerateFilesystemDownloadUrl", + "operationId": "Firmwares_GenerateFilesystemDownloadUrl", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "firmwareId": "umrkdttp", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Get_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9a26965b0af0 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Get_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "Firmwares_Get", + "operationId": "Firmwares_Get", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "firmwareId": "umrkdttp", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "properties": { + "fileName": "wresexxulcdsdd", + "vendor": "vycmdhgtmepcptyoubztiuudpkcpd", + "model": "f", + "version": "s", + "description": "uz", + "fileSize": 17, + "status": "Pending", + "statusMessages": [ + { + "message": "ulvhmhokezathzzauiitu" + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/firmwares/blah", + "name": "brmvnojpmxsgckdviynhxhftvcvbw", + "type": "vlxhdbrphhnttmxvawwwewza", + "systemData": { + "createdBy": "aylilpicryidesowemwnl", + "createdByType": "User", + "createdAt": "2023-02-19T06:40:29.228Z", + "lastModifiedBy": "bgtifu", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-02-19T06:40:29.228Z" + } + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Get_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..d1f3dc386c4e --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "Firmwares_Get", + "operationId": "Firmwares_Get", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "firmwareId": "umrkdttp", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_ListByWorkspace_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_ListByWorkspace_MaximumSet_Gen.json new file mode 100644 index 000000000000..cd73ab316ba8 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_ListByWorkspace_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "Firmwares_ListByWorkspace", + "operationId": "Firmwares_ListByWorkspace", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "fileName": "wresexxulcdsdd", + "vendor": "vycmdhgtmepcptyoubztiuudpkcpd", + "model": "f", + "version": "s", + "description": "uz", + "fileSize": 17, + "status": "Pending", + "statusMessages": [ + { + "message": "ulvhmhokezathzzauiitu" + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/firmwares/blah", + "name": "brmvnojpmxsgckdviynhxhftvcvbw", + "type": "vlxhdbrphhnttmxvawwwewza", + "systemData": { + "createdBy": "aylilpicryidesowemwnl", + "createdByType": "User", + "createdAt": "2023-02-19T06:40:29.228Z", + "lastModifiedBy": "bgtifu", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-02-19T06:40:29.228Z" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_ListByWorkspace_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_ListByWorkspace_MinimumSet_Gen.json new file mode 100644 index 000000000000..88fe689a53fe --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_ListByWorkspace_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "Firmwares_ListByWorkspace", + "operationId": "Firmwares_ListByWorkspace", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Update_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..ff2e337f3fcb --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Update_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "Firmwares_Update", + "operationId": "Firmwares_Update", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "firmwareId": "umrkdttp", + "api-version": "2024-01-10", + "firmware": { + "properties": { + "fileName": "wresexxulcdsdd", + "vendor": "vycmdhgtmepcptyoubztiuudpkcpd", + "model": "f", + "version": "s", + "description": "uz", + "fileSize": 17, + "status": "Pending", + "statusMessages": [ + { + "message": "ulvhmhokezathzzauiitu" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "fileName": "wresexxulcdsdd", + "vendor": "vycmdhgtmepcptyoubztiuudpkcpd", + "model": "f", + "version": "s", + "description": "uz", + "fileSize": 17, + "status": "Pending", + "statusMessages": [ + { + "message": "ulvhmhokezathzzauiitu" + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/firmwares/blah", + "name": "brmvnojpmxsgckdviynhxhftvcvbw", + "type": "vlxhdbrphhnttmxvawwwewza", + "systemData": { + "createdBy": "aylilpicryidesowemwnl", + "createdByType": "User", + "createdAt": "2023-02-19T06:40:29.228Z", + "lastModifiedBy": "bgtifu", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-02-19T06:40:29.228Z" + } + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Update_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..71ee4c083bf5 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Firmwares_Update_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "title": "Firmwares_Update", + "operationId": "Firmwares_Update", + "parameters": { + "subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE", + "resourceGroupName": "rgworkspaces-firmwares", + "workspaceName": "A7", + "firmwareId": "umrkdttp", + "api-version": "2024-01-10", + "firmware": {} + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Operations_List_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..975e1d407543 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "fvpbaphlxaooymk", + "isDataAction": true, + "display": { + "provider": "hjnmhvyawkrqwpakyneaal", + "resource": "erhsibwfehcpdah", + "operation": "tcikadfeehm", + "description": "xxtlajuenswnnpgrivilipjqc" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://nextlink" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Operations_List_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..cb8b5aba8ae8 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/PasswordHashes_ListByFirmware_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/PasswordHashes_ListByFirmware_MaximumSet_Gen.json new file mode 100644 index 000000000000..ce7ff4cf66a6 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/PasswordHashes_ListByFirmware_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "PasswordHashes_ListByFirmware", + "operationId": "PasswordHashes_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "passwordHashId": "d6c0397f-e52f-4808-a9df-000000000000", + "username": "anonymous", + "algorithm": "MD5", + "filePath": "/GzipExtractor/1/decompressed.bin", + "salt": "A17c6z5w", + "hash": "5OsdHjBn1p000000000000", + "context": "anonymous:$1$A17c6z5w$5OsdHjBn1p000000000000:2:0:99999:7:0:99999:0" + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/passwordHashes/d6c0397f-e52f-4808-a9df-000000000000", + "name": "d6c0397f-e52f-4808-a9df-000000000000", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/passwordHashes" + }, + { + "properties": { + "passwordHashId": "7a4f58c4-8613-41be-8a08-000000000000", + "username": "root", + "algorithm": "DES", + "filePath": "/GzipExtractor/1/decompressed.bin", + "salt": "ab", + "hash": "sxc000000000", + "context": "root:absxc000000000:0:0:root:/:/bin/sh" + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/passwordHashes/7a4f58c4-8613-41be-8a08-000000000000", + "name": "7a4f58c4-8613-41be-8a08-000000000000", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/passwordHashes" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/PasswordHashes_ListByFirmware_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/PasswordHashes_ListByFirmware_MinimumSet_Gen.json new file mode 100644 index 000000000000..f2dc9f97a4d6 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/PasswordHashes_ListByFirmware_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "PasswordHashes_ListByFirmware", + "operationId": "PasswordHashes_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/SbomComponents_ListByFirmware_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/SbomComponents_ListByFirmware_MaximumSet_Gen.json new file mode 100644 index 000000000000..8ed7ac3bf8f3 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/SbomComponents_ListByFirmware_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "SbomComponents_ListByFirmware", + "operationId": "SbomComponents_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "componentId": "busybox:1.30.1", + "componentName": "busybox", + "version": "1.30.1", + "license": "GPL-2.0-only", + "filePaths": [ + "/path/to/bin/busybox" + ] + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/sbomComponents/cd31ca40-6772-44f8-9180-000000000000", + "name": "cd31ca40-6772-44f8-9180-000000000000", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/sbomComponents" + }, + { + "properties": { + "componentId": "openvpn:2.4.6", + "componentName": "openvpn", + "version": "2.4.6", + "license": "GPL-2.0", + "filePaths": [ + "/path/to/squashfs-root/bin/openvpn" + ] + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/sbomComponents/5924e71d-5f38-444e-8b08-000000000000", + "name": "5924e71d-5f38-444e-8b08-000000000000", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/sbomComponents" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/SbomComponents_ListByFirmware_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/SbomComponents_ListByFirmware_MinimumSet_Gen.json new file mode 100644 index 000000000000..e927fa5c7be5 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/SbomComponents_ListByFirmware_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "SbomComponents_ListByFirmware", + "operationId": "SbomComponents_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_Get_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..01e0dbd5fd55 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_Get_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Summaries_Get", + "operationId": "Summaries_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "summaryName": "Firmware", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "properties": { + "summaryType": "Firmware", + "extractedSize": 302752916, + "extractedFileCount": 4171, + "componentCount": 35, + "binaryCount": 579, + "analysisTimeSeconds": 172, + "fileSize": 55326098, + "rootFileSystems": 2 + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/summaries/firmware", + "name": "firmware", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/summaries" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_Get_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..af977ff1615a --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_Get_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "title": "Summaries_Get", + "operationId": "Summaries_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "summaryName": "Firmware", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_ListByFirmware_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_ListByFirmware_MaximumSet_Gen.json new file mode 100644 index 000000000000..ca528e7d7df6 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_ListByFirmware_MaximumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "title": "Summaries_ListByFirmware", + "operationId": "Summaries_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "summaryType": "CVE" + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/summaries/CVE", + "name": "CVE", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/summaries" + }, + { + "properties": { + "summaryType": "BinaryHardening" + }, + "id": "/subscriptions/07aed47b-60ad-4d6e-a07a-000000000000/resourceGroups/FirmwareAnalysisRG/providers/Microsoft.IoTFirmwareDefense/workspaces/default/firmwares/109a9886-50bf-85a8-9d75-000000000000/summaries/BinaryHardening", + "name": "BinaryHardening", + "type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/summaries" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_ListByFirmware_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_ListByFirmware_MinimumSet_Gen.json new file mode 100644 index 000000000000..af45b9806baa --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Summaries_ListByFirmware_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "Summaries_ListByFirmware", + "operationId": "Summaries_ListByFirmware", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "FirmwareAnalysisRG", + "workspaceName": "default", + "firmwareId": "109a9886-50bf-85a8-9d75-000000000000", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Create_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..d565c0ef8df3 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Create_MaximumSet_Gen.json @@ -0,0 +1,63 @@ +{ + "title": "Workspaces_Create", + "operationId": "Workspaces_Create", + "parameters": { + "subscriptionId": "5443A01A-5242-4950-AC1A-2DD362180254", + "resourceGroupName": "rgworkspaces", + "workspaceName": "E___-3", + "api-version": "2024-01-10", + "workspace": { + "properties": {}, + "tags": { + "key450": "rzqqumbpfsbibnpirsm" + }, + "location": "jjwbseilitjgdrhbvvkwviqj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "key450": "rzqqumbpfsbibnpirsm" + }, + "location": "jjwbseilitjgdrhbvvkwviqj", + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/workspaces/blah", + "name": "tbrqhnzpsatbrnhtj", + "type": "angrpzpxmuppzqpzpljasjirao", + "systemData": { + "createdBy": "kmgstbzxtl", + "createdByType": "User", + "createdAt": "2023-02-19T05:35:25.545Z", + "lastModifiedBy": "rfnhyhbyqzxnumjmjhwkhduztidk", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-02-19T05:35:25.545Z" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "key450": "rzqqumbpfsbibnpirsm" + }, + "location": "jjwbseilitjgdrhbvvkwviqj", + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/workspaces/blah", + "name": "tbrqhnzpsatbrnhtj", + "type": "angrpzpxmuppzqpzpljasjirao", + "systemData": { + "createdBy": "kmgstbzxtl", + "createdByType": "User", + "createdAt": "2023-02-19T05:35:25.545Z", + "lastModifiedBy": "rfnhyhbyqzxnumjmjhwkhduztidk", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-02-19T05:35:25.545Z" + } + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Create_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..4a69c098eb9b --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Create_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "Workspaces_Create", + "operationId": "Workspaces_Create", + "parameters": { + "subscriptionId": "5443A01A-5242-4950-AC1A-2DD362180254", + "resourceGroupName": "rgworkspaces", + "workspaceName": "E___-3", + "api-version": "2024-01-10", + "workspace": { + "location": "jjwbseilitjgdrhbvvkwviqj" + } + }, + "responses": { + "200": { + "body": { + "location": "jjwbseilitjgdrhbvvkwviqj", + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/workspaces/blah", + "name": "tbrqhnzpsatbrnhtj", + "type": "angrpzpxmuppzqpzpljasjirao" + } + }, + "201": { + "body": { + "location": "jjwbseilitjgdrhbvvkwviqj", + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/workspaces/blah", + "name": "tbrqhnzpsatbrnhtj", + "type": "angrpzpxmuppzqpzpljasjirao" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Delete_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..67ca1c026a4a --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "Workspaces_Delete", + "operationId": "Workspaces_Delete", + "parameters": { + "subscriptionId": "5443A01A-5242-4950-AC1A-2DD362180254", + "resourceGroupName": "rgworkspaces", + "workspaceName": "E___-3", + "api-version": "2024-01-10" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Delete_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..67ca1c026a4a --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Delete_MinimumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "Workspaces_Delete", + "operationId": "Workspaces_Delete", + "parameters": { + "subscriptionId": "5443A01A-5242-4950-AC1A-2DD362180254", + "resourceGroupName": "rgworkspaces", + "workspaceName": "E___-3", + "api-version": "2024-01-10" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_GenerateUploadUrl_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_GenerateUploadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..a994cc2bcd31 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_GenerateUploadUrl_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Workspaces_GenerateUploadUrl", + "operationId": "Workspaces_GenerateUploadUrl", + "parameters": { + "subscriptionId": "5443A01A-5242-4950-AC1A-2DD362180254", + "resourceGroupName": "rgworkspaces", + "workspaceName": "E___-3", + "api-version": "2024-01-10", + "generateUploadUrl": { + "firmwareId": "ytsfprbywi" + } + }, + "responses": { + "200": { + "body": { + "url": "https://i/am/a/sas/token" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_GenerateUploadUrl_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_GenerateUploadUrl_MinimumSet_Gen.json new file mode 100644 index 000000000000..ce69b1ba3689 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_GenerateUploadUrl_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "Workspaces_GenerateUploadUrl", + "operationId": "Workspaces_GenerateUploadUrl", + "parameters": { + "subscriptionId": "5443A01A-5242-4950-AC1A-2DD362180254", + "resourceGroupName": "rgworkspaces", + "workspaceName": "E___-3", + "api-version": "2024-01-10", + "generateUploadUrl": {} + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Get_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..98e994fe79dd --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Get_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "title": "Workspaces_Get", + "operationId": "Workspaces_Get", + "parameters": { + "subscriptionId": "9781B4B5-0922-472A-80F0-B743D0596694", + "resourceGroupName": "rgworkspaces", + "workspaceName": "E_US", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "key6364": "itpmlxzoingnevgitv" + }, + "location": "zxwrauqottoy", + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/workspaces/blah", + "name": "vbgktdhddtb", + "type": "ux", + "systemData": { + "createdBy": "vnrbl", + "createdByType": "User", + "createdAt": "2023-04-21T14:59:45.580Z", + "lastModifiedBy": "zmmusinjpfjqy", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-04-21T14:59:45.580Z" + } + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Get_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..f966a1c35b68 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Get_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Workspaces_Get", + "operationId": "Workspaces_Get", + "parameters": { + "subscriptionId": "9781B4B5-0922-472A-80F0-B743D0596694", + "resourceGroupName": "rgworkspaces", + "workspaceName": "E_US", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "location": "zxwrauqottoy", + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/workspaces/blah", + "name": "tbrqhnzpsatbrnhtj", + "type": "angrpzpxmuppzqpzpljasjirao" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListByResourceGroup_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..588d415812c9 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "Workspaces_ListByResourceGroup", + "operationId": "Workspaces_ListByResourceGroup", + "parameters": { + "subscriptionId": "5443A01A-5242-4950-AC1A-2DD362180254", + "resourceGroupName": "rgworkspaces", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "key450": "rzqqumbpfsbibnpirsm" + }, + "location": "jjwbseilitjgdrhbvvkwviqj", + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/workspaces/blah", + "name": "tbrqhnzpsatbrnhtj", + "type": "angrpzpxmuppzqpzpljasjirao", + "systemData": { + "createdBy": "kmgstbzxtl", + "createdByType": "User", + "createdAt": "2023-02-19T05:35:25.545Z", + "lastModifiedBy": "rfnhyhbyqzxnumjmjhwkhduztidk", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-02-19T05:35:25.545Z" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListByResourceGroup_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..d05904845d94 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "Workspaces_ListByResourceGroup", + "operationId": "Workspaces_ListByResourceGroup", + "parameters": { + "subscriptionId": "5443A01A-5242-4950-AC1A-2DD362180254", + "resourceGroupName": "rgworkspaces", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListBySubscription_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..2130f905d20a --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "Workspaces_ListBySubscription", + "operationId": "Workspaces_ListBySubscription", + "parameters": { + "subscriptionId": "5443A01A-5242-4950-AC1A-2DD362180254", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "key450": "rzqqumbpfsbibnpirsm" + }, + "location": "jjwbseilitjgdrhbvvkwviqj", + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/workspaces/blah", + "name": "tbrqhnzpsatbrnhtj", + "type": "angrpzpxmuppzqpzpljasjirao", + "systemData": { + "createdBy": "kmgstbzxtl", + "createdByType": "User", + "createdAt": "2023-02-19T05:35:25.545Z", + "lastModifiedBy": "rfnhyhbyqzxnumjmjhwkhduztidk", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-02-19T05:35:25.545Z" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListBySubscription_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..47f90a362a62 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "title": "Workspaces_ListBySubscription", + "operationId": "Workspaces_ListBySubscription", + "parameters": { + "subscriptionId": "5443A01A-5242-4950-AC1A-2DD362180254", + "api-version": "2024-01-10" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Update_MaximumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..5fb87fa39122 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Update_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "Workspaces_Update", + "operationId": "Workspaces_Update", + "parameters": { + "subscriptionId": "5443A01A-5242-4950-AC1A-2DD362180254", + "resourceGroupName": "rgworkspaces", + "workspaceName": "E___-3", + "api-version": "2024-01-10", + "workspace": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "key450": "rzqqumbpfsbibnpirsm" + }, + "location": "jjwbseilitjgdrhbvvkwviqj", + "id": "/subscriptions/blah/resourceGroups/blah/providers/blah/workspaces/blah", + "name": "tbrqhnzpsatbrnhtj", + "type": "angrpzpxmuppzqpzpljasjirao", + "systemData": { + "createdBy": "kmgstbzxtl", + "createdByType": "User", + "createdAt": "2023-02-19T05:35:25.545Z", + "lastModifiedBy": "rfnhyhbyqzxnumjmjhwkhduztidk", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-02-19T05:35:25.545Z" + } + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Update_MinimumSet_Gen.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..f63d9a61fa17 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/examples/Workspaces_Update_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Workspaces_Update", + "operationId": "Workspaces_Update", + "parameters": { + "subscriptionId": "5443A01A-5242-4950-AC1A-2DD362180254", + "resourceGroupName": "rgworkspaces", + "workspaceName": "E___-3", + "api-version": "2024-01-10", + "workspace": {} + }, + "responses": { + "200": { + "body": { + "location": "jjwbseilitjgdrhbvvkwviqj" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/firmwares.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/firmwares.json new file mode 100644 index 000000000000..45207ad0a246 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/firmwares.json @@ -0,0 +1,537 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-10", + "title": "IoT Firmware Defense", + "description": "Firmware & IoT Security REST 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares": { + "get": { + "tags": [ + "Firmwares" + ], + "operationId": "Firmwares_ListByWorkspace", + "description": "Lists all of firmwares inside a workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirmwareList" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Firmwares_ListByWorkspace_MaximumSet_Gen": { + "$ref": "./examples/Firmwares_ListByWorkspace_MaximumSet_Gen.json" + }, + "Firmwares_ListByWorkspace_MinimumSet_Gen": { + "$ref": "./examples/Firmwares_ListByWorkspace_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}": { + "put": { + "tags": [ + "Firmwares" + ], + "operationId": "Firmwares_Create", + "description": "The operation to create a firmware.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FirmwareCreateBodyParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Firmware" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Firmware" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Firmwares_Create_MaximumSet_Gen": { + "$ref": "./examples/Firmwares_Create_MaximumSet_Gen.json" + }, + "Firmwares_Create_MinimumSet_Gen": { + "$ref": "./examples/Firmwares_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "Firmwares" + ], + "operationId": "Firmwares_Update", + "description": "The operation to update firmware.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FirmwareUpdateBodyParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Firmware" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Firmwares_Update_MaximumSet_Gen": { + "$ref": "./examples/Firmwares_Update_MaximumSet_Gen.json" + }, + "Firmwares_Update_MinimumSet_Gen": { + "$ref": "./examples/Firmwares_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "Firmwares" + ], + "operationId": "Firmwares_Delete", + "description": "The operation to delete a firmware.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Firmwares_Delete_MaximumSet_Gen": { + "$ref": "./examples/Firmwares_Delete_MaximumSet_Gen.json" + }, + "Firmwares_Delete_MinimumSet_Gen": { + "$ref": "./examples/Firmwares_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "Firmwares" + ], + "operationId": "Firmwares_Get", + "description": "Get firmware.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Firmware" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Firmwares_Get_MaximumSet_Gen": { + "$ref": "./examples/Firmwares_Get_MaximumSet_Gen.json" + }, + "Firmwares_Get_MinimumSet_Gen": { + "$ref": "./examples/Firmwares_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/generateDownloadUrl": { + "post": { + "tags": [ + "Firmwares" + ], + "operationId": "Firmwares_GenerateDownloadUrl", + "description": "The operation to a url for file download.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common.json#/definitions/UrlToken" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Firmwares_GenerateDownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/Firmwares_GenerateDownloadUrl_MaximumSet_Gen.json" + }, + "Firmwares_GenerateDownloadUrl_MinimumSet_Gen": { + "$ref": "./examples/Firmwares_GenerateDownloadUrl_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/generateFilesystemDownloadUrl": { + "post": { + "tags": [ + "Firmwares" + ], + "operationId": "Firmwares_GenerateFilesystemDownloadUrl", + "description": "The operation to a url for tar file download.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common.json#/definitions/UrlToken" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Firmwares_GenerateFilesystemDownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/Firmwares_GenerateFilesystemDownloadUrl_MaximumSet_Gen.json" + }, + "Firmwares_GenerateFilesystemDownloadUrl_MinimumSet_Gen": { + "$ref": "./examples/Firmwares_GenerateFilesystemDownloadUrl_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "FirmwareList": { + "type": "object", + "description": "List of firmwares", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Firmware" + }, + "description": "The list of firmwares." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of asset." + } + } + }, + "Firmware": { + "type": "object", + "description": "Firmware definition", + "properties": { + "properties": { + "title": "Firmware properties", + "description": "The properties of a firmware", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FirmwareProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ] + }, + "FirmwareUpdateDefinition": { + "type": "object", + "description": "Firmware definition", + "properties": { + "properties": { + "title": "Firmware properties", + "description": "The editable properties of a firmware", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FirmwareProperties" + } + } + }, + "FirmwareProperties": { + "type": "object", + "properties": { + "fileName": { + "type": "string", + "description": "File name for a firmware that user uploaded." + }, + "vendor": { + "type": "string", + "description": "Firmware vendor." + }, + "model": { + "type": "string", + "description": "Firmware model." + }, + "version": { + "type": "string", + "description": "Firmware version." + }, + "description": { + "type": "string", + "description": "User-specified description of the firmware." + }, + "fileSize": { + "description": "File size of the uploaded firmware image.", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "status": { + "type": "string", + "description": "The status of firmware scan.", + "enum": [ + "Pending", + "Extracting", + "Analyzing", + "Ready", + "Error" + ], + "default": "Pending", + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "statusMessages": { + "type": "array", + "description": "A list of errors or other messages generated during firmware analysis", + "items": { + "$ref": "#/definitions/StatusMessage" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "description": "Provisioning state of the resource.", + "type": "string", + "enum": [ + "Accepted", + "Succeeded", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "description": "Firmware properties." + }, + "StatusMessage": { + "type": "object", + "description": "Error and status message", + "properties": { + "errorCode": { + "description": "The error code", + "type": "integer", + "format": "int64" + }, + "message": { + "description": "The error or status message", + "type": "string" + } + } + } + }, + "parameters": { + "FirmwareCreateBodyParameter": { + "name": "firmware", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Firmware" + }, + "description": "Details of the firmware being created or updated.", + "x-ms-parameter-location": "method" + }, + "FirmwareUpdateBodyParameter": { + "name": "firmware", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirmwareUpdateDefinition" + }, + "description": "Details of the firmware being created or updated.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/operations.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/operations.json new file mode 100644 index 000000000000..7223641d72e4 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/operations.json @@ -0,0 +1,79 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-10", + "title": "IoT Firmware Defense", + "description": "Firmware & IoT Security REST 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": { + "/providers/Microsoft.IoTFirmwareDefense/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists the operations for this resource provider", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet_Gen": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/passwordHashes.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/passwordHashes.json new file mode 100644 index 000000000000..328316d8daca --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/passwordHashes.json @@ -0,0 +1,168 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-10", + "title": "IoT Firmware Defense", + "description": "Firmware & IoT Security REST 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/passwordHashes": { + "get": { + "tags": [ + "PasswordHashes" + ], + "operationId": "PasswordHashes_ListByFirmware", + "description": "Lists password hash analysis results of a firmware.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PasswordHashListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PasswordHashes_ListByFirmware_MaximumSet_Gen": { + "$ref": "./examples/PasswordHashes_ListByFirmware_MaximumSet_Gen.json" + }, + "PasswordHashes_ListByFirmware_MinimumSet_Gen": { + "$ref": "./examples/PasswordHashes_ListByFirmware_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "PasswordHash": { + "type": "object", + "properties": { + "passwordHashId": { + "description": "ID for password hash", + "type": "string", + "x-nullable": true + }, + "filePath": { + "description": "File path of the password hash", + "type": "string", + "x-nullable": true + }, + "salt": { + "description": "Salt of the password hash", + "type": "string", + "x-nullable": true + }, + "hash": { + "description": "Hash of the password", + "type": "string", + "x-nullable": true + }, + "context": { + "description": "Context of password hash", + "type": "string", + "x-nullable": true + }, + "username": { + "description": "User name of password hash", + "type": "string", + "x-nullable": true + }, + "algorithm": { + "description": "Algorithm of the password hash", + "type": "string", + "x-nullable": true + } + }, + "description": "Password hash properties" + }, + "PasswordHashResource": { + "type": "object", + "description": "Password hash resource", + "properties": { + "properties": { + "title": "Password hash properties", + "description": "The properties of a password hash found within a firmware image", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PasswordHash" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ] + }, + "PasswordHashListResult": { + "type": "object", + "description": "List of password hash results", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PasswordHashResource" + }, + "description": "The list of password hash results." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of resources." + } + } + } + }, + "parameters": {} +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/sbomComponents.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/sbomComponents.json new file mode 100644 index 000000000000..78d50066f90f --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/sbomComponents.json @@ -0,0 +1,158 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-10", + "title": "IoT Firmware Defense", + "description": "Firmware & IoT Security REST 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/sbomComponents": { + "get": { + "tags": [ + "SBOM" + ], + "operationId": "SbomComponents_ListByFirmware", + "description": "Lists SBOM analysis results of a firmware.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SbomComponentListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SbomComponents_ListByFirmware_MaximumSet_Gen": { + "$ref": "./examples/SbomComponents_ListByFirmware_MaximumSet_Gen.json" + }, + "SbomComponents_ListByFirmware_MinimumSet_Gen": { + "$ref": "./examples/SbomComponents_ListByFirmware_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "SbomComponent": { + "type": "object", + "properties": { + "componentId": { + "description": "ID for the component.", + "type": "string", + "x-nullable": true + }, + "componentName": { + "description": "Name for the component.", + "type": "string" + }, + "version": { + "description": "Version for the component.", + "type": "string" + }, + "license": { + "description": "License for the component.", + "type": "string", + "x-nullable": true + }, + "filePaths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "File paths related to the component." + } + }, + "description": "SBOM component of a firmware." + }, + "SbomComponentResource": { + "type": "object", + "description": "SBOM analysis result resource", + "properties": { + "properties": { + "title": "SBOM result properties", + "description": "The properties of an SBOM component found within a firmware image", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SbomComponent" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ] + }, + "SbomComponentListResult": { + "type": "object", + "description": "List of SBOM results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SbomComponentResource" + }, + "description": "The list of SBOM components." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of resources." + } + } + } + }, + "parameters": {} +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/summaries.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/summaries.json new file mode 100644 index 000000000000..9872abbe14e8 --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/summaries.json @@ -0,0 +1,455 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-10", + "title": "IoT Firmware Defense", + "description": "Firmware & IoT Security REST 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/summaries": { + "get": { + "tags": [ + "Summaries" + ], + "operationId": "Summaries_ListByFirmware", + "description": "Lists analysis result summary names of a firmware. To fetch the full summary data, get that summary by name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SummaryListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Summaries_ListByFirmware_MaximumSet_Gen": { + "$ref": "./examples/Summaries_ListByFirmware_MaximumSet_Gen.json" + }, + "Summaries_ListByFirmware_MinimumSet_Gen": { + "$ref": "./examples/Summaries_ListByFirmware_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/summaries/{summaryName}": { + "get": { + "tags": [ + "Summaries" + ], + "operationId": "Summaries_Get", + "description": "Get an analysis result summary of a firmware by name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "./common.json#/parameters/FirmwareIdParameter" + }, + { + "$ref": "#/parameters/SummaryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SummaryResource" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Summaries_Get_MaximumSet_Gen": { + "$ref": "./examples/Summaries_Get_MaximumSet_Gen.json" + }, + "Summaries_Get_MinimumSet_Gen": { + "$ref": "./examples/Summaries_Get_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "SummaryType": { + "type": "string", + "enum": [ + "Firmware", + "CVE", + "BinaryHardening", + "CryptoCertificate", + "CryptoKey" + ], + "description": "Describes the type of summary.", + "x-ms-enum": { + "modelAsString": true, + "name": "SummaryType" + } + }, + "SummaryListResult": { + "type": "object", + "description": "List of analysis summaries.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SummaryResource" + }, + "description": "The list of summaries." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of resources." + } + } + }, + "SummaryResourceProperties": { + "description": "Properties of an analysis summary.", + "type": "object", + "discriminator": "summaryType", + "properties": { + "summaryType": { + "$ref": "#/definitions/SummaryType" + } + }, + "readOnly": true, + "required": [ + "summaryType" + ] + }, + "SummaryResource": { + "description": "The object representing a firmware analysis summary resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/SummaryResourceProperties" + } + } + }, + "FirmwareSummary": { + "description": "Properties for high level summary of firmware analysis results.", + "type": "object", + "x-ms-discriminator-value": "Firmware", + "allOf": [ + { + "$ref": "#/definitions/SummaryResourceProperties" + } + ], + "properties": { + "extractedSize": { + "description": "Total extracted size of the firmware in bytes.", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "fileSize": { + "description": "Firmware file size in bytes.", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "extractedFileCount": { + "description": "Extracted file count.", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "componentCount": { + "description": "Components count.", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "binaryCount": { + "description": "Binary count", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "analysisTimeSeconds": { + "description": "Time used for analysis", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "rootFileSystems": { + "description": "The number of root file systems found.", + "type": "integer", + "format": "int64", + "x-nullable": true + } + } + }, + "CveSummary": { + "description": "Properties for a CVE analysis summary.", + "type": "object", + "x-ms-discriminator-value": "CVE", + "allOf": [ + { + "$ref": "#/definitions/SummaryResourceProperties" + } + ], + "properties": { + "critical": { + "description": "The total number of critical severity CVEs detected", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "high": { + "description": "The total number of high severity CVEs detected", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "medium": { + "description": "The total number of medium severity CVEs detected", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "low": { + "description": "The total number of low severity CVEs detected", + "type": "integer", + "format": "int64", + "x-nullable": true + }, + "unknown": { + "description": "The total number of unknown severity CVEs detected", + "type": "integer", + "format": "int64", + "x-nullable": true + } + } + }, + "BinaryHardeningSummaryResource": { + "description": "Properties for a binary hardening analysis summary.", + "type": "object", + "x-ms-discriminator-value": "BinaryHardening", + "allOf": [ + { + "$ref": "#/definitions/SummaryResourceProperties" + } + ], + "properties": { + "totalFiles": { + "description": "Total number of binaries that were analyzed", + "type": "integer", + "format": "int64" + }, + "nx": { + "description": "NX summary percentage", + "type": "integer", + "format": "int32", + "x-nullable": true + }, + "pie": { + "description": "PIE summary percentage", + "type": "integer", + "format": "int32", + "x-nullable": true + }, + "relro": { + "description": "RELRO summary percentage", + "type": "integer", + "format": "int32", + "x-nullable": true + }, + "canary": { + "description": "Canary summary percentage", + "type": "integer", + "format": "int32", + "x-nullable": true + }, + "stripped": { + "description": "Stripped summary percentage", + "type": "integer", + "format": "int32", + "x-nullable": true + } + } + }, + "CryptoCertificateSummaryResource": { + "description": "Properties for cryptographic certificate summary.", + "type": "object", + "x-ms-discriminator-value": "CryptoCertificate", + "allOf": [ + { + "$ref": "#/definitions/SummaryResourceProperties" + } + ], + "properties": { + "totalCertificates": { + "description": "Total number of certificates found.", + "type": "integer", + "format": "int64" + }, + "pairedKeys": { + "description": "Total number of paired private keys found for the certificates.", + "type": "integer", + "format": "int64" + }, + "expired": { + "description": "Total number of expired certificates found.", + "type": "integer", + "format": "int64" + }, + "expiringSoon": { + "description": "Total number of nearly expired certificates found.", + "type": "integer", + "format": "int64" + }, + "weakSignature": { + "description": "Total number of certificates found using a weak signature algorithm.", + "type": "integer", + "format": "int64" + }, + "selfSigned": { + "description": "Total number of certificates found that are self-signed.", + "type": "integer", + "format": "int64" + }, + "shortKeySize": { + "description": "Total number of certificates found that have an insecure key size for the key algorithm.", + "type": "integer", + "format": "int64" + } + } + }, + "CryptoKeySummaryResource": { + "description": "Properties for cryptographic key summary.", + "type": "object", + "x-ms-discriminator-value": "CryptoKey", + "allOf": [ + { + "$ref": "#/definitions/SummaryResourceProperties" + } + ], + "properties": { + "totalKeys": { + "description": "Total number of cryptographic keys found.", + "type": "integer", + "format": "int64" + }, + "publicKeys": { + "description": "Total number of (non-certificate) public keys found.", + "type": "integer", + "format": "int64" + }, + "privateKeys": { + "description": "Total number of private keys found.", + "type": "integer", + "format": "int64" + }, + "pairedKeys": { + "description": "Total number of keys found that have a matching paired key or certificate.", + "type": "integer", + "format": "int64" + }, + "shortKeySize": { + "description": "Total number of keys found that have an insecure key size for the algorithm.", + "type": "integer", + "format": "int64" + } + } + } + }, + "parameters": { + "SummaryNameParameter": { + "name": "summaryName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]*$", + "minLength": 3, + "maxLength": 63, + "enum": [ + "Firmware", + "CVE", + "BinaryHardening", + "CryptoCertificate", + "CryptoKey" + ], + "x-ms-parameter-location": "method", + "description": "The Firmware analysis summary name describing the type of summary.", + "x-ms-enum": { + "modelAsString": true, + "name": "summaryName" + } + } + } +} diff --git a/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/workspaces.json b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/workspaces.json new file mode 100644 index 000000000000..fd4d6418d9af --- /dev/null +++ b/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/workspaces.json @@ -0,0 +1,468 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-01-10", + "title": "IoT Firmware Defense", + "description": "Firmware & IoT Security REST 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.IoTFirmwareDefense/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_ListBySubscription", + "description": "Lists all of the firmware analysis workspaces in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Workspaces_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/Workspaces_ListBySubscription_MaximumSet_Gen.json" + }, + "Workspaces_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/Workspaces_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_ListByResourceGroup", + "description": "Lists all of the firmware analysis workspaces in the specified resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Workspaces_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/Workspaces_ListByResourceGroup_MaximumSet_Gen.json" + }, + "Workspaces_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/Workspaces_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}": { + "put": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Create", + "description": "The operation to create or update a firmware analysis workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/WorkspaceCreateBodyParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspaces_Create_MaximumSet_Gen": { + "$ref": "./examples/Workspaces_Create_MaximumSet_Gen.json" + }, + "Workspaces_Create_MinimumSet_Gen": { + "$ref": "./examples/Workspaces_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Update", + "description": "The operation to update a firmware analysis workspaces.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/WorkspaceUpdateBodyParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspaces_Update_MaximumSet_Gen": { + "$ref": "./examples/Workspaces_Update_MaximumSet_Gen.json" + }, + "Workspaces_Update_MinimumSet_Gen": { + "$ref": "./examples/Workspaces_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Delete", + "description": "The operation to delete a firmware analysis workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspaces_Delete_MaximumSet_Gen": { + "$ref": "./examples/Workspaces_Delete_MaximumSet_Gen.json" + }, + "Workspaces_Delete_MinimumSet_Gen": { + "$ref": "./examples/Workspaces_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Get", + "description": "Get firmware analysis workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspaces_Get_MaximumSet_Gen": { + "$ref": "./examples/Workspaces_Get_MaximumSet_Gen.json" + }, + "Workspaces_Get_MinimumSet_Gen": { + "$ref": "./examples/Workspaces_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/generateUploadUrl": { + "post": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_GenerateUploadUrl", + "description": "The operation to get a url for file upload.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GenerateUploadUrlBodyParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common.json#/definitions/UrlToken" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspaces_GenerateUploadUrl_MaximumSet_Gen": { + "$ref": "./examples/Workspaces_GenerateUploadUrl_MaximumSet_Gen.json" + }, + "Workspaces_GenerateUploadUrl_MinimumSet_Gen": { + "$ref": "./examples/Workspaces_GenerateUploadUrl_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "WorkspaceProperties": { + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "type": "string", + "enum": [ + "Accepted", + "Succeeded", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "description": "Workspace properties." + }, + "Workspace": { + "type": "object", + "description": "Firmware analysis workspace.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "WorkspaceUpdateDefinition": { + "type": "object", + "description": "Firmware analysis workspace.", + "properties": { + "properties": { + "description": "The editable workspace properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties" + } + } + }, + "WorkspaceList": { + "type": "object", + "description": "Return a list of firmware analysis workspaces.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Workspace" + }, + "description": "The list of firmware analysis workspaces." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of asset." + } + } + }, + "GenerateUploadUrlRequest": { + "type": "object", + "description": "Properties for generating an upload URL", + "properties": { + "firmwareId": { + "type": "string", + "description": "A unique ID for the firmware to be uploaded." + } + } + } + }, + "parameters": { + "WorkspaceCreateBodyParameter": { + "name": "workspace", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "Parameters when creating a firmware analysis workspace.", + "x-ms-parameter-location": "method" + }, + "WorkspaceUpdateBodyParameter": { + "name": "workspace", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdateDefinition" + }, + "description": "Parameters when updating a firmware analysis workspace.", + "x-ms-parameter-location": "method" + }, + "GenerateUploadUrlBodyParameter": { + "name": "generateUploadUrl", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateUploadUrlRequest" + }, + "description": "Parameters when requesting a URL to upload firmware.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/fist/resource-manager/readme.md b/specification/fist/resource-manager/readme.md index 4316749e1cde..88383bf7af29 100644 --- a/specification/fist/resource-manager/readme.md +++ b/specification/fist/resource-manager/readme.md @@ -27,15 +27,34 @@ These are the global settings for the fist. ``` yaml openapi-type: arm openapi-subtype: providerHub -tag: package-2023-02-08-preview +tag: package-2024-01-10 ``` +### Tag: package-2024-01-10 + +These settings apply only when `--tag=package-2024-01-10` is specified on the command line. + +```yaml $(tag) == 'package-2024-01-10' +input-file: + - Microsoft.IoTFirmwareDefense/stable/2024-01-10/binaryHardeningResults.json + - Microsoft.IoTFirmwareDefense/stable/2024-01-10/common.json + - Microsoft.IoTFirmwareDefense/stable/2024-01-10/cryptoCertificates.json + - Microsoft.IoTFirmwareDefense/stable/2024-01-10/cryptoKeys.json + - Microsoft.IoTFirmwareDefense/stable/2024-01-10/cves.json + - Microsoft.IoTFirmwareDefense/stable/2024-01-10/firmwares.json + - Microsoft.IoTFirmwareDefense/stable/2024-01-10/operations.json + - Microsoft.IoTFirmwareDefense/stable/2024-01-10/passwordHashes.json + - Microsoft.IoTFirmwareDefense/stable/2024-01-10/sbomComponents.json + - Microsoft.IoTFirmwareDefense/stable/2024-01-10/summaries.json + - Microsoft.IoTFirmwareDefense/stable/2024-01-10/workspaces.json +``` + ### Tag: package-2023-02-08-preview These settings apply only when `--tag=package-2023-02-08-preview` is specified on the command line. -```yaml $(tag) == 'package-2023-02-08-preview' +``` yaml $(tag) == 'package-2023-02-08-preview' input-file: - Microsoft.IoTFirmwareDefense/preview/2023-02-08-preview/common.json - Microsoft.IoTFirmwareDefense/preview/2023-02-08-preview/firmwares.json @@ -56,7 +75,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - - repo: azure-sdk-for-go + - repo: azure-sdk-for-go-track2 - repo: azure-sdk-for-js - repo: azure-resource-manager-schemas - repo: azure-cli-extensions @@ -81,7 +100,3 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp See configuration in [readme.csharp.md](./readme.csharp.md) - -## Java - -See configuration in [readme.java.md](./readme.java.md) diff --git a/specification/hardwaresecuritymodules/resource-manager/readme.go.md b/specification/hardwaresecuritymodules/resource-manager/readme.go.md index bc4babb77afb..46ca9713250f 100644 --- a/specification/hardwaresecuritymodules/resource-manager/readme.go.md +++ b/specification/hardwaresecuritymodules/resource-manager/readme.go.md @@ -15,6 +15,11 @@ module-name: sdk/resourcemanager/hardwaresecuritymodules/armhardwaresecuritymodu module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) azure-arm: true +directive: +- from: dedicatedhsm.json + where: $.definitions + transform: > + $.SystemData["x-ms-client-name"] = "DedicatedHsmSystemData"; ``` ### Go multi-api diff --git a/specification/hardwaresecuritymodules/resource-manager/readme.java.md b/specification/hardwaresecuritymodules/resource-manager/readme.java.md index 17c30ff97b5a..1aa45d54c395 100644 --- a/specification/hardwaresecuritymodules/resource-manager/readme.java.md +++ b/specification/hardwaresecuritymodules/resource-manager/readme.java.md @@ -4,4 +4,5 @@ These settings apply only when `--java` is specified on the command line. ``` yaml $(java) service-name: Hardware Security Modules +client-flattened-annotation-target: disabled ``` \ No newline at end of file diff --git a/specification/hardwaresecuritymodules/resource-manager/readme.md b/specification/hardwaresecuritymodules/resource-manager/readme.md index 4d8b4417f60a..dc78bbb6ccf6 100644 --- a/specification/hardwaresecuritymodules/resource-manager/readme.md +++ b/specification/hardwaresecuritymodules/resource-manager/readme.md @@ -31,6 +31,11 @@ openapi-type: arm tag: package-2023-12-preview ``` +``` yaml !$(typescript) +modelerfour: + flatten-models: false +``` + ### Tag: package-2018-10 These settings apply only when `--tag=package-2018-10` is specified on the command line. diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateAutoscaleCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateAutoscaleCluster.json new file mode 100644 index 000000000000..bda5723d3d02 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateAutoscaleCluster.json @@ -0,0 +1,354 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1", + "HDInsightCluster": { + "location": "West US 2", + "properties": { + "clusterType": "Trino", + "computeProfile": { + "nodes": [ + { + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 + } + ] + }, + "clusterProfile": { + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "trinoProfile": {}, + "sshProfile": { + "count": 2 + }, + "autoscaleProfile": { + "enabled": true, + "autoscaleType": "ScheduleBased", + "gracefulDecommissionTimeout": 3600, + "scheduleBasedConfig": { + "defaultCount": 10, + "timeZone": "Cen. Australia Standard Time", + "schedules": [ + { + "days": [ + "Monday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 20 + }, + { + "days": [ + "Sunday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 25 + } + ] + }, + "loadBasedConfig": { + "minNodes": 10, + "maxNodes": 20, + "pollInterval": 60, + "cooldownPeriod": 300, + "scalingRules": [ + { + "actionType": "scaleup", + "evaluationCount": 3, + "scalingMetric": "cpu", + "comparisonRule": { + "operator": "greaterThan", + "threshold": 90 + } + }, + { + "actionType": "scaledown", + "evaluationCount": 3, + "scalingMetric": "cpu", + "comparisonRule": { + "operator": "lessThan", + "threshold": 20 + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "Trino", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 + } + ] + }, + "clusterProfile": { + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", + "components": [ + { + "name": "Trino", + "version": "410" + }, + { + "name": "Hive metastore", + "version": "3.1.2" + } + ], + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "trinoProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + }, + "autoscaleProfile": { + "enabled": true, + "autoscaleType": "ScheduleBased", + "gracefulDecommissionTimeout": 3600, + "scheduleBasedConfig": { + "defaultCount": 10, + "timeZone": "Cen. Australia Standard Time", + "schedules": [ + { + "days": [ + "Monday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 20 + }, + { + "days": [ + "Sunday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 25 + } + ] + }, + "loadBasedConfig": { + "minNodes": 10, + "maxNodes": 20, + "pollInterval": 60, + "cooldownPeriod": 300, + "scalingRules": [ + { + "actionType": "scaleup", + "evaluationCount": 3, + "scalingMetric": "cpu", + "comparisonRule": { + "operator": "greaterThan", + "threshold": 90 + } + }, + { + "actionType": "scaledown", + "evaluationCount": 3, + "scalingMetric": "cpu", + "comparisonRule": { + "operator": "lessThan", + "threshold": 20 + } + } + ] + } + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Accepted", + "clusterType": "Trino", + "computeProfile": { + "nodes": [ + { + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 + } + ] + }, + "clusterProfile": { + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "trinoProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + }, + "autoscaleProfile": { + "enabled": true, + "autoscaleType": "ScheduleBased", + "gracefulDecommissionTimeout": 3600, + "scheduleBasedConfig": { + "defaultCount": 10, + "timeZone": "Cen. Australia Standard Time", + "schedules": [ + { + "days": [ + "Monday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 20 + }, + { + "days": [ + "Sunday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 25 + } + ] + }, + "loadBasedConfig": { + "minNodes": 10, + "maxNodes": 20, + "pollInterval": 60, + "cooldownPeriod": 300, + "scalingRules": [ + { + "actionType": "scaleup", + "evaluationCount": 3, + "scalingMetric": "cpu", + "comparisonRule": { + "operator": "greaterThan", + "threshold": 90 + } + }, + { + "actionType": "scaledown", + "evaluationCount": 3, + "scalingMetric": "cpu", + "comparisonRule": { + "operator": "lessThan", + "threshold": 20 + } + } + ] + } + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPool.json new file mode 100644 index 000000000000..6b62459601aa --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPool.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "ClusterPool": { + "location": "West US 2", + "properties": { + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "provisioningState": "Succeeded", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "aksClusterProfile": { + "aksVersion": "1.24", + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "provisioningState": "Accepted", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "aksClusterProfile": { + "aksVersion": "1.24", + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithPrivateAks.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithPrivateAks.json new file mode 100644 index 000000000000..f8e004e9bfb5 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithPrivateAks.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "ClusterPool": { + "location": "West US 2", + "properties": { + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2" + }, + "networkProfile": { + "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "enablePrivateApiServer": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "provisioningState": "Succeeded", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "aksClusterProfile": { + "aksVersion": "1.24", + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + }, + "networkProfile": { + "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "enablePrivateApiServer": true + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "provisioningState": "Accepted", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "aksClusterProfile": { + "aksVersion": "1.24", + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + }, + "networkProfile": { + "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "enablePrivateApiServer": true + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithUDRAks.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithUDRAks.json new file mode 100644 index 000000000000..6379c0cd473b --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithUDRAks.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "ClusterPool": { + "location": "West US 2", + "properties": { + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2" + }, + "networkProfile": { + "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "outboundType": "userDefinedRouting" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "provisioningState": "Succeeded", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "aksClusterProfile": { + "aksVersion": "1.24", + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + }, + "networkProfile": { + "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "outboundType": "userDefinedRouting" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "provisioningState": "Accepted", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "aksClusterProfile": { + "aksVersion": "1.24", + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + }, + "networkProfile": { + "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "outboundType": "userDefinedRouting" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateRangerCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateRangerCluster.json new file mode 100644 index 000000000000..46cba6645d3f --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateRangerCluster.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1", + "HDInsightCluster": { + "location": "West US 2", + "properties": { + "clusterType": "ranger", + "computeProfile": { + "nodes": [ + { + "type": "head", + "vmSize": "Standard_D3_v2", + "count": 2 + } + ] + }, + "clusterProfile": { + "clusterVersion": "0.0.1", + "ossVersion": "2.2.3", + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "rangerProfile": { + "rangerAdmin": { + "admins": [ + "testuser1@contoso.com", + "testuser2@contoso.com" + ], + "database": { + "host": "testsqlserver.database.windows.net", + "name": "testdb", + "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", + "username": "admin" + } + }, + "rangerAudit": { + "storageAccount": "https://teststorage.blob.core.windows.net/testblob" + }, + "rangerUsersync": { + "enabled": true, + "groups": [ + "0a53828f-36c9-44c3-be3d-99a7fce977ad", + "13be6971-79db-4f33-9d41-b25589ca25ac" + ], + "mode": "automatic", + "users": [ + "testuser1@contoso.com", + "testuser2@contoso.com" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "ranger", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "head", + "vmSize": "Standard_D3_v2", + "count": 2 + } + ] + }, + "clusterProfile": { + "clusterVersion": "0.0.1", + "ossVersion": "2.2.3", + "components": [ + { + "name": "HDFS", + "version": "2.2.3" + } + ], + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + } + }, + "rangerProfile": { + "rangerAdmin": { + "admins": [ + "testuser1@contoso.com", + "testuser2@contoso.com" + ], + "database": { + "host": "testsqlserver.database.windows.net", + "name": "testdb", + "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", + "username": "admin" + } + }, + "rangerAudit": { + "storageAccount": "https://teststorage.blob.core.windows.net/testblob" + }, + "rangerUsersync": { + "enabled": true, + "groups": [ + "0a53828f-36c9-44c3-be3d-99a7fce977ad", + "13be6971-79db-4f33-9d41-b25589ca25ac" + ], + "mode": "automatic", + "users": [ + "testuser1@contoso.com", + "testuser2@contoso.com" + ] + } + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Accepted", + "clusterType": "ranger", + "computeProfile": { + "nodes": [ + { + "type": "head", + "vmSize": "Standard_D3_v2", + "count": 2 + } + ] + }, + "clusterProfile": { + "clusterVersion": "0.0.1", + "ossVersion": "2.2.3", + "components": [ + { + "name": "HDFS", + "version": "2.2.3" + } + ], + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + } + }, + "rangerProfile": { + "rangerAdmin": { + "admins": [ + "testuser1@contoso.com", + "testuser2@contoso.com" + ], + "database": { + "host": "testsqlserver.database.windows.net", + "name": "testdb", + "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", + "username": "admin" + } + }, + "rangerAudit": { + "storageAccount": "https://teststorage.blob.core.windows.net/testblob" + }, + "rangerUsersync": { + "enabled": true, + "groups": [ + "0a53828f-36c9-44c3-be3d-99a7fce977ad", + "13be6971-79db-4f33-9d41-b25589ca25ac" + ], + "mode": "automatic", + "users": [ + "testuser1@contoso.com", + "testuser2@contoso.com" + ] + } + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkCluster.json new file mode 100644 index 000000000000..9ec97e0386cb --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkCluster.json @@ -0,0 +1,314 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1", + "HDInsightCluster": { + "location": "West US 2", + "properties": { + "clusterType": "spark", + "computeProfile": { + "nodes": [ + { + "type": "worker", + "vmSize": "Standard_D3_v2", + "count": 4 + } + ] + }, + "clusterProfile": { + "clusterVersion": "0.0.1", + "ossVersion": "2.2.3", + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "serviceConfigsProfiles": [ + { + "serviceName": "spark-service", + "configs": [ + { + "component": "spark-config", + "files": [ + { + "fileName": "spark-defaults.conf", + "values": { + "spark.eventLog.enabled": "true" + } + } + ] + } + ] + }, + { + "serviceName": "yarn-service", + "configs": [ + { + "component": "yarn-config", + "files": [ + { + "fileName": "core-site.xml", + "values": { + "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", + "storage.name": "teststorage", + "storage.protocol": "wasb", + "storage.key": "test key", + "storage.container": "testcontainer" + } + }, + { + "fileName": "yarn-site.xml", + "values": { + "yarn.webapp.ui2.enable": "false" + } + } + ] + } + ] + } + ], + "sparkProfile": {}, + "sshProfile": { + "count": 2 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "spark", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "worker", + "vmSize": "Standard_D3_v2", + "count": 4 + } + ] + }, + "clusterProfile": { + "clusterVersion": "0.0.1", + "ossVersion": "2.2.3", + "components": [ + { + "name": "HDFS", + "version": "2.2.3" + } + ], + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "serviceConfigsProfiles": [ + { + "serviceName": "spark-service", + "configs": [ + { + "component": "spark-config", + "files": [ + { + "fileName": "spark-defaults.conf", + "values": { + "spark.eventLog.enabled": "true" + } + } + ] + } + ] + }, + { + "serviceName": "yarn-service", + "configs": [ + { + "component": "yarn-config", + "files": [ + { + "fileName": "core-site.xml", + "values": { + "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", + "storage.name": "teststorage", + "storage.protocol": "wasb", + "storage.key": "test key", + "storage.container": "testcontainer" + } + }, + { + "fileName": "yarn-site.xml", + "values": { + "yarn.webapp.ui2.enable": "false" + } + } + ] + } + ] + } + ], + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "sparkProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Accepted", + "clusterType": "spark", + "computeProfile": { + "nodes": [ + { + "type": "worker", + "vmSize": "Standard_D3_v2", + "count": 4 + } + ] + }, + "clusterProfile": { + "clusterVersion": "0.0.1", + "ossVersion": "2.2.3", + "components": [ + { + "name": "HDFS", + "version": "2.2.3" + } + ], + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "serviceConfigsProfiles": [ + { + "serviceName": "spark-service", + "configs": [ + { + "component": "spark-config", + "files": [ + { + "fileName": "spark-defaults.conf", + "values": { + "spark.eventLog.enabled": "true" + } + } + ] + } + ] + }, + { + "serviceName": "yarn-service", + "configs": [ + { + "component": "yarn-config", + "files": [ + { + "fileName": "core-site.xml", + "values": { + "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", + "storage.name": "teststorage", + "storage.protocol": "wasb", + "storage.key": "test key", + "storage.container": "testcontainer" + } + }, + { + "fileName": "yarn-site.xml", + "values": { + "yarn.webapp.ui2.enable": "false" + } + } + ] + } + ] + } + ], + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "sparkProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkClusterWithInternalIngress.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkClusterWithInternalIngress.json new file mode 100644 index 000000000000..dc440404470c --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkClusterWithInternalIngress.json @@ -0,0 +1,331 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1", + "HDInsightCluster": { + "location": "West US 2", + "properties": { + "clusterType": "spark", + "computeProfile": { + "nodes": [ + { + "type": "worker", + "vmSize": "Standard_D3_v2", + "count": 4 + } + ] + }, + "clusterProfile": { + "clusterVersion": "0.0.1", + "ossVersion": "2.2.3", + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "serviceConfigsProfiles": [ + { + "serviceName": "spark-service", + "configs": [ + { + "component": "spark-config", + "files": [ + { + "fileName": "spark-defaults.conf", + "values": { + "spark.eventLog.enabled": "true" + } + } + ] + } + ] + }, + { + "serviceName": "yarn-service", + "configs": [ + { + "component": "yarn-config", + "files": [ + { + "fileName": "core-site.xml", + "values": { + "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", + "storage.name": "teststorage", + "storage.protocol": "wasb", + "storage.key": "test key", + "storage.container": "testcontainer" + } + }, + { + "fileName": "yarn-site.xml", + "values": { + "yarn.webapp.ui2.enable": "false" + } + } + ] + } + ] + } + ], + "sparkProfile": {}, + "sshProfile": { + "count": 2 + }, + "clusterAccessProfile": { + "enableInternalIngress": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "spark", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "worker", + "vmSize": "Standard_D3_v2", + "count": 4 + } + ] + }, + "clusterProfile": { + "clusterVersion": "0.0.1", + "ossVersion": "2.2.3", + "components": [ + { + "name": "HDFS", + "version": "2.2.3" + } + ], + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "serviceConfigsProfiles": [ + { + "serviceName": "spark-service", + "configs": [ + { + "component": "spark-config", + "files": [ + { + "fileName": "spark-defaults.conf", + "values": { + "spark.eventLog.enabled": "true" + } + } + ] + } + ] + }, + { + "serviceName": "yarn-service", + "configs": [ + { + "component": "yarn-config", + "files": [ + { + "fileName": "core-site.xml", + "values": { + "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", + "storage.name": "teststorage", + "storage.protocol": "wasb", + "storage.key": "test key", + "storage.container": "testcontainer" + } + }, + { + "fileName": "yarn-site.xml", + "values": { + "yarn.webapp.ui2.enable": "false" + } + } + ] + } + ] + } + ], + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net", + "privateFqdn": "cluster1-int.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0", + "privateSshEndpoint": "cluster1-int.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1", + "privateSshEndpoint": "cluster1-int.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "sparkProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + }, + "clusterAccessProfile": { + "enableInternalIngress": true, + "privateLinkServiceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/privateLinkServices/testpls" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Accepted", + "clusterType": "spark", + "computeProfile": { + "nodes": [ + { + "type": "worker", + "vmSize": "Standard_D3_v2", + "count": 4 + } + ] + }, + "clusterProfile": { + "clusterVersion": "0.0.1", + "ossVersion": "2.2.3", + "components": [ + { + "name": "HDFS", + "version": "2.2.3" + } + ], + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "serviceConfigsProfiles": [ + { + "serviceName": "spark-service", + "configs": [ + { + "component": "spark-config", + "files": [ + { + "fileName": "spark-defaults.conf", + "values": { + "spark.eventLog.enabled": "true" + } + } + ] + } + ] + }, + { + "serviceName": "yarn-service", + "configs": [ + { + "component": "yarn-config", + "files": [ + { + "fileName": "core-site.xml", + "values": { + "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", + "storage.name": "teststorage", + "storage.protocol": "wasb", + "storage.key": "test key", + "storage.container": "testcontainer" + } + }, + { + "fileName": "yarn-site.xml", + "values": { + "yarn.webapp.ui2.enable": "false" + } + } + ] + } + ] + } + ], + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net", + "privateFqdn": "cluster1-int.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0", + "privateSshEndpoint": "cluster1-int.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1", + "privateSshEndpoint": "cluster1-int.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "sparkProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + }, + "clusterAccessProfile": { + "enableInternalIngress": true, + "privateLinkServiceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/privateLinkServices/testpls" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteCluster.json new file mode 100644 index 000000000000..ab356ffe418b --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteCluster.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "rg1", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1" + }, + "responses": { + "202": { + "description": "Cluster delete request accepted.", + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteClusterPool.json new file mode 100644 index 000000000000..26ea702f7a13 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteClusterPool.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "rg1", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1" + }, + "responses": { + "202": { + "description": "Cluster Pool delete request accepted.", + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetCluster.json new file mode 100644 index 000000000000..ef3dd6469186 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetCluster.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "Trino", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 + } + ] + }, + "clusterProfile": { + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", + "components": [ + { + "name": "Trino", + "version": "410" + }, + { + "name": "Hive metastore", + "version": "3.1.2" + } + ], + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "trinoProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterInstanceView.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterInstanceView.json new file mode 100644 index 000000000000..5e9a1173929b --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterInstanceView.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-11-01-preview", + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "clusterPoolName": "clusterPool1" + }, + "responses": { + "200": { + "body": { + "name": "default", + "properties": { + "status": { + "ready": "True", + "reason": "", + "message": "" + }, + "serviceStatuses": [ + { + "kind": "ZooKeeper", + "ready": "true", + "message": "" + } + ] + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterPool.json new file mode 100644 index 000000000000..b8b6b322e021 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterPool.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "provisioningState": "Succeeded", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "aksClusterProfile": { + "aksVersion": "1.24", + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetOperations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetOperations.json new file mode 100644 index 000000000000..475a285c9d0c --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetOperations.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "resourceGroup1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.HDInsight/clusterpool/read", + "isDataAction": false, + "display": { + "provider": "HDInsight on AKS", + "resource": "Cluster Pool.", + "operation": "Get Cluster Pool Operation result.", + "description": "Get any cluster pool." + }, + "origin": "user, system" + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterPoolVersions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterPoolVersions.json new file mode 100644 index 000000000000..70e74845dc0a --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterPoolVersions.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "location": "westus2", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterpoolversions/1.0", + "name": "1.0", + "properties": { + "clusterPoolVersion": "1.0", + "aksVersion": "1.24", + "isPreview": false + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterpoolversions/1.1", + "name": "1.1", + "properties": { + "clusterPoolVersion": "1.1", + "aksVersion": "1.25", + "isPreview": false + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterpoolversions/1.2", + "name": "1.2", + "properties": { + "clusterPoolVersion": "1.2", + "aksVersion": "1.26", + "isPreview": true + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterVersions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterVersions.json new file mode 100644 index 000000000000..8237b497a231 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterVersions.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "location": "westus2", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterversions/flink_1.16.0-1.0.4", + "name": "flink_1.16.0-1.0.4", + "properties": { + "clusterType": "Flink", + "clusterVersion": "1.0.4", + "ossVersion": "1.16.0", + "clusterPoolVersion": "1.0", + "isPreview": false, + "components": [ + { + "name": "TaskManager", + "version": "1.16.0" + }, + { + "name": "JobManager", + "version": "1.16.0" + } + ] + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterversions/spark_3.3.1-1.0.4", + "name": "spark_3.3.1-1.0.4", + "properties": { + "clusterType": "Spark", + "clusterVersion": "1.0.4", + "ossVersion": "3.3.1", + "clusterPoolVersion": "1.0", + "isPreview": false, + "components": [ + { + "name": "Hadoop", + "version": "3.2.3" + }, + { + "name": "Hive", + "version": "3.1.4" + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterAvailableUpgrades.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterAvailableUpgrades.json new file mode 100644 index 000000000000..491729ce24af --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterAvailableUpgrades.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1/availableUpgrades/AKSPatchUpgrade", + "properties": { + "upgradeType": "AKSPatchUpgrade", + "currentVersion": "1.26.3", + "currentVersionStatus": "Supported", + "latestVersion": "1.26.6" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1/availableUpgrades/hotfix1", + "properties": { + "description": "Hotfix for historyserver on version 1.16.0-1.0.6.2", + "sourceClusterVersion": "1.0.6", + "sourceOssVersion": "1.16.0", + "sourceBuildNumber": "2", + "targetClusterVersion": "1.0.6", + "targetOssVersion": "1.16.0", + "targetBuildNumber": "3", + "componentName": "historyserver", + "severity": "low", + "upgradeType": "HotfixUpgrade", + "extendedProperties": "", + "createdTime": "2023-03-29T14:13:12Z" + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterInstanceViews.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterInstanceViews.json new file mode 100644 index 000000000000..34b3d4641df7 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterInstanceViews.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-11-01-preview", + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "clusterPoolName": "clusterPool1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "properties": { + "status": { + "ready": "True", + "reason": "", + "message": "" + }, + "serviceStatuses": [ + { + "kind": "ZooKeeper", + "ready": "true", + "message": "" + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterJobs.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterJobs.json new file mode 100644 index 000000000000..4658834c76f2 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterJobs.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "resourceGroupName": "hiloResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterPool1", + "clusterName": "cluster1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1/jobs/flink-job-1", + "properties": { + "runId": "job-15a-4322-b32c-ea541845e911", + "jobType": "FlinkJob", + "jobName": "flink-job-1", + "jobJarDirectory": "jobJarDirectory1", + "jarName": "job.jar", + "entryClass": "com.microsoft.hilo.flink.job.streaming.ExampleJob", + "flinkConfiguration": { + "parallelism": "1", + "savepoint.directory": "savepoint-directory" + }, + "jobId": "362b911137dfefc2e55784666f4d4253", + "status": "RUNNING", + "jobOutput": "job-output", + "actionResult": "SUCCESS" + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolAvailableUpgrades.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolAvailableUpgrades.json new file mode 100644 index 000000000000..e946df8f116a --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolAvailableUpgrades.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/availableUpgrades/AKSPatchUpgrade", + "properties": { + "upgradeType": "AKSPatchUpgrade", + "currentVersion": "1.26.3", + "currentVersionStatus": "Deprecated", + "latestVersion": "1.26.6" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/availableUpgrades/NodeOsUpgrade", + "properties": { + "upgradeType": "NodeOsUpgrade", + "latestVersion": "AKSCBLMariner-V2gen2-202310.09.0" + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPools.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPools.json new file mode 100644 index 000000000000..0bfda02428f5 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPools.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceGroupName": "hiloResourcegroup", + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "provisioningState": "Succeeded", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "aksClusterProfile": { + "aksVersion": "1.24", + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + } + }, + "location": "West US 2", + "tags": { + "department": "MightyMight", + "company": "Contoso" + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolsSubscription.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolsSubscription.json new file mode 100644 index 000000000000..59447e08b209 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolsSubscription.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "provisioningState": "Succeeded", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "aksClusterProfile": { + "aksVersion": "1.24", + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + } + }, + "location": "West US 2", + "tags": { + "department": "MightyMight", + "company": "Contoso" + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterServiceConfigs.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterServiceConfigs.json new file mode 100644 index 000000000000..c8c2b61ba39a --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterServiceConfigs.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-11-01-preview", + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "clusterPoolName": "clusterPool1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serviceName": "hadoop-service", + "componentName": "hadoop-component", + "fileName": "capacity-scheduler.xml", + "content": "" + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClustersByClusterPoolName.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClustersByClusterPoolName.json new file mode 100644 index 000000000000..5f3cd6f733db --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClustersByClusterPoolName.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "Trino", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 + } + ] + }, + "clusterProfile": { + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", + "components": [ + { + "name": "Trino", + "version": "410" + }, + { + "name": "Hive metastore", + "version": "3.1.2" + } + ], + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "trinoProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + } + } + }, + "location": "West US 2", + "tags": { + "department": "MightyMight", + "company": "Contoso" + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/LocationsNameAvailability.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/LocationsNameAvailability.json new file mode 100644 index 000000000000..2a2c69d2b1ba --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/LocationsNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "api-version": "2023-11-01-preview", + "location": "southeastasia", + "NameAvailabilityParameters": { + "name": "contosemember1", + "type": "Microsoft.HDInsight/clusterPools/clusters" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchCluster.json new file mode 100644 index 000000000000..1a19d9b98aa4 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchCluster.json @@ -0,0 +1,455 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1", + "ClusterPatchRequest": { + "properties": { + "clusterProfile": { + "serviceConfigsProfiles": [ + { + "serviceName": "TestService1", + "configs": [ + { + "component": "TestComp1", + "files": [ + { + "fileName": "TestFile1", + "values": { + "Test.config.1": "1", + "Test.config.2": "2" + } + }, + { + "fileName": "TestFile2", + "values": { + "Test.config.3": "3", + "Test.config.4": "4" + } + } + ] + }, + { + "component": "TestComp2", + "files": [ + { + "fileName": "TestFile3", + "content": "TestContent", + "path": "TestPath" + }, + { + "fileName": "TestFile4", + "values": { + "Test.config.7": "7", + "Test.config.8": "8" + } + } + ] + } + ] + }, + { + "serviceName": "TestService2", + "configs": [ + { + "component": "TestComp3", + "files": [ + { + "fileName": "TestFile5", + "values": { + "Test.config.9": "9" + } + } + ] + } + ] + } + ], + "sshProfile": { + "count": 2 + }, + "authorizationProfile": { + "userIds": [ + "Testuser1", + "Testuser2" + ] + }, + "autoscaleProfile": { + "enabled": true, + "autoscaleType": "ScheduleBased", + "gracefulDecommissionTimeout": -1, + "scheduleBasedConfig": { + "defaultCount": 3, + "timeZone": "Cen. Australia Standard Time", + "schedules": [ + { + "days": [ + "Monday, Tuesday, Wednesday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 3 + }, + { + "days": [ + "Sunday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 3 + } + ] + } + }, + "logAnalyticsProfile": { + "enabled": true, + "applicationLogs": { + "stdErrorEnabled": true, + "stdOutEnabled": true + }, + "metricsEnabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "location": "West US 2", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "Trino", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 + } + ] + }, + "clusterProfile": { + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "serviceConfigsProfiles": [ + { + "serviceName": "TestService1", + "configs": [ + { + "component": "TestComp1", + "files": [ + { + "fileName": "TestFile1", + "values": { + "Test.config.1": "1", + "Test.config.2": "2" + } + }, + { + "fileName": "TestFile2", + "values": { + "Test.config.3": "3", + "Test.config.4": "4" + } + } + ] + }, + { + "component": "TestComp2", + "files": [ + { + "fileName": "TestFile3", + "content": "TestContent", + "path": "TestPath" + }, + { + "fileName": "TestFile4", + "values": { + "Test.config.7": "7", + "Test.config.8": "8" + } + } + ] + } + ] + }, + { + "serviceName": "TestService2", + "configs": [ + { + "component": "TestComp3", + "files": [ + { + "fileName": "TestFile5", + "values": { + "Test.config.9": "9" + } + } + ] + } + ] + } + ], + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "autoscaleProfile": { + "enabled": true, + "autoscaleType": "ScheduleBased", + "gracefulDecommissionTimeout": -1, + "scheduleBasedConfig": { + "defaultCount": 3, + "timeZone": "Cen. Australia Standard Time", + "schedules": [ + { + "days": [ + "Monday, Tuesday, Wednesday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 3 + }, + { + "days": [ + "Sunday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 3 + } + ] + } + }, + "logAnalyticsProfile": { + "enabled": true, + "applicationLogs": { + "stdErrorEnabled": true, + "stdOutEnabled": true + }, + "metricsEnabled": true + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "trinoProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://management.azure.com/providers/Microsoft.HDInsight/locations/EASTUS/operationStatuses/676c3c86-188d-4591-9b55-c4298b4a1279?api-version=2023-11-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "location": "West US 2", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "Trino", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 + } + ] + }, + "clusterProfile": { + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "serviceConfigsProfiles": [ + { + "serviceName": "TestService1", + "configs": [ + { + "component": "TestComp1", + "files": [ + { + "fileName": "TestFile1", + "values": { + "Test.config.1": "1", + "Test.config.2": "2" + } + }, + { + "fileName": "TestFile2", + "values": { + "Test.config.3": "3", + "Test.config.4": "4" + } + } + ] + }, + { + "component": "TestComp2", + "files": [ + { + "fileName": "TestFile3", + "content": "TestContent", + "path": "TestPath" + }, + { + "fileName": "TestFile4", + "values": { + "Test.config.7": "7", + "Test.config.8": "8" + } + } + ] + } + ] + }, + { + "serviceName": "TestService2", + "configs": [ + { + "component": "TestComp3", + "files": [ + { + "fileName": "TestFile5", + "values": { + "Test.config.9": "9" + } + } + ] + } + ] + } + ], + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "autoscaleProfile": { + "enabled": true, + "autoscaleType": "ScheduleBased", + "gracefulDecommissionTimeout": -1, + "scheduleBasedConfig": { + "defaultCount": 3, + "timeZone": "Cen. Australia Standard Time", + "schedules": [ + { + "days": [ + "Monday, Tuesday, Wednesday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 3 + }, + { + "days": [ + "Sunday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 3 + } + ] + } + }, + "logAnalyticsProfile": { + "enabled": true, + "applicationLogs": { + "stdErrorEnabled": true, + "stdOutEnabled": true + }, + "metricsEnabled": true + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "trinoProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchClusterPool.json new file mode 100644 index 000000000000..2b2de7073b70 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchClusterPool.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterPoolTags": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/pathToOperationResult" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "provisioningState": "Succeeded", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "aksClusterProfile": { + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/pathToOperationResult" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "provisioningState": "Succeeded", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "aksClusterProfile": { + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchRangerCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchRangerCluster.json new file mode 100644 index 000000000000..e9eb705b75cf --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchRangerCluster.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1", + "ClusterPatchRequest": { + "properties": { + "clusterProfile": { + "rangerProfile": { + "rangerAdmin": { + "admins": [ + "testuser1@contoso.com", + "testuser2@contoso.com" + ], + "database": { + "host": "testsqlserver.database.windows.net", + "name": "testdb", + "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", + "username": "admin" + } + }, + "rangerAudit": { + "storageAccount": "https://teststorage.blob.core.windows.net/testblob" + }, + "rangerUsersync": { + "enabled": true, + "groups": [ + "0a53828f-36c9-44c3-be3d-99a7fce977ad", + "13be6971-79db-4f33-9d41-b25589ca25ac" + ], + "mode": "automatic", + "users": [ + "testuser1@contoso.com", + "testuser2@contoso.com" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "location": "West US 2", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "ranger", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "head", + "vmSize": "Standard_D3_v2", + "count": 2 + } + ] + }, + "clusterProfile": { + "clusterVersion": "1.0.1", + "ossVersion": "2.4.1", + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "logAnalyticsProfile": { + "enabled": true, + "applicationLogs": { + "stdErrorEnabled": true, + "stdOutEnabled": true + }, + "metricsEnabled": true + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + } + }, + "rangerProfile": { + "rangerAdmin": { + "admins": [ + "testuser1@contoso.com", + "testuser2@contoso.com" + ], + "database": { + "host": "testsqlserver.database.windows.net", + "name": "testdb", + "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", + "username": "admin" + } + }, + "rangerAudit": { + "storageAccount": "https://teststorage.blob.core.windows.net/testblob" + }, + "rangerUsersync": { + "enabled": true, + "groups": [ + "0a53828f-36c9-44c3-be3d-99a7fce977ad", + "13be6971-79db-4f33-9d41-b25589ca25ac" + ], + "mode": "automatic", + "users": [ + "testuser1@contoso.com", + "testuser2@contoso.com" + ] + } + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://management.azure.com/providers/Microsoft.HDInsight/locations/EASTUS/operationStatuses/676c3c86-188d-4591-9b55-c4298b4a1279?api-version=2023-11-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "location": "West US 2", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "ranger", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "head", + "vmSize": "Standard_D3_v2", + "count": 2 + } + ] + }, + "clusterProfile": { + "clusterVersion": "1.0.1", + "ossVersion": "2.4.1", + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "logAnalyticsProfile": { + "enabled": true, + "applicationLogs": { + "stdErrorEnabled": true, + "stdOutEnabled": true + }, + "metricsEnabled": true + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + } + }, + "rangerProfile": { + "rangerAdmin": { + "admins": [ + "testuser1@contoso.com", + "testuser2@contoso.com" + ], + "database": { + "host": "testsqlserver.database.windows.net", + "name": "testdb", + "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", + "username": "admin" + } + }, + "rangerAudit": { + "storageAccount": "https://teststorage.blob.core.windows.net/testblob" + }, + "rangerUsersync": { + "enabled": true, + "groups": [ + "0a53828f-36c9-44c3-be3d-99a7fce977ad", + "13be6971-79db-4f33-9d41-b25589ca25ac" + ], + "mode": "automatic", + "users": [ + "testuser1@contoso.com", + "testuser2@contoso.com" + ] + } + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ResizeCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ResizeCluster.json new file mode 100644 index 000000000000..0dc302d60775 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ResizeCluster.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1", + "ClusterResizeRequest": { + "location": "West US 2", + "properties": { + "targetWorkerNodeCount": 5 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "Trino", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 5 + } + ] + }, + "clusterProfile": { + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "trinoProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + }, + "autoscaleProfile": { + "enabled": true, + "autoscaleType": "ScheduleBased", + "gracefulDecommissionTimeout": 3600, + "scheduleBasedConfig": { + "defaultCount": 10, + "timeZone": "Cen. Australia Standard Time", + "schedules": [ + { + "days": [ + "Monday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 20 + }, + { + "days": [ + "Sunday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 25 + } + ] + }, + "loadBasedConfig": { + "minNodes": 10, + "maxNodes": 20, + "pollInterval": 60, + "cooldownPeriod": 300, + "scalingRules": [ + { + "actionType": "scaleup", + "evaluationCount": 3, + "scalingMetric": "cpu", + "comparisonRule": { + "operator": "greaterThan", + "threshold": 90 + } + }, + { + "actionType": "scaledown", + "evaluationCount": 3, + "scalingMetric": "cpu", + "comparisonRule": { + "operator": "lessThan", + "threshold": 20 + } + } + ] + } + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/RunClusterJob.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/RunClusterJob.json new file mode 100644 index 000000000000..8691574838dd --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/RunClusterJob.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1", + "ClusterJob": { + "properties": { + "jobType": "FlinkJob", + "jobName": "flink-job-name", + "action": "START", + "jobJarDirectory": "abfs://flinkjob@hilosa.dfs.core.windows.net/jars", + "jarName": "flink-sleep-job-0.0.1-SNAPSHOT.jar", + "entryClass": "com.microsoft.hilo.flink.job.streaming.SleepJob", + "flinkConfiguration": { + "parallelism": "1", + "savepoint.directory": "abfs://flinkjob@hilosa.dfs.core.windows.net/savepoint" + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "http://azure.async.operation/status" + } + }, + "200": { + "body": { + "properties": { + "runId": "job-15a-4322-b32c-ea541845e911", + "jobType": "FlinkJob", + "jobName": "flink-job-name", + "action": "START", + "jobJarDirectory": "abfs://flinkjob@hilosa.dfs.core.windows.net/jars", + "jarName": "flink-sleep-job-0.0.1-SNAPSHOT.jar", + "entryClass": "com.microsoft.hilo.flink.job.streaming.SleepJob", + "flinkConfiguration": { + "parallelism": "1", + "savepoint.directory": "abfs://flinkjob@hilosa.dfs.core.windows.net/savepoint" + } + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForCluster.json new file mode 100644 index 000000000000..9661f5aeae9a --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForCluster.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1", + "ClusterUpgradeRequest": { + "properties": { + "upgradeType": "AKSPatchUpgrade" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "http://azure.async.operation/status" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "trino", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "worker", + "vmSize": "Standard_D3_v2", + "count": 3 + } + ] + }, + "clusterProfile": { + "clusterVersion": "1.0.1", + "ossVersion": "2.4.1", + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "trinoProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + }, + "autoscaleProfile": { + "enabled": true, + "autoscaleType": "ScheduleBased", + "gracefulDecommissionTimeout": 3600, + "scheduleBasedConfig": { + "defaultCount": 10, + "timeZone": "Cen. Australia Standard Time", + "schedules": [ + { + "days": [ + "Monday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 20 + }, + { + "days": [ + "Sunday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 25 + } + ] + }, + "loadBasedConfig": { + "minNodes": 10, + "maxNodes": 20, + "pollInterval": 60, + "cooldownPeriod": 300, + "scalingRules": [ + { + "actionType": "scaleup", + "evaluationCount": 3, + "scalingMetric": "cpu", + "comparisonRule": { + "operator": "greaterThan", + "threshold": 90 + } + }, + { + "actionType": "scaledown", + "evaluationCount": 3, + "scalingMetric": "cpu", + "comparisonRule": { + "operator": "lessThan", + "threshold": 20 + } + } + ] + } + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json new file mode 100644 index 000000000000..a3c8bb60aca2 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "ClusterPoolUpgradeRequest": { + "properties": { + "upgradeType": "AKSPatchUpgrade", + "upgradeClusterPool": true, + "upgradeAllClusterNodes": false + } + } + }, + "responses": { + "202": { + "headers": { + "location": "http://azure.async.operation/status" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "provisioningState": "Succeeded", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "aksClusterProfile": { + "aksVersion": "1.24", + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeHotfixForCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeHotfixForCluster.json new file mode 100644 index 000000000000..bfb7e74dabde --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeHotfixForCluster.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "clusterName": "cluster1", + "ClusterUpgradeRequest": { + "properties": { + "upgradeType": "HotfixUpgrade", + "targetOssVersion": "1.16.0", + "targetClusterVersion": "1.0.6", + "targetBuildNumber": "3", + "componentName": "historyserver" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "http://azure.async.operation/status" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusterPools/clusters", + "properties": { + "provisioningState": "Succeeded", + "clusterType": "trino", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "computeProfile": { + "nodes": [ + { + "type": "worker", + "vmSize": "Standard_D3_v2", + "count": 3 + } + ] + }, + "clusterProfile": { + "clusterVersion": "1.0.1", + "ossVersion": "2.4.1", + "identityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", + "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", + "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" + }, + "authorizationProfile": { + "userIds": [ + "testuser1", + "testuser2" + ] + }, + "connectivityProfile": { + "web": { + "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" + }, + "ssh": [ + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" + }, + { + "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" + } + ] + }, + "trinoProfile": {}, + "sshProfile": { + "count": 2, + "podPrefix": "sshnode" + }, + "autoscaleProfile": { + "enabled": true, + "autoscaleType": "ScheduleBased", + "gracefulDecommissionTimeout": 3600, + "scheduleBasedConfig": { + "defaultCount": 10, + "timeZone": "Cen. Australia Standard Time", + "schedules": [ + { + "days": [ + "Monday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 20 + }, + { + "days": [ + "Sunday" + ], + "startTime": "00:00", + "endTime": "12:00", + "count": 25 + } + ] + }, + "loadBasedConfig": { + "minNodes": 10, + "maxNodes": 20, + "pollInterval": 60, + "cooldownPeriod": 300, + "scalingRules": [ + { + "actionType": "scaleup", + "evaluationCount": 3, + "scalingMetric": "cpu", + "comparisonRule": { + "operator": "greaterThan", + "threshold": 90 + } + }, + { + "actionType": "scaledown", + "evaluationCount": 3, + "scalingMetric": "cpu", + "comparisonRule": { + "operator": "lessThan", + "threshold": 20 + } + } + ] + } + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeNodeOsForClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeNodeOsForClusterPool.json new file mode 100644 index 000000000000..7dcdcb1ade3c --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeNodeOsForClusterPool.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", + "resourceGroupName": "hiloResourcegroup", + "api-version": "2023-11-01-preview", + "clusterPoolName": "clusterpool1", + "ClusterPoolUpgradeRequest": { + "properties": { + "upgradeType": "NodeOsUpgrade" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "http://azure.async.operation/status" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", + "name": "clusterpool1", + "type": "Microsoft.HDInsight/clusterPools", + "properties": { + "provisioningState": "Succeeded", + "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", + "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", + "clusterPoolProfile": { + "clusterPoolVersion": "1.2" + }, + "computeProfile": { + "vmSize": "Standard_D3_v2", + "count": 3 + }, + "aksClusterProfile": { + "aksVersion": "1.24", + "aksClusterAgentPoolIdentityProfile": { + "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", + "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", + "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" + }, + "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/hdinsight.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/hdinsight.json new file mode 100644 index 000000000000..d3c83858c916 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/hdinsight.json @@ -0,0 +1,4234 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsight on AKS Management Client", + "description": "The HDInsight on AKS Management Client.", + "version": "2023-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}": { + "get": { + "description": "Gets a cluster pool.", + "operationId": "ClusterPools_Get", + "x-ms-examples": { + "ClusterPoolGet": { + "$ref": "./examples/GetClusterPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Clusterpool details.", + "schema": { + "$ref": "#/definitions/ClusterPool" + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Creates or updates a cluster pool.", + "operationId": "ClusterPools_CreateOrUpdate", + "x-ms-examples": { + "ClusterPoolPut": { + "$ref": "./examples/CreateClusterPool.json" + }, + "ClusterPoolPutWithPrivateAks": { + "$ref": "./examples/CreateClusterPoolWithPrivateAks.json" + }, + "ClusterPoolPutWithUDRAks": { + "$ref": "./examples/CreateClusterPoolWithUDRAks.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "name": "ClusterPool", + "description": "The Cluster Pool to create.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPool" + } + } + ], + "responses": { + "201": { + "description": "ClusterPool is created.", + "schema": { + "$ref": "#/definitions/ClusterPool" + } + }, + "200": { + "description": "Update successful.", + "schema": { + "$ref": "#/definitions/ClusterPool" + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "description": "Updates an existing Cluster Pool Tags.", + "operationId": "ClusterPools_UpdateTags", + "x-ms-examples": { + "ClusterPoolsPatchTags": { + "$ref": "./examples/PatchClusterPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "name": "clusterPoolTags", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update tags." + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/ClusterPool" + } + }, + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ClusterPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Deletes a Cluster Pool.", + "operationId": "ClusterPools_Delete", + "x-ms-examples": { + "ClusterPoolDelete": { + "$ref": "./examples/DeleteClusterPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted response definition.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "No content - The Cluster Pool doesn't exist." + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusterpools": { + "get": { + "operationId": "ClusterPools_ListBySubscription", + "x-ms-examples": { + "ClusterPoolsListBySubscription": { + "$ref": "./examples/ListClusterPoolsSubscription.json" + } + }, + "description": "Gets the list of Cluster Pools within a Subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Cluster Pools successfully returned.", + "schema": { + "$ref": "#/definitions/ClusterPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools": { + "get": { + "operationId": "ClusterPools_ListByResourceGroup", + "x-ms-examples": { + "ClusterPoolsListByResourceGroup": { + "$ref": "./examples/ListClusterPools.json" + } + }, + "description": "Lists the HDInsight cluster pools under a resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Cluster Pools successfully returned.", + "schema": { + "$ref": "#/definitions/ClusterPoolListResult" + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/upgrade": { + "post": { + "description": "Upgrade a cluster pool.", + "operationId": "ClusterPools_Upgrade", + "x-ms-examples": { + "ClusterPoolsUpgradeAKSPatchVersion": { + "$ref": "./examples/UpgradeAKSPatchVersionForClusterPool.json" + }, + "ClusterPoolsUpgradeNodeOs": { + "$ref": "./examples/UpgradeNodeOsForClusterPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "name": "ClusterPoolUpgradeRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPoolUpgrade" + }, + "description": "Upgrade a cluster pool." + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/ClusterPool" + } + }, + "202": { + "description": "Cluster Pool Upgrade request accepted.", + "headers": { + "location": { + "type": "string", + "description": "URL to get the status of the resize operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/availableUpgrades": { + "get": { + "description": "List a cluster pool available upgrade.", + "operationId": "ClusterPoolAvailableUpgrades_List", + "x-ms-examples": { + "GetClusterPoolAvailableUpgrade": { + "$ref": "./examples/ListClusterPoolAvailableUpgrades.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Clusterpool Available Upgrade details.", + "schema": { + "$ref": "#/definitions/ClusterPoolAvailableUpgradeList" + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters": { + "get": { + "operationId": "Clusters_ListByClusterPoolName", + "description": "Lists the HDInsight cluster pools under a resource group.", + "x-ms-examples": { + "HDInsightClustersListByClusterPoolName": { + "$ref": "./examples/ListClustersByClusterPoolName.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Clusters successfully returned.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/upgrade": { + "post": { + "description": "Upgrade a cluster.", + "operationId": "Clusters_Upgrade", + "x-ms-examples": { + "ClustersUpgradeAKSPatchVersion": { + "$ref": "./examples/UpgradeAKSPatchVersionForCluster.json" + }, + "ClustersUpgradeHotfix": { + "$ref": "./examples/UpgradeHotfixForCluster.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "ClusterUpgradeRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpgrade" + }, + "description": "Upgrade a cluster." + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Cluster Upgrade request accepted.", + "headers": { + "location": { + "type": "string", + "description": "URL to get the status of the resize operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/availableUpgrades": { + "get": { + "description": "List a cluster available upgrade.", + "operationId": "ClusterAvailableUpgrades_List", + "x-ms-examples": { + "GetClusterAvailableUpgrade": { + "$ref": "./examples/ListClusterAvailableUpgrades.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "Cluster Available Upgrade details.", + "schema": { + "$ref": "#/definitions/ClusterAvailableUpgradeList" + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/resize": { + "post": { + "description": "Resize an existing Cluster.", + "operationId": "Clusters_Resize", + "x-ms-examples": { + "HDInsightClusterResize": { + "$ref": "./examples/ResizeCluster.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "ClusterResizeRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterResizeData" + }, + "description": "Resize a cluster." + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Cluster resize request accepted.", + "headers": { + "location": { + "type": "string", + "description": "URL to get the status of the resize operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}": { + "get": { + "operationId": "Clusters_Get", + "description": "Gets a HDInsight cluster.", + "x-ms-examples": { + "HDInsightClusterGet": { + "$ref": "./examples/GetCluster.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "Cluster details.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "operationId": "Clusters_Create", + "description": "Creates a cluster.", + "x-ms-examples": { + "HDInsightClusterPut": { + "$ref": "./examples/CreateAutoscaleCluster.json" + }, + "HDInsightSparkClusterPut": { + "$ref": "./examples/CreateSparkCluster.json" + }, + "HDInsightSparkClusterPutWithInternalIngress": { + "$ref": "./examples/CreateSparkClusterWithInternalIngress.json" + }, + "HDInsightRangerClusterPut": { + "$ref": "./examples/CreateRangerCluster.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "HDInsightCluster", + "in": "body", + "required": true, + "description": "The cluster to create.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + ], + "responses": { + "201": { + "description": "Cluster is created.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "200": { + "description": "Update successful.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "description": "Updates an existing Cluster.", + "operationId": "Clusters_Update", + "x-ms-examples": { + "HDInsightClustersPatchTags": { + "$ref": "./examples/PatchCluster.json" + }, + "HDInsightRangerClusterPatchTags": { + "$ref": "./examples/PatchRangerCluster.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "ClusterPatchRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPatch" + }, + "description": "Patch a cluster." + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "Clusters_Delete", + "description": "Deletes a cluster.", + "x-ms-examples": { + "HDInsightClustersDelete": { + "$ref": "./examples/DeleteCluster.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "202": { + "description": "Cluster delete request accepted.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "No content - The Cluster doesn't exist." + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/runJob": { + "post": { + "operationId": "ClusterJobs_RunJob", + "description": "Operations on jobs of HDInsight on AKS cluster.", + "x-ms-examples": { + "RunClusterJob": { + "$ref": "./examples/RunClusterJob.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "ClusterJob", + "description": "The Cluster job.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterJob" + } + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/ClusterJob" + } + }, + "202": { + "description": "Run cluster job action request accepted.", + "headers": { + "location": { + "type": "string", + "description": "URL to get the status of the resize operation." + } + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/jobs": { + "get": { + "operationId": "ClusterJobs_List", + "description": "Get jobs of HDInsight on AKS cluster.", + "x-ms-examples": { + "ListClusterJobs": { + "$ref": "./examples/ListClusterJobs.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The system query option to filter job returned in the response. Allowed value is 'jobName eq {jobName}' or 'jarName eq {jarName}'." + } + ], + "responses": { + "200": { + "description": "Cluster job details.", + "schema": { + "$ref": "#/definitions/ClusterJobList" + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/serviceConfigs": { + "get": { + "operationId": "Clusters_ListServiceConfigs", + "description": "Lists the config dump of all services running in cluster.", + "x-ms-examples": { + "HDInsightClusterGetServiceConfigs": { + "$ref": "./examples/ListClusterServiceConfigs.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceConfigListResult" + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/checkNameAvailability": { + "post": { + "description": "Check the availability of the resource name.", + "operationId": "Locations_CheckNameAvailability", + "x-ms-examples": { + "LocationsNameAvailability": { + "$ref": "./examples/LocationsNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "NameAvailabilityParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + }, + "description": "The name and type of the resource." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/instanceViews": { + "get": { + "operationId": "Clusters_ListInstanceViews", + "x-ms-examples": { + "HDInsightClusterGetInstanceViews": { + "$ref": "./examples/ListClusterInstanceViews.json" + } + }, + "description": "Lists the lists of instance views", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterInstanceViewsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/instanceViews/default": { + "get": { + "operationId": "Clusters_GetInstanceView", + "description": "Gets the status of a cluster instance.", + "x-ms-examples": { + "HDInsightClusterGetInstanceView": { + "$ref": "./examples/GetClusterInstanceView.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterPoolNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterInstanceViewResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.HDInsight/operations": { + "get": { + "description": "Returns list of operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "ListOperations": { + "$ref": "./examples/GetOperations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation details.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/availableClusterPoolVersions": { + "get": { + "description": "Returns a list of available cluster pool versions.", + "operationId": "AvailableClusterPoolVersions_ListByLocation", + "x-ms-examples": { + "ClusterPoolVersionListResult": { + "$ref": "./examples/ListAvailableClusterPoolVersions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Available cluster pool versions successfully returned.", + "schema": { + "$ref": "#/definitions/ClusterPoolVersionsListResult" + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/availableClusterVersions": { + "get": { + "description": "Returns a list of available cluster versions.", + "operationId": "AvailableClusterVersions_ListByLocation", + "x-ms-examples": { + "ClusterVersionListResult": { + "$ref": "./examples/ListAvailableClusterVersions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Available cluster versions successfully returned.", + "schema": { + "$ref": "#/definitions/ClusterVersionsListResult" + } + }, + "default": { + "description": "Error Response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ClusterPoolListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ClusterPool" + }, + "description": "The list of cluster pools." + }, + "nextLink": { + "type": "string", + "description": "The link (url) to the next page of results.", + "readOnly": true + } + }, + "description": "The list cluster pools operation response." + }, + "ClusterPoolProfile": { + "type": "object", + "description": "Cluster pool profile.", + "required": [ + "clusterPoolVersion" + ], + "properties": { + "clusterPoolVersion": { + "$ref": "#/definitions/ClusterPoolVersionPattern" + } + } + }, + "ClusterPoolComputeProfile": { + "type": "object", + "description": "Cluster pool compute profile.", + "required": [ + "vmSize" + ], + "properties": { + "vmSize": { + "type": "string", + "description": "The virtual machine SKU.", + "pattern": "^[a-zA-Z0-9_\\-]{0,256}$" + }, + "count": { + "description": "The number of virtual machines.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "ClusterPoolNetworkProfile": { + "type": "object", + "description": "Cluster pool networking configuration.", + "required": [ + "subnetId" + ], + "properties": { + "subnetId": { + "type": "string", + "description": "Cluster pool subnet resource id.", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. " + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. " + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster pool creation time and cannot be changed later. " + }, + "enablePrivateApiServer": { + "type": "boolean", + "description": "ClusterPool is based on AKS cluster. AKS cluster exposes the API server to public internet by default. If you set this property to true, a private AKS cluster will be created, and it will use private apiserver, which is not exposed to public internet.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "apiServerAuthorizedIpRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the AKS API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with private AKS clusters. So you cannot set enablePrivateApiServer to true and apiServerAuthorizedIpRanges at the same time." + } + } + }, + "ClusterPoolLogAnalyticsProfile": { + "type": "object", + "description": "Cluster pool log analytics profile used to enable or disable OMS agent for AKS cluster.", + "required": [ + "enabled" + ], + "properties": { + "enabled": { + "type": "boolean", + "description": "True if log analytics is enabled for cluster pool, otherwise false." + }, + "workspaceId": { + "type": "string", + "description": "Log analytics workspace to associate with the OMS agent.", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + } + } + } + }, + "AksClusterProfile": { + "type": "object", + "description": "Properties of the cluster pool underlying AKS cluster.", + "properties": { + "aksClusterResourceId": { + "type": "string", + "description": "ARM Resource ID of the AKS cluster", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ContainerService/managedClusters" + } + ] + } + }, + "aksClusterAgentPoolIdentityProfile": { + "description": "Identity properties of the AKS cluster agentpool MSI", + "allOf": [ + { + "$ref": "#/definitions/IdentityProfile" + } + ] + }, + "aksVersion": { + "type": "string", + "description": "AKS control plane and default node pool version of this ClusterPool", + "readOnly": true + } + } + }, + "ClusterPoolResourceProperties": { + "type": "object", + "required": [ + "computeProfile" + ], + "properties": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "type": "string", + "enum": [ + "Accepted", + "Succeeded", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningStatus", + "modelAsString": true + }, + "readOnly": true + }, + "deploymentId": { + "type": "string", + "description": "A unique id generated by the RP to identify the resource.", + "example": "45cd32aead6e4a91b079a0cdbfac8c36", + "readOnly": true + }, + "managedResourceGroupName": { + "type": "string", + "description": "A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction.", + "minLength": 1, + "maxLength": 40, + "example": "hdi-45cd32aead6e4a91b079a0cdbfac8c36" + }, + "aksManagedResourceGroupName": { + "type": "string", + "description": "A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}", + "readOnly": true, + "example": "MC_hdi-45cd32aead6e4a91b079a0cdbfac8c36_test-pool_eastus" + }, + "clusterPoolProfile": { + "description": "CLuster pool profile.", + "allOf": [ + { + "$ref": "#/definitions/ClusterPoolProfile" + } + ] + }, + "computeProfile": { + "description": "CLuster pool compute profile.", + "allOf": [ + { + "$ref": "#/definitions/ClusterPoolComputeProfile" + } + ] + }, + "aksClusterProfile": { + "description": "Properties of underlying AKS cluster.", + "readOnly": true, + "allOf": [ + { + "$ref": "#/definitions/AksClusterProfile" + } + ] + }, + "networkProfile": { + "description": "Cluster pool network profile.", + "allOf": [ + { + "$ref": "#/definitions/ClusterPoolNetworkProfile" + } + ] + }, + "logAnalyticsProfile": { + "description": "Cluster pool log analytics profile to enable OMS agent for AKS cluster.", + "allOf": [ + { + "$ref": "#/definitions/ClusterPoolLogAnalyticsProfile" + } + ] + }, + "status": { + "type": "string", + "description": "Business status of the resource.", + "example": "Running", + "readOnly": true + } + }, + "description": "Cluster pool resource properties." + }, + "ClusterPool": { + "type": "object", + "description": "Cluster pool.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Gets or sets the properties. Define cluster pool specific properties.", + "$ref": "#/definitions/ClusterPoolResourceProperties" + }, + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "SystemData of cluster pool.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + }, + "description": "The list of clusters." + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + }, + "description": "The list cluster operation response." + }, + "ClusterLogAnalyticsProfile": { + "type": "object", + "description": "Cluster log analytics profile to enable or disable OMS agent for cluster.", + "required": [ + "enabled" + ], + "properties": { + "enabled": { + "type": "boolean", + "description": "True if log analytics is enabled for the cluster, otherwise false." + }, + "applicationLogs": { + "$ref": "#/definitions/ClusterLogAnalyticsApplicationLogs" + }, + "metricsEnabled": { + "type": "boolean", + "description": "True if metrics are enabled, otherwise false." + } + } + }, + "ClusterLogAnalyticsApplicationLogs": { + "type": "object", + "description": "Collection of logs to be enabled or disabled for log analytics.", + "properties": { + "stdOutEnabled": { + "type": "boolean", + "description": "True if stdout is enabled, otherwise false." + }, + "stdErrorEnabled": { + "type": "boolean", + "description": "True if stderror is enabled, otherwise false." + } + } + }, + "ClusterPrometheusProfile": { + "type": "object", + "description": "Cluster Prometheus profile.", + "required": [ + "enabled" + ], + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable Prometheus for cluster or not.", + "default": false + } + } + }, + "IdentityProfile": { + "type": "object", + "description": "Identity Profile with details of an MSI.", + "required": [ + "msiResourceId", + "msiClientId", + "msiObjectId" + ], + "properties": { + "msiResourceId": { + "type": "string", + "description": "ResourceId of the MSI.", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + } + }, + "msiClientId": { + "type": "string", + "description": "ClientId of the MSI.", + "pattern": "^[{(]?[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}[)}]?$" + }, + "msiObjectId": { + "type": "string", + "description": "ObjectId of the MSI.", + "pattern": "^[{(]?[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}[)}]?$" + } + } + }, + "AuthorizationProfile": { + "type": "object", + "description": "Authorization profile with details of AAD user Ids and group Ids authorized for data plane access.", + "properties": { + "userIds": { + "type": "array", + "description": "AAD user Ids authorized for data plane access.", + "items": { + "type": "string" + } + }, + "groupIds": { + "type": "array", + "description": "AAD group Ids authorized for data plane access.", + "items": { + "type": "string" + } + } + } + }, + "SecretReference": { + "type": "object", + "description": "Secret reference and corresponding properties of a key vault secret.", + "required": [ + "referenceName", + "type", + "keyVaultObjectName" + ], + "properties": { + "referenceName": { + "type": "string", + "description": "Reference name of the secret to be used in service configs." + }, + "type": { + "type": "string", + "description": "Type of key vault object: secret, key or certificate.", + "enum": [ + "Key", + "Secret", + "Certificate" + ], + "x-ms-enum": { + "name": "KeyVaultObjectType", + "modelAsString": true + } + }, + "version": { + "type": "string", + "description": "Version of the secret in key vault." + }, + "keyVaultObjectName": { + "type": "string", + "description": "Object identifier name of the secret in key vault.", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,126}$" + } + } + }, + "SecretsProfile": { + "type": "object", + "description": "The cluster secret profile.", + "required": [ + "keyVaultResourceId" + ], + "properties": { + "keyVaultResourceId": { + "type": "string", + "description": "Name of the user Key Vault where all the cluster specific user secrets are stored.", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "secrets": { + "type": "array", + "description": "Properties of Key Vault secret.", + "items": { + "$ref": "#/definitions/SecretReference" + }, + "x-ms-identifiers": [] + } + } + }, + "ClusterConfigFile": { + "type": "object", + "description": "Cluster configuration files.", + "required": [ + "fileName" + ], + "properties": { + "fileName": { + "type": "string", + "description": "Configuration file name.", + "example": "hive-conf.xml." + }, + "content": { + "type": "string", + "description": "Free form content of the entire configuration file." + }, + "encoding": { + "type": "string", + "description": "This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text.", + "enum": [ + "Base64", + "None" + ], + "x-ms-enum": { + "name": "ContentEncoding", + "modelAsString": true + } + }, + "path": { + "type": "string", + "description": "Path of the config file if content is specified." + }, + "values": { + "type": "object", + "description": "List of key value pairs\nwhere key represents a valid service configuration name and value represents the value of the config.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ClusterServiceConfig": { + "type": "object", + "description": "Cluster configs per component.", + "required": [ + "component", + "files" + ], + "properties": { + "component": { + "type": "string", + "description": "Name of the component the config files should apply to." + }, + "files": { + "type": "array", + "description": "List of Config Files.", + "items": { + "$ref": "#/definitions/ClusterConfigFile" + }, + "x-ms-identifiers": [] + } + } + }, + "ClusterServiceConfigsProfile": { + "type": "object", + "description": "Cluster service configs.", + "required": [ + "serviceName", + "configs" + ], + "properties": { + "serviceName": { + "type": "string", + "description": "Name of the service the configurations should apply to." + }, + "configs": { + "type": "array", + "description": "List of service configs.", + "items": { + "$ref": "#/definitions/ClusterServiceConfig" + }, + "x-ms-identifiers": [] + } + } + }, + "ConnectivityProfile": { + "type": "object", + "description": "Cluster connectivity profile.", + "required": [ + "web" + ], + "properties": { + "web": { + "description": "Web connectivity endpoint details.", + "allOf": [ + { + "$ref": "#/definitions/WebConnectivityEndpoint" + } + ] + }, + "ssh": { + "type": "array", + "description": "List of SSH connectivity endpoints.", + "items": { + "$ref": "#/definitions/SshConnectivityEndpoint" + }, + "x-ms-identifiers": [] + } + }, + "readOnly": true + }, + "ClusterAccessProfile": { + "type": "object", + "description": "Cluster access profile.", + "required": [ + "enableInternalIngress" + ], + "properties": { + "enableInternalIngress": { + "type": "boolean", + "description": "Whether to create cluster using private IP instead of public IP. This property must be set at create time.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "privateLinkServiceId": { + "type": "string", + "readOnly": true, + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateLinkServices" + } + ] + }, + "description": "Private link service resource ID. Only when enableInternalIngress is true, this property will be returned." + } + } + }, + "WebConnectivityEndpoint": { + "type": "object", + "description": "Web connectivity endpoint details.", + "required": [ + "fqdn" + ], + "properties": { + "fqdn": { + "type": "string", + "description": "Web connectivity endpoint.", + "example": "clusterName11223344.clusterPoolName55667788.subid.eastus.hdinsightaks.net" + }, + "privateFqdn": { + "type": "string", + "description": "Private web connectivity endpoint. This property will only be returned when enableInternalIngress is true.", + "example": "clusterName11223344-int.clusterPoolName55667788.subid.eastus.hdinsightaks.net" + } + }, + "readOnly": true + }, + "SshConnectivityEndpoint": { + "type": "object", + "description": "SSH connectivity endpoint details.", + "required": [ + "endpoint" + ], + "properties": { + "endpoint": { + "type": "string", + "description": "SSH connectivity endpoint.", + "example": "clusterName11223344.clusterPoolName55667788.eastus.hdinsightaks.net/ssh/host/podPrefix-0" + }, + "privateSshEndpoint": { + "type": "string", + "description": "Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true.", + "example": "clusterName11223344-int.clusterPoolName55667788.eastus.hdinsightaks.net/ssh/host/podPrefix-0" + } + } + }, + "ClusterProfile": { + "type": "object", + "required": [ + "authorizationProfile", + "clusterVersion", + "ossVersion" + ], + "properties": { + "clusterVersion": { + "$ref": "#/definitions/ThreeOrFourPartVersionPattern" + }, + "ossVersion": { + "$ref": "#/definitions/ThreePartVersionPattern" + }, + "components": { + "$ref": "#/definitions/ClusterComponents" + }, + "identityProfile": { + "description": "This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster.", + "$ref": "#/definitions/IdentityProfile" + }, + "authorizationProfile": { + "$ref": "#/definitions/AuthorizationProfile" + }, + "secretsProfile": { + "$ref": "#/definitions/SecretsProfile" + }, + "serviceConfigsProfiles": { + "type": "array", + "description": "The service configs profiles.", + "items": { + "$ref": "#/definitions/ClusterServiceConfigsProfile" + }, + "x-ms-identifiers": [] + }, + "connectivityProfile": { + "$ref": "#/definitions/ConnectivityProfile" + }, + "clusterAccessProfile": { + "$ref": "#/definitions/ClusterAccessProfile" + }, + "logAnalyticsProfile": { + "$ref": "#/definitions/ClusterLogAnalyticsProfile" + }, + "prometheusProfile": { + "$ref": "#/definitions/ClusterPrometheusProfile" + }, + "sshProfile": { + "$ref": "#/definitions/SshProfile" + }, + "autoscaleProfile": { + "$ref": "#/definitions/AutoscaleProfile" + }, + "rangerPluginProfile": { + "$ref": "#/definitions/ClusterRangerPluginProfile" + }, + "kafkaProfile": { + "$ref": "#/definitions/KafkaProfile" + }, + "trinoProfile": { + "$ref": "#/definitions/TrinoProfile" + }, + "llapProfile": { + "type": "object", + "description": "LLAP cluster profile.", + "additionalProperties": true + }, + "flinkProfile": { + "$ref": "#/definitions/FlinkProfile" + }, + "sparkProfile": { + "$ref": "#/definitions/SparkProfile" + }, + "rangerProfile": { + "$ref": "#/definitions/RangerProfile" + }, + "stubProfile": { + "type": "object", + "description": "Stub cluster profile.", + "additionalProperties": true + }, + "scriptActionProfiles": { + "$ref": "#/definitions/ScriptActionProfiles" + } + }, + "description": "Cluster profile." + }, + "SshProfile": { + "type": "object", + "description": "Ssh profile for the cluster.", + "required": [ + "count" + ], + "properties": { + "count": { + "type": "integer", + "description": "Number of ssh pods per cluster.", + "format": "int32", + "maximum": 5.0, + "minimum": 0.0 + }, + "podPrefix": { + "type": "string", + "description": "Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //-", + "readOnly": true + } + } + }, + "AutoscaleProfile": { + "type": "object", + "description": "This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale.", + "required": [ + "enabled" + ], + "properties": { + "enabled": { + "type": "boolean", + "description": "This indicates whether auto scale is enabled on HDInsight on AKS cluster." + }, + "gracefulDecommissionTimeout": { + "type": "integer", + "format": "int32", + "description": "This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout." + }, + "autoscaleType": { + "type": "string", + "description": "User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based.", + "enum": [ + "ScheduleBased", + "LoadBased" + ], + "x-ms-enum": { + "name": "AutoscaleType", + "modelAsString": true + } + }, + "scheduleBasedConfig": { + "description": "Profiles of schedule based Autoscale.", + "$ref": "#/definitions/ScheduleBasedConfig" + }, + "loadBasedConfig": { + "description": "Profiles of load based Autoscale.", + "$ref": "#/definitions/LoadBasedConfig" + } + } + }, + "ScheduleBasedConfig": { + "type": "object", + "description": "Profile of schedule based Autoscale.", + "required": [ + "timeZone", + "defaultCount", + "schedules" + ], + "properties": { + "timeZone": { + "type": "string", + "description": "User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration." + }, + "defaultCount": { + "type": "integer", + "format": "int32", + "description": "Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down)" + }, + "schedules": { + "type": "array", + "description": "This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end).", + "items": { + "$ref": "#/definitions/Schedule" + }, + "x-ms-identifiers": [] + } + } + }, + "Schedule": { + "type": "object", + "description": "Schedule definition.", + "required": [ + "days", + "startTime", + "endTime", + "count" + ], + "properties": { + "startTime": { + "type": "string", + "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", + "description": "User has to set the start time of current schedule configuration, format like 10:30 (HH:MM)." + }, + "endTime": { + "type": "string", + "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", + "description": "User has to set the end time of current schedule configuration, format like 10:30 (HH:MM)." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer." + }, + "days": { + "type": "array", + "description": "User has to set the days where schedule has to be set for autoscale operation.", + "items": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "ScheduleDay", + "modelAsString": true + } + } + } + } + }, + "LoadBasedConfig": { + "type": "object", + "description": "Profile of load based Autoscale.", + "required": [ + "minNodes", + "maxNodes", + "scalingRules" + ], + "properties": { + "minNodes": { + "type": "integer", + "format": "int32", + "description": "User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes." + }, + "maxNodes": { + "type": "integer", + "format": "int32", + "description": "User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes." + }, + "pollInterval": { + "type": "integer", + "format": "int32", + "description": "User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation." + }, + "cooldownPeriod": { + "type": "integer", + "format": "int32", + "description": "This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds." + }, + "scalingRules": { + "type": "array", + "description": "The scaling rules.", + "items": { + "$ref": "#/definitions/ScalingRule" + }, + "x-ms-identifiers": [] + } + } + }, + "ScalingRule": { + "type": "object", + "description": "The scaling rule.", + "required": [ + "actionType", + "comparisonRule", + "evaluationCount", + "scalingMetric" + ], + "properties": { + "actionType": { + "type": "string", + "description": "The action type.", + "enum": [ + "scaleup", + "scaledown" + ], + "x-ms-enum": { + "name": "ScaleActionType", + "modelAsString": true + } + }, + "evaluationCount": { + "type": "integer", + "format": "int32", + "description": "This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered." + }, + "scalingMetric": { + "type": "string", + "description": "Metrics name for individual workloads. For example: cpu" + }, + "comparisonRule": { + "$ref": "#/definitions/ComparisonRule" + } + } + }, + "ComparisonRule": { + "type": "object", + "description": "The comparison rule.", + "required": [ + "operator", + "threshold" + ], + "properties": { + "operator": { + "type": "string", + "description": "The comparison operator.", + "enum": [ + "greaterThan", + "greaterThanOrEqual", + "lessThan", + "lessThanOrEqual" + ], + "x-ms-enum": { + "name": "ComparisonOperator", + "modelAsString": true + } + }, + "threshold": { + "type": "number", + "description": "Threshold setting." + } + } + }, + "TrinoProfile": { + "type": "object", + "description": "Trino Cluster profile.", + "properties": { + "catalogOptions": { + "$ref": "#/definitions/CatalogOptions" + }, + "coordinator": { + "$ref": "#/definitions/TrinoCoordinator" + }, + "userPluginsSpec": { + "$ref": "#/definitions/TrinoUserPlugins" + }, + "userTelemetrySpec": { + "$ref": "#/definitions/TrinoUserTelemetry" + }, + "worker": { + "$ref": "#/definitions/TrinoWorker" + } + } + }, + "CatalogOptions": { + "type": "object", + "description": "Trino cluster catalog options.", + "properties": { + "hive": { + "type": "array", + "description": "hive catalog options.", + "items": { + "$ref": "#/definitions/HiveCatalogOption" + }, + "x-ms-identifiers": [] + } + } + }, + "HiveCatalogOption": { + "type": "object", + "description": "Hive Catalog Option", + "required": [ + "catalogName", + "metastoreDbConnectionURL", + "metastoreWarehouseDir" + ], + "properties": { + "catalogName": { + "description": "Name of trino catalog which should use specified hive metastore.", + "minLength": 1, + "type": "string" + }, + "metastoreDbConnectionAuthenticationMode": { + "description": "The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization", + "type": "string", + "enum": [ + "SqlAuth", + "IdentityAuth" + ], + "x-ms-enum": { + "name": "MetastoreDbConnectionAuthenticationMode", + "modelAsString": true, + "values": [ + { + "value": "SqlAuth", + "description": "The password-based authentication to connect to your Hive metastore database. " + }, + { + "value": "IdentityAuth", + "description": "The managed-identity-based authentication to connect to your Hive metastore database. " + } + ] + }, + "default": "IdentityAuth" + }, + "metastoreDbConnectionPasswordSecret": { + "description": "Secret reference name from secretsProfile.secrets containing password for database connection.", + "type": "string" + }, + "metastoreDbConnectionURL": { + "description": "Connection string for hive metastore database.", + "type": "string" + }, + "metastoreDbConnectionUserName": { + "description": "User name for database connection.", + "type": "string" + }, + "metastoreWarehouseDir": { + "description": "Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri", + "type": "string" + } + } + }, + "FlinkCatalogOptions": { + "type": "object", + "description": "Flink cluster catalog options.", + "properties": { + "hive": { + "$ref": "#/definitions/FlinkHiveCatalogOption" + } + } + }, + "FlinkHiveCatalogOption": { + "type": "object", + "description": "Hive Catalog Option for Flink cluster.", + "required": [ + "metastoreDbConnectionURL" + ], + "properties": { + "metastoreDbConnectionAuthenticationMode": { + "description": "The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization", + "type": "string", + "enum": [ + "SqlAuth", + "IdentityAuth" + ], + "x-ms-enum": { + "name": "MetastoreDbConnectionAuthenticationMode", + "modelAsString": true, + "values": [ + { + "value": "SqlAuth", + "description": "The password-based authentication to connect to your Hive metastore database. " + }, + { + "value": "IdentityAuth", + "description": "The managed-identity-based authentication to connect to your Hive metastore database. " + } + ] + }, + "default": "IdentityAuth" + }, + "metastoreDbConnectionPasswordSecret": { + "description": "Secret reference name from secretsProfile.secrets containing password for database connection.", + "type": "string" + }, + "metastoreDbConnectionURL": { + "description": "Connection string for hive metastore database.", + "type": "string" + }, + "metastoreDbConnectionUserName": { + "description": "User name for database connection.", + "type": "string" + } + } + }, + "TrinoCoordinator": { + "type": "object", + "description": "Trino Coordinator.", + "properties": { + "debug": { + "$ref": "#/definitions/TrinoDebugConfig", + "x-ms-client-flatten": true + }, + "highAvailabilityEnabled": { + "type": "boolean", + "description": "The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true.", + "default": true + } + } + }, + "TrinoWorker": { + "type": "object", + "description": "Trino worker.", + "properties": { + "debug": { + "$ref": "#/definitions/TrinoDebugConfig", + "x-ms-client-flatten": true + } + } + }, + "TrinoDebugConfig": { + "type": "object", + "description": "Trino debug configuration.", + "properties": { + "enable": { + "type": "boolean", + "description": "The flag that if enable debug or not.", + "default": false + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The debug port.", + "default": 8008 + }, + "suspend": { + "type": "boolean", + "description": "The flag that if suspend debug or not.", + "default": false + } + } + }, + "TrinoUserTelemetry": { + "type": "object", + "description": "User telemetry", + "properties": { + "storage": { + "$ref": "#/definitions/TrinoTelemetryConfig" + } + } + }, + "TrinoTelemetryConfig": { + "type": "object", + "description": "Trino user telemetry definition.", + "properties": { + "hivecatalogName": { + "type": "string", + "description": "Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created.", + "minLength": 1 + }, + "hivecatalogSchema": { + "type": "string", + "description": "Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs.", + "default": "trinologs" + }, + "partitionRetentionInDays": { + "type": "integer", + "description": "Retention period for query log table partitions, this doesn't have any affect on actual data.", + "format": "int32", + "default": 365 + }, + "path": { + "type": "string", + "description": "Azure storage location of the blobs.", + "minLength": 1 + } + } + }, + "TrinoUserPlugins": { + "type": "object", + "description": "Trino user plugins spec", + "properties": { + "plugins": { + "type": "array", + "description": "Trino user plugins.", + "items": { + "$ref": "#/definitions/TrinoUserPlugin" + }, + "x-ms-identifiers": [] + } + } + }, + "TrinoUserPlugin": { + "type": "object", + "description": "Trino user plugin.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Denotes whether the plugin is active or not." + }, + "name": { + "type": "string", + "description": "This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path.", + "minLength": 1 + }, + "path": { + "type": "string", + "description": "Fully qualified path to the folder containing the plugins.", + "minLength": 1, + "pattern": "^(https)|(abfss)://.*$" + } + } + }, + "SparkProfile": { + "type": "object", + "description": "The spark cluster profile.", + "properties": { + "defaultStorageUrl": { + "type": "string", + "description": "The default storage URL." + }, + "metastoreSpec": { + "$ref": "#/definitions/SparkMetastoreSpec" + }, + "userPluginsSpec": { + "$ref": "#/definitions/SparkUserPlugins" + } + } + }, + "SparkUserPlugins": { + "type": "object", + "description": "Spark user plugins spec", + "properties": { + "plugins": { + "type": "array", + "description": "Spark user plugins.", + "items": { + "$ref": "#/definitions/SparkUserPlugin" + }, + "x-ms-identifiers": [] + } + } + }, + "SparkUserPlugin": { + "type": "object", + "description": "Spark user plugin.", + "required": [ + "path" + ], + "properties": { + "path": { + "type": "string", + "description": "Fully qualified path to the folder containing the plugins.", + "minLength": 1, + "pattern": "^(https)|(abfss)://.*$" + } + } + }, + "ScriptActionProfiles": { + "type": "array", + "description": "The script action profile list.", + "items": { + "$ref": "#/definitions/ScriptActionProfile" + }, + "x-ms-identifiers": [] + }, + "ScriptActionProfile": { + "type": "object", + "description": "The script action profile.", + "required": [ + "name", + "type", + "url", + "services" + ], + "properties": { + "type": { + "type": "string", + "description": "Type of the script action. Supported type is bash scripts." + }, + "name": { + "type": "string", + "description": "Script name." + }, + "url": { + "type": "string", + "description": "Url of the script file.", + "pattern": "^(https)|(http)://.*$" + }, + "parameters": { + "type": "string", + "description": "Additional parameters for the script action. It should be space-separated list of arguments required for script execution." + }, + "services": { + "items": { + "type": "string" + }, + "type": "array", + "description": "List of services to apply the script action." + }, + "timeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "Timeout duration for the script action in minutes." + }, + "shouldPersist": { + "type": "boolean", + "default": true, + "description": "Specify if the script should persist on the cluster." + } + } + }, + "SparkMetastoreSpec": { + "type": "object", + "description": "The metastore specification for Spark cluster.", + "required": [ + "dbServerHost", + "dbName" + ], + "properties": { + "dbServerHost": { + "type": "string", + "description": "The database server host." + }, + "dbName": { + "type": "string", + "description": "The database name." + }, + "dbConnectionAuthenticationMode": { + "description": "The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization", + "type": "string", + "enum": [ + "SqlAuth", + "IdentityAuth" + ], + "x-ms-enum": { + "name": "DbConnectionAuthenticationMode", + "modelAsString": true, + "values": [ + { + "value": "SqlAuth", + "description": "The password-based authentication to connect to your Hive metastore database. " + }, + { + "value": "IdentityAuth", + "description": "The managed-identity-based authentication to connect to your Hive metastore database. " + } + ] + }, + "default": "IdentityAuth" + }, + "dbUserName": { + "type": "string", + "description": "The database user name." + }, + "dbPasswordSecretName": { + "type": "string", + "description": "The secret name which contains the database user password." + }, + "keyVaultId": { + "type": "string", + "description": "The key vault resource id." + }, + "thriftUrl": { + "type": "string", + "description": "The thrift url." + } + } + }, + "FlinkProfile": { + "type": "object", + "description": "The Flink cluster profile.", + "required": [ + "storage", + "jobManager", + "taskManager" + ], + "properties": { + "storage": { + "$ref": "#/definitions/FlinkStorageProfile" + }, + "numReplicas": { + "type": "integer", + "format": "int32", + "description": "The number of task managers." + }, + "jobManager": { + "description": "Job Manager container/ process CPU and memory requirements", + "$ref": "#/definitions/ComputeResourceDefinition" + }, + "historyServer": { + "description": "History Server container/ process CPU and memory requirements", + "$ref": "#/definitions/ComputeResourceDefinition" + }, + "taskManager": { + "description": "Task Manager container/ process CPU and memory requirements", + "$ref": "#/definitions/ComputeResourceDefinition" + }, + "catalogOptions": { + "$ref": "#/definitions/FlinkCatalogOptions" + }, + "deploymentMode": { + "description": "A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session", + "type": "string", + "enum": [ + "Application", + "Session" + ], + "x-ms-enum": { + "name": "deploymentMode", + "modelAsString": true + } + }, + "jobSpec": { + "$ref": "#/definitions/FlinkJobProfile" + } + } + }, + "FlinkJobProfile": { + "type": "object", + "description": "Job specifications for flink clusters in application deployment mode. The specification is immutable even if job properties are changed by calling the RunJob API, please use the ListJob API to get the latest job information.", + "required": [ + "jobJarDirectory", + "jarName", + "upgradeMode" + ], + "properties": { + "jobJarDirectory": { + "description": "A string property that specifies the directory where the job JAR is located.", + "type": "string" + }, + "jarName": { + "description": "A string property that represents the name of the job JAR.", + "type": "string" + }, + "entryClass": { + "description": "A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package.", + "type": "string" + }, + "args": { + "description": "A string property representing additional JVM arguments for the Flink job. It should be space separated value.", + "type": "string" + }, + "savePointName": { + "description": "A string property that represents the name of the savepoint for the Flink job", + "type": "string" + }, + "upgradeMode": { + "description": "A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE.", + "type": "string", + "enum": [ + "STATELESS_UPDATE", + "UPDATE", + "LAST_STATE_UPDATE" + ], + "x-ms-enum": { + "name": "upgradeMode", + "modelAsString": true + } + } + } + }, + "FlinkStorageProfile": { + "type": "object", + "description": "The storage profile", + "required": [ + "storageUri" + ], + "properties": { + "storageUri": { + "type": "string", + "pattern": "^(\\w{4,5})://(.*)@(.*).\\b(blob|dfs)\\b.*$", + "description": "Storage account uri which is used for savepoint and checkpoint state." + }, + "storagekey": { + "type": "string", + "description": "Storage key is only required for wasb(s) storage.", + "x-ms-secret": true + } + } + }, + "ClusterRangerPluginProfile": { + "type": "object", + "description": "Cluster Ranger plugin profile.", + "required": [ + "enabled" + ], + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable Ranger for cluster or not.", + "default": false + } + } + }, + "RangerProfile": { + "type": "object", + "description": "The ranger cluster profile.", + "required": [ + "rangerAdmin", + "rangerUsersync" + ], + "properties": { + "rangerAdmin": { + "$ref": "#/definitions/RangerAdminSpec" + }, + "rangerAudit": { + "$ref": "#/definitions/RangerAuditSpec" + }, + "rangerUsersync": { + "$ref": "#/definitions/RangerUsersyncSpec" + } + } + }, + "RangerAdminSpec": { + "type": "object", + "description": "Specification for the Ranger Admin service.", + "properties": { + "admins": { + "description": "List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users.", + "items": { + "type": "string" + }, + "type": "array" + }, + "database": { + "properties": { + "host": { + "description": "The database URL", + "type": "string" + }, + "name": { + "description": "The database name", + "type": "string" + }, + "passwordSecretRef": { + "description": "Reference for the database password", + "type": "string" + }, + "username": { + "description": "The name of the database user", + "type": "string" + } + }, + "required": [ + "host", + "name" + ], + "type": "object" + } + }, + "required": [ + "admins", + "database" + ] + }, + "RangerAuditSpec": { + "description": "Properties required to describe audit log storage.", + "properties": { + "storageAccount": { + "description": "Azure storage location of the blobs. MSI should have read/write access to this Storage account.", + "minLength": 1, + "pattern": "^(https)|(abfss)://.*$", + "type": "string" + } + }, + "type": "object" + }, + "RangerUsersyncSpec": { + "description": "Specification for the Ranger Usersync service", + "properties": { + "enabled": { + "description": "Denotes whether usersync service should be enabled", + "type": "boolean", + "default": true + }, + "groups": { + "description": "List of groups that should be synced. These group names should match the object id of the respective AAD groups.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mode": { + "default": "automatic", + "description": "User & groups can be synced automatically or via a static list that's refreshed.", + "type": "string", + "enum": [ + "static", + "automatic" + ], + "x-ms-enum": { + "name": "RangerUsersyncMode", + "modelAsString": true + } + }, + "userMappingLocation": { + "description": "Azure storage location of a mapping file that lists user & group associations.", + "minLength": 1, + "pattern": "^(https)|(abfss)://.*$", + "type": "string" + }, + "users": { + "description": "List of user names that should be synced. These usernames should match the User principal name of the respective AAD users.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ComputeResourceDefinition": { + "type": "object", + "description": "The cpu and memory requirement definition.", + "required": [ + "cpu", + "memory" + ], + "properties": { + "cpu": { + "type": "number", + "format": "float", + "description": "The required CPU." + }, + "memory": { + "type": "integer", + "format": "int64", + "description": "The required memory in MB, Container memory will be 110 percentile" + } + } + }, + "KafkaProfile": { + "type": "object", + "description": "The Kafka cluster profile.", + "required": [ + "diskStorage" + ], + "properties": { + "enableKRaft": { + "description": "Expose Kafka cluster in KRaft mode.", + "default": true, + "type": "boolean" + }, + "enablePublicEndpoints": { + "description": "Expose worker nodes as public endpoints.", + "default": false, + "type": "boolean" + }, + "remoteStorageUri": { + "description": "Fully qualified path of Azure Storage container used for Tiered Storage.", + "type": "string", + "pattern": "^(https?|abfss?):\\/\\/[^/]+(?:\\/|$)" + }, + "diskStorage": { + "$ref": "#/definitions/DiskStorageProfile" + }, + "clusterIdentity": { + "description": "Identity of the internal service components inside the Kafka cluster.", + "$ref": "#/definitions/IdentityProfile", + "readOnly": true + }, + "connectivityEndpoints": { + "description": "Kafka bootstrap server and brokers related connectivity endpoints.", + "$ref": "#/definitions/KafkaConnectivityEndpoints", + "readOnly": true + } + } + }, + "DiskStorageProfile": { + "type": "object", + "description": "Kafka disk storage profile.", + "required": [ + "dataDiskSize", + "dataDiskType" + ], + "properties": { + "dataDiskSize": { + "description": "Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB.", + "format": "int32", + "type": "integer" + }, + "dataDiskType": { + "description": "Managed Disk Type.", + "type": "string", + "enum": [ + "Standard_HDD_LRS", + "Standard_SSD_LRS", + "Standard_SSD_ZRS", + "Premium_SSD_LRS", + "Premium_SSD_ZRS", + "Premium_SSD_v2_LRS" + ], + "x-ms-enum": { + "name": "DataDiskType", + "modelAsString": true + } + } + } + }, + "KafkaConnectivityEndpoints": { + "type": "object", + "description": "Kafka bootstrap server and broker related connectivity endpoints.", + "properties": { + "bootstrapServerEndpoint": { + "type": "string", + "description": "bootstrap server connectivity endpoint." + }, + "brokerEndpoints": { + "description": "Kafka broker endpoint list.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "ClusterResourceProperties": { + "type": "object", + "required": [ + "clusterType", + "computeProfile", + "clusterProfile" + ], + "properties": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "type": "string", + "enum": [ + "Accepted", + "Succeeded", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningStatus", + "modelAsString": true + }, + "readOnly": true + }, + "clusterType": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The type of cluster.", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{0,31}$" + }, + "deploymentId": { + "type": "string", + "description": "A unique id generated by the RP to identify the resource.", + "example": "45cd32aead6e4a91b079a0cdbfac8c36", + "readOnly": true + }, + "computeProfile": { + "description": "The compute profile.", + "$ref": "#/definitions/ComputeProfile" + }, + "clusterProfile": { + "$ref": "#/definitions/ClusterProfile" + }, + "status": { + "type": "string", + "description": "Business status of the resource.", + "example": "Running", + "readOnly": true + } + }, + "description": "Cluster resource properties." + }, + "ComputeProfile": { + "type": "object", + "description": "The compute profile.", + "required": [ + "nodes" + ], + "properties": { + "nodes": { + "type": "array", + "description": "The nodes definitions.", + "items": { + "$ref": "#/definitions/NodeProfile" + }, + "x-ms-identifiers": [] + } + } + }, + "NodeProfile": { + "type": "object", + "description": "The node profile.", + "required": [ + "type", + "vmSize", + "count" + ], + "properties": { + "type": { + "type": "string", + "description": "The node type.", + "pattern": "^(head|Head|HEAD|worker|Worker|WORKER)$" + }, + "vmSize": { + "type": "string", + "description": "The virtual machine SKU.", + "pattern": "^[a-zA-Z0-9_\\-]{0,256}$" + }, + "count": { + "description": "The number of virtual machines.", + "type": "integer", + "format": "int32", + "minimum": 1 + } + } + }, + "Cluster": { + "type": "object", + "description": "The cluster.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Gets or sets the properties. Define cluster specific properties.", + "$ref": "#/definitions/ClusterResourceProperties" + }, + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "SystemData of cluster.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ClusterPatch": { + "type": "object", + "description": "The patch for a cluster.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Define cluster patch specific properties.", + "$ref": "#/definitions/ClusterPatchProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "ClusterPatchProperties": { + "type": "object", + "description": "Cluster resource patch data.", + "properties": { + "clusterProfile": { + "$ref": "#/definitions/UpdatableClusterProfile" + } + } + }, + "UpdatableClusterProfile": { + "type": "object", + "properties": { + "serviceConfigsProfiles": { + "type": "array", + "description": "The service configs profiles.", + "items": { + "$ref": "#/definitions/ClusterServiceConfigsProfile" + }, + "x-ms-identifiers": [] + }, + "sshProfile": { + "$ref": "#/definitions/SshProfile" + }, + "autoscaleProfile": { + "$ref": "#/definitions/AutoscaleProfile" + }, + "authorizationProfile": { + "$ref": "#/definitions/AuthorizationProfile" + }, + "logAnalyticsProfile": { + "$ref": "#/definitions/ClusterLogAnalyticsProfile" + }, + "prometheusProfile": { + "$ref": "#/definitions/ClusterPrometheusProfile" + }, + "rangerPluginProfile": { + "$ref": "#/definitions/ClusterRangerPluginProfile" + }, + "rangerProfile": { + "$ref": "#/definitions/RangerProfile" + }, + "scriptActionProfiles": { + "$ref": "#/definitions/ScriptActionProfiles" + } + }, + "description": "Cluster resource patch properties." + }, + "ClusterResizeData": { + "type": "object", + "description": "The parameters for resizing a cluster.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Sets the properties. Define cluster resize specific properties.", + "$ref": "#/definitions/ClusterResizeProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ClusterResizeProperties": { + "type": "object", + "description": "The properties for resizing a cluster.", + "required": [ + "targetWorkerNodeCount" + ], + "properties": { + "targetWorkerNodeCount": { + "type": "integer", + "format": "int32", + "description": "Target node count of worker node." + } + } + }, + "ServiceConfigListResult": { + "type": "object", + "description": "Cluster instance service configs api response.", + "properties": { + "value": { + "type": "array", + "description": "Cluster instance service config array.", + "items": { + "$ref": "#/definitions/ServiceConfigResult" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link (url) to the next page of results.", + "readOnly": true + } + } + }, + "ServiceConfigResult": { + "type": "object", + "description": "Cluster instance service config.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Cluster instance service config properties.", + "allOf": [ + { + "$ref": "#/definitions/ServiceConfigListResultProperties" + } + ] + } + } + }, + "ServiceConfigListResultProperties": { + "type": "object", + "properties": { + "serviceName": { + "type": "string", + "description": "Service Config Name." + }, + "fileName": { + "type": "string", + "description": "File Name." + }, + "content": { + "type": "string", + "description": "Content in the service config file." + }, + "componentName": { + "type": "string", + "description": "Component Name." + }, + "type": { + "type": "string", + "description": "Config type." + }, + "path": { + "type": "string", + "description": "Config file path." + }, + "customKeys": { + "type": "object", + "description": "The custom keys.", + "additionalProperties": { + "type": "string" + } + }, + "defaultKeys": { + "type": "object", + "description": "The default keys.", + "additionalProperties": { + "$ref": "#/definitions/ServiceConfigListResultValueEntity" + } + } + }, + "required": [ + "serviceName", + "componentName", + "fileName" + ], + "description": "Service config response." + }, + "ServiceConfigListResultValueEntity": { + "type": "object", + "description": "Default config details.", + "properties": { + "value": { + "type": "string", + "description": "Config value." + }, + "description": { + "type": "string", + "description": "Config description." + } + }, + "required": [ + "value" + ] + }, + "ClusterInstanceViewsResult": { + "type": "object", + "properties": { + "value": { + "items": { + "$ref": "#/definitions/ClusterInstanceViewResult" + }, + "type": "array", + "description": "Cluster instance view array.", + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + }, + "description": "The instance view of a HDInsight Cluster." + }, + "ClusterInstanceViewResult": { + "type": "object", + "description": "Cluster Instance View.", + "required": [ + "name", + "properties" + ], + "properties": { + "name": { + "type": "string", + "description": "Name of the instance view." + }, + "properties": { + "description": "Properties of the instance view.", + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/ClusterInstanceViewProperties" + } + ] + } + } + }, + "ClusterInstanceViewProperties": { + "type": "object", + "description": "Cluster Instance View Properties.", + "required": [ + "status", + "serviceStatuses" + ], + "properties": { + "status": { + "description": "Status of the instance view.", + "allOf": [ + { + "$ref": "#/definitions/ClusterInstanceViewStatus" + } + ] + }, + "serviceStatuses": { + "type": "array", + "description": "List of statuses of relevant services that make up the HDInsight on AKS cluster to surface to the customer.", + "items": { + "$ref": "#/definitions/ServiceStatus" + }, + "x-ms-identifiers": [] + } + } + }, + "ClusterInstanceViewStatus": { + "type": "object", + "description": "Status of the instance view.", + "required": [ + "ready" + ], + "properties": { + "ready": { + "type": "string", + "description": "The cluster ready status" + }, + "reason": { + "type": "string", + "description": "The status reason." + }, + "message": { + "type": "string", + "description": "The additional message." + } + } + }, + "ServiceStatus": { + "type": "object", + "description": "Describes the status of a service of a HDInsight on AKS cluster.", + "required": [ + "kind", + "ready" + ], + "properties": { + "kind": { + "type": "string", + "description": "Kind of the service. E.g. \"Zookeeper\"." + }, + "ready": { + "type": "string", + "description": "Indicates if the service is ready / healthy. Values can be \"true\", \"false\", \"unknown\" or anything else." + }, + "message": { + "type": "string", + "description": "A message describing the error if any." + } + } + }, + "NameAvailabilityParameters": { + "description": "Details of check name availability request body.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name for checking availability." + }, + "type": { + "type": "string", + "description": "The resource type in Microsoft.HDInsight." + } + } + }, + "NameAvailabilityResult": { + "description": "Result of check name availability.", + "type": "object", + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Indicator of availability of the Microsoft.HDInsight resource name." + }, + "reason": { + "type": "string", + "description": "The reason of unavailability." + }, + "message": { + "type": "string", + "description": "The error message of unavailability." + } + } + }, + "ClusterPoolVersionPattern": { + "type": "string", + "description": "Cluster pool version is a 2-part version.", + "example": "1.2", + "pattern": "^(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})$" + }, + "ClusterPoolVersionsListResult": { + "type": "object", + "description": "Represents a list of cluster pool versions.", + "properties": { + "value": { + "type": "array", + "description": "The list of cluster pool versions.", + "items": { + "$ref": "#/definitions/ClusterPoolVersion" + } + }, + "nextLink": { + "type": "string", + "description": "The link (url) to the next page of results.", + "readOnly": true + } + } + }, + "ClusterPoolVersion": { + "type": "object", + "description": "Available cluster pool version.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Cluster pool version properties.", + "$ref": "#/definitions/ClusterPoolVersionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ClusterPoolVersionProperties": { + "type": "object", + "description": "Cluster pool version properties.", + "properties": { + "clusterPoolVersion": { + "$ref": "#/definitions/ClusterPoolVersionPattern" + }, + "aksVersion": { + "type": "string", + "description": "AKS version.", + "example": "1.24" + }, + "isPreview": { + "type": "boolean", + "description": "Indicate if this version is in preview or not.", + "default": false + } + } + }, + "ThreePartVersionPattern": { + "type": "string", + "description": "Version with three part.", + "example": "1.0.4", + "pattern": "^(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})$" + }, + "ThreeOrFourPartVersionPattern": { + "type": "string", + "description": "Version with 3/4 part.", + "example": "1.0.4", + "pattern": "^(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})(?:\\.(0|[1-9][0-9]{0,18}))?$" + }, + "ClusterVersionsListResult": { + "type": "object", + "description": "Represents a list of cluster versions.", + "properties": { + "value": { + "type": "array", + "description": "The list of cluster versions.", + "items": { + "$ref": "#/definitions/ClusterVersion" + } + }, + "nextLink": { + "type": "string", + "description": "The link (url) to the next page of results.", + "readOnly": true + } + } + }, + "ClusterVersion": { + "type": "object", + "description": "Available cluster version.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Cluster version properties.", + "$ref": "#/definitions/ClusterVersionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ClusterVersionProperties": { + "type": "object", + "description": "Cluster version properties.", + "properties": { + "clusterType": { + "type": "string", + "description": "The type of cluster.", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{0,31}$" + }, + "clusterVersion": { + "$ref": "#/definitions/ThreePartVersionPattern" + }, + "ossVersion": { + "$ref": "#/definitions/ThreePartVersionPattern" + }, + "clusterPoolVersion": { + "type": "string", + "description": "The two part cluster pool version. If the cluster version is before cluster pool version on-board, the return value will be empty string", + "example": "1.0" + }, + "isPreview": { + "type": "boolean", + "description": "Indicate if this version is in preview or not.", + "default": false + }, + "components": { + "$ref": "#/definitions/ClusterComponents" + } + } + }, + "ClusterComponents": { + "type": "array", + "description": "Component list of this cluster type and version.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + } + }, + "x-ms-identifiers": [], + "example": [ + { + "name": "HDFS", + "version": "1.2.3" + }, + { + "name": "HIVE", + "version": "1.2.3" + } + ] + }, + "ClusterJobList": { + "description": "Collection of cluster job.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "Collection of cluster job.", + "uniqueItems": false, + "items": { + "$ref": "#/definitions/ClusterJob" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + } + } + }, + "ClusterJob": { + "description": "Cluster job.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/ClusterJobProperties" + } + } + }, + "ClusterJobProperties": { + "description": "Properties of cluster job.", + "type": "object", + "properties": { + "jobType": { + "description": "Type of cluster job.", + "enum": [ + "FlinkJob" + ], + "type": "string", + "x-ms-enum": { + "name": "jobType", + "modelAsString": true + } + } + }, + "discriminator": "jobType", + "required": [ + "jobType" + ] + }, + "FlinkJobProperties": { + "description": "Properties of flink job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClusterJobProperties" + } + ], + "properties": { + "runId": { + "description": "Run id of job", + "type": "string" + }, + "jobName": { + "description": "Name of job", + "type": "string" + }, + "jobJarDirectory": { + "description": "A string property that specifies the directory where the job JAR is located.", + "type": "string" + }, + "jarName": { + "description": "A string property that represents the name of the job JAR.", + "type": "string" + }, + "entryClass": { + "description": "A string property that specifies the entry class for the Flink job.", + "type": "string" + }, + "args": { + "description": "A string property representing additional JVM arguments for the Flink job. It should be space separated value.", + "type": "string" + }, + "savePointName": { + "description": "A string property that represents the name of the savepoint for the Flink job", + "type": "string" + }, + "action": { + "description": "A string property that indicates the action to be performed on the Flink job. It can have one of the following enum values => NEW, UPDATE, STATELESS_UPDATE, STOP, START, CANCEL, SAVEPOINT, LIST_SAVEPOINT, or DELETE.", + "type": "string", + "enum": [ + "NEW", + "UPDATE", + "STATELESS_UPDATE", + "STOP", + "START", + "CANCEL", + "SAVEPOINT", + "LIST_SAVEPOINT", + "DELETE", + "LAST_STATE_UPDATE", + "RE_LAUNCH" + ], + "x-ms-enum": { + "name": "action", + "modelAsString": true + } + }, + "flinkConfiguration": { + "description": "Additional properties used to configure Flink jobs. It allows users to set properties such as parallelism and jobSavePointDirectory. It accepts additional key-value pairs as properties, where the keys are strings and the values are strings as well.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "jobId": { + "description": "Unique id for identifying a job", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of job.", + "type": "string", + "readOnly": true + }, + "jobOutput": { + "description": "Output of job.", + "type": "string", + "readOnly": true + }, + "actionResult": { + "description": "Action result of job.", + "type": "string", + "readOnly": true + }, + "lastSavePoint": { + "description": "The last savepoint.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "FlinkJob" + }, + "ClusterPoolAvailableUpgradeList": { + "type": "object", + "description": "collection of cluster pool available upgrade.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "Collection of cluster pool available upgrade.", + "uniqueItems": false, + "items": { + "$ref": "#/definitions/ClusterPoolAvailableUpgrade" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + } + } + }, + "ClusterPoolAvailableUpgrade": { + "type": "object", + "description": "Cluster pool available upgrade.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Gets or sets the properties. Define cluster pool upgrade specific properties.", + "$ref": "#/definitions/ClusterPoolAvailableUpgradeProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ClusterPoolAvailableUpgradeProperties": { + "type": "object", + "description": "Cluster pool available upgrade properties.", + "properties": { + "upgradeType": { + "description": "Type of upgrade.", + "enum": [ + "AKSPatchUpgrade", + "NodeOsUpgrade" + ], + "type": "string", + "x-ms-enum": { + "name": "clusterPoolAvailableUpgradeType", + "modelAsString": true + } + } + }, + "discriminator": "upgradeType", + "required": [ + "upgradeType" + ] + }, + "ClusterPoolAvailableUpgradeAksPatchUpgradeProperties": { + "type": "object", + "description": "Cluster pool available AKS patch version upgrade.", + "allOf": [ + { + "$ref": "#/definitions/ClusterPoolAvailableUpgradeProperties" + } + ], + "properties": { + "currentVersion": { + "description": "Current AKS version.", + "type": "string" + }, + "currentVersionStatus": { + "description": "Current AKS version's status: whether it is deprecated or supported", + "enum": [ + "Deprecated", + "Supported" + ], + "type": "string", + "x-ms-enum": { + "name": "currentClusterPoolAksVersionStatus", + "modelAsString": true + } + }, + "latestVersion": { + "description": "Latest AKS patch version.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AKSPatchUpgrade" + }, + "ClusterPoolAvailableUpgradeNodeOsUpgradeProperties": { + "type": "object", + "description": "Cluster pool available node OS update.", + "allOf": [ + { + "$ref": "#/definitions/ClusterPoolAvailableUpgradeProperties" + } + ], + "properties": { + "latestVersion": { + "description": "The latest node OS version.", + "type": "string" + } + }, + "x-ms-discriminator-value": "NodeOsUpgrade" + }, + "ClusterAvailableUpgradeList": { + "type": "object", + "description": "Collection of cluster available upgrade.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "Collection of Cluster available upgrade.", + "uniqueItems": false, + "items": { + "$ref": "#/definitions/ClusterAvailableUpgrade" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL of next result page.", + "type": "string" + } + } + }, + "ClusterAvailableUpgrade": { + "type": "object", + "description": "Cluster available upgrade.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Gets or sets the properties. Define cluster upgrade specific properties.", + "$ref": "#/definitions/ClusterAvailableUpgradeProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ClusterAvailableUpgradeProperties": { + "type": "object", + "description": "Cluster available upgrade properties.", + "properties": { + "upgradeType": { + "description": "Type of upgrade.", + "enum": [ + "AKSPatchUpgrade", + "HotfixUpgrade" + ], + "type": "string", + "x-ms-enum": { + "name": "clusterAvailableUpgradeType", + "modelAsString": true + } + } + }, + "discriminator": "upgradeType", + "required": [ + "upgradeType" + ] + }, + "ClusterAvailableUpgradeAksPatchUpgradeProperties": { + "type": "object", + "description": "Cluster available AKS patch version upgrade.", + "allOf": [ + { + "$ref": "#/definitions/ClusterAvailableUpgradeProperties" + } + ], + "properties": { + "currentVersion": { + "description": "Current node pool version.", + "type": "string" + }, + "currentVersionStatus": { + "description": "Current AKS version's status: whether it is deprecated or supported", + "enum": [ + "Deprecated", + "Supported" + ], + "type": "string", + "x-ms-enum": { + "name": "currentClusterAksVersionStatus", + "modelAsString": true + } + }, + "latestVersion": { + "description": "Latest available version, which should be equal to AKS control plane version if it's not deprecated.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AKSPatchUpgrade" + }, + "ClusterAvailableUpgradeHotfixUpgradeProperties": { + "type": "object", + "description": "Cluster available hotfix version upgrade.", + "allOf": [ + { + "$ref": "#/definitions/ClusterAvailableUpgradeProperties" + } + ], + "properties": { + "description": { + "type": "string", + "description": "Hotfix version upgrade description." + }, + "sourceOssVersion": { + "description": "Source OSS version of current cluster component.", + "type": "string" + }, + "sourceClusterVersion": { + "description": "Source cluster version of current cluster component.", + "type": "string" + }, + "sourceBuildNumber": { + "description": "Source build number of current cluster component.", + "type": "string" + }, + "targetOssVersion": { + "description": "Target OSS version of component to be upgraded.", + "type": "string" + }, + "targetClusterVersion": { + "description": "Target cluster version of component to be upgraded.", + "type": "string" + }, + "targetBuildNumber": { + "description": "Target build number of component to be upgraded.", + "type": "string" + }, + "componentName": { + "description": "Name of component to be upgraded.", + "type": "string" + }, + "severity": { + "description": "Severity of this upgrade.", + "enum": [ + "low", + "medium", + "high", + "critical" + ], + "type": "string", + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "extendedProperties": { + "description": "Extended properties of current available upgrade version", + "type": "string" + }, + "createdTime": { + "description": "Created time of current available upgrade version", + "type": "string", + "format": "date-time" + } + }, + "x-ms-discriminator-value": "HotfixUpgrade" + }, + "ClusterPoolUpgrade": { + "description": "Cluster Pool Upgrade.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/ClusterPoolUpgradeProperties" + } + } + }, + "ClusterPoolUpgradeProperties": { + "description": "Properties of upgrading cluster pool.", + "type": "object", + "properties": { + "upgradeType": { + "description": "Type of upgrade.", + "enum": [ + "AKSPatchUpgrade", + "NodeOsUpgrade" + ], + "type": "string", + "x-ms-enum": { + "name": "clusterPoolUpgradeType", + "modelAsString": true + } + } + }, + "discriminator": "upgradeType", + "required": [ + "upgradeType" + ] + }, + "ClusterPoolAKSPatchVersionUpgradeProperties": { + "description": "Properties of upgrading cluster pool's AKS patch version.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClusterPoolUpgradeProperties" + } + ], + "properties": { + "upgradeClusterPool": { + "description": "whether upgrade cluster pool or not. If it's true, upgradeAllClusterNodes should be false.", + "type": "boolean", + "default": false + }, + "upgradeAllClusterNodes": { + "description": "whether upgrade all clusters' nodes. If it's true, upgradeClusterPool should be false.", + "type": "boolean", + "default": false + }, + "targetAksVersion": { + "description": "Target AKS version. When it's not set, latest version will be used. When upgradeClusterPool is true and upgradeAllClusterNodes is false, target version should be greater or equal to current version. When upgradeClusterPool is false and upgradeAllClusterNodes is true, target version should be equal to AKS version of cluster pool.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AKSPatchUpgrade" + }, + "ClusterPoolNodeOsImageUpdateProperties": { + "description": "Properties of upgrading cluster pool's AKS patch version.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClusterPoolUpgradeProperties" + } + ], + "properties": {}, + "x-ms-discriminator-value": "NodeOsUpgrade" + }, + "ClusterUpgrade": { + "description": "Cluster Upgrade.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/ClusterUpgradeProperties" + } + } + }, + "ClusterUpgradeProperties": { + "description": "Properties of upgrading cluster.", + "type": "object", + "properties": { + "upgradeType": { + "description": "Type of upgrade.", + "enum": [ + "AKSPatchUpgrade", + "HotfixUpgrade" + ], + "type": "string", + "x-ms-enum": { + "name": "clusterUpgradeType", + "modelAsString": true + } + } + }, + "discriminator": "upgradeType", + "required": [ + "upgradeType" + ] + }, + "ClusterAKSPatchVersionUpgradeProperties": { + "description": "Properties of upgrading cluster's AKS patch version.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClusterUpgradeProperties" + } + ], + "properties": {}, + "x-ms-discriminator-value": "AKSPatchUpgrade" + }, + "ClusterHotfixUpgradeProperties": { + "description": "Properties of upgrading cluster's hotfix.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClusterUpgradeProperties" + } + ], + "properties": { + "targetOssVersion": { + "description": "Target OSS version of component to be upgraded.", + "type": "string" + }, + "targetClusterVersion": { + "description": "Target cluster version of component to be upgraded.", + "type": "string" + }, + "targetBuildNumber": { + "description": "Target build number of component to be upgraded.", + "type": "string" + }, + "componentName": { + "description": "Name of component to be upgraded.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HotfixUpgrade" + } + }, + "parameters": { + "ClusterPoolNameParameter": { + "name": "clusterPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster pool.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the HDInsight cluster.", + "x-ms-parameter-location": "method" + }, + "ClusterTypeNameParameter": { + "name": "clusterTypeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the HDInsight on AKS cluster type.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.java.md b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.java.md new file mode 100644 index 000000000000..01cdabebe9ad --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +``` diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md index 40814b24090e..83d80e29a505 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md @@ -30,12 +30,50 @@ description: HDInsight Containers Management Client openapi-type: arm openapi-subtype: rpaas azure-arm: true -tag: package-2023-06-preview +tag: package-preview-2023-11 +``` + +``` yaml +modelerfour: + flatten-models: false ``` ### Suppression +### Tag: package-preview-2023-11 + +These settings apply only when `--tag=package-preview-2023-11` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-11' +input-file: + - preview/2023-11-01-preview/hdinsight.json + +suppressions: + - code: ResourceNameRestriction + reason: Keep compatibility with old API version. + - code: OperationIdNounVerb + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters"].get.operationId + reason: The operation id is valid. + - code: EnumInsteadOfBoolean + - code: TrackedResourcePatchOperation + where: + - $.definitions.Cluster + reason: This is a false positive, and there is ClusterPatch defined for patching cluster. + - code: EnumInsteadOfBoolean + where: + - $.definitions.ClusterAccessProfile.properties.enableInternalIngress + - $.definitions.ClusterPoolNetworkProfile.properties.enablePrivateApiServer + - $.definitions.ClusterRangerPluginProfile.properties.enabled + - $.definitions.RangerUsersyncSpec.properties.enabled + - $.definitions.KafkaProfile.properties.enableKRaft + - $.definitions.KafkaProfile.enablePublicEndpoints + - $.definitions.ClusterPoolAKSPatchVersionUpgradeProperties.upgradeClusterPool + - $.definitions.ClusterPoolAKSPatchVersionUpgradeProperties.upgradeAllClusterNodes + reason: They are used for enabling or disabling a feature. Using a boolean type is more user friendly, and they will be not extended to other values. +``` + ### Tag: package-2023-06-preview These settings apply only when `--tag=package-2023-06-preview` is specified on the command line. diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/CheckNameAvailabilityPost.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/CheckNameAvailabilityPost.json new file mode 100644 index 000000000000..e8845c53178f --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/CheckNameAvailabilityPost.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "checkNameAvailabilityInputs": { + "type": "Microsoft.HealthcareApis/services", + "name": "serviceName" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Service name is not available." + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/OperationResultsGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/OperationResultsGet.json new file mode 100644 index 000000000000..2fc5b3caa41d --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/OperationResultsGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "locationName": "westus", + "operationResultId": "exampleid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.HealthcareApis/locations/westus/operationresults/exampleid", + "name": "servicename", + "status": "Requested", + "startTime": "2019-01-21T06:03:30.2716301Z", + "endTime": "2019-01-21T06:04:12.3413202Z", + "properties": {} + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/OperationsList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/OperationsList.json new file mode 100644 index 000000000000..49db71a584cf --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/OperationsList.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "api-version": "2023-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.HealthcareApis/services/read", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/services/write", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/services/delete", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/locations/operationresults/read", + "display": { + "provider": "Microsoft.HealthcareApis", + "resource": "operationresults", + "operation": "read", + "description": "Get the status of an asynchronous operation" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/read", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/write", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/delete", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/dicomservices/read", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/dicomservices/write", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/dicomservices/delete", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/iotconnectors/read", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/iotconnectors/write", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/iotconnectors/delete", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/fhirservices/read", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/fhirservices/write", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/fhirservices/delete", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/checkNameAvailability/post", + "display": {}, + "origin": "user" + }, + { + "name": "Microsoft.HealthcareApis/Operations/read", + "display": { + "provider": "Microsoft.HealthcareApis", + "resource": "operations", + "operation": "read", + "description": "Get the list of operations supported by this Resource Provider." + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Create.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Create.json new file mode 100644 index 000000000000..b15ca79a137d --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Create.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "dicomServiceName": "blue", + "api-version": "2023-12-01", + "dicomservice": { + "location": "westus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "location": "westus", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "provisioningState": "Succeeded", + "serviceUrl": null, + "eventState": "Disabled", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-mi": {} + } + } + } + }, + "201": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "location": "westus", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "provisioningState": "Creating", + "serviceUrl": null, + "eventState": "Disabled", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-mi": {} + } + } + } + }, + "202": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "location": "westus", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "provisioningState": "Accepted", + "serviceUrl": null, + "eventState": "Disabled", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-mi": {} + } + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Delete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Delete.json new file mode 100644 index 000000000000..d28d366683f7 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "dicomServiceName": "blue", + "api-version": "2023-12-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/westus/operationresults/f7eb8g4f1ncj3jgk6bg8jlqf8?api-version=2023-12-01" + } + }, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Get.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Get.json new file mode 100644 index 000000000000..72ec04d019a6 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Get.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "dicomServiceName": "blue", + "api-version": "2023-12-01" + }, + "responses": { + "200": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "provisioningState": "Succeeded", + "serviceUrl": "https://workspace1-blue.dicom.azurehealthcareapis.com", + "eventState": "Disabled", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + }, + "identity": { + "principalId": "2f1f372f-edcf-43f5-aedb-173da3cc5c1e", + "tenantId": "abfde7b2-df0f-47e6-aabf-2462b07508dc", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_List.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_List.json new file mode 100644 index 000000000000..dd5df6998b87 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_List.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2023-12-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "provisioningState": "Succeeded", + "serviceUrl": "https://workspace1-blue.dicom.azurehealthcareapis.com", + "eventState": "Disabled", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + }, + "identity": { + "principalId": "2f1f372f-edcf-43f5-aedb-173da3cc5c1e", + "tenantId": "abfde7b2-df0f-47e6-aabf-2462b07508dc", + "type": "SystemAssigned" + } + }, + { + "name": "red", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/red", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "provisioningState": "Succeeded", + "serviceUrl": "https://workspace1-red.dicom.azurehealthcareapis.com", + "eventState": "Disabled", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + }, + "identity": { + "principalId": "2f1f372f-edcf-43f5-aedb-173da3cc5c1e", + "tenantId": "abfde7b2-df0f-47e6-aabf-2462b07508dc", + "type": "SystemAssigned" + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Patch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Patch.json new file mode 100644 index 000000000000..39a573e80ba8 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/dicomservices/DicomServices_Patch.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "dicomServiceName": "blue", + "api-version": "2023-12-01", + "dicomservicePatchResource": { + "tags": { + "tagKey": "tagValue" + } + } + }, + "responses": { + "200": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "tags": { + "tagKey": "tagValue" + }, + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "provisioningState": "Succeeded", + "serviceUrl": "https://workspace1-blue.dicom.azurehealthcareapis.com", + "eventState": "Disabled", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + }, + "identity": { + "principalId": "2f1f372f-edcf-43f5-aedb-173da3cc5c1e", + "tenantId": "abfde7b2-df0f-47e6-aabf-2462b07508dc", + "type": "SystemAssigned" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/westus/operationresults/f7eb8g4f1ncj3jgk6bg8jlqf8?api-version=2021-11-01" + }, + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "tags": { + "tagKey": "tagValue" + }, + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "provisioningState": "Succeeded", + "serviceUrl": "https://workspace1-blue.dicom.azurehealthcareapis.com", + "eventState": "Disabled", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + }, + "identity": { + "principalId": "2f1f372f-edcf-43f5-aedb-173da3cc5c1e", + "tenantId": "abfde7b2-df0f-47e6-aabf-2462b07508dc", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Create.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Create.json new file mode 100644 index 000000000000..fff1df23774e --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Create.json @@ -0,0 +1,314 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "fhirServiceName": "fhirservice1", + "api-version": "2023-12-01", + "fhirservice": { + "location": "westus", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "kind": "fhir-R4", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-mi": {} + } + }, + "properties": { + "acrConfiguration": { + "loginServers": [ + "test1.azurecr.io" + ] + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true, + "smartIdentityProviders": [ + { + "authority": "https://login.b2clogin.com/11111111-1111-1111-1111-111111111111/v2.0", + "applications": [ + { + "clientId": "22222222-2222-2222-2222-222222222222", + "audience": "22222222-2222-2222-2222-222222222222", + "allowedDataActions": [ + "Read" + ] + } + ] + } + ] + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "importConfiguration": { + "enabled": false, + "initialImportMode": false, + "integrationDataStore": "existingStorageAccount" + }, + "implementationGuidesConfiguration": { + "usCoreMissingData": false + }, + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "fhirservice1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice1", + "location": "westus", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "kind": "fhir-R4", + "etag": "etagvalue", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true, + "smartIdentityProviders": [ + { + "authority": "https://login.b2clogin.com/11111111-1111-1111-1111-111111111111/v2.0", + "applications": [ + { + "clientId": "22222222-2222-2222-2222-222222222222", + "audience": "22222222-2222-2222-2222-222222222222", + "allowedDataActions": [ + "Read" + ] + } + ] + } + ] + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "importConfiguration": { + "enabled": false, + "initialImportMode": false, + "integrationDataStore": "existingStorageAccount" + }, + "implementationGuidesConfiguration": { + "usCoreMissingData": false + }, + "eventState": "Disabled", + "provisioningState": "Succeeded", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-mi": {} + } + } + } + }, + "201": { + "body": { + "name": "fhirservice1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice1", + "location": "westus", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "kind": "fhir-R4", + "etag": "etagvalue", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true, + "smartIdentityProviders": [ + { + "authority": "https://login.b2clogin.com/11111111-1111-1111-1111-111111111111/v2.0", + "applications": [ + { + "clientId": "22222222-2222-2222-2222-222222222222", + "audience": "22222222-2222-2222-2222-222222222222", + "allowedDataActions": [ + "Read" + ] + } + ] + } + ] + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "importConfiguration": { + "enabled": false, + "initialImportMode": false, + "integrationDataStore": "existingStorageAccount" + }, + "implementationGuidesConfiguration": { + "usCoreMissingData": false + }, + "eventState": "Disabled", + "provisioningState": "Creating", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + } + } + }, + "202": { + "body": { + "name": "fhirservice1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice1", + "location": "westus", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "kind": "fhir-R4", + "etag": "etagvalue", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true, + "smartIdentityProviders": [ + { + "authority": "https://login.b2clogin.com/11111111-1111-1111-1111-111111111111/v2.0", + "applications": [ + { + "clientId": "22222222-2222-2222-2222-222222222222", + "audience": "22222222-2222-2222-2222-222222222222", + "allowedDataActions": [ + "Read" + ] + } + ] + } + ] + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "importConfiguration": { + "enabled": false, + "initialImportMode": false, + "integrationDataStore": "existingStorageAccount" + }, + "implementationGuidesConfiguration": { + "usCoreMissingData": false + }, + "eventState": "Disabled", + "provisioningState": "Accepted", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-mi": {} + } + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Delete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Delete.json new file mode 100644 index 000000000000..3b05f2990cda --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "fhirServiceName": "fhirservice1", + "api-version": "2023-12-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/westus/operationresults/f7eb8g4f1ncj3jgk6bg8jlqf8?api-version=2023-12-01" + } + }, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Get.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Get.json new file mode 100644 index 000000000000..52dccd481229 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Get.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "fhirServiceName": "fhirservices1", + "api-version": "2023-12-01" + }, + "responses": { + "200": { + "body": { + "name": "fhirservices1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservices1", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true, + "smartIdentityProviders": [ + { + "authority": "https://login.b2clogin.com/11111111-1111-1111-1111-111111111111/v2.0", + "applications": [ + { + "clientId": "22222222-2222-2222-2222-222222222222", + "audience": "22222222-2222-2222-2222-222222222222", + "allowedDataActions": [ + "Read" + ] + } + ] + } + ] + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "importConfiguration": { + "enabled": false, + "initialImportMode": false, + "integrationDataStore": "existingStorageAccount" + }, + "implementationGuidesConfiguration": { + "usCoreMissingData": false + }, + "provisioningState": "Creating", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyUrl": "https://mykeyvault.vault.azure.net/keys/myEncryptionKey/myKeyVersion" + } + } + }, + "identity": { + "principalId": "2f1f372f-edcf-43f5-aedb-173da3cc5c1e", + "tenantId": "abfde7b2-df0f-47e6-aabf-2462b07508dc", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_List.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_List.json new file mode 100644 index 000000000000..8d6811e497d2 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2023-12-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "fhirservice1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice1", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "properties": { + "provisioningState": "Creating" + } + }, + { + "name": "fhirservice2", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice2", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "properties": { + "provisioningState": "Creating" + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Patch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Patch.json new file mode 100644 index 000000000000..899c7828431a --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/fhirservices/FhirServices_Patch.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "fhirServiceName": "fhirservice1", + "api-version": "2023-12-01", + "fhirservicePatchResource": { + "tags": { + "tagKey": "tagValue" + } + } + }, + "responses": { + "200": { + "body": { + "name": "fhirservice1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice1", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "tags": { + "tagKey": "tagValue" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/westus/operationresults/f7eb8g4f1ncj3jgk6bg8jlqf8?api-version=2023-12-01" + }, + "body": { + "name": "fhirservice1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice1", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "tags": { + "tagKey": "tagValue" + }, + "properties": { + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Create.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Create.json new file mode 100644 index 000000000000..463d3e26d435 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Create.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "api-version": "2023-12-01", + "iotConnector": { + "location": "westus", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + }, + "201": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Creating", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + }, + "202": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Accepted", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Delete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Delete.json new file mode 100644 index 000000000000..3b9ca766cc0c --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "api-version": "2023-12-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/westus/operationresults/f7eb8g4f1ncj3jgk6bg8jlqf8?api-version=2023-12-01" + } + }, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Get.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Get.json new file mode 100644 index 000000000000..eef777c75ec1 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "api-version": "2023-12-01" + }, + "responses": { + "200": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Creating", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_List.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_List.json new file mode 100644 index 000000000000..7903da2b39f8 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_List.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2023-12-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Creating", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + }, + { + "name": "red", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/red", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f6ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Suceeded", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "steps", + "typeMatchExpression": "$..[?(@steps)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.steps", + "valueName": "steps" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-27T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-27T19:26:24.072Z" + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Patch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Patch.json new file mode 100644 index 000000000000..fe0d1687a9c4 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_Patch.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "api-version": "2023-12-01", + "iotConnectorPatchResource": { + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/westus/operationresults/f7eb8g4f1ncj3jgk6bg8jlqf8?api-version=2023-12-01" + }, + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Accepted", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_Create.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_Create.json new file mode 100644 index 000000000000..adbecc3b49c3 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_Create.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "fhirDestinationName": "dest1", + "api-version": "2023-12-01", + "iotFhirDestination": { + "location": "westus", + "properties": { + "resourceIdentityResolutionType": "Create", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "dest1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations", + "location": "West US 2", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "properties": { + "provisioningState": "Succeeded", + "resourceIdentityResolutionType": "Create", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + }, + "201": { + "body": { + "name": "dest1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations", + "location": "West US 2", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "properties": { + "provisioningState": "Creating", + "resourceIdentityResolutionType": "Create", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + }, + "202": { + "body": { + "name": "dest1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations", + "location": "West US 2", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "properties": { + "provisioningState": "Accepted", + "resourceIdentityResolutionType": "Create", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_Delete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_Delete.json new file mode 100644 index 000000000000..0fdfc721f6ea --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "fhirDestinationName": "dest1", + "api-version": "2023-12-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/westus/operationresults/f7eb8g4f1ncj3jgk6bg8jlqf8?api-version=2023-12-01" + } + }, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_Get.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_Get.json new file mode 100644 index 000000000000..177fe5f3b2ea --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "fhirDestinationName": "dest1", + "api-version": "2023-12-01" + }, + "responses": { + "200": { + "body": { + "name": "dest1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "properties": { + "provisioningState": "Suceeded", + "resourceIdentityResolutionType": "Create", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_List.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_List.json new file mode 100644 index 000000000000..547e8cd2debe --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/iotconnectors/iotconnector_fhirdestination_List.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "api-version": "2023-12-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "dest1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "properties": { + "provisioningState": "Succeeded", + "resourceIdentityResolutionType": "Create", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + }, + { + "name": "dest2", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest2", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations", + "location": "westus", + "etag": "00000000-0000-0000-f6ac-912ca49e01d6", + "properties": { + "provisioningState": "Suceeded", + "resourceIdentityResolutionType": "Lookup", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-27T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-27T19:26:24.072Z" + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/PrivateLinkResourceGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/PrivateLinkResourceGet.json new file mode 100644 index 000000000000..fedfd451bf75 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/PrivateLinkResourceGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "rgname", + "resourceName": "service1", + "groupName": "fhir" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1/privateLinkResources/fhir", + "name": "fhir", + "type": "Microsoft.HealthcareApis/services/privateLinkResources", + "properties": { + "groupId": "fhir", + "requiredMembers": [ + "fhir" + ], + "requiredZoneNames": [ + "privatelink.azurehealthcareapis.com" + ] + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/PrivateLinkResourcesListByService.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/PrivateLinkResourcesListByService.json new file mode 100644 index 000000000000..d410c9bbdf90 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/PrivateLinkResourcesListByService.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "rgname", + "resourceName": "service1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1/privateLinkResources/fhir", + "name": "fhir", + "type": "Microsoft.HealthcareApis/services/privateLinkResources", + "properties": { + "groupId": "fhir", + "requiredMembers": [ + "fhir" + ], + "requiredZoneNames": [ + "privatelink.azurehealthcareapis.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreate.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreate.json new file mode 100644 index 000000000000..cfb849278f27 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreate.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2023-12-01", + "subscriptionId": "subid", + "serviceDescription": { + "location": "westus2", + "tags": {}, + "kind": "fhir-R4", + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US 2", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "identity": { + "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e", + "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US 2", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000 + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "identity": { + "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e", + "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreateInDataSovereignRegionWithCmkEnabled.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreateInDataSovereignRegionWithCmkEnabled.json new file mode 100644 index 000000000000..06de863b474d --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreateInDataSovereignRegionWithCmkEnabled.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2023-12-01", + "subscriptionId": "subid", + "serviceDescription": { + "location": "Southeast Asia", + "tags": {}, + "kind": "fhir-R4", + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key", + "crossTenantCmkApplicationId": "de3fbeef-8c3a-428e-8b9f-4d229c8a85f4" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US 2", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key", + "crossTenantCmkApplicationId": "de3fbeef-8c3a-428e-8b9f-4d229c8a85f4" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "identity": { + "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e", + "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US 2", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000 + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "identity": { + "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e", + "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreateMinimum.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreateMinimum.json new file mode 100644 index 000000000000..b20c236dbdd2 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreateMinimum.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "resourceName": "service2", + "resourceGroupName": "rg1", + "api-version": "2023-12-01", + "subscriptionId": "subid", + "serviceDescription": { + "location": "westus2", + "tags": {}, + "kind": "fhir-R4", + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2", + "name": "service2", + "type": "Microsoft.HealthcareApis/services", + "etag": "etagvalue", + "location": "westus2", + "kind": "fhir-R4", + "tags": {}, + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000 + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": false + }, + "corsConfiguration": { + "origins": [], + "headers": [], + "methods": [], + "maxAge": null, + "allowCredentials": false + }, + "provisioningState": "Creating", + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2", + "name": "service2", + "type": "Microsoft.HealthcareApis/services", + "etag": "etagvalue", + "location": "westus2", + "kind": "fhir-R4", + "tags": {}, + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": null + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": false + }, + "corsConfiguration": { + "origins": [], + "headers": [], + "methods": [], + "maxAge": null, + "allowCredentials": false + }, + "provisioningState": "Creating", + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreatePrivateEndpointConnection.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreatePrivateEndpointConnection.json new file mode 100644 index 000000000000..f3f7c0b3106a --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceCreatePrivateEndpointConnection.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "rgname", + "resourceName": "service1", + "privateEndpointConnectionName": "myConnection", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.HealthcareApis/services/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceDelete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceDelete.json new file mode 100644 index 000000000000..a229952801fc --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2023-12-01", + "subscriptionId": "subid" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/westus/operationresults/f7eb8g4f1ncj3jgk6bg8jlqf8?api-version=2023-12-01" + } + }, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceDeletePrivateEndpointConnection.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..863ab5e0ab58 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceDeletePrivateEndpointConnection.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "rgname", + "resourceName": "service1", + "privateEndpointConnectionName": "myConnection" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/westus/operationresults/f7eb8g4f1ncj3jgk6bg8jlqf8?api-version=2023-12-01" + } + }, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceGet.json new file mode 100644 index 000000000000..e29082504d77 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2023-12-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceGetInDataSovereignRegionWithCmkEnabled.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceGetInDataSovereignRegionWithCmkEnabled.json new file mode 100644 index 000000000000..6500da0b9a40 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceGetInDataSovereignRegionWithCmkEnabled.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2023-12-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "Southeast Asia", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key", + "crossTenantCmkApplicationId": null + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceGetPrivateEndpointConnection.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..9b69aae08d27 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceGetPrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "rgname", + "resourceName": "service1", + "privateEndpointConnectionName": "myConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.HealthcareApis/services/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceList.json new file mode 100644 index 000000000000..8c815e18cde7 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceList.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etag", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + ], + "nextLink": "https://host/subscriptions/subid/providers/Microsoft.HealthcareApis/services?api-version=2018-08-20-preview&%24skipToken=e30%3d" + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceListByResourceGroup.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceListByResourceGroup.json new file mode 100644 index 000000000000..972e6c495bac --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceListByResourceGroup.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "rgname" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/dddb8dcb-effb-4290-bb47-ce1e8440c729", + "name": "service1", + "location": "westus", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "tags": {}, + "etag": "etagvalue", + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + ], + "nextLink": "https://host/subscriptions/subid/resourceGroups/rgname/providers/Microsoft.HealthcareApis/services?api-version=2018-08-20-preview&%24skipToken=e30%3d" + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceListPrivateEndpointConnections.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceListPrivateEndpointConnections.json new file mode 100644 index 000000000000..dcfc4d4eb7f4 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServiceListPrivateEndpointConnections.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "rgname", + "resourceName": "service1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.HealthcareApis/services/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServicePatch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServicePatch.json new file mode 100644 index 000000000000..c140087e606c --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/legacy/ServicePatch.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2023-12-01", + "subscriptionId": "subid", + "servicePatchDescription": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/PrivateLinkResourcesListByWorkspace.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/PrivateLinkResourcesListByWorkspace.json new file mode 100644 index 000000000000..bb70060a7ca7 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/PrivateLinkResourcesListByWorkspace.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/workspaces/workspace1/privateLinkResources/healthcareworkspace", + "name": "healthcareworkspace", + "type": "Microsoft.HealthcareApis/workspaces/privateLinkResources", + "properties": { + "groupId": "healthcareworkspace", + "requiredMembers": [ + "fhirservices", + "dicomservices" + ], + "requiredZoneNames": [ + "privatelink.fhir.azurehealthcareapis.com", + "privatelink.dicom.azurehealthcareapis.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceCreatePrivateEndpointConnection.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceCreatePrivateEndpointConnection.json new file mode 100644 index 000000000000..d89200aca5e8 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceCreatePrivateEndpointConnection.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "myConnection", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/workspaces/workspace1/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.HealthcareApis/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceDeletePrivateEndpointConnection.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..69a218507905 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceDeletePrivateEndpointConnection.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "myConnection" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/westus/operationresults/f7eb8g4f1ncj3jgk6bg8jlqf8?api-version=2023-12-01" + } + }, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceGetPrivateEndpointConnection.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..861e4685529d --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceGetPrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "myConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/workspaces/workspace1/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.HealthcareApis/workspaces/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceListPrivateEndpointConnections.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceListPrivateEndpointConnections.json new file mode 100644 index 000000000000..6ce504d4d3ed --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspaceListPrivateEndpointConnections.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/workspaces/workspace1/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.HealthcareApis/workspaces/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspacePrivateLinkResourceGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspacePrivateLinkResourceGet.json new file mode 100644 index 000000000000..51bd78ee88f2 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/privatelink/WorkspacePrivateLinkResourceGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-12-01", + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "groupName": "healthcareworkspace" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/workspaces/workspace1/privateLinkResources/fhir", + "name": "fhir", + "type": "Microsoft.HealthcareApis/workspaces/privateLinkResources", + "properties": { + "groupId": "healthcareworkspace", + "requiredMembers": [ + "fhirservices", + "dicomservices" + ], + "requiredZoneNames": [ + "privatelink.fhir.azurehealthcareapis.com", + "privatelink.dicom.azurehealthcareapis.com" + ] + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Create.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Create.json new file mode 100644 index 000000000000..6179ca85f47c --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Create.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2023-12-01", + "workspace": { + "location": "westus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "westus", + "properties": { + "provisioningState": "Creating" + } + } + }, + "202": { + "body": { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "westus", + "properties": { + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Delete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Delete.json new file mode 100644 index 000000000000..5d749860fe32 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2023-12-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/westus/operationresults/f7eb8g4f1ncj3jgk6bg8jlqf8?api-version=2023-12-01" + } + }, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Get.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Get.json new file mode 100644 index 000000000000..8d53b3eb6b1d --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2023-12-01" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "westus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_ListByResourceGroup.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_ListByResourceGroup.json new file mode 100644 index 000000000000..4fd33be64ae5 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_ListByResourceGroup.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "api-version": "2023-12-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_ListBySubscription.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_ListBySubscription.json new file mode 100644 index 000000000000..276030e37430 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_ListBySubscription.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2023-12-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Patch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Patch.json new file mode 100644 index 000000000000..a184f31b047c --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/examples/workspaces/Workspaces_Patch.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2023-12-01", + "workspacePatchResource": { + "tags": { + "tagKey": "tagValue" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "westus", + "tags": { + "tagKey": "tagValue" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/westus/operationresults/f7eb8g4f1ncj3jgk6bg8jlqf8?api-version=2023-12-01" + }, + "body": { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "westus", + "tags": { + "tagKey": "tagValue" + }, + "properties": { + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/healthcare-apis.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/healthcare-apis.json new file mode 100644 index 000000000000..7fa220d75299 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-12-01/healthcare-apis.json @@ -0,0 +1,4276 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-12-01", + "title": "HealthcareApisClient", + "description": "Use this API to manage Microsoft HealthcareApis services in your Azure subscription." + }, + "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.HealthcareApis/services/{resourceName}": { + "get": { + "tags": [ + "Resource" + ], + "description": "Get the metadata of a service instance.", + "operationId": "Services_Get", + "x-ms-examples": { + "Get metadata": { + "$ref": "./examples/legacy/ServiceGet.json" + }, + "Get metadata for CMK enabled service in data sovereign region": { + "$ref": "./examples/legacy/ServiceGetInDataSovereignRegionWithCmkEnabled.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all of the properties of the service instance.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "Resource" + ], + "description": "Create or update the metadata of a service instance.", + "operationId": "Services_CreateOrUpdate", + "x-ms-examples": { + "Create or Update a service with all parameters": { + "$ref": "./examples/legacy/ServiceCreate.json" + }, + "Create or Update a service with minimum parameters": { + "$ref": "./examples/legacy/ServiceCreateMinimum.json" + }, + "Create or Update a service with all parameters and CMK enabled in a data sovereign region": { + "$ref": "./examples/legacy/ServiceCreateInDataSovereignRegionWithCmkEnabled.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "serviceDescription", + "in": "body", + "description": "The service instance metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is being updated; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "201": { + "description": "Created - Put request accepted and a new resource was created; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "patch": { + "tags": [ + "Resource" + ], + "description": "Update the metadata of a service instance.", + "operationId": "Services_Update", + "x-ms-examples": { + "Patch service": { + "$ref": "./examples/legacy/ServicePatch.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "servicePatchDescription", + "in": "body", + "description": "The service instance metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/ServicesPatchDescription" + } + } + ], + "responses": { + "200": { + "description": "The tags for the resource were updated successfully.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "Resource" + ], + "description": "Delete a service instance.", + "operationId": "Services_Delete", + "x-ms-examples": { + "Delete service": { + "$ref": "./examples/legacy/ServiceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "202": { + "description": "Accepted - Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services": { + "get": { + "tags": [ + "Collection" + ], + "description": "Get all the service instances in a subscription.", + "operationId": "Services_List", + "x-ms-examples": { + "List all services in subscription": { + "$ref": "./examples/legacy/ServiceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the subscription.", + "schema": { + "$ref": "#/definitions/ServicesDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services": { + "get": { + "tags": [ + "Collection" + ], + "description": "Get all the service instances in a resource group.", + "operationId": "Services_ListByResourceGroup", + "x-ms-examples": { + "List all services in resource group": { + "$ref": "./examples/legacy/ServiceListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the resource group.", + "schema": { + "$ref": "#/definitions/ServicesDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/checkNameAvailability": { + "post": { + "tags": [ + "Proxy" + ], + "description": "Check if a service instance name is available.", + "operationId": "Services_CheckNameAvailability", + "x-ms-examples": { + "Check name availability": { + "$ref": "./examples/CheckNameAvailabilityPost.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "checkNameAvailabilityInputs", + "in": "body", + "description": "Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the service name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/ServicesNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_ListByService", + "description": "Lists all private endpoint connections for a service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnection_List": { + "$ref": "./examples/legacy/ServiceListPrivateEndpointConnections.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnection_GetConnection": { + "$ref": "./examples/legacy/ServiceGetPrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "description": "Update the state of the specified private endpoint connection associated with the service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnection_CreateOrUpdate": { + "$ref": "./examples/legacy/ServiceCreatePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "No Content - The private endpoint connection does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete": { + "$ref": "./examples/legacy/ServiceDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByService", + "description": "Gets the private link resources that need to be created for a service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResultDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListGroupIds": { + "$ref": "./examples/legacy/PrivateLinkResourcesListByService.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_Get", + "description": "Gets a private link resource that need to be created for a service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_Get": { + "$ref": "./examples/legacy/PrivateLinkResourceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available workspaces under the specified subscription.", + "operationId": "Workspaces_ListBySubscription", + "x-ms-examples": { + "Get workspaces by subscription": { + "$ref": "./examples/workspaces/Workspaces_ListBySubscription.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": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the workspaces in the subscription.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available workspaces under the specified resource group.", + "operationId": "Workspaces_ListByResourceGroup", + "x-ms-examples": { + "Get workspaces by resource group": { + "$ref": "./examples/workspaces/Workspaces_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the workspaces in the resource group.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Gets the properties of the specified workspace.", + "operationId": "Workspaces_Get", + "x-ms-examples": { + "Get workspace": { + "$ref": "./examples/workspaces/Workspaces_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "Workspaces" + ], + "description": "Creates or updates a workspace resource with the specified parameters.", + "operationId": "Workspaces_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a workspace": { + "$ref": "./examples/workspaces/Workspaces_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "name": "workspace", + "description": "The parameters for creating or updating a healthcare workspace.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Created - Put request accepted and an existing resource is being created asynchronously.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted - Put request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "description": "Patch workspace details.", + "operationId": "Workspaces_Update", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a workspace": { + "$ref": "./examples/workspaces/Workspaces_Patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "name": "workspacePatchResource", + "description": "The parameters for updating a specified workspace.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspacePatchResource" + } + } + ], + "responses": { + "200": { + "description": "Updated - Patch request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted - Patch request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "description": "Deletes a specified workspace.", + "operationId": "Workspaces_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a workspace": { + "$ref": "./examples/workspaces/Workspaces_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "Resource deleted." + }, + "202": { + "description": "Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices": { + "get": { + "tags": [ + "DicomServices" + ], + "description": "Lists all DICOM Services for the given workspace", + "operationId": "DicomServices_ListByWorkspace", + "x-ms-examples": { + "List dicomservices": { + "$ref": "./examples/dicomservices/DicomServices_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "List of DICOM Services.", + "schema": { + "$ref": "#/definitions/DicomServiceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}": { + "get": { + "tags": [ + "DicomServices" + ], + "description": "Gets the properties of the specified DICOM Service.", + "operationId": "DicomServices_Get", + "x-ms-examples": { + "Get a dicomservice": { + "$ref": "./examples/dicomservices/DicomServices_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/dicomServiceName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/DicomService" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "DicomServices" + ], + "description": "Creates or updates a DICOM Service resource with the specified parameters.", + "operationId": "DicomServices_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a Dicom Service": { + "$ref": "./examples/dicomservices/DicomServices_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/dicomServiceName" + }, + { + "name": "dicomservice", + "description": "The parameters for creating or updating a Dicom Service resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DicomService" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/DicomService" + } + }, + "201": { + "description": "Created - Put request accepted and an existing resource is being created asynchronously.", + "schema": { + "$ref": "#/definitions/DicomService" + } + }, + "202": { + "description": "Accepted - Put request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/DicomService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "patch": { + "tags": [ + "DicomServices" + ], + "description": "Patch DICOM Service details.", + "operationId": "DicomServices_Update", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a dicomservice": { + "$ref": "./examples/dicomservices/DicomServices_Patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/dicomServiceName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "name": "dicomservicePatchResource", + "description": "The parameters for updating a Dicom Service.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DicomServicePatchResource" + } + } + ], + "responses": { + "200": { + "description": "Updated - Patch request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/DicomService" + } + }, + "202": { + "description": "Accepted - Patch request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/DicomService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "DicomServices" + ], + "description": "Deletes a DICOM Service.", + "operationId": "DicomServices_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a dicomservice": { + "$ref": "./examples/dicomservices/DicomServices_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dicomServiceName" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "Resource deleted." + }, + "202": { + "description": "Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors": { + "get": { + "tags": [ + "IotConnectors" + ], + "description": "Lists all IoT Connectors for the given workspace", + "operationId": "IotConnectors_ListByWorkspace", + "x-ms-examples": { + "List iotconnectors": { + "$ref": "./examples/iotconnectors/iotconnector_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "List of IoT Connectors.", + "schema": { + "$ref": "#/definitions/IotConnectorCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}": { + "get": { + "tags": [ + "IotConnectors" + ], + "description": "Gets the properties of the specified IoT Connector.", + "operationId": "IotConnectors_Get", + "x-ms-examples": { + "Get an IoT Connector": { + "$ref": "./examples/iotconnectors/iotconnector_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/iotConnectorName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/IotConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "IotConnectors" + ], + "description": "Creates or updates an IoT Connector resource with the specified parameters.", + "operationId": "IotConnectors_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create an IoT Connector": { + "$ref": "./examples/iotconnectors/iotconnector_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/iotConnectorName" + }, + { + "name": "iotConnector", + "description": "The parameters for creating or updating an IoT Connectors resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IotConnector" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/IotConnector" + } + }, + "201": { + "description": "Created - Put request accepted and an existing resource is being created asynchronously.", + "schema": { + "$ref": "#/definitions/IotConnector" + } + }, + "202": { + "description": "Accepted - Put request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/IotConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "patch": { + "tags": [ + "IotConnectors" + ], + "description": "Patch an IoT Connector.", + "operationId": "IotConnectors_Update", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch an IoT Connector": { + "$ref": "./examples/iotconnectors/iotconnector_Patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/iotConnectorName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "name": "iotConnectorPatchResource", + "description": "The parameters for updating an IoT Connector.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IotConnectorPatchResource" + } + } + ], + "responses": { + "200": { + "description": "Updated - Patch request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/IotConnector" + } + }, + "202": { + "description": "Accepted - Patch request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/IotConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "IotConnectors" + ], + "description": "Deletes an IoT Connector.", + "operationId": "IotConnectors_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete an IoT Connector": { + "$ref": "./examples/iotconnectors/iotconnector_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/iotConnectorName" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "Resource deleted." + }, + "202": { + "description": "Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations": { + "get": { + "tags": [ + "IotConnectors" + ], + "description": "Lists all FHIR destinations for the given IoT Connector", + "operationId": "FhirDestinations_ListByIotConnector", + "x-ms-examples": { + "List IoT Connectors": { + "$ref": "./examples/iotconnectors/iotconnector_fhirdestination_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/iotConnectorName" + } + ], + "responses": { + "200": { + "description": "List of IoT Connector FHIR destinations.", + "schema": { + "$ref": "#/definitions/IotFhirDestinationCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}": { + "get": { + "tags": [ + "IotConnectors" + ], + "description": "Gets the properties of the specified Iot Connector FHIR destination.", + "operationId": "IotConnectorFhirDestination_Get", + "x-ms-examples": { + "Get an IoT Connector destination": { + "$ref": "./examples/iotconnectors/iotconnector_fhirdestination_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/iotConnectorName" + }, + { + "$ref": "#/parameters/fhirDestinationName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/IotFhirDestination" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "IotConnectors" + ], + "description": "Creates or updates an IoT Connector FHIR destination resource with the specified parameters.", + "operationId": "IotConnectorFhirDestination_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update an Iot Connector FHIR destination": { + "$ref": "./examples/iotconnectors/iotconnector_fhirdestination_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/iotConnectorName" + }, + { + "$ref": "#/parameters/fhirDestinationName" + }, + { + "name": "iotFhirDestination", + "description": "The parameters for creating or updating an IoT Connector FHIR destination resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IotFhirDestination" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/IotFhirDestination" + } + }, + "201": { + "description": "Created - Put request accepted and an existing resource is being created asynchronously.", + "schema": { + "$ref": "#/definitions/IotFhirDestination" + } + }, + "202": { + "description": "Accepted - Put request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/IotFhirDestination" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "IotConnectors" + ], + "description": "Deletes an IoT Connector FHIR destination.", + "operationId": "IotConnectorFhirDestination_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete an IoT Connector destination": { + "$ref": "./examples/iotconnectors/iotconnector_fhirdestination_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/iotConnectorName" + }, + { + "$ref": "#/parameters/fhirDestinationName" + } + ], + "responses": { + "200": { + "description": "Resource deleted." + }, + "202": { + "description": "Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices": { + "get": { + "tags": [ + "FhirServices" + ], + "description": "Lists all FHIR Services for the given workspace", + "operationId": "FhirServices_ListByWorkspace", + "x-ms-examples": { + "List fhirservices": { + "$ref": "./examples/fhirservices/FhirServices_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "List of FHIR Services.", + "schema": { + "$ref": "#/definitions/FhirServiceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}": { + "get": { + "tags": [ + "FhirServices" + ], + "description": "Gets the properties of the specified FHIR Service.", + "operationId": "FhirServices_Get", + "x-ms-examples": { + "Get a Fhir Service": { + "$ref": "./examples/fhirservices/FhirServices_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/fhirServiceName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/FhirService" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "FhirServices" + ], + "description": "Creates or updates a FHIR Service resource with the specified parameters.", + "operationId": "FhirServices_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a Fhir Service": { + "$ref": "./examples/fhirservices/FhirServices_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/fhirServiceName" + }, + { + "name": "fhirservice", + "description": "The parameters for creating or updating a Fhir Service resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FhirService" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/FhirService" + } + }, + "201": { + "description": "Created - Put request accepted and an existing resource is being created asynchronously.", + "schema": { + "$ref": "#/definitions/FhirService" + } + }, + "202": { + "description": "Accepted - Put request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/FhirService" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "patch": { + "tags": [ + "FhirServices" + ], + "description": "Patch FHIR Service details.", + "operationId": "FhirServices_Update", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a Fhir Service": { + "$ref": "./examples/fhirservices/FhirServices_Patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/fhirServiceName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "name": "fhirservicePatchResource", + "description": "The parameters for updating a Fhir Service.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FhirServicePatchResource" + } + } + ], + "responses": { + "200": { + "description": "Updated - Patch request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/FhirService" + } + }, + "202": { + "description": "Accepted - Patch request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/FhirService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "FhirServices" + ], + "description": "Deletes a FHIR Service.", + "operationId": "FhirServices_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a Fhir Service": { + "$ref": "./examples/fhirservices/FhirServices_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/fhirServiceName" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "Resource deleted." + }, + "202": { + "description": "Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "WorkspacePrivateEndpointConnections_ListByWorkspace", + "description": "Lists all private endpoint connections for a workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "WorkspacePrivateEndpointConnection_List": { + "$ref": "./examples/privatelink/WorkspaceListPrivateEndpointConnections.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "WorkspacePrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "WorkspacePrivateEndpointConnection_GetConnection": { + "$ref": "./examples/privatelink/WorkspaceGetPrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "WorkspacePrivateEndpointConnections_CreateOrUpdate", + "description": "Update the state of the specified private endpoint connection associated with the workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionDescription" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "WorkspacePrivateEndpointConnection_CreateOrUpdate": { + "$ref": "./examples/privatelink/WorkspaceCreatePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection.", + "operationId": "WorkspacePrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "No Content - The private endpoint connection does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "WorkspacePrivateEndpointConnections_Delete": { + "$ref": "./examples/privatelink/WorkspaceDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "WorkspacePrivateLinkResources" + ], + "operationId": "WorkspacePrivateLinkResources_ListByWorkspace", + "description": "Gets the private link resources that need to be created for a workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResultDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "WorkspacePrivateLinkResources_ListGroupIds": { + "$ref": "./examples/privatelink/PrivateLinkResourcesListByWorkspace.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "WorkspacePrivateLinkResources" + ], + "operationId": "WorkspacePrivateLinkResources_Get", + "description": "Gets a private link resource that need to be created for a workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "WorkspacePrivateLinkResources_Get": { + "$ref": "./examples/privatelink/WorkspacePrivateLinkResourceGet.json" + } + } + } + }, + "/providers/Microsoft.HealthcareApis/operations": { + "get": { + "tags": [ + "Proxy" + ], + "description": "Lists all of the available operations supported by Microsoft Healthcare resource provider.", + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/OperationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListOperations" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/{locationName}/operationresults/{operationResultId}": { + "get": { + "tags": [ + "Proxy" + ], + "description": "Get the operation result for a long running operation.", + "operationId": "OperationResults_Get", + "x-ms-examples": { + "Get operation result": { + "$ref": "./examples/OperationResultsGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationName" + }, + { + "$ref": "#/parameters/operationResultId" + } + ], + "responses": { + "200": { + "description": "The body contains all of the properties of the operation result.", + "schema": { + "$ref": "#/definitions/OperationResultsDescription" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + } + }, + "definitions": { + "ServicesProperties": { + "description": "The properties of a service instance.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "$ref": "#/definitions/ProvisioningState" + }, + "accessPolicies": { + "$ref": "#/definitions/ServiceAccessPoliciesInfo", + "description": "The access policies of the service instance." + }, + "cosmosDbConfiguration": { + "$ref": "#/definitions/ServiceCosmosDbConfigurationInfo", + "description": "The settings for the Cosmos DB database backing the service." + }, + "authenticationConfiguration": { + "$ref": "#/definitions/ServiceAuthenticationConfigurationInfo", + "description": "The authentication configuration for the service instance." + }, + "corsConfiguration": { + "$ref": "#/definitions/ServiceCorsConfigurationInfo", + "description": "The settings for the CORS configuration of the service instance." + }, + "exportConfiguration": { + "$ref": "#/definitions/ServiceExportConfigurationInfo", + "description": "The settings for the export operation of the service instance." + }, + "privateEndpointConnections": { + "description": "The list of private endpoint connections that are set up for this resource.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "publicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "acrConfiguration": { + "$ref": "#/definitions/ServiceAcrConfigurationInfo", + "description": "The azure container registry settings used for convert data operation of the service instance." + }, + "importConfiguration": { + "$ref": "#/definitions/ServiceImportConfigurationInfo", + "description": "The settings for the import operation of the service instance." + } + } + }, + "ServiceAccessPoliciesInfo": { + "description": "The access policies of the service instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceAccessPolicyEntry" + }, + "x-ms-identifiers": [ + "objectId" + ] + }, + "ServiceAccessPolicyEntry": { + "description": "An access policy entry.", + "properties": { + "objectId": { + "description": "An Azure AD object ID (User or Apps) that is allowed access to the FHIR service.", + "type": "string", + "pattern": "^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$" + } + }, + "required": [ + "objectId" + ] + }, + "ServiceCosmosDbConfigurationInfo": { + "description": "The settings for the Cosmos DB database backing the service.", + "type": "object", + "properties": { + "offerThroughput": { + "type": "integer", + "description": "The provisioned throughput for the backing database.", + "readOnly": false, + "minimum": 400 + }, + "keyVaultKeyUri": { + "type": "string", + "description": "The URI of the customer-managed key for the backing database.", + "readOnly": false + }, + "crossTenantCmkApplicationId": { + "type": "string", + "pattern": "^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$", + "description": "The multi-tenant application id used to enable CMK access for services in a data sovereign region.", + "readOnly": false + } + } + }, + "ServiceAuthenticationConfigurationInfo": { + "description": "Authentication configuration information", + "type": "object", + "properties": { + "authority": { + "type": "string", + "description": "The authority url for the service", + "readOnly": false + }, + "audience": { + "type": "string", + "description": "The audience url for the service", + "readOnly": false + }, + "smartProxyEnabled": { + "type": "boolean", + "description": "If the SMART on FHIR proxy is enabled", + "readOnly": false + } + } + }, + "ServiceCorsConfigurationInfo": { + "description": "The settings for the CORS configuration of the service instance.", + "type": "object", + "properties": { + "origins": { + "type": "array", + "description": "The origins to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/ServiceCorsConfigurationOriginEntry" + } + }, + "headers": { + "type": "array", + "description": "The headers to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/ServiceCorsConfigurationHeaderEntry" + } + }, + "methods": { + "type": "array", + "description": "The methods to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/ServiceCorsConfigurationMethodEntry" + } + }, + "maxAge": { + "type": "integer", + "description": "The max age to be allowed via CORS.", + "readOnly": false, + "minimum": 0, + "maximum": 99999 + }, + "allowCredentials": { + "type": "boolean", + "description": "If credentials are allowed via CORS.", + "readOnly": false + } + } + }, + "ServiceExportConfigurationInfo": { + "description": "Export operation configuration information", + "type": "object", + "properties": { + "storageAccountName": { + "type": "string", + "description": "The name of the default export storage account.", + "readOnly": false + } + } + }, + "ServiceImportConfigurationInfo": { + "description": "Import operation configuration information", + "type": "object", + "properties": { + "integrationDataStore": { + "type": "string", + "description": "The name of the default integration storage account.", + "readOnly": false + }, + "initialImportMode": { + "type": "boolean", + "description": "If the FHIR service is in InitialImportMode.", + "readOnly": false + }, + "enabled": { + "type": "boolean", + "description": "If the import operation is enabled.", + "readOnly": false + } + } + }, + "ServiceAcrConfigurationInfo": { + "description": "Azure container registry configuration information", + "type": "object", + "properties": { + "loginServers": { + "type": "array", + "description": "The list of the ACR login servers.", + "readOnly": false, + "items": { + "type": "string" + } + }, + "ociArtifacts": { + "type": "array", + "description": "The list of Open Container Initiative (OCI) artifacts.", + "readOnly": false, + "items": { + "$ref": "#/definitions/ServiceOciArtifactEntry" + }, + "x-ms-identifiers": [] + } + } + }, + "ServiceCorsConfigurationOriginEntry": { + "description": "An origin for CORS.", + "type": "string", + "pattern": "^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\\:\\/\\/(?:[a-zA-Z0-9-]+[.]?)+(?:\\:[0-9]{1,5})?|[*]))$" + }, + "ServiceCorsConfigurationHeaderEntry": { + "description": "A header for CORS.", + "type": "string" + }, + "ServiceCorsConfigurationMethodEntry": { + "description": "A method for CORS.", + "type": "string" + }, + "ServicesDescription": { + "description": "The description of the service.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "description": "The common properties of a service.", + "$ref": "#/definitions/ServicesProperties" + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ServicesResource" + } + ] + }, + "ServicesPatchDescription": { + "description": "The description of the service.", + "type": "object", + "properties": { + "tags": { + "description": "Instance tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ServicesPropertiesUpdateParameters", + "description": "The properties for updating a service instance.", + "x-ms-client-flatten": true + } + } + }, + "ServicesResource": { + "description": "The common properties of a service.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "kind": { + "readOnly": false, + "type": "string", + "description": "The kind of the service.", + "enum": [ + "fhir", + "fhir-Stu3", + "fhir-R4" + ], + "x-ms-enum": { + "name": "kind", + "modelAsString": false + } + }, + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "etag": { + "description": "An etag associated with the resource, used for optimistic concurrency when editing it.", + "type": "string" + }, + "identity": { + "type": "object", + "description": "Setting indicating whether the service has a managed identity associated with it.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of the resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of the resource." + }, + "type": { + "description": "Type of identity being specified, currently SystemAssigned and None are allowed.", + "type": "string", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true + } + } + } + } + }, + "x-ms-azure-resource": true, + "required": [ + "location", + "kind" + ] + }, + "ServicesDescriptionListResult": { + "description": "A list of service description objects with a next link.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of service description objects.", + "type": "string" + }, + "value": { + "description": "A list of service description objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ServicesDescription" + } + } + } + }, + "ServicesPropertiesUpdateParameters": { + "description": "The properties for updating a service instance.", + "type": "object", + "properties": { + "publicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + } + } + }, + "CheckNameAvailabilityParameters": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the service instance to check.", + "type": "string" + }, + "type": { + "description": "The fully qualified resource type which includes provider namespace.", + "type": "string" + } + }, + "required": [ + "name", + "type" + ] + }, + "ServicesNameAvailabilityInfo": { + "description": "The properties indicating whether a given service name is available.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value which indicates whether the provided name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason for unavailability.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ServiceNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionDescription": { + "type": "object", + "properties": { + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateLinkResourceDescription": { + "type": "object", + "properties": { + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionListResultDescription": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionDescription" + } + } + }, + "description": "List of private endpoint connection associated with the specified storage account" + }, + "PrivateLinkResourceListResultDescription": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResourceDescription" + } + } + }, + "description": "A list of private link resources" + }, + "Error": { + "description": "Error details.", + "type": "object", + "properties": { + "error": { + "description": "Error details", + "$ref": "#/definitions/ErrorDetailsInternal" + } + } + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "error": { + "description": "Error details", + "$ref": "#/definitions/ErrorDetailsInternal" + } + } + }, + "ErrorDetailsInternal": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + }, + "ListOperations": { + "description": "Available operations of the service", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationDetail" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationDetail": { + "description": "Service REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string", + "readOnly": true + }, + "isDataAction": { + "description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.", + "type": "boolean", + "readOnly": true + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Display of the operation" + }, + "origin": { + "readOnly": true, + "type": "string", + "description": "Default value is 'user,system'." + }, + "actionType": { + "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", + "type": "string", + "readOnly": true, + "enum": [ + "Internal" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.HealthcareApis" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: Services" + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Friendly description for the operation," + } + } + }, + "OperationResultsDescription": { + "description": "The properties indicating the operation result of an operation on a service.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the operation returned.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the operation result.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "The status of the operation being performed.", + "enum": [ + "Canceled", + "Succeeded", + "Failed", + "Requested", + "Running" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "OperationResultStatus", + "modelAsString": true + } + }, + "startTime": { + "description": "The time that the operation was started.", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "The time that the operation finished.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": false, + "description": "Additional properties of the operation result.", + "type": "object" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "Service specifications of the operation" + } + } + }, + "ServiceSpecification": { + "description": "Service specification payload", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Specifications of the Log for Azure Monitoring", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [] + }, + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [] + } + } + }, + "LogSpecification": { + "description": "Specifications of the Log for Azure Monitoring", + "type": "object", + "properties": { + "name": { + "description": "Name of the log", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the log", + "type": "string" + }, + "blobDuration": { + "description": "Blob duration of the log", + "type": "string" + } + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric", + "type": "string" + }, + "unit": { + "description": "Unit that makes sense for the metric", + "type": "string" + }, + "category": { + "description": "Name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "supportedAggregationTypes": { + "description": "Supported aggregation types", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "supportedTimeGrainTypes": { + "description": "Supported time grain types", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.", + "type": "boolean" + }, + "metricFilterPattern": { + "type": "string", + "description": "Pattern for the filter of the metric." + }, + "dimensions": { + "description": "Dimensions of the metric", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "x-ms-identifiers": [] + }, + "isInternal": { + "type": "boolean", + "description": "Whether the metric is internal." + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "enableRegionalMdmAccount": { + "type": "boolean", + "description": "Whether regional MDM account enabled." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "The resource Id dimension name override." + } + } + }, + "MetricDimension": { + "description": "Specifications of the Dimension of metrics", + "type": "object", + "properties": { + "name": { + "description": "Name of the dimension", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "Whether this dimension should be included for the Shoebox export scenario", + "type": "boolean" + } + } + }, + "ProvisioningState": { + "description": "The provisioning state.", + "enum": [ + "Deleting", + "Succeeded", + "Creating", + "Accepted", + "Verifying", + "Updating", + "Failed", + "Canceled", + "Deprovisioned", + "Moving", + "Suspended", + "Warned", + "SystemMaintenance" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "ResourceTags": { + "type": "object", + "description": "List of key value pairs that describe the resource. This will overwrite the existing tags.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "ResourceCore": { + "type": "object", + "description": "The common properties for any resource, tracked or proxy.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "etag": { + "description": "An etag associated with the resource, used for optimistic concurrency when editing it.", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "LocationBasedResource": { + "type": "object", + "description": "The common properties for any location based resource, tracked or proxy.", + "allOf": [ + { + "$ref": "#/definitions/ResourceCore" + } + ], + "properties": { + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-azure-resource": true + }, + "TaggedResource": { + "type": "object", + "description": "The common properties of tracked resources in the service.", + "allOf": [ + { + "$ref": "#/definitions/ResourceTags" + }, + { + "$ref": "#/definitions/LocationBasedResource" + } + ], + "x-ms-azure-resource": true + }, + "ServiceManagedIdentity": { + "type": "object", + "description": "Managed service identity (system assigned and/or user assigned identities)", + "properties": { + "identity": { + "type": "object", + "description": "Setting indicating whether the service has a managed identity associated with it.", + "properties": { + "type": { + "description": "Type of identity being specified, currently SystemAssigned and None are allowed.", + "type": "string", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned" + ], + "x-ms-enum": { + "name": "ServiceManagedIdentityType", + "modelAsString": true + } + }, + "principalId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentities" + } + }, + "required": [ + "type" + ] + } + } + }, + "UserAssignedIdentity": { + "type": "object", + "description": "User assigned identity properties", + "properties": { + "principalId": { + "description": "The principal ID of the assigned identity.", + "format": "uuid", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client ID of the assigned identity.", + "format": "uuid", + "type": "string", + "readOnly": true + } + } + }, + "UserAssignedIdentities": { + "title": "User-Assigned Identities", + "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + }, + "Workspace": { + "type": "object", + "description": "Workspace resource.", + "allOf": [ + { + "$ref": "#/definitions/TaggedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": false, + "type": "object", + "description": "Workspaces resource specific properties.", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "$ref": "#/definitions/ProvisioningState" + }, + "privateEndpointConnections": { + "description": "The list of private endpoint connections that are set up for this resource.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "publicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "$ref": "#/definitions/ResourcePublicNetworkAccess" + } + } + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "#/definitions/systemData" + } + } + }, + "WorkspacePatchResource": { + "type": "object", + "description": "Workspace patch properties", + "allOf": [ + { + "$ref": "#/definitions/ResourceTags" + } + ] + }, + "WorkspaceList": { + "description": "Collection of workspace object with a next link", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page.", + "type": "string" + }, + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + } + } + }, + "DicomService": { + "type": "object", + "description": "The description of Dicom Service", + "allOf": [ + { + "$ref": "#/definitions/TaggedResource" + }, + { + "$ref": "#/definitions/ServiceManagedIdentity" + } + ], + "properties": { + "properties": { + "description": "Dicom Service configuration.", + "$ref": "#/definitions/DicomServiceProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "#/definitions/systemData" + } + } + }, + "DicomServicePatchResource": { + "type": "object", + "description": "Dicom Service patch properties", + "allOf": [ + { + "$ref": "#/definitions/ResourceTags" + }, + { + "$ref": "#/definitions/ServiceManagedIdentity" + } + ] + }, + "DicomServiceCollection": { + "description": "The collection of Dicom Services.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Dicom Services.", + "type": "string" + }, + "value": { + "description": "The list of Dicom Services.", + "type": "array", + "items": { + "$ref": "#/definitions/DicomService" + } + } + } + }, + "DicomServiceProperties": { + "description": "Dicom Service properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "$ref": "#/definitions/ProvisioningState" + }, + "authenticationConfiguration": { + "description": "Dicom Service authentication configuration.", + "$ref": "#/definitions/DicomServiceAuthenticationConfiguration" + }, + "corsConfiguration": { + "description": "Dicom Service Cors configuration.", + "$ref": "#/definitions/CorsConfiguration" + }, + "serviceUrl": { + "description": "The url of the Dicom Services.", + "type": "string", + "readOnly": true + }, + "privateEndpointConnections": { + "description": "The list of private endpoint connections that are set up for this resource.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "publicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "$ref": "#/definitions/ResourcePublicNetworkAccess" + }, + "eventState": { + "description": "DICOM Service event support status.", + "$ref": "#/definitions/ResourceEventState" + }, + "encryption": { + "description": "The encryption settings of the DICOM service", + "$ref": "#/definitions/Encryption" + } + } + }, + "DicomServiceAuthenticationConfiguration": { + "description": "Authentication configuration information", + "type": "object", + "properties": { + "authority": { + "type": "string", + "description": "The authority url for the service", + "readOnly": true + }, + "audiences": { + "type": "array", + "description": "The audiences for the service", + "items": { + "$ref": "#/definitions/DicomAudience" + }, + "readOnly": true + } + } + }, + "DicomAudience": { + "description": "The audience for Dicom Service", + "type": "string", + "readOnly": true + }, + "CorsConfiguration": { + "description": "The settings for the CORS configuration of the service instance.", + "type": "object", + "properties": { + "origins": { + "type": "array", + "description": "The origins to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/CorsConfigurationOriginEntry" + } + }, + "headers": { + "type": "array", + "description": "The headers to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/CorsConfigurationHeaderEntry" + } + }, + "methods": { + "type": "array", + "description": "The methods to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/CorsConfigurationMethodEntry" + } + }, + "maxAge": { + "type": "integer", + "format": "int32", + "description": "The max age to be allowed via CORS.", + "readOnly": false, + "minimum": 0, + "maximum": 99999 + }, + "allowCredentials": { + "type": "boolean", + "description": "If credentials are allowed via CORS.", + "readOnly": false + } + } + }, + "IotConnector": { + "type": "object", + "description": "IoT Connector definition.", + "allOf": [ + { + "$ref": "#/definitions/TaggedResource" + }, + { + "$ref": "#/definitions/ServiceManagedIdentity" + } + ], + "properties": { + "properties": { + "description": "IoT Connector configuration.", + "$ref": "#/definitions/IotConnectorProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "#/definitions/systemData" + } + } + }, + "IotConnectorPatchResource": { + "type": "object", + "description": "Iot Connector patch properties", + "allOf": [ + { + "$ref": "#/definitions/ResourceTags" + }, + { + "$ref": "#/definitions/ServiceManagedIdentity" + } + ] + }, + "IotConnectorCollection": { + "description": "A collection of IoT Connectors.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of IoT Connectors.", + "type": "string" + }, + "value": { + "description": "The list of IoT Connectors.", + "type": "array", + "items": { + "$ref": "#/definitions/IotConnector" + } + } + } + }, + "IotConnectorProperties": { + "description": "IoT Connector properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "$ref": "#/definitions/ProvisioningState" + }, + "ingestionEndpointConfiguration": { + "description": "Source configuration.", + "$ref": "#/definitions/IotEventHubIngestionEndpointConfiguration" + }, + "deviceMapping": { + "description": "Device Mappings.", + "$ref": "#/definitions/IotMappingProperties" + } + } + }, + "IotEventHubIngestionEndpointConfiguration": { + "type": "object", + "properties": { + "eventHubName": { + "type": "string", + "description": "Event Hub name to connect to." + }, + "consumerGroup": { + "type": "string", + "description": "Consumer group of the event hub to connected to." + }, + "fullyQualifiedEventHubNamespace": { + "type": "string", + "description": "Fully qualified namespace of the Event Hub to connect to." + } + }, + "description": "Event Hub ingestion endpoint configuration" + }, + "IotMappingProperties": { + "description": "The mapping content.", + "type": "object", + "properties": { + "content": { + "description": "The mapping.", + "type": "object" + } + } + }, + "IotIdentityResolutionType": { + "description": "The type of IoT identity resolution to use with the destination.", + "enum": [ + "Create", + "Lookup" + ], + "type": "string", + "x-ms-enum": { + "name": "IotIdentityResolutionType", + "modelAsString": true + } + }, + "IotDestinationProperties": { + "type": "object", + "description": "Common IoT Connector destination properties.", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "$ref": "#/definitions/ProvisioningState", + "x-ms-client-flatten": true + } + } + }, + "IotFhirDestinationProperties": { + "required": [ + "resourceIdentityResolutionType", + "fhirServiceResourceId", + "fhirMapping" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IotDestinationProperties" + } + ], + "description": "IoT Connector destination properties for an Azure FHIR service.", + "properties": { + "resourceIdentityResolutionType": { + "description": "Determines how resource identity is resolved on the destination.", + "$ref": "#/definitions/IotIdentityResolutionType" + }, + "fhirServiceResourceId": { + "type": "string", + "description": "Fully qualified resource id of the FHIR service to connect to." + }, + "fhirMapping": { + "description": "FHIR Mappings", + "$ref": "#/definitions/IotMappingProperties" + } + } + }, + "IotFhirDestination": { + "required": [ + "properties" + ], + "type": "object", + "description": "IoT Connector FHIR destination definition.", + "allOf": [ + { + "$ref": "#/definitions/LocationBasedResource" + } + ], + "properties": { + "properties": { + "description": "IoT FHIR Destination settings.", + "$ref": "#/definitions/IotFhirDestinationProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "#/definitions/systemData" + } + } + }, + "IotFhirDestinationCollection": { + "description": "A collection of IoT Connector FHIR destinations.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of IoT FHIR destinations.", + "type": "string" + }, + "value": { + "description": "The list of IoT Connector FHIR destinations.", + "type": "array", + "items": { + "$ref": "#/definitions/IotFhirDestination" + } + } + } + }, + "FhirServiceCollection": { + "description": "A collection of Fhir services.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Fhir Services.", + "type": "string" + }, + "value": { + "description": "The list of Fhir Services.", + "type": "array", + "items": { + "$ref": "#/definitions/FhirService" + } + } + } + }, + "FhirService": { + "type": "object", + "description": "The description of Fhir Service", + "allOf": [ + { + "$ref": "#/definitions/TaggedResource" + }, + { + "$ref": "#/definitions/ServiceManagedIdentity" + } + ], + "properties": { + "kind": { + "readOnly": false, + "type": "string", + "description": "The kind of the service.", + "enum": [ + "fhir-Stu3", + "fhir-R4" + ], + "x-ms-enum": { + "name": "fhirServiceKind", + "modelAsString": true + } + }, + "properties": { + "description": "Fhir Service configuration.", + "$ref": "#/definitions/FhirServiceProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "#/definitions/systemData" + } + } + }, + "FhirServicePatchResource": { + "type": "object", + "description": "FhirService patch properties", + "allOf": [ + { + "$ref": "#/definitions/ResourceTags" + }, + { + "$ref": "#/definitions/ServiceManagedIdentity" + } + ] + }, + "FhirServiceProperties": { + "description": "Fhir Service properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "$ref": "#/definitions/ProvisioningState" + }, + "acrConfiguration": { + "description": "Fhir Service Azure container registry configuration.", + "$ref": "#/definitions/FhirServiceAcrConfiguration" + }, + "authenticationConfiguration": { + "description": "Fhir Service authentication configuration.", + "$ref": "#/definitions/FhirServiceAuthenticationConfiguration" + }, + "corsConfiguration": { + "description": "Fhir Service Cors configuration.", + "$ref": "#/definitions/FhirServiceCorsConfiguration" + }, + "exportConfiguration": { + "description": "Fhir Service export configuration.", + "$ref": "#/definitions/FhirServiceExportConfiguration" + }, + "privateEndpointConnections": { + "description": "The list of private endpoint connections that are set up for this resource.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "publicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "$ref": "#/definitions/ResourcePublicNetworkAccess" + }, + "eventState": { + "description": "Fhir Service event support status.", + "$ref": "#/definitions/ResourceEventState" + }, + "resourceVersionPolicyConfiguration": { + "description": "Determines tracking of history for resources.", + "$ref": "#/definitions/ResourceVersionPolicyConfiguration" + }, + "importConfiguration": { + "description": "Fhir Service import configuration.", + "$ref": "#/definitions/FhirServiceImportConfiguration" + }, + "implementationGuidesConfiguration": { + "description": "Implementation Guides configuration.", + "$ref": "#/definitions/ImplementationGuidesConfiguration" + }, + "encryption": { + "description": "The encryption settings of the FHIR service", + "$ref": "#/definitions/Encryption" + } + } + }, + "ResourceVersionPolicyConfiguration": { + "description": "The settings for history tracking for FHIR resources.", + "type": "object", + "properties": { + "default": { + "description": "The default value for tracking history across all resources.", + "$ref": "#/definitions/FhirResourceVersionPolicy" + }, + "resourceTypeOverrides": { + "description": "A list of FHIR Resources and their version policy overrides.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FhirResourceVersionPolicy" + } + } + } + }, + "ImplementationGuidesConfiguration": { + "description": "The settings for Implementation Guides - defining capabilities for national standards, vendor consortiums, clinical societies, etc.", + "type": "object", + "properties": { + "usCoreMissingData": { + "type": "boolean", + "description": "If US Core Missing Data requirement is enabled.", + "readOnly": false + } + } + }, + "FhirResourceVersionPolicy": { + "type": "string", + "description": "Controls how resources are versioned on the FHIR service", + "enum": [ + "no-version", + "versioned", + "versioned-update" + ], + "x-ms-enum": { + "name": "FhirResourceVersionPolicy", + "modelAsString": true + } + }, + "FhirServiceAcrConfiguration": { + "description": "Azure container registry configuration information", + "type": "object", + "properties": { + "loginServers": { + "type": "array", + "description": "The list of the Azure container registry login servers.", + "readOnly": false, + "items": { + "type": "string" + } + }, + "ociArtifacts": { + "type": "array", + "description": "The list of Open Container Initiative (OCI) artifacts.", + "readOnly": false, + "items": { + "$ref": "#/definitions/ServiceOciArtifactEntry" + }, + "x-ms-identifiers": [] + } + } + }, + "FhirServiceAuthenticationConfiguration": { + "description": "Authentication configuration information", + "type": "object", + "properties": { + "authority": { + "type": "string", + "description": "The authority url for the service", + "readOnly": false + }, + "audience": { + "type": "string", + "description": "The audience url for the service", + "readOnly": false + }, + "smartProxyEnabled": { + "type": "boolean", + "description": "If the SMART on FHIR proxy is enabled", + "readOnly": false + }, + "smartIdentityProviders": { + "type": "array", + "description": "The array of identity provider configurations for SMART on FHIR authentication.", + "readOnly": false, + "items": { + "$ref": "#/definitions/SmartIdentityProviderConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "SmartIdentityProviderConfiguration": { + "description": "An object to configure an identity provider for use with SMART on FHIR authentication.", + "type": "object", + "properties": { + "authority": { + "description": "The identity provider token authority also known as the token issuing authority.", + "type": "string" + }, + "applications": { + "type": "array", + "description": "The array of identity provider applications for SMART on FHIR authentication.", + "readOnly": false, + "items": { + "$ref": "#/definitions/SmartIdentityProviderApplication" + }, + "x-ms-identifiers": [] + } + } + }, + "SmartIdentityProviderApplication": { + "description": "An Application configured in the Identity Provider used to access FHIR resources.", + "type": "object", + "properties": { + "clientId": { + "description": "The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority.", + "type": "string" + }, + "audience": { + "description": "The audience that will be used to validate bearer tokens against the given authority.", + "type": "string" + }, + "allowedDataActions": { + "description": "The actions that are permitted to be performed on FHIR resources for the application.", + "type": "array", + "items": { + "$ref": "#/definitions/SmartDataActions" + } + } + } + }, + "SmartDataActions": { + "type": "string", + "description": "The Data Actions that can be enabled for a Smart Identity Provider Application.", + "enum": [ + "Read" + ], + "x-ms-enum": { + "name": "SmartDataActions", + "modelAsString": true + } + }, + "FhirServiceCorsConfiguration": { + "description": "The settings for the CORS configuration of the service instance.", + "type": "object", + "properties": { + "origins": { + "type": "array", + "description": "The origins to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/CorsConfigurationOriginEntry" + } + }, + "headers": { + "type": "array", + "description": "The headers to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/CorsConfigurationHeaderEntry" + } + }, + "methods": { + "type": "array", + "description": "The methods to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/CorsConfigurationMethodEntry" + } + }, + "maxAge": { + "type": "integer", + "format": "int32", + "description": "The max age to be allowed via CORS.", + "readOnly": false, + "minimum": 0, + "maximum": 99999 + }, + "allowCredentials": { + "type": "boolean", + "description": "If credentials are allowed via CORS.", + "readOnly": false + } + } + }, + "CorsConfigurationOriginEntry": { + "description": "An origin for CORS.", + "type": "string", + "pattern": "^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\\:\\/\\/(?:[a-zA-Z0-9-]+[.]?)+(?:\\:[0-9]{1,5})?|[*]))$" + }, + "CorsConfigurationHeaderEntry": { + "description": "A header for CORS.", + "type": "string" + }, + "CorsConfigurationMethodEntry": { + "description": "A method for CORS.", + "type": "string" + }, + "ServiceOciArtifactEntry": { + "description": "An Open Container Initiative (OCI) artifact.", + "type": "object", + "properties": { + "loginServer": { + "description": "The Azure Container Registry login server.", + "type": "string" + }, + "imageName": { + "description": "The artifact name.", + "type": "string" + }, + "digest": { + "description": "The artifact digest.", + "type": "string" + } + } + }, + "FhirServiceExportConfiguration": { + "description": "Export operation configuration information", + "type": "object", + "properties": { + "storageAccountName": { + "type": "string", + "description": "The name of the default export storage account.", + "readOnly": false + } + } + }, + "FhirServiceImportConfiguration": { + "description": "Import operation configuration information", + "type": "object", + "properties": { + "integrationDataStore": { + "type": "string", + "description": "The name of the default integration storage account.", + "readOnly": false + }, + "initialImportMode": { + "type": "boolean", + "description": "If the FHIR service is in InitialImportMode.", + "readOnly": false + }, + "enabled": { + "type": "boolean", + "description": "If the import operation is enabled.", + "readOnly": false + } + } + }, + "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.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "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.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "ResourcePublicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "readOnly": true + }, + "Encryption": { + "description": "Settings to encrypt a service", + "type": "object", + "properties": { + "customerManagedKeyEncryption": { + "type": "object", + "description": "The encryption settings for the customer-managed key", + "readOnly": false, + "properties": { + "keyEncryptionKeyUrl": { + "type": "string", + "description": "The URL of the key to use for encryption", + "readOnly": false + } + } + } + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + }, + "description": "List of private endpoint connection associated with the specified storage account" + }, + "ResourceEventState": { + "type": "string", + "description": "Indicates the current status of event support for the resource.", + "enum": [ + "Disabled", + "Enabled", + "Updating" + ], + "x-ms-enum": { + "name": "ServiceEventState", + "modelAsString": true + }, + "readOnly": true + } + }, + "parameters": { + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the service instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + "locationName": { + "name": "locationName", + "in": "path", + "description": "The location of the operation.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "operationResultId": { + "name": "operationResultId", + "in": "path", + "description": "The ID of the operation result to get.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "workspaceName": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of workspace resource.", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "dicomServiceName": { + "name": "dicomServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of DICOM Service resource.", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "iotConnectorName": { + "name": "iotConnectorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of IoT Connector resource.", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "fhirDestinationName": { + "name": "fhirDestinationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of IoT Connector FHIR destination resource.", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "fhirServiceName": { + "name": "fhirServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of FHIR Service resource.", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the service instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + } + } +} diff --git a/specification/healthcareapis/resource-manager/readme.md b/specification/healthcareapis/resource-manager/readme.md index 376f5354594e..06fd2e59cafa 100644 --- a/specification/healthcareapis/resource-manager/readme.md +++ b/specification/healthcareapis/resource-manager/readme.md @@ -28,27 +28,37 @@ These are the global settings for HealthcareApis service. title: HealthcareApisManagementClient description: Azure Healthcare APIs Client openapi-type: arm -tag: package-2023-11 +tag: package-2023-12 azure-arm: true ``` +### Tag: package-2023-12 + +These settings apply only when `--tag=package-2023-12` is specified on the command line. + +```yaml $(tag) == 'package-2023-12' +input-file: + - Microsoft.HealthcareApis/stable/2023-12-01/healthcare-apis.json +``` ### Tag: package-2023-11 These settings apply only when `--tag=package-2023-11` is specified on the command line. -```yaml $(tag) == 'package-2023-11' +``` yaml $(tag) == 'package-2023-11' input-file: - Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json ``` + ### Tag: package-2023-09 These settings apply only when `--tag=package-2023-09` is specified on the command line. -```yaml $(tag) == 'package-2023-09' +``` yaml $(tag) == 'package-2023-09' input-file: - Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json ``` + ### Tag: package-2023-02 These settings apply only when `--tag=package-2023-02` is specified on the command line. diff --git a/specification/hybridaks/resource-manager/readme.java.md b/specification/hybridaks/resource-manager/readme.java.md new file mode 100644 index 000000000000..01cdabebe9ad --- /dev/null +++ b/specification/hybridaks/resource-manager/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +``` diff --git a/specification/hybridaks/resource-manager/readme.md b/specification/hybridaks/resource-manager/readme.md index abc0c4b5183b..07f43221312a 100644 --- a/specification/hybridaks/resource-manager/readme.md +++ b/specification/hybridaks/resource-manager/readme.md @@ -30,6 +30,10 @@ openapi-subtype: rpaas tag: package-2024-01 ``` +``` yaml +modelerfour: + flatten-models: false +``` ### Tag: package-2024-01 diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/connectedClusters.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/connectedClusters.json new file mode 100644 index 000000000000..1bc04934bdf8 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/connectedClusters.json @@ -0,0 +1,1033 @@ +{ + "swagger": "2.0", + "info": { + "title": "ConnectedKubernetesClient", + "version": "2024-02-01-preview", + "description": "Azure Connected Cluster Resource Provider API for adopting any Kubernetes Cluster" + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "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.Kubernetes/connectedClusters/{clusterName}": { + "put": { + "summary": "Register a new Kubernetes cluster with Azure Resource Manager.", + "operationId": "ConnectedCluster_Create", + "description": "API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM).", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "CreateClusterExample": { + "$ref": "./examples/CreateClusterExample.json" + }, + "CreateCluster_KindExample": { + "$ref": "./examples/CreateCluster_KindExample.json" + }, + "CreateClusterPrivateLinkExample": { + "$ref": "./examples/CreateClusterPrivateLinkExample.json" + } + }, + "parameters": [ + { + "$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/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + }, + { + "in": "body", + "name": "ConnectedCluster", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedCluster" + }, + "description": "Parameters supplied to Create a Connected Cluster." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "201": { + "description": "Resource creation request accepted", + "schema": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "summary": "Updates a connected cluster.", + "operationId": "ConnectedCluster_Update", + "description": "API to update certain properties of the connected cluster resource", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "UpdateClusterExample": { + "$ref": "./examples/UpdateClusterExample.json" + } + }, + "parameters": [ + { + "$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/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + }, + { + "in": "body", + "name": "ConnectedClusterPatch", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedClusterPatch" + }, + "description": "Parameters supplied to update Connected Cluster." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "summary": "Get the properties of the specified connected cluster.", + "operationId": "ConnectedCluster_Get", + "description": "Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "GetClusterExample": { + "$ref": "./examples/GetClusterExample.json" + }, + "GetProvisionedClusterExample": { + "$ref": "./examples/GetProvisionedClusterExample.json" + } + }, + "parameters": [ + { + "$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/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + } + ], + "responses": { + "200": { + "description": "Resource retrieved successfully.", + "schema": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "summary": "Delete a connected cluster.", + "operationId": "ConnectedCluster_Delete", + "description": "Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "DeleteClusterExample": { + "$ref": "./examples/DeleteClusterExample.json" + } + }, + "parameters": [ + { + "$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/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Resource deletion is in progress" + }, + "204": { + "description": "The resource was not found but the request is well formed" + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters/{clusterName}/listClusterUserCredential": { + "post": { + "summary": "Gets cluster user credentials of a connected cluster", + "operationId": "ConnectedCluster_ListClusterUserCredential", + "description": "Gets cluster user credentials of the connected cluster with a specified resource group and name.", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "ListClusterUserCredentialExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialResultCSPAAD.json" + }, + "ListClusterUserCredentialNonAadExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialResultCSPToken.json" + }, + "ListClusterUserCredentialCSPExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialResultHPAAD.json" + }, + "ListClusterUserCredentialNonAadCSPExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialResultHPToken.json" + } + }, + "parameters": [ + { + "$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/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNamePathParam" + }, + { + "in": "body", + "required": true, + "name": "Properties", + "schema": { + "$ref": "#/definitions/ListClusterUserCredentialProperties" + }, + "description": "ListClusterUserCredential properties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters": { + "get": { + "summary": "Lists all connected clusters", + "operationId": "ConnectedCluster_ListByResourceGroup", + "description": "API to enumerate registered connected K8s clusters under a Resource Group", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "GetClustersExample": { + "$ref": "./examples/GetClustersByResourceGroupExample.json" + } + }, + "parameters": [ + { + "$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/v2/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedClusterList" + } + }, + "default": { + "description": "Resource Provider 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.Kubernetes/connectedClusters": { + "get": { + "summary": "Lists all connected clusters", + "operationId": "ConnectedCluster_ListBySubscription", + "description": "API to enumerate registered connected K8s clusters under a Subscription", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "GetClustersBySubscriptionExample": { + "$ref": "./examples/GetClustersBySubscriptionExample.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedClusterList" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Kubernetes/operations": { + "get": { + "description": "Lists all of the available API operations for Connected Cluster resource.", + "operationId": "Operations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListConnectedClusterOperationsExample": { + "$ref": "./examples/ListConnectedClusterOperationsExample.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationList": { + "type": "object", + "description": "The paginated list of connected cluster API operations.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of connected cluster API operations." + }, + "nextLink": { + "type": "string", + "description": "The link to fetch the next page of connected cluster API operations." + } + } + }, + "Operation": { + "type": "object", + "description": "The Connected cluster API operation", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {Microsoft.Kubernetes}/{resource}/{operation}" + }, + "display": { + "type": "object", + "readOnly": true, + "description": "The object that represents the operation.", + "properties": { + "provider": { + "type": "string", + "description": "Service provider: Microsoft.connectedClusters" + }, + "resource": { + "type": "string", + "description": "Connected Cluster Resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "Operation type: Read, write, delete, etc." + }, + "description": { + "type": "string", + "description": "Description of the operation." + } + } + } + } + }, + "ConnectedClusterList": { + "description": "The paginated list of connected Clusters", + "type": "object", + "properties": { + "value": { + "description": "The list of connected clusters", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectedCluster" + } + }, + "nextLink": { + "description": "The link to fetch the next page of connected cluster", + "type": "string" + } + } + }, + "ConnectedCluster": { + "type": "object", + "required": [ + "properties", + "identity" + ], + "properties": { + "identity": { + "$ref": "#/definitions/ConnectedClusterIdentity", + "description": "The identity of the connected cluster." + }, + "kind": { + "$ref": "#/definitions/ConnectedClusterKind", + "description": "The kind of connected cluster." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectedClusterProperties", + "description": "Describes the connected cluster resource properties." + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a connected cluster." + }, + "ConnectedClusterIdentity": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of connected 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 connected cluster. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.", + "default": "SystemAssigned", + "enum": [ + "None", + "SystemAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + }, + "description": "Identity for the connected cluster." + }, + "ConnectedClusterKind": { + "type": "string", + "description": "Indicates the kind of Arc connected cluster based on host infrastructure.", + "enum": [ + "ProvisionedCluster" + ], + "x-ms-enum": { + "name": "ConnectedClusterKind", + "modelAsString": true + } + }, + "ConnectedClusterProperties": { + "type": "object", + "required": [ + "agentPublicKeyCertificate" + ], + "properties": { + "agentPublicKeyCertificate": { + "type": "string", + "description": "Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure." + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The Kubernetes version of the connected cluster resource" + }, + "totalNodeCount": { + "readOnly": true, + "type": "integer", + "description": "Number of nodes present in the connected cluster resource" + }, + "totalCoreCount": { + "readOnly": true, + "format": "int32", + "type": "integer", + "description": "Number of CPU cores present in the connected cluster resource" + }, + "agentVersion": { + "readOnly": true, + "type": "string", + "description": "Version of the agent running on the connected cluster resource" + }, + "provisioningState": { + "$ref": "#/definitions/ConnectedClusterProvisioningState", + "description": "Provisioning state of the connected cluster resource." + }, + "distribution": { + "type": "string", + "description": "The Kubernetes distribution running on this connected cluster." + }, + "distributionVersion": { + "type": "string", + "description": "The Kubernetes distribution version on this connected cluster." + }, + "infrastructure": { + "type": "string", + "description": "The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on." + }, + "offering": { + "type": "string", + "readOnly": true, + "description": "Connected cluster offering" + }, + "managedIdentityCertificateExpirationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Expiration time of the managed identity certificate" + }, + "lastConnectivityTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Time representing the last instance when heart beat was received from the cluster" + }, + "connectivityStatus": { + "type": "string", + "readOnly": true, + "description": "Represents the connectivity status of the connected cluster.", + "enum": [ + "Connecting", + "Connected", + "Offline", + "Expired" + ], + "x-ms-enum": { + "name": "ConnectivityStatus", + "modelAsString": true + } + }, + "privateLinkState": { + "type": "string", + "description": "Property which describes the state of private link on a connected cluster resource.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PrivateLinkState", + "modelAsString": true + } + }, + "privateLinkScopeResourceId": { + "type": "string", + "description": "The resource id of the private link scope this connected cluster is assigned to, if any." + }, + "azureHybridBenefit": { + "type": "string", + "description": "Indicates whether Azure Hybrid Benefit is opted in", + "enum": [ + "True", + "False", + "NotApplicable" + ], + "default": "NotApplicable", + "x-ms-enum": { + "name": "AzureHybridBenefit", + "modelAsString": true + } + }, + "aadProfile": { + "description": "AAD profile for the connected cluster.", + "$ref": "#/definitions/AadProfile" + }, + "arcAgentProfile": { + "description": "Arc agentry configuration for the provisioned cluster.", + "$ref": "#/definitions/ArcAgentProfile" + }, + "miscellaneousProperties": { + "description": "More properties related to the Connected Cluster", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "description": "Properties of the connected cluster." + }, + "CredentialResults": { + "type": "object", + "properties": { + "hybridConnectionConfig": { + "$ref": "#/definitions/HybridConnectionConfig", + "description": "Contains the REP (rendezvous endpoint) and “Sender” access token.", + "readOnly": true + }, + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list of credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "ConnectedClusterProvisioningState": { + "type": "string", + "description": "The current deployment state of connectedClusters.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ConnectedClusterPatch": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectedClusterPatchProperties", + "description": "Describes the connected cluster resource properties that can be updated during PATCH operation." + } + }, + "description": "Object containing updates for patch operations." + }, + "ConnectedClusterPatchProperties": { + "type": "object", + "properties": { + "distribution": { + "type": "string", + "description": "Represents the distribution of the connected cluster" + }, + "distributionVersion": { + "type": "string", + "description": "Represents the Kubernetes distribution version on this connected cluster." + }, + "azureHybridBenefit": { + "type": "string", + "description": "Indicates whether Azure Hybrid Benefit is opted in", + "enum": [ + "True", + "False", + "NotApplicable" + ], + "x-ms-enum": { + "name": "AzureHybridBenefit", + "modelAsString": true + } + } + }, + "description": "Properties which can be patched on the connected cluster resource." + }, + "HybridConnectionConfig": { + "type": "object", + "description": "Contains the REP (rendezvous endpoint) and “Sender” access token.", + "properties": { + "expirationTime": { + "description": "Timestamp when this token will be expired.", + "type": "integer", + "readOnly": true, + "format": "int64" + }, + "hybridConnectionName": { + "description": "Name of the connection", + "type": "string", + "readOnly": true + }, + "relay": { + "description": "Name of the relay.", + "type": "string", + "readOnly": true + }, + "token": { + "description": "Sender access token", + "type": "string", + "readOnly": true + } + } + }, + "AadProfile": { + "type": "object", + "description": "AAD Profile specifies attributes for Azure Active Directory integration.", + "properties": { + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + } + }, + "ArcAgentProfile": { + "description": "Defines the Arc Agent properties for the clusters.", + "type": "object", + "properties": { + "desiredAgentVersion": { + "type": "string", + "description": "Version of the Arc agents to be installed on the cluster resource" + }, + "agentAutoUpgrade": { + "type": "string", + "description": "Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "AutoUpgradeOptions", + "modelAsString": true + } + }, + "systemComponents": { + "type": "array", + "description": "List of system extensions can be installed on the cluster resource.", + "items": { + "$ref": "#/definitions/SystemComponent" + } + }, + "agentErrors": { + "type": "array", + "description": "List of system extensions can be installed on the cluster resource.", + "items": { + "$ref": "#/definitions/AgentError" + } + } + } + }, + "AgentError": { + "description": "Agent Errors if any during agent or system component upgrade.", + "type": "object", + "properties": { + "message": { + "type": "string", + "readOnly": true, + "description": "Agent error message." + }, + "severity": { + "type": "string", + "readOnly": true, + "description": "Severity of the error message." + }, + "component": { + "type": "string", + "readOnly": true, + "description": "Agent component where error message occured." + }, + "time": { + "format": "date-time", + "description": "The timestamp of error occured (UTC).", + "type": "string", + "readOnly": true + } + } + }, + "SystemComponent": { + "description": "System Extension and its desired versions to be installed on the cluster resource.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the system extension" + }, + "userSpecifiedVersion": { + "type": "string", + "description": "Version of the system extension to be installed on the cluster resource." + }, + "majorVersion": { + "type": "integer", + "format": "int32", + "description": "Major Version of the system extension to be installed on the cluster resource." + }, + "currentVersion": { + "type": "string", + "readOnly": true, + "description": "Version of the system extension is currently installed on the cluster resource." + } + } + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "properties": { + "createdBy": { + "description": "The identity that created the resource.", + "type": "string" + }, + "createdByType": { + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "type": "string" + }, + "lastModifiedBy": { + "description": "The identity that last modified the resource.", + "type": "string" + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "lastModifiedByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of resource modification (UTC).", + "type": "string" + } + }, + "readOnly": true + }, + "ListClusterUserCredentialProperties": { + "type": "object", + "required": [ + "authenticationMethod", + "clientProxy" + ], + "properties": { + "authenticationMethod": { + "type": "string", + "description": "The mode of client authentication.", + "enum": [ + "Token", + "AAD" + ], + "x-ms-enum": { + "name": "AuthenticationMethod", + "modelAsString": true + } + }, + "clientProxy": { + "type": "boolean", + "description": "Boolean value to indicate whether the request is for client side proxy or not" + } + }, + "description": "" + } + }, + "parameters": { + "ClusterNamePathParam": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Kubernetes cluster on which get is called.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPAAD.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPAAD.json new file mode 100644 index 000000000000..b89eb8f4f6b9 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPAAD.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-02-01-preview", + "Properties": { + "authenticationMethod": "AAD", + "clientProxy": true + } + }, + "responses": { + "200": { + "body": { + "hybridConnectionConfig": { + "expirationTime": 1631196183, + "hybridConnectionName": "microsoft.kubernetes/connectedclusters/229dc73f7b07196c79a93d4362d9c7fc4ed34df3e95290d27c56cec2dbb82865/1631185383340987904", + "relay": "azgnrelay-ph0-l1", + "token": "SharedAccessSignature 123456789034675890pbduwegiavifkuw647o02423bbhfouseb" + }, + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "WVhCcFZtVnljMmx2YmpvZ2RqRU5DbU5zZFhOMFpYSnpPZzBLTFNCamJIVnpkR1Z5T2cwS0lDQWdJR05sY25ScFptbGpZWFJsTFdGMWRHaHZjbWwwZVMxa1lYUmhPaUJNVXpCMFRGTXhRMUpWWkVwVWFVSkVVbFpLVlZOVldrcFJNRVpWVWxNd2RFeFRNSFJEYXpGS1UxVldOR1ZyVGtSUldFVnlXakJHTTFOVlNrSmFNR3hTVlRKMGRWZHNXblphZWtwMVZtcEtWbU5ZWkV0amJsWllUVEZDU0dWclJrOVJiV1J5WTFkb2NtRlZZelZrZWtKRFVWWkdlbEpyUmtWUlZUUkxWRlpHZW1Rd1RsSlhWVkpYVlZaR1JWSllaRXRoYkdWc1NsRXdiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR2JrOUZSazVUVld4RVVUSmtURkV3Um01U1ZVVXdWMWhDTlVOc1VtdFVNVkpTVTFkTmRtVnNhRVJsUjNoVFpXdFZNRg==" + } + ] + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPToken.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPToken.json new file mode 100644 index 000000000000..88c231d4de5f --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultCSPToken.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-02-01-preview", + "Properties": { + "authenticationMethod": "Token", + "clientProxy": true + } + }, + "responses": { + "200": { + "body": { + "hybridConnectionConfig": { + "expirationTime": 1631196183, + "hybridConnectionName": "microsoft.kubernetes/connectedclusters/229dc73f7b07196c79a93d4362d9c7fc4ed34df3e95290d27c56cec2dbb82865/1631185383340987904", + "relay": "azgnrelay-ph0-l1", + "token": "SharedAccessSignature 123456789034675890pbduwegiavifkuw647o02423bbhfouseb" + }, + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "WVhCcFZtVnljMmx2YmpvZ2RqRU5DbU5zZFhOMFpYSnpPZzBLTFNCamJIVnpkR1Z5T2cwS0lDQWdJR05sY25ScFptbGpZWFJsTFdGMWRHaHZjbWwwZVMxa1lYUmhPaUJNVXpCMFRGTXhRMUpWWkVwVWFVSkVVbFpLVlZOVldrcFJNRVpWVWxNd2RFeFRNSFJEYXpGS1UxVldOR1ZyVGtSUldFVnlXakJHTTFOVlNrSmFNR3hTVlRKMGRWZHNXblphZWtwMVZtcEtWbU5ZWkV0amJsWllUVEZDU0dWclJrOVJiV1J5WTFkb2NtRlZZelZrZWtKRFVWWkdlbEpyUmtWUlZUUkxWRlpHZW1Rd1RsSlhWVkpYVlZaR1JWSllaRXRoYkdWc1NsRXdiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR2JrOUZSazVUVld4RVVUSmtURkV3Um01U1ZVVXdWMWhDTlVOc1VtdFVNVkpTVTFkTmRtVnNhRVJsUjNoVFpXdFZNRg==" + } + ] + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultHPAAD.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultHPAAD.json new file mode 100644 index 000000000000..d7cb223b2fee --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultHPAAD.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-02-01-preview", + "Properties": { + "authenticationMethod": "AAD", + "clientProxy": false + } + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "WVhCcFZtVnljMmx2YmpvZ2RqRU5DbU5zZFhOMFpYSnpPZzBLTFNCamJIVnpkR1Z5T2cwS0lDQWdJR05sY25ScFptbGpZWFJsTFdGMWRHaHZjbWwwZVMxa1lYUmhPaUJNVXpCMFRGTXhRMUpWWkVwVWFVSkVVbFpLVlZOVldrcFJNRVpWVWxNd2RFeFRNSFJEYXpGS1UxVldOR1ZyVGtSUldFVnlXakJHTTFOVlNrSmFNR3hTVlRKMGRWZHNXblphZWtwMVZtcEtWbU5ZWkV0amJsWllUVEZDU0dWclJrOVJiV1J5WTFkb2NtRlZZelZrZWtKRFVWWkdlbEpyUmtWUlZUUkxWRlpHZW1Rd1RsSlhWVkpYVlZaR1JWSllaRXRoYkdWc1NsRXdiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR2JrOUZSazVUVld4RVVUSmtURkV3Um01U1ZVVXdWMWhDTlVOc1VtdFVNVkpTVTFkTmRtVnNhRVJsUjNoVFpXdFZNRg==" + } + ] + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultHPToken.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultHPToken.json new file mode 100644 index 000000000000..b85db2ef68a5 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ConnectedClustersListClusterCredentialResultHPToken.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-02-01-preview", + "Properties": { + "authenticationMethod": "Token", + "clientProxy": false + } + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "WVhCcFZtVnljMmx2YmpvZ2RqRU5DbU5zZFhOMFpYSnpPZzBLTFNCamJIVnpkR1Z5T2cwS0lDQWdJR05sY25ScFptbGpZWFJsTFdGMWRHaHZjbWwwZVMxa1lYUmhPaUJNVXpCMFRGTXhRMUpWWkVwVWFVSkVVbFpLVlZOVldrcFJNRVpWVWxNd2RFeFRNSFJEYXpGS1UxVldOR1ZyVGtSUldFVnlXakJHTTFOVlNrSmFNR3hTVlRKMGRWZHNXblphZWtwMVZtcEtWbU5ZWkV0amJsWllUVEZDU0dWclJrOVJiV1J5WTFkb2NtRlZZelZrZWtKRFVWWkdlbEpyUmtWUlZUUkxWRlpHZW1Rd1RsSlhWVkpYVlZaR1JWSllaRXRoYkdWc1NsRXdiSEZSVlRWRFdqSjBlR0ZIZEhCU2Vtd3pUVVZLUWxWVlZrZFJWVVpRVVRCR2JrOUZSazVUVld4RVVUSmtURkV3Um01U1ZVVXdWMWhDTlVOc1VtdFVNVkpTVTFkTmRtVnNhRVJsUjNoVFpXdFZNRg==" + } + ] + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/CreateClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/CreateClusterExample.json new file mode 100644 index 000000000000..e3f2fc63bfa2 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/CreateClusterExample.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-02-01-preview", + "ConnectedCluster": { + "location": "East US", + "tags": {}, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Succeeded", + "distribution": "AKS", + "distributionVersion": "1.0", + "azureHybridBenefit": "NotApplicable" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Accepted", + "distribution": "AKS", + "distributionVersion": "1.0", + "azureHybridBenefit": "NotApplicable" + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/CreateClusterPrivateLinkExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/CreateClusterPrivateLinkExample.json new file mode 100644 index 000000000000..3e5ae68ce649 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/CreateClusterPrivateLinkExample.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-02-01-preview", + "ConnectedCluster": { + "location": "East US", + "tags": {}, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "provisioningState": "Accepted", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/CreateCluster_KindExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/CreateCluster_KindExample.json new file mode 100644 index 000000000000..d66ddf35155c --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/CreateCluster_KindExample.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-02-01-preview", + "ConnectedCluster": { + "location": "East US", + "tags": {}, + "identity": { + "type": "SystemAssigned" + }, + "kind": "ProvisionedCluster", + "properties": { + "agentPublicKeyCertificate": "", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "aadProfile": { + "enableAzureRBAC": true, + "adminGroupObjectIDs": [ + "56f988bf-86f1-41af-91ab-2d7cd011db47" + ], + "tenantID": "82f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "majorVersion": 0 + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "kind": "ProvisionedCluster", + "properties": { + "agentPublicKeyCertificate": "", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Succeeded", + "distribution": "AKS", + "distributionVersion": "1.0", + "azureHybridBenefit": "NotApplicable", + "aadProfile": { + "enableAzureRBAC": true, + "adminGroupObjectIDs": [ + "56f988bf-86f1-41af-91ab-2d7cd011db47" + ], + "tenantID": "82f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "currentVersion": "0.1.0", + "majorVersion": 0 + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Accepted", + "distribution": "AKS", + "distributionVersion": "1.0", + "azureHybridBenefit": "NotApplicable", + "aadProfile": { + "enableAzureRBAC": true, + "adminGroupObjectIDs": [ + "56f988bf-86f1-41af-91ab-2d7cd011db47" + ], + "tenantID": "82f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "currentVersion": "0.1.0", + "majorVersion": 0 + } + ] + } + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/DeleteClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/DeleteClusterExample.json new file mode 100644 index 000000000000..d24ef91bff3e --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/DeleteClusterExample.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.Kubernetes/locations/eastasia/operationStatuses/eb4c5b0b-35c7-4de9-8b9c-d51bf24dd729", + "Location": "https://management.azure.com/providers/Microsoft.Kubernetes/locations/eastasia/operationStatuses/eb4c5b0b-35c7-4de9-8b9c-d51bf24dd729*B31BD6830F326F0DAC6966963A274F89A70EDF802817A03F8CC944233B6E6C2E?api-version=2024-02-01-preview&t=638325565717977058&c=MIIHADCCBeigAwIBAgITHgMjMN6vpcEQg2_WbgAAAyMw3jANBgkqhkiG9w0BAQsFADBEMRMwEQYKCZImiZPyLGQBGRYDR0JMMRMwEQYKCZImiZPyLGQBGRYDQU1FMRgwFgYDVQQDEw9BTUUgSW5mcmEgQ0EgMDYwHhcNMjMwODAzMDczNjQzWhcNMjQwNzI4MDczNjQzWjBAMT4wPAYDVQQDEzVhc3luY29wZXJhdGlvbnNpZ25pbmdjZXJ0aWZpY2F0ZS5tYW5hZ2VtZW50LmF6dXJlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKtqtBNpyBDffqSjU2vKc-q1Ku3MtRBZR4VV9i6TdAcmNpVmw6W8QNgsa-z0zaqgCcjkLIFSUySU0_7_r4cjNFPDGVj0Y3gPDesFRunHaZsZoA2l235ZxgkOhmI9Eq_hgRKbBV-_zy1PbegjuigJTDOv4tC_xxRRMMioo273xgqG_kUrJVmb5EpU0OONBJtawx7E17himPHTOSCk6f__KaMY6z55v5motGTAEvs40N_pYLk36d4xWMWAfMSqoQu0fCiDTOBh9fXR1Mix28dh2is83JJOEmTls4gNVGZ4_gVn6DrVk-sPnD5sGs789lwzBSlRdpOoJMUnxOgMEgc_JB0CAwEAAaOCA-0wggPpMCcGCSsGAQQBgjcVCgQaMBgwCgYIKwYBBQUHAwEwCgYIKwYBBQUHAwIwPQYJKwYBBAGCNxUHBDAwLgYmKwYBBAGCNxUIhpDjDYTVtHiE8Ys-hZvdFs6dEoFggvX2K4Py0SACAWQCAQowggHLBggrBgEFBQcBAQSCAb0wggG5MGMGCCsGAQUFBzAChldodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpaW5mcmEvQ2VydHMvQkwyUEtJSU5UQ0EwMi5BTUUuR0JMX0FNRSUyMEluZnJhJTIwQ0ElMjAwNi5jcnQwUwYIKwYBBQUHMAKGR2h0dHA6Ly9jcmwxLmFtZS5nYmwvYWlhL0JMMlBLSUlOVENBMDIuQU1FLkdCTF9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3J0MFMGCCsGAQUFBzAChkdodHRwOi8vY3JsMi5hbWUuZ2JsL2FpYS9CTDJQS0lJTlRDQTAyLkFNRS5HQkxfQU1FJTIwSW5mcmElMjBDQSUyMDA2LmNydDBTBggrBgEFBQcwAoZHaHR0cDovL2NybDMuYW1lLmdibC9haWEvQkwyUEtJSU5UQ0EwMi5BTUUuR0JMX0FNRSUyMEluZnJhJTIwQ0ElMjAwNi5jcnQwUwYIKwYBBQUHMAKGR2h0dHA6Ly9jcmw0LmFtZS5nYmwvYWlhL0JMMlBLSUlOVENBMDIuQU1FLkdCTF9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3J0MB0GA1UdDgQWBBQQBQ6aI7w4CwOrsQOypzq30e50CDAOBgNVHQ8BAf8EBAMCBaAwggEmBgNVHR8EggEdMIIBGTCCARWgggERoIIBDYY_aHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraWluZnJhL0NSTC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JshjFodHRwOi8vY3JsMS5hbWUuZ2JsL2NybC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JshjFodHRwOi8vY3JsMi5hbWUuZ2JsL2NybC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JshjFodHRwOi8vY3JsMy5hbWUuZ2JsL2NybC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JshjFodHRwOi8vY3JsNC5hbWUuZ2JsL2NybC9BTUUlMjBJbmZyYSUyMENBJTIwMDYuY3JsMBcGA1UdIAQQMA4wDAYKKwYBBAGCN3sBATAfBgNVHSMEGDAWgBTxRmjG8cPwKy19i2rhsvm-NfzRQTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAD5C_x4drGztlnmLaCdpAyL9KN3LkK_sr-VeDz0s3SwQ30lixsYUUfohjlbSqgoq5GW7WmEgMVuyHCv3nUc01REq-CK7A2xlhD68sfOKqXdpPFsjDCyVEFxuigozWoM3jh9ffTPLM-0cuvpIUH3sOooWAL0Y2RpShpYCxzE7ufkpuFvrs0SPvDNxn7Ga6gYdqvqXsGni-J8I4mQ5sPmZa23Nqq3RDpkYkMunjIJkX7_3p-mX4Wcnm5j93_oLnn7WRkjMF3gwwCcJGn_2yLAeVeJ8E4TNZA2_mfmwo7zGwRDV0VT4JM6evNGxDXVG9XG3hdGlZaoe_TTL5yyWR4CmM2A&s=oBCOqB7wr6rL3h0KEYh91fsSQOpjJEXV_-trbTwQJpxCgOFmN7OStVj0qiAoxRrAIJtCZHCDQnA_JjawmDlVQM7kkXVg9mg3GSG0ucDBu-G8dqYoEoS7dQu_1GKrEpyzQXCPZ4J9QZy1wDh5MmwftdAqyJ3XjTa5AFHlmnjJJiOQ0NAp4sM94-f5_Ru5ycMUdfjItDz_JjOjzSjsl6HSWMHdjvcqGUmbc7onurDb54T5hpNuioO3ex3YH7NdKP18-i66CsOx2MfidCgL6GGOw-KcVH89BPzXY8nxVqnCE54sc0EAjoyz0FU2pESjdrvJutP4c9HJc2rCJjLkxhujCQ&h=e_aACIZc0Bg5Zoog38uTxuuAtK2U6Zd6X45h4sVfHnM" + } + }, + "204": {} + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetClusterExample.json new file mode 100644 index 000000000000..5d535b22a1a7 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetClusterExample.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "2d2a754c-cade-4935-83d4-ce413c5a3910", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-12-17T07:14:58.865041Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Disabled", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "currentVersion": "0.1.0" + } + ], + "agentErrors": [ + { + "message": "Upgrade failed for agent extension Strato, version not found", + "severity": "Error", + "component": "Strato", + "time": "2020-12-17T07:14:58.865041Z" + } + ] + } + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetClustersByResourceGroupExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetClustersByResourceGroupExample.json new file mode 100644 index 000000000000..5cf11ff3a3c0 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetClustersByResourceGroupExample.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Disabled", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + }, + { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "XIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.1", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters?api-version=2019-11-01-preview&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetClustersBySubscriptionExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetClustersBySubscriptionExample.json new file mode 100644 index 000000000000..a62c1a341306 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetClustersBySubscriptionExample.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Disabled", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + }, + { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster2", + "name": "connectedCluster2", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "sikasire@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-12-17T07:06:33.9173186Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "XIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.16.3", + "totalNodeCount": 4, + "agentVersion": "0.1.0", + "privateLinkState": "Enabled", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters?api-version=2019-11-01-preview&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetProvisionedClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetProvisionedClusterExample.json new file mode 100644 index 000000000000..eabb477fd805 --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/GetProvisionedClusterExample.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "2d2a754c-cade-4935-83d4-ce413c5a3910", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-12-17T07:14:58.865041Z" + }, + "identity": { + "principalId": "d8cd1fd9-154f-4da7-b348-595f283c13a3", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "kind": "ProvisionedCluster", + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "privateLinkState": "Disabled", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "aadProfile": { + "enableAzureRBAC": true, + "adminGroupObjectIDs": [ + "56f988bf-86f1-41af-91ab-2d7cd011db47" + ], + "tenantID": "82f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "arcAgentProfile": { + "desiredAgentVersion": "0.1.0", + "agentAutoUpgrade": "Enabled", + "systemComponents": [ + { + "type": "Strato", + "userSpecifiedVersion": "0.1.1", + "currentVersion": "0.1.0", + "majorVersion": 0 + } + ] + }, + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ListConnectedClusterOperationsExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ListConnectedClusterOperationsExample.json new file mode 100644 index 000000000000..5a3e1b7fc76e --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/ListConnectedClusterOperationsExample.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Kubernetes/connectedClusters/write", + "display": { + "provider": "Microsoft.connectedClusters", + "resource": "connectedClusters", + "operation": "Create ConnectedCluster", + "description": "Create any ConnectedCluster" + } + }, + { + "name": "Microsoft.Kubernetes/connectedClusters/read", + "display": { + "provider": "Microsoft.Kubernetes", + "resource": "connectedClusters", + "operation": "Get ConnectedCluster", + "description": "Get any ConnectedCluster" + } + }, + { + "name": "Microsoft.Kubernetes/connectedClusters/delete", + "display": { + "provider": "Microsoft.Kubernetes", + "resource": "connectedClusters", + "operation": "Delete ConnectedCluster", + "description": "Delete any ConnectedCluster" + } + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters?api-version=2019-11-01-preview&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/UpdateClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/UpdateClusterExample.json new file mode 100644 index 000000000000..55cde988e87d --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2024-02-01-preview/examples/UpdateClusterExample.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "ConnectedClusterPatch": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", + "name": "connectedCluster1", + "type": "Microsoft.Kubernetes/connectedClusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "sikasire@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-17T07:06:33.9173186Z", + "lastModifiedBy": "2d2a754c-cade-4935-83d4-ce413c5a3910", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-12-17T07:14:58.865041Z" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "kubernetesVersion": "1.17.0", + "totalNodeCount": 2, + "agentVersion": "0.1.0", + "provisioningState": "Succeeded", + "azureHybridBenefit": "NotApplicable", + "distribution": "AKS", + "distributionVersion": "1.0", + "miscellaneousProperties": { + "createCorrelationId": "8e42616e-74dc-4117-9aaa-71ad5d0180d8", + "infrastructureVersion": "1.1" + } + } + } + } + } +} diff --git a/specification/hybridkubernetes/resource-manager/readme.md b/specification/hybridkubernetes/resource-manager/readme.md index 302228291432..19a738bcbfcc 100644 --- a/specification/hybridkubernetes/resource-manager/readme.md +++ b/specification/hybridkubernetes/resource-manager/readme.md @@ -31,6 +31,15 @@ tag: package-2024-01 ``` +### Tag: package-preview-2024-02-01 + +These settings apply only when `--tag=package-preview-2024-02-01` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-02-01' +input-file: + - Microsoft.Kubernetes/preview/2024-02-01-preview/connectedClusters.json +``` + ### Tag: package-2024-01 These settings apply only when `--tag=package-2024-01` is specified on the command line. diff --git a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/common.tsp b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/common.tsp index 38eafdf6b0d0..9039c37bc3ad 100644 --- a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/common.tsp +++ b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/common.tsp @@ -24,18 +24,19 @@ model ExtendedLocation { @lroStatus @doc("The provisioning status of the resource.") -enum ProvisioningState { - ...ResourceProvisioningState, +union ProvisioningState { + string, + ResourceProvisioningState, @doc("The resource is being created.") - Provisioning, + Provisioning: "Provisioning", @doc("The resource is being updated.") - Updating, + Updating: "Updating", @doc("The resource is being deleted.") - Deleting, + Deleting: "Deleting", @doc("The resource was accepted by the server.") - Accepted, + Accepted: "Accepted", } diff --git a/specification/iotoperationsdataprocessor/resource-manager/Microsoft.IoTOperationsDataProcessor/preview/2023-10-04-preview/openapi.json b/specification/iotoperationsdataprocessor/resource-manager/Microsoft.IoTOperationsDataProcessor/preview/2023-10-04-preview/openapi.json index 4449851959ce..9a47203193f0 100644 --- a/specification/iotoperationsdataprocessor/resource-manager/Microsoft.IoTOperationsDataProcessor/preview/2023-10-04-preview/openapi.json +++ b/specification/iotoperationsdataprocessor/resource-manager/Microsoft.IoTOperationsDataProcessor/preview/2023-10-04-preview/openapi.json @@ -67,7 +67,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -106,7 +106,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/InstanceListResult" } @@ -148,7 +148,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/InstanceListResult" } @@ -198,7 +198,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Instance" } @@ -323,7 +323,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Instance" } @@ -382,7 +382,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -430,7 +430,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatasetListResult" } @@ -488,7 +488,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Dataset" } @@ -629,7 +629,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Dataset" } @@ -696,7 +696,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -744,7 +744,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PipelineListResult" } @@ -802,7 +802,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Pipeline" } @@ -943,7 +943,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Pipeline" } @@ -1010,7 +1010,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/base.tsp b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/base.tsp index c4b5b8a03cec..7e2df9921356 100644 --- a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/base.tsp +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/base.tsp @@ -22,26 +22,29 @@ model ExtendedLocationProperty { } @doc("The enum defining type of ExtendedLocation accepted.") -enum ExtendedLocationType { +union ExtendedLocationType { + string, + @doc("CustomLocation type") - CustomLocation, + "CustomLocation", } @doc("The enum defining status of resource.") -enum ProvisioningState { - ...ResourceProvisioningState, +union ProvisioningState { + string, + ResourceProvisioningState, @doc("Resource is getting provisioned.") - Provisioning, + Provisioning: "Provisioning", @doc("Resource is Updating.") - Updating, + Updating: "Updating", @doc("Resource is Deleting.") - Deleting, + Deleting: "Deleting", @doc("Resource has been Accepted.") - Accepted, + Accepted: "Accepted", } @doc("Defines the Docker image details") @@ -122,12 +125,14 @@ model SanForCert { } @doc("Mqtt Protocol types") -enum MqttProtocol { +union MqttProtocol { + string, + @doc("Mqttv3") - v3, + "v3", @doc("Mqttv5") - v5, + "v5", } @doc("Mqtt Local Broker ConnectionSpec details") diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/datalakeconnector.tsp b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/datalakeconnector.tsp index 64c57dc39f59..7620bdc27dba 100644 --- a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/datalakeconnector.tsp +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/datalakeconnector.tsp @@ -69,12 +69,14 @@ model DataLakeConnectorProperties { } @doc("DataLake possible database formats") -enum DataLakeDatabaseFormat { +union DataLakeDatabaseFormat { + string, + @doc("Delta format.") - delta, + "delta", @doc("Parquet format.") - parquet, + "parquet", } // GENERATION FIX TEMP - add "minProperties": 1 and "maxProperties": 1 to this property after creation. @@ -142,12 +144,14 @@ model DataLakeFabricStorageAuthentication { // Add Fabric path type @doc("Fabric path type to use.") -enum FabricPathType { +union FabricPathType { + string, + @doc("Fabric path type is Files.") - files, + "files", @doc("Fabric path type is Tables.") - tables, + "tables", } // Add Fabric one lake guids @@ -264,49 +268,51 @@ model DeltaTableSchema { } @doc("Delta table format properties") -enum DeltaTableFormatEnum { +union DeltaTableFormatEnum { + string, + @doc("Bool format") - boolean, + "boolean", @doc("Signed integer 8") - int8, + "int8", @doc("Signed integer 16") - int16, + "int16", @doc("Signed integer 32") - int32, + "int32", @doc("Unsigned integer 8") - uInt8, + "uInt8", @doc("Unsigned integer 16") - uInt16, + "uInt16", @doc("Unsigned integer 32") - uInt32, + "uInt32", @doc("Unsigned integer 64") - uInt64, + "uInt64", @doc("Float 16") - float16, + "float16", @doc("Float 32") - float32, + "float32", @doc("Float 64") - float64, + "float64", @doc("Date 32") - date32, + "date32", @doc("Date 64") - date64, + "date64", @doc("Binary data") - binary, + "binary", @doc("UTF8 format") - utf8, + "utf8", } diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/kafkaconnector.tsp b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/kafkaconnector.tsp index 468ba5e83395..d13102fd799e 100644 --- a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/kafkaconnector.tsp +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/kafkaconnector.tsp @@ -110,15 +110,17 @@ model SaslRemoteBrokerBasicAuthentication { // Add KafkaSaslType properties. @doc("Kafka Sasl Authentication types") -enum KafkaSaslType { +union KafkaSaslType { + string, + @doc("Sasl Plain authentication.") - plain, + "plain", @doc("Sasl ScramSha256 authentication.") - scramSha256, + "scramSha256", @doc("Sasl ScramSha512 authentication.") - scramSha512, + "scramSha512", } // Add SaslRemoteBrokerBasicAuthenticationToken properties. @@ -237,34 +239,38 @@ model KafkaTopicMapBatching { // Add Kafka Message compression @doc("Kafka Message compression enum properties") -enum KafkaMessageCompressionType { +union KafkaMessageCompressionType { + string, + @doc("No Kafka message compression.") - none, + none: "none", @doc("Gzip Kafka message compression.") - gzip, + gzip: "gzip", @doc("Snappy Kafka message compression.") - snappy, + snappy: "snappy", @doc("Lz4 Kafka message compression.") - lz4, + lz4: "lz4", } // Add Kafka Partition Strategy @doc("Kafka Partition Strategy enum properties") -enum KafkaPartitionStrategy { +union KafkaPartitionStrategy { + string, + @doc("Default partition strategy.") - default, + default: "default", @doc("Static partition strategy.") - static, + static: "static", @doc("Topic partition strategy.") - topic, + topic: "topic", @doc("Property partition strategy.") - property, + property: "property", } // Add Kafka Routes properties. @@ -324,15 +330,17 @@ model MqttToKafkaRoutes { // Add KafkaAcks properties. @doc("Kafka Acks enum properties") -enum KafkaAcks { +union KafkaAcks { + string, + @doc("Kafka acks zero.") - zero, + "zero", @doc("Kafka acks one.") - one, + "one", @doc("Kafka acks all.") - all, + "all", } // Add SharedSubscriptionProperties properties. diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/mqttbridgeconnector.tsp b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/mqttbridgeconnector.tsp index a14ef5900c1d..6b1524d3f235 100644 --- a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/mqttbridgeconnector.tsp +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/mqttbridgeconnector.tsp @@ -83,12 +83,14 @@ model MqttBridgeRemoteBrokerConnectionSpec { } @doc("Protocol for remote connection.") -enum MqttBridgeRemoteBrokerProtocol { +union MqttBridgeRemoteBrokerProtocol { + string, + @doc("MQTT protocol.") - mqtt, + mqtt: "mqtt", @doc("MQTT over WebSocket protocol.") - webSocket, + webSocket: "webSocket", } // GENERATION FIX TEMP - add "minProperties": 1 and "maxProperties": 1 to this property after creation. @@ -179,7 +181,9 @@ model MqttBridgeRoutes { } @doc("MqttBridgeRoute direction properties") -enum MqttBridgeRouteDirection { +union MqttBridgeRouteDirection { + string, + @doc("Remote to Local Broker.") RemoteToLocal: "remote-to-local", diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/mqttbroker.tsp b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/mqttbroker.tsp index 3245e4cc0de0..650a53925200 100644 --- a/specification/iotoperationsmq/IoTOperationsMQ.Management/models/mqttbroker.tsp +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/models/mqttbroker.tsp @@ -337,27 +337,31 @@ model VolumeClaimSpecSelectorMatchExpressions { } @doc("The enum defining run mode of the broker deployment") -enum RunMode { +union RunMode { + string, + @doc("Automatically provision Frontend and Backend pods.") - auto, + "auto", @doc("Use Cardinality to set Frontend and Backend pods.") - distributed, + "distributed", } @doc("The memory profile settings of the Broker") -enum BrokerMemoryProfile { +union BrokerMemoryProfile { + string, + @doc("Tiny memory profile.") - tiny, + tiny: "tiny", @doc("Low memory profile.") - low, + low: "low", @doc("Medium memory profile.") - medium, + medium: "medium", @doc("High memory profile.") - high, + high: "high", } /** ******************* */ @@ -419,15 +423,17 @@ model BrokerListenerProperties { } @doc("Kubernetes Service Types supported by Listener") -enum ServiceType { +union ServiceType { + string, + @doc("Cluster IP Service.") - clusterIp, + clusterIp: "clusterIp", @doc("Load Balancer Service.") - loadBalancer, + loadBalancer: "loadBalancer", @doc("Node Port Service.") - nodePort, + nodePort: "nodePort", } @doc("Collection of different TLS types, NOTE- Enum at a time only one of them needs to be supported") @@ -688,13 +694,15 @@ model ResourceInfoDefinition { } @doc("ResourceInfoDefinition methods allowed") -enum ResourceInfoDefinitionMethods { +union ResourceInfoDefinitionMethods { + string, + @doc("Allowed Connecting to Broker") - Connect, + "Connect", @doc("Allowed Publishing to Broker") - Publish, + "Publish", @doc("Allowed Subscribing to Broker") - Subscribe, + "Subscribe", } diff --git a/specification/iotoperationsmq/resource-manager/Microsoft.IoTOperationsMQ/preview/2023-10-04-preview/iotoperationsmq.json b/specification/iotoperationsmq/resource-manager/Microsoft.IoTOperationsMQ/preview/2023-10-04-preview/iotoperationsmq.json index 60b1911f7f46..f1161e4262b4 100644 --- a/specification/iotoperationsmq/resource-manager/Microsoft.IoTOperationsMQ/preview/2023-10-04-preview/iotoperationsmq.json +++ b/specification/iotoperationsmq/resource-manager/Microsoft.IoTOperationsMQ/preview/2023-10-04-preview/iotoperationsmq.json @@ -94,7 +94,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -133,7 +133,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MqResourceListResult" } @@ -175,7 +175,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MqResourceListResult" } @@ -225,7 +225,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MqResource" } @@ -350,7 +350,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MqResource" } @@ -409,7 +409,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -457,7 +457,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BrokerResourceListResult" } @@ -515,7 +515,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BrokerResource" } @@ -656,7 +656,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BrokerResource" } @@ -723,7 +723,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -779,7 +779,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BrokerAuthenticationResourceListResult" } @@ -845,7 +845,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BrokerAuthenticationResource" } @@ -1002,7 +1002,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BrokerAuthenticationResource" } @@ -1077,7 +1077,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -1133,7 +1133,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BrokerAuthorizationResourceListResult" } @@ -1199,7 +1199,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BrokerAuthorizationResource" } @@ -1356,7 +1356,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BrokerAuthorizationResource" } @@ -1431,7 +1431,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -1487,7 +1487,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BrokerListenerResourceListResult" } @@ -1553,7 +1553,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BrokerListenerResource" } @@ -1710,7 +1710,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BrokerListenerResource" } @@ -1785,7 +1785,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -1833,7 +1833,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataLakeConnectorResourceListResult" } @@ -1891,7 +1891,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataLakeConnectorResource" } @@ -2032,7 +2032,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataLakeConnectorResource" } @@ -2099,7 +2099,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -2155,7 +2155,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataLakeTopicMapResourceListResult" } @@ -2221,7 +2221,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataLakeTopicMapResource" } @@ -2378,7 +2378,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataLakeTopicMapResource" } @@ -2453,7 +2453,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -2501,7 +2501,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DiagnosticServiceResourceListResult" } @@ -2559,7 +2559,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DiagnosticServiceResource" } @@ -2700,7 +2700,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DiagnosticServiceResource" } @@ -2767,7 +2767,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -2815,7 +2815,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/KafkaConnectorResourceListResult" } @@ -2873,7 +2873,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/KafkaConnectorResource" } @@ -3014,7 +3014,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/KafkaConnectorResource" } @@ -3081,7 +3081,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -3137,7 +3137,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/KafkaTopicMapResourceListResult" } @@ -3203,7 +3203,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/KafkaTopicMapResource" } @@ -3360,7 +3360,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/KafkaTopicMapResource" } @@ -3435,7 +3435,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -3483,7 +3483,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MqttBridgeConnectorResourceListResult" } @@ -3541,7 +3541,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MqttBridgeConnectorResource" } @@ -3682,7 +3682,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MqttBridgeConnectorResource" } @@ -3749,7 +3749,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -3805,7 +3805,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MqttBridgeTopicMapResourceListResult" } @@ -3871,7 +3871,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MqttBridgeTopicMapResource" } @@ -4028,7 +4028,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MqttBridgeTopicMapResource" } @@ -4103,7 +4103,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -4891,9 +4891,35 @@ "default": "aio-mq-dmqtt-frontend" }, "serviceType": { - "$ref": "#/definitions/ServiceType", + "type": "string", "description": "The Kubernetes Service type to deploy for Listener.", - "default": "clusterIp" + "default": "clusterIp", + "enum": [ + "clusterIp", + "loadBalancer", + "nodePort" + ], + "x-ms-enum": { + "name": "ServiceType", + "modelAsString": true, + "values": [ + { + "name": "clusterIp", + "value": "clusterIp", + "description": "Cluster IP Service." + }, + { + "name": "loadBalancer", + "value": "loadBalancer", + "description": "Load Balancer Service." + }, + { + "name": "nodePort", + "value": "nodePort", + "description": "Node Port Service." + } + ] + } }, "tls": { "$ref": "#/definitions/TlsCertMethod", @@ -5017,9 +5043,35 @@ "default": "aio-mq-dmqtt-frontend" }, "serviceType": { - "$ref": "#/definitions/ServiceType", + "type": "string", "description": "The Kubernetes Service type to deploy for Listener.", - "default": "clusterIp" + "default": "clusterIp", + "enum": [ + "clusterIp", + "loadBalancer", + "nodePort" + ], + "x-ms-enum": { + "name": "ServiceType", + "modelAsString": true, + "values": [ + { + "name": "clusterIp", + "value": "clusterIp", + "description": "Cluster IP Service." + }, + { + "name": "loadBalancer", + "value": "loadBalancer", + "description": "Load Balancer Service." + }, + { + "name": "nodePort", + "value": "nodePort", + "description": "Node Port Service." + } + ] + } }, "tls": { "$ref": "#/definitions/TlsCertMethodUpdate", @@ -5109,9 +5161,41 @@ "description": "Details of the internal CA cert that will be used to secure communication between pods." }, "memoryProfile": { - "$ref": "#/definitions/BrokerMemoryProfile", + "type": "string", "description": "Memory profile of broker.", - "default": "medium" + "default": "medium", + "enum": [ + "tiny", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "BrokerMemoryProfile", + "modelAsString": true, + "values": [ + { + "name": "tiny", + "value": "tiny", + "description": "Tiny memory profile." + }, + { + "name": "low", + "value": "low", + "description": "Low memory profile." + }, + { + "name": "medium", + "value": "medium", + "description": "Medium memory profile." + }, + { + "name": "high", + "value": "high", + "description": "High memory profile." + } + ] + } }, "mode": { "$ref": "#/definitions/RunMode", @@ -5245,9 +5329,41 @@ "description": "Details of the internal CA cert that will be used to secure communication between pods." }, "memoryProfile": { - "$ref": "#/definitions/BrokerMemoryProfile", + "type": "string", "description": "Memory profile of broker.", - "default": "medium" + "default": "medium", + "enum": [ + "tiny", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "BrokerMemoryProfile", + "modelAsString": true, + "values": [ + { + "name": "tiny", + "value": "tiny", + "description": "Tiny memory profile." + }, + { + "name": "low", + "value": "low", + "description": "Low memory profile." + }, + { + "name": "medium", + "value": "medium", + "description": "Medium memory profile." + }, + { + "name": "high", + "value": "high", + "description": "High memory profile." + } + ] + } }, "mode": { "$ref": "#/definitions/RunMode", @@ -7224,9 +7340,41 @@ "description": "The batching settings for kafka messages." }, "compression": { - "$ref": "#/definitions/KafkaMessageCompressionType", + "type": "string", "description": "The compression to use for kafka messages.", - "default": "none" + "default": "none", + "enum": [ + "none", + "gzip", + "snappy", + "lz4" + ], + "x-ms-enum": { + "name": "KafkaMessageCompressionType", + "modelAsString": true, + "values": [ + { + "name": "none", + "value": "none", + "description": "No Kafka message compression." + }, + { + "name": "gzip", + "value": "gzip", + "description": "Gzip Kafka message compression." + }, + { + "name": "snappy", + "value": "snappy", + "description": "Snappy Kafka message compression." + }, + { + "name": "lz4", + "value": "lz4", + "description": "Lz4 Kafka message compression." + } + ] + } }, "copyMqttProperties": { "type": "string", @@ -7241,9 +7389,41 @@ "description": "The partition to use for Kafka." }, "partitionStrategy": { - "$ref": "#/definitions/KafkaPartitionStrategy", + "type": "string", "description": "The partition strategy to use for Kafka.", - "default": "default" + "default": "default", + "enum": [ + "default", + "static", + "topic", + "property" + ], + "x-ms-enum": { + "name": "KafkaPartitionStrategy", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "Default partition strategy." + }, + { + "name": "static", + "value": "static", + "description": "Static partition strategy." + }, + { + "name": "topic", + "value": "topic", + "description": "Topic partition strategy." + }, + { + "name": "property", + "value": "property", + "description": "Property partition strategy." + } + ] + } }, "routes": { "type": "array", @@ -7342,9 +7522,41 @@ "description": "The batching settings for kafka messages." }, "compression": { - "$ref": "#/definitions/KafkaMessageCompressionType", + "type": "string", "description": "The compression to use for kafka messages.", - "default": "none" + "default": "none", + "enum": [ + "none", + "gzip", + "snappy", + "lz4" + ], + "x-ms-enum": { + "name": "KafkaMessageCompressionType", + "modelAsString": true, + "values": [ + { + "name": "none", + "value": "none", + "description": "No Kafka message compression." + }, + { + "name": "gzip", + "value": "gzip", + "description": "Gzip Kafka message compression." + }, + { + "name": "snappy", + "value": "snappy", + "description": "Snappy Kafka message compression." + }, + { + "name": "lz4", + "value": "lz4", + "description": "Lz4 Kafka message compression." + } + ] + } }, "copyMqttProperties": { "type": "string", @@ -7359,9 +7571,41 @@ "description": "The partition to use for Kafka." }, "partitionStrategy": { - "$ref": "#/definitions/KafkaPartitionStrategy", + "type": "string", "description": "The partition strategy to use for Kafka.", - "default": "default" + "default": "default", + "enum": [ + "default", + "static", + "topic", + "property" + ], + "x-ms-enum": { + "name": "KafkaPartitionStrategy", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "Default partition strategy." + }, + { + "name": "static", + "value": "static", + "description": "Static partition strategy." + }, + { + "name": "topic", + "value": "topic", + "description": "Topic partition strategy." + }, + { + "name": "property", + "value": "property", + "description": "Property partition strategy." + } + ] + } }, "routes": { "type": "array", @@ -7986,9 +8230,29 @@ "description": "The endpoint of remote broker to connect to." }, "protocol": { - "$ref": "#/definitions/MqttBridgeRemoteBrokerProtocol", + "type": "string", "description": "Protocol for remote connection.", - "default": "mqtt" + "default": "mqtt", + "enum": [ + "mqtt", + "webSocket" + ], + "x-ms-enum": { + "name": "MqttBridgeRemoteBrokerProtocol", + "modelAsString": true, + "values": [ + { + "name": "mqtt", + "value": "mqtt", + "description": "MQTT protocol." + }, + { + "name": "webSocket", + "value": "webSocket", + "description": "MQTT over WebSocket protocol." + } + ] + } }, "tls": { "$ref": "#/definitions/MqttBridgeRemoteBrokerConnectionTls", @@ -8014,9 +8278,29 @@ "description": "The endpoint of remote broker to connect to." }, "protocol": { - "$ref": "#/definitions/MqttBridgeRemoteBrokerProtocol", + "type": "string", "description": "Protocol for remote connection.", - "default": "mqtt" + "default": "mqtt", + "enum": [ + "mqtt", + "webSocket" + ], + "x-ms-enum": { + "name": "MqttBridgeRemoteBrokerProtocol", + "modelAsString": true, + "values": [ + { + "name": "mqtt", + "value": "mqtt", + "description": "MQTT protocol." + }, + { + "name": "webSocket", + "value": "webSocket", + "description": "MQTT over WebSocket protocol." + } + ] + } }, "tls": { "$ref": "#/definitions/MqttBridgeRemoteBrokerConnectionTlsUpdate", diff --git a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/common.tsp b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/common.tsp index f33dedad5abe..d731307e4cb7 100644 --- a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/common.tsp +++ b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/common.tsp @@ -24,17 +24,18 @@ model ExtendedLocation { @lroStatus @doc("The provisioning status of the resource.") -enum ProvisioningState { - ...ResourceProvisioningState, +union ProvisioningState { + string, + ResourceProvisioningState, @doc("The resource is being updated.") - Reconciling, + Reconciling: "Reconciling", @doc("The resource is being deleted.") - Deleting, + Deleting: "Deleting", @doc("The resource was accepted by the server.") - Accepted, + Accepted: "Accepted", } #suppress "@azure-tools/typespec-azure-core/bad-record-type" "properties field is loosely defined and are dependent on customer scenarios" @@ -64,7 +65,9 @@ model ReconciliationPolicy { } @doc("Policies to control how the resource should reconcile.") -enum ReconciliationPolicies { +union ReconciliationPolicies { + string, + @doc("Allows resource to reconcile periodically.") periodic: "periodic", } diff --git a/specification/iotoperationsorchestrator/resource-manager/Microsoft.IoTOperationsOrchestrator/preview/2023-10-04-preview/openapi.json b/specification/iotoperationsorchestrator/resource-manager/Microsoft.IoTOperationsOrchestrator/preview/2023-10-04-preview/openapi.json index 27c7bcdd0f40..93da3bce89cf 100644 --- a/specification/iotoperationsorchestrator/resource-manager/Microsoft.IoTOperationsOrchestrator/preview/2023-10-04-preview/openapi.json +++ b/specification/iotoperationsorchestrator/resource-manager/Microsoft.IoTOperationsOrchestrator/preview/2023-10-04-preview/openapi.json @@ -67,7 +67,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -106,7 +106,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/InstanceListResult" } @@ -145,7 +145,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SolutionListResult" } @@ -184,7 +184,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TargetListResult" } @@ -226,7 +226,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/InstanceListResult" } @@ -276,7 +276,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Instance" } @@ -401,7 +401,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Instance" } @@ -460,7 +460,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -500,7 +500,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SolutionListResult" } @@ -550,7 +550,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Solution" } @@ -675,7 +675,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Solution" } @@ -734,7 +734,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -774,7 +774,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TargetListResult" } @@ -824,7 +824,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Target" } @@ -949,7 +949,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Target" } @@ -1008,7 +1008,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/backuprestore.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/backuprestore.json new file mode 100644 index 000000000000..a5571ccb976d --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/backuprestore.json @@ -0,0 +1,435 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultClient", + "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", + "version": "7.5" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{vaultBaseUrl}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "vaultBaseUrl", + "description": "The vault name, for example https://myvault.vault.azure.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/backup": { + "post": { + "tags": [ + "FullBackup" + ], + "operationId": "FullBackup", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Creates a full backup using a user-provided SAS token to an Azure blob storage container.", + "parameters": [ + { + "in": "body", + "name": "azureStorageBlobContainerUri", + "schema": { + "$ref": "#/definitions/SASTokenParameter" + }, + "description": "Azure blob shared access signature token pointing to a valid Azure blob container where full backup needs to be stored. This token needs to be valid for at least next 24 hours from the time of making this call" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Started full backup", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/FullBackupOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Create full backup": { + "$ref": "./examples/FullBackup-example.json" + } + } + } + }, + "/backup/{jobId}/pending": { + "get": { + "tags": [ + "FullBackup" + ], + "operationId": "FullBackupStatus", + "description": "Returns the status of full backup operation", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The id returned as part of the backup request" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the full backup status", + "schema": { + "$ref": "#/definitions/FullBackupOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Full backup status": { + "$ref": "./examples/FullBackup-pending-example.json" + } + } + } + }, + "/restore": { + "put": { + "tags": [ + "FullRestore" + ], + "operationId": "FullRestoreOperation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Restores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup folder", + "parameters": [ + { + "name": "restoreBlobDetails", + "in": "body", + "schema": { + "$ref": "#/definitions/RestoreOperationParameters" + }, + "description": "The Azure blob SAS token pointing to a folder where the previous successful full backup was stored" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Started restore operation from the previously stored backup", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/RestoreOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Create full restore from backup": { + "$ref": "./examples/FullRestore-example.json" + } + } + } + }, + "/restore/{jobId}/pending": { + "get": { + "tags": [ + "FullRestore" + ], + "operationId": "RestoreStatus", + "description": "Returns the status of restore operation", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The Job Id returned part of the restore operation" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the full restore status", + "schema": { + "$ref": "#/definitions/RestoreOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Restore status": { + "$ref": "./examples/Restore-pending-example.json" + } + } + } + }, + "/keys/{keyName}/restore": { + "put": { + "tags": [ + "Keys" + ], + "operationId": "SelectiveKeyRestoreOperation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Restores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure Blob storage backup folder", + "parameters": [ + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key to be restored from the user supplied backup" + }, + { + "name": "restoreBlobDetails", + "in": "body", + "schema": { + "$ref": "#/definitions/SelectiveKeyRestoreOperationParameters" + }, + "description": "The Azure blob SAS token pointing to a folder where the previous successful full backup was stored" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Started selective key restore operation from the previously stored backup", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SelectiveKeyRestoreOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Selectively restore key from a backup": { + "$ref": "./examples/SelectiveRestore-example.json" + } + } + } + } + }, + "definitions": { + "RestoreOperationParameters": { + "properties": { + "sasTokenParameters": { + "$ref": "#/definitions/SASTokenParameter" + }, + "folderToRestore": { + "type": "string", + "description": "The Folder name of the blob where the previous successful full backup was stored" + } + }, + "required": [ + "folderToRestore", + "sasTokenParameters" + ] + }, + "SelectiveKeyRestoreOperationParameters": { + "properties": { + "sasTokenParameters": { + "$ref": "#/definitions/SASTokenParameter" + }, + "folder": { + "type": "string", + "description": "The Folder name of the blob where the previous successful full backup was stored" + } + }, + "required": [ + "folder", + "sasTokenParameters" + ] + }, + "SelectiveKeyRestoreOperation": { + "properties": { + "status": { + "type": "string", + "description": "Status of the restore operation." + }, + "statusDetails": { + "type": "string", + "description": "The status details of restore operation." + }, + "error": { + "$ref": "common.json#/definitions/Error", + "description": "Error encountered, if any, during the selective key restore operation." + }, + "jobId": { + "type": "string", + "description": "Identifier for the selective key restore operation." + }, + "startTime": { + "type": "integer", + "format": "unixtime", + "description": "The start time of the restore operation" + }, + "endTime": { + "type": "integer", + "format": "unixtime", + "description": "The end time of the restore operation", + "x-nullable": true + } + }, + "description": "Selective Key Restore operation" + }, + "SASTokenParameter": { + "properties": { + "storageResourceUri": { + "type": "string", + "description": "Azure Blob storage container Uri" + }, + "token": { + "type": "string", + "description": "The SAS token pointing to an Azure Blob storage container" + }, + "useManagedIdentity": { + "type": "boolean", + "default": false, + "description": "Indicates which authentication method should be used. If set to true, Managed HSM will use the configured user-assigned managed identity to authenticate with Azure Storage. Otherwise, a SAS token has to be specified." + } + }, + "required": [ + "storageResourceUri" + ] + }, + "FullBackupOperation": { + "properties": { + "status": { + "type": "string", + "description": "Status of the backup operation." + }, + "statusDetails": { + "type": "string", + "description": "The status details of backup operation." + }, + "error": { + "$ref": "common.json#/definitions/Error", + "description": "Error encountered, if any, during the full backup operation." + }, + "startTime": { + "type": "integer", + "format": "unixtime", + "description": "The start time of the backup operation in UTC" + }, + "endTime": { + "type": "integer", + "format": "unixtime", + "description": "The end time of the backup operation in UTC", + "x-nullable": true + }, + "jobId": { + "type": "string", + "description": "Identifier for the full backup operation." + }, + "azureStorageBlobContainerUri": { + "type": "string", + "description": "The Azure blob storage container Uri which contains the full backup" + } + }, + "description": "Full backup operation" + }, + "RestoreOperation": { + "properties": { + "status": { + "type": "string", + "description": "Status of the restore operation." + }, + "statusDetails": { + "type": "string", + "description": "The status details of restore operation." + }, + "error": { + "$ref": "common.json#/definitions/Error", + "description": "Error encountered, if any, during the restore operation." + }, + "jobId": { + "type": "string", + "description": "Identifier for the restore operation." + }, + "startTime": { + "type": "integer", + "format": "unixtime", + "description": "The start time of the restore operation" + }, + "endTime": { + "type": "integer", + "format": "unixtime", + "description": "The end time of the restore operation", + "x-nullable": true + } + }, + "description": "Restore operation" + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/certificates.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/certificates.json new file mode 100644 index 000000000000..1a69c7a9aa91 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/certificates.json @@ -0,0 +1,2075 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultClient", + "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", + "version": "7.5" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{vaultBaseUrl}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "vaultBaseUrl", + "description": "The vault name, for example https://myvault.vault.azure.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/certificates": { + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificates", + "summary": "List certificates in a specified key vault", + "description": "The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "name": "includePending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Specifies whether to include certificates which are not completely provisioned." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of certificates along with a link to the next page of certificates.", + "schema": { + "$ref": "#/definitions/CertificateListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetCertificates": { + "$ref": "./examples/GetCertificates-example.json" + } + } + } + }, + "/certificates/{certificate-name}": { + "delete": { + "tags": [ + "Certificates" + ], + "operationId": "DeleteCertificate", + "summary": "Deletes a certificate from a specified key vault.", + "description": "Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted certificate.", + "schema": { + "$ref": "#/definitions/DeletedCertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "DeleteCertificate": { + "$ref": "./examples/DeleteCertificate-example.json" + } + } + } + }, + "/certificates/contacts": { + "put": { + "tags": [ + "Certificates" + ], + "operationId": "SetCertificateContacts", + "description": "Sets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.", + "summary": "Sets the certificate contacts for the specified key vault.", + "parameters": [ + { + "name": "contacts", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Contacts" + }, + "description": "The contacts for the key vault certificate." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The contacts for the key vault certificate.", + "schema": { + "$ref": "#/definitions/Contacts" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "SetCertificateContacts": { + "$ref": "./examples/SetCertificateContacts-example.json" + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificateContacts", + "summary": "Lists the certificate contacts for a specified key vault.", + "description": "The GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the certificates/managecontacts permission.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The contacts for the key vault certificate.", + "schema": { + "$ref": "#/definitions/Contacts" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetCertificateContacts": { + "$ref": "./examples/GetCertificateContacts-example.json" + } + } + }, + "delete": { + "tags": [ + "Certificates" + ], + "operationId": "DeleteCertificateContacts", + "description": "Deletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission.", + "summary": "Deletes the certificate contacts for a specified key vault.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The contacts for the key vault certificate.", + "schema": { + "$ref": "#/definitions/Contacts" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "DeleteCertificateContacts": { + "$ref": "./examples/DeleteCertificateContacts-example.json" + } + } + } + }, + "/certificates/issuers": { + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificateIssuers", + "summary": "List certificate issuers for a specified key vault.", + "description": "The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of certificate issuers in a key vault along with a link to the next page of certificate issuers.", + "schema": { + "$ref": "#/definitions/CertificateIssuerListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetCertificateIssuers": { + "$ref": "./examples/GetCertificateIssuers-example.json" + } + } + } + }, + "/certificates/issuers/{issuer-name}": { + "put": { + "tags": [ + "Certificates" + ], + "operationId": "SetCertificateIssuer", + "summary": "Sets the specified certificate issuer.", + "description": "The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.", + "parameters": [ + { + "name": "issuer-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the issuer. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information." + }, + { + "name": "parameter", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateIssuerSetParameters" + }, + "description": "Certificate issuer set parameter." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The issuer for the key vault certificate.", + "schema": { + "$ref": "#/definitions/IssuerBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "SetCertificateIssuer": { + "$ref": "./examples/SetCertificateIssuer-example.json" + } + } + }, + "patch": { + "tags": [ + "Certificates" + ], + "operationId": "UpdateCertificateIssuer", + "summary": "Updates the specified certificate issuer.", + "description": "The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission.", + "parameters": [ + { + "name": "issuer-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the issuer." + }, + { + "name": "parameter", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateIssuerUpdateParameters" + }, + "description": "Certificate issuer update parameter." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The issuer for the key vault certificate.", + "schema": { + "$ref": "#/definitions/IssuerBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "UpdateCertificateIssuer": { + "$ref": "./examples/UpdateCertificateIssuer-example.json" + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificateIssuer", + "summary": "Lists the specified certificate issuer.", + "description": "The GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.", + "parameters": [ + { + "name": "issuer-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the issuer." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The issuer for the key vault certificate.", + "schema": { + "$ref": "#/definitions/IssuerBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetCertificateIssuer": { + "$ref": "./examples/GetCertificateIssuer-example.json" + } + } + }, + "delete": { + "tags": [ + "Certificates" + ], + "operationId": "DeleteCertificateIssuer", + "summary": "Deletes the specified certificate issuer.", + "description": "The DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers permission.", + "parameters": [ + { + "name": "issuer-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the issuer." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The issuer for the key vault certificate.", + "schema": { + "$ref": "#/definitions/IssuerBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "DeleteCertificateIssuer": { + "$ref": "./examples/DeleteCertificateIssuer-example.json" + } + } + } + }, + "/certificates/{certificate-name}/create": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "CreateCertificate", + "summary": "Creates a new certificate.", + "description": "If this is the first version, the certificate resource is created. This operation requires the certificates/create permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z-]+$", + "description": "The name of the certificate. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateCreateParameters" + }, + "description": "The parameters to create a certificate." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Created certificate bundle.", + "schema": { + "$ref": "#/definitions/CertificateOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "CreateCertificate": { + "$ref": "./examples/CreateCertificate-example.json" + } + } + } + }, + "/certificates/{certificate-name}/import": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "ImportCertificate", + "summary": "Imports a certificate into a specified key vault.", + "description": "Imports an existing valid certificate, containing a private key, into Azure Key Vault. This operation requires the certificates/import permission. The certificate to be imported can be in either PFX or PEM format. If the certificate is in PEM format the PEM file must contain the key as well as x509 certificates. Key Vault will only accept a key in PKCS#8 format.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z-]+$", + "description": "The name of the certificate. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateImportParameters" + }, + "description": "The parameters to import the certificate." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Imported certificate bundle to the vault.", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "ImportCertificate": { + "$ref": "./examples/ImportCertificate-example.json" + } + } + } + }, + "/certificates/{certificate-name}/versions": { + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificateVersions", + "summary": "List the versions of a certificate.", + "description": "The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of certificates in the key vault along with a link to the next page of keys.", + "schema": { + "$ref": "#/definitions/CertificateListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetCertificateVersions": { + "$ref": "./examples/GetCertificateVersions-example.json" + } + } + } + }, + "/certificates/{certificate-name}/policy": { + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificatePolicy", + "summary": "Lists the policy for a certificate.", + "description": "The GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate in a given key vault." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The certificate policy.", + "schema": { + "$ref": "#/definitions/CertificatePolicy" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetCertificatePolicy": { + "$ref": "./examples/GetCertificatePolicy-example.json" + } + } + }, + "patch": { + "tags": [ + "Certificates" + ], + "operationId": "UpdateCertificatePolicy", + "summary": "Updates the policy for a certificate.", + "description": "Set specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate in the given vault." + }, + { + "name": "certificatePolicy", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertificatePolicy" + }, + "description": "The policy for the certificate." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The certificate policy", + "schema": { + "$ref": "#/definitions/CertificatePolicy" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "UpdateCertificatePolicy": { + "$ref": "./examples/UpdateCertificatePolicy-example.json" + } + } + } + }, + "/certificates/{certificate-name}/{certificate-version}": { + "patch": { + "tags": [ + "Certificates" + ], + "operationId": "UpdateCertificate", + "summary": "Updates the specified attributes associated with the given certificate.", + "description": "The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes. This operation requires the certificates/update permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate in the given key vault." + }, + { + "name": "certificate-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the certificate." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateUpdateParameters" + }, + "description": "The parameters for certificate update." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The updated certificate.", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "UpdateCertificate": { + "$ref": "./examples/UpdateCertificate-example.json" + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificate", + "summary": "Gets information about a certificate.", + "description": "Gets information about a specific certificate. This operation requires the certificates/get permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate in the given vault." + }, + { + "name": "certificate-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the certificate. This URI fragment is optional. If not specified, the latest version of the certificate is returned." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved certificate.", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetCertificate": { + "$ref": "./examples/GetCertificate-example.json" + } + } + } + }, + "/certificates/{certificate-name}/pending": { + "patch": { + "tags": [ + "Certificates" + ], + "operationId": "UpdateCertificateOperation", + "summary": "Updates a certificate operation.", + "description": "Updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "name": "certificateOperation", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateOperationUpdateParameter" + }, + "description": "The certificate operation response." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A message containing the certificate operation response.", + "schema": { + "$ref": "#/definitions/CertificateOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "UpdateCertificateOperation": { + "$ref": "./examples/UpdateCertificateOperation-example.json" + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificateOperation", + "summary": "Gets the creation operation of a certificate.", + "description": "Gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The certificate operation response.", + "schema": { + "$ref": "#/definitions/CertificateOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetCertificateOperation": { + "$ref": "./examples/GetCertificateOperation-example.json" + } + } + }, + "delete": { + "tags": [ + "Certificates" + ], + "operationId": "DeleteCertificateOperation", + "summary": "Deletes the creation operation for a specific certificate.", + "description": "Deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A message containing the certificate operation response.", + "schema": { + "$ref": "#/definitions/CertificateOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "DeleteCertificateOperation": { + "$ref": "./examples/DeleteCertificateOperation-example.json" + } + } + } + }, + "/certificates/{certificate-name}/pending/merge": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "MergeCertificate", + "summary": "Merges a certificate or a certificate chain with a key pair existing on the server.", + "description": "The MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation requires the certificates/create permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateMergeParameters" + }, + "description": "The parameters to merge certificate." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Merged certificate bundle to the vault.", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "MergeCertificate": { + "$ref": "./examples/MergeCertificate-example.json" + } + } + } + }, + "/certificates/{certificate-name}/backup": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "BackupCertificate", + "summary": "Backs up the specified certificate.", + "description": "Requests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires the certificates/backup permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The backup blob containing the backed up certificate.", + "schema": { + "$ref": "#/definitions/BackupCertificateResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "BackupCertificate": { + "$ref": "./examples/BackupCertificate-example.json" + } + } + } + }, + "/certificates/restore": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "RestoreCertificate", + "summary": "Restores a backed up certificate to a vault.", + "description": "Restores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateRestoreParameters" + }, + "description": "The parameters to restore the certificate." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Restored certificate bundle in the vault.", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RestoreCertificate": { + "$ref": "./examples/RestoreCertificate-example.json" + } + } + } + }, + "/deletedcertificates": { + "get": { + "tags": [ + "DeletedCertificates" + ], + "operationId": "GetDeletedCertificates", + "summary": "Lists the deleted certificates in the specified vault currently available for recovery.", + "description": "The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "name": "includePending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Specifies whether to include certificates which are not completely provisioned." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of deleted certificates in the vault along with a link to the next page of deleted certificates", + "schema": { + "$ref": "#/definitions/DeletedCertificateListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetDeletedCertificates": { + "$ref": "./examples/GetDeletedCertificates-example.json" + } + } + } + }, + "/deletedcertificates/{certificate-name}": { + "get": { + "tags": [ + "DeletedCertificates" + ], + "operationId": "GetDeletedCertificate", + "summary": "Retrieves information about the specified deleted certificate.", + "description": "The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the certificates/get permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A Certificate bundle of the certificate and its attributes", + "schema": { + "$ref": "#/definitions/DeletedCertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetDeletedCertificate": { + "$ref": "./examples/GetDeletedCertificate-example.json" + } + } + }, + "delete": { + "tags": [ + "DeletedCertificates" + ], + "operationId": "PurgeDeletedCertificate", + "summary": "Permanently deletes the specified deleted certificate.", + "description": "The PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify 'Purgeable'. This operation requires the certificate/purge permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No content signaling that the certificate was purged forever." + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "PurgeDeletedCertificate": { + "$ref": "./examples/PurgeDeletedCertificate-example.json" + } + } + } + }, + "/deletedcertificates/{certificate-name}/recover": { + "post": { + "tags": [ + "DeletedCertificates" + ], + "operationId": "RecoverDeletedCertificate", + "summary": "Recovers the deleted certificate back to its current version under /certificates.", + "description": "The RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must be issued during the retention interval (available in the deleted certificate's attributes). This operation requires the certificates/recover permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deleted certificate" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A Certificate bundle of the original certificate and its attributes", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RecoverDeletedCertificate": { + "$ref": "./examples/RecoverDeletedCertificate-example.json" + } + } + } + } + }, + "definitions": { + "CertificateAttributes": { + "allOf": [ + { + "$ref": "common.json#/definitions/Attributes" + } + ], + "properties": { + "recoverableDays": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0." + }, + "recoveryLevel": { + "type": "string", + "description": "Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system can purge the certificate, at the end of the retention interval.", + "enum": [ + "Purgeable", + "Recoverable+Purgeable", + "Recoverable", + "Recoverable+ProtectedSubscription", + "CustomizedRecoverable+Purgeable", + "CustomizedRecoverable", + "CustomizedRecoverable+ProtectedSubscription" + ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] + }, + "readOnly": true, + "x-nullable": false + } + }, + "description": "The certificate management attributes." + }, + "CertificateItem": { + "properties": { + "id": { + "type": "string", + "description": "Certificate identifier." + }, + "attributes": { + "$ref": "#/definitions/CertificateAttributes", + "description": "The certificate management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "x5t": { + "x-ms-client-name": "X509Thumbprint", + "type": "string", + "format": "base64url", + "description": "Thumbprint of the certificate." + } + }, + "description": "The certificate item containing certificate metadata." + }, + "CertificateIssuerItem": { + "properties": { + "id": { + "type": "string", + "description": "Certificate Identifier." + }, + "provider": { + "type": "string", + "description": "The issuer provider." + } + }, + "description": "The certificate issuer item containing certificate issuer metadata." + }, + "CertificateBundle": { + "properties": { + "id": { + "type": "string", + "description": "The certificate id.", + "readOnly": true + }, + "kid": { + "type": "string", + "description": "The key id.", + "readOnly": true + }, + "sid": { + "type": "string", + "description": "The secret id.", + "readOnly": true + }, + "x5t": { + "x-ms-client-name": "X509Thumbprint", + "type": "string", + "format": "base64url", + "description": "Thumbprint of the certificate.", + "readOnly": true + }, + "policy": { + "$ref": "#/definitions/CertificatePolicy", + "description": "The management policy.", + "readOnly": true + }, + "cer": { + "type": "string", + "format": "byte", + "description": "CER contents of x509 certificate." + }, + "contentType": { + "type": "string", + "description": "The content type of the secret. eg. 'application/x-pem-file' or 'application/x-pkcs12', " + }, + "attributes": { + "$ref": "#/definitions/CertificateAttributes", + "description": "The certificate attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs" + } + }, + "description": "A certificate bundle consists of a certificate (X509) plus its attributes." + }, + "DeletedCertificateBundle": { + "allOf": [ + { + "$ref": "#/definitions/CertificateBundle" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted certificate." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the certificate is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the certificate was deleted, in UTC" + } + }, + "description": "A Deleted Certificate consisting of its previous id, attributes and its tags, as well as information on when it will be purged." + }, + "DeletedCertificateItem": { + "allOf": [ + { + "$ref": "#/definitions/CertificateItem" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted certificate." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the certificate is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the certificate was deleted, in UTC" + } + }, + "description": "The deleted certificate item containing metadata about the deleted certificate." + }, + "CertificateOperation": { + "properties": { + "id": { + "type": "string", + "description": "The certificate id.", + "readOnly": true + }, + "issuer": { + "x-ms-client-name": "IssuerParameters", + "$ref": "#/definitions/IssuerParameters", + "description": "Parameters for the issuer of the X509 component of a certificate." + }, + "csr": { + "type": "string", + "format": "byte", + "description": "The certificate signing request (CSR) that is being used in the certificate operation." + }, + "cancellation_requested": { + "type": "boolean", + "description": "Indicates if cancellation was requested on the certificate operation." + }, + "status": { + "type": "string", + "description": "Status of the certificate operation." + }, + "status_details": { + "type": "string", + "description": "The status details of the certificate operation." + }, + "error": { + "$ref": "common.json#/definitions/Error", + "description": "Error encountered, if any, during the certificate operation." + }, + "target": { + "type": "string", + "description": "Location which contains the result of the certificate operation." + }, + "request_id": { + "type": "string", + "description": "Identifier for the certificate operation." + } + }, + "description": "A certificate operation is returned in case of asynchronous requests." + }, + "CertificatePolicy": { + "properties": { + "id": { + "type": "string", + "description": "The certificate id.", + "readOnly": true + }, + "key_props": { + "x-ms-client-name": "KeyProperties", + "$ref": "keys.json#/definitions/KeyProperties", + "description": "Properties of the key backing a certificate." + }, + "secret_props": { + "x-ms-client-name": "SecretProperties", + "$ref": "secrets.json#/definitions/SecretProperties", + "description": "Properties of the secret backing a certificate." + }, + "x509_props": { + "x-ms-client-name": "X509CertificateProperties", + "$ref": "#/definitions/X509CertificateProperties", + "description": "Properties of the X509 component of a certificate." + }, + "lifetime_actions": { + "type": "array", + "items": { + "$ref": "#/definitions/LifetimeAction" + }, + "description": "Actions that will be performed by Key Vault over the lifetime of a certificate." + }, + "issuer": { + "x-ms-client-name": "IssuerParameters", + "$ref": "#/definitions/IssuerParameters", + "description": "Parameters for the issuer of the X509 component of a certificate." + }, + "attributes": { + "$ref": "#/definitions/CertificateAttributes", + "description": "The certificate attributes." + } + }, + "description": "Management policy for a certificate." + }, + "X509CertificateProperties": { + "properties": { + "subject": { + "type": "string", + "description": "The subject name. Should be a valid X509 distinguished Name." + }, + "ekus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The enhanced key usage." + }, + "sans": { + "x-ms-client-name": "SubjectAlternativeNames", + "$ref": "#/definitions/SubjectAlternativeNames", + "description": "The subject alternative names." + }, + "key_usage": { + "type": "array", + "description": "Defines how the certificate's key may be used.", + "items": { + "type": "string", + "enum": [ + "digitalSignature", + "nonRepudiation", + "keyEncipherment", + "dataEncipherment", + "keyAgreement", + "keyCertSign", + "cRLSign", + "encipherOnly", + "decipherOnly" + ], + "x-ms-enum": { + "name": "KeyUsageType", + "modelAsString": true + } + } + }, + "validity_months": { + "x-ms-client-name": "ValidityInMonths", + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The duration that the certificate is valid in months." + } + }, + "description": "Properties of the X509 component of a certificate." + }, + "IssuerParameters": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referenced issuer object or reserved names; for example, 'Self' or 'Unknown'." + }, + "cty": { + "x-ms-client-name": "CertificateType", + "type": "string", + "description": "Certificate type as supported by the provider (optional); for example 'OV-SSL', 'EV-SSL'" + }, + "cert_transparency": { + "x-ms-client-name": "CertificateTransparency", + "type": "boolean", + "description": "Indicates if the certificates generated under this policy should be published to certificate transparency logs." + } + }, + "description": "Parameters for the issuer of the X509 component of a certificate." + }, + "LifetimeAction": { + "properties": { + "trigger": { + "$ref": "#/definitions/Trigger", + "description": "The condition that will execute the action." + }, + "action": { + "$ref": "#/definitions/Action", + "description": "The action that will be executed." + } + }, + "description": "Action and its trigger that will be performed by Key Vault over the lifetime of a certificate." + }, + "Action": { + "properties": { + "action_type": { + "type": "string", + "description": "The type of the action.", + "enum": [ + "EmailContacts", + "AutoRenew" + ], + "x-ms-enum": { + "name": "CertificatePolicyAction", + "modelAsString": false + } + } + }, + "description": "The action that will be executed." + }, + "Trigger": { + "properties": { + "lifetime_percentage": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 99, + "description": "Percentage of lifetime at which to trigger. Value should be between 1 and 99." + }, + "days_before_expiry": { + "type": "integer", + "format": "int32", + "description": "Days before expiry to attempt renewal. Value should be between 1 and validity_in_months multiplied by 27. If validity_in_months is 36, then value should be between 1 and 972 (36 * 27)." + } + }, + "description": "A condition to be satisfied for an action to be executed." + }, + "SubjectAlternativeNames": { + "properties": { + "emails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Email addresses." + }, + "dns_names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Domain names." + }, + "upns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "User principal names." + } + }, + "description": "The subject alternate names of a X509 object." + }, + "IssuerBundle": { + "properties": { + "id": { + "type": "string", + "description": "Identifier for the issuer object.", + "readOnly": true + }, + "provider": { + "type": "string", + "description": "The issuer provider." + }, + "credentials": { + "$ref": "#/definitions/IssuerCredentials", + "description": "The credentials to be used for the issuer." + }, + "org_details": { + "x-ms-client-name": "OrganizationDetails", + "$ref": "#/definitions/OrganizationDetails", + "description": "Details of the organization as provided to the issuer." + }, + "attributes": { + "$ref": "#/definitions/IssuerAttributes", + "description": "Attributes of the issuer object." + } + }, + "description": "The issuer for Key Vault certificate." + }, + "IssuerAttributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether the issuer is enabled." + }, + "created": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Creation time in UTC." + }, + "updated": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Last updated time in UTC." + } + }, + "description": "The attributes of an issuer managed by the Key Vault service." + }, + "IssuerCredentials": { + "properties": { + "account_id": { + "type": "string", + "description": "The user name/account name/account id." + }, + "pwd": { + "x-ms-client-name": "Password", + "type": "string", + "description": "The password/secret/account key." + } + }, + "description": "The credentials to be used for the certificate issuer." + }, + "OrganizationDetails": { + "properties": { + "id": { + "type": "string", + "description": "Id of the organization." + }, + "admin_details": { + "type": "array", + "items": { + "$ref": "#/definitions/AdministratorDetails" + }, + "description": "Details of the organization administrator." + } + }, + "description": "Details of the organization of the certificate issuer." + }, + "AdministratorDetails": { + "properties": { + "first_name": { + "type": "string", + "description": "First name." + }, + "last_name": { + "type": "string", + "description": "Last name." + }, + "email": { + "x-ms-client-name": "EmailAddress", + "type": "string", + "description": "Email address." + }, + "phone": { + "type": "string", + "description": "Phone number." + } + }, + "description": "Details of the organization administrator of the certificate issuer." + }, + "Contacts": { + "properties": { + "id": { + "type": "string", + "description": "Identifier for the contacts collection.", + "readOnly": true + }, + "contacts": { + "x-ms-client-name": "ContactList", + "type": "array", + "items": { + "$ref": "#/definitions/Contact" + }, + "description": "The contact list for the vault certificates." + } + }, + "description": "The contacts for the vault certificates." + }, + "Contact": { + "properties": { + "email": { + "x-ms-client-name": "EmailAddress", + "type": "string", + "description": "Email address." + }, + "name": { + "type": "string", + "description": "Name." + }, + "phone": { + "type": "string", + "description": "Phone number." + } + }, + "description": "The contact information for the vault certificates." + }, + "CertificateCreateParameters": { + "properties": { + "policy": { + "x-ms-client-name": "CertificatePolicy", + "$ref": "#/definitions/CertificatePolicy", + "description": "The management policy for the certificate." + }, + "attributes": { + "x-ms-client-name": "CertificateAttributes", + "$ref": "#/definitions/CertificateAttributes", + "description": "The attributes of the certificate (optional)." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The certificate create parameters." + }, + "CertificateImportParameters": { + "properties": { + "value": { + "x-ms-client-name": "base64EncodedCertificate", + "type": "string", + "description": "Base64 encoded representation of the certificate object to import. This certificate needs to contain the private key." + }, + "pwd": { + "x-ms-client-name": "password", + "type": "string", + "description": "If the private key in base64EncodedCertificate is encrypted, the password used for encryption." + }, + "policy": { + "x-ms-client-name": "CertificatePolicy", + "$ref": "#/definitions/CertificatePolicy", + "description": "The management policy for the certificate." + }, + "attributes": { + "x-ms-client-name": "CertificateAttributes", + "$ref": "#/definitions/CertificateAttributes", + "description": "The attributes of the certificate (optional)." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The certificate import parameters.", + "required": [ + "value" + ] + }, + "CertificateUpdateParameters": { + "properties": { + "policy": { + "x-ms-client-name": "CertificatePolicy", + "$ref": "#/definitions/CertificatePolicy", + "description": "The management policy for the certificate." + }, + "attributes": { + "x-ms-client-name": "CertificateAttributes", + "$ref": "#/definitions/CertificateAttributes", + "description": "The attributes of the certificate (optional)." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The certificate update parameters." + }, + "CertificateMergeParameters": { + "properties": { + "x5c": { + "x-ms-client-name": "x509Certificates", + "type": "array", + "items": { + "type": "string", + "format": "byte" + }, + "description": "The certificate or the certificate chain to merge." + }, + "attributes": { + "x-ms-client-name": "CertificateAttributes", + "$ref": "#/definitions/CertificateAttributes", + "description": "The attributes of the certificate (optional)." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The certificate merge parameters", + "required": [ + "x5c" + ] + }, + "CertificateIssuerSetParameters": { + "properties": { + "provider": { + "type": "string", + "description": "The issuer provider." + }, + "credentials": { + "$ref": "#/definitions/IssuerCredentials", + "description": "The credentials to be used for the issuer." + }, + "org_details": { + "x-ms-client-name": "OrganizationDetails", + "$ref": "#/definitions/OrganizationDetails", + "description": "Details of the organization as provided to the issuer." + }, + "attributes": { + "$ref": "#/definitions/IssuerAttributes", + "description": "Attributes of the issuer object." + } + }, + "description": "The certificate issuer set parameters.", + "required": [ + "provider" + ] + }, + "CertificateIssuerUpdateParameters": { + "properties": { + "provider": { + "type": "string", + "description": "The issuer provider." + }, + "credentials": { + "$ref": "#/definitions/IssuerCredentials", + "description": "The credentials to be used for the issuer." + }, + "org_details": { + "x-ms-client-name": "OrganizationDetails", + "$ref": "#/definitions/OrganizationDetails", + "description": "Details of the organization as provided to the issuer." + }, + "attributes": { + "$ref": "#/definitions/IssuerAttributes", + "description": "Attributes of the issuer object." + } + }, + "description": "The certificate issuer update parameters." + }, + "CertificateOperationUpdateParameter": { + "properties": { + "cancellation_requested": { + "type": "boolean", + "description": "Indicates if cancellation was requested on the certificate operation." + } + }, + "description": "The certificate operation update parameters.", + "required": [ + "cancellation_requested" + ] + }, + "CertificateListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateItem" + }, + "readOnly": true, + "description": "A response message containing a list of certificates in the key vault along with a link to the next page of certificates." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of certificates." + } + }, + "description": "The certificate list result." + }, + "DeletedCertificateListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedCertificateItem" + }, + "readOnly": true, + "description": "A response message containing a list of deleted certificates in the vault along with a link to the next page of deleted certificates" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of deleted certificates." + } + }, + "description": "A list of certificates that have been deleted in this vault." + }, + "CertificateIssuerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateIssuerItem" + }, + "readOnly": true, + "description": "A response message containing a list of certificate issuers in the key vault along with a link to the next page of certificate issuers." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of certificate issuers." + } + }, + "description": "The certificate issuer list result." + }, + "PendingCertificateSigningRequestResult": { + "properties": { + "value": { + "type": "string", + "readOnly": true, + "description": "The pending certificate signing request as Base64 encoded string." + } + }, + "description": "The pending certificate signing request result." + }, + "CertificateRestoreParameters": { + "properties": { + "value": { + "type": "string", + "x-ms-client-name": "certificateBundleBackup", + "format": "base64url", + "description": "The backup blob associated with a certificate bundle." + } + }, + "description": "The certificate restore parameters.", + "required": [ + "value" + ] + }, + "BackupCertificateResult": { + "properties": { + "value": { + "type": "string", + "format": "base64url", + "readOnly": true, + "description": "The backup blob containing the backed up certificate." + } + }, + "description": "The backup certificate result, containing the backup blob." + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/common.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/common.json new file mode 100644 index 000000000000..388264c18b6f --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/common.json @@ -0,0 +1,84 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultClient", + "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", + "version": "7.5" + }, + "paths": {}, + "definitions": { + "Attributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether the object is enabled." + }, + "nbf": { + "x-ms-client-name": "NotBefore", + "type": "integer", + "format": "unixtime", + "description": "Not before date in UTC." + }, + "exp": { + "x-ms-client-name": "Expires", + "type": "integer", + "format": "unixtime", + "description": "Expiry date in UTC." + }, + "created": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Creation time in UTC." + }, + "updated": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Last updated time in UTC." + } + }, + "description": "The object attributes managed by the KeyVault service." + }, + "KeyVaultError": { + "properties": { + "error": { + "readOnly": true, + "$ref": "#/definitions/Error" + } + }, + "description": "The key vault error exception." + }, + "Error": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The error message." + }, + "innererror": { + "x-ms-client-name": "innerError", + "readOnly": true, + "$ref": "#/definitions/Error" + } + }, + "description": "The key vault server error.", + "x-nullable": true + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/BackupCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/BackupCertificate-example.json new file mode 100644 index 000000000000..fc194adfaca3 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/BackupCertificate-example.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "testcert", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "value": "JkF6dXJlS2V5VmF1bHRLZXlCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUkwTXpnMVlqQTNZaTFrTlRRM0xUUXlaVFV0WVdVNVpTMDJNVEJrWXpNNVpHWmhaamdpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLm85bmpNWEFSZWVla2NaRXBsVTNjdUxQcVZlWmxFbGRDM01XOWpYR0h6bnBXRTdHRGVOSXJraGZscHdTWXFnQnBYQkozMFpUQkRpRmpROENXSnJfUGlsUWNDRkZyN0xrdWJhWUs0TW1zcVh5WGIzbkRJcUJkQmZIUVNpZ1ZET0J5Ym9sUlRNNDYzYjBTbXhLVzJheEdFS2NuZzQ5WFkycG1SR0Vrb0plcHJWZ0tyRkpOUGQ3cGJIS3hQSWdDOFlnT2xudnZxR280RlRDSzh0ZWotcUt2UzBfRGV6Uk5vdTZqZ25SekpxX0g2NGxWMk1hQ0NnUy0xbTlyOGVOTVVvSlhTV1hwc0lneng1RzdEbzIya1ZEY25vMW9rajlCMXNvbklkWmtuY1JybDJBVHNRZVlzZXdkUVd1VmhxRzVLN0pNQWo5YzBRdkxhTmlpdl9PY2pFcm5qUS4zbmI4azJ3SEcyNHFJelNNb184WG13LnJzc3NMNjJ1aUNfTm9IbG5zQlgzcEEtck1uY3g5R3V2NmJYSHpKamxwOWNMUnVaSDBSWlJYVXRwU3BPQWdyZ20tU3BxeEdWSjd2bmprbV9FSzJwYy1sZHNjUWtRSDB4bVFVcGZFNzN5b1VTYTNXVVNMS2VIVnJLdUg5MUtJR0tLODE5ejc5d1Y5Y0F3UjlzcHJxbFFWZnlKdlNFM2tnZTh1RVBpRFFVMFl5WnJqVjBsMGJCU3VkeTN1MVlsVHB6Wk1EWmpUcE05ZGtMclgtaGdxZ1FGa2xFa1hNRWlzd0RDZVM3Y3J2bFg1bnVzbWh5SkZCMklCd3dxNWJieHptV1diU3JOc3lFMmJmWEpXOWN4TFlQcnJJZFpfbkd0X29RSGVQcUFZTS1iVnpTdzdBRGJjMU15NTZwclBGLW9PSm40MHptOTBaaFBTVGMyQXNKRGFBa3R5WFU4WktOYUhFVUlHLWI1SGhUdFBuZ20wN0FrWEtQNngwaDhzZ3ZIaGdCeGpfdWRfQVpQc3pLWG1HdUhFTW9lRGhpT3NkQVdRR0pwR2t0NHVlbmZyamNSeXVlaXJiTC1RV3o4MEtZUnk1QklxbzVJc19RVHpWN2dqMGstYS0td24tazNsNTJ4YjhaNkRXd2tWZ3hqUlNXOXZnV0pVd2U5M1ZrVWtHM3NLRW5SOE9ueTNjWlhQVl9LbWtBTEdlR0ZzQm53SmQwY3dueTBCN2I5VWQyQ19kWEZ0N1BvbnFVNldfT016cC1Nb1NtRzRHbEFpUkVfQ3FrWlhkalhIMVItSmpObUNfdXlPUTdaN1BVaDAtNmd2YUxpcE1CamlWR1FwdzlEZDhmVmtCbWk4VW5uOUxPYXJmSXVtcEJyUE43TTJhM05KdjN6b0NkanhZVFVUMTN1aElpYWl3aExoUFZhT2pUbFRmTkpqbHhIbG5lbGJ1RWJsZTk0bVV1bW8wcjhKRlFMSDdfRjhXMVo0OC1BcjhYYXJwMXhIY0FReHk1WWYwclktdUU1dTAyRnRHUHlPZ0JfNV9WdFlNR2VfRE1mdENLOGVMZGFnVllMRDJDNDUxTldZeVVfeHdNUWdQbXBaMWFnSEdCb2s0ejhsSFBndVhCQ3R2WFFuTHBXQTVBamdOLWNoWjNwUGJmc2RkNjBhekJuWDVaVXQza2hYaWNDdWk4b0xidEtzQUdmckNOZzFwT2Q0MHBHMEJlVy1lNVE1WWQydjY4eFh5a2RiTXhFblFCM3Fzd1djVlh1QXBIR18wREZVVmZvSlc2aVBZcDNWVE51amM5M3QtMDcxWnlZbUZ4V0RfVThMYTAtM19RLV8yZ0pwMVBaVV8tMVBRM1huLXdSWk1vb3JkZGZQa1VPZ0lqdWkwa1IwZWt5RjZvdWdLNnJrSVZHaGp3YUp0ekdKczJLdGxncnRCcEs2MXZEaE5zbFR5VHU5OUp2T2RFTXhwRG5lTEg4NnlvVnhxT3lIT3lxNjByXzdpTHgtdy03Q3FzWTloT3dmQlBZZ3BQVlM2bm9oZVBocTkwaGJTX0lrM21YbnRkRUNMREtSMi1wWFh6bjlPRjZIN09EdHB4S0VXQkdCaHJ0Ykxmd2JZS3dmWmZSVTJVUHpkLUxFd1lQdDloU203Z3lSODNoYkZiSFNBV1cySncxRWl1c3FURWRsRW1lQ3k2cFp1MVFZWko0TUQ0OG5rVXMwdmVHUVhTU2Ytb2RhQm1fYjZZdVh1cWcyWk03MlZjUTd4ZzV4MmpFenFqcllmdjdTTGJINFZBcWp0aFg5LUdRaWEwWEZaS18xempIenhkd1B0R2lSOHJfMkFFZTgtRXFoNi1FaTZKdjRFZjYyMnRrNWFJUWx3R1pETWpGSVNuUkpRdV8xcnJiY1E3enZsbWhUSWFQcUJNRFVxeHBEOXNWUlhuSHdIaTl1b1BCUTllbWJIMkV5WDV6MEhWRXlDa1JEbUd3cmR2RGdsOFVzMUhURjVwYXlYZmF2WkZUZjl3WFZyQXpsRFBEQkFJVFMzWnVJMEJWR2pJUGV1SnRiako4S1pTczRFQVNRRTVyVjViTUpNQXcwa19nYkVRTEZGSjJVb0ZzcWU1QUszM2xGXzR5cGMxU0JaWjJfUzYtbEQyNkpyRFVJSjFFRmJhbWtoUk12bWJIT1Utc0hDT0lRcHdadlJzV3Q3NExSQ1ZyQ09jMGpUdE5TT1JPUW5XRHVXRlFXSzk1TkRGMG96WjIyLVFEMU9YOE9iU3daaHdOXzNfS1pHRmtVMEhNdzNjSTI5LWUxbFltRDV3cmJ0ZlRFbllOeHJKOGpuUWFBY2FoNy14Q0JKeUQ3elo1MXIzRVVyY2VnazBzc1dLeHRPVjRLcTZENmxuVmU3bFpUT1dfTU5aZi1JSzJUbnZCaVZIMHk0SkVGaUxzSDJHbTM1d28yYlZVaXJsT1ljVEk1NlZhdDhMRWhGaEotVlUyNk84NHo2dUJFZmJucEZLbmdKc3pfYVlucW1zNWV1bmd3ek5ndjdlT0U0cUdKSURyMTRBUXRWdEYxcWdrZHNnVllWVXg4U29SQ0NobE5VUzRNRGxhc1hwS1VmV19ENWIxbDRkbXZiNEZNRHJqakJ6djk5dGJSeGZFYUVOSFlYTHZFZnJ0b0pMeW9na2tmNkxlbVoxVDZRbnRtNlR4S1IycU81WU1vMnRJZHlQNmZNRmkweEYtdE1IaHNSdVN3VEpybW1nREcteHVpZllVNkpfaElSNkMzVmo2VkFMMW1oZy0xeW1pRXZuanVLbElONzc4NmFWdVNpNmx5TjJJNzZqY0R6SHZ0VW1ibkVvWWtORHNPQXdqQk9MNFBlS0VjR1hWcm5YNDJhNW5IRWM2cmZQdjZ0Q2tVSUI0UldIdzEyUTFiNDM2N1JvRS1PTWN3TnV6ampob1M0S1ZJbHo4UEFMOW9YYTR4NXlQeG1aVzZ0UUVna1pKeFhEcS00SWRtd1UzTnpVZUoxdGpNaXFsc0xRWDdlc29fTHRtTWJ3bm83YkI3bjRlVnZ4aUtQU3p3dW94c25aaGs1b3ZSSE1xU0NtZjU2MjJvUTZvWEdmNUJLWExlQWdqaE1Sd21razEtUzlGajlyc1hlT19VYjJOMF9hVEFLemlidXIxNVcxaHI3Wk1PVFlxOFlSSGVPaWxSX3Bkdjl5NTlDRDQ1WmE0ZXFURHVrNmRxZ1d4YnoyVVVtMnpwM3pvTHVKSVZ1Y3FIaUVRTVNfMnFKcy1xQTAwT2FFY3huZTM2Q1RsZVNwZjF5cjh2VjNWNW1mQU5zRnJBa21CMnBRWTNfZ21UbldTYTJ3UWlMa2RFRllPSExTeEk5UVowNHo4ZFRfbW5QMmIwWV96N3ZLa0VGQmFpNU02UFdPWjVIOUx1M3Rnay1fR0g0ODd6ZHpuQm0weWZZY3ZIOHJUd1QyQl9UZVRFMG4xcWFRdDRiQ0diUkFQNE1DTDl0SGlIcmlzWEllejQzZlZ3b1c4R2x4YmxKanlLWkpXbmlRNjlBYks3SmYyUER6d2NVSHhkZU5HNGxEZmt6WmFxU2lybGRzZlhXOHBGLWZ6WFVVWHR4eDF4Um5nQ1hJVkxLbU5ZbV9CNnNrNGo0VzROVFMwQTBOcFhsZGJCWjZWWmFDMDNvRHVGUFY0MGtwdWQ0WEd3Q1l3M244ZjFHb0Z6Sk42QjFqOTRLeTdtNE5YT1JsQ3ZaRW5qZTl6T241T1d1ZG9USWRoRzBobXVDUTZ6TXI2YkVaTUFoV1ZFdlREY19iXzZsOWdLWmVxNmVtekxvcmptOEQzLXcyLXRBYlE2Tmpjd0J3eEhMZzlCRllRRFdvaU9UVmJKN2VBcUVFMHVxVkhBcE9KbFVIc2tmQy1uV3NzOV9fRTFURHBLcjRfRE93NFhPUGNzT3dlVU9EUWg3cVFXRE1ZcDVHU1poVWE4MVVHczhmemZKU3JPbmtaTmRVTS10Y0h3R01mX3didy11dmt4UFUtV0tvNUNqR2M2aU5KMDB4MjZZdUpCWXd6TVFyeDBJQWgxMjVBWlozX2FvaFFpLWw3a1pZVE82Q0JVOVZsYllNMndrZXp4ZGhrQ1oxd080Z1NNbDlKU3A5ejhxNV84SU1WM1pma00xV1VqSGZMQk4xRXdFMjRxZFVzcWxyU3NZN1hQaVlpcXQ5ZktXVmZDTWw4RU0yd2ZHYlhxMUI4eWl2UlpMcko0eEk2MUdVUWJFVGU4akNTYTF2aUxxZ0FIa25IYjVjVHIwbDRhTW1EZGZKWnJxZEdpb1lPb2IwdHBuc3IxanRfZm1obGhJa1NSQnREUk5XWEU1OXBjVXlULXpyVjBxZl9sOHN2TlNEV2N3d09YQ3lITWZzLWw0T29xMldVWTVLQi1nSG1HYUJod0oxa19ra3V2S0hlMl9TY0loc3JjTXV1eW5aLW14Vzl5NHBBS3pvdVFsQjR0ZGZvbHdSRk5KX0tHYWJPZXJiWFdDT0ZTd0JVTjdNaG0wOXNyVS1VWG5od1IwdTYyTjVvMDlfbGN5eThnWDg1ZUVrenhuOGZ2NHd2T0Y2dUd1cFk5UGxpSTRLMTNqSHlOd0ZuY2VmRlp2b0dxVlhkcUg5RGJkYS0zY1FhbVFlNmlMek0wRDlnLXlFc2NBTkpKS3ltelVzemZZdV8yY0p0TEhsd0I3NVhLeW1EMG9nUkRvRkRwTmNPd1dRRUlwdVJwU0pfdWtzR2EwZkd3MGVBTU4tQmc1OUs3emhRWHJISUZOckN1S1VPMVdvTkV5WkM2UGlKSUwtUlRsTFQ2WlBNZmdSZzZiUl9aQk43X2dseHBIakNDaFZXMkZ3MnJFUDJJX1pSeHFqdS1WbmVwV2o4eU1CaHZXZzdXNm9QWm1odmVtUTBkQUljNVZTbVVaelhvNFVURmJxSFN2MGlyVTNscVk2eUl1MGRPd2t2MlF4ZENfQVdRUmdLSGRUeG1xYXFUSXJwclZyUHZ1MDFQSGlFbVRnaDZZVEZ6Yllqb3JEeFExWDhlTUN5Rl80cWNjMnhOdTJRblBIdUR0RGZkSy1NV2xJUDhHUEhSMmhPMjlCa0JJSEM4TlgxZmxDN1ZSZkZsQ09McGVIeWl0MGRSd1d2S2tieGNIWl9fRE5ZLVBNQlZMZGpyR3lxT2JoQnpQZHZMeFpXWVU3THNRbnM1dmxiMTc5YXczX3VmclRIWGs0MVpjaDY2ekFRRl9tekQ3ZEVuMm1fb2tBaTh6NTRwdzdxUDAwNHkzenNPd0RmR0htYWF2c3dGMW5NMUN2YXhXajRINE45dVNUaV9DM1oza3lTRHlUNGdUZjNqc0FKUEJybXdSQVBpaU5PTTU3c0x2Y3dJRk9ENnA5QkdWbjFwbjQyZGRTU3A1M3JieTZEcnlwcHdDaDFrampQX3lCbTZRZnd6MElGUWJiSG1zVDNVa2RMb1dURjFSMF9sbjJtR1kxU0hHT2o3VHl1YnQ5d2xLVW5nczVMTWhVcHo3NU1LR3F6UkFnWXNKcHVKUVl1RVpKeGFPSHNmY2VwakdrcFdoMEtfWkhZUEJESzIwOFVqb3FqMDdlVVVueTBaXzJrNXUxTjQzWGJ3V0ZvWVBhdndheW1MYkhWdkRwbzdwMU9JT1IyNkt0SzdPeGlnZ0ZybGVISWNaODFwQzRCdlNzRnZsY1BCZEpHLTZxWTU0Q3J0R2xhaDRvQWplUXgxWS1YU0NLNnZLYUIwWnZHc2lIajhRQ0ZURjRuLUJqTWIzWDcycDJ5Q0tPRlpMRk5qcVR1aHJoYXNnMi1pWTNOTWdwVEQ5eVBSdjA2X1VpcEVfYjVsQ0R0Mmx5QU5NYVpZR1RvSmJTSVhBcFlyU1hEM1dFWllhTGUzQmFSUEJUYTAyeWpyVFZPRDRGNHRFR3c5MkZJZThOSk5NYXRXMFhPSFAwVWxKTXlQUDF2MVdvOUh5aFllaDFfdWg3SlRLcS1hWnJjOS1Xd0ItQXBKTHBQeGxmRzlGZkgwdjNwSTl0Z1VndWJmSkJQVjMwNll2MlNqQ0M2MmVYN3VFTUgzcXQ3TmFYcFVsNXZEVHpfMF9Vc3VlWERQcDNqV01XQTMwenFaYTRFT0dXdElMb0tEM1RjRWNVcmJONGV1bHFQSkFNcWdWdmk2YWRGdTgxU2w5cU1rVVUwaWpqMjZhZDFaeVlEUUZtWlJ4NjJYUW9ZdG81bXJ0eFZhYWtNNndqbkVPSUdJaHhBTnJoX0dNVzVxREhzMEV6TDU4b3lOY0Q5dE1MUC03N1FCbTZwUTFsR0swMVJ6Y3FzTk14ZzRMTzl2ZHQ3NFpIdEhMXzA1TjF2TUt4TE5GbkdhZmwxN1E0eEM0Z3NQeXpYdzBjcklyV2tIQlNQX0NoWE94SmZORWdyNjJOMXEzQVJZa0U1TVlCbzctM3djb3dNT09GcTlrakN1ZGpoekplRjRTUHdfMnFVWVhZRTZsNXJTYjYwUFlFSkJxdW82Skh5ZmdlOXFJX0Rzdmg4eEY1STJfLWtLT2pxU3FZam02NjU0cXVES3phQ3JWLUJFLWtQNF9DOU5OQ0xTaEVWUV92Z3hYdDhzbTRWNGNRMElDRmFzaWV6VnNuV1QtYmRQTGxBT2RqOS15RmhYVTRUYVF3YnZqQ0E2UHQ0aDNVWGdnQzNqWU5IMmJtRGpYSzhFdFJYRTV6cmJsTDRKMFZ1OGxHQVBZaGtOcGNOakNrNWhSSW5jT0dybE9aUk9jdTdSeVczR2JWM2Y1MGJKN0xLNHJjMnJCMTZuemhBdk41WXlydWdwQzdCOE9OR3NTY25ha1V1alJzRzZGYVpydDNzTDJMOW5RTUNoNE9INFF3VWpKWFZKUFJ2MHhPTF9jVEQtdjk0QWgwbWdtcFJ2Q1dhUkl5MXRxeDZHTmZ1R1Nyb0tObmtHYjRiRE1oblpZMmwxQWluWHlCMG5uRGlvci1EUmo1cjhRZi1iaUR6cGhTallzZTZrakdLR0ZObzU4WjFfaGxEaGFob1pQX1lRdlBtWi1Tb2pNaGhMRXZqMXEyZzZWRVd6a1FDWTdIWVEwM1Y3cHVCVm4yaXM1NXpBSGV4cGpERWoxWDgxWU92bnVTdXRhMGx3VkFEMkRoNjZDcmM2VVh2SEtUZTBCeFlsQWdVdkhQc1BkSy1OdVk4S3RaeGNqTWNDVWM0OVl6VW43RVBTamFNaHJ2Ni1mM0pwc09Na3JwREpLM0dPTUVRMUV4cnhYV1lGaGtLaHR2UXZkMXZCVS12b0pRcWJveU9vS1hMM29Xb0FRVnljWlR3Y2laeW4wbUtkVF96NDNFZGhNcDNKS3N5blJ3OVZtSzk3Q3lldGl5LV9HaWVMSngtWDladVMzOUdNa0YxaFVmYmkyc3FJZGZMZ0diem5uMTluTlRVUDlOR3dhaWhybU9Ib1lZeUJ6WE4tby1UWUxhSS01bkNuQ2FSSW9QTF9XSVhyWDZPSzdZU21IWjk4a2xJS19JNTlPSXlWSllrMVh6bGVwd1lPLXUwU0x6bTEtN0dKSE54RGVOMlZhUEk3TThVem10X0x5alliWWxocFFJQnNyUktsMmZZeExKaGt6Q3NjcWp2bVhDemRLVDNhNFV3NDJ4eDlsOWl6dFQ0UmtnV21fYV9YWWk0b0gwdjNCUXRSZ3NfUTBPaGo2T2Y2dEtyZU5XZmcxVDRjMk01SERJd3UxTkl2QXBqNzZtOXJWQkdPWTZFUnhfa2Y3d2twb1g5dWRvcjBCbEx4a1FCc0lwZXpUdzc1MTBncU81Nm1UWXlBUzFCUVdOY1Q2aWhfN3F4ZTVoUkVlZVB5YUpFMnhqR2JNWGg3V1hGYjN0ejVWVWJOTFpxMjBiM3E0UFdkdjJXX1Foc2VUY0JTRDY1eVFPYndTai1UcVpNNi1teUZHb3B6dVdfRWcxU3pzNzRaY3RMSUxyN3pMLXRyeC1WTTVfVHllMVZXbG9ZOTZVYUJyUktpQWU1SVhKMlBQd2RIY1p4SWx4N3dBRXdueXVOZXA2b2NKcXRwZUJ1elB0LTFaX3UyWjZrQmR4V0lpYlVEaGxOU3AxM1NkTGw0Z2hkemVqZWFaYVllRDVtTGltWWJ4dEhsQ1ZiTm0yNU1ZbDYxMFU3QlZnNVJJSXB6VUdmZ2Z5NnpJRzRLQjBMR3BISzNhdHRRUExvQ1VlTDRYNVdBUUFsb3BRa0RKOU5lTHFGdHN4cWpZaGJnZ1Z5am9ScjNPOVhzYzlJVEtVaXJaUDlyTVl0eFduT0tUck9YYVk2WVR2Wi05QUhpT3ZfdTRhOElTS01DVng3OUlnXzdqTjFfREhjdGd5cEEzVnpkbjNKdlJJQTlfbHZDV2dTSS1NUjlPQ19xekhIUmU5dENqWklDVzhwRURSYVhZOHc4UUQ0bXJicmFLTTNsWmtTNUF2NVp2WjFRTDJlZkExbXlJdmN2czhmekxRUFM0Nm0xX3ZPVzcxN05ydDQzeUcwbUZxZnk4aExaZEUzQ2RkMzRtVVFXWVdqSkdvQXZ0VHBXRmpwWkwwOERjQUd0RzVzdkU0Mi1WWjRqSVVYQ2JsemZaczl3N2VsNThvRkJLUng5dUJLby1PWmYxTVloVEZrSlU1V3YtUEVreXRPSVpfU09nZVM2RTVMTUZsOVpZenZ0QkJuWWF0bDY4NGpEdWx0STh4LXpmSHdwUEFwNk9CQVpxalk3S3JoSVJuVGRoc2Y1VUpCcmtvU1JGUFlaaXE4RjJLWHA2Nm1PbDMyRm5RTVprMUlDVkxiYVpnUFlWNnl5UXpZdEdhbjhOc3BFTG10RWkwMVlTZE1ySUxkUF9TVTZwXzJ1NU1oY0RPMDF0Y2hwMHp6eUVfTVp4YWJodXpMWUVIeXJvYl83cjFKdWNjZUQ4SlM5T3JBdEk1YXdsbEhGSFRRWExOWGJuTHdTQ2JrdHNiTGFoa05ya0ZXR1RDNFRzUlBfYTlHMVhFTE5DRkhaMVhvS3NsQTdMMzFGaWpyNFpEYjRQeW5hT1BrSlhCcEx6MGNLN2FmeFVxNWlySHhZNEQyVkdNT3gwUmc5UEJJeE1vdzN6TmVGZ3Y5dzRTdkJ5VUpQdjNGV3huX004M3g5dldiWFh3bU9LbHlLNVpWQi11LWxKVno5Rm81YWRfVEtwUkxqSGdNWURKNU9Ka2dhaEFQMmhOaG9lb0FicnBPNzVYT2tYZ3pONDdwVW1kdzhmZV9FN3ZSeUREZi1LNVZNS2UzOXRPSi0xRmxtemJVc0pET0lScHp5WVl0Y2Q4cGtPU3JQYnIzMWdJNFRIUjJHV2xwZWJCZ3VhYmppck9UTjI1Zy02MmRPWWVKNHVwNjI3MjdnbWNQWF9EYmJfSFdrTnVLaXBmdkJ1UmVNN2J1WE9LVzg2bllHSW5ZNzJZZ2lvYVpIaEJnY3pHbktuUUlkWTJ2U3NzQ3E2b1FSUGJqeHRQZ1gxT1h2bXNucmNBencwN01ULTNueWF1RDBfNG90RGJueF92dm1fM203ajBwcjBGUWZ6NWs1UEVNUG1sOFVhenFxX2xEU3djV2JOU21JbWF3OWt3U2NXN2xrOUViNTRLRTRhaWt2bVRxXzRuN3lkSDNQblI3bC1RMXE2X2k5VWdHUVFfSmk5UDZQbmszQzd6TTVYbDBpYllEVXVUV2FUdlRrX2ZjaXo0VUJXWkV1T0lLU2xZaHVBVzFQUTJPU3NiUWxPbDU4U3ZvTEYtS2w3TmNkRXRBODJVWjdkLVFCN2xKNWFCcnd0Vmx6TDFxX2Y1UGd6a2NtcW1pLVViM2tUQ0xlNjJYbzN1MmFvSnNTQ0c4bXhwZkJ6dVFVVkk3WXdTa2ktWUtNUnlJSGhuOG9xRDNQS0xMbHk2LVZkZy1VREE1RWhhLXA0TnZYb2lLb3ptRHdBZFFpeG1IcnJTdUEwWmh0eE14N0FSc0pqc285blZKR1BOSzhCeTMtbXQycnNOOHlMdHpyRXdkUzBtLW1sRHRKak9CWHJ1NmhWOFBPeV9vSWVzYmJtWkcxSk96Tkl5YmhPOWdNakpsNTBSQXVmcW1sSXJpOEVXQk9vdzdVT1RKQjgtTkR6VzVXdWNiS0VLOGotdWtSYXhhQklPcTJBTnI1Tl9hTEF2RFpmalp1cDl1RGNTc2FUOTNWR0dmQlhHX1BYRlhGWnNtd2NnamxsQWN3bkhCS2V6QWd3SnprRXpFaEdEOFhQMVh0dXJPZHh2YTRyd2ZtVG1yM1pHVWFmY0tTUm5malpnVERSVThVRFd4ZjRwMjB1T1h5RzBBUzlJLUF6WGN0Nm5EOFVQUlB1WDQ3UG1fN05mdWFVTkt4SEZ2RFdOdWYwcVE1OFlvZmhydjJlRDlzUFJFWV9CWjhXWm9IYy0tbVZ5MmM0aDdvTTUzQlFKbTQzRzNkaXotclRwWE0xUDExakc4em5XU3RBQkJxbW40LXdKVVl1UGpDV0VtY29qdGtRZEZmcjQzRUNqTzE1SDJaZGN6MkphZmpUcmxPdWlQOG96ZjEwa2RTYjBURTFVOXI1dHRIU0ZzOUxPVlZHVjJnQUxjUGtMU3R0clgwMXZHMWZLS1ZTRVI2TzlZM0pZYW02X0FwU2xONnlRbmlqM3NJTzdKc2xYdHhaMzY2bXI2Vnl6WmphajVVODlJSjdJUlY3eXBkOWtuZy1RRlZMT0FhRGU1eENvZG1jRjY4ZGp4LTZBVWpQWnBHOFYxVG04OXh5c3BTaU40M0lmLURacTlaMXFjSXNDOUJ4XzlxTHE2S3kwNTIydnBKWkw4NEdCZElXM0FuUUdKbFY2dkRXbThpcF9LMjg2NG8zcEg4UTdFWnpqc05KZ3p6RFU2SkU2Y2psTVdhMDR5dkVMa2dnUm9feVM1MWUzam1BNUFFdWpXLUJ6TXlzTjVkeUpiZC1HcnN4VFltck1wMWI0dFNhMXV1ZHBSdWl2cUFLdV9qbTBvYTA4UHZqRjJyNjRXYXZQZHVxcUs2VGUtMDc1RkFQNHFEZE5ocmpJSHpneWEtUWowY2NCRWtZbUo3di1mUWxneUxzaF80bHJZQmVyWnNCMDM1Z2Z2b19CakQ0Q1VWVWFTRkRya2U2OE41N1prblU0UkZXN1NNQXViaE93WjlCd1pmT0tuajV3bDhfemRFTDVLVDBQUm5IejRjQk01OTZGNXhleDFORzNqME80Y3JDbzVod0xMMUVwMnVweVlULXpfTkdkT1MwMG50bGt0dnNKMGFZSURuQy1SSDRYcUdBUXlpY3hJVzNnTXh3LUNvYlIyUGdPa1dLTVBJN2xFelNLN0VKcjZkZENmblhHRF9scE9HSXgtUTROdjFOU3E4VGw1dkRtdmdOXzZCOEhHbmV5bXdpQUlJZ3NpWWhfUmR0NnBrdWJLVF92aFkwMTI1WWZkck9NaW9keTFLbEpNR3NJNGxqX1dJYVRHQjdoY1dtY0stMy1NNWlZVnJUSktaR2RZbUFobXI3bkZVT28zWFFCZkVVZFpKb2Itc1R6eDdNYWttd2JEcHdQdHB5OXFQem03akI0ZC1yYmlncDI3azRTYlVFOXNFWTZVeVVJVk80Y2l5R3ltZThpOEdLY2dSWXJ3YTZmVlItTnNvcm16dmd5eGZVcDFGWDZuR0xNbE5VMDNEblBVU0JLT1RWTzVnM2JuNG1DNWI3anBVQnUwQTk5R2ZkTEJGaXg4dURwR2NsQm51TFhncjcyRFdCRmFKeldkZXNZbTlaLWk0WDBaUTh4cVZwdGpXTnI5Sm5sVDlLeDVKZXdRSHZkeXRRdHRaTXc3TS01Unc5UHJreklWd1JPZE5PVkxwRWl5RmVqM3YyZmJGRFVoRmg2ME00NWRMQ0hqU0k5eC15dDZ6LUVtQlBpdGtkcWpUT3hLam1qVV9WNzIta09tVndhZkY3MzdTcVRKa0lpWlVic002bEJoQ3Rxd2cwNi1DelR4U1pMYVgzOF95dE51aUY1S0JfcXVwcU54SGJ4TTVZN0l5SnJUcGR4MG9qNFZzWDlxWkFjTGxCZnRNaTFUSTVLMkJRSERSNW5FY2UwT2J1SWpjdlNrcjNYMmZwUWQ1cHlLdnBXcXpNbnNuQ3NsVnYyWUY5ZDZHVWFKeHlfQ2MzRVJqOXZIMnRJb2hBckh6VzJlN1lNUTRyQnducnowOXc0aWNnNG11TDdVSnVsVnJLcjdJS3FDYjJyWFViTDBIRUVrTUd3T0pISEVnVWxlYzRGajRNQl9ZNnh4SFJuekVKMVVBRXVTeDJaZG9Bd1JsSjMwRHZYTWMxcFo0NWktYXE5eV9oOFJxaUZSUlQwSktjYzFpeFA1Y1JWRmVpbFhKWXN0cDV6X1pKZ1FrSTdCQlBaR0M2bkZ5RC11LWh4MzhQN0IzQjdUUzdoWVlXdm9ETFpGSkI0a1ZGRUhvNlRKdWNDVlpJaEFMdHlfN3dreFFxdU1mMFNOREQtV0FPWUJkY3JpZzZmYnNKSVhvc2lMSWNDM3hOOGw2X1dzNk1UMXdXODZkcWRUWkJnN1Z6YUlnREJ2RDRNakRLdjk2M0k2c3ZmeG5FWWNEQ3dDalo5M2JwUGRJd0htZEY1ZE0xTGZVLTExMktBN3dCQTJWYjU2cFdBMWk2QXo3Z1N6RXhQRkZvVkNBdFlJUnBFcHh5SVBaQUVHV05zeDNpNEk2Z2lyZi1hUmFWejFXUURCemd3ZDd3TlpqV2xrRVlyRFBBZTFPVnl0bU9HQWlGZmZiQWVPaVF0V1lzMHYzVGFTOGcydk9peXRvakE4ZzM2dDQwQTB6T3pKYnlzUUM0Z0hjODJuVDdQUDJBTFdPU0RLTmxSX2M0eHFWTkxjdlhxZHFBNmpVRlBUY1FONzk4U1FRbGprcmd1bzhEcGxTZTBnODl1VHUwV0ttcFltSFA0WEtmeXRGRWlBR1FDSmIwZUl6NVZsTlAyVnFiRGRMcW1JSzhuNVlNSUtDY2ItY0FUdGFoRXU4QkxQcVE2VC1aa2t4MF93M2RmZjhVX3ZCZUFwS090SERMWUVqcTBnVktxUHhaUWczY3RJS2oxdXJPeTIybnJ5aTlnZWZVc2QzZUYyMnBCQkx2YWVWSk96QUZndk5YdnRiTXFsUW1CXzQxNG1tVGVtaGFlNktjOW9KRF9sLUxKWDZPU1FISlo4MHQ4Ql9VZkdacFZES1NubmFmMmY4UHYyMy1EUmlGNlNyQ0ZKN0d4TEhUNXJSNzU2MW1YUlV5Qy1leWtocVI1ZFZSZDZhOVQwSGY0TlZSbjJiaVdxeWhPR2VUa0hKazE0YllOUFdYTm5XSHl1VTdyNEZoOVVsb2lES2xIQjQ0VjlmYS1YMzE0c2VHZHRqUFNLdWhFRHBMeV90VU95aWU3aThJaGNIaE1XOHlFNi1Oa0lZSnF4cU5EbjAwdUkzSEhEUWtGYzFQV0RYdlVIcnBJUFRJcFFBQ3c1dkNWT2JpUmFoQVBJM2tFRFh4ZkY1S2VLMXRuS1hsZWRxQmRIc3lCUkZuNnp6T1p1UHdOWktKNHlYVDhoS2wyamQtNTlqdWpibDBmNF9WdVJFdmVQOW9FWWtTOHU3UmlBVEVHa1lPVkg3MkZXTzBzLVNJWGVRRkQzX3VvWjdrM0xjSm9GVjlXMDZrQUVWY1dURVZGRUlwamtNMy1FYnJSUVdMcy1heWVYQkNFSUxsQ2t0di1LblA2N0pyZFV0bTI2cnFlVXZ5MzdTMTBCTE53YjRiNHBvREhMS2FveGFuZy1iRjZUb29PR01UU01MWXUzaUlLc0R3Wm9kZG1WR0xyQ3FxNWJJR1BFZTNoMnc1RjFNZ1hyVEU2TmFubXpKckh5eHVPc0VyaGctaEpGeGVCcWE4WjZZWFduTXIxNDhLanNoYVAyeVpFSWV6OG81UEc3cWRWaHFRenhYT1c3eEQwSTUycjBvbkhxM1hzcV9SOGhFby1UYVdPbmY1NW1YYTNWMk81LV9XanZxZThWdzdwTUF5dG95dmh2NTVTVk9xcVdkNXNIdGhITzd0OWlMdDNFYVMxX0ZnaU8zVmVENmlvUVBNNjZsWmhaYkpZZHo4b1RFeU9SR09KbkpjSVpqVm1YSlJIbXF2eXZsUlpjdkVMM19KR1hEOEZGNHlBVE0zaGhlNDN6VEJVdk9oYlRjckhNQTRLZjhWczR4cU02QWFsczVBZzRUbVZSSnVLLUVRWFZCaFE0TEpBbEgxVXZzN3lKYTdLM2hsQlZEMWo5WXRWS2htMVhPNFJySTNrZmVxYmxoMTRHQ1NEdnI2OExyTk53SUZsY1JEY1pKalBOQi1GWGhUd25PbW50ZVItOFY0UTJVa19tczdTTm9ZUElWRnJqY1R6X1ZkQ3dYRTFmMjNocHpqQ2tnWGlsSUlNNEpNMkZmcDNTZTY2c1JHc1RXXzBBbF81R3Fqd3ZfZFBYWDA0RHJNMFI5dGljTHhLczBnM3hkSXF1M0huamxBRFU3S0c1Yl9NUmxUdWJCQ3pEamtJQWRRUEFwcUhaWktnODYyLWloMDE4bERfbFViWEwyMGhFNFBNbTE0eEg3R0dPQ3FWa1o3RVU4ekd5Yl9xWHV4RF9LZHFLSVR5eUc2WC00MHhOeTJ1cWpDMmlvVVpiM25Tam5kZWFiX19kbC1jMDBLWkU4RnhTRnRMN0RreWxpTWM2Yy1VQXBhUlZKQy1aa2NBaXlPZ2NBOVZQa0x5a2xlcGRNYXY1Y1J2a3FvTHhmS3RMU2FhS0taWEdveFd5OWp2am5KZHZfMmZDTXlUeFdOUWl6MzI5NG9mNkNNY09sTmc5VW5iaUlHb1JVX20tMHQzamNRWHBrZ0pDWlMwcmQyZ3RGVExYdUVlYU9ZTnJjZ2dPWkVQMkstc19kNUlCU2JqNXE1QS1HYU9hbzFuRmdFOEFlMDdEVXVzeTBYeVEzd0cxb3JIOXUtSUxpSHpyd01Ickx5ZWkwYmpYSm9HcVBuSWd5d29nWjdZRmF6a1ZSTGE4OTBZQjlXR2p2SEdqZ19yYmVabWRDWkFoalNiTlRveFN3bGkxMnh0bl93WkNWVkhlNzUtSGNkTHZHaGgyekwwVjlROG84NFI1NUFKVV9fNjI2REMxT2w0cXVLcEt1Z1EwMHowZElPbzMwcG5IT3hqa2xlcGRMM0dyN3dHNXZsSUJKbXVWMlBReC1Hc0JmX3lYbUhxOXBZZ2RJeXl3ZjNqSjlDcmROYXM1RGNseUExUS1Sa3MzdWtyU3dublN1ZE5OeTNCRlJ5ZkgtbHhWQmpYSHQxUUlQM2JLbjRvNmRPSHNLclc5XzRPVnBNREQ0UjNMRmpYNFM3MDJ5ZmdXSkk5Wld6TDFadk40X2t0Zy1iVHNYOC1zdzJfa2Y3dXVldmJmMkYzLThmM3lvNDNUZ2dQaDU2TEZjbFNidGdaNE05MDRTLWF5SGQ2NkhVbmU5T1Axc1NldGdKWXdZZVN6TTgzY2FUUXVqRVA4bFhEQWxKZGJ0MTRhZ2FValJkNlBNLVVIUGdGUmNtRTd5Y0k4YzNSdWxrVkU2Wk5qeUU4VkNnaFRoN2JMNTJNYXhUcVMzQWJKNUpHak9ESkk4ZTczV1BFZHZPZ1FPNnZvak0xNDFnSjFtaW9rTFNIbXNwVWRhSFdIdkNkc2VHeTZyZmJfYktmeGJGS3FNTEN6T3VKbjhxd3hlNUxJQms2djJCUmNzM1I4ZnI1VjBSQXB5U3J3bmRuWExFRHdVRU90YzdwSTBqajVNeGFJaWxKU1FMb00ydXpiWXZaVE1INklXSndEdU1hNW04MlFCRnV3TWFZRDd6WmNwM0RGb2dFc0N5YnFjZFd5SFBhV3NxQk5GSDRuYXdwRnMwQ2xZMWMwbGZQR1RnTWZJeTRxRnV5U012cHNkYWZORUdBdVFpYU5zRzROSnNJV2NYbFNFQ1FsLVhRaHF2YkpUWE03NldPVTVld0RneGRGeG5WREVhdFRlQWZZaUVEN1ZBelFNUXNFenU4VUx4VmI3RWJzX3RsUW5hU2hVX3E3RjNUVEV3VUpPdDNCeFdPcWFCbmhNdUdOdU5CNXJabFd3YVhrUTFNdGxwOEFmWTBXSF9kX2F3VXdQbUpCQXFEX0xKRncybWVBS25OZl85NlZiUW5iU2J1ME5uejlvTnVXVmNMcWZIeDIzX1JfVVE5enZibTlkaGlSaUxSMnVDUzN2d21XS1UzVG9vbks2c1NpeWNmYnh2QjE1TnFnN2l4UUV6M2U2emVkX3pQYy1GdF91ckRrR1dOTFJ1d2Zyb001REQ5XzQ0UFVvLU1SQ2NiVGp1emxqQmVjOXRUc1NRdnZWVnp3WHdNY004Zl8yWEJxcU5OVl91b3V6dVRPWkFfbkNVTDV0T1dFSXZIZmlDRWxJV3lrS0U1TUFUUVlUY3FRd0VwNUlBeDFDOXdudnZtVk5NcmFFNHpDSDJuZllsUGNIYWpMUGlXcHpUdUR4anJGeFhIbVBUc1JTM0Q1YU1yTmM5emwyZkR6ckJsbzV0Y1pPT0ladlR4X0ExeFA3RlFnNjMtbUZzTGlRZG16NzM1bWVjUEFmdkROMnV4dWp3YXFITGx5NGlLelljVVRjbHFhYV92X25VM09ESUxkcWt1S1pCZFZzZGwwX19YeDdkSlFHNG5nN3kxU0d1V2Z1NEdRRnV3azE5b1hJM0ptU0c2WVZHSW5wSUlNYjcwSy1BREliMlZBWjlVaUloMW1HNmpUZWRHWHJtMzF5b3Jnak1PUlRERU1rYnZCeTFaazVrR0E0V05aSmRKRnlSQUtXT3VNbVZOVXRWcTFWRHpkTkpNdGhaWUZHQUU5MEtBZVlaZDdmaFRSZlY3ZlFYdzhWOENmM3IxdmdMTXJyZ2JSOGwzeUsybFBLMnhMcFl0cVpRanFaREpvSjlwUHBlcHEwRF9Dc1JEcVlDVi0zNE5GbldXWklZQmtmZTRPSGFFZTRlXzNQOGxNVTFKUWlJY1dXWmJ1ZUJXSnlpNDQ1b24wRm0zVzdlYTRnUUJCN2c1MzU4MUJBZW9ZQVRUYnFFV0J0LWU4OS1YMDd1Nk1vSDVKUU80OV9kSW0wNU11VVlrV3ZQODFHNDMySDFPYmgxRUJBNG1WdHYtM2ZqeGVDRldiZHVzTWxxa3RYbXVodjBEVWdmWGh4OEoxS2JaMUdjN3cyT1E4S29KZXNGM2QyTzIycjFkdHRIamdmbHBUZlVXOGFaN2hPZ2otSy0wRHg5dXV3ZmNVVWMwUnd6bkNMbVdqd0lnZ2NfQWZJbVRpd1ljZWgzQzlpVnpLdkcyV3BfZHpCMjgzM3YycGI3SlRKbmFYT3VSSlhiM1JQS0pONGcyVXV1NnNYc1JBd2FlTnVtVVVpM1B5b0pCY3dhZFRsbVVrQ2JNcjJMQzBzYmZkbjNMOHk0bTd1UGg3VTJ1RE5EaGk1LTZaWUNYZE5SRVNzajVrR0QxNzJoUHRSVEV6RzhUeEN6Nlp4dE5MQ004a3pHVWtjS2FLeVctZFdaaFVWRENsZVdnQ3F0NWdvNUI1OEVaV2RJbi1SRTRxREZ5RlBDNDg3bk9nMUVyVmZBN0NHWldha1F2QXN5ZUhKb3dkc0RrdzZIV0x0Y2ZwQTJENHEyZ1Z2aDdraHVNMmwxSE5DdWxNOWJSXzZZYlhuTGlCMzIzN3Zjc1d2bHpBVmJCd0J3WHRQT3RGWEEwc0V3c3Qtb2N5V3Z4WFNsT19kdlhRNUdHa2pLcjhFX1hzM0dvZmlqaHpsZF91OWFROGNTek1XbE5xRGNPWncxdncxNUtaeFNXR1QzcDJ4S1VHLWtSZW1Jc1h6VW91TFdma2RCbk41Vk1tUTdJTXA1RkFfcmdHWnFwVHByaHJMSlVaeTNZN3I4bG1McW15Z055a2FMNWkyVEpIT3RWVHB2eHVzck1LMnUtSzdpbUJVMHlkQndFaHNOS1RWMXlGZng4Q2JZazJTeUo2QVlWeWZLM1FhVEdqb2FFMGxocGNPRUIycmpfUDhFWHAydlJ3TWZsYjBtc2daYTFCOE93d1BXRUJMdlROVjVzUEYycFpUaFlnM2xWVzFjSlZlTlBLRTJfYU1zS0p3UGVIY19YTTNrdDBXVkpMbTBnZzE2ek5EMjlsaUlfNTBjOW1VN2NpVG1hNEd5ZzJtSkUzVkg3VWxUanVkRldmNTZpSEZHNlJpU0FqVUFtMmtBTkNGMjFyb3ljVUhFTGo1aVlQZF90S09vcmJvRDlWRGcweDRDc3BQMmRKZWVzMVR6aVMwNU5qU096cnd4dG5qMTBBZ3kyd3B5XzUtbVl6dVJvYTUtNXVPSFhDRkFNSW5QQ2doakFudHVYUGw5REJRb1ZSMWYwUS1NdnJWQU1Qc3pfaXMxc2xZaTlFT3NDUWp1R2hsNGlxYmVNWWRhbFVZZllGYnd5dktaTGNlZndjaVdpY3EycWhpM2FxaWQ5WkVwVGRyR0FvRjItdmd5cWVsSjlRb2NfSG8xRldZdjFrVUR3RTBmQ2ZlV1FteHBFMTQyYmlZNVNnV01CaE9tVTBKWkt1c0hCV3B1ZWJ1TDVlc2RHVEJwRWtpcEpHWmtQSlB0YzBvTlJSVU90TVdZTTYxbXZaXzRTTFpqOW9kZ2U1akMwMHBzSHVYTUExTG5USDZ0R3FnSDlTd1Izd08zOTNTQnRMRU5oNy10UEVEVWc0dHpJeXAxTHQ4R2dWS09DTl8tc2RCbnlpSjJaNmYwSThEMXVPQnJYN0JGb3E2aHlkOWtMWnZiX2E1VHFUdzNKZDJCdHRzOHBWS3hhaXFtTW1WUmZPbU4xYmRJSHhlVUNCQzdXdE1LZUc0M2FNLXpYZDBfUmI4MkxJTVVVRDJadUxXb0MwUGZzUmpiYWNpOVhBOFlBVTE1WllTOVh1YV82NUZYT2xxcl9sT1RuUjd5Y0JZY2J5T2tIeGpIWVFmRGkyQmZRV0NkMElXaF9WcUxNZWozT3ZEUW5FZDZvNEU1N21FQ1lQUEJUSkFIZTNHTjU2UEl6T2xLNTRtVV9USUNpX0JKTkRXemJvdl8wSnVEWExZMmUxZnhCOXNURmc4c1hINUozYUhYY2dpYUdSaHlnMjRKZElJV3dkcXFRbmlLZWNfS1IxVTJhbEVqX2xPQTNNb3FadHk5Zzhnc2RCMjRmQlRLOWJZUnc5eW9OVWhrSl9fM2NxNlozVVFvc3VrWklreDJwVlRoTkU3THdEQ2gxbnVRYlpvUlZrN1NKc1pjWkZ1TTd1SUJRWUNVMGRIQzFRS2lublQxc3R5WDduM3RRLXZPWGRsSENaOEtmSERpR2tsemdKUkhVSFUwdU9JQUNuNGtUbkRzN1ZrRGtEZ2YxalBhYXVYLUR4X19Cdm5oWXIxRFp5eS01N2x3SG85c21rZDFNcGFUVGRLR0cxOVktUDh3MmcyNXJCcVlWQjhBZXRlbXQ1bEtZdE8yckhJNmZSSDZrLVhSM2I3WkVlSFA5MV9UTkc4QVZtV1djMUhaMmdYN0gySzgyUzRoUk1JcEItdkxUaFI2QmV4bTdDeXJHSFZqNHN3M0dtZWd0cG1obmJlNEZQRVo1UTZnNGhScUpmYTJvOUswZDI1aktwaURBTFllRVY3Y1VDUjhBVjRYNU5WR3hWdWppOVdYN0gwaU1mUjZHMmpIVkFZSmloSkxOSC1JSENWcVhxdng0ZWNSRmVxNGRqUjNBWjRITm5kNUJBaGlTSHRObkhlM3EzeG93cFduQVh4M0hHeFZKcUozZ0pVdDVtdGcyb29pYnJiTTVFVU1HT290QlZGT0k5eGd4RmZYT3dhYXNPNWxIbTVoQnFWZVczOHlXS1FqYU50VG16TjlITjFrRWFfS0JacHU0d3RGeGswNkdWTmFEUS1QbmZBV0FJalByQ1FjSjJMQ25kS2FBSHJyYTQ3WTI0dWJYd1hPNUZsSVh6NElaZzI3Z3NzTXpVR3kwdUtGc29LdnJrZkFLdjVWblR1WlJ6aklrZzNoZExLR2FMb3RPVmFwZkp5VnNidGh6T0JrSERUMDllcVlOYkFwbWdYWGdoVTZSb05nV3IwOURSMmZQV1FyaUVzbm9Gc21yZWc1MUUtc2JUWjJCb3FqVW1zRnlndjJZdVhpdTVXdFFUNGtKQ1NxczZZVEw0cGhoQy1sTEhubWs3Q0ZKVnNMUHpUM2ZUcVF5M2V6Sno5dUxyUWJKRXVVMGgyWHQtNGwzaENtNU1hQlVVUGU1SU0tWHZhVk5QM3FQUGN6NjEzZkt1WmwzV3NmZVVtYzl4OWhrbElxRlI4RE1aOFdpYnhJSG5CXy1vTnpvcGV3SXZkOU1RV18wQ0hJRlNWWV9lMDNfNlN4SDBiLU5DX1Y3MXZHNXpNTXpqUkc2WXB1d3hMVUQzQnV6cHNWSVR5ZTd4M1RSWFBxNE42aXF4cFlTeWpyMUUwVnk2UXhzWGc1Q0NsZEozN0p0R082b3pTY1gtdDNKOFJBbVk5Zk41WTRURUZCZkxFT3VtdkQ0WXdjd0xuVktKMnVYN3A5MWZjTTUzVVRhTVc4UTZSZ2JFaTlnZjg5SXl1OFc0WTBIQ0REbDE2dVhCSXdZR3IxX1lyRy1zOUU1dU9FbjVpVm9oY1JsX0RrZlNNenBsSUhPWkJzLVM2X0tud2lZMXZYeThhTWlqb2tFaTVOZnBMbUdZdklwdk1MUFViUzBrQXhGTWo3dktnRXR0S09pU2wxVTJleFF5d0tsYnJtUGxFamZ3YnFjRVZkbmZvTFhIYXpfNlhYTE1Qb1FobWhKUWtvVFN6UDFIb2J4UWY4Uk53VmpaeGF0enpxMGtpMjVmUXlTNTlET0wtVGtiWlFqOTByUnpCQ0hVaTZlNWFmNUN2b3p1T2NIdEJmRnJHVkw4R0JQMk1JWi1UTGsxZXcteFpBbE10UVRITEVuUE1US1Q3X0VwY2dJalNDQTVsZHFXQndZVWxJaXZWd3NzNXRlWEswQkNvWjY3OWxyTVdTOEIwUmRwbjM1djlPU1JOejh3TUFTNER4UVV3OXhOTzBrSjdCWHdUM1dOem90dVFFVDFIeWpEcDV0UHY2MVZuVlVDc3pRME1TaTcwakU2OGtnVm9TM0sxaHFxNUhyZlJoYTVEM2MzZDFBWnJzaUVsMXpMNU5OamktNnBpZENKVmxZeFNBa0gyc2VlZ3lGeUVVV2p3ejZRZzBzeWYtUGtCWVFaRGtKOGJsUWFyUjRMdVJGVmViUTZ0bnQtVThmS0M1d3kydzFXMUhiWUZOWHRzUnVkcm03WWVtUDI2eVVNRzNPUEktLS1zV3VEUW1VblIzemNaVGZkcVBkc3ZyRmtES1JESWZfN3hsbDBLVGtIbHEyRjJOTTBiYjlDb281SG5RdERpX1pJZmIxa3pZd1BHTDZMV1hsazdhcENaQ3daWVBLNWNmbHkyWU84QzRuX2w4eDJkLXdkclBMWGNMRi1xZnRtX2RzZmNrNjBrNUtGenozZEJKV0otY2l1ZWM0S010Sm1JMklxUm50MVpJRnNTOGhEcTF3b0ItLXVTX3ZfZ3lMMVRxRklNWE80b1dUZktOV0l6d1NOUVM3UGdCYXdIMHVIemZDeFJ1bmh5enRMTEdMZEtBamZxc3d6R2dDMnV0THcyOVJoZWtLWVNyaElGWFVoNFFjZF9GOUxfNXZyc3pSaXpKekRUMGVkWlhSVkZNdTFsV29zQUs2YV8wUGVZbFI5cC1XMS03eWo3dGJveGZGdzMyd3o2VlNWamJrMHlIUnpRYmtwNkp6QlIwcm1QU3VlU1QtcHNCSWVwSGI3S0dHQjA0ZmJvLXk2N3VSRkxKTHZlcTJua1o3dDFIRGozQ2taVGduUmJ0S0xYRVNkb3RFY0toQ1ZXaXNrTDZabURLVWJJTkF1MXpLMlJhZkJhNzVDNlVPX2llVnAweTBJX1JnT3hEd1Z4QzVReS0zdVZkc2trcFo5VGduUGhXQWlURF9tQlBmeWhQN2NCbFZvUUhoY1lKYWVjQ21jQmtVcTd3cmx1emdEWEduUkFveUp6MXlwZWNjWC1IUnlqOEFFYXhxSkVUeGpWTFpNODBNS0xtRjNXZWt1dVMxSDIxLTFYUFcyaDBfSkE1OTg1cm9uWnBCSUtoaXptUU44YVNndjBIbFlmVi03cTl1Vi0wLXFrNXVQWnljQkRDYnpUZnlGaEdzWGdKU0tPSm5PYkU0QWktMW14NHpJY3FSRmNiWkt1cF80clc5Z2lFX1pfYjBpTWlMTGlBUHJ5dGo5T241ckx1MnJhY2UxUHFvb2VrZzFuWWxCRllTdzA0eHBWSjNGNURCOTBDMHh0SzAyMEtEakpRU1VCZW52dUpsZ3V4WVMwWnQ1N3dKcnVXdmFpYUlIalFBTmRjMU1lSVJEZjF1Z2EwZ1NwVjZPbEltMlY2aTVDMllfcmY1eHJITmVlWjdwU3A1X3c1UTk5YlU4RkdEMHZNbXE5azc1eTdsR3NTMVlwc2stY2RZd0pSek5oa3RPeW5GOFZBNlcxSjkzVmZsa2Q0NTFnMGRJM3dGd05kY0FqWG8xdUMzWF9zdU1JOUl2ZU9jcWFqWlVNcEFCMTZzbU9waHVpQXlBcjNTbTltMTJMMVBvbzVVVDE4V1lEbFl6eXhNYkRmWmRUX0I2R2lNUnpFYVlHSENyQjJoaUhsYXlDdlpCNW9lbkVTUG1rS1c0dFNmOXhRc0R4U2U1ZnR0UGh4enJ4UWxieEM1V2dINlBibzdYdFcxdUpMUEVzVnlwdGRjS2lPSHczQ0d4dXA1NnVNdjhlRW50SGRHdVFERmVfalk5TUJYZXNsdnMtQTdBVzg0VUFvWE0xd0RYUFo0SVZjdmozSWRpbTh1WUVDU0dXMHlPcUo2MEVBYk9nM2ZERW1wbEpNVTBuc2kzREZmbWlqNkVRZ25hdk4yVUN0Z1lKVUUtUVoxU3lHTEY3OVlIRXhFVFRUZ0RheHNIYnZCX2NibWFwNC0zaGhPS041OXlQUmN1ZldZTGtrMUhpODg2c3V6VWJZa2MxTkZRWlBGekdYV28yUUFvUXlCQm5DS01YT2QyZzBPS2RaSFBYRUtVR05FM3A2blo1WVFCMUx4dXJhTVJCSUNqV2lHN1E2cC1XdXRpNHFvNnRvUjgyQlFFZUtqSC1KV2t4a0NoZ2tFaXpUSjFGcjlHRFZ0c3duOUdFcTBKZjJ0aFhKWXZUTkdTY2tTVFEwUzFIa0NlcVNLOXAyN0p3NHl4RTlocmFVdHYzaXl4MEhFZmNnTlNLVTk0WmpFa0R5UFozUXNLUUlCa0xweHJReGRsZ1hSV2ptMEpJSWQ3WmRiT3I0YUZPN2ozZlM2a3EwQk5SVzFBVnhRWXpkLThFWkV3b2w0MFNyNmFfaG5tUUo4WWZvYlFoTDBhZFBfWUNaT3dBc0g3alc4U0lKbGV1b0hLX2hPc2Fha1hkTnJPaFNoQ2VVYjNpNUQxRmxkak12SWFEajJFN1dfUDJodmVna25PNkFhOFJlZ1JRN1dvQkVpdGU4OEszeVdPOWJkdmZ1NjFJaTBIRU1RUm5LQVBILU83RVpMVWdzTmd1ak5YRW1jRmdmRmhmU1Zudko4Vjd1UnNmbE9NcEZkTmZzNU1KUDdEcEF6R3Q0aGRQaG14ZlBseDdqTXh4cnpOQ19GS0tvRDBwcWdJdWtTVnlMZzdrbXkwOE9paTk1QUNMREZsTnlQZjNtaUVUMHRfaHBmWFZrckhCZDB1Qk5Banltb2J6WmF5bW05SFhLTTFVSUFJN21WQWdUZnVUYmQ3eEY5TjlDNUJTZXVyVDJtYnNaY0JtWFNfa3hZTWtSWjFkSkdjN3FwVFBSZUxOVm10UURBVzZWdTZUWlpHNDREMHdRNllKalItNlFiVnNSR2NReGtxR09KQ2MyYm44SEdvMnZCSG50TTdEZVM0RXdLUXh0bVduVXdITTNVT0ZHaWVOVmRvZDhzcllzaE9sM2tvZlN1YUxIUkZiRGdVQlZoaHBFV3dUejF1VlhOd2VVN003N0R1dGJZYTFiRXRJY0hneXJjQUJTVW41dlh4cEhhbVY1RTJHczhEeDhYTmlBaWdYREJfbmhFZEdWWkVqSmd1TDg5VXltR0c0X3Z0cVMtN3hGYmtJaFpPMXBEVHZTMm1KM04zNUduNGI2S1FWcUEyWEY5amJwRFF0VFY0bEgwZWhiLUFyeGtGMkJjbnA0RUdNZWs0eDRXN1RfNEdtNzlFb3V0TjJzSW9iSFhXYi14bURJbUVId3ZHZkFsYkc5ZFFLZ1pDT3Rrb3EzUHJvY0hEMVFUTElpNEpQYU0zc1VFNngwcy00NXR5cEFHQ3N2MDhralVkUW5GbUVTYUhTYzJjSE5CUEFFX2ZzMGU2bm1fakRLektON095RkV5Ymd1bHZ5RTRsb2ZxWkxfcnNxWFlPN3lvT2oxX2FLVHhGa2ptallGNWhiS2FjcDhCNWstRUZUWVZYMzMzWG9OelJreDRnOFNWZW0xVUNibE1QOTJxb3BLUklPaWNJQWpmN2dkS2hhQmZTaE04UUt6bDJBVjBVU3lwMkdrUFRja0NrWEtXUXhhbl9RLWhtZ2l0V2w5ZVpOR3BpUjVSUGxqR3VRaVRYNlJENGZKcUdEQWNMSnEwYjZYZGhva24zMHd0Tmktc2J0RUN6NC1HV1ZOZVVBYThETl9haFNaMXAwT1MwMkRkbGVKOG1ZcW5vYThEbF90ZGZEV0xiNDg4WVplU3JwUmV2WlBJWm5OQ1lQUngxTDdxMVVGcWhfajVrQ1N3Q0VWTEpDUFdzaXlKSzluXzU5c3lUaW9DemxyM2tuTVZ2bDBZSnFYdXF2eW95TUZrcDdGdVdBbWtfYUR4eURaYm1mRGNLNVFnM0c2YlVwVXhPQVJyamgteWtreVpfcmxsa1hLUjVrTnJJMFFKYkw5UHBiWFNtMzZVSTFNajB4alVael9IYmx1Z3J3c2lzRUtGcGw0T0k2bUY1cUNLZVAwWmFmaW1nblhxS0d0RW9wNU9kTHNGRXNoa3BSSWh4Wk02eTVta0RZM0FrX0c5N0FuLUxzaVVWdG5IN2NYNUJPbHZIMVktREFGdzhkQTBpOFhPbkJoWnZ4aFZqdXctbWtHWjBITURVS0RMWk5uUVR1RXNnVEpDT1RQOVc5R0xtaGNfMGRSS1UwQTQ0RFVRU0l4SmxEYzNYWmdYOV9XdWxMY08tdjJib3pvLUhLcTB3blN0dmlPSU9YQ21BRW9PWDFodWROaUJmdktBc2NYTnE1bGc1YmtaN3dDR0xSQWoxUjRSelhDMnVsaUkyZ3lpMTFHZU1VanpoU0h5Ylk4NG5vWGpDODNJcGFTX1FTYl9WUFEyeWhMWExVdnp4SHJ4YldpajQ1a1VEMWJEZUkxOHhhQmd4UzJ6VlRVMF9FcW1WaU9wbjRnTWczd2oxMW5tV0JYOHVHUHlkUENhV2dtbFJTVXNxVXVGQ0dYZ3RNUFN2R09XRkl0LV82YzFWdVlzMGJDNzl3QnhwYy1MdENkRXIweVM4NWZKQTE3aktoclFINUJLQXNneUhKbzFVU21FZGMtTDRweWpkMS1obnZUYzZxRHBXQmhSREhieV9DeXBfc28ycERfYk12eFZ1YnBDX3FIT0dlaVRLSkpTcHdmMC1OdFRLSnAyUzloUXNQYnhIeUFlQy11ZThIMXA0WlcwWVVyWGpJRDVoS2pKRzQ4b1E2THBsaEJTWlNCa0xpczRqNm5nV2ozN0dLZEFNN01jNlpKVFZRdEw4RXZjWWNTSUlEN0liMHAzXzBIQzRKX21NTEtjRlZWWVp4TjlvSkVPZWJLUFVzbndwelVUX05KbjQ4VVZrMGwzeGtDaFlEVDVmMENoNl9MSmhSSzY3ckI0dXk2WTY3N2ZKN3RjRGFfWWsxZlotcmVpSlBRNHhMTnNOZ05hU0FoQ2tqZE5Nb241bmlPUFNhQUtVcWdDbkhsZzN5bDhPOXFhcVk1aXk0TzFlS1hHcmY1THkxV0lNX1luNmcyeFg4aF9TZ3hlcTdRN2ZOYlhIT0Ztd1Ywdk04aXhhRmJZYnF0N2hHT1pjWnVQaFVOaVdDSF8xb0MyUHlIUE1IcEtWcWdaOUNYYkdQNmFhY3J0UmpRMkxZdUZNSnNWRVhlN1gxNm1xMDZpd0dLUWxsUlZxXzZoZGtqUUs2SVpDVTNzMXV3cFlGeHdaTW1CQVVCaG1lb2kzUVItQlhrYnc0RU9nYXllQTJkSUV6a2g3cXFOYmNXNlNBdnp2eXd4cUlQT1FTSWYtMVlSRnZfSDBpYXN2MmQ0R0kxNHpDWXUtXzMwT0hqYzYyX0VMLWg4V29pa2Z3cTNXZWZNMTduN2hGSmZzMFNWNTVHY2U3UTdDQkxxNEVkSTlXc0t1MDlxeWhNWHJwUlZPWTBrZzdsNjYxa281c0VsN1RxYzgxNWl6OU1wS3RZU1RlV1lsd3pnb011clJDNktNYmZEV2poUmlldGo0Z0RkSW9GaUQ0dHJGNjZvU2k0WTE2WkNxYkVPMWVKNGNseWZZWk8zbzBwSk1NQ0gybUlwTVZPMkRueGJSSURIOUxiSEU2VE1qQjYtZkw1a3d3WUVoSHI3UnNaMnFFYUdWMDdXcFkwMUdoTWpEZXE5dGI3Qm0xXzFvcWtsdVcwMjZRUng5Vzcxa0RwU0xPNkxia1RWS2xuMlB4VmdZa3F5V0pHNlZUbU81T21fRWxlblhQMmx0bV9VVXN4MXgwdkxWczR1ejlHV1VYTGZKbVlzZnViQXBwVF85anZyRDlkV2xWc3NKdUMwRlVVNWxOUVUyOEJWSXpycV9ublJVRUJjc3BLR2d1RmN0Mjk0V2xFVjZzNFdTSU5vNG8zaVM1RWtfX1FsZEp3c3JKT3ZQS2M0S05OM1F2cFJDa3hPQ2VwZGpZZEMtbVdfMGxNdWVoVzVmcGUzRnhFMGhjeHFrZmkyUXA1Mk5VYkVZVWpPV2JRZ3UySVVmX3ZBMWpIRW9UTzRQNS1vYTBrRHZaUmxPQldRbTMyS0g0RkhwYWpiNndLTWVIOU1VZ2ZlS0dBNWVJRDRxaWwxWURONkRMa1BKT3FkeU91UGdqMTQ2WWJkZEtQdmFDOF9YS2w5Nm5BV1lfMVo3ZTNKYW9NNzhZR2pMaEV3alFpdHlSOElLRTV1ZmFDZHdYMWNPMG5FQlRnYTZPNzFrSEJkMEpGLTQ5X2FPX2RoWWo0WmVLWVNxOVhkQ1NHNGQzSFNxVGVsT2ozX0tzUGp5dk5ScmkzY0loVmJVWHkwcVoyN1NqdlRRcHFEaW5yMDBra1Q2OC13SXMxcXJhazQtcjZoQUFUeTM4S2FrUFJWYy1WMUQxUVppR3hFYUdrbUg5bF9YT2hFOEtHREIzZFgxNVNOREptRi1PR1dKSlJZNWhqZmpFWVNEVUhmb1NHTElNei01Wk5hVUs5cm42cFBMcWZfcTc1dkZ1TWRISzZhcTl3eWUtQTdLTjZyS0xqMlNfclV3RHk4dnBlbFBBTktNTG5Td09mV2U2eXdFRmFJTDRVLS01Z0NvczJBbGd0OWE4QmRKOVpsUDBUSzZEb0RVY0JTbE9VTWNJNGZXb0lDYkhwc3FnS1d3MUJXc0xGTFU1UnNSZVF0ZHhmSFNZdWs4azFWUlNhQnZnSEh5Uk9NemJXYzhSWmJCVjlQc1doaEpMeVpMM3RldzJ0RkhaM2h2U1A2SUVidWpxSE0tYnRWSXFqb3BEOHFDMG90YkNERnNqdXV0bFdVekgxTXhNVFFGdk1KY1Rfa0swM3NOSVBNTnc1MVlrQm1fV0hiQTNZY1V6d3BPd1JNNnQ4YWFVV2diRUkyNm93Szlhd3BUTzJmVHVncjdzNTJoWTFBNVRpMXRobDM4TU84UGNfeTFyYWJBeEVsMGloTUw3VlRFWmxhUml2VW5JS09ORDdXSXE0U2RHbjZzbXJLWW1LUGRFNy1vZzJfMXVhWkJyblRScHNrd1FiZUVlM09tT0lRUjltb3ZmNkRCdlZlVGtieG4zTHgyM2hwUVRRYlpFSTRORFFHMnlzTXcwSnQ4OHl2dEo3NkpwSEFYbWhkZUpBNWI0QTBYb2JvSW80a1JGTjNlUWlCQlB1eTVsZU1qeEZnVVE0N3Y2M0pyNmtibXpfSEVTZHowOGhNeUozakN4Q3ViNWdJVGhtbVdkQ1lIUjZRYjRtWlowMjhIT0ZCNTl6MkY4QVVENXNwU2wyZmhKZHBtUl9aZ1BsaVBuUm9YNGVPU25Dc2ZLTW95X1YwNk1KRTl3VGZPSXU1ME40cEhoTE9qQXNUX3NCSHBfYWJMb0x1ekpJZXdtV29SRThVR2xWVENOX2hJQk1pdWI1V01lbDgwa09nbHJTNXRMZnNCdW1qTTZXUEladUpjRG1jWlozdXpEeFBkRWdHbFZydXE0ZmpfMFBoUF9uNS1FcEVtYTkzZDFaLURCTXU3Wk54QWYwS1ZBOXVJOXZ1WFNQRDJOVmRpMG5QRFFjbFRCRWhKYW8wM01uc1VGbkxBNVZqQlJnQVV2Y05Cd3ZlYzRfOE9WMDJLRVRxZ0hMZ2tzbkIxdU1jZ0cxYnVQWHF5cmJJelN3WGJiTFViOTFWSkZERl9ZNGFTWGhWR0kyUzFpdGdZOVlsYzl3aFlJYU9pQy1KcTNiRUZiVnZiZnJnemMwOUtiYl9ya214ZjFpWDVRczh0blYybHpSaVB1eExibGx6dmlEYkM4ZkpMRE44VHo4NExMa0lMZHNmdjBHaWtkRThSelU5cFNnMVU5ZURUT0RnVktDRmtzaXdJbEJ5MDRqd0d5NnNwb1BudUxweG53OWhKQnpUc0M5dVRUTmlZeUk0SmxpdWs4Z3ZpR0JTT2lMeGNiRVlXTGFpN2NNQUYtcnI4VTYya2hDYlZZVU1mVGhnQjg5aklmNlZSa3pVSGs0QXVSR1k1QnpraWxBcDhHeHg2M1RacnVXR3ZMa1FKek5wNS1PVGN3V3hEN2N1VlFULU5icVNZRmZYMnZVcEt2Unp0WjNxeTJOMTRIYmdIeUZMYnl6SVVoTXdiNkY2M3dwcnlIN0hfMHp3OGRfb0N3bWVCMVBTQVBUcFhiYjhRZjluQlRXbjFCWlBMbUNVc1ZCaUFYQV8zUWp2SWkwUXlrN3gtb3BGc1E3OFdJUVpadkhsb0NRNWI4UGd0bVdaNUFwVDhPc1dXQU1sYkFzdXRLdXZjTFkzbW9DeFZIOGxzclZxOHVXSjhlQzgxUV9uOG5YNGFqcnZiNm51M2ZXTXRDNmxFeWwzSW1JSHRHd3lvVVZOVW4xZWlBQVpnYzdiQUlnNlBoV1pxS25DMkFyU19lbEVheVFUd0ZTWWxrM2Zjdlo4Z3RMOHB5THY0YkpEalI5NUprM1g4NGJEek5uSndfY2o2Y2Fqb0F3WW9nc3RRZFRnd0pqTU1WaU1Fa2hraVE2SVRUU3lDNUJmOTBCa2VXbWZwM2N3Y3c2cThwMG5NZEdnMjNDc0p4VHNla18zbFotRS1KcHZESHJnVUV4d3g1Z3lCVy1STjdrX2xnaGd3OUw3QUNTbHdGb2pHVzlZSzA4T0J3Tjg4ZEQwLVlmMkZSRmFnaFVQY0RfWXhmaC1qNDkyaGY1SnE1WWtyOGJMZENiZjdBTGgyeUp6UTRoUGREMDdnNW1uNThnT3ZMUWo4Z2tvTTBfMHVGOHBRaHpqenRjVlRaM2NBNkZobEI2a0Zkdk9OQXZVLXI5YkpFb2NOaW5fRTJmb1B4VUxqOVdEdGxaX3N2bWtEVzBjR05fRWRlR1dKLXhLcTdWNDRzck5vd0lCOEprZHE4dUhZXzFadVg3bWV6MHNYc0lNSEFFSWhkSnBJelpYQzVjYW9lTDRfalVxelB3dzJzMG1IU29CSlpQNjNWODhFQVpMVkdtaklwaC1PTkhQeU9QemFlQ21xajFlTVFaODdJSGNhYm1yUGNaWDFITTVvRi1meTZ5RFVzdUJyRkx1dmRyX0VJQ21TM0sxWEZmWVhsMkZCU1ZsRGNpUDJ0YVF1RzR0dHhjaWhoRWpERDVDcEZ4S2dha0lRSWc3VVFBTy1rUTN3THZHdW5CcG4wVy04eGpWRFBoU28zUUNOc29sNF9zWnFqVTBoeEVNTVo3YkVxTzNSVDNTVW1OM3RjdG9LWTBySzBxZmR1bk5iSXNjdG5TcUVPYzg3dWd4VTBXNHlQYjBNOEoyQUwySkV0bXlRZmN5RTBDalkzVjVZMjNlN19UVV83bEk5alBTbnhvVi0wdUhCRjZ0Z2xYN3p1akdJSG82MU5CMHo2MHpXZ01hYklqd0Rha3dPYXV2Uy1yX2RqbEZpeUUyZlJvQnNPNDN5WlI1OGJqcHhpRHJxOWdnMEtJcktBQ0gtWjliTUdxeFBIbHVrb1FGeHAtMWszQjdndE5GdGh4dEJqMng5Q1FBVUJwMFNZYXRhUmgwVlBPRGptMWhLd2FUTnUyNDlxZW0tbERiNTRhNFplaGZqVExkS1RoalFiMktwY2FCbVg4ekpQbnRhVlA2MXdDeVRGVDBSN2RIVHloZUhfS0NYbHA0WDN0ekdoRTg5VDVVWjVxVEZJWmNDR2I4YzM1c0pjYnh5bWZ0aUJJd05sUFRlbkNid3dfQXlOUWhreG95Wk1iai1lQ3NBN1M4V3FaUEp6ZVozWE5iV0ZJeS13S3hFMnVyTTJKRXd4eExXRllwOFQ1cFBQQVF1NG1NT0k3SDlfNzRTcWpMRFpCU1Myd3dUdU1YZW1aSDJuWVI0WmdCUF94UkZENzYyM204ZzRuLUdNNGhibVZPMW1LTllJbDlHdzljbkpQOHpSSWlNbUppWEdXTjktbjRPVHFRWExFVnlKbnlUQ0RCMzFTSFctTThyeUJMemEtOUxOdFZhUzVTWkM1UG1vem9EMFZyY2hFVEZmelhwREJfZGYwNk1aYS1icEpBQklTVWJidi1hM0Zobm9JUU0yRW1uT1N2Rkw1ZFdDRlZMcXAwREJOZEVOS0FiQmJaNGdaaGNEREVoSVQwQzh4dWJ5MjN1MW55ZlowRld0WXFoTTh1TS0xVzVOTlNLZGkwVFVhQ2d5OHhBdEh5Wk9YeWgzVFRMVTh2ME1rbjFRRjh5ODRsOVJlejE5VTR5Z2JqX01CVUJreGYtNnhpSFRVQkNpQmN1UnoxM1pSTkVMNUFzTUZLalQ3Y25zRDJxNS1fdDk4dEZ3SmNQejBTLVctbzFtVnBRSkFjZWZ1ZXBRcUdvVzdLNWIzMWFCVHUwWVc3MTZCeW1pSVEwTU5VdC1Cbnc0VTZtdG9wWWJVRjExVXhSSHl2R050dVVUMlp1MDFJSWlKTVRvYmxoZXlYQkFraEVUaDJTXy1Cckc4cG5oZWFZaE94a2wwZE1nZy1ISlJ6V0RXSHJTZ2tUN2plaThNNnhOY0Nwc19veC1kNkdsX1FwYnRkRGZWaGQ3clRaTzhCNTFQSVN3Yk9aYUhkZHotRlhUZmd1c3p6S0RwZmtSWjN0T010VFJ0U1ZWR2t3eG8wRWdfQW9iRVJSNnBBblRfN1hZQmpFWl9BSVVwQkhmYldjZENyUkN5YnR4b2VUU0RvS0twblJkV0E3cnpiLUtDQmVzNG9mdWhicnNldEdWXy1rT0dLc2FuT0lPbkNPQWdHc2VFb19NTnBvZVpjWmd5QlRlaHFmNXlCQ3FZN2FmM2E2Q0F0V2hfSE1IVzl4cGk1TVlZVk9sRVBWWHZHTFp4bi1xS2hzUDVwM0g4a0VHam10d21CWGFuQVhkNE1HemZtWnA2UkZ2d0VIaFJHNFJQQkZYSkZld3laMW1oSzZZVDZXYnpuUGloTC1PTjJPVnJEc25CSWdEUGVtclpnaVJIVWdnMkk0MXNnX1RMWTQ2N2NYUm1JZUc4NWpUTmRieEhkRkt5UWhNS045UUVBYXhDTGJsaF9FZFF1LWJtcnFfNVZoRmIwSDlocF93S0M2bFlOM3BFR3ZsajN5QzNIYU1LTW8xSVlBTkROcmhGM096U2VHUS1SWmZHeFQtZTNwdmRzc2ROTHE5XzNrdWdGZnB5ck1GY01iMkl5MFk1ajN2bF9vNTFvLVdiYUN1Wl9KZEZfb19JZV9zZ1ZnTUhoTVA0elIzRlBEVjVjVUR0bEtWWldSa25XMTRaZ1hnbFNRRG5kSG5lbmpqR1N0WkZnelh6c0FqX2xibm5BXzZnS2ktZHQ5SXk4aW92cFN1SzhTMmMxRFdqU2xIQ1FMS2tCdWR0REI4RFRaYjZneHJCZ0piNEpFUWp1LV9mUXlPR1NOellNZ01ISHFiVTVVbmpxOFVlQkFlclNnQnEzTWRza0xRNjlRVS04clRZbGszVEVLeFQzS3hhTUx6MmxWTkZSMzRkUDl5Zm9HMnZvOW9PS1VEb3VUaXRwNkdhV29Vdm5jWkdDME52bktJaUIzc1NiQ3pOWFdWbFpDWDhWdFhRQnB4NV9USDNhYi14bUJOUnVQMUZ4dlExNERsanZHQVBOM19DcHhxaHAwTmxzbk9xNzlqYmV0TmtqVHVrUTFZLVVhS1lUVFZOaTlQV21CbWJJTGx6X1FfQ21lSml1M1BwVVUyM28yNHlkR0JFTzZNZFg3aldMdHp5c1hxSVJyV1JUS0g1dG1rT3VwNlQzck03UGotb0NNMURacGZHdFUycU9aVW5hZF9TNGR2V3RBT0EzMVVsLU1DQjlLLUpHZEhyU1NKS0xoODNqM2d1ZDdoTUswVFJmYzVXLWdaZzdiT2xUc2EwcTB5anVKTzAxYmZQdjdQTjN2cTRkT1RabWluNnBJMzJSbzBTQU5NZzlBRkdvR1g3TElaR0Y5bVRMZkZGbkJTUlctaW5taW0yRW1NR1piQV9hNUdvTWxOamhmV2JvLW5aNHZubkI0M1NjZlNwZnI2LWRvRzd2VUZzMHlPUURuM0VvZF9ZcHBwUUwtLWtKR3VlYndlTVk4ZmdtVy14NktjRENjSEl6NU04MzhROC1KTEpPNzVLS0ZqREZGa3JtTGZfTGF5ZTJuekpKVGxhN0NnMUMyWS1kMFJGZnd3ODRHb1JjaGpVS0RPQnlFUDVlNzRpcnVSc2hjQjl4QVUweFpyZlIydmdQM2gwbG9UYjJ5UG9wekVwaXV3N01XZDA0eGhsMWhJUm1haXloRFMxc3R3WFh3aDN5SlNuWE5NMngwdnY5bGpQTmRDTzBiQ1lyZVQ1SXY3eFp0WEl1VW5jaWI3eldUQWZNZHM2cXF6Unp6Wkx5YXFTT0JrQkxJLW82R05SMm9PX3F6dTZteG5tMlJGOUlMcEdxYnRnZHhYTTdScVNkNVBEa1RfVjhrVzdOOXlfTUJuc2RpV05uelo3WndPNldrUlNvbkJPc0licVFVS3NXR1dUZ1E4ajE4dy1hd3hnWVJNQlhrY3lEakt5S0piMjZrWjhnRXNlcVQtM3RPTHdFeGM5cjh1MEtLT1M5YlROZDF3YTRFTWZHMEhFeE1SdmdqQ2N5QTlLa1pnU3Y3eTlNRm1BS2k1M3FXNnVvRHRfX1Bwa0lFLVpqUGhLLTdSa3Y1TmJUQnI1bmctTlR6ekFHc2s2enVPdnBpU05JSWxBRXNlUUJERWNES0c0M1Fsa0N0X3g0VmJ2QW9kQk9lTVJpZWNMeTVtLXo2SVZyME9xX0Jnek16ZW85Wl9xZFhWdFZobTU5ZkhDek1rcEM5WEN2dTVXaVU5UzhsV3Y0VmM1STZXa294QW9vZ081QXJFVVV4T3JsMzlma0ZpR2FvUmNBbWM0dG81anhUUjhuWVJXQ2tFdUQ1dEoxcFFUNkhpaW9XMk1OTXR0OExMTTFpeUMwejI4bWFlcmdBZUxGQ3pTODZ6QnJybXVTWFJEQlhhaW9DWGM3VkoxSEtmSUFYcDY2ZEZ3RjhRUkdUOE9LMm55dlZIMzlvRWhSX2M2T1NiRzJvYkxTOXdWM2RFSUFiY0RhR3hjVUpCU1JXeTdUR0ZhcWdhemlwRVRnejF0NThlNUZhS1AyUnoxMHV3LVRHSWN3VVJtRXhlSzVnbDZJWWdMVThKYmVNdWtpbTM4dVFXaklVQXEwOWhva3RsRFNueG8zRFg2STJjdFYtRk9xYk9rX1dLRURHRG9aRG9neG84UFNELUJWeGJrQldRZEwtTUNENUpzblBGRjZhLV9BdFBaWktKYnZoM0t5bWQwNXVfbk9qTURUdXFKU0xuNUV4MjFPbXAzQW9WZlpNYVlTV1hzaXpOWU10cEVReEMwbWp4aDFFLTNmRm5uOE9GdzVnTXFXNXN5d0ZHRklYcUF5MFlmc0Fsb0ZBTkstRVZvVmpCbjY0b0Q5X1NsNVBwZmxFZVlaSFFRS09IRmxWazVwdUhlZHdpckNfZGhkdGp2TnV2ZlNSb1BLU0VJWGxnV2owRHRrRkFiaXJkd1FNTFBUc21CT2pOYnhSWFkzVG9Qd0RSZGo3eC03VVJxY2Ftbjh2VW9UT1MxYWE4WVRMNm5FNVhsVHpuOW01MEh6ek1Rb2tnemcxQlFLSjRsMFJkbWw1a1RiX2tTRm5XY0hobHp5UGt3RUxvZnZfYnlBN0lSXzV0d21LLUZGcUVsYnE5WW1IaXNrR1BWMlpHTDFmTDFGaU1RSmtxLXNzeFlTNjZJRVZ3b1pCaGw4dUZJbnVidXhFeGJaSEpTX2xQY0pLTnQzcExWazJJSzJpc2duVFgwTnlJRWNzMG9pdDlfQVRERUJ5OHZwWTYyTjIxYk9la1lJM1o1Q0pleFFpVTc5VU1wektndTJvTGlaWnBaeXJ4TnVMa3BWSzJpT2toanNaN3gzNDhRdjBSUjdRN3p1aWM4b2hnbWYySUs5cjltOW93MTg4MlpRNFlETTdlOGlxc0t3dkZkOWZuOERlcWl2cmROQUhRcjFlQTZnN3BVSkpZZTNiUDJKLWpGSnN1azQwWXBFUXZVdGFaZjF0cUpPQlMtWlhvOE00aGEwUE5KTWx0bFhmZGJub2x6aHRnYVF5blR3WHJBRTBSZmtnWjlMaHFtenI3ay16TWEyM0t3UHdncDJmUGgzSmV0Z202Nkp4eHBnVjQ2dVl3UTVwSUFibll3MDFOTUxFTXlQaUNySlFFRWtwaXo4WG9hOGtJMkdRdkh3b1pTYlMtNzFZcHMzQ2oyLVZkRTBNaV8zUnRJUEZyaVVTUERfS2cxQ25pQlduN0IzS1pUYjd1MFFwOXl0VE1TdDNRbUNwcnR4YlktVWFwWEtESUYwYVVCN1RPaDRuN2lFZ0pQYzV5M1A1LVZkQ1VxUHJKS2VwckUxN3AzMmFyWjE4VFFwZE5rRHdXRWJWZFlMZDNvc2tTdkhCMHBmbTFablpMZzNpSGo3SmxFX0VsT0RIOVQ4MXRBS3ZyUFlzZUJsWnZQbEdUbDdRN29XN0tSZ21zVDJHMmlqOW11RlVEWEoyLU9ycFhHTWFURGxpdGNhcmpXR0tjMXFJRWhzQ0IybjI3LUlDX2FnbDdHbG4xUkdCRC02bEZGQjFuTVBWcHJpVGljQjA3THJZblNHSTVRdzFpY0pYNnV1TzYyOHRTMEh6Z0llUEdRVzhPMEtyR0xEZkktX2ozQkphbEN1eEpMeW5sdmE4MDVaWFZ3RUdCcEcyaGFOSlVleXhJeWFSamM2SGdOZzNHXzNIbFItWXhiUjBfSmtEODJwczhfd1VmZTBGOW4yYkUzWEVNeEd1bm9rbWdWbTdxQ3I0TzNxQk1HZ0dvN3ExNFRVTGhndk9GeXVZU3BKdkJ2a290NVptZS02SC1idVYySlVjNENQYUN6Y0pFSnB6QlNmTnk3eEFlQmNvbEN4Q0w2MzZDZS0yeUFGVTFFdjJ0NkN1U1BHZUlyY0RrRlUzT2RWOWxvRVlJaG5nNUdEdDdXUjN1RDJsRkh0M1dWLS1ieHkwSFU4YkZmT0c4b0hoU25NN1hsOWtGR1ROWUVxUndIUjk4eENYeXVlS1ZEMHVlN0ZPNnotY3dxV1NxX3BFb0ZUX0V4OFlHU0EtS1k4N1RCRFY1ODlYSEdMYW05bm43RXJybTdNc1p5Znp4V0NBb0U4YkktX0hRN3dTLVVTc3JuZkh0eVJCVkRMcHRSUDVXWDhTSW5jekUwbTFsZFdRUFRZdDFZTVdld1M1Wk5GWll0SFFVSU9FUzNRVlZ5dWlrcXZQczBQWE5Db1p1ZUJoVVViZlVab0E1WFpDTXFYWVdsQnBUMzRVWkRTV3RxUnRVcXhjZlk5YmpvNzZWNjRfSFAxUHJ4V2NQMFZFVi1QVmhxTE55VmRZd0VsRTB5YnlyWlNsRjRwVlM4VTdsd1VlS01UMnpHNWVDLUktakxpUEU5S1M0eWU5WEdtZjlVZEZjd1V3cXBiMjl0cVFFdXRUNFRmUU54elM1dzFqblUySF9BVmxvNm5LZGJiLWt5RjB5WGZyRXB4VHJtR1VSZTRqMEVzMHBXbU0xOVZxY05yeDJDczh0UDlGTlFxNlptQnJ1QVY5ajE0SlpOdUhvY1ozMmU3cTdsN2tfcWlseEtDN1hjR3lRS3U0YlpXdS1qWUEzdm5OSDVORnAyaEd4aWFLVmRka1pDQVlTUnBqMHVNZ1FuVGNEUkppTTJoV1piaGY0OXBUaUVwak90dmhIbHV0WDdYdmpnTDVZcWtVRzNBbUZVelZIOWs1QkFpUXo2VUtwVVJjUFVNUnFPTG5fbkpMd0VsY2xKUE0xYldZdEhZNHNTdzl0OTMzSjZxdzdENFdNRGJRLVI0QlJubkxwNUZZRUtSY2Z1cHVKWWtxV29xd3dQUzc4b1E1UmZfSF9VbVlBZEFOUXhsLVU0MUw5RTE1TEZqaFBsMUZObFhNLUp5ZVNJNjhlbUJ1NGNWY1l4d0oyMGd6Y2NuSWs5UEtjdXdUWE1IUjVIMmNtZENxRnVBY3lYUlJCaGhGRVBfNjFmbmxnRjMxMFZSdS02c3JmOVhnTGFuMEdtaVNZSC1UaVpmcUFrUjItRVlvdWxFUG9UWUw5OUhTekcwQTBveXhpc2YyaER3Z1NxNDVpbjJaTU9BQnRrNGpGT2ZKQ2kyOVZxMkV5YXVOQmRodkFQeUVzVHJpcV9ydHZPN1phUUs1Ulc3QndPZ0RsY3k5b0ROcmVfRG5mZm9jRUNmc3hMVndab0Z0Sm02eUpoNmU5SDVTOFdMcmF3MEhDTklaR2QyaWNTUTJEMG5oMjh6b3JSY1lfanpIYjBwX0VIZk1iNjhxa1hoQmREVE80ZVQxeGNtRmZuUXRCQnRCMVJYaEd6cW1MRlhTUXJRRWxHWFY0czZxNWFYRlJQNkljdGowQk02VkxHWXVpOUdZb3YxZEVrWVRaS3Y0QUtnQndySWRGazl4N0hOT29YRm8yRlgzY0hWTUpWU0hzck4xY00wekN5SVNGdDNkaHB4TnVsVHY5TkdfQWZmUUg4X3NQa05Ua1R6clcyRlM1RkZpTjVrQXJLeUZRRGlWNEZHZTRxWE5WbFhfOURtLW1Hdk03Q2lPWDg2Q3Z1OEg2c2JEckxFR2VxdVJFSHdxaE9DYnR1VDljczNIYlBsbDlvODhxTkw4TV9CSzc3aUh2a0lSQUc2Qkl3Qkt5ZFo1QUNpVnh0NVhIZ0tEUE05a1VaMTdLM3FwYXFUblk1YWw1QjF3bXVYMkwwSDVGckxxQjJTTFBPUE9zcU1RTlNidGExQXBkai1KMm0ybzFWY1JPaGhWeVJza29iLVNOUDd5WGJrbGlUOWJTSHl5YzFvbzFXcTZKYnNZd2hwdVI5aS1YX1cwYkc5M0hyYS10c2pvYmZPYjFBeW5sRXotRGpqZXl1eEt1UGVtLXVvRVlTWkZfbXRsd1JxbVNFSkFwWmlxQms5VHFTZW04LVBCZWxRR000MVhBOWtFeHc3cm41anROODZEdTdUX3JvRnRTWGxpakFQUm44ZTI4XzcyNEwyTWtrN3FPREpLMkg4Mzdvc3J5bjNXRWE5MW80OTJuTS1BcGNTZ0pfUUEzbURqUTJtaHZNVElPakh5TFRCZlBjaW4tby1UQzRhc28wdmpJUEhLZ3pUeE5oWnpYNHMySjFSRF9ldW91cHhfNXhocDdCTDZSTWt4eWVMd0o3Y2VwZFhDVmNmdzdzRDEwQnlyVGVtSnVoT2oxaWhrc1lVUmdEZFI4M3pweFl1Sk11a0ZqbjlxbEQ2a3c5YndNWnRpU2h4QjFZUHNuV1daV3U0TXFsVTg3SldZQzlEMzFUdXhiNFltYndsd1RsQTV6dFBTS3diTk1fYUI4aXZVUUhUazBPdFFwcndXMTlCdU9FbjFtWnpBYnJ0WkUyZ3NFQ2w3TTREWjZWR29nMGtza3gwSUlDVks3WkxEQmZRYXhIWmxFOFk2SGFCS0JrekhKSHE3MUNfcnMwcEo0UWZRV1NiNGdkRFpIeVpWY3JaNktPbEZsQTBma25LdEN4YnpjM3U2TUM5enFXa1ZYWWZZeWVvM1JSNUg3UVJZaUJqM1R6SjJVMVF4U1VqQjZyU19XeW9vWlhnNHNyeG5QRWdKak01TTdfMC1yY3NWVlVVdVNzT2RXMXFybjRlSy1Kd3Q0elkwUHhLYU5wZzRkMTFLUURIVXJkRjdPbnd4UmJ0NktLSFlGYW03UGh0ZVozV0dGbnBIbktzdHJYOVk2bEREYjBTLW5KQ3o4ODF5cUhUSmZ5YkhfRWFxS3R0ZU5ub3dDc190Nkt4NTVBS3o4c2VaU1psOXJnb0k1V0FrVkR5YmlfSlFFdTJnZnp0YzN0M1hCMnlTVDg4bl9BcDJNbU80X0V4QXBoVEpfNzdrYmJvWkl1Yll2ejA2Sjh5ZjR5Mk1yXzgySlFLVVBQYWhuNEozejR3eS16d2EtaDFLRkkyZThQTDZzODF3YmZ1QndrNlBHNFItZWg4UVhybEJrSXVqMkJ4eGU4VUZ3VUZONW9kbzY4VC1SWTF0bVdPRlZndnpDUkJKc1Zjb3htLU1CTGZsdW5XbTBVdDRvd0F1MlRKQ3lUaTRpWDhIM3E0X1lQTy1zMXBiQnRRaU0wQU01azVFNkdoZlc3MS1lQjJ2cHMtMjRORzE5R2gzTEhvTzNlelJtWmhwX3k3QXYxV0I5OURrbmJ6NXZ6dGxwcW92Y2hNNWRDOFNQalFkMDBDRW5NRmtwaVQ3SDZZTmFKVG5BcnVoanhTU2RKLXUxSmdGSE1ObzJpNEtfR0xxY1BlSGlIaTlPZDM5S2NGdVNQeHAxOV9wc0Z5bHRzWVp5cXhoNldJSG55bkRvdEpiOHd4dFU0bk1FMWFvazFZNk9yc1FUeGFtNnBFQnludFljbzFoLUlhanZHSGliWkV2UGdLNjgyc2RoZ295RjJ5OG1na2JTNWxHVDd6U2tYWm0yeUZwOGk0X0tVUnlYWUtqUndFZWdKTmktQ0gxWWs3ZHgwbExOaElOVzJEWkdyN3RFd1dOd2tFMzFHdWwtaXZWZzdGMTNMN2xXNW9OWTk1WXFXQlh0RzBsRHVoUlduSHg5dTNWV0twSDFmT0xDcnVIS1VXdzM3MmhtX21KS3U5UW1tQjNrWDF3SURXSkQ0SnFfeWlaekMxWEdIOEFzRmJfOFhtTGo3YW1aUmRwRFRRSmV3WlE2NXFJem44VEx0ekFhTUktUUlQZXJDSEZmeDFYWW81ZUpWdHc4MWphVHFRQWJCLVZ5X3ZXMG4zNXhUVklEOGdJUlpYakhRVEg3YTgtaDY3ZVFPdUNtS00yR2NZQjlFSmNRLVRPdUd5ck5Cd0lBckNxSGxDSzF3SjlPZjFYMjQ2cjY3dnd6MkJCQUdRWWp5dF9yZ09PcFFadGthV0pMd25ncXEwRE1pYWt5cE5LSlVJbEViX3ZkUGp6SFFKMV9IVzlMSFB2UWVHUmVJRTY2YzEyWlBBTm5tcndDaXR4M3hzcWNJZVd2d0Vya0ZzcWMteUlZbFd0V1Y4ejVmdklMY2JvSWRxVTJ4c3RqR0lvZDhudEp3RVRMeDJJQTZ6TUZHZ2E1UDZkcVhiMm85TUtxT3U3Z3UxYzBUaGtjVzB1QUFSb1F5ZzhDcnMzX0VfcC1YRXpCZGVWNzBIWUhXNk5CaV91OUVfLWVKVm13Vl9RcmJxanM4bEJxeEhsR1ZyUHVIbjd0ZU1ncXk5cjY4b0c4RVZRRFZUV0tXYWZ1U3Q1bHJpWXlTMlk5QnFqbXduUlBFR3lqTzJtLXVNRTRHQU84d0s2eFZVeWF1emlRQ0FyLnN4blQ5QmJTbklGT0RKQ1Y4WGR3RXc" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/BackupKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/BackupKey-example.json new file mode 100644 index 000000000000..bdde2957a953 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/BackupKey-example.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "testkey", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "value": "&AzureKeyVaultKeyBackupV1.microsoft.comeyJraWQiOiJiNTc2NDI5Zi0yNTY4LTQ1YmUtYmZhYS0zN2VkMDdmYzBjODEiLCJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkExMjhDQkMtSFMyNTYifQ.YMIP_MrQq46_fpDL_H3RJJsIJ-3NhyBd1yk9bBKNI8ggN31ah6qehcPHHLgJrx8jkBLLXPqp5f1zlil_rUk-KkOryc8ZI9cssM5_Sy3xpI4Zy6WIc5cjPWuGCCmBpAyrtGOVzhjQxo3rTW1DSqgZUvr8TJly2PKrviI_RgnEd6-RVKuuVN4efVaK9XVTmn1vfygzpTr_TWC9PFmzhOJzgU98_9_nVrWVHNS1uLXJXnWhAOfRYtVRNEQIENeLc-g3cMrK91s6NWxNqfF_GL6Px6qXG2WWCOg357fBgOVStDKiVH6N1MedQ5piadxxTT6LHZokB4x1JlAIfL_bU69PVw.F9Qb3tVlMKprCKK-YEi82w.T0MQiauw0l9Mb_DWDcXoo1jN6IYu59Y7SEL2mgtU0x3XL9yTsjeF4cb44LAh_oP7gmH3n7J-VD_xJ7hWcMW6yS49E_M9iygt9SCl9f4Suki3CYvL0QERTYKImj2-AFDLZIwNmGba8G8axPqGcNKsRgGZgYTToiYLqBryrbvLJudCqgjeQdi5MmtyPFpagHpHvKkucFGp-XmJ1KbO2A2QOWQTQZ9CereBqrCn24IwaQrUC4rND2w0UA1TcwEeuVBGELdJZosXs6CGDfjZHqcvpz74Jwx5OEiq_DPs9TKrkMhowcEplZ8ZJMcNQRfu9J89d7YXgGdB5ikJzp5ZV89w12b0zCHNYJjgddHS62fjVeaE1OOP_7yfX5tJb6d5AXigr-JJ3lb7cba9q64plbiarMKzab5Hm2LMFuKBr5Nako5P00hQBgGc6ipIK8MOcKsdaB2Fr50_Ub6rDS086u37-CHtFFqy-1AhiCixQjCML_kXkI0vDbbjF-_xkMdaBV-Au79O6zWjsDeeWKtUvVQnB0c4By7IWCLeVw22i09Yi72zBqfOF4rNgxU3kJ7_-5boWmyYW6wM8esN4xGY3PhU4yKE_uDg6vNNwt5scWYoS0xx6PCos8KDtcr-UypQ92thU_FXgq9StTYq2YgVWGPns5CDLODAJ-l11I6IitlP7HhyLo39j77iWfTKDgL5kp7D9E3_qdPZktjVPDu3ZQcT739N2zz_1kXrDom-6PPqwVS6mQzAUmqixSivcqbqjZIFtOllKFA6qerh2eSAYzTMSCuwJxDBRB5-n0MQlIHjC17dLZhVqD1Sb6Prq_y9sv2ivWq9La9GfGlHA6VY3T3QdSCukYRjXXq-B-NnVdhFMValVvosrJfnHFaXfLi0gs5U9Ku4yjD7QoW1yR1IY9OrZ4qRQwkpnm9O2rrH1pm_XSzLQT4kZcKbugxsoYtlDOSiobKDXu1MtCqvDnvxz8Fw1GpMrBuLkVQDVeeP2j4ZwLlOnLTNi8bScNm_7vTsTPm4ID9mjpWI8Bap83TKi3dzP1k1i3Ggrr1HJUAOzCCcQ4gilDKZ8RElQe21BAqJ7yEnnVlucyG6AWa7viYYuxxBHkDl7XGdvX0jI26rwcS_FH2yNiafd3wJI1342XAvT7CQeh8dZedJSqXQGjB5BHayV_ofzeUp_8HjFDhKUdrcI4i0kFppHdPXMAu128wDu2LnUzyM4JZwSIum_njbQ3ISTymELNx3wt2WSEOd7AKyKyB4BsSsdPMGewKI1gsj-HCEoNBwxPBAvVqCII3lf94m-EM8-XzNtBUqiOv9dDBkgvzJmI9k2O_VjcmFknGJoi1VzYpiQU4XlIZzjCwsCDqkahubcqXWr08UtPmWHFEy4CKorVL7UHiXlVrOGUGtSvucwKdcKTOzWlRx-DcF0LCzMdGZwcg3ei5mitlYbF2UlbN2bZSCPX9c9lESdAQHqPEl5raT67h9VxlOswhanxJFo4enDCZafNmDFG2La69EqBV6KLz0_4uKZC5mxavDk6WKyfoDNyqsuVLto7YsjRN152X05XHHnESz4ne3c0jwWaz60ZIGD5MHMQHPy7O4WgakaVsJeOfaCskwbb49q_mBsX0NfZPcqabDXhZ7BYLQ9XERGbnwd3JDBh-_TT7k6XDicKTnVPueF7wsV_4hOGRJdTI6PTfWj5uf8u7qEOAuKy6euVMKy97MWKOT8-ZQl0hIj0rbVGZH-R4rqH1v_VgQPdi-qWoqWqky0aZK3CNA3QxWftLGp0qEWpu6OQ-ChN7-vxN0tUeddDZQyWWtwx6TW1KhCBWZGjZm9AC68bU2BuNME55oUWGlncN9EnFzgNmQMTuK5vTgwZBHMjfQzlIG_yfwAumHycK5OOOvx95Hc7wDAD2W1WRohy05yLRdlBv_4DQrrMkadEpf0utvhwUwevR5McVEybOwUL6gf9krC4L4bTumBQloBrx5h3nLxYw90rijlnKj5YbKaejrMwbImyF-qVNMmjSwb52StJ0wOG3xOGfBQDxPXrmIxh0DR8GsK0dy-1HIIej5-oRMd_J9aVKz0Y4wx6V23h-jP3q24JbawvwlA6rV5iUFdh6JQriMNC-_aD_u__5U7t8CH7ZVCuP3nIi5x7gmqalK3egHm3pdb_lowXE4ZEBDLvtkihl-w-PFsuYoUJIFVqFvVs5EnSSMW0PIXOSfVMYmJZekbiG_QjxkB23BhzYrSjCz1qnSMx9kvbp9Qh1ndRXJJIPU2jeHuLB4OgW3hzynCaqAvPEuG2XnKpxXfxAKNzWiLIN-0lQ4_Qt4tw-fjaYRUV5KUjrbVgk2506HPmYTGVQWQ_m7gSASPZj6DbInku7K8EZr6owuH253Xqk9kIl2LMBpvjOkNMaQMxKr2-2YdPEy--fMAPLp_UMy2xjlKLKk7nXIu_H1vRng_VUrVHneGjFan87QEORSV7rTAprO2fT2j_9hh6JmtYkQqgG86YyJksUjWs3xpdi6NPFELjAgyOFC-4kMgKlgI3iTHIBWQ3jjtSe0Gct1K7BpBJRrIAF-1UB6JT6cJ28gMswI98kud5hoXYmT5lA-ZaD-I8dM0qFtHH8kYW_nzzo9m69-iYfV_wsy2mBvueoNQddQKBkmiUMnxV90tAyEg8YrZYL1rOcXqcoeI6_8RetmvYxVM1bpuq_j9fMv-zTA9JCeyJ1qAN5VAaicIgg1JXICLB9jeSOOsQw1avqvM7N1ArwCr6oMHrq5ZCEK85yVb5G8cctewoiHYsuYOOHgH3LnchWzfJ3MiEcM6_V7RdvBQd03kPzGEV8uI2uh9tmLk6F7UKzYM6ExI5mKPC9-QN2Mxe0z46ke2mxGGGw-yqL61GGAiKAcpClK5GxyQmPnDJ8DqJNOVX3h_o7a11Uo32kdtG2huXpDUsay6E8TbyGWEgwfX7ZVvk7UM3ejt3jYpqbdYJPMMBB0gM9OfIQcKITroH0rDlQ6ZkxPc4dpeCmM3875pWNQkg1JJuQg3xpOVgEFjYZlED50EiVJ787qC5aGmjLQZ_r-P7_hI7OepLVgPGHASRLlwGN-FpL78QoUzj_Xu06Pd6AuTLmbjhViDD-udnqu5UGwJ4lYjbjJCA7uPOe_ujsQhYwUGA_XBylnErIlL7OXHOTxaDlJGH4-4wMroanhOY5hgcVdvUBZUgRDUh40l3z8FUbaRlihE1yt0uNoGqwMdrZvhNIwaQcPYPyUwQ7Auhuv_jItUqiFBogryRoscwz2qttjmv8AQYHyAly9ujvbury5LcIh_EQfTzBnJy_p5Yw0CXnBK87fEH8raZHxWETpqlxyfYdVf9PjDXLbLabVCbzMsR2sXfAo6m4VhghF-CGNWymknD00Tme4La4W-A-OeGj72-n8Vc6b9g78wnmbAttdrQ8PYWKQvcuyDlvyEGGH_5UmtlSyj2JltKesw7Wsj-ak8CX1btdsSlhBWcaBttj3RjwlCxhD2MyVttzt207rOB7qtAIyX5zrY1LZHpwEmMx8dZs747ecfaeS4dQBZczSyB4VEYTQXgHygE_q-bw_exj5k9sDGxsSFqyzQBVoU9Kename4DJsLXWZinuPHYQSmX2TdPZmsdHxBkpAprb-H4HgEJpOalBkGwhXskHpb6TNHPxy-oOm-hAizmMVOg9gL2NHzRuAmoI3U4Ewa_GEnowteAQSLecMzZ6qgyudk0pnuRyN6P1m3BSQ184WS3jx1C460LAJ3arI-4Aeuin_0VX3qGva344vet87DR7IbME3KMkYkTuz-hzjnxGUT5qvaZv077PTq1m5CQPTdee6Sg34f-ylxh70j1I-NZvwhP2LVv92duVxJRR7xslJzS575q7ifuPG0Rzt4Ny3YDJz4MeCNNpZIpMBJxdvnG7k8lmyoBUQbdz8xBunXOqlD1GSm93NKc-wo7qfzIjv0Z1zYZp-nK7J64E-Jzx2D1glIDnodl9GmyS9po339IYaOPfRgI3ZwQSVGppBP7GMEGlFEqlo7m5-4SYXG6JdXaNr3iQVghPKdAei-bCLAPlbFJCEAU55r_HEfKlT5-36SydteqaSdGo1XFEzZuaH-_z8BlwXW0N0tRitz7Ixu9NANC8GutgkvXuER_Nnw5UIlarepM6TD_Z_e8rFD7haxV1WtoZd9BSwNbRmIyu6cfZzX2xSOVRUJwVHG-Y3ZDdiqkso_WGBvLRJBTVOsoeVnqe1ZKjoCQK1DaFOopxP7SMhp9YicoWFOUQNN5-DB3-68CmDsv15-s3DTqQC58xiwbY-4nYktySQWayzTobVNXmbvb9K9-uj0aTVFLzH1G0YvLmhSSSwk_3O-ctRPLEnXPSQV6GUOjywLHOXSD6_cYS7RkUtx2g8m_1nhIQm08Wui5MJGPGBDoDf7K3wz22tgQQWL10cbtJUoBF262UiH7LNi22VCkl0IX1UQ7-wpI0p8dWSoWo6SnOa7dQ5iBIbf9P_rQwWaaYu5_ZBZpCM4UqVcgaGSYVsqDzWEV8-tck0X8NuI2rgrR94CJxcJk91l-oz0nWaMAhprnn2_wxRXGNay36bjSq3YxM1stt1M7Rczu7Q2Pz-fdjGYANHvqAKXQ6imJaAsplNtJHuIJujwrNTPwFs4a9l4dXwM04QIfhc4yzmbp9XF7UYU423WMhQSdL5JZNWyAuq8AnG7mwgSP3T24NThuSFzf7uNNrJg_PY9UCVriOKqD7YUKARgQECA-NkalnXSEuTCvk2ifEX8Hzq2Il5wLFr9QJV0fO_DRCrS5sDuZVbwD24cejOybmguUanL8b2IjKxzLUOOke2EO5TQMtPQfcy62vEyscpC2EawzaCvWub1SWKdYVu-qPstUxyiOPsipTwWY3MuMFJprSlqaUP1Iksz3D4TjjHIsoG6MAllTYqB-IjnHHfc26nS7ra1yUcltHEkDwt8GR6ng-6OW5bmOBvTQCjdTP8RmvwokHEvFA9Wlk69VHTZEJSZ4gQeqsqo7HBICHwvUb9mzbHgiNtld5YAGOuuSpNLMTq39-33UVhN0KkHKQvBzr59qfhPHSyUFuLg28ojX0doox2JQDgPhlvUbDwpinDBjTpb07lcODaR7ecv3KC9HIAWkx9aWIskmXoAVaSVL0lgNMC3GVLR1D_pehA6rIk6F_jl647L8HDjDRDn6QFtHkmAamtMOVK7O1-T_-TNWph6waQNu0kWY-ep2DDgt96ztXRFSUgM9rL2y78CN2EEYmfAI-3UcjgTnU1FrWhFwt-I6Uf4Vp6V8_6qN2sT2ryaKXz4cBIcCh6o-KDi9oyH5w0Qyx8VoLS6StaQ2aNEz9Jjg-gCxiZtCRXyigilw549UaV2Wkxtvl6dydffaS3jmaLjh4f9xGkRPEGjffo1V4uCyBB9BChiUBdmjTleVRQ8nBrnVAnjauHa4lWud6HcK59V2MNZMMWmKKooA8qkn35TcnDuynJ2HMCgdIBJuPUOSy25Bxnfp8ENMJVkW_TyOnMy9orm55hlxfJ4D58ZwaQDK4AiEfMHTwIsOngjgSJ4KRCv1QkSUx7XEXMSIMQkTa0jK_Z5-OCVMssAo13W85VQJmZCCKYG6Vm-rnuXIGYfVV-858ow8BYPhCaTaW4dVpKXDCD5_sQljgIJwtVg4ODJcWqzRiYjTis2W5cvPoOXZ5B2fqZU9BXeOAc8Kv6kfCUjt8UyP1Shk07lmgP9onO1btyW9VxPHNnPw166CyrfUW1hAGB0ua1MbkDU7_vN4JZ0cuV5_b-olRo4y_rxd7PdVDBldpVMLlWxZ-XbWUjtZSVwZOMk8KoWatnWz5R4KVK6AgmbELxikS1J61gYI6XSro0Fqu7GM3bWvVPbmqGt8I_Tr3GjiJx6w9HodiKlFPsbLjA79bnHnCpwpHFAXb9wq7vc-H_0MMVTl7xNzo8HgQ_GkOXIu9_n1Rbe-RD4WRiHwTnbnYmzG63xowGNPI7g8Gm7fL_NzCXhox7TIHW28tXQByY8fdw_v-1KoSiaJ3p4pIRyQBmkBzf99FFZOKh5mLK2pkHOH5aenQE6x6pqCjCdqnwS97xbtJJuNAx3UzP7G3iyZSyel8HGtaMTeWHO1nhOedSeq5ahi8tAEyZv0QRqLlA4ZALkThyeCYrJAwW2iBZ9nCEEgzljOMpu2gtzCFy9ZKYYIhifJuT7vPGuXFMKKVX4XU9feh8XH1EVnvxpCnF9yxFgy8nUnBuGlFEV8UBUNh8NApIYcpeL7yCQyl6P7qhrN7HHH4Ih6hKKiUiB-Z4M0rTJOffGz0XFZiZH7XOmJk0MszBlEahAEn2SSRZiQWM8lDTQpGk_JwBJQ_QUNkLfxBpzlK0T0aqKWw3ghXY-OqjzS8q1W8uAc3ZlTT0VGEgVuO26_oEzWNvXbzJ1E_TAqREVKL_9aezms3rjc-FvWRGjLWONMxTtl9g19DWalP6jReRRExH7v0KLGoHuuEnHTsP_hl2vn3NVYiwtQnjQB9zb26JFlpg6EhAuI3xlVL3xpDOjeIO5s72YJcS3r03bB3m5G1IcEU8JDvY1y22Phnb8ef6z5ri8D69rUKY8E9qkhLWaXN24S-6Ab3QeKJrlHGOrhG6fJBtIjL_wFOdZ2j8Z4mPYvbZ5CDQ7g3MraXuiRzqgouy7NIbzjs8FDND8dsLGVt9CKjtU2tykBkIJPfXkgu4-JRTTDN3H4gpzOfwPyW_19tLvPJ4JQlysnxJhJmInSPKTQ9crRGTQeKAwLvYzgB0nPZB1wgPUbGitlhySWZjmjeUNhJsgoFwdtEu9hN4Cz4NYEKgZ3ZpJL-lfeInjtTB07P8ukiWqGxcAiR9L4Ov_xVlMboanWn4CM-8UJvcDhUDkiLktxtI8M7fM5nx-2AR_s0ryCWAubefALQtuDRt51VkfyIfBvQarowH6zH_V_gYIXWNt9oLILOqk4yjrdygFWY9vAvP7V8CYkiFnIUkXcZyClOgfq39mtJxpL3csouZXTHp11gLbmdT5ESn20E8bnZDq5oHEDXlOlfGHOevlzFtB_UxGXtKYX9J1AiKzBrdb7BbozdEp0-xuiy6XDZub79-mKruPL2ZYb1i5hVjQACvFp2PpZOi7xUfJRhOFwf-49JaTOWN3-aXUoCukCi1gj88dCoPYcUuk9ZlMzZdWXIp9gCX27_zSE5YDBaiVCWOsw4CJFbc-kQT9CZ34dSXbs6xKSt9-ahr9osicbGciZ1ICW_6YdK3IzrHuQEzNsCCKDuobUQQdZARQLyaeGl45g37mFoKP7bxoMZcP3F0w37AGLLW1cV-6uNnihYCZtu8YrFPuaxh_UULONMResyLUlDurvlnAUyj1U1MSlC1LkOm_UWoMuPs_UjSc7H77E80rgvBfBA7Z2DP2jV8QQRb6CTbxKiFI9LXfFR729EqDYUuQEI5d3tcyb7u8O2eBv_Tj9O4ODLyZ97gpLuVwuJUoqjARgEOuSiGul1hRqa9y6VtfjL4Njj2Ib1lcbrA.Nqzdpe8b7qsc3BjXFXZYZQ" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/BackupSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/BackupSecret-example.json new file mode 100644 index 000000000000..f470b20b3ebb --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/BackupSecret-example.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "secret-name": "testsecret", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "value": "KUF6dXJlS2V5VmF1bHRTZWNyZXRCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUppTlRjMk5ESTVaaTB5TlRZNExUUTFZbVV0WW1aaFlTMHpOMlZrTURkbVl6QmpPREVpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLmhERDdfVW9aU1ptR2JYN1dYUTU5WDkxZ0FQb05kdDcwZE1BbmgzbjQ3eWNjbkRNOU5vTm1hY0NHZmlNeUwxU0FlZDk0UjhBNDAtVE81TDNfQ05Qal9pdWIyaW03Z21nbHNPNnFFUVVIWU1tOEh2Wl9odFRrdEl4QzRPWEowYTB0S2hscnczZlBvVVFDZHVGcFg0ekEzYTR4VTZXTUNfYjZZVXZqUjZnSGM5TFRUR2tIazh1RTY0aVQ4cmt5RDRrU3RNcXhnU2lfRVZwUUdjWGdfNE9wQ1dBOUFha0N1NkpybGRaQW9BLUtXTWpQbGhaWHFYWGMyVkJlbUJjRTQ1YzY3QWhqYjJrSi1uQ1c5dHBjWS1JZ3JEUHFzWkswOS1WbHVtcl9SbzQzcG5FeW5jVFpTdzZlX1h6VnN0dUFOZHdiM0E2OVR1c1hfYkJKZ0J2SGQ4cDJSUS5WMTlhMVRacjZ2UjJHdEVaWGtOOXJRLmhwMU5IMmwtZklWbVgwWlNfTlRzekJfUEs1aktDUU5rSnJyRUhRQmZjQ2VjdHhmVU5uVlB6MVBqRWNDblZuV0pCUk4zTlFKZm01MjFLRHp1MzBIVUFEUGVmVHJyMFVFS2x5QTM2cThoWFY3VTdoQ0dHNk85NVpYclRsZlVENDI5RTNTNTQxdVBmWGpGR2cxbHlucFNTNnAtVkFzaXFlY1lpQWNuM1hhNzRhUm5xS3N3ZzhyU1ZOX09hSVU3ak1VVUhYZWY1ZmN0NlFrdWFfYkt6Z2dtR2ZiT2RTdVdNRmVQaF9mMkJMUFNGN3k1NThEMFZxSVlNY0JJR0dMU3BQUU93Q094OFF3Y3NVUEp4ZDFuWkVYYjRVNEJZYlhBcmFMX0NwekYxZlhYWVBsdmVUSGdKNVdrR28tWXNJVzAtT3ZqVGdLN2hIamxpR1psd29HOVUtbTJSVDZfbkhseHhVRFMyY3JseGNmay1OOTlXd0tEdUxFMTM5ZE1mN2RCSEl1aTdxd0RXdm1TN2JMTHYzM05Wd19XSl9DT1VGQjgycy1ELXk0UEdIRzVackhsSDgxa25mLVpRblU0SmZfY2lhMWhmWlY3ZFMxb21UZDQtNnJwZmpTMGxFT3VfZTQ5bUpYUGFpZ0hyLWFQYkFzTXJJQ2JvOUVIR2IzMXJ5SlR2QXF2ZmJDbU10bkdLUDV6aUNiZFh3SU5ONzBJTk5lZnJLWGZkZFBUd0RSV3d1ZkxCcGNlU0U0SG5EWVZVQmdkMDl4UUZidG12UDhhTXhhUlpGSTNpWG1fbmpCNmZfdlNhZUNUakdVYVVuRE1QQkdOQWQ5T2xVX3dvUnMtalNCVnVqd1FQSGlGcm5RWElkXzBRdXRYSm54cTU4aUtlTGJvNDJtOHgwaXBRcnB4aEZoUDdHNmZOWXAwVmxXR0RxZ1Q0VlpPQkZsZWRKUU0yaDQtb2xTbXdtUms0M0Y1cjdKd3h4aENqU1JReWx1MGEyQ0ZONWMyZjIxTElZaFliLWNReWFXMDNpV3hsb04zWld5cDJIb1FlUmZPR3lXUzBiU2NBT3JndGpBYnJaUFIwMGRRNnpSOHNBczFYUzh3dzBlaVczbFpsdjJwVWFxOVpTeVhnTS14b2NTOS1ueXRaWGtWWlUwX2dDVXJBV0ZKNG5XdW9oTGM1RkkyRWFQNWR0SXVWa3dnbXlsR1gtYk9ZeHp3dzVGYmI1V3VEbnJ5aDBMSnVic3Q4VXdLdnl3bk1jQ3duMjZSVTNxQVRudGJubVhJS0FyeGkwMldQVk9oTXdpUWZuX2h1TWk5emp3MEVuaXNWdktNWUNnR2xqNWlGZW5Tc0FKUXBiLUY4bng3OWFJQlJaTUc1a0huUDR5dGxmNm9FTkRsRXNJY21aeEtOdEIzcmJPdVROYUhLTXZBNmxSNzlMMDJZSTZrcEdrUUZnaHpIaTBjTWkwbFdCejRTM1AzUEMzZElZSVlQZ0Q2S05kT2FLWHkta0dWdUlsWFNmVlVrMnpzM0NBeTJhZEJjV0NMV094ZkRoQnlwNTl4MHpBRExvdnZySHRLOWF6TGN3N0lTbVl6eUhYMkpobVdReUYtTFd1VzhfcW41SkFVYlB5Z0RTRDYyMi1PTGZQVDZmc2VTWUVBUTFLVWRwZTFnSV9hZWxVT3FaRWN1aE5SckU1YUp0LTN5TEVLVWZIWXF6WTlGbHJrUE5MUC03Y2xRbmEySEhfZmMzZV9LTGtGUDFhQTJjM0RVaERseGhsTzB2bFVmV0c5eXpXaDNZN0NmRFlFMlBaUzZBcFBlYy0wa1NDcEVKMmtCcnFzWG4yeDJDX0FDdTdCTTVGZXNJQkN0M2NqSEdQSVVQRnEteGVmT0RCXzBQcXZDTXpBOHg5Zm10Ny1sNHhVQlJaa0dtZExhZFoxVzdFUXRNRVpsSWMtbDF1V1UzTU15cFZpVWR0OWxJUHVQVUEwc1NrbWxrTGhNSjgyNE5QN0hyVi01dC1ZNDcxaWVKMHdEUjFxMmU4MU8yazdNeTFlTDY3TlY4OVBHYU81SVR5WG1ueUVXMGtVbl9qa3l1UVRkV3dsS09HZVZIYkJWNFpxSXZHWjdQUS02TEE5eXc3a0dyZFRhVFZXOEdOOV9GY1c2VUhjbzA0U3dqTzY2S2x4VlFJWWpBdEZPZlBjWW5xNzF1RndyQS1UZHVDZG1sUFBHOVpjc2tiQmdrbF8wVk90dmhuc0pwYXZKZ2Zka0d3OF9qMkQzd0Jzemd0VndHNk9nNW16eVFwM2pFc0w3UmNtcXd6WFBOaDdKYXdHVDBJMlRvZHYyQ1Z3MDkzWjJlODFXR1NxRnlIejAxdjFBaGN2T2VWdmFjUGM2Y1JJaVduNW93ZF80d2FBdjlyNjVVdmtWa1FLRXpHUmo5eTZILXdZTTMyV1JyMzBlOU9MRTNKUU5POV9kNjRTRmIwSjZHa2VxUmtnNkVXc2xqN1JYLVU1VlhrS1BtMzNpS3c5dGU2NVBqQUNnZThRVDBYVWZEaUx5a1pGeUdpZ09ZMS1TVDFxUlE1eUhMTXhEc3BPRjFXd1lMQ2c2b3hocTlWMm55Z0U1cUJ2ZnYyWUtFaDdjM1dWNjJrYkw3UXJ2d0xkMHVRZ1FwYmUza3E3dGJzcC1lNWlud3cyY0YxQzByeHNScGZJRHlJMmg4b2xHMi1RQUZkWmtlMUlmaE1FZmNfdUdXX2pqSGJSWXVzYnZCRnpKMDdaOVJsVnFMR1A2WXBnTDFsRTFOY09xUVJyYVdxckdDTWZ6SzZMVENQSl93aHJRam9WTzdVRDJIUEVnUjZ2S3U3cWlmTmo3UjE5OUJuRi1EZmlnbk1TYTFKZkZadDNuVXVZOEhMUXRoUzN4MUMxOE50d3dsaDVuNGxYS3d5MERHenljbVNweE05QkdPNTFRckFmSXRfY0xHbUlzMlJ4MzMyeDRIdEZ3Z05nRzFBazNIUno4TlJ4V3lhNWhjb1NoYURXekhES2gyOVp3Vm4wYXVzeWJpal9uNlFGcnZZbjRSOHdPNlRQV3FrS09JcHkxc1lQNWxyNDc1anZSRVZGaFdCWDBiUXdJdnNlM0Q0a0dFQzgzU3FWYkhxY3phZTNwOFNxaG5tQW5ZYzBIbWp4clJfZUMzT0hYVFBGUFZmNDlVWHdrQjIwY1lvcjJ1dzBaTzJ2TUg3S1QwcjBSWDBQVy1qcGpORFpjSGRSNVVCMXFacGlWLWxaYkw0eF9IZW14aWUxY0RPOHNQSXhIOElUSWtOV0tTR1N2eWdraHBBbGl2RzVEZXJObElkeFE2c0tHQ3RtMDEyT2xjN2thaVFaNHh0TjR5ZVpPU2xyS0s0OTlIcWhObzhkNTNsbFFfMW5ncWlHbzhUSDlzWkFrclYwclc3dkJOSF92UlhBdTc2MnlpZGhZUURYYXJXSEFUMm9DU2hEN1lOdnotekoyZGtEajJMcW5CdFNCWFh5T2xsM3o0ZWFITDd2MDZ1QTgxMVBKQU5YZUdoenNaNFVQQUQ2Q0E4cGlxSHB4WGkxODRHNEJETVU4S2VHeHZLWnJiUlNOT2pTOFNrQUJKZERfSklIZ1RhNEFhNzdPUmNZcVY3OWZ5djFZVHNma2lLR2NUYzZIUjZzUVpsamt2U0NQNjdtTTRGUHRqTHlfX1pDQlNwdnRSVWd5UlpNM1dSOUViNHkxa29uRG4zUjMzN2lpSzdfbGtIa1UtZ21VbUpZUVdnUjYzT01pZUdRUHdNR3BSZXlRWE5yckJVTDN2Z2JYdjlac1ZDcDh1NHRwQjBleXJvUXgxZC1KSWJvOWVyR1VlX0ZzU1Fpd0tIaGFIUk02Nzh5dENkcHJFbDBWeG92TFVrX0xNcTFjN1R4MG5jbFl2WE4yUjhEMXNhU2FibkJSd19CU2tZMFNMSXdhb2RpY2o2ZzdLd0ZfMXB2eThhNF9LbnJNLUNkenBvdHA0aTd4QUJuY2JRVUEwWkpsYlp1elRpR0F4ZjFnclk1Z0dZOTVoWi1XZG1lOWlSazBHRTJGN3d4MlJyLUVvS3lZRjNjak0xMWt6MWFmME9fNFdyOXJoU3JrX1NHU3l2a3ZCTW9NZ0xOX0tSS1BlTjlqUnpwRlVST2VnN2NCbGlhdy1odnZhY2lCeDN2UWRqTE5jTldQdU1UbzVmME1QbmU4TUtXcFBoWjBySElMaEVuYW1pcG82X3pzNjczcE9ma09FS0JWWE9mUDEzR0UwS25SWTBab2JPLWRub254LVdBY1dodFZvX08xbkwwTWE5ZXFMMURhRGhJU0JNbVRIM1hkY2dDTnF0emIwcVMtS1l5Mk9zRzZOakRDVEM1aEI3MXIwU09WMUprNFV2QjdYemxTTW9YUXJnTzF2ZFVwSGtxaVhUM1RJZmlQMWRKcDEweDlSMlp5R0lzUzljQUtNMEZyMGRxQmJmQy16NTJpcWZweW4zUVVqb1Fld2hPYnJwUEZGOF9lUmVNRlIwSXZjUkxnMHpwek56UzU1N1pkQkZhemxNTThLcnkwN2QyUDAyTnZtclUtN1ZjOW8wZm1qem9WOHVVTG9PMkJHdmFRdnFJNmtBTmQ5VWo1X2JkY2NVUzBhcklzcGFZa1UtUXQtNnQxYU5YUUdGZEtUbFMwSVowek54bkNIZWRySEE4SkYtOFg3d1ZpRW1McXJQbU1Sd25sbWx3SnhxLVlReWMydmdUallSbUxCVU5TS3VrZkJsa2VnMmlCRWdySksxVlNyRWswX0ZvOXkzV1EwVlZuNXhEZXlGc1JuWDI4Tkl6alFQLVNXaHhYbzdPYm5YY1cxZHlWNE1fYjdzM096cEMwOTJWcGZYQkpaTDhBeHgxNGY2TmJzTEpXLW95VEdsaTJFb2FCZHJKQ2JkQlNOdWJlbGdRRmU2V2hqSjRGdlNrYVJISjFTT3ltbGFtQmYwaVNDOGM2X1g2SkZORjNmOXYuQjc5SDJvbVIyTU52SndydHVzclJ4UQ" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/CreateCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/CreateCertificate-example.json new file mode 100644 index 000000000000..d626433a2ddc --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/CreateCertificate-example.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "selfSignedCert01", + "api-version": "7.5", + "parameters": { + "policy": { + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=*.microsoft.com", + "sans": { + "dns_names": [ + "onedrive.microsoft.com", + "xbox.microsoft.com" + ] + } + }, + "issuer": { + "name": "Self" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/pending", + "issuer": { + "name": "Self" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=", + "cancellation_requested": false, + "status": "inProgress", + "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.", + "request_id": "6faacd568ab049a2803861e8dd3ae21f" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/CreateKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/CreateKey-example.json new file mode 100644 index 000000000000..bdda27b2884e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/CreateKey-example.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "CreateSoftKeyTest", + "api-version": "7.5", + "parameters": { + "kty": "RSA", + "key_size": 2048, + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "attributes": {}, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificate-example.json new file mode 100644 index 000000000000..1430f9a6f0cc --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificate-example.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "importCert01", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://myvault.vault.azure.net/deletedcertificates/importCert01", + "deletedDate": 1493938558, + "scheduledPurgeDate": 1501714558, + "id": "https://myvault.vault.azure.net/certificates/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "kid": "https://myvault.vault.azure.net/keys/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "sid": "https://myvault.vault.azure.net/secrets/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938557, + "updated": 1493938557, + "recoveryLevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://myvault.vault.azure.net/certificates/importCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297 + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938557, + "updated": 1493938557 + } + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificateContacts-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificateContacts-example.json new file mode 100644 index 000000000000..b6be48318fa1 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificateContacts-example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/contacts", + "contacts": [ + { + "email": "admin@contoso.com", + "name": "John Doe", + "phone": "1111111111" + }, + { + "email": "admin@contoso2.com", + "name": "Johnathan Doeman", + "phone": "2222222222" + } + ] + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificateIssuer-example.json new file mode 100644 index 000000000000..8f3ddf9ee435 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificateIssuer-example.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "issuer-name": "issuer01", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/issuers/issuer01", + "provider": "Test", + "credentials": { + "account_id": "keyvaultuser" + }, + "org_details": { + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + }, + "attributes": { + "enabled": true, + "created": 1482188806, + "updated": 1482189526 + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificateOperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificateOperation-example.json new file mode 100644 index 000000000000..8e2ec6190457 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteCertificateOperation-example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "deletedRequestedCert01", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/deletedRequestedCert01/pending", + "issuer": { + "name": "issuer03" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApf+kGcL+5uivj/ToYbQ15zcx3caEnpzXaX2eJgL0/Kwaz4u2/bNJ9+hoXnlOFFbCp4canVoNvgu8fw5NOu9U3gJNFQwjHeAqfsg8okZGkIk0riIpp4MMb/4GQb2y3B28AcTu2FANdzLoZzBqmQs51KBe1RONkdtqDYXIvnb5G+9+P7PCy5G//Ga0JAP6Y6P8+TrE9JLEj6Sny0ljLMpMyt4rIRAtNfKYSeiWVQmYX4jZfImIW3iq91zwMsRlrzTm80mNfHPCv7V/8NmYuh0MQgCr49lLbbKCgzDyo9h8sblVQvR5TAylpIk7bSQNf4tSdVNHnsF6CJWu6Pg31hyMpQIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBAHVjmYFs3FmecaJ1ExhK1WCFJaQJUTVbPJ1xJ93UJlLivhzI1yhQO9nMC2DKV+E+UCxceqjae6OG5LUhXfYAziS0HTc80+ZcUqrZRb5ZRt+8HU0TPbTDDqjj8wMZ4VlgQ3eXGAGesMfZV3AqWwa5itofvqm8KAmL4Yn/XMSHcKfRx3h9WnC6RXgZ8WNYK+r5o+gHlmuF7/AaNFh8UjIsjjOZQ0Yin/vA4yBEYTt1/OC7pScs3bdL9CIf4rC98qaMSf4B2W/vfrXUo0gGPYcep25jy7xnIltSY80Trn3Mty5YQ0IT+KPQcJKhbryGg6bIy4jJDwS7zkn51MR1q3kNoOA=", + "cancellation_requested": false, + "status": "inProgress", + "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.", + "request_id": "b88791e33d9c4d609d3e3cc3d2d40d11" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteKey-example.json new file mode 100644 index 000000000000..a9bb71741ef6 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteKey-example.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "CreateSoftKeyTest", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://myvault.vault.azure.net/deletedkeys/CreateSoftKeyTest", + "deletedDate": 1493942452, + "scheduledPurgeDate": 1501718452, + "key": { + "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteRoleAssignments-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteRoleAssignments-example.json new file mode 100644 index 000000000000..e34304c2cb19 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteRoleAssignments-example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "scope": "keys", + "roleAssignmentName": "roleAssignmentName", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "properties": { + "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId", + "principalId": "principalId", + "scope": "/keys" + }, + "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "roleAssignmentId" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteRoleDefinition-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteRoleDefinition-example.json new file mode 100644 index 000000000000..6969cb838172 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteRoleDefinition-example.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "scope": "/", + "roleDefinitionName": "00000000-0000-0000-0000-000000000000", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "properties": { + "roleName": "My custom role", + "type": "CustomRole", + "description": "Role description", + "assignableScopes": [ + "/" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.KeyVault/managedHsm/keys/sign/action" + ] + } + ] + }, + "id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Authorization/roleDefinitions", + "name": "00000000-0000-0000-0000-000000000000" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteSecret-example.json new file mode 100644 index 000000000000..31502dbd78ec --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/DeleteSecret-example.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "secret-name": "GetDeletedSecretTest", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://myvault.vault.azure.net/deletedsecrets/GetDeletedSecretTest", + "deletedDate": 1493938433, + "scheduledPurgeDate": 1501714433, + "id": "https://myvault.vault.azure.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865", + "attributes": { + "enabled": true, + "created": 1493938433, + "updated": 1493938433, + "recoveryLevel": "Recoverable+Purgeable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/FullBackup-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/FullBackup-example.json new file mode 100644 index 000000000000..6d5544bb350c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/FullBackup-example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "azureStorageBlobContainerUri": { + "storageResourceUri": "https://myaccount.blob.core.windows.net/sascontainer/sasContainer", + "token": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED" + }, + "api-version": "7.5" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 5, + "Azure-AsyncOperation": "https://myvault.vault.azure.net/backup/45aacd568ab049a2803861e8dd3ae21f/pending" + }, + "body": { + "status": "InProgress", + "statusDetails": "Full backup is in progress", + "azureStorageBlobContainerUri": "https://myaccount.blob.core.windows.net/sascontainer/fullbackup-pool-61e8dd3ae21f-1579243113", + "jobId": "45aacd568ab049a2803861e8dd3ae21f", + "startTime": 1490790000, + "endTime": 0 + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/FullBackup-pending-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/FullBackup-pending-example.json new file mode 100644 index 000000000000..870dd578dca7 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/FullBackup-pending-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "jobId": "45aacd568ab049a2803861e8dd3ae21f", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "status": "InProgress", + "statusDetails": "Full backup is in progress", + "azureStorageBlobContainerUri": "https://myaccount.blob.core.windows.net/sascontainer/.fullbackup-pool-61e8dd3ae21f-1579243113", + "jobId": "45aacd568ab049a2803861e8dd3ae21f", + "startTime": 1490790000, + "endTime": 0 + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/FullRestore-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/FullRestore-example.json new file mode 100644 index 000000000000..ae98fe964aa1 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/FullRestore-example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myhsm.managedhsm.azure.net", + "restoreBlobDetails": { + "sasTokenParameters": { + "storageResourceUri": "https://myaccount.blob.core.windows.net/sascontainer/sasContainer", + "token": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED" + }, + "folderToRestore": "mhsm-mypool-20200303062926785" + }, + "api-version": "7.5" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 5, + "Azure-AsyncOperation": "https://myvault.vault.azure.net/restore/45aacd568ab049a2803861e8dd3ae21f/pending" + }, + "body": { + "status": "InProgress", + "statusDetails": "Full restore is in progress", + "jobId": "45aacd568ab049a2803861e8dd3ae21f", + "startTime": 1490790000, + "endTime": 0 + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificate-example.json new file mode 100644 index 000000000000..da319429b6c2 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificate-example.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "selfSignedCert01", + "certificate-version": "pending", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/f60f2a4f8ae442cfb41ca2090bd4b769", + "kid": "https://myvault.vault.azure.net/keys/selfSignedCert01/f60f2a4f8ae442cfb41ca2090bd4b769", + "sid": "https://myvault.vault.azure.net/secrets/selfSignedCert01/f60f2a4f8ae442cfb41ca2090bd4b769", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938289, + "updated": 1493938291, + "recoveryLevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297 + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938289, + "updated": 1493938291 + } + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateContacts-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateContacts-example.json new file mode 100644 index 000000000000..b6be48318fa1 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateContacts-example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/contacts", + "contacts": [ + { + "email": "admin@contoso.com", + "name": "John Doe", + "phone": "1111111111" + }, + { + "email": "admin@contoso2.com", + "name": "Johnathan Doeman", + "phone": "2222222222" + } + ] + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateIssuer-example.json new file mode 100644 index 000000000000..8f3ddf9ee435 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateIssuer-example.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "issuer-name": "issuer01", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/issuers/issuer01", + "provider": "Test", + "credentials": { + "account_id": "keyvaultuser" + }, + "org_details": { + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + }, + "attributes": { + "enabled": true, + "created": 1482188806, + "updated": 1482189526 + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateIssuers-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateIssuers-example.json new file mode 100644 index 000000000000..332bc8d9e34e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateIssuers-example.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://myvault.vault.azure.net/certificates/issuers/issuer01", + "provider": "Test" + }, + { + "id": "https://myvault.vault.azure.net/certificates/issuers/issuer02", + "provider": "Test" + }, + { + "id": "https://myvault.vault.azure.net/certificates/issuers/issuer03", + "provider": "Test" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateOperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateOperation-example.json new file mode 100644 index 000000000000..dbc09888d1a7 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateOperation-example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "selfSignedCert01", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/pending", + "issuer": { + "name": "Self" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=", + "cancellation_requested": false, + "status": "inProgress", + "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.", + "request_id": "6faacd568ab049a2803861e8dd3ae21f" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificatePolicy-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificatePolicy-example.json new file mode 100644 index 000000000000..60f5d5df99de --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificatePolicy-example.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "updateCert01", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/updateCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297 + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1482188947, + "updated": 1482188947 + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateVersions-example.json new file mode 100644 index 000000000000..a0c244dd1ea1 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificateVersions-example.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "listVersionsCert01", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://myvault.vault.azure.net/certificates/listVersionsCert01/002ade539442463aba45c0efb42e3e84", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482189534, + "updated": 1482189534 + } + }, + { + "id": "https://myvault.vault.azure.net/certificates/listVersionsCert01/7fcb3e9eb8bf43f3a6ff4b9c3740801d", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482189532, + "updated": 1482189532 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificates-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificates-example.json new file mode 100644 index 000000000000..7d37cad5176f --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetCertificates-example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://myvault.vault.azure.net/certificates/listCert01", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482188987, + "updated": 1482188987 + } + }, + { + "id": "https://myvault.vault.azure.net/certificates/listCert02", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482188988, + "updated": 1482188988 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedCertificate-example.json new file mode 100644 index 000000000000..e665c6a8f87e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedCertificate-example.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "getDeletedCert", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "recoveryId": "https://myvault.vault.azure.net/deletedcertificates/getDeletedCert", + "deletedDate": 1493938292, + "scheduledPurgeDate": 1501714292, + "id": "https://myvault.vault.azure.net/certificates/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769", + "kid": "https://myvault.vault.azure.net/keys/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769", + "sid": "https://myvault.vault.azure.net/secrets/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938289, + "updated": 1493938291, + "recoveryLevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://myvault.vault.azure.net/certificates/getDeletedCert/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297 + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938289, + "updated": 1493938291 + } + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedCertificates-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedCertificates-example.json new file mode 100644 index 000000000000..a702f0075e57 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedCertificates-example.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5", + "maxresults": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "recoveryId": "https://myvault.vault.azure.net/deletedcertificates/listdeletedcerttest0", + "deletedDate": 1493937659, + "scheduledPurgeDate": 1501713659, + "id": "https://myvault.vault.azure.net/certificates/listdeletedcerttest0", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493937658, + "updated": 1493937658, + "recoveryLevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://myvault.vault.azure.net:443/deletedcertificates?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMTIhTURBd01ETTVJV05sY25ScFptbGpZWFJsTDB4SlUxUkVSVXhGVkVWRVEwVlNWRlJGVTFRd0wxQlBURWxEV1NFd01EQXdNamdoT1RrNU9TMHhNaTB6TVZReU16bzFPVG8xT1M0NU9UazVPVGs1V2lFLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedKey-example.json new file mode 100644 index 000000000000..a9bb71741ef6 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedKey-example.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "CreateSoftKeyTest", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://myvault.vault.azure.net/deletedkeys/CreateSoftKeyTest", + "deletedDate": 1493942452, + "scheduledPurgeDate": 1501718452, + "key": { + "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedKeys-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedKeys-example.json new file mode 100644 index 000000000000..1c53737ef47c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedKeys-example.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5", + "maxresults": 1, + "$skiptoken": "eyJOZXh0TWFya2VyIjoiMiE5MiFNREF3TURJeklXdGxlUzlNU1ZOVVJFVk1SVlJGUkV0RldWUkZVMVF3SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRJeU9qRTJPakF5TGpnM09URXpOemxhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "recoveryId": "https://myvault.vault.azure.net/deletedkeys/listdeletedkeytest0", + "deletedDate": 1493938031, + "scheduledPurgeDate": 1501714031, + "kid": "https://myvault.vault.azure.net/keys/listdeletedkeytest0", + "attributes": { + "enabled": true, + "created": 1493938031, + "updated": 1493938031, + "recoveryLevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://myvault.vault.azure.net:443/deletedkeys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVSRVZNUlZSRlJFdEZXVlJGVTFRd0x6RkRRa0ZGTkVaQk5qQTBNelJGTmtZNE9FUXdORE5GTkRFM09FUkNPVFE1SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRJeU9qUTNPakU1TGpVeU1UZ3dPVEZhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedSecret-example.json new file mode 100644 index 000000000000..31502dbd78ec --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedSecret-example.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "secret-name": "GetDeletedSecretTest", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://myvault.vault.azure.net/deletedsecrets/GetDeletedSecretTest", + "deletedDate": 1493938433, + "scheduledPurgeDate": 1501714433, + "id": "https://myvault.vault.azure.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865", + "attributes": { + "enabled": true, + "created": 1493938433, + "updated": 1493938433, + "recoveryLevel": "Recoverable+Purgeable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedSecrets-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedSecrets-example.json new file mode 100644 index 000000000000..051f00b8067b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetDeletedSecrets-example.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5", + "maxresults": 1, + "$skiptoken": "eyJOZXh0TWFya2VyIjoiMiExMDAhTURBd01ESTVJWE5sWTNKbGRDOU1TVk5VUkVWTVJWUkZSRk5GUTFKRlZGUkZVMVF3SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRFNU9qSTFPakU0TGpJNE5qUXdORFZhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "recoveryId": "https://myvault.vault.azure.net/deletedsecrets/listdeletedsecrettest0", + "deletedDate": 1493937855, + "scheduledPurgeDate": 1501713855, + "contentType": "plainText", + "id": "https://myvault.vault.azure.net/secrets/listdeletedsecrettest0", + "attributes": { + "enabled": true, + "created": 1493937855, + "updated": 1493937855, + "recoveryLevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://myvault.vault.azure.net:443/deletedsecrets?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExNDQhTURBd01EWXlJWE5sWTNKbGRDOU1TVk5VUkVWTVJWUkZSRk5GUTFKRlZGUkZVMVF3THpZMU16ZERSRVJGTlRJNU5qUkRSa1pDTVRkQ1JVWXhORGszUXpSQ1JEZEVJVEF3TURBeU9DRXlNREUzTFRBMUxUQTBWREl5T2pRME9qUXdMamsxTnpZeE1UbGFJUS0tIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKey-example.json new file mode 100644 index 000000000000..8a4fa0dbf33e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKey-example.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "CreateSoftKeyTest", + "key-version": "78deebed173b48e48f55abf87ed4cf71", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKeyRotationPolicy-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKeyRotationPolicy-example.json new file mode 100644 index 000000000000..22174a5508a4 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKeyRotationPolicy-example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "key01", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/keys/key01/rotationpolicy", + "lifetimeActions": [ + { + "trigger": { + "timeAfterCreate": "P90D" + }, + "action": { + "type": "Rotate" + } + }, + { + "trigger": { + "timeBeforeExpiry": "P30D" + }, + "action": { + "type": "Notify" + } + } + ], + "attributes": { + "expiryTime": "P2Y", + "created": 1482188947, + "updated": 1482188948 + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKeyVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKeyVersions-example.json new file mode 100644 index 000000000000..8c181fc6d770 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKeyVersions-example.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "listkeyversionstest", + "api-version": "7.5", + "maxresults": 1, + "$skiptoken": "eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVTMFZaVmtWU1UwbFBUbE5VUlZOVUx6ZERPVVJETmpjM05VUXdSVFF4TnpjNE1qZERORVk1T0VZME9ESkdRekV5SVRBd01EQXlPQ0U1T1RrNUxURXlMVE14VkRJek9qVTVPalU1TGprNU9UazVPVGxhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kid": "https://myvault.vault.azure.net/keys/listkeyversionstest/7c9dc6775d0e4177827c4f98f482fc12", + "attributes": { + "enabled": true, + "created": 1493937851, + "updated": 1493937851, + "recoveryLevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://myvault.vault.azure.net:443/keys/listkeyversionstest/versions?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVTMFZaVmtWU1UwbFBUbE5VUlZOVUwwRXdPRUZDUVVVNE1UZ3pNalF5TVRsQ05EUXpPREZFTWpoRVJURkdSVEJESVRBd01EQXlPQ0U1T1RrNUxURXlMVE14VkRJek9qVTVPalU1TGprNU9UazVPVGxhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKeys-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKeys-example.json new file mode 100644 index 000000000000..889955f46fe1 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetKeys-example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5", + "maxresults": 1, + "$skiptoken": "eyJOZXh0TWFya2VyIjoiMiE4MCFNREF3TURFMElXdGxlUzlUUkV0VVJWTlVTMFZaSVRBd01EQXlPQ0V5TURFM0xUQXlMVEUzVkRBd09qQXhPakEyTGpnd056azBOemhhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kid": "https://myvault.vault.azure.net/keys/sdktestkey", + "attributes": { + "enabled": true, + "created": 1493937656, + "updated": 1493937656, + "recoveryLevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://myvault.vault.azure.net:443/keys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetRandomBytes-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetRandomBytes-example.json new file mode 100644 index 000000000000..4c6eadda2476 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetRandomBytes-example.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myhsm.managedhsm.azure.net/", + "api-version": "7.5", + "parameters": { + "count": 4 + } + }, + "responses": { + "200": { + "body": { + "value": "MTIzNA" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetRoleAssignments-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetRoleAssignments-example.json new file mode 100644 index 000000000000..e34304c2cb19 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetRoleAssignments-example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "scope": "keys", + "roleAssignmentName": "roleAssignmentName", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "properties": { + "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId", + "principalId": "principalId", + "scope": "/keys" + }, + "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "roleAssignmentId" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetRoleDefinition-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetRoleDefinition-example.json new file mode 100644 index 000000000000..19e0b0f72864 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetRoleDefinition-example.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "scope": "/", + "api-version": "7.5", + "roleDefinitionName": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "properties": { + "roleName": "My custom role", + "type": "CustomRole", + "description": "Role description", + "assignableScopes": [ + "/" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.KeyVault/managedHsm/keys/sign/action" + ] + } + ] + }, + "id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Authorization/roleDefinitions", + "name": "00000000-0000-0000-0000-000000000000" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetSecret-example.json new file mode 100644 index 000000000000..da5ac1b9718b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetSecret-example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "secret-name": "mysecretname", + "secret-version": "4387e9f3d6e14c459867679a90fd0f79", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "value": "mysecretvalue", + "id": "https://myvault.vault.azure.net/secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79", + "attributes": { + "enabled": true, + "created": 1493938410, + "updated": 1493938410, + "recoveryLevel": "Recoverable+Purgeable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetSecretVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetSecretVersions-example.json new file mode 100644 index 000000000000..6418b20967a6 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetSecretVersions-example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "secret-name": "listsecretversionstest", + "api-version": "7.5", + "maxresults": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://myvault.vault.azure.net/secrets/listsecretversionstest/11a536561da34d6b8b452d880df58f3a", + "attributes": { + "enabled": true, + "created": 1481851699, + "updated": 1481851699 + } + } + ], + "nextLink": "https://myvault.vault.azure.net:443/secrets/listsecretversionstest/versions?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExNDQhTURBd01EWXlJWE5sWTNKbGRDOU1TVk5VVTBWRFVrVlVWa1ZTVTBsUFRsTlVSVk5VTHpGRU5EazJNa0l4UlVRM09EUkVRa1k0T1RsR016TXpNa1UwTnpZNFFqY3dJVEF3TURBeU9DRTVPVGs1TFRFeUxUTXhWREl6T2pVNU9qVTVMams1T1RrNU9UbGFJUS0tIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetSecrets-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetSecrets-example.json new file mode 100644 index 000000000000..a27ddc120b14 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/GetSecrets-example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5", + "maxresults": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "contentType": "plainText", + "id": "https://myvault.vault.azure.net/secrets/listsecrettest0", + "attributes": { + "enabled": true, + "created": 1482189047, + "updated": 1482189047 + } + } + ], + "nextLink": "https://myvault.vault.azure.net:443/secrets?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE4OCFNREF3TURJeUlYTmxZM0psZEM5TVNWTlVVMFZEVWtWVVZFVlRWREVoTURBd01ESTRJVEl3TVRZdE1USXRNVGxVTWpNNk1UQTZORFV1T0RneE9ERXhNRm9oIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ImportCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ImportCertificate-example.json new file mode 100644 index 000000000000..2188d703f13c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ImportCertificate-example.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "importCert01", + "api-version": "7.5", + "parameters": { + "value": "MIIJ...", + "pwd": "123", + "policy": { + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "kid": "https://myvault.vault.azure.net/keys/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "sid": "https://myvault.vault.azure.net/secrets/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MII++cut+for+brevity++EPAQj8", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938557, + "updated": 1493938557, + "recoveryLevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://myvault.vault.azure.net/certificates/importCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297 + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938557, + "updated": 1493938557 + } + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ImportKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ImportKey-example.json new file mode 100644 index 000000000000..b8fc6d0a81d9 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ImportKey-example.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "ImportSoftKeyTest", + "api-version": "7.5", + "parameters": { + "key": { + "kty": "RSA", + "n": "nKAwarTrOpzd1hhH4cQNdVTgRF-b0ubPD8ZNVf0UXjb62QuAk3Dn68ESThcF7SoDYRx2QVcfoMC9WCcuQUQDieJF-lvJTSer1TwH72NBovwKlHvrXqEI0a6_uVYY5n-soGt7qFZNbwQLdWWA6PrbqTLIkv6r01dcuhTiQQAn6OWEa0JbFvWfF1kILQIaSBBBaaQ4R7hZs7-VQTHGD7J1xGteof4gw2VTiwNdcE8p5UG5b6S9KQwAeET4yB4KFPwQ3TDdzxJQ89mwYVi_sgAIggN54hTq4oEKYJHBOMtFGIN0_HQ60ZSUnpOi87xNC-8VFqnv4rfTQ7nkK6XMvjMVfw", + "e": "AQAB", + "d": "GeT1_D5LAZa7qlC7WZ0DKJnOth8kcPrN0urTEFtWCbmHQWkAad_px_VUpGp0BWDDzENbXbQcu4QCCdf4crve5eXt8dVI86OSah-RpEdBq8OFsETIhg2Tmq8MbYTJexoynRcIC62xAaCmkFMmu931gQSvWnYWTEuOPgmD2oE_F-bP9TFlGRc69a6MSbtcSRyFTsd5KsUr40QS4zf2W4kZCOWejyLuxk88SXgUqcJx86Ulc1Ol1KkTBLadvReAZCyCMwKBlNRGw46BU_iK0vK7rTD9fmEd639Gjti6eLpnyQYpnVe8uGgwVU1fHBkAKyapWoEG6VMhMntcrvgukKLIsQ", + "dp": "ZGnmWx-Nca71z9a9vvT4g02iv3S-3kSgmhl8JST09YQwK8tfiK7nXnNMtXJi2K4dLKKnLicGtCzB6W3mXdLcP2SUOWDOeStoBt8HEBT4MrI1psCKqnBum78WkHju90rBFj99amkP6UeQy5EASAzgmKQu2nUaUnRV0lYP8LHMCkE", + "dq": "dtpke0foFs04hPS6XYLA5lc7-1MAHfZKN4CkMAofwDqPmRQzCxpDJUk0gMWGJEdU_Lqfbg22Py44cci0dczH36NW3UU5BL86T2_SPPDOuyX7kDscrIJCdowxQCGJHGRBEozM_uTL46wu6UnUIv7m7cuGgodJyZBcdwpo6ziFink", + "qi": "Y9KD5GaHkAYmAqpOfAQUMr71QuAAaBb0APzMuUvoEYw39PD3_vJeh9HZ15QmJ8zCX10-nlzUB-bWwvK-rGcJXbK4pArilr5MiaYv7e8h5eW2zs2_itDJ6Oebi-wVbMhg7DvUTBbkCvPhhIedE4UlDQmMYP7RhzVVs7SfmkGs_DQ", + "p": "v1jeCPnuJQM2PW2690Q9KJk0Ulok8VFGjkcHUHVi3orKdy7y_TCIWM6ZGvgFzI6abinzYbTEPKV4wFdMAwvOWmawXj5YrsoeB44_HXJ0ak_5_iP6XXR8MLGXbd0ZqsxvAZyzMj9vyle7EN2cBod6aenI2QZoRDucPvjPwZsZotk", + "q": "0Yv-Dj6qnvx_LL70lUnKA6MgHE_bUC4drl5ZNDDsUdUUYfxIK4G1rGU45kHGtp-Qg-Uyf9s52ywLylhcVE3jfbjOgEozlSwKyhqfXkLpMLWHqOKj9fcfYd4PWKPOgpzWsqjA6fJbBUMYo0CU2G9cWCtVodO7sBJVSIZunWrAlBc" + }, + "tags": { + "purpose": "unit test" + } + } + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://myvault.vault.azure.net/keys/ImportSoftKeyTest/2eb4a15d74184c6f84159c3ca90f0f4b", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "nKAwarTrOpzd1hhH4cQNdVTgRF-b0ubPD8ZNVf0UXjb62QuAk3Dn68ESThcF7SoDYRx2QVcfoMC9WCcuQUQDieJF-lvJTSer1TwH72NBovwKlHvrXqEI0a6_uVYY5n-soGt7qFZNbwQLdWWA6PrbqTLIkv6r01dcuhTiQQAn6OWEa0JbFvWfF1kILQIaSBBBaaQ4R7hZs7-VQTHGD7J1xGteof4gw2VTiwNdcE8p5UG5b6S9KQwAeET4yB4KFPwQ3TDdzxJQ89mwYVi_sgAIggN54hTq4oEKYJHBOMtFGIN0_HQ60ZSUnpOi87xNC-8VFqnv4rfTQ7nkK6XMvjMVfw", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942691, + "updated": 1493942691, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ListRoleAssignments-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ListRoleAssignments-example.json new file mode 100644 index 000000000000..75cd0f67680c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ListRoleAssignments-example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "scope": "keys", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId", + "principalId": "principalId", + "scope": "/keys" + }, + "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "roleAssignmentId" + } + ] + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ListRoleDefinitions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ListRoleDefinitions-example.json new file mode 100644 index 000000000000..6f6b4afb0c93 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ListRoleDefinitions-example.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "scope": "keys", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "roleName": "Role name", + "type": "roletype", + "description": "Role description", + "assignableScopes": [ + "/keys" + ], + "permissions": [ + { + "actions": [ + "get" + ], + "notActions": [] + } + ] + }, + "id": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId", + "type": "Microsoft.Authorization/roleDefinitions", + "name": "roleDefinitionId" + } + ] + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ListSettings-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ListSettings-example.json new file mode 100644 index 000000000000..003445914dc1 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ListSettings-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "settings": [ + { + "name": "AllowKeyManagementOperationsThroughARM", + "value": "true", + "type": "boolean" + } + ] + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/MergeCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/MergeCertificate-example.json new file mode 100644 index 000000000000..4eda30ad4031 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/MergeCertificate-example.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "testcert", + "api-version": "7.5", + "parameters": { + "x5c": [ + "MII++cut+for+brevity++EPAQj8" + ] + } + }, + "responses": { + "201": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/mycert1/f366e1a9dd774288ad84a45a5f620352", + "kid": "https:// mykeyvault.vault.azure.net/keys/mycert1/f366e1a9dd774288ad84a45a5f620352", + "sid": " mykeyvault.vault.azure.net/secrets/mycert1/f366e1a9dd774288ad84a45a5f620352", + "cer": "MII++cut+for+brevity++EPAQj8", + "x5t": "n14q2wbvyXr71Pcb58NivuiwJKk", + "attributes": { + "enabled": true, + "exp": 1530394215, + "nbf": 1435699215, + "created": 1435699919, + "updated": 1435699919 + }, + "policy": { + "id": "https:// mykeyvault.vault.azure.net/certificates/mycert1/policy", + "key_props": { + "exportable": false, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=Mycert1", + "ekus": [ + "1.3.6.1.5.5.7.3.1", + "1.3.6.1.5.5.7.3.2" + ], + "validity_months": 12 + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1435699811, + "updated": 1435699811 + } + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PurgeDeletedCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PurgeDeletedCertificate-example.json new file mode 100644 index 000000000000..845e970e9b79 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PurgeDeletedCertificate-example.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "deletedcertificates", + "api-version": "7.5" + }, + "responses": { + "204": {} + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PurgeDeletedKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PurgeDeletedKey-example.json new file mode 100644 index 000000000000..007f882c1a2a --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PurgeDeletedKey-example.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "testdeletedkey", + "api-version": "7.5" + }, + "responses": { + "204": {} + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PurgeDeletedSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PurgeDeletedSecret-example.json new file mode 100644 index 000000000000..92e41d3849ee --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PurgeDeletedSecret-example.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "secret-name": "testsecret", + "api-version": "7.5" + }, + "responses": { + "204": {} + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PutRoleAssignments-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PutRoleAssignments-example.json new file mode 100644 index 000000000000..a49bf6ce0e3b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PutRoleAssignments-example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "scope": "keys", + "roleAssignmentName": "roleAssignmentName", + "parameters": { + "properties": { + "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId", + "principalId": "principalId" + } + }, + "api-version": "7.5" + }, + "responses": { + "201": { + "body": { + "properties": { + "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId", + "principalId": "principalId", + "scope": "/keys" + }, + "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "roleAssignmentId" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PutRoleDefinition-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PutRoleDefinition-example.json new file mode 100644 index 000000000000..e62eddc37a8b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/PutRoleDefinition-example.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "scope": "keys", + "roleDefinitionName": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "roleName": "My custom role", + "type": "CustomRole", + "description": "Role description", + "permissions": [ + { + "dataActions": [ + "Microsoft.KeyVault/managedHsm/keys/sign/action" + ] + } + ] + } + }, + "api-version": "7.5" + }, + "responses": { + "201": { + "body": { + "properties": { + "roleName": "My custom role", + "type": "CustomRole", + "description": "Role description", + "assignableScopes": [ + "/" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.KeyVault/managedHsm/keys/sign/action" + ] + } + ] + }, + "id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Authorization/roleDefinitions", + "name": "00000000-0000-0000-0000-000000000000" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RecoverDeletedCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RecoverDeletedCertificate-example.json new file mode 100644 index 000000000000..a3a5fdab687a --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RecoverDeletedCertificate-example.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "CertCreateDeleteRecoverPurgeTest", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d", + "kid": "https://myvault.vault.azure.net/keys/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d", + "sid": "https://myvault.vault.azure.net/secrets/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938486, + "updated": 1493938486, + "recoveryLevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://myvault.vault.azure.net/certificates/CertCreateDeleteRecoverPurgeTest/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297 + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938486, + "updated": 1493938486 + } + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RecoverDeletedKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RecoverDeletedKey-example.json new file mode 100644 index 000000000000..bec37a48433e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RecoverDeletedKey-example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "CreateDeleteRecoverPurgeTest", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://myvault.vault.azure.net/keys/CreateDeleteRecoverPurgeTest/6fc2be54c6be4a7ea7bbb8a2a99a1996", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "v-SWMCmPNKoK_rB_pNXUl6Iwh9Kqd3XzQlh6SXi_slBishqP7pyKEFjNbUvMSlyvPt21rJupLbJr-yhsK2Rq2V6O0doGuCsoadgNGih1aVAuUJAJls1-b-G1IJjD18ArM4RitnCvJmQFqyK2RVHa3EpEfaQW4gcRrsRAhiJDjc1L1S3skdt-E_rZfL7DIh1ZtqFyQAqIWSAG0BXDdbgfEx1kJKqH-HRokDKeMCIaJtKZof6e-DJr3e9Iy8aAR7V-BsZ7vY7JMjyeEukMzEji4MEsIyOESL67DgFllDEi4OM_3WKyxr6uXxzHDzmppWsk2ykLsYA_ALLnR3ZNZCuL9Q", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493938342, + "updated": 1493938342, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateDeleteRecoverPurgeTest" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RecoverDeletedSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RecoverDeletedSecret-example.json new file mode 100644 index 000000000000..d01289149012 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RecoverDeletedSecret-example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "secret-name": "SecretCreateDeleteRecoverPurgeTest", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/secrets/SecretCreateDeleteRecoverPurgeTest/16f5f7feb7004280b7f3b8ac50cd01f9", + "attributes": { + "enabled": true, + "created": 1493937960, + "updated": 1493937960, + "recoveryLevel": "Recoverable+Purgeable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ReleasePolicy-example b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ReleasePolicy-example new file mode 100644 index 000000000000..c3bc10a44ce9 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/ReleasePolicy-example @@ -0,0 +1 @@ +{ "anyOf": [ { "allOf": [ { "claim": "x-ms-sgx-mrsigner", "condition": "equals", "value": "86788fe40448f2a12e20bf8d5e7a1c3139bc5fdc1432b370c1da3489ab649a85" }, { "claim": "x-ms-sgx-is-debuggable", "condition": "equals", "value": "false" } ], "authority": "http://localhost:8023/" } ] } \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/Restore-pending-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/Restore-pending-example.json new file mode 100644 index 000000000000..708c9a50adf2 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/Restore-pending-example.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "jobId": "45aacd568ab049a2803861e8dd3ae21f", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "status": "InProgress", + "statusDetails": "Full restore is in progress", + "jobId": "45aacd568ab049a2803861e8dd3ae21f", + "startTime": 1490790000, + "endTime": 0 + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RestoreCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RestoreCertificate-example.json new file mode 100644 index 000000000000..a37b4b55c6c0 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RestoreCertificate-example.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "parameters": { + "value": "JkF6dXJlS2V5VmF1bHRLZXlCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUkwTXpnMVlqQTNZaTFrTlRRM0xUUXlaVFV0WVdVNVpTMDJNVEJrWXpNNVpHWmhaamdpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLm85bmpNWEFSZWVla2NaRXBsVTNjdUxQcVZlWmxFbGRDM01XOWpYR0h6bnBXRTdHRGVOSXJraGZscHdTWXFnQnBYQkozMFpUQkRpRmpROENXSnJfUGlsUWNDRkZyN0xrdWJhWUs0TW1zcVh5WGIzbkRJcUJkQmZIUVNpZ1ZET0J5Ym9sUlRNNDYzYjBTbXhLVzJheEdFS2NuZzQ5WFkycG1SR0Vrb0plcHJWZ0tyRkpOUGQ3cGJIS3hQSWdDOFlnT2xudnZxR280RlRDSzh0ZWotcUt2UzBfRGV6Uk5vdTZqZ25SekpxX0g2NGxWMk1hQ0NnUy0xbTlyOGVOTVVvSlhTV1hwc0lneng1RzdEbzIya1ZEY25vMW9rajlCMXNvbklkWmtuY1JybDJBVHNRZVlzZXdkUVd1VmhxRzVLN0pNQWo5YzBRdkxhTmlpdl9PY2pFcm5qUS4zbmI4azJ3SEcyNHFJelNNb184WG13LnJzc3NMNjJ1aUNfTm9IbG5zQlgzcEEtck1uY3g5R3V2NmJYSHpKamxwOWNMUnVaSDBSWlJYVXRwU3BPQWdyZ20tU3BxeEdWSjd2bmprbV9FSzJwYy1sZHNjUWtRSDB4bVFVcGZFNzN5b1VTYTNXVVNMS2VIVnJLdUg5MUtJR0tLODE5ejc5d1Y5Y0F3UjlzcHJxbFFWZnlKdlNFM2tnZTh1RVBpRFFVMFl5WnJqVjBsMGJCU3VkeTN1MVlsVHB6Wk1EWmpUcE05ZGtMclgtaGdxZ1FGa2xFa1hNRWlzd0RDZVM3Y3J2bFg1bnVzbWh5SkZCMklCd3dxNWJieHptV1diU3JOc3lFMmJmWEpXOWN4TFlQcnJJZFpfbkd0X29RSGVQcUFZTS1iVnpTdzdBRGJjMU15NTZwclBGLW9PSm40MHptOTBaaFBTVGMyQXNKRGFBa3R5WFU4WktOYUhFVUlHLWI1SGhUdFBuZ20wN0FrWEtQNngwaDhzZ3ZIaGdCeGpfdWRfQVpQc3pLWG1HdUhFTW9lRGhpT3NkQVdRR0pwR2t0NHVlbmZyamNSeXVlaXJiTC1RV3o4MEtZUnk1QklxbzVJc19RVHpWN2dqMGstYS0td24tazNsNTJ4YjhaNkRXd2tWZ3hqUlNXOXZnV0pVd2U5M1ZrVWtHM3NLRW5SOE9ueTNjWlhQVl9LbWtBTEdlR0ZzQm53SmQwY3dueTBCN2I5VWQyQ19kWEZ0N1BvbnFVNldfT016cC1Nb1NtRzRHbEFpUkVfQ3FrWlhkalhIMVItSmpObUNfdXlPUTdaN1BVaDAtNmd2YUxpcE1CamlWR1FwdzlEZDhmVmtCbWk4VW5uOUxPYXJmSXVtcEJyUE43TTJhM05KdjN6b0NkanhZVFVUMTN1aElpYWl3aExoUFZhT2pUbFRmTkpqbHhIbG5lbGJ1RWJsZTk0bVV1bW8wcjhKRlFMSDdfRjhXMVo0OC1BcjhYYXJwMXhIY0FReHk1WWYwclktdUU1dTAyRnRHUHlPZ0JfNV9WdFlNR2VfRE1mdENLOGVMZGFnVllMRDJDNDUxTldZeVVfeHdNUWdQbXBaMWFnSEdCb2s0ejhsSFBndVhCQ3R2WFFuTHBXQTVBamdOLWNoWjNwUGJmc2RkNjBhekJuWDVaVXQza2hYaWNDdWk4b0xidEtzQUdmckNOZzFwT2Q0MHBHMEJlVy1lNVE1WWQydjY4eFh5a2RiTXhFblFCM3Fzd1djVlh1QXBIR18wREZVVmZvSlc2aVBZcDNWVE51amM5M3QtMDcxWnlZbUZ4V0RfVThMYTAtM19RLV8yZ0pwMVBaVV8tMVBRM1huLXdSWk1vb3JkZGZQa1VPZ0lqdWkwa1IwZWt5RjZvdWdLNnJrSVZHaGp3YUp0ekdKczJLdGxncnRCcEs2MXZEaE5zbFR5VHU5OUp2T2RFTXhwRG5lTEg4NnlvVnhxT3lIT3lxNjByXzdpTHgtdy03Q3FzWTloT3dmQlBZZ3BQVlM2bm9oZVBocTkwaGJTX0lrM21YbnRkRUNMREtSMi1wWFh6bjlPRjZIN09EdHB4S0VXQkdCaHJ0Ykxmd2JZS3dmWmZSVTJVUHpkLUxFd1lQdDloU203Z3lSODNoYkZiSFNBV1cySncxRWl1c3FURWRsRW1lQ3k2cFp1MVFZWko0TUQ0OG5rVXMwdmVHUVhTU2Ytb2RhQm1fYjZZdVh1cWcyWk03MlZjUTd4ZzV4MmpFenFqcllmdjdTTGJINFZBcWp0aFg5LUdRaWEwWEZaS18xempIenhkd1B0R2lSOHJfMkFFZTgtRXFoNi1FaTZKdjRFZjYyMnRrNWFJUWx3R1pETWpGSVNuUkpRdV8xcnJiY1E3enZsbWhUSWFQcUJNRFVxeHBEOXNWUlhuSHdIaTl1b1BCUTllbWJIMkV5WDV6MEhWRXlDa1JEbUd3cmR2RGdsOFVzMUhURjVwYXlYZmF2WkZUZjl3WFZyQXpsRFBEQkFJVFMzWnVJMEJWR2pJUGV1SnRiako4S1pTczRFQVNRRTVyVjViTUpNQXcwa19nYkVRTEZGSjJVb0ZzcWU1QUszM2xGXzR5cGMxU0JaWjJfUzYtbEQyNkpyRFVJSjFFRmJhbWtoUk12bWJIT1Utc0hDT0lRcHdadlJzV3Q3NExSQ1ZyQ09jMGpUdE5TT1JPUW5XRHVXRlFXSzk1TkRGMG96WjIyLVFEMU9YOE9iU3daaHdOXzNfS1pHRmtVMEhNdzNjSTI5LWUxbFltRDV3cmJ0ZlRFbllOeHJKOGpuUWFBY2FoNy14Q0JKeUQ3elo1MXIzRVVyY2VnazBzc1dLeHRPVjRLcTZENmxuVmU3bFpUT1dfTU5aZi1JSzJUbnZCaVZIMHk0SkVGaUxzSDJHbTM1d28yYlZVaXJsT1ljVEk1NlZhdDhMRWhGaEotVlUyNk84NHo2dUJFZmJucEZLbmdKc3pfYVlucW1zNWV1bmd3ek5ndjdlT0U0cUdKSURyMTRBUXRWdEYxcWdrZHNnVllWVXg4U29SQ0NobE5VUzRNRGxhc1hwS1VmV19ENWIxbDRkbXZiNEZNRHJqakJ6djk5dGJSeGZFYUVOSFlYTHZFZnJ0b0pMeW9na2tmNkxlbVoxVDZRbnRtNlR4S1IycU81WU1vMnRJZHlQNmZNRmkweEYtdE1IaHNSdVN3VEpybW1nREcteHVpZllVNkpfaElSNkMzVmo2VkFMMW1oZy0xeW1pRXZuanVLbElONzc4NmFWdVNpNmx5TjJJNzZqY0R6SHZ0VW1ibkVvWWtORHNPQXdqQk9MNFBlS0VjR1hWcm5YNDJhNW5IRWM2cmZQdjZ0Q2tVSUI0UldIdzEyUTFiNDM2N1JvRS1PTWN3TnV6ampob1M0S1ZJbHo4UEFMOW9YYTR4NXlQeG1aVzZ0UUVna1pKeFhEcS00SWRtd1UzTnpVZUoxdGpNaXFsc0xRWDdlc29fTHRtTWJ3bm83YkI3bjRlVnZ4aUtQU3p3dW94c25aaGs1b3ZSSE1xU0NtZjU2MjJvUTZvWEdmNUJLWExlQWdqaE1Sd21razEtUzlGajlyc1hlT19VYjJOMF9hVEFLemlidXIxNVcxaHI3Wk1PVFlxOFlSSGVPaWxSX3Bkdjl5NTlDRDQ1WmE0ZXFURHVrNmRxZ1d4YnoyVVVtMnpwM3pvTHVKSVZ1Y3FIaUVRTVNfMnFKcy1xQTAwT2FFY3huZTM2Q1RsZVNwZjF5cjh2VjNWNW1mQU5zRnJBa21CMnBRWTNfZ21UbldTYTJ3UWlMa2RFRllPSExTeEk5UVowNHo4ZFRfbW5QMmIwWV96N3ZLa0VGQmFpNU02UFdPWjVIOUx1M3Rnay1fR0g0ODd6ZHpuQm0weWZZY3ZIOHJUd1QyQl9UZVRFMG4xcWFRdDRiQ0diUkFQNE1DTDl0SGlIcmlzWEllejQzZlZ3b1c4R2x4YmxKanlLWkpXbmlRNjlBYks3SmYyUER6d2NVSHhkZU5HNGxEZmt6WmFxU2lybGRzZlhXOHBGLWZ6WFVVWHR4eDF4Um5nQ1hJVkxLbU5ZbV9CNnNrNGo0VzROVFMwQTBOcFhsZGJCWjZWWmFDMDNvRHVGUFY0MGtwdWQ0WEd3Q1l3M244ZjFHb0Z6Sk42QjFqOTRLeTdtNE5YT1JsQ3ZaRW5qZTl6T241T1d1ZG9USWRoRzBobXVDUTZ6TXI2YkVaTUFoV1ZFdlREY19iXzZsOWdLWmVxNmVtekxvcmptOEQzLXcyLXRBYlE2Tmpjd0J3eEhMZzlCRllRRFdvaU9UVmJKN2VBcUVFMHVxVkhBcE9KbFVIc2tmQy1uV3NzOV9fRTFURHBLcjRfRE93NFhPUGNzT3dlVU9EUWg3cVFXRE1ZcDVHU1poVWE4MVVHczhmemZKU3JPbmtaTmRVTS10Y0h3R01mX3didy11dmt4UFUtV0tvNUNqR2M2aU5KMDB4MjZZdUpCWXd6TVFyeDBJQWgxMjVBWlozX2FvaFFpLWw3a1pZVE82Q0JVOVZsYllNMndrZXp4ZGhrQ1oxd080Z1NNbDlKU3A5ejhxNV84SU1WM1pma00xV1VqSGZMQk4xRXdFMjRxZFVzcWxyU3NZN1hQaVlpcXQ5ZktXVmZDTWw4RU0yd2ZHYlhxMUI4eWl2UlpMcko0eEk2MUdVUWJFVGU4akNTYTF2aUxxZ0FIa25IYjVjVHIwbDRhTW1EZGZKWnJxZEdpb1lPb2IwdHBuc3IxanRfZm1obGhJa1NSQnREUk5XWEU1OXBjVXlULXpyVjBxZl9sOHN2TlNEV2N3d09YQ3lITWZzLWw0T29xMldVWTVLQi1nSG1HYUJod0oxa19ra3V2S0hlMl9TY0loc3JjTXV1eW5aLW14Vzl5NHBBS3pvdVFsQjR0ZGZvbHdSRk5KX0tHYWJPZXJiWFdDT0ZTd0JVTjdNaG0wOXNyVS1VWG5od1IwdTYyTjVvMDlfbGN5eThnWDg1ZUVrenhuOGZ2NHd2T0Y2dUd1cFk5UGxpSTRLMTNqSHlOd0ZuY2VmRlp2b0dxVlhkcUg5RGJkYS0zY1FhbVFlNmlMek0wRDlnLXlFc2NBTkpKS3ltelVzemZZdV8yY0p0TEhsd0I3NVhLeW1EMG9nUkRvRkRwTmNPd1dRRUlwdVJwU0pfdWtzR2EwZkd3MGVBTU4tQmc1OUs3emhRWHJISUZOckN1S1VPMVdvTkV5WkM2UGlKSUwtUlRsTFQ2WlBNZmdSZzZiUl9aQk43X2dseHBIakNDaFZXMkZ3MnJFUDJJX1pSeHFqdS1WbmVwV2o4eU1CaHZXZzdXNm9QWm1odmVtUTBkQUljNVZTbVVaelhvNFVURmJxSFN2MGlyVTNscVk2eUl1MGRPd2t2MlF4ZENfQVdRUmdLSGRUeG1xYXFUSXJwclZyUHZ1MDFQSGlFbVRnaDZZVEZ6Yllqb3JEeFExWDhlTUN5Rl80cWNjMnhOdTJRblBIdUR0RGZkSy1NV2xJUDhHUEhSMmhPMjlCa0JJSEM4TlgxZmxDN1ZSZkZsQ09McGVIeWl0MGRSd1d2S2tieGNIWl9fRE5ZLVBNQlZMZGpyR3lxT2JoQnpQZHZMeFpXWVU3THNRbnM1dmxiMTc5YXczX3VmclRIWGs0MVpjaDY2ekFRRl9tekQ3ZEVuMm1fb2tBaTh6NTRwdzdxUDAwNHkzenNPd0RmR0htYWF2c3dGMW5NMUN2YXhXajRINE45dVNUaV9DM1oza3lTRHlUNGdUZjNqc0FKUEJybXdSQVBpaU5PTTU3c0x2Y3dJRk9ENnA5QkdWbjFwbjQyZGRTU3A1M3JieTZEcnlwcHdDaDFrampQX3lCbTZRZnd6MElGUWJiSG1zVDNVa2RMb1dURjFSMF9sbjJtR1kxU0hHT2o3VHl1YnQ5d2xLVW5nczVMTWhVcHo3NU1LR3F6UkFnWXNKcHVKUVl1RVpKeGFPSHNmY2VwakdrcFdoMEtfWkhZUEJESzIwOFVqb3FqMDdlVVVueTBaXzJrNXUxTjQzWGJ3V0ZvWVBhdndheW1MYkhWdkRwbzdwMU9JT1IyNkt0SzdPeGlnZ0ZybGVISWNaODFwQzRCdlNzRnZsY1BCZEpHLTZxWTU0Q3J0R2xhaDRvQWplUXgxWS1YU0NLNnZLYUIwWnZHc2lIajhRQ0ZURjRuLUJqTWIzWDcycDJ5Q0tPRlpMRk5qcVR1aHJoYXNnMi1pWTNOTWdwVEQ5eVBSdjA2X1VpcEVfYjVsQ0R0Mmx5QU5NYVpZR1RvSmJTSVhBcFlyU1hEM1dFWllhTGUzQmFSUEJUYTAyeWpyVFZPRDRGNHRFR3c5MkZJZThOSk5NYXRXMFhPSFAwVWxKTXlQUDF2MVdvOUh5aFllaDFfdWg3SlRLcS1hWnJjOS1Xd0ItQXBKTHBQeGxmRzlGZkgwdjNwSTl0Z1VndWJmSkJQVjMwNll2MlNqQ0M2MmVYN3VFTUgzcXQ3TmFYcFVsNXZEVHpfMF9Vc3VlWERQcDNqV01XQTMwenFaYTRFT0dXdElMb0tEM1RjRWNVcmJONGV1bHFQSkFNcWdWdmk2YWRGdTgxU2w5cU1rVVUwaWpqMjZhZDFaeVlEUUZtWlJ4NjJYUW9ZdG81bXJ0eFZhYWtNNndqbkVPSUdJaHhBTnJoX0dNVzVxREhzMEV6TDU4b3lOY0Q5dE1MUC03N1FCbTZwUTFsR0swMVJ6Y3FzTk14ZzRMTzl2ZHQ3NFpIdEhMXzA1TjF2TUt4TE5GbkdhZmwxN1E0eEM0Z3NQeXpYdzBjcklyV2tIQlNQX0NoWE94SmZORWdyNjJOMXEzQVJZa0U1TVlCbzctM3djb3dNT09GcTlrakN1ZGpoekplRjRTUHdfMnFVWVhZRTZsNXJTYjYwUFlFSkJxdW82Skh5ZmdlOXFJX0Rzdmg4eEY1STJfLWtLT2pxU3FZam02NjU0cXVES3phQ3JWLUJFLWtQNF9DOU5OQ0xTaEVWUV92Z3hYdDhzbTRWNGNRMElDRmFzaWV6VnNuV1QtYmRQTGxBT2RqOS15RmhYVTRUYVF3YnZqQ0E2UHQ0aDNVWGdnQzNqWU5IMmJtRGpYSzhFdFJYRTV6cmJsTDRKMFZ1OGxHQVBZaGtOcGNOakNrNWhSSW5jT0dybE9aUk9jdTdSeVczR2JWM2Y1MGJKN0xLNHJjMnJCMTZuemhBdk41WXlydWdwQzdCOE9OR3NTY25ha1V1alJzRzZGYVpydDNzTDJMOW5RTUNoNE9INFF3VWpKWFZKUFJ2MHhPTF9jVEQtdjk0QWgwbWdtcFJ2Q1dhUkl5MXRxeDZHTmZ1R1Nyb0tObmtHYjRiRE1oblpZMmwxQWluWHlCMG5uRGlvci1EUmo1cjhRZi1iaUR6cGhTallzZTZrakdLR0ZObzU4WjFfaGxEaGFob1pQX1lRdlBtWi1Tb2pNaGhMRXZqMXEyZzZWRVd6a1FDWTdIWVEwM1Y3cHVCVm4yaXM1NXpBSGV4cGpERWoxWDgxWU92bnVTdXRhMGx3VkFEMkRoNjZDcmM2VVh2SEtUZTBCeFlsQWdVdkhQc1BkSy1OdVk4S3RaeGNqTWNDVWM0OVl6VW43RVBTamFNaHJ2Ni1mM0pwc09Na3JwREpLM0dPTUVRMUV4cnhYV1lGaGtLaHR2UXZkMXZCVS12b0pRcWJveU9vS1hMM29Xb0FRVnljWlR3Y2laeW4wbUtkVF96NDNFZGhNcDNKS3N5blJ3OVZtSzk3Q3lldGl5LV9HaWVMSngtWDladVMzOUdNa0YxaFVmYmkyc3FJZGZMZ0diem5uMTluTlRVUDlOR3dhaWhybU9Ib1lZeUJ6WE4tby1UWUxhSS01bkNuQ2FSSW9QTF9XSVhyWDZPSzdZU21IWjk4a2xJS19JNTlPSXlWSllrMVh6bGVwd1lPLXUwU0x6bTEtN0dKSE54RGVOMlZhUEk3TThVem10X0x5alliWWxocFFJQnNyUktsMmZZeExKaGt6Q3NjcWp2bVhDemRLVDNhNFV3NDJ4eDlsOWl6dFQ0UmtnV21fYV9YWWk0b0gwdjNCUXRSZ3NfUTBPaGo2T2Y2dEtyZU5XZmcxVDRjMk01SERJd3UxTkl2QXBqNzZtOXJWQkdPWTZFUnhfa2Y3d2twb1g5dWRvcjBCbEx4a1FCc0lwZXpUdzc1MTBncU81Nm1UWXlBUzFCUVdOY1Q2aWhfN3F4ZTVoUkVlZVB5YUpFMnhqR2JNWGg3V1hGYjN0ejVWVWJOTFpxMjBiM3E0UFdkdjJXX1Foc2VUY0JTRDY1eVFPYndTai1UcVpNNi1teUZHb3B6dVdfRWcxU3pzNzRaY3RMSUxyN3pMLXRyeC1WTTVfVHllMVZXbG9ZOTZVYUJyUktpQWU1SVhKMlBQd2RIY1p4SWx4N3dBRXdueXVOZXA2b2NKcXRwZUJ1elB0LTFaX3UyWjZrQmR4V0lpYlVEaGxOU3AxM1NkTGw0Z2hkemVqZWFaYVllRDVtTGltWWJ4dEhsQ1ZiTm0yNU1ZbDYxMFU3QlZnNVJJSXB6VUdmZ2Z5NnpJRzRLQjBMR3BISzNhdHRRUExvQ1VlTDRYNVdBUUFsb3BRa0RKOU5lTHFGdHN4cWpZaGJnZ1Z5am9ScjNPOVhzYzlJVEtVaXJaUDlyTVl0eFduT0tUck9YYVk2WVR2Wi05QUhpT3ZfdTRhOElTS01DVng3OUlnXzdqTjFfREhjdGd5cEEzVnpkbjNKdlJJQTlfbHZDV2dTSS1NUjlPQ19xekhIUmU5dENqWklDVzhwRURSYVhZOHc4UUQ0bXJicmFLTTNsWmtTNUF2NVp2WjFRTDJlZkExbXlJdmN2czhmekxRUFM0Nm0xX3ZPVzcxN05ydDQzeUcwbUZxZnk4aExaZEUzQ2RkMzRtVVFXWVdqSkdvQXZ0VHBXRmpwWkwwOERjQUd0RzVzdkU0Mi1WWjRqSVVYQ2JsemZaczl3N2VsNThvRkJLUng5dUJLby1PWmYxTVloVEZrSlU1V3YtUEVreXRPSVpfU09nZVM2RTVMTUZsOVpZenZ0QkJuWWF0bDY4NGpEdWx0STh4LXpmSHdwUEFwNk9CQVpxalk3S3JoSVJuVGRoc2Y1VUpCcmtvU1JGUFlaaXE4RjJLWHA2Nm1PbDMyRm5RTVprMUlDVkxiYVpnUFlWNnl5UXpZdEdhbjhOc3BFTG10RWkwMVlTZE1ySUxkUF9TVTZwXzJ1NU1oY0RPMDF0Y2hwMHp6eUVfTVp4YWJodXpMWUVIeXJvYl83cjFKdWNjZUQ4SlM5T3JBdEk1YXdsbEhGSFRRWExOWGJuTHdTQ2JrdHNiTGFoa05ya0ZXR1RDNFRzUlBfYTlHMVhFTE5DRkhaMVhvS3NsQTdMMzFGaWpyNFpEYjRQeW5hT1BrSlhCcEx6MGNLN2FmeFVxNWlySHhZNEQyVkdNT3gwUmc5UEJJeE1vdzN6TmVGZ3Y5dzRTdkJ5VUpQdjNGV3huX004M3g5dldiWFh3bU9LbHlLNVpWQi11LWxKVno5Rm81YWRfVEtwUkxqSGdNWURKNU9Ka2dhaEFQMmhOaG9lb0FicnBPNzVYT2tYZ3pONDdwVW1kdzhmZV9FN3ZSeUREZi1LNVZNS2UzOXRPSi0xRmxtemJVc0pET0lScHp5WVl0Y2Q4cGtPU3JQYnIzMWdJNFRIUjJHV2xwZWJCZ3VhYmppck9UTjI1Zy02MmRPWWVKNHVwNjI3MjdnbWNQWF9EYmJfSFdrTnVLaXBmdkJ1UmVNN2J1WE9LVzg2bllHSW5ZNzJZZ2lvYVpIaEJnY3pHbktuUUlkWTJ2U3NzQ3E2b1FSUGJqeHRQZ1gxT1h2bXNucmNBencwN01ULTNueWF1RDBfNG90RGJueF92dm1fM203ajBwcjBGUWZ6NWs1UEVNUG1sOFVhenFxX2xEU3djV2JOU21JbWF3OWt3U2NXN2xrOUViNTRLRTRhaWt2bVRxXzRuN3lkSDNQblI3bC1RMXE2X2k5VWdHUVFfSmk5UDZQbmszQzd6TTVYbDBpYllEVXVUV2FUdlRrX2ZjaXo0VUJXWkV1T0lLU2xZaHVBVzFQUTJPU3NiUWxPbDU4U3ZvTEYtS2w3TmNkRXRBODJVWjdkLVFCN2xKNWFCcnd0Vmx6TDFxX2Y1UGd6a2NtcW1pLVViM2tUQ0xlNjJYbzN1MmFvSnNTQ0c4bXhwZkJ6dVFVVkk3WXdTa2ktWUtNUnlJSGhuOG9xRDNQS0xMbHk2LVZkZy1VREE1RWhhLXA0TnZYb2lLb3ptRHdBZFFpeG1IcnJTdUEwWmh0eE14N0FSc0pqc285blZKR1BOSzhCeTMtbXQycnNOOHlMdHpyRXdkUzBtLW1sRHRKak9CWHJ1NmhWOFBPeV9vSWVzYmJtWkcxSk96Tkl5YmhPOWdNakpsNTBSQXVmcW1sSXJpOEVXQk9vdzdVT1RKQjgtTkR6VzVXdWNiS0VLOGotdWtSYXhhQklPcTJBTnI1Tl9hTEF2RFpmalp1cDl1RGNTc2FUOTNWR0dmQlhHX1BYRlhGWnNtd2NnamxsQWN3bkhCS2V6QWd3SnprRXpFaEdEOFhQMVh0dXJPZHh2YTRyd2ZtVG1yM1pHVWFmY0tTUm5malpnVERSVThVRFd4ZjRwMjB1T1h5RzBBUzlJLUF6WGN0Nm5EOFVQUlB1WDQ3UG1fN05mdWFVTkt4SEZ2RFdOdWYwcVE1OFlvZmhydjJlRDlzUFJFWV9CWjhXWm9IYy0tbVZ5MmM0aDdvTTUzQlFKbTQzRzNkaXotclRwWE0xUDExakc4em5XU3RBQkJxbW40LXdKVVl1UGpDV0VtY29qdGtRZEZmcjQzRUNqTzE1SDJaZGN6MkphZmpUcmxPdWlQOG96ZjEwa2RTYjBURTFVOXI1dHRIU0ZzOUxPVlZHVjJnQUxjUGtMU3R0clgwMXZHMWZLS1ZTRVI2TzlZM0pZYW02X0FwU2xONnlRbmlqM3NJTzdKc2xYdHhaMzY2bXI2Vnl6WmphajVVODlJSjdJUlY3eXBkOWtuZy1RRlZMT0FhRGU1eENvZG1jRjY4ZGp4LTZBVWpQWnBHOFYxVG04OXh5c3BTaU40M0lmLURacTlaMXFjSXNDOUJ4XzlxTHE2S3kwNTIydnBKWkw4NEdCZElXM0FuUUdKbFY2dkRXbThpcF9LMjg2NG8zcEg4UTdFWnpqc05KZ3p6RFU2SkU2Y2psTVdhMDR5dkVMa2dnUm9feVM1MWUzam1BNUFFdWpXLUJ6TXlzTjVkeUpiZC1HcnN4VFltck1wMWI0dFNhMXV1ZHBSdWl2cUFLdV9qbTBvYTA4UHZqRjJyNjRXYXZQZHVxcUs2VGUtMDc1RkFQNHFEZE5ocmpJSHpneWEtUWowY2NCRWtZbUo3di1mUWxneUxzaF80bHJZQmVyWnNCMDM1Z2Z2b19CakQ0Q1VWVWFTRkRya2U2OE41N1prblU0UkZXN1NNQXViaE93WjlCd1pmT0tuajV3bDhfemRFTDVLVDBQUm5IejRjQk01OTZGNXhleDFORzNqME80Y3JDbzVod0xMMUVwMnVweVlULXpfTkdkT1MwMG50bGt0dnNKMGFZSURuQy1SSDRYcUdBUXlpY3hJVzNnTXh3LUNvYlIyUGdPa1dLTVBJN2xFelNLN0VKcjZkZENmblhHRF9scE9HSXgtUTROdjFOU3E4VGw1dkRtdmdOXzZCOEhHbmV5bXdpQUlJZ3NpWWhfUmR0NnBrdWJLVF92aFkwMTI1WWZkck9NaW9keTFLbEpNR3NJNGxqX1dJYVRHQjdoY1dtY0stMy1NNWlZVnJUSktaR2RZbUFobXI3bkZVT28zWFFCZkVVZFpKb2Itc1R6eDdNYWttd2JEcHdQdHB5OXFQem03akI0ZC1yYmlncDI3azRTYlVFOXNFWTZVeVVJVk80Y2l5R3ltZThpOEdLY2dSWXJ3YTZmVlItTnNvcm16dmd5eGZVcDFGWDZuR0xNbE5VMDNEblBVU0JLT1RWTzVnM2JuNG1DNWI3anBVQnUwQTk5R2ZkTEJGaXg4dURwR2NsQm51TFhncjcyRFdCRmFKeldkZXNZbTlaLWk0WDBaUTh4cVZwdGpXTnI5Sm5sVDlLeDVKZXdRSHZkeXRRdHRaTXc3TS01Unc5UHJreklWd1JPZE5PVkxwRWl5RmVqM3YyZmJGRFVoRmg2ME00NWRMQ0hqU0k5eC15dDZ6LUVtQlBpdGtkcWpUT3hLam1qVV9WNzIta09tVndhZkY3MzdTcVRKa0lpWlVic002bEJoQ3Rxd2cwNi1DelR4U1pMYVgzOF95dE51aUY1S0JfcXVwcU54SGJ4TTVZN0l5SnJUcGR4MG9qNFZzWDlxWkFjTGxCZnRNaTFUSTVLMkJRSERSNW5FY2UwT2J1SWpjdlNrcjNYMmZwUWQ1cHlLdnBXcXpNbnNuQ3NsVnYyWUY5ZDZHVWFKeHlfQ2MzRVJqOXZIMnRJb2hBckh6VzJlN1lNUTRyQnducnowOXc0aWNnNG11TDdVSnVsVnJLcjdJS3FDYjJyWFViTDBIRUVrTUd3T0pISEVnVWxlYzRGajRNQl9ZNnh4SFJuekVKMVVBRXVTeDJaZG9Bd1JsSjMwRHZYTWMxcFo0NWktYXE5eV9oOFJxaUZSUlQwSktjYzFpeFA1Y1JWRmVpbFhKWXN0cDV6X1pKZ1FrSTdCQlBaR0M2bkZ5RC11LWh4MzhQN0IzQjdUUzdoWVlXdm9ETFpGSkI0a1ZGRUhvNlRKdWNDVlpJaEFMdHlfN3dreFFxdU1mMFNOREQtV0FPWUJkY3JpZzZmYnNKSVhvc2lMSWNDM3hOOGw2X1dzNk1UMXdXODZkcWRUWkJnN1Z6YUlnREJ2RDRNakRLdjk2M0k2c3ZmeG5FWWNEQ3dDalo5M2JwUGRJd0htZEY1ZE0xTGZVLTExMktBN3dCQTJWYjU2cFdBMWk2QXo3Z1N6RXhQRkZvVkNBdFlJUnBFcHh5SVBaQUVHV05zeDNpNEk2Z2lyZi1hUmFWejFXUURCemd3ZDd3TlpqV2xrRVlyRFBBZTFPVnl0bU9HQWlGZmZiQWVPaVF0V1lzMHYzVGFTOGcydk9peXRvakE4ZzM2dDQwQTB6T3pKYnlzUUM0Z0hjODJuVDdQUDJBTFdPU0RLTmxSX2M0eHFWTkxjdlhxZHFBNmpVRlBUY1FONzk4U1FRbGprcmd1bzhEcGxTZTBnODl1VHUwV0ttcFltSFA0WEtmeXRGRWlBR1FDSmIwZUl6NVZsTlAyVnFiRGRMcW1JSzhuNVlNSUtDY2ItY0FUdGFoRXU4QkxQcVE2VC1aa2t4MF93M2RmZjhVX3ZCZUFwS090SERMWUVqcTBnVktxUHhaUWczY3RJS2oxdXJPeTIybnJ5aTlnZWZVc2QzZUYyMnBCQkx2YWVWSk96QUZndk5YdnRiTXFsUW1CXzQxNG1tVGVtaGFlNktjOW9KRF9sLUxKWDZPU1FISlo4MHQ4Ql9VZkdacFZES1NubmFmMmY4UHYyMy1EUmlGNlNyQ0ZKN0d4TEhUNXJSNzU2MW1YUlV5Qy1leWtocVI1ZFZSZDZhOVQwSGY0TlZSbjJiaVdxeWhPR2VUa0hKazE0YllOUFdYTm5XSHl1VTdyNEZoOVVsb2lES2xIQjQ0VjlmYS1YMzE0c2VHZHRqUFNLdWhFRHBMeV90VU95aWU3aThJaGNIaE1XOHlFNi1Oa0lZSnF4cU5EbjAwdUkzSEhEUWtGYzFQV0RYdlVIcnBJUFRJcFFBQ3c1dkNWT2JpUmFoQVBJM2tFRFh4ZkY1S2VLMXRuS1hsZWRxQmRIc3lCUkZuNnp6T1p1UHdOWktKNHlYVDhoS2wyamQtNTlqdWpibDBmNF9WdVJFdmVQOW9FWWtTOHU3UmlBVEVHa1lPVkg3MkZXTzBzLVNJWGVRRkQzX3VvWjdrM0xjSm9GVjlXMDZrQUVWY1dURVZGRUlwamtNMy1FYnJSUVdMcy1heWVYQkNFSUxsQ2t0di1LblA2N0pyZFV0bTI2cnFlVXZ5MzdTMTBCTE53YjRiNHBvREhMS2FveGFuZy1iRjZUb29PR01UU01MWXUzaUlLc0R3Wm9kZG1WR0xyQ3FxNWJJR1BFZTNoMnc1RjFNZ1hyVEU2TmFubXpKckh5eHVPc0VyaGctaEpGeGVCcWE4WjZZWFduTXIxNDhLanNoYVAyeVpFSWV6OG81UEc3cWRWaHFRenhYT1c3eEQwSTUycjBvbkhxM1hzcV9SOGhFby1UYVdPbmY1NW1YYTNWMk81LV9XanZxZThWdzdwTUF5dG95dmh2NTVTVk9xcVdkNXNIdGhITzd0OWlMdDNFYVMxX0ZnaU8zVmVENmlvUVBNNjZsWmhaYkpZZHo4b1RFeU9SR09KbkpjSVpqVm1YSlJIbXF2eXZsUlpjdkVMM19KR1hEOEZGNHlBVE0zaGhlNDN6VEJVdk9oYlRjckhNQTRLZjhWczR4cU02QWFsczVBZzRUbVZSSnVLLUVRWFZCaFE0TEpBbEgxVXZzN3lKYTdLM2hsQlZEMWo5WXRWS2htMVhPNFJySTNrZmVxYmxoMTRHQ1NEdnI2OExyTk53SUZsY1JEY1pKalBOQi1GWGhUd25PbW50ZVItOFY0UTJVa19tczdTTm9ZUElWRnJqY1R6X1ZkQ3dYRTFmMjNocHpqQ2tnWGlsSUlNNEpNMkZmcDNTZTY2c1JHc1RXXzBBbF81R3Fqd3ZfZFBYWDA0RHJNMFI5dGljTHhLczBnM3hkSXF1M0huamxBRFU3S0c1Yl9NUmxUdWJCQ3pEamtJQWRRUEFwcUhaWktnODYyLWloMDE4bERfbFViWEwyMGhFNFBNbTE0eEg3R0dPQ3FWa1o3RVU4ekd5Yl9xWHV4RF9LZHFLSVR5eUc2WC00MHhOeTJ1cWpDMmlvVVpiM25Tam5kZWFiX19kbC1jMDBLWkU4RnhTRnRMN0RreWxpTWM2Yy1VQXBhUlZKQy1aa2NBaXlPZ2NBOVZQa0x5a2xlcGRNYXY1Y1J2a3FvTHhmS3RMU2FhS0taWEdveFd5OWp2am5KZHZfMmZDTXlUeFdOUWl6MzI5NG9mNkNNY09sTmc5VW5iaUlHb1JVX20tMHQzamNRWHBrZ0pDWlMwcmQyZ3RGVExYdUVlYU9ZTnJjZ2dPWkVQMkstc19kNUlCU2JqNXE1QS1HYU9hbzFuRmdFOEFlMDdEVXVzeTBYeVEzd0cxb3JIOXUtSUxpSHpyd01Ickx5ZWkwYmpYSm9HcVBuSWd5d29nWjdZRmF6a1ZSTGE4OTBZQjlXR2p2SEdqZ19yYmVabWRDWkFoalNiTlRveFN3bGkxMnh0bl93WkNWVkhlNzUtSGNkTHZHaGgyekwwVjlROG84NFI1NUFKVV9fNjI2REMxT2w0cXVLcEt1Z1EwMHowZElPbzMwcG5IT3hqa2xlcGRMM0dyN3dHNXZsSUJKbXVWMlBReC1Hc0JmX3lYbUhxOXBZZ2RJeXl3ZjNqSjlDcmROYXM1RGNseUExUS1Sa3MzdWtyU3dublN1ZE5OeTNCRlJ5ZkgtbHhWQmpYSHQxUUlQM2JLbjRvNmRPSHNLclc5XzRPVnBNREQ0UjNMRmpYNFM3MDJ5ZmdXSkk5Wld6TDFadk40X2t0Zy1iVHNYOC1zdzJfa2Y3dXVldmJmMkYzLThmM3lvNDNUZ2dQaDU2TEZjbFNidGdaNE05MDRTLWF5SGQ2NkhVbmU5T1Axc1NldGdKWXdZZVN6TTgzY2FUUXVqRVA4bFhEQWxKZGJ0MTRhZ2FValJkNlBNLVVIUGdGUmNtRTd5Y0k4YzNSdWxrVkU2Wk5qeUU4VkNnaFRoN2JMNTJNYXhUcVMzQWJKNUpHak9ESkk4ZTczV1BFZHZPZ1FPNnZvak0xNDFnSjFtaW9rTFNIbXNwVWRhSFdIdkNkc2VHeTZyZmJfYktmeGJGS3FNTEN6T3VKbjhxd3hlNUxJQms2djJCUmNzM1I4ZnI1VjBSQXB5U3J3bmRuWExFRHdVRU90YzdwSTBqajVNeGFJaWxKU1FMb00ydXpiWXZaVE1INklXSndEdU1hNW04MlFCRnV3TWFZRDd6WmNwM0RGb2dFc0N5YnFjZFd5SFBhV3NxQk5GSDRuYXdwRnMwQ2xZMWMwbGZQR1RnTWZJeTRxRnV5U012cHNkYWZORUdBdVFpYU5zRzROSnNJV2NYbFNFQ1FsLVhRaHF2YkpUWE03NldPVTVld0RneGRGeG5WREVhdFRlQWZZaUVEN1ZBelFNUXNFenU4VUx4VmI3RWJzX3RsUW5hU2hVX3E3RjNUVEV3VUpPdDNCeFdPcWFCbmhNdUdOdU5CNXJabFd3YVhrUTFNdGxwOEFmWTBXSF9kX2F3VXdQbUpCQXFEX0xKRncybWVBS25OZl85NlZiUW5iU2J1ME5uejlvTnVXVmNMcWZIeDIzX1JfVVE5enZibTlkaGlSaUxSMnVDUzN2d21XS1UzVG9vbks2c1NpeWNmYnh2QjE1TnFnN2l4UUV6M2U2emVkX3pQYy1GdF91ckRrR1dOTFJ1d2Zyb001REQ5XzQ0UFVvLU1SQ2NiVGp1emxqQmVjOXRUc1NRdnZWVnp3WHdNY004Zl8yWEJxcU5OVl91b3V6dVRPWkFfbkNVTDV0T1dFSXZIZmlDRWxJV3lrS0U1TUFUUVlUY3FRd0VwNUlBeDFDOXdudnZtVk5NcmFFNHpDSDJuZllsUGNIYWpMUGlXcHpUdUR4anJGeFhIbVBUc1JTM0Q1YU1yTmM5emwyZkR6ckJsbzV0Y1pPT0ladlR4X0ExeFA3RlFnNjMtbUZzTGlRZG16NzM1bWVjUEFmdkROMnV4dWp3YXFITGx5NGlLelljVVRjbHFhYV92X25VM09ESUxkcWt1S1pCZFZzZGwwX19YeDdkSlFHNG5nN3kxU0d1V2Z1NEdRRnV3azE5b1hJM0ptU0c2WVZHSW5wSUlNYjcwSy1BREliMlZBWjlVaUloMW1HNmpUZWRHWHJtMzF5b3Jnak1PUlRERU1rYnZCeTFaazVrR0E0V05aSmRKRnlSQUtXT3VNbVZOVXRWcTFWRHpkTkpNdGhaWUZHQUU5MEtBZVlaZDdmaFRSZlY3ZlFYdzhWOENmM3IxdmdMTXJyZ2JSOGwzeUsybFBLMnhMcFl0cVpRanFaREpvSjlwUHBlcHEwRF9Dc1JEcVlDVi0zNE5GbldXWklZQmtmZTRPSGFFZTRlXzNQOGxNVTFKUWlJY1dXWmJ1ZUJXSnlpNDQ1b24wRm0zVzdlYTRnUUJCN2c1MzU4MUJBZW9ZQVRUYnFFV0J0LWU4OS1YMDd1Nk1vSDVKUU80OV9kSW0wNU11VVlrV3ZQODFHNDMySDFPYmgxRUJBNG1WdHYtM2ZqeGVDRldiZHVzTWxxa3RYbXVodjBEVWdmWGh4OEoxS2JaMUdjN3cyT1E4S29KZXNGM2QyTzIycjFkdHRIamdmbHBUZlVXOGFaN2hPZ2otSy0wRHg5dXV3ZmNVVWMwUnd6bkNMbVdqd0lnZ2NfQWZJbVRpd1ljZWgzQzlpVnpLdkcyV3BfZHpCMjgzM3YycGI3SlRKbmFYT3VSSlhiM1JQS0pONGcyVXV1NnNYc1JBd2FlTnVtVVVpM1B5b0pCY3dhZFRsbVVrQ2JNcjJMQzBzYmZkbjNMOHk0bTd1UGg3VTJ1RE5EaGk1LTZaWUNYZE5SRVNzajVrR0QxNzJoUHRSVEV6RzhUeEN6Nlp4dE5MQ004a3pHVWtjS2FLeVctZFdaaFVWRENsZVdnQ3F0NWdvNUI1OEVaV2RJbi1SRTRxREZ5RlBDNDg3bk9nMUVyVmZBN0NHWldha1F2QXN5ZUhKb3dkc0RrdzZIV0x0Y2ZwQTJENHEyZ1Z2aDdraHVNMmwxSE5DdWxNOWJSXzZZYlhuTGlCMzIzN3Zjc1d2bHpBVmJCd0J3WHRQT3RGWEEwc0V3c3Qtb2N5V3Z4WFNsT19kdlhRNUdHa2pLcjhFX1hzM0dvZmlqaHpsZF91OWFROGNTek1XbE5xRGNPWncxdncxNUtaeFNXR1QzcDJ4S1VHLWtSZW1Jc1h6VW91TFdma2RCbk41Vk1tUTdJTXA1RkFfcmdHWnFwVHByaHJMSlVaeTNZN3I4bG1McW15Z055a2FMNWkyVEpIT3RWVHB2eHVzck1LMnUtSzdpbUJVMHlkQndFaHNOS1RWMXlGZng4Q2JZazJTeUo2QVlWeWZLM1FhVEdqb2FFMGxocGNPRUIycmpfUDhFWHAydlJ3TWZsYjBtc2daYTFCOE93d1BXRUJMdlROVjVzUEYycFpUaFlnM2xWVzFjSlZlTlBLRTJfYU1zS0p3UGVIY19YTTNrdDBXVkpMbTBnZzE2ek5EMjlsaUlfNTBjOW1VN2NpVG1hNEd5ZzJtSkUzVkg3VWxUanVkRldmNTZpSEZHNlJpU0FqVUFtMmtBTkNGMjFyb3ljVUhFTGo1aVlQZF90S09vcmJvRDlWRGcweDRDc3BQMmRKZWVzMVR6aVMwNU5qU096cnd4dG5qMTBBZ3kyd3B5XzUtbVl6dVJvYTUtNXVPSFhDRkFNSW5QQ2doakFudHVYUGw5REJRb1ZSMWYwUS1NdnJWQU1Qc3pfaXMxc2xZaTlFT3NDUWp1R2hsNGlxYmVNWWRhbFVZZllGYnd5dktaTGNlZndjaVdpY3EycWhpM2FxaWQ5WkVwVGRyR0FvRjItdmd5cWVsSjlRb2NfSG8xRldZdjFrVUR3RTBmQ2ZlV1FteHBFMTQyYmlZNVNnV01CaE9tVTBKWkt1c0hCV3B1ZWJ1TDVlc2RHVEJwRWtpcEpHWmtQSlB0YzBvTlJSVU90TVdZTTYxbXZaXzRTTFpqOW9kZ2U1akMwMHBzSHVYTUExTG5USDZ0R3FnSDlTd1Izd08zOTNTQnRMRU5oNy10UEVEVWc0dHpJeXAxTHQ4R2dWS09DTl8tc2RCbnlpSjJaNmYwSThEMXVPQnJYN0JGb3E2aHlkOWtMWnZiX2E1VHFUdzNKZDJCdHRzOHBWS3hhaXFtTW1WUmZPbU4xYmRJSHhlVUNCQzdXdE1LZUc0M2FNLXpYZDBfUmI4MkxJTVVVRDJadUxXb0MwUGZzUmpiYWNpOVhBOFlBVTE1WllTOVh1YV82NUZYT2xxcl9sT1RuUjd5Y0JZY2J5T2tIeGpIWVFmRGkyQmZRV0NkMElXaF9WcUxNZWozT3ZEUW5FZDZvNEU1N21FQ1lQUEJUSkFIZTNHTjU2UEl6T2xLNTRtVV9USUNpX0JKTkRXemJvdl8wSnVEWExZMmUxZnhCOXNURmc4c1hINUozYUhYY2dpYUdSaHlnMjRKZElJV3dkcXFRbmlLZWNfS1IxVTJhbEVqX2xPQTNNb3FadHk5Zzhnc2RCMjRmQlRLOWJZUnc5eW9OVWhrSl9fM2NxNlozVVFvc3VrWklreDJwVlRoTkU3THdEQ2gxbnVRYlpvUlZrN1NKc1pjWkZ1TTd1SUJRWUNVMGRIQzFRS2lublQxc3R5WDduM3RRLXZPWGRsSENaOEtmSERpR2tsemdKUkhVSFUwdU9JQUNuNGtUbkRzN1ZrRGtEZ2YxalBhYXVYLUR4X19Cdm5oWXIxRFp5eS01N2x3SG85c21rZDFNcGFUVGRLR0cxOVktUDh3MmcyNXJCcVlWQjhBZXRlbXQ1bEtZdE8yckhJNmZSSDZrLVhSM2I3WkVlSFA5MV9UTkc4QVZtV1djMUhaMmdYN0gySzgyUzRoUk1JcEItdkxUaFI2QmV4bTdDeXJHSFZqNHN3M0dtZWd0cG1obmJlNEZQRVo1UTZnNGhScUpmYTJvOUswZDI1aktwaURBTFllRVY3Y1VDUjhBVjRYNU5WR3hWdWppOVdYN0gwaU1mUjZHMmpIVkFZSmloSkxOSC1JSENWcVhxdng0ZWNSRmVxNGRqUjNBWjRITm5kNUJBaGlTSHRObkhlM3EzeG93cFduQVh4M0hHeFZKcUozZ0pVdDVtdGcyb29pYnJiTTVFVU1HT290QlZGT0k5eGd4RmZYT3dhYXNPNWxIbTVoQnFWZVczOHlXS1FqYU50VG16TjlITjFrRWFfS0JacHU0d3RGeGswNkdWTmFEUS1QbmZBV0FJalByQ1FjSjJMQ25kS2FBSHJyYTQ3WTI0dWJYd1hPNUZsSVh6NElaZzI3Z3NzTXpVR3kwdUtGc29LdnJrZkFLdjVWblR1WlJ6aklrZzNoZExLR2FMb3RPVmFwZkp5VnNidGh6T0JrSERUMDllcVlOYkFwbWdYWGdoVTZSb05nV3IwOURSMmZQV1FyaUVzbm9Gc21yZWc1MUUtc2JUWjJCb3FqVW1zRnlndjJZdVhpdTVXdFFUNGtKQ1NxczZZVEw0cGhoQy1sTEhubWs3Q0ZKVnNMUHpUM2ZUcVF5M2V6Sno5dUxyUWJKRXVVMGgyWHQtNGwzaENtNU1hQlVVUGU1SU0tWHZhVk5QM3FQUGN6NjEzZkt1WmwzV3NmZVVtYzl4OWhrbElxRlI4RE1aOFdpYnhJSG5CXy1vTnpvcGV3SXZkOU1RV18wQ0hJRlNWWV9lMDNfNlN4SDBiLU5DX1Y3MXZHNXpNTXpqUkc2WXB1d3hMVUQzQnV6cHNWSVR5ZTd4M1RSWFBxNE42aXF4cFlTeWpyMUUwVnk2UXhzWGc1Q0NsZEozN0p0R082b3pTY1gtdDNKOFJBbVk5Zk41WTRURUZCZkxFT3VtdkQ0WXdjd0xuVktKMnVYN3A5MWZjTTUzVVRhTVc4UTZSZ2JFaTlnZjg5SXl1OFc0WTBIQ0REbDE2dVhCSXdZR3IxX1lyRy1zOUU1dU9FbjVpVm9oY1JsX0RrZlNNenBsSUhPWkJzLVM2X0tud2lZMXZYeThhTWlqb2tFaTVOZnBMbUdZdklwdk1MUFViUzBrQXhGTWo3dktnRXR0S09pU2wxVTJleFF5d0tsYnJtUGxFamZ3YnFjRVZkbmZvTFhIYXpfNlhYTE1Qb1FobWhKUWtvVFN6UDFIb2J4UWY4Uk53VmpaeGF0enpxMGtpMjVmUXlTNTlET0wtVGtiWlFqOTByUnpCQ0hVaTZlNWFmNUN2b3p1T2NIdEJmRnJHVkw4R0JQMk1JWi1UTGsxZXcteFpBbE10UVRITEVuUE1US1Q3X0VwY2dJalNDQTVsZHFXQndZVWxJaXZWd3NzNXRlWEswQkNvWjY3OWxyTVdTOEIwUmRwbjM1djlPU1JOejh3TUFTNER4UVV3OXhOTzBrSjdCWHdUM1dOem90dVFFVDFIeWpEcDV0UHY2MVZuVlVDc3pRME1TaTcwakU2OGtnVm9TM0sxaHFxNUhyZlJoYTVEM2MzZDFBWnJzaUVsMXpMNU5OamktNnBpZENKVmxZeFNBa0gyc2VlZ3lGeUVVV2p3ejZRZzBzeWYtUGtCWVFaRGtKOGJsUWFyUjRMdVJGVmViUTZ0bnQtVThmS0M1d3kydzFXMUhiWUZOWHRzUnVkcm03WWVtUDI2eVVNRzNPUEktLS1zV3VEUW1VblIzemNaVGZkcVBkc3ZyRmtES1JESWZfN3hsbDBLVGtIbHEyRjJOTTBiYjlDb281SG5RdERpX1pJZmIxa3pZd1BHTDZMV1hsazdhcENaQ3daWVBLNWNmbHkyWU84QzRuX2w4eDJkLXdkclBMWGNMRi1xZnRtX2RzZmNrNjBrNUtGenozZEJKV0otY2l1ZWM0S010Sm1JMklxUm50MVpJRnNTOGhEcTF3b0ItLXVTX3ZfZ3lMMVRxRklNWE80b1dUZktOV0l6d1NOUVM3UGdCYXdIMHVIemZDeFJ1bmh5enRMTEdMZEtBamZxc3d6R2dDMnV0THcyOVJoZWtLWVNyaElGWFVoNFFjZF9GOUxfNXZyc3pSaXpKekRUMGVkWlhSVkZNdTFsV29zQUs2YV8wUGVZbFI5cC1XMS03eWo3dGJveGZGdzMyd3o2VlNWamJrMHlIUnpRYmtwNkp6QlIwcm1QU3VlU1QtcHNCSWVwSGI3S0dHQjA0ZmJvLXk2N3VSRkxKTHZlcTJua1o3dDFIRGozQ2taVGduUmJ0S0xYRVNkb3RFY0toQ1ZXaXNrTDZabURLVWJJTkF1MXpLMlJhZkJhNzVDNlVPX2llVnAweTBJX1JnT3hEd1Z4QzVReS0zdVZkc2trcFo5VGduUGhXQWlURF9tQlBmeWhQN2NCbFZvUUhoY1lKYWVjQ21jQmtVcTd3cmx1emdEWEduUkFveUp6MXlwZWNjWC1IUnlqOEFFYXhxSkVUeGpWTFpNODBNS0xtRjNXZWt1dVMxSDIxLTFYUFcyaDBfSkE1OTg1cm9uWnBCSUtoaXptUU44YVNndjBIbFlmVi03cTl1Vi0wLXFrNXVQWnljQkRDYnpUZnlGaEdzWGdKU0tPSm5PYkU0QWktMW14NHpJY3FSRmNiWkt1cF80clc5Z2lFX1pfYjBpTWlMTGlBUHJ5dGo5T241ckx1MnJhY2UxUHFvb2VrZzFuWWxCRllTdzA0eHBWSjNGNURCOTBDMHh0SzAyMEtEakpRU1VCZW52dUpsZ3V4WVMwWnQ1N3dKcnVXdmFpYUlIalFBTmRjMU1lSVJEZjF1Z2EwZ1NwVjZPbEltMlY2aTVDMllfcmY1eHJITmVlWjdwU3A1X3c1UTk5YlU4RkdEMHZNbXE5azc1eTdsR3NTMVlwc2stY2RZd0pSek5oa3RPeW5GOFZBNlcxSjkzVmZsa2Q0NTFnMGRJM3dGd05kY0FqWG8xdUMzWF9zdU1JOUl2ZU9jcWFqWlVNcEFCMTZzbU9waHVpQXlBcjNTbTltMTJMMVBvbzVVVDE4V1lEbFl6eXhNYkRmWmRUX0I2R2lNUnpFYVlHSENyQjJoaUhsYXlDdlpCNW9lbkVTUG1rS1c0dFNmOXhRc0R4U2U1ZnR0UGh4enJ4UWxieEM1V2dINlBibzdYdFcxdUpMUEVzVnlwdGRjS2lPSHczQ0d4dXA1NnVNdjhlRW50SGRHdVFERmVfalk5TUJYZXNsdnMtQTdBVzg0VUFvWE0xd0RYUFo0SVZjdmozSWRpbTh1WUVDU0dXMHlPcUo2MEVBYk9nM2ZERW1wbEpNVTBuc2kzREZmbWlqNkVRZ25hdk4yVUN0Z1lKVUUtUVoxU3lHTEY3OVlIRXhFVFRUZ0RheHNIYnZCX2NibWFwNC0zaGhPS041OXlQUmN1ZldZTGtrMUhpODg2c3V6VWJZa2MxTkZRWlBGekdYV28yUUFvUXlCQm5DS01YT2QyZzBPS2RaSFBYRUtVR05FM3A2blo1WVFCMUx4dXJhTVJCSUNqV2lHN1E2cC1XdXRpNHFvNnRvUjgyQlFFZUtqSC1KV2t4a0NoZ2tFaXpUSjFGcjlHRFZ0c3duOUdFcTBKZjJ0aFhKWXZUTkdTY2tTVFEwUzFIa0NlcVNLOXAyN0p3NHl4RTlocmFVdHYzaXl4MEhFZmNnTlNLVTk0WmpFa0R5UFozUXNLUUlCa0xweHJReGRsZ1hSV2ptMEpJSWQ3WmRiT3I0YUZPN2ozZlM2a3EwQk5SVzFBVnhRWXpkLThFWkV3b2w0MFNyNmFfaG5tUUo4WWZvYlFoTDBhZFBfWUNaT3dBc0g3alc4U0lKbGV1b0hLX2hPc2Fha1hkTnJPaFNoQ2VVYjNpNUQxRmxkak12SWFEajJFN1dfUDJodmVna25PNkFhOFJlZ1JRN1dvQkVpdGU4OEszeVdPOWJkdmZ1NjFJaTBIRU1RUm5LQVBILU83RVpMVWdzTmd1ak5YRW1jRmdmRmhmU1Zudko4Vjd1UnNmbE9NcEZkTmZzNU1KUDdEcEF6R3Q0aGRQaG14ZlBseDdqTXh4cnpOQ19GS0tvRDBwcWdJdWtTVnlMZzdrbXkwOE9paTk1QUNMREZsTnlQZjNtaUVUMHRfaHBmWFZrckhCZDB1Qk5Banltb2J6WmF5bW05SFhLTTFVSUFJN21WQWdUZnVUYmQ3eEY5TjlDNUJTZXVyVDJtYnNaY0JtWFNfa3hZTWtSWjFkSkdjN3FwVFBSZUxOVm10UURBVzZWdTZUWlpHNDREMHdRNllKalItNlFiVnNSR2NReGtxR09KQ2MyYm44SEdvMnZCSG50TTdEZVM0RXdLUXh0bVduVXdITTNVT0ZHaWVOVmRvZDhzcllzaE9sM2tvZlN1YUxIUkZiRGdVQlZoaHBFV3dUejF1VlhOd2VVN003N0R1dGJZYTFiRXRJY0hneXJjQUJTVW41dlh4cEhhbVY1RTJHczhEeDhYTmlBaWdYREJfbmhFZEdWWkVqSmd1TDg5VXltR0c0X3Z0cVMtN3hGYmtJaFpPMXBEVHZTMm1KM04zNUduNGI2S1FWcUEyWEY5amJwRFF0VFY0bEgwZWhiLUFyeGtGMkJjbnA0RUdNZWs0eDRXN1RfNEdtNzlFb3V0TjJzSW9iSFhXYi14bURJbUVId3ZHZkFsYkc5ZFFLZ1pDT3Rrb3EzUHJvY0hEMVFUTElpNEpQYU0zc1VFNngwcy00NXR5cEFHQ3N2MDhralVkUW5GbUVTYUhTYzJjSE5CUEFFX2ZzMGU2bm1fakRLektON095RkV5Ymd1bHZ5RTRsb2ZxWkxfcnNxWFlPN3lvT2oxX2FLVHhGa2ptallGNWhiS2FjcDhCNWstRUZUWVZYMzMzWG9OelJreDRnOFNWZW0xVUNibE1QOTJxb3BLUklPaWNJQWpmN2dkS2hhQmZTaE04UUt6bDJBVjBVU3lwMkdrUFRja0NrWEtXUXhhbl9RLWhtZ2l0V2w5ZVpOR3BpUjVSUGxqR3VRaVRYNlJENGZKcUdEQWNMSnEwYjZYZGhva24zMHd0Tmktc2J0RUN6NC1HV1ZOZVVBYThETl9haFNaMXAwT1MwMkRkbGVKOG1ZcW5vYThEbF90ZGZEV0xiNDg4WVplU3JwUmV2WlBJWm5OQ1lQUngxTDdxMVVGcWhfajVrQ1N3Q0VWTEpDUFdzaXlKSzluXzU5c3lUaW9DemxyM2tuTVZ2bDBZSnFYdXF2eW95TUZrcDdGdVdBbWtfYUR4eURaYm1mRGNLNVFnM0c2YlVwVXhPQVJyamgteWtreVpfcmxsa1hLUjVrTnJJMFFKYkw5UHBiWFNtMzZVSTFNajB4alVael9IYmx1Z3J3c2lzRUtGcGw0T0k2bUY1cUNLZVAwWmFmaW1nblhxS0d0RW9wNU9kTHNGRXNoa3BSSWh4Wk02eTVta0RZM0FrX0c5N0FuLUxzaVVWdG5IN2NYNUJPbHZIMVktREFGdzhkQTBpOFhPbkJoWnZ4aFZqdXctbWtHWjBITURVS0RMWk5uUVR1RXNnVEpDT1RQOVc5R0xtaGNfMGRSS1UwQTQ0RFVRU0l4SmxEYzNYWmdYOV9XdWxMY08tdjJib3pvLUhLcTB3blN0dmlPSU9YQ21BRW9PWDFodWROaUJmdktBc2NYTnE1bGc1YmtaN3dDR0xSQWoxUjRSelhDMnVsaUkyZ3lpMTFHZU1VanpoU0h5Ylk4NG5vWGpDODNJcGFTX1FTYl9WUFEyeWhMWExVdnp4SHJ4YldpajQ1a1VEMWJEZUkxOHhhQmd4UzJ6VlRVMF9FcW1WaU9wbjRnTWczd2oxMW5tV0JYOHVHUHlkUENhV2dtbFJTVXNxVXVGQ0dYZ3RNUFN2R09XRkl0LV82YzFWdVlzMGJDNzl3QnhwYy1MdENkRXIweVM4NWZKQTE3aktoclFINUJLQXNneUhKbzFVU21FZGMtTDRweWpkMS1obnZUYzZxRHBXQmhSREhieV9DeXBfc28ycERfYk12eFZ1YnBDX3FIT0dlaVRLSkpTcHdmMC1OdFRLSnAyUzloUXNQYnhIeUFlQy11ZThIMXA0WlcwWVVyWGpJRDVoS2pKRzQ4b1E2THBsaEJTWlNCa0xpczRqNm5nV2ozN0dLZEFNN01jNlpKVFZRdEw4RXZjWWNTSUlEN0liMHAzXzBIQzRKX21NTEtjRlZWWVp4TjlvSkVPZWJLUFVzbndwelVUX05KbjQ4VVZrMGwzeGtDaFlEVDVmMENoNl9MSmhSSzY3ckI0dXk2WTY3N2ZKN3RjRGFfWWsxZlotcmVpSlBRNHhMTnNOZ05hU0FoQ2tqZE5Nb241bmlPUFNhQUtVcWdDbkhsZzN5bDhPOXFhcVk1aXk0TzFlS1hHcmY1THkxV0lNX1luNmcyeFg4aF9TZ3hlcTdRN2ZOYlhIT0Ztd1Ywdk04aXhhRmJZYnF0N2hHT1pjWnVQaFVOaVdDSF8xb0MyUHlIUE1IcEtWcWdaOUNYYkdQNmFhY3J0UmpRMkxZdUZNSnNWRVhlN1gxNm1xMDZpd0dLUWxsUlZxXzZoZGtqUUs2SVpDVTNzMXV3cFlGeHdaTW1CQVVCaG1lb2kzUVItQlhrYnc0RU9nYXllQTJkSUV6a2g3cXFOYmNXNlNBdnp2eXd4cUlQT1FTSWYtMVlSRnZfSDBpYXN2MmQ0R0kxNHpDWXUtXzMwT0hqYzYyX0VMLWg4V29pa2Z3cTNXZWZNMTduN2hGSmZzMFNWNTVHY2U3UTdDQkxxNEVkSTlXc0t1MDlxeWhNWHJwUlZPWTBrZzdsNjYxa281c0VsN1RxYzgxNWl6OU1wS3RZU1RlV1lsd3pnb011clJDNktNYmZEV2poUmlldGo0Z0RkSW9GaUQ0dHJGNjZvU2k0WTE2WkNxYkVPMWVKNGNseWZZWk8zbzBwSk1NQ0gybUlwTVZPMkRueGJSSURIOUxiSEU2VE1qQjYtZkw1a3d3WUVoSHI3UnNaMnFFYUdWMDdXcFkwMUdoTWpEZXE5dGI3Qm0xXzFvcWtsdVcwMjZRUng5Vzcxa0RwU0xPNkxia1RWS2xuMlB4VmdZa3F5V0pHNlZUbU81T21fRWxlblhQMmx0bV9VVXN4MXgwdkxWczR1ejlHV1VYTGZKbVlzZnViQXBwVF85anZyRDlkV2xWc3NKdUMwRlVVNWxOUVUyOEJWSXpycV9ublJVRUJjc3BLR2d1RmN0Mjk0V2xFVjZzNFdTSU5vNG8zaVM1RWtfX1FsZEp3c3JKT3ZQS2M0S05OM1F2cFJDa3hPQ2VwZGpZZEMtbVdfMGxNdWVoVzVmcGUzRnhFMGhjeHFrZmkyUXA1Mk5VYkVZVWpPV2JRZ3UySVVmX3ZBMWpIRW9UTzRQNS1vYTBrRHZaUmxPQldRbTMyS0g0RkhwYWpiNndLTWVIOU1VZ2ZlS0dBNWVJRDRxaWwxWURONkRMa1BKT3FkeU91UGdqMTQ2WWJkZEtQdmFDOF9YS2w5Nm5BV1lfMVo3ZTNKYW9NNzhZR2pMaEV3alFpdHlSOElLRTV1ZmFDZHdYMWNPMG5FQlRnYTZPNzFrSEJkMEpGLTQ5X2FPX2RoWWo0WmVLWVNxOVhkQ1NHNGQzSFNxVGVsT2ozX0tzUGp5dk5ScmkzY0loVmJVWHkwcVoyN1NqdlRRcHFEaW5yMDBra1Q2OC13SXMxcXJhazQtcjZoQUFUeTM4S2FrUFJWYy1WMUQxUVppR3hFYUdrbUg5bF9YT2hFOEtHREIzZFgxNVNOREptRi1PR1dKSlJZNWhqZmpFWVNEVUhmb1NHTElNei01Wk5hVUs5cm42cFBMcWZfcTc1dkZ1TWRISzZhcTl3eWUtQTdLTjZyS0xqMlNfclV3RHk4dnBlbFBBTktNTG5Td09mV2U2eXdFRmFJTDRVLS01Z0NvczJBbGd0OWE4QmRKOVpsUDBUSzZEb0RVY0JTbE9VTWNJNGZXb0lDYkhwc3FnS1d3MUJXc0xGTFU1UnNSZVF0ZHhmSFNZdWs4azFWUlNhQnZnSEh5Uk9NemJXYzhSWmJCVjlQc1doaEpMeVpMM3RldzJ0RkhaM2h2U1A2SUVidWpxSE0tYnRWSXFqb3BEOHFDMG90YkNERnNqdXV0bFdVekgxTXhNVFFGdk1KY1Rfa0swM3NOSVBNTnc1MVlrQm1fV0hiQTNZY1V6d3BPd1JNNnQ4YWFVV2diRUkyNm93Szlhd3BUTzJmVHVncjdzNTJoWTFBNVRpMXRobDM4TU84UGNfeTFyYWJBeEVsMGloTUw3VlRFWmxhUml2VW5JS09ORDdXSXE0U2RHbjZzbXJLWW1LUGRFNy1vZzJfMXVhWkJyblRScHNrd1FiZUVlM09tT0lRUjltb3ZmNkRCdlZlVGtieG4zTHgyM2hwUVRRYlpFSTRORFFHMnlzTXcwSnQ4OHl2dEo3NkpwSEFYbWhkZUpBNWI0QTBYb2JvSW80a1JGTjNlUWlCQlB1eTVsZU1qeEZnVVE0N3Y2M0pyNmtibXpfSEVTZHowOGhNeUozakN4Q3ViNWdJVGhtbVdkQ1lIUjZRYjRtWlowMjhIT0ZCNTl6MkY4QVVENXNwU2wyZmhKZHBtUl9aZ1BsaVBuUm9YNGVPU25Dc2ZLTW95X1YwNk1KRTl3VGZPSXU1ME40cEhoTE9qQXNUX3NCSHBfYWJMb0x1ekpJZXdtV29SRThVR2xWVENOX2hJQk1pdWI1V01lbDgwa09nbHJTNXRMZnNCdW1qTTZXUEladUpjRG1jWlozdXpEeFBkRWdHbFZydXE0ZmpfMFBoUF9uNS1FcEVtYTkzZDFaLURCTXU3Wk54QWYwS1ZBOXVJOXZ1WFNQRDJOVmRpMG5QRFFjbFRCRWhKYW8wM01uc1VGbkxBNVZqQlJnQVV2Y05Cd3ZlYzRfOE9WMDJLRVRxZ0hMZ2tzbkIxdU1jZ0cxYnVQWHF5cmJJelN3WGJiTFViOTFWSkZERl9ZNGFTWGhWR0kyUzFpdGdZOVlsYzl3aFlJYU9pQy1KcTNiRUZiVnZiZnJnemMwOUtiYl9ya214ZjFpWDVRczh0blYybHpSaVB1eExibGx6dmlEYkM4ZkpMRE44VHo4NExMa0lMZHNmdjBHaWtkRThSelU5cFNnMVU5ZURUT0RnVktDRmtzaXdJbEJ5MDRqd0d5NnNwb1BudUxweG53OWhKQnpUc0M5dVRUTmlZeUk0SmxpdWs4Z3ZpR0JTT2lMeGNiRVlXTGFpN2NNQUYtcnI4VTYya2hDYlZZVU1mVGhnQjg5aklmNlZSa3pVSGs0QXVSR1k1QnpraWxBcDhHeHg2M1RacnVXR3ZMa1FKek5wNS1PVGN3V3hEN2N1VlFULU5icVNZRmZYMnZVcEt2Unp0WjNxeTJOMTRIYmdIeUZMYnl6SVVoTXdiNkY2M3dwcnlIN0hfMHp3OGRfb0N3bWVCMVBTQVBUcFhiYjhRZjluQlRXbjFCWlBMbUNVc1ZCaUFYQV8zUWp2SWkwUXlrN3gtb3BGc1E3OFdJUVpadkhsb0NRNWI4UGd0bVdaNUFwVDhPc1dXQU1sYkFzdXRLdXZjTFkzbW9DeFZIOGxzclZxOHVXSjhlQzgxUV9uOG5YNGFqcnZiNm51M2ZXTXRDNmxFeWwzSW1JSHRHd3lvVVZOVW4xZWlBQVpnYzdiQUlnNlBoV1pxS25DMkFyU19lbEVheVFUd0ZTWWxrM2Zjdlo4Z3RMOHB5THY0YkpEalI5NUprM1g4NGJEek5uSndfY2o2Y2Fqb0F3WW9nc3RRZFRnd0pqTU1WaU1Fa2hraVE2SVRUU3lDNUJmOTBCa2VXbWZwM2N3Y3c2cThwMG5NZEdnMjNDc0p4VHNla18zbFotRS1KcHZESHJnVUV4d3g1Z3lCVy1STjdrX2xnaGd3OUw3QUNTbHdGb2pHVzlZSzA4T0J3Tjg4ZEQwLVlmMkZSRmFnaFVQY0RfWXhmaC1qNDkyaGY1SnE1WWtyOGJMZENiZjdBTGgyeUp6UTRoUGREMDdnNW1uNThnT3ZMUWo4Z2tvTTBfMHVGOHBRaHpqenRjVlRaM2NBNkZobEI2a0Zkdk9OQXZVLXI5YkpFb2NOaW5fRTJmb1B4VUxqOVdEdGxaX3N2bWtEVzBjR05fRWRlR1dKLXhLcTdWNDRzck5vd0lCOEprZHE4dUhZXzFadVg3bWV6MHNYc0lNSEFFSWhkSnBJelpYQzVjYW9lTDRfalVxelB3dzJzMG1IU29CSlpQNjNWODhFQVpMVkdtaklwaC1PTkhQeU9QemFlQ21xajFlTVFaODdJSGNhYm1yUGNaWDFITTVvRi1meTZ5RFVzdUJyRkx1dmRyX0VJQ21TM0sxWEZmWVhsMkZCU1ZsRGNpUDJ0YVF1RzR0dHhjaWhoRWpERDVDcEZ4S2dha0lRSWc3VVFBTy1rUTN3THZHdW5CcG4wVy04eGpWRFBoU28zUUNOc29sNF9zWnFqVTBoeEVNTVo3YkVxTzNSVDNTVW1OM3RjdG9LWTBySzBxZmR1bk5iSXNjdG5TcUVPYzg3dWd4VTBXNHlQYjBNOEoyQUwySkV0bXlRZmN5RTBDalkzVjVZMjNlN19UVV83bEk5alBTbnhvVi0wdUhCRjZ0Z2xYN3p1akdJSG82MU5CMHo2MHpXZ01hYklqd0Rha3dPYXV2Uy1yX2RqbEZpeUUyZlJvQnNPNDN5WlI1OGJqcHhpRHJxOWdnMEtJcktBQ0gtWjliTUdxeFBIbHVrb1FGeHAtMWszQjdndE5GdGh4dEJqMng5Q1FBVUJwMFNZYXRhUmgwVlBPRGptMWhLd2FUTnUyNDlxZW0tbERiNTRhNFplaGZqVExkS1RoalFiMktwY2FCbVg4ekpQbnRhVlA2MXdDeVRGVDBSN2RIVHloZUhfS0NYbHA0WDN0ekdoRTg5VDVVWjVxVEZJWmNDR2I4YzM1c0pjYnh5bWZ0aUJJd05sUFRlbkNid3dfQXlOUWhreG95Wk1iai1lQ3NBN1M4V3FaUEp6ZVozWE5iV0ZJeS13S3hFMnVyTTJKRXd4eExXRllwOFQ1cFBQQVF1NG1NT0k3SDlfNzRTcWpMRFpCU1Myd3dUdU1YZW1aSDJuWVI0WmdCUF94UkZENzYyM204ZzRuLUdNNGhibVZPMW1LTllJbDlHdzljbkpQOHpSSWlNbUppWEdXTjktbjRPVHFRWExFVnlKbnlUQ0RCMzFTSFctTThyeUJMemEtOUxOdFZhUzVTWkM1UG1vem9EMFZyY2hFVEZmelhwREJfZGYwNk1aYS1icEpBQklTVWJidi1hM0Zobm9JUU0yRW1uT1N2Rkw1ZFdDRlZMcXAwREJOZEVOS0FiQmJaNGdaaGNEREVoSVQwQzh4dWJ5MjN1MW55ZlowRld0WXFoTTh1TS0xVzVOTlNLZGkwVFVhQ2d5OHhBdEh5Wk9YeWgzVFRMVTh2ME1rbjFRRjh5ODRsOVJlejE5VTR5Z2JqX01CVUJreGYtNnhpSFRVQkNpQmN1UnoxM1pSTkVMNUFzTUZLalQ3Y25zRDJxNS1fdDk4dEZ3SmNQejBTLVctbzFtVnBRSkFjZWZ1ZXBRcUdvVzdLNWIzMWFCVHUwWVc3MTZCeW1pSVEwTU5VdC1Cbnc0VTZtdG9wWWJVRjExVXhSSHl2R050dVVUMlp1MDFJSWlKTVRvYmxoZXlYQkFraEVUaDJTXy1Cckc4cG5oZWFZaE94a2wwZE1nZy1ISlJ6V0RXSHJTZ2tUN2plaThNNnhOY0Nwc19veC1kNkdsX1FwYnRkRGZWaGQ3clRaTzhCNTFQSVN3Yk9aYUhkZHotRlhUZmd1c3p6S0RwZmtSWjN0T010VFJ0U1ZWR2t3eG8wRWdfQW9iRVJSNnBBblRfN1hZQmpFWl9BSVVwQkhmYldjZENyUkN5YnR4b2VUU0RvS0twblJkV0E3cnpiLUtDQmVzNG9mdWhicnNldEdWXy1rT0dLc2FuT0lPbkNPQWdHc2VFb19NTnBvZVpjWmd5QlRlaHFmNXlCQ3FZN2FmM2E2Q0F0V2hfSE1IVzl4cGk1TVlZVk9sRVBWWHZHTFp4bi1xS2hzUDVwM0g4a0VHam10d21CWGFuQVhkNE1HemZtWnA2UkZ2d0VIaFJHNFJQQkZYSkZld3laMW1oSzZZVDZXYnpuUGloTC1PTjJPVnJEc25CSWdEUGVtclpnaVJIVWdnMkk0MXNnX1RMWTQ2N2NYUm1JZUc4NWpUTmRieEhkRkt5UWhNS045UUVBYXhDTGJsaF9FZFF1LWJtcnFfNVZoRmIwSDlocF93S0M2bFlOM3BFR3ZsajN5QzNIYU1LTW8xSVlBTkROcmhGM096U2VHUS1SWmZHeFQtZTNwdmRzc2ROTHE5XzNrdWdGZnB5ck1GY01iMkl5MFk1ajN2bF9vNTFvLVdiYUN1Wl9KZEZfb19JZV9zZ1ZnTUhoTVA0elIzRlBEVjVjVUR0bEtWWldSa25XMTRaZ1hnbFNRRG5kSG5lbmpqR1N0WkZnelh6c0FqX2xibm5BXzZnS2ktZHQ5SXk4aW92cFN1SzhTMmMxRFdqU2xIQ1FMS2tCdWR0REI4RFRaYjZneHJCZ0piNEpFUWp1LV9mUXlPR1NOellNZ01ISHFiVTVVbmpxOFVlQkFlclNnQnEzTWRza0xRNjlRVS04clRZbGszVEVLeFQzS3hhTUx6MmxWTkZSMzRkUDl5Zm9HMnZvOW9PS1VEb3VUaXRwNkdhV29Vdm5jWkdDME52bktJaUIzc1NiQ3pOWFdWbFpDWDhWdFhRQnB4NV9USDNhYi14bUJOUnVQMUZ4dlExNERsanZHQVBOM19DcHhxaHAwTmxzbk9xNzlqYmV0TmtqVHVrUTFZLVVhS1lUVFZOaTlQV21CbWJJTGx6X1FfQ21lSml1M1BwVVUyM28yNHlkR0JFTzZNZFg3aldMdHp5c1hxSVJyV1JUS0g1dG1rT3VwNlQzck03UGotb0NNMURacGZHdFUycU9aVW5hZF9TNGR2V3RBT0EzMVVsLU1DQjlLLUpHZEhyU1NKS0xoODNqM2d1ZDdoTUswVFJmYzVXLWdaZzdiT2xUc2EwcTB5anVKTzAxYmZQdjdQTjN2cTRkT1RabWluNnBJMzJSbzBTQU5NZzlBRkdvR1g3TElaR0Y5bVRMZkZGbkJTUlctaW5taW0yRW1NR1piQV9hNUdvTWxOamhmV2JvLW5aNHZubkI0M1NjZlNwZnI2LWRvRzd2VUZzMHlPUURuM0VvZF9ZcHBwUUwtLWtKR3VlYndlTVk4ZmdtVy14NktjRENjSEl6NU04MzhROC1KTEpPNzVLS0ZqREZGa3JtTGZfTGF5ZTJuekpKVGxhN0NnMUMyWS1kMFJGZnd3ODRHb1JjaGpVS0RPQnlFUDVlNzRpcnVSc2hjQjl4QVUweFpyZlIydmdQM2gwbG9UYjJ5UG9wekVwaXV3N01XZDA0eGhsMWhJUm1haXloRFMxc3R3WFh3aDN5SlNuWE5NMngwdnY5bGpQTmRDTzBiQ1lyZVQ1SXY3eFp0WEl1VW5jaWI3eldUQWZNZHM2cXF6Unp6Wkx5YXFTT0JrQkxJLW82R05SMm9PX3F6dTZteG5tMlJGOUlMcEdxYnRnZHhYTTdScVNkNVBEa1RfVjhrVzdOOXlfTUJuc2RpV05uelo3WndPNldrUlNvbkJPc0licVFVS3NXR1dUZ1E4ajE4dy1hd3hnWVJNQlhrY3lEakt5S0piMjZrWjhnRXNlcVQtM3RPTHdFeGM5cjh1MEtLT1M5YlROZDF3YTRFTWZHMEhFeE1SdmdqQ2N5QTlLa1pnU3Y3eTlNRm1BS2k1M3FXNnVvRHRfX1Bwa0lFLVpqUGhLLTdSa3Y1TmJUQnI1bmctTlR6ekFHc2s2enVPdnBpU05JSWxBRXNlUUJERWNES0c0M1Fsa0N0X3g0VmJ2QW9kQk9lTVJpZWNMeTVtLXo2SVZyME9xX0Jnek16ZW85Wl9xZFhWdFZobTU5ZkhDek1rcEM5WEN2dTVXaVU5UzhsV3Y0VmM1STZXa294QW9vZ081QXJFVVV4T3JsMzlma0ZpR2FvUmNBbWM0dG81anhUUjhuWVJXQ2tFdUQ1dEoxcFFUNkhpaW9XMk1OTXR0OExMTTFpeUMwejI4bWFlcmdBZUxGQ3pTODZ6QnJybXVTWFJEQlhhaW9DWGM3VkoxSEtmSUFYcDY2ZEZ3RjhRUkdUOE9LMm55dlZIMzlvRWhSX2M2T1NiRzJvYkxTOXdWM2RFSUFiY0RhR3hjVUpCU1JXeTdUR0ZhcWdhemlwRVRnejF0NThlNUZhS1AyUnoxMHV3LVRHSWN3VVJtRXhlSzVnbDZJWWdMVThKYmVNdWtpbTM4dVFXaklVQXEwOWhva3RsRFNueG8zRFg2STJjdFYtRk9xYk9rX1dLRURHRG9aRG9neG84UFNELUJWeGJrQldRZEwtTUNENUpzblBGRjZhLV9BdFBaWktKYnZoM0t5bWQwNXVfbk9qTURUdXFKU0xuNUV4MjFPbXAzQW9WZlpNYVlTV1hzaXpOWU10cEVReEMwbWp4aDFFLTNmRm5uOE9GdzVnTXFXNXN5d0ZHRklYcUF5MFlmc0Fsb0ZBTkstRVZvVmpCbjY0b0Q5X1NsNVBwZmxFZVlaSFFRS09IRmxWazVwdUhlZHdpckNfZGhkdGp2TnV2ZlNSb1BLU0VJWGxnV2owRHRrRkFiaXJkd1FNTFBUc21CT2pOYnhSWFkzVG9Qd0RSZGo3eC03VVJxY2Ftbjh2VW9UT1MxYWE4WVRMNm5FNVhsVHpuOW01MEh6ek1Rb2tnemcxQlFLSjRsMFJkbWw1a1RiX2tTRm5XY0hobHp5UGt3RUxvZnZfYnlBN0lSXzV0d21LLUZGcUVsYnE5WW1IaXNrR1BWMlpHTDFmTDFGaU1RSmtxLXNzeFlTNjZJRVZ3b1pCaGw4dUZJbnVidXhFeGJaSEpTX2xQY0pLTnQzcExWazJJSzJpc2duVFgwTnlJRWNzMG9pdDlfQVRERUJ5OHZwWTYyTjIxYk9la1lJM1o1Q0pleFFpVTc5VU1wektndTJvTGlaWnBaeXJ4TnVMa3BWSzJpT2toanNaN3gzNDhRdjBSUjdRN3p1aWM4b2hnbWYySUs5cjltOW93MTg4MlpRNFlETTdlOGlxc0t3dkZkOWZuOERlcWl2cmROQUhRcjFlQTZnN3BVSkpZZTNiUDJKLWpGSnN1azQwWXBFUXZVdGFaZjF0cUpPQlMtWlhvOE00aGEwUE5KTWx0bFhmZGJub2x6aHRnYVF5blR3WHJBRTBSZmtnWjlMaHFtenI3ay16TWEyM0t3UHdncDJmUGgzSmV0Z202Nkp4eHBnVjQ2dVl3UTVwSUFibll3MDFOTUxFTXlQaUNySlFFRWtwaXo4WG9hOGtJMkdRdkh3b1pTYlMtNzFZcHMzQ2oyLVZkRTBNaV8zUnRJUEZyaVVTUERfS2cxQ25pQlduN0IzS1pUYjd1MFFwOXl0VE1TdDNRbUNwcnR4YlktVWFwWEtESUYwYVVCN1RPaDRuN2lFZ0pQYzV5M1A1LVZkQ1VxUHJKS2VwckUxN3AzMmFyWjE4VFFwZE5rRHdXRWJWZFlMZDNvc2tTdkhCMHBmbTFablpMZzNpSGo3SmxFX0VsT0RIOVQ4MXRBS3ZyUFlzZUJsWnZQbEdUbDdRN29XN0tSZ21zVDJHMmlqOW11RlVEWEoyLU9ycFhHTWFURGxpdGNhcmpXR0tjMXFJRWhzQ0IybjI3LUlDX2FnbDdHbG4xUkdCRC02bEZGQjFuTVBWcHJpVGljQjA3THJZblNHSTVRdzFpY0pYNnV1TzYyOHRTMEh6Z0llUEdRVzhPMEtyR0xEZkktX2ozQkphbEN1eEpMeW5sdmE4MDVaWFZ3RUdCcEcyaGFOSlVleXhJeWFSamM2SGdOZzNHXzNIbFItWXhiUjBfSmtEODJwczhfd1VmZTBGOW4yYkUzWEVNeEd1bm9rbWdWbTdxQ3I0TzNxQk1HZ0dvN3ExNFRVTGhndk9GeXVZU3BKdkJ2a290NVptZS02SC1idVYySlVjNENQYUN6Y0pFSnB6QlNmTnk3eEFlQmNvbEN4Q0w2MzZDZS0yeUFGVTFFdjJ0NkN1U1BHZUlyY0RrRlUzT2RWOWxvRVlJaG5nNUdEdDdXUjN1RDJsRkh0M1dWLS1ieHkwSFU4YkZmT0c4b0hoU25NN1hsOWtGR1ROWUVxUndIUjk4eENYeXVlS1ZEMHVlN0ZPNnotY3dxV1NxX3BFb0ZUX0V4OFlHU0EtS1k4N1RCRFY1ODlYSEdMYW05bm43RXJybTdNc1p5Znp4V0NBb0U4YkktX0hRN3dTLVVTc3JuZkh0eVJCVkRMcHRSUDVXWDhTSW5jekUwbTFsZFdRUFRZdDFZTVdld1M1Wk5GWll0SFFVSU9FUzNRVlZ5dWlrcXZQczBQWE5Db1p1ZUJoVVViZlVab0E1WFpDTXFYWVdsQnBUMzRVWkRTV3RxUnRVcXhjZlk5YmpvNzZWNjRfSFAxUHJ4V2NQMFZFVi1QVmhxTE55VmRZd0VsRTB5YnlyWlNsRjRwVlM4VTdsd1VlS01UMnpHNWVDLUktakxpUEU5S1M0eWU5WEdtZjlVZEZjd1V3cXBiMjl0cVFFdXRUNFRmUU54elM1dzFqblUySF9BVmxvNm5LZGJiLWt5RjB5WGZyRXB4VHJtR1VSZTRqMEVzMHBXbU0xOVZxY05yeDJDczh0UDlGTlFxNlptQnJ1QVY5ajE0SlpOdUhvY1ozMmU3cTdsN2tfcWlseEtDN1hjR3lRS3U0YlpXdS1qWUEzdm5OSDVORnAyaEd4aWFLVmRka1pDQVlTUnBqMHVNZ1FuVGNEUkppTTJoV1piaGY0OXBUaUVwak90dmhIbHV0WDdYdmpnTDVZcWtVRzNBbUZVelZIOWs1QkFpUXo2VUtwVVJjUFVNUnFPTG5fbkpMd0VsY2xKUE0xYldZdEhZNHNTdzl0OTMzSjZxdzdENFdNRGJRLVI0QlJubkxwNUZZRUtSY2Z1cHVKWWtxV29xd3dQUzc4b1E1UmZfSF9VbVlBZEFOUXhsLVU0MUw5RTE1TEZqaFBsMUZObFhNLUp5ZVNJNjhlbUJ1NGNWY1l4d0oyMGd6Y2NuSWs5UEtjdXdUWE1IUjVIMmNtZENxRnVBY3lYUlJCaGhGRVBfNjFmbmxnRjMxMFZSdS02c3JmOVhnTGFuMEdtaVNZSC1UaVpmcUFrUjItRVlvdWxFUG9UWUw5OUhTekcwQTBveXhpc2YyaER3Z1NxNDVpbjJaTU9BQnRrNGpGT2ZKQ2kyOVZxMkV5YXVOQmRodkFQeUVzVHJpcV9ydHZPN1phUUs1Ulc3QndPZ0RsY3k5b0ROcmVfRG5mZm9jRUNmc3hMVndab0Z0Sm02eUpoNmU5SDVTOFdMcmF3MEhDTklaR2QyaWNTUTJEMG5oMjh6b3JSY1lfanpIYjBwX0VIZk1iNjhxa1hoQmREVE80ZVQxeGNtRmZuUXRCQnRCMVJYaEd6cW1MRlhTUXJRRWxHWFY0czZxNWFYRlJQNkljdGowQk02VkxHWXVpOUdZb3YxZEVrWVRaS3Y0QUtnQndySWRGazl4N0hOT29YRm8yRlgzY0hWTUpWU0hzck4xY00wekN5SVNGdDNkaHB4TnVsVHY5TkdfQWZmUUg4X3NQa05Ua1R6clcyRlM1RkZpTjVrQXJLeUZRRGlWNEZHZTRxWE5WbFhfOURtLW1Hdk03Q2lPWDg2Q3Z1OEg2c2JEckxFR2VxdVJFSHdxaE9DYnR1VDljczNIYlBsbDlvODhxTkw4TV9CSzc3aUh2a0lSQUc2Qkl3Qkt5ZFo1QUNpVnh0NVhIZ0tEUE05a1VaMTdLM3FwYXFUblk1YWw1QjF3bXVYMkwwSDVGckxxQjJTTFBPUE9zcU1RTlNidGExQXBkai1KMm0ybzFWY1JPaGhWeVJza29iLVNOUDd5WGJrbGlUOWJTSHl5YzFvbzFXcTZKYnNZd2hwdVI5aS1YX1cwYkc5M0hyYS10c2pvYmZPYjFBeW5sRXotRGpqZXl1eEt1UGVtLXVvRVlTWkZfbXRsd1JxbVNFSkFwWmlxQms5VHFTZW04LVBCZWxRR000MVhBOWtFeHc3cm41anROODZEdTdUX3JvRnRTWGxpakFQUm44ZTI4XzcyNEwyTWtrN3FPREpLMkg4Mzdvc3J5bjNXRWE5MW80OTJuTS1BcGNTZ0pfUUEzbURqUTJtaHZNVElPakh5TFRCZlBjaW4tby1UQzRhc28wdmpJUEhLZ3pUeE5oWnpYNHMySjFSRF9ldW91cHhfNXhocDdCTDZSTWt4eWVMd0o3Y2VwZFhDVmNmdzdzRDEwQnlyVGVtSnVoT2oxaWhrc1lVUmdEZFI4M3pweFl1Sk11a0ZqbjlxbEQ2a3c5YndNWnRpU2h4QjFZUHNuV1daV3U0TXFsVTg3SldZQzlEMzFUdXhiNFltYndsd1RsQTV6dFBTS3diTk1fYUI4aXZVUUhUazBPdFFwcndXMTlCdU9FbjFtWnpBYnJ0WkUyZ3NFQ2w3TTREWjZWR29nMGtza3gwSUlDVks3WkxEQmZRYXhIWmxFOFk2SGFCS0JrekhKSHE3MUNfcnMwcEo0UWZRV1NiNGdkRFpIeVpWY3JaNktPbEZsQTBma25LdEN4YnpjM3U2TUM5enFXa1ZYWWZZeWVvM1JSNUg3UVJZaUJqM1R6SjJVMVF4U1VqQjZyU19XeW9vWlhnNHNyeG5QRWdKak01TTdfMC1yY3NWVlVVdVNzT2RXMXFybjRlSy1Kd3Q0elkwUHhLYU5wZzRkMTFLUURIVXJkRjdPbnd4UmJ0NktLSFlGYW03UGh0ZVozV0dGbnBIbktzdHJYOVk2bEREYjBTLW5KQ3o4ODF5cUhUSmZ5YkhfRWFxS3R0ZU5ub3dDc190Nkt4NTVBS3o4c2VaU1psOXJnb0k1V0FrVkR5YmlfSlFFdTJnZnp0YzN0M1hCMnlTVDg4bl9BcDJNbU80X0V4QXBoVEpfNzdrYmJvWkl1Yll2ejA2Sjh5ZjR5Mk1yXzgySlFLVVBQYWhuNEozejR3eS16d2EtaDFLRkkyZThQTDZzODF3YmZ1QndrNlBHNFItZWg4UVhybEJrSXVqMkJ4eGU4VUZ3VUZONW9kbzY4VC1SWTF0bVdPRlZndnpDUkJKc1Zjb3htLU1CTGZsdW5XbTBVdDRvd0F1MlRKQ3lUaTRpWDhIM3E0X1lQTy1zMXBiQnRRaU0wQU01azVFNkdoZlc3MS1lQjJ2cHMtMjRORzE5R2gzTEhvTzNlelJtWmhwX3k3QXYxV0I5OURrbmJ6NXZ6dGxwcW92Y2hNNWRDOFNQalFkMDBDRW5NRmtwaVQ3SDZZTmFKVG5BcnVoanhTU2RKLXUxSmdGSE1ObzJpNEtfR0xxY1BlSGlIaTlPZDM5S2NGdVNQeHAxOV9wc0Z5bHRzWVp5cXhoNldJSG55bkRvdEpiOHd4dFU0bk1FMWFvazFZNk9yc1FUeGFtNnBFQnludFljbzFoLUlhanZHSGliWkV2UGdLNjgyc2RoZ295RjJ5OG1na2JTNWxHVDd6U2tYWm0yeUZwOGk0X0tVUnlYWUtqUndFZWdKTmktQ0gxWWs3ZHgwbExOaElOVzJEWkdyN3RFd1dOd2tFMzFHdWwtaXZWZzdGMTNMN2xXNW9OWTk1WXFXQlh0RzBsRHVoUlduSHg5dTNWV0twSDFmT0xDcnVIS1VXdzM3MmhtX21KS3U5UW1tQjNrWDF3SURXSkQ0SnFfeWlaekMxWEdIOEFzRmJfOFhtTGo3YW1aUmRwRFRRSmV3WlE2NXFJem44VEx0ekFhTUktUUlQZXJDSEZmeDFYWW81ZUpWdHc4MWphVHFRQWJCLVZ5X3ZXMG4zNXhUVklEOGdJUlpYakhRVEg3YTgtaDY3ZVFPdUNtS00yR2NZQjlFSmNRLVRPdUd5ck5Cd0lBckNxSGxDSzF3SjlPZjFYMjQ2cjY3dnd6MkJCQUdRWWp5dF9yZ09PcFFadGthV0pMd25ncXEwRE1pYWt5cE5LSlVJbEViX3ZkUGp6SFFKMV9IVzlMSFB2UWVHUmVJRTY2YzEyWlBBTm5tcndDaXR4M3hzcWNJZVd2d0Vya0ZzcWMteUlZbFd0V1Y4ejVmdklMY2JvSWRxVTJ4c3RqR0lvZDhudEp3RVRMeDJJQTZ6TUZHZ2E1UDZkcVhiMm85TUtxT3U3Z3UxYzBUaGtjVzB1QUFSb1F5ZzhDcnMzX0VfcC1YRXpCZGVWNzBIWUhXNk5CaV91OUVfLWVKVm13Vl9RcmJxanM4bEJxeEhsR1ZyUHVIbjd0ZU1ncXk5cjY4b0c4RVZRRFZUV0tXYWZ1U3Q1bHJpWXlTMlk5QnFqbXduUlBFR3lqTzJtLXVNRTRHQU84d0s2eFZVeWF1emlRQ0FyLnN4blQ5QmJTbklGT0RKQ1Y4WGR3RXc" + }, + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/testcert/21983500952149bbb3129b0c60e367a6", + "kid": "https://myvault.vault.azure.net/keys/testcert/21983500952149bbb3129b0c60e367a6", + "sid": "https://myvault.vault.azure.net/secrets/testcert/21983500952149bbb3129b0c60e367a6", + "x5t": "Z-n6Mydb08bmyOgk7bmx5HT8tyo", + "cer": "MIIDMjCCAhqgAwIBAgIQGn/FrGQZT/Cd9kgXIsytEjANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDEwtleGFtcGxlLmNvbTAeFw0xODA0MTcxODI2MjZaFw0xOTA0MTcxODM2MjZaMBYxFDASBgNVBAMTC2V4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsODIu9EJhfnn57k4++j6dC1M6Egi9aZucFQ9Jc29vFG9L9BkzllPGluKKdH1ypsrAUif7yGaq5d1nDyLhZUncU8dV/YIA7oll/fC+d0H4A37kVbM/60zXhXnKRx+DRZ2hJQzNBOodCaZpyZZEuYvtWdSCSILpa0R7yXYevjLaG5LfckOzuurXqeos7WB+l2q1c+6zx1KbNXbBl7QOz2nzk9oJU7CdhPOc+LOLppmsXRwwluKtmCDyKdrKAF/dANp5zGXFsognQcRctLSGQp8FbgBVQyZ+v81n9bPpSaBoUQMcH4uG9jPO6CWwbDSWE+FVYAm5kgjuW/1hqRSnOEV8QIDAQABo3wwejAOBgNVHQ8BAf8EBAMCBaAwCQYDVR0TBAIwADAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwHwYDVR0jBBgwFoAUaYJoBFokrORdsxOTA8sgrosMOmgwHQYDVR0OBBYEFGmCaARaJKzkXbMTkwPLIK6LDDpoMA0GCSqGSIb3DQEBCwUAA4IBAQAxL3t0kV1dq/PGUztjW+qK6Nh4sx7jsU59JtjON6zcibJ4hM+Q3Z+cEvW9zuGkuTbLz6fKNL9VnkF1LnlWTsyRmS7bF15/7iOgfdrr0vkJKVM1Zv/tqKEpBJ7Cbc0vW/VJQxZN+OlqGNc9bcx3cnqkRwpkgM25T0dVpoWtCgMwayUtbPFbTZWHHbpzHLF2BzYf5HyW1BoKXcVPM3r/rS7RETasRRsz2GqXXdfhjCd+HKVyv5kD9N3WcFNUsaq3TqAUZyOx9bO0Cn3gkmgz05JpfhPEylXwVpVAccOoXsNoFdxEKGO0w7pk7PwOhsW8sFprdXWp6OxtL0rrCNFF/llT", + "attributes": { + "enabled": true, + "nbf": 1523989586, + "exp": 1555526186, + "created": 1523990186, + "updated": 1523990186, + "recoveryLevel": "Purgeable" + }, + "policy": { + "id": "https://myvault.vault.azure.net/certificates/testcert/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=example.com", + "ekus": [ + "1.3.6.1.5.5.7.3.1", + "1.3.6.1.5.5.7.3.2" + ], + "key_usage": [ + "digitalSignature", + "keyEncipherment" + ], + "validity_months": 12 + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "AutoRenew" + } + } + ], + "issuer": { + "name": "Self" + }, + "attributes": { + "enabled": true, + "created": 1523990175, + "updated": 1523990175 + } + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RestoreKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RestoreKey-example.json new file mode 100644 index 000000000000..e53bafbc5d92 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RestoreKey-example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "parameters": { + "value": "&AzureKeyVaultKeyBackupV1.microsoft.comeyJraWQiOiJiNTc2NDI5Zi0yNTY4LTQ1YmUtYmZhYS0zN2VkMDdmYzBjODEiLCJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkExMjhDQkMtSFMyNTYifQ.YMIP_MrQq46_fpDL_H3RJJsIJ-3NhyBd1yk9bBKNI8ggN31ah6qehcPHHLgJrx8jkBLLXPqp5f1zlil_rUk-KkOryc8ZI9cssM5_Sy3xpI4Zy6WIc5cjPWuGCCmBpAyrtGOVzhjQxo3rTW1DSqgZUvr8TJly2PKrviI_RgnEd6-RVKuuVN4efVaK9XVTmn1vfygzpTr_TWC9PFmzhOJzgU98_9_nVrWVHNS1uLXJXnWhAOfRYtVRNEQIENeLc-g3cMrK91s6NWxNqfF_GL6Px6qXG2WWCOg357fBgOVStDKiVH6N1MedQ5piadxxTT6LHZokB4x1JlAIfL_bU69PVw.F9Qb3tVlMKprCKK-YEi82w.T0MQiauw0l9Mb_DWDcXoo1jN6IYu59Y7SEL2mgtU0x3XL9yTsjeF4cb44LAh_oP7gmH3n7J-VD_xJ7hWcMW6yS49E_M9iygt9SCl9f4Suki3CYvL0QERTYKImj2-AFDLZIwNmGba8G8axPqGcNKsRgGZgYTToiYLqBryrbvLJudCqgjeQdi5MmtyPFpagHpHvKkucFGp-XmJ1KbO2A2QOWQTQZ9CereBqrCn24IwaQrUC4rND2w0UA1TcwEeuVBGELdJZosXs6CGDfjZHqcvpz74Jwx5OEiq_DPs9TKrkMhowcEplZ8ZJMcNQRfu9J89d7YXgGdB5ikJzp5ZV89w12b0zCHNYJjgddHS62fjVeaE1OOP_7yfX5tJb6d5AXigr-JJ3lb7cba9q64plbiarMKzab5Hm2LMFuKBr5Nako5P00hQBgGc6ipIK8MOcKsdaB2Fr50_Ub6rDS086u37-CHtFFqy-1AhiCixQjCML_kXkI0vDbbjF-_xkMdaBV-Au79O6zWjsDeeWKtUvVQnB0c4By7IWCLeVw22i09Yi72zBqfOF4rNgxU3kJ7_-5boWmyYW6wM8esN4xGY3PhU4yKE_uDg6vNNwt5scWYoS0xx6PCos8KDtcr-UypQ92thU_FXgq9StTYq2YgVWGPns5CDLODAJ-l11I6IitlP7HhyLo39j77iWfTKDgL5kp7D9E3_qdPZktjVPDu3ZQcT739N2zz_1kXrDom-6PPqwVS6mQzAUmqixSivcqbqjZIFtOllKFA6qerh2eSAYzTMSCuwJxDBRB5-n0MQlIHjC17dLZhVqD1Sb6Prq_y9sv2ivWq9La9GfGlHA6VY3T3QdSCukYRjXXq-B-NnVdhFMValVvosrJfnHFaXfLi0gs5U9Ku4yjD7QoW1yR1IY9OrZ4qRQwkpnm9O2rrH1pm_XSzLQT4kZcKbugxsoYtlDOSiobKDXu1MtCqvDnvxz8Fw1GpMrBuLkVQDVeeP2j4ZwLlOnLTNi8bScNm_7vTsTPm4ID9mjpWI8Bap83TKi3dzP1k1i3Ggrr1HJUAOzCCcQ4gilDKZ8RElQe21BAqJ7yEnnVlucyG6AWa7viYYuxxBHkDl7XGdvX0jI26rwcS_FH2yNiafd3wJI1342XAvT7CQeh8dZedJSqXQGjB5BHayV_ofzeUp_8HjFDhKUdrcI4i0kFppHdPXMAu128wDu2LnUzyM4JZwSIum_njbQ3ISTymELNx3wt2WSEOd7AKyKyB4BsSsdPMGewKI1gsj-HCEoNBwxPBAvVqCII3lf94m-EM8-XzNtBUqiOv9dDBkgvzJmI9k2O_VjcmFknGJoi1VzYpiQU4XlIZzjCwsCDqkahubcqXWr08UtPmWHFEy4CKorVL7UHiXlVrOGUGtSvucwKdcKTOzWlRx-DcF0LCzMdGZwcg3ei5mitlYbF2UlbN2bZSCPX9c9lESdAQHqPEl5raT67h9VxlOswhanxJFo4enDCZafNmDFG2La69EqBV6KLz0_4uKZC5mxavDk6WKyfoDNyqsuVLto7YsjRN152X05XHHnESz4ne3c0jwWaz60ZIGD5MHMQHPy7O4WgakaVsJeOfaCskwbb49q_mBsX0NfZPcqabDXhZ7BYLQ9XERGbnwd3JDBh-_TT7k6XDicKTnVPueF7wsV_4hOGRJdTI6PTfWj5uf8u7qEOAuKy6euVMKy97MWKOT8-ZQl0hIj0rbVGZH-R4rqH1v_VgQPdi-qWoqWqky0aZK3CNA3QxWftLGp0qEWpu6OQ-ChN7-vxN0tUeddDZQyWWtwx6TW1KhCBWZGjZm9AC68bU2BuNME55oUWGlncN9EnFzgNmQMTuK5vTgwZBHMjfQzlIG_yfwAumHycK5OOOvx95Hc7wDAD2W1WRohy05yLRdlBv_4DQrrMkadEpf0utvhwUwevR5McVEybOwUL6gf9krC4L4bTumBQloBrx5h3nLxYw90rijlnKj5YbKaejrMwbImyF-qVNMmjSwb52StJ0wOG3xOGfBQDxPXrmIxh0DR8GsK0dy-1HIIej5-oRMd_J9aVKz0Y4wx6V23h-jP3q24JbawvwlA6rV5iUFdh6JQriMNC-_aD_u__5U7t8CH7ZVCuP3nIi5x7gmqalK3egHm3pdb_lowXE4ZEBDLvtkihl-w-PFsuYoUJIFVqFvVs5EnSSMW0PIXOSfVMYmJZekbiG_QjxkB23BhzYrSjCz1qnSMx9kvbp9Qh1ndRXJJIPU2jeHuLB4OgW3hzynCaqAvPEuG2XnKpxXfxAKNzWiLIN-0lQ4_Qt4tw-fjaYRUV5KUjrbVgk2506HPmYTGVQWQ_m7gSASPZj6DbInku7K8EZr6owuH253Xqk9kIl2LMBpvjOkNMaQMxKr2-2YdPEy--fMAPLp_UMy2xjlKLKk7nXIu_H1vRng_VUrVHneGjFan87QEORSV7rTAprO2fT2j_9hh6JmtYkQqgG86YyJksUjWs3xpdi6NPFELjAgyOFC-4kMgKlgI3iTHIBWQ3jjtSe0Gct1K7BpBJRrIAF-1UB6JT6cJ28gMswI98kud5hoXYmT5lA-ZaD-I8dM0qFtHH8kYW_nzzo9m69-iYfV_wsy2mBvueoNQddQKBkmiUMnxV90tAyEg8YrZYL1rOcXqcoeI6_8RetmvYxVM1bpuq_j9fMv-zTA9JCeyJ1qAN5VAaicIgg1JXICLB9jeSOOsQw1avqvM7N1ArwCr6oMHrq5ZCEK85yVb5G8cctewoiHYsuYOOHgH3LnchWzfJ3MiEcM6_V7RdvBQd03kPzGEV8uI2uh9tmLk6F7UKzYM6ExI5mKPC9-QN2Mxe0z46ke2mxGGGw-yqL61GGAiKAcpClK5GxyQmPnDJ8DqJNOVX3h_o7a11Uo32kdtG2huXpDUsay6E8TbyGWEgwfX7ZVvk7UM3ejt3jYpqbdYJPMMBB0gM9OfIQcKITroH0rDlQ6ZkxPc4dpeCmM3875pWNQkg1JJuQg3xpOVgEFjYZlED50EiVJ787qC5aGmjLQZ_r-P7_hI7OepLVgPGHASRLlwGN-FpL78QoUzj_Xu06Pd6AuTLmbjhViDD-udnqu5UGwJ4lYjbjJCA7uPOe_ujsQhYwUGA_XBylnErIlL7OXHOTxaDlJGH4-4wMroanhOY5hgcVdvUBZUgRDUh40l3z8FUbaRlihE1yt0uNoGqwMdrZvhNIwaQcPYPyUwQ7Auhuv_jItUqiFBogryRoscwz2qttjmv8AQYHyAly9ujvbury5LcIh_EQfTzBnJy_p5Yw0CXnBK87fEH8raZHxWETpqlxyfYdVf9PjDXLbLabVCbzMsR2sXfAo6m4VhghF-CGNWymknD00Tme4La4W-A-OeGj72-n8Vc6b9g78wnmbAttdrQ8PYWKQvcuyDlvyEGGH_5UmtlSyj2JltKesw7Wsj-ak8CX1btdsSlhBWcaBttj3RjwlCxhD2MyVttzt207rOB7qtAIyX5zrY1LZHpwEmMx8dZs747ecfaeS4dQBZczSyB4VEYTQXgHygE_q-bw_exj5k9sDGxsSFqyzQBVoU9Kename4DJsLXWZinuPHYQSmX2TdPZmsdHxBkpAprb-H4HgEJpOalBkGwhXskHpb6TNHPxy-oOm-hAizmMVOg9gL2NHzRuAmoI3U4Ewa_GEnowteAQSLecMzZ6qgyudk0pnuRyN6P1m3BSQ184WS3jx1C460LAJ3arI-4Aeuin_0VX3qGva344vet87DR7IbME3KMkYkTuz-hzjnxGUT5qvaZv077PTq1m5CQPTdee6Sg34f-ylxh70j1I-NZvwhP2LVv92duVxJRR7xslJzS575q7ifuPG0Rzt4Ny3YDJz4MeCNNpZIpMBJxdvnG7k8lmyoBUQbdz8xBunXOqlD1GSm93NKc-wo7qfzIjv0Z1zYZp-nK7J64E-Jzx2D1glIDnodl9GmyS9po339IYaOPfRgI3ZwQSVGppBP7GMEGlFEqlo7m5-4SYXG6JdXaNr3iQVghPKdAei-bCLAPlbFJCEAU55r_HEfKlT5-36SydteqaSdGo1XFEzZuaH-_z8BlwXW0N0tRitz7Ixu9NANC8GutgkvXuER_Nnw5UIlarepM6TD_Z_e8rFD7haxV1WtoZd9BSwNbRmIyu6cfZzX2xSOVRUJwVHG-Y3ZDdiqkso_WGBvLRJBTVOsoeVnqe1ZKjoCQK1DaFOopxP7SMhp9YicoWFOUQNN5-DB3-68CmDsv15-s3DTqQC58xiwbY-4nYktySQWayzTobVNXmbvb9K9-uj0aTVFLzH1G0YvLmhSSSwk_3O-ctRPLEnXPSQV6GUOjywLHOXSD6_cYS7RkUtx2g8m_1nhIQm08Wui5MJGPGBDoDf7K3wz22tgQQWL10cbtJUoBF262UiH7LNi22VCkl0IX1UQ7-wpI0p8dWSoWo6SnOa7dQ5iBIbf9P_rQwWaaYu5_ZBZpCM4UqVcgaGSYVsqDzWEV8-tck0X8NuI2rgrR94CJxcJk91l-oz0nWaMAhprnn2_wxRXGNay36bjSq3YxM1stt1M7Rczu7Q2Pz-fdjGYANHvqAKXQ6imJaAsplNtJHuIJujwrNTPwFs4a9l4dXwM04QIfhc4yzmbp9XF7UYU423WMhQSdL5JZNWyAuq8AnG7mwgSP3T24NThuSFzf7uNNrJg_PY9UCVriOKqD7YUKARgQECA-NkalnXSEuTCvk2ifEX8Hzq2Il5wLFr9QJV0fO_DRCrS5sDuZVbwD24cejOybmguUanL8b2IjKxzLUOOke2EO5TQMtPQfcy62vEyscpC2EawzaCvWub1SWKdYVu-qPstUxyiOPsipTwWY3MuMFJprSlqaUP1Iksz3D4TjjHIsoG6MAllTYqB-IjnHHfc26nS7ra1yUcltHEkDwt8GR6ng-6OW5bmOBvTQCjdTP8RmvwokHEvFA9Wlk69VHTZEJSZ4gQeqsqo7HBICHwvUb9mzbHgiNtld5YAGOuuSpNLMTq39-33UVhN0KkHKQvBzr59qfhPHSyUFuLg28ojX0doox2JQDgPhlvUbDwpinDBjTpb07lcODaR7ecv3KC9HIAWkx9aWIskmXoAVaSVL0lgNMC3GVLR1D_pehA6rIk6F_jl647L8HDjDRDn6QFtHkmAamtMOVK7O1-T_-TNWph6waQNu0kWY-ep2DDgt96ztXRFSUgM9rL2y78CN2EEYmfAI-3UcjgTnU1FrWhFwt-I6Uf4Vp6V8_6qN2sT2ryaKXz4cBIcCh6o-KDi9oyH5w0Qyx8VoLS6StaQ2aNEz9Jjg-gCxiZtCRXyigilw549UaV2Wkxtvl6dydffaS3jmaLjh4f9xGkRPEGjffo1V4uCyBB9BChiUBdmjTleVRQ8nBrnVAnjauHa4lWud6HcK59V2MNZMMWmKKooA8qkn35TcnDuynJ2HMCgdIBJuPUOSy25Bxnfp8ENMJVkW_TyOnMy9orm55hlxfJ4D58ZwaQDK4AiEfMHTwIsOngjgSJ4KRCv1QkSUx7XEXMSIMQkTa0jK_Z5-OCVMssAo13W85VQJmZCCKYG6Vm-rnuXIGYfVV-858ow8BYPhCaTaW4dVpKXDCD5_sQljgIJwtVg4ODJcWqzRiYjTis2W5cvPoOXZ5B2fqZU9BXeOAc8Kv6kfCUjt8UyP1Shk07lmgP9onO1btyW9VxPHNnPw166CyrfUW1hAGB0ua1MbkDU7_vN4JZ0cuV5_b-olRo4y_rxd7PdVDBldpVMLlWxZ-XbWUjtZSVwZOMk8KoWatnWz5R4KVK6AgmbELxikS1J61gYI6XSro0Fqu7GM3bWvVPbmqGt8I_Tr3GjiJx6w9HodiKlFPsbLjA79bnHnCpwpHFAXb9wq7vc-H_0MMVTl7xNzo8HgQ_GkOXIu9_n1Rbe-RD4WRiHwTnbnYmzG63xowGNPI7g8Gm7fL_NzCXhox7TIHW28tXQByY8fdw_v-1KoSiaJ3p4pIRyQBmkBzf99FFZOKh5mLK2pkHOH5aenQE6x6pqCjCdqnwS97xbtJJuNAx3UzP7G3iyZSyel8HGtaMTeWHO1nhOedSeq5ahi8tAEyZv0QRqLlA4ZALkThyeCYrJAwW2iBZ9nCEEgzljOMpu2gtzCFy9ZKYYIhifJuT7vPGuXFMKKVX4XU9feh8XH1EVnvxpCnF9yxFgy8nUnBuGlFEV8UBUNh8NApIYcpeL7yCQyl6P7qhrN7HHH4Ih6hKKiUiB-Z4M0rTJOffGz0XFZiZH7XOmJk0MszBlEahAEn2SSRZiQWM8lDTQpGk_JwBJQ_QUNkLfxBpzlK0T0aqKWw3ghXY-OqjzS8q1W8uAc3ZlTT0VGEgVuO26_oEzWNvXbzJ1E_TAqREVKL_9aezms3rjc-FvWRGjLWONMxTtl9g19DWalP6jReRRExH7v0KLGoHuuEnHTsP_hl2vn3NVYiwtQnjQB9zb26JFlpg6EhAuI3xlVL3xpDOjeIO5s72YJcS3r03bB3m5G1IcEU8JDvY1y22Phnb8ef6z5ri8D69rUKY8E9qkhLWaXN24S-6Ab3QeKJrlHGOrhG6fJBtIjL_wFOdZ2j8Z4mPYvbZ5CDQ7g3MraXuiRzqgouy7NIbzjs8FDND8dsLGVt9CKjtU2tykBkIJPfXkgu4-JRTTDN3H4gpzOfwPyW_19tLvPJ4JQlysnxJhJmInSPKTQ9crRGTQeKAwLvYzgB0nPZB1wgPUbGitlhySWZjmjeUNhJsgoFwdtEu9hN4Cz4NYEKgZ3ZpJL-lfeInjtTB07P8ukiWqGxcAiR9L4Ov_xVlMboanWn4CM-8UJvcDhUDkiLktxtI8M7fM5nx-2AR_s0ryCWAubefALQtuDRt51VkfyIfBvQarowH6zH_V_gYIXWNt9oLILOqk4yjrdygFWY9vAvP7V8CYkiFnIUkXcZyClOgfq39mtJxpL3csouZXTHp11gLbmdT5ESn20E8bnZDq5oHEDXlOlfGHOevlzFtB_UxGXtKYX9J1AiKzBrdb7BbozdEp0-xuiy6XDZub79-mKruPL2ZYb1i5hVjQACvFp2PpZOi7xUfJRhOFwf-49JaTOWN3-aXUoCukCi1gj88dCoPYcUuk9ZlMzZdWXIp9gCX27_zSE5YDBaiVCWOsw4CJFbc-kQT9CZ34dSXbs6xKSt9-ahr9osicbGciZ1ICW_6YdK3IzrHuQEzNsCCKDuobUQQdZARQLyaeGl45g37mFoKP7bxoMZcP3F0w37AGLLW1cV-6uNnihYCZtu8YrFPuaxh_UULONMResyLUlDurvlnAUyj1U1MSlC1LkOm_UWoMuPs_UjSc7H77E80rgvBfBA7Z2DP2jV8QQRb6CTbxKiFI9LXfFR729EqDYUuQEI5d3tcyb7u8O2eBv_Tj9O4ODLyZ97gpLuVwuJUoqjARgEOuSiGul1hRqa9y6VtfjL4Njj2Ib1lcbrA.Nqzdpe8b7qsc3BjXFXZYZQ" + }, + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://myvault.vault.azure.net/keys/KeyBackupRestoreTest/d7a019f5da8843aea30722a7edcc37f7", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "v6XXEveP0G4tVvtszozRrSSo6zYDOScH8YBVBBY1CR2MCXBk-iMnKgzUyePi9_ofP3AmOxXx-2AsLC8rxi6n3jQNbGtIvQ4oMdUEhWVcVkmwdl0XyOouofEmIHeSxRg6wXFG4tYAKLmKsO9HqmU5n7ebdDlYngcobc1xHsP0u8e0ltntlgWBlSthmY8AMKW9Sb_teEYhilbkvt_ALr00G_4XHmfq7hSOZePWbGSWQW6yC7__9MrlDfzaSlHyBIyLppPEB7u6Zewrl_eNJWoUVrouIGA32qNETIOr_wxXRVGKoerTt-wFC-CXPn30W_6CmKSxoFBNvnzijg5hAU9V0w", + "e": "AQAB" + }, + "attributes": { + "enabled": false, + "nbf": 1262332800, + "exp": 1893484800, + "created": 1493938217, + "updated": 1493938217, + "recoveryLevel": "Recoverable+Purgeable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RestoreSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RestoreSecret-example.json new file mode 100644 index 000000000000..b0995ad32ff5 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RestoreSecret-example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5", + "parameters": { + "value": "KUF6dXJlS2V5VmF1bHRTZWNyZXRCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUppTlRjMk5ESTVaaTB5TlRZNExUUTFZbVV0WW1aaFlTMHpOMlZrTURkbVl6QmpPREVpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLmhERDdfVW9aU1ptR2JYN1dYUTU5WDkxZ0FQb05kdDcwZE1BbmgzbjQ3eWNjbkRNOU5vTm1hY0NHZmlNeUwxU0FlZDk0UjhBNDAtVE81TDNfQ05Qal9pdWIyaW03Z21nbHNPNnFFUVVIWU1tOEh2Wl9odFRrdEl4QzRPWEowYTB0S2hscnczZlBvVVFDZHVGcFg0ekEzYTR4VTZXTUNfYjZZVXZqUjZnSGM5TFRUR2tIazh1RTY0aVQ4cmt5RDRrU3RNcXhnU2lfRVZwUUdjWGdfNE9wQ1dBOUFha0N1NkpybGRaQW9BLUtXTWpQbGhaWHFYWGMyVkJlbUJjRTQ1YzY3QWhqYjJrSi1uQ1c5dHBjWS1JZ3JEUHFzWkswOS1WbHVtcl9SbzQzcG5FeW5jVFpTdzZlX1h6VnN0dUFOZHdiM0E2OVR1c1hfYkJKZ0J2SGQ4cDJSUS5WMTlhMVRacjZ2UjJHdEVaWGtOOXJRLmhwMU5IMmwtZklWbVgwWlNfTlRzekJfUEs1aktDUU5rSnJyRUhRQmZjQ2VjdHhmVU5uVlB6MVBqRWNDblZuV0pCUk4zTlFKZm01MjFLRHp1MzBIVUFEUGVmVHJyMFVFS2x5QTM2cThoWFY3VTdoQ0dHNk85NVpYclRsZlVENDI5RTNTNTQxdVBmWGpGR2cxbHlucFNTNnAtVkFzaXFlY1lpQWNuM1hhNzRhUm5xS3N3ZzhyU1ZOX09hSVU3ak1VVUhYZWY1ZmN0NlFrdWFfYkt6Z2dtR2ZiT2RTdVdNRmVQaF9mMkJMUFNGN3k1NThEMFZxSVlNY0JJR0dMU3BQUU93Q094OFF3Y3NVUEp4ZDFuWkVYYjRVNEJZYlhBcmFMX0NwekYxZlhYWVBsdmVUSGdKNVdrR28tWXNJVzAtT3ZqVGdLN2hIamxpR1psd29HOVUtbTJSVDZfbkhseHhVRFMyY3JseGNmay1OOTlXd0tEdUxFMTM5ZE1mN2RCSEl1aTdxd0RXdm1TN2JMTHYzM05Wd19XSl9DT1VGQjgycy1ELXk0UEdIRzVackhsSDgxa25mLVpRblU0SmZfY2lhMWhmWlY3ZFMxb21UZDQtNnJwZmpTMGxFT3VfZTQ5bUpYUGFpZ0hyLWFQYkFzTXJJQ2JvOUVIR2IzMXJ5SlR2QXF2ZmJDbU10bkdLUDV6aUNiZFh3SU5ONzBJTk5lZnJLWGZkZFBUd0RSV3d1ZkxCcGNlU0U0SG5EWVZVQmdkMDl4UUZidG12UDhhTXhhUlpGSTNpWG1fbmpCNmZfdlNhZUNUakdVYVVuRE1QQkdOQWQ5T2xVX3dvUnMtalNCVnVqd1FQSGlGcm5RWElkXzBRdXRYSm54cTU4aUtlTGJvNDJtOHgwaXBRcnB4aEZoUDdHNmZOWXAwVmxXR0RxZ1Q0VlpPQkZsZWRKUU0yaDQtb2xTbXdtUms0M0Y1cjdKd3h4aENqU1JReWx1MGEyQ0ZONWMyZjIxTElZaFliLWNReWFXMDNpV3hsb04zWld5cDJIb1FlUmZPR3lXUzBiU2NBT3JndGpBYnJaUFIwMGRRNnpSOHNBczFYUzh3dzBlaVczbFpsdjJwVWFxOVpTeVhnTS14b2NTOS1ueXRaWGtWWlUwX2dDVXJBV0ZKNG5XdW9oTGM1RkkyRWFQNWR0SXVWa3dnbXlsR1gtYk9ZeHp3dzVGYmI1V3VEbnJ5aDBMSnVic3Q4VXdLdnl3bk1jQ3duMjZSVTNxQVRudGJubVhJS0FyeGkwMldQVk9oTXdpUWZuX2h1TWk5emp3MEVuaXNWdktNWUNnR2xqNWlGZW5Tc0FKUXBiLUY4bng3OWFJQlJaTUc1a0huUDR5dGxmNm9FTkRsRXNJY21aeEtOdEIzcmJPdVROYUhLTXZBNmxSNzlMMDJZSTZrcEdrUUZnaHpIaTBjTWkwbFdCejRTM1AzUEMzZElZSVlQZ0Q2S05kT2FLWHkta0dWdUlsWFNmVlVrMnpzM0NBeTJhZEJjV0NMV094ZkRoQnlwNTl4MHpBRExvdnZySHRLOWF6TGN3N0lTbVl6eUhYMkpobVdReUYtTFd1VzhfcW41SkFVYlB5Z0RTRDYyMi1PTGZQVDZmc2VTWUVBUTFLVWRwZTFnSV9hZWxVT3FaRWN1aE5SckU1YUp0LTN5TEVLVWZIWXF6WTlGbHJrUE5MUC03Y2xRbmEySEhfZmMzZV9LTGtGUDFhQTJjM0RVaERseGhsTzB2bFVmV0c5eXpXaDNZN0NmRFlFMlBaUzZBcFBlYy0wa1NDcEVKMmtCcnFzWG4yeDJDX0FDdTdCTTVGZXNJQkN0M2NqSEdQSVVQRnEteGVmT0RCXzBQcXZDTXpBOHg5Zm10Ny1sNHhVQlJaa0dtZExhZFoxVzdFUXRNRVpsSWMtbDF1V1UzTU15cFZpVWR0OWxJUHVQVUEwc1NrbWxrTGhNSjgyNE5QN0hyVi01dC1ZNDcxaWVKMHdEUjFxMmU4MU8yazdNeTFlTDY3TlY4OVBHYU81SVR5WG1ueUVXMGtVbl9qa3l1UVRkV3dsS09HZVZIYkJWNFpxSXZHWjdQUS02TEE5eXc3a0dyZFRhVFZXOEdOOV9GY1c2VUhjbzA0U3dqTzY2S2x4VlFJWWpBdEZPZlBjWW5xNzF1RndyQS1UZHVDZG1sUFBHOVpjc2tiQmdrbF8wVk90dmhuc0pwYXZKZ2Zka0d3OF9qMkQzd0Jzemd0VndHNk9nNW16eVFwM2pFc0w3UmNtcXd6WFBOaDdKYXdHVDBJMlRvZHYyQ1Z3MDkzWjJlODFXR1NxRnlIejAxdjFBaGN2T2VWdmFjUGM2Y1JJaVduNW93ZF80d2FBdjlyNjVVdmtWa1FLRXpHUmo5eTZILXdZTTMyV1JyMzBlOU9MRTNKUU5POV9kNjRTRmIwSjZHa2VxUmtnNkVXc2xqN1JYLVU1VlhrS1BtMzNpS3c5dGU2NVBqQUNnZThRVDBYVWZEaUx5a1pGeUdpZ09ZMS1TVDFxUlE1eUhMTXhEc3BPRjFXd1lMQ2c2b3hocTlWMm55Z0U1cUJ2ZnYyWUtFaDdjM1dWNjJrYkw3UXJ2d0xkMHVRZ1FwYmUza3E3dGJzcC1lNWlud3cyY0YxQzByeHNScGZJRHlJMmg4b2xHMi1RQUZkWmtlMUlmaE1FZmNfdUdXX2pqSGJSWXVzYnZCRnpKMDdaOVJsVnFMR1A2WXBnTDFsRTFOY09xUVJyYVdxckdDTWZ6SzZMVENQSl93aHJRam9WTzdVRDJIUEVnUjZ2S3U3cWlmTmo3UjE5OUJuRi1EZmlnbk1TYTFKZkZadDNuVXVZOEhMUXRoUzN4MUMxOE50d3dsaDVuNGxYS3d5MERHenljbVNweE05QkdPNTFRckFmSXRfY0xHbUlzMlJ4MzMyeDRIdEZ3Z05nRzFBazNIUno4TlJ4V3lhNWhjb1NoYURXekhES2gyOVp3Vm4wYXVzeWJpal9uNlFGcnZZbjRSOHdPNlRQV3FrS09JcHkxc1lQNWxyNDc1anZSRVZGaFdCWDBiUXdJdnNlM0Q0a0dFQzgzU3FWYkhxY3phZTNwOFNxaG5tQW5ZYzBIbWp4clJfZUMzT0hYVFBGUFZmNDlVWHdrQjIwY1lvcjJ1dzBaTzJ2TUg3S1QwcjBSWDBQVy1qcGpORFpjSGRSNVVCMXFacGlWLWxaYkw0eF9IZW14aWUxY0RPOHNQSXhIOElUSWtOV0tTR1N2eWdraHBBbGl2RzVEZXJObElkeFE2c0tHQ3RtMDEyT2xjN2thaVFaNHh0TjR5ZVpPU2xyS0s0OTlIcWhObzhkNTNsbFFfMW5ncWlHbzhUSDlzWkFrclYwclc3dkJOSF92UlhBdTc2MnlpZGhZUURYYXJXSEFUMm9DU2hEN1lOdnotekoyZGtEajJMcW5CdFNCWFh5T2xsM3o0ZWFITDd2MDZ1QTgxMVBKQU5YZUdoenNaNFVQQUQ2Q0E4cGlxSHB4WGkxODRHNEJETVU4S2VHeHZLWnJiUlNOT2pTOFNrQUJKZERfSklIZ1RhNEFhNzdPUmNZcVY3OWZ5djFZVHNma2lLR2NUYzZIUjZzUVpsamt2U0NQNjdtTTRGUHRqTHlfX1pDQlNwdnRSVWd5UlpNM1dSOUViNHkxa29uRG4zUjMzN2lpSzdfbGtIa1UtZ21VbUpZUVdnUjYzT01pZUdRUHdNR3BSZXlRWE5yckJVTDN2Z2JYdjlac1ZDcDh1NHRwQjBleXJvUXgxZC1KSWJvOWVyR1VlX0ZzU1Fpd0tIaGFIUk02Nzh5dENkcHJFbDBWeG92TFVrX0xNcTFjN1R4MG5jbFl2WE4yUjhEMXNhU2FibkJSd19CU2tZMFNMSXdhb2RpY2o2ZzdLd0ZfMXB2eThhNF9LbnJNLUNkenBvdHA0aTd4QUJuY2JRVUEwWkpsYlp1elRpR0F4ZjFnclk1Z0dZOTVoWi1XZG1lOWlSazBHRTJGN3d4MlJyLUVvS3lZRjNjak0xMWt6MWFmME9fNFdyOXJoU3JrX1NHU3l2a3ZCTW9NZ0xOX0tSS1BlTjlqUnpwRlVST2VnN2NCbGlhdy1odnZhY2lCeDN2UWRqTE5jTldQdU1UbzVmME1QbmU4TUtXcFBoWjBySElMaEVuYW1pcG82X3pzNjczcE9ma09FS0JWWE9mUDEzR0UwS25SWTBab2JPLWRub254LVdBY1dodFZvX08xbkwwTWE5ZXFMMURhRGhJU0JNbVRIM1hkY2dDTnF0emIwcVMtS1l5Mk9zRzZOakRDVEM1aEI3MXIwU09WMUprNFV2QjdYemxTTW9YUXJnTzF2ZFVwSGtxaVhUM1RJZmlQMWRKcDEweDlSMlp5R0lzUzljQUtNMEZyMGRxQmJmQy16NTJpcWZweW4zUVVqb1Fld2hPYnJwUEZGOF9lUmVNRlIwSXZjUkxnMHpwek56UzU1N1pkQkZhemxNTThLcnkwN2QyUDAyTnZtclUtN1ZjOW8wZm1qem9WOHVVTG9PMkJHdmFRdnFJNmtBTmQ5VWo1X2JkY2NVUzBhcklzcGFZa1UtUXQtNnQxYU5YUUdGZEtUbFMwSVowek54bkNIZWRySEE4SkYtOFg3d1ZpRW1McXJQbU1Sd25sbWx3SnhxLVlReWMydmdUallSbUxCVU5TS3VrZkJsa2VnMmlCRWdySksxVlNyRWswX0ZvOXkzV1EwVlZuNXhEZXlGc1JuWDI4Tkl6alFQLVNXaHhYbzdPYm5YY1cxZHlWNE1fYjdzM096cEMwOTJWcGZYQkpaTDhBeHgxNGY2TmJzTEpXLW95VEdsaTJFb2FCZHJKQ2JkQlNOdWJlbGdRRmU2V2hqSjRGdlNrYVJISjFTT3ltbGFtQmYwaVNDOGM2X1g2SkZORjNmOXYuQjc5SDJvbVIyTU52SndydHVzclJ4UQ" + } + }, + "responses": { + "200": { + "body": { + "contentType": "text", + "id": "https://myvault.vault.azure.net/secrets/SecretBackupRestoreTest/01ddd6e3a0d34d35bb5bccecb1251837", + "attributes": { + "enabled": true, + "nbf": 1262332800, + "exp": 1893484800, + "created": 1493938113, + "updated": 1493938113, + "recoveryLevel": "Recoverable+Purgeable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RotateKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RotateKey-example.json new file mode 100644 index 000000000000..fddd7c7f6b49 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/RotateKey-example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "Key01", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SelectiveRestore-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SelectiveRestore-example.json new file mode 100644 index 000000000000..e08c8af5b81b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SelectiveRestore-example.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net", + "keyName": "hsm-mail-key", + "restoreBlobDetails": { + "sasTokenParameters": { + "storageResourceUri": "https://myaccount.blob.core.windows.net/sascontainer/sasContainer", + "token": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED" + }, + "folder": "mhsm-mypool-20200303062926785" + }, + "api-version": "7.5" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 5, + "Azure-AsyncOperation": "https://myvault.vault.azure.net/restore/45aacd568a23b0s49a2803861e8dd3ase21f/pending" + }, + "body": { + "status": "InProgress", + "statusDetails": "Selective Key restore is in progress", + "jobId": "45aacd568a23b0s49a2803861e8dd3ase21f", + "startTime": 1490790000, + "endTime": 0 + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SetCertificateContacts-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SetCertificateContacts-example.json new file mode 100644 index 000000000000..53aeabd413e6 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SetCertificateContacts-example.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5", + "contacts": { + "contacts": [ + { + "email": "admin@contoso.com", + "name": "John Doe", + "phone": "1111111111" + }, + { + "email": "admin@contoso2.com", + "name": "Johnathan Doeman", + "phone": "2222222222" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/contacts", + "contacts": [ + { + "email": "admin@contoso.com", + "name": "John Doe", + "phone": "1111111111" + }, + { + "email": "admin@contoso2.com", + "name": "Johnathan Doeman", + "phone": "2222222222" + } + ] + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SetCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SetCertificateIssuer-example.json new file mode 100644 index 000000000000..c974770d5088 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SetCertificateIssuer-example.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "issuer-name": "issuer01", + "api-version": "7.5", + "parameter": { + "provider": "Test", + "credentials": { + "account_id": "keyvaultuser", + "pwd": "password" + }, + "org_details": { + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/issuers/issuer01", + "provider": "Test", + "credentials": { + "account_id": "keyvaultuser" + }, + "org_details": { + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + }, + "attributes": { + "enabled": true, + "created": 1482188806, + "updated": 1482189526 + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SetSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SetSecret-example.json new file mode 100644 index 000000000000..4ea0fe7fb9c3 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/SetSecret-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "secret-name": "crpsecret", + "api-version": "7.5", + "parameters": { + "value": "mysecretvalue" + } + }, + "responses": { + "200": { + "body": { + "value": "mysecretvalue", + "id": "https://myvault.vault.azure.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441", + "attributes": { + "enabled": true, + "created": 1493938459, + "updated": 1493938459, + "recoveryLevel": "Recoverable+Purgeable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificate-example.json new file mode 100644 index 000000000000..3a396ca7226a --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificate-example.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "updateCert01", + "certificate-version": "c3d31d7b36c942ad83ef36fc0785a4fc", + "api-version": "7.5", + "parameters": { + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799 + }, + "tags": { + "department": "KeyVaultTest" + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc", + "kid": "https://myvault.vault.azure.net/keys/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc", + "sid": "https://myvault.vault.azure.net/secrets/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482188981, + "updated": 1482188981 + }, + "tags": { + "department": "KeyVaultTest" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificateIssuer-example.json new file mode 100644 index 000000000000..104806e97a10 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificateIssuer-example.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "issuer-name": "issuer01", + "api-version": "7.5", + "parameter": { + "provider": "Test", + "credentials": { + "account_id": "newuseraccount", + "pwd": "newpassword" + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/issuers/issuer01", + "provider": "Test", + "credentials": { + "account_id": "newuseraccount" + }, + "org_details": { + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + }, + "attributes": { + "enabled": true, + "created": 1482188806, + "updated": 1482189526 + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificateOperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificateOperation-example.json new file mode 100644 index 000000000000..e52a7566ee87 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificateOperation-example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "cancellationRequestedCert01", + "api-version": "7.5", + "certificateOperation": { + "cancellation_requested": true + } + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/cancellationRequestedCert01/pending", + "issuer": { + "name": "issuer02" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxxM2zqnPtpH8aiHX5TdEoZLO0Y6fsjk9QcjKgnHomrwUc9vK20UYYEPKt9aGOT7HNx0do8OulPCnLPrKowci8UHu1qRW/qHvsOJQ/UrQoMCHxtXptVc7Avx8WQb045sCdgp/Cl4xO8LMZa70kE4dghZU9zmNZk8wqDIxyYdh1lqqfGe49EWOxcfszTeeKs8KCsQznjExbsudBHLLWoX4VFTGMe3VcIPcV6iFf70buHKznDMXFiRC0IYwkc/GyWIadB1CSEae8k/0evsPI5lYYZLaO/kLffEUtzysqxZNCQR+S0eVPTGTLHa+fndnPPs65XZDzSZi2fZL01oXUfCAQQIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBAKto/ZF9+02fQ3sLuIsRuap/O/AZz3IhAubNfyCaWvVGVAQz/Aqpf5c/liyKhxqRG6LR9Zu50oxRK5222ezR+56vJikjdXRVShf2xYsMm1CbCM1JuzsnkTeoUHHE12xx1srH/9TH+DVZIk6NXxc4wVIagbpwxiS5gR3Nly5k0ZVv7R1B79J0GUqSwK6qjuooWrBsYMEx319hz8fB/Y4jnPE8p+Cnn3AGEqnebVngXncq/QnHxnrRVfvKFVySqRvlsvM8buILmBbIaywEUqwhNtZX2i9E7reEJ8aeZcf+lAeKF3YDvffaXGTc75aiZlBk30Lv/hn0vs9T0/FedUnIae4=", + "cancellation_requested": true, + "status": "inProgress", + "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.", + "request_id": "3dd81d528cc84c5a837c607f1a50f2e1" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificatePolicy-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificatePolicy-example.json new file mode 100644 index 000000000000..944dbd2eac38 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateCertificatePolicy-example.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "certificate-name": "updateCert01", + "api-version": "7.5", + "certificatePolicy": { + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297 + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Self" + }, + "attributes": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/certificates/updateCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297 + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Self" + }, + "attributes": { + "enabled": true, + "created": 1482188947, + "updated": 1482188948 + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateKey-example.json new file mode 100644 index 000000000000..eaa5f1a77396 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateKey-example.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "UpdateKeyAttributesTest", + "key-version": "3d31e6e5c4c14eaf9be8d42c00225088", + "api-version": "7.5", + "parameters": { + "key_ops": [ + "decrypt", + "encrypt" + ], + "attributes": { + "enabled": false, + "nbf": 631180800, + "exp": 662716800 + } + } + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://myvault.vault.azure.net/keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088", + "kty": "RSA", + "key_ops": [ + "decrypt", + "encrypt" + ], + "n": "tHCSyq1FqGHXIFHs1m4riKYgPFNSTlJGPzxwfUyZJUxxZsFWMxmZRzbM3kcXC5N40AJfeqDOMs0gY0LZEfhw8kJHBf2GEH2Sz923E4OQjLk_ECdAiKPW_8t22cqD_pGIuB7uibjLZgFFRv7oe0t8cTXKn7IwAH5gQBLs8NNV7hx1Ozy82ekCgOovFldmD3c3P1oZQ_v_-jOP6O202aEfDcZut42J6zI8eYwvGiDKmo2fCPPeth1LYBOeUMnrEZGT_f_w3yAgqvuSkHCL0x4MjZzc2EoNI_3ooAHZohDaPHLRfz8neDPADZzbHA6SDn3GgvC1K_Je5GBmqjTH3aIMlw", + "e": "AQAB" + }, + "attributes": { + "enabled": false, + "nbf": 631180800, + "exp": 662716800, + "created": 1493860275, + "updated": 1493860277, + "recoveryLevel": "Recoverable+Purgeable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateKeyRotationPolicy-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateKeyRotationPolicy-example.json new file mode 100644 index 000000000000..a937083e86f6 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateKeyRotationPolicy-example.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "updateKey01", + "api-version": "7.5", + "keyRotationPolicy": { + "lifetimeActions": [ + { + "trigger": { + "timeAfterCreate": "P90D" + }, + "action": { + "type": "Rotate" + } + }, + { + "trigger": { + "timeBeforeExpiry": "P30D" + }, + "action": { + "type": "Notify" + } + } + ], + "attributes": { + "expiryTime": "P2Y" + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/keys/updateKey01/rotationpolicy", + "lifetimeActions": [ + { + "trigger": { + "timeAfterCreate": "P90D" + }, + "action": { + "type": "Rotate" + } + }, + { + "trigger": { + "timeBeforeExpiry": "P30D" + }, + "action": { + "type": "Notify" + } + } + ], + "attributes": { + "expiryTime": "P2Y", + "created": 1482188947, + "updated": 1482188948 + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateSecret-example.json new file mode 100644 index 000000000000..8f1bf561a697 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateSecret-example.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "secret-name": "crpsecret", + "secret-version": "03bcccc7c8cf4546a0e3e21e52560441", + "api-version": "7.5", + "parameters": { + "tags": { + "mytag": "myvalue" + }, + "contentType": "myContentType", + "attributes": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441", + "contentType": "myContentType", + "attributes": { + "enabled": true, + "created": 1493938459, + "updated": 1493938459, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "mytag": "myvalue" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateSetting-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateSetting-example.json new file mode 100644 index 000000000000..6a16042dae77 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/UpdateSetting-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "setting-name": "AllowKeyManagementOperationsThroughARM", + "api-version": "7.5", + "parameters": { + "value": "true" + } + }, + "responses": { + "200": { + "body": { + "name": "AllowKeyManagementOperationsThroughARM", + "value": "true", + "type": "boolean" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/backupStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/backupStorageAccount.json new file mode 100644 index 000000000000..1c3cf16ed7a2 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/backupStorageAccount.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "backupStrg01", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": "KUF6dXJlS2V5VmF1bHRTZWNyZXRCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUkwTXpnMVlqQTNZaTFrTlRRM0xUUXlaVFV0WVdVNVpTMDJNVEJrWXpNNVpHWmhaamdpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLk1JeFMyLXh0eHAxekpaZ3ZrTUY3d2pGMWxiLVJyNWFrbHFMLXpBaVVOODJKZFJNUDFwak5iS0phRktIOXBRcDg4ODBKeERDSmdESUZHc19OOGlnYmdIZ0Q1c0xVMi1pRzdKM29Hc00taFRMb05oaUd6aGY1YVREakYzWjZpZVhxcFMzVFVOVUFkeFhpTkpIYk94YjBmWHNtcWFtNnA0dXJ3Yzl3Qnk1c2pwRnJheHNRM3NRcHBDLXZybXlVZExaelJIWS0xYnhwaFQxVUdiS0Zsd1dSODU5TmFSQ1BZOFhDWUVrX0hxNnc5S0lWSXRTTlRYYWYxUWFzUDJob0NHT19PMzkzVUNzWGp0NzRtOURqdi1vTHRoMUl6TU5sSWp0STg2MTRhTGs0RTFMUXd6ZUx2X2Y1cndKeXJOWkF1c3VWRlRieFp1Zzh6T3BfYTdCOGhGSEJyQS5rc3pPdTN3blllb1ZUUjRLc2dqMUxBLmYyY3huVE1BbU13Ty1RcmdHSUFYUFN2bEdZUDRYWmJvMFVFOGxtY2xZa3ZhRE5ab3E0Wm41MVNKTDNuUFZsVnBaRFlrUmlpd05BSUxvRS12QWtVbmZoLUczOWo3RHhqWm1zZW02bXBmOWxoZjBnZFFNTDdmejBqRDZ0dW1xSVFaWUhFalV3VG5xdDloeEw5N0lnUUV0WmtFV0VnUEJETnJJNFpYWXdNU2ZyR0FfdkgzYXU1MWpabDFTWjlGajJsTHpEblNqbFd0U05QSzc3X2RwbUxrTXNCSmMtamRteUpxYmVxdmdRcGFTSUNsOXpUUXFQM2RxN1VQV2c1R1ZDNmlNZjlTcnBoUVRKX1V2bnp4LWk4ZWR6ZUppd2hYNW9HQ043RDNDWjkxTzNLQkhmYklOX1VvQWlQVWxzazFveU9KOEVjMk5mbHhOaFlrNFRKUTFBN2xnbXlLRlNQeVMyaFlwUDA2VEpTb0JUenVTQk5OTVdmT0RaTDFfV3V5eThJcDktdlVHMW5JOENDQ1hIeEVVN2FVLW5nRVR5aFBfbWt3Q2FGLWx2WTNqZlV1Z29wSllLR3VscXZadk1VZHhLYU1oemR2a05ubFdGeXlJNXdiRUdZcWgzWEJ0MS11TThrOFZVTDdQallzVUt4S1dYbzBMblJPZmFTbTZpTm9ZTmFOTm5YbF9fVW9rd05fSWM0eVVYR3RuMFhUcTZ4anQwZUpEajlET3FyYmdiLTZoclltRmxLTUNqalVxSGtLU1VPaHVYSE9jOFdFa0JEM1hiR29idi03b3c0c0gyN0YxbHh2UVh0OVgtOUl1akN5dHBMYmt6YnJVdHZJT2puY19xTUNjMXFFTG1wZHJCTGFoMzVmWHZQZXotVk9zSXBNOGdsekhWUUgyWWZHU0UwaTJqVkxpVllkZlFHeDNwdTZPamdUc1hPUm5acldlbFExMVlNbUJkWlVqWFNlZkVlQkxuT1lBbUNtYWM0dHNTa2JHTXZzQm92OWNEc1NRLWlsQUhsT1Fsanp3Umt1bnIxdk1ITlFhRDJLUEE5eGxxZ2NKU3FGT3d3RzROSzBxamhyb0NoZDFxM2RHR2V3U2tTd2xZbW44ZlM0VEJ5VjFMYmtWb2NZZHpiWDhiZG54dHRhVDhKS0pUbjJETWxjVFpvR1hFbWQzN2ZZVnlaNm5uMXdxZExtVW9XLW5OQXc3T3RLV3hyMXJUNV9qOHZjRGhTWk1HdTF6aV81NDEyVTRLcG01dlQ3c3BpWXA4aDl3Rk5scmFjYnVjZGVlaS1zMWR6cDlqWGo2NjRuWWxoYzNjOHJubjJ4ZWlna09YLTNUSWxnbmdxeXpJWG5ROHU0dTc5TC1ObXk1VFNjLU4wTnJVTUxQVE51MnhsUlE4Y0VLT0h4QkJGQV80Nk1yVXlhbjUwODFMSlYtTVVyaXAycl9tS3FJRjJET2wxS2V1aGg5am9PeFVybUk0T19MYkduVjJTbUdoZEZSd3FxUS15U2pxcFE2OFBza3hlQmxTdDZnX28tLVl6Qkg3dDI4V3ZYYzdIT3paNFBwa0psTjVmWFRwOXgtOGNuTGptcG5Pc2hUZWxTUXRYaDMwcTU3LXJZbVJzc2t2cFZfaTZFX2JUMTk2VWtTOHo2WUp1QXh3LXdlZ2tPY1ZITUxkeW5vaDU2UUtuWDhMVFdHdjhqWWNQazlaSlNSbXljTExOcWNtRnpUU1JEbzBXMXBkQVJXY2tqRFM2VFZIdTlHSElsTG9oRnpONEU1T3FqdUMxRjEwSFZjUGxoNTc5UmczWk1SNWJoVjltSEZNOFhJZU9HTHAxZFkxbnNLY2dqRVVlUW5qcF9za0RzanJZMVVncXRkTTVNVWhNSHlEZlhaZ3libk1jSDVRaml0YjdWZktrQk1YcGRwU3pLQWx0WDNjelIwODRPVm5nVGtiV2JZQURDTUQ2N1dlLWM1ZDFONHI2WFdFb2RXelNyWlhyZmc0RVRNNG1UZnV3ZjB0d3NORkRJdW5BWDkwbnZJWm1Ualo2RktpTjBiRnVNWmRpR1NKNTZNUEZMcFd3N3p0dmVmN0xENmhjNHJESXBQbEkwTVlVWTJSLWZGakdaZ29JTmdKMkVuMGFFM0c1V1RySjRxcHhhdHB4MVk3ZUgzOUk3WTYzcEJFWEtkRWIwTmstM0tnM0ljbDJPSkp6SU1fM1VHSlJTTmRQWGlfV3ViNGRTMDV4eURzZTR0d1FXdm9rb1QybHlZNGphNlVOc3lvYWN1eGFsTUZvUFR5dHF4YlVTaXFIMEZab0pWcm84amZja2wyYklmSzRqRzN6TnJIOWU1c3VUVWJDV09wYjczeFNMMG9TLVQ0T1JSNnBRbTZHQk05bFJ0eUhtMHJUMy1sNXc0c2ItNnRDcTM4S3FRdURRTGVTcDI1Rk8zMU1uVE5nTFlUeEUwUEZDT3hmRG1RY3BOOFRoWHBGbzZLNHNrd0dmQkpKTU9BTWtIUWZnMUM0c0V5cS1PLS1FWFhjbVV6QjJGRnR4c1gwR3o0aGJSdTFiUlhXcWMxU0IyUk82d0JsWGdPUmJqZjJlLWJQUFFMdmtGcWR3bFpUTE1kaWVUdjQyQmd1SFd3dzI5OEVqcnNNUXg1WG9aRG11MDFRTzlZSjFmTEYtWjkwWEVOU2p5OTM0M3UyUHhrNjhheG10bnp2ZTdwd3Q3Z0ZMMUoxZlZEd3BqMUtBZDdwdGZoWG4yUzJmT1Bfc3JOM3QxNk1qX29qOUVLQm5VNC1jQ3RLWGRkZS1EWk5zQkNhSGZ1bEtHSkFHYmx1UWs2Yi1kQk5oUS05Z19kajdfcjZub2Z2aDRielEybGlQd1E3M1RTazNiQTdzd2EzclZ5ZTVDTVNlOVotNkVKV1phek1sN0w4VUJ3cFllN0J0eHhUNEVBVGo2SXBvYWhGNTgtRHpiMmRsc1c1ZDZIWmpYZUNMTGtVRmQ5Mll3eDBibFlCanc4eTVzM040OEJMME84WG51ak42c0F0eG04Sm9hWXFVUUd3LXNBS1pTZHAzNk1GNlZXYkpUcHBoZHQ2aEhWQjFoRzdpSGN1STBTRzY0WjczNXEzZ0tSYXFHdzhIUXItSWNyeks0VEQwenk5b01NMHpRLVFBSE1PdzAyX0ozU3pVQWZ1bzFWNU42ajB0VGsyeEt0TFp3cmlHOHJNRl9NWTJrN09mdkxqNFlCb3VNN2lBNVM4LnNfM0VabFhIb1lrV283ZzdpRUp1bHc" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/decrypt-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/decrypt-example.json new file mode 100644 index 000000000000..a1c15a9f99bf --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/decrypt-example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "sdktestkey", + "key-version": "4eb68492b5f6421e835d961ad2be3155", + "api-version": "7.5", + "parameters": { + "alg": "RSA-OAEP", + "value": "sid-4nG3FzRIFWXLXlG-FZo6H1-kzbNX5Exe0_VRqcGLuJWjI9oSofsn-2IagDsQzkpNAXv9V8aoIizelrK_14darhxaAV8OejO7Oh7spjxa7IxMVS3e-cwcLdEHzMbMfM1uFpDyRFqEUASHI0H8F1M2m1e9TUSXOVW3KMqm7cK94ZQMFvd4AYdLfmfnStMp_MqIQh4kpIkB6h2b1M3possVrLKH_l2L3uT-qFiwQlH9-dt0Cje5mrkpsYCy4hAXNFUPhIyBWAZwOQylIE2sPuopFs55lRIHpWP2CqNe-IK8tX87BRuJ_Vy3GIFxDjD5uu74scIyQCKMImB6xQ_-mQ" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://myvault.vault.azure.net/keys/sdktestkey/4eb68492b5f6421e835d961ad2be3155", + "value": "dvDmrSBpjRjtYg" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/deleteStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/deleteStorageAccount.json new file mode 100644 index 000000000000..8f2193a06bcd --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/deleteStorageAccount.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "deleteStrg01", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/deleteStrg01", + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName": "key1", + "autoRegenerateKey": true, + "regenerationPeriod": "P30D", + "recoveryId": "https://myvault.vault.azure.net/deletedstorage/deleteStrg01", + "scheduledPurgeDate": 1490790000, + "deletedDate": 1490760000, + "attributes": { + "enabled": true, + "created": 1490738386, + "updated": 1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "tag1": "val1", + "tag2": "val2" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/deleteStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/deleteStorageSasDefinition.json new file mode 100644 index 000000000000..965e72f88312 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/deleteStorageSasDefinition.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "deletesas01", + "sas-definition-name": "deleteStrgSasDef01", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/deletesas01/sas/deleteStrgSasDef01", + "sid": "https://myvault.vault.azure.net/secrets/deletesas01-deleteStrgSasDef01", + "templateUri": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED", + "sasType": "service", + "validityPeriod": "P15D", + "recoveryId": "https://myvault.vault.azure.net/deletedstorage/deletesas01/sas/deleteStrgSasDef01", + "scheduledPurgeDate": 1490790000, + "deletedDate": 1490760000, + "attributes": { + "enabled": true, + "created": 1490738438, + "updated": 1490738438, + "recoveryLevel": "Recoverable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/encrypt-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/encrypt-example.json new file mode 100644 index 000000000000..e4b37283f98e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/encrypt-example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "sdktestkey", + "key-version": "f6bc1f3d37c14b2bb1a2ebb4b24e9535", + "api-version": "7.5", + "parameters": { + "alg": "RSA1_5", + "value": "5ka5IVsnGrzufA" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://myvault.vault.azure.net/keys/sdktestkey/f6bc1f3d37c14b2bb1a2ebb4b24e9535", + "value": "CR0Hk0z72oOit5TxObqRpo-WFGZkb5BeN1C0xJFKHxzdDCESYPCNB-OkiWVAnMcSyu6g2aC8riVRRxY5MC2CWKj-CJ_SMke5X2kTi5yi4hJ5vuOLzmg_M6Bmqib7LsI-TeJHr9rs3-tZaSCdZ2zICeFWYduWV5rPjTnAD98epTorT8AA1zMaYHMIhKpmttcj18-dHr0E0T55dgRtsjK04uC3FlRd3odl4RhO1UHAmYpDd5FUqN-20R0dK0Zk8F8sOtThLhEmuLvqPHOCUBiGUhHA4nRDq1La4SUbThu2KMQJL6BbxxEymuliaYcNNtW7MxgVOf6V3mFxVNRY622i9g" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getDeletedStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getDeletedStorageAccount.json new file mode 100644 index 000000000000..8f2193a06bcd --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getDeletedStorageAccount.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "deleteStrg01", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/deleteStrg01", + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName": "key1", + "autoRegenerateKey": true, + "regenerationPeriod": "P30D", + "recoveryId": "https://myvault.vault.azure.net/deletedstorage/deleteStrg01", + "scheduledPurgeDate": 1490790000, + "deletedDate": 1490760000, + "attributes": { + "enabled": true, + "created": 1490738386, + "updated": 1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "tag1": "val1", + "tag2": "val2" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getDeletedStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getDeletedStorageSasDefinition.json new file mode 100644 index 000000000000..965e72f88312 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getDeletedStorageSasDefinition.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "deletesas01", + "sas-definition-name": "deleteStrgSasDef01", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/deletesas01/sas/deleteStrgSasDef01", + "sid": "https://myvault.vault.azure.net/secrets/deletesas01-deleteStrgSasDef01", + "templateUri": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED", + "sasType": "service", + "validityPeriod": "P15D", + "recoveryId": "https://myvault.vault.azure.net/deletedstorage/deletesas01/sas/deleteStrgSasDef01", + "scheduledPurgeDate": 1490790000, + "deletedDate": 1490760000, + "attributes": { + "enabled": true, + "created": 1490738438, + "updated": 1490738438, + "recoveryLevel": "Recoverable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getStorageAccount.json new file mode 100644 index 000000000000..b2b215d4ac3b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getStorageAccount.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "readStrg01", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/readStrg01", + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName": "key1", + "autoRegenerateKey": true, + "regenerationPeriod": "P30D", + "attributes": { + "enabled": true, + "created": 1490738386, + "updated": 1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "tag1": "val1", + "tag2": "val2" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getStorageSasDefinition.json new file mode 100644 index 000000000000..db0a8a59f2f8 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/getStorageSasDefinition.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "getsas01", + "sas-definition-name": "getStrgSasDef01", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/getsas01/sas/getStrgSasDef01", + "sid": "https://myvault.vault.azure.net/secrets/getsas01-getStrgSasDef01", + "templateUri": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED", + "sasType": "service", + "validityPeriod": "P15D", + "attributes": { + "enabled": true, + "created": 1490738438, + "updated": 1490738438, + "recoveryLevel": "Recoverable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listDeletedStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listDeletedStorageAccount.json new file mode 100644 index 000000000000..10c7f999cddd --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listDeletedStorageAccount.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "https://myvault.vault.azure.net/storage/listDeletedStorage01", + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc1", + "recoveryId": "https://myvault.vault.azure.net/deletedstorage/listDeletedStorage01", + "scheduledPurgeDate": 1490790000, + "deletedDate": 1490760000, + "attributes": { + "enabled": true, + "created": 1490738386, + "updated": 1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "tag1": "val1", + "tag2": "val2" + } + }, + { + "id": "https://myvault.vault.azure.net/storage/listDeletedStorage02", + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc2", + "recoveryId": "https://myvault.vault.azure.net/deletedstorage/listDeletedStorage02", + "scheduledPurgeDate": 1490790000, + "deletedDate": 1490760000, + "attributes": { + "enabled": true, + "created": 1490738386, + "updated": 1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "tag3": "val3", + "tag4": "val4" + } + } + ], + "nextLink": "https://{BaseUri}/storage?api-version=7.2&%24skiptoken=" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listDeletedStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listDeletedStorageSasDefinition.json new file mode 100644 index 000000000000..8e0ad99da644 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listDeletedStorageSasDefinition.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "listsas01", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "https://myvault.vault.azure.net/storage/listsas01/sas/listDeletedSasDef01", + "sid": "https://myvault.vault.azure.net/secrets/listsas01-listDeletedSasDef01", + "recoveryId": "https://myvault.vault.azure.net/deletedstorage/listsas01/sas/listDeletedSasDef01", + "scheduledPurgeDate": 1490790000, + "deletedDate": 1490760000, + "attributes": { + "enabled": true, + "created": 1490738438, + "updated": 1490738438, + "recoveryLevel": "Recoverable" + } + }, + { + "id": "https://myvault.vault.azure.net/storage/listsas01/sas/listDeletedSasDef02", + "sid": "https://myvault.vault.azure.net/secrets/listsas01-listDeletedSasDef02", + "recoveryId": "https://myvault.vault.azure.net/deletedstorage/listsas01/sas/listDeletedSasDef02", + "scheduledPurgeDate": 1490790000, + "deletedDate": 1490760000, + "attributes": { + "enabled": true, + "created": 1490738438, + "updated": 1490738438, + "recoveryLevel": "Recoverable" + } + } + ], + "nextLink": "https://{BaseUri}/deletedstorage/listsas01/sas?api-version=7.2&%24skiptoken=" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listStorageAccount.json new file mode 100644 index 000000000000..dd12a5f51bc9 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listStorageAccount.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "https://myvault.vault.azure.net/storage/listStorage01", + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc1", + "attributes": { + "enabled": true, + "created": 1490738386, + "updated": 1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "tag1": "val1", + "tag2": "val2" + } + }, + { + "id": "https://myvault.vault.azure.net/storage/listStorage02", + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc2", + "attributes": { + "enabled": true, + "created": 1490738386, + "updated": 1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "tag3": "val3", + "tag4": "val4" + } + } + ], + "nextLink": "https://{BaseUri}/storage?api-version=7.2&%24skiptoken=" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listStorageSasDefinition.json new file mode 100644 index 000000000000..4a3868e40a3d --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/listStorageSasDefinition.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "listsas01", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "https://myvault.vault.azure.net/storage/listsas01/sas/listStrgSasDef01", + "sid": "https://myvault.vault.azure.net/secrets/listsas01-listStrgSasDef01", + "attributes": { + "enabled": true, + "created": 1490738438, + "updated": 1490738438, + "recoveryLevel": "Recoverable" + } + }, + { + "id": "https://myvault.vault.azure.net/storage/listsas01/sas/listStrgSasDef02", + "sid": "https://myvault.vault.azure.net/secrets/listsas01-listStrgSasDef02", + "attributes": { + "enabled": true, + "created": 1490738438, + "updated": 1490738438, + "recoveryLevel": "Recoverable" + } + } + ], + "nextLink": "https://{BaseUri}/storage/listsas01/sas?api-version=7.2&%24skiptoken=" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/purgeStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/purgeStorageAccount.json new file mode 100644 index 000000000000..fea960d468a0 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/purgeStorageAccount.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "purgeStrg01", + "api-version": "7.5" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/recoverStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/recoverStorageAccount.json new file mode 100644 index 000000000000..dd7aa9a37dd0 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/recoverStorageAccount.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "recoverStrg01", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/recoverStrg01", + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName": "key1", + "autoRegenerateKey": true, + "regenerationPeriod": "P30D", + "attributes": { + "enabled": true, + "created": 1490738386, + "updated": 1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "tag1": "val1", + "tag2": "val2" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/recoverStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/recoverStorageSasDefinition.json new file mode 100644 index 000000000000..3a838402a920 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/recoverStorageSasDefinition.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "recoversas01", + "sas-definition-name": "recoverStrgSasDef01", + "api-version": "7.5" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/recoversas01/sas/recoverStrgSasDef01", + "sid": "https://myvault.vault.azure.net/secrets/recoversas01-recoverStrgSasDef01", + "templateUri": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED", + "sasType": "service", + "validityPeriod": "P15D", + "attributes": { + "enabled": true, + "created": 1490738438, + "updated": 1490738438, + "recoveryLevel": "Recoverable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/regenerateStorageAccountKey.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/regenerateStorageAccountKey.json new file mode 100644 index 000000000000..5d9d317f0a12 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/regenerateStorageAccountKey.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "regenerateKey01", + "api-version": "7.5", + "parameters": { + "keyName": "key2" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/regenerateKey01", + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName": "key2", + "autoRegenerateKey": true, + "regenerationPeriod": "P10D", + "attributes": { + "enabled": true, + "created": 1490738386, + "updated": 1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "tag1": "val1", + "tag2": "val2" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/release-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/release-example.json new file mode 100644 index 000000000000..755a301728fd --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/release-example.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "exportable-aes-key", + "key-version": "4eb68492b5f6421e835d961ad2be3155", + "api-version": "7.5", + "parameters": { + "target": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkdXQXkxNk5ieFJJQ3lCUzVKckJxRk5DdXdjS2YxYUVYbS1hUDVsUlJ4UEUiLCJqa3UiOiJodHRwOi8vbG9jYWxob3N0OjgwMjMva2V5cyJ9.eyJhYXMtZWhkIjoiZXlKclpYbHpJanBiZXlKbElqb2lRVkZCUWlJc0ltdGxlVjl2Y0hNaU9sc2laR1ZqY25sd2RDSXNJbVZ1WTNKNWNIUWlYU3dpYTJsa0lqb2lOVE16TmpReU5HTXRaV1kzWlMxaU1tRm1MVFU1WmprdE5HUXdPRGhtTURRMFpHVTFJaXdpYTNSNUlqb2lVbE5CSWl3aWJpSTZJbkJPYkhoWVNuRTNPSGRPUkVVd2FXMVNOa1JCWWs5alNrRXpUekp1UlZvNVdFaGtjMDVQTjB0b00xWlJRVTh5VWt0eFlqQk9iRXh4TVhwUFRVOTVZVlJPUW5rNWMzUTRjbG95TURWYU1EWTFjalY2YlRKa1FrSllkRkJUU21Sc1VtSm9WRXd0TlRCcWFFVXpiRUV4WjFVemVYcDJaR0o1U1Zob2NtMDNkWEJFVGtKemFXeFNlR1ZVUW1KUGNWOW1XSE5vT1dGMVVHeGxVM0pOWlZCR2JGbElkVmRNTjJacGNYWktiMHMyZUZSSVZFSmZUa2R1WjBWMlFrMTVPRGRxWlVsbExWbEJUbUYxWkRsRk5GYzFhWHBLZFVwNmJGOHhORkJFY1VWdWVGcFNTM0F5YW1WUGJsZEpTRXRVVm0wMWFsRmhiakZoTlVkdmJGWmxRV2szWlhoalNtRXlNaTFLZERSRWEwNHlWakZMTUZCZlR6YzJSME5ETjNCWlVYVlpTWEkxZFZWclExUmtWVVYxYmxKSWIyaFRWbTFHZVZGaldFSlVkVmxuUVdNMVJFZEpaVGQ1UjNSRFdtOW9WRjlsVmxGQ2NESldVU0lzSW5WelpTSTZJbVZ1WXlKOVhYMCIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODAyMy8iLCJzZ3gtbXJlbmNsYXZlIjoiMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMCIsInNneC1tcnNpZ25lciI6Ijg2Nzg4ZmU0MDQ0OGYyYTEyZTIwYmY4ZDVlN2ExYzMxMzliYzVmZGMxNDMyYjM3MGMxZGEzNDg5YWI2NDlhODUiLCJpcy1kZWJ1Z2dhYmxlIjp0cnVlLCJ0ZWUiOiJzZ3giLCJpYXQiOjE1ODc0MjUxNzMsImV4cCI6MTU4ODAyOTk3M30.CA9gO0kRMHt6e9xTKopwEnDt-Mc52oAAe6zicFwX3REZd5E0m3WzJuSYS8H9iKTGL1dfusflPx74C5xLTZiHe0D2YFHYoW3efEm3r55DwkpTbA6tbDjMY7OIC9XuC7prAf4nQ5hYRk0LATzwytYIZ-c-R08ZEt5CV5XqR5MuSDKWWslPm36BHD3l03VVNEEG4hC9KuCIZ2z9YK5ofGze-IY1J9x1EwnG-y_1RF6rDKENjOROOaOH9JvohHGIfK0FKVj8_7E6JxMTQMb7K-45GfE20tTVdCs4A4k3jXNrIRcGmSK5EMrB_LbHzk0PIc6sjl-VuPZVqGxhsaAyoH3cdA" + } + }, + "responses": { + "200": { + "body": { + "value": "ew0KICAgICAgICAiYXR0cmlidXRlcyI6IHsNCiAgICAgICAgICAiY3JlYXRlZCI6IDE1ODc0MjUxNzQsDQogICAgICAgICAgImVuYWJsZWQiOiB0cnVlLA0KICAgICAgICAgICJleHBvcnRhYmxlIjogdHJ1ZSwNCiAgICAgICAgICAicmVjb3ZlcmFibGVEYXlzIjogOTAsDQogICAgICAgICAgInJlY292ZXJ5TGV2ZWwiOiAiUmVjb3ZlcmFibGUrUHVyZ2VhYmxlIiwNCiAgICAgICAgICAidXBkYXRlZCI6IDE1ODc0MjUxNzQNCiAgICAgICAgfSwNCiAgICAgICAgImtleSI6IHsNCiAgICAgICAgICAia2V5X29wcyI6IFsNCiAgICAgICAgICAgICJkZWNyeXB0IiwNCiAgICAgICAgICAgICJlbmNyeXB0Ig0KICAgICAgICAgIF0sDQogICAgICAgICAgImtpZCI6ICJodHRwczovL215dmF1bHQudmF1bHQuYXp1cmUubmV0L2tleXMvZXhwb3J0YWJsZS1hZXMta2V5LzRlYjY4NDkyYjVmNjQyMWU4MzVkOTYxYWQyYmUzMTU1IiwNCiAgICAgICAgICAia3R5IjogIm9jdCIsDQogICAgICAgICAgImtleV9oc20iOiAiQ3hYM3FWVHQyMlp2andkUy1mbU1Tc0xwYVFROEljZkdBQzJUWVdvM0ZYSVBuT3JTbVpXZFdOM2dMTU5TTFV0VU9oWHF3WENlNmpPeEgyak1yNnN1TzRRMG1mckt1ckFCLUlDNWdiRFpHR0Q5WGtzckFreVlTLTBwNHA0STRRNFF4RU9DdENLWVBZV1d1OTFkZzV4ZzVhWWpWUnlSNUczQzZPMGhhb3RwMUZMMUZpT0IxUFZjVzlIY2hESWRITUZDc3pzYjMzcGJ2RHVZdkpYUFBxZFNJR0lUOFA4RXhWRzlfUndZVFpsMktqM01UU2JlOXpqT0VFVy1FbkE2UGhyMEVGTzBoOTRkV0swWTJ0UGh5ekdZT1NCU2NKQ1dJZHdEOWxUMWFhSE5GRTByU0xKOXd2MHFHZXpSMTBuRDdWN0FMWmlFc2NzckFjd3JXVHRtbUNKTUFJSnBHZjB1OXJOMV9KUWlYdU80UTlDZjRiNzNuU1Axa0lJQVBrWjNyNkZxbXJtOEY3TmVLaXMiDQogICAgICAgIH0sDQogICAgICAgICJyZWxlYXNlX3BvbGljeSI6IHsNCiAgICAgICAgICAiY29udGVudFR5cGUiOiAiYXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtODsgdmVyc2lvbj0xLjAiLA0KICAgICAgICAgICJkYXRhIjogImV5QWlZVzU1VDJZaU9pQmJJSHNnSW1Gc2JFOW1Jam9nV3lCN0lDSmpiR0ZwYlNJNklDSjRMVzF6TFhObmVDMXRjbk5wWjI1bGNpSXNJQ0pqYjI1a2FYUnBiMjRpT2lBaVpYRjFZV3h6SWl3Z0luWmhiSFZsSWpvZ0lqZzJOemc0Wm1VME1EUTBPR1l5WVRFeVpUSXdZbVk0WkRWbE4yRXhZek14TXpsaVl6Vm1aR014TkRNeVlqTTNNR014WkdFek5EZzVZV0kyTkRsaE9EVWlJSDBzSUhzZ0ltTnNZV2x0SWpvZ0luZ3RiWE10YzJkNExXbHpMV1JsWW5WbloyRmliR1VpTENBaVkyOXVaR2wwYVc5dUlqb2dJbVZ4ZFdGc2N5SXNJQ0oyWVd4MVpTSTZJQ0ptWVd4elpTSWdmU0JkTENBaVlYVjBhRzl5YVhSNUlqb2dJbWgwZEhBNkx5OXNiMk5oYkdodmMzUTZPREF5TXk4aUlIMGdYU0I5Ig0KICAgICAgICB9DQogICAgICB9" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/restoreStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/restoreStorageAccount.json new file mode 100644 index 000000000000..db95ac66093b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/restoreStorageAccount.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "readStrg01", + "api-version": "7.5", + "parameters": { + "value": "KUF6dXJlS2V5VmF1bHRTZWNyZXRCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUkwTXpnMVlqQTNZaTFrTlRRM0xUUXlaVFV0WVdVNVpTMDJNVEJrWXpNNVpHWmhaamdpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLk1JeFMyLXh0eHAxekpaZ3ZrTUY3d2pGMWxiLVJyNWFrbHFMLXpBaVVOODJKZFJNUDFwak5iS0phRktIOXBRcDg4ODBKeERDSmdESUZHc19OOGlnYmdIZ0Q1c0xVMi1pRzdKM29Hc00taFRMb05oaUd6aGY1YVREakYzWjZpZVhxcFMzVFVOVUFkeFhpTkpIYk94YjBmWHNtcWFtNnA0dXJ3Yzl3Qnk1c2pwRnJheHNRM3NRcHBDLXZybXlVZExaelJIWS0xYnhwaFQxVUdiS0Zsd1dSODU5TmFSQ1BZOFhDWUVrX0hxNnc5S0lWSXRTTlRYYWYxUWFzUDJob0NHT19PMzkzVUNzWGp0NzRtOURqdi1vTHRoMUl6TU5sSWp0STg2MTRhTGs0RTFMUXd6ZUx2X2Y1cndKeXJOWkF1c3VWRlRieFp1Zzh6T3BfYTdCOGhGSEJyQS5rc3pPdTN3blllb1ZUUjRLc2dqMUxBLmYyY3huVE1BbU13Ty1RcmdHSUFYUFN2bEdZUDRYWmJvMFVFOGxtY2xZa3ZhRE5ab3E0Wm41MVNKTDNuUFZsVnBaRFlrUmlpd05BSUxvRS12QWtVbmZoLUczOWo3RHhqWm1zZW02bXBmOWxoZjBnZFFNTDdmejBqRDZ0dW1xSVFaWUhFalV3VG5xdDloeEw5N0lnUUV0WmtFV0VnUEJETnJJNFpYWXdNU2ZyR0FfdkgzYXU1MWpabDFTWjlGajJsTHpEblNqbFd0U05QSzc3X2RwbUxrTXNCSmMtamRteUpxYmVxdmdRcGFTSUNsOXpUUXFQM2RxN1VQV2c1R1ZDNmlNZjlTcnBoUVRKX1V2bnp4LWk4ZWR6ZUppd2hYNW9HQ043RDNDWjkxTzNLQkhmYklOX1VvQWlQVWxzazFveU9KOEVjMk5mbHhOaFlrNFRKUTFBN2xnbXlLRlNQeVMyaFlwUDA2VEpTb0JUenVTQk5OTVdmT0RaTDFfV3V5eThJcDktdlVHMW5JOENDQ1hIeEVVN2FVLW5nRVR5aFBfbWt3Q2FGLWx2WTNqZlV1Z29wSllLR3VscXZadk1VZHhLYU1oemR2a05ubFdGeXlJNXdiRUdZcWgzWEJ0MS11TThrOFZVTDdQallzVUt4S1dYbzBMblJPZmFTbTZpTm9ZTmFOTm5YbF9fVW9rd05fSWM0eVVYR3RuMFhUcTZ4anQwZUpEajlET3FyYmdiLTZoclltRmxLTUNqalVxSGtLU1VPaHVYSE9jOFdFa0JEM1hiR29idi03b3c0c0gyN0YxbHh2UVh0OVgtOUl1akN5dHBMYmt6YnJVdHZJT2puY19xTUNjMXFFTG1wZHJCTGFoMzVmWHZQZXotVk9zSXBNOGdsekhWUUgyWWZHU0UwaTJqVkxpVllkZlFHeDNwdTZPamdUc1hPUm5acldlbFExMVlNbUJkWlVqWFNlZkVlQkxuT1lBbUNtYWM0dHNTa2JHTXZzQm92OWNEc1NRLWlsQUhsT1Fsanp3Umt1bnIxdk1ITlFhRDJLUEE5eGxxZ2NKU3FGT3d3RzROSzBxamhyb0NoZDFxM2RHR2V3U2tTd2xZbW44ZlM0VEJ5VjFMYmtWb2NZZHpiWDhiZG54dHRhVDhKS0pUbjJETWxjVFpvR1hFbWQzN2ZZVnlaNm5uMXdxZExtVW9XLW5OQXc3T3RLV3hyMXJUNV9qOHZjRGhTWk1HdTF6aV81NDEyVTRLcG01dlQ3c3BpWXA4aDl3Rk5scmFjYnVjZGVlaS1zMWR6cDlqWGo2NjRuWWxoYzNjOHJubjJ4ZWlna09YLTNUSWxnbmdxeXpJWG5ROHU0dTc5TC1ObXk1VFNjLU4wTnJVTUxQVE51MnhsUlE4Y0VLT0h4QkJGQV80Nk1yVXlhbjUwODFMSlYtTVVyaXAycl9tS3FJRjJET2wxS2V1aGg5am9PeFVybUk0T19MYkduVjJTbUdoZEZSd3FxUS15U2pxcFE2OFBza3hlQmxTdDZnX28tLVl6Qkg3dDI4V3ZYYzdIT3paNFBwa0psTjVmWFRwOXgtOGNuTGptcG5Pc2hUZWxTUXRYaDMwcTU3LXJZbVJzc2t2cFZfaTZFX2JUMTk2VWtTOHo2WUp1QXh3LXdlZ2tPY1ZITUxkeW5vaDU2UUtuWDhMVFdHdjhqWWNQazlaSlNSbXljTExOcWNtRnpUU1JEbzBXMXBkQVJXY2tqRFM2VFZIdTlHSElsTG9oRnpONEU1T3FqdUMxRjEwSFZjUGxoNTc5UmczWk1SNWJoVjltSEZNOFhJZU9HTHAxZFkxbnNLY2dqRVVlUW5qcF9za0RzanJZMVVncXRkTTVNVWhNSHlEZlhaZ3libk1jSDVRaml0YjdWZktrQk1YcGRwU3pLQWx0WDNjelIwODRPVm5nVGtiV2JZQURDTUQ2N1dlLWM1ZDFONHI2WFdFb2RXelNyWlhyZmc0RVRNNG1UZnV3ZjB0d3NORkRJdW5BWDkwbnZJWm1Ualo2RktpTjBiRnVNWmRpR1NKNTZNUEZMcFd3N3p0dmVmN0xENmhjNHJESXBQbEkwTVlVWTJSLWZGakdaZ29JTmdKMkVuMGFFM0c1V1RySjRxcHhhdHB4MVk3ZUgzOUk3WTYzcEJFWEtkRWIwTmstM0tnM0ljbDJPSkp6SU1fM1VHSlJTTmRQWGlfV3ViNGRTMDV4eURzZTR0d1FXdm9rb1QybHlZNGphNlVOc3lvYWN1eGFsTUZvUFR5dHF4YlVTaXFIMEZab0pWcm84amZja2wyYklmSzRqRzN6TnJIOWU1c3VUVWJDV09wYjczeFNMMG9TLVQ0T1JSNnBRbTZHQk05bFJ0eUhtMHJUMy1sNXc0c2ItNnRDcTM4S3FRdURRTGVTcDI1Rk8zMU1uVE5nTFlUeEUwUEZDT3hmRG1RY3BOOFRoWHBGbzZLNHNrd0dmQkpKTU9BTWtIUWZnMUM0c0V5cS1PLS1FWFhjbVV6QjJGRnR4c1gwR3o0aGJSdTFiUlhXcWMxU0IyUk82d0JsWGdPUmJqZjJlLWJQUFFMdmtGcWR3bFpUTE1kaWVUdjQyQmd1SFd3dzI5OEVqcnNNUXg1WG9aRG11MDFRTzlZSjFmTEYtWjkwWEVOU2p5OTM0M3UyUHhrNjhheG10bnp2ZTdwd3Q3Z0ZMMUoxZlZEd3BqMUtBZDdwdGZoWG4yUzJmT1Bfc3JOM3QxNk1qX29qOUVLQm5VNC1jQ3RLWGRkZS1EWk5zQkNhSGZ1bEtHSkFHYmx1UWs2Yi1kQk5oUS05Z19kajdfcjZub2Z2aDRielEybGlQd1E3M1RTazNiQTdzd2EzclZ5ZTVDTVNlOVotNkVKV1phek1sN0w4VUJ3cFllN0J0eHhUNEVBVGo2SXBvYWhGNTgtRHpiMmRsc1c1ZDZIWmpYZUNMTGtVRmQ5Mll3eDBibFlCanc4eTVzM040OEJMME84WG51ak42c0F0eG04Sm9hWXFVUUd3LXNBS1pTZHAzNk1GNlZXYkpUcHBoZHQ2aEhWQjFoRzdpSGN1STBTRzY0WjczNXEzZ0tSYXFHdzhIUXItSWNyeks0VEQwenk5b01NMHpRLVFBSE1PdzAyX0ozU3pVQWZ1bzFWNU42ajB0VGsyeEt0TFp3cmlHOHJNRl9NWTJrN09mdkxqNFlCb3VNN2lBNVM4LnNfM0VabFhIb1lrV283ZzdpRUp1bHc" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/restoreStrg01", + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName": "key1", + "autoRegenerateKey": true, + "regenerationPeriod": "P30D", + "attributes": { + "enabled": true, + "created": 1490738386, + "updated": 1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "tag1": "val1", + "tag2": "val2" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomaindownloadpost-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomaindownloadpost-example.json new file mode 100644 index 000000000000..d0e7f6671ec8 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomaindownloadpost-example.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "CertificateInfoObject": { + "certificates": [ + { + "kid": "id1", + "kty": "RSA", + "key_ops": [ + "verify", + "encrypt", + "wrapKey" + ], + "alg": "RSA-OAEP-256", + "x5c": [ + "MIIEnTCCBAgIBATANBgkAoWgAwIqhkiG9w0BAQsFADAQMQ4wDAYDVQQDDAVjZXJ0QTAeFw0yMDA0MjYwMzU1NDNaFw0yMTA0MjYwMzU1NDNaMBAxDjAMBgNVBAMMBWNlcnRBMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAi0+23X8hLsFgrh7O2VtM2fVrSRIUDM/7+/D7A+FQOyt1jsMC8CSYHixo65l/FbAWGx79mqANMa0v2NX4UPDgkRhHlnQXstXa+VRgylqKpS+Da0x9Om/mivTQ26aDwb1Pd8h+SGcgJNy1VOnmI5+uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB+6PXXM/nReFWs32fiojoFeUbneQthQnRCS7CeokqIF1KJoOIrTZFCJ+hw2qtCtKrr8K+0rqC/Jq5r1cu6o0/NOweOqKgwRQKapcrbdY0JsmcTERisX07w9fMbtMA/yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp/TO5+kQigYkgVZXcPjbm2c0hdkisPt+APqEdMotmYTANxtC6McP+9KOO8+12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH/36Vfc5ad+nxRYwYObRYfgOh8vpYaw3cpj5+UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv/ZX7qbNhv11a76gJRi/IoHkcf1UTpxCoD+eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz/ZCOrc+RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vsCAwEAAaMCMAAwDQYJKoZIhvcNAQELBQADggIBAAjHy9GCPejDYIVb/iv8Wo40n317LQN7H6ay+YB5L2byEQATvC1ixde6VqwU6k9VdoQOTfP3xJhfstKrO+n5mFJBL4KG8BZBbd6XQu/ggPLKEIVZFbeQkX6o03K54gY8GxYjHr6gF12I6heLWVKA/Qi480GqSlp2Nz+LE1jgPp9u52xpUPjsvRHXtxYZ7Q3O2jhPToNr3D/TZSu3tmQOeqj9M/igLDe9TxqN9C9jraUGR7Lr4zN1srtvIKhxGMS3Q9kC4Mq+ZNNIwC9+jzzd8fB2pGJP/iTFDzB0pDh9Jz0/CR4O4aGoYqkQEx629aZH2TzhOh2yf04TaniwkHXnUEsPTxrpY8ty/OUG3HzBMHCDhS08ZSimrrxhiWyH6g0OEglXVGrI2nH6nnQIn1MTNILcjUTMRt/WSOz6G07oZciAouKD2YS/W1qPap600kGhTya81BuYThGmFoXVMs7Mk3XBzZ81b6hJ6ncwCLb3g4YzqeQ8bOf42jYJctq4tPNaXTfoC7N0FX7lPVJpRdh6BFcHYcg0NPWJsdk6LtSJB6bp2qptRAgJ5S94s843FRd8PRFE10TKDfj3YFRBNkx7qDjwUhtN8/JC9+RHHw0Ngd0x2/BLqeCEMAQaJoC53h0aMLW6PSyovnsLvdJbN/rYc15qUXSz8TtjaHFpjsy/Fo5H" + ], + "x5t": "dJKBile6IJDrRGqa3k5d8_IKFdI", + "x5t#S256": "0HylM2tkO5ny9CyZ9VLASxspFr8GknnsvuoJEzuZO2A", + "n": "i0-23X8hLsFgrh7O2VtM2fVrSRIUDM_7-_D7A-FQOyt1jsMC8CSYHixo65l_FbAWGx79mqANMa0v2NX4UPDgkRhHlnQXstXa-VRgylqKpS-Da0x9Om_mivTQ26aDwb1Pd8h-SGcgJNy1VOnmI5-uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB-6PXXM_nReFWs32fiojoFeUbneQthQnRCS7CeokqIF1KJoOIrTZFCJ-hw2qtCtKrr8K-0rqC_Jq5r1cu6o0_NOweOqKgwRQKapcrbdY0JsmcTERisX07w9fMbtMA_yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp_TO5-kQigYkgVZXcPjbm2c0hdkisPt-APqEdMotmYTANxtC6McP-9KOO8-12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH_36Vfc5ad-nxRYwYObRYfgOh8vpYaw3cpj5-UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv_ZX7qbNhv11a76gJRi_IoHkcf1UTpxCoD-eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz_ZCOrc-RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vs", + "e": "AQAB" + }, + { + "kid": "id2", + "kty": "RSA", + "key_ops": [ + "verify", + "encrypt", + "wrapKey" + ], + "alg": "RSA-OAEP-256", + "x5c": [ + "MIIEnTCCBAgIBAoWgAwIqhkiG9w0BTANBgkAAQsFADAQMQ4wDAYDVQQDDAVjZXJ0QTAeFw0yMDA0MjYwMzU1NDNaFw0yMTA0MjYwMzU1NDNaMBAxDjAMBgNVBAMMBWNlcnRBMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAi0+23X8hLsFgrh7O2VtM2fVrSRIUDM/7+/D7A+FQOyt1jsMC8CSYHixo65l/FbAWGx79mqANMa0v2NX4UPDgkRhHlnQXstXa+VRgylqKpS+Da0x9Om/mivTQ26aDwb1Pd8h+SGcgJNy1VOnmI5+uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB+6PXXM/nReFWs32fiojoFeUbneQthQnRCS7CeokqIF1KJoOIrTZFCJ+hw2qtCtKrr8K+0rqC/Jq5r1cu6o0/NOweOqKgwRQKapcrbdY0JsmcTERisX07w9fMbtMA/yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp/TO5+kQigYkgVZXcPjbm2c0hdkisPt+APqEdMotmYTANxtC6McP+9KOO8+12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH/36Vfc5ad+nxRYwYObRYfgOh8vpYaw3cpj5+UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv/ZX7qbNhv11a76gJRi/IoHkcf1UTpxCoD+eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz/ZCOrc+RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vsCAwEAAaMCMAAwDQYJKoZIhvcNAQELBQADggIBAAjHy9GCPejDYIVb/iv8Wo40n317LQN7H6ay+YB5L2byEQATvC1ixde6VqwU6k9VdoQOTfP3xJhfstKrO+n5mFJBL4KG8BZBbd6XQu/ggPLKEIVZFbeQkX6o03K54gY8GxYjHr6gF12I6heLWVKA/Qi480GqSlp2Nz+LE1jgPp9u52xpUPjsvRHXtxYZ7Q3O2jhPToNr3D/TZSu3tmQOeqj9M/igLDe9TxqN9C9jraUGR7Lr4zN1srtvIKhxGMS3Q9kC4Mq+ZNNIwC9+jzzd8fB2pGJP/iTFDzB0pDh9Jz0/CR4O4aGoYqkQEx629aZH2TzhOh2yf04TaniwkHXnUEsPTxrpY8ty/OUG3HzBMHCDhS08ZSimrrxhiWyH6g0OEglXVGrI2nH6nnQIn1MTNILcjUTMRt/WSOz6G07oZciAouKD2YS/W1qPap600kGhTya81BuYThGmFoXVMs7Mk3XBzZ81b6hJ6ncwCLb3g4YzqeQ8bOf42jYJctq4tPNaXTfoC7N0FX7lPVJpRdh6BFcHYcg0NPWJsdk6LtSJB6bp2qptRAgJ5S94s843FRd8PRFE10TKDfj3YFRBNkx7qDjwUhtN8/JC9+RHHw0Ngd0x2/BLqeCEMAQaJoC53h0aMLW6PSyovnsLvdJbN/rYc15qUXSz8TtjaHFpjsy/Fo5H" + ], + "x5t": "dJKBile6IJDrRGqa3k5d8_IKFdI", + "x5t#S256": "0HylM2tkO5ny9CyZ9VLASxspFr8GknnsvuoJEzuZO2A", + "n": "i0-23X8hLsFgrh7O2VtM2fVrSRIUDM_7-_D7A-FQOyt1jsMC8CSYHixo65l_FbAWGx79mqANMa0v2NX4UPDgkRhHlnQXstXa-VRgylqKpS-Da0x9Om_mivTQ26aDwb1Pd8h-SGcgJNy1VOnmI5-uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB-6PXXM_nReFWs32fiojoFeUbneQthQnRCS7CeokqIF1KJoOIrTZFCJ-hw2qtCtKrr8K-0rqC_Jq5r1cu6o0_NOweOqKgwRQKapcrbdY0JsmcTERisX07w9fMbtMA_yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp_TO5-kQigYkgVZXcPjbm2c0hdkisPt-APqEdMotmYTANxtC6McP-9KOO8-12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH_36Vfc5ad-nxRYwYObRYfgOh8vpYaw3cpj5-UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv_ZX7qbNhv11a76gJRi_IoHkcf1UTpxCoD-eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz_ZCOrc-RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vs", + "e": "AQAB" + }, + { + "kid": "id3", + "kty": "RSA", + "key_ops": [ + "verify", + "encrypt", + "wrapKey" + ], + "alg": "RSA-OAEP-256", + "x5c": [ + "MIIEnTCCBkiG9w0BAQsFADAQMQ4wDAYDVQQDDAgIBATANBgkAoWgAwIqhAVjZXJ0QTAeFw0yMDA0MjYwMzU1NDNaFw0yMTA0MjYwMzU1NDNaMBAxDjAMBgNVBAMMBWNlcnRBMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAi0+23X8hLsFgrh7O2VtM2fVrSRIUDM/7+/D7A+FQOyt1jsMC8CSYHixo65l/FbAWGx79mqANMa0v2NX4UPDgkRhHlnQXstXa+VRgylqKpS+Da0x9Om/mivTQ26aDwb1Pd8h+SGcgJNy1VOnmI5+uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB+6PXXM/nReFWs32fiojoFeUbneQthQnRCS7CeokqIF1KJoOIrTZFCJ+hw2qtCtKrr8K+0rqC/Jq5r1cu6o0/NOweOqKgwRQKapcrbdY0JsmcTERisX07w9fMbtMA/yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp/TO5+kQigYkgVZXcPjbm2c0hdkisPt+APqEdMotmYTANxtC6McP+9KOO8+12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH/36Vfc5ad+nxRYwYObRYfgOh8vpYaw3cpj5+UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv/ZX7qbNhv11a76gJRi/IoHkcf1UTpxCoD+eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz/ZCOrc+RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vsCAwEAAaMCMAAwDQYJKoZIhvcNAQELBQADggIBAAjHy9GCPejDYIVb/iv8Wo40n317LQN7H6ay+YB5L2byEQATvC1ixde6VqwU6k9VdoQOTfP3xJhfstKrO+n5mFJBL4KG8BZBbd6XQu/ggPLKEIVZFbeQkX6o03K54gY8GxYjHr6gF12I6heLWVKA/Qi480GqSlp2Nz+LE1jgPp9u52xpUPjsvRHXtxYZ7Q3O2jhPToNr3D/TZSu3tmQOeqj9M/igLDe9TxqN9C9jraUGR7Lr4zN1srtvIKhxGMS3Q9kC4Mq+ZNNIwC9+jzzd8fB2pGJP/iTFDzB0pDh9Jz0/CR4O4aGoYqkQEx629aZH2TzhOh2yf04TaniwkHXnUEsPTxrpY8ty/OUG3HzBMHCDhS08ZSimrrxhiWyH6g0OEglXVGrI2nH6nnQIn1MTNILcjUTMRt/WSOz6G07oZciAouKD2YS/W1qPap600kGhTya81BuYThGmFoXVMs7Mk3XBzZ81b6hJ6ncwCLb3g4YzqeQ8bOf42jYJctq4tPNaXTfoC7N0FX7lPVJpRdh6BFcHYcg0NPWJsdk6LtSJB6bp2qptRAgJ5S94s843FRd8PRFE10TKDfj3YFRBNkx7qDjwUhtN8/JC9+RHHw0Ngd0x2/BLqeCEMAQaJoC53h0aMLW6PSyovnsLvdJbN/rYc15qUXSz8TtjaHFpjsy/Fo5H" + ], + "x5t": "dJKBile6IJDrRGqa3k5d8_IKFdI", + "x5t#S256": "0HylM2tkO5ny9CyZ9VLASxspFr8GknnsvuoJEzuZO2A", + "n": "i0-23X8hLsFgrh7O2VtM2fVrSRIUDM_7-_D7A-FQOyt1jsMC8CSYHixo65l_FbAWGx79mqANMa0v2NX4UPDgkRhHlnQXstXa-VRgylqKpS-Da0x9Om_mivTQ26aDwb1Pd8h-SGcgJNy1VOnmI5-uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB-6PXXM_nReFWs32fiojoFeUbneQthQnRCS7CeokqIF1KJoOIrTZFCJ-hw2qtCtKrr8K-0rqC_Jq5r1cu6o0_NOweOqKgwRQKapcrbdY0JsmcTERisX07w9fMbtMA_yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp_TO5-kQigYkgVZXcPjbm2c0hdkisPt-APqEdMotmYTANxtC6McP-9KOO8-12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH_36Vfc5ad-nxRYwYObRYfgOh8vpYaw3cpj5-UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv_ZX7qbNhv11a76gJRi_IoHkcf1UTpxCoD-eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz_ZCOrc-RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vs", + "e": "AQAB" + } + ], + "required": 2 + }, + "api-version": "7.5" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 5, + "Azure-AsyncOperation": "https://myvault.vault.azure.net/securitydomain/download/pending" + }, + "body": { + "value": "{"EncData":{"data":[{"compact_jwe":"eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoiaHNtX2JhY2t1cCJ9..wthTpnCjHzwAonmxJRkrhg.b1SmMr2d_bwUFIKKeFvtcioKPbQz78brwWnrUAdN-3KqcMEQsmINE7OVgbKlVtWkdzbfhgkPwuuHmhoPPzIwkGA40auKeoNh-D7dVjpIwcUp5L45UVSQYs9zTPBtfJr-s-1nMC4HpfzWDsaeLTO8_pdm4lHJ-e7wFy175RP04YGLOfUDiPSiFWO5PwwcB4lILuer8rh2hf-HSu3ygam67uFv75Y0-SH17QwTzpnDm_6To3ZQfHDzwYJkB9VbdohuLqixAF61-xR5o_771Gm8yddquF-jWjiR005fAJqKoU23yfaxYvdNhWMAU0St_LnGNv1itPaX7quvii38Yan7wMOUdh8MnUK_k7XaIOzU2_PUVVYvGdMqqeiTM-pkzAqd-6-NogyesM477WvpMkAvI6KKloFBJC4_RQXaLHLvp2p1NS45FK513oRIxtNwp-3rT0NESdSnv_ovBx8ETjYt_LrmQ4zeojjDUKd-DZlPpYFQP0ea_6jRrJlgyoT-zs8VLAEDGh_Yfd4rtsD5XEdeLgB20Av5iKFMcpxmMURjDIA6DKXMQqHkTKjmiBe6htNgaM617KaXrTnZ19R-3ZR1lk8RhhBnrgCAjiVwYUpO1Pitd66n_6TYSU2yxY12LhgEwgXqGjs8bHTKFbvUVlJA7nWTR7hSPzSd2cjyAiCCGVDR48V0ScQAUqKLeEeIy78nyrPHOd_97tkFIplvhgrpdutHICrjD7OPLYRzPjEBRqPQsBmQK9vWSC499daHO4I9KQLofU75VhN8kt6UxhfET_yyD_Hc4PbKfG9LmaaIqTemUfBVu9DLxErKo8KT-Q_WEF-K8FEmxYuAJXH22KkMl_Haoko46TBWAOq7n-o3htimPeRlnJFqkIjm0Hsu3XBDNGi0AYdkijA4C8-8Up6OYIeCfvNyQ3aYerhITjGGZn2ryHFBFtwYR0nBBsF_0Z8JDz59oLKe18ayYoiJuPsSujxTqMx_24n8ZwPNpz-XX-pDUjdIFoU-EIutQlgOwjReJgr7X_2RK9qP_OnDFDMRvsQNhKZHZIaDGUtDNwbq2cGC0MDIix83GdHKodlbj6BzUq-QqWOWRuKbCSgLWT-WRvssQyN6xHatGoUR1ELqZOz2Tfl4rnJkd-I9QLMysMsmQbfWeMpIYp73oRLlU6obFsd3bM6uFxaFp53OJCjcFQCe-c8_LD1i6uhExSYzsRb8KGg2_Gi0SBJG0v0Rom9_z2VIRpDy0Wrfhg-_XF6TtSmfHhajQW5jL-q2sfBCeqR93qWaKuLRPKD_Jn3XIIGTxRIC34DM9_mzkE16IFCkGg7qD2fBga04p6sXkvQ-RGXTXJdiNwsiUmQPTwB_KIP68TMAgRMjA0AI26NJftofxzx6_L6U55H6D-VuR7C9k2GiVkf4Vu4CjxY29MgpPDehwRr5U1tAPU7Z-gUODoCSpdH5TccSQ8kJoqDo-8IdJ29XkCDQ7C_u6i1UT__yHKn1pILhrpqfneoO5HNl4BSn2ypGEeJ_bWB6_F1N-aphT3cFjPZ5goK_3vOUl87H-J316xiPdbdhb3vdI5dCwZzHs8FplZUirF4ilDs8nIkDk4qwHdfoCeVNX-XMgyANQ9Je418rDfJkd_69abK0z1yJrh8dxMj1GJw67asdvu_5uzVOr0etOyX53QS-RHKxK8EfTgE6I8pV0SCXQbH9KiMwWXrn9r94C1agwI-FuoBe4Yxxz88W6EGoS2L2i0Y34-acYRqI9y3yviRwOoTocgRaw41TSvQ8NsS0OAIrcRs2R_1hNxYNlP2Rm8VKOrWDr450sID-wzV3RbqzrKqRgnlA8AJruBkQOm43UAHVpCcZoTkT1V1b-VziwmD3WHGdQg3mzER-viFGDI-bJ_OM7RVvQpOmqAQAY1oCyc9htqFJIIaa7bo1-CYjp3SwB-bplN8nX8GUaTnCEmS57USl31Pei6K3yrfQeIZ_8CdRvx-g52ka95MgFfFqANtSPS8Wm2PJnyh9qa9bMXsJb9FeXRqYJUv8l_sedUbDXTAKpFZ_aYR7UJKkLVz3b4G1AjmpRPAwswMSX2mRAspkxgfku_xB4rh0n_kx447CjXkUcJw16ZATr56OvLvB6fhEsjz8UXdr52GCTv39nR0lPeKC9Yp-FLfGisMMY7LC8XsESvaYU46vFg2FUHcbh23_qlCbZWOZoowQkJqI3eBSk5FG7euO8DKKkAScwvAfsw13EBLrvv8Kznf2wQlSuTUD27VhKw2NyIKnQ2dy3ywCmOA2FsAvDpQjrmsHN5fT5S-iSF4re0k0U5W5IQX6G3I2PCXRC8rgdP7J1M8q0TkNdM2EEjw0mmjdiS6DU3mc-P5rkHDu8tjzObKDHNLm2_kChAajMsmqIC31b9LoMH4slXmCcP8PMqz3W8MptWcFHqKOzCx2SZiUFGZ7hvkW4uars1C0oyzAIa07x1yifqHU-mmLj-ELJucLdgUNJBcxanTSRsuiF8g5NbPPHt5GtKbP-RviPwevpwcn7kUOQP3QRzbR9KuJEgBStaguMF2SpV4C6RMga5FPzP4Uj7m6gC2OVJ0xDoydGXJrOkcbFXGBt__1GHmnYL5qXUlbAOqxE-7fbbzou8hiJ-HxPScY_Prp8oYQFtColJHLdQGhpTOXJw_eSJaENchg3l5E6LB5U9LYdy4fJxtzF8t7GztxgPe2qK7LANDUesqeBD32STGzqXsTn7QcepA0r0sNyriqnHDSbOo_3St3JnBsvSlzTbYandJ3cZI7W6Ek1BVKxhU5D-DcIoTvqco7KtYmiKoEOXclocBFKLXOXCa1XoQFlRtBtcTAoKL3YJfSKFpEL8UW7nveq9_qvvPTm2jTQozPp-b8MdRCf1UstHwRqx72Usqp0JnxSTDZF-tJmsvVGbBGqR3fcfOYFhLY7w4P61U-5ScT1jqhhg9UPl7ITQA19IDrdXvkHJ-JFlUthTv6bsZOqn2cMiDcuGScpKrH10tgffvqlReg1-YILbL-rxx94dDvGtd_5vycAf1bcd0wtZG7Kih89XYi-qV6UsK-afrOexToi_V9rSO2fxDoFCBhWgTstLsZHACxUO6K6slQpmPiE1J6WWv23bvND_8Cwp3M8QDlk-SQil4BTfqcyWsDstcNmFrFVBA1gFtWFUhxq9GAU2Cj5mkV3dDzH03qX-b6pgiJQ5HQVFl5JEvm1KAgvj2PDap6hrwsWePHjxc1spCGIrp6JOu-VP2o82NaYv4KU1RAQj-fuv-TX_hn3HoLwiCkcQhGiYjVF2oTGCLHd-_kTAQF6CghCF9PUqfuSZHY_Eox0mMvPYD0z5DY0XHIF8S48pLNPOlyBQgzR5O8sEGfNA9S4rrpUWIBjDNzrTiY25jWuts3HhxUQNw_G5tQj--aU9BqB-fH4MUJ6oG3YCHzdqEAwNLrUVBAw3k84XdgLcVqaW2AIJq10KCSPuLNcvTDs6XHWKy2LwtQ4GuCzDHBAibO_oWHPr6rhDJUg2e5vhetqPez5u3J1xStT8raB2OvNbOhoNAbcp04PlbwPrigAECGS1T885ZN7jb9DwQNrLpYOCoIPDceiXnax5j_T6ax-HZt_cA02kRY0SAHBHNFNAq8yLHvHu2bqBJbRfxpJ9NFfxQzdJ2bZR6bG8nxuSTJejyuQvRZ70NeFjGNEhDECrS5J2I0ATPZ05OLMNQNw6vDDbAJdy5_VOazspa-j13wpURnH0sZPIwV0UjRttcQ5G74M-w-ezi5I6vGY99rPxYfFQ2UHNrsM_B9UqNVWfMjr1Q3fyqlngb0RazXth_ac-Rb8PmWqAbpoWszqw-fqCCJ-oGkZL--xNxacv0_X8xB9XOmMj82XaJvHMVbiufpQClZpOKA6BkcBXjIS4-90X5gyyaMWwlz3pGnwU1HVMDpMyPI7UJaFmvDPpU6ZXYevVEFD3865PJxFCfp_uXhYPj0AY-TMEjOfR3PI-22xl9tDA39Cn2Xsx3kCg5VHeoMAmfl3v-ifqQlggF2U-n4BW_04BZNoQycFPvp4CF5smLUu0Jel7pn0Qx8T8r4KhEQudhRMwE2mZW8LFSyWhmqsD4W5TCb-PU0PesG07E1rKbGEWcZZ-1zNijmRYJqPwYIdgRga1_0fKB4W1dEQ6q9zTDJyza3SKC7MXan4zwayhc4i79O-M3rOIB3OIIPW6F65135YyTUZDLbjeBO8fv6RBAOLGLj_82shOAAkEsIq8OJuGMcb0FTUujaCGADZ-o9EcaX7L2n1jrA5UDhSZWlaCB_gjEO8CM7IWlX2uQa5I9X8d7yTOSdVV_FCnNsr4TucoqcYjZCwUfiJR-r_alJmYnTNQ0Za8kyeTVefXL926qrCQjIG1WoAWambDMPuzBBMdnlYSris2WerSxE_tcy17v7oiOWnm9LaUjnhoEWU9SN0AHBu2hlkgG8c4O8G2j6xGtAETFrIFy713I2-7xeB63E22jgAPJQjmUxG6ZhLEHRA9sGYKyJyzu3fww4HlEKQ3tZW7BSWMnyqX9BlTnkdBkHuANJb-mIqizQTyzEhu0KANFcl78ZZ762SJ_tDZA4ad8pxdzMVhfzobKvBj6uIJr1oBZHnjwpRo3V99uvlIFIfAKs_ViREitAGqOoFi73bZnXSyD9fgXX5NwF-fpgyKEeBMtjs9N-qaCeDUQaRZYSesRB9R-1EMkjjtpcIiNhlHllggmm9gvOcy-txmtYq6XE80CsP7NoIfHgrXI5pqDgXkDJ0wIbqDuwhQx5cfAZEWqnP5OJBTFnAlE3IjjtAg1tU6-miKysoG4m9VVTz3F6xvWCtiqYxUE_Mmw-7Qppr7PtEwwpueChs6FCS0Iv4a9PP_Hz-zAKtfmuN88zhrcxcqXI4TjxzKzt4495EnL-ejGVTGt68m_260RIHkL3jiP-Wx6RZFEEoTa0Z7M0HvxdorNEUlaqjh1WFdJTUwtn4JbiyRELkaeCLLF-vQxvEpVh83onuKYjEEW_BQwkmoHLm42V-e2wyTxFkxyjA6rEBi8jxvWDXykrIUXn4JEvrKC2ZfnfIA5BFGpyiNLmM3IY14xJCuQcX6hUpj5V1Z_nYA-mfLRyWf82B3dENw0TdV9A59OcfRTejlwYWCHHqpZOMrP_6mR2fI9HThHV35QxH1-7ybyHCya1uw8a4gO2JWZ1jcWSX6gvnTM8Qk8xn7Frqgigaa2xcdbRXelyhqFT_x-IIRAAMlBKeoxrvWi4PA6CspqK2AJ94eQDxtcf-uj41zO1j2gA2b4gbphuvPGeECQ5IP2s78Xs64JUOVjHeLIuPP3IZiFlXktr_RgppO6YKqFMqL4FePLGmeCA6_s0_tHm72lraEK9fZz_jPpEf-CV02VK7hf3pHvPSrbefkLurZIrf9rk--Kmaftd-Ax_w56rRW-ZktfIwN7rNvmuOBVQiTrgz9L-Ox8Um1Rz4LKxsEjJeNWpMIYmD6SwkMo5Q6nzKKkYyPon21MUjM9bSKSRmLUELxHJ7TXWIuReYFB1oiwyTz8wYvkLIBe5A4Sf_U6O4hufeW-ruscCIkj6hnusVJ8uvjbm4gvPOd-_Dxyh2f-PbeT2YH6AqlBTYlfaA_RMriEjEsFVjdlblUeUVjlPOs2THHKU4iLQJoryEuPPnpa5tUIEmytpmJ6ysoZw7wRAAnL_N3FV-gzkd8WWz6RnWkuHVTnOXMFQd8RTP726KZ-32GtlGFfJPMiuFh8pJ9IuVAgLphcEMxlXmg7EEbRuDgJ-mujFGQeiiLuKIJjDWztYg8MKm053H3OP1BWqsZ5lz-ftRxvmBno8QCV63Mymj8fPpJ0x0a748HruXKLhRcmwIZ2f2jDLj4l4kN1l7fRR5biH36GFm58CKADj9yFChArGf73cJI0_uBSiuPqA12Qvcqx_HV90_7T7krGgbMYdgR0zn1r3y-RdzOUVuuAzaZoHJaYUpDcq7uY4j5kQrvZfmcUve_brQCJCJzrZNEMclmE7B29NVnCd5J05YeZ3ok9mYrwGe9vPxfURlma9eOhEGFC_5yOGqOL0Xv8x_nQlZi3MTquQbTLOiVV88oNxWWCWaRLHvJOS3A2clwBsTSRu_Y0vBAIZqpmev4Yxs8ZVqvmYGlF2vnO6rnrmcXXtOrQE_M4M2kmtezrayJTzO-1taJ4VvI7fjedmmje6y4Dfadn4eNp2nenmIurbExNfzGH6yzLS-GzYWUKlaNMzrb3XHeb5PR13fdBYxO5ffhPu1dOmnQb5tma_iLjdFQdA8EQT9mxg8zCQacd0Mys44j1EvbhHsq5bD1dkJPixJ2l7-yq-NxJmbyWa8FKxC9htHhAwTuv9RzjAI3CvcOkNuUqTZZ-WLS3lPqIXF66CfyRkESQy9QqFv60NWyQyzeHC-OcUBnHXL-PbaPJ4ZMa20D9X5o4G7h6601z62Bb0LvuEIpX4gX1grTEMRIoMlvMt976DBL74zbC7EjOHD2zqCm3OWCItDcsAoA6JnosiN6jSXQDRRaaubQSpyxGafMjiHd9onNiowFDJ9-LlNGNrHj7-2OIVMZL2AH2ulacn65IkjVSaIw9_4xy_QT9S9sPvGDefEckULrrnR-IDvSqQWIqJbm7M41mXLkxW-TuT35bW0Cte5BKDRJHLOSyEdvdvY_W_tFy-cotHauViGeKxSK_kTExACUlVOzCqfH2iM_5juu5D6ZqXQfV_zJHa5TFCtR4rKUdVe6CKZn1Ef1CWtx_h1x1KFtLsiHOnDGKIPzmoVcp45OCIcHc0BO7_BLulRIZpZVrce_1M37NoJFt91fKq9vyt-44g_aZQ1-YZfVaIkhzq-gc5bTq8f7c8SrBuMZi8TYOViygsHtSxVDsZLXpqe5b_IXVupB-BmmG6zfM1faCFsZaW8Mch9POL_OBwMU7B4nSuvye1Go_nvAoHvfl2VWUgMr70DbtOM68mxA1VPRKC5t2IQX27YQZhrDSZLm48htrKUGCUJ1Z2aR9WasAkrTM82uc7pjqoC7zGPanqFHqKvisUY9FJt0VWawx8lWglXZQHHsDW6rVjR61Ib2FWfBED_pU0slzaCYAiyxKdAWsz2_CxoGizT8g5Wwb22o1ZwuOgNJs-vK8XYuXvLwS7H-0kVXKBHCHoR2HzvygGmPkkDzJrfrU7xss9HuJ5H-RJrZqxf-NimLOZngzbbajb9BspaRpTpQl0navNJVmsLI2XzRpVWlZW-i5VuHCfFD27NEoKjPz0TbcGPgCmEGNuj7u4dKKv4WlZLGo-VOTl-jdU_ZcEF7-oVPYMvjSNhTZwYl9LJ07lqbKzha54NbeKve95stUU8bmaMqwu3WqRIm6abIK_ymyz_B9TjjViK9nShaX4MzKCNjbhY51pzoYksn4jHCY0qT2G9Y3Zz2fVnCMKuMYWJtgA7myY7PPHKrqMNZrtrcoi7vbLdRM70f7hVHzeEzxXdR11pc7QtVuiPYRElvPNFPPEFBnd6O6jgllGi4VHz1WkP9bwUEOzYPqwhBJoMSiRtkjAIw_zsITcdvE1mQlR0lyDRJMOAB4JU7iEg1SoPHcvNfblZaD675BJpVpRFJRN1mF0WyiEIo8p1SbjkHVQlUqtKe84rQ2PkTWCVFxl9RL34cpw2f1Zjuml1XaFgKfVu6KJqdfzsPpGamTtfDm7dhWYIFkR7aW3oYIe15HgKgH1dfdCn0TeX2mS7Q1GO2G5YlRmE8rW-jtcmqTC6wxbuLGuvbBmFy9s1KrY_vCWWpi8CXg2mJzI1b9JHPx1uoPML-T_Qx6thgGBDyFireORH8eHZ8OO2tvMi8FL7brLKq9ku3vmojZeXZYlLoDbXNOIwK4PZ3icYUTcYI1Zk49TiWmM6dzveojd8vzU4fKDefPVuYs78mHHnDbFzzIFxxQkcu9cloe2KsY4rocMjnYZwgwyoVJB3PbF6roeYwVQW72xLZLvKGkEFCWJ1TvaEQ7gGkqI4r3dA4-kmRnTAlsOwSdZXgsegozG2PQ6je5xHcSPoe6DhRN1mhK5fYG_JdjfJ_7-ud-Z66S1eT-q-piG68e_iXLibGFz4Zacd0VV3J7Ua2qx84W_PPB4SdNeBCdb9CovWFm1jXTqoQEaLCG5Y820AS7uoPlIz14Glhqd1dqJnkyDIyQiegrPLoOhWch3-x9fli0MjbPts3t-8ECozbUiiyPYp_ag1ReHElsqPmrAFB1rgUB9JlI05-M4mhByjS1_Cbz5KDrEJD_pPWsIxyIRRsJeeZ4OM_cgbTq7gBlGs4fpGE6IGYg3-VFwcSWiHpvlV8dxv54ihkMFQT5An4MUvT3c5c7V841g9kmHiv2jDIOsFXD9gp3mdjER4lACQuGbU9fwufsnqh_OqGMOlvO3j7uRzNWFKotbGg25fow2gSnY_53BttFDXEteEd7KpbYbneu-2H_rQRhn2iqCc84kIL5jiQTEOtokOIBBa2ae2cs-D8HVjgWNJLqzl5l9WpqUTWdCaRLku9Dfuai1zpc8BJBC83M3k6NA6LlVix3t9cj5GvV7Gl-Pawbv04dPa1t0T0c4Sqo4y92zbKH7viO06f2eAhpbAbCU0xFr__mXKgK2XrSe3lYqM2PwAmPASVdXsBsJvv7_MzGikmZlAK2Ka5vR4ExF4czw4voHc1Gz_n2ifZ-ZlKFbKM63usmLygtqY7EFh1rwJSZrHcGx2y7WcxIeQcj-TmuDoqpodusPzsvGKPo39trRxTn6eNd_e38MOpMST9TKLBhUuo4YEZ3oHSjaRp8LKJn6c5ACzTDQZ8qRUhL6gdv7mEFPi1aSV3S-W5EMX8TSEOhfzCrl_Q9FGiXimJgWRtMMkRGxcH-alG4XZKau9prhYqC7HKb5VNBLx9AazkqAQ1DnqFGd4GXwynZ7W4uADq_RoA3oU7ugBRsVcHx-L62HMOOAaXbzUec0ic6wimUuivbikwYJu2xh2sOjTp5BVQAqFzUu44X1EiiBqRWHYni4cEk8ij95bxtm5CR0py8sFTDP0Fqq-YZ2qKz2wbH_xJei9x7nDqPyaD0Dii61dvQXkjkk4hEHknQjhyDv4fK7XFz0FYLWbL0CNNFgGybaB2VOaFbBPVgmJ4E6BqLwSXMTGWUwx8r6VSZnCYz64_WoGgPmxQCrGQYpZYTW6AXos2Y4mCgMygCWhJNx6kjmlddt6SxSVuueKtfZC06i-c7ikFo3FXG1tbjptSw8ZLmgVoI83_lq3qcoP53dVIYW-FBu2IrpaMCd6X52VPFuHhJbQ3X1tTn3-sqNAouwVrFc2cSlroItE8pXvUZE-MA4wBZ1z4IbZcbN2-_4eS9CD4slUJRrANLw9DwpZJZ7OsoeBSYFJyl8HZk1l3NSCtZMAB1_NP81iZ5vjgkQK3YzVL0zJeuqBTseRoLecpOXF5WgDhWkPTecnftqLuvidg6wMGFKtnXga5kmfPmK4wlqUHPGPRmvCWVYzTT7jLOMWXU3VflRZZmzIw8ekzK849fnYBDwbv-Z2oqXE4aPQK0QCXyG3MOP3BipQWsemCRKEggFPS4D4NTcKQJTt--e-UzL99n3cY9jWQZOeObI9qN_71TOVp5PMfb2t0HBMMJ6LpqTn9qPAQwBGYa39idjSfmMsWwMwkngi2EdFVI39RM58ge2rHMQcFQxlhros4i-d6yRzM8k5MpdlaouP6wUiFgQ5zGm0JU52kCOUjLgiBMjHKd51Qk7z66avbqiozQQJygx9_3oVK321pEArGwD6r0J-BrIbAjafaMlolOnmScnx5S6tOkCUD_9H7TPF4hQ0AB_lfai4qhHP-v-6slqCLjOAfNNfNe-_kgSY_uZF1D6Oqfe5C98Osk_SVGjPla3k6MBtYyLFif7hVKRBEbnN8J750ZzTuzn23111cvrfXixo2qF7qh3PyC0G5bzbXQL6kWsmSKdudaW7Sx4oVTvU2yGMUsukvj8fw_78hIaoywDQKn6OZtXK3dU3s1qVI4BP2EGnYww1OH5gJ6wyzwjS0cMeKnWbYXussiMQftG27yx98JpZgpfEzalhr38q9llAsteZxoKx8fdarqcMNuYbKnTOv6SfA_dTuVh3z6C1Uvr_z0_gwUmUaa_Vq2OdMeUWb0H_qHg6_qJ4VOYhN87E2nyZG2LIckEOsi7NsMeoUxx4-78eqqLi9SplqH2XAKlKSid4xeeT5w9R9aRCTftqSqHJ_kF2O9zzTCI_WNGF_yusdtxDxnYLLqm4IjQesNdRWgn5DCgD8CsjEfbsIi5X1YATgoJA-9genTUw-MxhG6Xytf9B3JbHrh0VPkf5pNQf20OLOHS0ISK9OP0lxrFRAAWkp7D_Z4dH8CrIE-FqcXp0sq7BwR8fEEC31hbr9x4JtOQbFsx63Rha3u9m8MMK3TyE7ya8h2Uu62OzuCRkJ_fRrD879pIvOtQankc4IPOHkkb4uyIlbLJ9AAxxgWe0_EgabuO1gCMRCPnzEaGz_ij3fUqEVjWW1wXVWR9U8dbKsvPWwNEwvcIyqt_Fe31Z3FlTAvx65RZFA_Wbh8mQu4h51usk3AY4FuJiujEePg5sKpVridWmZHKHRZwcD_-4mB5UwoHQqxVTFZF0eqrtOAW0gWoIw8GT-JVzUkGrVCBbzd60rG4Nud2sf512sw1qNdhFeqhOH11bB72--xd99whyw1Q6kz4boNhwiE04rkAtc8DzUs1frWh.gxjema4_JLMBOfM_K5dxH7wjWsghsHRX5716vFZagdQ","tag":"hsm_backup"},{"compact_jwe":"eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoiYmFzZV9lbmNsYXZlX2JhY2t1cCJ9..R3I7fa81q2LbHtBJSeweBg.tCpY2VAY9idq4aeYhHxsoGVW2OyJu7NTtolBYaAIH0l6AWGOHP6kTd0aZxlUzt63n5zYL1kxRxWLTBnUAXLmmOB0f6eKJhc7fJdUe57p8ML4cJKHl2RKQptj_ET9TuNsDYgYmUx6D3u2YVjNFqc1pXUmD7unxtM9yN1TSFv3VcmA4qf5vuOvyCslagtOZsnKaGUzdjYjOQKJGEz2y7YIYXOKG-icgXtgm5f_Qp6HYBeIahn--H8LKnnONkATJtRQAPERYkLKndsZ7RK6aZrqZGnRFoED7MZIhDn3XCJClYgqlzl7kaGBU8eJldjJ25gNr3u21jfMx0C7j6eFZ97y4RaCBFQJmPiQUafBGXH2OLcAKiM9w61ksF587Eup95OKXJ0kHFx8ohViqlbg5UuB8ZcytxvtKzfXnQTBjKfCbbobPdSqk5PDUkBYbyXeRKVW0tDyVEfOajWsXM1uTlYr-D8-Ao1WocOHAbHF3xuuPafsDvIXq7w2N_rBp9vM9jOC0jtLDzWXxYpr21ZcHvhpibB3qwdEMKZ_d75JC9cEf1O9-IMiPTIZckZhtErk5PAR7frXAPA8rkV2mMYIALNY_DB8CpuHGbGxfzpMbggvSTu9KZq_6ahHleHOEjFIW5zbXzw4m9ezLDzPNrsYL1knn-p1OI8Mgsf5fwXYKSmOUExFCuB647vvWavh9ys9aLYXSNojDAljfTkFe9FUUuFKJeyKEykdCKROdveIxjHy8zaAtcAdgUIp0OQVvAN7ugfB8IRP-e5ki5VZm4zWGP2BEVM_vYle2A6TJtH3LPT7MUzTlo1PU1kKTLkgq2Ujx0Devfk-88Z3SlXUekQTnPWIYciacXC1ZmztUAZpa0ki_SqufF3ftd8LQIGwE4zddfmsDzileHZKGvTf-t1KdNoUnBmbqNoBNmDunSnLyAzWEXMzgeHdpl-vKYZSQp9frivDeWfe8lWVbORlbP4q79JCkUdph1rg3iyqtchzLkBx7ZjxbdPFz2E7CPvPaEbrTgz9X4T7uYkRUNkCFJlp_MKE_tKa5spDL-rLvlx2JUwejWPbrEgVD7hqwaVIL5wpg8GJR8xHiyWLo3UqM_SAefez1CCpIEoT0OQ5M_xU9a5jwl0.o-IINHw1WNRAslRFq88iYrYeNebmTa9TkFPuRoKF_eY","tag":"base_enclave_backup"},{"compact_jwe":"eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoia21zcF9lbmNsYXZlX2JhY2t1cCJ9..Wao6CQPawH7YFEwG7e3kNg.3UIhxHamWAKXiAPojW3eqnz58QlJOBoNp2FpusOI4QtzFb2ds43oSV9zCyQjIksFXFJ4CfkkD0AHqAKgkMKgRVwOZOlrE2GdJJEY5o96BU8xHjd_ATZ6vQb2ULER0FqTfvH9NrfV9Hd__YTKMTuQ60NWYkT_TwMLQ_i2D7GwBtKzK7AglEcmS7EznXp4fY6FbQNctd3c4zVYAbx2qnwG1f3L3Z2wddgrIXD2bejnQBbL_uHEbT3_23hYx6EtxDCq4mr35pu1SH41uPigA724mwrSWaDw6GIDypeZssTX6g6Et9drvho9PzYN3mvLiGoOtpOMCuq1rwruBfM2id6G_SQLOWdGsP9gHPK1WAXe47-mjYpdlhbhaMN1UiRAelNETuj_3h9yZ9uhW1noS9WIaOVzLEUpCfrMMYL-gnnLnQvVJHV62FMD8WedRU3zURK47TVqLkscdhblMeBGQhIWDxhAnK3GqANGnY3pgoZzC4Stu_ZcMKkl1VtnvbeFhLLG2zf0T4A35CoYTuwNut-CUKJk9nfgLyavV5RFrX5pRSWyFKGT768FO62hAczBd8UyWpuRo4hYfFc9B8uCJgmIH_JYxQVX028ujGrbm8r5EkMF4s27DYZi0E5B2FFs3K8K2A2q3ItGvJYwdsg5CH7xeazVF6kcMnoSvo3G61ZvYMe8MpCG4zC1zGSx7GJzcFLrPoNqegO8hoZyc2NK75zPEYCuM93q0uCMPa9PnlOWkKg5s_tKMVbA_l0GvxwekxURTJK0Wn4qsGb-tjoyft7t2lspoK2zkXKODaRRV_QxbrbqbQsIzF-r06pzsRQHLFNTxYBA_v2sPAIqdHj0tJKqK7PnW2I7enA4NT3SZ9ZzZGBcrnkty2m_AV2A3VhteFN7_B8UEgaxJzsK5VdBxF-BC4VeJGo1tKqrtZKP_GjBMMLlb6XY8EhKpPOS4kdHBslTWO-cpg8g46qFzfD7j8NHQ1xRBjFfwfr9f0tb8YrCGzOQ5c0B7FALCJNKIFgsrVjYdOd9oYuA5tbZfvRAt2GNY_-THwLr0pYad3cmWMNUPPcwdwr4j6B5BK9jbQ_gtRWFqAwHuBhtBnIij1uPTO46eFkmQvVOQ6vYz3My3WcjNKnyv_WftgGTRHvs9Ey_nQLgebWgTHb7KulV8J7gEY0N8DhouloGUMqliXtn6jaetUeRBahOhTnI1XeZ4fstgilw7vxDxR5u5WpGGAkG2-dso5oN9AUDpxvvXxZWwKH76CoqFjnbHA0WVXyGHD4L6IYkA8dXxgpYm9E98S7b4gi12q0zMeLGf7vKIDmNmjoEVhXKFKPN_34F0LxMMUk_1nA3yqoaWmGzRSVWq--yhkNPzwMH1xX2kCZyoXlgndK8zw5dIpskdlfHnSZb1ZDv6mMhPnIK1hanRYoSsKVmdopEHm87CTUiYErtyOH7fSaijTw3WTRv47mUqGou0WuCHfReUs10V-nRiachIPj-5vSSMKCSpWlqbuCUvD9lvy-ESnlL4O_ZlEQrDg5TSILY5N8Xl9qS4x4DwNCGVbJvI1B_xNBNBfDUfqQvQy7RU7wVaHqKzR23Huy8sAO1WBW0jBumQJ275JGfWSVx-F1a_8HZG0GVKs02IqFt4S9dr0CO5tG2k1NssMukYytbtsqrItlsnTQV7bMHEgZFIbzLjAwyaQc85d0IxlBbbmBYeHdZtnlddtk9Bvy4sjrDgIVeAepuVqF3N6IkquI3U-gjwKAcA3J1RddCDyrLU2ajFF9WaSAnaiNqruGz7YV9H1biidXRbHPhEsE43K2Jh_ic9PhLU3vPWlcQ85uGtkZLQM3emAuG2KGSFA71wZroXhqTHALJ5jKLIaCDewh_LpNLsc3tUKLN04ZV2GH8StYu7ve9A6AySrhTf1JDeyigZz_dSY-Asihk3D1cI3xFhy-Gle3VCvOF1RLQ_dxv65vnWSZGAxtMuqGWeMNuYcOlizeDfg4Un3dO7Uit8ioTxuMV2wrESOUzQu8ioGzO3iWtWYl_2Yt-1uxfUF5LH_D9oik1iA2wDOrvqIzhAs2FjLLBhjKpHqeb82SgbwzRQo2EBfnzrb30V6kON538BdjtBKHoaGIJxKRsgF6sRI1C-nITx5aYyXI0LCSBAEe9yJTZLUWkjOp-_zRJv_GwdNxSZvLHGdpYVOpr11z8U4k8XLMqJtaYp-fMBqXxybLd3qhMd_PvWGMvRGboiwqwrv-ZYplu9cR5kTofiGcR5HZZYxSr3ueUnmzccI2EBMAQjsu2-kaScK2sVjx6zcThu4PPqIzD-Zst9QljjTa-endSY-o-MR1ol7d64xy5bW37CCNprX_FnwwchHB1uGS3KlLwQLdWCe_wOb6743MHqYja16n3uoTdQtMQHRKz7OdiivL1t4bPtUkeQ_fJlDjCn2SDjQzPTYf8JV4xZdLVepA7WCZ4u2YsrPPJRMRuNu3UMYEqb5a_isurIc2MD53aRidyq80R7YdiTH1_hd4_GzDY7uP0jJnuDutICMRBK59jz21Yjrw-rpgg4QkFT6JmBnqRKm-X-XNSC0WKxRFr4fBQKUp7lA_D9HUgsv9OPOQDAyWfU37ckf_XAM4DbaRYNFktI9zu3k8VRMMDOOuROu34XpaSeTiX4gVmtzul93RwvUJe00AOArANwfjJEFGIN_7Vq1eGNhlZS0JFAiv48bsSw0M0tyjfTc-fRk1huQLxp-G9Dr0x4WfZX-zuX3iLyVtlvB34z7yw1I58jISxWLfW3EtyOLhwDJojXLriyN_ZrQCmAKK_g_MShocAK2Z7KL3K-DLl66qKGtpWAdKBg5llY-XQrcZqv0idmiZJwjgi2dX7VefUL6rWxND23NUoU7AEUzjsu8J0qvfd-SxwHzlxZKaJ855ti7SKdT58Tc_LLSxP1WQp2hCNvBv02P6RzUDt-CRIVNYjTc1ZUsRO0rDLS0Df6ldzFVxqZRxzy9iCfas4EVwL5o8XrUnhtzQKjcTcOtn5rZ8y8vbuHFZGrfS3DnozcnsgQzEpXl9_G0FV0DV7lczMiDj95xhwrrmnkmvV8VKY8QSJD3nIX99BgNKZWr6gVZovDv1RjAwbbJRNrrCa-zGrhEoV_JOPdHL-NfSl604NxoGSHGtmzCBRKPb7G5B_XUlPa44FQyx-JM7FiqlN9CyIrJdeTWqkcjQDZOLoC4PPtcvCfWB8Vw7uB7T_nlyziEfOsVGyKUT0a5NoAvFi5RFHOWjX6nBCYFNhxTYUdSDvDTa9iX7VrwsMiTo0lBo2P2oNBx9CC4j3Ui5NW_4x2MuiJHKjswWkgup8qwzry9qaM_H1EuvUeit_OdE3z0Ux7tdOD23IjdUnNvyxdN15Xpe4CiQxbLSnd0OJBzhXvvWfrBUgfkm2F1V75WRxcHx6ak_P1k-hkvFowFfq-eDupE8hs54WFdQAJjXs5w37dYvMQxvYwJkEpL3b7vdDwIYcjFX9Ig-2bIU6I6sJ_ZpbSN6Zcln2hNmnX4ZeY4uPE01URe6m7Gm9AfpE2aKiO1-iVnzJGA8IJPxu5ztZLmYCOho96NtWUsGQ80JSnh0YuD-8YrXfZpKJ2fDaO86x5Pt5cyQRXsxte0OR8F07yNmgrSHgcF0BFLn_wlWlbTwkbDy5edaqeE0WYtF52yuf7u2voexYrA.DUHtrC2MbUXTgNWM6YvZi2GHVJLzrlcgUUqvEpk6JBc","tag":"kmsp_enclave_backup"}],"kdf":"sp108_kdf"},"SharedKeys":{"enc_shares":[{"enc_key":"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoibm90IHVzZWQifQ.M-AxGQYJ6UCCLmeXp9gSR2EU1lnKLEq2f1VwMnOJWiaLDbHgMl_m-FVu_Xl4GMs36ONza1IgqD3_ZChxvbTK4mobgs9rC0VGKXx7G7qdm7Ml8ETfBjjLMYwdIQyGryTDYWXenTtAZqZI6w56fa_TD2hsz3FCcd-PftLXfm8h1LhYGeY_QYj30OyXeWoEgVgw6-CguDia5GqZ8HJ_9KFxeVOB_sBKuB7VZgiF3y-UdCQMWBRJHHMNfMk4A5umO5iaQo1U7zCzDCTjhv0U_U9SfNtqEPWdlVqjv0uzZ5rNIGqB24pNMOEyuO2H6VN-tGLd_ZK6SGRcOsOAVYek3uZ6rz8bzAYEUX-yW4PTQevR86ZRsspHutcbWZ6-2HnXQ_TQ0I4S-q2HUET4A5Ai6s-MBAKx49xUxsUCRlPLqgPe0DDeh2f9UiBtFC-ik08epXklGVrjUaW-56EE5oTwYcumZM3-gPwOWrT7YnE8VwpoxKugpnkMX4CIejNY9BG5epl_sE_-4i1diijkt4zQKC4uS9hC1tRuW_anpdpiwuXPUNidM_eiX5QUeMOnzqQc-kqrgQGWTaZzKirdcP8zlO7XBvVimQsewuUIfu_EZLCMtYWKdEKNNJo_KM0ynojgN3rlbkSyedSpN0UugN7Owz6bfW3lR4wJj8NrZ4o39r0KT8Y.vcaaqCdL3E6Sl2FJUxVMuQ.mqSktigzXnFiNHhQ0WCTaxKA81XZZESP8Bsn2XSHYsFzN9vNtqQ7Nvwb7DR-JrsiTQElYoCRjqrzfBBnDl-Uwh9A-KjpsPRJqtGwgRYooFU.ymNm5QZRqygZv7hCWfABi4_JDr6vgP5QMBjh0GvX9L8","x5t_256":"787v1DtWq49M7o0zvTQnjtWx3vcSslYg0qbz1vRTkO4"},{"enc_key":"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoibm90IHVzZWQifQ.guAbxgNRcCqrM9AwNrD9dvVqAqF0IEnR0SmfFGT7OhiP8YuUJlWv9Ku2eokNF-VkmFnfG_1iHUVhaLM4Cw_DAF45bum2PBsojpF1cQML2OGsrgLgdml1cmlJJixwPi6coSU810aku7ijUUSLCJiRhroBzfVmOKIjCGnheDr_iuWp7SZRDlz63hS2Thumvt--SW56LlRxzKzRZxYb9G-Y0oaqxRHl18KIjz0fMxK0KdN2NKA7Vh6DRyQGpoEAYN4mbLIl80op9VQBPMnTMJFtGcZPWBo6UCBOGE3zye2Da2jFgLkg9_qE_51v8DieeBXcaFLYsWyqm6Q-rgs1q6Z3VKDfCN4SC6YoHPlwLB2B092Cw3d3I0VnvyKSvwf0Gm5osPomnmR7CWkm2HeT0AIlRhPn5cUuOvcWPa4QmlGrDnlgdS9TjJgcTXPtEKSicZkXtXmuKMPuMncRTSNTr4XfwiBm4Am22JwQm7LOKS9_g16-C01SpXyP4-6FRWsY1g30UcfLOKZcEemQ5RTdCZBQSwP16DgNO-yn3bSQYvdaTbnjWJUJ12Mji1s0rLLt1d8NFm-WEUWuAYwPybRKkbAEwEj4t28rFfGhVAvg4Gz-Hxw8qK-HnJCpYQmMqjOHiiCu9cUQF2ypfLlDUORRZXwPhnw95CVWrOrhVXCHUi9mL-w.ytUR25RV89XScGRmIo71lA._SXk5o1yZWivNMleHb_9gmMyfn66pLWr-LamVtVhc4qYfX5DQbJ1hjUWbempvQshGULj_O12JJmOmnVKDf0GNEnrF9IEFTio2Og-SxsJu44.f-FySaX4czgHc9_xZjP2xGbl9xnto30M057VtBhsk-I","x5t_256":"nhGiWZ3sDugAKZNnpU4f90wXlZQM03GV6PfsbNLs8No"},{"enc_key":"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoibm90IHVzZWQifQ.etZu2czOsU0AedQIggjll4VHZN4HYWsQidoDuLtUYR2U1ZpKStXJ5-R7nRmLvMTIVUCJVqM2NFq60zr6LeG5UsOcFFj_LC822Tr0BIkPZftVgX3RrGNbsrcJXkqqo_kNV437N_5VX0TNetVTFMwD38CqW_J-BE0wRJCmEMY8BZorDNsGNNuaRX5l7hwCQ_Tm7SJEXe4dujRWTEDYs9uwLzX1pZeqTEkC_e9tMWuCfCfZ8CRrCnhCz2zbvmD1JWZUYQsnwkr5-lmft0RoTs1vpePlkHv9wRJebJwSoJQbcCrO2RQDOhwPB6GWnMVM65Zu91XyWtP4WcPqojNpt6GHFOva3_tShmKWtX5xa3GsQEIi3BI7F9WL4Bu6HjrQd05cpvUro4_hTyDbYKDOH94YOV-jQx5J_QQrVVrClRYwF4f33pR-O2Inxu7U3dbM-QP49KaJ7ch82Jf94qccttbhTjq4nSw5MWecnCPf4HkRcul9DkIdEpcDH2dZUqdWBGb1nEcevW440TlRn6G0TxjK0Z_gizLxuulfIOQ12HJMvPcYww9_-1gFegTt83osy8BfV3p407xZWETNPTyecL55vztJR2cR6KZdeNGl6ZD5806eOc9ZPb0KQgob72DU3Nf82bt3upPt-q0hSng3HXzTeHVbQQWMMZlApCvhwiZitHg.cg4wkrCJuc5AnbZciPYXCQ.X9mGsD1ubRSIES0brRb9hPSLZckShcdnkAG1711irzfriD1fpKZgkTpC6_CgZNpbSbGOzlA6dgjQyzq3GE7RFkC1G8xqoCdO1MZu1ElC7W0.4uFEtARRKsTwqYKcD4S6mGCbMfhqyOqwUGtZO1kX4Lc","x5t_256":"wd9ErZhXQZixpwM6O-EB9cKAiAiS7aWgRGdAkM1M270"}],"key_algorithm":"shamir_share","required":2},"version":2}" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomainoperationstatus-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomainoperationstatus-example.json new file mode 100644 index 000000000000..b21641177443 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomainoperationstatus-example.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "status": "InProgress", + "status_details": "" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomaintransferkey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomaintransferkey-example.json new file mode 100644 index 000000000000..8e61bfeb78a8 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomaintransferkey-example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.5" + }, + "responses": { + "200": { + "body": { + "key_format": "jwk", + "transfer_key": { + "kid": "https://myvault.vault.azure.net/transfer_key", + "kty": "RSA", + "key_ops": [ + "encrypt" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB", + "alg": "RSA-OAEP-256", + "x5c": [ + "MIIEnTCCBAgIBATANBgkAoWgAwIqhkiG9w0BAQsFADAQMQ4wDAYDVQQDDAVjZXJ0QTAeFw0yMDA0MjYwM/mivTQ26aDwb1Pd8h+SGcgJNy1VOnmI5+uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB/yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp/TO5+kQigYkgVZXcPjbm2c0hdkisPt+APqEdMotmYTANxtC6McP+9KOO8+12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH/36Vfc5ad+nxRYwYObRYfgOh8vpYaw3cpj5+UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv/ZX7qbNhv11a76gJRi/IoHkcf1UTpxCoD+eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz/ZCOrc+RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vsCAwEAAaMCMAAwDQYJKoZIhvcNAQELBQADggIBAAjHy9GCPejDYIVb/iv8Wo40n317LQN7H6ay+YB5L2byEQATvC1ixde6VqwU6k9VdoQOTfP3xJhfstKrO+n5mFJBL4KG8BZBbd6XQu/ggPLKEIVZFbeQkX6o03K54gY8GxYjHr6gF12I6heLWVKA/Qi480GqSlp2Nz+LE1jgPp9u52xpUPjsvRHXtxYZ7Q3O2jhPToNr3D/TZSu3tmQOeqj9M/igLDe9TxqN9C9jraUGR7Lr4zN1srtvIKhxGMS3Q9kC4Mq+ZNNIwC9+jzzd8fB2pGJP/iTFDzB0pDh9Jz0/CR4O4aGoYqkQEx629aZH2TzhOh2yf04TaniwkHXnUEsPTxrpY8ty/OUG3HzBMHCDhS08ZSimrrxhiWyH6g0OEglXVGrI2nH6nnQIn1MTNILcjUTMRt/WSOz6G07oZciAouKD2YS/W1qPap600kGhTya81BuYThGmFoXVMs7Mk3XBzZ81b6hJ6ncwCLb3g4YzqeQ8bOf42jYJctq4tPNaXTfoC7N0FX7lPVJpRdh6BFcHYcg0NPWJsdk6LtSJB6bp2qptRAgJ5S94s843FRd8PRFE10TKDfj3YFRBNkx7qDjwUhtN8/JC9+RHHw0Ngd0x2/BLqeCEMAQaJoC53h0aMLW6PSyovnsLvdJbN/rYc15qUXSz8TtjaHFpjsy/Fo5H" + ], + "x5t": "dJKBile6IJDrRGqa3k5d8_IKFdI", + "x5t#S256": "gIBQCTDDN" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomainuploadoperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomainuploadoperation-example.json new file mode 100644 index 000000000000..3cf2a52944f9 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/securitydomainuploadoperation-example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "security_domain": { + "value": "{"EncData":{"data":[{"compact_jwe":"eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoiaHNtX2JhY2t1cCJ9..wthTpnCjHzwAonmxJRkrhg.b1SmMr2d_bwUFIKKeFvtcioKPbQz78brwWnrUAdN-3KqcMEQsmINE7OVgbKlVtWkdzbfhgkPwuuHmhoPPzIwkGA40auKeoNh-D7dVjpIwcUp5L45UVSQYs9zTPBtfJr-s-1nMC4HpfzWDsaeLTO8_pdm4lHJ-e7wFy175RP04YGLOfUDiPSiFWO5PwwcB4lILuer8rh2hf-HSu3ygam67uFv75Y0-SH17QwTzpnDm_6To3ZQfHDzwYJkB9VbdohuLqixAF61-xR5o_771Gm8yddquF-jWjiR005fAJqKoU23yfaxYvdNhWMAU0St_LnGNv1itPaX7quvii38Yan7wMOUdh8MnUK_k7XaIOzU2_PUVVYvGdMqqeiTM-pkzAqd-6-NogyesM477WvpMkAvI6KKloFBJC4_RQXaLHLvp2p1NS45FK513oRIxtNwp-3rT0NESdSnv_ovBx8ETjYt_LrmQ4zeojjDUKd-DZlPpYFQP0ea_6jRrJlgyoT-zs8VLAEDGh_Yfd4rtsD5XEdeLgB20Av5iKFMcpxmMURjDIA6DKXMQqHkTKjmiBe6htNgaM617KaXrTnZ19R-3ZR1lk8RhhBnrgCAjiVwYUpO1Pitd66n_6TYSU2yxY12LhgEwgXqGjs8bHTKFbvUVlJA7nWTR7hSPzSd2cjyAiCCGVDR48V0ScQAUqKLeEeIy78nyrPHOd_97tkFIplvhgrpdutHICrjD7OPLYRzPjEBRqPQsBmQK9vWSC499daHO4I9KQLofU75VhN8kt6UxhfET_yyD_Hc4PbKfG9LmaaIqTemUfBVu9DLxErKo8KT-Q_WEF-K8FEmxYuAJXH22KkMl_Haoko46TBWAOq7n-o3htimPeRlnJFqkIjm0Hsu3XBDNGi0AYdkijA4C8-8Up6OYIeCfvNyQ3aYerhITjGGZn2ryHFBFtwYR0nBBsF_0Z8JDz59oLKe18ayYoiJuPsSujxTqMx_24n8ZwPNpz-XX-pDUjdIFoU-EIutQlgOwjReJgr7X_2RK9qP_OnDFDMRvsQNhKZHZIaDGUtDNwbq2cGC0MDIix83GdHKodlbj6BzUq-QqWOWRuKbCSgLWT-WRvssQyN6xHatGoUR1ELqZOz2Tfl4rnJkd-I9QLMysMsmQbfWeMpIYp73oRLlU6obFsd3bM6uFxaFp53OJCjcFQCe-c8_LD1i6uhExSYzsRb8KGg2_Gi0SBJG0v0Rom9_z2VIRpDy0Wrfhg-_XF6TtSmfHhajQW5jL-q2sfBCeqR93qWaKuLRPKD_Jn3XIIGTxRIC34DM9_mzkE16IFCkGg7qD2fBga04p6sXkvQ-RGXTXJdiNwsiUmQPTwB_KIP68TMAgRMjA0AI26NJftofxzx6_L6U55H6D-VuR7C9k2GiVkf4Vu4CjxY29MgpPDehwRr5U1tAPU7Z-gUODoCSpdH5TccSQ8kJoqDo-8IdJ29XkCDQ7C_u6i1UT__yHKn1pILhrpqfneoO5HNl4BSn2ypGEeJ_bWB6_F1N-aphT3cFjPZ5goK_3vOUl87H-J316xiPdbdhb3vdI5dCwZzHs8FplZUirF4ilDs8nIkDk4qwHdfoCeVNX-XMgyANQ9Je418rDfJkd_69abK0z1yJrh8dxMj1GJw67asdvu_5uzVOr0etOyX53QS-RHKxK8EfTgE6I8pV0SCXQbH9KiMwWXrn9r94C1agwI-FuoBe4Yxxz88W6EGoS2L2i0Y34-acYRqI9y3yviRwOoTocgRaw41TSvQ8NsS0OAIrcRs2R_1hNxYNlP2Rm8VKOrWDr450sID-wzV3RbqzrKqRgnlA8AJruBkQOm43UAHVpCcZoTkT1V1b-VziwmD3WHGdQg3mzER-viFGDI-bJ_OM7RVvQpOmqAQAY1oCyc9htqFJIIaa7bo1-CYjp3SwB-bplN8nX8GUaTnCEmS57USl31Pei6K3yrfQeIZ_8CdRvx-g52ka95MgFfFqANtSPS8Wm2PJnyh9qa9bMXsJb9FeXRqYJUv8l_sedUbDXTAKpFZ_aYR7UJKkLVz3b4G1AjmpRPAwswMSX2mRAspkxgfku_xB4rh0n_kx447CjXkUcJw16ZATr56OvLvB6fhEsjz8UXdr52GCTv39nR0lPeKC9Yp-FLfGisMMY7LC8XsESvaYU46vFg2FUHcbh23_qlCbZWOZoowQkJqI3eBSk5FG7euO8DKKkAScwvAfsw13EBLrvv8Kznf2wQlSuTUD27VhKw2NyIKnQ2dy3ywCmOA2FsAvDpQjrmsHN5fT5S-iSF4re0k0U5W5IQX6G3I2PCXRC8rgdP7J1M8q0TkNdM2EEjw0mmjdiS6DU3mc-P5rkHDu8tjzObKDHNLm2_kChAajMsmqIC31b9LoMH4slXmCcP8PMqz3W8MptWcFHqKOzCx2SZiUFGZ7hvkW4uars1C0oyzAIa07x1yifqHU-mmLj-ELJucLdgUNJBcxanTSRsuiF8g5NbPPHt5GtKbP-RviPwevpwcn7kUOQP3QRzbR9KuJEgBStaguMF2SpV4C6RMga5FPzP4Uj7m6gC2OVJ0xDoydGXJrOkcbFXGBt__1GHmnYL5qXUlbAOqxE-7fbbzou8hiJ-HxPScY_Prp8oYQFtColJHLdQGhpTOXJw_eSJaENchg3l5E6LB5U9LYdy4fJxtzF8t7GztxgPe2qK7LANDUesqeBD32STGzqXsTn7QcepA0r0sNyriqnHDSbOo_3St3JnBsvSlzTbYandJ3cZI7W6Ek1BVKxhU5D-DcIoTvqco7KtYmiKoEOXclocBFKLXOXCa1XoQFlRtBtcTAoKL3YJfSKFpEL8UW7nveq9_qvvPTm2jTQozPp-b8MdRCf1UstHwRqx72Usqp0JnxSTDZF-tJmsvVGbBGqR3fcfOYFhLY7w4P61U-5ScT1jqhhg9UPl7ITQA19IDrdXvkHJ-JFlUthTv6bsZOqn2cMiDcuGScpKrH10tgffvqlReg1-YILbL-rxx94dDvGtd_5vycAf1bcd0wtZG7Kih89XYi-qV6UsK-afrOexToi_V9rSO2fxDoFCBhWgTstLsZHACxUO6K6slQpmPiE1J6WWv23bvND_8Cwp3M8QDlk-SQil4BTfqcyWsDstcNmFrFVBA1gFtWFUhxq9GAU2Cj5mkV3dDzH03qX-b6pgiJQ5HQVFl5JEvm1KAgvj2PDap6hrwsWePHjxc1spCGIrp6JOu-VP2o82NaYv4KU1RAQj-fuv-TX_hn3HoLwiCkcQhGiYjVF2oTGCLHd-_kTAQF6CghCF9PUqfuSZHY_Eox0mMvPYD0z5DY0XHIF8S48pLNPOlyBQgzR5O8sEGfNA9S4rrpUWIBjDNzrTiY25jWuts3HhxUQNw_G5tQj--aU9BqB-fH4MUJ6oG3YCHzdqEAwNLrUVBAw3k84XdgLcVqaW2AIJq10KCSPuLNcvTDs6XHWKy2LwtQ4GuCzDHBAibO_oWHPr6rhDJUg2e5vhetqPez5u3J1xStT8raB2OvNbOhoNAbcp04PlbwPrigAECGS1T885ZN7jb9DwQNrLpYOCoIPDceiXnax5j_T6ax-HZt_cA02kRY0SAHBHNFNAq8yLHvHu2bqBJbRfxpJ9NFfxQzdJ2bZR6bG8nxuSTJejyuQvRZ70NeFjGNEhDECrS5J2I0ATPZ05OLMNQNw6vDDbAJdy5_VOazspa-j13wpURnH0sZPIwV0UjRttcQ5G74M-w-ezi5I6vGY99rPxYfFQ2UHNrsM_B9UqNVWfMjr1Q3fyqlngb0RazXth_ac-Rb8PmWqAbpoWszqw-fqCCJ-oGkZL--xNxacv0_X8xB9XOmMj82XaJvHMVbiufpQClZpOKA6BkcBXjIS4-90X5gyyaMWwlz3pGnwU1HVMDpMyPI7UJaFmvDPpU6ZXYevVEFD3865PJxFCfp_uXhYPj0AY-TMEjOfR3PI-22xl9tDA39Cn2Xsx3kCg5VHeoMAmfl3v-ifqQlggF2U-n4BW_04BZNoQycFPvp4CF5smLUu0Jel7pn0Qx8T8r4KhEQudhRMwE2mZW8LFSyWhmqsD4W5TCb-PU0PesG07E1rKbGEWcZZ-1zNijmRYJqPwYIdgRga1_0fKB4W1dEQ6q9zTDJyza3SKC7MXan4zwayhc4i79O-M3rOIB3OIIPW6F65135YyTUZDLbjeBO8fv6RBAOLGLj_82shOAAkEsIq8OJuGMcb0FTUujaCGADZ-o9EcaX7L2n1jrA5UDhSZWlaCB_gjEO8CM7IWlX2uQa5I9X8d7yTOSdVV_FCnNsr4TucoqcYjZCwUfiJR-r_alJmYnTNQ0Za8kyeTVefXL926qrCQjIG1WoAWambDMPuzBBMdnlYSris2WerSxE_tcy17v7oiOWnm9LaUjnhoEWU9SN0AHBu2hlkgG8c4O8G2j6xGtAETFrIFy713I2-7xeB63E22jgAPJQjmUxG6ZhLEHRA9sGYKyJyzu3fww4HlEKQ3tZW7BSWMnyqX9BlTnkdBkHuANJb-mIqizQTyzEhu0KANFcl78ZZ762SJ_tDZA4ad8pxdzMVhfzobKvBj6uIJr1oBZHnjwpRo3V99uvlIFIfAKs_ViREitAGqOoFi73bZnXSyD9fgXX5NwF-fpgyKEeBMtjs9N-qaCeDUQaRZYSesRB9R-1EMkjjtpcIiNhlHllggmm9gvOcy-txmtYq6XE80CsP7NoIfHgrXI5pqDgXkDJ0wIbqDuwhQx5cfAZEWqnP5OJBTFnAlE3IjjtAg1tU6-miKysoG4m9VVTz3F6xvWCtiqYxUE_Mmw-7Qppr7PtEwwpueChs6FCS0Iv4a9PP_Hz-zAKtfmuN88zhrcxcqXI4TjxzKzt4495EnL-ejGVTGt68m_260RIHkL3jiP-Wx6RZFEEoTa0Z7M0HvxdorNEUlaqjh1WFdJTUwtn4JbiyRELkaeCLLF-vQxvEpVh83onuKYjEEW_BQwkmoHLm42V-e2wyTxFkxyjA6rEBi8jxvWDXykrIUXn4JEvrKC2ZfnfIA5BFGpyiNLmM3IY14xJCuQcX6hUpj5V1Z_nYA-mfLRyWf82B3dENw0TdV9A59OcfRTejlwYWCHHqpZOMrP_6mR2fI9HThHV35QxH1-7ybyHCya1uw8a4gO2JWZ1jcWSX6gvnTM8Qk8xn7Frqgigaa2xcdbRXelyhqFT_x-IIRAAMlBKeoxrvWi4PA6CspqK2AJ94eQDxtcf-uj41zO1j2gA2b4gbphuvPGeECQ5IP2s78Xs64JUOVjHeLIuPP3IZiFlXktr_RgppO6YKqFMqL4FePLGmeCA6_s0_tHm72lraEK9fZz_jPpEf-CV02VK7hf3pHvPSrbefkLurZIrf9rk--Kmaftd-Ax_w56rRW-ZktfIwN7rNvmuOBVQiTrgz9L-Ox8Um1Rz4LKxsEjJeNWpMIYmD6SwkMo5Q6nzKKkYyPon21MUjM9bSKSRmLUELxHJ7TXWIuReYFB1oiwyTz8wYvkLIBe5A4Sf_U6O4hufeW-ruscCIkj6hnusVJ8uvjbm4gvPOd-_Dxyh2f-PbeT2YH6AqlBTYlfaA_RMriEjEsFVjdlblUeUVjlPOs2THHKU4iLQJoryEuPPnpa5tUIEmytpmJ6ysoZw7wRAAnL_N3FV-gzkd8WWz6RnWkuHVTnOXMFQd8RTP726KZ-32GtlGFfJPMiuFh8pJ9IuVAgLphcEMxlXmg7EEbRuDgJ-mujFGQeiiLuKIJjDWztYg8MKm053H3OP1BWqsZ5lz-ftRxvmBno8QCV63Mymj8fPpJ0x0a748HruXKLhRcmwIZ2f2jDLj4l4kN1l7fRR5biH36GFm58CKADj9yFChArGf73cJI0_uBSiuPqA12Qvcqx_HV90_7T7krGgbMYdgR0zn1r3y-RdzOUVuuAzaZoHJaYUpDcq7uY4j5kQrvZfmcUve_brQCJCJzrZNEMclmE7B29NVnCd5J05YeZ3ok9mYrwGe9vPxfURlma9eOhEGFC_5yOGqOL0Xv8x_nQlZi3MTquQbTLOiVV88oNxWWCWaRLHvJOS3A2clwBsTSRu_Y0vBAIZqpmev4Yxs8ZVqvmYGlF2vnO6rnrmcXXtOrQE_M4M2kmtezrayJTzO-1taJ4VvI7fjedmmje6y4Dfadn4eNp2nenmIurbExNfzGH6yzLS-GzYWUKlaNMzrb3XHeb5PR13fdBYxO5ffhPu1dOmnQb5tma_iLjdFQdA8EQT9mxg8zCQacd0Mys44j1EvbhHsq5bD1dkJPixJ2l7-yq-NxJmbyWa8FKxC9htHhAwTuv9RzjAI3CvcOkNuUqTZZ-WLS3lPqIXF66CfyRkESQy9QqFv60NWyQyzeHC-OcUBnHXL-PbaPJ4ZMa20D9X5o4G7h6601z62Bb0LvuEIpX4gX1grTEMRIoMlvMt976DBL74zbC7EjOHD2zqCm3OWCItDcsAoA6JnosiN6jSXQDRRaaubQSpyxGafMjiHd9onNiowFDJ9-LlNGNrHj7-2OIVMZL2AH2ulacn65IkjVSaIw9_4xy_QT9S9sPvGDefEckULrrnR-IDvSqQWIqJbm7M41mXLkxW-TuT35bW0Cte5BKDRJHLOSyEdvdvY_W_tFy-cotHauViGeKxSK_kTExACUlVOzCqfH2iM_5juu5D6ZqXQfV_zJHa5TFCtR4rKUdVe6CKZn1Ef1CWtx_h1x1KFtLsiHOnDGKIPzmoVcp45OCIcHc0BO7_BLulRIZpZVrce_1M37NoJFt91fKq9vyt-44g_aZQ1-YZfVaIkhzq-gc5bTq8f7c8SrBuMZi8TYOViygsHtSxVDsZLXpqe5b_IXVupB-BmmG6zfM1faCFsZaW8Mch9POL_OBwMU7B4nSuvye1Go_nvAoHvfl2VWUgMr70DbtOM68mxA1VPRKC5t2IQX27YQZhrDSZLm48htrKUGCUJ1Z2aR9WasAkrTM82uc7pjqoC7zGPanqFHqKvisUY9FJt0VWawx8lWglXZQHHsDW6rVjR61Ib2FWfBED_pU0slzaCYAiyxKdAWsz2_CxoGizT8g5Wwb22o1ZwuOgNJs-vK8XYuXvLwS7H-0kVXKBHCHoR2HzvygGmPkkDzJrfrU7xss9HuJ5H-RJrZqxf-NimLOZngzbbajb9BspaRpTpQl0navNJVmsLI2XzRpVWlZW-i5VuHCfFD27NEoKjPz0TbcGPgCmEGNuj7u4dKKv4WlZLGo-VOTl-jdU_ZcEF7-oVPYMvjSNhTZwYl9LJ07lqbKzha54NbeKve95stUU8bmaMqwu3WqRIm6abIK_ymyz_B9TjjViK9nShaX4MzKCNjbhY51pzoYksn4jHCY0qT2G9Y3Zz2fVnCMKuMYWJtgA7myY7PPHKrqMNZrtrcoi7vbLdRM70f7hVHzeEzxXdR11pc7QtVuiPYRElvPNFPPEFBnd6O6jgllGi4VHz1WkP9bwUEOzYPqwhBJoMSiRtkjAIw_zsITcdvE1mQlR0lyDRJMOAB4JU7iEg1SoPHcvNfblZaD675BJpVpRFJRN1mF0WyiEIo8p1SbjkHVQlUqtKe84rQ2PkTWCVFxl9RL34cpw2f1Zjuml1XaFgKfVu6KJqdfzsPpGamTtfDm7dhWYIFkR7aW3oYIe15HgKgH1dfdCn0TeX2mS7Q1GO2G5YlRmE8rW-jtcmqTC6wxbuLGuvbBmFy9s1KrY_vCWWpi8CXg2mJzI1b9JHPx1uoPML-T_Qx6thgGBDyFireORH8eHZ8OO2tvMi8FL7brLKq9ku3vmojZeXZYlLoDbXNOIwK4PZ3icYUTcYI1Zk49TiWmM6dzveojd8vzU4fKDefPVuYs78mHHnDbFzzIFxxQkcu9cloe2KsY4rocMjnYZwgwyoVJB3PbF6roeYwVQW72xLZLvKGkEFCWJ1TvaEQ7gGkqI4r3dA4-kmRnTAlsOwSdZXgsegozG2PQ6je5xHcSPoe6DhRN1mhK5fYG_JdjfJ_7-ud-Z66S1eT-q-piG68e_iXLibGFz4Zacd0VV3J7Ua2qx84W_PPB4SdNeBCdb9CovWFm1jXTqoQEaLCG5Y820AS7uoPlIz14Glhqd1dqJnkyDIyQiegrPLoOhWch3-x9fli0MjbPts3t-8ECozbUiiyPYp_ag1ReHElsqPmrAFB1rgUB9JlI05-M4mhByjS1_Cbz5KDrEJD_pPWsIxyIRRsJeeZ4OM_cgbTq7gBlGs4fpGE6IGYg3-VFwcSWiHpvlV8dxv54ihkMFQT5An4MUvT3c5c7V841g9kmHiv2jDIOsFXD9gp3mdjER4lACQuGbU9fwufsnqh_OqGMOlvO3j7uRzNWFKotbGg25fow2gSnY_53BttFDXEteEd7KpbYbneu-2H_rQRhn2iqCc84kIL5jiQTEOtokOIBBa2ae2cs-D8HVjgWNJLqzl5l9WpqUTWdCaRLku9Dfuai1zpc8BJBC83M3k6NA6LlVix3t9cj5GvV7Gl-Pawbv04dPa1t0T0c4Sqo4y92zbKH7viO06f2eAhpbAbCU0xFr__mXKgK2XrSe3lYqM2PwAmPASVdXsBsJvv7_MzGikmZlAK2Ka5vR4ExF4czw4voHc1Gz_n2ifZ-ZlKFbKM63usmLygtqY7EFh1rwJSZrHcGx2y7WcxIeQcj-TmuDoqpodusPzsvGKPo39trRxTn6eNd_e38MOpMST9TKLBhUuo4YEZ3oHSjaRp8LKJn6c5ACzTDQZ8qRUhL6gdv7mEFPi1aSV3S-W5EMX8TSEOhfzCrl_Q9FGiXimJgWRtMMkRGxcH-alG4XZKau9prhYqC7HKb5VNBLx9AazkqAQ1DnqFGd4GXwynZ7W4uADq_RoA3oU7ugBRsVcHx-L62HMOOAaXbzUec0ic6wimUuivbikwYJu2xh2sOjTp5BVQAqFzUu44X1EiiBqRWHYni4cEk8ij95bxtm5CR0py8sFTDP0Fqq-YZ2qKz2wbH_xJei9x7nDqPyaD0Dii61dvQXkjkk4hEHknQjhyDv4fK7XFz0FYLWbL0CNNFgGybaB2VOaFbBPVgmJ4E6BqLwSXMTGWUwx8r6VSZnCYz64_WoGgPmxQCrGQYpZYTW6AXos2Y4mCgMygCWhJNx6kjmlddt6SxSVuueKtfZC06i-c7ikFo3FXG1tbjptSw8ZLmgVoI83_lq3qcoP53dVIYW-FBu2IrpaMCd6X52VPFuHhJbQ3X1tTn3-sqNAouwVrFc2cSlroItE8pXvUZE-MA4wBZ1z4IbZcbN2-_4eS9CD4slUJRrANLw9DwpZJZ7OsoeBSYFJyl8HZk1l3NSCtZMAB1_NP81iZ5vjgkQK3YzVL0zJeuqBTseRoLecpOXF5WgDhWkPTecnftqLuvidg6wMGFKtnXga5kmfPmK4wlqUHPGPRmvCWVYzTT7jLOMWXU3VflRZZmzIw8ekzK849fnYBDwbv-Z2oqXE4aPQK0QCXyG3MOP3BipQWsemCRKEggFPS4D4NTcKQJTt--e-UzL99n3cY9jWQZOeObI9qN_71TOVp5PMfb2t0HBMMJ6LpqTn9qPAQwBGYa39idjSfmMsWwMwkngi2EdFVI39RM58ge2rHMQcFQxlhros4i-d6yRzM8k5MpdlaouP6wUiFgQ5zGm0JU52kCOUjLgiBMjHKd51Qk7z66avbqiozQQJygx9_3oVK321pEArGwD6r0J-BrIbAjafaMlolOnmScnx5S6tOkCUD_9H7TPF4hQ0AB_lfai4qhHP-v-6slqCLjOAfNNfNe-_kgSY_uZF1D6Oqfe5C98Osk_SVGjPla3k6MBtYyLFif7hVKRBEbnN8J750ZzTuzn23111cvrfXixo2qF7qh3PyC0G5bzbXQL6kWsmSKdudaW7Sx4oVTvU2yGMUsukvj8fw_78hIaoywDQKn6OZtXK3dU3s1qVI4BP2EGnYww1OH5gJ6wyzwjS0cMeKnWbYXussiMQftG27yx98JpZgpfEzalhr38q9llAsteZxoKx8fdarqcMNuYbKnTOv6SfA_dTuVh3z6C1Uvr_z0_gwUmUaa_Vq2OdMeUWb0H_qHg6_qJ4VOYhN87E2nyZG2LIckEOsi7NsMeoUxx4-78eqqLi9SplqH2XAKlKSid4xeeT5w9R9aRCTftqSqHJ_kF2O9zzTCI_WNGF_yusdtxDxnYLLqm4IjQesNdRWgn5DCgD8CsjEfbsIi5X1YATgoJA-9genTUw-MxhG6Xytf9B3JbHrh0VPkf5pNQf20OLOHS0ISK9OP0lxrFRAAWkp7D_Z4dH8CrIE-FqcXp0sq7BwR8fEEC31hbr9x4JtOQbFsx63Rha3u9m8MMK3TyE7ya8h2Uu62OzuCRkJ_fRrD879pIvOtQankc4IPOHkkb4uyIlbLJ9AAxxgWe0_EgabuO1gCMRCPnzEaGz_ij3fUqEVjWW1wXVWR9U8dbKsvPWwNEwvcIyqt_Fe31Z3FlTAvx65RZFA_Wbh8mQu4h51usk3AY4FuJiujEePg5sKpVridWmZHKHRZwcD_-4mB5UwoHQqxVTFZF0eqrtOAW0gWoIw8GT-JVzUkGrVCBbzd60rG4Nud2sf512sw1qNdhFeqhOH11bB72--xd99whyw1Q6kz4boNhwiE04rkAtc8DzUs1frWh.gxjema4_JLMBOfM_K5dxH7wjWsghsHRX5716vFZagdQ","tag":"hsm_backup"},{"compact_jwe":"eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoiYmFzZV9lbmNsYXZlX2JhY2t1cCJ9..R3I7fa81q2LbHtBJSeweBg.tCpY2VAY9idq4aeYhHxsoGVW2OyJu7NTtolBYaAIH0l6AWGOHP6kTd0aZxlUzt63n5zYL1kxRxWLTBnUAXLmmOB0f6eKJhc7fJdUe57p8ML4cJKHl2RKQptj_ET9TuNsDYgYmUx6D3u2YVjNFqc1pXUmD7unxtM9yN1TSFv3VcmA4qf5vuOvyCslagtOZsnKaGUzdjYjOQKJGEz2y7YIYXOKG-icgXtgm5f_Qp6HYBeIahn--H8LKnnONkATJtRQAPERYkLKndsZ7RK6aZrqZGnRFoED7MZIhDn3XCJClYgqlzl7kaGBU8eJldjJ25gNr3u21jfMx0C7j6eFZ97y4RaCBFQJmPiQUafBGXH2OLcAKiM9w61ksF587Eup95OKXJ0kHFx8ohViqlbg5UuB8ZcytxvtKzfXnQTBjKfCbbobPdSqk5PDUkBYbyXeRKVW0tDyVEfOajWsXM1uTlYr-D8-Ao1WocOHAbHF3xuuPafsDvIXq7w2N_rBp9vM9jOC0jtLDzWXxYpr21ZcHvhpibB3qwdEMKZ_d75JC9cEf1O9-IMiPTIZckZhtErk5PAR7frXAPA8rkV2mMYIALNY_DB8CpuHGbGxfzpMbggvSTu9KZq_6ahHleHOEjFIW5zbXzw4m9ezLDzPNrsYL1knn-p1OI8Mgsf5fwXYKSmOUExFCuB647vvWavh9ys9aLYXSNojDAljfTkFe9FUUuFKJeyKEykdCKROdveIxjHy8zaAtcAdgUIp0OQVvAN7ugfB8IRP-e5ki5VZm4zWGP2BEVM_vYle2A6TJtH3LPT7MUzTlo1PU1kKTLkgq2Ujx0Devfk-88Z3SlXUekQTnPWIYciacXC1ZmztUAZpa0ki_SqufF3ftd8LQIGwE4zddfmsDzileHZKGvTf-t1KdNoUnBmbqNoBNmDunSnLyAzWEXMzgeHdpl-vKYZSQp9frivDeWfe8lWVbORlbP4q79JCkUdph1rg3iyqtchzLkBx7ZjxbdPFz2E7CPvPaEbrTgz9X4T7uYkRUNkCFJlp_MKE_tKa5spDL-rLvlx2JUwejWPbrEgVD7hqwaVIL5wpg8GJR8xHiyWLo3UqM_SAefez1CCpIEoT0OQ5M_xU9a5jwl0.o-IINHw1WNRAslRFq88iYrYeNebmTa9TkFPuRoKF_eY","tag":"base_enclave_backup"},{"compact_jwe":"eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoia21zcF9lbmNsYXZlX2JhY2t1cCJ9..Wao6CQPawH7YFEwG7e3kNg.3UIhxHamWAKXiAPojW3eqnz58QlJOBoNp2FpusOI4QtzFb2ds43oSV9zCyQjIksFXFJ4CfkkD0AHqAKgkMKgRVwOZOlrE2GdJJEY5o96BU8xHjd_ATZ6vQb2ULER0FqTfvH9NrfV9Hd__YTKMTuQ60NWYkT_TwMLQ_i2D7GwBtKzK7AglEcmS7EznXp4fY6FbQNctd3c4zVYAbx2qnwG1f3L3Z2wddgrIXD2bejnQBbL_uHEbT3_23hYx6EtxDCq4mr35pu1SH41uPigA724mwrSWaDw6GIDypeZssTX6g6Et9drvho9PzYN3mvLiGoOtpOMCuq1rwruBfM2id6G_SQLOWdGsP9gHPK1WAXe47-mjYpdlhbhaMN1UiRAelNETuj_3h9yZ9uhW1noS9WIaOVzLEUpCfrMMYL-gnnLnQvVJHV62FMD8WedRU3zURK47TVqLkscdhblMeBGQhIWDxhAnK3GqANGnY3pgoZzC4Stu_ZcMKkl1VtnvbeFhLLG2zf0T4A35CoYTuwNut-CUKJk9nfgLyavV5RFrX5pRSWyFKGT768FO62hAczBd8UyWpuRo4hYfFc9B8uCJgmIH_JYxQVX028ujGrbm8r5EkMF4s27DYZi0E5B2FFs3K8K2A2q3ItGvJYwdsg5CH7xeazVF6kcMnoSvo3G61ZvYMe8MpCG4zC1zGSx7GJzcFLrPoNqegO8hoZyc2NK75zPEYCuM93q0uCMPa9PnlOWkKg5s_tKMVbA_l0GvxwekxURTJK0Wn4qsGb-tjoyft7t2lspoK2zkXKODaRRV_QxbrbqbQsIzF-r06pzsRQHLFNTxYBA_v2sPAIqdHj0tJKqK7PnW2I7enA4NT3SZ9ZzZGBcrnkty2m_AV2A3VhteFN7_B8UEgaxJzsK5VdBxF-BC4VeJGo1tKqrtZKP_GjBMMLlb6XY8EhKpPOS4kdHBslTWO-cpg8g46qFzfD7j8NHQ1xRBjFfwfr9f0tb8YrCGzOQ5c0B7FALCJNKIFgsrVjYdOd9oYuA5tbZfvRAt2GNY_-THwLr0pYad3cmWMNUPPcwdwr4j6B5BK9jbQ_gtRWFqAwHuBhtBnIij1uPTO46eFkmQvVOQ6vYz3My3WcjNKnyv_WftgGTRHvs9Ey_nQLgebWgTHb7KulV8J7gEY0N8DhouloGUMqliXtn6jaetUeRBahOhTnI1XeZ4fstgilw7vxDxR5u5WpGGAkG2-dso5oN9AUDpxvvXxZWwKH76CoqFjnbHA0WVXyGHD4L6IYkA8dXxgpYm9E98S7b4gi12q0zMeLGf7vKIDmNmjoEVhXKFKPN_34F0LxMMUk_1nA3yqoaWmGzRSVWq--yhkNPzwMH1xX2kCZyoXlgndK8zw5dIpskdlfHnSZb1ZDv6mMhPnIK1hanRYoSsKVmdopEHm87CTUiYErtyOH7fSaijTw3WTRv47mUqGou0WuCHfReUs10V-nRiachIPj-5vSSMKCSpWlqbuCUvD9lvy-ESnlL4O_ZlEQrDg5TSILY5N8Xl9qS4x4DwNCGVbJvI1B_xNBNBfDUfqQvQy7RU7wVaHqKzR23Huy8sAO1WBW0jBumQJ275JGfWSVx-F1a_8HZG0GVKs02IqFt4S9dr0CO5tG2k1NssMukYytbtsqrItlsnTQV7bMHEgZFIbzLjAwyaQc85d0IxlBbbmBYeHdZtnlddtk9Bvy4sjrDgIVeAepuVqF3N6IkquI3U-gjwKAcA3J1RddCDyrLU2ajFF9WaSAnaiNqruGz7YV9H1biidXRbHPhEsE43K2Jh_ic9PhLU3vPWlcQ85uGtkZLQM3emAuG2KGSFA71wZroXhqTHALJ5jKLIaCDewh_LpNLsc3tUKLN04ZV2GH8StYu7ve9A6AySrhTf1JDeyigZz_dSY-Asihk3D1cI3xFhy-Gle3VCvOF1RLQ_dxv65vnWSZGAxtMuqGWeMNuYcOlizeDfg4Un3dO7Uit8ioTxuMV2wrESOUzQu8ioGzO3iWtWYl_2Yt-1uxfUF5LH_D9oik1iA2wDOrvqIzhAs2FjLLBhjKpHqeb82SgbwzRQo2EBfnzrb30V6kON538BdjtBKHoaGIJxKRsgF6sRI1C-nITx5aYyXI0LCSBAEe9yJTZLUWkjOp-_zRJv_GwdNxSZvLHGdpYVOpr11z8U4k8XLMqJtaYp-fMBqXxybLd3qhMd_PvWGMvRGboiwqwrv-ZYplu9cR5kTofiGcR5HZZYxSr3ueUnmzccI2EBMAQjsu2-kaScK2sVjx6zcThu4PPqIzD-Zst9QljjTa-endSY-o-MR1ol7d64xy5bW37CCNprX_FnwwchHB1uGS3KlLwQLdWCe_wOb6743MHqYja16n3uoTdQtMQHRKz7OdiivL1t4bPtUkeQ_fJlDjCn2SDjQzPTYf8JV4xZdLVepA7WCZ4u2YsrPPJRMRuNu3UMYEqb5a_isurIc2MD53aRidyq80R7YdiTH1_hd4_GzDY7uP0jJnuDutICMRBK59jz21Yjrw-rpgg4QkFT6JmBnqRKm-X-XNSC0WKxRFr4fBQKUp7lA_D9HUgsv9OPOQDAyWfU37ckf_XAM4DbaRYNFktI9zu3k8VRMMDOOuROu34XpaSeTiX4gVmtzul93RwvUJe00AOArANwfjJEFGIN_7Vq1eGNhlZS0JFAiv48bsSw0M0tyjfTc-fRk1huQLxp-G9Dr0x4WfZX-zuX3iLyVtlvB34z7yw1I58jISxWLfW3EtyOLhwDJojXLriyN_ZrQCmAKK_g_MShocAK2Z7KL3K-DLl66qKGtpWAdKBg5llY-XQrcZqv0idmiZJwjgi2dX7VefUL6rWxND23NUoU7AEUzjsu8J0qvfd-SxwHzlxZKaJ855ti7SKdT58Tc_LLSxP1WQp2hCNvBv02P6RzUDt-CRIVNYjTc1ZUsRO0rDLS0Df6ldzFVxqZRxzy9iCfas4EVwL5o8XrUnhtzQKjcTcOtn5rZ8y8vbuHFZGrfS3DnozcnsgQzEpXl9_G0FV0DV7lczMiDj95xhwrrmnkmvV8VKY8QSJD3nIX99BgNKZWr6gVZovDv1RjAwbbJRNrrCa-zGrhEoV_JOPdHL-NfSl604NxoGSHGtmzCBRKPb7G5B_XUlPa44FQyx-JM7FiqlN9CyIrJdeTWqkcjQDZOLoC4PPtcvCfWB8Vw7uB7T_nlyziEfOsVGyKUT0a5NoAvFi5RFHOWjX6nBCYFNhxTYUdSDvDTa9iX7VrwsMiTo0lBo2P2oNBx9CC4j3Ui5NW_4x2MuiJHKjswWkgup8qwzry9qaM_H1EuvUeit_OdE3z0Ux7tdOD23IjdUnNvyxdN15Xpe4CiQxbLSnd0OJBzhXvvWfrBUgfkm2F1V75WRxcHx6ak_P1k-hkvFowFfq-eDupE8hs54WFdQAJjXs5w37dYvMQxvYwJkEpL3b7vdDwIYcjFX9Ig-2bIU6I6sJ_ZpbSN6Zcln2hNmnX4ZeY4uPE01URe6m7Gm9AfpE2aKiO1-iVnzJGA8IJPxu5ztZLmYCOho96NtWUsGQ80JSnh0YuD-8YrXfZpKJ2fDaO86x5Pt5cyQRXsxte0OR8F07yNmgrSHgcF0BFLn_wlWlbTwkbDy5edaqeE0WYtF52yuf7u2voexYrA.DUHtrC2MbUXTgNWM6YvZi2GHVJLzrlcgUUqvEpk6JBc","tag":"kmsp_enclave_backup"}],"kdf":"sp108_kdf"},"SharedKeys":{"enc_shares":[{"enc_key":"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoibm90IHVzZWQifQ.M-AxGQYJ6UCCLmeXp9gSR2EU1lnKLEq2f1VwMnOJWiaLDbHgMl_m-FVu_Xl4GMs36ONza1IgqD3_ZChxvbTK4mobgs9rC0VGKXx7G7qdm7Ml8ETfBjjLMYwdIQyGryTDYWXenTtAZqZI6w56fa_TD2hsz3FCcd-PftLXfm8h1LhYGeY_QYj30OyXeWoEgVgw6-CguDia5GqZ8HJ_9KFxeVOB_sBKuB7VZgiF3y-UdCQMWBRJHHMNfMk4A5umO5iaQo1U7zCzDCTjhv0U_U9SfNtqEPWdlVqjv0uzZ5rNIGqB24pNMOEyuO2H6VN-tGLd_ZK6SGRcOsOAVYek3uZ6rz8bzAYEUX-yW4PTQevR86ZRsspHutcbWZ6-2HnXQ_TQ0I4S-q2HUET4A5Ai6s-MBAKx49xUxsUCRlPLqgPe0DDeh2f9UiBtFC-ik08epXklGVrjUaW-56EE5oTwYcumZM3-gPwOWrT7YnE8VwpoxKugpnkMX4CIejNY9BG5epl_sE_-4i1diijkt4zQKC4uS9hC1tRuW_anpdpiwuXPUNidM_eiX5QUeMOnzqQc-kqrgQGWTaZzKirdcP8zlO7XBvVimQsewuUIfu_EZLCMtYWKdEKNNJo_KM0ynojgN3rlbkSyedSpN0UugN7Owz6bfW3lR4wJj8NrZ4o39r0KT8Y.vcaaqCdL3E6Sl2FJUxVMuQ.mqSktigzXnFiNHhQ0WCTaxKA81XZZESP8Bsn2XSHYsFzN9vNtqQ7Nvwb7DR-JrsiTQElYoCRjqrzfBBnDl-Uwh9A-KjpsPRJqtGwgRYooFU.ymNm5QZRqygZv7hCWfABi4_JDr6vgP5QMBjh0GvX9L8","x5t_256":"787v1DtWq49M7o0zvTQnjtWx3vcSslYg0qbz1vRTkO4"},{"enc_key":"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoibm90IHVzZWQifQ.guAbxgNRcCqrM9AwNrD9dvVqAqF0IEnR0SmfFGT7OhiP8YuUJlWv9Ku2eokNF-VkmFnfG_1iHUVhaLM4Cw_DAF45bum2PBsojpF1cQML2OGsrgLgdml1cmlJJixwPi6coSU810aku7ijUUSLCJiRhroBzfVmOKIjCGnheDr_iuWp7SZRDlz63hS2Thumvt--SW56LlRxzKzRZxYb9G-Y0oaqxRHl18KIjz0fMxK0KdN2NKA7Vh6DRyQGpoEAYN4mbLIl80op9VQBPMnTMJFtGcZPWBo6UCBOGE3zye2Da2jFgLkg9_qE_51v8DieeBXcaFLYsWyqm6Q-rgs1q6Z3VKDfCN4SC6YoHPlwLB2B092Cw3d3I0VnvyKSvwf0Gm5osPomnmR7CWkm2HeT0AIlRhPn5cUuOvcWPa4QmlGrDnlgdS9TjJgcTXPtEKSicZkXtXmuKMPuMncRTSNTr4XfwiBm4Am22JwQm7LOKS9_g16-C01SpXyP4-6FRWsY1g30UcfLOKZcEemQ5RTdCZBQSwP16DgNO-yn3bSQYvdaTbnjWJUJ12Mji1s0rLLt1d8NFm-WEUWuAYwPybRKkbAEwEj4t28rFfGhVAvg4Gz-Hxw8qK-HnJCpYQmMqjOHiiCu9cUQF2ypfLlDUORRZXwPhnw95CVWrOrhVXCHUi9mL-w.ytUR25RV89XScGRmIo71lA._SXk5o1yZWivNMleHb_9gmMyfn66pLWr-LamVtVhc4qYfX5DQbJ1hjUWbempvQshGULj_O12JJmOmnVKDf0GNEnrF9IEFTio2Og-SxsJu44.f-FySaX4czgHc9_xZjP2xGbl9xnto30M057VtBhsk-I","x5t_256":"nhGiWZ3sDugAKZNnpU4f90wXlZQM03GV6PfsbNLs8No"},{"enc_key":"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoibm90IHVzZWQifQ.etZu2czOsU0AedQIggjll4VHZN4HYWsQidoDuLtUYR2U1ZpKStXJ5-R7nRmLvMTIVUCJVqM2NFq60zr6LeG5UsOcFFj_LC822Tr0BIkPZftVgX3RrGNbsrcJXkqqo_kNV437N_5VX0TNetVTFMwD38CqW_J-BE0wRJCmEMY8BZorDNsGNNuaRX5l7hwCQ_Tm7SJEXe4dujRWTEDYs9uwLzX1pZeqTEkC_e9tMWuCfCfZ8CRrCnhCz2zbvmD1JWZUYQsnwkr5-lmft0RoTs1vpePlkHv9wRJebJwSoJQbcCrO2RQDOhwPB6GWnMVM65Zu91XyWtP4WcPqojNpt6GHFOva3_tShmKWtX5xa3GsQEIi3BI7F9WL4Bu6HjrQd05cpvUro4_hTyDbYKDOH94YOV-jQx5J_QQrVVrClRYwF4f33pR-O2Inxu7U3dbM-QP49KaJ7ch82Jf94qccttbhTjq4nSw5MWecnCPf4HkRcul9DkIdEpcDH2dZUqdWBGb1nEcevW440TlRn6G0TxjK0Z_gizLxuulfIOQ12HJMvPcYww9_-1gFegTt83osy8BfV3p407xZWETNPTyecL55vztJR2cR6KZdeNGl6ZD5806eOc9ZPb0KQgob72DU3Nf82bt3upPt-q0hSng3HXzTeHVbQQWMMZlApCvhwiZitHg.cg4wkrCJuc5AnbZciPYXCQ.X9mGsD1ubRSIES0brRb9hPSLZckShcdnkAG1711irzfriD1fpKZgkTpC6_CgZNpbSbGOzlA6dgjQyzq3GE7RFkC1G8xqoCdO1MZu1ElC7W0.4uFEtARRKsTwqYKcD4S6mGCbMfhqyOqwUGtZO1kX4Lc","x5t_256":"wd9ErZhXQZixpwM6O-EB9cKAiAiS7aWgRGdAkM1M270"}],"key_algorithm":"shamir_share","required":2},"version":2}" + }, + "api-version": "7.5" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Retry-After": 5, + "Azure-AsyncOperation": "https://myvault.vault.azure.net/securitydomain/upload/pending" + }, + "body": { + "status": "InProgress", + "status_details": "" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/setStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/setStorageAccount.json new file mode 100644 index 000000000000..eb399c945acd --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/setStorageAccount.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "setStrg01", + "api-version": "7.5", + "parameters": { + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName": "key2", + "autoRegenerateKey": true, + "regenerationPeriod": "P15D", + "attributes": { + "enabled": true + }, + "tags": { + "tag1": "val1", + "tag2": "val2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/setStrg01", + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName": "key2", + "autoRegenerateKey": true, + "regenerationPeriod": "P15D", + "attributes": { + "enabled": true, + "created": 1490738386, + "updated": 1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "tag1": "val1", + "tag2": "val2" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/setStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/setStorageSasDefinition.json new file mode 100644 index 000000000000..049d3ac88208 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/setStorageSasDefinition.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "setsas01", + "sas-definition-name": "setStrgSasDef01", + "api-version": "7.5", + "parameters": { + "templateUri": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED", + "sasType": "service", + "validityPeriod": "P15D", + "attributes": { + "enabled": true + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/setsas01/sas/setStrgSasDef01", + "sid": "https://myvault.vault.azure.net/secrets/setsas01-setStrgSasDef01", + "templateUri": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED", + "sasType": "service", + "validityPeriod": "P15D", + "attributes": { + "enabled": true, + "created": 1490738438, + "updated": 1490738438, + "recoveryLevel": "Recoverable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/sign-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/sign-example.json new file mode 100644 index 000000000000..505bbd061958 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/sign-example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "testkey", + "key-version": "9885aa558e8d448789683188f8c194b0", + "api-version": "7.5", + "parameters": { + "alg": "RS512", + "value": "RUE3Nzg4NTQ4QjQ5RjFFN0U2NzAyQzhDNEMwMkJDOTA1MTYyOTUzNjI5NDhBNzZDQTlFOTM1NDA2M0ZGMjk2Mg" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://myvault.vault.azure.net/keys/testkey/9885aa558e8d448789683188f8c194b0", + "value": "aKFG8NXcfTzqyR44rW42484K_zZI_T7zZuebvWuNgAoEI1gXYmxrshp42CunSmmu4oqo4-IrCikPkNIBkHXnAW2cv03Ad0UpwXhVfepK8zzDBaJPMKVGS-ZRz8CshEyGDKaLlb3J3zEkXpM3RrSEr0mdV6hndHD_mznLB5RmFui5DsKAhez4vUqajgtkgcPfCekMqeSwp6r9ItVL-gEoAohx8XMDsPedqu-7BuZcBcdayaPuBRL4wWoTDULA11P-UN_sJ5qMj3BbiRYhIlBWGR04wIGfZ3pkJjHJUpOvgH2QajdYPzUBauOCewMYbq9XkLRSzI_A7HkkDVycugSeAA" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/unwrapKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/unwrapKey-example.json new file mode 100644 index 000000000000..4f936f750cf7 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/unwrapKey-example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "sdktestkey", + "key-version": "0698c2156c1a4e1da5b6bab6f6422fd6", + "api-version": "7.5", + "parameters": { + "alg": "RSA1_5", + "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6", + "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/updateStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/updateStorageAccount.json new file mode 100644 index 000000000000..5a68d162b70c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/updateStorageAccount.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "patchStrg01", + "api-version": "7.5", + "parameters": { + "activeKeyName": "key1", + "regenerationPeriod": "P10D" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/patchStrg01", + "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName": "key1", + "autoRegenerateKey": true, + "regenerationPeriod": "P10D", + "attributes": { + "enabled": true, + "created": 1490738386, + "updated": 1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "tag1": "val1", + "tag2": "val2" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/updateStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/updateStorageSasDefinition.json new file mode 100644 index 000000000000..96a1ba8c2d3b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/updateStorageSasDefinition.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "storage-account-name": "patchsas01", + "sas-definition-name": "patchStrgSasDef01", + "api-version": "7.5", + "parameters": { + "templateUri": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED", + "sasType": "service", + "validityPeriod": "P15D", + "attributes": { + "enabled": true + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "https://myvault.vault.azure.net/storage/patchsas01/sas/patchStrgSasDef01", + "sid": "https://myvault.vault.azure.net/secrets/patchsas01-patchStrgSasDef01", + "templateUri": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED", + "sasType": "service", + "validityPeriod": "P15D", + "attributes": { + "enabled": true, + "created": 1490738438, + "updated": 1490738438, + "recoveryLevel": "Recoverable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/verify-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/verify-example.json new file mode 100644 index 000000000000..7e263ed48554 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/verify-example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "testkey", + "key-version": "9885aa558e8d448789683188f8c194b0", + "api-version": "7.5", + "parameters": { + "alg": "RS512", + "value": "RUE3Nzg4NTQ4QjQ5RjFFN0U2NzAyQzhDNEMwMkJDOTA1MTYyOTUzNjI5NDhBNzZDQTlFOTM1NDA2M0ZGMjk2Mg", + "digest": "aKFG8NXcfTzqyR44rW42484K_zZI_T7zZuebvWuNgAoEI1gXYmxrshp42CunSmmu4oqo4-IrCikPkNIBkHXnAW2cv03Ad0UpwXhVfepK8zzDBaJPMKVGS-ZRz8CshEyGDKaLlb3J3zEkXpM3RrSEr0mdV6hndHD_mznLB5RmFui5DsKAhez4vUqajgtkgcPfCekMqeSwp6r9ItVL-gEoAohx8XMDsPedqu-7BuZcBcdayaPuBRL4wWoTDULA11P-UN_sJ5qMj3BbiRYhIlBWGR04wIGfZ3pkJjHJUpOvgH2QajdYPzUBauOCewMYbq9XkLRSzI_A7HkkDVycugSeAA" + } + }, + "responses": { + "200": { + "body": { + "value": true + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/wrapKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/wrapKey-example.json new file mode 100644 index 000000000000..04ca3067eb0f --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/wrapKey-example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "sdktestkey", + "key-version": "0698c2156c1a4e1da5b6bab6f6422fd6", + "api-version": "7.5", + "parameters": { + "alg": "RSA1_5", + "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6", + "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/index.md b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/index.md new file mode 100644 index 000000000000..1d8c9d77ab0e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/index.md @@ -0,0 +1,26 @@ +--- +ms.assetid: 357c9947-1098-4a03-9f1e-7b27e5aa75bf +ms.title: Azure Key Vault REST Reference +ms.prod: +ms.service: azure-keyvault +author: BrucePerlerMS +ms.author: bruceper +ms.manager: mbaldwin +--- + +# Azure Key Vault + +Azure Key Vault enables users to store and use cryptographic keys within the Microsoft Azure environment. Azure Key Vault supports multiple key types and algorithms, and enables the use of Hardware Security Modules (HSM) for high value customer keys. Key Vault also supports storage of secrets, limited size octet objects. Certificate management is also available through Key Vault including support for renewal processing and working with a range of certificate authorities. + +## REST Operation Groups + +| Operation Group | Description | +|-----------------|-------------| +|Keys | Operations for interacting with keys including create, import, update, and delete.| +|Secrets | Operations for interacting with secrets including create, update, and delete.| +|Certificates | Operations for interacting with certificates including create, import, update, delete and a set of contact and renewal management tasks.| +|Storage | Operations for interacting with storage accounts including create, read, update, delete, list, regeneratekey and a set of sas definition related tasks.| + +## See Also + +- [About keys, secrets, certificates and storage](link) diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/keys.json new file mode 100644 index 000000000000..7357164103cf --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/keys.json @@ -0,0 +1,2257 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultClient", + "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", + "version": "7.5" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{vaultBaseUrl}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "vaultBaseUrl", + "description": "The vault name, for example https://myvault.vault.azure.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/keys/{key-name}/create": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "CreateKey", + "summary": "Creates a new key, stores it, then returns key parameters and attributes to the client.", + "description": "The create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z-]+$", + "description": "The name for the new key. The system will generate the version name for the new key. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyCreateParameters" + }, + "description": "The parameters to create a key." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A key bundle containing the result of the create key request.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Create key": { + "$ref": "./examples/CreateKey-example.json" + } + } + } + }, + "/keys/{key-name}/rotate": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "RotateKey", + "summary": "Creates a new key version, stores it, then returns key parameters, attributes and policy to the client.", + "description": "The operation will rotate the key based on the key policy. It requires the keys/rotate permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z-]+$", + "description": "The name of key to be rotated. The system will generate a new version in the specified key." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A key bundle containing the result of the rotate key request.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Rotate key": { + "$ref": "./examples/RotateKey-example.json" + } + } + } + }, + "/keys/{key-name}": { + "put": { + "tags": [ + "Keys" + ], + "operationId": "ImportKey", + "summary": "Imports an externally created key, stores it, and returns key parameters and attributes to the client.", + "description": "The import key operation may be used to import any key type into an Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z-]+$", + "description": "Name for the imported key. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyImportParameters" + }, + "description": "The parameters to import a key." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Imported key bundle to the vault.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Import key": { + "$ref": "./examples/ImportKey-example.json" + } + } + }, + "delete": { + "tags": [ + "Keys" + ], + "operationId": "DeleteKey", + "summary": "Deletes a key of any type from storage in Azure Key Vault.", + "description": "The delete key operation cannot be used to remove individual versions of a key. This operation removes the cryptographic material associated with the key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or Encrypt/Decrypt operations. This operation requires the keys/delete permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key to delete." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The public part of the deleted key and deletion information on when the key will be purged.", + "schema": { + "$ref": "#/definitions/DeletedKeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Delete key": { + "$ref": "./examples/DeleteKey-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}": { + "patch": { + "tags": [ + "Keys" + ], + "operationId": "UpdateKey", + "summary": "The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.", + "description": "In order to perform this operation, the key must already exist in the Key Vault. Note: The cryptographic material of a key itself cannot be changed. This operation requires the keys/update permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of key to update." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key to update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyUpdateParameters" + }, + "description": "The parameters of the key to update." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The updated key.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Update key": { + "$ref": "./examples/UpdateKey-example.json" + } + } + }, + "get": { + "tags": [ + "Keys" + ], + "operationId": "GetKey", + "summary": "Gets the public part of a stored key.", + "description": "The get key operation is applicable to all key types. If the requested key is symmetric, then no key material is released in the response. This operation requires the keys/get permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key to get." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "Adding the version parameter retrieves a specific version of a key. This URI fragment is optional. If not specified, the latest version of the key is returned." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A key bundle containing the key and its attributes.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Get key": { + "$ref": "./examples/GetKey-example.json" + } + } + } + }, + "/keys/{key-name}/versions": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "GetKeyVersions", + "summary": "Retrieves a list of individual key versions with the same key name.", + "description": "The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of keys along with a link to the next page of keys.", + "schema": { + "$ref": "#/definitions/KeyListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetKeyVersions": { + "$ref": "./examples/GetKeyVersions-example.json" + } + } + } + }, + "/keys": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "GetKeys", + "summary": "List keys in the specified vault.", + "description": "Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of keys in the vault along with a link to the next page of keys.", + "schema": { + "$ref": "#/definitions/KeyListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetKeys": { + "$ref": "./examples/GetKeys-example.json" + } + } + } + }, + "/keys/{key-name}/backup": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "BackupKey", + "summary": "Requests that a backup of the specified key be downloaded to the client.", + "description": "The Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does NOT return key material in a form that can be used outside the Azure Key Vault system, the returned key material is either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another Azure Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation requires the key/backup permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The backup blob containing the backed up key.", + "schema": { + "$ref": "#/definitions/BackupKeyResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "BackupKey": { + "$ref": "./examples/BackupKey-example.json" + } + } + } + }, + "/keys/restore": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "RestoreKey", + "summary": "Restores a backed up key to a vault.", + "description": "Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyRestoreParameters" + }, + "description": "The parameters to restore the key." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Restored key bundle in the vault.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RestoreKey": { + "$ref": "./examples/RestoreKey-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/encrypt": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "encrypt", + "summary": "Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.", + "description": "The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyOperationsParameters" + }, + "description": "The parameters for the encryption operation." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The encryption result.", + "schema": { + "$ref": "#/definitions/KeyOperationResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Encrypt example": { + "$ref": "./examples/encrypt-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/decrypt": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "decrypt", + "summary": "Decrypts a single block of encrypted data.", + "description": "The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/decrypt permission. Microsoft recommends not to use CBC algorithms for decryption without first ensuring the integrity of the ciphertext using an HMAC, for example. See https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode for more information.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyOperationsParameters" + }, + "description": "The parameters for the decryption operation." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The decryption result.", + "schema": { + "$ref": "#/definitions/KeyOperationResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Decrypt example": { + "$ref": "./examples/decrypt-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/sign": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "sign", + "summary": "Creates a signature from a digest using the specified key.", + "description": "The SIGN operation is applicable to asymmetric and symmetric keys stored in Azure Key Vault since this operation uses the private portion of the key. This operation requires the keys/sign permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeySignParameters" + }, + "description": "The parameters for the signing operation." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The signature value.", + "schema": { + "$ref": "#/definitions/KeyOperationResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Sign": { + "$ref": "./examples/sign-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/verify": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "verify", + "summary": "Verifies a signature using a specified key.", + "description": "The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyVerifyParameters" + }, + "description": "The parameters for verify operations." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The verification result.", + "schema": { + "$ref": "#/definitions/KeyVerifyResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Verify": { + "$ref": "./examples/verify-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/wrapkey": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "wrapKey", + "summary": "Wraps a symmetric key using a specified key.", + "description": "The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/wrapKey permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyOperationsParameters" + }, + "description": "The parameters for wrap operation." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The wrapped symmetric key.", + "schema": { + "$ref": "#/definitions/KeyOperationResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Wrapkey": { + "$ref": "./examples/wrapKey-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/unwrapkey": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "unwrapKey", + "summary": "Unwraps a symmetric key using the specified key that was initially used for wrapping that key.", + "description": "The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyOperationsParameters" + }, + "description": "The parameters for the key operation." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The unwrapped symmetric key.", + "schema": { + "$ref": "#/definitions/KeyOperationResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Unwrapkey": { + "$ref": "./examples/unwrapKey-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/release": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "release", + "summary": "Releases a key.", + "description": "The release key operation is applicable to all key types. The target key must be marked exportable. This operation requires the keys/release permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key to get." + }, + { + "name": "key-version", + "required": true, + "in": "path", + "type": "string", + "description": "Adding the version parameter retrieves a specific version of a key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyReleaseParameters" + }, + "description": "The parameters for the key release operation." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A JWS containing the key, its attributes, the result of the key release, and information about the request.", + "schema": { + "$ref": "#/definitions/KeyReleaseResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Release": { + "$ref": "./examples/release-example.json" + } + } + } + }, + "/deletedkeys": { + "get": { + "tags": [ + "DeletedKeys" + ], + "operationId": "GetDeletedKeys", + "summary": "Lists the deleted keys in the specified vault.", + "description": "Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of deleted keys in the vault along with a link to the next page of deleted keys.", + "schema": { + "$ref": "#/definitions/DeletedKeyListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetDeletedKeys": { + "$ref": "./examples/GetDeletedKeys-example.json" + } + } + } + }, + "/deletedkeys/{key-name}": { + "get": { + "tags": [ + "DeletedKeys" + ], + "operationId": "GetDeletedKey", + "summary": "Gets the public part of a deleted key.", + "description": "The Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/get permission. ", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion information.", + "schema": { + "$ref": "#/definitions/DeletedKeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetDeletedKey": { + "$ref": "./examples/GetDeletedKey-example.json" + } + } + }, + "delete": { + "tags": [ + "DeletedKeys" + ], + "operationId": "PurgeDeletedKey", + "summary": "Permanently deletes the specified key.", + "description": "The Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/purge permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No content, signaling that the key was permanently purged." + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "PurgeDeletedKey": { + "$ref": "./examples/PurgeDeletedKey-example.json" + } + } + } + }, + "/deletedkeys/{key-name}/recover": { + "post": { + "tags": [ + "DeletedKeys" + ], + "operationId": "RecoverDeletedKey", + "summary": "Recovers the deleted key to its latest version.", + "description": "The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error. Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deleted key." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A Key bundle of the original key and its attributes", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RecoverDeletedKey": { + "$ref": "./examples/RecoverDeletedKey-example.json" + } + } + } + }, + "/keys/{key-name}/rotationpolicy": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "GetKeyRotationPolicy", + "summary": "Lists the policy for a key.", + "description": "The GetKeyRotationPolicy operation returns the specified key policy resources in the specified key vault. This operation requires the keys/get permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key in a given key vault." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The key rotation policy.", + "schema": { + "$ref": "#/definitions/KeyRotationPolicy" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetKeyRotationPolicy": { + "$ref": "./examples/GetKeyRotationPolicy-example.json" + } + } + }, + "put": { + "tags": [ + "Keys" + ], + "operationId": "UpdateKeyRotationPolicy", + "summary": "Updates the rotation policy for a key.", + "description": "Set specified members in the key policy. Leave others as undefined. This operation requires the keys/update permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key in the given vault." + }, + { + "name": "keyRotationPolicy", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KeyRotationPolicy" + }, + "description": "The policy for the key." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The policy for the key.", + "schema": { + "$ref": "#/definitions/KeyRotationPolicy" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "UpdateKeyRotationPolicy": { + "$ref": "./examples/UpdateKeyRotationPolicy-example.json" + } + } + } + }, + "/rng": { + "post": { + "tags": [ + "RNG" + ], + "operationId": "GetRandomBytes", + "summary": "Get the requested number of bytes containing random values.", + "description": "Get the requested number of bytes containing random values from a managed HSM.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/GetRandomBytesRequest" + }, + "description": "The request object to get random bytes." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The bytes encoded as a base64url string.", + "schema": { + "$ref": "#/definitions/RandomBytes" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetRandomBytes": { + "$ref": "./examples/GetRandomBytes-example.json" + } + } + } + } + }, + "definitions": { + "GetRandomBytesRequest": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 128, + "description": "The requested number of random bytes." + } + }, + "description": "The get random bytes request object.", + "required": [ + "count" + ] + }, + "RandomBytes": { + "properties": { + "value": { + "type": "string", + "format": "base64url", + "description": "The bytes encoded as a base64url string." + } + }, + "required": [ + "value" + ], + "description": "The get random bytes response object containing the bytes." + }, + "KeyReleasePolicy": { + "properties": { + "contentType": { + "description": "Content type and version of key release policy", + "type": "string", + "default": "application/json; charset=utf-8" + }, + "immutable": { + "description": "Defines the mutability state of the policy. Once marked immutable, this flag cannot be reset and the policy cannot be changed under any circumstances.", + "type": "boolean" + }, + "data": { + "description": "Blob encoding the policy rules under which the key can be released. Blob must be base64 URL encoded.", + "type": "string", + "format": "base64url", + "x-ms-client-name": "encodedPolicy" + } + }, + "description": "The policy rules under which the key can be exported." + }, + "JsonWebKey": { + "properties": { + "kid": { + "type": "string", + "description": "Key identifier." + }, + "kty": { + "type": "string", + "description": "JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.", + "enum": [ + "EC", + "EC-HSM", + "RSA", + "RSA-HSM", + "oct", + "oct-HSM" + ], + "x-ms-enum": { + "name": "JsonWebKeyType", + "modelAsString": true, + "values": [ + { + "value": "EC", + "description": "Elliptic Curve." + }, + { + "value": "EC-HSM", + "description": "Elliptic Curve with a private key which is stored in the HSM." + }, + { + "value": "RSA", + "description": "RSA (https://tools.ietf.org/html/rfc3447)" + }, + { + "value": "RSA-HSM", + "description": "RSA with a private key which is stored in the HSM." + }, + { + "value": "oct", + "description": "Octet sequence (used to represent symmetric keys)" + }, + { + "value": "oct-HSM", + "description": "Octet sequence (used to represent symmetric keys) which is stored the HSM." + } + ] + } + }, + "key_ops": { + "type": "array", + "items": { + "type": "string", + "description": "Supported key operations." + } + }, + "n": { + "type": "string", + "format": "base64url", + "description": "RSA modulus." + }, + "e": { + "type": "string", + "format": "base64url", + "description": "RSA public exponent." + }, + "d": { + "type": "string", + "format": "base64url", + "description": "RSA private exponent, or the D component of an EC private key." + }, + "dp": { + "x-ms-client-name": "DP", + "type": "string", + "format": "base64url", + "description": "RSA private key parameter." + }, + "dq": { + "x-ms-client-name": "DQ", + "type": "string", + "format": "base64url", + "description": "RSA private key parameter." + }, + "qi": { + "x-ms-client-name": "QI", + "type": "string", + "format": "base64url", + "description": "RSA private key parameter." + }, + "p": { + "type": "string", + "format": "base64url", + "description": "RSA secret prime." + }, + "q": { + "type": "string", + "format": "base64url", + "description": "RSA secret prime, with p < q." + }, + "k": { + "type": "string", + "format": "base64url", + "description": "Symmetric key." + }, + "key_hsm": { + "x-ms-client-name": "t", + "type": "string", + "format": "base64url", + "description": "Protected Key, used with 'Bring Your Own Key'." + }, + "crv": { + "type": "string", + "description": "Elliptic curve name. For valid values, see JsonWebKeyCurveName.", + "enum": [ + "P-256", + "P-384", + "P-521", + "P-256K" + ], + "x-ms-enum": { + "name": "JsonWebKeyCurveName", + "modelAsString": true, + "values": [ + { + "value": "P-256", + "description": "The NIST P-256 elliptic curve, AKA SECG curve SECP256R1." + }, + { + "value": "P-384", + "description": "The NIST P-384 elliptic curve, AKA SECG curve SECP384R1." + }, + { + "value": "P-521", + "description": "The NIST P-521 elliptic curve, AKA SECG curve SECP521R1." + }, + { + "value": "P-256K", + "description": "The SECG SECP256K1 elliptic curve." + } + ] + } + }, + "x": { + "type": "string", + "format": "base64url", + "description": "X component of an EC public key." + }, + "y": { + "type": "string", + "format": "base64url", + "description": "Y component of an EC public key." + } + }, + "description": "As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18" + }, + "KeyAttributes": { + "allOf": [ + { + "$ref": "common.json#/definitions/Attributes" + } + ], + "properties": { + "recoverableDays": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0." + }, + "recoveryLevel": { + "type": "string", + "description": "Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval.", + "enum": [ + "Purgeable", + "Recoverable+Purgeable", + "Recoverable", + "Recoverable+ProtectedSubscription", + "CustomizedRecoverable+Purgeable", + "CustomizedRecoverable", + "CustomizedRecoverable+ProtectedSubscription" + ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] + }, + "readOnly": true, + "x-nullable": false + }, + "exportable": { + "type": "boolean", + "description": "Indicates if the private key can be exported. Release policy must be provided when creating the first version of an exportable key." + }, + "hsmPlatform": { + "type": "string", + "description": "The underlying HSM Platform.", + "readOnly": true + } + }, + "description": "The attributes of a key managed by the key vault service." + }, + "KeyBundle": { + "properties": { + "key": { + "$ref": "#/definitions/JsonWebKey", + "description": "The Json web key." + }, + "attributes": { + "$ref": "#/definitions/KeyAttributes", + "description": "The key management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "managed": { + "type": "boolean", + "readOnly": true, + "description": "True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true." + }, + "release_policy": { + "$ref": "#/definitions/KeyReleasePolicy", + "x-nullable": true, + "description": "The policy rules under which the key can be exported." + } + }, + "description": "A KeyBundle consisting of a WebKey plus its attributes." + }, + "KeyItem": { + "properties": { + "kid": { + "type": "string", + "description": "Key identifier." + }, + "attributes": { + "$ref": "#/definitions/KeyAttributes", + "description": "The key management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "managed": { + "type": "boolean", + "readOnly": true, + "description": "True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true." + } + }, + "description": "The key item containing key metadata." + }, + "DeletedKeyBundle": { + "allOf": [ + { + "$ref": "#/definitions/KeyBundle" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted key." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the key is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the key was deleted, in UTC" + } + }, + "description": "A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion info" + }, + "DeletedKeyItem": { + "allOf": [ + { + "$ref": "#/definitions/KeyItem" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted key." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the key is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the key was deleted, in UTC" + } + }, + "description": "The deleted key item containing the deleted key metadata and information about deletion." + }, + "KeyProperties": { + "properties": { + "exportable": { + "type": "boolean", + "description": "Indicates if the private key can be exported. Release policy must be provided when creating the first version of an exportable key." + }, + "kty": { + "x-ms-client-name": "keyType", + "type": "string", + "description": "The type of key pair to be used for the certificate.", + "enum": [ + "EC", + "EC-HSM", + "RSA", + "RSA-HSM", + "oct", + "oct-HSM" + ], + "x-ms-enum": { + "name": "JsonWebKeyType", + "modelAsString": true + } + }, + "key_size": { + "type": "integer", + "format": "int32", + "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." + }, + "reuse_key": { + "type": "boolean", + "description": "Indicates if the same key pair will be used on certificate renewal." + }, + "crv": { + "x-ms-client-name": "curve", + "type": "string", + "description": "Elliptic curve name. For valid values, see JsonWebKeyCurveName.", + "enum": [ + "P-256", + "P-384", + "P-521", + "P-256K" + ], + "x-ms-enum": { + "name": "JsonWebKeyCurveName", + "modelAsString": true + } + } + }, + "description": "Properties of the key pair backing a certificate." + }, + "KeyCreateParameters": { + "properties": { + "kty": { + "type": "string", + "minLength": 1, + "description": "The type of key to create. For valid values, see JsonWebKeyType.", + "enum": [ + "EC", + "EC-HSM", + "RSA", + "RSA-HSM", + "oct", + "oct-HSM" + ], + "x-ms-enum": { + "name": "JsonWebKeyType", + "modelAsString": true + } + }, + "key_size": { + "type": "integer", + "format": "int32", + "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." + }, + "public_exponent": { + "type": "integer", + "format": "int32", + "description": "The public exponent for a RSA key." + }, + "key_ops": { + "type": "array", + "items": { + "type": "string", + "description": "JSON web key operations. For more information, see JsonWebKeyOperation.", + "enum": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey", + "import", + "export" + ], + "x-ms-enum": { + "name": "JsonWebKeyOperation", + "modelAsString": true + } + } + }, + "attributes": { + "x-ms-client-name": "keyAttributes", + "$ref": "#/definitions/KeyAttributes" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "crv": { + "x-ms-client-name": "curve", + "type": "string", + "description": "Elliptic curve name. For valid values, see JsonWebKeyCurveName.", + "enum": [ + "P-256", + "P-384", + "P-521", + "P-256K" + ], + "x-ms-enum": { + "name": "JsonWebKeyCurveName", + "modelAsString": true + } + }, + "release_policy": { + "$ref": "#/definitions/KeyReleasePolicy", + "x-nullable": true, + "description": "The policy rules under which the key can be exported." + } + }, + "description": "The key create parameters.", + "required": [ + "kty" + ] + }, + "KeyImportParameters": { + "properties": { + "Hsm": { + "type": "boolean", + "description": "Whether to import as a hardware key (HSM) or software key." + }, + "key": { + "$ref": "#/definitions/JsonWebKey", + "description": "The Json web key" + }, + "attributes": { + "x-ms-client-name": "keyAttributes", + "$ref": "#/definitions/KeyAttributes", + "description": "The key management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "release_policy": { + "$ref": "#/definitions/KeyReleasePolicy", + "x-nullable": true, + "description": "The policy rules under which the key can be exported." + } + }, + "description": "The key import parameters.", + "required": [ + "key" + ] + }, + "KeyExportParameters": { + "properties": { + "wrappingKey": { + "$ref": "#/definitions/JsonWebKey", + "description": "The export key encryption Json web key. This key MUST be a RSA key that supports encryption." + }, + "wrappingKid": { + "type": "string", + "description": "The export key encryption key identifier. This key MUST be a RSA key that supports encryption." + }, + "enc": { + "type": "string", + "minLength": 1, + "description": "The encryption algorithm to use to protected the exported key material", + "enum": [ + "CKM_RSA_AES_KEY_WRAP", + "RSA_AES_KEY_WRAP_256", + "RSA_AES_KEY_WRAP_384" + ], + "x-ms-enum": { + "name": "KeyEncryptionAlgorithm", + "modelAsString": true + } + } + }, + "description": "The export key parameters." + }, + "KeyReleaseParameters": { + "properties": { + "target": { + "type": "string", + "minLength": 1, + "description": "The attestation assertion for the target of the key release.", + "x-ms-client-name": "targetAttestationToken" + }, + "nonce": { + "type": "string", + "description": "A client provided nonce for freshness." + }, + "enc": { + "type": "string", + "minLength": 1, + "description": "The encryption algorithm to use to protected the exported key material", + "enum": [ + "CKM_RSA_AES_KEY_WRAP", + "RSA_AES_KEY_WRAP_256", + "RSA_AES_KEY_WRAP_384" + ], + "x-ms-enum": { + "name": "KeyEncryptionAlgorithm", + "modelAsString": true + } + } + }, + "description": "The release key parameters.", + "required": [ + "target" + ] + }, + "KeyOperationsParameters": { + "properties": { + "alg": { + "x-ms-client-name": "algorithm", + "type": "string", + "minLength": 1, + "description": "algorithm identifier", + "enum": [ + "RSA-OAEP", + "RSA-OAEP-256", + "RSA1_5", + "A128GCM", + "A192GCM", + "A256GCM", + "A128KW", + "A192KW", + "A256KW", + "A128CBC", + "A192CBC", + "A256CBC", + "A128CBCPAD", + "A192CBCPAD", + "A256CBCPAD" + ], + "x-ms-enum": { + "name": "JsonWebKeyEncryptionAlgorithm", + "modelAsString": true + } + }, + "value": { + "type": "string", + "format": "base64url" + }, + "iv": { + "type": "string", + "format": "base64url", + "description": "Cryptographically random, non-repeating initialization vector for symmetric algorithms." + }, + "aad": { + "type": "string", + "format": "base64url", + "description": "Additional data to authenticate but not encrypt/decrypt when using authenticated crypto algorithms." + }, + "tag": { + "type": "string", + "format": "base64url", + "description": "The tag to authenticate when performing decryption with an authenticated algorithm." + } + }, + "description": "The key operations parameters.", + "required": [ + "alg", + "value" + ] + }, + "KeySignParameters": { + "properties": { + "alg": { + "x-ms-client-name": "algorithm", + "type": "string", + "minLength": 1, + "description": "The signing/verification algorithm identifier. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm.", + "enum": [ + "PS256", + "PS384", + "PS512", + "RS256", + "RS384", + "RS512", + "RSNULL", + "ES256", + "ES384", + "ES512", + "ES256K" + ], + "x-ms-enum": { + "name": "JsonWebKeySignatureAlgorithm", + "modelAsString": true, + "values": [ + { + "value": "PS256", + "description": "RSASSA-PSS using SHA-256 and MGF1 with SHA-256, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "PS384", + "description": "RSASSA-PSS using SHA-384 and MGF1 with SHA-384, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "PS512", + "description": "RSASSA-PSS using SHA-512 and MGF1 with SHA-512, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "RS256", + "description": "RSASSA-PKCS1-v1_5 using SHA-256, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "RS384", + "description": "RSASSA-PKCS1-v1_5 using SHA-384, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "RS512", + "description": "RSASSA-PKCS1-v1_5 using SHA-512, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "RSNULL", + "description": "Reserved" + }, + { + "value": "ES256", + "description": "ECDSA using P-256 and SHA-256, as described in https://tools.ietf.org/html/rfc7518." + }, + { + "value": "ES384", + "description": "ECDSA using P-384 and SHA-384, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "ES512", + "description": "ECDSA using P-521 and SHA-512, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "ES256K", + "description": "ECDSA using P-256K and SHA-256, as described in https://tools.ietf.org/html/rfc7518" + } + ] + } + }, + "value": { + "type": "string", + "format": "base64url" + } + }, + "description": "The key operations parameters.", + "required": [ + "alg", + "value" + ] + }, + "KeyVerifyParameters": { + "properties": { + "alg": { + "x-ms-client-name": "algorithm", + "type": "string", + "minLength": 1, + "description": "The signing/verification algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm.", + "enum": [ + "PS256", + "PS384", + "PS512", + "RS256", + "RS384", + "RS512", + "RSNULL", + "ES256", + "ES384", + "ES512", + "ES256K" + ], + "x-ms-enum": { + "name": "JsonWebKeySignatureAlgorithm", + "modelAsString": true + } + }, + "digest": { + "type": "string", + "format": "base64url", + "description": "The digest used for signing." + }, + "value": { + "x-ms-client-name": "signature", + "type": "string", + "format": "base64url", + "description": "The signature to be verified." + } + }, + "description": "The key verify parameters.", + "required": [ + "alg", + "digest", + "value" + ] + }, + "KeyUpdateParameters": { + "properties": { + "key_ops": { + "type": "array", + "items": { + "type": "string", + "description": "JSON web key operations. For more information, see JsonWebKeyOperation.", + "enum": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey", + "import", + "export" + ], + "x-ms-enum": { + "name": "JsonWebKeyOperation", + "modelAsString": true + } + }, + "description": "Json web key operations. For more information on possible key operations, see JsonWebKeyOperation." + }, + "attributes": { + "x-ms-client-name": "keyAttributes", + "$ref": "#/definitions/KeyAttributes" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "release_policy": { + "$ref": "#/definitions/KeyReleasePolicy", + "x-nullable": true, + "description": "The policy rules under which the key can be exported." + } + }, + "description": "The key update parameters." + }, + "KeyRestoreParameters": { + "properties": { + "value": { + "type": "string", + "x-ms-client-name": "keyBundleBackup", + "format": "base64url", + "description": "The backup blob associated with a key bundle." + } + }, + "description": "The key restore parameters.", + "required": [ + "value" + ] + }, + "KeyOperationResult": { + "properties": { + "kid": { + "type": "string", + "description": "Key identifier", + "readOnly": true + }, + "value": { + "x-ms-client-name": "result", + "type": "string", + "format": "base64url", + "readOnly": true + }, + "iv": { + "type": "string", + "format": "base64url", + "readOnly": true + }, + "tag": { + "type": "string", + "x-ms-client-name": "authenticationTag", + "format": "base64url", + "readOnly": true + }, + "aad": { + "type": "string", + "x-ms-client-name": "additionalAuthenticatedData", + "format": "base64url", + "readOnly": true + } + }, + "description": "The key operation result." + }, + "KeyVerifyResult": { + "properties": { + "value": { + "type": "boolean", + "readOnly": true, + "description": "True if the signature is verified, otherwise false." + } + }, + "description": "The key verify result." + }, + "KeyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/KeyItem" + }, + "readOnly": true, + "description": "A response message containing a list of keys in the key vault along with a link to the next page of keys." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of keys." + } + }, + "description": "The key list result." + }, + "DeletedKeyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedKeyItem" + }, + "readOnly": true, + "description": "A response message containing a list of deleted keys in the vault along with a link to the next page of deleted keys" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of deleted keys." + } + }, + "description": "A list of keys that have been deleted in this vault." + }, + "BackupKeyResult": { + "properties": { + "value": { + "type": "string", + "format": "base64url", + "readOnly": true, + "description": "The backup blob containing the backed up key." + } + }, + "description": "The backup key result, containing the backup blob." + }, + "KeyRotationPolicy": { + "properties": { + "id": { + "type": "string", + "description": "The key policy id.", + "readOnly": true + }, + "lifetimeActions": { + "type": "array", + "items": { + "$ref": "#/definitions/LifetimeActions" + }, + "description": "Actions that will be performed by Key Vault over the lifetime of a key. For preview, lifetimeActions can only have two items at maximum: one for rotate, one for notify. Notification time would be default to 30 days before expiry and it is not configurable." + }, + "attributes": { + "$ref": "#/definitions/KeyRotationPolicyAttributes", + "description": "The key rotation policy attributes." + } + }, + "description": "Management policy for a key." + }, + "LifetimeActions": { + "properties": { + "trigger": { + "$ref": "#/definitions/LifetimeActionsTrigger", + "description": "The condition that will execute the action." + }, + "action": { + "$ref": "#/definitions/LifetimeActionsType", + "description": "The action that will be executed." + } + }, + "description": "Action and its trigger that will be performed by Key Vault over the lifetime of a key." + }, + "LifetimeActionsTrigger": { + "properties": { + "timeAfterCreate": { + "type": "string", + "description": "Time after creation to attempt to rotate. It only applies to rotate. It will be in ISO 8601 duration format. Example: 90 days : \"P90D\" " + }, + "timeBeforeExpiry": { + "type": "string", + "description": "Time before expiry to attempt to rotate or notify. It will be in ISO 8601 duration format. Example: 90 days : \"P90D\"" + } + }, + "description": "A condition to be satisfied for an action to be executed." + }, + "LifetimeActionsType": { + "properties": { + "type": { + "type": "string", + "description": "The type of the action. The value should be compared case-insensitively.", + "enum": [ + "Rotate", + "Notify" + ], + "x-ms-enum": { + "name": "KeyRotationPolicyAction", + "modelAsString": false, + "values": [ + { + "value": "Rotate", + "description": "Rotate the key based on the key policy." + }, + { + "value": "Notify", + "description": "Trigger Event Grid events. Defaults to 30 days before expiry. Key Vault only." + } + ] + } + } + }, + "description": "The action that will be executed." + }, + "KeyRotationPolicyAttributes": { + "properties": { + "expiryTime": { + "type": "string", + "description": "The expiryTime will be applied on the new key version. It should be at least 28 days. It will be in ISO 8601 Format. Examples: 90 days: P90D, 3 months: P3M, 48 hours: PT48H, 1 year and 10 days: P1Y10D" + }, + "created": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The key rotation policy created time in UTC." + }, + "updated": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The key rotation policy's last updated time in UTC." + } + }, + "description": "The key rotation policy attributes." + }, + "KeyReleaseResult": { + "properties": { + "value": { + "type": "string", + "readOnly": true, + "description": "A signed object containing the released key." + } + }, + "description": "The release result, containing the released key." + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/rbac.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/rbac.json new file mode 100644 index 000000000000..52c30a549f3f --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/rbac.json @@ -0,0 +1,923 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultClient", + "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", + "version": "7.5" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{vaultBaseUrl}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "vaultBaseUrl", + "description": "The vault name, for example https://myvault.vault.azure.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName}": { + "delete": { + "tags": [ + "RoleDefinitions" + ], + "operationId": "RoleDefinitions_Delete", + "description": "Deletes a custom role definition.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role definition to delete. Managed HSM only supports '/'.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (GUID) of the role definition to delete." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role definition that was deleted.", + "schema": { + "$ref": "#/definitions/RoleDefinition" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "DeleteRoleDefinition": { + "$ref": "./examples/DeleteRoleDefinition-example.json" + } + } + }, + "put": { + "tags": [ + "RoleDefinitions" + ], + "operationId": "RoleDefinitions_CreateOrUpdate", + "description": "Creates or updates a custom role definition.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role definition to create or update. Managed HSM only supports '/'.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role definition to create or update. It can be any valid GUID." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleDefinitionCreateParameters" + }, + "description": "Parameters for the role definition." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the role definition.", + "schema": { + "$ref": "#/definitions/RoleDefinition" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "PutRoleDefinition": { + "$ref": "./examples/PutRoleDefinition-example.json" + } + } + }, + "get": { + "tags": [ + "RoleDefinitions" + ], + "operationId": "RoleDefinitions_Get", + "description": "Get the specified role definition.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role definition to get. Managed HSM only supports '/'.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role definition to get." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role definition.", + "schema": { + "$ref": "#/definitions/RoleDefinition" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetRoleAssignments": { + "$ref": "./examples/GetRoleDefinition-example.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleDefinitions": { + "get": { + "tags": [ + "RoleDefinitions" + ], + "operationId": "RoleDefinitions_List", + "description": "Get all role definitions that are applicable at scope and above.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role definition.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role definitions.", + "schema": { + "$ref": "#/definitions/RoleDefinitionListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListRoleDefinitions": { + "$ref": "./examples/ListRoleDefinitions-example.json" + } + }, + "x-ms-odata": "#/definitions/RoleDefinitionFilter" + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}": { + "delete": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_Delete", + "description": "Deletes a role assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment to delete.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment to delete." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "DeleteRoleAssignments": { + "$ref": "./examples/DeleteRoleAssignments-example.json" + } + } + }, + "put": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_Create", + "description": "Creates a role assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment to create.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment to create. It can be any valid GUID." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleAssignmentCreateParameters" + }, + "description": "Parameters for the role assignment." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "PutRoleAssignments": { + "$ref": "./examples/PutRoleAssignments-example.json" + } + } + }, + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_Get", + "description": "Get the specified role assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment to get." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetRoleAssignments": { + "$ref": "./examples/GetRoleAssignments-example.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_ListForScope", + "description": "Gets role assignments for a scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignments.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListRoleAssignments": { + "$ref": "./examples/ListRoleAssignments-example.json" + } + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter" + } + } + }, + "definitions": { + "RoleAssignmentFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role assignment of the specific principal." + } + }, + "description": "Role Assignments filter" + }, + "RoleAssignmentPropertiesWithScope": { + "properties": { + "scope": { + "$ref": "#/definitions/RoleScope" + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + } + }, + "description": "Role assignment properties with scope." + }, + "RoleAssignment": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role assignment ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role assignment name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role assignment type." + }, + "properties": { + "$ref": "#/definitions/RoleAssignmentPropertiesWithScope", + "description": "Role assignment properties." + } + }, + "description": "Role Assignments" + }, + "RoleAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleAssignment" + }, + "description": "Role assignment list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Role assignment list operation result." + }, + "RoleAssignmentProperties": { + "properties": { + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID used in the role assignment." + }, + "principalId": { + "type": "string", + "description": "The principal ID assigned to the role. This maps to the ID inside the Active Directory. It can point to a user, service principal, or security group." + } + }, + "required": [ + "roleDefinitionId", + "principalId" + ], + "description": "Role assignment properties." + }, + "RoleDefinitionCreateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/RoleDefinitionProperties", + "description": "Role definition properties." + } + }, + "required": [ + "properties" + ], + "description": "Role definition create parameters." + }, + "RoleAssignmentCreateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/RoleAssignmentProperties", + "description": "Role assignment properties." + } + }, + "required": [ + "properties" + ], + "description": "Role assignment create parameters." + }, + "RoleDefinitionFilter": { + "properties": { + "roleName": { + "type": "string", + "description": "Returns role definition with the specific name." + } + }, + "description": "Role Definitions filter" + }, + "Permission": { + "properties": { + "actions": { + "type": "array", + "description": "Action permissions that are granted.", + "items": { + "type": "string" + } + }, + "notActions": { + "type": "array", + "description": "Action permissions that are excluded but not denied. They may be granted by other role definitions assigned to a principal.", + "items": { + "type": "string", + "description": "Not actions." + } + }, + "dataActions": { + "type": "array", + "description": "Data action permissions that are granted.", + "items": { + "$ref": "#/definitions/DataAction" + } + }, + "notDataActions": { + "type": "array", + "description": "Data action permissions that are excluded but not denied. They may be granted by other role definitions assigned to a principal.", + "items": { + "$ref": "#/definitions/DataAction" + } + } + }, + "description": "Role definition permissions." + }, + "RoleDefinitionProperties": { + "properties": { + "roleName": { + "type": "string", + "description": "The role name." + }, + "description": { + "type": "string", + "description": "The role definition description." + }, + "type": { + "type": "string", + "description": "The role type.", + "enum": [ + "AKVBuiltInRole", + "CustomRole" + ], + "x-ms-enum": { + "name": "RoleType", + "modelAsString": true, + "values": [ + { + "name": "BuiltInRole", + "value": "AKVBuiltInRole", + "description": "Built in role." + }, + { + "value": "CustomRole", + "description": "Custom role." + } + ] + }, + "x-ms-client-name": "roleType" + }, + "permissions": { + "type": "array", + "items": { + "$ref": "#/definitions/Permission" + }, + "description": "Role definition permissions." + }, + "assignableScopes": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleScope" + }, + "description": "Role definition assignable scopes." + } + }, + "description": "Role definition properties." + }, + "RoleDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role definition ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role definition name." + }, + "type": { + "type": "string", + "description": "The role definition type.", + "readOnly": true, + "enum": [ + "Microsoft.Authorization/roleDefinitions" + ], + "x-ms-enum": { + "name": "RoleDefinitionType", + "modelAsString": true + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleDefinitionProperties", + "description": "Role definition properties." + } + }, + "description": "Role definition." + }, + "RoleDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleDefinition" + }, + "description": "Role definition list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Role definition list operation result." + }, + "RoleScope": { + "type": "string", + "description": "The role scope.", + "enum": [ + "/", + "/keys" + ], + "x-ms-enum": { + "name": "RoleScope", + "modelAsString": true, + "values": [ + { + "name": "Global", + "value": "/", + "description": "Global scope" + }, + { + "name": "Keys", + "value": "/keys", + "description": "Keys scope" + } + ] + } + }, + "DataAction": { + "type": "string", + "description": "Supported permissions for data actions.", + "enum": [ + "Microsoft.KeyVault/managedHsm/keys/read/action", + "Microsoft.KeyVault/managedHsm/keys/write/action", + "Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action", + "Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action", + "Microsoft.KeyVault/managedHsm/keys/backup/action", + "Microsoft.KeyVault/managedHsm/keys/restore/action", + "Microsoft.KeyVault/managedHsm/roleAssignments/delete/action", + "Microsoft.KeyVault/managedHsm/roleAssignments/read/action", + "Microsoft.KeyVault/managedHsm/roleAssignments/write/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/read/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/write/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action", + "Microsoft.KeyVault/managedHsm/keys/encrypt/action", + "Microsoft.KeyVault/managedHsm/keys/decrypt/action", + "Microsoft.KeyVault/managedHsm/keys/wrap/action", + "Microsoft.KeyVault/managedHsm/keys/unwrap/action", + "Microsoft.KeyVault/managedHsm/keys/sign/action", + "Microsoft.KeyVault/managedHsm/keys/verify/action", + "Microsoft.KeyVault/managedHsm/keys/create", + "Microsoft.KeyVault/managedHsm/keys/delete", + "Microsoft.KeyVault/managedHsm/keys/export/action", + "Microsoft.KeyVault/managedHsm/keys/release/action", + "Microsoft.KeyVault/managedHsm/keys/import/action", + "Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete", + "Microsoft.KeyVault/managedHsm/securitydomain/download/action", + "Microsoft.KeyVault/managedHsm/securitydomain/download/read", + "Microsoft.KeyVault/managedHsm/securitydomain/upload/action", + "Microsoft.KeyVault/managedHsm/securitydomain/upload/read", + "Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read", + "Microsoft.KeyVault/managedHsm/backup/start/action", + "Microsoft.KeyVault/managedHsm/restore/start/action", + "Microsoft.KeyVault/managedHsm/backup/status/action", + "Microsoft.KeyVault/managedHsm/restore/status/action", + "Microsoft.KeyVault/managedHsm/rng/action" + ], + "x-ms-enum": { + "name": "DataAction", + "modelAsString": true, + "values": [ + { + "name": "ReadHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/read/action", + "description": "Read HSM key metadata." + }, + { + "name": "WriteHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/write/action", + "description": "Update an HSM key." + }, + { + "name": "ReadDeletedHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action", + "description": "Read deleted HSM key." + }, + { + "name": "RecoverDeletedHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action", + "description": "Recover deleted HSM key." + }, + { + "name": "BackupHsmKeys", + "value": "Microsoft.KeyVault/managedHsm/keys/backup/action", + "description": "Backup HSM keys." + }, + { + "name": "RestoreHsmKeys", + "value": "Microsoft.KeyVault/managedHsm/keys/restore/action", + "description": "Restore HSM keys." + }, + { + "name": "DeleteRoleAssignment", + "value": "Microsoft.KeyVault/managedHsm/roleAssignments/delete/action", + "description": "Delete role assignment." + }, + { + "name": "GetRoleAssignment", + "value": "Microsoft.KeyVault/managedHsm/roleAssignments/read/action", + "description": "Get role assignment." + }, + { + "name": "WriteRoleAssignment", + "value": "Microsoft.KeyVault/managedHsm/roleAssignments/write/action", + "description": "Create or update role assignment." + }, + { + "name": "ReadRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/read/action", + "description": "Get role definition." + }, + { + "name": "WriteRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/write/action", + "description": "Create or update role definition." + }, + { + "name": "DeleteRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action", + "description": "Delete role definition." + }, + { + "name": "EncryptHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/encrypt/action", + "description": "Encrypt using an HSM key." + }, + { + "name": "DecryptHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/decrypt/action", + "description": "Decrypt using an HSM key." + }, + { + "name": "WrapHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/wrap/action", + "description": "Wrap using an HSM key." + }, + { + "name": "UnwrapHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/unwrap/action", + "description": "Unwrap using an HSM key." + }, + { + "name": "SignHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/sign/action", + "description": "Sign using an HSM key." + }, + { + "name": "VerifyHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/verify/action", + "description": "Verify using an HSM key." + }, + { + "name": "CreateHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/create", + "description": "Create an HSM key." + }, + { + "name": "DeleteHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/delete", + "description": "Delete an HSM key." + }, + { + "name": "ExportHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/export/action", + "description": "Export an HSM key." + }, + { + "name": "ReleaseKey", + "value": "Microsoft.KeyVault/managedHsm/keys/release/action", + "description": "Release an HSM key using Secure Key Release." + }, + { + "name": "ImportHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/import/action", + "description": "Import an HSM key." + }, + { + "name": "PurgeDeletedHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete", + "description": "Purge a deleted HSM key." + }, + { + "name": "DownloadHsmSecurityDomain", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/download/action", + "description": "Download an HSM security domain." + }, + { + "name": "DownloadHsmSecurityDomainStatus", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/download/read", + "description": "Check status of HSM security domain download." + }, + { + "name": "UploadHsmSecurityDomain", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/upload/action", + "description": "Upload an HSM security domain." + }, + { + "name": "ReadHsmSecurityDomainStatus", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/upload/read", + "description": "Check the status of the HSM security domain exchange file." + }, + { + "name": "ReadHsmSecurityDomainTransferKey", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read", + "description": "Download an HSM security domain transfer key." + }, + { + "name": "StartHsmBackup", + "value": "Microsoft.KeyVault/managedHsm/backup/start/action", + "description": "Start an HSM backup." + }, + { + "name": "StartHsmRestore", + "value": "Microsoft.KeyVault/managedHsm/restore/start/action", + "description": "Start an HSM restore." + }, + { + "name": "ReadHsmBackupStatus", + "value": "Microsoft.KeyVault/managedHsm/backup/status/action", + "description": "Read an HSM backup status." + }, + { + "name": "ReadHsmRestoreStatus", + "value": "Microsoft.KeyVault/managedHsm/restore/status/action", + "description": "Read an HSM restore status." + }, + { + "name": "RandomNumbersGenerate", + "value": "Microsoft.KeyVault/managedHsm/rng/action", + "description": "Generate random numbers." + } + ] + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/secrets.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/secrets.json new file mode 100644 index 000000000000..100cde8d9a0c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/secrets.json @@ -0,0 +1,882 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultClient", + "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", + "version": "7.5" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{vaultBaseUrl}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "vaultBaseUrl", + "description": "The vault name, for example https://myvault.vault.azure.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/secrets/{secret-name}": { + "put": { + "tags": [ + "Secrets" + ], + "operationId": "SetSecret", + "summary": "Sets a secret in a specified key vault.", + "description": " The SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z-]+$", + "description": "The name of the secret. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/SecretSetParameters" + }, + "description": "The parameters for setting the secret." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A secret bundle containing the result of the set secret request.", + "schema": { + "$ref": "#/definitions/SecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "SetSecret": { + "$ref": "./examples/SetSecret-example.json" + } + } + }, + "delete": { + "tags": [ + "Secrets" + ], + "operationId": "DeleteSecret", + "summary": "Deletes a secret from a specified key vault.", + "description": "The DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires the secrets/delete permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted secret and information on when the secret will be deleted, and how to recover the deleted secret.", + "schema": { + "$ref": "#/definitions/DeletedSecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "DeleteSecret": { + "$ref": "./examples/DeleteSecret-example.json" + } + } + } + }, + "/secrets/{secret-name}/{secret-version}": { + "patch": { + "tags": [ + "Secrets" + ], + "operationId": "UpdateSecret", + "summary": "Updates the attributes associated with a specified secret in a given key vault.", + "description": "The UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value of a secret itself cannot be changed. This operation requires the secrets/set permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "name": "secret-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the secret." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/SecretUpdateParameters" + }, + "description": "The parameters for update secret operation." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The updated secret.", + "schema": { + "$ref": "#/definitions/SecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "UpdateSecret": { + "$ref": "./examples/UpdateSecret-example.json" + } + } + }, + "get": { + "tags": [ + "Secrets" + ], + "operationId": "GetSecret", + "summary": "Get a specified secret from a given key vault.", + "description": "The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "name": "secret-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the secret. This URI fragment is optional. If not specified, the latest version of the secret is returned." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved secret.", + "schema": { + "$ref": "#/definitions/SecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetSecret": { + "$ref": "./examples/GetSecret-example.json" + } + } + } + }, + "/secrets": { + "get": { + "tags": [ + "Secrets" + ], + "operationId": "GetSecrets", + "summary": "List secrets in a specified key vault.", + "description": "The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified, the service will return up to 25 results." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of secrets in the vault along with a link to the next page of secrets.", + "schema": { + "$ref": "#/definitions/SecretListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetSecrets": { + "$ref": "./examples/GetSecrets-example.json" + } + } + } + }, + "/secrets/{secret-name}/versions": { + "get": { + "tags": [ + "Secrets" + ], + "operationId": "GetSecretVersions", + "summary": "List all versions of the specified secret.", + "description": "The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified, the service will return up to 25 results." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of secrets along with a link to the next page of secrets.", + "schema": { + "$ref": "#/definitions/SecretListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetSecretVersions": { + "$ref": "./examples/GetSecretVersions-example.json" + } + } + } + }, + "/deletedsecrets": { + "get": { + "tags": [ + "DeletedSecrets" + ], + "operationId": "GetDeletedSecrets", + "summary": "Lists deleted secrets for the specified vault.", + "description": "The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of deleted secrets in the vault, along with a link to the next page of deleted secrets.", + "schema": { + "$ref": "#/definitions/DeletedSecretListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetDeletedSecrets": { + "$ref": "./examples/GetDeletedSecrets-example.json" + } + } + } + }, + "/deletedsecrets/{secret-name}": { + "get": { + "tags": [ + "DeletedSecrets" + ], + "operationId": "GetDeletedSecret", + "summary": "Gets the specified deleted secret.", + "description": "The Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A secret bundle of the secret and its attributes.", + "schema": { + "$ref": "#/definitions/DeletedSecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetDeletedSecret": { + "$ref": "./examples/GetDeletedSecret-example.json" + } + } + }, + "delete": { + "tags": [ + "DeletedSecrets" + ], + "operationId": "PurgeDeletedSecret", + "summary": "Permanently deletes the specified secret.", + "description": "The purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No content signaling that the secret was purged forever." + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "PurgeDeletedSecret": { + "$ref": "./examples/PurgeDeletedSecret-example.json" + } + } + } + }, + "/deletedsecrets/{secret-name}/recover": { + "post": { + "tags": [ + "DeletedSecrets" + ], + "operationId": "RecoverDeletedSecret", + "summary": "Recovers the deleted secret to the latest version.", + "description": "Recovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deleted secret." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A Secret bundle of the original secret and its attributes.", + "schema": { + "$ref": "#/definitions/SecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RecoverDeletedSecret": { + "$ref": "./examples/RecoverDeletedSecret-example.json" + } + } + } + }, + "/secrets/{secret-name}/backup": { + "post": { + "tags": [ + "Secrets" + ], + "operationId": "BackupSecret", + "summary": "Backs up the specified secret.", + "description": "Requests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The backup blob containing the backed up secret.", + "schema": { + "$ref": "#/definitions/BackupSecretResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "BackupSecret": { + "$ref": "./examples/BackupSecret-example.json" + } + } + } + }, + "/secrets/restore": { + "post": { + "tags": [ + "Secrets" + ], + "operationId": "RestoreSecret", + "summary": "Restores a backed up secret to a vault.", + "description": "Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/SecretRestoreParameters" + }, + "description": "The parameters to restore the secret." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Restored secret bundle in the vault.", + "schema": { + "$ref": "#/definitions/SecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RestoreSecret": { + "$ref": "./examples/RestoreSecret-example.json" + } + } + } + } + }, + "definitions": { + "SecretBundle": { + "properties": { + "value": { + "type": "string", + "description": "The secret value." + }, + "id": { + "type": "string", + "description": "The secret id." + }, + "contentType": { + "type": "string", + "description": "The content type of the secret." + }, + "attributes": { + "$ref": "#/definitions/SecretAttributes", + "description": "The secret management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "kid": { + "type": "string", + "readOnly": true, + "description": "If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate." + }, + "managed": { + "type": "boolean", + "readOnly": true, + "description": "True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true." + } + }, + "description": "A secret consisting of a value, id and its attributes." + }, + "SecretItem": { + "properties": { + "id": { + "type": "string", + "description": "Secret identifier." + }, + "attributes": { + "$ref": "#/definitions/SecretAttributes", + "description": "The secret management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "contentType": { + "type": "string", + "description": "Type of the secret value such as a password." + }, + "managed": { + "type": "boolean", + "readOnly": true, + "description": "True if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true." + } + }, + "description": "The secret item containing secret metadata." + }, + "DeletedSecretBundle": { + "allOf": [ + { + "$ref": "#/definitions/SecretBundle" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted secret." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the secret is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the secret was deleted, in UTC" + } + }, + "description": "A Deleted Secret consisting of its previous id, attributes and its tags, as well as information on when it will be purged." + }, + "DeletedSecretItem": { + "allOf": [ + { + "$ref": "#/definitions/SecretItem" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted secret." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the secret is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the secret was deleted, in UTC" + } + }, + "description": "The deleted secret item containing metadata about the deleted secret." + }, + "SecretAttributes": { + "allOf": [ + { + "$ref": "common.json#/definitions/Attributes" + } + ], + "properties": { + "recoverableDays": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0." + }, + "recoveryLevel": { + "type": "string", + "description": "Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval.", + "enum": [ + "Purgeable", + "Recoverable+Purgeable", + "Recoverable", + "Recoverable+ProtectedSubscription", + "CustomizedRecoverable+Purgeable", + "CustomizedRecoverable", + "CustomizedRecoverable+ProtectedSubscription" + ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] + }, + "readOnly": true, + "x-nullable": false + } + }, + "description": "The secret management attributes." + }, + "SecretRestoreParameters": { + "properties": { + "value": { + "type": "string", + "x-ms-client-name": "secretBundleBackup", + "format": "base64url", + "description": "The backup blob associated with a secret bundle." + } + }, + "description": "The secret restore parameters.", + "required": [ + "value" + ] + }, + "SecretProperties": { + "properties": { + "contentType": { + "type": "string", + "description": "The media type (MIME type)." + } + }, + "description": "Properties of the key backing a certificate." + }, + "SecretSetParameters": { + "properties": { + "value": { + "type": "string", + "description": "The value of the secret." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "contentType": { + "type": "string", + "description": "Type of the secret value such as a password." + }, + "attributes": { + "x-ms-client-name": "secretAttributes", + "$ref": "#/definitions/SecretAttributes", + "description": "The secret management attributes." + } + }, + "description": "The secret set parameters.", + "required": [ + "value" + ] + }, + "SecretUpdateParameters": { + "properties": { + "contentType": { + "type": "string", + "description": "Type of the secret value such as a password." + }, + "attributes": { + "x-ms-client-name": "secretAttributes", + "$ref": "#/definitions/SecretAttributes", + "description": "The secret management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The secret update parameters." + }, + "SecretListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecretItem" + }, + "readOnly": true, + "description": "A response message containing a list of secrets in the key vault along with a link to the next page of secrets." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of secrets." + } + }, + "description": "The secret list result." + }, + "DeletedSecretListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedSecretItem" + }, + "readOnly": true, + "description": "A response message containing a list of the deleted secrets in the vault along with a link to the next page of deleted secrets" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of deleted secrets." + } + }, + "description": "The deleted secret list result" + }, + "BackupSecretResult": { + "properties": { + "value": { + "type": "string", + "format": "base64url", + "readOnly": true, + "description": "The backup blob containing the backed up secret." + } + }, + "description": "The backup secret result, containing the backup blob." + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/securitydomain.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/securitydomain.json new file mode 100644 index 000000000000..0180879457ba --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/securitydomain.json @@ -0,0 +1,364 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultClient", + "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", + "version": "7.5" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{vaultBaseUrl}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "vaultBaseUrl", + "description": "The vault name, for example https://myvault.vault.azure.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/securitydomain/download/pending": { + "get": { + "tags": [ + "HSMSecurityDomain" + ], + "operationId": "HSMSecurityDomain_DownloadPending", + "description": "Retrieves the Security Domain download operation status", + "responses": { + "200": { + "description": "Security Domain download operation status", + "schema": { + "$ref": "#/definitions/SecurityDomainOperationStatus" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Find Security Domain download operation status": { + "$ref": "./examples/securitydomainoperationstatus-example.json" + } + } + } + }, + "/securitydomain/download": { + "post": { + "tags": [ + "HSMSecurityDomain" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "operationId": "HSMSecurityDomain_Download", + "description": "Retrieves the Security Domain from the managed HSM. Calling this endpoint can be used to activate a provisioned managed HSM resource.", + "parameters": [ + { + "in": "body", + "name": "CertificateInfoObject", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateInfoObject" + }, + "description": "The Security Domain download operation requires customer to provide N certificates (minimum 3 and maximum 10) containing a public key in JWK format." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The response contains the Security Domain that is being confirmed.", + "schema": { + "$ref": "#/definitions/SecurityDomainObject" + }, + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Retrieve Security Domain": { + "$ref": "./examples/securitydomaindownloadpost-example.json" + } + } + } + }, + "/securitydomain/upload": { + "get": { + "tags": [ + "HSMSecurityDomain" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "operationId": "HSMSecurityDomain_TransferKey", + "description": "Retrieve Security Domain transfer key", + "responses": { + "200": { + "description": "Security Domain transfer key response", + "schema": { + "$ref": "#/definitions/TransferKey" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Retrieve Security Domain transfer key": { + "$ref": "./examples/securitydomaintransferkey-example.json" + } + } + }, + "post": { + "tags": [ + "HSMSecurityDomain" + ], + "operationId": "HSMSecurityDomain_Upload", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Restore the provided Security Domain.", + "parameters": [ + { + "in": "body", + "name": "security_domain", + "description": "The Security Domain to be restored.", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityDomainObject" + } + } + ], + "responses": { + "202": { + "description": "Restore of the Security Domain started.", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SecurityDomainOperationStatus" + } + }, + "204": { + "description": "Final response" + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Security Domain upload operation": { + "$ref": "./examples/securitydomainuploadoperation-example.json" + } + } + } + }, + "/securitydomain/upload/pending": { + "get": { + "tags": [ + "HSMSecurityDomain" + ], + "operationId": "HSMSecurityDomain_UploadPending", + "description": "Get Security Domain upload operation status", + "responses": { + "200": { + "description": "Security Domain upload operation status", + "schema": { + "$ref": "#/definitions/SecurityDomainOperationStatus" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Find Security Domain upload operation status": { + "$ref": "./examples/securitydomainoperationstatus-example.json" + } + } + } + } + }, + "definitions": { + "CertificateInfoObject": { + "properties": { + "certificates": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityDomainJsonWebKey" + }, + "minItems": 3, + "maxItems": 10, + "uniqueItems": true, + "description": "Certificates needed from customer" + }, + "required": { + "description": "Customer to specify the number of certificates (minimum 2 and maximum 10) to restore Security Domain", + "type": "integer", + "default": 2, + "minimum": 2, + "maximum": 10 + } + }, + "required": [ + "certificates" + ] + }, + "TransferKey": { + "properties": { + "key_format": { + "type": "string", + "default": "jwk", + "description": "Specifies the format of the transfer key" + }, + "transfer_key": { + "$ref": "#/definitions/SecurityDomainJsonWebKey", + "description": "Specifies the transfer key in JWK format" + } + }, + "required": [ + "transfer_key" + ] + }, + "SecurityDomainObject": { + "properties": { + "value": { + "type": "string", + "description": "The Security Domain." + } + }, + "description": "The Security Domain.", + "required": [ + "value" + ] + }, + "SecurityDomainOperationStatus": { + "properties": { + "status": { + "description": "operation status", + "enum": [ + "Success", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "OperationStatus" + }, + "type": "string" + }, + "status_details": { + "type": "string" + } + } + }, + "SecurityDomainJsonWebKey": { + "properties": { + "kid": { + "type": "string", + "description": "Key identifier." + }, + "kty": { + "type": "string", + "description": "JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. For Security Domain this value must be RSA." + }, + "key_ops": { + "type": "array", + "items": { + "type": "string", + "description": "Supported key operations." + } + }, + "n": { + "type": "string", + "description": "RSA modulus." + }, + "e": { + "type": "string", + "description": "RSA public exponent." + }, + "x5c": { + "description": "X509 certificate chain parameter", + "type": "array", + "items": { + "type": "string" + } + }, + "use": { + "description": "Public Key Use Parameter. This is optional and if present must be enc.", + "type": "string" + }, + "x5t": { + "description": "X509 certificate SHA1 thumbprint. This is optional.", + "type": "string" + }, + "x5t#S256": { + "description": "X509 certificate SHA256 thumbprint.", + "type": "string" + }, + "alg": { + "description": "Algorithm intended for use with the key.", + "type": "string" + } + }, + "required": [ + "kty", + "key_ops", + "alg", + "kid", + "x5c", + "x5t#S256", + "n", + "e" + ] + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/settings.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/settings.json new file mode 100644 index 000000000000..2fb03277deb7 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/settings.json @@ -0,0 +1,214 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultClient", + "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", + "version": "7.5" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{vaultBaseUrl}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "vaultBaseUrl", + "description": "The vault name, for example https://myvault.vault.azure.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/settings/{setting-name}": { + "patch": { + "tags": [ + "Settings" + ], + "operationId": "UpdateSetting", + "summary": "Updates key vault account setting, stores it, then returns the setting name and value to the client.", + "description": "Description of the pool setting to be updated", + "parameters": [ + { + "$ref": "#/parameters/SettingNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/UpdateSettingRequest" + }, + "description": "The parameters to update an account setting." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "An account setting containing the name of the setting and the value it is set to. ", + "schema": { + "$ref": "#/definitions/Setting" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Update Setting": { + "$ref": "./examples/UpdateSetting-example.json" + } + } + }, + "get": { + "tags": [ + "Settings" + ], + "operationId": "GetSetting", + "summary": "Get specified account setting object.", + "description": "Retrieves the setting object of a specified setting name.", + "parameters": [ + { + "$ref": "#/parameters/SettingNameParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "An account setting containing the name of the setting and the value it is set to.", + "schema": { + "$ref": "#/definitions/Setting" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetSetting": { + "$ref": "./examples/UpdateSetting-example.json" + } + } + } + }, + "/settings": { + "get": { + "tags": [ + "Settings" + ], + "operationId": "GetSettings", + "summary": "List account settings.", + "description": "Retrieves a list of all the available account settings that can be configured.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of account settings with their associated value.", + "schema": { + "$ref": "#/definitions/SettingsListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetSettings": { + "$ref": "./examples/ListSettings-example.json" + } + } + } + } + }, + "definitions": { + "UpdateSettingRequest": { + "properties": { + "value": { + "type": "string", + "description": "The value of the pool setting." + } + }, + "description": "The update settings request object.", + "required": [ + "value" + ], + "type": "object" + }, + "Setting": { + "properties": { + "name": { + "type": "string", + "description": "The account setting to be updated" + }, + "value": { + "type": "string", + "description": "The value of the pool setting." + }, + "type": { + "enum": [ + "boolean" + ], + "type": "string", + "x-ms-enum": { + "name": "SettingTypeEnum", + "modelAsString": true + }, + "description": "The type specifier of the value." + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "SettingsListResult": { + "properties": { + "settings": { + "type": "array", + "items": { + "$ref": "#/definitions/Setting" + }, + "readOnly": true, + "description": "A response message containing a list of account settings with their associated value." + } + }, + "description": "The settings list result.", + "type": "object" + } + }, + "parameters": { + "SettingNameParameter": { + "name": "setting-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account setting. Must be a valid settings option.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/storage.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/storage.json new file mode 100644 index 000000000000..5c9041fc03ea --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/storage.json @@ -0,0 +1,1613 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultClient", + "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", + "version": "7.5" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{vaultBaseUrl}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "vaultBaseUrl", + "description": "The vault name, for example https://myvault.vault.azure.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/storage": { + "get": { + "tags": [ + "Storage" + ], + "operationId": "GetStorageAccounts", + "description": "List storage accounts managed by the specified key vault. This operation requires the storage/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of storage accounts along with a link to the next page of storage accounts.", + "schema": { + "$ref": "#/definitions/StorageListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Storage account": { + "$ref": "./examples/listStorageAccount.json" + } + } + } + }, + "/deletedstorage": { + "get": { + "tags": [ + "DeletedStorage" + ], + "operationId": "GetDeletedStorageAccounts", + "summary": "Lists deleted storage accounts for the specified vault.", + "description": "The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of deleted storage accounts in the vault, along with a link to the next page of deleted storage accounts.", + "schema": { + "$ref": "#/definitions/DeletedStorageListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Deleted Storage Accounts": { + "$ref": "./examples/listDeletedStorageAccount.json" + } + } + } + }, + "/deletedstorage/{storage-account-name}": { + "get": { + "tags": [ + "DeletedStorage" + ], + "operationId": "GetDeletedStorageAccount", + "summary": "Gets the specified deleted storage account.", + "description": "The Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted storage account and information on when it will be purged, and how to recover the deleted storage account.", + "schema": { + "$ref": "#/definitions/DeletedStorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Get Deleted Storage": { + "$ref": "./examples/getDeletedStorageAccount.json" + } + } + }, + "delete": { + "tags": [ + "DeletedStorage" + ], + "operationId": "PurgeDeletedStorageAccount", + "summary": "Permanently deletes the specified storage account.", + "description": "The purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No content signaling that the storage account was purged forever." + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Purge Deleted Storage Account": { + "$ref": "./examples/purgeStorageAccount.json" + } + } + } + }, + "/deletedstorage/{storage-account-name}/recover": { + "post": { + "tags": [ + "DeletedStorage" + ], + "operationId": "RecoverDeletedStorageAccount", + "summary": "Recovers the deleted storage account.", + "description": "Recovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A storage bundle of the original storage account and its attributes.", + "schema": { + "$ref": "#/definitions/StorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Recover Deleted Storage Account": { + "$ref": "./examples/recoverStorageAccount.json" + } + } + } + }, + "/storage/{storage-account-name}/backup": { + "post": { + "tags": [ + "Storage" + ], + "operationId": "BackupStorageAccount", + "summary": "Backs up the specified storage account.", + "description": "Requests that a backup of the specified storage account be downloaded to the client. This operation requires the storage/backup permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The backup blob containing the backed up storage account.", + "schema": { + "$ref": "#/definitions/BackupStorageResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Backup Storage Account": { + "$ref": "./examples/backupStorageAccount.json" + } + } + } + }, + "/storage/restore": { + "post": { + "tags": [ + "Storage" + ], + "operationId": "RestoreStorageAccount", + "summary": "Restores a backed up storage account to a vault.", + "description": "Restores a backed up storage account to a vault. This operation requires the storage/restore permission.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/StorageRestoreParameters" + }, + "description": "The parameters to restore the storage account." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Restored storage account bundle in the vault.", + "schema": { + "$ref": "#/definitions/StorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Restore Storage Account": { + "$ref": "./examples/restoreStorageAccount.json" + } + } + } + }, + "/storage/{storage-account-name}": { + "delete": { + "tags": [ + "Storage" + ], + "operationId": "DeleteStorageAccount", + "description": "Deletes a storage account. This operation requires the storage/delete permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted storage account and information on when the storage account will be deleted, and how to recover the deleted storage account.", + "schema": { + "$ref": "#/definitions/DeletedStorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Delete Storage account": { + "$ref": "./examples/deleteStorageAccount.json" + } + } + }, + "get": { + "tags": [ + "Storage" + ], + "operationId": "GetStorageAccount", + "description": "Gets information about a specified storage account. This operation requires the storage/get permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved storage account.", + "schema": { + "$ref": "#/definitions/StorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Get Storage account": { + "$ref": "./examples/getStorageAccount.json" + } + } + }, + "put": { + "tags": [ + "Storage" + ], + "operationId": "SetStorageAccount", + "description": "Creates or updates a new storage account. This operation requires the storage/set permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/StorageAccountCreateParameters" + }, + "description": "The parameters to create a storage account." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The created storage account.", + "schema": { + "$ref": "#/definitions/StorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Set Storage account": { + "$ref": "./examples/setStorageAccount.json" + } + } + }, + "patch": { + "tags": [ + "Storage" + ], + "operationId": "UpdateStorageAccount", + "description": "Updates the specified attributes associated with the given storage account. This operation requires the storage/set/update permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/StorageAccountUpdateParameters" + }, + "description": "The parameters to update a storage account." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The updated storage account.", + "schema": { + "$ref": "#/definitions/StorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Update Storage account": { + "$ref": "./examples/updateStorageAccount.json" + } + } + } + }, + "/storage/{storage-account-name}/regeneratekey": { + "post": { + "tags": [ + "Storage" + ], + "operationId": "RegenerateStorageAccountKey", + "description": "Regenerates the specified key value for the given storage account. This operation requires the storage/regeneratekey permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/StorageAccountRegenerteKeyParameters" + }, + "description": "The parameters to regenerate storage account key." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The updated storage account.", + "schema": { + "$ref": "#/definitions/StorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Regenerate Storage account key": { + "$ref": "./examples/regenerateStorageAccountKey.json" + } + } + } + }, + "/storage/{storage-account-name}/sas": { + "get": { + "tags": [ + "Storage" + ], + "operationId": "GetSasDefinitions", + "description": "List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of SAS definitions along with a link to the next page of SAS definitions.", + "schema": { + "$ref": "#/definitions/SasDefinitionListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Storage Sas Definition": { + "$ref": "./examples/listStorageSasDefinition.json" + } + } + } + }, + "/deletedstorage/{storage-account-name}/sas": { + "get": { + "tags": [ + "DeletedStorage" + ], + "operationId": "GetDeletedSasDefinitions", + "summary": "Lists deleted SAS definitions for the specified vault and storage account.", + "description": "The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of deleted SAS definitions for the storage account, along with a link to the next page of deleted SAS definitions.", + "schema": { + "$ref": "#/definitions/DeletedSasDefinitionListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Deleted Storage Sas Definitions": { + "$ref": "./examples/listDeletedStorageSasDefinition.json" + } + } + } + }, + "/deletedstorage/{storage-account-name}/sas/{sas-definition-name}": { + "get": { + "tags": [ + "DeletedStorage" + ], + "operationId": "GetDeletedSasDefinition", + "summary": "Gets the specified deleted sas definition.", + "description": "The Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "sas-definition-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the SAS definition." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted SAS definition and information on when the it will be purged, and how to recover the deleted SAS definition.", + "schema": { + "$ref": "#/definitions/DeletedSasDefinitionBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Get Deleted Storage Sas Definition": { + "$ref": "./examples/getDeletedStorageSasDefinition.json" + } + } + } + }, + "/deletedstorage/{storage-account-name}/sas/{sas-definition-name}/recover": { + "post": { + "tags": [ + "DeletedStorage" + ], + "operationId": "RecoverDeletedSasDefinition", + "summary": "Recovers the deleted SAS definition.", + "description": "Recovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "sas-definition-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the SAS definition." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A SAS definition bundle of the original SAS definition and its attributes.", + "schema": { + "$ref": "#/definitions/SasDefinitionBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Recover Deleted Storage Sas Definition": { + "$ref": "./examples/recoverStorageSasDefinition.json" + } + } + } + }, + "/storage/{storage-account-name}/sas/{sas-definition-name}": { + "delete": { + "tags": [ + "Storage" + ], + "operationId": "DeleteSasDefinition", + "description": "Deletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "sas-definition-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the SAS definition." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted SAS definition and information on when the SAS definition will be deleted, and how to recover the deleted SAS definition.", + "schema": { + "$ref": "#/definitions/DeletedSasDefinitionBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Delete Storage Sas Definition": { + "$ref": "./examples/deleteStorageSasDefinition.json" + } + } + }, + "get": { + "tags": [ + "Storage" + ], + "operationId": "GetSasDefinition", + "description": "Gets information about a SAS definition for the specified storage account. This operation requires the storage/getsas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "sas-definition-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the SAS definition." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved SAS definition.", + "schema": { + "$ref": "#/definitions/SasDefinitionBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Get Storage Sas Definition": { + "$ref": "./examples/getStorageSasDefinition.json" + } + } + }, + "put": { + "tags": [ + "Storage" + ], + "operationId": "SetSasDefinition", + "description": "Creates or updates a new SAS definition for the specified storage account. This operation requires the storage/setsas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "sas-definition-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the SAS definition. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/SasDefinitionCreateParameters" + }, + "description": "The parameters to create a SAS definition." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The created SAS definition.", + "schema": { + "$ref": "#/definitions/SasDefinitionBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Set Storage Sas definition": { + "$ref": "./examples/setStorageSasDefinition.json" + } + } + }, + "patch": { + "tags": [ + "Storage" + ], + "operationId": "UpdateSasDefinition", + "description": "Updates the specified attributes associated with the given SAS definition. This operation requires the storage/setsas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "sas-definition-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the SAS definition." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/SasDefinitionUpdateParameters" + }, + "description": "The parameters to update a SAS definition." + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The updated SAS definition.", + "schema": { + "$ref": "#/definitions/SasDefinitionBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Update Storage Sas definition": { + "$ref": "./examples/updateStorageSasDefinition.json" + } + } + } + } + }, + "definitions": { + "StorageRestoreParameters": { + "properties": { + "value": { + "type": "string", + "x-ms-client-name": "storageBundleBackup", + "format": "base64url", + "description": "The backup blob associated with a storage account." + } + }, + "description": "The secret restore parameters.", + "required": [ + "value" + ] + }, + "StorageAccountAttributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "the enabled state of the object." + }, + "created": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Creation time in UTC." + }, + "updated": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Last updated time in UTC." + }, + "recoverableDays": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0." + }, + "recoveryLevel": { + "type": "string", + "description": "Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the system can purge the storage account, at the end of the retention interval.", + "enum": [ + "Purgeable", + "Recoverable+Purgeable", + "Recoverable", + "Recoverable+ProtectedSubscription", + "CustomizedRecoverable+Purgeable", + "CustomizedRecoverable", + "CustomizedRecoverable+ProtectedSubscription" + ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] + }, + "readOnly": true, + "x-nullable": false + } + }, + "description": "The storage account management attributes." + }, + "StorageBundle": { + "properties": { + "id": { + "type": "string", + "description": "The storage account id.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "The storage account resource id.", + "readOnly": true + }, + "activeKeyName": { + "type": "string", + "description": "The current active storage account key name.", + "readOnly": true + }, + "autoRegenerateKey": { + "type": "boolean", + "description": "whether keyvault should manage the storage account for the user.", + "readOnly": true + }, + "regenerationPeriod": { + "type": "string", + "description": "The key regeneration time duration specified in ISO-8601 format.", + "readOnly": true + }, + "attributes": { + "$ref": "#/definitions/StorageAccountAttributes", + "description": "The storage account attributes.", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs", + "readOnly": true + } + }, + "description": "A Storage account bundle consists of key vault storage account details plus its attributes." + }, + "DeletedStorageBundle": { + "allOf": [ + { + "$ref": "#/definitions/StorageBundle" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted storage account." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the storage account is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the storage account was deleted, in UTC" + } + }, + "description": "A deleted storage account bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged." + }, + "StorageAccountCreateParameters": { + "properties": { + "resourceId": { + "type": "string", + "description": "Storage account resource id." + }, + "activeKeyName": { + "type": "string", + "description": "Current active storage account key name." + }, + "autoRegenerateKey": { + "type": "boolean", + "description": "whether keyvault should manage the storage account for the user." + }, + "regenerationPeriod": { + "type": "string", + "description": "The key regeneration time duration specified in ISO-8601 format." + }, + "attributes": { + "x-ms-client-name": "StorageAccountAttributes", + "$ref": "#/definitions/StorageAccountAttributes", + "description": "The attributes of the storage account." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The storage account create parameters.", + "required": [ + "resourceId", + "activeKeyName", + "autoRegenerateKey" + ] + }, + "StorageAccountUpdateParameters": { + "properties": { + "activeKeyName": { + "type": "string", + "description": "The current active storage account key name." + }, + "autoRegenerateKey": { + "type": "boolean", + "description": "whether keyvault should manage the storage account for the user." + }, + "regenerationPeriod": { + "type": "string", + "description": "The key regeneration time duration specified in ISO-8601 format." + }, + "attributes": { + "x-ms-client-name": "StorageAccountAttributes", + "$ref": "#/definitions/StorageAccountAttributes", + "description": "The attributes of the storage account." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The storage account update parameters." + }, + "StorageAccountRegenerteKeyParameters": { + "properties": { + "keyName": { + "type": "string", + "description": "The storage account key name." + } + }, + "description": "The storage account key regenerate parameters.", + "required": [ + "keyName" + ] + }, + "StorageAccountItem": { + "properties": { + "id": { + "type": "string", + "description": "Storage identifier.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "Storage account resource Id.", + "readOnly": true + }, + "attributes": { + "$ref": "#/definitions/StorageAccountAttributes", + "description": "The storage account management attributes.", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs.", + "readOnly": true + } + }, + "description": "The storage account item containing storage account metadata." + }, + "DeletedStorageAccountItem": { + "allOf": [ + { + "$ref": "#/definitions/StorageAccountItem" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted storage account." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the storage account is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the storage account was deleted, in UTC" + } + }, + "description": "The deleted storage account item containing metadata about the deleted storage account." + }, + "StorageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountItem" + }, + "readOnly": true, + "description": "A response message containing a list of storage accounts in the key vault along with a link to the next page of storage accounts." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of storage accounts." + } + }, + "description": "The storage accounts list result." + }, + "DeletedStorageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedStorageAccountItem" + }, + "readOnly": true, + "description": "A response message containing a list of the deleted storage accounts in the vault along with a link to the next page of deleted storage accounts" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of deleted storage accounts." + } + }, + "description": "The deleted storage account list result" + }, + "SasDefinitionAttributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "the enabled state of the object." + }, + "created": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Creation time in UTC." + }, + "updated": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Last updated time in UTC." + }, + "recoverableDays": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0." + }, + "recoveryLevel": { + "type": "string", + "description": "Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only the system can purge the SAS definition, at the end of the retention interval.", + "enum": [ + "Purgeable", + "Recoverable+Purgeable", + "Recoverable", + "Recoverable+ProtectedSubscription", + "CustomizedRecoverable+Purgeable", + "CustomizedRecoverable", + "CustomizedRecoverable+ProtectedSubscription" + ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true + }, + "readOnly": true, + "x-nullable": false + } + }, + "description": "The SAS definition management attributes." + }, + "SasDefinitionBundle": { + "properties": { + "id": { + "type": "string", + "description": "The SAS definition id.", + "readOnly": true + }, + "sid": { + "x-ms-client-name": "SecretId", + "type": "string", + "description": "Storage account SAS definition secret id.", + "readOnly": true + }, + "templateUri": { + "type": "string", + "description": "The SAS definition token template signed with an arbitrary key. Tokens created according to the SAS definition will have the same properties as the template.", + "readOnly": true + }, + "sasType": { + "type": "string", + "description": "The type of SAS token the SAS definition will create.", + "enum": [ + "account", + "service" + ], + "x-ms-enum": { + "name": "SasTokenType", + "modelAsString": true + }, + "readOnly": true + }, + "validityPeriod": { + "type": "string", + "description": "The validity period of SAS tokens created according to the SAS definition.", + "readOnly": true + }, + "attributes": { + "$ref": "#/definitions/SasDefinitionAttributes", + "description": "The SAS definition attributes.", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs", + "readOnly": true + } + }, + "description": "A SAS definition bundle consists of key vault SAS definition details plus its attributes." + }, + "DeletedSasDefinitionBundle": { + "allOf": [ + { + "$ref": "#/definitions/SasDefinitionBundle" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted SAS definition." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the SAS definition is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the SAS definition was deleted, in UTC" + } + }, + "description": "A deleted SAS definition bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged." + }, + "SasDefinitionItem": { + "properties": { + "id": { + "type": "string", + "description": "The storage SAS identifier.", + "readOnly": true + }, + "sid": { + "x-ms-client-name": "SecretId", + "type": "string", + "description": "The storage account SAS definition secret id.", + "readOnly": true + }, + "attributes": { + "$ref": "#/definitions/SasDefinitionAttributes", + "description": "The SAS definition management attributes.", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs.", + "readOnly": true + } + }, + "description": "The SAS definition item containing storage SAS definition metadata." + }, + "DeletedSasDefinitionItem": { + "allOf": [ + { + "$ref": "#/definitions/SasDefinitionItem" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted SAS definition." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the SAS definition is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the SAS definition was deleted, in UTC" + } + }, + "description": "The deleted SAS definition item containing metadata about the deleted SAS definition." + }, + "SasDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SasDefinitionItem" + }, + "readOnly": true, + "description": "A response message containing a list of SAS definitions along with a link to the next page of SAS definitions." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of SAS definitions." + } + }, + "description": "The storage account SAS definition list result." + }, + "DeletedSasDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedSasDefinitionItem" + }, + "readOnly": true, + "description": "A response message containing a list of the deleted SAS definitions in the vault along with a link to the next page of deleted sas definitions" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of deleted SAS definitions." + } + }, + "description": "The deleted SAS definition list result" + }, + "SasDefinitionCreateParameters": { + "properties": { + "templateUri": { + "type": "string", + "description": "The SAS definition token template signed with an arbitrary key. Tokens created according to the SAS definition will have the same properties as the template." + }, + "sasType": { + "type": "string", + "description": "The type of SAS token the SAS definition will create.", + "enum": [ + "account", + "service" + ], + "x-ms-enum": { + "name": "SasTokenType", + "modelAsString": true + } + }, + "validityPeriod": { + "type": "string", + "description": "The validity period of SAS tokens created according to the SAS definition." + }, + "attributes": { + "x-ms-client-name": "SasDefinitionAttributes", + "$ref": "#/definitions/SasDefinitionAttributes", + "description": "The attributes of the SAS definition." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The SAS definition create parameters.", + "required": [ + "templateUri", + "sasType", + "validityPeriod" + ] + }, + "SasDefinitionUpdateParameters": { + "properties": { + "templateUri": { + "type": "string", + "description": "The SAS definition token template signed with an arbitrary key. Tokens created according to the SAS definition will have the same properties as the template." + }, + "sasType": { + "type": "string", + "description": "The type of SAS token the SAS definition will create.", + "enum": [ + "account", + "service" + ], + "x-ms-enum": { + "name": "SasTokenType", + "modelAsString": true + } + }, + "validityPeriod": { + "type": "string", + "description": "The validity period of SAS tokens created according to the SAS definition." + }, + "attributes": { + "x-ms-client-name": "SasDefinitionAttributes", + "$ref": "#/definitions/SasDefinitionAttributes", + "description": "The attributes of the SAS definition." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The SAS definition update parameters." + }, + "BackupStorageResult": { + "properties": { + "value": { + "type": "string", + "format": "base64url", + "readOnly": true, + "description": "The backup blob containing the backed up storage account." + } + }, + "description": "The backup storage result, containing the backup blob." + } + } +} diff --git a/specification/keyvault/data-plane/readme.md b/specification/keyvault/data-plane/readme.md index 95a427fb0b4a..aeddacfc797e 100644 --- a/specification/keyvault/data-plane/readme.md +++ b/specification/keyvault/data-plane/readme.md @@ -26,15 +26,31 @@ These are the global settings for the KeyVault API. ``` yaml openapi-type: data-plane -tag: package-preview-7.5-preview.1 +tag: package-7.5 ``` +### Tag: package-7.5 + +These settings apply only when `--tag=package-7.5` is specified on the command line. + +```yaml $(tag) == 'package-7.5' +input-file: + - Microsoft.KeyVault/stable/7.5/backuprestore.json + - Microsoft.KeyVault/stable/7.5/certificates.json + - Microsoft.KeyVault/stable/7.5/common.json + - Microsoft.KeyVault/stable/7.5/keys.json + - Microsoft.KeyVault/stable/7.5/rbac.json + - Microsoft.KeyVault/stable/7.5/secrets.json + - Microsoft.KeyVault/stable/7.5/securitydomain.json + - Microsoft.KeyVault/stable/7.5/settings.json + - Microsoft.KeyVault/stable/7.5/storage.json +``` ### Tag: package-preview-7.5-preview.1 These settings apply only when `--tag=package-preview-7.5-preview.1` is specified on the command line. -```yaml $(tag) == 'package-preview-7.5-preview.1' +``` yaml $(tag) == 'package-preview-7.5-preview.1' input-file: - Microsoft.KeyVault/preview/7.5-preview.1/backuprestore.json - Microsoft.KeyVault/preview/7.5-preview.1/certificates.json @@ -46,6 +62,7 @@ input-file: - Microsoft.KeyVault/preview/7.5-preview.1/settings.json - Microsoft.KeyVault/preview/7.5-preview.1/storage.json ``` + ### Tag: package-7.4 These settings apply only when `--tag=package-7.4` is specified on the command line. diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/LiftrBase/main.tsp b/specification/liftrastronomer/Astronomer.Astro.Management/LiftrBase/main.tsp index ed53138e04b1..7ce7ff252b5b 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/LiftrBase/main.tsp +++ b/specification/liftrastronomer/Astronomer.Astro.Management/LiftrBase/main.tsp @@ -15,7 +15,9 @@ enum Versions { } @doc("Marketplace subscription status of a resource.") -enum MarketplaceSubscriptionStatus { +union MarketplaceSubscriptionStatus { + string, + @doc("Purchased but not yet activated") PendingFulfillmentStart: "PendingFulfillmentStart", @@ -121,13 +123,15 @@ model SingleSignOnProperties { } @doc("Various states of the SSO resource") -enum SingleSignOnStates { +union SingleSignOnStates { + string, + @doc("Initial state of the SSO resource") - Initial, + "Initial", @doc("State of the SSO resource when it is enabled") - Enable, + "Enable", @doc("State of the SSO resource when it is disabled") - Disable, + "Disable", } diff --git a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json index dc5f45c3a5c8..be7091f241a4 100644 --- a/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json +++ b/specification/liftrastronomer/resource-manager/Astronomer.Astro/preview/2023-08-01-preview/astronomer.json @@ -60,7 +60,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -99,7 +99,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OrganizationResourceListResult" } @@ -141,7 +141,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OrganizationResourceListResult" } @@ -193,7 +193,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OrganizationResource" } @@ -322,7 +322,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OrganizationResource" } @@ -401,7 +401,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", diff --git a/specification/liftrastronomer/resource-manager/readme.go.md b/specification/liftrastronomer/resource-manager/readme.go.md new file mode 100644 index 000000000000..b6bdc27d97bb --- /dev/null +++ b/specification/liftrastronomer/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/astro/armastro +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +``` diff --git a/specification/liftrastronomer/resource-manager/readme.md b/specification/liftrastronomer/resource-manager/readme.md index d9225ab88bbc..78b72bdaeee0 100644 --- a/specification/liftrastronomer/resource-manager/readme.md +++ b/specification/liftrastronomer/resource-manager/readme.md @@ -27,8 +27,14 @@ These are the global settings for the astronomer service. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-08-01-preview +tag: package-2023-08-01 ``` + +``` yaml +modelerfour: + flatten-models: false +``` + ### Tag: package-2023-08-01-preview These settings apply only when `--tag=package-2023-08-01-preview` is specified on the command line. @@ -45,4 +51,36 @@ These settings apply only when `--tag=package-2023-08-01` is specified on the co ```yaml $(tag) == 'package-2023-08-01' input-file: - Astronomer.Astro/stable/2023-08-01/astronomer.json -``` \ No newline at end of file +``` + + +# 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-java + - repo: azure-sdk-for-js + - repo: azure-sdk-for-go +``` + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) \ No newline at end of file diff --git a/specification/liftrastronomer/resource-manager/readme.python.md b/specification/liftrastronomer/resource-manager/readme.python.md new file mode 100644 index 000000000000..45003608943d --- /dev/null +++ b/specification/liftrastronomer/resource-manager/readme.python.md @@ -0,0 +1,19 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +title: AstroMgmtClient +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-astro +namespace: azure.mgmt.astro +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/astro/azure-mgmt-astro/azure/mgmt/astro +``` diff --git a/specification/deploymentmanager/resource-manager/readme.typescript.md b/specification/liftrastronomer/resource-manager/readme.typescript.md similarity index 67% rename from specification/deploymentmanager/resource-manager/readme.typescript.md rename to specification/liftrastronomer/resource-manager/readme.typescript.md index c5770c7c83d6..d9fb2b5a82a1 100644 --- a/specification/deploymentmanager/resource-manager/readme.typescript.md +++ b/specification/liftrastronomer/resource-manager/readme.typescript.md @@ -4,9 +4,10 @@ These settings apply only when `--typescript` is specified on the command line. Please also specify `--typescript-sdks-folder=`. ``` yaml $(typescript) +title: AstroManagementClient typescript: azure-arm: true - package-name: "@azure/arm-deploymentmanager" - output-folder: "$(typescript-sdks-folder)/sdk/deploymentmanager/arm-deploymentmanager" + package-name: "@azure/arm-astro" + output-folder: "$(typescript-sdks-folder)/sdk/astro/arm-astro" generate-metadata: true ``` diff --git a/specification/loadtestservice/LoadTestService/models.tsp b/specification/loadtestservice/LoadTestService/models.tsp index 519a40e3acca..6845712c4e92 100644 --- a/specification/loadtestservice/LoadTestService/models.tsp +++ b/specification/loadtestservice/LoadTestService/models.tsp @@ -830,7 +830,7 @@ model DimensionFilter { @doc("The response to a metrics query.") @friendlyName("Metrics") -// using friendlyName to change the name of the model due to issue in using projectedName '@projectedName("json", "Metrics")' https://github.com/microsoft/typespec/issues/2276 +// using friendlyName to change the name of the model due to issue in using projectedName '@encodedName("application/json", "Metrics")' https://github.com/microsoft/typespec/issues/2276 model Metrics is Azure.Core.Page; @doc("The time series returned when a data query is performed.") diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json index aeca65383679..66bc44bb985f 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json @@ -2308,30 +2308,6 @@ } } }, - "PFAction": { - "type": "string", - "description": "Action to take on failure of pass/fail criteria.", - "enum": [ - "continue", - "stop" - ], - "x-ms-enum": { - "name": "PFAction", - "modelAsString": true, - "values": [ - { - "name": "continue", - "value": "continue", - "description": "Test will continue to run even if pass fail metric criteria metric gets failed." - }, - { - "name": "stop", - "value": "stop", - "description": "Test run will stop if pass fail criteria metric is not passed." - } - ] - } - }, "PFAgFunc": { "type": "string", "description": "Aggregation functions for pass/fail criteria.", @@ -2605,9 +2581,29 @@ "description": "The value to compare with the client metric. Allowed values - ‘error : [0.0 ,\n100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms." }, "action": { - "$ref": "#/definitions/PFAction", + "type": "string", "description": "Action taken after the threshold is met. Default is ‘continue’.", - "default": "continue" + "default": "continue", + "enum": [ + "continue", + "stop" + ], + "x-ms-enum": { + "name": "PFAction", + "modelAsString": true, + "values": [ + { + "name": "continue", + "value": "continue", + "description": "Test will continue to run even if pass fail metric criteria metric gets failed." + }, + { + "name": "stop", + "value": "stop", + "description": "Test run will stop if pass fail criteria metric is not passed." + } + ] + } }, "actualValue": { "type": "number", diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json index d51356815ed8..a06c110812bb 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json @@ -2230,30 +2230,6 @@ } } }, - "PFAction": { - "type": "string", - "description": "Action to take on failure of pass/fail criteria.", - "enum": [ - "continue", - "stop" - ], - "x-ms-enum": { - "name": "PFAction", - "modelAsString": true, - "values": [ - { - "name": "continue", - "value": "continue", - "description": "Test will continue to run even if pass fail metric criteria metric gets failed." - }, - { - "name": "stop", - "value": "stop", - "description": "Test run will stop if pass fail criteria metric is not passed." - } - ] - } - }, "PFAgFunc": { "type": "string", "description": "Aggregation functions for pass/fail criteria.", @@ -2527,9 +2503,29 @@ "description": "The value to compare with the client metric. Allowed values - ‘error : [0.0 ,\n100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms." }, "action": { - "$ref": "#/definitions/PFAction", + "type": "string", "description": "Action taken after the threshold is met. Default is ‘continue’.", - "default": "continue" + "default": "continue", + "enum": [ + "continue", + "stop" + ], + "x-ms-enum": { + "name": "PFAction", + "modelAsString": true, + "values": [ + { + "name": "continue", + "value": "continue", + "description": "Test will continue to run even if pass fail metric criteria metric gets failed." + }, + { + "name": "stop", + "value": "stop", + "description": "Test run will stop if pass fail criteria metric is not passed." + } + ] + } }, "actualValue": { "type": "number", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/createOrUpdate.json new file mode 100644 index 000000000000..23886af19add --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/createOrUpdate.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "groupId": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "reservedCapacity": 1 + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Premium", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "reservedCapacity": 1 + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Premium", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "reservedCapacity": 1 + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/delete.json new file mode 100644 index 000000000000..353c8a97bb89 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "groupId": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/get.json new file mode 100644 index 000000000000..f248168c150c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/get.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "groupId": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "reservedCapacity": 1 + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:53", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:53", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/list.json new file mode 100644 index 000000000000..6acdc09941ce --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/list.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "groupId": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "reservedCapacity": 1 + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:08", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:08", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Premium", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/listBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/listBySubscription.json new file mode 100644 index 000000000000..f22dd8f1af66 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/listBySubscription.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-01-01-preview", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "reservedCapacity": 1 + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/update.json new file mode 100644 index 000000000000..1affd50c29d8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/CapacityReservationGroup/update.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "groupId": "string", + "api-version": "2024-01-01-preview", + "body": { + "tags": {}, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "reservedCapacity": 1 + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Premium", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/AKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/AKSCompute.json new file mode 100644 index 000000000000..3a0f5add62e3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/AKSCompute.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "properties": { + "agentCount": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded", + "properties": { + "agentCount": 4 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/AmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/AmlCompute.json new file mode 100644 index 000000000000..2c50cacebdb8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/AmlCompute.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "description": "some compute", + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "computeType": "AmlCompute", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "osType": "Windows", + "virtualMachineImage": null, + "isolatedNetwork": false, + "subnet": { + "id": "test-subnet-resource-id" + }, + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "Enabled", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "errors": null, + "currentNodeCount": 0, + "targetNodeCount": 1, + "nodeStateCounts": { + "preparingNodeCount": 0, + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "leavingNodeCount": 0, + "preemptedNodeCount": 0 + }, + "enableNodePublicIp": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/BasicAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/BasicAKSCompute.json new file mode 100644 index 000000000000..37da2fd685c9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/BasicAKSCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AKS" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/BasicAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/BasicAmlCompute.json new file mode 100644 index 000000000000..e4a595bdb57a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/BasicAmlCompute.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "osType": "Windows", + "virtualMachineImage": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myImageGallery/images/myImageDefinition/versions/0.0.1" + }, + "isolatedNetwork": false, + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "NotSpecified", + "enableNodePublicIp": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json new file mode 100644 index 000000000000..1cdf489bc52f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "DataFactory" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/ComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/ComputeInstance.json new file mode 100644 index 000000000000..7f7120065ada --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/ComputeInstance.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6", + "subnet": { + "id": "test-subnet-resource-id" + }, + "applicationSharingPolicy": "Personal", + "autologgerSettings": { + "mlflowAutologger": "Enabled" + }, + "sshSettings": { + "sshPublicAccess": "Disabled" + }, + "enableOSPatching": true, + "releaseQuotaOnStop": true, + "enableSSO": true, + "enableRootAccess": true, + "customServices": [ + { + "name": "rstudio-workbench", + "image": { + "type": "docker", + "reference": "ghcr.io/azure/rstudio-workbench:latest" + }, + "environmentVariables": { + "RSP_LICENSE": { + "type": "local", + "value": "XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX" + } + }, + "docker": { + "privileged": true + }, + "endpoints": [ + { + "protocol": "http", + "name": "connect", + "target": 8787, + "published": 4444, + "hostIp": null + } + ], + "volumes": [ + { + "type": "bind", + "source": "/mnt/azureuser/", + "target": "/home/testuser/", + "readOnly": true + } + ], + "kernel": { + "displayName": "TestKernel", + "language": "python", + "argv": [ + "option1", + "option2", + "option3" + ] + } + } + ], + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json new file mode 100644 index 000000000000..9fa9546b06bc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json new file mode 100644 index 000000000000..1ad6b9908e7a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6", + "applicationSharingPolicy": "Personal", + "sshSettings": { + "sshPublicAccess": "Disabled" + }, + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + }, + "schedules": { + "computeStartStop": [ + { + "status": "Enabled", + "action": "Stop", + "triggerType": "Cron", + "cron": { + "expression": "0 18 * * *", + "startTime": "2021-04-23T01:30:00", + "timeZone": "Pacific Standard Time" + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/KubernetesCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/KubernetesCompute.json new file mode 100644 index 000000000000..d82539ec6bee --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/createOrUpdate/KubernetesCompute.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "properties": { + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "provisioningState": "Creating", + "properties": { + "relayConnectionString": null, + "serviceBusConnectionString": null, + "extensionPrincipalId": null, + "extensionInstanceReleaseTrain": "stable", + "vcName": null, + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "provisioningState": "Creating", + "properties": { + "relayConnectionString": null, + "serviceBusConnectionString": null, + "extensionPrincipalId": null, + "extensionInstanceReleaseTrain": "stable", + "vcName": null, + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/delete.json new file mode 100644 index 000000000000..b5909104b00f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "underlyingResourceAction": "Delete" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/AKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/AKSCompute.json new file mode 100644 index 000000000000..33de1ac25923 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/AKSCompute.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/AmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/AmlCompute.json new file mode 100644 index 000000000000..23351eba18d4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/AmlCompute.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "computeType": "AmlCompute", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "osType": "Windows", + "virtualMachineImage": null, + "isolatedNetwork": false, + "subnet": { + "id": "test-subnet-resource-id" + }, + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "Enabled", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "errors": null, + "currentNodeCount": 0, + "targetNodeCount": 1, + "nodeStateCounts": { + "preparingNodeCount": 0, + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "leavingNodeCount": 0, + "preemptedNodeCount": 0 + }, + "enableNodePublicIp": true + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/ComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/ComputeInstance.json new file mode 100644 index 000000000000..136da7b60a59 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/ComputeInstance.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "computeType": "ComputeInstance", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "subnet": { + "id": "test-subnet-resource-id" + }, + "applicationSharingPolicy": "Shared", + "sshSettings": { + "sshPublicAccess": "Enabled", + "adminUserName": "azureuser", + "sshPort": 22 + }, + "osImageMetadata": { + "currentImageVersion": "22.06.14", + "latestImageVersion": "22.07.22", + "isLatestOsImageVersion": false + }, + "enableOSPatching": true, + "releaseQuotaOnStop": true, + "enableSSO": true, + "enableRootAccess": true, + "customServices": [ + { + "name": "rstudio-workbench", + "image": { + "type": "docker", + "reference": "ghcr.io/azure/rstudio-workbench:latest" + }, + "environmentVariables": { + "RSP_LICENSE": { + "type": "local", + "value": "XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX" + } + }, + "docker": { + "privileged": true + }, + "endpoints": [ + { + "protocol": "http", + "name": "connect", + "target": 8787, + "published": 4444, + "hostIp": null + } + ], + "volumes": [ + { + "type": "bind", + "source": "/mnt/azureuser/", + "target": "/home/testuser/", + "readOnly": true, + "consistency": "test", + "bind": { + "propagation": "test", + "createHostPath": true, + "selinux": "test" + }, + "volume": { + "nocopy": true + }, + "tmpfs": { + "size": 10 + } + } + ] + } + ], + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + }, + "createdBy": { + "userName": "foobar@microsoft.com", + "userOrgId": "00000000-0000-0000-0000-000000000000", + "userId": "00000000-0000-0000-0000-000000000000" + }, + "connectivityEndpoints": { + "publicIpAddress": "10.0.0.1", + "privateIpAddress": "10.0.0.1" + }, + "applications": [ + { + "displayName": "Jupyter", + "endpointUri": "https://compute123.eastus2.azureml.net/jupyter" + } + ], + "errors": null, + "state": "Running" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/KubernetesCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/KubernetesCompute.json new file mode 100644 index 000000000000..c4a74f2d8a4a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/get/KubernetesCompute.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "provisioningState": "Succeeded", + "isAttachedCompute": true, + "properties": { + "relayConnectionString": null, + "serviceBusConnectionString": null, + "extensionPrincipalId": null, + "extensionInstanceReleaseTrain": "stable", + "vcName": null, + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/getAllowedVMSizesForResize.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/getAllowedVMSizesForResize.json new file mode 100644 index 000000000000..f45c3587960f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/getAllowedVMSizesForResize.json @@ -0,0 +1,255 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_DS1_v2", + "family": "standardDSv2Family", + "vCPUs": 1, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 7168, + "memoryGB": 3.5, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.07, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS2_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 14336, + "memoryGB": 7.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.15, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS3_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.29, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS4_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.58, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS5_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 1.17, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS11_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.18, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS12_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.37, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS13_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.74, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS14_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 229376, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 1.48, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/list.json new file mode 100644 index 000000000000..fce23286bf5e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/list.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute1234", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute1234", + "location": "eastus", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute1234-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/listKeys.json new file mode 100644 index 000000000000..2266552eaeb1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/listKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "computeType": "AKS", + "userKubeConfig": "user kube config...", + "adminKubeConfig": "admin kube config...", + "imagePullSecretName": "the image pull secret name" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/listNodes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/listNodes.json new file mode 100644 index 000000000000..194ccf7fbf39 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/listNodes.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "nodes": [ + { + "nodeId": "tvm-3601533753_1-20170719t162906z", + "privateIpAddress": "13.84.190.124", + "publicIpAddress": "13.84.190.134", + "port": 50000, + "nodeState": "running", + "runId": "2f378a44-38f2-443a-9f0d-9909d0b47890" + }, + { + "nodeId": "tvm-3601533753_2-20170719t162906z", + "privateIpAddress": "13.84.190.124", + "publicIpAddress": "13.84.190.134", + "port": 50001, + "nodeState": "idle" + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/patch.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/patch.json new file mode 100644 index 000000000000..67f3de32d069 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/patch.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "parameters": { + "properties": { + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/resize.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/resize.json new file mode 100644 index 000000000000..28da004947c1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/resize.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "parameters": { + "targetVMSize": "Standard_DS11_v2" + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/restart.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/restart.json new file mode 100644 index 000000000000..93fa7ec4642c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/restart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/start.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/start.json new file mode 100644 index 000000000000..93fa7ec4642c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/start.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/stop.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/stop.json new file mode 100644 index 000000000000..93fa7ec4642c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/stop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/updateCustomServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/updateCustomServices.json new file mode 100644 index 000000000000..166ca3d4972d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/updateCustomServices.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "customServices": [ + { + "name": "rstudio-workbench", + "image": { + "type": "docker", + "reference": "ghcr.io/azure/rstudio-workbench:latest" + }, + "environmentVariables": { + "RSP_LICENSE": { + "type": "local", + "value": "XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX" + } + }, + "docker": { + "privileged": true + }, + "endpoints": [ + { + "protocol": "http", + "name": "connect", + "target": 8787, + "published": 4444, + "hostIp": null + } + ], + "volumes": [ + { + "type": "bind", + "source": "/mnt/azureuser/", + "target": "/home/testuser/", + "readOnly": true + } + ] + } + ] + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/updateDataMounts.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/updateDataMounts.json new file mode 100644 index 000000000000..68f55d15fa77 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/updateDataMounts.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "dataMounts": [ + { + "source": "azureml://subscriptions/some-sub/resourcegroups/some-rg/workspaces/some-ws/data/some-data-asset-name/versions/some-data-asset-version", + "sourceType": "URI", + "mountName": "hello", + "mountAction": "Mount", + "mountMode": "ReadOnly", + "mountPath": "/some/random/path/on/host" + } + ] + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/updateIdleShutdownSetting.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/updateIdleShutdownSetting.json new file mode 100644 index 000000000000..5b00927cf897 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Compute/updateIdleShutdownSetting.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-01-01-preview", + "parameters": { + "idleTimeBeforeShutdown": "PT120M" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/DataReference/getBlobReferenceSAS.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/DataReference/getBlobReferenceSAS.json new file mode 100644 index 000000000000..89dbaa0c9b84 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/DataReference/getBlobReferenceSAS.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "assetId": "string", + "blobUri": "https://www.contoso.com/example" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "NoCredentials" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json new file mode 100644 index 000000000000..96d3dfa0bb66 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "skipValidation": false, + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey", + "key": "string" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "isDefault": false, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "isDefault": false, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json new file mode 100644 index 000000000000..d3d4fe993c78 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "skipValidation": false, + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal", + "clientSecret": "string" + } + }, + "datastoreType": "AzureDataLakeGen1", + "storeName": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } + }, + "datastoreType": "AzureDataLakeGen1", + "storeName": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } + }, + "datastoreType": "AzureDataLakeGen1", + "storeName": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json new file mode 100644 index 000000000000..26c551a70abe --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "skipValidation": false, + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal", + "clientSecret": "string" + } + }, + "datastoreType": "AzureDataLakeGen2", + "filesystem": "string", + "accountName": "string", + "endpoint": "string", + "protocol": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } + }, + "datastoreType": "AzureDataLakeGen2", + "filesystem": "string", + "accountName": "string", + "endpoint": "string", + "protocol": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } + }, + "datastoreType": "AzureDataLakeGen2", + "filesystem": "string", + "accountName": "string", + "endpoint": "string", + "protocol": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json new file mode 100644 index 000000000000..6aa0dc2af462 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "skipValidation": false, + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey", + "key": "string" + } + }, + "datastoreType": "AzureFile", + "accountName": "string", + "fileShareName": "string", + "endpoint": "string", + "protocol": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureFile", + "accountName": "string", + "fileShareName": "string", + "endpoint": "string", + "protocol": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureFile", + "accountName": "string", + "fileShareName": "string", + "endpoint": "string", + "protocol": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/delete.json new file mode 100644 index 000000000000..c57832f83d32 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/get.json new file mode 100644 index 000000000000..a37e4bf69349 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "isDefault": false, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/list.json new file mode 100644 index 000000000000..4b9011a8768f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/list.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "count": 1, + "isDefault": false, + "names": [ + "string" + ], + "searchText": "string", + "orderBy": "string", + "orderByAsc": false + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "isDefault": false, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/listSecrets.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/listSecrets.json new file mode 100644 index 000000000000..3bf2ae34520a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Datastore/listSecrets.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "secretsType": "AccountKey", + "key": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/create.json new file mode 100644 index 000000000000..d9f4bd884a8b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/create.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "testworkspace", + "endpointName": "Azure.OpenAI", + "deploymentName": "text-davinci-003", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "type": "Azure.OpenAI", + "model": { + "format": "OpenAI", + "name": "text-davinci-003", + "version": "1" + }, + "versionUpgradeOption": "OnceNewDefaultVersionAvailable" + } + } + }, + "responses": { + "200": { + "body": { + "systemData": { + "createdBy": "00000000-1111-2222-3333-444444444444", + "createdByType": "Application", + "lastModifiedBy": "00000000-1111-2222-3333-444444444444", + "lastModifiedByType": "Application" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/endpoints/Azure.OpenAI/deployments/text-davinci-003", + "name": "text-davinci-003", + "type": "Microsoft.MachineLearningServices/workspaces/endpoints/deployments", + "properties": { + "type": "Azure.OpenAI", + "model": { + "format": "OpenAI", + "name": "text-davinci-003", + "version": "1", + "source": null + }, + "versionUpgradeOption": "OnceNewDefaultVersionAvailable", + "raiPolicyName": "Microsoft.Default", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/delete.json new file mode 100644 index 000000000000..6e0d7f18e0e6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "endpointName": "Azure.OpenAI", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/get.json new file mode 100644 index 000000000000..78c536a78071 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "testworkspace", + "endpointName": "Azure.OpenAI", + "deploymentName": "text-davinci-003", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "systemData": { + "createdBy": "00000000-1111-2222-3333-444444444444", + "createdByType": "Application", + "lastModifiedBy": "00000000-1111-2222-3333-444444444444", + "lastModifiedByType": "Application" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/endpoints/Azure.OpenAI/deployments/text-davinci-003", + "name": "text-davinci-003", + "type": "Microsoft.MachineLearningServices/workspaces/endpoints/deployments", + "properties": { + "type": "Azure.OpenAI", + "model": { + "format": "OpenAI", + "name": "text-davinci-003", + "version": "1", + "source": null + }, + "versionUpgradeOption": "OnceNewDefaultVersionAvailable", + "raiPolicyName": "Microsoft.Default", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/getDeployments.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/getDeployments.json new file mode 100644 index 000000000000..b4ab2364b071 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/getDeployments.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "testworkspace", + "endpointName": "Azure.OpenAI", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "systemData": { + "createdBy": "00000000-1111-2222-3333-444444444444", + "createdByType": "Application", + "lastModifiedBy": "00000000-1111-2222-3333-444444444444", + "lastModifiedByType": "Application" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/endpoints/Azure.OpenAI/deployments/text-davinci-003", + "name": "text-davinci-003", + "type": "Microsoft.MachineLearningServices/workspaces/endpoints/deployments", + "properties": { + "type": "Azure.OpenAI", + "model": { + "format": "OpenAI", + "name": "text-davinci-003", + "version": "1", + "source": null + }, + "versionUpgradeOption": "OnceNewDefaultVersionAvailable", + "raiPolicyName": "Microsoft.Default", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/getInWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/getInWorkspace.json new file mode 100644 index 000000000000..1d5f06f04704 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/Deployment/getInWorkspace.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "systemData": { + "createdBy": "00000000-1111-2222-3333-444444444444", + "createdByType": "Application", + "lastModifiedBy": "00000000-1111-2222-3333-444444444444", + "lastModifiedByType": "Application" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/endpoints/Azure.OpenAI/deployments/text-davinci-003", + "name": "text-davinci-003", + "type": "Microsoft.MachineLearningServices/workspaces/endpoints/deployments", + "properties": { + "type": "Azure.OpenAI", + "model": { + "format": "OpenAI", + "name": "text-davinci-003", + "version": "1", + "source": null + }, + "versionUpgradeOption": "OnceNewDefaultVersionAvailable", + "raiPolicyName": "Microsoft.Default", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/create.json new file mode 100644 index 000000000000..9cd17a3001d9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/create.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "endpointName": "Azure.OpenAI", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "endpointType": "Azure.OpenAI", + "name": "Azure.OpenAI", + "associatedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveService/account/account-1" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/endpoints/Azure.OpenAI", + "name": "Azure.OpenAI", + "type": "Microsoft.MachineLearningServices/workspaces/endpoints", + "properties": { + "endpointType": "Azure.OpenAI", + "name": "Azure.OpenAI", + "associatedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveService/account/account-1", + "endpointUri": "https://www.contoso.com/", + "provisioningState": "Succeeded", + "failureReason": "some_string" + }, + "systemData": { + "createdAt": "2020-01-01T00:00:00Z", + "createdBy": "some_string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T00:00:00Z", + "lastModifiedBy": "some_string", + "lastModifiedByType": "User" + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/get.json new file mode 100644 index 000000000000..4f029a367148 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "endpointName": "Azure.OpenAI", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/endpoints/Azure.OpenAI", + "name": "Azure.OpenAI", + "type": "Microsoft.MachineLearningServices/workspaces/endpoints", + "properties": { + "endpointType": "Azure.OpenAI", + "name": "Azure.OpenAI", + "associatedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveService/account/account-1", + "endpointUri": "https://www.contoso.com/", + "provisioningState": "Succeeded", + "failureReason": "some_string" + }, + "systemData": { + "createdAt": "2020-01-01T00:00:00Z", + "createdBy": "some_string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T00:00:00Z", + "lastModifiedBy": "some_string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/getModels.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/getModels.json new file mode 100644 index 000000000000..4904fb8a4b97 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/getModels.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "endpointName": "Azure.OpenAI", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "baseModel": null, + "isDefaultVersion": false, + "skus": [ + { + "name": "Standard", + "usageName": "OpenAI.Standard.ada", + "deprecationDate": "2024-03-01T00:00:00+00:00", + "capacity": { + "minimum": null, + "maximum": 10000, + "step": null, + "default": 120 + }, + "rateLimits": [ + { + "count": 1.0, + "renewalPeriod": 10.0, + "rules": [] + }, + { + "count": 1000.0, + "renewalPeriod": 60.0, + "rules": [] + } + ] + } + ], + "maxCapacity": 3, + "capabilities": { + "fineTune": "true", + "inference": "false", + "scaleType": "Manual", + "completion": "true", + "search": "true", + "FineTuneTokensMaxValue": "2000000000" + }, + "finetuneCapabilities": { + "scaleType": "Manual,Standard", + "completion": "true", + "search": "true", + "FineTuneTokensMaxValue": "2000000000" + }, + "deprecation": { + "fineTune": "2024-07-05T00:00:00+00:00", + "inference": "2024-07-05T00:00:00+00:00" + }, + "systemData": { + "createdBy": "Microsoft", + "createdByType": null, + "lastModifiedBy": "Microsoft", + "lastModifiedByType": null + }, + "format": "OpenAI", + "name": "ada", + "version": "1", + "source": null, + "callRateLimit": null + }, + { + "baseModel": null, + "isDefaultVersion": false, + "skus": [ + { + "name": "Standard", + "usageName": "OpenAI.Standard.babbage", + "deprecationDate": "2024-03-01T00:00:00+00:00", + "capacity": { + "minimum": null, + "maximum": 10000, + "step": null, + "default": 120 + }, + "rateLimits": [ + { + "count": 1.0, + "renewalPeriod": 10.0, + "rules": [] + }, + { + "count": 1000.0, + "renewalPeriod": 60.0, + "rules": [] + } + ] + } + ], + "maxCapacity": 3, + "capabilities": { + "fineTune": "true", + "inference": "false", + "scaleType": "Manual", + "completion": "true", + "search": "true", + "FineTuneTokensMaxValue": "2000000000" + }, + "finetuneCapabilities": { + "scaleType": "Manual,Standard", + "completion": "true", + "search": "true", + "FineTuneTokensMaxValue": "2000000000" + }, + "deprecation": { + "fineTune": "2024-07-05T00:00:00+00:00", + "inference": "2024-07-05T00:00:00+00:00" + }, + "systemData": { + "createdBy": "Microsoft", + "createdByType": null, + "lastModifiedBy": "Microsoft", + "lastModifiedByType": null + }, + "format": "OpenAI", + "name": "babbage", + "version": "1" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/list.json new file mode 100644 index 000000000000..0ef44f0ae60c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/list.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "api-version": "2024-01-01-preview", + "$skip": "skip_string", + "endpointType": "Azure.OpenAI" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/endpoints/Azure.OpenAI", + "name": "Azure.OpenAI", + "type": "Microsoft.MachineLearningServices/workspaces/endpoints", + "properties": { + "endpointType": "Azure.OpenAI", + "name": "Azure.OpenAI", + "associatedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveService/account/account-1", + "endpointUri": "https://www.contoso.com/", + "provisioningState": "Succeeded", + "failureReason": "some_string" + }, + "systemData": { + "createdAt": "2020-01-01T00:00:00Z", + "createdBy": "some_string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T00:00:00Z", + "lastModifiedBy": "some_string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "some_string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/listKeys.json new file mode 100644 index 000000000000..2065c85e1ced --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/listKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "endpointName": "Azure.OpenAI", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "keys": { + "key1": "some_string", + "key2": "some_string" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/regenerateKey.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/regenerateKey.json new file mode 100644 index 000000000000..966b6a7277fb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Endpoint/regenerateKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "endpointName": "Azure.OpenAI", + "api-version": "2024-01-01-preview", + "body": { + "keyName": "Key1" + } + }, + "responses": { + "200": { + "body": { + "key1": "some_string", + "key2": "some_string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ExternalFQDN/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ExternalFQDN/get.json new file mode 100644 index 000000000000..bc9b427b0dd3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ExternalFQDN/get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "category": "Azure Active Directory", + "endpoints": [ + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + }, + { + "properties": { + "category": "Azure portal", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Feature/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Feature/get.json new file mode 100644 index 000000000000..f00e6ec464f0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Feature/get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "featuresetName": "string", + "featuresetVersion": "string", + "featureName": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "featureName": "string", + "dataType": "Float" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:51", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:51", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Feature/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Feature/list.json new file mode 100644 index 000000000000..4e4fc37dbb4d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Feature/list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "featuresetName": "string", + "featuresetVersion": "string", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "tags": "string", + "featureName": "string", + "description": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "featureName": "string", + "dataType": "Boolean" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:50", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:50", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/AutoMLJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/AutoMLJob/createOrUpdate.json new file mode 100644 index 000000000000..b5f2199827ab --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/AutoMLJob/createOrUpdate.json @@ -0,0 +1,333 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "f69c8d5a-9b39-4183-92d3-a2b18944cf95": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Direct", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "CancelRequested", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "94ce04ed-3b17-4e48-a2a6-a923068268fd": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "a6f57022-8e31-44db-98e6-fa9495abb01c": null + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:22", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Provisioning", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "0aec33cb-4916-4b3b-b610-35f3f78cc6f0": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Direct", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "342c3b36-f4d6-4af6-8410-7198803cff8f": null + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:22", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/AutoMLJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/AutoMLJob/get.json new file mode 100644 index 000000000000..c444c6727cfd --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/AutoMLJob/get.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Scheduled", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "9c4f5d89-ed21-42e3-9263-246633ca4a50": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Enabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "30a01c8b-9d69-4924-8a14-63a1fbd78f3a": null + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:19", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:19", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/AutoMLJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/AutoMLJob/list.json new file mode 100644 index 000000000000..ddb9e268d22c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/AutoMLJob/list.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "jobType": "string", + "tag": "string", + "listViewType": "All", + "assetName": "string", + "scheduled": false, + "scheduleId": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Failed", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "4e53b3df-bd02-42d1-a3cd-ee4678c0b79f": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "1a89709e-1af8-41de-99c1-0349bd20e005": null + }, + "queueSettings": { + "jobTier": "Spot", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:22", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/CommandJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/CommandJob/createOrUpdate.json new file mode 100644 index 000000000000..db9482fd5645 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/CommandJob/createOrUpdate.json @@ -0,0 +1,333 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "c9ac10d0-915b-4de5-afe8-a4c78a37a558": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Queued", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "500bc411-5f81-4b2c-aae9-f84c33146a4c": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "56fc2716-8290-4394-867e-14e89387af68": null + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:23", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:23", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Preparing", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "56a57b62-09f2-48ee-a4ec-a19a230a6aa0": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "e3455adb-ad77-4518-985a-c60703f3d3ea": null + }, + "queueSettings": { + "jobTier": "Standard", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:23", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:23", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/CommandJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/CommandJob/get.json new file mode 100644 index 000000000000..46b60ab8d9e0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/CommandJob/get.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "a2da3516-d5bf-4e6f-a220-463602afc87c": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Enabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "049b85fe-425d-4ec6-b194-85c0f2771fe5": null + }, + "queueSettings": { + "jobTier": "Spot", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:23", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:23", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/CommandJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/CommandJob/list.json new file mode 100644 index 000000000000..63545f33cc15 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/CommandJob/list.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "jobType": "string", + "tag": "string", + "listViewType": "ActiveOnly", + "assetName": "string", + "scheduled": false, + "scheduleId": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Failed", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "47f85ca1-a889-4417-a451-2ebca543e605": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "13a3c675-c28b-4143-807e-fde07ad06a01": null + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:23", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:23", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/FineTuningJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/FineTuningJob/createOrUpdate.json new file mode 100644 index 000000000000..8bb5588e46e0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/FineTuningJob/createOrUpdate.json @@ -0,0 +1,181 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "jobType": "FineTuning", + "experimentName": "llm-finetuning", + "fineTuningDetails": { + "taskType": "TextCompletion", + "modelProvider": "Custom", + "model": { + "jobInputType": "mlflow_model", + "uri": "azureml://registries/azureml-meta/models/Llama-2-7b/versions/11", + "mode": "ReadOnlyMount", + "description": null + }, + "trainingData": { + "jobInputType": "uri_file", + "uri": "azureml://registries/azureml-meta/models/Llama-2-7b/versions/11", + "mode": "ReadOnlyMount", + "description": null + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "ReadWriteMount", + "jobOutputType": "mlflow_model" + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Created", + "experimentName": "string", + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "fineTuningDetails": { + "taskType": "TextCompletion", + "modelProvider": "Custom", + "model": { + "jobInputType": "mlflow_model", + "uri": "azureml://registries/azureml-meta/models/Llama-2-7b/versions/11", + "mode": "ReadOnlyMount", + "description": null + }, + "trainingData": { + "jobInputType": "uri_file", + "uri": "azureml://datastores/workspaceblobstore/paths/UI/2023-06-06_175927_UTC/small_train.jsonl", + "mode": "ReadOnlyMount", + "description": null + } + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "jobType": "FineTuning", + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "ReadWriteMount", + "jobOutputType": "mlflow_model" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:22", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Created", + "experimentName": "string", + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "fineTuningDetails": { + "taskType": "TextCompletion", + "modelProvider": "Custom", + "model": { + "jobInputType": "mlflow_model", + "uri": "azureml://registries/azureml-meta/models/Llama-2-7b/versions/11", + "mode": "ReadOnlyMount", + "description": null + }, + "trainingData": { + "jobInputType": "uri_file", + "uri": "azureml://datastores/workspaceblobstore/paths/UI/2023-06-06_175927_UTC/small_train.jsonl", + "mode": "ReadOnlyMount", + "description": null + } + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "jobType": "FineTuning", + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "ReadWriteMount", + "jobOutputType": "mlflow_model" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:22", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/FineTuningJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/FineTuningJob/get.json new file mode 100644 index 000000000000..97f568734734 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/FineTuningJob/get.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Created", + "experimentName": "string", + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "fineTuningDetails": { + "taskType": "TextCompletion", + "modelProvider": "Custom", + "model": { + "jobInputType": "mlflow_model", + "uri": "azureml://registries/azureml-meta/models/Llama-2-7b/versions/11", + "mode": "ReadOnlyMount", + "description": null + }, + "trainingData": { + "jobInputType": "uri_file", + "uri": "azureml://datastores/workspaceblobstore/paths/UI/2023-06-06_175927_UTC/small_train.jsonl", + "mode": "ReadOnlyMount", + "description": null + } + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "jobType": "FineTuning", + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "ReadWriteMount", + "jobOutputType": "mlflow_model" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:22", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/FineTuningJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/FineTuningJob/list.json new file mode 100644 index 000000000000..2b6b32f3bb08 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/FineTuningJob/list.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "jobType": "string", + "tag": "string", + "listViewType": "All", + "assetName": "string", + "scheduled": false, + "scheduleId": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Created", + "experimentName": "string", + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "fineTuningDetails": { + "taskType": "TextCompletion", + "modelProvider": "Custom", + "model": { + "jobInputType": "mlflow_model", + "uri": "azureml://registries/azureml-meta/models/Llama-2-7b/versions/11", + "mode": "ReadOnlyMount", + "description": null + }, + "trainingData": { + "jobInputType": "uri_file", + "uri": "azureml://datastores/workspaceblobstore/paths/UI/2023-06-06_175927_UTC/small_train.jsonl", + "mode": "ReadOnlyMount", + "description": null + } + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "jobType": "FineTuning", + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "ReadWriteMount", + "jobOutputType": "mlflow_model" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:22", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/PipelineJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/PipelineJob/createOrUpdate.json new file mode 100644 index 000000000000..1ec86231bd68 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/PipelineJob/createOrUpdate.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/PipelineJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/PipelineJob/get.json new file mode 100644 index 000000000000..095bd511a634 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/PipelineJob/get.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/PipelineJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/PipelineJob/list.json new file mode 100644 index 000000000000..557b7599696d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/PipelineJob/list.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "jobType": "string", + "tag": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/SweepJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/SweepJob/createOrUpdate.json new file mode 100644 index 000000000000..a16abd950155 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/SweepJob/createOrUpdate.json @@ -0,0 +1,333 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "5fc1f627-491e-45a0-a6a2-f5b4be884911": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Starting", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "b2de23ac-268c-459c-bbf3-0d8ece77d247": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "5489ee88-92db-4266-b321-ed47823d52b8": null + }, + "queueSettings": { + "jobTier": "Standard", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:25", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:25", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Starting", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "64db9b4b-db26-4473-9eb8-49e5e5cbeb3f": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "307f11f6-ff8d-450d-b8a3-4c9d0f7d883f": null + }, + "queueSettings": { + "jobTier": "Standard", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:25", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:25", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/SweepJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/SweepJob/get.json new file mode 100644 index 000000000000..cf94265be8aa --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/SweepJob/get.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Preparing", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "81750226-212a-41d5-b3c3-d6ba8a48ed6e": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Direct", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "92ae6a47-dc8b-407a-88d1-2e8a1932e15a": null + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:24", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:24", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/SweepJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/SweepJob/list.json new file mode 100644 index 000000000000..fafde5166380 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/SweepJob/list.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "jobType": "string", + "tag": "string", + "listViewType": "ActiveOnly", + "assetName": "string", + "scheduled": false, + "scheduleId": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Running", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "0a76565a-7e17-45ce-bdea-0548a617ce27": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Direct", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "ed0b17ef-7461-4e01-92bb-376554a4ee87": null + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:25", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:25", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/cancel.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/cancel.json new file mode 100644 index 000000000000..ecebda4da0be --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/cancel.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/delete.json new file mode 100644 index 000000000000..8656b88950c2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/update.json new file mode 100644 index 000000000000..63f9aea93f3a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Job/update.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "notificationSetting": { + "webhooks": { + "string": { + "eventType": "string", + "webhookType": "AzureDevOps" + } + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Canceled", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ], + "webhooks": { + "string": { + "eventType": "string", + "webhookType": "AzureDevOps" + } + } + }, + "secretsConfiguration": { + "string": { + "workspaceSecretName": "string", + "uri": null + } + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "maxInstanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "00cac5bf-6a80-4db4-9c7f-1feebe8c21c8": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "autoDeleteSetting": { + "condition": "CreatedGreaterThan", + "value": "string" + }, + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Enabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "6f851dd9-5a2d-4bd7-8a67-3b0e6a075bdb": null + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:44", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:44", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/createOrUpdate.json new file mode 100644 index 000000000000..9707c1c4079b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/createOrUpdate.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "id": "testLabelingJob", + "body": { + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob", + "name": "testLabelingJob", + "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs", + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + }, + "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "status": "NotStarted", + "progressMetrics": { + "totalDatapointCount": 0, + "completedDatapointCount": 0, + "skippedDatapointCount": 0, + "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-12-08T01:23:37.234Z" + } + ], + "createdDateTime": "2020-12-08T01:23:37.234Z" + }, + "systemData": { + "createdAt": "2020-12-08T01:23:37.235Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-08T01:23:37.235Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob", + "name": "testLabelingJob", + "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs", + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + }, + "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "status": "NotStarted", + "progressMetrics": { + "totalDatapointCount": 0, + "completedDatapointCount": 0, + "skippedDatapointCount": 0, + "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-12-08T01:23:37.234Z" + } + ], + "createdDateTime": "2020-12-08T01:23:37.234Z" + }, + "systemData": { + "createdAt": "2020-12-08T01:23:37.235Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-08T01:23:37.235Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/delete.json new file mode 100644 index 000000000000..f3e021657835 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "id": "testLabelingJob" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/exportLabels.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/exportLabels.json new file mode 100644 index 000000000000..fa675153f845 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/exportLabels.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "id": "testLabelingJob", + "body": { + "format": "Dataset" + } + }, + "responses": { + "200": { + "body": { + "format": "Dataset", + "labelingJobId": "string", + "exportedRowCount": 0, + "startDateTime": "2021-02-08T23:34:40.730Z", + "endDateTime": "2021-02-08T23:34:40.730Z" + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/get.json new file mode 100644 index 000000000000..7fc4ea725602 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/get.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "id": "testLabelingJob", + "includeJobInstructions": true, + "includeLabelCategories": true + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob", + "name": "testLabelingJob", + "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs", + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + }, + "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "status": "NotStarted", + "progressMetrics": { + "totalDatapointCount": 0, + "completedDatapointCount": 0, + "skippedDatapointCount": 0, + "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-12-08T01:23:37.234Z" + } + ], + "createdDateTime": "2020-12-08T01:23:37.234Z" + }, + "systemData": { + "createdAt": "2020-12-08T01:23:37.235Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-08T01:23:37.235Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/list.json new file mode 100644 index 000000000000..5fa90905c4ec --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/list.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "$skipToken": "skiptoken", + "count": "10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob", + "name": "testLabelingJob", + "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs", + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + }, + "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "status": "NotStarted", + "progressMetrics": { + "totalDatapointCount": 0, + "completedDatapointCount": 0, + "skippedDatapointCount": 0, + "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-12-08T01:23:37.234Z" + } + ], + "createdDateTime": "2020-12-08T01:23:37.234Z" + }, + "systemData": { + "createdAt": "2020-12-08T01:23:37.235Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-08T01:23:37.235Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/pause.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/pause.json new file mode 100644 index 000000000000..93b565166a62 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/pause.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Queued", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ], + "webhooks": { + "string": { + "eventType": "string", + "webhookType": "AzureDevOps" + } + } + }, + "secretsConfiguration": { + "string": { + "workspaceSecretName": "string", + "uri": null + } + }, + "jobType": "Labeling", + "provisioningState": "InProgress", + "labelCategories": { + "string": { + "displayName": "string", + "multiSelect": "Disabled", + "classes": { + "string": { + "displayName": "string", + "subclasses": null + } + } + } + }, + "jobInstructions": { + "uri": "string" + }, + "dataConfiguration": { + "dataId": "string", + "incrementalDataRefresh": "Disabled" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "string", + "trainingComputeBinding": "string" + }, + "labelingJobMediaProperties": { + "mediaType": "Image", + "annotationType": "Classification" + }, + "projectId": "00000000-1111-2222-3333-444444444444", + "progressMetrics": { + "totalDatapointCount": 1, + "completedDatapointCount": 1, + "skippedDatapointCount": 1, + "incrementalDataLastRefreshDateTime": "2020-01-01T12:34:56.999+00:21" + }, + "statusMessages": [ + { + "level": "Information", + "code": "string", + "message": "string", + "createdDateTime": "2020-01-01T12:34:56.999+00:21" + } + ], + "createdDateTime": "2020-01-01T12:34:56.999+00:21" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/resume.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/resume.json new file mode 100644 index 000000000000..513022abed00 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/LabelingJob/resume.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Failed", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ], + "webhooks": { + "string": { + "eventType": "string", + "webhookType": "AzureDevOps" + } + } + }, + "secretsConfiguration": { + "string": { + "workspaceSecretName": "string", + "uri": null + } + }, + "jobType": "Labeling", + "provisioningState": "Succeeded", + "labelCategories": { + "string": { + "displayName": "string", + "multiSelect": "Enabled", + "classes": { + "string": { + "displayName": "string", + "subclasses": null + } + } + } + }, + "jobInstructions": { + "uri": "string" + }, + "dataConfiguration": { + "dataId": "string", + "incrementalDataRefresh": "Disabled" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "string", + "trainingComputeBinding": "string" + }, + "labelingJobMediaProperties": { + "mediaType": "Image", + "annotationType": "BoundingBox" + }, + "projectId": "00000000-1111-2222-3333-444444444444", + "progressMetrics": { + "totalDatapointCount": 1, + "completedDatapointCount": 1, + "skippedDatapointCount": 1, + "incrementalDataLastRefreshDateTime": "2020-01-01T12:34:56.999+00:22" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-01-01T12:34:56.999+00:22" + } + ], + "createdDateTime": "2020-01-01T12:34:56.999+00:22" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/createOrUpdateRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/createOrUpdateRule.json new file mode 100644 index 000000000000..911be0abe1b8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/createOrUpdateRule.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "ruleName": "rule-1", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "type": "FQDN", + "destination": "some_string", + "status": "Active", + "category": "UserDefined" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/outboundRules/rule-1", + "name": "rule-1", + "type": "Microsoft.MachineLearningServices/workspaces/outboundRules", + "properties": { + "type": "FQDN", + "destination": "some_string", + "status": "Active", + "category": "UserDefined" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/deleteRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/deleteRule.json new file mode 100644 index 000000000000..3ed27f56847a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/deleteRule.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "ruleName": "some_string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/getRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/getRule.json new file mode 100644 index 000000000000..a15166f950a9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/getRule.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "ruleName": "rule-1", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/outboundRules/rule-1", + "name": "rule-1", + "type": "Microsoft.MachineLearningServices/workspaces/outboundRules", + "properties": { + "type": "FQDN", + "destination": "some_string", + "status": "Active", + "category": "UserDefined" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/listRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/listRule.json new file mode 100644 index 000000000000..298fa30696ae --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/listRule.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/outboundRules/rule-1", + "name": "rule-1", + "type": "Microsoft.MachineLearningServices/workspaces/outboundRules", + "properties": { + "type": "FQDN", + "destination": "some_string", + "status": "Inactive", + "category": "Required" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/outboundRules/rule-2", + "name": "rule-2", + "type": "Microsoft.MachineLearningServices/workspaces/outboundRules", + "properties": { + "type": "FQDN", + "destination": "some_string", + "status": "Inactive", + "category": "Required" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/provision.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/provision.json new file mode 100644 index 000000000000..7e0749c1f565 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/ManagedNetwork/provision.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "api-version": "2024-01-01-preview", + "body": { + "includeSpark": false + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + }, + "200": { + "body": { + "status": "Active", + "sparkReady": true + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Notebook/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Notebook/listKeys.json new file mode 100644 index 000000000000..d8a18901f654 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Notebook/listKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "primaryAccessKey": null, + "secondaryAccessKey": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Notebook/prepare.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Notebook/prepare.json new file mode 100644 index 000000000000..80174b17feb9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Notebook/prepare.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "resourceId": "aabbccddee112233445566778899", + "fqdn": "testnotebook.notebooks.azure.com", + "notebookPreparationError": { + "statusCode": 500, + "errorMessage": "general error" + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json new file mode 100644 index 000000000000..7526150fa777 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/get.json new file mode 100644 index 000000000000..7904e81a62e7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/get.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json new file mode 100644 index 000000000000..f1f812c86aa8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "count": 1 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "Microsoft.MachineLearning.Services/endpoints/deployments", + "sku": { + "name": "string", + "tier": "Free" + }, + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "Automatic" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/update.json new file mode 100644 index 000000000000..7402d9dec0cb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/update.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview", + "body": { + "tags": {}, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json new file mode 100644 index 000000000000..4b12263c0cd6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/get.json new file mode 100644 index 000000000000..9c74b8a498b4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/get.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json new file mode 100644 index 000000000000..f1f812c86aa8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "count": 1 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "Microsoft.MachineLearning.Services/endpoints/deployments", + "sku": { + "name": "string", + "tier": "Free" + }, + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "Automatic" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/update.json new file mode 100644 index 000000000000..eaabcccb0e11 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/update.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview", + "body": { + "tags": {}, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/getLogs.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/getLogs.json new file mode 100644 index 000000000000..fcecb09a9796 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/getLogs.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-01-01-preview", + "endpointName": "testEndpoint", + "deploymentName": "testDeployment", + "body": { + "containerType": "StorageInitializer", + "tail": 0 + } + }, + "responses": { + "200": { + "body": { + "content": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/list.json new file mode 100644 index 000000000000..5a3e3cc41209 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/OnlineDeployment/list.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/createOrUpdate.json new file mode 100644 index 000000000000..72c84d64a24c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/createOrUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-01-01-preview", + "monitor": "true", + "body": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/delete.json new file mode 100644 index 000000000000..bd352e17bf5a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-01-01-preview", + "monitor": "true" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/get.json new file mode 100644 index 000000000000..9be867d23d0e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-01-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/list.json new file mode 100644 index 000000000000..5fab42321666 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateEndpointConnection/list.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-01-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateLinkResource/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateLinkResource/list.json new file mode 100644 index 000000000000..cb776e7dabd2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/PrivateLinkResource/list.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateLinkResources/amlworkspace", + "name": "amlworkspace", + "type": "Microsoft.MachineLearningServices/workspaces/privateLinkResources", + "properties": { + "groupId": "amlworkspace", + "requiredMembers": [ + "default" + ] + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Quota/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Quota/list.json new file mode 100644 index 000000000000..20acea4589ae --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Quota/list.json @@ -0,0 +1,415 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 48, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quota", + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Quota/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Quota/update.json new file mode 100644 index 000000000000..79c612d09ef8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Quota/update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2024-01-01-preview", + "parameters": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 100, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 200, + "unit": "Count" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 100, + "unit": "Count", + "status": "Success" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 200, + "unit": "Count", + "status": "Success" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/createOrUpdate-SystemCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/createOrUpdate-SystemCreated.json new file mode 100644 index 000000000000..fa8d8547bba6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/createOrUpdate-SystemCreated.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/createOrUpdate-UserCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/createOrUpdate-UserCreated.json new file mode 100644 index 000000000000..14e30d4ec1ee --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/createOrUpdate-UserCreated.json @@ -0,0 +1,260 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:39", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:39", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:39", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:39", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/delete.json new file mode 100644 index 000000000000..f4f33220179f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location", + "Retry-After": 100 + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/get-SystemCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/get-SystemCreated.json new file mode 100644 index 000000000000..0636125d2f22 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/get-SystemCreated.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:40", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:40", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/get-UserCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/get-UserCreated.json new file mode 100644 index 000000000000..65ad116d926b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/get-UserCreated.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:45", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:45", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/list-SystemCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/list-SystemCreated.json new file mode 100644 index 000000000000..ca8b1c3b9041 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/list-SystemCreated.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:40", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:40", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/list-UserCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/list-UserCreated.json new file mode 100644 index 000000000000..f6cedd68e3ad --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/list-UserCreated.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:42", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:42", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/listBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/listBySubscription.json new file mode 100644 index 000000000000..8ac81c76988c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/listBySubscription.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/removeRegions.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/removeRegions.json new file mode 100644 index 000000000000..3aa65fba8216 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/removeRegions.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + }, + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + }, + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + }, + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + }, + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:01", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:01", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "202": { + "headers": { + "Location": "example_location", + "Retry-After": 100 + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/update-SystemCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/update-SystemCreated.json new file mode 100644 index 000000000000..3faad26712ac --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/update-SystemCreated.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-01-01-preview", + "body": { + "tags": {}, + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Basic", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:02", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:02", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/update-UserCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/update-UserCreated.json new file mode 100644 index 000000000000..bfe8d96399b3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registries/update-UserCreated.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-01-01-preview", + "body": { + "tags": {}, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Basic", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:58", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:58", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/createOrUpdate.json new file mode 100644 index 000000000000..f054b69b1724 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/createOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-01-01-preview", + "codeName": "testContainer", + "body": { + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/delete.json new file mode 100644 index 000000000000..d99b7e25cf3e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-01-01-preview", + "codeName": "testContainer" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/get.json new file mode 100644 index 000000000000..647089416026 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-01-01-preview", + "codeName": "testContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/list.json new file mode 100644 index 000000000000..301f30a52e54 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeContainer/list.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-01-01-preview", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-08-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/codes/testContainer2", + "name": "testContainer2", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-08-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..cb26d6dcd150 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "codeName": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "pendingUploadId": "string", + "pendingUploadType": "None" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "SAS", + "sasUri": "https://www.contoso.com/example" + } + }, + "pendingUploadId": "string", + "pendingUploadType": "None" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/createOrUpdate.json new file mode 100644 index 000000000000..e56c366f0289 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/createOrUpdate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "codeName": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/delete.json new file mode 100644 index 000000000000..03f08517afe8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "codeName": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/get.json new file mode 100644 index 000000000000..8ec634486187 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "codeName": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/list.json new file mode 100644 index 000000000000..94592b18549c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/CodeVersion/list.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "codeName": "string", + "api-version": "2024-01-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/createOrUpdate.json new file mode 100644 index 000000000000..b697e76718a4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/createOrUpdate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/delete.json new file mode 100644 index 000000000000..e911d2454d8e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/get.json new file mode 100644 index 000000000000..7508dbc29506 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/list.json new file mode 100644 index 000000000000..0f9c031fb695 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentContainer/list.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "testContainer", + "api-version": "2024-01-01-preview", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/createOrUpdate.json new file mode 100644 index 000000000000..e4008f11cffe --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/createOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "8ced901b-d826-477d-bfef-329da9672513": null + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "2de2e74e-457d-4447-a581-933abc2b9d96": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "a6c1349d-5e45-48da-92c3-3ce176cb30e9": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/delete.json new file mode 100644 index 000000000000..ae477bb1bf26 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/get.json new file mode 100644 index 000000000000..16717878bf47 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "1a7c40b5-2029-4f5f-a8d6-fd0822038773": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/list.json new file mode 100644 index 000000000000..4730dab106eb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ComponentVersion/list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "api-version": "2024-01-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "50acbce5-cccc-475a-8ac6-c4da402afbd8": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/createOrUpdate.json new file mode 100644 index 000000000000..dc70aefcf286 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "dataType": "uri_folder" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "mltable" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "uri_folder" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/delete.json new file mode 100644 index 000000000000..9b0abbb539fa --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/get.json new file mode 100644 index 000000000000..aaa4563db5ca --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "uri_file" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:14", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:14", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/registryList.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/registryList.json new file mode 100644 index 000000000000..b433cd0a9037 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataContainer/registryList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "listViewType": "All" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "uri_folder" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..e8137bb20a23 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "pendingUploadId": "string", + "pendingUploadType": "None" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "SAS", + "sasUri": "https://www.contoso.com/example" + } + }, + "pendingUploadId": "string", + "pendingUploadType": "None" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/createOrUpdate.json new file mode 100644 index 000000000000..45e18b6cc726 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/createOrUpdate.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:13", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:13", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:13", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:13", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/delete.json new file mode 100644 index 000000000000..b6993f128954 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/get.json new file mode 100644 index 000000000000..4eec4fe1f451 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:14", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:14", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/registryList.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/registryList.json new file mode 100644 index 000000000000..581f141c4fd5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/DataVersionBase/registryList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2024-01-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string", + "$tags": "string", + "listViewType": "ArchivedOnly" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:48", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:48", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/createOrUpdate.json new file mode 100644 index 000000000000..66836bd7f91a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-01-01-preview", + "environmentName": "testEnvironment", + "body": { + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/registries/environments", + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + }, + "systemData": { + "createdAt": "2020-12-04T03:39:11.300Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-04T03:39:11.300Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/registries/environments", + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + }, + "systemData": { + "createdAt": "2020-12-04T03:39:11.301Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-04T03:39:11.301Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/delete.json new file mode 100644 index 000000000000..1c39b5e442e8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-01-01-preview", + "environmentName": "testContainer" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/get.json new file mode 100644 index 000000000000..554aeaf105cb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-01-01-preview", + "environmentName": "testEnvironment" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/registries/environments", + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/list.json new file mode 100644 index 000000000000..fc9cc4d2dc6a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentContainer/list.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "environmentName": "testContainer", + "api-version": "2024-01-01-preview", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/registries/environments", + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/createOrUpdate.json new file mode 100644 index 000000000000..6850f945c372 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/createOrUpdate.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "environmentName": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/delete.json new file mode 100644 index 000000000000..0ecafe8d8e53 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "environmentName": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/get.json new file mode 100644 index 000000000000..75c97c64fcd0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "environmentName": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/list.json new file mode 100644 index 000000000000..d852b66d83c3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/EnvironmentVersion/list.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-regsitry", + "environmentName": "string", + "api-version": "2024-01-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/createOrUpdate.json new file mode 100644 index 000000000000..cf6c78d5d540 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/createOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "registry123", + "api-version": "2024-01-01-preview", + "modelName": "testContainer", + "body": { + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/registry123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/registry123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/delete.json new file mode 100644 index 000000000000..e6dde6ce5e59 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "registry123", + "api-version": "2024-01-01-preview", + "modelName": "testContainer" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/get.json new file mode 100644 index 000000000000..ac68d48a11f7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "registry123", + "api-version": "2024-01-01-preview", + "modelName": "testContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/registry123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/list.json new file mode 100644 index 000000000000..6ff6555df002 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelContainer/list.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "registry123", + "api-version": "2024-01-01-preview", + "name": "testContainer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/registry123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..94d96ee62bf9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "modelName": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "pendingUploadId": "string", + "pendingUploadType": "None" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "SAS", + "sasUri": "https://www.contoso.com/example" + } + }, + "pendingUploadId": "string", + "pendingUploadType": "TemporaryBlobReference" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/createOrUpdate.json new file mode 100644 index 000000000000..6206ed5a1eff --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/createOrUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/delete.json new file mode 100644 index 000000000000..fa5f7829bc43 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/get.json new file mode 100644 index 000000000000..11869fd51e40 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/list.json new file mode 100644 index 000000000000..4f5e784c2538 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/list.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "$orderBy": "string", + "$top": 1, + "version": "string", + "description": "string", + "offset": 1, + "tags": "string", + "properties": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/package.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/package.json new file mode 100644 index 000000000000..70e1809d0500 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Registry/ModelVersion/package.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "baseEnvironmentSource": { + "baseEnvironmentSourceType": "EnvironmentAsset", + "resourceId": "string" + }, + "inferencingServer": { + "serverType": "AzureMLBatch", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + } + }, + "environmentVariables": { + "string": "string" + }, + "modelConfiguration": { + "mode": "ReadOnlyMount", + "mountPath": "string" + }, + "inputs": [ + { + "inputType": "UriFile", + "mode": "Download", + "path": { + "inputPathType": "Url", + "url": "string" + }, + "mountPath": "string" + } + ], + "tags": { + "string": "string" + }, + "targetEnvironmentId": "string" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "baseEnvironmentSource": { + "baseEnvironmentSourceType": "EnvironmentAsset", + "resourceId": "string" + }, + "inferencingServer": { + "serverType": "AzureMLBatch", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + } + }, + "environmentVariables": { + "string": "string" + }, + "modelConfiguration": { + "mode": "ReadOnlyMount", + "mountPath": "string" + }, + "inputs": [ + { + "inputType": "UriFile", + "mode": "Download", + "path": { + "inputPathType": "Url", + "url": "string" + }, + "mountPath": "string" + } + ], + "tags": { + "string": "string" + }, + "targetEnvironmentId": "string", + "logUrl": "string", + "buildId": "string", + "buildState": "NotStarted" + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/createOrUpdate.json new file mode 100644 index 000000000000..15553c2e58d9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/createOrUpdate.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "9965593e-526f-4b89-bb36-761138cf2794": null + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "d77a9a9a-4bb5-4c0c-8a77-459be8b82b9f": null + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "13ea51e0-ff28-49c3-a85d-9b5199eb14e5": null + } + }, + "provisioningState": "Failed" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/delete.json new file mode 100644 index 000000000000..3d5e7a71d603 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/get.json new file mode 100644 index 000000000000..6d4c9a3902a2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "a108545b-def1-4c86-8e53-dbcb1de3a8bc": null + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/list.json new file mode 100644 index 000000000000..03b0a02d82cc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/list.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "00cd1396-a094-4d48-8d86-14c43a55a6af": null + } + }, + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/trigger.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/trigger.json new file mode 100644 index 000000000000..62a9d6563016 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/trigger.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "test-schedule", + "api-version": "2024-01-01-preview", + "body": { + "scheduleTime": "2024-01-01T12:34:56.999Z" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "scheduleActionType": "CreateJob", + "submissionId": "createjob-test-job-id" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Usage/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Usage/list.json new file mode 100644 index 000000000000..3a5565354841 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Usage/list.json @@ -0,0 +1,400 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/totalCores/usages", + "currentValue": 7, + "limit": 100, + "name": { + "localizedValue": "Clusters", + "value": "Clusters" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/dedicatedCores/usages", + "currentValue": 14, + "limit": 24, + "name": { + "localizedValue": "Total Cluster Dedicated Regional vCPUs", + "value": "Total Cluster Dedicated Regional vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 48, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_dsv2/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster2_dsv2/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 0, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 12, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 6, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_nc/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/usages", + "currentValue": 6, + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluser1_nc/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 6, + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/lowPriorityCores/usages", + "currentValue": 18, + "limit": 50, + "name": { + "localizedValue": "Total Cluster LowPriority Regional vCPUs", + "value": "Total Cluster LowPriority Regional vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_D_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "value": "Standard D Family Cluster LowPriority vCPUs", + "localizedValue": "Standard D Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_DSv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard DSv2 Family Cluster LowPriority vCPUs", + "value": "Standard DSv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_Dv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard Dv2 Family Cluster LowPriority vCPUs", + "value": "Standard Dv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_FSv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard FSv2 Family Cluster LowPriority vCPUs", + "value": "Standard FSv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 18, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 12, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster2_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster3_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NCv2 Family Cluster LowPriority vCPUs", + "value": "Standard NCv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv3_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NCv3 Family Cluster LowPriority vCPUs", + "value": "Standard NCv3 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_ND_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard ND Family Cluster LowPriority vCPUs", + "value": "Standard ND Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NDv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NDv2 Family Cluster LowPriority vCPUs", + "value": "Standard NDv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NV_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NV Family Cluster LowPriority vCPUs", + "value": "Standard NV Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/VirtualMachineSize/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/VirtualMachineSize/list.json new file mode 100644 index 000000000000..63ac2891c340 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/VirtualMachineSize/list.json @@ -0,0 +1,388 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-01-01-preview", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_DS1_v2", + "family": "standardDSv2Family", + "vCPUs": 1, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 7168, + "memoryGB": 3.5, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.13, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.01, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.07, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.05, + "osType": "Windows", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS2_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 14336, + "memoryGB": 7.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.03, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.15, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.1, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.25, + "osType": "Windows", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS3_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.2, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.06, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.5, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.29, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS4_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.12, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.4, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 1.01, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.58, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS5_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 1.17, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.81, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 2.02, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.23, + "osType": "Linux", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS11_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.26, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.18, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.11, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.04, + "osType": "Linux", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS12_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.37, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.53, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.21, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.07, + "osType": "Linux", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS13_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.15, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.42, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.74, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 1.06, + "osType": "Windows", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS14_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 229376, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.3, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 1.48, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.84, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 2.11, + "osType": "Windows", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/createOrUpdate.json new file mode 100644 index 000000000000..e6b19bbef716 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/createOrUpdate.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "cd3c37dc-2876-4ca4-8a54-21bd7619724a": null + } + } + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "4939850d-8eae-4343-8566-0826259a2ad1": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "b76755e4-16bf-45d4-b625-6634df7444cc": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/delete.json new file mode 100644 index 000000000000..4be40a671f5d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/get.json new file mode 100644 index 000000000000..d59079ef52d0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/get.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "843c2bb4-e5f1-4267-98c8-ba22a99dbb00": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/list.json new file mode 100644 index 000000000000..db6fa46d53a7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/list.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "a3c13e2e-a213-4cac-9f5a-b49966906ad6": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/update.json new file mode 100644 index 000000000000..b48fb6dfd861 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchDeployment/update.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string" + }, + "tags": {} + } + }, + "responses": { + "200": { + "headers": { + "Location": "example_location" + }, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "1e5e1cf9-b0ea-4cf6-9764-e750bf85c10a": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/createOrUpdate.json new file mode 100644 index 000000000000..e7040a16d3f3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/createOrUpdate.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + }, + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/delete.json new file mode 100644 index 000000000000..91196d880ad0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1234", + "workspaceName": "testworkspace", + "endpointName": "testBatchEndpoint", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/get.json new file mode 100644 index 000000000000..04f5f84b6250 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/get.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/list.json new file mode 100644 index 000000000000..0b8e1da1778d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/list.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "count": 1 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/listKeys.json new file mode 100644 index 000000000000..5ac78bf84296 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/listKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryKey": "string", + "secondaryKey": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/update.json new file mode 100644 index 000000000000..3e52585cc0e6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/BatchEndpoint/update.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview", + "body": { + "tags": {}, + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + } + } + }, + "responses": { + "200": { + "headers": { + "Location": "example_location" + }, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/createOrUpdate.json new file mode 100644 index 000000000000..b02af08d6021 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/createOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "name": "testContainer", + "body": { + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/delete.json new file mode 100644 index 000000000000..c3f26339648f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "name": "testContainer" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/get.json new file mode 100644 index 000000000000..65e387a7317f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "name": "testContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/list.json new file mode 100644 index 000000000000..9ebc3bda4961 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeContainer/list.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "name": "testcode", + "api-version": "2024-01-01-preview", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-08-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer2", + "name": "testContainer2", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-08-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..a25e64274226 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "pendingUploadId": "string", + "pendingUploadType": "TemporaryBlobReference" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "SAS", + "sasUri": "https://www.contoso.com/example" + } + }, + "pendingUploadId": "string", + "pendingUploadType": "TemporaryBlobReference" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/createOrUpdate.json new file mode 100644 index 000000000000..0e12b4ab5af9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/createOrUpdate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/delete.json new file mode 100644 index 000000000000..39d11648f1b0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/get.json new file mode 100644 index 000000000000..b2ff31ceec0d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/list.json new file mode 100644 index 000000000000..610852bce162 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/list.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/publish.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/publish.json new file mode 100644 index 000000000000..6c72c1f7ba7f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/CodeVersion/publish.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "registryName": "string", + "destinationName": "string", + "destinationVersion": "string" + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/createOrUpdate.json new file mode 100644 index 000000000000..2495967e2594 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/createOrUpdate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/delete.json new file mode 100644 index 000000000000..c57832f83d32 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/get.json new file mode 100644 index 000000000000..9ece9a46644b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/list.json new file mode 100644 index 000000000000..aab863ae7106 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentContainer/list.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/createOrUpdate.json new file mode 100644 index 000000000000..c034804e6dc2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/createOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "8ced901b-d826-477d-bfef-329da9672513": null + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "2de2e74e-457d-4447-a581-933abc2b9d96": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "a6c1349d-5e45-48da-92c3-3ce176cb30e9": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/delete.json new file mode 100644 index 000000000000..39d11648f1b0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/get.json new file mode 100644 index 000000000000..7bee79bef216 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "1a7c40b5-2029-4f5f-a8d6-fd0822038773": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/list.json new file mode 100644 index 000000000000..e0397d29e60b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "50acbce5-cccc-475a-8ac6-c4da402afbd8": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/publish.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/publish.json new file mode 100644 index 000000000000..6c72c1f7ba7f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ComponentVersion/publish.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "registryName": "string", + "destinationName": "string", + "destinationVersion": "string" + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/createOrUpdate.json new file mode 100644 index 000000000000..a0f46f321481 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/createOrUpdate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-01-01-preview", + "name": "datacontainer123", + "body": { + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123", + "name": "datacontainer123", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123", + "name": "datacontainer123", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/delete.json new file mode 100644 index 000000000000..f043c53a22bb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-01-01-preview", + "name": "datacontainer123" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/get.json new file mode 100644 index 000000000000..f20352029578 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-01-01-preview", + "name": "datacontainer123" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123", + "name": "datacontainer123", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/list.json new file mode 100644 index 000000000000..c87a6ca5db9e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataContainer/list.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "name": "data123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123", + "name": "datastore123", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer124", + "name": "datastore124", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/createOrUpdate.json new file mode 100644 index 000000000000..52ceda4a92b8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/delete.json new file mode 100644 index 000000000000..39d11648f1b0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/get.json new file mode 100644 index 000000000000..da70687a2808 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/list.json new file mode 100644 index 000000000000..0154c10d15a8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string", + "$tags": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/publish.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/publish.json new file mode 100644 index 000000000000..6c72c1f7ba7f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/DataVersionBase/publish.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "registryName": "string", + "destinationName": "string", + "destinationVersion": "string" + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/createOrUpdate.json new file mode 100644 index 000000000000..00d5e8d9625b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "name": "testEnvironment", + "body": { + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/workspaces/environments", + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + }, + "systemData": { + "createdAt": "2020-12-04T03:39:11.300Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-04T03:39:11.300Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/workspaces/environments", + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + }, + "systemData": { + "createdAt": "2020-12-04T03:39:11.301Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-04T03:39:11.301Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/delete.json new file mode 100644 index 000000000000..c3f26339648f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "name": "testContainer" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/get.json new file mode 100644 index 000000000000..dc9d02d1d2e2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "name": "testEnvironment" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/workspaces/environments", + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/list.json new file mode 100644 index 000000000000..2aea69540470 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentContainer/list.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/workspaces/environments", + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/createOrUpdate.json new file mode 100644 index 000000000000..0f3c6246450c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/createOrUpdate.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/delete.json new file mode 100644 index 000000000000..39d11648f1b0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/get.json new file mode 100644 index 000000000000..e4f98354cf46 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/list.json new file mode 100644 index 000000000000..627b1f337a30 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/list.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/publish.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/publish.json new file mode 100644 index 000000000000..6c72c1f7ba7f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/EnvironmentVersion/publish.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "registryName": "string", + "destinationName": "string", + "destinationVersion": "string" + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/createOrUpdate.json new file mode 100644 index 000000000000..1073c883905e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/createOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:48", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:48", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:48", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:48", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/delete.json new file mode 100644 index 000000000000..f1071d596059 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/getEntity.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/getEntity.json new file mode 100644 index 000000000000..0318442c0301 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/getEntity.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:49", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:49", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/list.json new file mode 100644 index 000000000000..b1ac507f74ed --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetContainer/list.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "tags": "string", + "listViewType": "ArchivedOnly" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:46", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:46", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/backfill.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/backfill.json new file mode 100644 index 000000000000..b240f36f4aa9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/backfill.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "displayName": "string", + "description": "string", + "featureWindow": { + "featureWindowStart": "2020-01-01T12:34:56.999+00:51", + "featureWindowEnd": "2020-01-01T12:34:56.999+00:51" + }, + "tags": { + "string": "string" + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + }, + "jobId": "string", + "dataAvailabilityStatus": [ + "None" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobIds": [ + "string", + "string" + ] + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/createOrUpdate.json new file mode 100644 index 000000000000..a8930d62beb1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/createOrUpdate.json @@ -0,0 +1,219 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "Online", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Day", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Monday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "OnlineAndOffline", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Day", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Wednesday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "Offline", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Hour", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Wednesday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Failed" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/delete.json new file mode 100644 index 000000000000..1ed73627ddd7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/get.json new file mode 100644 index 000000000000..fde829488aa7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/get.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "None", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Minute", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Wednesday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/list.json new file mode 100644 index 000000000000..898e74bcebcd --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturesetVersion/list.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "tags": "string", + "listViewType": "All" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "Offline", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Month", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Saturday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:49", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:49", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json new file mode 100644 index 000000000000..d4804a6f14dd --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/delete.json new file mode 100644 index 000000000000..f1071d596059 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/getEntity.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/getEntity.json new file mode 100644 index 000000000000..7449f425c7cc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/getEntity.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:43", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:43", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/list.json new file mode 100644 index 000000000000..4387fc94b39a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityContainer/list.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "tags": "string", + "listViewType": "All" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:43", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:43", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json new file mode 100644 index 000000000000..dfc83455c564 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Datetime", + "columnName": "string" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Integer", + "columnName": "string" + } + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:58", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:58", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Integer", + "columnName": "string" + } + ], + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:58", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:58", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/delete.json new file mode 100644 index 000000000000..1ed73627ddd7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/get.json new file mode 100644 index 000000000000..1fcc041fde96 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Datetime", + "columnName": "string" + } + ], + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:57", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:57", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/list.json new file mode 100644 index 000000000000..5e72a4662889 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/FeaturestoreEntityVersion/list.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "tags": "string", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Datetime", + "columnName": "string" + } + ], + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:55", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:55", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/createOrUpdate.json new file mode 100644 index 000000000000..ec2570ab9465 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/createOrUpdate.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg1", + "workspaceName": "my-aml-workspace", + "poolName": "string", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "groupId": "string", + "authMode": "AAD" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Canceled", + "groupId": "string", + "authMode": "AAD", + "endpointUri": "https://www.contoso.com/example" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:19", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:19", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Succeeded", + "groupId": "string", + "authMode": "AAD", + "endpointUri": "https://www.contoso.com/example" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:19", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:19", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Basic", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/delete.json new file mode 100644 index 000000000000..ef15af3ffafe --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "poolName": "string", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/get.json new file mode 100644 index 000000000000..3b9a528ffcc9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "poolName": "string", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Failed", + "groupId": "string", + "authMode": "AAD", + "endpointUri": "https://www.contoso.com/example" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:20", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:20", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/list.json new file mode 100644 index 000000000000..4219657967a2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/list.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "poolName": "string", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "count": 1, + "tags": "string", + "properties": "string", + "orderBy": "CreatedAtAsc" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Canceled", + "groupId": "string", + "authMode": "AAD", + "endpointUri": "https://www.contoso.com/example" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:20", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:20", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/update.json new file mode 100644 index 000000000000..27a4087fdf40 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceEndpoint/update.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "poolName": "string", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview", + "body": { + "tags": {} + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Canceled", + "groupId": "string", + "authMode": "AAD", + "endpointUri": "https://www.contoso.com/example" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:20", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:20", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/createOrUpdate.json new file mode 100644 index 000000000000..216f49663790 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/createOrUpdate.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "poolName": "string", + "groupName": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "priority": 1, + "bonusExtraCapacity": 1, + "metadata": "string" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Updating", + "priority": 1, + "bonusExtraCapacity": 1, + "metadata": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Basic", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Deleting", + "priority": 1, + "bonusExtraCapacity": 1, + "metadata": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/delete.json new file mode 100644 index 000000000000..351ddfdb11a6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "poolName": "string", + "groupName": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/get.json new file mode 100644 index 000000000000..71a5bbe96e54 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "poolName": "string", + "groupName": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Failed", + "priority": 1, + "bonusExtraCapacity": 1, + "metadata": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:17", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:17", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/getStatus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/getStatus.json new file mode 100644 index 000000000000..332f7b0617d1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/getStatus.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "poolName": "string", + "groupName": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "requestedCapacity": 1, + "bonusExtraCapacity": 1, + "actualCapacityInfo": { + "allocated": 1, + "assignmentSuccess": 1, + "assignmentFailed": 1 + }, + "endpointCount": 1 + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/list.json new file mode 100644 index 000000000000..69549239df68 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/list.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "poolName": "string", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "count": 1, + "tags": "string", + "properties": "string", + "orderBy": "CreatedAtDesc" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Failed", + "priority": 1, + "bonusExtraCapacity": 1, + "metadata": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:17", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:17", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/listSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/listSkus.json new file mode 100644 index 000000000000..b10cc83367d5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/listSkus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "poolName": "string", + "groupName": "string", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "count": 1 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "string", + "sku": { + "name": "string", + "tier": "Free" + }, + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "Automatic" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/update.json new file mode 100644 index 000000000000..150a31c3a6f3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferenceGroup/update.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "poolName": "string", + "groupName": "string", + "api-version": "2024-01-01-preview", + "body": { + "tags": {}, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Failed", + "priority": 1, + "bonusExtraCapacity": 1, + "metadata": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:17", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:17", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/createOrUpdate.json new file mode 100644 index 000000000000..2fd0cd2bcef8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/createOrUpdate.json @@ -0,0 +1,240 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "inferencePoolName": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentConfiguration": { + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "readinessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "startupProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + } + }, + "nodeSkuType": "string", + "requestConfiguration": { + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelConfiguration": { + "modelId": "string" + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Canceled", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentConfiguration": { + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "readinessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "startupProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + } + }, + "nodeSkuType": "string", + "requestConfiguration": { + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelConfiguration": { + "modelId": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:21", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:21", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Canceled", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentConfiguration": { + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "readinessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "startupProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + } + }, + "nodeSkuType": "string", + "requestConfiguration": { + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelConfiguration": { + "modelId": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:21", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:21", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/delete.json new file mode 100644 index 000000000000..a94e0308c278 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "inferencePoolName": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/get.json new file mode 100644 index 000000000000..9d88c5ca1c35 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/get.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "inferencePoolName": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Canceled", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentConfiguration": { + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "readinessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "startupProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + } + }, + "nodeSkuType": "string", + "requestConfiguration": { + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelConfiguration": { + "modelId": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:21", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:21", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/getStatus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/getStatus.json new file mode 100644 index 000000000000..b7e56ee09fe7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/getStatus.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "inferencePoolName": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "requestedCapacity": 1, + "actualCapacity": 1, + "reservedCapacity": 1, + "groupCount": 1 + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/list.json new file mode 100644 index 000000000000..a8f5e6783dac --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/list.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "count": 1, + "tags": "string", + "properties": "string", + "orderBy": "UpdatedAtAsc" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Failed", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentConfiguration": { + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "readinessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "startupProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + } + }, + "nodeSkuType": "string", + "requestConfiguration": { + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelConfiguration": { + "modelId": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:22", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Premium", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/listSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/listSkus.json new file mode 100644 index 000000000000..d911f0cb4ec9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/listSkus.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "inferencePoolName": "string", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "count": 1 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "string", + "sku": { + "name": "string", + "tier": "Basic" + }, + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "Manual" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/update.json new file mode 100644 index 000000000000..fd91032b06a4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/InferencePool/update.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "inferencePoolName": "string", + "api-version": "2024-01-01-preview", + "body": { + "tags": {}, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "string": {} + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "provisioningState": "Canceled", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentConfiguration": { + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "readinessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "startupProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + } + }, + "nodeSkuType": "string", + "requestConfiguration": { + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelConfiguration": { + "modelId": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:22", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/createOrUpdate.json new file mode 100644 index 000000000000..889a0cdb5d06 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/createOrUpdate.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "modelId": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelId": "string", + "marketplacePlan": { + "publisherId": "string", + "offerId": "string", + "planId": "string" + }, + "marketplaceSubscriptionStatus": "Suspended", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelId": "string", + "marketplacePlan": { + "publisherId": "string", + "offerId": "string", + "planId": "string" + }, + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/delete.json new file mode 100644 index 000000000000..4fcc3615ac20 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/locations/centralus/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/get.json new file mode 100644 index 000000000000..6578ac8592e3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelId": "string", + "marketplacePlan": { + "publisherId": "string", + "offerId": "string", + "planId": "string" + }, + "marketplaceSubscriptionStatus": "Suspended", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:14", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:14", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/list.json new file mode 100644 index 000000000000..e869d3537e37 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/MarketplaceSubscription/list.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelId": "string", + "marketplacePlan": { + "publisherId": "string", + "offerId": "string", + "planId": "string" + }, + "marketplaceSubscriptionStatus": "Suspended", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:13", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:13", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/createOrUpdate.json new file mode 100644 index 000000000000..7bfe204c283d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/createOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-01-01-preview", + "name": "testContainer", + "body": { + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/delete.json new file mode 100644 index 000000000000..5e27487cb917 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-01-01-preview", + "name": "testContainer" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/get.json new file mode 100644 index 000000000000..1d21469b0d3a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-01-01-preview", + "name": "testContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/list.json new file mode 100644 index 000000000000..3a62c5d94ae0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelContainer/list.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-01-01-preview", + "name": "testContainer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/createOrUpdate.json new file mode 100644 index 000000000000..043d77edaa50 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/createOrUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/delete.json new file mode 100644 index 000000000000..39d11648f1b0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/get.json new file mode 100644 index 000000000000..100f37874baa --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/list.json new file mode 100644 index 000000000000..37097ad09e2f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/list.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "$orderBy": "string", + "$top": 1, + "version": "string", + "description": "string", + "offset": 1, + "tags": "string", + "properties": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/package.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/package.json new file mode 100644 index 000000000000..6dd78a570b4f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/package.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "baseEnvironmentSource": { + "baseEnvironmentSourceType": "EnvironmentAsset", + "resourceId": "string" + }, + "inferencingServer": { + "serverType": "AzureMLBatch", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + } + }, + "environmentVariables": { + "string": "string" + }, + "modelConfiguration": { + "mode": "ReadOnlyMount", + "mountPath": "string" + }, + "inputs": [ + { + "inputType": "UriFile", + "mode": "Download", + "path": { + "inputPathType": "Url", + "url": "string" + }, + "mountPath": "string" + } + ], + "tags": { + "string": "string" + }, + "targetEnvironmentId": "string" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "baseEnvironmentSource": { + "baseEnvironmentSourceType": "EnvironmentAsset", + "resourceId": "string" + }, + "inferencingServer": { + "serverType": "AzureMLBatch", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + } + }, + "environmentVariables": { + "string": "string" + }, + "modelConfiguration": { + "mode": "ReadOnlyMount", + "mountPath": "string" + }, + "inputs": [ + { + "inputType": "UriFile", + "mode": "Download", + "path": { + "inputPathType": "Url", + "url": "string" + }, + "mountPath": "string" + } + ], + "tags": { + "string": "string" + }, + "targetEnvironmentId": "string", + "logUrl": "string", + "buildId": "string", + "buildState": "NotStarted" + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/publish.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/publish.json new file mode 100644 index 000000000000..6c72c1f7ba7f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ModelVersion/publish.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-01-01-preview", + "body": { + "registryName": "string", + "destinationName": "string", + "destinationVersion": "string" + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineDeployment/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineDeployment/delete.json new file mode 100644 index 000000000000..cc3a62888f28 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineDeployment/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-01-01-preview", + "endpointName": "testEndpoint", + "deploymentName": "testDeployment" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/createOrUpdate.json new file mode 100644 index 000000000000..e97a300161bd --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/createOrUpdate.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "authMode": "AMLToken", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/delete.json new file mode 100644 index 000000000000..5969eec17404 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/get.json new file mode 100644 index 000000000000..c309038ece61 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/getToken.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/getToken.json new file mode 100644 index 000000000000..376eb6a7b3e1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/getToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "accessToken": "string", + "tokenType": "string", + "expiryTimeUtc": 1, + "refreshAfterTimeUtc": 1 + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/list.json new file mode 100644 index 000000000000..2d1801e0630a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/list.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string", + "name": "string", + "count": 1, + "computeType": "Managed", + "tags": "string", + "properties": "string", + "orderBy": "CreatedAtDesc" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/listKeys.json new file mode 100644 index 000000000000..5ac78bf84296 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/listKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryKey": "string", + "secondaryKey": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/regenerateKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/regenerateKeys.json new file mode 100644 index 000000000000..2c87e6c3c54f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/regenerateKeys.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview", + "body": { + "keyType": "Primary", + "keyValue": "string" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/update.json new file mode 100644 index 000000000000..5450eef89d3e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/OnlineEndpoint/update.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-01-01-preview", + "body": { + "tags": {}, + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/createOrUpdate.json new file mode 100644 index 000000000000..a7176d94002e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/createOrUpdate.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "capacityReservation": { + "capacityReservationGroupId": "string", + "endpointReservedCapacity": 1 + }, + "authMode": "AAD" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "capacityReservation": { + "capacityReservationGroupId": "string", + "endpointReservedCapacity": 1 + }, + "authMode": "Key", + "inferenceEndpoint": { + "uri": "https://www.contoso.com/example", + "headers": { + "string": "string" + } + }, + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:46", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:46", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "capacityReservation": { + "capacityReservationGroupId": "string", + "endpointReservedCapacity": 1 + }, + "authMode": "AAD", + "inferenceEndpoint": { + "uri": "https://www.contoso.com/example", + "headers": { + "string": "string" + } + }, + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:46", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:46", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Basic", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/delete.json new file mode 100644 index 000000000000..1e03500b79ac --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/get.json new file mode 100644 index 000000000000..53262cb427d5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/get.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "capacityReservation": { + "capacityReservationGroupId": "string", + "endpointReservedCapacity": 1 + }, + "authMode": "Key", + "inferenceEndpoint": { + "uri": "https://www.contoso.com/example", + "headers": { + "string": "string" + } + }, + "provisioningState": "Failed" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:46", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:46", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Premium", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/getStatus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/getStatus.json new file mode 100644 index 000000000000..1312611e9018 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/getStatus.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "metrics": { + "string": "string" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/list.json new file mode 100644 index 000000000000..2cc4a132ebac --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/list.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-01-01-preview", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "capacityReservation": { + "capacityReservationGroupId": "string", + "endpointReservedCapacity": 1 + }, + "authMode": "Key", + "inferenceEndpoint": { + "uri": "https://www.contoso.com/example", + "headers": { + "string": "string" + } + }, + "provisioningState": "Failed" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:46", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:46", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/listKeys.json new file mode 100644 index 000000000000..e84b4e855f49 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/listKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryKey": "string", + "secondaryKey": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/regenerateKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/regenerateKeys.json new file mode 100644 index 000000000000..c1170b096ca2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/regenerateKeys.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "body": { + "keyType": "Primary", + "keyValue": "string" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryKey": "string", + "secondaryKey": "string" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/update.json new file mode 100644 index 000000000000..293dab7a00fa --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/ServerlessEndpoint/update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-01-01-preview", + "body": { + "tags": {}, + "sku": { + "name": "string", + "tier": "Basic", + "size": "string", + "family": "string", + "capacity": 1 + }, + "identity": { + "type": "None", + "userAssignedIdentities": { + "string": {} + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "offer": { + "publisher": "string", + "offerName": "string" + }, + "capacityReservation": { + "capacityReservationGroupId": "string", + "endpointReservedCapacity": 1 + }, + "authMode": "AAD", + "inferenceEndpoint": { + "uri": "https://www.contoso.com/example", + "headers": { + "string": "string" + } + }, + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:47", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:47", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Premium", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/create.json new file mode 100644 index 000000000000..4ec80a589773 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/create.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "body": { + "location": "eastus2euap", + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": {} + } + }, + "properties": { + "friendlyName": "HelloName", + "description": "test description", + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "encryption": { + "status": "Enabled", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai" + }, + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai" + }, + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "allowPublicAccessWhenBehindVnet": false, + "publicNetworkAccess": "Disabled", + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ], + "enableDataIsolation": false + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/delete.json new file mode 100644 index 000000000000..5f4603e7419d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/diagnose.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/diagnose.json new file mode 100644 index 000000000000..6dd57625e2ee --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/diagnose.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "body": { + "value": { + "udr": {}, + "nsg": {}, + "resourceLock": {}, + "dnsResolution": {}, + "storageAccount": {}, + "keyVault": {}, + "containerRegistry": {}, + "applicationInsights": {}, + "others": {} + } + } + }, + "responses": { + "200": { + "body": { + "value": { + "userDefinedRouteResults": [], + "networkSecurityRuleResults": [], + "resourceLockResults": [], + "dnsResolutionResults": [ + { + "code": "CustomDNSInUse", + "level": "Warning", + "message": "We have detected an on-premise dns server is configured. Please make sure conditional forwarding is configured correctly according to doc https://foo" + } + ], + "storageAccountResults": [], + "keyVaultResults": [], + "containerRegistryResults": [], + "applicationInsightsResults": [], + "otherResults": [] + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/get.json new file mode 100644 index 000000000000..f9afc6f88cd4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/get.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai" + }, + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "serviceProvisionedResourceGroup": "testworkspace_0000111122223333", + "privateLinkCount": 0, + "allowPublicAccessWhenBehindVnet": false, + "publicNetworkAccess": "Disabled", + "imageBuildCompute": "testcompute", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/testprivatelinkconnection", + "name": "testprivatelinkconnection", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ], + "sharedPrivateLinkResources": [ + { + "name": "testcosmosdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testcosmosdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ], + "managedNetwork": { + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "some_string": { + "type": "FQDN", + "destination": "some_string", + "status": "Inactive", + "category": "Required" + } + }, + "status": { + "status": "Active", + "sparkReady": false + } + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listByResourceGroup.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listByResourceGroup.json new file mode 100644 index 000000000000..4f6c0d87de3d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listByResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace1", + "name": "testworkspace1", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName 1", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listBySubscription.json new file mode 100644 index 000000000000..0b2845a1692b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listBySubscription.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-5678/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listKeys.json new file mode 100644 index 000000000000..6776b2fa31e8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listKeys.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "userStorageKey": null, + "userStorageArmId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/ragargeastus2euap/providers/Microsoft.Storage/storageAccounts/testdemoworkazashomr", + "appInsightsInstrumentationKey": null, + "containerRegistryCredentials": { + "location": null, + "username": "testdemoworkjmjmeykp", + "passwords": [ + { + "name": "password", + "value": "" + }, + { + "name": "password2", + "value": "0KARRQoQHSUq1yViPWg7YFernOS=Ic/t" + } + ] + }, + "notebookAccessKeys": { + "primaryAccessKey": null, + "secondaryAccessKey": null + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listNotebookAccessToken.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listNotebookAccessToken.json new file mode 100644 index 000000000000..4ddb855b09fd --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listNotebookAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "notebookResourceId": "94350843095843059", + "hostName": "Host product name", + "publicDns": "resource.notebooks.azure.net", + "tokenType": "Bearer", + "expiresIn": 28800.0, + "scope": "aznb_identity" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listStorageAccountKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listStorageAccountKeys.json new file mode 100644 index 000000000000..6560cd982ba6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/listStorageAccountKeys.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "userStorageKey": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/operationsList.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/operationsList.json new file mode 100644 index 000000000000..2f93808413e6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/operationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.MachineLearningServices/workspaces/write", + "display": { + "provider": "Microsoft MachineLearningServices", + "resource": "workspaces", + "operation": "Create/Update Machine Learning workspaces" + } + }, + { + "name": "Microsoft.MachineLearningServices/workspaces/delete", + "display": { + "provider": "Microsoft MachineLearningServices", + "resource": "workspaces", + "operation": "Delete Machine Learning workspaces" + } + }, + { + "name": "Microsoft.MachineLearningServices/workspaces/listkeys/action", + "display": { + "provider": "Microsoft MachineLearningServices", + "resource": "workspaces", + "operation": "List workspace Keys" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/resyncKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/resyncKeys.json new file mode 100644 index 000000000000..f5b92696533a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/resyncKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/update.json new file mode 100644 index 000000000000..3654c53d0227 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/Workspace/update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "friendlyName": "New friendly name", + "description": "new description", + "publicNetworkAccess": "Disabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "New friendly name", + "description": "new description", + "publicNetworkAccess": "Disabled" + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/create.json new file mode 100644 index 000000000000..e7ac441fe0d5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/create.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "www.facebook.com", + "authType": "None" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "www.facebook.com", + "authType": "None" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/delete.json new file mode 100644 index 000000000000..73a266f365cb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/get.json new file mode 100644 index 000000000000..6555cf3dc42b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "www.facebook.com", + "authType": "None" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/list.json new file mode 100644 index 000000000000..b1e6cf6dc371 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/list.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "api-version": "2024-01-01-preview", + "target": "www.facebook.com", + "category": "ContainerRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "www.facebook.com", + "authType": "PAT" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-2", + "name": "connection-2", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ContainerRegistry", + "target": "www.facebook.com", + "authType": "PAT" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/listSecrets.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/listSecrets.json new file mode 100644 index 000000000000..34f215822aa9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/listSecrets.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "authType": "AccessKey", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "category": "CustomKeys", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + }, + "systemData": { + "createdAt": "2020-01-01T00:00:00Z", + "createdBy": "some_string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T00:00:00Z", + "lastModifiedBy": "some_string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/testConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/testConnection.json new file mode 100644 index 000000000000..253c7d29baf9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/testConnection.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "target_url", + "authType": "None" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/update.json new file mode 100644 index 000000000000..854dd8eb5d4d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceConnection/update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2024-01-01-preview", + "body": { + "properties": { + "authType": "AccessKey", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "authType": "AccessKey", + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + }, + "systemData": { + "createdAt": "2020-01-01T00:00:00Z", + "createdBy": "some_string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T00:00:00Z", + "lastModifiedBy": "some_string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceFeature/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceFeature/list.json new file mode 100644 index 000000000000..661a75dea140 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/examples/WorkspaceFeature/list.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "testworkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "automatedml_createeditexperimentsui", + "displayName": "Create edit experiments UI", + "description": "Create, edit or delete AutoML experiments in the SDK" + }, + { + "id": "workspace_upgradeworkspaceui", + "displayName": "Upgrade workspace UI", + "description": "Upgrade workspace from Basic to enterprise from the UI" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/machineLearningServices.json new file mode 100644 index 000000000000..afa3853f7f6c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/machineLearningServices.json @@ -0,0 +1,4184 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.", + "version": "2024-01-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}/providers/Microsoft.MachineLearningServices/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usages_List", + "description": "Gets the current usage information as well as limits for AML resources for given subscription and location.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "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" + }, + "x-ms-examples": { + "List Usages": { + "$ref": "./examples/Usage/list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "Returns supported VM Sizes in a location", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Sizes": { + "$ref": "./examples/VirtualMachineSize/list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/updateQuotas": { + "post": { + "tags": [ + "Quota" + ], + "operationId": "Quotas_Update", + "description": "Update quota for each VM family in workspace.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for update quota is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaUpdateParameters" + }, + "description": "Quota update parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful.", + "schema": { + "$ref": "#/definitions/UpdateWorkspaceQuotasResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "update quotas": { + "$ref": "./examples/Quota/update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/quotas": { + "get": { + "tags": [ + "Quota" + ], + "operationId": "Quotas_List", + "description": "Gets the currently assigned Workspace Quotas based on VMFamily.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListWorkspaceQuotas" + } + }, + "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" + }, + "x-ms-examples": { + "List workspace quotas by VMFamily": { + "$ref": "./examples/Quota/list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "Compute_List", + "description": "Gets computes in specified workspace.", + "x-ms-examples": { + "Get Computes": { + "$ref": "./examples/Compute/list.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Machine Learning computes and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedComputeResourcesList" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Get", + "description": "Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.", + "x-ms-examples": { + "Get a AKS Compute": { + "$ref": "./examples/Compute/get/AKSCompute.json" + }, + "Get a AML Compute": { + "$ref": "./examples/Compute/get/AmlCompute.json" + }, + "Get an ComputeInstance": { + "$ref": "./examples/Compute/get/ComputeInstance.json" + }, + "Get a Kubernetes Compute": { + "$ref": "./examples/Compute/get/KubernetesCompute.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_CreateOrUpdate", + "description": "Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a AML Compute": { + "$ref": "./examples/Compute/createOrUpdate/BasicAmlCompute.json" + }, + "Create an ComputeInstance Compute with minimal inputs": { + "$ref": "./examples/Compute/createOrUpdate/ComputeInstanceMinimal.json" + }, + "Create an ComputeInstance Compute": { + "$ref": "./examples/Compute/createOrUpdate/ComputeInstance.json" + }, + "Create an ComputeInstance Compute with Schedules": { + "$ref": "./examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json" + }, + "Create an AKS Compute": { + "$ref": "./examples/Compute/createOrUpdate/BasicAKSCompute.json" + }, + "Create a DataFactory Compute": { + "$ref": "./examples/Compute/createOrUpdate/BasicDataFactoryCompute.json" + }, + "Update a AML Compute": { + "$ref": "./examples/Compute/createOrUpdate/AmlCompute.json" + }, + "Update an AKS Compute": { + "$ref": "./examples/Compute/createOrUpdate/AKSCompute.json" + }, + "Attach a Kubernetes Compute": { + "$ref": "./examples/Compute/createOrUpdate/KubernetesCompute.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ComputeDefinitionParameter" + } + ], + "responses": { + "200": { + "description": "Compute creation or update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "201": { + "description": "Compute creation or update initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Update", + "description": "Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a AmlCompute Compute": { + "$ref": "./examples/Compute/patch.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateParameters" + }, + "description": "Additional parameters for cluster update." + } + ], + "responses": { + "200": { + "description": "Compute update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Delete", + "description": "Deletes specified Machine Learning compute.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Compute": { + "$ref": "./examples/Compute/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/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UnderlyingResourceActionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "Compute deletion initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } + } + }, + "204": { + "description": "No content; The target compute does not exist." + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/customServices": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_UpdateCustomServices", + "description": "Updates the custom services list. The list of custom services provided shall be overwritten", + "x-ms-examples": { + "Update Custom Services": { + "$ref": "./examples/Compute/updateCustomServices.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "customServices", + "required": true, + "description": "New list of Custom Services.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomService" + } + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes": { + "post": { + "tags": [ + "MachineLearningComputes" + ], + "operationId": "Compute_ListNodes", + "description": "Get the details (e.g IP address, port etc) of all the compute nodes in the compute.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of IP addresses.", + "schema": { + "$ref": "#/definitions/AmlComputeNodesInformation" + } + }, + "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", + "itemName": "nodes" + }, + "x-ms-examples": { + "Get compute nodes information for a compute": { + "$ref": "./examples/Compute/listNodes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_ListKeys", + "description": "Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).", + "x-ms-examples": { + "List AKS Compute Keys": { + "$ref": "./examples/Compute/listKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeSecrets" + } + }, + "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.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/updateDataMounts": { + "post": { + "tags": [ + "MachineLearningComputes" + ], + "summary": "Update Data Mounts of a Machine Learning compute.", + "operationId": "Compute_UpdateDataMounts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dataMounts", + "in": "body", + "description": "The parameters for creating or updating a machine learning workspace.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ComputeInstanceDataMount" + } + } + } + ], + "responses": { + "200": { + "description": "Success." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Data Mounts": { + "$ref": "./examples/Compute/updateDataMounts.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/start": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Start", + "description": "Posts a start action to a compute instance", + "x-ms-examples": { + "Start ComputeInstance Compute": { + "$ref": "./examples/Compute/start.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success." + }, + "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.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/stop": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Stop", + "description": "Posts a stop action to a compute instance", + "x-ms-examples": { + "Stop ComputeInstance Compute": { + "$ref": "./examples/Compute/stop.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success." + }, + "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.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/restart": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Restart", + "description": "Posts a restart action to a compute instance", + "x-ms-examples": { + "Restart ComputeInstance Compute": { + "$ref": "./examples/Compute/restart.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success." + }, + "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.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/updateIdleShutdownSetting": { + "post": { + "tags": [ + "MachineLearningComputes" + ], + "operationId": "Compute_UpdateIdleShutdownSetting", + "description": "Updates the idle shutdown setting of a compute instance.", + "x-ms-examples": { + "Update idle shutdown setting of ComputeInstance": { + "$ref": "./examples/Compute/updateIdleShutdownSetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "description": "The object for updating idle shutdown setting of specified ComputeInstance.", + "schema": { + "$ref": "#/definitions/IdleShutdownSetting" + } + } + ], + "responses": { + "200": { + "description": "Success." + }, + "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.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/getAllowedVmSizesForResize": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_getAllowedResizeSizes", + "description": "Returns supported virtual machine sizes for resize", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Sizes": { + "$ref": "./examples/Compute/getAllowedVMSizesForResize.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/resize": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Resize", + "description": "Updates the size of a Compute Instance.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "description": "The object for updating VM size setting of specified Compute Instance.", + "schema": { + "$ref": "#/definitions/ResizeSchema" + } + } + ], + "responses": { + "202": { + "description": "Compute resize initiated.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Sizes": { + "$ref": "./examples/Compute/resize.json" + } + } + } + } + }, + "parameters": { + "WorkspaceNameParameter": { + "name": "workspaceName", + "description": "Name of Azure Machine Learning workspace.", + "in": "path", + "type": "string", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$", + "x-ms-parameter-location": "method" + }, + "ComputeNameParameter": { + "name": "computeName", + "description": "Name of the Azure Machine Learning compute.", + "in": "path", + "type": "string", + "required": true, + "pattern": "^[a-zA-Z](?![a-zA-Z0-9-]*-\\d+$)[a-zA-Z0-9\\-]{2,23}$", + "x-ms-parameter-location": "method" + }, + "AsyncOperationIdParameter": { + "name": "asyncOperationId", + "description": "Identifier of an asynchronous Azure Machine Learning compute operation.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "description": "The name of the Azure location/region.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "PaginationParameter": { + "in": "query", + "name": "$skip", + "type": "string", + "description": "Continuation token for pagination.", + "required": false, + "x-ms-parameter-location": "method" + }, + "ComputeDefinitionParameter": { + "in": "body", + "name": "parameters", + "description": "Payload with Machine Learning compute definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ComputeResource" + }, + "x-ms-parameter-location": "method" + }, + "ComputeTypeParameter": { + "in": "query", + "name": "compute-type", + "type": "string", + "description": "Type of compute to filter by.", + "required": false, + "x-ms-parameter-location": "method" + }, + "UnderlyingResourceActionParameter": { + "in": "query", + "name": "underlyingResourceAction", + "type": "string", + "description": "Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.", + "required": true, + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "UnderlyingResourceAction", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "UsageName": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "amlWorkspaceLocation": { + "readOnly": true, + "type": "string", + "description": "Region of the AML workspace in the id." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The current usage of the resource." + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "description": "Describes AML Resource Usage." + }, + "ListUsagesResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of AML resource usages." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML resource usage information. Call ListNext() with this to fetch the next page of AML resource usage information." + } + }, + "description": "The List Usages operation response." + }, + "VirtualMachineSize": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Virtual Machine size name", + "description": "The name of the virtual machine size.", + "readOnly": true + }, + "family": { + "type": "string", + "title": "Virtual Machine family name", + "description": "The family name of the virtual machine size.", + "readOnly": true + }, + "vCPUs": { + "type": "integer", + "format": "int32", + "title": "Number of vPUs", + "description": "The number of vCPUs supported by the virtual machine size.", + "readOnly": true + }, + "gpus": { + "type": "integer", + "format": "int32", + "title": "Number of gPUs", + "description": "The number of gPUs supported by the virtual machine size.", + "readOnly": true + }, + "osVhdSizeMB": { + "type": "integer", + "format": "int32", + "title": "OS VHD Disk size", + "description": "The OS VHD disk size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "maxResourceVolumeMB": { + "type": "integer", + "format": "int32", + "title": "Resource volume size", + "description": "The resource volume size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "memoryGB": { + "type": "number", + "format": "double", + "title": "Memory size", + "description": "The amount of memory, in GB, supported by the virtual machine size.", + "readOnly": true + }, + "lowPriorityCapable": { + "type": "boolean", + "title": "Low priority capable", + "description": "Specifies if the virtual machine size supports low priority VMs.", + "readOnly": true + }, + "premiumIO": { + "type": "boolean", + "title": "Premium IO supported", + "description": "Specifies if the virtual machine size supports premium IO.", + "readOnly": true + }, + "estimatedVMPrices": { + "title": "Estimated VM prices", + "description": "The estimated price information for using a VM.", + "$ref": "#/definitions/EstimatedVMPrices" + }, + "supportedComputeTypes": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Supported Compute Types", + "description": "Specifies the compute types supported by the virtual machine size." + } + }, + "description": "Describes the properties of a VM size." + }, + "EstimatedVMPrices": { + "type": "object", + "properties": { + "billingCurrency": { + "type": "string", + "title": "Billing currency", + "description": "Three lettered code specifying the currency of the VM price. Example: USD", + "enum": [ + "USD" + ], + "x-ms-enum": { + "name": "BillingCurrency", + "modelAsString": true + } + }, + "unitOfMeasure": { + "type": "string", + "title": "Unit of time measure", + "description": "The unit of time measurement for the specified VM price. Example: OneHour", + "enum": [ + "OneHour" + ], + "x-ms-enum": { + "name": "UnitOfMeasure", + "modelAsString": true + } + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/EstimatedVMPrice" + }, + "x-ms-identifiers": [], + "title": "List of estimated VM prices.", + "description": "The list of estimated prices for using a VM of a particular OS type, tier, etc." + } + }, + "required": [ + "billingCurrency", + "unitOfMeasure", + "values" + ], + "description": "The estimated price info for using a VM." + }, + "EstimatedVMPrice": { + "type": "object", + "properties": { + "retailPrice": { + "type": "number", + "format": "double", + "title": "Retail price", + "description": "The price charged for using the VM." + }, + "osType": { + "type": "string", + "title": "OS type", + "description": "Operating system type used by the VM.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "VMPriceOSType", + "modelAsString": true + } + }, + "vmTier": { + "type": "string", + "title": "VM tier", + "description": "The type of the VM.", + "enum": [ + "Standard", + "LowPriority", + "Spot" + ], + "x-ms-enum": { + "name": "VMTier", + "modelAsString": true + } + } + }, + "required": [ + "retailPrice", + "osType", + "vmTier" + ], + "description": "The estimated price info for using a VM of a particular OS type, tier, etc." + }, + "VirtualMachineSizeListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of virtual machine sizes supported by AmlCompute." + } + }, + "description": "The List Virtual Machine size operation response." + }, + "QuotaBaseProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "type": "string", + "description": "Specifies the resource type." + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The properties for Quota update or retrieval." + }, + "QuotaUpdateParameters": { + "type": "object", + "properties": { + "value": { + "description": "The list for update quota.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaBaseProperties" + } + }, + "location": { + "description": "Region of workspace quota to be updated.", + "type": "string" + } + }, + "description": "Quota update parameters." + }, + "UpdateWorkspaceQuotasResult": { + "type": "object", + "properties": { + "value": { + "description": "The list of workspace quota update result.", + "items": { + "$ref": "#/definitions/UpdateWorkspaceQuotas" + }, + "readOnly": true, + "type": "array" + }, + "nextLink": { + "description": "The URI to fetch the next page of workspace quota update result. Call ListNext() with this to fetch the next page of Workspace Quota update result.", + "readOnly": true, + "type": "string" + } + }, + "description": "The result of update workspace quota." + }, + "UpdateWorkspaceQuotas": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + }, + "status": { + "type": "string", + "readOnly": false, + "title": "Update Workspace Quota Status.", + "description": "Status of update workspace quota.", + "enum": [ + "Undefined", + "Success", + "Failure", + "InvalidQuotaBelowClusterMinimum", + "InvalidQuotaExceedsSubscriptionLimit", + "InvalidVMFamilyName", + "OperationNotSupportedForSku", + "OperationNotEnabledForRegion" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + } + }, + "description": "The properties for update Quota response." + }, + "ResourceName": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Resource Name." + }, + "ResourceQuota": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "amlWorkspaceLocation": { + "readOnly": true, + "type": "string", + "description": "Region of the AML workspace in the id." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "name": { + "$ref": "#/definitions/ResourceName", + "description": "Name of the resource.", + "readOnly": true + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The quota assigned to a resource." + }, + "ListWorkspaceQuotas": { + "type": "object", + "properties": { + "value": { + "description": "The list of Workspace Quotas by VM Family", + "items": { + "$ref": "#/definitions/ResourceQuota" + }, + "readOnly": true, + "type": "array" + }, + "nextLink": { + "description": "The URI to fetch the next page of workspace quota information by VM Family. Call ListNext() with this to fetch the next page of Workspace Quota information.", + "readOnly": true, + "type": "string" + } + }, + "description": "The List WorkspaceQuotasByVMFamily operation response." + }, + "ResourceId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource" + } + }, + "required": [ + "id" + ], + "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", + "x-ms-azure-resource": true + }, + "PaginatedComputeResourcesList": { + "type": "object", + "description": "Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.", + "properties": { + "value": { + "type": "array", + "description": "An array of Machine Learning compute objects wrapped in ARM resource envelope.", + "items": { + "$ref": "#/definitions/ComputeResource" + } + }, + "nextLink": { + "type": "string", + "description": "A continuation link (absolute URI) to the next page of results in the list." + } + } + }, + "ComputeResource": { + "type": "object", + "description": "Machine Learning compute object wrapped into ARM resource envelope.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + }, + { + "$ref": "#/definitions/ComputeResourceSchema" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace.", + "x-nullable": true + } + } + }, + "ComputeResourceSchema": { + "type": "object", + "properties": { + "properties": { + "description": "Compute properties", + "$ref": "#/definitions/Compute" + } + } + }, + "Compute": { + "type": "object", + "description": "Machine Learning compute object.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + }, + "computeLocation": { + "description": "Location for the underlying compute", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "type": "string", + "description": "The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of the Machine Learning compute.", + "x-nullable": true + }, + "createdOn": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time at which the compute was created." + }, + "modifiedOn": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time at which the compute was last modified." + }, + "resourceId": { + "type": "string", + "description": "ARM resource id of the underlying compute", + "x-nullable": true + }, + "provisioningErrors": { + "type": "array", + "description": "Errors during provisioning", + "items": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + }, + "x-ms-identifiers": [ + "/error/code" + ], + "readOnly": true, + "x-nullable": true + }, + "isAttachedCompute": { + "type": "boolean", + "description": "Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.", + "readOnly": true + }, + "disableLocalAuth": { + "type": "boolean", + "description": "Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "computeType" + ] + }, + "AKS": { + "description": "A Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/AKSSchema" + } + ], + "x-ms-discriminator-value": "AKS" + }, + "AKSSchema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "description": "AKS properties", + "properties": { + "clusterFqdn": { + "description": "Cluster full qualified domain name", + "type": "string", + "x-nullable": true + }, + "systemServices": { + "type": "array", + "description": "System services", + "items": { + "$ref": "#/definitions/SystemService" + }, + "x-ms-identifiers": [ + "publicIpAddress" + ], + "readOnly": true, + "x-nullable": true + }, + "agentCount": { + "description": "Number of agents", + "type": "integer", + "format": "int32", + "minimum": 0, + "x-nullable": true + }, + "agentVmSize": { + "description": "Agent virtual machine size", + "type": "string", + "x-nullable": true + }, + "clusterPurpose": { + "description": "Intended usage of the cluster", + "type": "string", + "default": "FastProd", + "enum": [ + "FastProd", + "DenseProd", + "DevTest" + ], + "x-ms-enum": { + "name": "ClusterPurpose", + "modelAsString": true + } + }, + "sslConfiguration": { + "description": "SSL configuration", + "$ref": "#/definitions/SslConfiguration", + "x-nullable": true + }, + "aksNetworkingConfiguration": { + "description": "AKS networking configuration for vnet", + "$ref": "#/definitions/AksNetworkingConfiguration", + "x-nullable": true + }, + "loadBalancerType": { + "description": "Load Balancer Type", + "type": "string", + "default": "PublicIp", + "enum": [ + "PublicIp", + "InternalLoadBalancer" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + } + }, + "loadBalancerSubnet": { + "description": "Load Balancer Subnet", + "type": "string", + "x-nullable": true + } + } + } + } + }, + "Kubernetes": { + "description": "A Machine Learning compute based on Kubernetes Compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/KubernetesSchema" + } + ], + "x-ms-discriminator-value": "Kubernetes" + }, + "KubernetesSchema": { + "type": "object", + "description": "Kubernetes Compute Schema", + "properties": { + "properties": { + "description": "Properties of Kubernetes", + "$ref": "#/definitions/KubernetesProperties" + } + } + }, + "KubernetesProperties": { + "type": "object", + "description": "Kubernetes properties", + "properties": { + "relayConnectionString": { + "description": "Relay connection string.", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + }, + "serviceBusConnectionString": { + "description": "ServiceBus connection string.", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + }, + "extensionPrincipalId": { + "description": "Extension principal-id.", + "type": "string", + "x-nullable": true + }, + "extensionInstanceReleaseTrain": { + "description": "Extension instance release train.", + "type": "string" + }, + "vcName": { + "description": "VC name.", + "type": "string" + }, + "namespace": { + "description": "Compute namespace", + "type": "string", + "default": "default" + }, + "defaultInstanceType": { + "description": "Default instance type", + "type": "string" + }, + "instanceTypes": { + "description": "Instance Type Schema", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/InstanceTypeSchema" + } + } + } + }, + "AmlComputeProperties": { + "type": "object", + "description": "AML Compute properties", + "properties": { + "osType": { + "description": "Compute OS Type", + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true + } + }, + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "vmPriority": { + "description": "Virtual Machine priority", + "type": "string", + "enum": [ + "Dedicated", + "LowPriority" + ], + "x-ms-enum": { + "name": "VmPriority", + "modelAsString": true + } + }, + "virtualMachineImage": { + "description": "Virtual Machine image for AML Compute - windows only", + "$ref": "#/definitions/VirtualMachineImage", + "x-nullable": true + }, + "isolatedNetwork": { + "description": "Network is isolated or not", + "type": "boolean" + }, + "scaleSettings": { + "description": "Scale settings for AML Compute", + "$ref": "#/definitions/ScaleSettings" + }, + "userAccountCredentials": { + "title": "User account credentials.", + "description": "Credentials for an administrator user account that will be created on each compute node.", + "$ref": "#/definitions/UserAccountCredentials", + "x-nullable": true + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId", + "x-nullable": true + }, + "remoteLoginPortPublicAccess": { + "type": "string", + "default": "NotSpecified", + "title": "Close remote Login Access Port", + "description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled", + "NotSpecified" + ], + "x-ms-enum": { + "name": "remoteLoginPortPublicAccess", + "modelAsString": true + } + }, + "allocationState": { + "type": "string", + "readOnly": true, + "title": "Allocation state.", + "description": "Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.", + "enum": [ + "Steady", + "Resizing" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": true + } + }, + "allocationStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Allocation state transition time.", + "description": "The time at which the compute entered its current allocation state." + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered by various compute nodes during node setup.", + "type": "array", + "x-nullable": true, + "items": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + }, + "x-ms-identifiers": [ + "/error/code" + ] + }, + "currentNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Current node count.", + "description": "The number of compute nodes currently assigned to the compute.", + "x-nullable": true + }, + "targetNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Target node count.", + "description": "The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation.", + "x-nullable": true + }, + "nodeStateCounts": { + "title": "Node state counts.", + "description": "Counts of various node states on the compute.", + "readOnly": true, + "$ref": "#/definitions/NodeStateCounts", + "x-nullable": true + }, + "enableNodePublicIp": { + "type": "boolean", + "default": true, + "title": "Enable node public IP.", + "description": "Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.", + "x-nullable": true + }, + "propertyBag": { + "type": "object", + "description": "A property bag containing additional properties.", + "x-nullable": true + } + } + }, + "AmlCompute": { + "description": "An Azure Machine Learning compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/AmlComputeSchema" + } + ], + "x-ms-discriminator-value": "AmlCompute" + }, + "AmlComputeSchema": { + "type": "object", + "description": "Properties(top level) of AmlCompute", + "properties": { + "properties": { + "description": "Properties of AmlCompute", + "$ref": "#/definitions/AmlComputeProperties" + } + } + }, + "ComputeInstanceProperties": { + "description": "Compute Instance properties", + "type": "object", + "properties": { + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId", + "x-nullable": true + }, + "applicationSharingPolicy": { + "type": "string", + "default": "Shared", + "title": "Sharing policy for applications on this compute instance", + "description": "Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.", + "enum": [ + "Personal", + "Shared" + ], + "x-ms-enum": { + "name": "applicationSharingPolicy", + "modelAsString": true + } + }, + "autologgerSettings": { + "description": "Specifies settings for autologger.", + "$ref": "#/definitions/ComputeInstanceAutologgerSettings", + "x-nullable": true + }, + "sshSettings": { + "description": "Specifies policy and settings for SSH access.", + "$ref": "#/definitions/ComputeInstanceSshSettings", + "x-nullable": true + }, + "customServices": { + "type": "array", + "description": "List of Custom Services added to the compute.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/CustomService" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "osImageMetadata": { + "readOnly": true, + "description": "Returns metadata about the operating system image for this compute instance.", + "$ref": "#/definitions/ImageMetadata" + }, + "connectivityEndpoints": { + "readOnly": true, + "description": "Describes all connectivity endpoints available for this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceConnectivityEndpoints" + }, + "applications": { + "type": "array", + "readOnly": true, + "description": "Describes available applications and their endpoints on this ComputeInstance.", + "items": { + "$ref": "#/definitions/ComputeInstanceApplication" + }, + "x-ms-identifiers": [ + "displayName" + ] + }, + "createdBy": { + "readOnly": true, + "description": "Describes information on user who created this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceCreatedBy" + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered on this ComputeInstance.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + }, + "x-ms-identifiers": [ + "/error/code" + ] + }, + "state": { + "description": "The current state of this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceState", + "readOnly": true + }, + "computeInstanceAuthorizationType": { + "type": "string", + "title": "Compute Instance Authorization type.", + "description": "The Compute Instance Authorization type. Available values are personal (default).", + "default": "personal", + "x-nullable": true, + "enum": [ + "personal" + ], + "x-ms-enum": { + "name": "ComputeInstanceAuthorizationType", + "modelAsString": true + } + }, + "enableOSPatching": { + "type": "boolean", + "default": false, + "title": "Enable Auto OS Patching.", + "description": "Enable Auto OS Patching. Possible values are: true, false.", + "x-nullable": true + }, + "enableRootAccess": { + "type": "boolean", + "default": true, + "title": "Enable root access.", + "description": "Enable root access. Possible values are: true, false.", + "x-nullable": true + }, + "enableSSO": { + "type": "boolean", + "default": true, + "title": "Enable SSO (single sign on).", + "description": "Enable SSO (single sign on). Possible values are: true, false.", + "x-nullable": true + }, + "releaseQuotaOnStop": { + "type": "boolean", + "default": false, + "title": "Release quota if compute instance stopped.", + "description": "Release quota if compute instance stopped. Possible values are: true - release quota if compute instance stopped. false - don't release quota when compute instance stopped.", + "x-nullable": true + }, + "personalComputeInstanceSettings": { + "title": "Personal Compute Instance settings.", + "description": "Settings for a personal compute instance.", + "$ref": "#/definitions/PersonalComputeInstanceSettings", + "x-nullable": true + }, + "setupScripts": { + "description": "Details of customized scripts to execute for setting up the cluster.", + "$ref": "#/definitions/SetupScripts", + "x-nullable": true + }, + "lastOperation": { + "description": "The last operation on ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceLastOperation", + "readOnly": true, + "x-nullable": true + }, + "schedules": { + "description": "The list of schedules to be applied on the computes.", + "$ref": "#/definitions/ComputeSchedules", + "x-nullable": true + }, + "idleTimeBeforeShutdown": { + "type": "string", + "description": "Stops compute instance after user defined period of inactivity. Time is defined in ISO8601 format. Minimum is 15 min, maximum is 3 days." + }, + "enableNodePublicIp": { + "type": "boolean", + "title": "Enable node public IP.", + "description": "Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.", + "x-nullable": true + }, + "containers": { + "type": "array", + "readOnly": true, + "description": "Describes informations of containers on this ComputeInstance.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ComputeInstanceContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "dataDisks": { + "type": "array", + "readOnly": true, + "description": "Describes informations of dataDisks on this ComputeInstance.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ComputeInstanceDataDisk" + }, + "x-ms-identifiers": [] + }, + "dataMounts": { + "type": "array", + "readOnly": true, + "description": "Describes informations of dataMounts on this ComputeInstance.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ComputeInstanceDataMount" + }, + "x-ms-identifiers": [] + }, + "versions": { + "description": "ComputeInstance version.", + "$ref": "#/definitions/ComputeInstanceVersion", + "readOnly": true + } + } + }, + "ComputeInstance": { + "description": "An Azure Machine Learning compute instance.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/ComputeInstanceSchema" + } + ], + "x-ms-discriminator-value": "ComputeInstance" + }, + "ComputeInstanceSchema": { + "type": "object", + "description": "Properties(top level) of ComputeInstance", + "properties": { + "properties": { + "description": "Properties of ComputeInstance", + "$ref": "#/definitions/ComputeInstanceProperties" + } + } + }, + "VirtualMachine": { + "description": "A Machine Learning compute based on Azure Virtual Machines.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/VirtualMachineSchema" + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "VirtualMachineSchema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "virtualMachineSize": { + "description": "Virtual Machine size", + "type": "string" + }, + "sshPort": { + "description": "Port open for ssh connections.", + "type": "integer", + "format": "int32" + }, + "notebookServerPort": { + "description": "Notebook server port open for ssh connections.", + "type": "integer", + "format": "int32" + }, + "address": { + "description": "Public IP address of the virtual machine.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for virtual machine", + "$ref": "#/definitions/VirtualMachineSshCredentials" + }, + "isNotebookInstanceCompute": { + "description": "Indicates whether this compute will be used for running notebooks.", + "type": "boolean" + } + } + } + } + }, + "HDInsightProperties": { + "type": "object", + "description": "HDInsight compute properties", + "properties": { + "sshPort": { + "description": "Port open for ssh connections on the master node of the cluster.", + "type": "integer", + "format": "int32" + }, + "address": { + "description": "Public IP address of the master node of the cluster.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for master node of the cluster", + "$ref": "#/definitions/VirtualMachineSshCredentials", + "x-nullable": true + } + } + }, + "HDInsight": { + "description": "A HDInsight compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/HDInsightSchema" + } + ], + "x-ms-discriminator-value": "HDInsight" + }, + "HDInsightSchema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/HDInsightProperties" + } + } + }, + "DataFactory": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + } + ], + "x-ms-discriminator-value": "DataFactory" + }, + "DatabricksProperties": { + "type": "object", + "description": "Properties of Databricks", + "properties": { + "databricksAccessToken": { + "description": "Databricks access token", + "type": "string" + }, + "workspaceUrl": { + "description": "Workspace Url", + "type": "string" + } + } + }, + "Databricks": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/DatabricksSchema" + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "DatabricksSchema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DatabricksProperties" + } + } + }, + "DataLakeAnalytics": { + "description": "A DataLakeAnalytics compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/DataLakeAnalyticsSchema" + } + ], + "x-ms-discriminator-value": "DataLakeAnalytics" + }, + "DataLakeAnalyticsSchema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "dataLakeStoreAccountName": { + "description": "DataLake Store Account Name", + "type": "string" + } + } + } + } + }, + "SynapseSpark": { + "type": "object", + "description": "A SynapseSpark compute.", + "properties": { + "properties": { + "type": "object", + "properties": { + "autoScaleProperties": { + "description": "Auto scale properties.", + "$ref": "#/definitions/AutoScaleProperties" + }, + "autoPauseProperties": { + "description": "Auto pause properties.", + "$ref": "#/definitions/AutoPauseProperties" + }, + "sparkVersion": { + "description": "Spark version.", + "type": "string" + }, + "nodeCount": { + "description": "The number of compute nodes currently assigned to the compute.", + "type": "integer", + "format": "int32" + }, + "nodeSize": { + "description": "Node size.", + "type": "string" + }, + "nodeSizeFamily": { + "description": "Node size family.", + "type": "string" + }, + "subscriptionId": { + "description": "Azure subscription identifier.", + "type": "string" + }, + "resourceGroup": { + "description": "Name of the resource group in which workspace is located.", + "type": "string" + }, + "workspaceName": { + "description": "Name of Azure Machine Learning workspace.", + "type": "string" + }, + "poolName": { + "description": "Pool name.", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Compute" + } + ], + "x-ms-discriminator-value": "SynapseSpark" + }, + "SystemService": { + "type": "object", + "description": "A system service running on a compute.", + "properties": { + "systemServiceType": { + "description": "The type of this system service.", + "readOnly": true, + "type": "string" + }, + "publicIpAddress": { + "type": "string", + "description": "Public IP address", + "readOnly": true + }, + "version": { + "description": "The version for this type.", + "readOnly": true, + "type": "string" + } + } + }, + "SslConfiguration": { + "type": "object", + "description": "The ssl configuration for scoring", + "properties": { + "status": { + "description": "Enable or disable ssl for scoring", + "type": "string", + "enum": [ + "Disabled", + "Enabled", + "Auto" + ], + "x-ms-enum": { + "name": "SslConfigStatus", + "modelAsString": true + } + }, + "cert": { + "description": "Cert data", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + }, + "key": { + "description": "Key data", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + }, + "cname": { + "description": "CNAME of the cert", + "type": "string", + "x-nullable": true + }, + "leafDomainLabel": { + "description": "Leaf domain label of public endpoint", + "type": "string", + "x-nullable": true + }, + "overwriteExistingDomain": { + "description": "Indicates whether to overwrite existing domain label.", + "type": "boolean" + } + } + }, + "AksNetworkingConfiguration": { + "type": "object", + "description": "Advance configuration for AKS networking", + "properties": { + "subnetId": { + "description": "Virtual network subnet resource ID the compute nodes belong to", + "type": "string" + }, + "serviceCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.", + "type": "string" + }, + "dnsServiceIP": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.", + "type": "string" + }, + "dockerBridgeCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.", + "type": "string" + } + } + }, + "UserAccountCredentials": { + "type": "object", + "properties": { + "adminUserName": { + "type": "string", + "title": "User name.", + "description": "Name of the administrator user account which can be used to SSH to nodes." + }, + "adminUserSshPublicKey": { + "type": "string", + "x-ms-secret": true, + "title": "SSH public key.", + "description": "SSH public key of the administrator user account." + }, + "adminUserPassword": { + "type": "string", + "x-ms-secret": true, + "title": "Password.", + "description": "Password of the administrator user account." + } + }, + "required": [ + "adminUserName" + ], + "description": "Settings for user account that gets created on each on the nodes of a compute." + }, + "ScaleSettings": { + "type": "object", + "description": "scale settings for AML Compute", + "properties": { + "maxNodeCount": { + "description": "Max number of nodes to use", + "type": "integer", + "format": "int32" + }, + "minNodeCount": { + "description": "Min number of nodes to use", + "type": "integer", + "format": "int32", + "default": 0 + }, + "nodeIdleTimeBeforeScaleDown": { + "type": "string", + "format": "duration", + "description": "Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format." + } + }, + "required": [ + "maxNodeCount" + ] + }, + "VirtualMachineImage": { + "type": "object", + "description": "Virtual Machine image for Windows AML Compute", + "properties": { + "id": { + "description": "Virtual Machine image path", + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "NodeStateCounts": { + "type": "object", + "properties": { + "idleNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Idle node count.", + "description": "Number of compute nodes in idle state." + }, + "runningNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Running node count.", + "description": "Number of compute nodes which are running jobs." + }, + "preparingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preparing node count.", + "description": "Number of compute nodes which are being prepared." + }, + "unusableNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Unusable node count.", + "description": "Number of compute nodes which are in unusable state." + }, + "leavingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Leaving node count.", + "description": "Number of compute nodes which are leaving the amlCompute." + }, + "preemptedNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preempted node count.", + "description": "Number of compute nodes which are in preempted state." + } + }, + "description": "Counts of various compute node states on the amlCompute." + }, + "ScaleSettingsInformation": { + "type": "object", + "properties": { + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Scale settings." + } + }, + "description": "Desired scale settings for the amlCompute." + }, + "ClusterUpdateProperties": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of ClusterUpdate", + "$ref": "#/definitions/ScaleSettingsInformation" + } + }, + "description": "The properties of a amlCompute that need to be updated." + }, + "ClusterUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterUpdateProperties", + "description": "The properties of the amlCompute." + } + }, + "description": "AmlCompute update parameters." + }, + "AmlComputeNodesInformation": { + "type": "object", + "description": "Result of AmlCompute Nodes", + "properties": { + "nodes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlComputeNodeInformation" + }, + "x-ms-identifiers": [ + "nodeId" + ], + "description": "The collection of returned AmlCompute nodes details." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + } + }, + "AmlComputeNodeInformation": { + "type": "object", + "description": "Compute node information related to a AmlCompute.", + "properties": { + "nodeId": { + "readOnly": true, + "type": "string", + "title": "Node ID.", + "description": "ID of the compute node." + }, + "privateIpAddress": { + "readOnly": true, + "type": "string", + "title": "Private IP address.", + "description": "Private IP address of the compute node.", + "x-nullable": true + }, + "publicIpAddress": { + "readOnly": true, + "type": "string", + "title": "Public IP address.", + "description": "Public IP address of the compute node.", + "x-nullable": true + }, + "port": { + "readOnly": true, + "type": "number", + "format": "int32", + "title": "Port.", + "description": "SSH port number of the node." + }, + "nodeState": { + "readOnly": true, + "type": "string", + "enum": [ + "idle", + "running", + "preparing", + "unusable", + "leaving", + "preempted" + ], + "description": "State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.", + "x-ms-enum": { + "name": "nodeState", + "modelAsString": true + } + }, + "runId": { + "readOnly": true, + "type": "string", + "title": "Run ID.", + "description": "ID of the Experiment running on the node, if any else null.", + "x-nullable": true + } + } + }, + "VirtualMachineSshCredentials": { + "type": "object", + "description": "Admin credentials for virtual machine", + "properties": { + "username": { + "description": "Username of admin account", + "type": "string" + }, + "password": { + "description": "Password of admin account", + "type": "string" + }, + "publicKeyData": { + "description": "Public key data", + "type": "string", + "x-ms-secret": true + }, + "privateKeyData": { + "description": "Private key data", + "type": "string", + "x-ms-secret": true + } + } + }, + "ComputeSecrets": { + "type": "object", + "description": "Secrets related to a Machine Learning compute. Might differ for every type of compute.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + } + }, + "required": [ + "computeType" + ] + }, + "AksComputeSecretsProperties": { + "type": "object", + "description": "Properties of AksComputeSecrets", + "properties": { + "userKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "adminKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "imagePullSecretName": { + "type": "string", + "description": "Image registry pull secret.", + "x-nullable": true + } + } + }, + "AksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "$ref": "#/definitions/AksComputeSecretsProperties" + } + ], + "x-ms-discriminator-value": "AKS" + }, + "VirtualMachineSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "$ref": "#/definitions/VirtualMachineSecretsSchema" + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "VirtualMachineSecretsSchema": { + "type": "object", + "properties": { + "administratorAccount": { + "description": "Admin credentials for virtual machine.", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + }, + "DatabricksComputeSecretsProperties": { + "type": "object", + "description": "Properties of Databricks Compute Secrets", + "properties": { + "databricksAccessToken": { + "description": "access token for databricks account.", + "type": "string" + } + } + }, + "DatabricksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on Databricks.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "$ref": "#/definitions/DatabricksComputeSecretsProperties" + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "ComputeType": { + "type": "string", + "description": "The type of compute", + "enum": [ + "AKS", + "Kubernetes", + "AmlCompute", + "ComputeInstance", + "DataFactory", + "VirtualMachine", + "HDInsight", + "Databricks", + "DataLakeAnalytics", + "SynapseSpark" + ], + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": true + } + }, + "ImageMetadata": { + "type": "object", + "description": "Returns metadata about the operating system image for this compute instance.", + "properties": { + "currentImageVersion": { + "type": "string", + "description": "Specifies the current operating system image version this compute instance is running on." + }, + "latestImageVersion": { + "type": "string", + "description": "Specifies the latest available operating system image version." + }, + "isLatestOsImageVersion": { + "type": "boolean", + "description": "Specifies whether this compute instance is running on the latest operating system image." + }, + "osPatchingStatus": { + "readOnly": true, + "description": "Metadata about the os patching.", + "$ref": "#/definitions/OsPatchingStatus" + } + } + }, + "OsPatchingStatus": { + "type": "object", + "description": "Returns metadata about the os patching.", + "properties": { + "patchStatus": { + "type": "string", + "description": "The os patching status.", + "enum": [ + "CompletedWithWarnings", + "Failed", + "InProgress", + "Succeeded", + "Unknown" + ], + "x-ms-enum": { + "name": "PatchStatus", + "modelAsString": true + } + }, + "latestPatchTime": { + "type": "string", + "description": "Time of the latest os patching." + }, + "rebootPending": { + "type": "boolean", + "description": "Specifies whether this compute instance is pending for reboot to finish os patching." + }, + "scheduledRebootTime": { + "type": "string", + "description": "Time of scheduled reboot." + } + } + }, + "CustomService": { + "type": "object", + "description": "Specifies the custom service configuration", + "properties": { + "name": { + "type": "string", + "description": "Name of the Custom Service" + }, + "image": { + "$ref": "#/definitions/Image", + "description": "Describes the Image Specifications" + }, + "environmentVariables": { + "type": "object", + "description": "Environment Variable for the container", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + "docker": { + "description": "Describes the docker settings for the image", + "$ref": "#/definitions/Docker", + "x-nullable": true + }, + "endpoints": { + "type": "array", + "description": "Configuring the endpoints for the container", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "volumes": { + "type": "array", + "description": "Configuring the volumes for the container", + "items": { + "$ref": "#/definitions/VolumeDefinition" + }, + "x-ms-identifiers": [ + "source", + "target" + ] + }, + "kernel": { + "description": "Describes the jupyter kernel settings for the image if its a custom environment", + "$ref": "#/definitions/JupyterKernelConfig" + } + }, + "additionalProperties": true + }, + "Image": { + "type": "object", + "properties": { + "type": { + "default": "docker", + "enum": [ + "docker", + "azureml" + ], + "type": "string", + "title": "Type of the image", + "description": "Type of the image. Possible values are: docker - For docker images. azureml - For AzureML Environment images (custom and curated)", + "x-ms-enum": { + "name": "ImageType", + "modelAsString": true + } + }, + "reference": { + "type": "string", + "description": "Image reference URL if type is docker. Environment name if type is azureml" + }, + "version": { + "type": "string", + "description": "Version of image being used. If latest then skip this field" + } + }, + "additionalProperties": true + }, + "EnvironmentVariable": { + "type": "object", + "properties": { + "type": { + "enum": [ + "local" + ], + "default": "local", + "title": "Type of Environment Variable", + "description": "Type of the Environment Variable. Possible values are: local - For local variable", + "type": "string", + "x-ms-enum": { + "name": "EnvironmentVariableType", + "modelAsString": true + } + }, + "value": { + "type": "string", + "description": "Value of the Environment variable" + } + }, + "additionalProperties": true + }, + "Docker": { + "type": "object", + "properties": { + "privileged": { + "type": "boolean", + "description": "Indicate whether container shall run in privileged or non-privileged mode.", + "x-nullable": true + } + }, + "additionalProperties": true + }, + "Endpoint": { + "type": "object", + "properties": { + "protocol": { + "enum": [ + "tcp", + "udp", + "http" + ], + "default": "tcp", + "title": "Endpoint Communication Protocol", + "description": "Protocol over which communication will happen over this endpoint", + "x-ms-enum": { + "name": "protocol", + "modelAsString": true + }, + "type": "string" + }, + "name": { + "type": "string", + "description": "Name of the Endpoint" + }, + "target": { + "format": "int32", + "type": "integer", + "description": "Application port inside the container." + }, + "published": { + "format": "int32", + "type": "integer", + "description": "Port over which the application is exposed from container.", + "x-nullable": true + }, + "hostIp": { + "description": "Host IP over which the application is exposed from the container", + "type": "string", + "x-nullable": true + } + } + }, + "VolumeDefinition": { + "type": "object", + "properties": { + "type": { + "enum": [ + "bind", + "volume", + "tmpfs", + "npipe" + ], + "default": "bind", + "title": "Type of Volume Definition", + "description": "Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe", + "x-ms-enum": { + "name": "VolumeDefinitionType", + "modelAsString": true + }, + "type": "string" + }, + "readOnly": { + "type": "boolean", + "description": "Indicate whether to mount volume as readOnly. Default value for this is false.", + "x-nullable": true + }, + "source": { + "type": "string", + "description": "Source of the mount. For bind mounts this is the host path." + }, + "target": { + "type": "string", + "description": "Target of the mount. For bind mounts this is the path in the container." + }, + "consistency": { + "type": "string", + "description": "Consistency of the volume", + "x-nullable": true + }, + "bind": { + "$ref": "#/definitions/BindOptions", + "description": "Bind Options of the mount", + "x-nullable": true + }, + "volume": { + "$ref": "#/definitions/VolumeOptions", + "description": "Volume Options of the mount", + "x-nullable": true + }, + "tmpfs": { + "$ref": "#/definitions/TmpfsOptions", + "description": "tmpfs option of the mount", + "x-nullable": true + } + } + }, + "VolumeOptions": { + "type": "object", + "properties": { + "nocopy": { + "type": "boolean", + "description": "Indicate whether volume is nocopy", + "x-nullable": true + } + } + }, + "BindOptions": { + "type": "object", + "properties": { + "propagation": { + "type": "string", + "description": "Type of Bind Option", + "x-nullable": true + }, + "createHostPath": { + "type": "boolean", + "description": "Indicate whether to create host path.", + "x-nullable": true + }, + "selinux": { + "type": "string", + "description": "Mention the selinux options.", + "x-nullable": true + } + } + }, + "TmpfsOptions": { + "type": "object", + "properties": { + "size": { + "format": "int32", + "type": "integer", + "description": "Mention the Tmpfs size" + } + } + }, + "JupyterKernelConfig": { + "type": "object", + "description": "Jupyter kernel configuration.", + "properties": { + "argv": { + "type": "array", + "description": "Argument to the the runtime", + "items": { + "type": "string", + "description": "argument values" + } + }, + "displayName": { + "type": "string", + "description": "Display name of the kernel" + }, + "language": { + "type": "string", + "description": "Language of the kernel [Example value: python]" + } + } + }, + "ComputeInstanceAutologgerSettings": { + "type": "object", + "description": "Specifies settings for autologger.", + "properties": { + "mlflowAutologger": { + "type": "string", + "description": "Indicates whether mlflow autologger is enabled for notebooks.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "mlflowAutologger", + "modelAsString": true + } + } + } + }, + "ComputeInstanceSshSettings": { + "type": "object", + "description": "Specifies policy and settings for SSH access.", + "properties": { + "sshPublicAccess": { + "type": "string", + "default": "Disabled", + "title": "Access policy for SSH", + "description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "sshPublicAccess", + "modelAsString": true + } + }, + "adminUserName": { + "type": "string", + "readOnly": true, + "description": "Describes the admin user name." + }, + "sshPort": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Describes the port for connecting through SSH." + }, + "adminPublicKey": { + "type": "string", + "description": "Specifies the SSH rsa public key file as a string. Use \"ssh-keygen -t rsa -b 2048\" to generate your SSH key pairs." + } + } + }, + "ComputeInstanceState": { + "type": "string", + "description": "Current state of an ComputeInstance.", + "enum": [ + "Creating", + "CreateFailed", + "Deleting", + "Running", + "Restarting", + "Resizing", + "JobRunning", + "SettingUp", + "SetupFailed", + "Starting", + "Stopped", + "Stopping", + "UserSettingUp", + "UserSetupFailed", + "Unknown", + "Unusable" + ], + "x-ms-enum": { + "name": "ComputeInstanceState", + "modelAsString": true + } + }, + "ComputeInstanceLastOperation": { + "type": "object", + "description": "The last operation on ComputeInstance.", + "properties": { + "operationName": { + "type": "string", + "description": "Name of the last operation.", + "enum": [ + "Create", + "Start", + "Stop", + "Restart", + "Resize", + "Reimage", + "Delete" + ], + "x-ms-enum": { + "name": "OperationName", + "modelAsString": true + } + }, + "operationTime": { + "type": "string", + "format": "date-time", + "description": "Time of the last operation." + }, + "operationStatus": { + "type": "string", + "description": "Operation status.", + "enum": [ + "InProgress", + "Succeeded", + "CreateFailed", + "StartFailed", + "StopFailed", + "RestartFailed", + "ResizeFailed", + "ReimageFailed", + "DeleteFailed" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": true + } + }, + "operationTrigger": { + "type": "string", + "description": "Trigger of operation.", + "enum": [ + "User", + "Schedule", + "IdleShutdown" + ], + "x-ms-enum": { + "name": "operationTrigger", + "modelAsString": true + } + } + } + }, + "ComputeInstanceVersion": { + "type": "object", + "description": "Version of computeInstance.", + "properties": { + "runtime": { + "type": "string", + "description": "Runtime of compute instance.", + "x-nullable": true + } + } + }, + "ComputeSchedules": { + "type": "object", + "description": "The list of schedules to be applied on the computes", + "properties": { + "computeStartStop": { + "type": "array", + "items": { + "$ref": "#/definitions/ComputeStartStopSchedule" + }, + "description": "The list of compute start stop schedules to be applied." + } + } + }, + "ComputeStartStopSchedule": { + "type": "object", + "description": "Compute start stop schedule properties", + "properties": { + "id": { + "description": "A system assigned id for the schedule.", + "type": "string", + "x-nullable": true, + "readOnly": true + }, + "provisioningStatus": { + "description": "The current deployment state of schedule.", + "type": "string", + "enum": [ + "Completed", + "Provisioning", + "Failed" + ], + "x-ms-enum": { + "name": "provisioningStatus", + "modelAsString": true, + "values": [ + { + "value": "Completed" + }, + { + "value": "Provisioning" + }, + { + "value": "Failed" + } + ] + }, + "readOnly": true + }, + "status": { + "$ref": "#/definitions/ScheduleStatus" + }, + "action": { + "description": "[Required] The compute power action.", + "$ref": "#/definitions/ComputePowerAction" + }, + "triggerType": { + "description": "[Required] The schedule trigger type.", + "$ref": "#/definitions/ComputeTriggerType" + }, + "recurrence": { + "description": "Required if triggerType is Recurrence.", + "$ref": "#/definitions/Recurrence" + }, + "cron": { + "description": "Required if triggerType is Cron.", + "$ref": "#/definitions/Cron" + }, + "schedule": { + "description": "[Deprecated] Not used any more.", + "$ref": "#/definitions/ScheduleBase" + } + } + }, + "ComputeTriggerType": { + "enum": [ + "Recurrence", + "Cron" + ], + "type": "string", + "x-ms-enum": { + "name": "ComputeTriggerType", + "modelAsString": true, + "values": [ + { + "value": "Recurrence" + }, + { + "value": "Cron" + } + ] + }, + "additionalProperties": false + }, + "ScheduleBase": { + "type": "object", + "properties": { + "id": { + "description": "A system assigned id for the schedule.", + "type": "string", + "x-nullable": true + }, + "provisioningStatus": { + "$ref": "#/definitions/ScheduleProvisioningState" + }, + "status": { + "$ref": "#/definitions/ScheduleStatus" + } + }, + "additionalProperties": false + }, + "ScheduleProvisioningState": { + "enum": [ + "Completed", + "Provisioning", + "Failed" + ], + "description": "The current deployment state of schedule.", + "type": "string", + "x-ms-enum": { + "name": "ScheduleProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Completed" + }, + { + "value": "Provisioning" + }, + { + "value": "Failed" + } + ] + }, + "additionalProperties": false + }, + "ScheduleStatus": { + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Is the schedule enabled or disabled?", + "type": "string", + "x-ms-enum": { + "name": "ScheduleStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "ComputePowerAction": { + "type": "string", + "description": "[Required] The compute power action.", + "enum": [ + "Start", + "Stop" + ], + "x-ms-enum": { + "name": "ComputePowerAction", + "modelAsString": true + } + }, + "Recurrence": { + "type": "object", + "description": "The workflow trigger recurrence for ComputeStartStop schedule type.", + "properties": { + "frequency": { + "description": "[Required] The frequency to trigger schedule.", + "$ref": "#/definitions/ComputeRecurrenceFrequency" + }, + "interval": { + "description": "[Required] Specifies schedule interval in conjunction with frequency", + "type": "integer", + "format": "int32" + }, + "startTime": { + "description": "The start time in yyyy-MM-ddTHH:mm:ss format.", + "type": "string", + "x-nullable": true + }, + "timeZone": { + "description": "Specifies time zone in which the schedule runs.\r\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11", + "default": "UTC", + "type": "string" + }, + "schedule": { + "description": "[Required] The recurrence schedule.", + "$ref": "#/definitions/ComputeRecurrenceSchedule" + } + } + }, + "ComputeRecurrenceFrequency": { + "description": "Enum to describe the frequency of a compute recurrence schedule", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "type": "string", + "x-ms-enum": { + "name": "ComputeRecurrenceFrequency", + "modelAsString": true, + "values": [ + { + "value": "Minute", + "description": "Minute frequency" + }, + { + "value": "Hour", + "description": "Hour frequency" + }, + { + "value": "Day", + "description": "Day frequency" + }, + { + "value": "Week", + "description": "Week frequency" + }, + { + "value": "Month", + "description": "Month frequency" + } + ] + }, + "additionalProperties": false + }, + "ComputeRecurrenceSchedule": { + "required": [ + "hours", + "minutes" + ], + "type": "object", + "properties": { + "hours": { + "description": "[Required] List of hours for the schedule.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "minutes": { + "description": "[Required] List of minutes for the schedule.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "monthDays": { + "description": "List of month days for the schedule", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true + }, + "weekDays": { + "description": "List of days for the schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/ComputeWeekDay" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ComputeWeekDay": { + "description": "Enum of weekday", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "ComputeWeekDay", + "modelAsString": true, + "values": [ + { + "value": "Monday", + "description": "Monday weekday" + }, + { + "value": "Tuesday", + "description": "Tuesday weekday" + }, + { + "value": "Wednesday", + "description": "Wednesday weekday" + }, + { + "value": "Thursday", + "description": "Thursday weekday" + }, + { + "value": "Friday", + "description": "Friday weekday" + }, + { + "value": "Saturday", + "description": "Saturday weekday" + }, + { + "value": "Sunday", + "description": "Sunday weekday" + } + ] + }, + "additionalProperties": false + }, + "Cron": { + "type": "object", + "description": "The workflow trigger cron for ComputeStartStop schedule type.", + "properties": { + "startTime": { + "description": "The start time in yyyy-MM-ddTHH:mm:ss format.", + "type": "string", + "x-nullable": true + }, + "timeZone": { + "description": "Specifies time zone in which the schedule runs.\r\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11", + "type": "string", + "default": "UTC" + }, + "expression": { + "description": "[Required] Specifies cron expression of schedule.\r\nThe expression should follow NCronTab format.", + "type": "string" + } + } + }, + "ComputeInstanceDataMount": { + "type": "object", + "description": "Defines an Aml Instance DataMount.", + "properties": { + "source": { + "type": "string", + "description": "Source of the ComputeInstance data mount." + }, + "sourceType": { + "description": "Data source type.", + "type": "string", + "enum": [ + "Dataset", + "Datastore", + "URI" + ], + "x-ms-enum": { + "name": "sourceType", + "modelAsString": true + } + }, + "mountName": { + "type": "string", + "description": "name of the ComputeInstance data mount." + }, + "mountAction": { + "description": "Mount Action.", + "type": "string", + "enum": [ + "Mount", + "Unmount" + ], + "x-ms-enum": { + "name": "mountAction", + "modelAsString": true + } + }, + "mountMode": { + "description": "Mount Mode.", + "type": "string", + "enum": [ + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "mountMode", + "modelAsString": true + } + }, + "createdBy": { + "type": "string", + "description": "who this data mount created by." + }, + "mountPath": { + "type": "string", + "description": "Path of this data mount." + }, + "mountState": { + "description": "Mount state.", + "type": "string", + "enum": [ + "MountRequested", + "Mounted", + "MountFailed", + "UnmountRequested", + "UnmountFailed", + "Unmounted" + ], + "x-ms-enum": { + "name": "mountState", + "modelAsString": true + } + }, + "mountedOn": { + "type": "string", + "format": "date-time", + "title": "Mounted time.", + "description": "The time when the disk mounted." + }, + "error": { + "type": "string", + "description": "Error of this data mount." + } + } + }, + "ComputeInstanceDataDisk": { + "type": "object", + "description": "Defines an Aml Instance DataDisk.", + "properties": { + "caching": { + "description": "Caching type of Data Disk.", + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "caching", + "modelAsString": true + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in gigabytes.", + "description": "The initial disk size in gigabytes." + }, + "lun": { + "type": "integer", + "format": "int32", + "title": "The logical unit number.", + "description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun." + }, + "storageAccountType": { + "description": "type of this storage account.", + "type": "string", + "default": "Standard_LRS", + "enum": [ + "Standard_LRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "storageAccountType", + "modelAsString": true + } + } + } + }, + "ComputeInstanceContainer": { + "type": "object", + "description": "Defines an Aml Instance container.", + "properties": { + "name": { + "type": "string", + "description": "Name of the ComputeInstance container." + }, + "autosave": { + "description": "Auto save settings.", + "type": "string", + "enum": [ + "None", + "Local", + "Remote" + ], + "x-ms-enum": { + "name": "autosave", + "modelAsString": true + } + }, + "gpu": { + "type": "string", + "description": "Information of GPU." + }, + "network": { + "description": "network of this container.", + "type": "string", + "enum": [ + "Bridge", + "Host" + ], + "x-ms-enum": { + "name": "network", + "modelAsString": true + } + }, + "environment": { + "description": "Environment information of this container.", + "$ref": "#/definitions/ComputeInstanceEnvironmentInfo" + }, + "services": { + "type": "array", + "readOnly": true, + "description": "services of this containers.", + "items": { + "type": "object" + }, + "x-ms-identifiers": [] + } + } + }, + "ComputeInstanceEnvironmentInfo": { + "type": "object", + "description": "Environment information", + "properties": { + "name": { + "description": "name of environment.", + "type": "string" + }, + "version": { + "description": "version of environment.", + "type": "string" + } + } + }, + "ComputeInstanceApplication": { + "type": "object", + "description": "Defines an Aml Instance application and its connectivity endpoint URI.", + "properties": { + "displayName": { + "type": "string", + "description": "Name of the ComputeInstance application." + }, + "endpointUri": { + "type": "string", + "description": "Application' endpoint URI." + } + } + }, + "ComputeInstanceConnectivityEndpoints": { + "type": "object", + "readOnly": true, + "description": "Defines all connectivity endpoints and properties for an ComputeInstance.", + "properties": { + "publicIpAddress": { + "type": "string", + "readOnly": true, + "description": "Public IP Address of this ComputeInstance.", + "x-nullable": true + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed).", + "x-nullable": true + } + } + }, + "ComputeInstanceCreatedBy": { + "type": "object", + "readOnly": true, + "description": "Describes information on user who created this ComputeInstance.", + "properties": { + "userName": { + "type": "string", + "readOnly": true, + "description": "Name of the user.", + "x-nullable": true + }, + "userOrgId": { + "type": "string", + "readOnly": true, + "description": "Uniquely identifies user' Azure Active Directory organization." + }, + "userId": { + "type": "string", + "readOnly": true, + "description": "Uniquely identifies the user within his/her organization.", + "x-nullable": true + } + } + }, + "PersonalComputeInstanceSettings": { + "type": "object", + "properties": { + "assignedUser": { + "$ref": "#/definitions/AssignedUser", + "title": "Assigned User.", + "description": "A user explicitly assigned to a personal compute instance." + } + }, + "description": "Settings for a personal compute instance." + }, + "AssignedUser": { + "type": "object", + "description": "A user that can be assigned to a compute instance.", + "properties": { + "objectId": { + "type": "string", + "description": "User’s AAD Object Id." + }, + "tenantId": { + "type": "string", + "description": "User’s AAD Tenant Id." + } + }, + "required": [ + "objectId", + "tenantId" + ] + }, + "SetupScripts": { + "type": "object", + "description": "Details of customized scripts to execute for setting up the cluster.", + "properties": { + "scripts": { + "description": "Customized setup scripts", + "$ref": "#/definitions/ScriptsToExecute" + } + } + }, + "ScriptsToExecute": { + "type": "object", + "description": "Customized setup scripts", + "properties": { + "startupScript": { + "description": "Script that's run every time the machine starts.", + "$ref": "#/definitions/ScriptReference" + }, + "creationScript": { + "description": "Script that's run only once during provision of the compute.", + "$ref": "#/definitions/ScriptReference" + } + } + }, + "ScriptReference": { + "type": "object", + "description": "Script reference", + "properties": { + "scriptSource": { + "description": "The storage source of the script: inline, workspace.", + "type": "string" + }, + "scriptData": { + "description": "The location of scripts in the mounted volume.", + "type": "string" + }, + "scriptArguments": { + "description": "Optional command line arguments passed to the script to run.", + "type": "string" + }, + "timeout": { + "description": "Optional time period passed to timeout command.", + "type": "string" + } + } + }, + "AutoScaleProperties": { + "type": "object", + "description": "Auto scale properties", + "properties": { + "minNodeCount": { + "format": "int32", + "type": "integer" + }, + "enabled": { + "type": "boolean" + }, + "maxNodeCount": { + "format": "int32", + "type": "integer" + } + } + }, + "AutoPauseProperties": { + "type": "object", + "description": "Auto pause properties", + "properties": { + "delayInMinutes": { + "format": "int32", + "type": "integer" + }, + "enabled": { + "type": "boolean" + } + } + }, + "InstanceTypeSchema": { + "type": "object", + "description": "Instance type schema.", + "properties": { + "nodeSelector": { + "type": "object", + "description": "Node Selector", + "x-nullable": true, + "additionalProperties": { + "type": "string", + "x-nullable": true + } + }, + "resources": { + "type": "object", + "description": "Resource requests/limits for this instance type", + "properties": { + "requests": { + "description": "Resource requests for this instance type", + "$ref": "#/definitions/InstanceResourceSchema" + }, + "limits": { + "description": "Resource limits for this instance type", + "$ref": "#/definitions/InstanceResourceSchema" + } + } + } + } + }, + "InstanceResourceSchema": { + "type": "object", + "description": "Resource requests/limits for this instance type", + "additionalProperties": { + "type": "string" + } + }, + "IdleShutdownSetting": { + "type": "object", + "description": "Stops compute instance after user defined period of inactivity.", + "properties": { + "idleTimeBeforeShutdown": { + "type": "string", + "description": "Time is defined in ISO8601 format. Minimum is 15 min, maximum is 3 days." + } + } + }, + "ResizeSchema": { + "type": "object", + "description": "Schema for Compute Instance resize.", + "properties": { + "targetVMSize": { + "type": "string", + "description": "The name of the virtual machine size." + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/mfe.json new file mode 100644 index 000000000000..237468057e3d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/mfe.json @@ -0,0 +1,31068 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "version": "2024-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/capacityReserverationGroups": { + "get": { + "tags": [ + "CapacityReservationGroup" + ], + "summary": "List CapacityReservationGroups by subscription", + "operationId": "CapacityReservationGroups_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CapacityReservationGroupTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListBySubscription Capacity Reservation Group.": { + "$ref": "./examples/CapacityReservationGroup/listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/capacityReserverationGroups": { + "get": { + "tags": [ + "CapacityReservationGroup" + ], + "summary": "Lists CapacityReservationGroups", + "operationId": "CapacityReservationGroups_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-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CapacityReservationGroupTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Capacity Reservation Group.": { + "$ref": "./examples/CapacityReservationGroup/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/capacityReserverationGroups/{groupId}": { + "delete": { + "tags": [ + "CapacityReservationGroup" + ], + "summary": "Delete CapacityReservationGroup", + "operationId": "CapacityReservationGroups_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "in": "path", + "name": "groupId", + "description": "Group ID", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Capacity Reservation Group.": { + "$ref": "./examples/CapacityReservationGroup/delete.json" + } + } + }, + "get": { + "tags": [ + "CapacityReservationGroup" + ], + "summary": "Get CapacityReservationGroup", + "operationId": "CapacityReservationGroups_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" + }, + { + "in": "path", + "name": "groupId", + "description": "Group ID", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CapacityReservationGroupTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Capacity Reservation Group.": { + "$ref": "./examples/CapacityReservationGroup/get.json" + } + } + }, + "patch": { + "tags": [ + "CapacityReservationGroup" + ], + "summary": "Update CapacityReservationGroup", + "operationId": "CapacityReservationGroups_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "in": "path", + "name": "groupId", + "description": "Group ID", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Capacity Reservation Group payload to update", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSkuAndIdentity" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CapacityReservationGroupTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Capacity Reservation Group.": { + "$ref": "./examples/CapacityReservationGroup/update.json" + } + } + }, + "put": { + "tags": [ + "CapacityReservationGroup" + ], + "summary": "Create or update CapacityReservationGroup", + "operationId": "CapacityReservationGroups_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "in": "path", + "name": "groupId", + "description": "Group ID", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Capacity Reservation Group payload to create", + "required": true, + "schema": { + "$ref": "#/definitions/CapacityReservationGroupTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/CapacityReservationGroupTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CapacityReservationGroupTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Capacity Reservation Group.": { + "$ref": "./examples/CapacityReservationGroup/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes": { + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "List containers.", + "operationId": "RegistryCodeContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Code Container.": { + "$ref": "./examples/Registry/CodeContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}": { + "delete": { + "tags": [ + "CodeContainer" + ], + "summary": "Delete Code container.", + "operationId": "RegistryCodeContainers_Delete", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Code Container.": { + "$ref": "./examples/Registry/CodeContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "Get Code container.", + "operationId": "RegistryCodeContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Code Container.": { + "$ref": "./examples/Registry/CodeContainer/get.json" + } + } + }, + "put": { + "tags": [ + "CodeContainer" + ], + "summary": "Create or update Code container.", + "operationId": "RegistryCodeContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Code Container.": { + "$ref": "./examples/Registry/CodeContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions": { + "get": { + "tags": [ + "CodeVersion" + ], + "summary": "List versions.", + "operationId": "RegistryCodeVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}": { + "delete": { + "tags": [ + "CodeVersion" + ], + "summary": "Delete version.", + "operationId": "RegistryCodeVersions_Delete", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "CodeVersion" + ], + "summary": "Get version.", + "operationId": "RegistryCodeVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/get.json" + } + } + }, + "put": { + "tags": [ + "CodeVersion" + ], + "summary": "Create or update version.", + "operationId": "RegistryCodeVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}/startPendingUpload": { + "post": { + "tags": [ + "CodeVersion" + ], + "summary": "Generate a storage location and credential for the client to upload a code asset to.", + "operationId": "RegistryCodeVersions_CreateOrGetStartPendingUpload", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Pending upload name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/createOrGetStartPendingUpload.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components": { + "get": { + "tags": [ + "ComponentContainer" + ], + "summary": "List containers.", + "operationId": "RegistryComponentContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Component Container.": { + "$ref": "./examples/Registry/ComponentContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}": { + "delete": { + "tags": [ + "ComponentContainer" + ], + "summary": "Delete container.", + "operationId": "RegistryComponentContainers_Delete", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Component Container.": { + "$ref": "./examples/Registry/ComponentContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ComponentContainer" + ], + "summary": "Get container.", + "operationId": "RegistryComponentContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Component Container.": { + "$ref": "./examples/Registry/ComponentContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ComponentContainer" + ], + "summary": "Create or update container.", + "operationId": "RegistryComponentContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Component Container.": { + "$ref": "./examples/Registry/ComponentContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions": { + "get": { + "tags": [ + "ComponentVersion" + ], + "summary": "List versions.", + "operationId": "RegistryComponentVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "stage", + "description": "Component stage.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Component Version.": { + "$ref": "./examples/Registry/ComponentVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions/{version}": { + "delete": { + "tags": [ + "ComponentVersion" + ], + "summary": "Delete version.", + "operationId": "RegistryComponentVersions_Delete", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Component Version.": { + "$ref": "./examples/Registry/ComponentVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ComponentVersion" + ], + "summary": "Get version.", + "operationId": "RegistryComponentVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Component Version.": { + "$ref": "./examples/Registry/ComponentVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ComponentVersion" + ], + "summary": "Create or update version.", + "operationId": "RegistryComponentVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Component Version.": { + "$ref": "./examples/Registry/ComponentVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data": { + "get": { + "tags": [ + "DataContainerRegistry" + ], + "summary": "List Data containers.", + "operationId": "RegistryDataContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegistryList Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/registryList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}": { + "delete": { + "tags": [ + "DataContainerRegistry" + ], + "summary": "Delete container.", + "operationId": "RegistryDataContainers_Delete", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "DataContainerRegistry" + ], + "summary": "Get container.", + "operationId": "RegistryDataContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/get.json" + } + } + }, + "put": { + "tags": [ + "DataContainerRegistry" + ], + "summary": "Create or update container.", + "operationId": "RegistryDataContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions": { + "get": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "List data versions in the data container", + "operationId": "RegistryDataVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Data container's name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegistryList Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/registryList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}": { + "delete": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "Delete version.", + "operationId": "RegistryDataVersions_Delete", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "Get version.", + "operationId": "RegistryDataVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/get.json" + } + } + }, + "put": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "Create or update version.", + "operationId": "RegistryDataVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}/startPendingUpload": { + "post": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "Generate a storage location and credential for the client to upload a data asset to.", + "operationId": "RegistryDataVersions_CreateOrGetStartPendingUpload", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Data asset name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/datareferences/{name}/versions/{version}": { + "post": { + "tags": [ + "DataReference" + ], + "summary": "Get blob reference SAS Uri value.", + "operationId": "RegistryDataReferences_GetBlobReferenceSAS", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Data reference name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Asset id and blob uri.", + "required": true, + "schema": { + "$ref": "#/definitions/GetBlobReferenceSASRequestDto" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/GetBlobReferenceSASResponseDto" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetBlobReferenceSAS Data Reference.": { + "$ref": "./examples/DataReference/getBlobReferenceSAS.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments": { + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "List environment containers.", + "operationId": "RegistryEnvironmentContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}": { + "delete": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Delete container.", + "operationId": "RegistryEnvironmentContainers_Delete", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Get container.", + "operationId": "RegistryEnvironmentContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/get.json" + } + } + }, + "put": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Create or update container.", + "operationId": "RegistryEnvironmentContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions": { + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "List versions.", + "operationId": "RegistryEnvironmentVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "stage", + "description": "Stage for including/excluding (for example) archived entities. Takes priority over listViewType", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}": { + "delete": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Delete version.", + "operationId": "RegistryEnvironmentVersions_Delete", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Get version.", + "operationId": "RegistryEnvironmentVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/get.json" + } + } + }, + "put": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Create or update version.", + "operationId": "RegistryEnvironmentVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions": { + "get": { + "tags": [ + "MarketplaceSubscription" + ], + "summary": "List containers.", + "operationId": "MarketplaceSubscriptions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MarketplaceSubscriptionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}": { + "delete": { + "tags": [ + "MarketplaceSubscription" + ], + "summary": "Delete Marketplace Subscription (asynchronous).", + "operationId": "MarketplaceSubscriptions_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Marketplace Subscription name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "MarketplaceSubscription" + ], + "summary": "Get container.", + "operationId": "MarketplaceSubscriptions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MarketplaceSubscriptionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/get.json" + } + } + }, + "put": { + "tags": [ + "MarketplaceSubscription" + ], + "summary": "Create or update Marketplace Subscription (asynchronous).", + "operationId": "MarketplaceSubscriptions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Marketplace Subscription name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Marketplace Subscription entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/MarketplaceSubscriptionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/MarketplaceSubscriptionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/MarketplaceSubscriptionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models": { + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "List model containers.", + "operationId": "RegistryModelContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}": { + "delete": { + "tags": [ + "ModelContainer" + ], + "summary": "Delete container.", + "operationId": "RegistryModelContainers_Delete", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "Get container.", + "operationId": "RegistryModelContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ModelContainer" + ], + "summary": "Create or update model container.", + "operationId": "RegistryModelContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions": { + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "List versions.", + "operationId": "RegistryModelVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "version", + "description": "Version identifier.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Model description.", + "type": "string" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}": { + "delete": { + "tags": [ + "ModelVersion" + ], + "summary": "Delete version.", + "operationId": "RegistryModelVersions_Delete", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "Get version.", + "operationId": "RegistryModelVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ModelVersion" + ], + "summary": "Create or update version.", + "operationId": "RegistryModelVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}/package": { + "post": { + "tags": [ + "ModelVersion" + ], + "summary": "Model Version Package operation.", + "operationId": "RegistryModelVersions_Package", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Package operation request body.", + "required": true, + "schema": { + "$ref": "#/definitions/PackageRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PackageResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Package Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/package.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}/startPendingUpload": { + "post": { + "tags": [ + "ModelVersion" + ], + "summary": "Generate a storage location and credential for the client to upload a model asset to.", + "operationId": "RegistryModelVersions_CreateOrGetStartPendingUpload", + "consumes": [ + "application/json" + ], + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Model name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/createOrGetStartPendingUpload.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": { + "get": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Lists Batch inference endpoint in the workspace.", + "operationId": "BatchEndpoints_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": { + "delete": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Delete Batch Inference Endpoint (asynchronous).", + "operationId": "BatchEndpoints_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Gets a batch inference endpoint by name.", + "operationId": "BatchEndpoints_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Name for the Batch Endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/get.json" + } + } + }, + "patch": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Update a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_Update", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Name for the Batch inference endpoint.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Mutable batch inference endpoint definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Creates a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Name for the Batch inference endpoint.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Batch inference endpoint definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": { + "get": { + "tags": [ + "BatchDeployment" + ], + "summary": "Lists Batch inference deployments in the workspace.", + "operationId": "BatchDeployments_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top of list.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": { + "delete": { + "tags": [ + "BatchDeployment" + ], + "summary": "Delete Batch Inference deployment (asynchronous).", + "operationId": "BatchDeployments_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference deployment identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "BatchDeployment" + ], + "summary": "Gets a batch inference deployment by id.", + "operationId": "BatchDeployments_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch deployments.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/get.json" + } + } + }, + "patch": { + "tags": [ + "BatchDeployment" + ], + "summary": "Update a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_Update", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Batch inference deployment definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "BatchDeployment" + ], + "summary": "Creates/updates a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Batch inference deployment definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": { + "post": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Lists batch Inference Endpoint keys.", + "operationId": "BatchEndpoints_ListKeys", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListKeys Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": { + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "List containers.", + "operationId": "CodeContainers_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": { + "delete": { + "tags": [ + "CodeContainer" + ], + "summary": "Delete container.", + "operationId": "CodeContainers_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "Get container.", + "operationId": "CodeContainers_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/get.json" + } + } + }, + "put": { + "tags": [ + "CodeContainer" + ], + "summary": "Create or update container.", + "operationId": "CodeContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": { + "get": { + "tags": [ + "CodeVersion" + ], + "summary": "List versions.", + "operationId": "CodeVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "hash", + "description": "If specified, return CodeVersion assets with specified content hash value, regardless of name", + "type": "string" + }, + { + "in": "query", + "name": "hashVersion", + "description": "Hash algorithm version when listing by hash", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": { + "delete": { + "tags": [ + "CodeVersion" + ], + "summary": "Delete version.", + "operationId": "CodeVersions_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "CodeVersion" + ], + "summary": "Get version.", + "operationId": "CodeVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/get.json" + } + } + }, + "put": { + "tags": [ + "CodeVersion" + ], + "summary": "Create or update version.", + "operationId": "CodeVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/publish": { + "post": { + "tags": [ + "CodeVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "CodeVersions_Publish", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Publish Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/startPendingUpload": { + "post": { + "tags": [ + "CodeVersion" + ], + "summary": "Generate a storage location and credential for the client to upload a code asset to.", + "operationId": "CodeVersions_CreateOrGetStartPendingUpload", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components": { + "get": { + "tags": [ + "ComponentContainer" + ], + "summary": "List component containers.", + "operationId": "ComponentContainers_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}": { + "delete": { + "tags": [ + "ComponentContainer" + ], + "summary": "Delete container.", + "operationId": "ComponentContainers_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "ComponentContainer" + ], + "summary": "Get container.", + "operationId": "ComponentContainers_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ComponentContainer" + ], + "summary": "Create or update container.", + "operationId": "ComponentContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions": { + "get": { + "tags": [ + "ComponentVersion" + ], + "summary": "List component versions.", + "operationId": "ComponentVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Component name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "stage", + "description": "Component stage.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}": { + "delete": { + "tags": [ + "ComponentVersion" + ], + "summary": "Delete version.", + "operationId": "ComponentVersions_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "ComponentVersion" + ], + "summary": "Get version.", + "operationId": "ComponentVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ComponentVersion" + ], + "summary": "Create or update version.", + "operationId": "ComponentVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}/publish": { + "post": { + "tags": [ + "ComponentVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "ComponentVersions_Publish", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Publish Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": { + "get": { + "tags": [ + "DataContainer" + ], + "summary": "List data containers.", + "operationId": "DataContainers_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": { + "delete": { + "tags": [ + "DataContainer" + ], + "summary": "Delete container.", + "operationId": "DataContainers_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "DataContainer" + ], + "summary": "Get container.", + "operationId": "DataContainers_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/get.json" + } + } + }, + "put": { + "tags": [ + "DataContainer" + ], + "summary": "Create or update container.", + "operationId": "DataContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": { + "get": { + "tags": [ + "DataVersion" + ], + "summary": "List data versions in the data container", + "operationId": "DataVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Data container's name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "stage", + "description": "data stage", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": { + "delete": { + "tags": [ + "DataVersion" + ], + "summary": "Delete version.", + "operationId": "DataVersions_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/delete.json" + } + } + }, + "get": { + "tags": [ + "DataVersion" + ], + "summary": "Get version.", + "operationId": "DataVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/get.json" + } + } + }, + "put": { + "tags": [ + "DataVersion" + ], + "summary": "Create or update version.", + "operationId": "DataVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}/publish": { + "post": { + "tags": [ + "DataVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "DataVersions_Publish", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Publish Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { + "get": { + "tags": [ + "Datastore" + ], + "summary": "List datastores.", + "operationId": "Datastores_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "count", + "description": "Maximum number of results to return.", + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "in": "query", + "name": "isDefault", + "description": "Filter down to the workspace default datastore.", + "type": "boolean" + }, + { + "in": "query", + "name": "names", + "description": "Names of datastores to return.", + "type": "array", + "items": { + "type": "string" + } + }, + { + "in": "query", + "name": "searchText", + "description": "Text to search for in the datastore names.", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "Order by property (createdtime | modifiedtime | name).", + "type": "string" + }, + { + "in": "query", + "name": "orderByAsc", + "description": "Order by property in ascending order.", + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatastoreResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List datastores.": { + "$ref": "./examples/Datastore/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": { + "delete": { + "tags": [ + "Datastore" + ], + "summary": "Delete datastore.", + "operationId": "Datastores_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Datastore name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete datastore.": { + "$ref": "./examples/Datastore/delete.json" + } + } + }, + "get": { + "tags": [ + "Datastore" + ], + "summary": "Get datastore.", + "operationId": "Datastores_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Datastore name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get datastore.": { + "$ref": "./examples/Datastore/get.json" + } + } + }, + "put": { + "tags": [ + "Datastore" + ], + "summary": "Create or update datastore.", + "operationId": "Datastores_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Datastore name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "skipValidation", + "description": "Flag to skip validation.", + "type": "boolean", + "default": false + }, + { + "in": "body", + "name": "body", + "description": "Datastore entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate datastore (AzureBlob w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen1 w/ ServicePrincipal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen2 w/ Service Principal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure File store w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureFileWAccountKey/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": { + "post": { + "tags": [ + "Datastore" + ], + "summary": "Get datastore secrets.", + "operationId": "Datastores_ListSecrets", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Datastore name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "description": "Base definition for datastore secrets.", + "$ref": "#/definitions/DatastoreSecrets" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get datastore secrets.": { + "$ref": "./examples/Datastore/listSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": { + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "List environment containers.", + "operationId": "EnvironmentContainers_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": { + "delete": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Delete container.", + "operationId": "EnvironmentContainers_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Get container.", + "operationId": "EnvironmentContainers_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/get.json" + } + } + }, + "put": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Create or update container.", + "operationId": "EnvironmentContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": { + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "List versions.", + "operationId": "EnvironmentVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "stage", + "description": "Stage for including/excluding (for example) archived entities. Takes priority over listViewType", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": { + "delete": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Delete version.", + "operationId": "EnvironmentVersions_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Get version.", + "operationId": "EnvironmentVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/get.json" + } + } + }, + "put": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Creates or updates an EnvironmentVersion.", + "operationId": "EnvironmentVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Name of EnvironmentVersion. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version of EnvironmentVersion.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Definition of EnvironmentVersion.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}/publish": { + "post": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "EnvironmentVersions_Publish", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Publish Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets": { + "get": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "List featurestore entity containers.", + "operationId": "FeaturesetContainers_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "name", + "description": "name for the featureset", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature set", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features": { + "get": { + "tags": [ + "Feature" + ], + "summary": "List Features.", + "operationId": "Features_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "featuresetName", + "description": "Featureset name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "featuresetVersion", + "description": "Featureset Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "featureName", + "description": "feature name.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Description of the featureset.", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "Page size.", + "type": "integer", + "format": "int32", + "default": 1000 + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeatureResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Feature.": { + "$ref": "./examples/Feature/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}": { + "get": { + "tags": [ + "Feature" + ], + "summary": "Get feature.", + "operationId": "Features_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "featuresetName", + "description": "Feature set name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "featuresetVersion", + "description": "Feature set version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "featureName", + "description": "Feature Name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeatureResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Feature.": { + "$ref": "./examples/Feature/get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": { + "delete": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "Delete container.", + "operationId": "FeaturesetContainers_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "Get container.", + "operationId": "FeaturesetContainers_GetEntity", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetEntity Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/getEntity.json" + } + } + }, + "put": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "Create or update container.", + "operationId": "FeaturesetContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions": { + "get": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "List versions.", + "operationId": "FeaturesetVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Featureset name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "versionName", + "description": "name for the featureset version", + "type": "string" + }, + { + "in": "query", + "name": "version", + "description": "featureset version", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature set version", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" + }, + { + "in": "query", + "name": "stage", + "description": "Specifies the featurestore stage", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}": { + "delete": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "Delete version.", + "operationId": "FeaturesetVersions_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "Get version.", + "operationId": "FeaturesetVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/get.json" + } + } + }, + "put": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "Create or update version.", + "operationId": "FeaturesetVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill": { + "post": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "Backfill.", + "operationId": "FeaturesetVersions_Backfill", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Feature set version backfill request entity.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetVersionBackfillRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionBackfillResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backfill Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/backfill.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities": { + "get": { + "tags": [ + "FeaturestoreEntityContainer" + ], + "summary": "List featurestore entity containers.", + "operationId": "FeaturestoreEntityContainers_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "name", + "description": "name for the featurestore entity", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the featurestore entity", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}": { + "delete": { + "tags": [ + "FeaturestoreEntityContainer" + ], + "summary": "Delete container.", + "operationId": "FeaturestoreEntityContainers_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FeaturestoreEntityContainer" + ], + "summary": "Get container.", + "operationId": "FeaturestoreEntityContainers_GetEntity", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetEntity Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/getEntity.json" + } + } + }, + "put": { + "tags": [ + "FeaturestoreEntityContainer" + ], + "summary": "Create or update container.", + "operationId": "FeaturestoreEntityContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions": { + "get": { + "tags": [ + "FeaturestoreEntityVersion" + ], + "summary": "List versions.", + "operationId": "FeaturestoreEntityVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Feature entity name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "versionName", + "description": "name for the featurestore entity version", + "type": "string" + }, + { + "in": "query", + "name": "version", + "description": "featurestore entity version", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature entity version", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" + }, + { + "in": "query", + "name": "stage", + "description": "Specifies the featurestore stage", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}": { + "delete": { + "tags": [ + "FeaturestoreEntityVersion" + ], + "summary": "Delete version.", + "operationId": "FeaturestoreEntityVersions_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FeaturestoreEntityVersion" + ], + "summary": "Get version.", + "operationId": "FeaturestoreEntityVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/get.json" + } + } + }, + "put": { + "tags": [ + "FeaturestoreEntityVersion" + ], + "summary": "Create or update version.", + "operationId": "FeaturestoreEntityVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools": { + "get": { + "tags": [ + "InferencePool" + ], + "summary": "List InferencePools.", + "operationId": "InferencePools_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of inferencePools to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "The option to order the response.", + "type": "string", + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InferencePoolTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Inference Pool.": { + "$ref": "./examples/Workspace/InferencePool/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{inferencePoolName}": { + "delete": { + "tags": [ + "InferencePool" + ], + "summary": "Delete InferencePool (asynchronous).", + "operationId": "InferencePools_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "inferencePoolName", + "description": "Name of InferencePool", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Inference Pool.": { + "$ref": "./examples/Workspace/InferencePool/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "InferencePool" + ], + "summary": "Get InferencePool.", + "operationId": "InferencePools_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "inferencePoolName", + "description": "Name of InferencePool", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InferencePoolTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Inference Pool.": { + "$ref": "./examples/Workspace/InferencePool/get.json" + } + } + }, + "patch": { + "tags": [ + "InferencePool" + ], + "summary": "Update InferencePool (asynchronous).", + "operationId": "InferencePools_Update", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "inferencePoolName", + "description": "Name of InferencePool", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Inference Pool entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSkuAndIdentity" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InferencePoolTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace Inference Pool.": { + "$ref": "./examples/Workspace/InferencePool/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "InferencePool" + ], + "summary": "Create or update InferencePool (asynchronous).", + "operationId": "InferencePools_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "inferencePoolName", + "description": "Name of InferencePool", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "InferencePool entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/InferencePoolTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/InferencePoolTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/InferencePoolTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Inference Pool.": { + "$ref": "./examples/Workspace/InferencePool/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{inferencePoolName}/getStatus": { + "post": { + "tags": [ + "InferencePool" + ], + "summary": "Retrieve inference pool status.", + "operationId": "InferencePools_GetStatus", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "inferencePoolName", + "description": "Name of InferencePool", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PoolStatus" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetStatus Workspace Inference Pool.": { + "$ref": "./examples/Workspace/InferencePool/getStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{inferencePoolName}/skus": { + "get": { + "tags": [ + "InferencePool" + ], + "summary": "List Inference Pool Skus.", + "operationId": "InferencePools_ListSkus", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "inferencePoolName", + "description": "Inference Group name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of Skus to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SkuResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListSkus Workspace Inference Pool.": { + "$ref": "./examples/Workspace/InferencePool/listSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/endpoints": { + "get": { + "tags": [ + "InferenceEndpoint" + ], + "summary": "List Inference Endpoints.", + "operationId": "InferenceEndpoints_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "poolName", + "description": "Name of the InferencePool.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of InferenceEndpoint to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "The option to order the response.", + "type": "string", + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InferenceEndpointTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Inference Endpoint.": { + "$ref": "./examples/Workspace/InferenceEndpoint/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/endpoints/{endpointName}": { + "delete": { + "tags": [ + "InferenceEndpoint" + ], + "summary": "Delete InferenceEndpoint (asynchronous).", + "operationId": "InferenceEndpoints_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "poolName", + "description": "InferencePool name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "endpointName", + "description": "InferenceEndpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Inference Endpoint.": { + "$ref": "./examples/Workspace/InferenceEndpoint/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "InferenceEndpoint" + ], + "summary": "Get InferenceEndpoint.", + "operationId": "InferenceEndpoints_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "poolName", + "description": "InferencePool name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "endpointName", + "description": "InferenceEndpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InferenceEndpointTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Inference Endpoint.": { + "$ref": "./examples/Workspace/InferenceEndpoint/get.json" + } + } + }, + "patch": { + "tags": [ + "InferenceEndpoint" + ], + "summary": "Update InferenceEndpoint (asynchronous).", + "operationId": "InferenceEndpoints_Update", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "poolName", + "description": "InferencePool name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "endpointName", + "description": "InferenceEndpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "description": "Strictly used in update requests." + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InferenceEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace Inference Endpoint.": { + "$ref": "./examples/Workspace/InferenceEndpoint/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "InferenceEndpoint" + ], + "summary": "Create or update InferenceEndpoint (asynchronous).", + "operationId": "InferenceEndpoints_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "poolName", + "description": "InferencePool name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "endpointName", + "description": "InferenceEndpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "InferenceEndpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/InferenceEndpointTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/InferenceEndpointTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/InferenceEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Inference Endpoint.": { + "$ref": "./examples/Workspace/InferenceEndpoint/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups": { + "get": { + "tags": [ + "InferenceGroup" + ], + "summary": "List Inference Groups.", + "operationId": "InferenceGroups_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "poolName", + "description": "Name of the InferencePool.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of InferenceGroup to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "The option to order the response.", + "type": "string", + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InferenceGroupTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Inference Group.": { + "$ref": "./examples/Workspace/InferenceGroup/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups/{groupName}": { + "delete": { + "tags": [ + "InferenceGroup" + ], + "summary": "Delete InferenceGroup (asynchronous).", + "operationId": "InferenceGroups_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "poolName", + "description": "InferencePool name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "groupName", + "description": "InferenceGroup name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Inference Group.": { + "$ref": "./examples/Workspace/InferenceGroup/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "InferenceGroup" + ], + "summary": "Get InferenceGroup.", + "operationId": "InferenceGroups_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "poolName", + "description": "InferencePool name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "groupName", + "description": "InferenceGroup name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InferenceGroupTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Inference Group.": { + "$ref": "./examples/Workspace/InferenceGroup/get.json" + } + } + }, + "patch": { + "tags": [ + "InferenceGroup" + ], + "summary": "Update InferenceGroup (asynchronous).", + "operationId": "InferenceGroups_Update", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "poolName", + "description": "InferencePool name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "groupName", + "description": "InferenceGroup name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSku" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InferenceGroupTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace Inference Group.": { + "$ref": "./examples/Workspace/InferenceGroup/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "InferenceGroup" + ], + "summary": "Create or update InferenceGroup (asynchronous).", + "operationId": "InferenceGroups_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "poolName", + "description": "InferencePool name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "groupName", + "description": "InferenceGroup name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "InferenceGroup entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/InferenceGroupTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/InferenceGroupTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/InferenceGroupTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Inference Group.": { + "$ref": "./examples/Workspace/InferenceGroup/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups/{groupName}/getStatus": { + "post": { + "tags": [ + "InferenceGroup" + ], + "summary": "Retrieve inference group status.", + "operationId": "InferenceGroups_GetStatus", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "poolName", + "description": "InferencePool name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "groupName", + "description": "InferenceGroup name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/GroupStatus" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetStatus Workspace Inference Group.": { + "$ref": "./examples/Workspace/InferenceGroup/getStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups/{groupName}/skus": { + "get": { + "tags": [ + "InferenceGroup" + ], + "summary": "List Inference Group Skus.", + "operationId": "InferenceGroups_ListSkus", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "poolName", + "description": "Inference Pool name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "groupName", + "description": "Inference Group name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of Skus to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SkuResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListSkus Workspace Inference Group.": { + "$ref": "./examples/Workspace/InferenceGroup/listSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": { + "get": { + "tags": [ + "Job" + ], + "summary": "Lists Jobs in the workspace.", + "operationId": "Jobs_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "jobType", + "description": "Type of job to be returned.", + "type": "string" + }, + { + "in": "query", + "name": "tag", + "description": "Jobs returned will have this tag key.", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + }, + { + "in": "query", + "name": "assetName", + "description": "Asset name the job's named output is registered with", + "type": "string" + }, + { + "in": "query", + "name": "scheduled", + "description": "Indicator whether the job is scheduled job.", + "type": "boolean" + }, + { + "in": "query", + "name": "scheduleId", + "description": "The scheduled id for listing the job triggered from", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Command Job.": { + "$ref": "./examples/Job/CommandJob/list.json" + }, + "List AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/list.json" + }, + "List FineTuning Job.": { + "$ref": "./examples/Job/FineTuningJob/list.json" + }, + "List Sweep Job.": { + "$ref": "./examples/Job/SweepJob/list.json" + }, + "List Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { + "delete": { + "tags": [ + "Job" + ], + "summary": "Deletes a Job (asynchronous).", + "operationId": "Jobs_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Job.": { + "$ref": "./examples/Job/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Job" + ], + "summary": "Gets a Job by name/id.", + "operationId": "Jobs_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Command Job.": { + "$ref": "./examples/Job/CommandJob/get.json" + }, + "Get AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/get.json" + }, + "Get FineTuning Job.": { + "$ref": "./examples/Job/FineTuningJob/get.json" + }, + "Get Sweep Job.": { + "$ref": "./examples/Job/SweepJob/get.json" + }, + "Get Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/get.json" + } + } + }, + "patch": { + "tags": [ + "Job" + ], + "summary": "Updates a Job.", + "operationId": "Jobs_Update", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Job definition to apply during the operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialJobBasePartialResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Job.": { + "$ref": "./examples/Job/update.json" + } + } + }, + "put": { + "tags": [ + "Job" + ], + "summary": "Creates and executes a Job.\r\nFor update case, the Tags in the definition passed in will replace Tags in the existing job.", + "operationId": "Jobs_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Job definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Command Job.": { + "$ref": "./examples/Job/CommandJob/createOrUpdate.json" + }, + "CreateOrUpdate AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/createOrUpdate.json" + }, + "CreateOrUpdate FineTuning Job.": { + "$ref": "./examples/Job/FineTuningJob/createOrUpdate.json" + }, + "CreateOrUpdate Sweep Job.": { + "$ref": "./examples/Job/SweepJob/createOrUpdate.json" + }, + "CreateOrUpdate Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { + "post": { + "tags": [ + "Job" + ], + "summary": "Cancels a Job (asynchronous).", + "operationId": "Jobs_Cancel", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Cancel Job.": { + "$ref": "./examples/Job/cancel.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs": { + "get": { + "tags": [ + "LabelingJob" + ], + "summary": "Lists labeling jobs in the workspace.", + "operationId": "LabelingJobs_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$top", + "description": "Number of labeling jobs to return.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LabelingJobResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Labeling Job.": { + "$ref": "./examples/LabelingJob/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}": { + "delete": { + "tags": [ + "LabelingJob" + ], + "summary": "Delete a labeling job.", + "operationId": "LabelingJobs_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Labeling Job.": { + "$ref": "./examples/LabelingJob/delete.json" + } + } + }, + "get": { + "tags": [ + "LabelingJob" + ], + "summary": "Gets a labeling job by name/id.", + "operationId": "LabelingJobs_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LabelingJobResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Labeling Job.": { + "$ref": "./examples/LabelingJob/get.json" + } + } + }, + "put": { + "tags": [ + "LabelingJob" + ], + "summary": "Creates or updates a labeling job (asynchronous).", + "operationId": "LabelingJobs_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "LabelingJob definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/LabelingJobResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/LabelingJobResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/LabelingJobResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Labeling Job.": { + "$ref": "./examples/LabelingJob/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/exportLabels": { + "post": { + "tags": [ + "LabelingJob" + ], + "summary": "Export labels from a labeling job (asynchronous). Using the URL in the Location header, the status of the job export operation can be tracked.", + "operationId": "LabelingJobs_ExportLabels", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The export summary.", + "required": true, + "schema": { + "$ref": "#/definitions/ExportSummary" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExportSummary" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExportLabels Labeling Job.": { + "$ref": "./examples/LabelingJob/exportLabels.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/pause": { + "post": { + "tags": [ + "LabelingJob" + ], + "summary": "Pause a labeling job.", + "operationId": "LabelingJobs_Pause", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LabelingJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pause Labeling Job.": { + "$ref": "./examples/LabelingJob/pause.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/resume": { + "post": { + "tags": [ + "LabelingJob" + ], + "summary": "Resume a labeling job (asynchronous).", + "operationId": "LabelingJobs_Resume", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LabelingJob" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Resume Labeling Job.": { + "$ref": "./examples/LabelingJob/resume.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models": { + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "List model containers.", + "operationId": "ModelContainers_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "count", + "description": "Maximum number of results to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": { + "delete": { + "tags": [ + "ModelContainer" + ], + "summary": "Delete container.", + "operationId": "ModelContainers_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "Get container.", + "operationId": "ModelContainers_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ModelContainer" + ], + "summary": "Create or update container.", + "operationId": "ModelContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions": { + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "List model versions.", + "operationId": "ModelVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Model name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "version", + "description": "Model version.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Model description.", + "type": "string" + }, + { + "in": "query", + "name": "offset", + "description": "Number of initial results to skip.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + }, + { + "in": "query", + "name": "feed", + "description": "Name of the feed.", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "stage", + "description": "Model stage", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": { + "delete": { + "tags": [ + "ModelVersion" + ], + "summary": "Delete version.", + "operationId": "ModelVersions_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "Get version.", + "operationId": "ModelVersions_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ModelVersion" + ], + "summary": "Create or update version.", + "operationId": "ModelVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}/package": { + "post": { + "tags": [ + "ModelVersion" + ], + "summary": "Model Version Package operation.", + "operationId": "ModelVersions_Package", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Package operation request body.", + "required": true, + "schema": { + "$ref": "#/definitions/PackageRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PackageResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Package Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/package.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}/publish": { + "post": { + "tags": [ + "ModelVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "ModelVersions_Publish", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Publish Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": { + "get": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "List Online Endpoints.", + "operationId": "OnlineEndpoints_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "name", + "description": "Name of the endpoint.", + "type": "string" + }, + { + "in": "query", + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "computeType", + "description": "EndpointComputeType to be filtered by.", + "type": "string", + "enum": [ + "Managed", + "Kubernetes", + "AzureMLCompute" + ], + "x-ms-enum": { + "name": "EndpointComputeType", + "modelAsString": true + } + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "The option to order the response.", + "type": "string", + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}": { + "delete": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Delete Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Get Online Endpoint.", + "operationId": "OnlineEndpoints_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/get.json" + } + } + }, + "patch": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Update Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_Update", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Create or update Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": { + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "List Inference Endpoint Deployments.", + "operationId": "OnlineDeployments_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top of list.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Online Deployments.": { + "$ref": "./examples/OnlineDeployment/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": { + "delete": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Delete Inference Endpoint Deployment (asynchronous).", + "operationId": "OnlineDeployments_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Online Deployment.": { + "$ref": "./examples/Workspace/OnlineDeployment/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Get Inference Deployment Deployment.", + "operationId": "OnlineDeployments_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/get.json" + }, + "Get Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/get.json" + } + } + }, + "patch": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Update Online Deployment (asynchronous).", + "operationId": "OnlineDeployments_Update", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSku" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/update.json" + }, + "Update Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Create or update Inference Endpoint Deployment (asynchronous).", + "operationId": "OnlineDeployments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Inference Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json" + }, + "CreateOrUpdate Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": { + "post": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Polls an Endpoint operation.", + "operationId": "OnlineDeployments_GetLogs", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The name and identifier for the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The request containing parameters for retrieving logs.", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentLogsRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentLogs" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Online Deployment Logs.": { + "$ref": "./examples/OnlineDeployment/getLogs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/skus": { + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "List Inference Endpoint Deployment Skus.", + "operationId": "OnlineDeployments_ListSkus", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of Skus to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SkuResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Managed Online Deployment Skus.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json" + }, + "List Kubernetes Online Deployment Skus.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/listKeys": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", + "operationId": "OnlineEndpoints_ListKeys", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListKeys Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", + "operationId": "OnlineEndpoints_RegenerateKeys", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "RegenerateKeys request .", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateEndpointKeysRequest" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegenerateKeys Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/regenerateKeys.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/token": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.", + "operationId": "OnlineEndpoints_GetToken", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthToken" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetToken Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/getToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules": { + "get": { + "tags": [ + "Schedule" + ], + "summary": "List schedules in specified workspace.", + "operationId": "Schedules_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "Status filter for schedule.", + "type": "string", + "default": "EnabledOnly", + "enum": [ + "EnabledOnly", + "DisabledOnly", + "All" + ], + "x-ms-enum": { + "name": "ScheduleListViewType", + "modelAsString": true, + "values": [ + { + "value": "EnabledOnly" + }, + { + "value": "DisabledOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Schedules.": { + "$ref": "./examples/Schedule/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}": { + "delete": { + "tags": [ + "Schedule" + ], + "summary": "Delete schedule.", + "operationId": "Schedules_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Schedule.": { + "$ref": "./examples/Schedule/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Schedule" + ], + "summary": "Get schedule.", + "operationId": "Schedules_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Schedule.": { + "$ref": "./examples/Schedule/get.json" + } + } + }, + "put": { + "tags": [ + "Schedule" + ], + "summary": "Create or update schedule.", + "operationId": "Schedules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Schedule definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ScheduleResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Schedule.": { + "$ref": "./examples/Schedule/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}/trigger": { + "post": { + "tags": [ + "Schedule" + ], + "summary": "Trigger run.", + "operationId": "Schedules_Trigger", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Request body for trigger once", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerOnceRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TriggerRunSubmissionDto" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Trigger Schedule.": { + "$ref": "./examples/Schedule/trigger.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints": { + "get": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "List Serverless Endpoints.", + "operationId": "ServerlessEndpoints_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}": { + "delete": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Delete Serverless Endpoint (asynchronous).", + "operationId": "ServerlessEndpoints_Delete", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Get Serverless Endpoint.", + "operationId": "ServerlessEndpoints_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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/get.json" + } + } + }, + "patch": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Update Serverless Endpoint (asynchronous).", + "operationId": "ServerlessEndpoints_Update", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Serverless Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSkuAndIdentity" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Create or update Serverless Endpoint (asynchronous).", + "operationId": "ServerlessEndpoints_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{0,51}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Serverless Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/getStatus": { + "post": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Status of the model backing the Serverless Endpoint.", + "operationId": "ServerlessEndpoints_GetStatus", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointStatus" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetStatus Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/getStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/listKeys": { + "post": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", + "operationId": "ServerlessEndpoints_ListKeys", + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListKeys Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/regenerateKeys": { + "post": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", + "operationId": "ServerlessEndpoints_RegenerateKeys", + "consumes": [ + "application/json" + ], + "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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "RegenerateKeys request .", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateEndpointKeysRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegenerateKeys Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/regenerateKeys.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "AccountKeyDatastoreCredentials": { + "description": "Account key datastore credentials configuration.", + "required": [ + "secrets" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "secrets": { + "description": "[Required] Storage account secrets.", + "$ref": "#/definitions/AccountKeyDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "AccountKey", + "additionalProperties": false + }, + "AccountKeyDatastoreSecrets": { + "description": "Datastore account key secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "key": { + "description": "Storage account key.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "AccountKey", + "additionalProperties": false + }, + "ActualCapacityInfo": { + "type": "object", + "properties": { + "allocated": { + "format": "int32", + "description": "Gets or sets the total number of instances for the group.", + "default": 0, + "type": "integer" + }, + "assignmentFailed": { + "format": "int32", + "description": "Gets or sets the number of instances which failed to successfully complete assignment.", + "default": 0, + "type": "integer" + }, + "assignmentSuccess": { + "format": "int32", + "description": "Gets or sets the number of instances which successfully completed assignment.", + "default": 0, + "type": "integer" + } + }, + "additionalProperties": false + }, + "AllFeatures": { + "required": [ + "filterType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringFeatureFilterBase" + } + ], + "x-ms-discriminator-value": "AllFeatures", + "additionalProperties": false + }, + "AllNodes": { + "description": "All nodes means the service will be running on all of the nodes of the job", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Nodes" + } + ], + "x-ms-discriminator-value": "All", + "additionalProperties": false + }, + "AmlToken": { + "description": "AML Token identity configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IdentityConfiguration" + } + ], + "x-ms-discriminator-value": "AMLToken", + "additionalProperties": false + }, + "AmlTokenComputeIdentity": { + "description": "AML token compute identity definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitorComputeIdentityBase" + } + ], + "x-ms-discriminator-value": "AmlToken", + "additionalProperties": false + }, + "AnonymousAccessCredential": { + "description": "Access credential with no credentials", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataReferenceCredential" + } + ], + "x-ms-discriminator-value": "NoCredentials", + "additionalProperties": false + }, + "AssetBase": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "autoDeleteSetting": { + "description": "Specifies the lifecycle setting of managed data asset.", + "$ref": "#/definitions/AutoDeleteSetting", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "isAnonymous": { + "description": "If the name version are system generated (anonymous registration). For types where Stage is defined, when Stage is provided it will be used to populate IsAnonymous", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "isArchived": { + "description": "Is the asset archived? For types where Stage is defined, when Stage is provided it will be used to populate IsArchived", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "additionalProperties": false + }, + "AssetContainer": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "isArchived": { + "description": "Is the asset archived?", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "latestVersion": { + "description": "The latest version inside this container.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "nextVersion": { + "description": "The next auto incremental version", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AssetJobInput": { + "description": "Asset input type.", + "required": [ + "uri" + ], + "type": "object", + "properties": { + "mode": { + "description": "Input Asset Delivery Mode.", + "default": "ReadOnlyMount", + "$ref": "#/definitions/InputDeliveryMode", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "pathOnCompute": { + "description": "Input Asset Delivery Path.", + "type": "string", + "x-nullable": true + }, + "uri": { + "description": "[Required] Input Asset URI.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, + "AssetJobOutput": { + "description": "Asset output type.", + "type": "object", + "properties": { + "assetName": { + "description": "Output Asset Name.", + "type": "string", + "x-nullable": true + }, + "assetVersion": { + "description": "Output Asset Version.", + "type": "string", + "x-nullable": true + }, + "autoDeleteSetting": { + "description": "Auto delete setting of output data asset.", + "$ref": "#/definitions/AutoDeleteSetting", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "mode": { + "description": "Output Asset Delivery Mode.", + "default": "ReadWriteMount", + "$ref": "#/definitions/OutputDeliveryMode", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "pathOnCompute": { + "description": "Output Asset Delivery Path.", + "type": "string", + "x-nullable": true + }, + "uri": { + "description": "Output Asset URI.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AssetProvisioningState": { + "description": "Provisioning state of registry asset.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "AssetProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + }, + { + "value": "Creating" + }, + { + "value": "Updating" + }, + { + "value": "Deleting" + } + ] + }, + "additionalProperties": false + }, + "AssetReferenceBase": { + "description": "Base definition for asset references.", + "required": [ + "referenceType" + ], + "type": "object", + "properties": { + "referenceType": { + "description": "[Required] Specifies the type of asset reference.", + "$ref": "#/definitions/ReferenceType" + } + }, + "discriminator": "referenceType" + }, + "AuthMode": { + "description": "Enum to determine endpoint authentication mode.", + "enum": [ + "AAD" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthMode", + "modelAsString": true, + "values": [ + { + "value": "AAD" + } + ] + }, + "additionalProperties": false + }, + "AutoDeleteCondition": { + "enum": [ + "CreatedGreaterThan", + "LastAccessedGreaterThan" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoDeleteCondition", + "modelAsString": true, + "values": [ + { + "value": "CreatedGreaterThan" + }, + { + "value": "LastAccessedGreaterThan" + } + ] + }, + "additionalProperties": false + }, + "AutoDeleteSetting": { + "type": "object", + "properties": { + "condition": { + "description": "When to check if an asset is expired", + "default": "CreatedGreaterThan", + "$ref": "#/definitions/AutoDeleteCondition", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "value": { + "description": "Expiration condition value.", + "type": "string", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AutoForecastHorizon": { + "description": "Forecast horizon determined automatically by system.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ForecastHorizon" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoMLJob": { + "description": "AutoMLJob class.\r\nUse this class for executing AutoML tasks like Classification/Regression etc.\r\nSee TaskType enum for all the tasks supported.", + "required": [ + "taskDetails" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "environmentId": { + "description": "The ARM resource ID of the Environment specification for the job.\r\nThis is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "taskDetails": { + "description": "[Required] This represents scenario which can be one of Tables/NLP/Image", + "$ref": "#/definitions/AutoMLVertical" + } + }, + "x-ms-discriminator-value": "AutoML", + "additionalProperties": false + }, + "AutoMLVertical": { + "description": "AutoML vertical class.\r\nBase class for AutoML verticals - TableVertical/ImageVertical/NLPVertical", + "required": [ + "taskType", + "trainingData" + ], + "type": "object", + "properties": { + "logVerbosity": { + "description": "Log verbosity for the job.", + "default": "Info", + "$ref": "#/definitions/LogVerbosity" + }, + "targetColumnName": { + "description": "Target column name: This is prediction values column.\r\nAlso known as label column name in context of classification tasks.", + "type": "string", + "x-nullable": true + }, + "taskType": { + "description": "[Required] Task type for AutoMLJob.", + "$ref": "#/definitions/TaskType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "trainingData": { + "description": "[Required] Training data input.", + "$ref": "#/definitions/MLTableJobInput" + } + }, + "discriminator": "taskType" + }, + "AutoNCrossValidations": { + "description": "N-Cross validations determined automatically.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NCrossValidations" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoRebuildSetting": { + "description": "AutoRebuild setting for the derived image", + "enum": [ + "Disabled", + "OnBaseImageUpdate" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoRebuildSetting", + "modelAsString": true, + "values": [ + { + "value": "Disabled" + }, + { + "value": "OnBaseImageUpdate" + } + ] + }, + "additionalProperties": false + }, + "AutoSeasonality": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Seasonality" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoTargetLags": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetLags" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoTargetRollingWindowSize": { + "description": "Target lags rolling window determined automatically.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetRollingWindowSize" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutologgerSettings": { + "description": "Settings for Autologger.", + "required": [ + "mlflowAutologger" + ], + "type": "object", + "properties": { + "mlflowAutologger": { + "description": "[Required] Indicates whether mlflow autologger is enabled.", + "$ref": "#/definitions/MLFlowAutologgerState", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "AzureBlobDatastore": { + "description": "Azure Blob datastore configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "accountName": { + "description": "Storage account name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "containerName": { + "description": "Storage account container name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "protocol": { + "description": "Protocol used to communicate with the storage account.", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureBlob", + "additionalProperties": false + }, + "AzureDataLakeGen1Datastore": { + "description": "Azure Data Lake Gen1 datastore configuration.", + "required": [ + "storeName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "storeName": { + "description": "[Required] Azure Data Lake store name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureDataLakeGen1", + "additionalProperties": false + }, + "AzureDataLakeGen2Datastore": { + "description": "Azure Data Lake Gen2 datastore configuration.", + "required": [ + "accountName", + "filesystem" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "accountName": { + "description": "[Required] Storage account name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "filesystem": { + "description": "[Required] The name of the Data Lake Gen2 filesystem.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "protocol": { + "description": "Protocol used to communicate with the storage account.", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureDataLakeGen2", + "additionalProperties": false + }, + "AzureDatastore": { + "description": "Base definition for Azure datastore contents configuration.", + "type": "object", + "properties": { + "resourceGroup": { + "description": "Azure Resource Group name", + "type": "string", + "x-nullable": true + }, + "subscriptionId": { + "description": "Azure Subscription Id", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AzureDevOpsWebhook": { + "description": "Webhook details specific for Azure DevOps", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Webhook" + } + ], + "x-ms-discriminator-value": "AzureDevOps", + "additionalProperties": false + }, + "AzureFileDatastore": { + "description": "Azure File datastore configuration.", + "required": [ + "accountName", + "fileShareName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "accountName": { + "description": "[Required] Storage account name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "fileShareName": { + "description": "[Required] The name of the Azure file share that the datastore points to.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "protocol": { + "description": "Protocol used to communicate with the storage account.", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureFile", + "additionalProperties": false + }, + "AzureMLBatchInferencingServer": { + "description": "Azure ML batch inferencing server configurations.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InferencingServer" + } + ], + "properties": { + "codeConfiguration": { + "description": "Code configuration for AML batch inferencing server.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "AzureMLBatch", + "additionalProperties": false + }, + "AzureMLOnlineInferencingServer": { + "description": "Azure ML online inferencing configurations.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InferencingServer" + } + ], + "properties": { + "codeConfiguration": { + "description": "Code configuration for AML inferencing server.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "AzureMLOnline", + "additionalProperties": false + }, + "AzureOpenAiFineTuning": { + "required": [ + "modelProvider" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FineTuningVertical" + } + ], + "properties": { + "hyperParameters": { + "description": "HyperParameters for fine tuning Azure Open AI model.", + "$ref": "#/definitions/AzureOpenAiHyperParameters", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "AzureOpenAI", + "additionalProperties": false + }, + "AzureOpenAiHyperParameters": { + "description": "Azure Open AI hyperparameters for fine tuning.", + "type": "object", + "properties": { + "batchSize": { + "format": "int32", + "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.", + "type": "integer", + "x-nullable": true + }, + "learningRateMultiplier": { + "format": "double", + "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid over fitting.", + "type": "number", + "x-nullable": true + }, + "nEpochs": { + "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", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "BanditPolicy": { + "description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EarlyTerminationPolicy" + } + ], + "properties": { + "slackAmount": { + "format": "float", + "description": "Absolute distance allowed from the best performing run.", + "default": 0, + "type": "number" + }, + "slackFactor": { + "format": "float", + "description": "Ratio of the allowed distance from the best performing run.", + "default": 0, + "type": "number" + } + }, + "x-ms-discriminator-value": "Bandit", + "additionalProperties": false + }, + "BaseEnvironmentId": { + "description": "Base environment type.", + "required": [ + "resourceId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseEnvironmentSource" + } + ], + "properties": { + "resourceId": { + "description": "[Required] Resource id accepting ArmId or AzureMlId.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "EnvironmentAsset", + "additionalProperties": false + }, + "BaseEnvironmentSource": { + "required": [ + "baseEnvironmentSourceType" + ], + "type": "object", + "properties": { + "baseEnvironmentSourceType": { + "description": "[Required] Base environment type.", + "$ref": "#/definitions/BaseEnvironmentSourceType" + } + }, + "discriminator": "baseEnvironmentSourceType" + }, + "BaseEnvironmentSourceType": { + "description": "Base environment type.", + "enum": [ + "EnvironmentAsset" + ], + "type": "string", + "x-ms-enum": { + "name": "BaseEnvironmentSourceType", + "modelAsString": true, + "values": [ + { + "value": "EnvironmentAsset" + } + ] + }, + "additionalProperties": false + }, + "BatchDeployment": { + "description": "Batch inference settings per deployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointDeploymentPropertiesBase" + } + ], + "properties": { + "compute": { + "description": "Compute target for batch inference operation.", + "type": "string", + "x-nullable": true + }, + "deploymentConfiguration": { + "description": "Properties relevant to different deployment types.", + "$ref": "#/definitions/BatchDeploymentConfiguration", + "x-nullable": true + }, + "errorThreshold": { + "format": "int32", + "description": "Error threshold, if the error count for the entire input goes above this value,\r\nthe batch inference will be aborted. Range is [-1, int.MaxValue].\r\nFor FileDataset, this value is the count of file failures.\r\nFor TabularDataset, this value is the count of record failures.\r\nIf set to -1 (the lower bound), all failures during batch inference will be ignored.", + "default": -1, + "type": "integer" + }, + "loggingLevel": { + "description": "Logging level for batch inference operation.", + "default": "Info", + "$ref": "#/definitions/BatchLoggingLevel" + }, + "maxConcurrencyPerInstance": { + "format": "int32", + "description": "Indicates maximum number of parallelism per instance.", + "default": 1, + "type": "integer" + }, + "miniBatchSize": { + "format": "int64", + "description": "Size of the mini-batch passed to each batch invocation.\r\nFor FileDataset, this is the number of files per mini-batch.\r\nFor TabularDataset, this is the size of the records in bytes, per mini-batch.", + "default": 10, + "type": "integer" + }, + "model": { + "description": "Reference to the model asset for the endpoint deployment.", + "$ref": "#/definitions/AssetReferenceBase", + "x-nullable": true + }, + "outputAction": { + "description": "Indicates how the output will be organized.", + "default": "AppendRow", + "$ref": "#/definitions/BatchOutputAction" + }, + "outputFileName": { + "description": "Customized output file name for append_row output action.", + "default": "predictions.csv", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state for the endpoint deployment.", + "$ref": "#/definitions/DeploymentProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "resources": { + "description": "Indicates compute configuration for the job.\r\nIf not provided, will default to the defaults defined in ResourceConfiguration.", + "$ref": "#/definitions/DeploymentResourceConfiguration", + "x-nullable": true + }, + "retrySettings": { + "description": "Retry Settings for the batch inference operation.\r\nIf not provided, will default to the defaults defined in BatchRetrySettings.", + "$ref": "#/definitions/BatchRetrySettings", + "x-nullable": true + } + }, + "x-ms-client-name": "BatchDeploymentProperties", + "additionalProperties": false + }, + "BatchDeploymentConfiguration": { + "description": "Properties relevant to different deployment types.", + "required": [ + "deploymentConfigurationType" + ], + "type": "object", + "properties": { + "deploymentConfigurationType": { + "description": "[Required] The type of the deployment", + "$ref": "#/definitions/BatchDeploymentConfigurationType" + } + }, + "discriminator": "deploymentConfigurationType" + }, + "BatchDeploymentConfigurationType": { + "description": "The enumerated property types for batch deployments.", + "enum": [ + "Model", + "PipelineComponent" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchDeploymentConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Model" + }, + { + "value": "PipelineComponent" + } + ] + }, + "additionalProperties": false + }, + "BatchDeploymentTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/BatchDeployment" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "BatchDeployment", + "additionalProperties": false + }, + "BatchDeploymentTrackedResourceArmPaginatedResult": { + "description": "A paginated list of BatchDeployment entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of BatchDeployment objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type BatchDeployment.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + } + }, + "additionalProperties": false + }, + "BatchEndpoint": { + "description": "Batch endpoint configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesBase" + } + ], + "properties": { + "defaults": { + "description": "Default values for Batch Endpoint.", + "$ref": "#/definitions/BatchEndpointDefaults", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "BatchEndpointProperties", + "additionalProperties": false + }, + "BatchEndpointDefaults": { + "description": "Batch endpoint default values", + "type": "object", + "properties": { + "deploymentName": { + "description": "Name of the deployment that will be default for the endpoint.\r\nThis deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "BatchEndpointTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/BatchEndpoint" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "BatchEndpoint", + "additionalProperties": false + }, + "BatchEndpointTrackedResourceArmPaginatedResult": { + "description": "A paginated list of BatchEndpoint entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of BatchEndpoint objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type BatchEndpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + } + }, + "additionalProperties": false + }, + "BatchLoggingLevel": { + "description": "Log verbosity for batch inferencing.\r\nIncreasing verbosity order for logging is : Warning, Info and Debug.\r\nThe default value is Info.", + "enum": [ + "Info", + "Warning", + "Debug" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchLoggingLevel", + "modelAsString": true, + "values": [ + { + "value": "Info" + }, + { + "value": "Warning" + }, + { + "value": "Debug" + } + ] + }, + "additionalProperties": false + }, + "BatchOutputAction": { + "description": "Enum to determine how batch inferencing will handle output", + "enum": [ + "SummaryOnly", + "AppendRow" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchOutputAction", + "modelAsString": true, + "values": [ + { + "value": "SummaryOnly" + }, + { + "value": "AppendRow" + } + ] + }, + "additionalProperties": false + }, + "BatchPipelineComponentDeploymentConfiguration": { + "description": "Properties for a Batch Pipeline Component Deployment.", + "required": [ + "deploymentConfigurationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BatchDeploymentConfiguration" + } + ], + "properties": { + "componentId": { + "description": "The ARM id of the component to be run.", + "$ref": "#/definitions/IdAssetReference", + "x-nullable": true + }, + "description": { + "description": "The description which will be applied to the job.", + "type": "string", + "x-nullable": true + }, + "settings": { + "description": "Run-time settings for the pipeline job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "tags": { + "description": "The tags which will be applied to the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PipelineComponent", + "additionalProperties": false + }, + "BatchRetrySettings": { + "description": "Retry settings for a batch inference operation.", + "type": "object", + "properties": { + "maxRetries": { + "format": "int32", + "description": "Maximum retry count for a mini-batch", + "default": 3, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "Invocation timeout for a mini-batch, in ISO 8601 format.", + "default": "PT30S", + "type": "string" + } + }, + "additionalProperties": false + }, + "BayesianSamplingAlgorithm": { + "description": "Defines a Sampling Algorithm that generates values based on previous values", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SamplingAlgorithm" + } + ], + "x-ms-discriminator-value": "Bayesian", + "additionalProperties": false + }, + "BlobReferenceForConsumptionDto": { + "type": "object", + "properties": { + "blobUri": { + "format": "uri", + "description": "Blob URI path for client to upload data.\r\nExample: https://blob.windows.core.net/Container/Path", + "type": "string", + "x-nullable": true + }, + "credential": { + "description": "Credential info to access storage account", + "$ref": "#/definitions/PendingUploadCredentialDto", + "x-nullable": true + }, + "storageAccountArmId": { + "description": "Arm ID of the storage account to use", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "BlockedTransformers": { + "description": "Enum for all classification models supported by AutoML.", + "enum": [ + "TextTargetEncoder", + "OneHotEncoder", + "CatTargetEncoder", + "TfIdf", + "WoETargetEncoder", + "LabelEncoder", + "WordEmbedding", + "NaiveBayes", + "CountVectorizer", + "HashOneHotEncoder" + ], + "type": "string", + "x-ms-enum": { + "name": "BlockedTransformers", + "modelAsString": true, + "values": [ + { + "value": "TextTargetEncoder", + "description": "Target encoding for text data." + }, + { + "value": "OneHotEncoder", + "description": "Ohe hot encoding creates a binary feature transformation." + }, + { + "value": "CatTargetEncoder", + "description": "Target encoding for categorical data." + }, + { + "value": "TfIdf", + "description": "Tf-Idf stands for, term-frequency times inverse document-frequency. This is a common term weighting scheme for identifying information from documents." + }, + { + "value": "WoETargetEncoder", + "description": "Weight of Evidence encoding is a technique used to encode categorical variables. It uses the natural log of the P(1)/P(0) to create weights." + }, + { + "value": "LabelEncoder", + "description": "Label encoder converts labels/categorical variables in a numerical form." + }, + { + "value": "WordEmbedding", + "description": "Word embedding helps represents words or phrases as a vector, or a series of numbers." + }, + { + "value": "NaiveBayes", + "description": "Naive Bayes is a classified that is used for classification of discrete features that are categorically distributed." + }, + { + "value": "CountVectorizer", + "description": "Count Vectorizer converts a collection of text documents to a matrix of token counts." + }, + { + "value": "HashOneHotEncoder", + "description": "Hashing One Hot Encoder can turn categorical variables into a limited number of new features. This is often used for high-cardinality categorical features." + } + ] + }, + "additionalProperties": false + }, + "BuildContext": { + "description": "Configuration settings for Docker build context", + "required": [ + "contextUri" + ], + "type": "object", + "properties": { + "contextUri": { + "description": "[Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs.\r\n", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dockerfilePath": { + "description": "Path to the Dockerfile in the build context.\r\n", + "default": "Dockerfile", + "type": "string", + "example": "prod/Dockerfile", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "CapacityReservationGroup": { + "required": [ + "reservedCapacity" + ], + "type": "object", + "properties": { + "offer": { + "description": "Offer used by this capacity reservation group.", + "$ref": "#/definitions/ServerlessOffer", + "x-nullable": true + }, + "reservedCapacity": { + "format": "int32", + "description": "[Required] Specifies the amount of capacity to reserve.", + "type": "integer" + } + }, + "x-ms-client-name": "CapacityReservationGroupProperties", + "additionalProperties": false + }, + "CapacityReservationGroupTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/CapacityReservationGroup" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "CapacityReservationGroup", + "additionalProperties": false + }, + "CapacityReservationGroupTrackedResourceArmPaginatedResult": { + "description": "A paginated list of CapacityReservationGroup entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of CapacityReservationGroup objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type CapacityReservationGroup.", + "type": "array", + "items": { + "$ref": "#/definitions/CapacityReservationGroupTrackedResource" + } + } + }, + "additionalProperties": false + }, + "CategoricalDataDriftMetric": { + "enum": [ + "JensenShannonDistance", + "PopulationStabilityIndex", + "PearsonsChiSquaredTest" + ], + "type": "string", + "x-ms-enum": { + "name": "CategoricalDataDriftMetric", + "modelAsString": true, + "values": [ + { + "value": "JensenShannonDistance", + "description": "The Jensen Shannon Distance (JSD) metric." + }, + { + "value": "PopulationStabilityIndex", + "description": "The Population Stability Index (PSI) metric." + }, + { + "value": "PearsonsChiSquaredTest", + "description": "The Pearsons Chi Squared Test metric." + } + ] + }, + "additionalProperties": false + }, + "CategoricalDataDriftMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataDriftMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The categorical data drift metric to calculate.", + "$ref": "#/definitions/CategoricalDataDriftMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Categorical", + "additionalProperties": false + }, + "CategoricalDataQualityMetric": { + "enum": [ + "NullValueRate", + "DataTypeErrorRate", + "OutOfBoundsRate" + ], + "type": "string", + "x-ms-enum": { + "name": "CategoricalDataQualityMetric", + "modelAsString": true, + "values": [ + { + "value": "NullValueRate", + "description": "Calculates the rate of null values." + }, + { + "value": "DataTypeErrorRate", + "description": "Calculates the rate of data type errors." + }, + { + "value": "OutOfBoundsRate", + "description": "Calculates the rate values are out of bounds." + } + ] + }, + "additionalProperties": false + }, + "CategoricalDataQualityMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataQualityMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The categorical data quality metric to calculate.", + "$ref": "#/definitions/CategoricalDataQualityMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Categorical", + "additionalProperties": false + }, + "CategoricalPredictionDriftMetric": { + "enum": [ + "JensenShannonDistance", + "PopulationStabilityIndex", + "PearsonsChiSquaredTest" + ], + "type": "string", + "x-ms-enum": { + "name": "CategoricalPredictionDriftMetric", + "modelAsString": true, + "values": [ + { + "value": "JensenShannonDistance", + "description": "The Jensen Shannon Distance (JSD) metric." + }, + { + "value": "PopulationStabilityIndex", + "description": "The Population Stability Index (PSI) metric." + }, + { + "value": "PearsonsChiSquaredTest", + "description": "The Pearsons Chi Squared Test metric." + } + ] + }, + "additionalProperties": false + }, + "CategoricalPredictionDriftMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PredictionDriftMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The categorical prediction drift metric to calculate.", + "$ref": "#/definitions/CategoricalPredictionDriftMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Categorical", + "additionalProperties": false + }, + "CertificateDatastoreCredentials": { + "description": "Certificate datastore credentials configuration.", + "required": [ + "clientId", + "secrets", + "tenantId", + "thumbprint" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "authorityUrl": { + "description": "Authority URL used for authentication.", + "type": "string", + "x-nullable": true + }, + "clientId": { + "format": "uuid", + "description": "[Required] Service principal client ID.", + "type": "string" + }, + "resourceUrl": { + "description": "Resource the service principal has access to.", + "type": "string", + "x-nullable": true + }, + "secrets": { + "description": "[Required] Service principal secrets.", + "$ref": "#/definitions/CertificateDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "tenantId": { + "format": "uuid", + "description": "[Required] ID of the tenant to which the service principal belongs.", + "type": "string" + }, + "thumbprint": { + "description": "[Required] Thumbprint of the certificate used for authentication.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "Certificate", + "additionalProperties": false + }, + "CertificateDatastoreSecrets": { + "description": "Datastore certificate secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "certificate": { + "description": "Service principal certificate.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Certificate", + "additionalProperties": false + }, + "Classification": { + "description": "Classification task in AutoML Table vertical.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TableVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "positiveLabel": { + "description": "Positive label for binary metrics calculation.", + "type": "string", + "x-nullable": true + }, + "primaryMetric": { + "description": "Primary metric for the task.", + "default": "AUCWeighted", + "$ref": "#/definitions/ClassificationPrimaryMetrics" + }, + "trainingSettings": { + "description": "Inputs for training phase for an AutoML Job.", + "$ref": "#/definitions/ClassificationTrainingSettings", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Classification", + "additionalProperties": false + }, + "ClassificationModelPerformanceMetric": { + "enum": [ + "Accuracy", + "Precision", + "Recall" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationModelPerformanceMetric", + "modelAsString": true, + "values": [ + { + "value": "Accuracy", + "description": "Calculates the accuracy of the model predictions." + }, + { + "value": "Precision", + "description": "Calculates the precision of the model predictions." + }, + { + "value": "Recall", + "description": "Calculates the recall of the model predictions." + } + ] + }, + "additionalProperties": false + }, + "ClassificationModelPerformanceMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ModelPerformanceMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The classification model performance to calculate.", + "$ref": "#/definitions/ClassificationModelPerformanceMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Classification", + "additionalProperties": false + }, + "ClassificationModels": { + "description": "Enum for all classification models supported by AutoML.", + "enum": [ + "LogisticRegression", + "SGD", + "MultinomialNaiveBayes", + "BernoulliNaiveBayes", + "SVM", + "LinearSVM", + "KNN", + "DecisionTree", + "RandomForest", + "ExtremeRandomTrees", + "LightGBM", + "GradientBoosting", + "XGBoostClassifier" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationModels", + "modelAsString": true, + "values": [ + { + "value": "LogisticRegression", + "description": "Logistic regression is a fundamental classification technique.\nIt belongs to the group of linear classifiers and is somewhat similar to polynomial and linear regression.\nLogistic regression is fast and relatively uncomplicated, and it's convenient for you to interpret the results.\nAlthough it's essentially a method for binary classification, it can also be applied to multiclass problems." + }, + { + "value": "SGD", + "description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs." + }, + { + "value": "MultinomialNaiveBayes", + "description": "The multinomial Naive Bayes classifier is suitable for classification with discrete features (e.g., word counts for text classification).\nThe multinomial distribution normally requires integer feature counts. However, in practice, fractional counts such as tf-idf may also work." + }, + { + "value": "BernoulliNaiveBayes", + "description": "Naive Bayes classifier for multivariate Bernoulli models." + }, + { + "value": "SVM", + "description": "A support vector machine (SVM) is a supervised machine learning model that uses classification algorithms for two-group classification problems.\nAfter giving an SVM model sets of labeled training data for each category, they're able to categorize new text." + }, + { + "value": "LinearSVM", + "description": "A support vector machine (SVM) is a supervised machine learning model that uses classification algorithms for two-group classification problems.\nAfter giving an SVM model sets of labeled training data for each category, they're able to categorize new text.\nLinear SVM performs best when input data is linear, i.e., data can be easily classified by drawing the straight line between classified values on a plotted graph." + }, + { + "value": "KNN", + "description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set." + }, + { + "value": "DecisionTree", + "description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features." + }, + { + "value": "RandomForest", + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the bagging method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + }, + { + "value": "ExtremeRandomTrees", + "description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm." + }, + { + "value": "LightGBM", + "description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms." + }, + { + "value": "GradientBoosting", + "description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution." + }, + { + "value": "XGBoostClassifier", + "description": "XGBoost: Extreme Gradient Boosting Algorithm. This algorithm is used for structured data where target column values can be divided into distinct class values." + } + ] + }, + "additionalProperties": false + }, + "ClassificationMultilabelPrimaryMetrics": { + "description": "Primary metrics for classification multilabel tasks.", + "enum": [ + "AUCWeighted", + "Accuracy", + "NormMacroRecall", + "AveragePrecisionScoreWeighted", + "PrecisionScoreWeighted", + "IOU" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationMultilabelPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "AUCWeighted", + "description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class." + }, + { + "value": "Accuracy", + "description": "Accuracy is the ratio of predictions that exactly match the true class labels." + }, + { + "value": "NormMacroRecall", + "description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1." + }, + { + "value": "AveragePrecisionScoreWeighted", + "description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class." + }, + { + "value": "PrecisionScoreWeighted", + "description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class." + }, + { + "value": "IOU", + "description": "Intersection Over Union. Intersection of predictions divided by union of predictions." + } + ] + }, + "additionalProperties": false + }, + "ClassificationPrimaryMetrics": { + "description": "Primary metrics for classification tasks.", + "enum": [ + "AUCWeighted", + "Accuracy", + "NormMacroRecall", + "AveragePrecisionScoreWeighted", + "PrecisionScoreWeighted" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "AUCWeighted", + "description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class." + }, + { + "value": "Accuracy", + "description": "Accuracy is the ratio of predictions that exactly match the true class labels." + }, + { + "value": "NormMacroRecall", + "description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1." + }, + { + "value": "AveragePrecisionScoreWeighted", + "description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class." + }, + { + "value": "PrecisionScoreWeighted", + "description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class." + } + ] + }, + "additionalProperties": false + }, + "ClassificationTrainingSettings": { + "description": "Classification Training related configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrainingSettings" + } + ], + "properties": { + "allowedTrainingAlgorithms": { + "description": "Allowed models for classification task.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationModels" + }, + "x-nullable": true + }, + "blockedTrainingAlgorithms": { + "description": "Blocked models for classification task.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationModels" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "CocoExportSummary": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSummary" + } + ], + "properties": { + "containerName": { + "description": "The container name to which the labels will be exported.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "snapshotPath": { + "description": "The output path where the labels will be exported.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Coco", + "additionalProperties": false + }, + "CodeConfiguration": { + "description": "Configuration for a scoring code asset.", + "required": [ + "scoringScript" + ], + "type": "object", + "properties": { + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "scoringScript": { + "description": "[Required] The script to execute on startup. eg. \"score.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "CodeContainer": { + "description": "Container for code asset versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the code container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "CodeContainerProperties", + "additionalProperties": false + }, + "CodeContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/CodeContainer" + } + }, + "x-ms-client-name": "CodeContainer", + "additionalProperties": false + }, + "CodeContainerResourceArmPaginatedResult": { + "description": "A paginated list of CodeContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type CodeContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/CodeContainerResource" + } + } + }, + "additionalProperties": false + }, + "CodeVersion": { + "description": "Code asset version details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "codeUri": { + "description": "Uri where code is located", + "type": "string", + "example": "https://blobStorage/folderName", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the code version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "CodeVersionProperties", + "additionalProperties": false + }, + "CodeVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/CodeVersion" + } + }, + "x-ms-client-name": "CodeVersion", + "additionalProperties": false + }, + "CodeVersionResourceArmPaginatedResult": { + "description": "A paginated list of CodeVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type CodeVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/CodeVersionResource" + } + } + }, + "additionalProperties": false + }, + "Collection": { + "type": "object", + "properties": { + "clientId": { + "description": "The msi client id used to collect logging to blob storage. If it's null,backend will pick a registered endpoint identity to auth.", + "type": "string", + "x-nullable": true + }, + "dataCollectionMode": { + "description": "Enable or disable data collection.", + "default": "Disabled", + "$ref": "#/definitions/DataCollectionMode" + }, + "dataId": { + "description": "The data asset arm resource id. Client side will ensure data asset is pointing to the blob storage, and backend will collect data to the blob storage.", + "type": "string", + "x-nullable": true + }, + "samplingRate": { + "format": "double", + "description": "The sampling rate for collection. Sampling rate 1.0 means we collect 100% of data by default.", + "default": 1, + "type": "number" + } + }, + "additionalProperties": false + }, + "ColumnTransformer": { + "description": "Column transformer parameters.", + "type": "object", + "properties": { + "fields": { + "description": "Fields to apply transformer logic on.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "parameters": { + "description": "Different properties to be passed to transformer.\r\nInput expected is dictionary of key,value pairs in JSON format.", + "type": "object", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "CommandJob": { + "description": "Command job definition.", + "required": [ + "command", + "environmentId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "autologgerSettings": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "$ref": "#/definitions/AutologgerSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "command": { + "description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "distribution": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, Ray, or null.", + "$ref": "#/definitions/DistributionConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentId": { + "description": "[Required] The ARM resource ID of the Environment specification for the job.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Mapping of input data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "limits": { + "description": "Command Job limit.", + "$ref": "#/definitions/CommandJobLimits", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "parameters": { + "description": "Input parameters.", + "type": "object", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Command", + "additionalProperties": false + }, + "CommandJobLimits": { + "description": "Command Job limit class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobLimits" + } + ], + "x-ms-discriminator-value": "Command", + "additionalProperties": false + }, + "ComponentConfiguration": { + "description": "Used for sweep over component", + "type": "object", + "properties": { + "pipelineSettings": { + "description": "Pipeline settings, for things like ContinueRunOnStepFailure etc.", + "type": "object", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ComponentContainer": { + "description": "Component container definition.\r\n", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the component container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "ComponentContainerProperties", + "additionalProperties": false + }, + "ComponentContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ComponentContainer" + } + }, + "x-ms-client-name": "ComponentContainer", + "additionalProperties": false + }, + "ComponentContainerResourceArmPaginatedResult": { + "description": "A paginated list of ComponentContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ComponentContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ComponentContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/ComponentContainerResource" + } + } + }, + "additionalProperties": false + }, + "ComponentVersion": { + "description": "Definition of a component version: defines resources that span component types.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "componentSpec": { + "description": "Defines Component definition details.\r\n", + "type": "object", + "example": { + "name": "Hello_Python_World", + "display_name": "Hello_Python_World", + "version": 1, + "type": "command", + "code": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/mycode/versions/1", + "environment": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/AzureML-Tutorial/versions/1", + "command": "python hello.py" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the component version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "stage": { + "description": "Stage in the component lifecycle", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ComponentVersionProperties", + "additionalProperties": false + }, + "ComponentVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ComponentVersion" + } + }, + "x-ms-client-name": "ComponentVersion", + "additionalProperties": false + }, + "ComponentVersionResourceArmPaginatedResult": { + "description": "A paginated list of ComponentVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ComponentVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ComponentVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + }, + "additionalProperties": false + }, + "ContainerResourceRequirements": { + "description": "Resource requirements for each container instance within an online deployment.", + "type": "object", + "properties": { + "containerResourceLimits": { + "description": "Container resource limit info:", + "$ref": "#/definitions/ContainerResourceSettings", + "x-nullable": true + }, + "containerResourceRequests": { + "description": "Container resource request info:", + "$ref": "#/definitions/ContainerResourceSettings", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ContainerResourceSettings": { + "type": "object", + "properties": { + "cpu": { + "description": "Number of vCPUs request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "1", + "x-nullable": true + }, + "gpu": { + "description": "Number of Nvidia GPU cards request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "1", + "x-nullable": true + }, + "memory": { + "description": "Memory size request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "2Gi", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ContainerType": { + "description": "The type of container to retrieve logs from.", + "enum": [ + "StorageInitializer", + "InferenceServer", + "ModelDataCollector" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true, + "values": [ + { + "value": "StorageInitializer", + "description": "The container used to download models and score script." + }, + { + "value": "InferenceServer", + "description": "The container used to serve user's request." + }, + { + "value": "ModelDataCollector", + "description": "The container used to collect payload and custom logging when mdc is enabled." + } + ] + }, + "additionalProperties": false + }, + "CreateMonitorAction": { + "required": [ + "monitorDefinition" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], + "properties": { + "monitorDefinition": { + "description": "[Required] Defines the monitor.", + "$ref": "#/definitions/MonitorDefinition", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "CreateMonitor", + "additionalProperties": false + }, + "CredentialsType": { + "description": "Enum to determine the datastore credentials type.", + "enum": [ + "AccountKey", + "Certificate", + "None", + "Sas", + "ServicePrincipal", + "KerberosKeytab", + "KerberosPassword" + ], + "type": "string", + "x-ms-enum": { + "name": "CredentialsType", + "modelAsString": true, + "values": [ + { + "value": "AccountKey" + }, + { + "value": "Certificate" + }, + { + "value": "None" + }, + { + "value": "Sas" + }, + { + "value": "ServicePrincipal" + }, + { + "value": "KerberosKeytab" + }, + { + "value": "KerberosPassword" + } + ] + }, + "additionalProperties": false + }, + "CronTrigger": { + "required": [ + "expression" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerBase" + } + ], + "properties": { + "expression": { + "description": "[Required] Specifies cron expression of schedule.\r\nThe expression should follow NCronTab format.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "Cron", + "additionalProperties": false + }, + "CsvExportSummary": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSummary" + } + ], + "properties": { + "containerName": { + "description": "The container name to which the labels will be exported.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "snapshotPath": { + "description": "The output path where the labels will be exported.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "CSV", + "additionalProperties": false + }, + "CustomForecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ForecastHorizon" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] Forecast horizon value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomInferencingServer": { + "description": "Custom inference server configurations.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InferencingServer" + } + ], + "properties": { + "inferenceConfiguration": { + "description": "Inference configuration for custom inferencing.", + "$ref": "#/definitions/OnlineInferenceConfiguration", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "properties": { + "metric": { + "description": "[Required] The user-defined metric to calculate.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "CustomModelFineTuning": { + "required": [ + "modelProvider" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FineTuningVertical" + } + ], + "properties": { + "hyperParameters": { + "description": "HyperParameters for fine tuning custom model.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomModelJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "custom_model", + "additionalProperties": false + }, + "CustomModelJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "custom_model", + "additionalProperties": false + }, + "CustomMonitoringSignal": { + "required": [ + "componentId", + "metricThresholds" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "componentId": { + "description": "[Required] ARM resource ID of the component resource used to calculate the custom metrics.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "inputAssets": { + "description": "Monitoring assets to take as input. Key is the component input port name, value is the data asset.", + "type": "object", + "additionalProperties": { + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Extra component parameters to take as input. Key is the component literal input port name, value is the parameter value.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomMetricThreshold" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "workspaceConnection": { + "description": "A list of metrics to calculate and their associated thresholds.", + "$ref": "#/definitions/MonitoringWorkspaceConnection", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomNCrossValidations": { + "description": "N-Cross validations are specified by user.", + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NCrossValidations" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] N-Cross validations value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomSeasonality": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Seasonality" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] Seasonality value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomTargetLags": { + "required": [ + "values" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetLags" + } + ], + "properties": { + "values": { + "description": "[Required] Set target lags values.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomTargetRollingWindowSize": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetRollingWindowSize" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] TargetRollingWindowSize value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "DataAvailabilityStatus": { + "enum": [ + "None", + "Pending", + "Incomplete", + "Complete" + ], + "type": "string", + "x-ms-enum": { + "name": "DataAvailabilityStatus", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "Pending" + }, + { + "value": "Incomplete" + }, + { + "value": "Complete" + } + ] + }, + "additionalProperties": false + }, + "DataCollectionMode": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DataCollectionMode", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "DataCollector": { + "required": [ + "collections" + ], + "type": "object", + "properties": { + "collections": { + "description": "[Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string.\r\nModel data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Collection", + "x-nullable": true + } + }, + "requestLogging": { + "description": "The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional.", + "$ref": "#/definitions/RequestLogging", + "x-nullable": true + }, + "rollingRate": { + "description": "When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file.\r\nIf the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/.\r\nIf it's day, all data will be collected in blob path /yyyy/MM/dd/.\r\nThe other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly.", + "default": "Hour", + "$ref": "#/definitions/RollingRateType" + } + }, + "additionalProperties": false + }, + "DataContainer": { + "description": "Container for data asset versions.", + "required": [ + "dataType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "dataType": { + "description": "[Required] Specifies the type of data.", + "$ref": "#/definitions/DataType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-client-name": "DataContainerProperties", + "additionalProperties": false + }, + "DataContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/DataContainer" + } + }, + "x-ms-client-name": "DataContainer", + "additionalProperties": false + }, + "DataContainerResourceArmPaginatedResult": { + "description": "A paginated list of DataContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type DataContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/DataContainerResource" + } + } + }, + "additionalProperties": false + }, + "DataDriftMetricThresholdBase": { + "required": [ + "dataType" + ], + "type": "object", + "properties": { + "dataType": { + "description": "[Required] Specifies the data type of the metric threshold.", + "$ref": "#/definitions/MonitoringFeatureDataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "discriminator": "dataType" + }, + "DataDriftMonitoringSignal": { + "required": [ + "metricThresholds", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "dataSegment": { + "description": "The data segment used for scoping on a subset of the data population.", + "$ref": "#/definitions/MonitoringDataSegment", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "featureImportanceSettings": { + "description": "The settings for computing feature importance.", + "$ref": "#/definitions/FeatureImportanceSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "features": { + "description": "The feature filter which identifies which feature to calculate drift over.", + "$ref": "#/definitions/MonitoringFeatureFilterBase", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/DataDriftMetricThresholdBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "[Required] The data which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "DataDrift", + "additionalProperties": false + }, + "DataImport": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataVersionBase" + } + ], + "properties": { + "assetName": { + "description": "Name of the asset for data import job to create", + "type": "string", + "x-nullable": true + }, + "source": { + "description": "Source data of the asset to import from", + "$ref": "#/definitions/DataImportSource", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "uri_folder", + "additionalProperties": false + }, + "DataImportSource": { + "required": [ + "sourceType" + ], + "type": "object", + "properties": { + "connection": { + "description": "Workspace connection for data import source storage", + "type": "string", + "x-nullable": true + }, + "sourceType": { + "description": "[Required] Specifies the type of data.", + "$ref": "#/definitions/DataImportSourceType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "sourceType" + }, + "DataImportSourceType": { + "description": "Enum to determine the type of data.", + "enum": [ + "database", + "file_system" + ], + "type": "string", + "x-ms-enum": { + "name": "DataImportSourceType", + "modelAsString": true, + "values": [ + { + "value": "database" + }, + { + "value": "file_system" + } + ] + }, + "additionalProperties": false + }, + "DataPathAssetReference": { + "description": "Reference to an asset via its path in a datastore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "datastoreId": { + "description": "ARM resource ID of the datastore where the asset is located.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "The path of the file/directory in the datastore.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "DataPath", + "additionalProperties": false + }, + "DataQualityMetricThresholdBase": { + "required": [ + "dataType" + ], + "type": "object", + "properties": { + "dataType": { + "description": "[Required] Specifies the data type of the metric threshold.", + "$ref": "#/definitions/MonitoringFeatureDataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "discriminator": "dataType" + }, + "DataQualityMonitoringSignal": { + "required": [ + "metricThresholds", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "featureImportanceSettings": { + "description": "The settings for computing feature importance.", + "$ref": "#/definitions/FeatureImportanceSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "features": { + "description": "The features to calculate drift over.", + "$ref": "#/definitions/MonitoringFeatureFilterBase", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/DataQualityMetricThresholdBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "[Required] The data produced by the production service which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "DataQuality", + "additionalProperties": false + }, + "DataReferenceCredential": { + "description": "DataReferenceCredential base class", + "required": [ + "credentialType" + ], + "type": "object", + "properties": { + "credentialType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/DataReferenceCredentialType" + } + }, + "discriminator": "credentialType" + }, + "DataReferenceCredentialType": { + "description": "Enum to determine the DataReference credentials type.", + "enum": [ + "SAS", + "DockerCredentials", + "ManagedIdentity", + "NoCredentials" + ], + "type": "string", + "x-ms-enum": { + "name": "DataReferenceCredentialType", + "modelAsString": true, + "values": [ + { + "value": "SAS" + }, + { + "value": "DockerCredentials" + }, + { + "value": "ManagedIdentity" + }, + { + "value": "NoCredentials" + } + ] + }, + "additionalProperties": false + }, + "DataType": { + "description": "Enum to determine the type of data.", + "enum": [ + "uri_file", + "uri_folder", + "mltable" + ], + "type": "string", + "x-ms-enum": { + "name": "DataType", + "modelAsString": true, + "values": [ + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + } + ] + }, + "additionalProperties": false + }, + "DataVersionBase": { + "description": "Data version base definition", + "required": [ + "dataType", + "dataUri" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "dataType": { + "description": "[Required] Specifies the type of data.", + "$ref": "#/definitions/DataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dataUri": { + "description": "[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "intellectualProperty": { + "description": "Intellectual Property details. Used if data is an Intellectual Property.", + "$ref": "#/definitions/IntellectualProperty", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "stage": { + "description": "Stage in the data lifecycle assigned to this data asset", + "type": "string", + "x-nullable": true + } + }, + "discriminator": "dataType", + "x-ms-client-name": "DataVersionBaseProperties" + }, + "DataVersionBaseResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/DataVersionBase" + } + }, + "x-ms-client-name": "DataVersionBase", + "additionalProperties": false + }, + "DataVersionBaseResourceArmPaginatedResult": { + "description": "A paginated list of DataVersionBase entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of DataVersionBase objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type DataVersionBase.", + "type": "array", + "items": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + }, + "additionalProperties": false + }, + "DatabaseSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataImportSource" + } + ], + "properties": { + "query": { + "description": "SQL Query statement for data import Database source", + "type": "string", + "x-nullable": true + }, + "storedProcedure": { + "description": "SQL StoredProcedure on data import Database source", + "type": "string", + "x-nullable": true + }, + "storedProcedureParams": { + "description": "SQL StoredProcedure parameters", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "tableName": { + "description": "Name of the table on data import Database source", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "database", + "additionalProperties": false + }, + "DatasetExportSummary": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSummary" + } + ], + "properties": { + "labeledAssetName": { + "description": "The unique name of the labeled data asset.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Dataset", + "additionalProperties": false + }, + "Datastore": { + "description": "Base definition for datastore contents configuration.", + "required": [ + "credentials", + "datastoreType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "credentials": { + "description": "[Required] Account credentials.", + "$ref": "#/definitions/DatastoreCredentials" + }, + "datastoreType": { + "description": "[Required] Storage type backing the datastore.", + "$ref": "#/definitions/DatastoreType" + }, + "intellectualProperty": { + "description": "Intellectual Property details.", + "$ref": "#/definitions/IntellectualProperty", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "isDefault": { + "description": "Readonly property to indicate if datastore is the workspace default datastore", + "type": "boolean", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "discriminator": "datastoreType", + "x-ms-client-name": "DatastoreProperties" + }, + "DatastoreCredentials": { + "description": "Base definition for datastore credentials.", + "required": [ + "credentialsType" + ], + "type": "object", + "properties": { + "credentialsType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/CredentialsType" + } + }, + "discriminator": "credentialsType" + }, + "DatastoreResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Datastore" + } + }, + "x-ms-client-name": "Datastore", + "additionalProperties": false + }, + "DatastoreResourceArmPaginatedResult": { + "description": "A paginated list of Datastore entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Datastore objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Datastore.", + "type": "array", + "items": { + "$ref": "#/definitions/DatastoreResource" + } + } + }, + "additionalProperties": false + }, + "DatastoreSecrets": { + "description": "Base definition for datastore secrets.", + "required": [ + "secretsType" + ], + "type": "object", + "properties": { + "secretsType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/SecretsType" + } + }, + "discriminator": "secretsType" + }, + "DatastoreType": { + "description": "Enum to determine the datastore contents type.", + "enum": [ + "AzureBlob", + "AzureDataLakeGen1", + "AzureDataLakeGen2", + "AzureFile", + "Hdfs", + "OneLake" + ], + "type": "string", + "x-ms-enum": { + "name": "DatastoreType", + "modelAsString": true, + "values": [ + { + "value": "AzureBlob" + }, + { + "value": "AzureDataLakeGen1" + }, + { + "value": "AzureDataLakeGen2" + }, + { + "value": "AzureFile" + }, + { + "value": "Hdfs" + }, + { + "value": "OneLake" + } + ] + }, + "additionalProperties": false + }, + "DefaultScaleSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineScaleSettings" + } + ], + "x-ms-discriminator-value": "Default", + "additionalProperties": false + }, + "DeploymentLogs": { + "type": "object", + "properties": { + "content": { + "description": "The retrieved online deployment logs.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "DeploymentLogsRequest": { + "type": "object", + "properties": { + "containerType": { + "description": "The type of container to retrieve logs from.", + "default": "InferenceServer", + "$ref": "#/definitions/ContainerType" + }, + "tail": { + "format": "int32", + "description": "The maximum number of lines to tail.", + "type": "integer", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "DeploymentProvisioningState": { + "description": "Possible values for DeploymentProvisioningState.", + "enum": [ + "Creating", + "Deleting", + "Scaling", + "Updating", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "DeploymentProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Scaling" + }, + { + "value": "Updating" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "DeploymentResourceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceConfiguration" + } + ], + "additionalProperties": false + }, + "DestinationAsset": { + "description": "Publishing destination registry asset information", + "type": "object", + "properties": { + "destinationName": { + "description": "Destination asset name", + "type": "string", + "x-nullable": true + }, + "destinationVersion": { + "description": "Destination asset version", + "type": "string", + "x-nullable": true + }, + "registryName": { + "description": "Destination registry name", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "DistributionConfiguration": { + "description": "Base definition for job distribution configuration.", + "required": [ + "distributionType" + ], + "type": "object", + "properties": { + "distributionType": { + "description": "[Required] Specifies the type of distribution framework.", + "$ref": "#/definitions/DistributionType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "distributionType" + }, + "DistributionType": { + "description": "Enum to determine the job distribution type.", + "enum": [ + "PyTorch", + "TensorFlow", + "Mpi", + "Ray" + ], + "type": "string", + "x-ms-enum": { + "name": "DistributionType", + "modelAsString": true, + "values": [ + { + "value": "PyTorch" + }, + { + "value": "TensorFlow" + }, + { + "value": "Mpi" + }, + { + "value": "Ray" + } + ] + }, + "additionalProperties": false + }, + "DockerCredential": { + "description": "Credential for docker with username and password", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataReferenceCredential" + } + ], + "properties": { + "password": { + "description": "DockerCredential user password", + "type": "string", + "x-nullable": true + }, + "userName": { + "description": "DockerCredential user name", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "DockerCredentials", + "additionalProperties": false + }, + "EarlyTerminationPolicy": { + "description": "Early termination policies enable canceling poor-performing runs before they complete", + "required": [ + "policyType" + ], + "type": "object", + "properties": { + "delayEvaluation": { + "format": "int32", + "description": "Number of intervals by which to delay the first evaluation.", + "default": 0, + "type": "integer" + }, + "evaluationInterval": { + "format": "int32", + "description": "Interval (number of runs) between policy evaluations.", + "default": 0, + "type": "integer" + }, + "policyType": { + "description": "[Required] Name of policy configuration", + "$ref": "#/definitions/EarlyTerminationPolicyType" + } + }, + "discriminator": "policyType" + }, + "EarlyTerminationPolicyType": { + "enum": [ + "Bandit", + "MedianStopping", + "TruncationSelection" + ], + "type": "string", + "x-ms-enum": { + "name": "EarlyTerminationPolicyType", + "modelAsString": true, + "values": [ + { + "value": "Bandit" + }, + { + "value": "MedianStopping" + }, + { + "value": "TruncationSelection" + } + ] + }, + "additionalProperties": false + }, + "EgressPublicNetworkAccessType": { + "description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled for egress of a deployment.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EgressPublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "EmailNotificationEnableType": { + "description": "Enum to determine the email notification type.", + "enum": [ + "JobCompleted", + "JobFailed", + "JobCancelled" + ], + "type": "string", + "x-ms-enum": { + "name": "EmailNotificationEnableType", + "modelAsString": true, + "values": [ + { + "value": "JobCompleted" + }, + { + "value": "JobFailed" + }, + { + "value": "JobCancelled" + } + ] + }, + "additionalProperties": false + }, + "EndpointAuthKeys": { + "description": "Keys for endpoint authentication.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary key.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "secondaryKey": { + "description": "The secondary key.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointAuthMode": { + "description": "Enum to determine endpoint authentication mode.", + "enum": [ + "AMLToken", + "Key", + "AADToken" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointAuthMode", + "modelAsString": true, + "values": [ + { + "value": "AMLToken" + }, + { + "value": "Key" + }, + { + "value": "AADToken" + } + ] + }, + "additionalProperties": false + }, + "EndpointAuthToken": { + "description": "Service Token", + "type": "object", + "properties": { + "accessToken": { + "description": "Access token for endpoint authentication.", + "type": "string", + "x-nullable": true + }, + "expiryTimeUtc": { + "format": "int64", + "description": "Access token expiry time (UTC).", + "default": 0, + "type": "integer" + }, + "refreshAfterTimeUtc": { + "format": "int64", + "description": "Refresh access token after time (UTC).", + "default": 0, + "type": "integer" + }, + "tokenType": { + "description": "Access token type.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointComputeType": { + "description": "Enum to determine endpoint compute type.", + "enum": [ + "Managed", + "Kubernetes", + "AzureMLCompute" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointComputeType", + "modelAsString": true, + "values": [ + { + "value": "Managed" + }, + { + "value": "Kubernetes" + }, + { + "value": "AzureMLCompute" + } + ] + }, + "additionalProperties": false + }, + "EndpointDeploymentPropertiesBase": { + "description": "Base definition for endpoint deployment.", + "type": "object", + "properties": { + "codeConfiguration": { + "description": "Code configuration for the endpoint deployment.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + }, + "description": { + "description": "Description of the endpoint deployment.", + "type": "string", + "x-nullable": true + }, + "environmentId": { + "description": "ARM resource ID of the environment specification for the endpoint deployment.", + "type": "string", + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables configuration for the deployment.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointPropertiesBase": { + "description": "Inference Endpoint base definition", + "required": [ + "authMode" + ], + "type": "object", + "properties": { + "authMode": { + "description": "[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.", + "$ref": "#/definitions/EndpointAuthMode" + }, + "description": { + "description": "Description of the inference endpoint.", + "type": "string", + "x-nullable": true + }, + "keys": { + "description": "EndpointAuthKeys to set initially on an Endpoint.\r\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.", + "$ref": "#/definitions/EndpointAuthKeys", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true, + "x-nullable": true + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "scoringUri": { + "format": "uri", + "description": "Endpoint URI.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "swaggerUri": { + "format": "uri", + "description": "Endpoint Swagger URI.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointProvisioningState": { + "description": "State of endpoint provisioning.", + "enum": [ + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Updating", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Updating" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "EndpointScheduleAction": { + "required": [ + "actionType", + "endpointInvocationDefinition" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], + "properties": { + "endpointInvocationDefinition": { + "description": "[Required] Defines Schedule action definition details.\r\n", + "type": "object", + "example": { + "endpoint": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/batchEndpoints/hello-pipeline", + "inputs": { + "create_time": "${{creation_context.trigger_time}}" + } + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-discriminator-value": "InvokeBatchEndpoint", + "additionalProperties": false + }, + "EnvironmentContainer": { + "description": "Container for environment specification versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the environment container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "EnvironmentContainerProperties", + "additionalProperties": false + }, + "EnvironmentContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/EnvironmentContainer" + } + }, + "x-ms-client-name": "EnvironmentContainer", + "additionalProperties": false + }, + "EnvironmentContainerResourceArmPaginatedResult": { + "description": "A paginated list of EnvironmentContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type EnvironmentContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + } + }, + "additionalProperties": false + }, + "EnvironmentType": { + "description": "Environment type is either user created or curated by Azure ML service", + "enum": [ + "Curated", + "UserCreated" + ], + "type": "string", + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true, + "values": [ + { + "value": "Curated" + }, + { + "value": "UserCreated" + } + ] + }, + "additionalProperties": false + }, + "EnvironmentVersion": { + "description": "Environment version details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "autoRebuild": { + "description": "Defines if image needs to be rebuilt based on base image changes.", + "default": "Disabled", + "$ref": "#/definitions/AutoRebuildSetting", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "build": { + "description": "Configuration settings for Docker build context.", + "$ref": "#/definitions/BuildContext", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "condaFile": { + "description": "Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.\r\n", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentType": { + "description": "Environment type is either user managed or curated by the Azure ML service\r\n", + "$ref": "#/definitions/EnvironmentType", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "image": { + "description": "Name of the image that will be used for the environment.\r\n", + "type": "string", + "example": "docker.io/tensorflow/serving:latest", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "inferenceConfig": { + "description": "Defines configuration specific to inference.", + "$ref": "#/definitions/InferenceContainerProperties", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "intellectualProperty": { + "description": "Intellectual Property details. Used if environment is an Intellectual Property.", + "$ref": "#/definitions/IntellectualProperty", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "osType": { + "description": "The OS type of the environment.", + "default": "Linux", + "$ref": "#/definitions/OperatingSystemType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "provisioningState": { + "description": "Provisioning state for the environment version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "stage": { + "description": "Stage in the environment lifecycle assigned to this environment", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "EnvironmentVersionProperties", + "additionalProperties": false + }, + "EnvironmentVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/EnvironmentVersion" + } + }, + "x-ms-client-name": "EnvironmentVersion", + "additionalProperties": false + }, + "EnvironmentVersionResourceArmPaginatedResult": { + "description": "A paginated list of EnvironmentVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type EnvironmentVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + }, + "additionalProperties": false + }, + "ExportFormatType": { + "description": "The format of exported labels.", + "enum": [ + "Dataset", + "Coco", + "CSV" + ], + "type": "string", + "x-ms-enum": { + "name": "ExportFormatType", + "modelAsString": true, + "values": [ + { + "value": "Dataset" + }, + { + "value": "Coco" + }, + { + "value": "CSV" + } + ] + }, + "additionalProperties": false + }, + "ExportSummary": { + "required": [ + "format" + ], + "type": "object", + "properties": { + "endDateTime": { + "format": "date-time", + "description": "The time when the export was completed.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "exportedRowCount": { + "format": "int64", + "description": "The total number of labeled datapoints exported.", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "format": { + "description": "[Required] The format of exported labels, also as the discriminator.", + "$ref": "#/definitions/ExportFormatType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "labelingJobId": { + "description": "Name and identifier of the job containing exported labels.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "startDateTime": { + "format": "date-time", + "description": "The time when the export was requested.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "discriminator": "format" + }, + "Feature": { + "description": "Dto object representing feature", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "dataType": { + "description": "Specifies type", + "default": "String", + "$ref": "#/definitions/FeatureDataType" + }, + "featureName": { + "description": "Specifies name", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "FeatureProperties", + "additionalProperties": false + }, + "FeatureAttributionDriftMonitoringSignal": { + "required": [ + "featureImportanceSettings", + "metricThreshold", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "featureImportanceSettings": { + "description": "[Required] The settings for computing feature importance.", + "$ref": "#/definitions/FeatureImportanceSettings", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "metricThreshold": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "$ref": "#/definitions/FeatureAttributionMetricThreshold", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "productionData": { + "description": "[Required] The data which drift will be calculated for.", + "type": "array", + "items": { + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "FeatureAttributionDrift", + "additionalProperties": false + }, + "FeatureAttributionMetric": { + "enum": [ + "NormalizedDiscountedCumulativeGain" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureAttributionMetric", + "modelAsString": true, + "values": [ + { + "value": "NormalizedDiscountedCumulativeGain", + "description": "The Normalized Discounted Cumulative Gain metric." + } + ] + }, + "additionalProperties": false + }, + "FeatureAttributionMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "properties": { + "metric": { + "description": "[Required] The feature attribution metric to calculate.", + "$ref": "#/definitions/FeatureAttributionMetric", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FeatureDataType": { + "enum": [ + "String", + "Integer", + "Long", + "Float", + "Double", + "Binary", + "Datetime", + "Boolean" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureDataType", + "modelAsString": true, + "values": [ + { + "value": "String" + }, + { + "value": "Integer" + }, + { + "value": "Long" + }, + { + "value": "Float" + }, + { + "value": "Double" + }, + { + "value": "Binary" + }, + { + "value": "Datetime" + }, + { + "value": "Boolean" + } + ] + }, + "additionalProperties": false + }, + "FeatureImportanceMode": { + "description": "The mode of operation for computing feature importance.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureImportanceMode", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "Disables computing feature importance within a signal." + }, + { + "value": "Enabled", + "description": "Enables computing feature importance within a signal." + } + ] + }, + "additionalProperties": false + }, + "FeatureImportanceSettings": { + "type": "object", + "properties": { + "mode": { + "description": "The mode of operation for computing feature importance.", + "default": "Disabled", + "$ref": "#/definitions/FeatureImportanceMode" + }, + "targetColumn": { + "description": "The name of the target column within the input data asset.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FeatureLags": { + "description": "Flag for generating lags for the numeric features.", + "enum": [ + "None", + "Auto" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureLags", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No feature lags generated." + }, + { + "value": "Auto", + "description": "System auto-generates feature lags." + } + ] + }, + "additionalProperties": false + }, + "FeatureResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Feature" + } + }, + "x-ms-client-name": "Feature", + "additionalProperties": false + }, + "FeatureResourceArmPaginatedResult": { + "description": "A paginated list of Feature entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Feature objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Feature.", + "type": "array", + "items": { + "$ref": "#/definitions/FeatureResource" + } + } + }, + "additionalProperties": false + }, + "FeatureSubset": { + "required": [ + "features", + "filterType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringFeatureFilterBase" + } + ], + "properties": { + "features": { + "description": "[Required] The list of features to include.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "FeatureSubset", + "additionalProperties": false + }, + "FeatureWindow": { + "description": "Specifies the feature window", + "type": "object", + "properties": { + "featureWindowEnd": { + "format": "date-time", + "description": "Specifies the feature window end time", + "type": "string", + "x-nullable": true + }, + "featureWindowStart": { + "format": "date-time", + "description": "Specifies the feature window start time", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FeaturesetContainer": { + "description": "Dto object representing feature set", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the featureset container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "FeaturesetContainerProperties", + "additionalProperties": false + }, + "FeaturesetContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturesetContainer" + } + }, + "x-ms-client-name": "FeaturesetContainer", + "additionalProperties": false + }, + "FeaturesetContainerResourceArmPaginatedResult": { + "description": "A paginated list of FeaturesetContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturesetContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturesetContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + } + }, + "additionalProperties": false + }, + "FeaturesetSpecification": { + "description": "Dto object representing specification", + "type": "object", + "properties": { + "path": { + "description": "Specifies the spec path", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FeaturesetVersion": { + "description": "Dto object representing feature set version", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "entities": { + "description": "Specifies list of entities", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "materializationSettings": { + "description": "Specifies the materialization settings", + "$ref": "#/definitions/MaterializationSettings", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the featureset version container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "specification": { + "description": "Specifies the feature spec details", + "$ref": "#/definitions/FeaturesetSpecification", + "x-nullable": true + }, + "stage": { + "description": "Specifies the asset stage", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "FeaturesetVersionProperties", + "additionalProperties": false + }, + "FeaturesetVersionBackfillRequest": { + "description": "Request payload for creating a backfill request for a given feature set version", + "type": "object", + "properties": { + "dataAvailabilityStatus": { + "description": "Specified the data availability status that you want to backfill", + "type": "array", + "items": { + "$ref": "#/definitions/DataAvailabilityStatus" + } + }, + "description": { + "description": "Specifies description", + "type": "string" + }, + "displayName": { + "description": "Specifies description", + "type": "string" + }, + "featureWindow": { + "description": "Specifies the backfill feature window to be materialized", + "$ref": "#/definitions/FeatureWindow", + "x-nullable": true + }, + "jobId": { + "description": "Specify the jobId to retry the failed materialization", + "type": "string" + }, + "properties": { + "description": "Specifies the properties", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + }, + "resource": { + "description": "Specifies the compute resource settings", + "$ref": "#/definitions/MaterializationComputeResource" + }, + "sparkConfiguration": { + "description": "Specifies the spark compute settings", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + }, + "tags": { + "description": "Specifies the tags", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "FeaturesetVersionBackfillResponse": { + "description": "Response payload for creating a backfill request for a given feature set version", + "type": "object", + "properties": { + "jobIds": { + "description": "List of jobs submitted as part of the backfill request.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FeaturesetVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturesetVersion" + } + }, + "x-ms-client-name": "FeaturesetVersion", + "additionalProperties": false + }, + "FeaturesetVersionResourceArmPaginatedResult": { + "description": "A paginated list of FeaturesetVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturesetVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturesetVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturesetVersionResource" + } + } + }, + "additionalProperties": false + }, + "FeaturestoreEntityContainer": { + "description": "Dto object representing feature entity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the featurestore entity container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "FeaturestoreEntityContainerProperties", + "additionalProperties": false + }, + "FeaturestoreEntityContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturestoreEntityContainer" + } + }, + "x-ms-client-name": "FeaturestoreEntityContainer", + "additionalProperties": false + }, + "FeaturestoreEntityContainerResourceArmPaginatedResult": { + "description": "A paginated list of FeaturestoreEntityContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturestoreEntityContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturestoreEntityContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } + } + }, + "additionalProperties": false + }, + "FeaturestoreEntityVersion": { + "description": "Dto object representing feature entity version", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "indexColumns": { + "description": "Specifies index columns", + "type": "array", + "items": { + "$ref": "#/definitions/IndexColumn" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "provisioningState": { + "description": "Provisioning state for the featurestore entity version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "stage": { + "description": "Specifies the asset stage", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "FeaturestoreEntityVersionProperties", + "additionalProperties": false + }, + "FeaturestoreEntityVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturestoreEntityVersion" + } + }, + "x-ms-client-name": "FeaturestoreEntityVersion", + "additionalProperties": false + }, + "FeaturestoreEntityVersionResourceArmPaginatedResult": { + "description": "A paginated list of FeaturestoreEntityVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturestoreEntityVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturestoreEntityVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } + } + }, + "additionalProperties": false + }, + "FeaturizationMode": { + "description": "Featurization mode - determines data featurization mode.", + "enum": [ + "Auto", + "Custom", + "Off" + ], + "type": "string", + "x-ms-enum": { + "name": "FeaturizationMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Auto mode, system performs featurization without any custom featurization inputs." + }, + { + "value": "Custom", + "description": "Custom featurization." + }, + { + "value": "Off", + "description": "Featurization off. 'Forecasting' task cannot use this value." + } + ] + }, + "additionalProperties": false + }, + "FeaturizationSettings": { + "description": "Featurization Configuration.", + "type": "object", + "properties": { + "datasetLanguage": { + "description": "Dataset language, useful for the text data.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FileSystemSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataImportSource" + } + ], + "properties": { + "path": { + "description": "Path on data import FileSystem source", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "file_system", + "additionalProperties": false + }, + "FineTuningJob": { + "description": "FineTuning Job definition.", + "required": [ + "fineTuningDetails", + "jobType", + "outputs" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "fineTuningDetails": { + "description": "[Required] ", + "$ref": "#/definitions/FineTuningVertical" + }, + "outputs": { + "description": "[Required] ", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "FineTuning", + "additionalProperties": false + }, + "FineTuningTaskType": { + "enum": [ + "ChatCompletion", + "TextCompletion", + "TextClassification", + "QuestionAnswering", + "TextSummarization", + "TokenClassification", + "TextTranslation", + "ImageClassification", + "ImageInstanceSegmentation", + "ImageObjectDetection", + "VideoMultiObjectTracking" + ], + "type": "string", + "x-ms-enum": { + "name": "FineTuningTaskType", + "modelAsString": true, + "values": [ + { + "value": "ChatCompletion" + }, + { + "value": "TextCompletion" + }, + { + "value": "TextClassification" + }, + { + "value": "QuestionAnswering" + }, + { + "value": "TextSummarization" + }, + { + "value": "TokenClassification" + }, + { + "value": "TextTranslation" + }, + { + "value": "ImageClassification" + }, + { + "value": "ImageInstanceSegmentation" + }, + { + "value": "ImageObjectDetection" + }, + { + "value": "VideoMultiObjectTracking" + } + ] + }, + "additionalProperties": false + }, + "FineTuningVertical": { + "required": [ + "model", + "modelProvider", + "taskType", + "trainingData" + ], + "type": "object", + "properties": { + "model": { + "description": "[Required] Input model for fine tuning.", + "$ref": "#/definitions/MLFlowModelJobInput" + }, + "modelProvider": { + "description": "[Required] Enum to determine the type of fine tuning.", + "$ref": "#/definitions/ModelProvider", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "taskType": { + "description": "[Required] Fine tuning task type.", + "$ref": "#/definitions/FineTuningTaskType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "trainingData": { + "description": "[Required] Training data for fine tuning.", + "$ref": "#/definitions/JobInput" + }, + "validationData": { + "description": "Validation data for fine tuning.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + } + }, + "discriminator": "modelProvider" + }, + "FixedInputData": { + "description": "Fixed input data definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringInputDataBase" + } + ], + "x-ms-discriminator-value": "Fixed", + "additionalProperties": false + }, + "FlavorData": { + "type": "object", + "properties": { + "data": { + "description": "Model flavor-specific data.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ForecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Set forecast horizon value selection mode.", + "$ref": "#/definitions/ForecastHorizonMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "ForecastHorizonMode": { + "description": "Enum to determine forecast horizon selection mode.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ForecastHorizonMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Forecast horizon to be determined automatically." + }, + { + "value": "Custom", + "description": "Use the custom forecast horizon." + } + ] + }, + "additionalProperties": false + }, + "Forecasting": { + "description": "Forecasting task in AutoML Table vertical.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TableVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "forecastingSettings": { + "description": "Forecasting task specific inputs.", + "$ref": "#/definitions/ForecastingSettings", + "x-nullable": true + }, + "primaryMetric": { + "description": "Primary metric for forecasting task.", + "default": "NormalizedRootMeanSquaredError", + "$ref": "#/definitions/ForecastingPrimaryMetrics" + }, + "trainingSettings": { + "description": "Inputs for training phase for an AutoML Job.", + "$ref": "#/definitions/ForecastingTrainingSettings", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Forecasting", + "additionalProperties": false + }, + "ForecastingModels": { + "description": "Enum for all forecasting models supported by AutoML.", + "enum": [ + "AutoArima", + "Prophet", + "Naive", + "SeasonalNaive", + "Average", + "SeasonalAverage", + "ExponentialSmoothing", + "Arimax", + "TCNForecaster", + "ElasticNet", + "GradientBoosting", + "DecisionTree", + "KNN", + "LassoLars", + "SGD", + "RandomForest", + "ExtremeRandomTrees", + "LightGBM", + "XGBoostRegressor" + ], + "type": "string", + "x-ms-enum": { + "name": "ForecastingModels", + "modelAsString": true, + "values": [ + { + "value": "AutoArima", + "description": "Auto-Autoregressive Integrated Moving Average (ARIMA) model uses time-series data and statistical analysis to interpret the data and make future predictions.\nThis model aims to explain data by using time series data on its past values and uses linear regression to make predictions." + }, + { + "value": "Prophet", + "description": "Prophet is a procedure for forecasting time series data based on an additive model where non-linear trends are fit with yearly, weekly, and daily seasonality, plus holiday effects.\nIt works best with time series that have strong seasonal effects and several seasons of historical data. Prophet is robust to missing data and shifts in the trend, and typically handles outliers well." + }, + { + "value": "Naive", + "description": "The Naive forecasting model makes predictions by carrying forward the latest target value for each time-series in the training data." + }, + { + "value": "SeasonalNaive", + "description": "The Seasonal Naive forecasting model makes predictions by carrying forward the latest season of target values for each time-series in the training data." + }, + { + "value": "Average", + "description": "The Average forecasting model makes predictions by carrying forward the average of the target values for each time-series in the training data." + }, + { + "value": "SeasonalAverage", + "description": "The Seasonal Average forecasting model makes predictions by carrying forward the average value of the latest season of data for each time-series in the training data." + }, + { + "value": "ExponentialSmoothing", + "description": "Exponential smoothing is a time series forecasting method for univariate data that can be extended to support data with a systematic trend or seasonal component." + }, + { + "value": "Arimax", + "description": "An Autoregressive Integrated Moving Average with Explanatory Variable (ARIMAX) model can be viewed as a multiple regression model with one or more autoregressive (AR) terms and/or one or more moving average (MA) terms.\nThis method is suitable for forecasting when data is stationary/non stationary, and multivariate with any type of data pattern, i.e., level/trend /seasonality/cyclicity." + }, + { + "value": "TCNForecaster", + "description": "TCNForecaster: Temporal Convolutional Networks Forecaster. //TODO: Ask forecasting team for brief intro." + }, + { + "value": "ElasticNet", + "description": "Elastic net is a popular type of regularized linear regression that combines two popular penalties, specifically the L1 and L2 penalty functions." + }, + { + "value": "GradientBoosting", + "description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution." + }, + { + "value": "DecisionTree", + "description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features." + }, + { + "value": "KNN", + "description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set." + }, + { + "value": "LassoLars", + "description": "Lasso model fit with Least Angle Regression a.k.a. Lars. It is a Linear Model trained with an L1 prior as regularizer." + }, + { + "value": "SGD", + "description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs.\nIt's an inexact but powerful technique." + }, + { + "value": "RandomForest", + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the bagging method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + }, + { + "value": "ExtremeRandomTrees", + "description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm." + }, + { + "value": "LightGBM", + "description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms." + }, + { + "value": "XGBoostRegressor", + "description": "XGBoostRegressor: Extreme Gradient Boosting Regressor is a supervised machine learning model using ensemble of base learners." + } + ] + }, + "additionalProperties": false + }, + "ForecastingPrimaryMetrics": { + "description": "Primary metrics for Forecasting task.", + "enum": [ + "SpearmanCorrelation", + "NormalizedRootMeanSquaredError", + "R2Score", + "NormalizedMeanAbsoluteError" + ], + "type": "string", + "x-ms-enum": { + "name": "ForecastingPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "SpearmanCorrelation", + "description": "The Spearman's rank coefficient of correlation is a non-parametric measure of rank correlation." + }, + { + "value": "NormalizedRootMeanSquaredError", + "description": "The Normalized Root Mean Squared Error (NRMSE) the RMSE facilitates the comparison between models with different scales." + }, + { + "value": "R2Score", + "description": "The R2 score is one of the performance evaluation measures for forecasting-based machine learning models." + }, + { + "value": "NormalizedMeanAbsoluteError", + "description": "The Normalized Mean Absolute Error (NMAE) is a validation metric to compare the Mean Absolute Error (MAE) of (time) series with different scales." + } + ] + }, + "additionalProperties": false + }, + "ForecastingSettings": { + "description": "Forecasting specific parameters.", + "type": "object", + "properties": { + "countryOrRegionForHolidays": { + "description": "Country or region for holidays for forecasting tasks.\r\nThese should be ISO 3166 two-letter country/region codes, for example 'US' or 'GB'.", + "type": "string", + "x-nullable": true + }, + "cvStepSize": { + "format": "int32", + "description": "Number of periods between the origin time of one CV fold and the next fold. For\r\nexample, if `CVStepSize` = 3 for daily data, the origin time for each fold will be\r\nthree days apart.", + "type": "integer", + "x-nullable": true + }, + "featureLags": { + "description": "Flag for generating lags for the numeric features with 'auto' or null.", + "default": "None", + "$ref": "#/definitions/FeatureLags" + }, + "featuresUnknownAtForecastTime": { + "description": "The feature columns that are available for training but unknown at the time of forecast/inference.\r\nIf features_unknown_at_forecast_time is not set, it is assumed that all the feature columns in the dataset are known at inference time.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "forecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", + "default": "{\"Mode\": \"Custom\", \"Value\": 1}", + "$ref": "#/definitions/ForecastHorizon" + }, + "frequency": { + "description": "When forecasting, this parameter represents the period with which the forecast is desired, for example daily, weekly, yearly, etc. The forecast frequency is dataset frequency by default.", + "type": "string", + "x-nullable": true + }, + "seasonality": { + "description": "Set time series seasonality as an integer multiple of the series frequency.\r\nIf seasonality is set to 'auto', it will be inferred.", + "default": "{\"Mode\": \"Auto\"}", + "$ref": "#/definitions/Seasonality" + }, + "shortSeriesHandlingConfig": { + "description": "The parameter defining how if AutoML should handle short time series.", + "default": "Auto", + "$ref": "#/definitions/ShortSeriesHandlingConfiguration" + }, + "targetAggregateFunction": { + "description": "The function to be used to aggregate the time series target column to conform to a user specified frequency.\r\nIf the TargetAggregateFunction is set i.e. not 'None', but the freq parameter is not set, the error is raised. The possible target aggregation functions are: \"sum\", \"max\", \"min\" and \"mean\".", + "default": "None", + "$ref": "#/definitions/TargetAggregationFunction" + }, + "targetLags": { + "description": "The number of past periods to lag from the target column.", + "$ref": "#/definitions/TargetLags", + "x-nullable": true + }, + "targetRollingWindowSize": { + "description": "The number of past periods used to create a rolling window average of the target column.", + "$ref": "#/definitions/TargetRollingWindowSize", + "x-nullable": true + }, + "timeColumnName": { + "description": "The name of the time column. This parameter is required when forecasting to specify the datetime column in the input data used for building the time series and inferring its frequency.", + "type": "string", + "x-nullable": true + }, + "timeSeriesIdColumnNames": { + "description": "The names of columns used to group a timeseries. It can be used to create multiple series.\r\nIf grain is not defined, the data set is assumed to be one time-series. This parameter is used with task type forecasting.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "useStl": { + "description": "Configure STL Decomposition of the time-series target column.", + "default": "None", + "$ref": "#/definitions/UseStl" + } + }, + "additionalProperties": false + }, + "ForecastingTrainingSettings": { + "description": "Forecasting Training related configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrainingSettings" + } + ], + "properties": { + "allowedTrainingAlgorithms": { + "description": "Allowed models for forecasting task.", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastingModels" + }, + "x-nullable": true + }, + "blockedTrainingAlgorithms": { + "description": "Blocked models for forecasting task.", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastingModels" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "GenerationSafetyQualityMetric": { + "description": "Generation safety quality metric enum.", + "enum": [ + "AcceptableGroundednessScorePerInstance", + "AggregatedGroundednessPassRate", + "AcceptableCoherenceScorePerInstance", + "AggregatedCoherencePassRate", + "AcceptableFluencyScorePerInstance", + "AggregatedFluencyPassRate", + "AcceptableSimilarityScorePerInstance", + "AggregatedSimilarityPassRate", + "AcceptableRelevanceScorePerInstance", + "AggregatedRelevancePassRate" + ], + "type": "string", + "x-ms-enum": { + "name": "GenerationSafetyQualityMetric", + "modelAsString": true, + "values": [ + { + "value": "AcceptableGroundednessScorePerInstance" + }, + { + "value": "AggregatedGroundednessPassRate" + }, + { + "value": "AcceptableCoherenceScorePerInstance" + }, + { + "value": "AggregatedCoherencePassRate" + }, + { + "value": "AcceptableFluencyScorePerInstance" + }, + { + "value": "AggregatedFluencyPassRate" + }, + { + "value": "AcceptableSimilarityScorePerInstance" + }, + { + "value": "AggregatedSimilarityPassRate" + }, + { + "value": "AcceptableRelevanceScorePerInstance" + }, + { + "value": "AggregatedRelevancePassRate" + } + ] + }, + "additionalProperties": false + }, + "GenerationSafetyQualityMetricThreshold": { + "description": "Generation safety quality metric threshold definition.", + "required": [ + "metric" + ], + "type": "object", + "properties": { + "metric": { + "description": "[Required] Gets or sets the feature attribution metric to calculate.", + "$ref": "#/definitions/GenerationSafetyQualityMetric", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "Gets or sets the threshold value.\r\nIf null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "GenerationSafetyQualityMonitoringSignal": { + "description": "Generation safety quality monitoring signal definition.", + "required": [ + "metricThresholds", + "samplingRate" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "metricThresholds": { + "description": "[Required] Gets or sets the metrics to calculate and the corresponding thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/GenerationSafetyQualityMetricThreshold" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "Gets or sets the production data for computing metrics.", + "type": "array", + "items": { + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + }, + "samplingRate": { + "format": "double", + "description": "[Required] The sample rate of the production data, should be greater than 0 and at most 1.", + "type": "number", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "workspaceConnectionId": { + "description": "Gets or sets the workspace connection ID used to connect to the content generation endpoint.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "GenerationSafetyQuality", + "additionalProperties": false + }, + "GenerationTokenUsageMetric": { + "description": "Generation token statistics metric enum.", + "enum": [ + "TotalTokenCount", + "TotalTokenCountPerGroup" + ], + "type": "string", + "x-ms-enum": { + "name": "GenerationTokenUsageMetric", + "modelAsString": true, + "values": [ + { + "value": "TotalTokenCount" + }, + { + "value": "TotalTokenCountPerGroup" + } + ] + }, + "additionalProperties": false + }, + "GenerationTokenUsageMetricThreshold": { + "description": "Generation token statistics metric threshold definition.", + "required": [ + "metric" + ], + "type": "object", + "properties": { + "metric": { + "description": "[Required] Gets or sets the feature attribution metric to calculate.", + "$ref": "#/definitions/GenerationTokenUsageMetric", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "Gets or sets the threshold value.\r\nIf null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "GenerationTokenUsageSignal": { + "description": "Generation token usage signal definition.", + "required": [ + "metricThresholds", + "samplingRate" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "metricThresholds": { + "description": "[Required] Gets or sets the metrics to calculate and the corresponding thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/GenerationTokenUsageMetricThreshold" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "Gets or sets the production data for computing metrics.", + "type": "array", + "items": { + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + }, + "samplingRate": { + "format": "double", + "description": "[Required] The sample rate of the production data, should be greater than 0 and at most 1.", + "type": "number", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "GenerationTokenStatistics", + "additionalProperties": false + }, + "GetBlobReferenceForConsumptionDto": { + "type": "object", + "properties": { + "blobUri": { + "format": "uri", + "description": "Blob uri, example: https://blob.windows.core.net/Container/Path", + "type": "string", + "x-nullable": true + }, + "credential": { + "description": "Credential info to access storage account", + "$ref": "#/definitions/DataReferenceCredential", + "x-nullable": true + }, + "storageAccountArmId": { + "description": "The ARM id of the storage account", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "GetBlobReferenceSASRequestDto": { + "description": "BlobReferenceSASRequest for getBlobReferenceSAS API", + "type": "object", + "properties": { + "assetId": { + "description": "Id of the asset to be accessed", + "type": "string", + "x-nullable": true + }, + "blobUri": { + "format": "uri", + "description": "Blob uri of the asset to be accessed", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "GetBlobReferenceSASResponseDto": { + "description": "BlobReferenceSASResponse for getBlobReferenceSAS API", + "type": "object", + "properties": { + "blobReferenceForConsumption": { + "description": "Blob reference for consumption details", + "$ref": "#/definitions/GetBlobReferenceForConsumptionDto", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "Goal": { + "description": "Defines supported metric goals for hyperparameter tuning", + "enum": [ + "Minimize", + "Maximize" + ], + "type": "string", + "x-ms-enum": { + "name": "Goal", + "modelAsString": true, + "values": [ + { + "value": "Minimize" + }, + { + "value": "Maximize" + } + ] + }, + "additionalProperties": false + }, + "GridSamplingAlgorithm": { + "description": "Defines a Sampling Algorithm that exhaustively generates every value combination in the space", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SamplingAlgorithm" + } + ], + "x-ms-discriminator-value": "Grid", + "additionalProperties": false + }, + "GroupStatus": { + "type": "object", + "properties": { + "actualCapacityInfo": { + "description": "Gets or sets the actual capacity info for the group.", + "$ref": "#/definitions/ActualCapacityInfo", + "x-nullable": true + }, + "bonusExtraCapacity": { + "format": "int32", + "description": "Gets or sets capacity used from the pool's reserved capacity.", + "default": 0, + "type": "integer" + }, + "endpointCount": { + "format": "int32", + "description": "Gets or sets the actual number of endpoints in the group.", + "default": 0, + "type": "integer" + }, + "requestedCapacity": { + "format": "int32", + "description": "Gets or sets the request number of instances for the group.", + "default": 0, + "type": "integer" + } + }, + "additionalProperties": false + }, + "HdfsDatastore": { + "required": [ + "nameNodeAddress" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "hdfsServerCertificate": { + "description": "The TLS cert of the HDFS server. Needs to be a base64 encoded string. Required if \"Https\" protocol is selected.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "nameNodeAddress": { + "description": "[Required] IP Address or DNS HostName.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "protocol": { + "description": "Protocol used to communicate with the storage account (Https/Http).", + "default": "http", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Hdfs", + "additionalProperties": false + }, + "IdAssetReference": { + "description": "Reference to an asset via its ARM resource ID.", + "required": [ + "assetId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "assetId": { + "description": "[Required] ARM resource ID of the asset.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "Id", + "additionalProperties": false + }, + "IdentityConfiguration": { + "description": "Base definition for identity configuration.", + "required": [ + "identityType" + ], + "type": "object", + "properties": { + "identityType": { + "description": "[Required] Specifies the type of identity framework.", + "$ref": "#/definitions/IdentityConfigurationType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "identityType" + }, + "IdentityConfigurationType": { + "description": "Enum to determine identity framework.", + "enum": [ + "Managed", + "AMLToken", + "UserIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "IdentityConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Managed" + }, + { + "value": "AMLToken" + }, + { + "value": "UserIdentity" + } + ] + }, + "additionalProperties": false + }, + "ImageAnnotationType": { + "description": "Annotation type of image data.", + "enum": [ + "Classification", + "BoundingBox", + "InstanceSegmentation" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageAnnotationType", + "modelAsString": true, + "values": [ + { + "value": "Classification" + }, + { + "value": "BoundingBox" + }, + { + "value": "InstanceSegmentation" + } + ] + }, + "additionalProperties": false + }, + "ImageClassification": { + "description": "Image Classification. Multi-class image classification is used when an image is classified with only a single label\r\nfrom a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageClassificationBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "Accuracy", + "$ref": "#/definitions/ClassificationPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageClassification", + "additionalProperties": false + }, + "ImageClassificationBase": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageVertical" + } + ], + "properties": { + "modelSettings": { + "description": "Settings used for training the model.", + "$ref": "#/definitions/ImageModelSettingsClassification", + "x-nullable": true + }, + "searchSpace": { + "description": "Search space for sampling different combinations of models and their hyperparameters.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageModelDistributionSettingsClassification" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "ImageClassificationMultilabel": { + "description": "Image Classification Multilabel. Multi-label image classification is used when an image could have one or more labels\r\nfrom a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageClassificationBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "IOU", + "$ref": "#/definitions/ClassificationMultilabelPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageClassificationMultilabel", + "additionalProperties": false + }, + "ImageInstanceSegmentation": { + "description": "Image Instance Segmentation. Instance segmentation is used to identify objects in an image at the pixel level,\r\ndrawing a polygon around each object in the image.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageObjectDetectionBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "MeanAveragePrecision", + "$ref": "#/definitions/InstanceSegmentationPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageInstanceSegmentation", + "additionalProperties": false + }, + "ImageLimitSettings": { + "description": "Limit settings for the AutoML job.", + "type": "object", + "properties": { + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum number of concurrent AutoML iterations.", + "default": 1, + "type": "integer" + }, + "maxTrials": { + "format": "int32", + "description": "Maximum number of AutoML iterations.", + "default": 1, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "P7D", + "type": "string" + } + }, + "additionalProperties": false + }, + "ImageModelDistributionSettings": { + "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n```\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n```\r\nAll distributions can be specified as distribution_name(min, max) or choice(val1, val2, ..., valn)\r\nwhere distribution name can be: uniform, quniform, loguniform, etc\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "properties": { + "amsGradient": { + "description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "augmentations": { + "description": "Settings for using Augmentations.", + "type": "string", + "example": "choice('hflip;mosaic;random_crop', 'mosaic')", + "x-nullable": true + }, + "beta1": { + "description": "Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + }, + "beta2": { + "description": "Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + }, + "distributed": { + "description": "Whether to use distributer training.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "earlyStopping": { + "description": "Enable early stopping logic during training.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "earlyStoppingDelay": { + "description": "Minimum number of epochs or validation evaluations to wait before primary metric improvement\r\nis tracked for early stopping. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "earlyStoppingPatience": { + "description": "Minimum number of epochs or validation evaluations with no primary metric improvement before\r\nthe run is stopped. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "enableOnnxNormalization": { + "description": "Enable normalization when exporting ONNX model.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "evaluationFrequency": { + "description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "gradientAccumulationStep": { + "description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\r\nupdating the model weights while accumulating the gradients of those steps, and then using\r\nthe accumulated gradients to compute the weight updates. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "layersToFreeze": { + "description": "Number of layers to freeze for the model. Must be a positive integer.\r\nFor instance, passing 2 as value for 'seresnext' means\r\nfreezing layer0 and layer1. For a full list of models supported and details on layer freeze, please\r\nsee: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "string", + "example": "choice(1, 2)", + "x-nullable": true + }, + "learningRate": { + "description": "Initial learning rate. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0.0005, 0.005)", + "x-nullable": true + }, + "learningRateScheduler": { + "description": "Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.", + "type": "string", + "example": "choice('warmup_cosine', 'step')", + "x-nullable": true + }, + "modelName": { + "description": "Name of the model to use for training.\r\nFor more information on the available models please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "string", + "example": "choice('seresnext', 'resnest50')", + "x-nullable": true + }, + "momentum": { + "description": "Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].", + "type": "string", + "example": "quniform(0, 1)", + "x-nullable": true + }, + "nesterov": { + "description": "Enable nesterov when optimizer is 'sgd'.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "numberOfEpochs": { + "description": "Number of training epochs. Must be a positive integer.", + "type": "string", + "example": "choice(15, 30)", + "x-nullable": true + }, + "numberOfWorkers": { + "description": "Number of data loader workers. Must be a non-negative integer.", + "type": "string", + "example": "uniform(8, 16)", + "x-nullable": true + }, + "optimizer": { + "description": "Type of optimizer. Must be either 'sgd', 'adam', or 'adamw'.", + "type": "string", + "example": "choice('sgd', 'adam', 'adamw')", + "x-nullable": true + }, + "randomSeed": { + "description": "Random seed to be used when using deterministic training.", + "type": "string", + "example": "loguniform(0, 1)", + "x-nullable": true + }, + "stepLRGamma": { + "description": "Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].", + "type": "string", + "example": "choice(0.1, 0.2, 0.25)", + "x-nullable": true + }, + "stepLRStepSize": { + "description": "Value of step size when learning rate scheduler is 'step'. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "trainingBatchSize": { + "description": "Training batch size. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "validationBatchSize": { + "description": "Validation batch size. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "warmupCosineLRCycles": { + "description": "Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + }, + "warmupCosineLRWarmupEpochs": { + "description": "Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "weightDecay": { + "description": "Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelDistributionSettingsClassification": { + "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n```\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n```\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageModelDistributionSettings" + } + ], + "properties": { + "trainingCropSize": { + "description": "Image crop size that is input to the neural network for the training dataset. Must be a positive integer.", + "type": "string", + "example": "choice(224, 360)", + "x-nullable": true + }, + "validationCropSize": { + "description": "Image crop size that is input to the neural network for the validation dataset. Must be a positive integer.", + "type": "string", + "example": "choice(224, 360)", + "x-nullable": true + }, + "validationResizeSize": { + "description": "Image size to which to resize before cropping for validation dataset. Must be a positive integer.", + "type": "string", + "example": "choice(128, 256)", + "x-nullable": true + }, + "weightedLoss": { + "description": "Weighted loss. The accepted values are 0 for no weighted loss.\r\n1 for weighted loss with sqrt.(class_weights). 2 for weighted loss with class_weights. Must be 0 or 1 or 2.", + "type": "string", + "example": "choice(0, 1, 2)", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelDistributionSettingsObjectDetection": { + "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n```\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n```\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageModelDistributionSettings" + } + ], + "properties": { + "boxDetectionsPerImage": { + "description": "Maximum number of detections per image, for all classes. Must be a positive integer.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(50, 100)", + "x-nullable": true + }, + "boxScoreThreshold": { + "description": "During inference, only return proposals with a classification score greater than\r\nBoxScoreThreshold. Must be a float in the range[0, 1].", + "type": "string", + "example": "uniform(0.1, 0.2)", + "x-nullable": true + }, + "imageSize": { + "description": "Image size for train and validation. Must be a positive integer.\r\nNote: The training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(224, 640)", + "x-nullable": true + }, + "maxSize": { + "description": "Maximum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(640, 1333)", + "x-nullable": true + }, + "minSize": { + "description": "Minimum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(300, 600)", + "x-nullable": true + }, + "modelSize": { + "description": "Model size. Must be 'small', 'medium', 'large', or 'xlarge'.\r\nNote: training run may get into CUDA OOM if the model size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice('small', 'medium', 'large', 'xlarge')", + "x-nullable": true + }, + "multiScale": { + "description": "Enable multi-scale image by varying image size by +/- 50%.\r\nNote: training run may get into CUDA OOM if no sufficient GPU memory.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "nmsIouThreshold": { + "description": "IOU threshold used during inference in NMS post processing. Must be float in the range [0, 1].", + "type": "string", + "example": "uniform(0.1, 0.2)", + "x-nullable": true + }, + "tileGridSize": { + "description": "The grid size to use for tiling each image. Note: TileGridSize must not be\r\nNone to enable small object detection logic. A string containing two integers in mxn format.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice('3x2', '2x2')", + "x-nullable": true + }, + "tileOverlapRatio": { + "description": "Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1).\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "uniform(0.1, 0.2)", + "x-nullable": true + }, + "tilePredictionsNmsThreshold": { + "description": "The IOU threshold to use to perform NMS while merging predictions from tiles and image.\r\nUsed in validation/ inference. Must be float in the range [0, 1].\r\nNote: This settings is not supported for the 'yolov5' algorithm.\r\nNMS: Non-maximum suppression", + "type": "string", + "example": "uniform(0.2, 0.3)", + "x-nullable": true + }, + "validationIouThreshold": { + "description": "IOU threshold to use when computing validation metric. Must be float in the range [0, 1].", + "type": "string", + "example": "uniform(0.2, 0.3)", + "x-nullable": true + }, + "validationMetricType": { + "description": "Metric computation method to use for validation metrics. Must be 'none', 'coco', 'voc', or 'coco_voc'.", + "type": "string", + "example": "choice('none', 'coco', 'voc', 'coco_voc')", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelSettings": { + "description": "Settings used for training the model.\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "properties": { + "advancedSettings": { + "description": "Settings for advanced scenarios.", + "type": "string", + "example": "key1:val1;key2;key3:val3;key4", + "x-nullable": true + }, + "amsGradient": { + "description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.", + "type": "boolean", + "x-nullable": true + }, + "augmentations": { + "description": "Settings for using Augmentations.", + "type": "string", + "example": "hflip;mosaic;random_crop", + "x-nullable": true + }, + "beta1": { + "format": "float", + "description": "Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "beta2": { + "format": "float", + "description": "Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "checkpointFrequency": { + "format": "int32", + "description": "Frequency to store model checkpoints. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "checkpointModel": { + "description": "The pretrained checkpoint model for incremental training.", + "$ref": "#/definitions/MLFlowModelJobInput", + "x-nullable": true + }, + "checkpointRunId": { + "description": "The id of a previous run that has a pretrained checkpoint for incremental training.", + "type": "string", + "x-nullable": true + }, + "distributed": { + "description": "Whether to use distributed training.", + "type": "boolean", + "x-nullable": true + }, + "earlyStopping": { + "description": "Enable early stopping logic during training.", + "type": "boolean", + "x-nullable": true + }, + "earlyStoppingDelay": { + "format": "int32", + "description": "Minimum number of epochs or validation evaluations to wait before primary metric improvement\r\nis tracked for early stopping. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "earlyStoppingPatience": { + "format": "int32", + "description": "Minimum number of epochs or validation evaluations with no primary metric improvement before\r\nthe run is stopped. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "enableOnnxNormalization": { + "description": "Enable normalization when exporting ONNX model.", + "type": "boolean", + "x-nullable": true + }, + "evaluationFrequency": { + "format": "int32", + "description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "gradientAccumulationStep": { + "format": "int32", + "description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\r\nupdating the model weights while accumulating the gradients of those steps, and then using\r\nthe accumulated gradients to compute the weight updates. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "layersToFreeze": { + "format": "int32", + "description": "Number of layers to freeze for the model. Must be a positive integer.\r\nFor instance, passing 2 as value for 'seresnext' means\r\nfreezing layer0 and layer1. For a full list of models supported and details on layer freeze, please\r\nsee: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "integer", + "x-nullable": true + }, + "learningRate": { + "format": "float", + "description": "Initial learning rate. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "learningRateScheduler": { + "description": "Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.", + "default": "None", + "$ref": "#/definitions/LearningRateScheduler" + }, + "modelName": { + "description": "Name of the model to use for training.\r\nFor more information on the available models please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "string", + "x-nullable": true + }, + "momentum": { + "format": "float", + "description": "Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "nesterov": { + "description": "Enable nesterov when optimizer is 'sgd'.", + "type": "boolean", + "x-nullable": true + }, + "numberOfEpochs": { + "format": "int32", + "description": "Number of training epochs. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "numberOfWorkers": { + "format": "int32", + "description": "Number of data loader workers. Must be a non-negative integer.", + "type": "integer", + "x-nullable": true + }, + "optimizer": { + "description": "Type of optimizer.", + "default": "None", + "$ref": "#/definitions/StochasticOptimizer" + }, + "randomSeed": { + "format": "int32", + "description": "Random seed to be used when using deterministic training.", + "type": "integer", + "x-nullable": true + }, + "stepLRGamma": { + "format": "float", + "description": "Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "stepLRStepSize": { + "format": "int32", + "description": "Value of step size when learning rate scheduler is 'step'. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "trainingBatchSize": { + "format": "int32", + "description": "Training batch size. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "validationBatchSize": { + "format": "int32", + "description": "Validation batch size. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "warmupCosineLRCycles": { + "format": "float", + "description": "Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "warmupCosineLRWarmupEpochs": { + "format": "int32", + "description": "Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "weightDecay": { + "format": "float", + "description": "Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].", + "type": "number", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelSettingsClassification": { + "description": "Settings used for training the model.\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageModelSettings" + } + ], + "properties": { + "trainingCropSize": { + "format": "int32", + "description": "Image crop size that is input to the neural network for the training dataset. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "validationCropSize": { + "format": "int32", + "description": "Image crop size that is input to the neural network for the validation dataset. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "validationResizeSize": { + "format": "int32", + "description": "Image size to which to resize before cropping for validation dataset. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "weightedLoss": { + "format": "int32", + "description": "Weighted loss. The accepted values are 0 for no weighted loss.\r\n1 for weighted loss with sqrt.(class_weights). 2 for weighted loss with class_weights. Must be 0 or 1 or 2.", + "type": "integer", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelSettingsObjectDetection": { + "description": "Settings used for training the model.\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageModelSettings" + } + ], + "properties": { + "boxDetectionsPerImage": { + "format": "int32", + "description": "Maximum number of detections per image, for all classes. Must be a positive integer.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "boxScoreThreshold": { + "format": "float", + "description": "During inference, only return proposals with a classification score greater than\r\nBoxScoreThreshold. Must be a float in the range[0, 1].", + "type": "number", + "x-nullable": true + }, + "imageSize": { + "format": "int32", + "description": "Image size for train and validation. Must be a positive integer.\r\nNote: The training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "logTrainingMetrics": { + "description": "Enable computing and logging training metrics.", + "default": "Enable", + "$ref": "#/definitions/LogTrainingMetrics" + }, + "logValidationLoss": { + "description": "Enable computing and logging validation loss.", + "default": "Disable", + "$ref": "#/definitions/LogValidationLoss" + }, + "maxSize": { + "format": "int32", + "description": "Maximum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "minSize": { + "format": "int32", + "description": "Minimum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "modelSize": { + "description": "Model size. Must be 'small', 'medium', 'large', or 'xlarge'.\r\nNote: training run may get into CUDA OOM if the model size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "default": "None", + "$ref": "#/definitions/ModelSize" + }, + "multiScale": { + "description": "Enable multi-scale image by varying image size by +/- 50%.\r\nNote: training run may get into CUDA OOM if no sufficient GPU memory.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "boolean", + "x-nullable": true + }, + "nmsIouThreshold": { + "format": "float", + "description": "IOU threshold used during inference in NMS post processing. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "tileGridSize": { + "description": "The grid size to use for tiling each image. Note: TileGridSize must not be\r\nNone to enable small object detection logic. A string containing two integers in mxn format.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "3x2", + "x-nullable": true + }, + "tileOverlapRatio": { + "format": "float", + "description": "Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1).\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "number", + "x-nullable": true + }, + "tilePredictionsNmsThreshold": { + "format": "float", + "description": "The IOU threshold to use to perform NMS while merging predictions from tiles and image.\r\nUsed in validation/ inference. Must be float in the range [0, 1].\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "number", + "x-nullable": true + }, + "validationIouThreshold": { + "format": "float", + "description": "IOU threshold to use when computing validation metric. Must be float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "validationMetricType": { + "description": "Metric computation method to use for validation metrics.", + "default": "None", + "$ref": "#/definitions/ValidationMetricType" + } + }, + "additionalProperties": false + }, + "ImageObjectDetection": { + "description": "Image Object Detection. Object detection is used to identify objects in an image and locate each object with a\r\nbounding box e.g. locate all dogs and cats in an image and draw a bounding box around each.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageObjectDetectionBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "MeanAveragePrecision", + "$ref": "#/definitions/ObjectDetectionPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageObjectDetection", + "additionalProperties": false + }, + "ImageObjectDetectionBase": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageVertical" + } + ], + "properties": { + "modelSettings": { + "description": "Settings used for training the model.", + "$ref": "#/definitions/ImageModelSettingsObjectDetection", + "x-nullable": true + }, + "searchSpace": { + "description": "Search space for sampling different combinations of models and their hyperparameters.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageModelDistributionSettingsObjectDetection" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "ImageSweepSettings": { + "description": "Model sweeping and hyperparameter sweeping related settings.", + "required": [ + "samplingAlgorithm" + ], + "type": "object", + "properties": { + "earlyTermination": { + "description": "Type of early termination policy.", + "$ref": "#/definitions/EarlyTerminationPolicy", + "x-nullable": true + }, + "samplingAlgorithm": { + "description": "[Required] Type of the hyperparameter sampling algorithms.", + "$ref": "#/definitions/SamplingAlgorithmType" + } + }, + "additionalProperties": false + }, + "ImageVertical": { + "description": "Abstract class for AutoML tasks that train image (computer vision) models -\r\nsuch as Image Classification / Image Classification Multilabel / Image Object Detection / Image Instance Segmentation.", + "required": [ + "limitSettings" + ], + "type": "object", + "properties": { + "limitSettings": { + "description": "[Required] Limit settings for the AutoML job.", + "$ref": "#/definitions/ImageLimitSettings" + }, + "sweepSettings": { + "description": "Model sweeping and hyperparameter sweeping related settings.", + "$ref": "#/definitions/ImageSweepSettings", + "x-nullable": true + }, + "validationData": { + "description": "Validation data inputs.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, + "validationDataSize": { + "format": "double", + "description": "The fraction of training dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImportDataAction": { + "required": [ + "actionType", + "dataImportDefinition" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], + "properties": { + "dataImportDefinition": { + "description": "[Required] Defines Schedule action definition details.", + "$ref": "#/definitions/DataImport", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-discriminator-value": "ImportData", + "additionalProperties": false + }, + "IncrementalDataRefresh": { + "description": "Whether IncrementalDataRefresh is enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "IncrementalDataRefresh", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "IndexColumn": { + "description": "Dto object representing index column", + "type": "object", + "properties": { + "columnName": { + "description": "Specifies the column name", + "type": "string", + "x-nullable": true + }, + "dataType": { + "description": "Specifies the data type", + "default": "String", + "$ref": "#/definitions/FeatureDataType" + } + }, + "additionalProperties": false + }, + "InferenceContainerProperties": { + "type": "object", + "properties": { + "livenessRoute": { + "description": "The route to check the liveness of the inference server container.", + "$ref": "#/definitions/Route" + }, + "readinessRoute": { + "description": "The route to check the readiness of the inference server container.", + "$ref": "#/definitions/Route" + }, + "scoringRoute": { + "description": "The port to send the scoring requests to, within the inference server container.", + "$ref": "#/definitions/Route" + } + }, + "additionalProperties": false + }, + "InferenceEndpoint": { + "description": "InferenceEndpoint configuration", + "required": [ + "authMode", + "groupId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PropertiesBase" + } + ], + "properties": { + "authMode": { + "description": "[Required] Authentication mode for the endpoint.", + "$ref": "#/definitions/AuthMode" + }, + "endpointUri": { + "format": "uri", + "description": "Endpoint URI for the inference endpoint.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "groupId": { + "description": "[Required] Group within the same pool with which this endpoint needs to be associated with.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/PoolProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "InferenceEndpointProperties", + "additionalProperties": false + }, + "InferenceEndpointTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/InferenceEndpoint" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "InferenceEndpoint", + "additionalProperties": false + }, + "InferenceEndpointTrackedResourceArmPaginatedResult": { + "description": "A paginated list of InferenceEndpoint entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of InferenceEndpoint objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type InferenceEndpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/InferenceEndpointTrackedResource" + } + } + }, + "additionalProperties": false + }, + "InferenceGroup": { + "description": "Inference group configuration", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PropertiesBase" + } + ], + "properties": { + "bonusExtraCapacity": { + "format": "int32", + "description": "Capacity to be used from the pool's reserved capacity.\r\noptional", + "default": 0, + "type": "integer" + }, + "metadata": { + "description": "Metadata for the inference group.", + "type": "string", + "x-nullable": true + }, + "priority": { + "format": "int32", + "description": "Priority of the group within the N:Microsoft.MachineLearning.ManagementFrontEnd.Contracts.V20240101Preview.Pools.InferencePools.", + "default": 0, + "type": "integer" + }, + "provisioningState": { + "description": "Provisioning state for the inference group.", + "$ref": "#/definitions/PoolProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "InferenceGroupProperties", + "additionalProperties": false + }, + "InferenceGroupTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/InferenceGroup" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "InferenceGroup", + "additionalProperties": false + }, + "InferenceGroupTrackedResourceArmPaginatedResult": { + "description": "A paginated list of InferenceGroup entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of InferenceGroup objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type InferenceGroup.", + "type": "array", + "items": { + "$ref": "#/definitions/InferenceGroupTrackedResource" + } + } + }, + "additionalProperties": false + }, + "InferencePool": { + "description": "Inference pool configuration", + "required": [ + "nodeSkuType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PropertiesBase" + } + ], + "properties": { + "codeConfiguration": { + "description": "Code configuration for the inference pool.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + }, + "environmentConfiguration": { + "description": "EnvironmentConfiguration for the inference pool.", + "$ref": "#/definitions/PoolEnvironmentConfiguration", + "x-nullable": true + }, + "modelConfiguration": { + "description": "ModelConfiguration for the inference pool.", + "$ref": "#/definitions/PoolModelConfiguration", + "x-nullable": true + }, + "nodeSkuType": { + "description": "[Required] Compute instance type.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state for the pool.", + "$ref": "#/definitions/PoolProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "requestConfiguration": { + "description": "Request configuration for the inference pool.", + "$ref": "#/definitions/RequestConfiguration", + "x-nullable": true + } + }, + "x-ms-client-name": "InferencePoolProperties", + "additionalProperties": false + }, + "InferencePoolTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/InferencePool" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "InferencePool", + "additionalProperties": false + }, + "InferencePoolTrackedResourceArmPaginatedResult": { + "description": "A paginated list of InferencePool entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of InferencePool objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type InferencePool.", + "type": "array", + "items": { + "$ref": "#/definitions/InferencePoolTrackedResource" + } + } + }, + "additionalProperties": false + }, + "InferencingServer": { + "required": [ + "serverType" + ], + "type": "object", + "properties": { + "serverType": { + "description": "[Required] Inferencing server type for various targets.", + "$ref": "#/definitions/InferencingServerType" + } + }, + "discriminator": "serverType" + }, + "InferencingServerType": { + "description": "Inferencing server type for various targets.", + "enum": [ + "AzureMLOnline", + "AzureMLBatch", + "Triton", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "InferencingServerType", + "modelAsString": true, + "values": [ + { + "value": "AzureMLOnline" + }, + { + "value": "AzureMLBatch" + }, + { + "value": "Triton" + }, + { + "value": "Custom" + } + ] + }, + "additionalProperties": false + }, + "InputDeliveryMode": { + "description": "Enum to determine the input data delivery mode.", + "enum": [ + "ReadOnlyMount", + "ReadWriteMount", + "Download", + "Direct", + "EvalMount", + "EvalDownload" + ], + "type": "string", + "x-ms-enum": { + "name": "InputDeliveryMode", + "modelAsString": true, + "values": [ + { + "value": "ReadOnlyMount" + }, + { + "value": "ReadWriteMount" + }, + { + "value": "Download" + }, + { + "value": "Direct" + }, + { + "value": "EvalMount" + }, + { + "value": "EvalDownload" + } + ] + }, + "additionalProperties": false + }, + "InputPathType": { + "description": "Input path type for package inputs.", + "enum": [ + "Url", + "PathId", + "PathVersion" + ], + "type": "string", + "x-ms-enum": { + "name": "InputPathType", + "modelAsString": true, + "values": [ + { + "value": "Url" + }, + { + "value": "PathId" + }, + { + "value": "PathVersion" + } + ] + }, + "additionalProperties": false + }, + "InstanceSegmentationPrimaryMetrics": { + "description": "Primary metrics for InstanceSegmentation tasks.", + "enum": [ + "MeanAveragePrecision" + ], + "type": "string", + "x-ms-enum": { + "name": "InstanceSegmentationPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "MeanAveragePrecision", + "description": "Mean Average Precision (MAP) is the average of AP (Average Precision).\nAP is calculated for each class and averaged to get the MAP." + } + ] + }, + "additionalProperties": false + }, + "IntellectualProperty": { + "description": "Intellectual Property details for a resource.", + "required": [ + "publisher" + ], + "type": "object", + "properties": { + "protectionLevel": { + "description": "Protection level of the Intellectual Property.", + "default": "All", + "$ref": "#/definitions/ProtectionLevel" + }, + "publisher": { + "description": "[Required] Publisher of the Intellectual Property. Must be the same as Registry publisher name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, + "JobBase": { + "description": "Base definition for a job.", + "required": [ + "jobType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "componentId": { + "description": "ARM resource ID of the component resource.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "computeId": { + "description": "ARM resource ID of the compute resource.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "displayName": { + "description": "Display name of job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "experimentName": { + "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.", + "default": "Default", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "identity": { + "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null.\r\nDefaults to AmlToken if null.", + "$ref": "#/definitions/IdentityConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "isArchived": { + "description": "Is the asset archived?", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "jobType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "notificationSetting": { + "description": "Notification setting for the job", + "$ref": "#/definitions/NotificationSetting", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "secretsConfiguration": { + "description": "Configuration for secrets to be made available during runtime.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SecretConfiguration", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "services": { + "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/JobService", + "x-nullable": true + }, + "x-nullable": true + }, + "status": { + "description": "Status of the job.", + "$ref": "#/definitions/JobStatus", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "discriminator": "jobType", + "x-ms-client-name": "JobBaseProperties" + }, + "JobBaseResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/JobBase" + } + }, + "x-ms-client-name": "JobBase", + "additionalProperties": false + }, + "JobBaseResourceArmPaginatedResult": { + "description": "A paginated list of JobBase entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of JobBase objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type JobBase.", + "type": "array", + "items": { + "$ref": "#/definitions/JobBaseResource" + } + } + }, + "additionalProperties": false + }, + "JobInput": { + "description": "Command job definition.", + "required": [ + "jobInputType" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the input.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobInputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobInputType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "jobInputType" + }, + "JobInputType": { + "description": "Enum to determine the Job Input Type.", + "enum": [ + "literal", + "uri_file", + "uri_folder", + "mltable", + "custom_model", + "mlflow_model", + "triton_model" + ], + "type": "string", + "x-ms-enum": { + "name": "JobInputType", + "modelAsString": true, + "values": [ + { + "value": "literal" + }, + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + }, + { + "value": "custom_model" + }, + { + "value": "mlflow_model" + }, + { + "value": "triton_model" + } + ] + }, + "additionalProperties": false + }, + "JobLimits": { + "required": [ + "jobLimitsType" + ], + "type": "object", + "properties": { + "jobLimitsType": { + "description": "[Required] JobLimit type.", + "$ref": "#/definitions/JobLimitsType" + }, + "timeout": { + "format": "duration", + "description": "The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.", + "type": "string", + "x-nullable": true + } + }, + "discriminator": "jobLimitsType" + }, + "JobLimitsType": { + "enum": [ + "Command", + "Sweep" + ], + "type": "string", + "x-ms-enum": { + "name": "JobLimitsType", + "modelAsString": true, + "values": [ + { + "value": "Command" + }, + { + "value": "Sweep" + } + ] + }, + "additionalProperties": false + }, + "JobOutput": { + "description": "Job output definition container information on where to find job output/logs.", + "required": [ + "jobOutputType" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the output.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobOutputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobOutputType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "jobOutputType" + }, + "JobOutputType": { + "description": "Enum to determine the Job Output Type.", + "enum": [ + "uri_file", + "uri_folder", + "mltable", + "custom_model", + "mlflow_model", + "triton_model" + ], + "type": "string", + "x-ms-enum": { + "name": "JobOutputType", + "modelAsString": true, + "values": [ + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + }, + { + "value": "custom_model" + }, + { + "value": "mlflow_model" + }, + { + "value": "triton_model" + } + ] + }, + "additionalProperties": false + }, + "JobProvisioningState": { + "description": "Enum to determine the job provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress" + ], + "type": "string", + "x-ms-enum": { + "name": "JobProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + }, + { + "value": "InProgress" + } + ] + }, + "additionalProperties": false + }, + "JobResourceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceConfiguration" + } + ], + "properties": { + "dockerArgs": { + "description": "Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "shmSize": { + "description": "Size of the docker container's shared memory block. This should be in the format of (number)(unit) where number as to be greater than 0 and the unit can be one of b(bytes), k(kilobytes), m(megabytes), or g(gigabytes).", + "default": "2g", + "pattern": "\\d+[bBkKmMgG]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "JobScheduleAction": { + "required": [ + "actionType", + "jobDefinition" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], + "properties": { + "jobDefinition": { + "description": "[Required] Defines Schedule action definition details.", + "$ref": "#/definitions/JobBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-discriminator-value": "CreateJob", + "additionalProperties": false + }, + "JobService": { + "description": "Job endpoint definition", + "type": "object", + "properties": { + "endpoint": { + "description": "Url for endpoint.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "errorMessage": { + "description": "Any error in the service.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "jobServiceType": { + "description": "Endpoint type.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "nodes": { + "description": "Nodes that user would like to start the service on.\r\nIf Nodes is not set or set to null, the service will only be started on leader node.", + "$ref": "#/definitions/Nodes", + "x-nullable": true + }, + "port": { + "format": "int32", + "description": "Port for endpoint set by user.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "properties": { + "description": "Additional properties to set on the endpoint.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "status": { + "description": "Status of endpoint.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "JobStatus": { + "description": "The status of a job.", + "enum": [ + "NotStarted", + "Starting", + "Provisioning", + "Preparing", + "Queued", + "Running", + "Finalizing", + "CancelRequested", + "Completed", + "Failed", + "Canceled", + "NotResponding", + "Paused", + "Unknown", + "Scheduled" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "Run hasn't started yet." + }, + { + "value": "Starting", + "description": "Run has started. The user has a run ID." + }, + { + "value": "Provisioning", + "description": "(Not used currently) It will be used if ES is creating the compute target." + }, + { + "value": "Preparing", + "description": "The run environment is being prepared." + }, + { + "value": "Queued", + "description": "The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting for all required nodes to be ready." + }, + { + "value": "Running", + "description": "The job started to run in the compute target." + }, + { + "value": "Finalizing", + "description": "Job is completed in the target. It is in output collection state now." + }, + { + "value": "CancelRequested", + "description": "Cancellation has been requested for the job." + }, + { + "value": "Completed", + "description": "Job completed successfully. This reflects that both the job itself and output collection states completed successfully" + }, + { + "value": "Failed", + "description": "Job failed." + }, + { + "value": "Canceled", + "description": "Following cancellation request, the job is now successfully canceled." + }, + { + "value": "NotResponding", + "description": "When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run goes to NotResponding state.\nNotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of the previous states." + }, + { + "value": "Paused", + "description": "The job is paused by users. Some adjustment to labeling jobs can be made only in paused state." + }, + { + "value": "Unknown", + "description": "Default job status if not mapped to all other statuses" + }, + { + "value": "Scheduled", + "description": "The job is in a scheduled state. Job is not in any active state." + } + ] + }, + "additionalProperties": false + }, + "JobTier": { + "description": "Enum to determine the job tier.", + "enum": [ + "Null", + "Spot", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "JobTier", + "modelAsString": true, + "values": [ + { + "value": "Null" + }, + { + "value": "Spot" + }, + { + "value": "Basic" + }, + { + "value": "Standard" + }, + { + "value": "Premium" + } + ] + }, + "additionalProperties": false + }, + "JobType": { + "description": "Enum to determine the type of job.", + "enum": [ + "AutoML", + "Command", + "Labeling", + "Sweep", + "Pipeline", + "Spark", + "FineTuning" + ], + "type": "string", + "x-ms-enum": { + "name": "JobType", + "modelAsString": true, + "values": [ + { + "value": "AutoML" + }, + { + "value": "Command" + }, + { + "value": "Labeling" + }, + { + "value": "Sweep" + }, + { + "value": "Pipeline" + }, + { + "value": "Spark" + }, + { + "value": "FineTuning" + } + ] + }, + "additionalProperties": false + }, + "KerberosCredentials": { + "required": [ + "kerberosKdcAddress", + "kerberosPrincipal", + "kerberosRealm" + ], + "type": "object", + "properties": { + "kerberosKdcAddress": { + "description": "[Required] IP Address or DNS HostName.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "kerberosPrincipal": { + "description": "[Required] Kerberos Username", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "kerberosRealm": { + "description": "[Required] Domain over which a Kerberos authentication server has the authority to authenticate a user, host or service.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "KerberosKeytabCredentials": { + "required": [ + "secrets" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/KerberosCredentials" + }, + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "secrets": { + "description": "[Required] Keytab secrets.", + "$ref": "#/definitions/KerberosKeytabSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "KerberosKeytab", + "additionalProperties": false + }, + "KerberosKeytabSecrets": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "kerberosKeytab": { + "description": "Kerberos keytab secret.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "KerberosKeytab", + "additionalProperties": false + }, + "KerberosPasswordCredentials": { + "required": [ + "secrets" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/KerberosCredentials" + }, + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "secrets": { + "description": "[Required] Kerberos password secrets.", + "$ref": "#/definitions/KerberosPasswordSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "KerberosPassword", + "additionalProperties": false + }, + "KerberosPasswordSecrets": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "kerberosPassword": { + "description": "Kerberos password secret.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "KerberosPassword", + "additionalProperties": false + }, + "KeyType": { + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true, + "values": [ + { + "value": "Primary" + }, + { + "value": "Secondary" + } + ] + }, + "additionalProperties": false + }, + "KubernetesOnlineDeployment": { + "description": "Properties specific to a KubernetesOnlineDeployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineDeployment" + } + ], + "properties": { + "containerResourceRequirements": { + "description": "The resource requirements for the container (cpu and memory).", + "$ref": "#/definitions/ContainerResourceRequirements", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Kubernetes", + "additionalProperties": false + }, + "LabelCategory": { + "description": "Label category definition", + "type": "object", + "properties": { + "classes": { + "description": "Dictionary of label classes in this category.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/LabelClass", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "displayName": { + "description": "Display name of the label category.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "multiSelect": { + "description": "Indicates whether it is allowed to select multiple classes in this category.", + "default": "Disabled", + "$ref": "#/definitions/MultiSelect", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "additionalProperties": false + }, + "LabelClass": { + "description": "Label class definition", + "type": "object", + "properties": { + "displayName": { + "description": "Display name of the label class.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "subclasses": { + "description": "Dictionary of subclasses of the label class.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/LabelClass", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "LabelingDataConfiguration": { + "description": "Labeling data configuration definition", + "type": "object", + "properties": { + "dataId": { + "description": "Resource Id of the data asset to perform labeling.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "incrementalDataRefresh": { + "description": "Indicates whether to enable incremental data refresh.", + "default": "Disabled", + "$ref": "#/definitions/IncrementalDataRefresh", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "additionalProperties": false + }, + "LabelingJob": { + "description": "Labeling job definition", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "createdDateTime": { + "format": "date-time", + "description": "Created time of the job in UTC timezone.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "dataConfiguration": { + "description": "Configuration of data used in the job.", + "$ref": "#/definitions/LabelingDataConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobInstructions": { + "description": "Labeling instructions of the job.", + "$ref": "#/definitions/LabelingJobInstructions", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "labelCategories": { + "description": "Label categories of the job.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/LabelCategory", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "labelingJobMediaProperties": { + "description": "Media type specific properties in the job.", + "$ref": "#/definitions/LabelingJobMediaProperties", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "mlAssistConfiguration": { + "description": "Configuration of MLAssist feature in the job.", + "default": "{\"MLAssist\":\"Disabled\"}", + "$ref": "#/definitions/MLAssistConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "progressMetrics": { + "description": "Progress metrics of the job.", + "$ref": "#/definitions/ProgressMetrics", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "projectId": { + "format": "uuid", + "description": "Internal id of the job(Previously called project).", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "provisioningState": { + "description": "Specifies the labeling job provisioning state.", + "$ref": "#/definitions/JobProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "statusMessages": { + "description": "Status messages of the job.", + "type": "array", + "items": { + "$ref": "#/definitions/StatusMessage" + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "Labeling", + "x-ms-client-name": "LabelingJobProperties", + "additionalProperties": false + }, + "LabelingJobImageProperties": { + "description": "Properties of a labeling job for image data", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LabelingJobMediaProperties" + } + ], + "properties": { + "annotationType": { + "description": "Annotation type of image labeling job.", + "default": "Classification", + "$ref": "#/definitions/ImageAnnotationType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Image", + "additionalProperties": false + }, + "LabelingJobInstructions": { + "description": "Instructions for labeling job", + "type": "object", + "properties": { + "uri": { + "description": "The link to a page with detailed labeling instructions for labelers.", + "type": "string", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "LabelingJobMediaProperties": { + "description": "Properties of a labeling job", + "required": [ + "mediaType" + ], + "type": "object", + "properties": { + "mediaType": { + "description": "[Required] Media type of the job.", + "$ref": "#/definitions/MediaType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mediaType" + }, + "LabelingJobResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/LabelingJob" + } + }, + "x-ms-client-name": "LabelingJob", + "additionalProperties": false + }, + "LabelingJobResourceArmPaginatedResult": { + "description": "A paginated list of LabelingJob entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of LabelingJob objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type LabelingJob.", + "type": "array", + "items": { + "$ref": "#/definitions/LabelingJobResource" + } + } + }, + "additionalProperties": false + }, + "LabelingJobTextProperties": { + "description": "Properties of a labeling job for text data", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LabelingJobMediaProperties" + } + ], + "properties": { + "annotationType": { + "description": "Annotation type of text labeling job.", + "default": "Classification", + "$ref": "#/definitions/TextAnnotationType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Text", + "additionalProperties": false + }, + "LakeHouseArtifact": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OneLakeArtifact" + } + ], + "x-ms-discriminator-value": "LakeHouse", + "additionalProperties": false + }, + "LearningRateScheduler": { + "description": "Learning rate scheduler enum.", + "enum": [ + "None", + "WarmupCosine", + "Step" + ], + "type": "string", + "x-ms-enum": { + "name": "LearningRateScheduler", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No learning rate scheduler selected." + }, + { + "value": "WarmupCosine", + "description": "Cosine Annealing With Warmup." + }, + { + "value": "Step", + "description": "Step learning rate scheduler." + } + ] + }, + "additionalProperties": false + }, + "ListViewType": { + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "type": "string", + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + }, + "additionalProperties": false + }, + "LiteralJobInput": { + "description": "Literal input type.", + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], + "properties": { + "value": { + "description": "[Required] Literal value for the input.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "literal", + "additionalProperties": false + }, + "LogTrainingMetrics": { + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "LogTrainingMetrics", + "modelAsString": true, + "values": [ + { + "value": "Enable", + "description": "Enable compute and log training metrics." + }, + { + "value": "Disable", + "description": "Disable compute and log training metrics." + } + ] + }, + "additionalProperties": false + }, + "LogValidationLoss": { + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "LogValidationLoss", + "modelAsString": true, + "values": [ + { + "value": "Enable", + "description": "Enable compute and log validation metrics." + }, + { + "value": "Disable", + "description": "Disable compute and log validation metrics." + } + ] + }, + "additionalProperties": false + }, + "LogVerbosity": { + "description": "Enum for setting log verbosity.", + "enum": [ + "NotSet", + "Debug", + "Info", + "Warning", + "Error", + "Critical" + ], + "type": "string", + "x-ms-enum": { + "name": "LogVerbosity", + "modelAsString": true, + "values": [ + { + "value": "NotSet", + "description": "No logs emitted." + }, + { + "value": "Debug", + "description": "Debug and above log statements logged." + }, + { + "value": "Info", + "description": "Info and above log statements logged." + }, + { + "value": "Warning", + "description": "Warning and above log statements logged." + }, + { + "value": "Error", + "description": "Error and above log statements logged." + }, + { + "value": "Critical", + "description": "Only critical statements logged." + } + ] + }, + "additionalProperties": false + }, + "MLAssistConfiguration": { + "description": "Labeling MLAssist configuration definition", + "required": [ + "mlAssist" + ], + "type": "object", + "properties": { + "mlAssist": { + "description": "[Required] Indicates whether MLAssist feature is enabled.", + "$ref": "#/definitions/MLAssistConfigurationType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "discriminator": "mlAssist" + }, + "MLAssistConfigurationDisabled": { + "description": "Labeling MLAssist configuration definition when MLAssist is disabled", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MLAssistConfiguration" + } + ], + "x-ms-discriminator-value": "Disabled", + "additionalProperties": false + }, + "MLAssistConfigurationEnabled": { + "description": "Labeling MLAssist configuration definition when MLAssist is enabled", + "required": [ + "inferencingComputeBinding", + "trainingComputeBinding" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MLAssistConfiguration" + } + ], + "properties": { + "inferencingComputeBinding": { + "description": "[Required] AML compute binding used in inferencing.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "trainingComputeBinding": { + "description": "[Required] AML compute binding used in training.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-discriminator-value": "Enabled", + "additionalProperties": false + }, + "MLAssistConfigurationType": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MLAssistConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "MLFlowAutologgerState": { + "description": "Enum to determine the state of mlflow autologger.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MLFlowAutologgerState", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "MLFlowModelJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "mlflow_model", + "additionalProperties": false + }, + "MLFlowModelJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "mlflow_model", + "additionalProperties": false + }, + "MLTableData": { + "description": "MLTable data definition", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataVersionBase" + } + ], + "properties": { + "referencedUris": { + "description": "Uris referenced in the MLTable definition (required for lineage)", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "mltable", + "additionalProperties": false + }, + "MLTableJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "mltable", + "additionalProperties": false + }, + "MLTableJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "mltable", + "additionalProperties": false + }, + "ManagedComputeIdentity": { + "description": "Managed compute identity definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitorComputeIdentityBase" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "ManagedIdentity", + "additionalProperties": false + }, + "ManagedIdentity": { + "description": "Managed identity configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IdentityConfiguration" + } + ], + "properties": { + "clientId": { + "format": "uuid", + "description": "Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "objectId": { + "format": "uuid", + "description": "Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resourceId": { + "description": "Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Managed", + "additionalProperties": false + }, + "ManagedIdentityCredential": { + "description": "Credential for user managed identity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataReferenceCredential" + } + ], + "properties": { + "managedIdentityType": { + "description": "ManagedIdentityCredential identity type", + "type": "string", + "x-nullable": true + }, + "userManagedIdentityClientId": { + "description": "ClientId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", + "type": "string", + "x-nullable": true + }, + "userManagedIdentityPrincipalId": { + "description": "PrincipalId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", + "type": "string", + "x-nullable": true + }, + "userManagedIdentityResourceId": { + "description": "Full arm scope for the Id. For ManagedIdentityType = SystemManaged, this field is null.", + "type": "string", + "x-nullable": true + }, + "userManagedIdentityTenantId": { + "description": "TenantId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "ManagedIdentity", + "additionalProperties": false + }, + "ManagedOnlineDeployment": { + "description": "Properties specific to a ManagedOnlineDeployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineDeployment" + } + ], + "x-ms-discriminator-value": "Managed", + "additionalProperties": false + }, + "MarketplacePlan": { + "type": "object", + "properties": { + "offerId": { + "description": "The Offer ID of the Marketplace Plan.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "planId": { + "description": "The Plan ID of the Marketplace Plan.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "publisherId": { + "description": "The Publisher ID of the Marketplace Plan.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "MarketplaceSubscription": { + "required": [ + "modelId" + ], + "type": "object", + "properties": { + "marketplacePlan": { + "description": "Marketplace Plan associated with the Marketplace Subscription.", + "$ref": "#/definitions/MarketplacePlan", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "marketplaceSubscriptionStatus": { + "description": "Current status of the Marketplace Subscription.", + "$ref": "#/definitions/MarketplaceSubscriptionStatus", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "modelId": { + "description": "[Required] Target Marketplace Model ID to create a Marketplace Subscription for.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning State of the Marketplace Subscription.", + "$ref": "#/definitions/MarketplaceSubscriptionProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "MarketplaceSubscriptionProperties", + "additionalProperties": false + }, + "MarketplaceSubscriptionProvisioningState": { + "enum": [ + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Updating", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MarketplaceSubscriptionProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating", + "description": "MarketplaceSubscription is being created." + }, + { + "value": "Deleting", + "description": "MarketplaceSubscription is being deleted." + }, + { + "value": "Succeeded", + "description": "MarketplaceSubscription is successfully provisioned." + }, + { + "value": "Failed", + "description": "MarketplaceSubscription provisioning failed." + }, + { + "value": "Updating", + "description": "MarketplaceSubscription is being updated." + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "MarketplaceSubscriptionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/MarketplaceSubscription" + } + }, + "x-ms-client-name": "MarketplaceSubscription", + "additionalProperties": false + }, + "MarketplaceSubscriptionResourceArmPaginatedResult": { + "description": "A paginated list of MarketplaceSubscription entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of MarketplaceSubscription objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type MarketplaceSubscription.", + "type": "array", + "items": { + "$ref": "#/definitions/MarketplaceSubscriptionResource" + } + } + }, + "additionalProperties": false + }, + "MarketplaceSubscriptionStatus": { + "enum": [ + "PendingFulfillmentStart", + "Subscribed", + "Suspended", + "Unsubscribed" + ], + "type": "string", + "x-ms-enum": { + "name": "MarketplaceSubscriptionStatus", + "modelAsString": true, + "values": [ + { + "value": "PendingFulfillmentStart", + "description": "The Marketplace Subscription is being fulfilled." + }, + { + "value": "Subscribed", + "description": "The customer can now use the Marketplace Subscription's\nmodel and will be billed." + }, + { + "value": "Suspended", + "description": "The customer could not be billed for the Marketplace Subscription.\nThe customer will not be able to access the model." + }, + { + "value": "Unsubscribed", + "description": "Marketplace Subscriptions reach this state in response to an explicit customer or CSP action.\nA Marketplace Subscription can also be canceled implicitly, as a result of nonpayment of dues,\nafter being in the Suspended state for some time." + } + ] + }, + "additionalProperties": false + }, + "MaterializationComputeResource": { + "description": "Dto object representing compute resource", + "type": "object", + "properties": { + "instanceType": { + "description": "Specifies the instance type", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "MaterializationSettings": { + "type": "object", + "properties": { + "notification": { + "description": "Specifies the notification details", + "$ref": "#/definitions/NotificationSetting", + "x-nullable": true + }, + "resource": { + "description": "Specifies the compute resource settings", + "$ref": "#/definitions/MaterializationComputeResource", + "x-nullable": true + }, + "schedule": { + "description": "Specifies the schedule details", + "$ref": "#/definitions/RecurrenceTrigger", + "x-nullable": true + }, + "sparkConfiguration": { + "description": "Specifies the spark compute settings", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "storeType": { + "description": "Specifies the stores to which materialization should happen", + "default": "None", + "$ref": "#/definitions/MaterializationStoreType" + } + }, + "additionalProperties": false + }, + "MaterializationStoreType": { + "enum": [ + "None", + "Online", + "Offline", + "OnlineAndOffline" + ], + "type": "string", + "x-ms-enum": { + "name": "MaterializationStoreType", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "Online" + }, + { + "value": "Offline" + }, + { + "value": "OnlineAndOffline" + } + ] + }, + "additionalProperties": false + }, + "MediaType": { + "description": "Media type of data asset.", + "enum": [ + "Image", + "Text" + ], + "type": "string", + "x-ms-enum": { + "name": "MediaType", + "modelAsString": true, + "values": [ + { + "value": "Image" + }, + { + "value": "Text" + } + ] + }, + "additionalProperties": false + }, + "MedianStoppingPolicy": { + "description": "Defines an early termination policy based on running averages of the primary metric of all runs", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EarlyTerminationPolicy" + } + ], + "x-ms-discriminator-value": "MedianStopping", + "additionalProperties": false + }, + "ModelConfiguration": { + "description": "Model configuration options.", + "type": "object", + "properties": { + "mode": { + "description": "Input delivery mode for the model.", + "default": "Download", + "$ref": "#/definitions/PackageInputDeliveryMode" + }, + "mountPath": { + "description": "Relative mounting path of the model in the target image.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ModelContainer": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the model container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "ModelContainerProperties", + "additionalProperties": false + }, + "ModelContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ModelContainer" + } + }, + "x-ms-client-name": "ModelContainer", + "additionalProperties": false + }, + "ModelContainerResourceArmPaginatedResult": { + "description": "A paginated list of ModelContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ModelContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ModelContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelContainerResource" + } + } + }, + "additionalProperties": false + }, + "ModelPackageInput": { + "description": "Model package input options.", + "required": [ + "inputType", + "path" + ], + "type": "object", + "properties": { + "inputType": { + "description": "[Required] Type of the input included in the target image.", + "$ref": "#/definitions/PackageInputType" + }, + "mode": { + "description": "Input delivery mode of the input.", + "default": "Copy", + "$ref": "#/definitions/PackageInputDeliveryMode" + }, + "mountPath": { + "description": "Relative mount path of the input in the target image.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "[Required] Location of the input.", + "$ref": "#/definitions/PackageInputPathBase" + } + }, + "additionalProperties": false + }, + "ModelPerformanceMetricThresholdBase": { + "required": [ + "modelType" + ], + "type": "object", + "properties": { + "modelType": { + "description": "[Required] Specifies the data type of the metric threshold.", + "$ref": "#/definitions/MonitoringModelType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "discriminator": "modelType" + }, + "ModelPerformanceSignal": { + "description": "Model performance signal definition.", + "required": [ + "metricThreshold", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "dataSegment": { + "description": "The data segment.", + "$ref": "#/definitions/MonitoringDataSegment", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThreshold": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "$ref": "#/definitions/ModelPerformanceMetricThresholdBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "productionData": { + "description": "[Required] The data produced by the production service which performance will be calculated for.", + "type": "array", + "items": { + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "referenceData": { + "description": "[Required] The reference data used as the basis to calculate model performance.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "ModelPerformance", + "additionalProperties": false + }, + "ModelProvider": { + "description": "Enum to determine the type of fine tuning.", + "enum": [ + "AzureOpenAI", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ModelProvider", + "modelAsString": true, + "values": [ + { + "value": "AzureOpenAI", + "description": "Fine tuning using Azure Open AI model." + }, + { + "value": "Custom", + "description": "Fine tuning using custom model." + } + ] + }, + "additionalProperties": false + }, + "ModelSettings": { + "required": [ + "modelId" + ], + "type": "object", + "properties": { + "modelId": { + "description": "[Required] ", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, + "ModelSize": { + "description": "Image model size.", + "enum": [ + "None", + "Small", + "Medium", + "Large", + "ExtraLarge" + ], + "type": "string", + "x-ms-enum": { + "name": "ModelSize", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No value selected." + }, + { + "value": "Small", + "description": "Small size." + }, + { + "value": "Medium", + "description": "Medium size." + }, + { + "value": "Large", + "description": "Large size." + }, + { + "value": "ExtraLarge", + "description": "Extra large size." + } + ] + }, + "additionalProperties": false + }, + "ModelTaskType": { + "description": "Model task type enum.", + "enum": [ + "Classification", + "Regression", + "QuestionAnswering" + ], + "type": "string", + "x-ms-enum": { + "name": "ModelTaskType", + "modelAsString": true, + "values": [ + { + "value": "Classification" + }, + { + "value": "Regression" + }, + { + "value": "QuestionAnswering" + } + ] + }, + "additionalProperties": false + }, + "ModelVersion": { + "description": "Model asset version details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "flavors": { + "description": "Mapping of model flavors to their properties.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FlavorData", + "x-nullable": true + }, + "x-nullable": true + }, + "intellectualProperty": { + "description": "Intellectual Property details. Used if model is an Intellectual Property.", + "$ref": "#/definitions/IntellectualProperty", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobName": { + "description": "Name of the training job which produced this model", + "type": "string", + "x-nullable": true + }, + "modelType": { + "description": "The storage format for this entity. Used for NCD.", + "type": "string", + "x-nullable": true + }, + "modelUri": { + "description": "The URI path to the model contents.", + "type": "string", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the model version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "stage": { + "description": "Stage in the model lifecycle assigned to this model", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ModelVersionProperties", + "additionalProperties": false + }, + "ModelVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ModelVersion" + } + }, + "x-ms-client-name": "ModelVersion", + "additionalProperties": false + }, + "ModelVersionResourceArmPaginatedResult": { + "description": "A paginated list of ModelVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ModelVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ModelVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelVersionResource" + } + } + }, + "additionalProperties": false + }, + "MonitorComputeConfigurationBase": { + "description": "Monitor compute configuration base definition.", + "required": [ + "computeType" + ], + "type": "object", + "properties": { + "computeType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitorComputeType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "computeType" + }, + "MonitorComputeIdentityBase": { + "description": "Monitor compute identity base definition.", + "required": [ + "computeIdentityType" + ], + "type": "object", + "properties": { + "computeIdentityType": { + "description": "[Required] Monitor compute identity type enum.", + "$ref": "#/definitions/MonitorComputeIdentityType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "computeIdentityType" + }, + "MonitorComputeIdentityType": { + "description": "Monitor compute identity type enum.", + "enum": [ + "AmlToken", + "ManagedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitorComputeIdentityType", + "modelAsString": true, + "values": [ + { + "value": "AmlToken", + "description": "Authenticates through user's AML token." + }, + { + "value": "ManagedIdentity", + "description": "Authenticates through a user-provided managed identity." + } + ] + }, + "additionalProperties": false + }, + "MonitorComputeType": { + "description": "Monitor compute type enum.", + "enum": [ + "ServerlessSpark" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitorComputeType", + "modelAsString": true, + "values": [ + { + "value": "ServerlessSpark", + "description": "Serverless Spark compute." + } + ] + }, + "additionalProperties": false + }, + "MonitorDefinition": { + "required": [ + "computeConfiguration", + "signals" + ], + "type": "object", + "properties": { + "alertNotificationSettings": { + "description": "The monitor's notification settings.", + "$ref": "#/definitions/MonitorNotificationSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "computeConfiguration": { + "description": "[Required] The ARM resource ID of the compute resource to run the monitoring job on.", + "$ref": "#/definitions/MonitorComputeConfigurationBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "monitoringTarget": { + "description": "The ARM resource ID of either the model or deployment targeted by this monitor.", + "$ref": "#/definitions/MonitoringTarget", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "signals": { + "description": "[Required] The signals to monitor.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringSignalBase", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "MonitorEmailNotificationSettings": { + "type": "object", + "properties": { + "emails": { + "description": "This is the email recipient list which has a limitation of 499 characters in total.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "MonitorNotificationSettings": { + "type": "object", + "properties": { + "emailNotificationSettings": { + "description": "The AML notification email settings.", + "$ref": "#/definitions/MonitorEmailNotificationSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "MonitorServerlessSparkCompute": { + "description": "Monitor serverless spark compute definition.", + "required": [ + "computeIdentity", + "instanceType", + "runtimeVersion" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitorComputeConfigurationBase" + } + ], + "properties": { + "computeIdentity": { + "description": "[Required] The identity scheme leveraged to by the spark jobs running on serverless Spark.", + "$ref": "#/definitions/MonitorComputeIdentityBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "instanceType": { + "description": "[Required] The instance type running the Spark job.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "runtimeVersion": { + "description": "[Required] The Spark runtime version.", + "minLength": 1, + "pattern": "^[0-9]+\\.[0-9]+$", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "ServerlessSpark", + "additionalProperties": false + }, + "MonitoringDataSegment": { + "type": "object", + "properties": { + "feature": { + "description": "The feature to segment the data on.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "values": { + "description": "Filters for only the specified values of the given segmented feature.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "MonitoringFeatureDataType": { + "enum": [ + "Numerical", + "Categorical" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringFeatureDataType", + "modelAsString": true, + "values": [ + { + "value": "Numerical", + "description": "Used for features of numerical data type." + }, + { + "value": "Categorical", + "description": "Used for features of categorical data type." + } + ] + }, + "additionalProperties": false + }, + "MonitoringFeatureFilterBase": { + "required": [ + "filterType" + ], + "type": "object", + "properties": { + "filterType": { + "description": "[Required] Specifies the feature filter to leverage when selecting features to calculate metrics over.", + "$ref": "#/definitions/MonitoringFeatureFilterType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "filterType" + }, + "MonitoringFeatureFilterType": { + "enum": [ + "AllFeatures", + "TopNByAttribution", + "FeatureSubset" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringFeatureFilterType", + "modelAsString": true, + "values": [ + { + "value": "AllFeatures", + "description": "Includes all features." + }, + { + "value": "TopNByAttribution", + "description": "Only includes the top contributing features, measured by feature attribution." + }, + { + "value": "FeatureSubset", + "description": "Includes a user-defined subset of features." + } + ] + }, + "additionalProperties": false + }, + "MonitoringInputDataBase": { + "description": "Monitoring input data base definition.", + "required": [ + "inputDataType", + "jobInputType", + "uri" + ], + "type": "object", + "properties": { + "columns": { + "description": "Mapping of column names to special uses.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "dataContext": { + "description": "The context metadata of the data source.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputDataType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitoringInputDataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "jobInputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobInputType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "uri": { + "description": "[Required] Input Asset URI.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "inputDataType" + }, + "MonitoringInputDataType": { + "description": "Monitoring input data type enum.", + "enum": [ + "Static", + "Rolling", + "Fixed" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringInputDataType", + "modelAsString": true, + "values": [ + { + "value": "Static", + "description": "An input data with a fixed window size." + }, + { + "value": "Rolling", + "description": "An input data which rolls relatively to the monitor's current run time." + }, + { + "value": "Fixed", + "description": "An input data with tabular format which doesn't require preprocessing." + } + ] + }, + "additionalProperties": false + }, + "MonitoringModelType": { + "enum": [ + "Classification", + "Regression" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringModelType", + "modelAsString": true, + "values": [ + { + "value": "Classification", + "description": "A model trained for classification tasks." + }, + { + "value": "Regression", + "description": "A model trained for regressions tasks." + } + ] + }, + "additionalProperties": false + }, + "MonitoringNotificationType": { + "enum": [ + "AmlNotification", + "AzureMonitor" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringNotificationType", + "modelAsString": true, + "values": [ + { + "value": "AmlNotification", + "description": "Enables email notifications through AML notifications." + }, + { + "value": "AzureMonitor", + "description": "Enables notifications through Azure Monitor by posting metrics to the workspace's Azure Monitor instance." + } + ] + }, + "additionalProperties": false + }, + "MonitoringSignalBase": { + "required": [ + "signalType" + ], + "type": "object", + "properties": { + "notificationTypes": { + "description": "The current notification mode for this signal.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoringNotificationType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "signalType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitoringSignalType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "signalType" + }, + "MonitoringSignalType": { + "enum": [ + "DataDrift", + "PredictionDrift", + "DataQuality", + "FeatureAttributionDrift", + "Custom", + "ModelPerformance", + "GenerationSafetyQuality", + "GenerationTokenStatistics" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringSignalType", + "modelAsString": true, + "values": [ + { + "value": "DataDrift", + "description": "Tracks model input data distribution change, comparing against training data or past production data." + }, + { + "value": "PredictionDrift", + "description": "Tracks prediction result data distribution change, comparing against validation/test label data or past production data." + }, + { + "value": "DataQuality", + "description": "Tracks model input data integrity." + }, + { + "value": "FeatureAttributionDrift", + "description": "Tracks feature importance change in production, comparing against feature importance at training time." + }, + { + "value": "Custom", + "description": "Tracks a custom signal provided by users." + }, + { + "value": "ModelPerformance", + "description": "Tracks model performance based on ground truth data." + }, + { + "value": "GenerationSafetyQuality", + "description": "Tracks the safety and quality of generated content." + }, + { + "value": "GenerationTokenStatistics", + "description": "Tracks the token usage of generative endpoints." + } + ] + }, + "additionalProperties": false + }, + "MonitoringTarget": { + "description": "Monitoring target definition.", + "required": [ + "taskType" + ], + "type": "object", + "properties": { + "deploymentId": { + "description": "The ARM resource ID of either the deployment targeted by this monitor.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "modelId": { + "description": "The ARM resource ID of either the model targeted by this monitor.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "taskType": { + "description": "[Required] The machine learning task type of the model.", + "$ref": "#/definitions/ModelTaskType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "MonitoringThreshold": { + "type": "object", + "properties": { + "value": { + "format": "double", + "description": "The threshold value. If null, the set default is dependent on the metric type.", + "type": "number", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "MonitoringWorkspaceConnection": { + "description": "Monitoring workspace connection definition.", + "type": "object", + "properties": { + "environmentVariables": { + "description": "The properties of a workspace service connection to store as environment variables in the submitted jobs.\r\nKey is workspace connection property path, name is environment variable key.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "secrets": { + "description": "The properties of a workspace service connection to store as secrets in the submitted jobs.\r\nKey is workspace connection property path, name is secret key.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "Mpi": { + "description": "MPI distribution configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + } + ], + "properties": { + "processCountPerInstance": { + "format": "int32", + "description": "Number of processes per MPI node.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Mpi", + "additionalProperties": false + }, + "MultiSelect": { + "description": "Whether multiSelect is enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiSelect", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "NCrossValidations": { + "description": "N-Cross validations value.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Mode for determining N-Cross validations.", + "$ref": "#/definitions/NCrossValidationsMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "NCrossValidationsMode": { + "description": "Determines how N-Cross validations value is determined.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "NCrossValidationsMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Determine N-Cross validations value automatically. Supported only for 'Forecasting' AutoML task." + }, + { + "value": "Custom", + "description": "Use custom N-Cross validations value." + } + ] + }, + "additionalProperties": false + }, + "NlpFixedParameters": { + "description": "Fixed training parameters that won't be swept over during AutoML NLP training.", + "type": "object", + "properties": { + "gradientAccumulationSteps": { + "format": "int32", + "description": "Number of steps to accumulate gradients over before running a backward pass.", + "type": "integer", + "x-nullable": true + }, + "learningRate": { + "format": "float", + "description": "The learning rate for the training procedure.", + "type": "number", + "x-nullable": true + }, + "learningRateScheduler": { + "description": "The type of learning rate schedule to use during the training procedure.", + "default": "None", + "$ref": "#/definitions/NlpLearningRateScheduler" + }, + "modelName": { + "description": "The name of the model to train.", + "type": "string", + "x-nullable": true + }, + "numberOfEpochs": { + "format": "int32", + "description": "Number of training epochs.", + "type": "integer", + "x-nullable": true + }, + "trainingBatchSize": { + "format": "int32", + "description": "The batch size for the training procedure.", + "type": "integer", + "x-nullable": true + }, + "validationBatchSize": { + "format": "int32", + "description": "The batch size to be used during evaluation.", + "type": "integer", + "x-nullable": true + }, + "warmupRatio": { + "format": "float", + "description": "The warmup ratio, used alongside LrSchedulerType.", + "type": "number", + "x-nullable": true + }, + "weightDecay": { + "format": "float", + "description": "The weight decay for the training procedure.", + "type": "number", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "NlpLearningRateScheduler": { + "description": "Enum of learning rate schedulers that aligns with those supported by HF", + "enum": [ + "None", + "Linear", + "Cosine", + "CosineWithRestarts", + "Polynomial", + "Constant", + "ConstantWithWarmup" + ], + "type": "string", + "x-ms-enum": { + "name": "NlpLearningRateScheduler", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No learning rate schedule." + }, + { + "value": "Linear", + "description": "Linear warmup and decay." + }, + { + "value": "Cosine", + "description": "Linear warmup then cosine decay." + }, + { + "value": "CosineWithRestarts", + "description": "Linear warmup, cosine decay, then restart to initial LR." + }, + { + "value": "Polynomial", + "description": "Increase linearly then polynomially decay." + }, + { + "value": "Constant", + "description": "Constant learning rate." + }, + { + "value": "ConstantWithWarmup", + "description": "Linear warmup followed by constant value." + } + ] + }, + "additionalProperties": false + }, + "NlpParameterSubspace": { + "description": "Stringified search spaces for each parameter. See below examples.", + "type": "object", + "properties": { + "gradientAccumulationSteps": { + "description": "Number of steps to accumulate gradients over before running a backward pass.", + "type": "string", + "example": "choice(1, 2)", + "x-nullable": true + }, + "learningRate": { + "description": "The learning rate for the training procedure.", + "type": "string", + "example": "uniform(5e-6, 5e-5)", + "x-nullable": true + }, + "learningRateScheduler": { + "description": "The type of learning rate schedule to use during the training procedure.", + "type": "string", + "example": "choice('linear', 'cosine')", + "x-nullable": true + }, + "modelName": { + "description": "The name of the model to train.", + "type": "string", + "example": "choice('bert-base-cased', 'roberta-base')", + "x-nullable": true + }, + "numberOfEpochs": { + "description": "Number of training epochs.", + "type": "string", + "example": "choice(3, 4)", + "x-nullable": true + }, + "trainingBatchSize": { + "description": "The batch size for the training procedure.", + "type": "string", + "example": "choice(16, 32)", + "x-nullable": true + }, + "validationBatchSize": { + "description": "The batch size to be used during evaluation.", + "type": "string", + "example": "choice(16, 32)", + "x-nullable": true + }, + "warmupRatio": { + "description": "The warmup ratio, used alongside LrSchedulerType.", + "type": "string", + "example": "uniform(0.01, 0.1)", + "x-nullable": true + }, + "weightDecay": { + "description": "The weight decay for the training procedure.", + "type": "string", + "example": "uniform(0.01, 0.1)", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "NlpSweepSettings": { + "description": "Model sweeping and hyperparameter tuning related settings.", + "required": [ + "samplingAlgorithm" + ], + "type": "object", + "properties": { + "earlyTermination": { + "description": "Type of early termination policy for the sweeping job.", + "$ref": "#/definitions/EarlyTerminationPolicy", + "x-nullable": true + }, + "samplingAlgorithm": { + "description": "[Required] Type of sampling algorithm.", + "$ref": "#/definitions/SamplingAlgorithmType" + } + }, + "additionalProperties": false + }, + "NlpVertical": { + "description": "Abstract class for NLP related AutoML tasks.\r\nNLP - Natural Language Processing.", + "type": "object", + "properties": { + "featurizationSettings": { + "description": "Featurization inputs needed for AutoML job.", + "$ref": "#/definitions/NlpVerticalFeaturizationSettings", + "x-nullable": true + }, + "fixedParameters": { + "description": "Model/training parameters that will remain constant throughout training.", + "$ref": "#/definitions/NlpFixedParameters", + "x-nullable": true + }, + "limitSettings": { + "description": "Execution constraints for AutoMLJob.", + "$ref": "#/definitions/NlpVerticalLimitSettings", + "x-nullable": true + }, + "searchSpace": { + "description": "Search space for sampling different combinations of models and their hyperparameters.", + "type": "array", + "items": { + "$ref": "#/definitions/NlpParameterSubspace" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "sweepSettings": { + "description": "Settings for model sweeping and hyperparameter tuning.", + "$ref": "#/definitions/NlpSweepSettings", + "x-nullable": true + }, + "validationData": { + "description": "Validation data inputs.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "NlpVerticalFeaturizationSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeaturizationSettings" + } + ], + "additionalProperties": false + }, + "NlpVerticalLimitSettings": { + "description": "Job execution constraints.", + "type": "object", + "properties": { + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum Concurrent AutoML iterations.", + "default": 1, + "type": "integer" + }, + "maxNodes": { + "format": "int32", + "description": "Maximum nodes to use for the experiment.", + "default": 1, + "type": "integer" + }, + "maxTrials": { + "format": "int32", + "description": "Number of AutoML iterations.", + "default": 1, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "P7D", + "type": "string" + }, + "trialTimeout": { + "format": "duration", + "description": "Timeout for individual HD trials.", + "type": "string" + } + }, + "additionalProperties": false + }, + "Nodes": { + "description": "Abstract Nodes definition", + "required": [ + "nodesValueType" + ], + "type": "object", + "properties": { + "nodesValueType": { + "description": "[Required] Type of the Nodes value", + "$ref": "#/definitions/NodesValueType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "nodesValueType" + }, + "NodesValueType": { + "description": "The enumerated types for the nodes value", + "enum": [ + "All", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "NodesValueType", + "modelAsString": true, + "values": [ + { + "value": "All" + }, + { + "value": "Custom" + } + ] + }, + "additionalProperties": false + }, + "NoneDatastoreCredentials": { + "description": "Empty/none datastore credentials.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "x-ms-discriminator-value": "None", + "additionalProperties": false + }, + "NotificationSetting": { + "description": "Configuration for notification.", + "type": "object", + "properties": { + "emailOn": { + "description": "Send email notification to user on specified notification type", + "type": "array", + "items": { + "$ref": "#/definitions/EmailNotificationEnableType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "emails": { + "description": "This is the email recipient list which has a limitation of 499 characters in total concat with comma separator", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "webhooks": { + "description": "Send webhook callback to a service. Key is a user-provided name for the webhook.", + "type": "object", + "additionalProperties": { + "description": "Webhook base", + "$ref": "#/definitions/Webhook", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "NumericalDataDriftMetric": { + "enum": [ + "JensenShannonDistance", + "PopulationStabilityIndex", + "NormalizedWassersteinDistance", + "TwoSampleKolmogorovSmirnovTest" + ], + "type": "string", + "x-ms-enum": { + "name": "NumericalDataDriftMetric", + "modelAsString": true, + "values": [ + { + "value": "JensenShannonDistance", + "description": "The Jensen Shannon Distance (JSD) metric." + }, + { + "value": "PopulationStabilityIndex", + "description": "The Population Stability Index (PSI) metric." + }, + { + "value": "NormalizedWassersteinDistance", + "description": "The Normalized Wasserstein Distance metric." + }, + { + "value": "TwoSampleKolmogorovSmirnovTest", + "description": "The Two Sample Kolmogorov-Smirnov Test (two-sample K–S) metric." + } + ] + }, + "additionalProperties": false + }, + "NumericalDataDriftMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataDriftMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The numerical data drift metric to calculate.", + "$ref": "#/definitions/NumericalDataDriftMetric" + } + }, + "x-ms-discriminator-value": "Numerical", + "additionalProperties": false + }, + "NumericalDataQualityMetric": { + "enum": [ + "NullValueRate", + "DataTypeErrorRate", + "OutOfBoundsRate" + ], + "type": "string", + "x-ms-enum": { + "name": "NumericalDataQualityMetric", + "modelAsString": true, + "values": [ + { + "value": "NullValueRate", + "description": "Calculates the rate of null values." + }, + { + "value": "DataTypeErrorRate", + "description": "Calculates the rate of data type errors." + }, + { + "value": "OutOfBoundsRate", + "description": "Calculates the rate values are out of bounds." + } + ] + }, + "additionalProperties": false + }, + "NumericalDataQualityMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataQualityMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The numerical data quality metric to calculate.", + "$ref": "#/definitions/NumericalDataQualityMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Numerical", + "additionalProperties": false + }, + "NumericalPredictionDriftMetric": { + "enum": [ + "JensenShannonDistance", + "PopulationStabilityIndex", + "NormalizedWassersteinDistance", + "TwoSampleKolmogorovSmirnovTest" + ], + "type": "string", + "x-ms-enum": { + "name": "NumericalPredictionDriftMetric", + "modelAsString": true, + "values": [ + { + "value": "JensenShannonDistance", + "description": "The Jensen Shannon Distance (JSD) metric." + }, + { + "value": "PopulationStabilityIndex", + "description": "The Population Stability Index (PSI) metric." + }, + { + "value": "NormalizedWassersteinDistance", + "description": "The Normalized Wasserstein Distance metric." + }, + { + "value": "TwoSampleKolmogorovSmirnovTest", + "description": "The Two Sample Kolmogorov-Smirnov Test (two-sample K–S) metric." + } + ] + }, + "additionalProperties": false + }, + "NumericalPredictionDriftMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PredictionDriftMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The numerical prediction drift metric to calculate.", + "$ref": "#/definitions/NumericalPredictionDriftMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Numerical", + "additionalProperties": false + }, + "ObjectDetectionPrimaryMetrics": { + "description": "Primary metrics for Image ObjectDetection task.", + "enum": [ + "MeanAveragePrecision" + ], + "type": "string", + "x-ms-enum": { + "name": "ObjectDetectionPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "MeanAveragePrecision", + "description": "Mean Average Precision (MAP) is the average of AP (Average Precision).\nAP is calculated for each class and averaged to get the MAP." + } + ] + }, + "additionalProperties": false + }, + "Objective": { + "description": "Optimization objective.", + "required": [ + "goal", + "primaryMetric" + ], + "type": "object", + "properties": { + "goal": { + "description": "[Required] Defines supported metric goals for hyperparameter tuning", + "$ref": "#/definitions/Goal" + }, + "primaryMetric": { + "description": "[Required] Name of the metric to optimize.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, + "OneLakeArtifact": { + "description": "OneLake artifact (data source) configuration.", + "required": [ + "artifactName", + "artifactType" + ], + "type": "object", + "properties": { + "artifactName": { + "description": "[Required] OneLake artifact name", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "artifactType": { + "description": "[Required] OneLake artifact type", + "$ref": "#/definitions/OneLakeArtifactType" + } + }, + "discriminator": "artifactType" + }, + "OneLakeArtifactType": { + "description": "Enum to determine OneLake artifact type.", + "enum": [ + "LakeHouse" + ], + "type": "string", + "x-ms-enum": { + "name": "OneLakeArtifactType", + "modelAsString": true, + "values": [ + { + "value": "LakeHouse" + } + ] + }, + "additionalProperties": false + }, + "OneLakeDatastore": { + "description": "OneLake (Trident) datastore configuration.", + "required": [ + "artifact", + "oneLakeWorkspaceName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "artifact": { + "description": "[Required] OneLake artifact backing the datastore.", + "$ref": "#/definitions/OneLakeArtifact", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "endpoint": { + "description": "OneLake endpoint to use for the datastore.", + "type": "string", + "example": "data.microsoft.com", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "oneLakeWorkspaceName": { + "description": "[Required] OneLake workspace name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "OneLake", + "additionalProperties": false + }, + "OnlineDeployment": { + "required": [ + "endpointComputeType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointDeploymentPropertiesBase" + } + ], + "properties": { + "appInsightsEnabled": { + "description": "If true, enables Application Insights logging.", + "default": false, + "type": "boolean" + }, + "dataCollector": { + "description": "The mdc configuration, we disable mdc when it's null.", + "$ref": "#/definitions/DataCollector", + "x-nullable": true + }, + "egressPublicNetworkAccess": { + "description": "If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.", + "default": "Enabled", + "$ref": "#/definitions/EgressPublicNetworkAccessType" + }, + "endpointComputeType": { + "description": "[Required] The compute type of the endpoint.", + "$ref": "#/definitions/EndpointComputeType" + }, + "instanceType": { + "description": "Compute instance type.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "livenessProbe": { + "description": "Liveness probe monitors the health of the container regularly.", + "$ref": "#/definitions/ProbeSettings", + "x-nullable": true + }, + "model": { + "description": "The URI path to the model.", + "type": "string", + "x-nullable": true + }, + "modelMountPath": { + "description": "The path to mount the model in custom container.", + "type": "string", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint deployment.", + "$ref": "#/definitions/DeploymentProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "readinessProbe": { + "description": "Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.", + "$ref": "#/definitions/ProbeSettings", + "x-nullable": true + }, + "requestSettings": { + "description": "Request settings for the deployment.", + "$ref": "#/definitions/OnlineRequestSettings", + "x-nullable": true + }, + "scaleSettings": { + "description": "Scale settings for the deployment.\r\nIf it is null or not provided,\r\nit defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment\r\nand to DefaultScaleSettings for ManagedOnlineDeployment.", + "$ref": "#/definitions/OnlineScaleSettings", + "x-nullable": true + } + }, + "discriminator": "endpointComputeType", + "x-ms-client-name": "OnlineDeploymentProperties" + }, + "OnlineDeploymentTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/OnlineDeployment" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "OnlineDeployment", + "additionalProperties": false + }, + "OnlineDeploymentTrackedResourceArmPaginatedResult": { + "description": "A paginated list of OnlineDeployment entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of OnlineDeployment objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type OnlineDeployment.", + "type": "array", + "items": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + }, + "additionalProperties": false + }, + "OnlineEndpoint": { + "description": "Online endpoint configuration", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesBase" + } + ], + "properties": { + "compute": { + "description": "ARM resource ID of the compute if it exists.\r\noptional", + "type": "string", + "x-nullable": true + }, + "mirrorTraffic": { + "description": "Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "publicNetworkAccess": { + "description": "Set to \"Enabled\" for endpoints that should allow public access when Private Link is enabled.", + "default": "Enabled", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "traffic": { + "description": "Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true + } + }, + "x-ms-client-name": "OnlineEndpointProperties", + "additionalProperties": false + }, + "OnlineEndpointTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/OnlineEndpoint" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "OnlineEndpoint", + "additionalProperties": false + }, + "OnlineEndpointTrackedResourceArmPaginatedResult": { + "description": "A paginated list of OnlineEndpoint entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type OnlineEndpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + } + }, + "additionalProperties": false + }, + "OnlineInferenceConfiguration": { + "description": "Online inference configuration options.", + "type": "object", + "properties": { + "configurations": { + "description": "Additional configurations", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "entryScript": { + "description": "Entry script or command to invoke.", + "type": "string", + "x-nullable": true + }, + "livenessRoute": { + "description": "The route to check the liveness of the inference server container.", + "$ref": "#/definitions/Route", + "x-nullable": true + }, + "readinessRoute": { + "description": "The route to check the readiness of the inference server container.", + "$ref": "#/definitions/Route", + "x-nullable": true + }, + "scoringRoute": { + "description": "The port to send the scoring requests to, within the inference server container.", + "$ref": "#/definitions/Route", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "OnlineRequestSettings": { + "description": "Online deployment scoring requests configuration.", + "type": "object", + "properties": { + "maxConcurrentRequestsPerInstance": { + "format": "int32", + "description": "The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.", + "default": 1, + "type": "integer" + }, + "maxQueueWait": { + "format": "duration", + "description": "The maximum amount of time a request will stay in the queue in ISO 8601 format.\r\nDefaults to 500ms.", + "default": "PT0.5S", + "type": "string" + }, + "requestTimeout": { + "format": "duration", + "description": "The scoring timeout in ISO 8601 format.\r\nDefaults to 5000ms.", + "default": "PT5S", + "type": "string" + } + }, + "additionalProperties": false + }, + "OnlineScaleSettings": { + "description": "Online deployment scaling configuration.", + "required": [ + "scaleType" + ], + "type": "object", + "properties": { + "scaleType": { + "description": "[Required] Type of deployment scaling algorithm", + "$ref": "#/definitions/ScaleType" + } + }, + "discriminator": "scaleType" + }, + "OperatingSystemType": { + "description": "The type of operating system.", + "enum": [ + "Linux", + "Windows" + ], + "type": "string", + "x-ms-enum": { + "name": "OperatingSystemType", + "modelAsString": true, + "values": [ + { + "value": "Linux" + }, + { + "value": "Windows" + } + ] + }, + "additionalProperties": false + }, + "OrderString": { + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "type": "string", + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true, + "values": [ + { + "value": "CreatedAtDesc" + }, + { + "value": "CreatedAtAsc" + }, + { + "value": "UpdatedAtDesc" + }, + { + "value": "UpdatedAtAsc" + } + ] + }, + "additionalProperties": false + }, + "OutputDeliveryMode": { + "description": "Output data delivery mode enums.", + "enum": [ + "ReadWriteMount", + "Upload", + "Direct" + ], + "type": "string", + "x-ms-enum": { + "name": "OutputDeliveryMode", + "modelAsString": true, + "values": [ + { + "value": "ReadWriteMount" + }, + { + "value": "Upload" + }, + { + "value": "Direct" + } + ] + }, + "additionalProperties": false + }, + "OutputPathAssetReference": { + "description": "Reference to an asset via its path in a job output.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "jobId": { + "description": "ARM resource ID of the job.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "The path of the file/directory in the job output.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "OutputPath", + "additionalProperties": false + }, + "PackageBuildState": { + "description": "Package build state returned in package response.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "PackageBuildState", + "modelAsString": true, + "values": [ + { + "value": "NotStarted" + }, + { + "value": "Running" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + } + ] + }, + "additionalProperties": false + }, + "PackageInputDeliveryMode": { + "description": "Mounting type of the model or the inputs", + "enum": [ + "Copy", + "Download" + ], + "type": "string", + "x-ms-enum": { + "name": "PackageInputDeliveryMode", + "modelAsString": true, + "values": [ + { + "value": "Copy" + }, + { + "value": "Download" + } + ] + }, + "additionalProperties": false + }, + "PackageInputPathBase": { + "required": [ + "inputPathType" + ], + "type": "object", + "properties": { + "inputPathType": { + "description": "[Required] Input path type for package inputs.", + "$ref": "#/definitions/InputPathType" + } + }, + "discriminator": "inputPathType" + }, + "PackageInputPathId": { + "description": "Package input path specified with a resource id.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PackageInputPathBase" + } + ], + "properties": { + "resourceId": { + "description": "Input resource id.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PathId", + "additionalProperties": false + }, + "PackageInputPathUrl": { + "description": "Package input path specified as an url.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PackageInputPathBase" + } + ], + "properties": { + "url": { + "description": "Input path url.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Url", + "additionalProperties": false + }, + "PackageInputPathVersion": { + "description": "Package input path specified with name and version.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PackageInputPathBase" + } + ], + "properties": { + "resourceName": { + "description": "Input resource name.", + "type": "string", + "x-nullable": true + }, + "resourceVersion": { + "description": "Input resource version.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PathVersion", + "additionalProperties": false + }, + "PackageInputType": { + "description": "Type of the inputs.", + "enum": [ + "UriFile", + "UriFolder" + ], + "type": "string", + "x-ms-enum": { + "name": "PackageInputType", + "modelAsString": true, + "values": [ + { + "value": "UriFile" + }, + { + "value": "UriFolder" + } + ] + }, + "additionalProperties": false + }, + "PackageRequest": { + "description": "Model package operation request properties.", + "required": [ + "inferencingServer", + "targetEnvironmentId" + ], + "type": "object", + "properties": { + "baseEnvironmentSource": { + "description": "Base environment to start with.", + "$ref": "#/definitions/BaseEnvironmentSource", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentVariables": { + "description": "Collection of environment variables.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inferencingServer": { + "description": "[Required] Inferencing server configurations.", + "$ref": "#/definitions/InferencingServer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "inputs": { + "description": "Collection of inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelPackageInput" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + }, + "modelConfiguration": { + "description": "Model configuration including the mount mode.", + "$ref": "#/definitions/ModelConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "properties": { + "description": "Property dictionary. Properties can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "tags": { + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "targetEnvironmentId": { + "description": "[Required] Arm ID of the target environment to be created by package operation.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "PackageResponse": { + "description": "Package response returned after async package operation completes successfully.", + "type": "object", + "properties": { + "baseEnvironmentSource": { + "description": "Base environment to start with.", + "$ref": "#/definitions/BaseEnvironmentSource", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "buildId": { + "description": "Build id of the image build operation.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "buildState": { + "description": "Build state of the image build operation.", + "$ref": "#/definitions/PackageBuildState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "environmentVariables": { + "description": "Collection of environment variables.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "inferencingServer": { + "description": "Inferencing server configurations.", + "$ref": "#/definitions/InferencingServer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Collection of inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelPackageInput" + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + }, + "logUrl": { + "description": "Log url of the image build operation.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "modelConfiguration": { + "description": "Model configuration including the mount mode.", + "$ref": "#/definitions/ModelConfiguration", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "properties": { + "description": "Property dictionary. Tags can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "tags": { + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "targetEnvironmentId": { + "description": "Asset ID of the target environment created by package operation.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PartialBatchDeployment": { + "description": "Mutable batch inference settings per deployment.", + "type": "object", + "properties": { + "description": { + "description": "Description of the endpoint deployment.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties": { + "description": "Strictly used in update requests.", + "type": "object", + "properties": { + "properties": { + "description": "Additional attributes of the entity.", + "$ref": "#/definitions/PartialBatchDeployment" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "PartialJobBase": { + "description": "Mutable base definition for a job.", + "type": "object", + "properties": { + "notificationSetting": { + "description": "Mutable notification setting for the job", + "$ref": "#/definitions/PartialNotificationSetting", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PartialJobBasePartialResource": { + "description": "Azure Resource Manager resource envelope strictly used in update requests.", + "type": "object", + "properties": { + "properties": { + "description": "Additional attributes of the entity.", + "$ref": "#/definitions/PartialJobBase" + } + }, + "additionalProperties": false + }, + "PartialManagedServiceIdentity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "type": "object", + "properties": { + "type": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentityType" + }, + "userAssignedIdentities": { + "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PartialUserAssignedIdentity" + } + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResource": { + "description": "Strictly used in update requests.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResourceWithIdentity": { + "description": "Strictly used in update requests.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PartialMinimalTrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "#/definitions/PartialManagedServiceIdentity" + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResourceWithSku": { + "description": "Strictly used in update requests.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PartialMinimalTrackedResource" + } + ], + "properties": { + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "#/definitions/PartialSku" + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResourceWithSkuAndIdentity": { + "description": "Strictly used in update requests.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PartialMinimalTrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "#/definitions/PartialManagedServiceIdentity" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "#/definitions/PartialSku" + } + }, + "additionalProperties": false + }, + "PartialNotificationSetting": { + "description": "Mutable configuration for notification.", + "type": "object", + "properties": { + "webhooks": { + "description": "Send webhook callback to a service. Key is a user-provided name for the webhook.", + "type": "object", + "additionalProperties": { + "description": "Webhook base", + "$ref": "#/definitions/Webhook", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PartialSku": { + "description": "Common SKU definition.", + "type": "object", + "properties": { + "capacity": { + "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.", + "type": "integer" + }, + "family": { + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "name": { + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code.", + "type": "string" + }, + "size": { + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.", + "type": "string" + }, + "tier": { + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + } + }, + "additionalProperties": false + }, + "PartialUserAssignedIdentity": { + "type": "object", + "additionalProperties": false + }, + "PendingUploadCredentialDto": { + "required": [ + "credentialType" + ], + "type": "object", + "properties": { + "credentialType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/PendingUploadCredentialType" + } + }, + "discriminator": "credentialType" + }, + "PendingUploadCredentialType": { + "description": "Enum to determine the PendingUpload credentials type.", + "enum": [ + "SAS" + ], + "type": "string", + "x-ms-enum": { + "name": "PendingUploadCredentialType", + "modelAsString": true, + "values": [ + { + "value": "SAS" + } + ] + }, + "additionalProperties": false + }, + "PendingUploadRequestDto": { + "type": "object", + "properties": { + "pendingUploadId": { + "description": "If PendingUploadId = null then random guid will be used.", + "type": "string", + "x-nullable": true + }, + "pendingUploadType": { + "description": "TemporaryBlobReference is the only supported type", + "default": "TemporaryBlobReference", + "$ref": "#/definitions/PendingUploadType" + } + }, + "additionalProperties": false + }, + "PendingUploadResponseDto": { + "type": "object", + "properties": { + "blobReferenceForConsumption": { + "description": "Container level read, write, list SAS", + "$ref": "#/definitions/BlobReferenceForConsumptionDto", + "x-nullable": true + }, + "pendingUploadId": { + "description": "ID for this upload request", + "type": "string", + "x-nullable": true + }, + "pendingUploadType": { + "description": "TemporaryBlobReference is the only supported type", + "default": "TemporaryBlobReference", + "$ref": "#/definitions/PendingUploadType" + } + }, + "additionalProperties": false + }, + "PendingUploadType": { + "description": "Type of storage to use for the pending upload location", + "enum": [ + "None", + "TemporaryBlobReference" + ], + "type": "string", + "x-ms-enum": { + "name": "PendingUploadType", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "TemporaryBlobReference" + } + ] + }, + "additionalProperties": false + }, + "PipelineJob": { + "description": "Pipeline Job definition: defines generic to MFE attributes.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "inputs": { + "description": "Inputs for the pipeline job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobs": { + "description": "Jobs construct the Pipeline Job.", + "type": "object", + "additionalProperties": { + "type": "object", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Outputs for the pipeline job", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "settings": { + "description": "Pipeline settings, for things like ContinueRunOnStepFailure etc.", + "type": "object", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "sourceJobId": { + "description": "ARM resource ID of source job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Pipeline", + "additionalProperties": false + }, + "PoolEnvironmentConfiguration": { + "description": "Environment configuration options.", + "type": "object", + "properties": { + "environmentId": { + "description": "ARM resource ID of the environment specification for the inference pool.", + "type": "string", + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables configuration for the inference pool.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "livenessProbe": { + "description": "Liveness probe monitors the health of the container regularly.", + "$ref": "#/definitions/ProbeSettings", + "x-nullable": true + }, + "readinessProbe": { + "description": "Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.", + "$ref": "#/definitions/ProbeSettings", + "x-nullable": true + }, + "startupProbe": { + "description": "This verifies whether the application within a container is started. Startup probes run before any other probe, and, unless it finishes successfully, disables other probes.", + "$ref": "#/definitions/ProbeSettings", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PoolModelConfiguration": { + "description": "Model configuration options.", + "type": "object", + "properties": { + "modelId": { + "description": "The URI path to the model.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PoolProvisioningState": { + "description": "State of pool related resources provisioning.", + "enum": [ + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Updating", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "PoolProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Updating" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "PoolStatus": { + "type": "object", + "properties": { + "actualCapacity": { + "format": "int32", + "description": "Gets or sets the actual number of instances in the pool.", + "default": 0, + "type": "integer" + }, + "groupCount": { + "format": "int32", + "description": "Gets or sets the actual number of groups in the pool.", + "default": 0, + "type": "integer" + }, + "requestedCapacity": { + "format": "int32", + "description": "Gets or sets the requested number of instances for the pool.", + "default": 0, + "type": "integer" + }, + "reservedCapacity": { + "format": "int32", + "description": "Gets or sets the number of instances in the pool reserved by the system.", + "default": 0, + "type": "integer" + } + }, + "additionalProperties": false + }, + "PredictionDriftMetricThresholdBase": { + "required": [ + "dataType" + ], + "type": "object", + "properties": { + "dataType": { + "description": "[Required] Specifies the data type of the metric threshold.", + "$ref": "#/definitions/MonitoringFeatureDataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "discriminator": "dataType" + }, + "PredictionDriftMonitoringSignal": { + "required": [ + "metricThresholds", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/PredictionDriftMetricThresholdBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "[Required] The data which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "PredictionDrift", + "additionalProperties": false + }, + "ProbeSettings": { + "description": "Deployment container liveness/readiness probe configuration.", + "type": "object", + "properties": { + "failureThreshold": { + "format": "int32", + "description": "The number of failures to allow before returning an unhealthy status.", + "default": 30, + "type": "integer" + }, + "initialDelay": { + "format": "duration", + "description": "The delay before the first probe in ISO 8601 format.", + "type": "string", + "x-nullable": true + }, + "period": { + "format": "duration", + "description": "The length of time between probes in ISO 8601 format.", + "default": "PT10S", + "type": "string" + }, + "successThreshold": { + "format": "int32", + "description": "The number of successful probes before returning a healthy status.", + "default": 1, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "The probe timeout in ISO 8601 format.", + "default": "PT2S", + "type": "string" + } + }, + "additionalProperties": false + }, + "ProgressMetrics": { + "description": "Progress metrics definition", + "type": "object", + "properties": { + "completedDatapointCount": { + "format": "int64", + "description": "The completed datapoint count.", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "incrementalDataLastRefreshDateTime": { + "format": "date-time", + "description": "The time of last successful incremental data refresh in UTC.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "skippedDatapointCount": { + "format": "int64", + "description": "The skipped datapoint count.", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "totalDatapointCount": { + "format": "int64", + "description": "The total datapoint count.", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PropertiesBase": { + "description": "Base definition for pool resources.", + "type": "object", + "properties": { + "description": { + "description": "Description of the resource.", + "type": "string", + "x-nullable": true + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ProtectionLevel": { + "description": "Protection level associated with the Intellectual Property.", + "enum": [ + "All", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionLevel", + "modelAsString": true, + "values": [ + { + "value": "All", + "description": "All means Intellectual Property is fully protected." + }, + { + "value": "None", + "description": "None means it is not an Intellectual Property." + } + ] + }, + "additionalProperties": false + }, + "PublicNetworkAccessType": { + "description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "PyTorch": { + "description": "PyTorch distribution configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + } + ], + "properties": { + "processCountPerInstance": { + "format": "int32", + "description": "Number of processes per node.", + "type": "integer", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PyTorch", + "additionalProperties": false + }, + "QueueSettings": { + "type": "object", + "properties": { + "jobTier": { + "description": "Controls the compute job tier", + "default": "Null", + "$ref": "#/definitions/JobTier", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "priority": { + "format": "int32", + "description": "Controls the priority of the job on a compute.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RandomSamplingAlgorithm": { + "description": "Defines a Sampling Algorithm that generates values randomly", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SamplingAlgorithm" + } + ], + "properties": { + "logbase": { + "description": "An optional positive number or e in string format to be used as base for log based random sampling", + "type": "string", + "x-nullable": true + }, + "rule": { + "description": "The specific type of random algorithm", + "default": "Random", + "$ref": "#/definitions/RandomSamplingAlgorithmRule" + }, + "seed": { + "format": "int32", + "description": "An optional integer to use as the seed for random number generation", + "type": "integer", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Random", + "additionalProperties": false + }, + "RandomSamplingAlgorithmRule": { + "description": "The specific type of random algorithm", + "enum": [ + "Random", + "Sobol" + ], + "type": "string", + "x-ms-enum": { + "name": "RandomSamplingAlgorithmRule", + "modelAsString": true, + "values": [ + { + "value": "Random" + }, + { + "value": "Sobol" + } + ] + }, + "additionalProperties": false + }, + "Ray": { + "description": "Ray distribution configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + } + ], + "properties": { + "address": { + "description": "The address of Ray head node.", + "type": "string", + "x-nullable": true + }, + "dashboardPort": { + "format": "int32", + "description": "The port to bind the dashboard server to.", + "type": "integer", + "x-nullable": true + }, + "headNodeAdditionalArgs": { + "description": "Additional arguments passed to ray start in head node.", + "type": "string", + "x-nullable": true + }, + "includeDashboard": { + "description": "Provide this argument to start the Ray dashboard GUI.", + "type": "boolean", + "x-nullable": true + }, + "port": { + "format": "int32", + "description": "The port of the head ray process.", + "type": "integer", + "x-nullable": true + }, + "workerNodeAdditionalArgs": { + "description": "Additional arguments passed to ray start in worker node.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Ray", + "additionalProperties": false + }, + "RecurrenceFrequency": { + "description": "Enum to describe the frequency of a recurrence schedule", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "type": "string", + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": true, + "values": [ + { + "value": "Minute", + "description": "Minute frequency" + }, + { + "value": "Hour", + "description": "Hour frequency" + }, + { + "value": "Day", + "description": "Day frequency" + }, + { + "value": "Week", + "description": "Week frequency" + }, + { + "value": "Month", + "description": "Month frequency" + } + ] + }, + "additionalProperties": false + }, + "RecurrenceSchedule": { + "required": [ + "hours", + "minutes" + ], + "type": "object", + "properties": { + "hours": { + "description": "[Required] List of hours for the schedule.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "minutes": { + "description": "[Required] List of minutes for the schedule.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "monthDays": { + "description": "List of month days for the schedule", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true + }, + "weekDays": { + "description": "List of days for the schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/WeekDay" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RecurrenceTrigger": { + "required": [ + "frequency", + "interval" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerBase" + } + ], + "properties": { + "frequency": { + "description": "[Required] The frequency to trigger schedule.", + "$ref": "#/definitions/RecurrenceFrequency" + }, + "interval": { + "format": "int32", + "description": "[Required] Specifies schedule interval in conjunction with frequency", + "type": "integer" + }, + "schedule": { + "description": "The recurrence schedule.", + "$ref": "#/definitions/RecurrenceSchedule", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Recurrence", + "additionalProperties": false + }, + "ReferenceType": { + "description": "Enum to determine which reference method to use for an asset.", + "enum": [ + "Id", + "DataPath", + "OutputPath" + ], + "type": "string", + "x-ms-enum": { + "name": "ReferenceType", + "modelAsString": true, + "values": [ + { + "value": "Id" + }, + { + "value": "DataPath" + }, + { + "value": "OutputPath" + } + ] + }, + "additionalProperties": false + }, + "RegenerateEndpointKeysRequest": { + "required": [ + "keyType" + ], + "type": "object", + "properties": { + "keyType": { + "description": "[Required] Specification for which type of key to generate. Primary or Secondary.", + "$ref": "#/definitions/KeyType", + "example": "Primary" + }, + "keyValue": { + "description": "The value the key is set to.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "Regression": { + "description": "Regression task in AutoML Table vertical.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TableVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for regression task.", + "default": "NormalizedRootMeanSquaredError", + "$ref": "#/definitions/RegressionPrimaryMetrics" + }, + "trainingSettings": { + "description": "Inputs for training phase for an AutoML Job.", + "$ref": "#/definitions/RegressionTrainingSettings", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Regression", + "additionalProperties": false + }, + "RegressionModelPerformanceMetric": { + "enum": [ + "MeanAbsoluteError", + "RootMeanSquaredError", + "MeanSquaredError" + ], + "type": "string", + "x-ms-enum": { + "name": "RegressionModelPerformanceMetric", + "modelAsString": true, + "values": [ + { + "value": "MeanAbsoluteError", + "description": "The Mean Absolute Error (MAE) metric." + }, + { + "value": "RootMeanSquaredError", + "description": "The Root Mean Squared Error (RMSE) metric." + }, + { + "value": "MeanSquaredError", + "description": "The Mean Squared Error (MSE) metric." + } + ] + }, + "additionalProperties": false + }, + "RegressionModelPerformanceMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ModelPerformanceMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The regression model performance metric to calculate.", + "$ref": "#/definitions/RegressionModelPerformanceMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Regression", + "additionalProperties": false + }, + "RegressionModels": { + "description": "Enum for all Regression models supported by AutoML.", + "enum": [ + "ElasticNet", + "GradientBoosting", + "DecisionTree", + "KNN", + "LassoLars", + "SGD", + "RandomForest", + "ExtremeRandomTrees", + "LightGBM", + "XGBoostRegressor" + ], + "type": "string", + "x-ms-enum": { + "name": "RegressionModels", + "modelAsString": true, + "values": [ + { + "value": "ElasticNet", + "description": "Elastic net is a popular type of regularized linear regression that combines two popular penalties, specifically the L1 and L2 penalty functions." + }, + { + "value": "GradientBoosting", + "description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution." + }, + { + "value": "DecisionTree", + "description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features." + }, + { + "value": "KNN", + "description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set." + }, + { + "value": "LassoLars", + "description": "Lasso model fit with Least Angle Regression a.k.a. Lars. It is a Linear Model trained with an L1 prior as regularizer." + }, + { + "value": "SGD", + "description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs.\nIt's an inexact but powerful technique." + }, + { + "value": "RandomForest", + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the bagging method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + }, + { + "value": "ExtremeRandomTrees", + "description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm." + }, + { + "value": "LightGBM", + "description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms." + }, + { + "value": "XGBoostRegressor", + "description": "XGBoostRegressor: Extreme Gradient Boosting Regressor is a supervised machine learning model using ensemble of base learners." + } + ] + }, + "additionalProperties": false + }, + "RegressionPrimaryMetrics": { + "description": "Primary metrics for Regression task.", + "enum": [ + "SpearmanCorrelation", + "NormalizedRootMeanSquaredError", + "R2Score", + "NormalizedMeanAbsoluteError" + ], + "type": "string", + "x-ms-enum": { + "name": "RegressionPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "SpearmanCorrelation", + "description": "The Spearman's rank coefficient of correlation is a nonparametric measure of rank correlation." + }, + { + "value": "NormalizedRootMeanSquaredError", + "description": "The Normalized Root Mean Squared Error (NRMSE) the RMSE facilitates the comparison between models with different scales." + }, + { + "value": "R2Score", + "description": "The R2 score is one of the performance evaluation measures for forecasting-based machine learning models." + }, + { + "value": "NormalizedMeanAbsoluteError", + "description": "The Normalized Mean Absolute Error (NMAE) is a validation metric to compare the Mean Absolute Error (MAE) of (time) series with different scales." + } + ] + }, + "additionalProperties": false + }, + "RegressionTrainingSettings": { + "description": "Regression Training related configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrainingSettings" + } + ], + "properties": { + "allowedTrainingAlgorithms": { + "description": "Allowed models for regression task.", + "type": "array", + "items": { + "$ref": "#/definitions/RegressionModels" + }, + "x-nullable": true + }, + "blockedTrainingAlgorithms": { + "description": "Blocked models for regression task.", + "type": "array", + "items": { + "$ref": "#/definitions/RegressionModels" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RequestConfiguration": { + "description": "Scoring requests configuration.", + "type": "object", + "properties": { + "maxConcurrentRequestsPerInstance": { + "format": "int32", + "description": "The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.", + "default": 1, + "type": "integer" + }, + "requestTimeout": { + "format": "duration", + "description": "The scoring timeout in ISO 8601 format.\r\nDefaults to 5000ms.", + "default": "PT5S", + "type": "string" + } + }, + "additionalProperties": false + }, + "RequestLogging": { + "type": "object", + "properties": { + "captureHeaders": { + "description": "For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ResourceBase": { + "type": "object", + "properties": { + "description": { + "description": "The asset description text.", + "type": "string", + "x-nullable": true + }, + "properties": { + "description": "The asset property dictionary.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "tags": { + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ResourceConfiguration": { + "type": "object", + "properties": { + "instanceCount": { + "format": "int32", + "description": "Optional number of instances or nodes used by the compute target.", + "default": 1, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "instanceType": { + "description": "Optional type of VM used as supported by the compute target.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "locations": { + "description": "Locations where the job can run.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "maxInstanceCount": { + "format": "int32", + "description": "Optional max allowed number of instances or nodes to be used by the compute target.\r\nFor use with elastic training, currently supported by PyTorch distribution type only.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "properties": { + "description": "Additional properties bag.", + "type": "object", + "additionalProperties": { + "type": "object", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RollingInputData": { + "description": "Rolling input data definition.", + "required": [ + "windowOffset", + "windowSize" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringInputDataBase" + } + ], + "properties": { + "preprocessingComponentId": { + "description": "The ARM resource ID of the component resource used to preprocess the data.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "windowOffset": { + "format": "duration", + "description": "[Required] The time offset between the end of the data window and the monitor's current run time.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "windowSize": { + "format": "duration", + "description": "[Required] The size of the trailing data window.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Rolling", + "additionalProperties": false + }, + "RollingRateType": { + "enum": [ + "Year", + "Month", + "Day", + "Hour", + "Minute" + ], + "type": "string", + "x-ms-enum": { + "name": "RollingRateType", + "modelAsString": true, + "values": [ + { + "value": "Year" + }, + { + "value": "Month" + }, + { + "value": "Day" + }, + { + "value": "Hour" + }, + { + "value": "Minute" + } + ] + }, + "additionalProperties": false + }, + "Route": { + "required": [ + "path", + "port" + ], + "type": "object", + "properties": { + "path": { + "description": "[Required] The path for the route.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "port": { + "format": "int32", + "description": "[Required] The port for the route.", + "type": "integer" + } + }, + "additionalProperties": false + }, + "SASCredential": { + "description": "Access with full SAS uri", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataReferenceCredential" + } + ], + "properties": { + "sasUri": { + "format": "uri", + "description": "Full SAS Uri, including the storage, container/blob path and SAS token", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "SAS", + "additionalProperties": false + }, + "SASCredentialDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PendingUploadCredentialDto" + } + ], + "properties": { + "sasUri": { + "format": "uri", + "description": "Full SAS Uri, including the storage, container/blob path and SAS token", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + } + }, + "x-ms-discriminator-value": "SAS", + "additionalProperties": false + }, + "SamplingAlgorithm": { + "description": "The Sampling Algorithm used to generate hyperparameter values, along with properties to\r\nconfigure the algorithm", + "required": [ + "samplingAlgorithmType" + ], + "type": "object", + "properties": { + "samplingAlgorithmType": { + "description": "[Required] The algorithm used for generating hyperparameter values, along with configuration properties", + "$ref": "#/definitions/SamplingAlgorithmType" + } + }, + "discriminator": "samplingAlgorithmType" + }, + "SamplingAlgorithmType": { + "enum": [ + "Grid", + "Random", + "Bayesian" + ], + "type": "string", + "x-ms-enum": { + "name": "SamplingAlgorithmType", + "modelAsString": true, + "values": [ + { + "value": "Grid" + }, + { + "value": "Random" + }, + { + "value": "Bayesian" + } + ] + }, + "additionalProperties": false + }, + "SasDatastoreCredentials": { + "description": "SAS datastore credentials configuration.", + "required": [ + "secrets" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "secrets": { + "description": "[Required] Storage container secrets.", + "$ref": "#/definitions/SasDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "Sas", + "additionalProperties": false + }, + "SasDatastoreSecrets": { + "description": "Datastore SAS secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "sasToken": { + "description": "Storage container SAS token.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Sas", + "additionalProperties": false + }, + "ScaleType": { + "enum": [ + "Default", + "TargetUtilization" + ], + "type": "string", + "x-ms-enum": { + "name": "ScaleType", + "modelAsString": true, + "values": [ + { + "value": "Default" + }, + { + "value": "TargetUtilization" + } + ] + }, + "additionalProperties": false + }, + "Schedule": { + "description": "Base definition of a schedule", + "required": [ + "action", + "trigger" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "action": { + "description": "[Required] Specifies the action of the schedule", + "$ref": "#/definitions/ScheduleActionBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "displayName": { + "description": "Display name of schedule.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "isEnabled": { + "description": "Is the schedule enabled?", + "default": true, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "provisioningState": { + "description": "Provisioning state for the schedule.", + "$ref": "#/definitions/ScheduleProvisioningStatus", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "trigger": { + "description": "[Required] Specifies the trigger details", + "$ref": "#/definitions/TriggerBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-client-name": "ScheduleProperties", + "additionalProperties": false + }, + "ScheduleActionBase": { + "required": [ + "actionType" + ], + "type": "object", + "properties": { + "actionType": { + "description": "[Required] Specifies the action type of the schedule", + "$ref": "#/definitions/ScheduleActionType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "discriminator": "actionType" + }, + "ScheduleActionType": { + "enum": [ + "CreateJob", + "InvokeBatchEndpoint", + "ImportData", + "CreateMonitor" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleActionType", + "modelAsString": true, + "values": [ + { + "value": "CreateJob" + }, + { + "value": "InvokeBatchEndpoint" + }, + { + "value": "ImportData" + }, + { + "value": "CreateMonitor" + } + ] + }, + "additionalProperties": false + }, + "ScheduleListViewType": { + "enum": [ + "EnabledOnly", + "DisabledOnly", + "All" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleListViewType", + "modelAsString": true, + "values": [ + { + "value": "EnabledOnly" + }, + { + "value": "DisabledOnly" + }, + { + "value": "All" + } + ] + }, + "additionalProperties": false + }, + "ScheduleProvisioningStatus": { + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleProvisioningStatus", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Updating" + }, + { + "value": "Deleting" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "ScheduleResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Schedule" + } + }, + "x-ms-client-name": "Schedule", + "additionalProperties": false + }, + "ScheduleResourceArmPaginatedResult": { + "description": "A paginated list of Schedule entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Schedule objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScheduleResource" + } + } + }, + "additionalProperties": false + }, + "ScheduleType": { + "enum": [ + "ComputeStartStop", + "CreateJob", + "InvokeBatchEndpoint", + "ImportData", + "CreateMonitor", + "FeatureStoreMaterialization" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleType", + "modelAsString": true, + "values": [ + { + "value": "ComputeStartStop" + }, + { + "value": "CreateJob" + }, + { + "value": "InvokeBatchEndpoint" + }, + { + "value": "ImportData" + }, + { + "value": "CreateMonitor" + }, + { + "value": "FeatureStoreMaterialization" + } + ] + }, + "additionalProperties": false + }, + "Seasonality": { + "description": "Forecasting seasonality.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Seasonality mode.", + "$ref": "#/definitions/SeasonalityMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "SeasonalityMode": { + "description": "Forecasting seasonality mode.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "SeasonalityMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Seasonality to be determined automatically." + }, + { + "value": "Custom", + "description": "Use the custom seasonality value." + } + ] + }, + "additionalProperties": false + }, + "SecretConfiguration": { + "description": "Secret Configuration definition.", + "type": "object", + "properties": { + "uri": { + "description": "Secret Uri.\r\nSample Uri : https://myvault.vault.azure.net/secrets/mysecretname/secretversion", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "workspaceSecretName": { + "description": "Name of secret in workspace key vault.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "SecretsType": { + "description": "Enum to determine the datastore secrets type.", + "enum": [ + "AccountKey", + "Certificate", + "Sas", + "ServicePrincipal", + "KerberosPassword", + "KerberosKeytab" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretsType", + "modelAsString": true, + "values": [ + { + "value": "AccountKey" + }, + { + "value": "Certificate" + }, + { + "value": "Sas" + }, + { + "value": "ServicePrincipal" + }, + { + "value": "KerberosPassword" + }, + { + "value": "KerberosKeytab" + } + ] + }, + "additionalProperties": false + }, + "ServerlessEndpoint": { + "type": "object", + "properties": { + "authMode": { + "description": "Specifies the authentication mode for the Serverless endpoint.", + "$ref": "#/definitions/ServerlessInferenceEndpointAuthMode" + }, + "capacityReservation": { + "description": "Optional capacity reservation information for the endpoint. When specified, the Serverless Endpoint\r\nwill be allocated capacity from the specified capacity reservation group.", + "$ref": "#/definitions/ServerlessEndpointCapacityReservation", + "x-nullable": true + }, + "inferenceEndpoint": { + "description": "The inference uri to target when making requests against the serverless endpoint", + "$ref": "#/definitions/ServerlessInferenceEndpoint", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "marketplaceSubscriptionId": { + "description": "The MarketplaceSubscription ARM ID associated to this ServerlessEndpoint.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "modelSettings": { + "description": "The model settings (model id) for the model being serviced on the ServerlessEndpoint.", + "$ref": "#/definitions/ModelSettings", + "x-nullable": true + }, + "offer": { + "description": "The publisher-defined Serverless Offer to provision the endpoint with.", + "$ref": "#/definitions/ServerlessOffer", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "endpointState": { + "description": "State of the Serverless Endpoint.", + "$ref": "#/definitions/ServerlessEndpointState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "ServerlessEndpointProperties", + "additionalProperties": false + }, + "ServerlessEndpointCapacityReservation": { + "required": [ + "capacityReservationGroupId" + ], + "type": "object", + "properties": { + "capacityReservationGroupId": { + "description": "[Required] Specifies a capacity reservation group ID to allocate capacity from.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "endpointReservedCapacity": { + "format": "int32", + "description": "Specifies a capacity amount to reserve for this endpoint within the parent capacity reservation group.", + "type": "integer", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ServerlessEndpointState": { + "description": "State of the Serverless Endpoint.", + "enum": [ + "Unknown", + "Creating", + "Deleting", + "Suspending", + "Reinstating", + "Online", + "Suspended", + "CreationFailed", + "DeletionFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerlessEndpointState", + "modelAsString": true, + "values": [ + { + "value": "Unknown" + }, + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Suspending" + }, + { + "value": "Reinstating" + }, + { + "value": "Online" + }, + { + "value": "Suspended" + }, + { + "value": "CreationFailed" + }, + { + "value": "DeletionFailed" + } + ] + }, + "additionalProperties": false + }, + "ServerlessEndpointStatus": { + "type": "object", + "properties": { + "metrics": { + "description": "The model-specific metrics from the backing inference endpoint.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ServerlessEndpointTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ServerlessEndpoint" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "ServerlessEndpoint", + "additionalProperties": false + }, + "ServerlessEndpointTrackedResourceArmPaginatedResult": { + "description": "A paginated list of ServerlessEndpoint entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ServerlessEndpoint objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ServerlessEndpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + } + }, + "additionalProperties": false + }, + "ServerlessInferenceEndpoint": { + "required": [ + "uri" + ], + "type": "object", + "properties": { + "headers": { + "description": "Specifies any required headers to target this serverless endpoint.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "uri": { + "format": "uri", + "description": "[Required] The inference uri to target when making requests against the Serverless Endpoint.", + "type": "string", + "x-ms-mutability": [ + "read" + ] + } + }, + "additionalProperties": false + }, + "ServerlessInferenceEndpointAuthMode": { + "enum": [ + "Key", + "AAD" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerlessInferenceEndpointAuthMode", + "modelAsString": true, + "values": [ + { + "value": "Key" + }, + { + "value": "AAD" + } + ] + }, + "additionalProperties": false + }, + "ServerlessOffer": { + "required": [ + "offerName", + "publisher" + ], + "type": "object", + "properties": { + "offerName": { + "description": "[Required] The name of the Serverless Offer", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "publisher": { + "description": "[Required] Publisher name of the Serverless Offer", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, + "ServiceDataAccessAuthIdentity": { + "enum": [ + "None", + "WorkspaceSystemAssignedIdentity", + "WorkspaceUserAssignedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceDataAccessAuthIdentity", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Do not use any identity for service data access." + }, + { + "value": "WorkspaceSystemAssignedIdentity", + "description": "Use the system assigned managed identity of the Workspace to authenticate service data access." + }, + { + "value": "WorkspaceUserAssignedIdentity", + "description": "Use the user assigned managed identity of the Workspace to authenticate service data access." + } + ] + }, + "additionalProperties": false + }, + "ServicePrincipalDatastoreCredentials": { + "description": "Service Principal datastore credentials configuration.", + "required": [ + "clientId", + "secrets", + "tenantId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "authorityUrl": { + "description": "Authority URL used for authentication.", + "type": "string", + "x-nullable": true + }, + "clientId": { + "format": "uuid", + "description": "[Required] Service principal client ID.", + "type": "string" + }, + "resourceUrl": { + "description": "Resource the service principal has access to.", + "type": "string", + "x-nullable": true + }, + "secrets": { + "description": "[Required] Service principal secrets.", + "$ref": "#/definitions/ServicePrincipalDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "tenantId": { + "format": "uuid", + "description": "[Required] ID of the tenant to which the service principal belongs.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ServicePrincipal", + "additionalProperties": false + }, + "ServicePrincipalDatastoreSecrets": { + "description": "Datastore Service Principal secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "clientSecret": { + "description": "Service principal secret.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "ServicePrincipal", + "additionalProperties": false + }, + "ShortSeriesHandlingConfiguration": { + "description": "The parameter defining how if AutoML should handle short time series.", + "enum": [ + "None", + "Auto", + "Pad", + "Drop" + ], + "type": "string", + "x-ms-enum": { + "name": "ShortSeriesHandlingConfiguration", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Represents no/null value." + }, + { + "value": "Auto", + "description": "Short series will be padded if there are no long series, otherwise short series will be dropped." + }, + { + "value": "Pad", + "description": "All the short series will be padded." + }, + { + "value": "Drop", + "description": "All the short series will be dropped." + } + ] + }, + "additionalProperties": false + }, + "SkuCapacity": { + "description": "SKU capacity information", + "type": "object", + "properties": { + "default": { + "format": "int32", + "description": "Gets or sets the default capacity.", + "default": 0, + "type": "integer" + }, + "maximum": { + "format": "int32", + "description": "Gets or sets the maximum.", + "default": 0, + "type": "integer" + }, + "minimum": { + "format": "int32", + "description": "Gets or sets the minimum.", + "default": 0, + "type": "integer" + }, + "scaleType": { + "description": "Gets or sets the type of the scale.", + "default": "Automatic", + "$ref": "#/definitions/SkuScaleType" + } + }, + "additionalProperties": false + }, + "SkuResource": { + "description": "Fulfills ARM Contract requirement to list all available SKUS for a resource.", + "type": "object", + "properties": { + "capacity": { + "description": "Gets or sets the Sku Capacity.", + "$ref": "#/definitions/SkuCapacity", + "x-nullable": true + }, + "resourceType": { + "description": "The resource type name.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "sku": { + "description": "Gets or sets the Sku.", + "$ref": "#/definitions/SkuSetting", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "SkuResourceArmPaginatedResult": { + "description": "A paginated list of SkuResource entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of SkuResource objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type SkuResource.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuResource" + }, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "SkuScaleType": { + "description": "Node scaling setting for the compute sku.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuScaleType", + "modelAsString": true, + "values": [ + { + "value": "Automatic", + "description": "Automatically scales node count." + }, + { + "value": "Manual", + "description": "Node count scaled upon user request." + }, + { + "value": "None", + "description": "Fixed set of nodes." + } + ] + }, + "additionalProperties": false + }, + "SkuSetting": { + "description": "SkuSetting fulfills the need for stripped down SKU info in ARM contract.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "[Required] The name of the SKU. Ex - P3. It is typically a letter+number code.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "tier": { + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", + "default": "Basic", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + } + }, + "additionalProperties": false + }, + "SparkJob": { + "description": "Spark job definition.", + "required": [ + "codeId", + "entry" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "archives": { + "description": "Archive files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "args": { + "description": "Arguments for the job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "codeId": { + "description": "[Required] ARM resource ID of the code asset.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "conf": { + "description": "Spark configured properties.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "entry": { + "description": "[Required] The entry to execute on startup of the job.", + "$ref": "#/definitions/SparkJobEntry", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentId": { + "description": "The ARM resource ID of the Environment specification for the job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "files": { + "description": "Files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Mapping of input data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jars": { + "description": "Jar files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "pyFiles": { + "description": "Python files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "$ref": "#/definitions/SparkResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Spark", + "additionalProperties": false + }, + "SparkJobEntry": { + "description": "Spark job entry point definition.", + "required": [ + "sparkJobEntryType" + ], + "type": "object", + "properties": { + "sparkJobEntryType": { + "description": "[Required] Type of the job's entry point.", + "$ref": "#/definitions/SparkJobEntryType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "sparkJobEntryType" + }, + "SparkJobEntryType": { + "enum": [ + "SparkJobPythonEntry", + "SparkJobScalaEntry" + ], + "type": "string", + "x-ms-enum": { + "name": "SparkJobEntryType", + "modelAsString": true, + "values": [ + { + "value": "SparkJobPythonEntry" + }, + { + "value": "SparkJobScalaEntry" + } + ] + }, + "additionalProperties": false + }, + "SparkJobPythonEntry": { + "required": [ + "file" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SparkJobEntry" + } + ], + "properties": { + "file": { + "description": "[Required] Relative python file path for job entry point.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "train.py", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "SparkJobPythonEntry", + "additionalProperties": false + }, + "SparkJobScalaEntry": { + "required": [ + "className" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SparkJobEntry" + } + ], + "properties": { + "className": { + "description": "[Required] Scala class name used as entry point.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "microsoft.aml.sample.myapp", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "SparkJobScalaEntry", + "additionalProperties": false + }, + "SparkResourceConfiguration": { + "type": "object", + "properties": { + "instanceType": { + "description": "Optional type of VM used as supported by the compute target.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "runtimeVersion": { + "description": "Version of spark runtime used for the job.", + "default": "3.1", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "StackEnsembleSettings": { + "description": "Advances setting to customize StackEnsemble run.", + "type": "object", + "properties": { + "stackMetaLearnerKWargs": { + "description": "Optional parameters to pass to the initializer of the meta-learner.", + "type": "object", + "x-nullable": true + }, + "stackMetaLearnerTrainPercentage": { + "format": "double", + "description": "Specifies the proportion of the training set (when choosing train and validation type of training) to be reserved for training the meta-learner. Default value is 0.2.", + "default": 0.2, + "type": "number" + }, + "stackMetaLearnerType": { + "description": "The meta-learner is a model trained on the output of the individual heterogeneous models.", + "default": "None", + "$ref": "#/definitions/StackMetaLearnerType" + } + }, + "additionalProperties": false + }, + "StackMetaLearnerType": { + "description": "The meta-learner is a model trained on the output of the individual heterogeneous models.\r\nDefault meta-learners are LogisticRegression for classification tasks (or LogisticRegressionCV if cross-validation is enabled) and ElasticNet for regression/forecasting tasks (or ElasticNetCV if cross-validation is enabled).\r\nThis parameter can be one of the following strings: LogisticRegression, LogisticRegressionCV, LightGBMClassifier, ElasticNet, ElasticNetCV, LightGBMRegressor, or LinearRegression", + "enum": [ + "None", + "LogisticRegression", + "LogisticRegressionCV", + "LightGBMClassifier", + "ElasticNet", + "ElasticNetCV", + "LightGBMRegressor", + "LinearRegression" + ], + "type": "string", + "x-ms-enum": { + "name": "StackMetaLearnerType", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "LogisticRegression", + "description": "Default meta-learners are LogisticRegression for classification tasks." + }, + { + "value": "LogisticRegressionCV", + "description": "Default meta-learners are LogisticRegression for classification task when CV is on." + }, + { + "value": "LightGBMClassifier" + }, + { + "value": "ElasticNet", + "description": "Default meta-learners are LogisticRegression for regression task." + }, + { + "value": "ElasticNetCV", + "description": "Default meta-learners are LogisticRegression for regression task when CV is on." + }, + { + "value": "LightGBMRegressor" + }, + { + "value": "LinearRegression" + } + ] + }, + "additionalProperties": false + }, + "StaticInputData": { + "description": "Static input data definition.", + "required": [ + "windowEnd", + "windowStart" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringInputDataBase" + } + ], + "properties": { + "preprocessingComponentId": { + "description": "The ARM resource ID of the component resource used to preprocess the data.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "windowEnd": { + "format": "date-time", + "description": "[Required] The end date of the data window.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "windowStart": { + "format": "date-time", + "description": "[Required] The start date of the data window.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Static", + "additionalProperties": false + }, + "StatusMessage": { + "description": "Active message associated with project", + "type": "object", + "properties": { + "code": { + "description": "Service-defined message code.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Time in UTC at which the message was created.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "level": { + "description": "Severity level of message.", + "$ref": "#/definitions/StatusMessageLevel", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "message": { + "description": "A human-readable representation of the message code.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "StatusMessageLevel": { + "enum": [ + "Error", + "Information", + "Warning" + ], + "type": "string", + "x-ms-enum": { + "name": "StatusMessageLevel", + "modelAsString": true, + "values": [ + { + "value": "Error" + }, + { + "value": "Information" + }, + { + "value": "Warning" + } + ] + }, + "additionalProperties": false + }, + "StochasticOptimizer": { + "description": "Stochastic optimizer for image models.", + "enum": [ + "None", + "Sgd", + "Adam", + "Adamw" + ], + "type": "string", + "x-ms-enum": { + "name": "StochasticOptimizer", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No optimizer selected." + }, + { + "value": "Sgd", + "description": "Stochastic Gradient Descent optimizer." + }, + { + "value": "Adam", + "description": "Adam is algorithm the optimizes stochastic objective functions based on adaptive estimates of moments" + }, + { + "value": "Adamw", + "description": "AdamW is a variant of the optimizer Adam that has an improved implementation of weight decay." + } + ] + }, + "additionalProperties": false + }, + "SweepJob": { + "description": "Sweep job definition.", + "required": [ + "objective", + "samplingAlgorithm", + "searchSpace", + "trial" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "componentConfiguration": { + "description": "Component Configuration for sweep over component", + "$ref": "#/definitions/ComponentConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "earlyTermination": { + "description": "Early termination policies enable canceling poor-performing runs before they complete", + "$ref": "#/definitions/EarlyTerminationPolicy", + "x-nullable": true + }, + "inputs": { + "description": "Mapping of input data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "limits": { + "description": "Sweep Job limit.", + "default": "{}", + "$ref": "#/definitions/SweepJobLimits", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "objective": { + "description": "[Required] Optimization objective.", + "$ref": "#/definitions/Objective" + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "samplingAlgorithm": { + "description": "[Required] The hyperparameter sampling algorithm", + "$ref": "#/definitions/SamplingAlgorithm" + }, + "searchSpace": { + "description": "[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter", + "type": "object" + }, + "trial": { + "description": "[Required] Trial component definition.", + "$ref": "#/definitions/TrialComponent" + } + }, + "x-ms-discriminator-value": "Sweep", + "additionalProperties": false + }, + "SweepJobLimits": { + "description": "Sweep Job limit class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobLimits" + } + ], + "properties": { + "maxConcurrentTrials": { + "format": "int32", + "description": "Sweep Job max concurrent trials.", + "type": "integer", + "x-nullable": true + }, + "maxTotalTrials": { + "format": "int32", + "description": "Sweep Job max total trials.", + "type": "integer", + "x-nullable": true + }, + "trialTimeout": { + "format": "duration", + "description": "Sweep Job Trial timeout value.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Sweep", + "additionalProperties": false + }, + "TableFixedParameters": { + "description": "Fixed training parameters that won't be swept over during AutoML Table training.", + "type": "object", + "properties": { + "booster": { + "description": "Specify the boosting type, e.g gbdt for XGBoost.", + "type": "string", + "x-nullable": true + }, + "boostingType": { + "description": "Specify the boosting type, e.g gbdt for LightGBM.", + "type": "string", + "x-nullable": true + }, + "growPolicy": { + "description": "Specify the grow policy, which controls the way new nodes are added to the tree.", + "type": "string", + "x-nullable": true + }, + "learningRate": { + "format": "double", + "description": "The learning rate for the training procedure.", + "type": "number", + "x-nullable": true + }, + "maxBin": { + "format": "int32", + "description": "Specify the Maximum number of discrete bins to bucket continuous features .", + "type": "integer", + "x-nullable": true + }, + "maxDepth": { + "format": "int32", + "description": "Specify the max depth to limit the tree depth explicitly.", + "type": "integer", + "x-nullable": true + }, + "maxLeaves": { + "format": "int32", + "description": "Specify the max leaves to limit the tree leaves explicitly.", + "type": "integer", + "x-nullable": true + }, + "minDataInLeaf": { + "format": "int32", + "description": "The minimum number of data per leaf.", + "type": "integer", + "x-nullable": true + }, + "minSplitGain": { + "format": "double", + "description": "Minimum loss reduction required to make a further partition on a leaf node of the tree.", + "type": "number", + "x-nullable": true + }, + "modelName": { + "description": "The name of the model to train.", + "type": "string", + "x-nullable": true + }, + "nEstimators": { + "format": "int32", + "description": "Specify the number of trees (or rounds) in an model.", + "type": "integer", + "x-nullable": true + }, + "numLeaves": { + "format": "int32", + "description": "Specify the number of leaves.", + "type": "integer", + "x-nullable": true + }, + "preprocessorName": { + "description": "The name of the preprocessor to use.", + "type": "string", + "x-nullable": true + }, + "regAlpha": { + "format": "double", + "description": "L1 regularization term on weights.", + "type": "number", + "x-nullable": true + }, + "regLambda": { + "format": "double", + "description": "L2 regularization term on weights.", + "type": "number", + "x-nullable": true + }, + "subsample": { + "format": "double", + "description": "Subsample ratio of the training instance.", + "type": "number", + "x-nullable": true + }, + "subsampleFreq": { + "format": "double", + "description": "Frequency of subsample.", + "type": "number", + "x-nullable": true + }, + "treeMethod": { + "description": "Specify the tree method.", + "type": "string", + "x-nullable": true + }, + "withMean": { + "description": "If true, center before scaling the data with StandardScalar.", + "default": false, + "type": "boolean" + }, + "withStd": { + "description": "If true, scaling the data with Unit Variance with StandardScalar.", + "default": false, + "type": "boolean" + } + }, + "additionalProperties": false + }, + "TableParameterSubspace": { + "type": "object", + "properties": { + "booster": { + "description": "Specify the boosting type, e.g gbdt for XGBoost.", + "type": "string", + "x-nullable": true + }, + "boostingType": { + "description": "Specify the boosting type, e.g gbdt for LightGBM.", + "type": "string", + "x-nullable": true + }, + "growPolicy": { + "description": "Specify the grow policy, which controls the way new nodes are added to the tree.", + "type": "string", + "x-nullable": true + }, + "learningRate": { + "description": "The learning rate for the training procedure.", + "type": "string", + "x-nullable": true + }, + "maxBin": { + "description": "Specify the Maximum number of discrete bins to bucket continuous features .", + "type": "string", + "x-nullable": true + }, + "maxDepth": { + "description": "Specify the max depth to limit the tree depth explicitly.", + "type": "string", + "x-nullable": true + }, + "maxLeaves": { + "description": "Specify the max leaves to limit the tree leaves explicitly.", + "type": "string", + "x-nullable": true + }, + "minDataInLeaf": { + "description": "The minimum number of data per leaf.", + "type": "string", + "x-nullable": true + }, + "minSplitGain": { + "description": "Minimum loss reduction required to make a further partition on a leaf node of the tree.", + "type": "string", + "x-nullable": true + }, + "modelName": { + "description": "The name of the model to train.", + "type": "string", + "x-nullable": true + }, + "nEstimators": { + "description": "Specify the number of trees (or rounds) in an model.", + "type": "string", + "x-nullable": true + }, + "numLeaves": { + "description": "Specify the number of leaves.", + "type": "string", + "x-nullable": true + }, + "preprocessorName": { + "description": "The name of the preprocessor to use.", + "type": "string", + "x-nullable": true + }, + "regAlpha": { + "description": "L1 regularization term on weights.", + "type": "string", + "x-nullable": true + }, + "regLambda": { + "description": "L2 regularization term on weights.", + "type": "string", + "x-nullable": true + }, + "subsample": { + "description": "Subsample ratio of the training instance.", + "type": "string", + "x-nullable": true + }, + "subsampleFreq": { + "description": "Frequency of subsample", + "type": "string", + "x-nullable": true + }, + "treeMethod": { + "description": "Specify the tree method.", + "type": "string", + "x-nullable": true + }, + "withMean": { + "description": "If true, center before scaling the data with StandardScalar.", + "type": "string", + "x-nullable": true + }, + "withStd": { + "description": "If true, scaling the data with Unit Variance with StandardScalar.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "TableSweepSettings": { + "required": [ + "samplingAlgorithm" + ], + "type": "object", + "properties": { + "earlyTermination": { + "description": "Type of early termination policy for the sweeping job.", + "$ref": "#/definitions/EarlyTerminationPolicy", + "x-nullable": true + }, + "samplingAlgorithm": { + "description": "[Required] Type of sampling algorithm.", + "$ref": "#/definitions/SamplingAlgorithmType" + } + }, + "additionalProperties": false + }, + "TableVertical": { + "description": "Abstract class for AutoML tasks that use table dataset as input - such as Classification/Regression/Forecasting.", + "type": "object", + "properties": { + "cvSplitColumnNames": { + "description": "Columns to use for CVSplit data.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "featurizationSettings": { + "description": "Featurization inputs needed for AutoML job.", + "$ref": "#/definitions/TableVerticalFeaturizationSettings", + "x-nullable": true + }, + "fixedParameters": { + "description": "Model/training parameters that will remain constant throughout training.", + "$ref": "#/definitions/TableFixedParameters", + "x-nullable": true + }, + "limitSettings": { + "description": "Execution constraints for AutoMLJob.", + "$ref": "#/definitions/TableVerticalLimitSettings", + "x-nullable": true + }, + "nCrossValidations": { + "description": "Number of cross validation folds to be applied on training dataset\r\nwhen validation dataset is not provided.", + "$ref": "#/definitions/NCrossValidations", + "x-nullable": true + }, + "searchSpace": { + "description": "Search space for sampling different combinations of models and their hyperparameters.", + "type": "array", + "items": { + "$ref": "#/definitions/TableParameterSubspace" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "sweepSettings": { + "description": "Settings for model sweeping and hyperparameter tuning.", + "$ref": "#/definitions/TableSweepSettings", + "x-nullable": true + }, + "testData": { + "description": "Test data input.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, + "testDataSize": { + "format": "double", + "description": "The fraction of test dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + }, + "validationData": { + "description": "Validation data inputs.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, + "validationDataSize": { + "format": "double", + "description": "The fraction of training dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + }, + "weightColumnName": { + "description": "The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "TableVerticalFeaturizationSettings": { + "description": "Featurization Configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeaturizationSettings" + } + ], + "properties": { + "blockedTransformers": { + "description": "These transformers shall not be used in featurization.", + "type": "array", + "items": { + "$ref": "#/definitions/BlockedTransformers" + }, + "x-nullable": true + }, + "columnNameAndTypes": { + "description": "Dictionary of column name and its type (int, float, string, datetime etc).", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "enableDnnFeaturization": { + "description": "Determines whether to use Dnn based featurizers for data featurization.", + "default": false, + "type": "boolean" + }, + "mode": { + "description": "Featurization mode - User can keep the default 'Auto' mode and AutoML will take care of necessary transformation of the data in featurization phase.\r\nIf 'Off' is selected then no featurization is done.\r\nIf 'Custom' is selected then user can specify additional inputs to customize how featurization is done.", + "default": "Auto", + "$ref": "#/definitions/FeaturizationMode" + }, + "transformerParams": { + "description": "User can specify additional transformers to be used along with the columns to which it would be applied and parameters for the transformer constructor.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/ColumnTransformer" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "TableVerticalLimitSettings": { + "description": "Job execution constraints.", + "type": "object", + "properties": { + "enableEarlyTermination": { + "description": "Enable early termination, determines whether or not if AutoMLJob will terminate early if there is no score improvement in last 20 iterations.", + "default": true, + "type": "boolean" + }, + "exitScore": { + "format": "double", + "description": "Exit score for the AutoML job.", + "type": "number", + "x-nullable": true + }, + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum Concurrent iterations.", + "default": 1, + "type": "integer" + }, + "maxCoresPerTrial": { + "format": "int32", + "description": "Max cores per iteration.", + "default": -1, + "type": "integer" + }, + "maxNodes": { + "format": "int32", + "description": "Maximum nodes to use for the experiment.", + "default": 1, + "type": "integer" + }, + "maxTrials": { + "format": "int32", + "description": "Number of iterations.", + "default": 1000, + "type": "integer" + }, + "sweepConcurrentTrials": { + "format": "int32", + "description": "Number of concurrent sweeping runs that user wants to trigger.", + "default": 0, + "type": "integer" + }, + "sweepTrials": { + "format": "int32", + "description": "Number of sweeping runs that user wants to trigger.", + "default": 0, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "PT6H", + "type": "string" + }, + "trialTimeout": { + "format": "duration", + "description": "Iteration timeout.", + "default": "PT30M", + "type": "string" + } + }, + "additionalProperties": false + }, + "TargetAggregationFunction": { + "description": "Target aggregate function.", + "enum": [ + "None", + "Sum", + "Max", + "Min", + "Mean" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetAggregationFunction", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Represent no value set." + }, + { + "value": "Sum" + }, + { + "value": "Max" + }, + { + "value": "Min" + }, + { + "value": "Mean" + } + ] + }, + "additionalProperties": false + }, + "TargetLags": { + "description": "The number of past periods to lag from the target column.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Set target lags mode - Auto/Custom", + "$ref": "#/definitions/TargetLagsMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "TargetLagsMode": { + "description": "Target lags selection modes.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetLagsMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Target lags to be determined automatically." + }, + { + "value": "Custom", + "description": "Use the custom target lags." + } + ] + }, + "additionalProperties": false + }, + "TargetRollingWindowSize": { + "description": "Forecasting target rolling window size.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] TargetRollingWindowSiz detection mode.", + "$ref": "#/definitions/TargetRollingWindowSizeMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "TargetRollingWindowSizeMode": { + "description": "Target rolling windows size mode.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetRollingWindowSizeMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Determine rolling windows size automatically." + }, + { + "value": "Custom", + "description": "Use the specified rolling window size." + } + ] + }, + "additionalProperties": false + }, + "TargetUtilizationScaleSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineScaleSettings" + } + ], + "properties": { + "maxInstances": { + "format": "int32", + "description": "The maximum number of instances that the deployment can scale to. The quota will be reserved for max_instances.", + "default": 1, + "type": "integer" + }, + "minInstances": { + "format": "int32", + "description": "The minimum number of instances to always be present.", + "default": 1, + "type": "integer" + }, + "pollingInterval": { + "format": "duration", + "description": "The polling interval in ISO 8691 format. Only supports duration with precision as low as Seconds.", + "default": "PT1S", + "type": "string" + }, + "targetUtilizationPercentage": { + "format": "int32", + "description": "Target CPU usage for the autoscaler.", + "default": 70, + "type": "integer" + } + }, + "x-ms-discriminator-value": "TargetUtilization", + "additionalProperties": false + }, + "TaskType": { + "description": "AutoMLJob Task type.", + "enum": [ + "Classification", + "Regression", + "Forecasting", + "ImageClassification", + "ImageClassificationMultilabel", + "ImageObjectDetection", + "ImageInstanceSegmentation", + "TextClassification", + "TextClassificationMultilabel", + "TextNER" + ], + "type": "string", + "x-ms-enum": { + "name": "TaskType", + "modelAsString": true, + "values": [ + { + "value": "Classification", + "description": "Classification in machine learning and statistics is a supervised learning approach in which\nthe computer program learns from the data given to it and make new observations or classifications." + }, + { + "value": "Regression", + "description": "Regression means to predict the value using the input data. Regression models are used to predict a continuous value." + }, + { + "value": "Forecasting", + "description": "Forecasting is a special kind of regression task that deals with time-series data and creates forecasting model\nthat can be used to predict the near future values based on the inputs." + }, + { + "value": "ImageClassification", + "description": "Image Classification. Multi-class image classification is used when an image is classified with only a single label\nfrom a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'." + }, + { + "value": "ImageClassificationMultilabel", + "description": "Image Classification Multilabel. Multi-label image classification is used when an image could have one or more labels\nfrom a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'." + }, + { + "value": "ImageObjectDetection", + "description": "Image Object Detection. Object detection is used to identify objects in an image and locate each object with a\nbounding box e.g. locate all dogs and cats in an image and draw a bounding box around each." + }, + { + "value": "ImageInstanceSegmentation", + "description": "Image Instance Segmentation. Instance segmentation is used to identify objects in an image at the pixel level,\ndrawing a polygon around each object in the image." + }, + { + "value": "TextClassification", + "description": "Text classification (also known as text tagging or text categorization) is the process of sorting texts into categories.\nCategories are mutually exclusive." + }, + { + "value": "TextClassificationMultilabel", + "description": "Multilabel classification task assigns each sample to a group (zero or more) of target labels." + }, + { + "value": "TextNER", + "description": "Text Named Entity Recognition a.k.a. TextNER.\nNamed Entity Recognition (NER) is the ability to take free-form text and identify the occurrences of entities such as people, locations, organizations, and more." + } + ] + }, + "additionalProperties": false + }, + "TensorFlow": { + "description": "TensorFlow distribution configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + } + ], + "properties": { + "parameterServerCount": { + "format": "int32", + "description": "Number of parameter server tasks.", + "default": 0, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "workerCount": { + "format": "int32", + "description": "Number of workers. If not specified, will default to the instance count.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "TensorFlow", + "additionalProperties": false + }, + "TextAnnotationType": { + "description": "Annotation type of text data.", + "enum": [ + "Classification", + "NamedEntityRecognition" + ], + "type": "string", + "x-ms-enum": { + "name": "TextAnnotationType", + "modelAsString": true, + "values": [ + { + "value": "Classification" + }, + { + "value": "NamedEntityRecognition" + } + ] + }, + "additionalProperties": false + }, + "TextClassification": { + "description": "Text Classification task in AutoML NLP vertical.\r\nNLP - Natural Language Processing.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NlpVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for Text-Classification task.", + "default": "Accuracy", + "$ref": "#/definitions/ClassificationPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "TextClassification", + "additionalProperties": false + }, + "TextClassificationMultilabel": { + "description": "Text Classification Multilabel task in AutoML NLP vertical.\r\nNLP - Natural Language Processing.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NlpVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for Text-Classification-Multilabel task.\r\nCurrently only Accuracy is supported as primary metric, hence user need not set it explicitly.", + "$ref": "#/definitions/ClassificationMultilabelPrimaryMetrics", + "readOnly": true + } + }, + "x-ms-discriminator-value": "TextClassificationMultilabel", + "additionalProperties": false + }, + "TextNer": { + "description": "Text-NER task in AutoML NLP vertical.\r\nNER - Named Entity Recognition.\r\nNLP - Natural Language Processing.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NlpVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for Text-NER task.\r\nOnly 'Accuracy' is supported for Text-NER, so user need not set this explicitly.", + "$ref": "#/definitions/ClassificationPrimaryMetrics", + "readOnly": true + } + }, + "x-ms-discriminator-value": "TextNER", + "additionalProperties": false + }, + "TopNFeaturesByAttribution": { + "required": [ + "filterType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringFeatureFilterBase" + } + ], + "properties": { + "top": { + "format": "int32", + "description": "The number of top features to include.", + "default": 10, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "TopNByAttribution", + "additionalProperties": false + }, + "TrainingMode": { + "description": "Training mode dictates whether to use distributed training or not", + "enum": [ + "Auto", + "Distributed", + "NonDistributed" + ], + "type": "string", + "x-ms-enum": { + "name": "TrainingMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Auto mode" + }, + { + "value": "Distributed", + "description": "Distributed training mode" + }, + { + "value": "NonDistributed", + "description": "Non distributed training mode" + } + ] + }, + "additionalProperties": false + }, + "TrainingSettings": { + "description": "Training related configuration.", + "type": "object", + "properties": { + "enableDnnTraining": { + "description": "Enable recommendation of DNN models.", + "default": false, + "type": "boolean" + }, + "enableModelExplainability": { + "description": "Flag to turn on explainability on best model.", + "default": true, + "type": "boolean" + }, + "enableOnnxCompatibleModels": { + "description": "Flag for enabling onnx compatible models.", + "default": false, + "type": "boolean" + }, + "enableStackEnsemble": { + "description": "Enable stack ensemble run.", + "default": true, + "type": "boolean" + }, + "enableVoteEnsemble": { + "description": "Enable voting ensemble run.", + "default": true, + "type": "boolean" + }, + "ensembleModelDownloadTimeout": { + "format": "duration", + "description": "During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded.\r\nConfigure this parameter with a higher value than 300 secs, if more time is needed.", + "default": "PT5M", + "type": "string" + }, + "stackEnsembleSettings": { + "description": "Stack ensemble settings for stack ensemble run.", + "$ref": "#/definitions/StackEnsembleSettings", + "x-nullable": true + }, + "trainingMode": { + "description": "TrainingMode mode - Setting to 'auto' is same as setting it to 'non-distributed' for now, however in the future may result in mixed mode or heuristics based mode selection. Default is 'auto'.\r\nIf 'Distributed' then only distributed featurization is used and distributed algorithms are chosen.\r\nIf 'NonDistributed' then only non distributed algorithms are chosen.", + "default": "Auto", + "$ref": "#/definitions/TrainingMode" + } + }, + "additionalProperties": false + }, + "TrialComponent": { + "description": "Trial component definition.", + "required": [ + "command", + "environmentId" + ], + "type": "object", + "properties": { + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "command": { + "description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "distribution": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "$ref": "#/definitions/DistributionConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentId": { + "description": "[Required] The ARM resource ID of the Environment specification for the job.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "TriggerBase": { + "required": [ + "triggerType" + ], + "type": "object", + "properties": { + "endTime": { + "description": "Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601.\r\nRecommented format would be \"2022-06-01T00:00:01\"\r\nIf not present, the schedule will run indefinitely", + "type": "string", + "x-nullable": true + }, + "startTime": { + "description": "Specifies start time of schedule in ISO 8601 format, but without a UTC offset.", + "type": "string", + "x-nullable": true + }, + "timeZone": { + "description": "Specifies time zone in which the schedule runs.\r\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11", + "default": "UTC", + "type": "string" + }, + "triggerType": { + "description": "[Required] ", + "$ref": "#/definitions/TriggerType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "discriminator": "triggerType" + }, + "TriggerOnceRequest": { + "required": [ + "scheduleTime" + ], + "type": "object", + "properties": { + "scheduleTime": { + "description": "[Required] Specify the schedule time for trigger once", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, + "TriggerRunSubmissionDto": { + "type": "object", + "properties": { + "scheduleActionType": { + "$ref": "#/definitions/ScheduleType" + }, + "submissionId": { + "type": "string" + } + }, + "additionalProperties": false + }, + "TriggerType": { + "enum": [ + "Recurrence", + "Cron" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerType", + "modelAsString": true, + "values": [ + { + "value": "Recurrence" + }, + { + "value": "Cron" + } + ] + }, + "additionalProperties": false + }, + "TritonInferencingServer": { + "description": "Triton inferencing server configurations.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InferencingServer" + } + ], + "properties": { + "inferenceConfiguration": { + "description": "Inference configuration for Triton.", + "$ref": "#/definitions/OnlineInferenceConfiguration", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Triton", + "additionalProperties": false + }, + "TritonModelJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "triton_model", + "additionalProperties": false + }, + "TritonModelJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "triton_model", + "additionalProperties": false + }, + "TruncationSelectionPolicy": { + "description": "Defines an early termination policy that cancels a given percentage of runs at each evaluation interval.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EarlyTerminationPolicy" + } + ], + "properties": { + "truncationPercentage": { + "format": "int32", + "description": "The percentage of runs to cancel at each evaluation interval.", + "default": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "TruncationSelection", + "additionalProperties": false + }, + "UriFileDataVersion": { + "description": "uri-file data version entity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataVersionBase" + } + ], + "x-ms-discriminator-value": "uri_file", + "additionalProperties": false + }, + "UriFileJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "uri_file", + "additionalProperties": false + }, + "UriFileJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "uri_file", + "additionalProperties": false + }, + "UriFolderDataVersion": { + "description": "uri-folder data version entity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataVersionBase" + } + ], + "x-ms-discriminator-value": "uri_folder", + "additionalProperties": false + }, + "UriFolderJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "uri_folder", + "additionalProperties": false + }, + "UriFolderJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "uri_folder", + "additionalProperties": false + }, + "UseStl": { + "description": "Configure STL Decomposition of the time-series target column.", + "enum": [ + "None", + "Season", + "SeasonTrend" + ], + "type": "string", + "x-ms-enum": { + "name": "UseStl", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No stl decomposition." + }, + { + "value": "Season" + }, + { + "value": "SeasonTrend" + } + ] + }, + "additionalProperties": false + }, + "UserIdentity": { + "description": "User identity configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IdentityConfiguration" + } + ], + "x-ms-discriminator-value": "UserIdentity", + "additionalProperties": false + }, + "ValidationMetricType": { + "description": "Metric computation method to use for validation metrics in image tasks.", + "enum": [ + "None", + "Coco", + "Voc", + "CocoVoc" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationMetricType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No metric." + }, + { + "value": "Coco", + "description": "Coco metric." + }, + { + "value": "Voc", + "description": "Voc metric." + }, + { + "value": "CocoVoc", + "description": "CocoVoc metric." + } + ] + }, + "additionalProperties": false + }, + "Webhook": { + "description": "Webhook base", + "required": [ + "webhookType" + ], + "type": "object", + "properties": { + "eventType": { + "description": "Send callback on a specified notification event", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "webhookType": { + "description": "[Required] Specifies the type of service to send a callback", + "$ref": "#/definitions/WebhookType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "webhookType" + }, + "WebhookType": { + "description": "Enum to determine the webhook callback service type.", + "enum": [ + "AzureDevOps" + ], + "type": "string", + "x-ms-enum": { + "name": "WebhookType", + "modelAsString": true, + "values": [ + { + "value": "AzureDevOps" + } + ] + }, + "additionalProperties": false + }, + "WeekDay": { + "description": "Enum of weekday", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true, + "values": [ + { + "value": "Monday", + "description": "Monday weekday" + }, + { + "value": "Tuesday", + "description": "Tuesday weekday" + }, + { + "value": "Wednesday", + "description": "Wednesday weekday" + }, + { + "value": "Thursday", + "description": "Thursday weekday" + }, + { + "value": "Friday", + "description": "Friday weekday" + }, + { + "value": "Saturday", + "description": "Saturday weekday" + }, + { + "value": "Sunday", + "description": "Sunday weekday" + } + ] + }, + "additionalProperties": false + } + }, + "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/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/registries.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/registries.json new file mode 100644 index 000000000000..39b7a8524a84 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/registries.json @@ -0,0 +1,909 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "version": "2024-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/registries": { + "get": { + "tags": [ + "RegistryManagement" + ], + "summary": "List registries by subscription", + "operationId": "Registries_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List registries by subscription.": { + "$ref": "./examples/Registries/listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries": { + "get": { + "tags": [ + "RegistryManagement" + ], + "summary": "List registries", + "operationId": "Registries_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-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List registries with system created accounts.": { + "$ref": "./examples/Registries/list-SystemCreated.json" + }, + "List registries with user created accounts.": { + "$ref": "./examples/Registries/list-UserCreated.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}": { + "delete": { + "tags": [ + "RegistryManagement" + ], + "summary": "Delete registry", + "operationId": "Registries_Delete", + "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": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No content" + } + }, + "x-ms-examples": { + "Delete Registry.": { + "$ref": "./examples/Registries/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "RegistryManagement" + ], + "summary": "Get registry", + "operationId": "Registries_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": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + }, + "x-ms-examples": { + "Get Registry with system created accounts.": { + "$ref": "./examples/Registries/get-SystemCreated.json" + }, + "Get Registry with user created accounts.": { + "$ref": "./examples/Registries/get-UserCreated.json" + } + } + }, + "patch": { + "tags": [ + "RegistryManagement" + ], + "summary": "Update tags", + "operationId": "Registries_Update", + "consumes": [ + "application/json" + ], + "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": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Details required to create the registry.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialRegistryPartialTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + }, + "x-ms-examples": { + "Update Registry with system created accounts.": { + "$ref": "./examples/Registries/update-SystemCreated.json" + }, + "Update Registry with user created accounts.": { + "$ref": "./examples/Registries/update-UserCreated.json" + } + } + }, + "put": { + "tags": [ + "RegistryManagement" + ], + "summary": "Create or update registry", + "operationId": "Registries_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Details required to create the registry.", + "required": true, + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry with system created accounts.": { + "$ref": "./examples/Registries/createOrUpdate-SystemCreated.json" + }, + "CreateOrUpdate Registry with user created accounts.": { + "$ref": "./examples/Registries/createOrUpdate-UserCreated.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.MachineLearningServices/registries/{registryName}/removeRegions": { + "post": { + "tags": [ + "RegistryManagement" + ], + "summary": "Remove regions from registry", + "operationId": "Registries_RemoveRegions", + "consumes": [ + "application/json" + ], + "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": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Details required to create the registry.", + "required": true, + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Remove regions from registry": { + "$ref": "./examples/Registries/removeRegions.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "AcrDetails": { + "description": "Details of ACR account to be used for the Registry", + "type": "object", + "properties": { + "systemCreatedAcrAccount": { + "description": "Details of system created ACR account to be used for the Registry", + "$ref": "#/definitions/SystemCreatedAcrAccount", + "x-nullable": true + }, + "userCreatedAcrAccount": { + "description": "Details of user created ACR account to be used for the Registry", + "$ref": "#/definitions/UserCreatedAcrAccount", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ArmResourceId": { + "description": "ARM ResourceId of a resource", + "type": "object", + "properties": { + "resourceId": { + "description": "Arm ResourceId is in the format \"/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}\"\r\nor \"/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}\"", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointServiceConnectionStatus": { + "description": "Connection status of the service consumer with the service provider", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointServiceConnectionStatus", + "modelAsString": true + }, + "additionalProperties": false + }, + "RegistryPartialManagedServiceIdentity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + } + ], + "additionalProperties": false + }, + "PartialRegistry": { + "description": "Partial Registry class for PATCH", + "type": "object", + "additionalProperties": false + }, + "PartialRegistryPartialTrackedResource": { + "description": "Strictly used in update requests.", + "type": "object", + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "#/definitions/RegistryPartialManagedServiceIdentity" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "#/definitions/PartialSku" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "PartialSku": { + "description": "Common SKU definition.", + "type": "object", + "properties": { + "capacity": { + "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.", + "type": "integer" + }, + "family": { + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "name": { + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code.", + "type": "string" + }, + "size": { + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.", + "type": "string" + }, + "tier": { + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + } + }, + "additionalProperties": false + }, + "RegistryPrivateEndpointConnection": { + "description": "Private endpoint connection definition.", + "type": "object", + "properties": { + "id": { + "description": "This is the private endpoint connection name created on SRP\r\nFull resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName}", + "type": "string", + "x-nullable": true + }, + "location": { + "description": "Same as workspace location.", + "type": "string", + "x-nullable": true, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the Private Endpoint Connection", + "$ref": "#/definitions/RegistryPrivateEndpointConnectionProperties", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RegistryPrivateEndpointConnectionProperties": { + "description": "Properties of the Private Endpoint Connection", + "type": "object", + "properties": { + "groupIds": { + "description": "The group ids", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "privateEndpoint": { + "description": "The PE network resource that is linked to this PE connection.", + "$ref": "#/definitions/PrivateEndpointResource", + "x-nullable": true + }, + "registryPrivateLinkServiceConnectionState": { + "description": "The connection state.", + "$ref": "#/definitions/RegistryPrivateLinkServiceConnectionState", + "x-nullable": true + }, + "provisioningState": { + "description": "One of null, \"Succeeded\", \"Provisioning\", \"Failed\". While not approved, it's null.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PrivateEndpointResource": { + "description": "The PE network resource that is linked to this PE connection.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpoint" + } + ], + "properties": { + "subnetArmId": { + "description": "The subnetId that the private endpoint is connected to.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RegistryPrivateLinkServiceConnectionState": { + "description": "The connection state.", + "type": "object", + "properties": { + "actionsRequired": { + "description": "Some RP chose \"None\". Other RPs use this for region expansion.", + "type": "string", + "x-nullable": true + }, + "description": { + "description": "User-defined message that, per NRP doc, may be used for approval-related message.", + "type": "string", + "x-nullable": true + }, + "status": { + "description": "Connection status of the service consumer with the service provider", + "$ref": "#/definitions/EndpointServiceConnectionStatus" + } + }, + "additionalProperties": false + }, + "Registry": { + "description": "Details of the Registry", + "type": "object", + "properties": { + "discoveryUrl": { + "description": "Discovery URL for the Registry", + "type": "string", + "x-nullable": true + }, + "intellectualPropertyPublisher": { + "description": "IntellectualPropertyPublisher for the registry", + "type": "string", + "x-nullable": true + }, + "managedResourceGroup": { + "description": "ResourceId of the managed RG if the registry has system created resources", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + }, + "managedResourceGroupSettings": { + "description": "Managed resource group specific settings", + "$ref": "#/definitions/ManagedResourceGroupSettings", + "x-nullable": true + }, + "mlFlowRegistryUri": { + "description": "MLFlow Registry URI for the Registry", + "type": "string", + "x-nullable": true + }, + "registryPrivateEndpointConnections": { + "description": "Private endpoint connections info used for pending connections in private link portal", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryPrivateEndpointConnection" + }, + "x-nullable": true + }, + "publicNetworkAccess": { + "description": "Is the Registry accessible from the internet?\r\nPossible values: \"Enabled\" or \"Disabled\"", + "type": "string", + "x-nullable": true + }, + "regionDetails": { + "description": "Details of each region the registry is in", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryRegionArmDetails" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "x-ms-client-name": "RegistryProperties", + "additionalProperties": false + }, + "RegistryRegionArmDetails": { + "description": "Details for each region the registry is in", + "type": "object", + "properties": { + "acrDetails": { + "description": "List of ACR accounts", + "type": "array", + "items": { + "$ref": "#/definitions/AcrDetails" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "location": { + "description": "The location where the registry exists", + "type": "string", + "x-nullable": true + }, + "storageAccountDetails": { + "description": "List of storage accounts", + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountDetails" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "ManagedResourceGroupSettings": { + "description": "Managed resource group settings", + "type": "object", + "properties": { + "assignedIdentities": { + "description": "List of assigned identities for the managed resource group", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedResourceGroupAssignedIdentities" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "ManagedResourceGroupAssignedIdentities": { + "description": "Details for managed resource group assigned identities.", + "type": "object", + "properties": { + "principalId": { + "description": "Identity principal Id", + "type": "string", + "x-nullable": false + } + }, + "additionalProperties": false + }, + "RegistryTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Registry" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "Registry", + "additionalProperties": false + }, + "RegistryTrackedResourceArmPaginatedResult": { + "description": "A paginated list of Registry entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Registry objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Registry.", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + }, + "additionalProperties": false + }, + "StorageAccountDetails": { + "description": "Details of storage account to be used for the Registry", + "type": "object", + "properties": { + "systemCreatedStorageAccount": { + "description": "Details of system created storage account to be used for the registry", + "$ref": "#/definitions/SystemCreatedStorageAccount", + "x-nullable": true + }, + "userCreatedStorageAccount": { + "description": "Details of user created storage account to be used for the registry", + "$ref": "#/definitions/UserCreatedStorageAccount", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "SystemCreatedAcrAccount": { + "type": "object", + "properties": { + "acrAccountName": { + "description": "Name of the ACR account", + "type": "string", + "x-nullable": true + }, + "acrAccountSku": { + "description": "SKU of the ACR account", + "type": "string", + "x-nullable": true + }, + "armResourceId": { + "description": "This is populated once the ACR account is created.", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "SystemCreatedStorageAccount": { + "type": "object", + "properties": { + "allowBlobPublicAccess": { + "description": "Public blob access allowed", + "type": "boolean" + }, + "armResourceId": { + "description": "This is populated once the storage account is created.", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + }, + "storageAccountHnsEnabled": { + "description": "HNS enabled for storage account", + "type": "boolean" + }, + "storageAccountName": { + "description": "Name of the storage account", + "type": "string", + "x-nullable": true + }, + "storageAccountType": { + "description": "Allowed values:\r\n\"Standard_LRS\",\r\n\"Standard_GRS\",\r\n\"Standard_RAGRS\",\r\n\"Standard_ZRS\",\r\n\"Standard_GZRS\",\r\n\"Standard_RAGZRS\",\r\n\"Premium_LRS\",\r\n\"Premium_ZRS\"", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "UserCreatedAcrAccount": { + "type": "object", + "properties": { + "armResourceId": { + "description": "ARM ResourceId of a resource", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "UserCreatedStorageAccount": { + "type": "object", + "properties": { + "armResourceId": { + "description": "ARM ResourceId of a resource", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + } + }, + "additionalProperties": false + } + }, + "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." + } + }, + "parameters": { + "RegistryNameParameter": { + "name": "registryName", + "description": "Name of Azure Machine Learning registry. This is case-insensitive", + "in": "path", + "type": "string", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceFeatures.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceFeatures.json new file mode 100644 index 000000000000..26b4565a6a0b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceFeatures.json @@ -0,0 +1,114 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "version": "2024-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/features": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all enabled features for a workspace", + "operationId": "WorkspaceFeatures_List", + "x-ms-examples": { + "List Workspace features": { + "$ref": "./examples/WorkspaceFeature/list.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": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListAmlUserFeatureResult" + } + }, + "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" + } + } + } + }, + "definitions": { + "AmlUserFeature": { + "description": "Features enabled for a workspace", + "type": "object", + "properties": { + "id": { + "description": "Specifies the feature ID", + "type": "string" + }, + "displayName": { + "description": "Specifies the feature name ", + "type": "string" + }, + "description": { + "description": "Describes the feature for user experience", + "type": "string" + } + } + }, + "ListAmlUserFeatureResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlUserFeature" + }, + "description": "The list of AML user facing features." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML user features information. Call ListNext() with this to fetch the next page of AML user features information." + } + }, + "description": "The List Aml user feature operation response." + } + }, + "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/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json new file mode 100644 index 000000000000..0aee201cdd37 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json @@ -0,0 +1,5253 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.", + "version": "2024-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/providers/Microsoft.MachineLearningServices/operations": { + "get": { + "tags": [ + "Operation" + ], + "summary": "Lists all of the available Azure Machine Learning Workspaces REST API operations", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/Workspace/operationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "summary": "Lists all the available machine learning workspaces under the specified subscription.", + "operationId": "Workspaces_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/WorkspaceKindParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "aiCapabilities", + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspaces by subscription": { + "$ref": "./examples/Workspace/listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "summary": "Lists all the available machine learning workspaces under the specified resource group.", + "operationId": "Workspaces_ListByResourceGroup", + "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-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/WorkspaceKindParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "aiCapabilities", + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspaces by Resource Group": { + "$ref": "./examples/Workspace/listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}": { + "delete": { + "tags": [ + "Workspaces" + ], + "summary": "Deletes a machine learning workspace.", + "operationId": "Workspaces_Delete", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/WorkspaceForceToPurgeParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace": { + "$ref": "./examples/Workspace/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Workspaces" + ], + "summary": "Gets the properties of the specified machine learning workspace.", + "operationId": "Workspaces_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace": { + "$ref": "./examples/Workspace/get.json" + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "summary": "Updates a machine learning workspace with the specified parameters.", + "operationId": "Workspaces_Update", + "consumes": [ + "application/json" + ], + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The parameters for updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace": { + "$ref": "./examples/Workspace/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Workspaces" + ], + "summary": "Creates or updates a workspace with the specified parameters.", + "operationId": "Workspaces_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The parameters for creating or updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Workspace": { + "$ref": "./examples/Workspace/create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { + "get": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "Lists all the available machine learning workspaces connections under the specified workspace.", + "operationId": "WorkspaceConnections_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/TargetParameter" + }, + { + "$ref": "#/parameters/CategoryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "includeAll", + "description": "query parameter that indicates if get connection call should return both connections and datastores", + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListWorkspaceConnections": { + "$ref": "./examples/WorkspaceConnection/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": { + "delete": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "Delete machine learning workspaces connections by name.", + "operationId": "WorkspaceConnections_Delete", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/delete.json" + } + } + }, + "get": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "Lists machine learning workspaces connections by name.", + "operationId": "WorkspaceConnections_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "#/parameters/AOAIModelsToDeployParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/get.json" + } + } + }, + "patch": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "Update machine learning workspaces connections under the specified workspace.", + "operationId": "WorkspaceConnections_Update", + "consumes": [ + "application/json" + ], + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Parameters for workspace connection update.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionUpdateParameter" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/update.json" + } + } + }, + "put": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "Create or update machine learning workspaces connections under the specified workspace.", + "operationId": "WorkspaceConnections_Create", + "consumes": [ + "application/json" + ], + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The object for creating or updating a new workspace connection", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { + "post": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "List all the secrets of a machine learning workspaces connections.", + "operationId": "WorkspaceConnections_ListSecrets", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AOAIModelsToDeployParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/listSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/testconnection": { + "post": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "Test machine learning workspaces connections under the specified workspace.", + "operationId": "WorkspaceConnections_TestConnection", + "consumes": [ + "application/json" + ], + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Workspace Connection object", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/testConnection.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/deployments": { + "get": { + "tags": [ + "Endpoint" + ], + "summary": "Get all the deployments under the workspace scope", + "operationId": "EndpointDeployment_GetInWorkspace", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/EndpointTypeParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/EndpointDeploymentResourcePropertiesBasicResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Endpoint Deployments In Workspace": { + "$ref": "./examples/Endpoint/Deployment/getInWorkspace.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Diagnose workspace setup issue.", + "operationId": "Workspaces_Diagnose", + "consumes": [ + "application/json" + ], + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The parameter of diagnosing workspace health", + "schema": { + "$ref": "#/definitions/DiagnoseWorkspaceParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/DiagnoseResponseResult" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Diagnose Workspace": { + "$ref": "./examples/Workspace/diagnose.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints": { + "get": { + "tags": [ + "Endpoint" + ], + "summary": "List All the endpoints under this workspace", + "operationId": "Endpoint_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/EndpointTypeParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/EndpointResourcePropertiesBasicResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Endpoint": { + "$ref": "./examples/Endpoint/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}": { + "get": { + "tags": [ + "Endpoint" + ], + "summary": "Gets endpoint resource", + "operationId": "Endpoint_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/EndpointResourcePropertiesBasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Endpoint": { + "$ref": "./examples/Endpoint/get.json" + } + } + }, + "put": { + "tags": [ + "Endpoint" + ], + "summary": "Create or update endpoint resource with the specified parameters", + "operationId": "Endpoint_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Endpoint resource object", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointResourcePropertiesBasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/EndpointResourcePropertiesBasicResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Endpoint": { + "$ref": "./examples/Endpoint/create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/deployments": { + "get": { + "tags": [ + "Endpoint" + ], + "summary": "Get all the deployments under the endpoint resource scope", + "operationId": "EndpointDeployment_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/EndpointDeploymentResourcePropertiesBasicResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Endpoint Deployments": { + "$ref": "./examples/Endpoint/Deployment/getDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/deployments/{deploymentName}": { + "delete": { + "tags": [ + "Endpoint" + ], + "summary": "Delete endpoint deployment resource by name", + "operationId": "EndpointDeployment_Delete", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "Deployment was successfully deleted or doesn't exist." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Endpoint Deployment": { + "$ref": "./examples/Endpoint/Deployment/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Endpoint" + ], + "summary": "Get deployments under endpoint resource by name", + "operationId": "EndpointDeployment_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/EndpointDeploymentResourcePropertiesBasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Endpoint Deployment": { + "$ref": "./examples/Endpoint/Deployment/get.json" + } + } + }, + "put": { + "tags": [ + "Endpoint" + ], + "summary": "Create or update endpoint deployment resource with the specified parameters", + "operationId": "EndpointDeployment_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "deployment object", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointDeploymentResourcePropertiesBasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/EndpointDeploymentResourcePropertiesBasicResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Endpoint Deployment": { + "$ref": "./examples/Endpoint/Deployment/create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/listKeys": { + "post": { + "tags": [ + "Endpoint" + ], + "summary": "List keys for the endpoint resource.", + "operationId": "Endpoint_ListKeys", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/EndpointKeys" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Endpoint Keys": { + "$ref": "./examples/Endpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/models": { + "get": { + "tags": [ + "Endpoint" + ], + "summary": "Get available models under the endpoint resource.", + "operationId": "Endpoint_GetModels", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/EndpointModels" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Endpoint Models": { + "$ref": "./examples/Endpoint/getModels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/regenerateKey": { + "post": { + "tags": [ + "Endpoint" + ], + "summary": "Regenerate account keys", + "operationId": "Endpoint_RegenerateKeys", + "consumes": [ + "application/json" + ], + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateServiceAccountKeyContent" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/AccountApiKeys" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Regenerate Endpoint Keys": { + "$ref": "./examples/Endpoint/regenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.", + "operationId": "Workspaces_ListKeys", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListWorkspaceKeysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Get Azure Machine Learning Workspace notebook access token", + "operationId": "Workspaces_ListNotebookAccessToken", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NotebookAccessTokenResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listNotebookAccessToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Lists keys of Azure Machine Learning Workspaces notebook.", + "operationId": "Workspaces_ListNotebookKeys", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListNotebookKeysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Notebook/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Lists keys of Azure Machine Learning Workspace's storage account.", + "operationId": "Workspaces_ListStorageAccountKeys", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListStorageAccountKeysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listStorageAccountKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "OutboundNetworkDependenciesEndpoints" + ], + "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", + "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExternalFQDNResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListOutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/ExternalFQDN/get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": { + "get": { + "tags": [ + "ManagedNetwork" + ], + "summary": "Lists the managed network outbound rules for a machine learning workspace.", + "operationId": "ManagedNetworkSettingsRule_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/listRule.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { + "delete": { + "tags": [ + "ManagedNetwork" + ], + "summary": "Deletes an outbound rule from the managed network of a machine learning workspace.", + "operationId": "ManagedNetworkSettingsRule_Delete", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/deleteRule.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ManagedNetwork" + ], + "summary": "Gets an outbound rule from the managed network of a machine learning workspace.", + "operationId": "ManagedNetworkSettingsRule_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/getRule.json" + } + } + }, + "put": { + "tags": [ + "ManagedNetwork" + ], + "summary": "Creates or updates an outbound rule in the managed network of a machine learning workspace.", + "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Outbound Rule to be created or updated in the managed network of a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/createOrUpdateRule.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/prepareNotebook": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Prepare Azure Machine Learning Workspace's notebook resource", + "operationId": "Workspaces_PrepareNotebook", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NotebookResourceInfo" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Prepare Notebook": { + "$ref": "./examples/Notebook/prepare.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to get all PE connections.", + "operationId": "PrivateEndpointConnections_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StorageAccountListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnection/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "delete": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to delete a PE connection.", + "operationId": "PrivateEndpointConnections_Delete", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/delete.json" + } + } + }, + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to get a PE connection.", + "operationId": "PrivateEndpointConnections_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspaceGetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/get.json" + } + } + }, + "put": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to approve or reject a PE connection.\r\nThis method must validate and forward the call to NRP.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "PrivateEndpointConnection object", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "WorkspacePrivateLinkResources" + ], + "summary": "Called by Client (Portal, CLI, etc) to get available \"private link resources\" for the workspace.\r\nEach \"private link resource\" is a connection endpoint (IP address) to the resource.\r\nPre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution.\r\nOther RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc.\r\nDefined in the \"[NRP] Private Endpoint Design\" doc, topic \"GET API for GroupIds\".", + "operationId": "PrivateLinkResources_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspaceListPrivateLinkResources": { + "$ref": "./examples/PrivateLinkResource/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/provisionManagedNetwork": { + "post": { + "tags": [ + "ManagedNetwork" + ], + "summary": "Provisions the managed network of a machine learning workspace.", + "operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork", + "consumes": [ + "application/json" + ], + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Managed Network Provisioning Options for a machine learning workspace.", + "schema": { + "$ref": "#/definitions/ManagedNetworkProvisionOptions" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ManagedNetworkProvisionStatus" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Provision ManagedNetwork": { + "$ref": "./examples/ManagedNetwork/provision.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Resync all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ResyncKeys", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Resync Workspace Keys": { + "$ref": "./examples/Workspace/resyncKeys.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "AADAuthTypeWorkspaceConnectionProperties": { + "description": "This connection type covers the AAD auth for any applicable Azure service", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "AAD" + }, + "AccessKeyAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionAccessKey" + } + }, + "x-ms-discriminator-value": "AccessKey" + }, + "AccountApiKeys": { + "type": "object", + "properties": { + "key1": { + "type": "string", + "x-ms-secret": true + }, + "key2": { + "type": "string", + "x-ms-secret": true + } + } + }, + "AccountKeyAuthTypeWorkspaceConnectionProperties": { + "description": "This connection type covers the account key connection for Azure storage", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" + } + }, + "x-ms-discriminator-value": "AccountKey" + }, + "AccountModel": { + "description": "Cognitive Services account Model.", + "type": "object", + "properties": { + "baseModel": { + "type": "object", + "description": "Base Model Identifier.", + "$ref": "#/definitions/DeploymentModel" + }, + "isDefaultVersion": { + "type": "boolean", + "description": "If the model is default version." + }, + "skus": { + "type": "array", + "items": { + "$ref": "#/definitions/ModelSku" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of Model Sku." + }, + "maxCapacity": { + "type": "integer", + "format": "int32", + "description": "The max capacity." + }, + "capabilities": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The capabilities." + }, + "finetuneCapabilities": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The capabilities for finetune models." + }, + "deprecation": { + "type": "object", + "$ref": "#/definitions/ModelDeprecationInfo" + }, + "lifecycleStatus": { + "type": "string", + "enum": [ + "GenerallyAvailable", + "Preview" + ], + "x-ms-enum": { + "name": "ModelLifecycleStatus", + "modelAsString": true + }, + "description": "Model lifecycle status." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DeploymentModel" + } + ] + }, + "ApiKeyAuthWorkspaceConnectionProperties": { + "description": "This connection type covers the generic ApiKey auth connection categories, for examples:\r\nAzureOpenAI:\r\n Category:= AzureOpenAI\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= {ApiBase}\r\n \r\nCognitiveService:\r\n Category:= CognitiveService\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= ServiceRegion={serviceRegion}\r\n \r\nCognitiveSearch:\r\n Category:= CognitiveSearch\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= {Endpoint}\r\n \r\nUse Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionApiKey" + } + }, + "x-ms-discriminator-value": "ApiKey" + }, + "CallRateLimit": { + "type": "object", + "properties": { + "count": { + "type": "number", + "description": "The count value of Call Rate Limit." + }, + "renewalPeriod": { + "type": "number", + "description": "The renewal period in seconds of Call Rate Limit." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "x-ms-identifiers": [ + "key" + ] + } + }, + "description": "The call rate limit Cognitive Services account." + }, + "CapacityConfig": { + "type": "object", + "properties": { + "minimum": { + "type": "integer", + "format": "int32", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "format": "int32", + "description": "The maximum capacity." + }, + "step": { + "type": "integer", + "format": "int32", + "description": "The minimal incremental between allowed values for capacity." + }, + "default": { + "type": "integer", + "format": "int32", + "description": "The default capacity." + }, + "allowedValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The array of allowed values for capacity." + } + }, + "description": "The capacity configuration." + }, + "CognitiveServiceEndpointDeploymentResourceProperties": { + "required": [ + "model" + ], + "type": "object", + "properties": { + "model": { + "description": "Model used for the endpoint deployment.", + "$ref": "#/definitions/EndpointDeploymentModel" + }, + "raiPolicyName": { + "type": "string", + "description": "The name of RAI policy." + }, + "sku": { + "$ref": "#/definitions/CognitiveServicesSku" + }, + "versionUpgradeOption": { + "description": "Deployment model version upgrade option.", + "type": "string", + "enum": [ + "OnceNewDefaultVersionAvailable", + "OnceCurrentVersionExpired", + "NoAutoUpgrade" + ], + "x-ms-enum": { + "name": "DeploymentModelVersionUpgradeOption", + "modelAsString": true + } + } + } + }, + "CognitiveServicesSku": { + "type": "object", + "properties": { + "capacity": { + "format": "int32", + "type": "integer" + }, + "family": { + "type": "string" + }, + "name": { + "type": "string" + }, + "size": { + "type": "string" + }, + "tier": { + "type": "string" + } + } + }, + "ComputeRuntimeDto": { + "type": "object", + "properties": { + "sparkRuntimeVersion": { + "type": "string" + } + } + }, + "ConnectionAuthType": { + "description": "Authentication type of the connection target", + "enum": [ + "PAT", + "ManagedIdentity", + "UsernamePassword", + "None", + "SAS", + "AccountKey", + "ServicePrincipal", + "AccessKey", + "ApiKey", + "CustomKeys", + "OAuth2", + "AAD" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionAuthType", + "modelAsString": true + } + }, + "ConnectionCategory": { + "description": "Category of the connection", + "enum": [ + "PythonFeed", + "ContainerRegistry", + "Git", + "S3", + "Snowflake", + "AzureSqlDb", + "AzureSynapseAnalytics", + "AzureMySqlDb", + "AzurePostgresDb", + "ADLSGen2", + "Redis", + "ApiKey", + "AzureOpenAI", + "CognitiveSearch", + "CognitiveService", + "CustomKeys", + "AzureBlob", + "AzureOneLake", + "CosmosDb", + "CosmosDbMongoDbApi", + "AzureDataExplorer", + "AzureMariaDb", + "AzureDatabricksDeltaLake", + "AzureSqlMi", + "AzureTableStorage", + "AmazonRdsForOracle", + "AmazonRdsForSqlServer", + "AmazonRedshift", + "Db2", + "Drill", + "GoogleBigQuery", + "Greenplum", + "Hbase", + "Hive", + "Impala", + "Informix", + "MariaDb", + "MicrosoftAccess", + "MySql", + "Netezza", + "Oracle", + "Phoenix", + "PostgreSql", + "Presto", + "SapOpenHub", + "SapBw", + "SapHana", + "SapTable", + "Spark", + "SqlServer", + "Sybase", + "Teradata", + "Vertica", + "Cassandra", + "Couchbase", + "MongoDbV2", + "MongoDbAtlas", + "AmazonS3Compatible", + "FileServer", + "FtpServer", + "GoogleCloudStorage", + "Hdfs", + "OracleCloudStorage", + "Sftp", + "GenericHttp", + "ODataRest", + "Odbc", + "GenericRest", + "AmazonMws", + "Concur", + "Dynamics", + "DynamicsAx", + "DynamicsCrm", + "GoogleAdWords", + "Hubspot", + "Jira", + "Magento", + "Marketo", + "Office365", + "Eloqua", + "Responsys", + "OracleServiceCloud", + "PayPal", + "QuickBooks", + "Salesforce", + "SalesforceServiceCloud", + "SalesforceMarketingCloud", + "SapCloudForCustomer", + "SapEcc", + "ServiceNow", + "SharePointOnlineList", + "Shopify", + "Square", + "WebTable", + "Xero", + "Zoho", + "GenericContainerRegistry" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionCategory", + "modelAsString": true + } + }, + "ConnectionGroup": { + "description": "Group based on connection category", + "enum": [ + "Azure", + "AzureAI", + "Database", + "NoSQL", + "File", + "GenericProtocol", + "ServicesAndApps" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionGroup", + "modelAsString": true + } + }, + "ContentSafetyEndpointDeploymentResourceProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServiceEndpointDeploymentResourceProperties" + }, + { + "$ref": "#/definitions/EndpointDeploymentResourceProperties" + } + ], + "x-ms-discriminator-value": "Azure.ContentSafety" + }, + "ContentSafetyEndpointResourceProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointResourceProperties" + } + ], + "x-ms-discriminator-value": "Azure.ContentSafety" + }, + "CosmosDbSettings": { + "type": "object", + "properties": { + "collectionsThroughput": { + "format": "int32", + "type": "integer" + } + } + }, + "CustomKeys": { + "description": "Custom Keys credential object", + "type": "object", + "properties": { + "keys": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CustomKeysWorkspaceConnectionProperties": { + "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "description": "Custom Keys credential object", + "$ref": "#/definitions/CustomKeys" + } + }, + "x-ms-discriminator-value": "CustomKeys" + }, + "DefaultResourceProvisioningState": { + "enum": [ + "NotStarted", + "Failed", + "Creating", + "Updating", + "Succeeded", + "Deleting", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-enum": { + "name": "DefaultResourceProvisioningState", + "modelAsString": true + } + }, + "DeploymentModel": { + "type": "object", + "properties": { + "format": { + "type": "string", + "description": "Deployment model format." + }, + "name": { + "type": "string", + "description": "Deployment model name." + }, + "version": { + "type": "string", + "description": "Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API." + }, + "source": { + "type": "string", + "description": "Optional. Deployment model source ARM resource ID." + }, + "callRateLimit": { + "readOnly": true, + "$ref": "#/definitions/CallRateLimit" + } + }, + "description": "Properties of Cognitive Services account deployment model." + }, + "DiagnoseRequestProperties": { + "type": "object", + "properties": { + "applicationInsights": { + "description": "Setting for diagnosing dependent application insights", + "type": "object", + "additionalProperties": {} + }, + "containerRegistry": { + "description": "Setting for diagnosing dependent container registry", + "type": "object", + "additionalProperties": {} + }, + "dnsResolution": { + "description": "Setting for diagnosing dns resolution", + "type": "object", + "additionalProperties": {} + }, + "keyVault": { + "description": "Setting for diagnosing dependent key vault", + "type": "object", + "additionalProperties": {} + }, + "nsg": { + "description": "Setting for diagnosing network security group", + "type": "object", + "additionalProperties": {} + }, + "others": { + "description": "Setting for diagnosing unclassified category of problems", + "type": "object", + "additionalProperties": {} + }, + "requiredResourceProviders": { + "description": "Setting for diagnosing the presence of required resource providers in the workspace.", + "type": "object", + "additionalProperties": {} + }, + "resourceLock": { + "description": "Setting for diagnosing resource lock", + "type": "object", + "additionalProperties": {} + }, + "storageAccount": { + "description": "Setting for diagnosing dependent storage account", + "type": "object", + "additionalProperties": {} + }, + "udr": { + "description": "Setting for diagnosing user defined routing", + "type": "object", + "additionalProperties": {} + } + } + }, + "DiagnoseResponseResult": { + "type": "object", + "properties": { + "value": { + "type": "object", + "properties": { + "userDefinedRouteResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "networkSecurityRuleResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "resourceLockResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "dnsResolutionResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "storageAccountResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "keyVaultResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "containerRegistryResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "applicationInsightsResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "otherResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + } + } + } + } + }, + "DiagnoseResult": { + "description": "Result of Diagnose", + "type": "object", + "properties": { + "code": { + "description": "Code for workspace setup error", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "level": { + "description": "Level of workspace setup error", + "$ref": "#/definitions/DiagnoseResultLevel", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "message": { + "description": "Message of workspace setup error", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "DiagnoseResultLevel": { + "description": "Level of workspace setup error", + "enum": [ + "Warning", + "Error", + "Information" + ], + "type": "string", + "x-ms-enum": { + "name": "DiagnoseResultLevel", + "modelAsString": true + } + }, + "DiagnoseWorkspaceParameters": { + "description": "Parameters to diagnose a workspace", + "type": "object", + "properties": { + "value": { + "$ref": "#/definitions/DiagnoseRequestProperties" + } + } + }, + "EncryptionKeyVaultUpdateProperties": { + "required": [ + "keyIdentifier" + ], + "type": "object", + "properties": { + "keyIdentifier": { + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + } + }, + "EncryptionProperty": { + "required": [ + "keyVaultProperties", + "status" + ], + "type": "object", + "properties": { + "cosmosDbResourceId": { + "description": "The byok cosmosdb account that customer brings to store customer's data\r\nwith encryption", + "type": "string" + }, + "identity": { + "description": "Identity to be used with the keyVault", + "$ref": "#/definitions/IdentityForCmk" + }, + "keyVaultProperties": { + "description": "KeyVault details to do the encryption", + "$ref": "#/definitions/KeyVaultProperties" + }, + "searchAccountResourceId": { + "description": "The byok search account that customer brings to store customer's data\r\nwith encryption", + "type": "string" + }, + "status": { + "$ref": "#/definitions/EncryptionStatus" + }, + "storageAccountResourceId": { + "description": "The byok storage account that customer brings to store customer's data\r\nwith encryption", + "type": "string" + } + } + }, + "EncryptionStatus": { + "description": "Indicates whether or not the encryption is enabled for the workspace.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } + }, + "EncryptionUpdateProperties": { + "required": [ + "keyVaultProperties" + ], + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties" + } + } + }, + "EndpointDeploymentModel": { + "type": "object", + "properties": { + "format": { + "description": "Model format", + "type": "string" + }, + "name": { + "description": "Model name.", + "type": "string" + }, + "source": { + "description": "Optional. Deployment model source ARM resource ID.", + "type": "string" + }, + "version": { + "description": "Model version.", + "type": "string" + } + } + }, + "EndpointDeploymentResourceProperties": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "failureReason": { + "description": "The failure reason if the creation failed.", + "type": "string" + }, + "provisioningState": { + "description": "Read-only provision state status property.", + "$ref": "#/definitions/DefaultResourceProvisioningState" + }, + "type": { + "description": "Kind of the deployment.", + "minLength": 1, + "pattern": "[a-zA-Z0-9._]", + "type": "string" + } + }, + "discriminator": "type" + }, + "EndpointDeploymentResourcePropertiesBasicResource": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EndpointDeploymentResourceProperties" + } + } + }, + "EndpointDeploymentResourcePropertiesBasicResourceArmPaginatedResult": { + "type": "object", + "properties": { + "nextLink": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDeploymentResourcePropertiesBasicResource" + } + } + } + }, + "EndpointKeys": { + "type": "object", + "properties": { + "keys": { + "description": "Dictionary of Keys for the endpoint.", + "$ref": "#/definitions/AccountApiKeys", + "x-ms-secret": true + } + } + }, + "EndpointModels": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "List of models.", + "type": "array", + "items": { + "$ref": "#/definitions/AccountModel" + } + } + } + }, + "EndpointResourceProperties": { + "required": [ + "endpointType" + ], + "type": "object", + "properties": { + "associatedResourceId": { + "description": "Byo resource id for creating the built-in model service endpoints.", + "type": "string", + "format": "arm-id" + }, + "endpointType": { + "description": "Type of the endpoint.", + "type": "string", + "enum": [ + "Azure.OpenAI", + "Azure.Speech", + "Azure.ContentSafety", + "Azure.Llama", + "managedOnlineEndpoint" + ], + "x-ms-enum": { + "name": "endpointType", + "modelAsString": true + } + }, + "endpointUri": { + "description": "Uri of the endpoint.", + "type": "string", + "format": "url" + }, + "failureReason": { + "description": "The failure reason if the creation failed.", + "type": "string" + }, + "name": { + "description": "Name of the endpoint.", + "type": "string" + }, + "provisioningState": { + "description": "Read-only provision state status property.", + "$ref": "#/definitions/DefaultResourceProvisioningState" + } + }, + "discriminator": "endpointType" + }, + "EndpointResourcePropertiesBasicResource": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EndpointResourceProperties" + } + } + }, + "EndpointResourcePropertiesBasicResourceArmPaginatedResult": { + "type": "object", + "properties": { + "nextLink": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointResourcePropertiesBasicResource" + } + } + } + }, + "ExternalFQDNResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpointsPropertyBag" + }, + "x-ms-identifiers": [ + "/properties/category" + ] + } + } + }, + "FQDNEndpoint": { + "type": "object", + "properties": { + "domainName": { + "type": "string" + }, + "endpointDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpointDetail" + }, + "x-ms-identifiers": [ + "port" + ] + } + } + }, + "FQDNEndpointDetail": { + "type": "object", + "properties": { + "port": { + "format": "int32", + "type": "integer" + } + } + }, + "FQDNEndpoints": { + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpoint" + }, + "x-ms-identifiers": [ + "domainName" + ] + } + } + }, + "FQDNEndpointsPropertyBag": { + "description": "Property bag for FQDN endpoints result", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FQDNEndpoints" + } + } + }, + "FeatureStoreSettings": { + "type": "object", + "properties": { + "computeRuntime": { + "$ref": "#/definitions/ComputeRuntimeDto" + }, + "offlineStoreConnectionName": { + "type": "string" + }, + "onlineStoreConnectionName": { + "type": "string" + } + } + }, + "FqdnOutboundRule": { + "description": "FQDN Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "type": "string" + } + }, + "x-ms-discriminator-value": "FQDN" + }, + "IdentityForCmk": { + "description": "Identity object used for encryption.", + "type": "object", + "properties": { + "userAssignedIdentity": { + "description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault", + "type": "string" + } + } + }, + "IsolationMode": { + "description": "Isolation mode for the managed network of a machine learning workspace.", + "enum": [ + "Disabled", + "AllowInternetOutbound", + "AllowOnlyApprovedOutbound" + ], + "type": "string", + "x-ms-enum": { + "name": "IsolationMode", + "modelAsString": true + } + }, + "KeyVaultProperties": { + "description": "Customer Key vault properties.", + "required": [ + "keyIdentifier", + "keyVaultArmId" + ], + "type": "object", + "properties": { + "identityClientId": { + "description": "Currently, we support only SystemAssigned MSI.\r\nWe need this when we support UserAssignedIdentities", + "type": "string" + }, + "keyIdentifier": { + "description": "KeyVault key identifier to encrypt the data", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "keyVaultArmId": { + "description": "KeyVault Arm Id that contains the data encryption key", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + } + }, + "ListNotebookKeysResult": { + "type": "object", + "properties": { + "primaryAccessKey": { + "description": "The primary access key of the Notebook", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "secondaryAccessKey": { + "description": "The secondary access key of the Notebook", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } + } + }, + "ListStorageAccountKeysResult": { + "type": "object", + "properties": { + "userStorageKey": { + "description": "The access key of the storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } + } + }, + "ListWorkspaceKeysResult": { + "type": "object", + "properties": { + "appInsightsInstrumentationKey": { + "description": "The access key of the workspace app insights", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "containerRegistryCredentials": { + "$ref": "#/definitions/RegistryListCredentialsResult" + }, + "notebookAccessKeys": { + "$ref": "#/definitions/ListNotebookKeysResult" + }, + "userStorageArmId": { + "description": "The arm Id key of the workspace storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "userStorageKey": { + "description": "The access key of the workspace storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } + } + }, + "ManagedIdentityAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" + } + }, + "x-ms-discriminator-value": "ManagedIdentity" + }, + "ManagedNetworkProvisionOptions": { + "description": "Managed Network Provisioning options for managed network of a machine learning workspace.", + "type": "object", + "properties": { + "includeSpark": { + "type": "boolean" + } + } + }, + "ManagedNetworkProvisionStatus": { + "description": "Status of the Provisioning for the managed network of a machine learning workspace.", + "type": "object", + "properties": { + "sparkReady": { + "type": "boolean" + }, + "status": { + "description": "Status for the managed network of a machine learning workspace.", + "$ref": "#/definitions/ManagedNetworkStatus" + } + } + }, + "ManagedNetworkSettings": { + "description": "Managed Network settings for a machine learning workspace.", + "type": "object", + "properties": { + "isolationMode": { + "description": "Isolation mode for the managed network of a machine learning workspace.", + "$ref": "#/definitions/IsolationMode" + }, + "networkId": { + "type": "string", + "readOnly": true + }, + "outboundRules": { + "type": "object", + "additionalProperties": { + "description": "Outbound Rule for the managed network of a machine learning workspace.", + "$ref": "#/definitions/OutboundRule" + }, + "x-nullable": true + }, + "status": { + "description": "Status of the Provisioning for the managed network of a machine learning workspace.", + "$ref": "#/definitions/ManagedNetworkProvisionStatus" + }, + "changeableIsolationModes": { + "type": "array", + "items": { + "$ref": "#/definitions/IsolationMode" + }, + "readOnly": true + } + } + }, + "ManagedNetworkStatus": { + "description": "Status for the managed network of a machine learning workspace.", + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedNetworkStatus", + "modelAsString": true + } + }, + "ManagedOnlineEndpointDeploymentResourceProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointDeploymentResourceProperties" + } + ], + "x-ms-discriminator-value": "managedOnlineEndpoint" + }, + "ManagedOnlineEndpointResourceProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointResourceProperties" + } + ], + "x-ms-discriminator-value": "managedOnlineEndpoint" + }, + "ModelDeprecationInfo": { + "description": "Cognitive Services account ModelDeprecationInfo.", + "type": "object", + "properties": { + "fineTune": { + "type": "string", + "description": "The datetime of deprecation of the fineTune Model." + }, + "inference": { + "type": "string", + "description": "The datetime of deprecation of the inference Model." + } + } + }, + "ModelSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the model SKU." + }, + "usageName": { + "type": "string", + "description": "The usage name of the model SKU." + }, + "deprecationDate": { + "type": "string", + "format": "date-time", + "description": "The datetime of deprecation of the model SKU." + }, + "capacity": { + "type": "object", + "description": "The capacity configuration.", + "$ref": "#/definitions/CapacityConfig" + }, + "rateLimits": { + "type": "array", + "items": { + "$ref": "#/definitions/CallRateLimit" + }, + "x-ms-identifiers": [], + "description": "The list of rateLimit." + } + }, + "description": "Describes an available Cognitive Services Model SKU." + }, + "NoneAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "None" + }, + "NotebookAccessTokenResult": { + "type": "object", + "properties": { + "accessToken": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "expiresIn": { + "format": "int32", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "hostName": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "notebookResourceId": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "publicDns": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "refreshToken": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "scope": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "tokenType": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "NotebookPreparationError": { + "type": "object", + "properties": { + "errorMessage": { + "type": "string" + }, + "statusCode": { + "format": "int32", + "type": "integer" + } + } + }, + "NotebookResourceInfo": { + "type": "object", + "properties": { + "fqdn": { + "type": "string" + }, + "isPrivateLinkEnabled": { + "type": "boolean" + }, + "notebookPreparationError": { + "description": "The error that occurs when preparing notebook.", + "$ref": "#/definitions/NotebookPreparationError" + }, + "resourceId": { + "description": "the data plane resourceId that used to initialize notebook component", + "type": "string" + } + } + }, + "OAuth2AuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionOAuth2" + } + }, + "x-ms-discriminator-value": "OAuth2" + }, + "OpenAIEndpointDeploymentResourceProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServiceEndpointDeploymentResourceProperties" + }, + { + "$ref": "#/definitions/EndpointDeploymentResourceProperties" + } + ], + "x-ms-discriminator-value": "Azure.OpenAI" + }, + "OpenAIEndpointResourceProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointResourceProperties" + } + ], + "x-ms-discriminator-value": "Azure.OpenAI" + }, + "OutboundRule": { + "description": "Outbound Rule for the managed network of a machine learning workspace.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "category": { + "description": "Category of a managed network Outbound Rule of a machine learning workspace.", + "$ref": "#/definitions/RuleCategory" + }, + "status": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "$ref": "#/definitions/RuleStatus" + }, + "type": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "$ref": "#/definitions/RuleType" + } + }, + "discriminator": "type" + }, + "OutboundRuleBasicResource": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Outbound Rule for the managed network of a machine learning workspace.", + "$ref": "#/definitions/OutboundRule" + } + } + }, + "OutboundRuleListResult": { + "description": "List of outbound rules for the managed network of a machine learning workspace.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } + } + }, + "PATAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken" + } + }, + "x-ms-discriminator-value": "PAT" + }, + "Password": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "value": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } + } + }, + "PrivateEndpointConnection": { + "description": "The Private Endpoint Connection resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "description": "Same as workspace location.", + "type": "string" + }, + "properties": { + "description": "Private endpoint connection properties.", + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true + }, + "sku": { + "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PrivateEndpointConnectionListResult": { + "description": "List of private endpoint connection associated with the specified workspace", + "type": "object", + "properties": { + "value": { + "description": "Array of private endpoint connections", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/WorkspacePrivateEndpointResource" + }, + "privateLinkServiceConnectionState": { + "description": "The connection state.", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState" + } + } + }, + "PrivateEndpointConnectionProvisioningState": { + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateEndpointDestination": { + "description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", + "properties": { + "serviceResourceId": { + "type": "string", + "format": "arm-id" + }, + "sparkEnabled": { + "type": "boolean" + }, + "sparkStatus": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "$ref": "#/definitions/RuleStatus" + }, + "subresourceTarget": { + "type": "string" + } + } + }, + "PrivateEndpointOutboundRule": { + "description": "Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "$ref": "#/definitions/PrivateEndpointDestination" + } + }, + "x-ms-discriminator-value": "PrivateEndpoint" + }, + "PrivateEndpointServiceConnectionStatus": { + "description": "Connection status of the service consumer with the service provider\r\nPossible state transitions\r\nPending -> Approved (Service provider approves the connection request)\r\nPending -> Rejected (Service provider rejects the connection request)\r\nPending -> Disconnected (Service provider deletes the connection)\r\nApproved -> Rejected (Service provider rejects the approved connection)\r\nApproved -> Disconnected (Service provider deletes the connection)\r\nRejected -> Pending (Service consumer re-initiates the connection request that was rejected)\r\nRejected -> Disconnected (Service provider deletes the connection)", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "description": "Same as workspace location.", + "type": "string" + }, + "properties": { + "description": "Properties of a private link resource.", + "$ref": "#/definitions/PrivateLinkResourceProperties", + "x-ms-client-flatten": true + }, + "sku": { + "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PrivateLinkResourceListResult": { + "description": "A list of private link resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Properties of a private link resource.", + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string" + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The private link resource Private link DNS zone name.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "A collection of information about the state of the connection between service consumer and provider.", + "type": "object", + "properties": { + "actionsRequired": { + "description": "Some RP chose \"None\". Other RPs use this for region expansion.", + "type": "string" + }, + "description": { + "description": "User-defined message that, per NRP doc, may be used for approval-related message.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + } + } + }, + "ProvisioningState": { + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "PublicNetworkAccessType": { + "description": "The public network access flag.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true + } + }, + "RegenerateServiceAccountKeyContent": { + "type": "object", + "properties": { + "keyName": { + "$ref": "#/definitions/ServiceAccountKeyName" + } + } + }, + "RegistryListCredentialsResult": { + "type": "object", + "properties": { + "location": { + "description": "The location of the workspace ACR", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "passwords": { + "type": "array", + "items": { + "$ref": "#/definitions/Password" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "username": { + "description": "The username of the workspace ACR", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "RequestMatchPattern": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "method": { + "type": "string" + } + } + }, + "RuleAction": { + "description": "The action enum for networking rule.", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleAction", + "modelAsString": true + } + }, + "RuleCategory": { + "description": "Category of a managed network Outbound Rule of a machine learning workspace.", + "enum": [ + "Required", + "Recommended", + "UserDefined" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleCategory", + "modelAsString": true + } + }, + "RuleStatus": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleStatus", + "modelAsString": true + } + }, + "RuleType": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "enum": [ + "FQDN", + "PrivateEndpoint", + "ServiceTag" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleType", + "modelAsString": true + } + }, + "SASAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" + } + }, + "x-ms-discriminator-value": "SAS" + }, + "ServerlessComputeSettings": { + "type": "object", + "properties": { + "serverlessComputeCustomSubnet": { + "description": "The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed", + "type": "string", + "format": "arm-id" + }, + "serverlessComputeNoPublicIP": { + "description": "The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint", + "type": "boolean" + } + } + }, + "ServiceAccountKeyName": { + "enum": [ + "Key1", + "Key2" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceAccountKeyName", + "modelAsString": true + } + }, + "ServiceManagedResourcesSettings": { + "type": "object", + "properties": { + "cosmosDb": { + "$ref": "#/definitions/CosmosDbSettings" + } + } + }, + "ServicePrincipalAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" + } + }, + "x-ms-discriminator-value": "ServicePrincipal" + }, + "ServiceTagDestination": { + "description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", + "properties": { + "action": { + "description": "The action enum for networking rule.", + "$ref": "#/definitions/RuleAction" + }, + "addressPrefixes": { + "description": "Optional, if provided, the ServiceTag property will be ignored.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "portRanges": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "serviceTag": { + "type": "string" + } + } + }, + "ServiceTagOutboundRule": { + "description": "Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "$ref": "#/definitions/ServiceTagDestination" + } + }, + "x-ms-discriminator-value": "ServiceTag" + }, + "SharedPrivateLinkResource": { + "type": "object", + "properties": { + "name": { + "description": "Unique name of the private link", + "type": "string" + }, + "properties": { + "description": "Properties of a shared private link resource.", + "$ref": "#/definitions/SharedPrivateLinkResourceProperty", + "x-ms-client-flatten": true + } + } + }, + "SharedPrivateLinkResourceProperty": { + "description": "Properties of a shared private link resource.", + "type": "object", + "properties": { + "groupId": { + "description": "group id of the private link", + "type": "string" + }, + "privateLinkResourceId": { + "description": "the resource id that private link links to", + "type": "string" + }, + "requestMessage": { + "description": "Request message", + "type": "string" + }, + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + } + } + }, + "SpeechEndpointDeploymentResourceProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServiceEndpointDeploymentResourceProperties" + }, + { + "$ref": "#/definitions/EndpointDeploymentResourceProperties" + } + ], + "x-ms-discriminator-value": "Azure.Speech" + }, + "SpeechEndpointResourceProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointResourceProperties" + } + ], + "x-ms-discriminator-value": "Azure.Speech" + }, + "ThrottlingRule": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "renewalPeriod": { + "type": "number" + }, + "count": { + "type": "number" + }, + "minCount": { + "type": "number" + }, + "dynamicThrottlingEnabled": { + "type": "boolean" + }, + "matchPatterns": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestMatchPattern" + }, + "x-ms-identifiers": [ + "path", + "method" + ] + } + } + }, + "UsernamePasswordAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" + } + }, + "x-ms-discriminator-value": "UsernamePassword" + }, + "Workspace": { + "description": "An object that represents a machine learning workspace.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "type": "string" + }, + "location": { + "type": "string" + }, + "properties": { + "description": "Additional attributes of the entity.", + "$ref": "#/definitions/WorkspaceProperties", + "x-ms-client-flatten": true + }, + "sku": { + "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WorkspaceConnectionAccessKey": { + "type": "object", + "properties": { + "accessKeyId": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" + } + } + }, + "WorkspaceConnectionApiKey": { + "description": "Api key object for workspace connection credential.", + "type": "object", + "properties": { + "key": { + "type": "string" + } + } + }, + "WorkspaceConnectionManagedIdentity": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "resourceId": { + "type": "string" + } + } + }, + "WorkspaceConnectionOAuth2": { + "description": "ClientId and ClientSecret are required. Other properties are optional\r\ndepending on each OAuth2 provider's implementation.", + "type": "object", + "properties": { + "authUrl": { + "description": "Required by Concur connection category", + "type": "string", + "format": "url" + }, + "clientId": { + "type": "string", + "description": "Client id in the format of UUID", + "format": "uuid" + }, + "clientSecret": { + "type": "string", + "x-ms-secret": true + }, + "developerToken": { + "description": "Required by GoogleAdWords connection category", + "type": "string", + "x-ms-secret": true + }, + "password": { + "type": "string", + "x-ms-secret": true + }, + "refreshToken": { + "description": "Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho\r\nwhere user needs to get RefreshToken offline", + "type": "string", + "x-ms-secret": true + }, + "tenantId": { + "description": "Required by QuickBooks and Xero connection categories", + "type": "string" + }, + "username": { + "description": "Concur, ServiceNow auth server AccessToken grant type is 'Password'\r\nwhich requires UsernamePassword", + "type": "string" + } + } + }, + "WorkspaceConnectionPersonalAccessToken": { + "type": "object", + "properties": { + "pat": { + "type": "string" + } + } + }, + "WorkspaceConnectionPropertiesV2": { + "required": [ + "authType" + ], + "type": "object", + "properties": { + "authType": { + "description": "Authentication type of the connection target", + "$ref": "#/definitions/ConnectionAuthType" + }, + "category": { + "description": "Category of the connection", + "$ref": "#/definitions/ConnectionCategory" + }, + "createdByWorkspaceArmId": { + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "expiryTime": { + "format": "date-time", + "type": "string" + }, + "group": { + "description": "Group based on connection category", + "$ref": "#/definitions/ConnectionGroup", + "readOnly": true + }, + "isSharedToAll": { + "type": "boolean" + }, + "metadata": { + "type": "object" + }, + "sharedUserList": { + "type": "array", + "items": { + "type": "string" + } + }, + "target": { + "type": "string" + } + }, + "discriminator": "authType" + }, + "WorkspaceConnectionPropertiesV2BasicResource": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + } + }, + "WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult": { + "type": "object", + "properties": { + "nextLink": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + } + } + }, + "WorkspaceConnectionServicePrincipal": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string" + }, + "tenantId": { + "type": "string" + } + } + }, + "WorkspaceConnectionSharedAccessSignature": { + "type": "object", + "properties": { + "sas": { + "type": "string" + } + } + }, + "WorkspaceConnectionUpdateParameter": { + "description": "The properties that the machine learning workspace connection will be updated with.", + "type": "object", + "properties": { + "properties": { + "description": "The properties that the machine learning workspace connection will be updated with.", + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + } + }, + "WorkspaceConnectionUsernamePassword": { + "type": "object", + "properties": { + "password": { + "type": "string" + }, + "securityToken": { + "description": "Optional, required by connections like SalesForce for extra security in addition to UsernamePassword", + "type": "string", + "x-ms-secret": true + }, + "username": { + "type": "string" + } + } + }, + "WorkspaceHubConfig": { + "description": "WorkspaceHub's configuration object.", + "type": "object", + "properties": { + "additionalWorkspaceStorageAccounts": { + "type": "array", + "items": { + "type": "string" + } + }, + "defaultWorkspaceResourceGroup": { + "type": "string" + } + } + }, + "WorkspaceListResult": { + "description": "The result of a request to list machine learning workspaces.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + } + } + }, + "WorkspacePrivateEndpointResource": { + "description": "The Private Endpoint resource.", + "type": "object", + "properties": { + "id": { + "description": "e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "subnetArmId": { + "description": "The subnetId that the private endpoint is connected to.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "WorkspaceProperties": { + "description": "The properties of a machine learning workspace.", + "type": "object", + "properties": { + "allowPublicAccessWhenBehindVnet": { + "description": "The flag to indicate whether to allow public access when behind VNet.", + "type": "boolean" + }, + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" + }, + "associatedWorkspaces": { + "type": "array", + "items": { + "type": "string" + } + }, + "containerRegistries": { + "type": "array", + "items": { + "type": "string" + } + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace.", + "type": "string" + }, + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "discoveryUrl": { + "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", + "type": "string" + }, + "enableDataIsolation": { + "type": "boolean" + }, + "enableSoftwareBillOfMaterials": { + "description": "Flag to tell if SoftwareBillOfMaterial should be enabled for this workspace", + "type": "boolean" + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperty" + }, + "existingWorkspaces": { + "type": "array", + "items": { + "type": "string" + } + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" + }, + "hbiWorkspace": { + "description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service", + "type": "boolean" + }, + "hubResourceId": { + "type": "string" + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "ipAllowlist": { + "description": "The list of IPv4 addresses that are allowed to access the workspace.", + "type": "array", + "items": { + "type": "string" + } + }, + "keyVault": { + "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "keyVaults": { + "type": "array", + "items": { + "type": "string" + } + }, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" + }, + "mlFlowTrackingUri": { + "description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "notebookInfo": { + "description": "The notebook info of Azure ML workspace.", + "$ref": "#/definitions/NotebookResourceInfo", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "primaryUserAssignedIdentity": { + "description": "The user assigned identity resource id that represents the workspace identity.", + "type": "string" + }, + "privateEndpointConnections": { + "description": "The list of private endpoint connections in the workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-identifiers": [ + "name" + ] + }, + "privateLinkCount": { + "format": "int32", + "description": "Count of private connections in the workspace", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "provisioningState": { + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "serverlessComputeSettings": { + "description": "Settings for serverless compute in a workspace", + "$ref": "#/definitions/ServerlessComputeSettings" + }, + "serviceManagedResourcesSettings": { + "description": "The service managed resource settings.", + "$ref": "#/definitions/ServiceManagedResourcesSettings" + }, + "serviceProvisionedResourceGroup": { + "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "sharedPrivateLinkResources": { + "description": "The list of shared private link resources in this workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "softDeleteRetentionInDays": { + "format": "int32", + "description": "Retention time in days after workspace get soft deleted.", + "type": "integer" + }, + "storageAccount": { + "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "storageAccounts": { + "type": "array", + "items": { + "type": "string" + } + }, + "storageHnsEnabled": { + "description": "If the storage associated with the workspace has hierarchical namespace(HNS) enabled.", + "type": "boolean", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "systemDatastoresAuthMode": { + "description": "The auth mode used for accessing the system datastores of the workspace.", + "type": "string" + }, + "tenantId": { + "description": "The tenant id associated with this workspace.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "v1LegacyMode": { + "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "type": "boolean" + }, + "workspaceHubConfig": { + "description": "WorkspaceHub's configuration object.", + "$ref": "#/definitions/WorkspaceHubConfig" + }, + "workspaceId": { + "description": "The immutable id associated with this workspace.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "WorkspacePropertiesUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", + "type": "object", + "properties": { + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace.", + "type": "string" + }, + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "enableDataIsolation": { + "type": "boolean" + }, + "enableSoftwareBillOfMaterials": { + "description": "Flag to tell if SoftwareBillOfMaterial should be enabled for this workspace", + "type": "boolean" + }, + "encryption": { + "$ref": "#/definitions/EncryptionUpdateProperties" + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "ipAllowlist": { + "description": "The list of IPv4 addresses that are allowed to access the workspace.", + "type": "array", + "items": { + "type": "string" + } + }, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" + }, + "primaryUserAssignedIdentity": { + "description": "The user assigned identity resource id that represents the workspace identity.", + "type": "string" + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "serverlessComputeSettings": { + "description": "Settings for serverless compute in a workspace", + "$ref": "#/definitions/ServerlessComputeSettings" + }, + "serviceManagedResourcesSettings": { + "description": "The service managed resource settings.", + "$ref": "#/definitions/ServiceManagedResourcesSettings" + }, + "softDeleteRetentionInDays": { + "format": "int32", + "description": "Retention time in days after workspace get soft deleted.", + "type": "integer" + }, + "v1LegacyMode": { + "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "type": "boolean" + } + } + }, + "WorkspaceUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "description": "The properties that the machine learning workspace will be updated with.", + "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", + "x-ms-client-flatten": true + }, + "sku": { + "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + }, + "tags": { + "description": "The resource tags for the machine learning workspace.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": { + "WorkspaceKindParameter": { + "in": "query", + "name": "kind", + "description": "Kind of workspace.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "PaginationParameter": { + "in": "query", + "name": "$skip", + "description": "Continuation token for pagination.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "in": "path", + "name": "workspaceName", + "description": "Azure Machine Learning Workspace Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "WorkspaceForceToPurgeParameter": { + "in": "query", + "name": "forceToPurge", + "description": "Flag to indicate delete is a purge request.", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "TargetParameter": { + "in": "query", + "name": "target", + "description": "Target of the workspace connection.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "CategoryParameter": { + "in": "query", + "name": "category", + "description": "Category of the workspace connection.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConnectionName": { + "in": "path", + "name": "connectionName", + "description": "Friendly name of the workspace connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "AOAIModelsToDeployParameter": { + "in": "query", + "name": "aoaiModelsToDeploy", + "description": "query parameter for which AOAI mode should be deployed", + "type": "string", + "x-ms-parameter-location": "method" + }, + "EndpointTypeParameter": { + "in": "query", + "name": "endpointType", + "description": "Endpoint type filter", + "type": "string", + "enum": [ + "Azure.OpenAI", + "Azure.Speech", + "Azure.ContentSafety", + "Azure.Llama", + "managedOnlineEndpoint" + ], + "x-ms-enum": { + "name": "endpointType", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "EndpointNameParameter": { + "in": "path", + "name": "endpointName", + "description": "Name of the endpoint resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]{2,32}$" + }, + "DeploymentNameParameter": { + "in": "path", + "name": "deploymentName", + "description": "Name of the deployment resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "RuleName": { + "in": "path", + "name": "ruleName", + "description": "Name of the workspace managed network outbound rule", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "PrivateEndpointConnectionName": { + "in": "path", + "name": "privateEndpointConnectionName", + "description": "NRP Private Endpoint Connection Name", + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/mfe.json index 618d167b57b0..7169863e45a1 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/mfe.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/mfe.json @@ -19346,7 +19346,7 @@ }, "maxQueueWait": { "format": "duration", - "description": "The maximum amount of time a request will stay in the queue in ISO 8601 format.\r\nDefaults to 500ms.", + "description": "(Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format.\r\nDefaults to 500ms.\r\n(Now increase `request_timeout_ms` to account for any networking/queue delays)", "default": "PT0.5S", "type": "string" }, diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index f59c94a49181..19d9ed823a70 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -26,15 +26,71 @@ These are the global settings for the Machine Learning Services API. ``` yaml openapi-type: arm -tag: package-preview-2023-08 +tag: package-preview-2024-01 ``` +### Tag: package-preview-2024-01 + +These settings apply only when `--tag=package-preview-2024-01` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-01' +input-file: + - Microsoft.MachineLearningServices/preview/2024-01-01-preview/machineLearningServices.json + - Microsoft.MachineLearningServices/preview/2024-01-01-preview/mfe.json + - Microsoft.MachineLearningServices/preview/2024-01-01-preview/registries.json + - Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceFeatures.json + - Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json +suppressions: + - code: PathForResourceAction + reason: Keep identical to stable GA version to avoid breaking changes. https://dev.azure.com/msdata/Vienna/_workitems/edit/2803196 + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/datareferences/{name}/versions/{version}"].post + - code: AvoidAdditionalProperties + reason: As discussed these are hyperparameters which can vary by model and fine tuning task types so cannot have strictly typed properties. + where: + - $.definitions["CustomModelFineTuning"].properties["hyperParameters"] + - code: AvoidAdditionalProperties + reason: This is coming for wrong reason, just inheriting from JobBase. + where: + - $.definitions["FineTuningJob"].allOf[0]["allOf"][0].properties["properties"] + - $.definitions["FineTuningJob"].allOf[0].properties["notificationSetting"].properties["webhooks"] + - $.definitions["FineTuningJob"].allOf[0].properties["secretsConfiguration"] + - $.definitions["FineTuningJob"].allOf[0].properties["services"] + - $.definitions["FineTuningJob"].allOf[0].properties["services"].additionalProperties["properties"].properties + - code: AvoidAdditionalProperties + reason: There is a similar usage in existing jobs. + where: + - $.definitions["FineTuningJob"].properties["outputs"] + - code: ProvisioningStateSpecifiedForLROPut + reason: Service already using 202 response code for the below APIs, got exceptions from ARM reviewer. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/deployments/{deploymentName}"].put + - code: PutResponseCodes + reason: Service already using 202 response code for the below APIs, got exceptions from ARM reviewer. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/deployments/{deploymentName}"].put + - code: AvoidAdditionalProperties + reason: This is an external reference right now, we will have full control on the schema returned in the upcoming version and will avoid this. + from: workspaceRP.json + where: + - $.definitions.AccountModel.properties.finetuneCapabilities + - $.definitions.AccountModel.properties.capabilities + - $.definitions.EndpointModels.properties.value.items.properties.capabilities + - $.definitions.EndpointModels.properties.value.items.properties.finetuneCapabilities + - code: GuidUsage + reason: This property has always been a GUID, we just didn't mark its format before, this can't be change without breaking the customer. + from: workspaceRP.json + where: + - $.definitions.WorkspaceConnectionOAuth2.properties.clientId.format +``` ### Tag: package-preview-2023-08 These settings apply only when `--tag=package-preview-2023-08` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-08' +``` yaml $(tag) == 'package-preview-2023-08' input-file: - Microsoft.MachineLearningServices/preview/2023-08-01-preview/machineLearningServices.json - Microsoft.MachineLearningServices/preview/2023-08-01-preview/mfe.json @@ -56,7 +112,7 @@ suppressions: These settings apply only when `--tag=package-2023-10` is specified on the command line. -```yaml $(tag) == 'package-2023-10' +``` yaml $(tag) == 'package-2023-10' input-file: - Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json - Microsoft.MachineLearningServices/stable/2023-10-01/mfe.json diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_EvaluatePointInPolygon.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_EvaluatePointInPolygon.json deleted file mode 100644 index 5d94dd13c8c0..000000000000 --- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_EvaluatePointInPolygon.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "geography": "us", - "format": "json", - "api-version": "1.0", - "udid": "[udid]", - "lat": 47.622942, - "lon": -122.316456 - }, - "responses": { - "200": { - "body": { - "summary": { - "sourcePoint": { - "lat": 33.5362475, - "lon": -111.9267386 - }, - "udid": "[udid from request]", - "information": "4 polygons processed in user data" - }, - "result": { - "pointInPolygons": true, - "intersectingGeometries": [ - "1001", - "1003" - ] - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetBuffer.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetBuffer.json deleted file mode 100644 index f0cdf649b353..000000000000 --- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetBuffer.json +++ /dev/null @@ -1,170 +0,0 @@ -{ - "parameters": { - "geography": "us", - "format": "json", - "api-version": "1.0", - "udid": "[udid]", - "distances": "176.3" - }, - "responses": { - "200": { - "body": { - "summary": { - "udid": "[udid from request]", - "information": "1 feature processed in user data" - }, - "result": { - "type": "FeatureCollection", - "features": [ - { - "type": "Feature", - "properties": { - "geometryId": "ExampleId", - "bufferDist": 176.3 - }, - "geometry": { - "type": "Polygon", - "coordinates": [ - [ - [ - -111.92483859605078, - 33.5362475 - ], - [ - -111.92487510409389, - 33.53587682761772 - ], - [ - -111.92498322523961, - 33.535520399967204 - ], - [ - -111.92515880445296, - 33.535191914363196 - ], - [ - -111.92539509432322, - 33.53490399432323 - ], - [ - -111.92568301436319, - 33.534667704452971 - ], - [ - -111.9260114999672, - 33.53449212523963 - ], - [ - -111.9263679276177, - 33.5343840040939 - ], - [ - -111.9267386, - 33.534347496050785 - ], - [ - -111.92710927238228, - 33.5343840040939 - ], - [ - -111.92746570003278, - 33.53449212523963 - ], - [ - -111.9277941856368, - 33.534667704452971 - ], - [ - -111.92808210567676, - 33.53490399432323 - ], - [ - -111.92831839554702, - 33.535191914363196 - ], - [ - -111.92849397476037, - 33.535520399967204 - ], - [ - -111.9286020959061, - 33.53587682761772 - ], - [ - -111.92863860394921, - 33.5362475 - ], - [ - -111.9286020959061, - 33.536618172382283 - ], - [ - -111.92849397476037, - 33.5369746000328 - ], - [ - -111.92831839554702, - 33.537303085636808 - ], - [ - -111.92808210567676, - 33.537591005676774 - ], - [ - -111.9277941856368, - 33.537827295547032 - ], - [ - -111.92746570003278, - 33.538002874760373 - ], - [ - -111.92710927238228, - 33.5381109959061 - ], - [ - -111.9267386, - 33.538147503949219 - ], - [ - -111.9263679276177, - 33.5381109959061 - ], - [ - -111.9260114999672, - 33.538002874760373 - ], - [ - -111.92568301436319, - 33.537827295547032 - ], - [ - -111.92539509432322, - 33.537591005676774 - ], - [ - -111.92515880445296, - 33.537303085636808 - ], - [ - -111.92498322523961, - 33.5369746000328 - ], - [ - -111.92487510409389, - 33.536618172382283 - ], - [ - -111.92483859605078, - 33.5362475 - ] - ] - ] - } - } - ] - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetClosestPoint.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetClosestPoint.json deleted file mode 100644 index 426ebeaf3725..000000000000 --- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetClosestPoint.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "geography": "us", - "format": "json", - "api-version": "1.0", - "udid": "[udid]", - "lat": 47.622942, - "lon": -122.316456 - }, - "responses": { - "200": { - "body": { - "summary": { - "sourcePoint": { - "lat": 47.622942, - "lon": -122.316456 - }, - "udid": "[udid from request]", - "information": "10 points processed in user data" - }, - "result": [ - { - "distanceInMeters": 1587492.66, - "position": { - "lat": 40.516153406773952, - "lon": -105.02860293715861 - }, - "geometryId": "1001" - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGeofence.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGeofence.json deleted file mode 100644 index 774de28742a6..000000000000 --- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGeofence.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "geography": "us", - "format": "json", - "api-version": "1.0", - "deviceId": "unique_device_name_under_account", - "udid": "[udId]", - "lat": 48.36, - "lon": -124.63, - "searchBuffer": 50, - "userTime": "2017-07-21T17:32:28Z", - "isAsync": true, - "mode": "EnterAndExit" - }, - "responses": { - "200": { - "body": { - "geometries": [ - { - "deviceId": "unique_device_name_under_account", - "udId": "[udId]", - "geometryId": "2", - "distance": 999, - "nearestLat": 47.621954, - "nearestLon": -122.131841 - }, - { - "deviceId": "unique_device_name_under_account", - "udId": "[udId]", - "geometryId": "1", - "distance": -999, - "nearestLat": 47.609833, - "nearestLon": -122.148274 - } - ], - "expiredGeofenceGeometryId": [ - "5" - ], - "invalidPeriodGeofenceGeometryId": [ - "3", - "4" - ], - "isEventPublished": true - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGreatCircleDistance.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGreatCircleDistance.json deleted file mode 100644 index 0565252283f3..000000000000 --- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGreatCircleDistance.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "geography": "us", - "format": "json", - "api-version": "1.0", - "query": "47.622942,-122.316456:47.610378,-122.200676" - }, - "responses": { - "200": { - "body": { - "summary": { - "sourcePoint": { - "lat": 47.622942, - "lon": -122.316456 - }, - "targetPoint": { - "lat": 47.610378, - "lon": -122.200676 - } - }, - "result": { - "distanceInMeters": 8797.62 - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostBuffer.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostBuffer.json deleted file mode 100644 index 201618ac2347..000000000000 --- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostBuffer.json +++ /dev/null @@ -1,191 +0,0 @@ -{ - "parameters": { - "geography": "us", - "format": "json", - "api-version": "1.0", - "bufferRequestBody": { - "geometries": { - "type": "FeatureCollection", - "features": [ - { - "type": "Feature", - "properties": { - "geometryId": "ExampleId" - }, - "geometry": { - "type": "Point", - "coordinates": [ - -111.9267386, - 33.5362475 - ] - } - } - ] - }, - "distances": [ - 176.3 - ] - } - }, - "responses": { - "200": { - "body": { - "summary": { - "udid": null, - "information": "1 feature processed in user data" - }, - "result": { - "type": "FeatureCollection", - "features": [ - { - "type": "Feature", - "properties": { - "geometryId": "ExampleId", - "bufferDist": 176.3 - }, - "geometry": { - "type": "Polygon", - "coordinates": [ - [ - [ - -111.92483859605078, - 33.5362475 - ], - [ - -111.92487510409389, - 33.53587682761772 - ], - [ - -111.92498322523961, - 33.535520399967204 - ], - [ - -111.92515880445296, - 33.535191914363196 - ], - [ - -111.92539509432322, - 33.53490399432323 - ], - [ - -111.92568301436319, - 33.534667704452971 - ], - [ - -111.9260114999672, - 33.53449212523963 - ], - [ - -111.9263679276177, - 33.5343840040939 - ], - [ - -111.9267386, - 33.534347496050785 - ], - [ - -111.92710927238228, - 33.5343840040939 - ], - [ - -111.92746570003278, - 33.53449212523963 - ], - [ - -111.9277941856368, - 33.534667704452971 - ], - [ - -111.92808210567676, - 33.53490399432323 - ], - [ - -111.92831839554702, - 33.535191914363196 - ], - [ - -111.92849397476037, - 33.535520399967204 - ], - [ - -111.9286020959061, - 33.53587682761772 - ], - [ - -111.92863860394921, - 33.5362475 - ], - [ - -111.9286020959061, - 33.536618172382283 - ], - [ - -111.92849397476037, - 33.5369746000328 - ], - [ - -111.92831839554702, - 33.537303085636808 - ], - [ - -111.92808210567676, - 33.537591005676774 - ], - [ - -111.9277941856368, - 33.537827295547032 - ], - [ - -111.92746570003278, - 33.538002874760373 - ], - [ - -111.92710927238228, - 33.5381109959061 - ], - [ - -111.9267386, - 33.538147503949219 - ], - [ - -111.9263679276177, - 33.5381109959061 - ], - [ - -111.9260114999672, - 33.538002874760373 - ], - [ - -111.92568301436319, - 33.537827295547032 - ], - [ - -111.92539509432322, - 33.537591005676774 - ], - [ - -111.92515880445296, - 33.537303085636808 - ], - [ - -111.92498322523961, - 33.5369746000328 - ], - [ - -111.92487510409389, - 33.536618172382283 - ], - [ - -111.92483859605078, - 33.5362475 - ] - ] - ] - } - } - ] - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostClosestPoint.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostClosestPoint.json deleted file mode 100644 index c47be26bac17..000000000000 --- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostClosestPoint.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "geography": "us", - "format": "json", - "api-version": "1.0", - "lat": 47.622942, - "lon": -122.316456, - "closestPointRequestBody": { - "type": "FeatureCollection", - "features": [ - { - "type": "Feature", - "properties": { - "geometryId": 1001 - }, - "geometry": { - "type": "Point", - "coordinates": [ - -105.02860293715861, - 40.516153406773952 - ] - } - }, - { - "type": "Feature", - "properties": { - "geometryId": 1002 - }, - "geometry": { - "type": "Point", - "coordinates": [ - -105.02860381672178, - 40.515990990037309 - ] - } - }, - { - "type": "Feature", - "properties": { - "geometryId": 1003 - }, - "geometry": { - "type": "Point", - "coordinates": [ - -105.02812292879467, - 40.516058678088562 - ] - } - } - ] - } - }, - "responses": { - "200": { - "body": { - "summary": { - "sourcePoint": { - "lat": 47.622942, - "lon": -122.316456 - }, - "udid": null, - "information": "3 points processed in user data" - }, - "result": [ - { - "distanceInMeters": 1587492.66, - "position": { - "lat": 40.516153406773952, - "lon": -105.02860293715861 - }, - "geometryId": "1001" - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostGeofence.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostGeofence.json deleted file mode 100644 index 11c4fe5176c7..000000000000 --- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostGeofence.json +++ /dev/null @@ -1,133 +0,0 @@ -{ - "parameters": { - "geography": "us", - "format": "json", - "api-version": "1.0", - "deviceId": "unique_device_name_under_account", - "lat": 48.36, - "lon": -124.63, - "searchBuffer": 50, - "usertime": "2017-07-21T17:32:28Z", - "isAsync": true, - "mode": "EnterAndExit", - "searchGeofenceRequestBody": { - "type": "FeatureCollection", - "features": [ - { - "type": "Feature", - "geometry": { - "type": "Polygon", - "coordinates": [ - [ - [ - -122.13241226662022, - 47.61701140091722 - ], - [ - -122.12810106940353, - 47.6169969269402 - ], - [ - -122.12824948956276, - 47.61907683751349 - ], - [ - -122.12833297981392, - 47.621929787055336 - ], - [ - -122.12971398040168, - 47.62184100705295 - ], - [ - -122.1318413862121, - 47.62195364373008 - ], - [ - -122.13231034769727, - 47.61716332618121 - ], - [ - -122.13241226662022, - 47.61701140091722 - ] - ] - ] - }, - "properties": { - "geometryId": "2", - "name": "Crossroad Mall" - } - }, - { - "type": "Feature", - "geometry": { - "type": "Polygon", - "coordinates": [ - [ - [ - -122.1534220563239, - 47.60981818546625 - ], - [ - -122.153451623509, - 47.60628733146004 - ], - [ - -122.14971782206638, - 47.606250040787046 - ], - [ - -122.14817354810637, - 47.606391046012305 - ], - [ - -122.1482735128807, - 47.60983316796356 - ], - [ - -122.15225500989803, - 47.60982613678752 - ], - [ - -122.1534220563239, - 47.60981818546625 - ] - ] - ] - }, - "properties": { - "geometryId": "1", - "name": "Sammamish High school" - } - } - ] - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "geometries": [ - { - "deviceId": "unique_device_name_under_account", - "geometryId": "2", - "distance": -999, - "nearestLat": 47.621954, - "nearestLon": -122.131841 - }, - { - "deviceId": "unique_device_name_under_account", - "geometryId": "1", - "distance": 999, - "nearestLat": 47.609833, - "nearestLon": -122.148274 - } - ], - "expiredGeofenceGeometryId": [], - "invalidPeriodGeofenceGeometryId": [], - "isEventPublished": true - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostPointInPolygon.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostPointInPolygon.json deleted file mode 100644 index fc0ce0e8d71e..000000000000 --- a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostPointInPolygon.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "parameters": { - "geography": "us", - "format": "json", - "api-version": "1.0", - "lat": 33.5362475, - "lon": -111.9267386, - "pointInPolygonRequestBody": { - "type": "FeatureCollection", - "features": [ - { - "type": "Feature", - "properties": { - "geometryId": 1001 - }, - "geometry": { - "type": "Polygon", - "coordinates": [ - [ - [ - -111.9267386, - 33.5362475 - ], - [ - -111.9627875, - 33.5104882 - ], - [ - -111.9027061, - 33.5004686 - ], - [ - -111.9267386, - 33.5362475 - ] - ] - ] - } - } - ] - } - }, - "responses": { - "200": { - "body": { - "summary": { - "sourcePoint": { - "lat": 33.5362475, - "lon": -111.9267386 - }, - "udid": null, - "information": "1 polygons processed in user data" - }, - "result": { - "pointInPolygons": true, - "intersectingGeometries": [ - "1001" - ] - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/1.0/spatial.json b/specification/maps/data-plane/Creator/preview/1.0/spatial.json deleted file mode 100644 index 878bd01ada69..000000000000 --- a/specification/maps/data-plane/Creator/preview/1.0/spatial.json +++ /dev/null @@ -1,902 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Spatial Service", - "version": "1.0", - "description": "Azure Maps Spatial REST APIs" - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "default": "1.0", - "x-ms-parameter-location": "client" - }, - "GeofenceMode": { - "name": "mode", - "in": "query", - "description": "Mode of the geofencing async event mechanism.", - "type": "string", - "enum": [ - "All", - "EnterAndExit" - ], - "x-ms-enum": { - "name": "GeofenceMode", - "modelAsString": true, - "values": [ - { - "value": "All", - "description": "Publish all the query results to Azure Maps account event subscription." - }, - { - "value": "EnterAndExit", - "description": "Only publish result when user location is considered as crossing geofencing boarder." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "SpatialUploadUdid": { - "name": "udid", - "in": "query", - "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SpatialUploadDataFormat": { - "name": "dataFormat", - "description": "Data format of the content being uploaded. Currently, only `geojson` format is supported.", - "type": "string", - "in": "query", - "required": true, - "enum": [ - "geojson" - ], - "x-ms-enum": { - "name": "SpatialUploadDataFormat", - "modelAsString": true, - "values": [ - { - "value": "geojson", - "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "SearchGeofenceRequestBody": { - "name": "searchGeofenceRequestBody", - "in": "body", - "description": "The geofencing GeoJSON data.", - "required": true, - "schema": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection" - }, - "x-ms-parameter-location": "method" - }, - "ClosestPointRequestBody": { - "name": "closestPointRequestBody", - "in": "body", - "description": "The FeatureCollection of Point geometries from which closest point to source point should be determined. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", - "required": true, - "schema": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection" - }, - "x-ms-parameter-location": "method" - }, - "PointInPolygonRequestBody": { - "name": "pointInPolygonRequestBody", - "in": "body", - "description": "A FeatureCollection with a set of Polygon/MultiPolygon geometries. The maximum number of vertices accepted to form a Polygon is 10,000. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", - "required": true, - "schema": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection" - }, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/spatial/geofence/{format}": { - "get": { - "description": "**Search Geofence Get API**\n\n**Applies to:** S1 Pricing tier.\n\nThe Geofence Get API allows you to retrieve the proximity of a coordinate to a \ngeofence that has been uploaded to the Data service. You can use the \n[Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) to upload \na geofence or set of fences. See [Geofencing GeoJSON data](https://docs.microsoft.com/en-us/azure/azure-maps/geofence-geojson) \nfor more details on the geofence data format. To query the proximity of a coordinate, you supply the location of the object you are tracking as well\nas the ID for the fence or set of fences, and the response will contain information about\nthe distance from the outer edge of the geofence. A negative value signifies that the \ncoordinate is inside of the fence while a positive value means that it is outside of the\nfence.

This API can be used for a variety of scenarios that include things like asset \ntracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).\nTo test this API, you can upload the sample data from Post Geofence API examples (Request Body) via Data Upload API and replace the `{udid}` from the sample request below with the udid returned by Data Upload API.\n\n\n### Geofencing InnerError code\n\nIn geofencing response error contract, `innererror` is an object containing service specific information about the error. `code` is a property in `innererror` which can map to a specific geofencing error type. The table belows shows the code mapping between all the known client error type to the corresponding geofencing error `message`.\n\ninnererror.code | error.message\n---------------------------- | -------------------------------------- \nNullDeviceId | Device Id should not be null.\nNullUdid\t | Udid should not be null.\nUdidWrongFormat| Udid should be acquired from user data ingestion API.\nInvalidUserTime| Usertime is invalid.\nInvalidSearchBuffer| Searchbuffer is invalid.\nInvalidSearchRange| The value range of searchbuffer should be from 0 to 500 meters.\nInvalidLatLon| Lat and/or lon parameters are invalid.\nInvalidIsAsyncValue| The IsAsync parameter is invalid.\nInvalidModeValue| The mode parameter invalid.\nInvalidJson| Geofencing data is not a valid json file.\nNotSupportedGeoJson| Geofencing data can't be read as a Feature or FeatureCollections.\nInvalidGeoJson| Geofencing data is invalid.\nNoUserDataWithAccountOrSubscription| Can't find user geofencing data with provided account-id and/or subscription-id.\nNoUserDataWithUdid|\tCan't find user geofencing data with provided udid.", - "operationId": "Spatial_GetGeofence", - "x-ms-examples": { - "GetGeofence": { - "$ref": "./examples/spatial/Spatial_GetGeofence.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" - }, - { - "name": "deviceId", - "in": "query", - "description": "ID of the device", - "required": true, - "type": "string" - }, - { - "name": "udid", - "in": "query", - "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLatitudeAbbreviated" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLongitudeAbbreviated" - }, - { - "x-ms-client-name": "altitude", - "name": "z", - "in": "query", - "description": "The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion is used. Example: 200.", - "type": "number" - }, - { - "name": "userTime", - "in": "query", - "format": "date-time", - "description": "The user request time. If not presented in the request, the default value is DateTime.Now.", - "type": "string" - }, - { - "x-ms-client-name": "searchBufferInMeters", - "name": "searchBuffer", - "in": "query", - "description": "The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50.", - "type": "number", - "minimum": 0, - "maximum": 500 - }, - { - "name": "isAsync", - "in": "query", - "description": "If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false.", - "type": "boolean" - }, - { - "$ref": "#/parameters/GeofenceMode" - } - ], - "responses": { - "200": { - "description": "OK The X-Correlation-id header value is present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.", - "headers": { - "X-Correlation-id": { - "description": "Value present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/Geofence" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "post": { - "description": "**Search Geofence Post API**\n**Applies to:** S1 Pricing tier.\nThe Geofence Post API allows you to retrieve the proximity of a coordinate to a provided geofence or set of fences. With POST call, you do not have to upload the fence data in advance, instead you supply the location of the object you are tracking in query parameters as well as the fence or set of fences data in post request body. See [Geofencing GeoJSON data](https://docs.microsoft.com/en-us/azure/azure-maps/geofence-geojson) for more details on the geofence data format. The response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.

This API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).", - "operationId": "Spatial_PostGeofence", - "x-ms-examples": { - "PostGeofence": { - "$ref": "./examples/spatial/Spatial_PostGeofence.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" - }, - { - "name": "deviceId", - "in": "query", - "description": "ID of the device", - "required": true, - "type": "string" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLatitudeAbbreviated" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLongitudeAbbreviated" - }, - { - "x-ms-client-name": "altitude", - "name": "z", - "in": "query", - "description": "The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion geofencing is applied. Example: 200.", - "type": "number" - }, - { - "name": "userTime", - "in": "query", - "format": "date-time", - "description": "The user request time. If not presented in the request, the default value is DateTime.UtcNow.", - "type": "string" - }, - { - "name": "searchBuffer", - "in": "query", - "description": "The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50.", - "type": "number", - "minimum": 0, - "maximum": 500 - }, - { - "name": "isAsync", - "in": "query", - "description": "If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false.", - "type": "boolean" - }, - { - "$ref": "#/parameters/GeofenceMode" - }, - { - "$ref": "#/parameters/SearchGeofenceRequestBody" - } - ], - "responses": { - "200": { - "description": "OK The X-Correlation-id header value is present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.", - "headers": { - "X-Correlation-id": { - "description": "Value present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/Geofence" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/spatial/buffer/{format}": { - "post": { - "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided.", - "operationId": "Spatial_PostBuffer", - "x-ms-examples": { - "PostBuffer": { - "$ref": "./examples/spatial/Spatial_PostBuffer.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" - }, - { - "name": "bufferRequestBody", - "in": "body", - "description": "The FeatureCollection and the list of distances (one per feature or one for all features).", - "required": true, - "schema": { - "$ref": "#/definitions/BufferRequestBody" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BufferResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input features are provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided. \n\nTo test this API, you can upload the sample data from [Post Buffer API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postbuffer#examples) examples (Request Body without distances array) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the `{udid}` from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getbuffer#examples) with the udid returned by Data Upload API.", - "operationId": "Spatial_GetBuffer", - "x-ms-examples": { - "GetBuffer": { - "$ref": "./examples/spatial/Spatial_GetBuffer.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" - }, - { - "$ref": "#/parameters/SpatialUploadUdid" - }, - { - "name": "distances", - "in": "query", - "description": "The list of distances (one per feature or one for all features), delimited by semicolons. For example, 12.34;-56.78. Positive distance will generate a buffer outside of the feature, whereas negative distance will generate a buffer inside of the feature. If the negative distance larger than the geometry itself, an empty polygon will be returned.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BufferResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/spatial/closestPoint/{format}": { - "post": { - "description": "**Applies to**: S1 pricing tier.\n\nThis API returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.", - "operationId": "Spatial_PostClosestPoint", - "x-ms-examples": { - "PostClosestPoint": { - "$ref": "./examples/spatial/Spatial_PostClosestPoint.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLatitudeAbbreviated" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLongitudeAbbreviated" - }, - { - "name": "numberOfClosestPoints", - "in": "query", - "description": "The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50", - "type": "integer" - }, - { - "$ref": "#/parameters/ClosestPointRequestBody" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClosestPointResponse" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to**: S1 pricing tier.\n\nThis API returns the closest point between a base point and a given set of points in the user uploaded data set identified by udid. The set of target points is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The maximum number of points accepted is 100,000. The algorithm does not take into account routing or traffic. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.\n\nTo test this API, you can upload the sample data from [Post Closest Point API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postclosestpoint#examples) examples (Request Body) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the `{udid}` from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getclosestpoint#examples) with the udid returned by Data Upload API.", - "operationId": "Spatial_GetClosestPoint", - "x-ms-examples": { - "GetClosestPoint": { - "$ref": "./examples/spatial/Spatial_GetClosestPoint.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" - }, - { - "$ref": "#/parameters/SpatialUploadUdid" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLatitudeAbbreviated" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLongitudeAbbreviated" - }, - { - "name": "numberOfClosestPoints", - "in": "query", - "description": "The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50", - "type": "integer" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClosestPointResponse" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/spatial/pointInPolygon/{format}": { - "post": { - "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The user data may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries (referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.", - "operationId": "Spatial_PostPointInPolygon", - "x-ms-examples": { - "PostPointInPolygon": { - "$ref": "./examples/spatial/Spatial_PostPointInPolygon.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLatitudeAbbreviated" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLongitudeAbbreviated" - }, - { - "$ref": "#/parameters/PointInPolygonRequestBody" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PointInPolygonResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.\n\n \nTo test this API, you can upload the sample data from [Post Point In Polygon API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postpointinpolygon#examples) examples (Request Body) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the `{udid}` from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getpointinpolygon#examples) with the udid returned by Data Upload API.", - "operationId": "Spatial_EvaluatePointInPolygon", - "x-ms-examples": { - "GetPointInPolygon": { - "$ref": "./examples/spatial/Spatial_EvaluatePointInPolygon.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" - }, - { - "$ref": "#/parameters/SpatialUploadUdid" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLatitudeAbbreviated" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/PositionLongitudeAbbreviated" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PointInPolygonResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/spatial/greatCircleDistance/{format}": { - "get": { - "description": "**Applies to**: S1 pricing tier.\n\nThis API will return the great-circle or shortest distance between two points on the surface of a sphere, measured along the surface of the sphere. This differs from calculating a straight line through the sphere's interior. This method is helpful for estimating travel distances for airplanes by calculating the shortest distance between airports.", - "operationId": "Spatial_GetGreatCircleDistance", - "x-ms-examples": { - "GetGreatCircleDistance": { - "$ref": "./examples/spatial/Spatial_GetGreatCircleDistance.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" - }, - { - "name": "query", - "in": "query", - "description": "The Coordinates through which the distance is calculated, delimited by a colon. Two coordinates are required. The first one is the source point coordinate and the last is the target point coordinate. For example, 47.622942,122.316456:57.673988,127.121513", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/GreatCircleDistanceResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "GeofenceGeometry": { - "description": "The geofencing geometry.", - "type": "object", - "readOnly": true, - "properties": { - "deviceId": { - "description": "ID of the device.", - "type": "string", - "readOnly": true - }, - "udId": { - "x-ms-client-name": "udid", - "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", - "type": "string", - "readOnly": true - }, - "geometryId": { - "description": "The unique id identifies a geometry.", - "type": "string", - "readOnly": true - }, - "distance": { - "description": "Distance from the coordinate to the closest border of the geofence (in meters except when special values -999/999 are used). Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border, then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.", - "type": "number", - "readOnly": true - }, - "nearestLat": { - "description": "Latitude of the nearest point of the geometry.", - "type": "number", - "readOnly": true - }, - "nearestLon": { - "description": "Longitude of the nearest point of the geometry.", - "type": "number", - "readOnly": true - }, - "nearestZ": { - "x-ms-client-name": "nearestElevation", - "description": "Sea level in meter of the nearest point on the 2D extrusion geometry. This will only be presented in response when value is provided for 'zInMeter' in the request.", - "type": "number", - "readOnly": true - } - } - }, - "Geofence": { - "description": "This object is returned from a geofence proximity call.", - "type": "object", - "properties": { - "geometries": { - "description": "Lists the fence geometries that contain the coordinate position or overlap the searchBuffer around the position.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/GeofenceGeometry" - } - }, - "expiredGeofenceGeometryId": { - "description": "Lists of the geometry ID of the geofence which is expired relative to the user time in the request.", - "type": "array", - "readOnly": true, - "items": { - "type": "string" - } - }, - "invalidPeriodGeofenceGeometryId": { - "description": "Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.", - "type": "array", - "readOnly": true, - "items": { - "type": "string" - } - }, - "isEventPublished": { - "description": "True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber. This will only be presented in response when 'isAsync' query parameter is set to true.", - "type": "boolean", - "readOnly": true - } - } - }, - "BufferRequestBody": { - "description": "An object with a FeatureCollection and a list of distances. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", - "type": "object", - "properties": { - "geometries": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection" - }, - "distances": { - "description": "List of the distances to compute the buffer for, one-to-one per Feature in the collection, or one for all Features in the collection.", - "type": "array", - "items": { - "type": "number" - } - } - } - }, - "BufferSummary": { - "type": "object", - "readOnly": true, - "properties": { - "udid": { - "description": "The udid for the user data if one exists", - "type": "string", - "readOnly": true - }, - "information": { - "description": "The information about what happened during the call.", - "type": "string", - "readOnly": true - } - } - }, - "BufferResult": { - "description": "This object is returned from a successful Spatial Buffer call.", - "type": "object", - "properties": { - "summary": { - "$ref": "#/definitions/BufferSummary" - }, - "result": { - "x-ms-client-name": "features", - "description": "The FeatureCollection of buffers for the input.", - "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection" - } - } - }, - "ClosestPointResponse": { - "description": "This object is returned from a successful Spatial Closest Point call", - "type": "object", - "properties": { - "summary": { - "$ref": "#/definitions/ClosestPointSummary" - }, - "result": { - "description": "Closest Point Result Array", - "type": "array", - "items": { - "$ref": "#/definitions/ClosestPoint" - } - } - } - }, - "ClosestPointSummary": { - "description": "Closest Point Summary object", - "type": "object", - "readOnly": true, - "properties": { - "sourcePoint": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPairAbbreviated" - }, - "udid": { - "description": "A unique data id (udid) for the uploaded content", - "type": "string", - "readOnly": true - }, - "information": { - "description": "Processing information", - "type": "string", - "readOnly": true - } - } - }, - "ClosestPoint": { - "description": "Closest Point Result Entry Object", - "type": "object", - "readOnly": true, - "properties": { - "distanceInMeters": { - "description": "The distance in meters from the source point to the closest point", - "type": "number", - "readOnly": true - }, - "position": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPairAbbreviated" - }, - "geometryId": { - "description": "The unique id identifies a geometry", - "type": "string", - "readOnly": true - } - } - }, - "PointInPolygonResult": { - "description": "Returns true if point is within the polygon, false otherwise", - "type": "object", - "properties": { - "summary": { - "$ref": "#/definitions/PointInPolygonSummary" - }, - "result": { - "description": "Point In Polygon Result Object", - "type": "object", - "properties": { - "pointInPolygons": { - "x-ms-client-name": "isPointInPolygons", - "description": "Point In Polygons Property", - "type": "boolean", - "readOnly": true - }, - "intersectingGeometries": { - "description": "Geometries array", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/GeometryId" - } - } - } - } - } - }, - "PointInPolygonSummary": { - "description": "Point In Polygon Summary object", - "type": "object", - "readOnly": true, - "properties": { - "sourcePoint": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPairAbbreviated" - }, - "udid": { - "description": "A unique data id (udid) for the uploaded content. Udid is not applicable for POST spatial operations(set to null)", - "type": "string", - "readOnly": true - }, - "information": { - "description": "Processing information", - "type": "string", - "readOnly": true - } - } - }, - "GeometryId": { - "description": "The Spatial geometry", - "type": "string", - "readOnly": true - }, - "GreatCircleDistanceSummary": { - "description": "Summary object", - "type": "object", - "readOnly": true, - "properties": { - "sourcePoint": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPairAbbreviated" - }, - "targetPoint": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPairAbbreviated" - } - } - }, - "GreatCircleDistanceResult": { - "description": "This object is returned from a successful Great Circle Distance call", - "type": "object", - "properties": { - "summary": { - "$ref": "#/definitions/GreatCircleDistanceSummary" - }, - "result": { - "description": "Result Object", - "type": "object", - "readOnly": true, - "properties": { - "distanceInMeters": { - "description": "The great circle distance in meters from the source point to the target point", - "type": "number", - "readOnly": true - } - } - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2.0/alias.json b/specification/maps/data-plane/Creator/preview/2.0/alias.json index 88ce2c8906e9..ce98474b07df 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/alias.json +++ b/specification/maps/data-plane/Creator/preview/2.0/alias.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -94,7 +94,7 @@ "paths": { "/aliases": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to create an alias. You can also assign the alias during the create request. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response with the alias resource in the body.\n\nA sample response from creating an alias:\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to create an alias. You can also assign the alias during the create request. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response with the alias resource in the body.\n\nA sample response from creating an alias:\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", "operationId": "Alias_Create", "x-ms-examples": { "Create an alias that does not reference any resource": { @@ -131,7 +131,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ\n\nA sample response returning 2 alias resources:\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33.123Z\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"creatorDataItemId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33.123Z\"\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 previously successfully created aliases.\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ\n\nA sample response returning 2 alias resources:\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33.123Z\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"creatorDataItemId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33.123Z\"\n }\n ]\n}\n```", "operationId": "Alias_List", "x-ms-examples": { "List all the previously created aliases": { @@ -165,7 +165,7 @@ }, "/aliases/{aliasId}": { "put": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to assign an alias to reference a resource.\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.\n\n### Assign Alias Response\n\nThe Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to assign an alias to reference a resource.\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.\n\n### Assign Alias Response\n\nThe Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", "operationId": "Alias_Assign", "x-ms-examples": { "Assign an alias to a resource": { @@ -199,7 +199,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a previously created alias. You can also use this API to delete old/unused aliases to create space for new content.This API does not delete the references resource, only the alias referencing the resource.\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete a previously created alias. You can also use this API to delete old/unused aliases to create space for new content.This API does not delete the references resource, only the alias referencing the resource.\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.", "operationId": "Alias_Delete", "x-ms-examples": { "Delete previously created alias": { @@ -227,7 +227,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch the details of a previously created alias.\n\n### Submit Get Details Request\n\nTo get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\nHere's a sample response:\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch the details of a previously created alias.\n\n### Submit Get Details Request\n\nTo get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\nHere's a sample response:\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", "operationId": "Alias_Get", "x-ms-examples": { "Get a previously created alias": { 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 b3a2e2724d7d..49200926af5c 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/data.json +++ b/specification/maps/data-plane/Creator/preview/2.0/data.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -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/rest/api/maps/data-v2/upload) call.", + "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](/rest/api/maps/data/upload) call.", "type": "string", "in": "path", "required": true, @@ -126,7 +126,7 @@ "paths": { "/mapData": { "post": { - "description": "> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data) and [v2](/rest/api/maps/data-v2)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](https://learn.microsoft.com/azure/azure-maps/how-to-create-data-registries).\n\n**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/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/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.", + "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](/rest/api/maps/spatial).\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\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](/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](/rest/api/maps/data/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": "> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data) and [v2](/rest/api/maps/data-v2)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](https://learn.microsoft.com/azure/azure-maps/how-to-create-data-registries).\n\n**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/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/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](/rest/api/maps/data/upload).\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\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": "> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data) and [v2](/rest/api/maps/data-v2)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](https://learn.microsoft.com/azure/azure-maps/how-to-create-data-registries).\n\n**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/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/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.", + "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](/rest/api/maps/data/upload), for \nuse in the [Azure Maps Geofencing Service](/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\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](/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](/rest/api/maps/data/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": "> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data) and [v2](/rest/api/maps/data-v2)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](https://learn.microsoft.com/azure/azure-maps/how-to-create-data-registries).\n\n**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/rest/api/maps/data-v2/upload) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/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/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](/rest/api/maps/data/upload) for use in our [Azure Maps Geofencing Service](/rest/api/maps/spatial).\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\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": "> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data) and [v2](/rest/api/maps/data-v2)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](https://learn.microsoft.com/azure/azure-maps/how-to-create-data-registries).\n\n**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/rest/api/maps/data-v2/upload) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/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/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](/rest/api/maps/data/upload) for use in our [Azure Maps Geofencing Service](/rest/api/maps/spatial). You can also use this API to delete old/unused uploaded content and create space for new content. \n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\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": { @@ -332,7 +332,7 @@ }, "/mapData/operations/{operationId}": { "get": { - "description": "> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data) and [v2](/rest/api/maps/data-v2)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](https://learn.microsoft.com/azure/azure-maps/how-to-create-data-registries).\n\nThis path will be obtained from a call to POST /mapData. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once completed.\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n", + "description": "This path will be obtained from a call to POST /mapData. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once completed.\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\n", "operationId": "Data_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { diff --git a/specification/maps/data-plane/Creator/preview/2.0/dataset.json b/specification/maps/data-plane/Creator/preview/2.0/dataset.json index 08a909a75436..eee1c18c5464 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/dataset.json +++ b/specification/maps/data-plane/Creator/preview/2.0/dataset.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -69,7 +69,7 @@ }, "ConversionIdQuery": { "name": "conversionId", - "description": "The unique ID used to create the dataset. The `conversionId` must have been obtained from a successful call to the Conversion Service [Convert API](https://docs.microsoft.com/rest/api/maps/v2/conversion/convert) and may be provided with multiple query parameters with same name (if more than one is provided).", + "description": "The unique ID used to create the dataset. The `conversionId` must have been obtained from a successful call to the Conversion Service [Convert API](/rest/api/maps-creator/conversion/convert) and may be provided with multiple query parameters with same name (if more than one is provided).", "type": "string", "in": "query", "required": true, @@ -109,7 +109,7 @@ "paths": { "/datasets": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API allows the caller to create a dataset from data that was uploaded to the Azure Maps Data Service and converted using the Azure Maps Conversion Service.\n\nYou can use this API in a scenario like uploading a DWG zip package for a building, converting the zip package using the Azure Maps Conversion Service, and creating a dataset from the converted zip package. The created dataset can be used to create tilesets using the Azure Maps Tileset Service and can be queried via the Azure Maps WFS Service.\n\n### Submit Create Request\n\nTo create your dataset, you will use a `POST` request where the `conversionId` query parameter is an ID that represents the converted DWG zip package, the `datasetId` parameter will be the ID of a previously created dataset to append with the current dataset and, optionally, the `description` query parameter will contain a description (if description is not provided a default description will be given).\n\nThe Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n This API allows the caller to create a dataset from data that was uploaded to the Azure Maps Data Service and converted using the Azure Maps Conversion Service.\n\nYou can use this API in a scenario like uploading a DWG zip package for a building, converting the zip package using the Azure Maps Conversion Service, and creating a dataset from the converted zip package. The created dataset can be used to create tilesets using the Azure Maps Tileset Service and can be queried via the Azure Maps WFS Service.\n\n### Submit Create Request\n\nTo create your dataset, you will use a `POST` request where the `conversionId` query parameter is an ID that represents the converted DWG zip package, the `datasetId` parameter will be the ID of a previously created dataset to append with the current dataset and, optionally, the `description` query parameter will contain a description (if description is not provided a default description will be given).\n\nThe Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "Dataset_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -150,7 +150,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all previously successfully created datasets.\n\n### Submit List Request\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](https://docs.microsoft.com/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 3 dataset resources:\n\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ], },\n \"\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\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 previously successfully created datasets.\n\n### Submit List Request\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 3 dataset resources:\n\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ], },\n \"\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n ]\n}\n```", "operationId": "Dataset_List", "x-ms-examples": { "List all the previously created datasets": { @@ -184,7 +184,7 @@ }, "/datasets/{datasetId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a previously successfully created dataset.\n\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the details for a dataset in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](https://docs.microsoft.com/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n```", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a previously successfully created dataset.\n\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the details for a dataset in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n```", "operationId": "Dataset_Get", "x-ms-examples": { "Get details for a previously created dataset": { @@ -215,7 +215,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nYou can also use this API to delete old/unused datasets to create space for new Creator content.\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nYou can also use this API to delete old/unused datasets to create space for new Creator content.\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.", "operationId": "Dataset_Delete", "x-ms-examples": { "Delete previously created dataset": { diff --git a/specification/maps/data-plane/Creator/preview/2.0/dwgconversion.json b/specification/maps/data-plane/Creator/preview/2.0/dwgconversion.json index 81d1686aa115..8e56ed54866d 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/dwgconversion.json +++ b/specification/maps/data-plane/Creator/preview/2.0/dwgconversion.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -69,7 +69,7 @@ }, "UdidQuery": { "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/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://learn.microsoft.com/rest/api/maps/data/upload) call.", "type": "string", "in": "query", "required": true, @@ -77,7 +77,7 @@ }, "ConversionId": { "name": "conversionId", - "description": "The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](https://docs.microsoft.com/rest/api/maps/v2/conversion/convert) call.", + "description": "The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](/rest/api/maps-creator/conversion/convert) call.", "type": "string", "in": "path", "required": true, @@ -85,7 +85,7 @@ }, "OutputOntology": { "name": "outputOntology", - "description": "Output ontology version. \"facility-2.0\" is the only supported value at this time. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/creator-facility-ontology) for more information about Azure Maps Creator ontologies.", + "description": "Output ontology version. \"facility-2.0\" is the only supported value at this time. Please refer to this [article](/azure/azure-maps/creator-facility-ontology) for more information about Azure Maps Creator ontologies.", "type": "string", "in": "query", "required": true, @@ -124,7 +124,7 @@ "paths": { "/conversions": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be uploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the `udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload) to call this Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be uploaded using the [Azure Maps Data Service](/rest/api/maps/data). Once uploaded, use the `udid` returned by the [Data Upload API](/rest/api/maps/data/upload) to call this Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", "operationId": "Conversion_Convert", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -165,7 +165,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/rest/api/maps/v2/conversion/convert). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\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 successful data conversions submitted previously using the [Conversion API](/rest/api/maps-creator/conversion). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
", "operationId": "Conversion_List", "x-ms-examples": { "Returns a list of all the data processed by the Conversion Service for the account": { @@ -199,7 +199,7 @@ }, "/conversions/{conversionId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a successful data conversion submitted previously using the [Conversion API](https://docs.microsoft.com/rest/api/maps/v2/conversion/convert). ", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a successful data conversion submitted previously using the [Conversion API](/rest/api/maps-creator/conversion/convert). ", "operationId": "Conversion_Get", "x-ms-examples": { "Get the details for one conversion operation": { @@ -230,7 +230,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/rest/api/maps/v2/conversion/convert).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](/rest/api/maps-creator/conversion/convert).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", "operationId": "Conversion_Delete", "x-ms-examples": { "Delete previously converted content": { diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetFeatures.json b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetFeatures.json index baadf9b72821..674bd1c582c1 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetFeatures.json +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetFeatures.json @@ -5,7 +5,12 @@ "datasetId": "018fda98-e638-0edf-5ef7-28491ff3bed4", "collectionId": "unit", "limit": 1, - "bbox": "-122, 47, -120, 46" + "bbox": [ + -122, + 47, + -120, + 46 + ] }, "responses": { "200": { diff --git a/specification/maps/data-plane/Creator/preview/2.0/featurestate.json b/specification/maps/data-plane/Creator/preview/2.0/featurestate.json index fce531d32ac7..ff15ec3ee841 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/featurestate.json +++ b/specification/maps/data-plane/Creator/preview/2.0/featurestate.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -77,7 +77,7 @@ }, "DatasetIdForCreate": { "name": "datasetId", - "description": "The datasetId must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/rest/api/maps/v2/dataset/create) call.", + "description": "The datasetId must have been obtained from a successful [Dataset Create API](/rest/api/maps-creator/dataset/create) call.", "type": "string", "in": "query", "required": true, @@ -128,7 +128,7 @@ "paths": { "/featureStateSets": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the [State Tile documentation](https://docs.microsoft.com/rest/api/maps/render/get-map-state-tile) for more information.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nThe Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the [State Tile documentation](/rest/api/maps/render/get-map-state-tile) for more information.", "operationId": "FeatureState_CreateStateset", "x-ms-examples": { "Create a new stateset with a datasetId": { @@ -171,7 +171,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API allows the caller to fetch a list of all previously successfully created statesets.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n This API allows the caller to fetch a list of all previously successfully created statesets.", "operationId": "FeatureState_ListStatesets", "x-ms-examples": { "List all the previously created statesets": { @@ -205,7 +205,7 @@ }, "/featureStateSets/{statesetId}": { "put": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis PUT API allows the user to update the stateset style rules.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis PUT API allows the user to update the stateset style rules.", "operationId": "FeatureState_UpdateStateset", "x-ms-examples": { "Update stateset style rules with a statesetId": { @@ -242,7 +242,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This DELETE API allows the user to delete the stateset and the associated data.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n This DELETE API allows the user to delete the stateset and the associated data.", "operationId": "FeatureState_DeleteStateset", "x-ms-examples": { "Delete an existing stateset": { @@ -270,7 +270,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", "operationId": "FeatureState_GetStateset", "x-ms-examples": { "Get stateset information with a statesetId": { @@ -304,7 +304,7 @@ "/featureStateSets/{statesetId}/featureStates/{featureId}": { "put": { "operationId": "FeatureState_UpdateStates", - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis PUT API allows the user to update the state of the given feature in the given stateset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis PUT API allows the user to update the state of the given feature in the given stateset.", "x-ms-examples": { "Update the states of a feature": { "$ref": "./examples/featurestate/Featurestate_UpdateStates.json" @@ -344,7 +344,7 @@ }, "delete": { "operationId": "FeatureState_DeleteState", - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", "x-ms-examples": { "Delete the given feature state": { "$ref": "./examples/featurestate/Featurestate_DeleteFeatureState.json" @@ -378,7 +378,7 @@ }, "get": { "operationId": "FeatureState_ListStates", - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API returns the current state information associated with the given feature in the given stateset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n This API returns the current state information associated with the given feature in the given stateset.", "x-ms-examples": { "Get the current states of a feature": { "$ref": "./examples/featurestate/Featurestate_ListStates.json" diff --git a/specification/maps/data-plane/Creator/preview/2.0/tileset.json b/specification/maps/data-plane/Creator/preview/2.0/tileset.json index c8e82a35f86b..2f51ac5b9b95 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2.0/tileset.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -69,7 +69,7 @@ }, "DatasetIdQuery": { "name": "datasetId", - "description": "The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/rest/api/maps/v2/dataset/create) call.", + "description": "The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](/rest/api/maps-creator/dataset/create) call.", "type": "string", "in": "query", "required": true, @@ -102,7 +102,7 @@ "paths": { "/tilesets": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Tileset Create API allows the caller to create a tileset from a dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/dataset/createpreview).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be \nused as the source of the tileset data.\n\nThe Create Tileset API is a \n[long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Create API allows the caller to create a tileset from a dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/get-map-tile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps-creator/dataset/create). [This](/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be \nused as the source of the tileset data.\n\nThe Create Tileset API is a \n[long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "Tileset_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -140,7 +140,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all tilesets created. \n
", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a list of all tilesets created. \n
", "operationId": "Tileset_List", "x-ms-examples": { "Get a list of all tilesets": { @@ -174,7 +174,7 @@ }, "/tilesets/{tilesetId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a tileset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a tileset.", "operationId": "Tileset_Get", "x-ms-examples": { "Gets the details for a single tileset": { @@ -205,7 +205,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a created tileset.
\nYou can use this API if a tileset is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete a created tileset.
\nYou can use this API if a tileset is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", "operationId": "Tileset_Delete", "x-ms-examples": { "Delete a created tileset": { diff --git a/specification/maps/data-plane/Creator/preview/2.0/wfs.json b/specification/maps/data-plane/Creator/preview/2.0/wfs.json index 87ab73ba1e1b..9de7fc768fef 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/wfs.json +++ b/specification/maps/data-plane/Creator/preview/2.0/wfs.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -116,7 +116,7 @@ "paths": { "/wfs/datasets/{datasetId}/": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Landing Page API provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/rest/api/maps-creator/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Landing Page API provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", "operationId": "WFS_GetLandingPage", "x-ms-examples": { "GetLandingPage": { @@ -149,7 +149,7 @@ }, "/wfs/datasets/{datasetId}/conformance": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Requirements Classes lists all requirements classes specified in the standard that the server conforms to.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/rest/api/maps-creator/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Requirements Classes lists all requirements classes specified in the standard that the server conforms to.", "operationId": "WFS_ListConformance", "x-ms-examples": { "GetConformance": { @@ -182,7 +182,7 @@ }, "/wfs/datasets/{datasetId}/collections": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Collections Description API provides descriptions of all the collections in a given dataset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/rest/api/maps-creator/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Collections Description API provides descriptions of all the collections in a given dataset.", "operationId": "WFS_GetCollections", "x-ms-examples": { "GetCollections": { @@ -215,7 +215,7 @@ }, "/wfs/datasets/{datasetId}/collections/{collectionId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/rest/api/maps-creator/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.", "operationId": "WFS_GetCollection", "x-ms-examples": { "GetCollection": { @@ -251,7 +251,7 @@ }, "/wfs/datasets/{datasetId}/collections/{collectionId}/definition": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Definition API provides the detailed data model of a given collection.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/rest/api/maps-creator/dataset). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Definition API provides the detailed data model of a given collection.", "operationId": "WFS_GetCollectionDefinition", "x-ms-examples": { "GetCollectionDefinition": { @@ -287,7 +287,7 @@ }, "/wfs/datasets/{datasetId}/collections/{collectionId}/items": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Features API returns the list of features in the given collection.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/rest/api/maps-creator/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Features API returns the list of features in the given collection.", "operationId": "WFS_GetFeatures", "x-ms-examples": { "GetFeatures": { @@ -332,7 +332,7 @@ }, "/wfs/datasets/{datasetId}/collections/{collectionId}/items/{featureId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Feature API returns the feature identified by the provided id in the given collection.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/rest/api/maps-creator/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Feature API returns the feature identified by the provided id in the given collection.", "operationId": "WFS_GetFeature", "x-ms-examples": { "GetFeature": { @@ -366,7 +366,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features. Deleting a facility feature deletes all the child features of that facility recursively.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/rest/api/maps-creator/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features. Deleting a facility feature deletes all the child features of that facility recursively.", "operationId": "WFS_DeleteFeature", "x-ms-examples": { "DeleteFeature": { diff --git a/specification/maps/data-plane/Creator/preview/2022-09-01-preview/tileset.json b/specification/maps/data-plane/Creator/preview/2022-09-01-preview/tileset.json index a477ec1282ae..2acb5a2d6390 100644 --- a/specification/maps/data-plane/Creator/preview/2022-09-01-preview/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2022-09-01-preview/tileset.json @@ -102,7 +102,7 @@ "paths": { "/tilesets": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Create request creates a tileset from the specified dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/v2/dataset/create).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an **optional request body** as [tileset configuration](/rest/api/documentation-preview/tileset/create?#tilesetconfiguration). The `datasetId` query parameter will be used as the source of the tileset data.\n\nThe Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Create request creates a tileset from the specified dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/v2/dataset/create).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an **optional request body** as [tileset configuration](/rest/api/maps-creator/tileset/create#tilesetconfiguration). The `datasetId` query parameter will be used as the source of the tileset data.\n\nThe Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "Tileset_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -241,7 +241,7 @@ }, "/tilesets:fetchConfiguration": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Get Configuration request allows the caller to get a default [tileset configuration](/rest/api/documentation-preview/tileset/get-configuration?#tilesetconfiguration) based on the dataset provided. Then the tileset configuration can be used to create custom tileset using the [Tileset Create API](/rest/api/documentation-preview/tileset/create).\n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Get Configuration request allows the caller to get a default [tileset configuration](/rest/api/maps-creator/tileset/get-configuration#tilesetconfiguration) based on the dataset provided. Then the tileset configuration can be used to create custom tileset using the [Tileset Create API](/rest/api/documentation-preview/tileset/create).\n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", "operationId": "Tileset_GetConfiguration", "x-ms-examples": { "Gets the tileset configuration for a given dataset": { @@ -261,7 +261,7 @@ ], "responses": { "200": { - "description": "Get tileset configuration request completed successfully. The response body contains a default [tileset configuration](/rest/api/documentation-preview/tileset/get-configuration?#tilesetconfiguration) generated for the given dataset.", + "description": "Get tileset configuration request completed successfully. The response body contains a default [tileset configuration](/rest/api/maps-creator/tileset/get-configuration#tilesetconfiguration) generated for the given dataset.", "schema": { "$ref": "#/definitions/TilesetConfiguration" } @@ -274,7 +274,7 @@ }, "/tilesets:validateConfiguration": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Validate Configuration request allows the caller to validate a [tileset configuration](/rest/api/documentation-preview/tileset/validate-configuration?#tilesetconfiguration).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Validate Configuration request allows the caller to validate a [tileset configuration](/rest/api/maps-creator/tileset/validate-configuration#tilesetconfiguration).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", "operationId": "Tileset_ValidateConfiguration", "x-ms-examples": { "Validates the correctness of a tileset configuration": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/alias.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/alias.json index 3df6eabc7f00..375e5cc70796 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/alias.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/alias.json @@ -93,7 +93,7 @@ "paths": { "/aliases": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to create an alias. You can also assign the alias during the create request. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response with the alias resource in the body.\n\nA sample response from creating an alias:\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to create an alias. You can also assign the alias during the create request. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response with the alias resource in the body.\n\nA sample response from creating an alias:\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", "operationId": "Alias_Create", "x-ms-examples": { "Create an alias that does not reference any resource": { @@ -130,7 +130,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ\n\nA sample response returning 2 alias resources:\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33.123Z\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"creatorDataItemId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33.123Z\"\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 previously successfully created aliases.\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ\n\nA sample response returning 2 alias resources:\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33.123Z\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"creatorDataItemId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33.123Z\"\n }\n ]\n}\n```", "operationId": "Alias_List", "x-ms-examples": { "List all the previously created aliases": { @@ -164,7 +164,7 @@ }, "/aliases/{aliasId}": { "put": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to assign an alias to reference a resource.\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.\n\n### Assign Alias Response\n\nThe Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to assign an alias to reference a resource.\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.\n\n### Assign Alias Response\n\nThe Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", "operationId": "Alias_Assign", "x-ms-examples": { "Assign an alias to a resource": { @@ -198,7 +198,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a previously created alias. You can also use this API to delete old/unused aliases to create space for new content.This API does not delete the references resource, only the alias referencing the resource.\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete a previously created alias. You can also use this API to delete old/unused aliases to create space for new content.This API does not delete the references resource, only the alias referencing the resource.\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.", "operationId": "Alias_Delete", "x-ms-examples": { "Delete previously created alias": { @@ -226,7 +226,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch the details of a previously created alias.\n\n### Submit Get Details Request\n\nTo get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\nHere's a sample response:\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch the details of a previously created alias.\n\n### Submit Get Details Request\n\nTo get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\nHere's a sample response:\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", "operationId": "Alias_Get", "x-ms-examples": { "Get a previously created alias": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dataset.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dataset.json index c17d5fcb6e2e..f5d484f459ad 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dataset.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dataset.json @@ -25,14 +25,14 @@ "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](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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](/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -68,7 +68,7 @@ }, "ConversionIdQuery": { "name": "conversionId", - "description": "ID to create the dataset. The `conversionId` must be obtained from a successful call to the Conversion Service [Convert API](https://docs.microsoft.com/rest/api/maps/v2/conversion/convert). Only one conversionId can be provided per API call. **conversionId and udid are mutually exclusive parameters.**", + "description": "ID to create the dataset. The `conversionId` must be obtained from a successful call to the Conversion Service [Convert API](/rest/api/maps-creator/conversion/convert). Only one conversionId can be provided per API call. **conversionId and udid are mutually exclusive parameters.**", "type": "string", "in": "query", "required": false, @@ -76,7 +76,7 @@ }, "Udid": { "name": "udid", - "description": "ID to create the dataset. The `udid` can be obtained from uploading data using [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data-v2). Only one udid can be provided per API call. **outputOntology parameter must be provided with the udid. conversionId and udid are mutually exclusive parameters.**", + "description": "ID to create the dataset. The `udid` can be obtained from uploading data using [Azure Maps Data Service](/rest/api/maps/data). Only one udid can be provided per API call. **outputOntology parameter must be provided with the udid. conversionId and udid are mutually exclusive parameters.**", "type": "string", "in": "query", "required": false, @@ -131,7 +131,7 @@ "paths": { "/datasets": { "post": { - "description": "This API allows the caller to create a dataset from data that was uploaded to the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data-v2) and converted using the [Azure Maps Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion). You can also create a dataset directly using data uploaded to the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data-v2), provided that the uploaded data is a zip of GeoJSON files conforming to the [facility ontology](https://docs.microsoft.com/azure/azure-maps/creator-facility-ontology) format.\n\nFor more information on how to create a dataset from a zip of GeoJSON files, please visit this [article](https://aka.ms/howtofacilitygeojson)\n\n### Submit Create Request\n\nTo create your dataset, issue a `POST` request with the required parameters. The Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "This API allows the caller to create a dataset from data that was uploaded to the [Azure Maps Data Service](/rest/api/maps/data) and converted using the [Azure Maps Conversion Service](/rest/api/maps-creator/conversion). You can also create a dataset directly using data uploaded to the [Azure Maps Data Service](/rest/api/maps/data), provided that the uploaded data is a zip of GeoJSON files conforming to the [facility ontology](/azure/azure-maps/creator-facility-ontology) format.\n\nFor more information on how to create a dataset from a zip of GeoJSON files, please visit this [article](https://aka.ms/howtofacilitygeojson)\n\n### Submit Create Request\n\nTo create your dataset, issue a `POST` request with the required parameters. The Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "Dataset_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dwgconversion.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dwgconversion.json index 40f73f3e535e..e22c6b258b9c 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dwgconversion.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dwgconversion.json @@ -25,14 +25,14 @@ "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](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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](/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -68,7 +68,7 @@ }, "UdidQuery": { "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/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](/rest/api/maps/data/upload) call.", "type": "string", "in": "query", "required": true, @@ -76,7 +76,7 @@ }, "ConversionId": { "name": "conversionId", - "description": "The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](https://docs.microsoft.com/rest/api/maps/v2/conversion/convert) call.", + "description": "The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](/rest/api/maps-creator/conversion/convert) call.", "type": "string", "in": "path", "required": true, @@ -98,11 +98,11 @@ "values": [ { "value": "1.0", - "description": "The drawing package version 1.0. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/drawing-requirements?pivots=1.0) for more information." + "description": "The drawing package version 1.0. Please refer to this [article](/azure/azure-maps/drawing-requirements?pivots=1.0) for more information." }, { "value": "2.0", - "description": "The drawing package version 2.0. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/drawing-requirements?pivots=2.0) for more information." + "description": "The drawing package version 2.0. Please refer to this [article](/azure/azure-maps/drawing-requirements?pivots=2.0) for more information." } ] }, @@ -128,7 +128,7 @@ "paths": { "/conversions": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be uploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the `udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload-preview) to call this Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be uploaded using the [Azure Maps Data Service](/rest/api/maps/data). Once uploaded, use the `udid` returned by the [Data Upload API](/rest/api/maps/data/upload) to call this Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", "operationId": "Conversion_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -166,7 +166,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/rest/api/maps/v2/conversion/convert). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\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 successful data conversions submitted previously using the [Conversion API](/rest/api/maps-creator/conversion/convert). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
", "operationId": "Conversion_List", "x-ms-examples": { "Returns a list of all the data processed by the Conversion Service for the account": { @@ -200,7 +200,7 @@ }, "/conversions/{conversionId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a successful data conversion submitted previously using the [Conversion API](https://docs.microsoft.com/rest/api/maps/v2/conversion/convert). ", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a successful data conversion submitted previously using the [Conversion API](/rest/api/maps-creator/conversion/convert). ", "operationId": "Conversion_Get", "x-ms-examples": { "Get the details for one conversion operation": { @@ -231,7 +231,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/rest/api/maps/v2/conversion/convert).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](/rest/api/maps-creator/conversion/convert).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", "operationId": "Conversion_Delete", "x-ms-examples": { "Delete previously converted content": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/features.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/features.json index f1503e78de27..5539a4f8cd0e 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/features.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/features.json @@ -144,7 +144,7 @@ "paths": { "/features/datasets/{datasetId}": { "get": { - "description": "The Get Landing Page API provides links to the API definition, the Conformance statements, and the metadata about the feature data in this dataset.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get Landing Page API provides links to the API definition, the Conformance statements, and the metadata about the feature data in this dataset.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_GetLandingPage", "x-ms-examples": { "GetLandingPage": { @@ -177,7 +177,7 @@ }, "/features/datasets/{datasetId}/api": { "get": { - "description": "The Get API Definition API provides a description of the capabilities of the Features service. It can be used by developers to understand the API or by development tools to support the implementation of servers and clients.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get API Definition API provides a description of the capabilities of the Features service. It can be used by developers to understand the API or by development tools to support the implementation of servers and clients.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_GetApiDefinition", "x-ms-examples": { "GetApiDefinition": { @@ -210,7 +210,7 @@ }, "/features/datasets/{datasetId}/conformance": { "get": { - "description": "The Get Conformance API lists all requirements classes specified in the standard that the server conforms to.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get Conformance API lists all requirements classes specified in the standard that the server conforms to.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_ListConformance", "x-ms-examples": { "GetConformance": { @@ -243,7 +243,7 @@ }, "/features/datasets/{datasetId}/collections": { "get": { - "description": "The Get Collections API provides a list of all the collections in a given dataset.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get Collections API provides a list of all the collections in a given dataset.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_GetCollections", "x-ms-examples": { "GetCollections": { @@ -276,7 +276,7 @@ }, "/features/datasets/{datasetId}/collections/{collectionId}": { "get": { - "description": "The Get Collection API returns the collection identified by the provided id in the given dataset.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get Collection API returns the collection identified by the provided id in the given dataset.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_GetCollection", "x-ms-examples": { "GetCollection": { @@ -312,7 +312,7 @@ }, "/features/datasets/{datasetId}/collections/{collectionId}/definition": { "get": { - "description": "The Collection Definition API provides the detailed data model of a given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Collection Definition API provides the detailed data model of a given collection.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_GetCollectionDefinition", "x-ms-examples": { "GetCollectionDefinition": { @@ -348,7 +348,7 @@ }, "/features/datasets/{datasetId}/collections/{collectionId}/items": { "get": { - "description": "The Get Features API returns the list of features in the given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get Features API returns the list of features in the given collection.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_GetItems", "x-ms-examples": { "GetFeatures": { @@ -391,7 +391,7 @@ } }, "post": { - "description": "This Post Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API creates a feature with the provided attributes in the given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "This Post Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API creates a feature with the provided attributes in the given collection.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_Create", "x-ms-examples": { "PostFeature": { @@ -430,7 +430,7 @@ }, "/features/datasets/{datasetId}/collections/{collectionId}/items/{featureId}": { "get": { - "description": "The Get Feature API returns the feature identified by the provided id in the given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get Feature API returns the feature identified by the provided id in the given collection.\n\nThe Features API is a part of [Creator](azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_Get", "x-ms-examples": { "GetFeature": { @@ -464,7 +464,7 @@ } }, "put": { - "description": "This Put Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API **replaces** the feature identified by the provided id in the given collection, i.e., the request body overwrites all the existing attributes of a feature.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "This Put Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API **replaces** the feature identified by the provided id in the given collection, i.e., the request body overwrites all the existing attributes of a feature.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_Replace", "x-ms-examples": { "PutFeature": { @@ -501,7 +501,7 @@ } }, "patch": { - "description": "This Patch Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API **updates** attributes by performing a merge patch on the feature identified by the provided id in the given collection. It allows for the update of individual feature attributes without implicitly overwriting excluded attributes in the request body.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "This Patch Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API **updates** attributes by performing a merge patch on the feature identified by the provided id in the given collection. It allows for the update of individual feature attributes without implicitly overwriting excluded attributes in the request body.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_Update", "x-ms-examples": { "PatchFeature": { @@ -538,7 +538,7 @@ } }, "delete": { - "description": "This Delete Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API deletes the feature identified by the provided id in the given collection. Please note that if other existing features are dependent on the requested feature for deletion, the delete request will fail until the dependent features are deleted first.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "This Delete Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API deletes the feature identified by the provided id in the given collection. Please note that if other existing features are dependent on the requested feature for deletion, the delete request will fail until the dependent features are deleted first.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_Delete", "x-ms-examples": { "DeleteFeature": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/featurestate.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/featurestate.json index 191d785fdd7b..3735d50e04ef 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/featurestate.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/featurestate.json @@ -76,7 +76,7 @@ }, "DatasetIdForCreate": { "name": "datasetId", - "description": "The datasetId must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/rest/api/maps/v2/dataset/create) call.", + "description": "The datasetId must have been obtained from a successful [Dataset Create API](/rest/api/maps-creator/dataset/create) call.", "type": "string", "in": "query", "required": true, @@ -127,7 +127,7 @@ "paths": { "/featureStateSets": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the [State Tile documentation](https://docs.microsoft.com/rest/api/maps/render/get-map-state-tile) for more information.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the [State Tile documentation](https://docs.microsoft.com/rest/api/maps/render/get-map-state-tile) for more information.", "operationId": "FeatureState_CreateStateset", "x-ms-examples": { "Create a new stateset with a datasetId": { @@ -170,7 +170,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API allows the caller to fetch a list of all previously successfully created statesets.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n This API allows the caller to fetch a list of all previously successfully created statesets.", "operationId": "FeatureState_ListStatesets", "x-ms-examples": { "List all the previously created statesets": { @@ -204,7 +204,7 @@ }, "/featureStateSets/{statesetId}": { "put": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis PUT API allows the user to update the stateset style rules.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis PUT API allows the user to update the stateset style rules.", "operationId": "FeatureState_UpdateStateset", "x-ms-examples": { "Update stateset style rules with a statesetId": { @@ -241,7 +241,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This DELETE API allows the user to delete the stateset and the associated data.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n This DELETE API allows the user to delete the stateset and the associated data.", "operationId": "FeatureState_DeleteStateset", "x-ms-examples": { "Delete an existing stateset": { @@ -269,7 +269,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", "operationId": "FeatureState_GetStateset", "x-ms-examples": { "Get stateset information with a statesetId": { @@ -303,7 +303,7 @@ "/featureStateSets/{statesetId}/featureStates/{featureId}": { "put": { "operationId": "FeatureState_UpdateStates", - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis PUT API allows the user to update the state of the given feature in the given stateset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis PUT API allows the user to update the state of the given feature in the given stateset.", "x-ms-examples": { "Update the states of a feature": { "$ref": "./examples/featurestate/Featurestate_UpdateStates.json" @@ -343,7 +343,7 @@ }, "delete": { "operationId": "FeatureState_DeleteState", - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", "x-ms-examples": { "Delete the given feature state": { "$ref": "./examples/featurestate/Featurestate_DeleteFeatureState.json" @@ -377,7 +377,7 @@ }, "get": { "operationId": "FeatureState_ListStates", - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API returns the current state information associated with the given feature in the given stateset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n This API returns the current state information associated with the given feature in the given stateset.", "x-ms-examples": { "Get the current states of a feature": { "$ref": "./examples/featurestate/Featurestate_ListStates.json" diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/mapconfiguration.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/mapconfiguration.json index 373b86f16954..fd9418b051c7 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/mapconfiguration.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/mapconfiguration.json @@ -101,7 +101,7 @@ "paths": { "/styles/mapconfigurations": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Map Configuration Create request allows the caller to create a map configuration in their Azure Maps account.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n## Submit Create Request\n\nTo create your map configuration you will make a `POST` request with a map configuration file. \n\n### POST Body for Create Request\nAn `HTTP POST` request with the map configuration data in the body of the request is required to create a new map configuration in your Azure Maps account. The map configuration data must be in JSON format with `Content-Type` set to `application/json` in the header. Alternatively, you can send the map configuration JSON in a ZIP file along with any thumbnail images it references, with `Content-Type` set to `application/zip` in the header. \n\n Note: The embedded JSON size limit is 1 MB and zip file size limit is 23 MB.\n\n\n Here's a sample map configuration json:\n\n\n```json\n{\n \"version\": 1.0,\n \"description\": \"First indoor map configuration!\",\n \"defaultConfiguration\": \"indoor_light\",\n \"configurations\": [\n {\n \"name\": \"indoor_light\",\n \"displayName\": \"Indoor light\",\n \"theme\": \"light\",\n \"thumbnail\": \"indoor_2022-01-01.png\",\n \"baseMap\": \"microsoft_light\",\n \"layers\": [\n {\n \"tilesetId\": \"9601b149-cff6-dae6-af94-396f1b795fdb\",\n \"styleId\": \"microsoft-maps:indoor_2022-01-01\"\n }\n ]\n },\n {\n \"name\": \"indoor_dark\",\n \"displayName\": \"Indoor dark\",\n \"theme\": \"dark\",\n \"baseMap\": \"microsoft_dark\",\n \"thumbnail\": \"indoor_dark_2022-01-01.png\",\n \"layers\": [\n {\n \"tilesetId\": \"9601b149-cff6-dae6-af94-396f1b795fdb\",\n \"styleId\": \"microsoft-maps:indoor_dark_2022-01-01\"\n }\n ]\n }\n ]\n}\n``` \n\n Since the map configuration json contains two thumbnail image references 'indoor_2022-01-01.png' and 'indoor_dark_2022-01-01.png', a zip file including the map configuration json file and two thumbnail images should be provided as request body to make a valid create request. ALL files should be put in the root directory of the zip file. The thumbnail image file name should match the thumbnail name provided in the json file. \n\nThe Create Map Configuration API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Map Configuration Create request allows the caller to create a map configuration in their Azure Maps account.\n\n## Submit Create Request\n\nTo create your map configuration you will make a `POST` request with a map configuration file. \n\n### POST Body for Create Request\nAn `HTTP POST` request with the map configuration data in the body of the request is required to create a new map configuration in your Azure Maps account. The map configuration data must be in JSON format with `Content-Type` set to `application/json` in the header. Alternatively, you can send the map configuration JSON in a ZIP file along with any thumbnail images it references, with `Content-Type` set to `application/zip` in the header. \n\n Note: The embedded JSON size limit is 1 MB and zip file size limit is 23 MB.\n\n\n Here's a sample map configuration json:\n\n\n```json\n{\n \"version\": 1.0,\n \"description\": \"First indoor map configuration!\",\n \"defaultConfiguration\": \"indoor_light\",\n \"configurations\": [\n {\n \"name\": \"indoor_light\",\n \"displayName\": \"Indoor light\",\n \"theme\": \"light\",\n \"thumbnail\": \"indoor_2022-01-01.png\",\n \"baseMap\": \"microsoft_light\",\n \"layers\": [\n {\n \"tilesetId\": \"9601b149-cff6-dae6-af94-396f1b795fdb\",\n \"styleId\": \"microsoft-maps:indoor_2022-01-01\"\n }\n ]\n },\n {\n \"name\": \"indoor_dark\",\n \"displayName\": \"Indoor dark\",\n \"theme\": \"dark\",\n \"baseMap\": \"microsoft_dark\",\n \"thumbnail\": \"indoor_dark_2022-01-01.png\",\n \"layers\": [\n {\n \"tilesetId\": \"9601b149-cff6-dae6-af94-396f1b795fdb\",\n \"styleId\": \"microsoft-maps:indoor_dark_2022-01-01\"\n }\n ]\n }\n ]\n}\n``` \n\n Since the map configuration json contains two thumbnail image references 'indoor_2022-01-01.png' and 'indoor_dark_2022-01-01.png', a zip file including the map configuration json file and two thumbnail images should be provided as request body to make a valid create request. ALL files should be put in the root directory of the zip file. The thumbnail image file name should match the thumbnail name provided in the json file. \n\nThe Create Map Configuration API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "MapConfiguration_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -132,7 +132,7 @@ { "name": "MapConfiguration", "in": "body", - "description": "The configuration file used to create the map configuration. If JSON data format is provided, then the request body should follow [MapConfiguration specification](/rest/api/documentation-preview/map-configuration/create?#mapconfiguration). If ZIP data format is provided, you should also provide the thumbnail images referenced in the configuration JSON file. ALL files should be put in the root directory of the zip file. The thumbnail image file name should match the thumbnail name provided in the json file. The size limit is 23 MB.", + "description": "The configuration file used to create the map configuration. If JSON data format is provided, then the request body should follow [MapConfiguration specification](/rest/api/maps-creator/map-configuration/create?view=rest-maps-creator-2023-03-01-preview&tabs=HTTP#mapconfiguration). If ZIP data format is provided, you should also provide the thumbnail images referenced in the configuration JSON file. ALL files should be put in the root directory of the zip file. The thumbnail image file name should match the thumbnail name provided in the json file. The size limit is 23 MB.", "required": true, "schema": { "$ref": "#/definitions/MapConfiguration" @@ -149,7 +149,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Map Configuration List request allows the caller to fetch a list of all map configurations created. You will see all the default map configurations which are created during tileset creation.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. \n
", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Map Configuration List request allows the caller to fetch a list of all map configurations created. You will see all the default map configurations which are created during tileset creation. \n
", "operationId": "MapConfiguration_List", "x-ms-examples": { "Get a list of all map configurations": { @@ -183,7 +183,7 @@ }, "/styles/mapconfigurations/{mapConfigurationId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Map Configuration Get request allows the caller to fetch a map configuration. The response contains a zip file with the map configuration JSON and any image files it references. You can always get the default map configuration using predefined alias `defaultIndoor_{tilesetId}` for a given tileset if you deleted the auto-generated map configuration. The two predefined styles used in default map configuration are `microsoft-maps:indoor_2022-01-01` and `microsoft-maps:indoor_dark_2022-01-01`.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Map Configuration Get request allows the caller to fetch a map configuration. The response contains a zip file with the map configuration JSON and any image files it references. You can always get the default map configuration using predefined alias `defaultIndoor_{tilesetId}` for a given tileset if you deleted the auto-generated map configuration. The two predefined styles used in default map configuration are `microsoft-maps:indoor_2022-01-01` and `microsoft-maps:indoor_dark_2022-01-01`.\n\n", "operationId": "MapConfiguration_Get", "x-ms-examples": { "Gets the details for a single map configuration": { @@ -225,7 +225,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Map Configuration Delete request allows the caller to remove a map configuration from their Azure Maps account. You can use this API if a map configuration is no longer needed. \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n### Submit Delete Request\n\nAn `HTTP DELETE` request with the `mapConfigurationId` in the path of the request is required to remove an existing map configuration from your Azure Maps account.
\n\n#### Delete request \"Successful\"\n\nThe Map Configuration Delete API returns a HTTP `204 No Content` response with an empty body, if the map configuration was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the map configuration with the passed-in `mapConfigurationId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - MapConfiguration Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Map Configuration Delete request allows the caller to remove a map configuration from their Azure Maps account. You can use this API if a map configuration is no longer needed. \n\n### Submit Delete Request\n\nAn `HTTP DELETE` request with the `mapConfigurationId` in the path of the request is required to remove an existing map configuration from your Azure Maps account.
\n\n#### Delete request \"Successful\"\n\nThe Map Configuration Delete API returns a HTTP `204 No Content` response with an empty body, if the map configuration was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the map configuration with the passed-in `mapConfigurationId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - MapConfiguration Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", "operationId": "MapConfiguration_Delete", "x-ms-examples": { "Delete a created map configuration": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/style.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/style.json index 9085c58c78a2..89492dac8f73 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/style.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/style.json @@ -101,7 +101,7 @@ "paths": { "/styles": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Style Create request allows the caller to create an Azure Maps style.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n## Submit Create Request\n\nTo create your style you will make a `POST` request with an azure maps style. \n\nThe Create Style API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Style Create request allows the caller to create an Azure Maps style.\n\n## Submit Create Request\n\nTo create your style you will make a `POST` request with an azure maps style. \n\nThe Create Style API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "Style_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -149,7 +149,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Style List request allows the caller to fetch a list of all styles created. The default indoor style `microsoft-maps:indoor_2022-01-01` and `microsoft-maps:indoor_dark_2022-01-01` will not show in the list response. But you can still use it as your own style by the predefined alias.\n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. \n
", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Style List request allows the caller to fetch a list of all styles created. The default indoor style `microsoft-maps:indoor_2022-01-01` and `microsoft-maps:indoor_dark_2022-01-01` will not show in the list response. But you can still use it as your own style by the predefined alias.\n
", "operationId": "Style_List", "x-ms-examples": { "Get a list of all styles": { @@ -183,7 +183,7 @@ }, "/styles/{styleId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Style Get request allows the caller to get a style. Customers can get two predefined default styles using alias `microsoft-maps:indoor_2022-01-01` for indoor light and `microsoft-maps:indoor_dark_2022-01-01` for indoor dark. \n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Style Get request allows the caller to get a style. Customers can get two predefined default styles using alias `microsoft-maps:indoor_2022-01-01` for indoor light and `microsoft-maps:indoor_dark_2022-01-01` for indoor dark.", "operationId": "Style_Get", "x-ms-examples": { "Get the details for a single style": { @@ -225,7 +225,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Style Delete request allows the caller to remove a style from their Azure Maps account.
\n\n### Submit Delete Request\n\nAn `HTTP DELETE` request with the `styleId` in the path of the request is required to remove an existing style from your Azure Maps account.
\n\n#### Delete request \"Successful\"\n\nThe Style Delete API returns a HTTP `204 No Content` response with an empty body, if the style was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the style with the passed-in `styleId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Style Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Style Delete request allows the caller to remove a style from their Azure Maps account.
\n\n### Submit Delete Request\n\nAn `HTTP DELETE` request with the `styleId` in the path of the request is required to remove an existing style from your Azure Maps account.
\n\n#### Delete request \"Successful\"\n\nThe Style Delete API returns a HTTP `204 No Content` response with an empty body, if the style was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the style with the passed-in `styleId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Style Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", "operationId": "Style_Delete", "x-ms-examples": { "Delete a created style": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/tileset.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/tileset.json index 9619a706a779..474fe0e82eed 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/tileset.json @@ -25,14 +25,14 @@ "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](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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](/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -68,7 +68,7 @@ }, "DatasetIdQuery": { "name": "datasetId", - "description": "The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/rest/api/maps/v2/dataset/create) call.", + "description": "The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](/rest/api/maps-creator/dataset/create) call.", "type": "string", "in": "query", "required": true, @@ -101,7 +101,7 @@ "paths": { "/tilesets": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Create request creates a tileset from the specified dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/v2/dataset/create).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an **optional request body** as [tileset configuration](/rest/api/documentation-preview/tileset/create?#tilesetconfiguration). The `datasetId` query parameter will be used as the source of the tileset data.\n\nThe Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Create request creates a tileset from the specified dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps-creator/dataset/create).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an **optional request body** as [tileset configuration](/rest/api/maps-creator/tileset/create#tilesetconfiguration). The `datasetId` query parameter will be used as the source of the tileset data.\n\nThe Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "Tileset_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -145,7 +145,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset List request allows the caller to fetch a list of all tilesets created.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. \n
", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset List request allows the caller to fetch a list of all tilesets created. \n
", "operationId": "Tileset_List", "x-ms-examples": { "Get a list of all tilesets": { @@ -179,7 +179,7 @@ }, "/tilesets/{tilesetId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Get request allows the caller to fetch a tileset.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Get request allows the caller to fetch a tileset.", "operationId": "Tileset_Get", "x-ms-examples": { "Gets the details for a single tileset": { @@ -210,7 +210,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Delete request allows the caller to delete a created tileset. You can use this API if a tileset is no longer needed. \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Delete request allows the caller to delete a created tileset. You can use this API if a tileset is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", "operationId": "Tileset_Delete", "x-ms-examples": { "Delete a created tileset": { @@ -240,7 +240,7 @@ }, "/tilesets:fetchConfiguration": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Get Configuration request allows the caller to get a default [tileset configuration](/rest/api/documentation-preview/tileset/get-configuration?#tilesetconfiguration) based on the dataset provided. Then the tileset configuration can be used to create custom tileset using the [Tileset Create API](/rest/api/documentation-preview/tileset/create).\n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Get Configuration request allows the caller to get a default [tileset configuration](/rest/api/maps-creator/tileset/get-configuration#tilesetconfiguration) based on the dataset provided. Then the tileset configuration can be used to create custom tileset using the [Tileset Create API](/rest/api/maps-creator/tileset/create).\n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", "operationId": "Tileset_GetConfiguration", "x-ms-examples": { "Gets the tileset configuration for a given dataset": { @@ -260,7 +260,7 @@ ], "responses": { "200": { - "description": "Get tileset configuration request completed successfully. The response body contains a default [tileset configuration](/rest/api/documentation-preview/tileset/get-configuration?#tilesetconfiguration) generated for the given dataset.", + "description": "Get tileset configuration request completed successfully. The response body contains a default [tileset configuration](/rest/api/maps-creator/tileset/get-configuration#tilesetconfiguration) generated for the given dataset.", "schema": { "$ref": "#/definitions/TilesetConfiguration" } @@ -273,7 +273,7 @@ }, "/tilesets:validateConfiguration": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Validate Configuration request allows the caller to validate a [tileset configuration](/rest/api/documentation-preview/tileset/validate-configuration?#tilesetconfiguration).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Validate Configuration request allows the caller to validate a [tileset configuration](/rest/api/maps-creator/tileset/validate-configuration#tilesetconfiguration).", "operationId": "Tileset_ValidateConfiguration", "x-ms-examples": { "Validates the correctness of a tileset configuration": { @@ -532,7 +532,7 @@ ], "properties": { "featureClasses": { - "description": "The list of feature classes that will be used to build the layer. The valid feature classes can be found in its ontology definition. For example, [Facility Ontology](https://docs.microsoft.com/azure/azure-maps/creator-facility-ontology)", + "description": "The list of feature classes that will be used to build the layer. The valid feature classes can be found in its ontology definition. For example, [Facility Ontology](/azure/azure-maps/creator-facility-ontology)", "type": "array", "items": { "type": "string" diff --git a/specification/maps/data-plane/Creator/readme.md b/specification/maps/data-plane/Creator/readme.md index 3c468fd5c1ab..16988816c2c4 100644 --- a/specification/maps/data-plane/Creator/readme.md +++ b/specification/maps/data-plane/Creator/readme.md @@ -41,6 +41,8 @@ directive: from: /specification/maps/data-plane/Creator/preview/2023-07-01-preview reason: The files in '/specification/maps/data-plane/Creator/stable/2023-07-01-preview' were never released. Please ignore them, they should not appear in the TOC. '/specification/maps/data-plane/Creator/preview/2023-03-01-preview/' contains the latest preview. + - suppress: RESPONSE_SCHEMA_NOT_IN_SPEC + reason: false positive from oav is breaking our example validation. See azure/oav#1021. ``` ### Tag: package-stable-V2 diff --git a/specification/maps/data-plane/Creator/stable/2023-07-01/features.json b/specification/maps/data-plane/Creator/stable/2023-07-01/features.json index a252def617d0..a789165f4ab8 100644 --- a/specification/maps/data-plane/Creator/stable/2023-07-01/features.json +++ b/specification/maps/data-plane/Creator/stable/2023-07-01/features.json @@ -144,7 +144,7 @@ "paths": { "/features/datasets/{datasetId}": { "get": { - "description": "The Get Landing Page API provides links to the API definition, the Conformance statements, and the metadata about the feature data in this dataset.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get Landing Page API provides links to the API definition, the Conformance statements, and the metadata about the feature data in this dataset.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_GetLandingPage", "x-ms-examples": { "GetLandingPage": { @@ -177,7 +177,7 @@ }, "/features/datasets/{datasetId}/api": { "get": { - "description": "The Get API Definition API provides a description of the capabilities of the Features service. It can be used by developers to understand the API or by development tools to support the implementation of servers and clients.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get API Definition API provides a description of the capabilities of the Features service. It can be used by developers to understand the API or by development tools to support the implementation of servers and clients.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_GetApiDefinition", "x-ms-examples": { "GetApiDefinition": { @@ -210,7 +210,7 @@ }, "/features/datasets/{datasetId}/conformance": { "get": { - "description": "The Get Conformance API lists all requirements classes specified in the standard that the server conforms to.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get Conformance API lists all requirements classes specified in the standard that the server conforms to.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_ListConformance", "x-ms-examples": { "GetConformance": { @@ -243,7 +243,7 @@ }, "/features/datasets/{datasetId}/collections": { "get": { - "description": "The Get Collections API provides a list of all the collections in a given dataset.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get Collections API provides a list of all the collections in a given dataset.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_GetCollections", "x-ms-examples": { "GetCollections": { @@ -276,7 +276,7 @@ }, "/features/datasets/{datasetId}/collections/{collectionId}": { "get": { - "description": "The Get Collection API returns the collection identified by the provided id in the given dataset.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get Collection API returns the collection identified by the provided id in the given dataset.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_GetCollection", "x-ms-examples": { "GetCollection": { @@ -312,7 +312,7 @@ }, "/features/datasets/{datasetId}/collections/{collectionId}/definition": { "get": { - "description": "The Collection Definition API provides the detailed data model of a given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Collection Definition API provides the detailed data model of a given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_GetCollectionDefinition", "x-ms-examples": { "GetCollectionDefinition": { @@ -348,7 +348,7 @@ }, "/features/datasets/{datasetId}/collections/{collectionId}/items": { "get": { - "description": "The Get Features API returns the list of features in the given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get Features API returns the list of features in the given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_GetItems", "x-ms-examples": { "GetFeatures": { @@ -391,7 +391,7 @@ } }, "post": { - "description": "This Post Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API creates a feature with the provided attributes in the given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "This Post Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API creates a feature with the provided attributes in the given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_Create", "x-ms-examples": { "PostFeature": { @@ -430,7 +430,7 @@ }, "/features/datasets/{datasetId}/collections/{collectionId}/items/{featureId}": { "get": { - "description": "The Get Feature API returns the feature identified by the provided id in the given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "The Get Feature API returns the feature identified by the provided id in the given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_Get", "x-ms-examples": { "GetFeature": { @@ -464,7 +464,7 @@ } }, "put": { - "description": "This Put Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API **replaces** the feature identified by the provided id in the given collection, i.e., the request body overwrites all the existing attributes of a feature.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "This Put Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API **replaces** the feature identified by the provided id in the given collection, i.e., the request body overwrites all the existing attributes of a feature.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_Replace", "x-ms-examples": { "PutFeature": { @@ -501,7 +501,7 @@ } }, "patch": { - "description": "This Patch Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API **updates** attributes by performing a merge patch on the feature identified by the provided id in the given collection. It allows for the update of individual feature attributes without implicitly overwriting excluded attributes in the request body.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "This Patch Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API **updates** attributes by performing a merge patch on the feature identified by the provided id in the given collection. It allows for the update of individual feature attributes without implicitly overwriting excluded attributes in the request body.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_Update", "x-ms-examples": { "PatchFeature": { @@ -538,7 +538,7 @@ } }, "delete": { - "description": "This Delete Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API deletes the feature identified by the provided id in the given collection. Please note that if other existing features are dependent on the requested feature for deletion, the delete request will fail until the dependent features are deleted first.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", + "description": "This Delete Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API deletes the feature identified by the provided id in the given collection. Please note that if other existing features are dependent on the requested feature for deletion, the delete request will fail until the dependent features are deleted first.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", "operationId": "Features_Delete", "x-ms-examples": { "DeleteFeature": { diff --git a/specification/maps/data-plane/Creator/stable/2023-07-01/tileset.json b/specification/maps/data-plane/Creator/stable/2023-07-01/tileset.json index 58e11a65a8a5..4dcc4940881b 100644 --- a/specification/maps/data-plane/Creator/stable/2023-07-01/tileset.json +++ b/specification/maps/data-plane/Creator/stable/2023-07-01/tileset.json @@ -101,7 +101,7 @@ "paths": { "/tilesets": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Create request creates a tileset from the specified dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/v2/dataset/create).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an **optional request body** as [tileset configuration](/rest/api/documentation-preview/tileset/create?#tilesetconfiguration). The `datasetId` query parameter will be used as the source of the tileset data.\n\nThe Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Create request creates a tileset from the specified dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/v2/dataset/create).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an **optional request body** as [tileset configuration](/rest/api/maps-creator/tileset/create#tilesetconfiguration). The `datasetId` query parameter will be used as the source of the tileset data.\n\nThe Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "Tileset_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -240,7 +240,7 @@ }, "/tilesets:fetchConfiguration": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Get Configuration request allows the caller to get a default [tileset configuration](/rest/api/documentation-preview/tileset/get-configuration?#tilesetconfiguration) based on the dataset provided. Then the tileset configuration can be used to create custom tileset using the [Tileset Create API](/rest/api/documentation-preview/tileset/create).\n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Get Configuration request allows the caller to get a default [tileset configuration](/rest/api/maps-creator/tileset/get-configuration#tilesetconfiguration) based on the dataset provided. Then the tileset configuration can be used to create custom tileset using the [Tileset Create API](/rest/api/documentation-preview/tileset/create).\n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", "operationId": "Tileset_GetConfiguration", "x-ms-examples": { "Gets the tileset configuration for a given dataset": { @@ -260,7 +260,7 @@ ], "responses": { "200": { - "description": "Get tileset configuration request completed successfully. The response body contains a default [tileset configuration](/rest/api/documentation-preview/tileset/get-configuration?#tilesetconfiguration) generated for the given dataset.", + "description": "Get tileset configuration request completed successfully. The response body contains a default [tileset configuration](/rest/api/maps-creator/tileset/get-configuration#tilesetconfiguration) generated for the given dataset.", "schema": { "$ref": "#/definitions/TilesetConfiguration" } @@ -273,7 +273,7 @@ }, "/tilesets:validateConfiguration": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Validate Configuration request allows the caller to validate a [tileset configuration](/rest/api/documentation-preview/tileset/validate-configuration?#tilesetconfiguration).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Validate Configuration request allows the caller to validate a [tileset configuration](/rest/api/maps-creator/tileset/validate-configuration#tilesetconfiguration).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", "operationId": "Tileset_ValidateConfiguration", "x-ms-examples": { "Validates the correctness of a tileset configuration": { diff --git a/specification/maps/data-plane/DataRegistry/stable/2023-06-01/dataregistry.json b/specification/maps/data-plane/DataRegistry/stable/2023-06-01/dataregistry.json index 76984b052ad4..d6feccc12402 100644 --- a/specification/maps/data-plane/DataRegistry/stable/2023-06-01/dataregistry.json +++ b/specification/maps/data-plane/DataRegistry/stable/2023-06-01/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\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\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.", "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 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 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.", "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## 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## 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": { diff --git a/specification/maps/data-plane/Geolocation/preview/1.0/geolocation.json b/specification/maps/data-plane/Geolocation/preview/1.0/geolocation.json index dee601f3c4ca..f57b0efcba90 100644 --- a/specification/maps/data-plane/Geolocation/preview/1.0/geolocation.json +++ b/specification/maps/data-plane/Geolocation/preview/1.0/geolocation.json @@ -64,7 +64,7 @@ "paths": { "/geolocation/ip/{format}": { "get": { - "description": "\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis service will return the ISO country code for the provided IP address. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from.", + "description": "\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis service will return the ISO country code for the provided IP address. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from.", "operationId": "Geolocation_GetIPToLocation", "x-ms-client-name": "GetLocation", "x-ms-examples": { diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json index 78d05d51d0ce..6c9b7ab15608 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json +++ b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -153,7 +153,7 @@ }, "SubscriptionKey": { "name": "subscription-key", - "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", "type": "string", "in": "query", "required": false, @@ -217,7 +217,7 @@ }, "Udid": { "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/uploadpreview) call.", + "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](/rest/api/maps/data/upload?view=rest-maps-1.0) call.", "type": "string", "in": "path", "required": true, @@ -228,7 +228,7 @@ "/mapData/upload": { "post": { "x-publish": true, - "description": "> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data) and [v2](/rest/api/maps/data-v2)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](https://learn.microsoft.com/en-us/azure/azure-maps/how-to-create-data-registries).\n\n**Applies to:** S1 pricing tier.\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## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. 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/deletepreview) to \ndelete old/unused content and create space for new uploads.", + "description": "**Applies to:** S1 pricing tier.\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](/rest/api/maps/spatial).\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\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 `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](/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](/rest/api/maps/data/delete?view=rest-maps-1.0) to \ndelete old/unused content and create space for new uploads.", "operationId": "Data_UploadPreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -296,7 +296,7 @@ "/mapData/{udid}": { "put": { "x-publish": true, - "description": "> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data) and [v2](/rest/api/maps/data-v2)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](https://learn.microsoft.com/en-us/azure/azure-maps/how-to-create-data-registries).\n\n**Applies to:** S1 pricing tier.\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/uploadpreview), 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## 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/deletepreview) to \ndelete old/unused content and create space for new uploads.", + "description": "**Applies to:** S1 pricing tier.\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](/rest/api/maps/data/upload?view=rest-maps-1.0), for \nuse in the [Azure Maps Geofencing Service](/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\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](/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](/rest/api/maps/data/delete?view=rest-maps-1.0) to \ndelete old/unused content and create space for new uploads.", "operationId": "Data_UpdatePreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -362,7 +362,7 @@ }, "get": { "x-publish": true, - "description": "> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data) and [v2](/rest/api/maps/data-v2)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](https://learn.microsoft.com/en-us/azure/azure-maps/how-to-create-data-registries).\n\n**Applies to:** S1 pricing tier.\n
\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/uploadpreview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). \n\n\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:** S1 pricing tier.\n
\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](/rest/api/maps/data/upload?view=rest-maps-1.0) for use in our [Azure Maps Geofencing Service](/rest/api/maps/spatial).\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n\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_DownloadPreview", "x-ms-examples": { "Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { @@ -415,7 +415,7 @@ }, "delete": { "x-publish": true, - "description": "> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data) and [v2](/rest/api/maps/data-v2)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](https://learn.microsoft.com/en-us/azure/azure-maps/how-to-create-data-registries).\n\n**Applies to:** S1 pricing tier.\n
\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/uploadpreview) 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### 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:** S1 pricing tier.\n
\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](/rest/api/maps/data/upload?view=rest-maps-1.0) for use in our [Azure Maps Geofencing Service](/rest/api/maps/spatial). You can also use this API to delete old/unused uploaded content and create space for new content.\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n\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_DeletePreview", "x-ms-examples": { "Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { @@ -464,7 +464,7 @@ "/mapData": { "get": { "x-publish": true, - "description": "> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data) and [v2](/rest/api/maps/data-v2)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](https://learn.microsoft.com/en-us/azure/azure-maps/how-to-create-data-registries).\n\n**Applies to:** S1 pricing tier.\n
\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/uploadpreview). \n\n\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://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://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://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:** S1 pricing tier.\n
\n\nThis API allows the caller to fetch a list of all content uploaded previously using the [Data Upload API](/rest/api/maps/data/upload?view=rest-maps-1.0).\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n\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://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://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://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_ListPreview", "x-ms-examples": { "List all the previously uploaded data": { diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/2.0/data.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/2.0/data.json index 425ed63d048e..cf0e61a74043 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Data/preview/2.0/data.json +++ b/specification/maps/data-plane/Microsoft.Maps/Data/preview/2.0/data.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -94,7 +94,7 @@ }, "SubscriptionKey": { "name": "subscription-key", - "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", "type": "string", "in": "query", "required": false, @@ -163,7 +163,7 @@ }, "Udid": { "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/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](/rest/api/maps/data/upload) call.", "type": "string", "in": "path", "required": true, @@ -190,7 +190,7 @@ "/mapData": { "post": { "x-publish": true, - "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## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. 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` if `dataFormat` is `JSON`\n- `application/vnd.geo+json` if `dataFormat` is `geoJSON` \n- `application/octet-stream` if `dataFormat` is `zip`\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/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](/rest/api/maps/spatial).\n\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 `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` if `dataFormat` is `JSON`\n- `application/vnd.geo+json` if `dataFormat` is `geoJSON` \n- `application/octet-stream` if `dataFormat` is `zip`\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](/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](/rest/api/maps/data/delete) to \ndelete old/unused content and create space for new uploads.", "operationId": "Data_UploadPreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -277,7 +277,7 @@ }, "get": { "x-publish": true, - "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/rest/api/maps/data-v2/upload-preview). \n\n\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 \"created\": \"2021-04-05T18:41:15+00:00\",\n \"updated\": \"2021-04-05T18:41:26+00:00\",\n \"sizeInBytes\": 29920,\n \"uploadStatus\": \"Completed\",\n \"description\": \"Sample Building\",\n \"dataFormat\": \"zip\"\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 \"created\": \"2021-06-09T12:42:17+00:00\",\n \"updated\": \"2021-06-09T12:42:19+00:00\",\n \"sizeInBytes\": 1339,\n \"uploadStatus\": \"Completed\",\n \"description\": \"Sample Lobby\",\n \"dataFormat\": \"zip\"\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 \"created\": \"2021-07-08T08:25:48+00:00\",\n \"updated\": \"2021-07-08T08:25:52+00:00\",\n \"sizeInBytes\": 1650,\n \"uploadStatus\": \"Pending\",\n \"description\": \"Sample Break Room\",\n \"dataFormat\": \"zip\"\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](/rest/api/maps/data/upload). \n\n\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 \"created\": \"2021-04-05T18:41:15+00:00\",\n \"updated\": \"2021-04-05T18:41:26+00:00\",\n \"sizeInBytes\": 29920,\n \"uploadStatus\": \"Completed\",\n \"description\": \"Sample Building\",\n \"dataFormat\": \"zip\"\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 \"created\": \"2021-06-09T12:42:17+00:00\",\n \"updated\": \"2021-06-09T12:42:19+00:00\",\n \"sizeInBytes\": 1339,\n \"uploadStatus\": \"Completed\",\n \"description\": \"Sample Lobby\",\n \"dataFormat\": \"zip\"\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 \"created\": \"2021-07-08T08:25:48+00:00\",\n \"updated\": \"2021-07-08T08:25:52+00:00\",\n \"sizeInBytes\": 1650,\n \"uploadStatus\": \"Pending\",\n \"description\": \"Sample Break Room\",\n \"dataFormat\": \"zip\"\n }]\n}\n```\n\n
", "operationId": "Data_ListPreview", "x-ms-examples": { "List all the previously uploaded data": { @@ -344,7 +344,7 @@ "/mapData/{udid}": { "put": { "x-publish": true, - "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## 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` if `dataFormat` is `JSON`\n- `application/vnd.geo+json` if `dataFormat` is `geoJSON`\n- `application/octet-stream` if `dataFormat` is `zip`\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/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](/rest/api/maps/data/upload), for \nuse in the [Azure Maps Geofencing Service](/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\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` if `dataFormat` is `JSON`\n- `application/vnd.geo+json` if `dataFormat` is `geoJSON`\n- `application/octet-stream` if `dataFormat` is `zip`\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](/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](/rest/api/maps/data/delete) to \ndelete old/unused content and create space for new uploads.", "operationId": "Data_UpdatePreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -431,7 +431,7 @@ }, "get": { "x-publish": true, - "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/rest/api/maps/data-v2/upload-preview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial). \n\n\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` if `dataFormat` is `JSON`\n - `application/vnd.geo+json` if `dataFormat` is `geoJSON`\n - `application/octet-stream` if `dataFormat` is `zip`\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](/rest/api/maps/data/upload) for use in our [Azure Maps Geofencing Service](/en-us/rest/api/maps/spatial). \n\n\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` if `dataFormat` is `JSON`\n - `application/vnd.geo+json` if `dataFormat` is `geoJSON`\n - `application/octet-stream` if `dataFormat` is `zip`\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_DownloadPreview", "x-ms-examples": { "Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { @@ -499,7 +499,7 @@ }, "delete": { "x-publish": true, - "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/rest/api/maps/data-v2/upload-preview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/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### 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](/rest/api/maps/data/upload) for use in our [Azure Maps Geofencing Service](/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### 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_DeletePreview", "x-ms-examples": { "Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/render.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/render.json index d57c9deab44b..59dfa7bee45e 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/render.json +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/render.json @@ -116,7 +116,7 @@ }, "TilesetId_rv2": { "name": "tilesetId", - "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", + "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", "type": "string", "in": "query", "required": true, diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/render.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/render.json index ba8503711fef..daf31d40541a 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/render.json +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/render.json @@ -116,7 +116,7 @@ }, "TilesetId_rv2": { "name": "tilesetId", - "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", + "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", "type": "string", "in": "query", "required": true, diff --git a/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/2.0/tileset.json b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/2.0/tileset.json index 16c83e71f3ca..11094e8b1c7c 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/2.0/tileset.json +++ b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/2.0/tileset.json @@ -226,7 +226,7 @@ "/tilesets": { "post": { "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Tileset Create API allows the caller to create a tileset from a dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/dataset/createpreview).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be \nused as the source of the tileset data.\n\nThe Create Tileset API is a \n[long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Tileset Create API allows the caller to create a tileset from a dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps-creator/dataset/create).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be \nused as the source of the tileset data.\n\nThe Create Tileset API is a \n[long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "Tileset_Create", "x-ms-examples": { "Create Tileset by providing a Dataset Id": { diff --git a/specification/maps/data-plane/Render/preview/1.0/examples/SuccessfulWorldCopyrightRequest.json b/specification/maps/data-plane/Render/preview/1.0/examples/SuccessfulWorldCopyrightRequest.json index fee7389f1757..fca338394d32 100644 --- a/specification/maps/data-plane/Render/preview/1.0/examples/SuccessfulWorldCopyrightRequest.json +++ b/specification/maps/data-plane/Render/preview/1.0/examples/SuccessfulWorldCopyrightRequest.json @@ -247,7 +247,7 @@ ], "country": { "ISO3": "MAC", - "label": "Macao" + "label": "Macao SAR" } }, { diff --git a/specification/maps/data-plane/Render/preview/1.0/render.json b/specification/maps/data-plane/Render/preview/1.0/render.json index d835cafc50c0..3624d6a1cef9 100644 --- a/specification/maps/data-plane/Render/preview/1.0/render.json +++ b/specification/maps/data-plane/Render/preview/1.0/render.json @@ -18,14 +18,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -173,8 +173,8 @@ "paths": { "/map/static/{format}": { "get": { - "summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following S0 and S1 capabilities. \n\nIn S0 you can:\n- Render up to 5 pushpins specified in the request\n- Provide one custom image for the pins referenced in the request\n- Add labels to the pushpins\n\nIn S1 you can:\n- Render pushpins through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n- Render of supported GeoJSON geometry types uploaded through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n

\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n

\n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |", - "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](https://learn.microsoft.com/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](https://learn.microsoft.com/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following S0 and S1 capabilities. \n\nIn S0 you can:\n- Render up to 5 pushpins specified in the request\n- Provide one custom image for the pins referenced in the request\n- Add labels to the pushpins\n\nIn S1 you can:\n- Render pushpins through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n- Render of supported GeoJSON geometry types uploaded through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n

\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n

\n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |", + "summary": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following S0 and S1 capabilities. \n\nIn S0 you can:\n- Render up to 5 pushpins specified in the request\n- Provide one custom image for the pins referenced in the request\n- Add labels to the pushpins\n\nIn S1 you can:\n- Render pushpins through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n- Render of supported GeoJSON geometry types uploaded through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n

\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n

\n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |", + "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following S0 and S1 capabilities. \n\nIn S0 you can:\n- Render up to 5 pushpins specified in the request\n- Provide one custom image for the pins referenced in the request\n- Add labels to the pushpins\n\nIn S1 you can:\n- Render pushpins through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n- Render of supported GeoJSON geometry types uploaded through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n

\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n

\n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |", "operationId": "Render_GetMapImage", "x-ms-client-name": "GetMapStaticImage", "x-ms-examples": { @@ -248,7 +248,7 @@ { "name": "zoom", "in": "query", - "description": "Desired zoom level of the map. Zoom value must be in the range: 0-20 (inclusive). Default value is 12.

Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "description": "Desired zoom level of the map. Zoom value must be in the range: 0-20 (inclusive). Default value is 12.

Please see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid) for details.", "type": "integer", "format": "int32", "minimum": 0, @@ -352,8 +352,8 @@ }, "/map/tile/{format}": { "get": { - "summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nFetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", - "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](https://learn.microsoft.com/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](https://learn.microsoft.com/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nFetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", + "summary": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nFetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", + "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nFetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", "operationId": "Render_GetMapTile", "x-ms-examples": { "Successful Tile Request": { @@ -484,8 +484,8 @@ }, "/map/statetile": { "get": { - "summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid))", - "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](https://learn.microsoft.com/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](https://learn.microsoft.com/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid))", + "summary": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid))", + "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid))", "operationId": "Render_GetMapStateTile", "x-ms-examples": { "Successful State Tile Request": { @@ -543,8 +543,8 @@ }, "/map/copyright/caption/{format}": { "get": { - "summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.", - "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](https://learn.microsoft.com/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](https://learn.microsoft.com/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.", + "summary": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.", + "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.", "operationId": "Render_GetCopyrightCaption", "x-ms-examples": { "Successful Copyright Caption Request": { @@ -578,7 +578,7 @@ "/map/imagery/{format}": { "get": { "summary": "**Applies to**: S0 and S1 pricing tiers.\n\nThis service returns a map image tile with size 256x256, given the x and y coordinates and zoom\nlevel. Zoom level ranges from 1 to 19. The current available style value is 'satellite' which provides satellite\nimagery alone.\n\n\n**Note**: We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", - "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](https://learn.microsoft.com/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](https://learn.microsoft.com/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis service returns a map image tile with size 256x256, given the x and y coordinates and zoom\nlevel. Zoom level ranges from 1 to 19. The current available style value is 'satellite' which provides satellite\nimagery alone.\n\n\n**Note**: We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", + "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis service returns a map image tile with size 256x256, given the x and y coordinates and zoom\nlevel. Zoom level ranges from 1 to 19. The current available style value is 'satellite' which provides satellite\nimagery alone.\n\n\n**Note**: We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", "operationId": "Render_GetMapImageryTile", "x-ms-examples": { "Successful Imagery Tile Request": { @@ -654,8 +654,8 @@ }, "/map/copyright/bounding/{format}": { "get": { - "summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", - "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](https://learn.microsoft.com/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](https://learn.microsoft.com/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", + "summary": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", + "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", "operationId": "Render_GetCopyrightFromBoundingBox", "x-ms-examples": { "Successful Bounding Box Copyright Request": { @@ -697,8 +697,8 @@ }, "/map/copyright/tile/{format}": { "get": { - "summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).", - "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](https://learn.microsoft.com/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](https://learn.microsoft.com/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).", + "summary": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).", + "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).", "operationId": "Render_GetCopyrightForTile", "x-ms-examples": { "Successful Tile Copyright Request": { @@ -743,8 +743,8 @@ }, "/map/copyright/world/{format}": { "get": { - "summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.", - "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](https://learn.microsoft.com/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](https://learn.microsoft.com/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.", + "summary": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.", + "description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.", "operationId": "Render_GetCopyrightForWorld", "x-ms-examples": { "Successful World Copyright Request": { diff --git a/specification/maps/data-plane/Render/preview/2.0/render.json b/specification/maps/data-plane/Render/preview/2.0/render.json index 619ffedd0463..559613f50a63 100644 --- a/specification/maps/data-plane/Render/preview/2.0/render.json +++ b/specification/maps/data-plane/Render/preview/2.0/render.json @@ -62,7 +62,7 @@ }, "TilesetId_rv2": { "name": "tilesetId", - "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", + "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", "type": "string", "in": "query", "required": true, diff --git a/specification/maps/data-plane/Render/stable/2022-08-01/examples/Render_GetCopyrightForWorld.json b/specification/maps/data-plane/Render/stable/2022-08-01/examples/Render_GetCopyrightForWorld.json index 4ef16af3e191..a3bb1f5f7a91 100644 --- a/specification/maps/data-plane/Render/stable/2022-08-01/examples/Render_GetCopyrightForWorld.json +++ b/specification/maps/data-plane/Render/stable/2022-08-01/examples/Render_GetCopyrightForWorld.json @@ -1840,7 +1840,7 @@ { "country": { "ISO3": "MAC", - "label": "Macao" + "label": "Macao SAR" }, "copyrights": [ "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", diff --git a/specification/maps/data-plane/Render/stable/2022-08-01/render.json b/specification/maps/data-plane/Render/stable/2022-08-01/render.json index 27591b5bab45..1dd2dfa6add3 100644 --- a/specification/maps/data-plane/Render/stable/2022-08-01/render.json +++ b/specification/maps/data-plane/Render/stable/2022-08-01/render.json @@ -144,7 +144,7 @@ }, "TilesetId": { "name": "tilesetId", - "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", + "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", "type": "string", "in": "query", "required": true, @@ -272,7 +272,7 @@ "paths": { "/map/tile": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK.", "operationId": "Render_GetMapTile", "x-ms-client-name": "GetMapTile", "x-ms-examples": { @@ -346,7 +346,7 @@ }, "/map/tileset": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Tileset API allows users to request metadata for a tileset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Tileset API allows users to request metadata for a tileset.", "operationId": "Render_GetMapTileset", "x-ms-examples": { "Successful Tileset Request": { @@ -382,7 +382,7 @@ }, "/map/attribution": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset.", "operationId": "Render_GetMapAttribution", "x-ms-examples": { "Successful Attribution Request": { @@ -439,7 +439,7 @@ }, "/map/statetile": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid))", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid))", "operationId": "Render_GetMapStateTile", "x-ms-examples": { "Successful State Tile Request": { @@ -497,7 +497,7 @@ }, "/map/copyright/caption/{format}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries/regions.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries/regions.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.", "operationId": "Render_GetCopyrightCaption", "x-ms-examples": { "Successful Copyright Caption Request": { @@ -530,7 +530,7 @@ }, "/map/static/{format}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following capabilities. \n\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n

\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n

\n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following capabilities. \n\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n

\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n

\n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |", "operationId": "Render_GetMapStaticImage", "x-ms-examples": { "Successful Static Image Request": { @@ -707,7 +707,7 @@ }, "/map/copyright/bounding/{format}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", "operationId": "Render_GetCopyrightFromBoundingBox", "x-ms-examples": { "Successful BoundingBox Copyright Request": { @@ -749,7 +749,7 @@ }, "/map/copyright/tile/{format}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).", "operationId": "Render_GetCopyrightForTile", "x-ms-examples": { "Successful Tile Copyright Request": { @@ -794,7 +794,7 @@ }, "/map/copyright/world/{format}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.", "operationId": "Render_GetCopyrightForWorld", "x-ms-examples": { "Successful World Copyright Request": { diff --git a/specification/maps/data-plane/Route/preview/1.0/route.json b/specification/maps/data-plane/Route/preview/1.0/route.json index d2b5704010c9..71bdb8fc217f 100644 --- a/specification/maps/data-plane/Route/preview/1.0/route.json +++ b/specification/maps/data-plane/Route/preview/1.0/route.json @@ -837,7 +837,7 @@ "paths": { "/route/matrix/{format}": { "post": { - "description": "\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_PostRouteMatrix", "x-ms-client-name": "RequestRouteMatrix", "x-ms-long-running-operation": true, @@ -942,7 +942,7 @@ } }, "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nIf the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nIf the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_GetRouteMatrix", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -982,7 +982,7 @@ }, "/route/matrix/sync/{format}": { "post": { - "description": "\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_PostRouteMatrixSync", "x-ms-client-name": "RequestRouteMatrixSync", "x-ms-examples": { @@ -1089,7 +1089,7 @@ }, "/route/directions/{format}": { "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nReturns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nInformation returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.\n\nRouting service provides a set of parameters for a detailed description of vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nReturns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nInformation returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.\n\nRouting service provides a set of parameters for a detailed description of vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.", "operationId": "Route_GetRouteDirections", "x-ms-examples": { "Successfully retrieve a route between an origin and a destination": { @@ -1260,7 +1260,7 @@ } }, "post": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nReturns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nInformation returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.\n\nRouting service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nReturns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nInformation returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.\n\nRouting service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.", "operationId": "Route_PostRouteDirections", "x-ms-client-name": "GetRouteDirectionsWithAdditionalParameters", "x-ms-examples": { @@ -1443,7 +1443,7 @@ }, "/route/range/{format}": { "get": { - "description": "__Route Range (Isochrone) API__\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis service will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point.\n\nThe returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone.", + "description": "__Route Range (Isochrone) API__\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis service will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point.\n\nThe returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone.", "operationId": "Route_GetRouteRange", "x-ms-examples": { "Successfully retrieve a set of locations that can be reached from the origin point based on various conditions": { @@ -1603,7 +1603,7 @@ }, "/route/directions/batch/{format}": { "post": { - "description": "**Route Directions Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n``` GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 ```\nNote:- Please remember to add AUTH information (subscription-key/azure_auth - See [Security](#security)) to the _status URI_ before running it.
\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Route Directions Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n``` GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 ```\nNote:- Please remember to add AUTH information (subscription-key/azure_auth - See [Security](#security)) to the _status URI_ before running it.
\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Route_PostRouteDirectionsBatch", "x-ms-client-name": "RequestRouteDirectionsBatch", "x-ms-long-running-operation": true, @@ -1651,7 +1651,7 @@ } }, "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Route_GetRouteDirectionsBatch", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1691,7 +1691,7 @@ }, "/route/directions/batch/sync/{format}": { "post": { - "description": "**Route Directions Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Route Directions Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Route_PostRouteDirectionsBatchSync", "x-ms-client-name": "RequestRouteDirectionsBatchSync", "x-ms-examples": { diff --git a/specification/maps/data-plane/Route/preview/2023-10-01-preview/route.json b/specification/maps/data-plane/Route/preview/2023-10-01-preview/route.json index 2d89580240b2..2295a724ee8a 100644 --- a/specification/maps/data-plane/Route/preview/2023-10-01-preview/route.json +++ b/specification/maps/data-plane/Route/preview/2023-10-01-preview/route.json @@ -20,7 +20,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 [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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> * For more information on Microsoft identity platform, see [Microsoft identity platform overview](/entra/identity-platform/v2-overview).\n\n", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -64,7 +64,7 @@ "Accept-Language": { "name": "Accept-Language", "in": "header", - "description": "Language in which routing results should be returned. \n\nRefer to [Supported Languages](https://learn.microsoft.com/en-us/azure/azure-maps/supported-languages#routing-v2-services-preview-supported-languages) for details.", + "description": "Language in which routing results should be returned. \n\nFor more information, see [Localization support in Azure Maps](https://learn.microsoft.com/en-us/azure/azure-maps/supported-languages#routing-v2-services-preview-supported-languages) for details.", "required": false, "type": "string", "x-ms-parameter-location": "client" @@ -73,7 +73,7 @@ "paths": { "/route/directions": { "post": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nRoute Directions V2 API returns the ideal route between an origin and a destination for automobile (driving), commercial trucks and walking routes, passing through a series of waypoints if they are specified. A waypoint is a specified geographical location defined by longitude and latitude that is used for navigational purposes. The route will consider factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nThe API returns the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as an optimized waypoint order or turn by turn instructions is also available, depending on the parameters used.\n\nRoute Directions takes into account local laws, vehicle dimensions, cargo type, max speed, bridge and tunnel heights to calculate the truck specific route and avoid complex maneuvers and difficult roads. Not all trucks can travel the same routes as other vehicles due to certain restrictions based on the vehicle profile or cargo type. For example, highways often have separate speed limits for trucks, some roads do not allow trucks with flammable or hazardous materials, height and weight restriction on bridges.\n\nRoute Directions supports up to 25 waypoints and up to 10 viaWaypoints between any two waypoints for driving and walking route. Each set of waypoints creates a separate route Leg. ViaWaypoints define the route path and can be used for route construction through specific locations and do not create route Legs like waypoints. Truck route supports up to 150 waypoints and does not support viaWaypoints.\n\nRouting availability in countries/regions is summarized in the [Routing coverage documentation](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2).\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\n", + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe Route Directions API returns the ideal route between an origin and destination for automobile (driving), commercial trucks and walking routes. The route passes through a series of waypoints if specified. A waypoint is a geographical location defined by longitude and latitude that is used for navigational purposes. The route considers factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nThe API returns the distance, estimated travel time, and a representation of the route geometry. More routing information such as an optimized waypoint order or turn by turn instructions is also available, depending on the parameters used.\n\nThe Route Directions considers local laws, vehicle dimensions, cargo type, max speed, bridge and tunnel heights to calculate the truck specific routes and avoid complex maneuvers and difficult roads. Not all trucks can travel the same routes as other vehicles due to certain restrictions based on the vehicle profile or cargo type. For example, highways often have separate speed limits for trucks, some roads don't allow trucks with flammable or hazardous materials, and there can be height and weight restriction on bridges.\n\nUp to 25 waypoints and 10 viaWaypoints between any two waypoints is supported for driving and walking routes. Each set of waypoints creates a separate route Leg. ViaWaypoints define the route path and can be used for route creation through specific locations, but they don't create route Legs. Truck routes support up to 150 waypoints but don't support viaWaypoints.\n\nFor information about routing availability in countries/regions, see [Azure Maps routing coverage](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2).\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\n", "operationId": "Route_PostDirections", "consumes": [ "application/geo+json" @@ -133,7 +133,7 @@ }, "/route/directions:batch": { "post": { - "description": "**Directions Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Route Directions Batch API sends batches of queries to Route Directions API using just a single API call. The API allows caller to batch up to **100** queries.\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\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions:batch?api-version=2023-10-01-preview\n```\n### POST Body for Batch Request\nTo send the _directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _directions_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"optionalId\": \"bbc9c0f6-ab52-49d8-a788-a658fa654c94\",\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.3368,\n 47.614988\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 0,\n \"pointType\": \"waypoint\"\n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.316067,\n 47.606356\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 1,\n \"pointType\": \"waypoint\"\n }\n }\n ],\n \"optimizeRoute\": \"fastestWithoutTraffic\",\n \"routeOutputOptions\": [\n \"routeSummary\"\n ],\n \"maxRouteCount\": 3,\n \"travelMode\": \"driving\"\n },\n {\n \"optionalId\": \"a191de3c-1268-4986-98f0-03f0a5d9302a\",\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.3368,\n 47.614988\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 0,\n \"pointType\": \"waypoint\"\n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.316067,\n 47.606356\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 1,\n \"pointType\": \"waypoint\"\n }\n }\n ],\n \"optimizeRoute\": \"shortest\",\n \"routeOutputOptions\": [\n \"routeSummary\"\n ],\n \"maxRouteCount\": 2,\n \"travelMode\": \"driving\"\n }\n ]\n}\n ```\n\nA _directions_ batchItem object can accept any of the supported _directions_ [Request body](https://docs.microsoft.com/en-us/rest/api/maps/route-v2/post-directions#request-body) \n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`DirectionsResponse`](https://docs.microsoft.com/en-us/rest/api/maps/route-v2/post-directions#response) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", + "description": "**Directions Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Route Directions Batch API sends batches of up to **100** queries as a single call to the [Route Directions API](https://learn.microsoft.com/en-us/rest/api/maps/route/post-directions?view=rest-maps-2023-10-01-preview).\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\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions:batch?api-version=2023-10-01-preview\n```\n### POST Body for Batch Request\nTo send the _directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _directions_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"optionalId\": \"bbc9c0f6-ab52-49d8-a788-a658fa654c94\",\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.3368,\n 47.614988\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 0,\n \"pointType\": \"waypoint\"\n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.316067,\n 47.606356\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 1,\n \"pointType\": \"waypoint\"\n }\n }\n ],\n \"optimizeRoute\": \"fastestWithoutTraffic\",\n \"routeOutputOptions\": [\n \"routeSummary\"\n ],\n \"maxRouteCount\": 3,\n \"travelMode\": \"driving\"\n },\n {\n \"optionalId\": \"a191de3c-1268-4986-98f0-03f0a5d9302a\",\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.3368,\n 47.614988\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 0,\n \"pointType\": \"waypoint\"\n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.316067,\n 47.606356\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 1,\n \"pointType\": \"waypoint\"\n }\n }\n ],\n \"optimizeRoute\": \"shortest\",\n \"routeOutputOptions\": [\n \"routeSummary\"\n ],\n \"maxRouteCount\": 2,\n \"travelMode\": \"driving\"\n }\n ]\n}\n ```\n\nA _directions_ batchItem object can accept any of the supported _directions_ [Request body](https://docs.microsoft.com/en-us/rest/api/maps/route-v2/post-directions#request-body) \n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`DirectionsResponse`](https://docs.microsoft.com/en-us/rest/api/maps/route-v2/post-directions#response) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", "operationId": "Route_PostDirectionsBatch", "consumes": [ "application/json" 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 0feb99f7ad28..df96d0c523c8 100644 --- a/specification/maps/data-plane/Search/preview/1.0/search.json +++ b/specification/maps/data-plane/Search/preview/1.0/search.json @@ -18,14 +18,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](https://learn.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://learn.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 Microsoft Entra ID 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>* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).\n\n", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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>* For more information on Microsoft identity platform, see [Microsoft identity platform overview](/entra/identity-platform/v2-overview).\n\n", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://learn.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://learn.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -221,7 +221,7 @@ "EntityType": { "name": "entityType", "in": "query", - "description": "Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via [Get Search Polygon](https://learn.microsoft.com/rest/api/maps/search/getsearchpolygon) API. The following parameters are ignored when entityType is set:\n\n* heading\n* number\n* returnRoadUse\n* returnSpeedLimit\n* roadUse\n* returnMatchType", + "description": "Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via [Get Search Polygon](/rest/api/maps/search/get-search-polygon?view=rest-maps-1.0) API. The following parameters are ignored when entityType is set:\n\n* heading\n* number\n* returnRoadUse\n* returnSpeedLimit\n* roadUse\n* returnMatchType", "type": "string", "enum": [ "Country", @@ -295,7 +295,7 @@ "name": "categorySet", "in": "query", "x-ms-client-name": "categoryFilter", - "description": "A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: \n\n* **categorySet=7315** (Search Points of Interest from category Restaurant)\n\n* **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) ", + "description": "A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. Maximum number of `categorySet` values supported per request is 10. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples:\n\n* **categorySet=7315** (Search Points of Interest from category Restaurant)\n\n* **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) ", "type": "array", "items": { "type": "integer" @@ -443,7 +443,7 @@ "paths": { "/search/polygon/{format}": { "get": { - "description": "**Get Polygon**\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Polygon service allows you to request the geometry data such as a city or country/region outline for a set of entities, previously retrieved from an Online Search request in GeoJSON format. The geometry ID is returned in the sourceGeometry object under \"geometry\" and \"id\" in either a Search Address or Search Fuzzy call.\n\nPlease note that any geometry ID retrieved from an Online Search endpoint has a limited lifetime. The client should not store geometry IDs in persistent storage for later referral, as the stability of these identifiers is not guaranteed for a long period of time. It is expected that a request to the Polygon method is made within a few minutes of the request to the Online Search method that provided the ID. The service allows for batch requests up to 20 identifiers.", + "description": "**Get Polygon**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Polygon service allows you to request the geometry data such as a city or country/region outline for a set of entities, previously retrieved from an Online Search request in GeoJSON format. The geometry ID is returned in the sourceGeometry object under \"geometry\" and \"id\" in either a Search Address or Search Fuzzy call.\n\nPlease note that any geometry ID retrieved from an Online Search endpoint has a limited lifetime. The client should not store geometry IDs in persistent storage for later referral, as the stability of these identifiers is not guaranteed for a long period of time. It is expected that a request to the Polygon method is made within a few minutes of the request to the Online Search method that provided the ID. The service allows for batch requests up to 20 identifiers.", "operationId": "Search_GetSearchPolygon", "x-ms-client-name": "ListPolygons", "x-ms-examples": { @@ -488,7 +488,7 @@ }, "/search/fuzzy/{format}": { "get": { - "description": "\n**Free Form Search**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe basic default API is Free Form Search which handles the most fuzzy of inputs handling any combination of address or POI tokens. This search API is the canonical 'single line search'. The Free Form Search API is a seamless combination of POI search and geocoding. The API can also be weighted with a contextual position (lat./lon. pair), or fully constrained by a coordinate and radius, or it can be executed more generally without any geo biasing anchor point.

We strongly advise you to use the 'countrySet' parameter to specify only the countries/regions for which your application needs coverage, as the default behavior will be to search the entire world, potentially returning unnecessary results.

E.g.: `countrySet`=US,FR

Please see [Search Coverage](https://learn.microsoft.com/azure/location-based-services/geocoding-coverage) for a complete list of all the supported countries/regions.

Most Search queries default to `maxFuzzyLevel`=2 to gain performance and also reduce unusual results. This new default can be overridden as needed per request by passing in the query param `maxFuzzyLevel`=3 or 4.", + "description": "\n**Free Form Search**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe basic default API is Free Form Search which handles the most fuzzy of inputs handling any combination of address or POI tokens. This search API is the canonical 'single line search'. The Free Form Search API is a seamless combination of POI search and geocoding. The API can also be weighted with a contextual position (lat./lon. pair), or fully constrained by a coordinate and radius, or it can be executed more generally without any geo biasing anchor point.

We strongly advise you to use the 'countrySet' parameter to specify only the countries/regions for which your application needs coverage, as the default behavior will be to search the entire world, potentially returning unnecessary results.

E.g.: `countrySet`=US,FR

Please see [Search Coverage](/azure/location-based-services/geocoding-coverage) for a complete list of all the supported countries/regions.

Most Search queries default to `maxFuzzyLevel`=2 to gain performance and also reduce unusual results. This new default can be overridden as needed per request by passing in the query param `maxFuzzyLevel`=3 or 4.", "operationId": "Search_GetSearchFuzzy", "x-ms-client-name": "FuzzySearch", "x-ms-examples": { @@ -599,7 +599,7 @@ }, "/search/poi/{format}": { "get": { - "description": "**Get POI by Name**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nPoints of Interest (POI) Search allows you to request POI results by name. Search supports additional query parameters such as language and filtering results by area of interest driven by country/region or bounding box. Endpoint will return only POI results matching the query string. Response includes POI details such as address, coordinate location and category.", + "description": "**Get POI by Name**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nPoints of Interest (POI) Search allows you to request POI results by name. Search supports additional query parameters such as language and filtering results by area of interest driven by country/region or bounding box. Endpoint will return only POI results matching the query string. Response includes POI details such as address, coordinate location and category.", "operationId": "Search_GetSearchPOI", "x-ms-client-name": "SearchPointOfInterest", "x-ms-examples": { @@ -688,7 +688,7 @@ }, "/search/nearby/{format}": { "get": { - "description": "**Nearby Search**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nIf you have a use case for only retrieving POI results around a specific location, the nearby search method may be the right choice. This endpoint will only return POI results, and does not take in a search query parameter.", + "description": "**Nearby Search**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nIf you have a use case for only retrieving POI results around a specific location, the nearby search method may be the right choice. This endpoint will only return POI results, and does not take in a search query parameter.", "operationId": "Search_GetSearchNearby", "x-ms-client-name": "SearchNearbyPointOfInterest", "x-ms-examples": { @@ -762,7 +762,7 @@ }, "/search/poi/category/{format}": { "get": { - "description": "**Get POI by Category**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nPoints of Interest (POI) Category Search allows you to request POI results from given category. Search allows to query POIs from one category at a time. Endpoint will only return POI results which are categorized as specified. Response includes POI details such as address, coordinate location and classification.", + "description": "**Get POI by Category**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nPoints of Interest (POI) Category Search allows you to request POI results from given category. Search allows to query POIs from one category at a time. Endpoint will only return POI results which are categorized as specified. Response includes POI details such as address, coordinate location and classification.", "operationId": "Search_GetSearchPOICategory", "x-ms-client-name": "SearchPointOfInterestCategory", "x-ms-examples": { @@ -783,7 +783,7 @@ { "name": "query", "in": "query", - "description": "The POI category to search for (e.g., \"AIRPORT\", \"RESTAURANT\"), must be properly URL encoded. Supported main categories can be requested by calling [Get Search POI Category Tree API](https://aka.ms/AzureMapsPOICategoryTree). List of available categories can also be found [here](https://learn.microsoft.com/azure/azure-maps/supported-search-categories). We recommend to use POI Search Category Tree API to request the supported categories.", + "description": "The POI category to search for (e.g., \"AIRPORT\", \"RESTAURANT\"), must be properly URL encoded. Supported main categories can be requested by calling [Get Search POI Category Tree API](https://aka.ms/AzureMapsPOICategoryTree). For a list of available categories, see [Azure Maps supported categories](/azure/azure-maps/supported-search-categories). We recommend to use POI Search Category Tree API to request the supported categories.", "required": true, "type": "string" }, @@ -851,7 +851,7 @@ }, "/search/poi/category/tree/{format}": { "get": { - "description": "**Get POI Category Tree**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nPOI Category API provides a full list of supported Points of Interest (POI) categories and subcategories together with their translations and synonyms. The returned content can be used to provide more meaningful results through other Search Service APIs, like [Get Search POI](https://learn.microsoft.com/rest/api/maps/search/getsearchpoi).", + "description": "**Get POI Category Tree**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nPOI Category API provides a full list of supported Points of Interest (POI) categories and subcategories together with their translations and synonyms. The returned content can be used to provide more meaningful results through other Search Service APIs, like [Get Search POI](/rest/api/maps/search/get-search-poi?view=rest-maps-1.0).", "operationId": "Search_GetSearchPOICategoryTree", "x-ms-client-name": "GetPointOfInterestCategoryTree", "x-ms-examples": { @@ -872,7 +872,7 @@ { "name": "language", "in": "query", - "description": "Language in which search results should be returned. Should be one of supported IETF language tags, except NGT and NGT-Latn. Language tag is case insensitive. When data in specified language is not available for a specific field, default language is used (English).\n\nPlease refer to [Supported Languages](https://learn.microsoft.com/azure/azure-maps/supported-languages) for details.", + "description": "Language in which search results should be returned. Should be one of supported IETF language tags, except NGT and NGT-Latn. Language tag is case insensitive. When data in specified language is not available for a specific field, default language is used (English).\n\nPlease refer to [Supported Languages](/azure/azure-maps/supported-languages) for details.", "type": "string" } ], @@ -891,7 +891,7 @@ }, "/search/address/{format}": { "get": { - "description": "**Address Geocoding**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nIn many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocode endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.", + "description": "**Address Geocoding**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nIn many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocode endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.", "operationId": "Search_GetSearchAddress", "x-ms-client-name": "SearchAddress", "x-ms-examples": { @@ -971,7 +971,7 @@ }, "/search/address/reverse/{format}": { "get": { - "description": "**Reverse Geocode to an Address**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThere may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.", + "description": "**Reverse Geocode to an Address**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThere may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.", "operationId": "Search_GetSearchAddressReverse", "x-ms-client-name": "ReverseSearchAddress", "x-ms-examples": { @@ -1082,7 +1082,7 @@ }, "/search/address/reverse/crossStreet/{format}": { "get": { - "description": "**Reverse Geocode to a Cross Street**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThere may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable cross street. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located.\nThis endpoint will return cross street information for a given coordinate.", + "description": "**Reverse Geocode to a Cross Street**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThere may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable cross street. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located.\nThis endpoint will return cross street information for a given coordinate.", "operationId": "Search_GetSearchAddressReverseCrossStreet", "x-ms-client-name": "ReverseSearchCrossStreetAddress", "x-ms-examples": { @@ -1139,7 +1139,7 @@ }, "/search/address/structured/{format}": { "get": { - "description": "**Structured Address Geocoding**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nAzure Address Geocoding can also be accessed for structured address look up exclusively. The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.", + "description": "**Structured Address Geocoding**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nAzure Address Geocoding can also be accessed for structured address look up exclusively. The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.", "operationId": "Search_GetSearchAddressStructured", "x-ms-client-name": "SearchStructuredAddress", "x-ms-examples": { @@ -1253,7 +1253,7 @@ }, "/search/geometry/{format}": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Geometry endpoint allows you to perform a free form search inside a single geometry or many of them. The search results that fall inside the geometry/geometries will be returned.

To send the geometry you will use a `POST` request where the request body will contain the `geometry` object represented as a `GeoJSON` type and the `Content-Type` header will be set to `application/json`. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following `GeoJSON` types:
  • **GeoJSON FeatureCollection**
    The `geometry` can be represented as a `GeoJSON FeatureCollection` object. This is the recommended option if the geometry contains both Polygons and Circles. The `FeatureCollection` can contain a max of 50 `GeoJSON Feature` objects. Each `Feature` object should represent either a Polygon or a Circle with the following conditions:
    • A `Feature` object for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.
    • A `Feature` object for the Circle geometry is composed of a _center_ represented using a `GeoJSON Point` type and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.

    Please see the Examples section below for a sample `FeatureCollection` representation.

  • **GeoJSON GeometryCollection**
    The `geometry` can be represented as a `GeoJSON GeometryCollection` object. This is the recommended option if the geometry contains a list of Polygons only. The `GeometryCollection` can contain a max of 50 `GeoJSON Polygon` objects. Each `Polygon` object can have a max of 50 coordinates. Please see the Examples section below for a sample `GeometryCollection` representation.

  • **GeoJSON Polygon**
    The `geometry` can be represented as a `GeoJSON Polygon` object. This is the recommended option if the geometry contains a single Polygon. The `Polygon` object can have a max of 50 coordinates. Please see the Examples section below for a sample `Polygon` representation.

.

", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Geometry endpoint allows you to perform a free form search inside a single geometry or many of them. The search results that fall inside the geometry/geometries will be returned.

To send the geometry you will use a `POST` request where the request body will contain the `geometry` object represented as a `GeoJSON` type and the `Content-Type` header will be set to `application/json`. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following `GeoJSON` types:
  • **GeoJSON FeatureCollection**
    The `geometry` can be represented as a `GeoJSON FeatureCollection` object. This is the recommended option if the geometry contains both Polygons and Circles. The `FeatureCollection` can contain a max of 50 `GeoJSON Feature` objects. Each `Feature` object should represent either a Polygon or a Circle with the following conditions:
    • A `Feature` object for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.
    • A `Feature` object for the Circle geometry is composed of a _center_ represented using a `GeoJSON Point` type and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.

    Please see the Examples section below for a sample `FeatureCollection` representation.

  • **GeoJSON GeometryCollection**
    The `geometry` can be represented as a `GeoJSON GeometryCollection` object. This is the recommended option if the geometry contains a list of Polygons only. The `GeometryCollection` can contain a max of 50 `GeoJSON Polygon` objects. Each `Polygon` object can have a max of 50 coordinates. Please see the Examples section below for a sample `GeometryCollection` representation.

  • **GeoJSON Polygon**
    The `geometry` can be represented as a `GeoJSON Polygon` object. This is the recommended option if the geometry contains a single Polygon. The `Polygon` object can have a max of 50 coordinates. Please see the Examples section below for a sample `Polygon` representation.

.

", "operationId": "Search_PostSearchInsideGeometry", "x-ms-client-name": "SearchInsideGeometry", "x-ms-examples": { @@ -1327,7 +1327,7 @@ }, "/search/alongRoute/{format}": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Along Route endpoint allows you to perform a fuzzy search for POIs along a specified route. This search is constrained by specifying the `maxDetourTime` limiting measure.

To send the route-points you will use a `POST` request where the request body will contain the `route` object represented as a `GeoJSON LineString` type and the `Content-Type` header will be set to `application/json`. Each route-point in `route` is represented as a `GeoJSON Position` type i.e. an array where the _longitude_ value is followed by the _latitude_ value and the _altitude_ value is ignored. The `route` should contain at least 2 route-points.

It is possible that original route will be altered, some of it's points may be skipped. If the route that passes through the found point is faster than the original one, the `detourTime` value in the response is negative.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Along Route endpoint allows you to perform a fuzzy search for POIs along a specified route. This search is constrained by specifying the `maxDetourTime` limiting measure.

To send the route-points you will use a `POST` request where the request body will contain the `route` object represented as a `GeoJSON LineString` type and the `Content-Type` header will be set to `application/json`. Each route-point in `route` is represented as a `GeoJSON Position` type i.e. an array where the _longitude_ value is followed by the _latitude_ value and the _altitude_ value is ignored. The `route` should contain at least 2 route-points.

It is possible that original route will be altered, some of it's points may be skipped. If the route that passes through the found point is faster than the original one, the `detourTime` value in the response is negative.", "operationId": "Search_PostSearchAlongRoute", "x-ms-client-name": "SearchAlongRoute", "x-ms-examples": { @@ -1405,7 +1405,7 @@ }, "/search/fuzzy/batch/sync/{format}": { "post": { - "description": "**Search Fuzzy Batch API**\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Fuzzy Batch API sends batches of queries to [Search Fuzzy API](https://learn.microsoft.com/rest/api/maps/search/getsearchfuzzy) using just a single API call. You can call Search Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Fuzzy Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n {\"query\": \"?query=Space Needle\"},\n {\"query\": \"?query=pizza&limit=10\"}\n ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](https://learn.microsoft.com/rest/api/maps/search/getsearchfuzzy#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResponse`](https://learn.microsoft.com/rest/api/maps/search/getsearchfuzzy#SearchAddressResponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"atm\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"ATM at Wells Fargo\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"statue of liberty\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"Statue of Liberty\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"New York, NY 10004\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Search Fuzzy Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Fuzzy Batch API sends batches of queries to [Search Fuzzy API](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0) using just a single API call. You can call Search Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Fuzzy Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n {\"query\": \"?query=Space Needle\"},\n {\"query\": \"?query=pizza&limit=10\"}\n ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResult`](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#SearchAddressResult) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"atm\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"ATM at Wells Fargo\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"statue of liberty\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"Statue of Liberty\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"New York, NY 10004\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Search_PostSearchFuzzyBatchSync", "x-ms-client-name": "FuzzySearchBatchSync", "x-ms-examples": { @@ -1456,7 +1456,7 @@ }, "/search/fuzzy/batch/{format}": { "post": { - "description": "**Search Fuzzy Batch API**\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Fuzzy Batch API sends batches of queries to [Search Fuzzy API](https://learn.microsoft.com/rest/api/maps/search/getsearchfuzzy) using just a single API call. You can call Search Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Fuzzy Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n {\"query\": \"?query=Space Needle\"},\n {\"query\": \"?query=pizza&limit=10\"}\n ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](https://learn.microsoft.com/rest/api/maps/search/getsearchfuzzy#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchFuzzyResponse`](https://learn.microsoft.com/rest/api/maps/search/get-search-fuzzy?tabs=HTTP#searchaddressresult) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"atm\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"ATM at Wells Fargo\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"statue of liberty\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"Statue of Liberty\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"New York, NY 10004\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Search Fuzzy Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Fuzzy Batch API sends batches of queries to [Search Fuzzy API](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0) using just a single API call. You can call Search Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Fuzzy Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n {\"query\": \"?query=Space Needle\"},\n {\"query\": \"?query=pizza&limit=10\"}\n ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResult`](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#searchaddressresult) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"atm\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"ATM at Wells Fargo\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"statue of liberty\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"Statue of Liberty\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"New York, NY 10004\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Search_PostSearchFuzzyBatch", "x-ms-client-name": "FuzzySearchBatch", "x-ms-long-running-operation": true, @@ -1505,7 +1505,7 @@ } }, "get": { - "description": "**Search Fuzzy Batch API**\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Fuzzy Batch API sends batches of queries to [Search Fuzzy API](https://learn.microsoft.com/rest/api/maps/search/getsearchfuzzy) using just a single API call. You can call Search Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Fuzzy Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n {\"query\": \"?query=Space Needle\"},\n {\"query\": \"?query=pizza&limit=10\"}\n ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](https://learn.microsoft.com/rest/api/maps/search/getsearchfuzzy#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResult`](https://learn.microsoft.com/rest/api/maps/search/get-search-fuzzy?tabs=HTTP#searchaddressresult) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"atm\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"ATM at Wells Fargo\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"statue of liberty\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"Statue of Liberty\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"New York, NY 10004\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Search Fuzzy Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Fuzzy Batch API sends batches of queries to [Search Fuzzy API](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0) using just a single API call. You can call Search Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Fuzzy Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n {\"query\": \"?query=Space Needle\"},\n {\"query\": \"?query=pizza&limit=10\"}\n ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResult`](/rest/api/maps/search/get-search-fuzzy?view=rest-maps-1.0#searchaddressresult) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"atm\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"ATM at Wells Fargo\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"statue of liberty\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"Statue of Liberty\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"New York, NY 10004\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Search_GetSearchFuzzyBatch", "x-ms-client-name": "GetFuzzySearchBatch", "x-ms-long-running-operation": true, @@ -1546,7 +1546,7 @@ }, "/search/address/batch/sync/{format}": { "post": { - "description": "**Search Address Batch API**\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Address Batch API sends batches of queries to [Search Address API](https://learn.microsoft.com/rest/api/maps/search/getsearchaddress) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](https://learn.microsoft.com/rest/api/maps/search/getsearchaddress#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResponse`](https://learn.microsoft.com/rest/api/maps/search/getsearchaddress#SearchAddressResponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"one microsoft way redmond wa 98052\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.63989,\n \"lon\": -122.12509\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"pike pl seattle wa 98101\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.60963,\n \"lon\": -122.34215\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Search Address Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Address Batch API sends batches of queries to [Search Address API](/rest/api/maps/search/get-search-address?view=rest-maps-1.0) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](/rest/api/maps/search/get-search-address?view=rest-maps-1.0#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResult`](/rest/api/maps/search/get-search-address?view=rest-maps-1.0#SearchAddressResult) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"one microsoft way redmond wa 98052\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.63989,\n \"lon\": -122.12509\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"pike pl seattle wa 98101\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.60963,\n \"lon\": -122.34215\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Search_PostSearchAddressBatchSync", "x-ms-client-name": "SearchAddressBatchSync", "x-ms-examples": { @@ -1597,7 +1597,7 @@ }, "/search/address/batch/{format}": { "post": { - "description": "**Search Address Batch API**\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Address Batch API sends batches of queries to [Search Address API](https://learn.microsoft.com/rest/api/maps/search/getsearchaddress) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](https://learn.microsoft.com/rest/api/maps/search/getsearchaddress#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResponse`](https://learn.microsoft.com/rest/api/maps/search/getsearchaddress#SearchAddressResponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"one microsoft way redmond wa 98052\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.63989,\n \"lon\": -122.12509\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"pike pl seattle wa 98101\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.60963,\n \"lon\": -122.34215\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Search Address Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Address Batch API sends batches of queries to [Search Address API](/rest/api/maps/search/get-search-address?view=rest-maps-1.0) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](/rest/api/maps/search/get-search-address?view=rest-maps-1.0#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResult`](/rest/api/maps/search/get-search-address?view=rest-maps-1.0#SearchAddressResult) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"one microsoft way redmond wa 98052\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.63989,\n \"lon\": -122.12509\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"pike pl seattle wa 98101\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.60963,\n \"lon\": -122.34215\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Search_PostSearchAddressBatch", "x-ms-client-name": "SearchAddressBatch", "x-ms-long-running-operation": true, @@ -1646,7 +1646,7 @@ } }, "get": { - "description": "**Search Address Batch API**\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Address Batch API sends batches of queries to [Search Address API](https://learn.microsoft.com/rest/api/maps/search/getsearchaddress) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](https://learn.microsoft.com/rest/api/maps/search/getsearchaddress#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResponse`](https://learn.microsoft.com/rest/api/maps/search/getsearchaddress#SearchAddressResponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"one microsoft way redmond wa 98052\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.63989,\n \"lon\": -122.12509\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"pike pl seattle wa 98101\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.60963,\n \"lon\": -122.34215\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Search Address Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Address Batch API sends batches of queries to [Search Address API](/rest/api/maps/search/get-search-address?view=rest-maps-1.0) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](/rest/api/maps/search/get-search-address?view=rest-maps-1.0#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResult`](/rest/api/maps/search/get-search-address?view=rest-maps-1.0#SearchAddressResult) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"one microsoft way redmond wa 98052\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.63989,\n \"lon\": -122.12509\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"pike pl seattle wa 98101\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.60963,\n \"lon\": -122.34215\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Search_GetSearchAddressBatch", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1686,7 +1686,7 @@ }, "/search/address/reverse/batch/sync/{format}": { "post": { - "description": "**Search Address Reverse Batch API**\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Address Reverse Batch API sends batches of queries to [Search Address Reverse API](https://learn.microsoft.com/rest/api/maps/search/getsearchaddressreverse) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Reverse Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=48.858561,2.294911\"},\n {\"query\": \"?query=47.639765,-122.127896&radius=5000&limit=2\"},\n {\"query\": \"?query=47.621028,-122.348170\"},\n {\"query\": \"?query=43.722990,10.396695\"},\n {\"query\": \"?query=40.750958,-73.982336\"}\n ]\n}\n```\n\nA _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](https://learn.microsoft.com/rest/api/maps/search/getsearchaddressreverse#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressReverseResponse`](https://learn.microsoft.com/rest/api/maps/search/getsearchaddressreverse#searchaddressreverseresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 11\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"France\",\n \"freeformAddress\": \"Avenue Anatole France, 75007 Paris\"\n },\n \"position\": \"48.858490,2.294820\"\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 1\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"United States of America\",\n \"freeformAddress\": \"157th Pl NE, Redmond WA 98052\"\n },\n \"position\": \"47.640470,-122.129430\"\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Search Address Reverse Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Address Reverse Batch API sends batches of queries to [Search Address Reverse API](/rest/api/maps/search/get-search-address-reverse?view=rest-maps-1.0) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Reverse Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=48.858561,2.294911\"},\n {\"query\": \"?query=47.639765,-122.127896&radius=5000&limit=2\"},\n {\"query\": \"?query=47.621028,-122.348170\"},\n {\"query\": \"?query=43.722990,10.396695\"},\n {\"query\": \"?query=40.750958,-73.982336\"}\n ]\n}\n```\n\nA _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](/rest/api/maps/search/get-search-address-reverse?view=rest-maps-1.0#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressReverseResponse`](/rest/api/maps/search/get-search-address-reverse?view=rest-maps-1.0#searchaddressreverseresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 11\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"France\",\n \"freeformAddress\": \"Avenue Anatole France, 75007 Paris\"\n },\n \"position\": \"48.858490,2.294820\"\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 1\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"United States of America\",\n \"freeformAddress\": \"157th Pl NE, Redmond WA 98052\"\n },\n \"position\": \"47.640470,-122.129430\"\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Search_PostSearchAddressReverseBatchSync", "x-ms-client-name": "ReverseSearchAddressBatchSync", "x-ms-examples": { @@ -1737,7 +1737,7 @@ }, "/search/address/reverse/batch/{format}": { "post": { - "description": "**Search Address Reverse Batch API**\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Address Reverse Batch API sends batches of queries to [Search Address Reverse API](https://learn.microsoft.com/rest/api/maps/search/getsearchaddressreverse) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Reverse Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=48.858561,2.294911\"},\n {\"query\": \"?query=47.639765,-122.127896&radius=5000&limit=2\"},\n {\"query\": \"?query=47.621028,-122.348170\"},\n {\"query\": \"?query=43.722990,10.396695\"},\n {\"query\": \"?query=40.750958,-73.982336\"}\n ]\n}\n```\n\nA _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](https://learn.microsoft.com/rest/api/maps/search/getsearchaddressreverse#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressReverseResponse`](https://learn.microsoft.com/rest/api/maps/search/getsearchaddressreverse#searchaddressreverseresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 11\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"France\",\n \"freeformAddress\": \"Avenue Anatole France, 75007 Paris\"\n },\n \"position\": \"48.858490,2.294820\"\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 1\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"United States of America\",\n \"freeformAddress\": \"157th Pl NE, Redmond WA 98052\"\n },\n \"position\": \"47.640470,-122.129430\"\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Search Address Reverse Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Address Reverse Batch API sends batches of queries to [Search Address Reverse API](/rest/api/maps/search/get-search-address-reverse?view=rest-maps-1.0) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Reverse Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=48.858561,2.294911\"},\n {\"query\": \"?query=47.639765,-122.127896&radius=5000&limit=2\"},\n {\"query\": \"?query=47.621028,-122.348170\"},\n {\"query\": \"?query=43.722990,10.396695\"},\n {\"query\": \"?query=40.750958,-73.982336\"}\n ]\n}\n```\n\nA _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](/rest/api/maps/search/get-search-address-reverse?view=rest-maps-1.0#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressReverseResponse`](/rest/api/maps/search/get-search-address-reverse?view=rest-maps-1.0#searchaddressreverseresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 11\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"France\",\n \"freeformAddress\": \"Avenue Anatole France, 75007 Paris\"\n },\n \"position\": \"48.858490,2.294820\"\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 1\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"United States of America\",\n \"freeformAddress\": \"157th Pl NE, Redmond WA 98052\"\n },\n \"position\": \"47.640470,-122.129430\"\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Search_PostSearchAddressReverseBatch", "x-ms-client-name": "ReverseSearchAddressBatch", "x-ms-long-running-operation": true, @@ -1786,7 +1786,7 @@ } }, "get": { - "description": "**Search Address Reverse Batch API**\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Address Reverse Batch API sends batches of queries to [Search Address Reverse API](https://learn.microsoft.com/rest/api/maps/search/getsearchaddressreverse) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Reverse Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=48.858561,2.294911\"},\n {\"query\": \"?query=47.639765,-122.127896&radius=5000&limit=2\"},\n {\"query\": \"?query=47.621028,-122.348170\"},\n {\"query\": \"?query=43.722990,10.396695\"},\n {\"query\": \"?query=40.750958,-73.982336\"}\n ]\n}\n```\n\nA _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](https://learn.microsoft.com/rest/api/maps/search/getsearchaddressreverse#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressReverseResponse`](https://learn.microsoft.com/rest/api/maps/search/getsearchaddressreverse#searchaddressreverseresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 11\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"France\",\n \"freeformAddress\": \"Avenue Anatole France, 75007 Paris\"\n },\n \"position\": \"48.858490,2.294820\"\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 1\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"United States of America\",\n \"freeformAddress\": \"157th Pl NE, Redmond WA 98052\"\n },\n \"position\": \"47.640470,-122.129430\"\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Search Address Reverse Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Search Address Reverse Batch API sends batches of queries to [Search Address Reverse API](/rest/api/maps/search/get-search-address-reverse?view=rest-maps-1.0) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Search Address Reverse Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=48.858561,2.294911\"},\n {\"query\": \"?query=47.639765,-122.127896&radius=5000&limit=2\"},\n {\"query\": \"?query=47.621028,-122.348170\"},\n {\"query\": \"?query=43.722990,10.396695\"},\n {\"query\": \"?query=40.750958,-73.982336\"}\n ]\n}\n```\n\nA _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](/rest/api/maps/search/get-search-address-reverse?view=rest-maps-1.0#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressReverseResponse`](/rest/api/maps/search/get-search-address-reverse?view=rest-maps-1.0#searchaddressreverseresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 11\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"France\",\n \"freeformAddress\": \"Avenue Anatole France, 75007 Paris\"\n },\n \"position\": \"48.858490,2.294820\"\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 1\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"United States of America\",\n \"freeformAddress\": \"157th Pl NE, Redmond WA 98052\"\n },\n \"position\": \"47.640470,-122.129430\"\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Search_GetSearchAddressReverseBatch", "x-ms-client-name": "GetReverseSearchAddressBatch", "x-ms-long-running-operation": true, @@ -2019,7 +2019,7 @@ "$ref": "#/definitions/AddressRanges" }, "dataSources": { - "description": "Optional section. Reference geometry id for use with the [Get Search Polygon](https://learn.microsoft.com/rest/api/maps/search/getsearchpolygon) API.", + "description": "Optional section. Reference geometry id for use with the [Get Search Polygon](/rest/api/maps/search/get-search-polygon?view=rest-maps-1.0) API.", "type": "object", "readOnly": true, "$ref": "#/definitions/DataSources" @@ -2055,7 +2055,7 @@ "type": "object", "properties": { "id": { - "description": "Unique ID for the category. ID can be used to restrict search results to specific categories through other Search Service APIs, like [Get Search POI](https://learn.microsoft.com/rest/api/maps/search/getsearchpoi).", + "description": "Unique ID for the category. ID can be used to restrict search results to specific categories through other Search Service APIs, like [Get Search POI](/rest/api/maps/search/get-search-poi?view=rest-maps-1.0).", "type": "integer", "readOnly": true }, @@ -2394,7 +2394,7 @@ "readOnly": true }, "municipality": { - "description": "City / Town", + "description": "City / Town
Note: `municipality` represents the residential municipality. Depending on the location, the `municipality` value may differ from the commonly known name of a city or town. For the commonly known name of the city or town, it’s suggested that the `localName` value be used instead of the `municipality` value.", "type": "string", "readOnly": true }, @@ -2454,7 +2454,7 @@ "readOnly": true }, "localName": { - "description": "An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property.", + "description": "An address component that represents the name of a geographic area or locality that groups multiple addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. `localName` represents the postal municipality. Depending on the location, `localName` is the commonly known name of a city or town. For the commonly known name of a city or town, use `localName` instead of `municipality`.", "type": "string", "readOnly": true }, @@ -2661,7 +2661,7 @@ }, "DataSources": { "x-ms-client-name": "DataSource", - "description": "Optional section. Reference ids for use with the [Get Search Polygon](https://learn.microsoft.com/rest/api/maps/search/getsearchpolygon) API.", + "description": "Optional section. Reference ids for use with the [Get Search Polygon](/rest/api/maps/search/get-search-polygon?view=rest-maps-1.0) API.", "type": "object", "readOnly": true, "properties": { @@ -2676,7 +2676,7 @@ "type": "object", "properties": { "id": { - "description": "Pass this as geometryId to the [Get Search Polygon](https://learn.microsoft.com/rest/api/maps/search/getsearchpolygon) API to fetch geometry information for this result.", + "description": "Pass this as geometryId to the [Get Search Polygon](/rest/api/maps/search/get-search-polygon?view=rest-maps-1.0) API to fetch geometry information for this result.", "type": "string", "readOnly": true } @@ -2712,7 +2712,7 @@ ], "properties": { "response": { - "description": "The result of the query. SearchAddressResponse if the query completed successfully, ErrorResponse otherwise.", + "description": "The result of the query. SearchAddressResult if the query completed successfully, ErrorResponse otherwise.", "type": "object", "readOnly": true, "allOf": [ diff --git a/specification/maps/data-plane/Search/stable/2023-06-01/search.json b/specification/maps/data-plane/Search/stable/2023-06-01/search.json index ba17953b3841..a33ddec5b298 100644 --- a/specification/maps/data-plane/Search/stable/2023-06-01/search.json +++ b/specification/maps/data-plane/Search/stable/2023-06-01/search.json @@ -18,7 +18,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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 Microsoft Entra ID 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> * For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).\n\n", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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> * For more information on Microsoft identity platform, see [Microsoft identity platform overview](/entra/identity-platform/v2-overview).\n\n", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -74,7 +74,7 @@ "Accept-Language": { "name": "Accept-Language", "in": "header", - "description": "Language in which search results should be returned. \n\nPlease refer to [Supported Languages](https://learn.microsoft.com/azure/azure-maps/supported-languages) for details.", + "description": "Language in which search results should be returned. \n\nPlease refer to [Supported Languages](/azure/azure-maps/supported-languages) for details.", "required": false, "type": "string", "x-ms-parameter-location": "client" @@ -287,7 +287,7 @@ "paths": { "/geocode": { "get": { - "description": "**Geocoding**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nIn many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocoding endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No Point of Interest (POIs) will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.", + "description": "**Geocoding**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nIn many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocoding endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No Point of Interest (POIs) will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.", "operationId": "Search_GetGeocoding", "produces": [ "application/geo+json" @@ -406,7 +406,7 @@ }, "/geocode:batch": { "post": { - "description": "**Geocoding Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Geocoding Batch API sends batches of queries to [Geocoding API](https://docs.microsoft.com/rest/api/maps/search-v2/get-geocoding) using just a single API call. The API allows caller to batch up to **100** queries.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01\n```\n### POST Body for Batch Request\nTo send the _geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"addressLine\": \"One, Microsoft Way, Redmond, WA 98052\",\n \"top\": 2\n },\n {\n \"addressLine\": \"Pike Pl\",\n \"adminDistrict\": \"WA\",\n \"locality\": \"Seattle\",\n \"top\": 3\n }\n ]\n}\n```\n\nA _geocoding_ batchItem object can accept any of the supported _geocoding_ [URI parameters](https://docs.microsoft.com/rest/api/maps/search-v2/get-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`GeocodingResponse`](https://docs.microsoft.com/rest/api/maps/search-v2/get-geocoding#geocodingresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", + "description": "**Geocoding Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Geocoding Batch API sends batches of queries to [Geocoding API](/rest/api/maps/search/get-geocoding) using just a single API call. The API allows caller to batch up to **100** queries.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01\n```\n### POST Body for Batch Request\nTo send the _geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"addressLine\": \"One, Microsoft Way, Redmond, WA 98052\",\n \"top\": 2\n },\n {\n \"addressLine\": \"Pike Pl\",\n \"adminDistrict\": \"WA\",\n \"locality\": \"Seattle\",\n \"top\": 3\n }\n ]\n}\n```\n\nA _geocoding_ batchItem object can accept any of the supported _geocoding_ [URI parameters](/rest/api/maps/search/get-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`GeocodingResponse`](/rest/api/maps/search/get-geocoding#geocodingresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", "operationId": "Search_GetGeocodingBatch", "x-ms-examples": { "A Geocoding Batch API call containing 2 Geocoding queries": { @@ -448,7 +448,7 @@ }, "/search/polygon": { "get": { - "description": "**Get Polygon**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nSupplies polygon data of a geographical area outline such as a city or a country region.", + "description": "**Get Polygon**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nSupplies polygon data of a geographical area outline such as a city or a country region.", "operationId": "Search_GetPolygon", "produces": [ "application/geo+json" @@ -508,7 +508,7 @@ }, "/reverseGeocode": { "get": { - "description": "**Reverse Geocoding**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nTranslate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.", + "description": "**Reverse Geocoding**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nTranslate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.", "operationId": "Search_GetReverseGeocoding", "produces": [ "application/geo+json" @@ -565,7 +565,7 @@ }, "/reverseGeocode:batch": { "post": { - "description": "**Reverse Geocoding Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Reverse Geocoding Batch API sends batches of queries to [Reverse Geocoding API](https://docs.microsoft.com/rest/api/maps/search-v2/get-reverse-geocoding) using just a single API call. The API allows caller to batch up to **100** queries.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01\n```\n### POST Body for Batch Request\nTo send the _reverse geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _reverse geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"coordinates\": [-122.128275, 47.639429],\n \"resultTypes\": [\"Address\", \"PopulatedPlace\"]\n },\n {\n \"coordinates\": [-122.341979399674, 47.6095253501216]\n }\n ]\n}\n```\n\nA _reverse geocoding_ batchItem object can accept any of the supported _reverse geocoding_ [URI parameters](https://docs.microsoft.com/rest/api/maps/search-v2/get-reverse-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`GeocodingResponse`](https://docs.microsoft.com/rest/api/maps/search-v2/get-reverse-geocoding#geocodingresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", + "description": "**Reverse Geocoding Batch API**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Reverse Geocoding Batch API sends batches of queries to [Reverse Geocoding API](/rest/api/maps/search/get-reverse-geocoding) using just a single API call. The API allows caller to batch up to **100** queries.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01\n```\n### POST Body for Batch Request\nTo send the _reverse geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _reverse geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"coordinates\": [-122.128275, 47.639429],\n \"resultTypes\": [\"Address\", \"PopulatedPlace\"]\n },\n {\n \"coordinates\": [-122.341979399674, 47.6095253501216]\n }\n ]\n}\n```\n\nA _reverse geocoding_ batchItem object can accept any of the supported _reverse geocoding_ [URI parameters](/rest/api/maps/search/get-reverse-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`GeocodingResponse`](/rest/api/maps/search/get-reverse-geocoding#geocodingresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", "operationId": "Search_GetReverseGeocodingBatch", "x-ms-examples": { "A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries": { diff --git a/specification/maps/data-plane/Spatial/stable/2022-08-01/spatial.json b/specification/maps/data-plane/Spatial/stable/2022-08-01/spatial.json index 140ed039cb83..16eecb962a6b 100644 --- a/specification/maps/data-plane/Spatial/stable/2022-08-01/spatial.json +++ b/specification/maps/data-plane/Spatial/stable/2022-08-01/spatial.json @@ -25,7 +25,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Microsoft Entra OAuth 2.0](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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -94,7 +94,7 @@ "SpatialUploadUdid": { "name": "udid", "in": "query", - "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "description": "The unique id used when creating a [Data registry](/rest/api/maps/data-registry/register-or-replace) to upload a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "required": true, "type": "string", "x-ms-parameter-location": "method" @@ -180,7 +180,7 @@ "paths": { "/spatial/geofence/{format}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Geofence Get API allows you to retrieve the proximity of a coordinate to a \ngeofence that has been uploaded to the Data service. You can use the \n[Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) to upload \na geofence or set of fences. See [Geofencing GeoJSON data](https://docs.microsoft.com/azure/azure-maps/geofence-geojson) \nfor more details on the geofence data format. To query the proximity of a coordinate, you supply the location of the object you are tracking as well\nas the ID for the fence or set of fences, and the response will contain information about\nthe distance from the outer edge of the geofence. A negative value signifies that the \ncoordinate is inside of the fence while a positive value means that it is outside of the\nfence.

This API can be used for a variety of scenarios that include things like asset \ntracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).\nTo test this API, you can upload the sample data from Post Geofence API examples (Request Body) via Data Upload API and replace the `{udid}` from the sample request below with the udid returned by Data Upload API.\n\n\n### Geofencing InnerError code\n\nIn geofencing response error contract, `innererror` is an object containing service specific information about the error. `code` is a property in `innererror` which can map to a specific geofencing error type. The table belows shows the code mapping between all the known client error type to the corresponding geofencing error `message`.\n\ninnererror.code | error.message\n---------------------------- | -------------------------------------- \nNullDeviceId | Device Id should not be null.\nNullUdid\t | Udid should not be null.\nUdidWrongFormat| Udid should be acquired from user data ingestion API.\nInvalidUserTime| Usertime is invalid.\nInvalidSearchBuffer| Searchbuffer is invalid.\nInvalidSearchRange| The value range of searchbuffer should be from 0 to 500 meters.\nInvalidLatLon| Lat and/or lon parameters are invalid.\nInvalidIsAsyncValue| The IsAsync parameter is invalid.\nInvalidModeValue| The mode parameter invalid.\nInvalidJson| Geofencing data is not a valid json file.\nNotSupportedGeoJson| Geofencing data can't be read as a Feature or FeatureCollections.\nInvalidGeoJson| Geofencing data is invalid.\nNoUserDataWithAccountOrSubscription| Can't find user geofencing data with provided account-id and/or subscription-id.\nNoUserDataWithUdid|\tCan't find user geofencing data with provided udid.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Geofence Get API allows you to retrieve the proximity of a coordinate to a \ngeofence that has been uploaded to the Data registry. You can use the \n[Data registry](/rest/api/maps/data-registry/register-or-replace) service to upload \na geofence or set of fences. See [Geofencing GeoJSON data](/azure/azure-maps/geofence-geojson) \nfor more details on the geofence data format. To query the proximity of a coordinate, you supply the location of the object you are tracking as well\nas the ID for the fence or set of fences, and the response will contain information about\nthe distance from the outer edge of the geofence. A negative value signifies that the \ncoordinate is inside of the fence while a positive value means that it is outside of the\nfence.

This API can be used for a variety of scenarios that include things like asset \ntracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).\nTo test this API, you can upload the sample data from Post Geofence API examples (Request Body) using the Data registry service and replace the `{udid}` from the sample request below with the `udid` used to create the Data registry. For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n\n### Geofencing InnerError code\n\nIn geofencing response error contract, `innererror` is an object containing service specific information about the error. `code` is a property in `innererror` which can map to a specific geofencing error type. The table belows shows the code mapping between all the known client error type to the corresponding geofencing error `message`.\n\ninnererror.code | error.message\n---------------------------- | -------------------------------------- \nNullDeviceId | Device Id should not be null.\nNullUdid\t | Udid should not be null.\nUdidWrongFormat| Udid should be acquired from user data ingestion API.\nInvalidUserTime| Usertime is invalid.\nInvalidSearchBuffer| Searchbuffer is invalid.\nInvalidSearchRange| The value range of searchbuffer should be from 0 to 500 meters.\nInvalidLatLon| Lat and/or lon parameters are invalid.\nInvalidIsAsyncValue| The IsAsync parameter is invalid.\nInvalidModeValue| The mode parameter invalid.\nInvalidJson| Geofencing data is not a valid json file.\nNotSupportedGeoJson| Geofencing data can't be read as a Feature or FeatureCollections.\nInvalidGeoJson| Geofencing data is invalid.\nNoUserDataWithAccountOrSubscription| Can't find user geofencing data with provided account-id and/or subscription-id.\nNoUserDataWithUdid|\tCan't find user geofencing data with provided udid.", "operationId": "Spatial_GetGeofence", "x-ms-examples": { "GetGeofence": { @@ -265,7 +265,7 @@ } }, "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Geofence Post API allows you to retrieve the proximity of a coordinate to a provided geofence or set of fences. With POST call, you do not have to upload the fence data in advance, instead you supply the location of the object you are tracking in query parameters as well as the fence or set of fences data in post request body. See [Geofencing GeoJSON data](https://docs.microsoft.com/azure/azure-maps/geofence-geojson) for more details on the geofence data format. The response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.

This API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Geofence Post API allows you to retrieve the proximity of a coordinate to a provided geofence or set of fences. With POST call, you do not have to upload the fence data in advance, instead you supply the location of the object you are tracking in query parameters as well as the fence or set of fences data in post request body. See [Geofencing GeoJSON data](/azure/azure-maps/geofence-geojson) for more details on the geofence data format. The response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.

This API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).", "operationId": "Spatial_PostGeofence", "x-ms-examples": { "PostGeofence": { @@ -351,7 +351,7 @@ }, "/spatial/buffer/{format}": { "post": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided.", "operationId": "Spatial_PostBuffer", "x-ms-examples": { "PostBuffer": { @@ -391,7 +391,7 @@ } }, "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input features are provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided. \n\nTo test this API, you can upload the sample data from [Post Buffer API](https://docs.microsoft.com/rest/api/maps/spatial/postbuffer#examples) examples (Request Body without distances array) via [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) and replace the `{udid}` from the [sample request below](https://docs.microsoft.com/rest/api/maps/spatial/getbuffer#examples) with the udid returned by Data Upload API.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input features are provided by a GeoJSON file which is uploaded using the [Data registry API](/rest/api/maps/data-registry/register-or-replace) and referenced by a unique udid. The GeoJSON file may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided. \n\nTo test this API, you can upload the sample data from [Post Buffer API](/rest/api/maps/spatial/postbuffer#examples) examples (Request Body without distances array) using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and replace the `{udid}` in the following [sample request](/rest/api/maps/spatial/getbuffer#examples) with the `udid` used when creating the data registry. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "operationId": "Spatial_GetBuffer", "x-ms-examples": { "GetBuffer": { @@ -434,7 +434,7 @@ }, "/spatial/closestPoint/{format}": { "post": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.", "operationId": "Spatial_PostClosestPoint", "x-ms-examples": { "PostClosestPoint": { @@ -480,7 +480,7 @@ } }, "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns the closest point between a base point and a given set of points in the user uploaded data set identified by udid. The set of target points is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The maximum number of points accepted is 100,000. The algorithm does not take into account routing or traffic. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.\n\nTo test this API, you can upload the sample data from [Post Closest Point API](https://docs.microsoft.com/rest/api/maps/spatial/postclosestpoint#examples) examples (Request Body) via [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) and replace the `{udid}` from the [sample request below](https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint#examples) with the udid returned by Data Upload API.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns the closest point between a base point and a given set of points in the user uploaded data set identified by `udid`. The set of target points is provided by a GeoJSON file which is uploaded using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and referenced by a unique udid. The GeoJSON file may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The maximum number of points accepted is 100,000. The algorithm does not take into account routing or traffic. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.\n\nTo test this API, you can upload the sample data from [Post Closest Point API](/rest/api/maps/spatial/postclosestpoint#examples) examples (Request Body) using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and replace the `{udid}` from the [sample request below](/rest/api/maps/spatial/getclosestpoint#examples) with the `udid` used when creating the data registry. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "operationId": "Spatial_GetClosestPoint", "x-ms-examples": { "GetClosestPoint": { @@ -528,7 +528,7 @@ }, "/spatial/pointInPolygon/{format}": { "post": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The user data may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries (referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The user data may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries (referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.", "operationId": "Spatial_PostPointInPolygon", "x-ms-examples": { "PostPointInPolygon": { @@ -568,7 +568,7 @@ } }, "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.\n\n \nTo test this API, you can upload the sample data from [Post Point In Polygon API](https://docs.microsoft.com/rest/api/maps/spatial/postpointinpolygon#examples) examples (Request Body) via [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) and replace the `{udid}` from the [sample request below](https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon#examples) with the udid returned by Data Upload API.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.\n\n \nTo test this API, you can upload the sample data from [Post Point In Polygon API](/rest/api/maps/spatial/postpointinpolygon#examples) examples (Request Body) using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and replace the `{udid}` from the [sample request below](/rest/api/maps/spatial/getpointinpolygon#examples) with the `udid` used when creating the data registry. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "operationId": "Spatial_GetPointInPolygon", "x-ms-examples": { "GetPointInPolygon": { @@ -610,7 +610,7 @@ }, "/spatial/greatCircleDistance/{format}": { "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API will return the great-circle or shortest distance between two points on the surface of a sphere, measured along the surface of the sphere. This differs from calculating a straight line through the sphere's interior. This method is helpful for estimating travel distances for airplanes by calculating the shortest distance between airports.", + "description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API will return the great-circle or shortest distance between two points on the surface of a sphere, measured along the surface of the sphere. This differs from calculating a straight line through the sphere's interior. This method is helpful for estimating travel distances for airplanes by calculating the shortest distance between airports.", "operationId": "Spatial_GetGreatCircleDistance", "x-ms-examples": { "GetGreatCircleDistance": { @@ -662,7 +662,7 @@ }, "udId": { "x-ms-client-name": "udid", - "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "description": "The unique id used when creating a [Data registry](/rest/api/maps/data-registry/register-or-replace) to upload a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "type": "string", "readOnly": true }, diff --git a/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneEnumIANA.json b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneEnumIANA.json index 2db943d752e7..894c96fa5864 100644 --- a/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneEnumIANA.json +++ b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneEnumIANA.json @@ -691,7 +691,7 @@ "HasZone1970Location": true }, { - "Id": "Asia/Chungking", + "Id": "Asia/Chongqing", "IsAlias": true, "AliasOf": "Asia/Shanghai", "HasZone1970Location": true @@ -721,19 +721,19 @@ "HasZone1970Location": true }, { - "Id": "Asia/Macao", + "Id": "Asia/Macao SAR", "IsAlias": true, "AliasOf": "Asia/Macau", "HasZone1970Location": true }, { - "Id": "Asia/Rangoon", + "Id": "Asia/Yangon (Rangoon)", "IsAlias": true, "AliasOf": "Asia/Yangon", "HasZone1970Location": true }, { - "Id": "Asia/Saigon", + "Id": "Asia/Ho Chi Minh City", "IsAlias": true, "AliasOf": "Asia/Ho_Chi_Minh", "HasZone1970Location": true @@ -1129,7 +1129,7 @@ "HasZone1970Location": true }, { - "Id": "ROC", + "Id": "Taiwan", "IsAlias": true, "AliasOf": "Asia/Taipei", "HasZone1970Location": true @@ -1147,7 +1147,7 @@ "HasZone1970Location": true }, { - "Id": "Turkey", + "Id": "Türkiye", "IsAlias": true, "AliasOf": "Europe/Istanbul", "HasZone1970Location": true diff --git a/specification/maps/data-plane/Timezone/preview/1.0/timezone.json b/specification/maps/data-plane/Timezone/preview/1.0/timezone.json index 89d54ca15057..fafa1a5586ce 100644 --- a/specification/maps/data-plane/Timezone/preview/1.0/timezone.json +++ b/specification/maps/data-plane/Timezone/preview/1.0/timezone.json @@ -131,7 +131,7 @@ "paths": { "/timezone/byId/{format}": { "get": { - "description": "__Time Zone by Id__\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns current, historical, and future time zone information for the specified IANA time zone ID.", + "description": "__Time Zone by Id__\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns current, historical, and future time zone information for the specified IANA time zone ID.", "operationId": "Timezone_GetTimezoneByID", "x-ms-examples": { "Successfully retrieve timezone by ID": { @@ -187,7 +187,7 @@ }, "/timezone/byCoordinates/{format}": { "get": { - "description": "__Time Zone by Coordinates__\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.", + "description": "__Time Zone by Coordinates__\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.", "operationId": "Timezone_GetTimezoneByCoordinates", "x-ms-examples": { "Successfully retrieve timezone by coordinates": { @@ -250,7 +250,7 @@ }, "/timezone/enumWindows/{format}": { "get": { - "description": "__Windows Time Zones__\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns a full list of Windows Time Zone IDs.", + "description": "__Windows Time Zones__\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns a full list of Windows Time Zone IDs.", "operationId": "Timezone_GetTimezoneEnumWindows", "x-ms-client-name": "GetWindowsTimezoneIds", "x-ms-examples": { @@ -284,7 +284,7 @@ }, "/timezone/enumIana/{format}": { "get": { - "description": "__IANA Time Zones__\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns a full list of IANA time zone IDs. Updates to the IANA service will be reflected in the system within one day.", + "description": "__IANA Time Zones__\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns a full list of IANA time zone IDs. Updates to the IANA service will be reflected in the system within one day.", "operationId": "Timezone_GetTimezoneEnumIANA", "x-ms-client-name": "GetIANATimezoneIds", "x-ms-examples": { @@ -318,7 +318,7 @@ }, "/timezone/ianaVersion/{format}": { "get": { - "description": "__Time Zone IANA Version__\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns the current IANA version number as Metadata.", + "description": "__Time Zone IANA Version__\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns the current IANA version number as Metadata.", "operationId": "Timezone_GetTimezoneIANAVersion", "x-ms-client-name": "GetIANAVersion", "x-ms-examples": { @@ -352,7 +352,7 @@ }, "/timezone/windowsToIana/{format}": { "get": { - "description": "__Windows to IANA Time Zone__\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns a corresponding IANA ID, given a valid Windows Time Zone ID. Multiple IANA IDs may be returned for a single Windows ID. It is possible to narrow these results by adding an optional territory parameter.", + "description": "__Windows to IANA Time Zone__\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns a corresponding IANA ID, given a valid Windows Time Zone ID. Multiple IANA IDs may be returned for a single Windows ID. It is possible to narrow these results by adding an optional territory parameter.", "operationId": "Timezone_GetTimezoneWindowsToIANA", "x-ms-client-name": "ConvertWindowsTimezoneToIANA", "x-ms-examples": { diff --git a/specification/maps/data-plane/Traffic/preview/1.0/traffic.json b/specification/maps/data-plane/Traffic/preview/1.0/traffic.json index 24762978da53..5f39485651da 100644 --- a/specification/maps/data-plane/Traffic/preview/1.0/traffic.json +++ b/specification/maps/data-plane/Traffic/preview/1.0/traffic.json @@ -108,7 +108,7 @@ "paths": { "/traffic/flow/tile/{format}": { "get": { - "description": "__Traffic Flow Tile__\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Azure Flow Tile API serves 256 x 256 pixel tiles showing traffic flow. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. The Flow tiles use colors to indicate either the speed of traffic on different road segments, or the difference between that speed and the free-flow speed on the road segment in question.", + "description": "__Traffic Flow Tile__\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Azure Flow Tile API serves 256 x 256 pixel tiles showing traffic flow. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. The Flow tiles use colors to indicate either the speed of traffic on different road segments, or the difference between that speed and the free-flow speed on the road segment in question.", "operationId": "Traffic_GetTrafficFlowTile", "x-ms-examples": { "Request tile depicting the traffic flow": { @@ -209,7 +209,7 @@ }, "/traffic/flow/segment/{format}": { "get": { - "description": "__Traffic Flow Segment__\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis service provides information about the speeds and travel times of the road fragment closest to the given coordinates. It is designed to work alongside the Flow layer of the Render Service to support clickable flow data visualizations. With this API, the client side can connect any place in the map with flow data on the closest road and present it to the user.", + "description": "__Traffic Flow Segment__\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis service provides information about the speeds and travel times of the road fragment closest to the given coordinates. It is designed to work alongside the Flow layer of the Render Service to support clickable flow data visualizations. With this API, the client side can connect any place in the map with flow data on the closest road and present it to the user.", "operationId": "Traffic_GetTrafficFlowSegment", "x-ms-examples": { "Request traffic flow segment information": { @@ -315,7 +315,7 @@ }, "/traffic/incident/tile/{format}": { "get": { - "description": "__Traffic Incident Tile__\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis service serves 256 x 256 pixel tiles showing traffic incidents. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. Traffic tiles render graphics to indicate traffic on the roads in the specified area.", + "description": "__Traffic Incident Tile__\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis service serves 256 x 256 pixel tiles showing traffic incidents. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. Traffic tiles render graphics to indicate traffic on the roads in the specified area.", "operationId": "Traffic_GetTrafficIncidentTile", "x-ms-examples": { "Request a tile depicting a traffic incident": { @@ -414,7 +414,7 @@ }, "/traffic/incident/detail/{format}": { "get": { - "description": "__Traffic Incident Detail__ \n\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API provides information on traffic incidents inside a given bounding box, based on the current Traffic Model ID. The Traffic Model ID is available to grant synchronization of data between calls and API's. The Traffic Model ID is a key value for determining the currency of traffic incidents. It is updated every minute, and is valid for two minutes before it times out. It is used in rendering [incident tiles](https://docs.microsoft.com/rest/api/maps/traffic/gettrafficincidenttile). It can be obtained from the [Viewport API](https://docs.microsoft.com/rest/api/maps/traffic/gettrafficincidentviewport).", + "description": "__Traffic Incident Detail__ \n\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API provides information on traffic incidents inside a given bounding box, based on the current Traffic Model ID. The Traffic Model ID is available to grant synchronization of data between calls and API's. The Traffic Model ID is a key value for determining the currency of traffic incidents. It is updated every minute, and is valid for two minutes before it times out. It is used in rendering [incident tiles](https://docs.microsoft.com/rest/api/maps/traffic/gettrafficincidenttile). It can be obtained from the [Viewport API](https://docs.microsoft.com/rest/api/maps/traffic/gettrafficincidentviewport).", "operationId": "Traffic_GetTrafficIncidentDetail", "x-ms-examples": { "Request information about a traffic incident": { @@ -579,7 +579,7 @@ }, "/traffic/incident/viewport/{format}": { "get": { - "description": "__Traffic Incident Viewport__\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns legal and technical information for the viewport described in the request. It should be called by client applications whenever the viewport changes (for instance, through zooming, panning, going to a location, or displaying a route). The request should contain the bounding box and zoom level of the viewport whose information is needed. The return will contain map version information, as well as the current Traffic Model ID and copyright IDs. The Traffic Model ID returned by the Viewport Description is used by other APIs to retrieve last traffic information for further processing.", + "description": "__Traffic Incident Viewport__\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns legal and technical information for the viewport described in the request. It should be called by client applications whenever the viewport changes (for instance, through zooming, panning, going to a location, or displaying a route). The request should contain the bounding box and zoom level of the viewport whose information is needed. The return will contain map version information, as well as the current Traffic Model ID and copyright IDs. The Traffic Model ID returned by the Viewport Description is used by other APIs to retrieve last traffic information for further processing.", "operationId": "Traffic_GetTrafficIncidentViewport", "x-ms-examples": { "Request traffic incident information for the selected viewport": { diff --git a/specification/maps/data-plane/Weather/stable/1.1/weather.json b/specification/maps/data-plane/Weather/stable/1.1/weather.json index 506fa9d79f67..cdf885941982 100644 --- a/specification/maps/data-plane/Weather/stable/1.1/weather.json +++ b/specification/maps/data-plane/Weather/stable/1.1/weather.json @@ -259,7 +259,7 @@ "paths": { "/weather/forecast/hourly/{format}": { "get": { - "description": "**Get Hourly Forecast**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nRequest detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, humidity, wind, precipitation, and ultraviolet (UV) index.\n\nIn S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days).", + "description": "**Get Hourly Forecast**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nRequest detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, humidity, wind, precipitation, and ultraviolet (UV) index.\n\nIn S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days).", "operationId": "Weather_GetHourlyForecast", "x-ms-examples": { "Successfully retrieve detailed weather forecast by the hour": { @@ -307,7 +307,7 @@ }, "/weather/forecast/minute/{format}": { "get": { - "description": "**Get Minute Forecast**\n \n \n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes. Users can request weather forecasts in the interval of 1, 5 and 15 minutes. The response will include details such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation intensity value (dBZ).", + "description": "**Get Minute Forecast**\n \n \n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes. Users can request weather forecasts in the interval of 1, 5 and 15 minutes. The response will include details such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation intensity value (dBZ).", "operationId": "Weather_GetMinuteForecast", "x-ms-examples": { "Successfully retrieve minute-by-minute forecasts for a given location": { @@ -352,7 +352,7 @@ }, "/weather/forecast/quarterDay/{format}": { "get": { - "description": "**Get Quarter-Day Forecast**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nService returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details such as temperature, humidity, wind, precipitation, and UV index are returned.", + "description": "**Get Quarter-Day Forecast**\n\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nService returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details such as temperature, humidity, wind, precipitation, and UV index are returned.", "operationId": "Weather_GetQuarterDayForecast", "x-ms-examples": { "Successfully retrieve detailed weather forecast by a given location": { @@ -400,7 +400,7 @@ }, "/weather/currentConditions/{format}": { "get": { - "description": "**Get Current Conditions**\n \n \n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Current Conditions service returns detailed current weather conditions such as precipitation, temperature and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular location can be retrieved. The basic information returned with the response include details such as observation date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and temperature. Additional details such as RealFeel™ Temperature and UV index are also returned.", + "description": "**Get Current Conditions**\n \n \n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Current Conditions service returns detailed current weather conditions such as precipitation, temperature and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular location can be retrieved. The basic information returned with the response include details such as observation date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and temperature. Additional details such as RealFeel™ Temperature and UV index are also returned.", "operationId": "Weather_GetCurrentConditions", "x-ms-examples": { "Successfully retrieve detailed current weather conditions for a given coordinate location": { @@ -454,7 +454,7 @@ }, "/weather/forecast/daily/{format}": { "get": { - "description": "**Get Daily Forecast**\n \n \n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, 25, or 45 days for a given coordinate location. The response include details such as temperature, wind, precipitation, air quality, and UV index.\n\nIn S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily forecast for the next 25 days, and 45 days.", + "description": "**Get Daily Forecast**\n \n \n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, 25, or 45 days for a given coordinate location. The response include details such as temperature, wind, precipitation, air quality, and UV index.\n\nIn S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily forecast for the next 25 days, and 45 days.", "operationId": "Weather_GetDailyForecast", "x-ms-examples": { "Successfully retrieve detailed daily weather forecast for a given coordinate location": { @@ -502,7 +502,7 @@ }, "/weather/route/{format}": { "get": { - "description": "**Get Weather along route**\n \n \n **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, weather hazard assessments, and notifications along a route described as a sequence of waypoints. \n This includes a list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might be used to paint each portion of a route according to how safe it is for the driver. When submitting the waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. Data is updated every five minutes. \n \n The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows you to first request a route between an origin and a destination and use that as an input for Weather Along Route endpoint.\n \n In addition, the service supports scenarios to generate weather notifications for waypoints that experience an increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing the end product to display a heavy rain notification before the driver reaches that waypoint. \n The trigger for when to display the notification for a waypoint could be based, for example, on a [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the waypoint.\n\n The API covers all regions of the planet except latitudes above Greenland and Antarctica.", + "description": "**Get Weather along route**\n \n \n **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, weather hazard assessments, and notifications along a route described as a sequence of waypoints. \n This includes a list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might be used to paint each portion of a route according to how safe it is for the driver. When submitting the waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. Data is updated every five minutes. \n \n The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows you to first request a route between an origin and a destination and use that as an input for Weather Along Route endpoint.\n \n In addition, the service supports scenarios to generate weather notifications for waypoints that experience an increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing the end product to display a heavy rain notification before the driver reaches that waypoint. \n The trigger for when to display the notification for a waypoint could be based, for example, on a [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the waypoint.\n\n The API covers all regions of the planet except latitudes above Greenland and Antarctica.", "operationId": "Weather_GetWeatherAlongRoute", "x-ms-examples": { "Successfully retrieve detailed weather casts along a route described as a sequence of waypoints": { @@ -545,7 +545,7 @@ }, "/weather/severe/alerts/{format}": { "get": { - "description": "**Get Severe Weather Alerts**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nSevere weather phenomenon can significantly impact our everyday life and business operations. For example, severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of refrigerated food products.  Azure Maps Severe Weather Alerts API returns the severe weather alerts that are available worldwide from both official Government Meteorological Agencies and leading global to regional weather alert providers. The service can return details such as alert type, category, level and detailed description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, heat waves or forest fires.", + "description": "**Get Severe Weather Alerts**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nSevere weather phenomenon can significantly impact our everyday life and business operations. For example, severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of refrigerated food products.  Azure Maps Severe Weather Alerts API returns the severe weather alerts that are available worldwide from both official Government Meteorological Agencies and leading global to regional weather alert providers. The service can return details such as alert type, category, level and detailed description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, heat waves or forest fires.", "operationId": "Weather_GetSevereWeatherAlerts", "x-ms-examples": { "Successfully retrieve severe weather alerts": { @@ -590,7 +590,7 @@ }, "/weather/indices/daily/{format}": { "get": { - "description": "**Get Daily Indices**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThere may be times when you want to know if the weather conditions are optimal for a specific activity, for example, for outdoor construction, indoor activities, running or farming including soil moisture information. Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a health mobile application can notify users that today is good weather for running or for other outdoors activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days starting from current day.", + "description": "**Get Daily Indices**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nThere may be times when you want to know if the weather conditions are optimal for a specific activity, for example, for outdoor construction, indoor activities, running or farming including soil moisture information. Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a health mobile application can notify users that today is good weather for running or for other outdoors activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days starting from current day.", "operationId": "Weather_GetDailyIndices", "x-ms-examples": { "Successfully retrieve daily indices values from current day": { @@ -647,7 +647,7 @@ }, "/weather/tropical/storms/active/{format}": { "get": { - "description": "**Get Tropical Storm Active**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet all government-issued active tropical storms. Information about the tropical storms includes, government ID, basin ID, year of origin, name and if it is subtropical.", + "description": "**Get Tropical Storm Active**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet all government-issued active tropical storms. Information about the tropical storms includes, government ID, basin ID, year of origin, name and if it is subtropical.", "operationId": "Weather_GetTropicalStormActive", "x-ms-examples": { "Get Tropical Storm Active": { @@ -680,7 +680,7 @@ }, "/weather/tropical/storms/{format}": { "get": { - "description": "**Get Tropical Storm Search**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nSearch government-issued tropical storms by year, basin ID, and government ID. Information about the tropical storms includes, government ID, basin ID, status, year, name and if it is subtropical.", + "description": "**Get Tropical Storm Search**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nSearch government-issued tropical storms by year, basin ID, and government ID. Information about the tropical storms includes, government ID, basin ID, status, year, name and if it is subtropical.", "operationId": "Weather_GetTropicalStormSearch", "x-ms-client-name": "SearchTropicalStorm", "x-ms-examples": { @@ -726,7 +726,7 @@ }, "/weather/tropical/storms/forecasts/{format}": { "get": { - "description": "**Get Tropical Storm Forecasts**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet individual government-issued tropical storm forecasts. Information about the forecasted tropical storms includes, location, status, date the forecast was created, window, wind speed and wind radii.", + "description": "**Get Tropical Storm Forecasts**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet individual government-issued tropical storm forecasts. Information about the forecasted tropical storms includes, location, status, date the forecast was created, window, wind speed and wind radii.", "operationId": "Weather_GetTropicalStormForecast", "x-ms-examples": { "Get Tropical Storm Forecasts": { @@ -785,7 +785,7 @@ }, "/weather/tropical/storms/locations/{format}": { "get": { - "description": "**Get Tropical Storm Locations**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet location of individual government-issued tropical storms. Information about the tropical storms includes, location coordinates, geometry, basin ID, date, wind details and wind radii.", + "description": "**Get Tropical Storm Locations**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet location of individual government-issued tropical storms. Information about the tropical storms includes, location coordinates, geometry, basin ID, date, wind details and wind radii.", "operationId": "Weather_GetTropicalStormLocations", "x-ms-examples": { "Get Tropical Storm Locations": { @@ -847,7 +847,7 @@ }, "/weather/airQuality/current/{format}": { "get": { - "description": "**Get Current Air Quality**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet detailed information about the concentration of pollutants and overall status for current air quality. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", + "description": "**Get Current Air Quality**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet detailed information about the concentration of pollutants and overall status for current air quality. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", "operationId": "Weather_GetCurrentAirQuality", "x-ms-examples": { "Get Current Air Quality": { @@ -889,7 +889,7 @@ }, "/weather/airQuality/forecasts/daily/{format}": { "get": { - "description": "**Get Air Quality Daily Forecasts**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet detailed information about the concentration of pollutants and overall status of forecasted daily air quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", + "description": "**Get Air Quality Daily Forecasts**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet detailed information about the concentration of pollutants and overall status of forecasted daily air quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", "operationId": "Weather_GetAirQualityDailyForecasts", "x-ms-examples": { "Get Daily Air Quality Forecasts": { @@ -986,7 +986,7 @@ }, "/weather/airQuality/forecasts/hourly/{format}": { "get": { - "description": "**Get Air Quality Hourly Forecasts**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet detailed information about the concentration of pollutants and overall status for forecasted upcoming hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans of 1, 12, 24, 48, 72, and 96 hours. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", + "description": "**Get Air Quality Hourly Forecasts**\n\n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet detailed information about the concentration of pollutants and overall status for forecasted upcoming hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans of 1, 12, 24, 48, 72, and 96 hours. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", "operationId": "Weather_GetAirQualityHourlyForecasts", "x-ms-examples": { "Get Hourly Air Quality Forecasts": { @@ -1080,7 +1080,7 @@ }, "/weather/historical/actuals/daily/{format}": { "get": { - "description": "**Get Daily Historical Actuals**\n \n \n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Daily Historical Actuals service returns climatology data such as past daily actual observed temperatures, precipitation, snowfall, snow depth and cooling/heating degree day information, for the day at a given coordinate location. The data is requested for a specified date range, up to 31 days in a single API request. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", + "description": "**Get Daily Historical Actuals**\n \n \n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Daily Historical Actuals service returns climatology data such as past daily actual observed temperatures, precipitation, snowfall, snow depth and cooling/heating degree day information, for the day at a given coordinate location. The data is requested for a specified date range, up to 31 days in a single API request. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", "operationId": "Weather_GetDailyHistoricalActuals", "x-ms-examples": { "Successful Daily Historical Actuals Request": { @@ -1135,7 +1135,7 @@ }, "/weather/historical/records/daily/{format}": { "get": { - "description": "**Get Daily Historical Records**\n \n \n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Daily Historical Records service returns climatology data such as past daily record temperatures, precipitation and snowfall at a given coordinate location. Availability of records data will vary by location. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", + "description": "**Get Daily Historical Records**\n \n \n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Daily Historical Records service returns climatology data such as past daily record temperatures, precipitation and snowfall at a given coordinate location. Availability of records data will vary by location. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", "operationId": "Weather_GetDailyHistoricalRecords", "x-ms-examples": { "Successful Daily Historical Records Request": { @@ -1190,7 +1190,7 @@ }, "/weather/historical/normals/daily/{format}": { "get": { - "description": "**Get Daily Historical Normals**\n \n \n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Daily Historical Normals service returns climatology data such as past daily normal temperatures, precipitation and cooling/heating degree day information for the day at a given coordinate location. Normals are a 30-year average for temperatures and precipitation for a specific location. As is standard practice in climatology, the 30-year average covers years 1991-2020, this data will be used for one decade and then will reset in the year 2030. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", + "description": "**Get Daily Historical Normals**\n \n \n**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Daily Historical Normals service returns climatology data such as past daily normal temperatures, precipitation and cooling/heating degree day information for the day at a given coordinate location. Normals are a 30-year average for temperatures and precipitation for a specific location. As is standard practice in climatology, the 30-year average covers years 1991-2020, this data will be used for one decade and then will reset in the year 2030. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", "operationId": "Weather_GetDailyHistoricalNormals", "x-ms-examples": { "Successful Daily Historical Normals Request": { diff --git a/specification/maps/data-plane/readme.md b/specification/maps/data-plane/readme.md index ae96746cd280..227d750b56f3 100644 --- a/specification/maps/data-plane/readme.md +++ b/specification/maps/data-plane/readme.md @@ -27,7 +27,7 @@ These are the global settings for MapsClient. ``` yaml title: MapsClient openapi-type: data-plane -tag: package-stable-2023-07-01 +tag: package-stable-2023-06-01 ``` ### Suppression @@ -43,24 +43,21 @@ directive: where: $.paths["/providers/Microsoft.Subscription/subscriptionOperations/{operationId}"].get reason: The reason for this suppression is the API is already released and introducing new LRO properties will not function and are not supported today and will only be developed for the next version of this API. - - suppress: INVALID_TYPE - reason: false positive from oav is breaking our example validation. See azure/oav#1020. - - suppress: RESPONSE_SCHEMA_NOT_IN_SPEC reason: false positive from oav is breaking our example validation. See azure/oav#1021. ``` -### Tag: package-stable-2023-07-01 +### Tag: package-stable-2023-06-01 -These settings apply only when `--tag=package-stable-2023-07-01` is specified on the command line. +These settings apply only when `--tag=package-stable-2023-06-01` is specified on the command line. -```yaml $(tag) == 'package-stable-2023-07-01' +```yaml $(tag) == 'package-stable-2023-06-01' input-file: - Common/stable/2023-06-01/common.json - DataRegistry/stable/2023-06-01/dataregistry.json - Geolocation/preview/1.0/geolocation.json - - Microsoft.Maps/Data/preview/2.0/data.json + - Creator/preview/2.0/data.json - Render/stable/2022-08-01/render.json - Route/preview/1.0/route.json - Search/stable/2023-06-01/search.json @@ -77,10 +74,19 @@ These settings apply only when `--tag=package-stable-1.0` is specified on the co ```yaml $(tag) == 'package-stable-1.0' input-file: - Microsoft.Maps/Data/preview/1.0/data.json - - Microsoft.Maps/Render/preview/1.0/render.json + - Render/preview/1.0/render.json - Search/preview/1.0/search.json ``` +### Tag: package-2023-10-01-preview + +These settings apply only when `--tag=package-2023-10-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-10-01-preview' +input-file: + - Route/preview/2023-10-01-preview/route.json +``` + ### Tag: package-deprecated These settings apply only when `--tag=package-deprecated` is specified on the command line. @@ -88,6 +94,7 @@ These settings apply only when `--tag=package-deprecated` is specified on the co ``` yaml $(tag) == 'package-deprecated' input-file: - Microsoft.Maps/Alias/preview/2.0/alias.json + - Microsoft.Maps/Data/preview/2.0/data.json - Microsoft.Maps/DEM/preview/1.0/elevation.json - Microsoft.Maps/Feedback/preview/1.0/feedback.json - Microsoft.Maps/Geolocation/preview/1.0/geolocation.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..f16d0885daa9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,146 @@ +{ + "title": "AksAssessmentOperations_Create", + "operationId": "AksAssessmentOperations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "resource": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..f0d51215e094 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "AksAssessmentOperations_Delete", + "operationId": "AksAssessmentOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..d01de4be575b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "AksAssessmentOperations_DownloadUrl", + "operationId": "AksAssessmentOperations_DownloadUrl", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "vthjjfdenyh", + "expirationTime": "2023-11-07T06:51:25.205Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e1b9b706628a --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "AksAssessmentOperations_Get", + "operationId": "AksAssessmentOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..0ea13f960ed3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AksAssessmentOperations_ListByAssessmentProject", + "operationId": "AksAssessmentOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "continuationToken": "polt", + "$top": 5, + "$filter": "azekdtdhupdngbqxzdppicwf", + "totalRecordCount": 18, + "projectName": "testproject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..0dcb435d8b0c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "AksClusterOperations_Get", + "operationId": "AksClusterOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "clusterName": "testaksassessment-cluster" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "testaksassessment-cluster", + "nodePools": [ + { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 1, + "podCount": 1, + "monthlyCost": 10, + "podApproxMonthlyCost": 10 + } + ], + "region": "Unknown", + "userNodePoolCount": 0, + "userNodeCount": 6, + "systemNodePoolCount": 16, + "systemNodeCount": 18, + "podCount": 26, + "monthlyCost": 14 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/clusters/testaksassessment-cluster", + "name": "testaksassessment-cluster", + "type": "AKSAssessmentCluster", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..342ead7f7c85 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "AksClusterOperations_ListByAksAssessment", + "operationId": "AksClusterOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "$filter": "sfmesuqkmjezolfjvalm", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "name": "testaksassessment-cluster", + "nodePools": [ + { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 1, + "podCount": 1, + "monthlyCost": 10, + "podApproxMonthlyCost": 10 + } + ], + "region": "Unknown", + "userNodePoolCount": 0, + "userNodeCount": 6, + "systemNodePoolCount": 16, + "systemNodeCount": 18, + "podCount": 26, + "monthlyCost": 14 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/clusters/testaksassessment-cluster", + "name": "testaksassessment-cluster", + "type": "AKSAssessmentCluster", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..9eb57abd092c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "AksCostDetailOperations_ListByAksAssessment", + "operationId": "AksCostDetailOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "$filter": "ww", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 16, + "podCount": 7, + "monthlyCost": 6, + "podApproxMonthlyCost": 27 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/costDetails/testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "type": "AKSAssessmentCostDetail", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..309a4acc9b72 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "AksOptionsOperations_Get", + "operationId": "AksOptionsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "edges": { + "AKS": { + "AzureLocation": [ + "EastAsia" + ] + } + } + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessmentOptions/default", + "name": "default", + "type": "AKSAssessmentOptions", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..ae7a9e938ff8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "AksOptionsOperations_ListByAssessmentProject", + "operationId": "AksOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "edges": { + "AKS": { + "AzureLocation": [ + "EastAsia" + ] + } + } + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessmentOptions/default", + "name": "default", + "type": "AKSAssessmentOptions", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..5e04837a1d32 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,63 @@ +{ + "title": "AksSummaryOperations_Get", + "operationId": "AksSummaryOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "summaryName": "AKS" + }, + "responses": { + "200": { + "body": { + "properties": { + "aksAssessmentSummary": { + "skuSummary": { + "StandardDS_v2": { + "count": 17, + "monthlyCost": 18 + } + }, + "webAppSummary": { + "IIS": { + "count": 17, + "monthlyCost": 18 + } + }, + "webServerSummary": { + "IIS": 13 + }, + "webAppCount": 19, + "webServerCount": 28, + "machineCount": 17, + "totalMonthlyCost": 6 + }, + "assessmentName": "testaksassessment", + "summaryName": "testaksassessmentsummary", + "suitabilityPerTarget": { + "AKS": { + "Ready": 11 + } + }, + "monthlyComputeCost": 8, + "monthlyStorageCost": 26, + "confidenceScore": 7 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/summaries/AKS", + "name": "AKS", + "type": "AKSAssessmentSummary", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..3b407bd5a439 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,67 @@ +{ + "title": "AksSummaryOperations_ListByAksAssessment", + "operationId": "AksSummaryOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "aksAssessmentSummary": { + "skuSummary": { + "StandardDS_v2": { + "count": 17, + "monthlyCost": 18 + } + }, + "webAppSummary": { + "IIS": { + "count": 17, + "monthlyCost": 18 + } + }, + "webServerSummary": { + "IIS": 13 + }, + "webAppCount": 19, + "webServerCount": 28, + "machineCount": 17, + "totalMonthlyCost": 6 + }, + "assessmentName": "testaksassessment", + "summaryName": "testaksassessmentsummary", + "suitabilityPerTarget": { + "AKS": { + "Ready": 11 + } + }, + "monthlyComputeCost": 8, + "monthlyStorageCost": 26, + "confidenceScore": 7 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/summaries/AKS", + "name": "AKS", + "type": "AKSAssessmentSummary", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b4bf9a07585e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,129 @@ +{ + "title": "AssessedMachinesOperations_Get", + "operationId": "AssessedMachinesOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D8E1C413-E65F-40C0-8A7E-743D6B7A6AE9", + "resourceGroupName": "rgopenapi", + "projectName": "pavqtntysjn", + "groupName": "smawqdmhfngray", + "assessmentName": "qjlumxyqsitd", + "assessedMachineName": "oqxjeheiipjmuo" + }, + "responses": { + "200": { + "body": { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing", + "recommendedDiskSize": "StandardSSD_E10", + "recommendedDiskType": "StandardSSD", + "gigabytesForRecommendedDiskSize": 17, + "recommendDiskThroughputInMbps": 13, + "recommendedDiskIops": 7, + "monthlyStorageCost": 5, + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 8, + "megabytesPerSecondOfRead": 9, + "megabytesPerSecondOfWrite": 29, + "numberOfReadOperationsPerSecond": 12, + "numberOfWriteOperationsPerSecond": 28 + } + }, + "monthlyUltraStorageCost": 11, + "hostProcessor": { + "name": "Intel(R) Xeon(R) Gold 5220R CPU @ 2.20GHz", + "numberOfSockets": 2, + "numberOfCoresPerSocket": 24 + }, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 273.792, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 14.88, + "description": null + } + ], + "monthlyBandwidthCost": 4, + "monthlyStorageCost": 10, + "monthlyPremiumStorageCost": 6, + "monthlyStandardSsdStorageCost": 4, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "NotApplicable", + "suitabilityExplanation": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "monthlyBandwidthCosts": 4, + "netGigabytesTransmittedPerMonth": 6, + "displayName": "VM Network", + "macAddress": "00:50:56:95:98:e8", + "ipAddresses": [ + "2404:f801:4800:1c:c4c2:1cd:7154:a028" + ], + "megabytesPerSecondReceived": 10, + "megabytesPerSecondTransmitted": 24 + } + }, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "recommendedSize": "Standard_F4s_v2", + "numberOfCoresForRecommendedSize": 8, + "megabytesOfMemoryForRecommendedSize": 27, + "monthlyComputeCostForRecommendedSize": 1, + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "PercentageOfCoresUtilizedMissing", + "type": "AssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T09:14:13.8168575Z", + "updatedTimestamp": "2023-09-26T09:14:13.8168575Z", + "displayName": "SQLTestDBVM28", + "description": null, + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_50150976-65ec-de99-1b54-a52710c3066e", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 21, + "numberOfCores": 7, + "confidenceRatingInPercentage": 14, + "percentageCoresUtilization": 24, + "percentageMemoryUtilization": 5, + "suitability": "Suitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1/assessedMachines/50fa865c-8c5c-4371-b7eb-5b900d7f9451", + "name": "riigi", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments/assessedMachines", + "systemData": { + "createdBy": "jsfqnyqqwykkv", + "createdByType": "sakanwar", + "createdAt": "2023-09-26T12:46:17.892Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T12:46:17.892Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..edf57eac8717 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json @@ -0,0 +1,137 @@ +{ + "title": "AssessedMachinesOperations_ListByAssessment", + "operationId": "AssessedMachinesOperations_ListByAssessment", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D8E1C413-E65F-40C0-8A7E-743D6B7A6AE9", + "resourceGroupName": "rgopenapi", + "$filter": "sbkdovsfqldhdb", + "pageSize": 10, + "continuationToken": "hbyseetshbplfkjmpjhsiurqgt", + "totalRecordCount": 25, + "projectName": "sloqixzfjk", + "groupName": "kjuepxerwseq", + "assessmentName": "rhzcmubwrrkhtocsibu" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing", + "recommendedDiskSize": "StandardSSD_E10", + "recommendedDiskType": "StandardSSD", + "gigabytesForRecommendedDiskSize": 17, + "recommendDiskThroughputInMbps": 13, + "recommendedDiskIops": 7, + "monthlyStorageCost": 5, + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 8, + "megabytesPerSecondOfRead": 9, + "megabytesPerSecondOfWrite": 29, + "numberOfReadOperationsPerSecond": 12, + "numberOfWriteOperationsPerSecond": 28 + } + }, + "monthlyUltraStorageCost": 11, + "hostProcessor": { + "name": "Intel(R) Xeon(R) Gold 5220R CPU @ 2.20GHz", + "numberOfSockets": 2, + "numberOfCoresPerSocket": 24 + }, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 273.792, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 14.88, + "description": null + } + ], + "monthlyBandwidthCost": 4, + "monthlyStorageCost": 10, + "monthlyPremiumStorageCost": 6, + "monthlyStandardSsdStorageCost": 4, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "NotApplicable", + "suitabilityExplanation": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "monthlyBandwidthCosts": 4, + "netGigabytesTransmittedPerMonth": 6, + "displayName": "VM Network", + "macAddress": "00:50:56:95:98:e8", + "ipAddresses": [ + "2404:f801:4800:1c:c4c2:1cd:7154:a028" + ], + "megabytesPerSecondReceived": 10, + "megabytesPerSecondTransmitted": 24 + } + }, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "recommendedSize": "Standard_F4s_v2", + "numberOfCoresForRecommendedSize": 8, + "megabytesOfMemoryForRecommendedSize": 27, + "monthlyComputeCostForRecommendedSize": 1, + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "PercentageOfCoresUtilizedMissing", + "type": "AssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T09:14:13.8168575Z", + "updatedTimestamp": "2023-09-26T09:14:13.8168575Z", + "displayName": "SQLTestDBVM28", + "description": null, + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_50150976-65ec-de99-1b54-a52710c3066e", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 21, + "numberOfCores": 7, + "confidenceRatingInPercentage": 14, + "percentageCoresUtilization": 24, + "percentageMemoryUtilization": 5, + "suitability": "Suitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1/assessedMachines/50fa865c-8c5c-4371-b7eb-5b900d7f9451", + "name": "riigi", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments/assessedMachines", + "systemData": { + "createdBy": "jsfqnyqqwykkv", + "createdByType": "sakanwar", + "createdAt": "2023-09-26T12:46:17.892Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T12:46:17.892Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..acafff9bbc3d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,225 @@ +{ + "title": "AssessedSqlDatabaseV2Operations_Get", + "operationId": "AssessedSqlDatabaseV2Operations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlDatabaseName": "858eb860-9e07-417c-91b6-bca1bffb3bf5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlDatabases/858eb860-9e07-417c-91b6-bca1bffb3bf5", + "name": "858eb860-9e07-417c-91b6-bca1bffb3bf5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlDatabases", + "properties": { + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "bufferCacheSizeInMB": 18.875576036866359, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 1024.0, + "predictedDataSizeInMB": 10.0, + "predictedLogSizeInMB": 5.0, + "cores": 2, + "azureSqlTargetType": "AzureSqlDatabase" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 118.999824, + "monthlyStorageCost": 0.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "DatabaseCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsDatabaseStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.01" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.005" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "isDatabaseHighlyAvailable": false, + "linkedAvailabilityGroupOverview": null, + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "assessedSqlInstanceArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "machineName": "SQLHAVM17", + "instanceName": "MSSQLSERVER", + "databaseName": "Finance_User10", + "databaseSizeInMB": 15.0, + "compatibilityLevel": "CompatLevel120", + "sqlDatabaseSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqldatabases/ea92ba27-3656-5370-8bcc-e5eed9d7ba5e", + "percentageCoresUtilization": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.8572031Z", + "updatedTimestamp": "2023-09-08T05:22:36.4665924Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..ef0642365d6c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,233 @@ +{ + "title": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/DatabaseName,'adv130'))", + "pageSize": 23, + "totalRecordCount": 1, + "continuationToken": null, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlDatabases/858eb860-9e07-417c-91b6-bca1bffb3bf5", + "name": "858eb860-9e07-417c-91b6-bca1bffb3bf5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlDatabases", + "properties": { + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "bufferCacheSizeInMB": 18.875576036866359, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 1024.0, + "predictedDataSizeInMB": 10.0, + "predictedLogSizeInMB": 5.0, + "cores": 2, + "azureSqlTargetType": "AzureSqlDatabase" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 118.999824, + "monthlyStorageCost": 0.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "DatabaseCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsDatabaseStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.01" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.005" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "isDatabaseHighlyAvailable": false, + "linkedAvailabilityGroupOverview": null, + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "assessedSqlInstanceArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "machineName": "SQLHAVM17", + "instanceName": "MSSQLSERVER", + "databaseName": "Finance_User10", + "databaseSizeInMB": 15.0, + "compatibilityLevel": "CompatLevel120", + "sqlDatabaseSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqldatabases/ea92ba27-3656-5370-8bcc-e5eed9d7ba5e", + "percentageCoresUtilization": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.8572031Z", + "updatedTimestamp": "2023-09-08T05:22:36.4665924Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..40f502179c68 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,474 @@ +{ + "title": "AssessedSqlInstanceV2Operations_Get", + "operationId": "AssessedSqlInstanceV2Operations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlInstanceName": "3c6574cf-b4e1-4fdc-93db-6bbcc570dda2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/3c6574cf-b4e1-4fdc-93db-6bbcc570dda2", + "name": "3c6574cf-b4e1-4fdc-93db-6bbcc570dda2", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlInstances", + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.56 + } + ], + "logDiskSizes": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.56 + } + ], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 32.94432, + "monthlyStorageCost": 3.12, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigratePrimaryReplicaAndAllOtherReplicasToIaaS", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "2 PremiumSSD(P2)" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "memoryInUseInMB": 4096.0, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "BusinessCritical", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 32768.0, + "predictedDataSizeInMB": 112.0, + "predictedLogSizeInMB": 112.0, + "cores": 4, + "azureSqlTargetType": "AzureSqlManagedInstance" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 475.999296, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "InstanceCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "4" + } + ] + }, + { + "reasoningId": "MeetsInstanceStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.109" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.109" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "IncrementsInStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "MaxAvailableStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsAlwaysOnInstanceReplicaRequirementWithoutSecondaries", + "reasoningString": null, + "reasoningCategory": "AlwaysOnAG", + "contextParameters": [ + { + "contextKey": "AlwaysOnDatabaseServiceTier", + "contextValue": "BusinessCritical" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "BusinessCritical" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 833.165424, + "monthlyStorageCost": 24.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "storageTypeBasedDetails": [ + { + "storageType": "Rows", + "diskSizeInMB": 112.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "storageType": "Log", + "diskSizeInMB": 112.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 34, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2021-07-13T00:00:00Z", + "extendedSupportEndDate": "2026-07-14T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "fciMetadata": null, + "availabilityReplicaSummary": { + "numberOfSynchronousReadReplicas": 0, + "numberOfSynchronousNonReadReplicas": 0, + "numberOfAsynchronousReadReplicas": 0, + "numberOfAsynchronousNonReadReplicas": 0, + "numberOfPrimaryReplicas": 6 + }, + "isClustered": false, + "isHighAvailabilityEnabled": true, + "recommendedTargetReasonings": [ + { + "reasoningId": "RecommendedWithWarningsForSQLVM", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "MigrationIssuesCount", + "contextValue": "0" + }, + { + "contextKey": "MigrationWarningsCount", + "contextValue": "1" + }, + { + "contextKey": "RecommendedCost", + "contextValue": "36.06432" + } + ] + }, + { + "reasoningId": "RecommendedCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "RecommendedCost", + "contextValue": "36.06432" + } + ] + } + ], + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/184b8433-6991-45db-9f57-3dd3f6397a60", + "machineName": "SQLAGVM02", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/13c17b85-8842-4d50-a640-df0e45e56670", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2016", + "numberOfCoresAllocated": 2, + "percentageCoresUtilization": 100.0, + "logicalDisks": [ + { + "diskId": "s:", + "diskSizeInMB": 104.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "diskId": "l:", + "diskSizeInMB": 104.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "diskId": "c:", + "diskSizeInMB": 16.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "databaseSummary": { + "numberOfUserDatabases": 6, + "totalDatabaseSizeInMB": 224.0, + "largestDatabaseSizeInMB": 144.0, + "totalDiscoveredUserDatabases": 7 + }, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.9353438Z", + "updatedTimestamp": "2023-09-08T05:22:35.9666076Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..4a342f512350 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,505 @@ +{ + "title": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/InstanceName,'MSSQLSERVER'))", + "pageSize": 23, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/dhlodhiccy/providers/Microsoft.Migrate/assessmentprojects/dhccy30279project/groups/test_paas_pref_grp_2812/sqlAssessments/test_train_250823/assessedSqlInstances/27b94796-026e-4278-a546-664d46977c0a", + "name": "27b94796-026e-4278-a546-664d46977c0a", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlInstances", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [ + { + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.2 + } + ], + "logDiskSizes": [ + { + "diskType": "Premium", + "diskSize": "Premium_P3", + "diskRedundancy": "LRS", + "storageCost": 2.4 + } + ], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 26.361408, + "monthlyStorageCost": 3.6, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "MeetsVirtualMachineCpuScalingFactorRequirement", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "CoreUtilizationPercentage", + "contextValue": "0" + }, + { + "contextKey": "AllocatedCores", + "contextValue": "4" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "0" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineIOPSRequirement", + "reasoningString": null, + "reasoningCategory": "IOPSType", + "contextParameters": [ + { + "contextKey": "VirtualMachineIOPSRequiredInIOPerSec", + "contextValue": "0" + }, + { + "contextKey": "VirtualMachineUncachedDiskIOPSAvailableInIOPerSec", + "contextValue": "3200" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineIOThroughputRequirement", + "reasoningString": null, + "reasoningCategory": "ThroughputType", + "contextParameters": [ + { + "contextKey": "VirtualMachineIOThroughputRequiredInInMBPerSec", + "contextValue": "0" + }, + { + "contextKey": "VirtualMachineIOThroughputUncachedAvailableInIOPerSec", + "contextValue": "48" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "1 PremiumSSD_P2,1 PremiumSSD_P3" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "memoryInUseInMB": 0.0, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 65536.0, + "predictedDataSizeInMB": 6696.25, + "predictedLogSizeInMB": 14220.125, + "cores": 4, + "azureSqlTargetType": "AzureSqlManagedInstance" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 199.999104, + "monthlyStorageCost": 3.68, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToMI", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "MeetsInstanceCpuScalingFactorRequirement", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "CoreUtilizationPercentage", + "contextValue": "0" + }, + { + "contextKey": "AllocatedCores", + "contextValue": "4" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "4" + } + ] + }, + { + "reasoningId": "MeetsInstanceStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "6.539" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "13.887" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "64" + }, + { + "contextKey": "IncrementsInStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "MaxAvailableStorageInGB", + "contextValue": "2048" + } + ] + }, + { + "reasoningId": "MeetsInstanceIOThroughputRequirement", + "reasoningString": null, + "reasoningCategory": "ThroughputType", + "contextParameters": [ + { + "contextKey": "InstanceLevelThroughputRequiredInMBPerSec", + "contextValue": "0" + }, + { + "contextKey": "InstanceLevelThroughputAvailableInMBPerSec", + "contextValue": "10" + } + ] + }, + { + "reasoningId": "MeetsInstanceIOPSDataLogRequirement", + "reasoningString": null, + "reasoningCategory": "IOPSType", + "contextParameters": [ + { + "contextKey": "InstanceLevelIOPSRequiredInIOPerSec", + "contextValue": "0" + }, + { + "contextKey": "InstanceLevelIOPSAvailableInIOPerSec", + "contextValue": "6000" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 1199.994624, + "monthlyStorageCost": 7.13, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToDB", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "ServerCredentials", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "accessibilitytestdiag917", + "objectType": "ServerCredential" + } + ] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "storageTypeBasedDetails": [ + { + "storageType": "Rows", + "diskSizeInMB": 6696.25, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "storageType": "Log", + "diskSizeInMB": 14220.125, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 34, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2021-07-13T00:00:00Z", + "extendedSupportEndDate": "2026-07-14T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "fciMetadata": null, + "availabilityReplicaSummary": null, + "isClustered": false, + "isHighAvailabilityEnabled": false, + "recommendedTargetReasonings": [ + { + "reasoningId": "RecommendedForSQLVM", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "MigrationIssuesCount", + "contextValue": "0" + }, + { + "contextKey": "MigrationWarningsCount", + "contextValue": "0" + }, + { + "contextKey": "RecommendedCost", + "contextValue": "29.961408" + } + ] + }, + { + "reasoningId": "RecommendedCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "RecommendedCost", + "contextValue": "29.961408" + } + ] + }, + { + "reasoningId": "SQLMICost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "SQLMICost", + "contextValue": "203.679104" + } + ] + }, + { + "reasoningId": "SQLDBCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "SQLDBCost", + "contextValue": "1207.124624" + } + ] + } + ], + "sizingCriterion": "PerformanceBased", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/dhlodhiccy/providers/Microsoft.Migrate/assessmentprojects/dhccy30279project/machines/daf51245-560b-4caa-9c18-5409ab93d319", + "machineName": "SQLTestDBVM46", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/dhlodhiccy/providers/microsoft.offazure/mastersites/dhccy37819mastersite/sqlsites/dhccy37819sqlsites/sqlservers/a5a6441d-9f63-463e-a720-73fecd90a2e4", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2016", + "numberOfCoresAllocated": 4, + "percentageCoresUtilization": 0.0, + "logicalDisks": [ + { + "diskId": "d:", + "diskSizeInMB": 20916.375, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "databaseSummary": { + "numberOfUserDatabases": 12, + "totalDatabaseSizeInMB": 20916.375, + "largestDatabaseSizeInMB": 20815.0, + "totalDiscoveredUserDatabases": 12 + }, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-08-25T09:20:24.5544874Z", + "updatedTimestamp": "2023-08-25T09:20:25.2195402Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..49f63ce8832f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,155 @@ +{ + "title": "AssessedSqlMachinesOperations_Get", + "operationId": "AssessedSqlMachinesOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlMachineName": "cc64c9dc-b38e-435d-85ad-d509df5d92c6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "name": "cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlMachines", + "properties": { + "biosGuid": null, + "fqdn": null, + "sqlInstances": [ + { + "instanceId": "291313e5-e25f-4b6b-9f21-165a2dd03650", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/291313e5-e25f-4b6b-9f21-165a2dd03650", + "sqlInstanceEntityId": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlFciState": "Active" + } + ], + "suitabilityDetail": "PercentageOfCoresUtilizedMissing, PercentageOfMemoryUtilizedMissing", + "suitabilityExplanation": "NotApplicable", + "recommendedVmSize": "Standard_D2as_v4", + "recommendedVmFamily": "Dasv4_series", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Mainstream", + "eta": 64, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2024-01-09T00:00:00Z", + "extendedSupportEndDate": "2029-01-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "recommendedVmSizeNumberOfCores": 2, + "recommendedVmSizeMegabytesOfMemory": 8192.0, + "monthlyComputeCost": 32.94432, + "disks": { + "6000C293-381c-8460-c29b-ef937230e629": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing, NumberOfWriteOperationsPerSecondMissing, MegabytesPerSecondOfReadMissing, MegabytesPerSecondOfWriteMissing", + "recommendedDiskSize": "Premium_P10", + "recommendedDiskType": "Premium", + "recommendedDiskSizeGigabytes": 128, + "recommendDiskThroughputInMbps": 100.0, + "recommendedDiskIops": 500.0, + "monthlyStorageCost": 19.71, + "name": "6000C293-381c-8460-c29b-ef937230e629", + "displayName": "scsi0:0", + "gigabytesProvisioned": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + }, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "suitabilityExplanation": "NotApplicable", + "monthlyBandwidthCosts": 0.0, + "netGigabytesTransmittedPerMonth": 0.0, + "name": "4000", + "displayName": "VM Network", + "macAddress": "00:50:56:82:b7:83", + "ipAddresses": [ + "2404:f801:4800:20:418c:eec9:86c5:aea1", + "2404:f801:4800:20:6113:238d:17f0:b246", + "10.150.91.119", + "10.150.91.138", + "10.150.91.139" + ], + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "monthlyBandwidthCost": 0.0, + "monthlyStorageCost": 19.71, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "migrationGuidelines": [ + { + "guidelineId": "MigrateNodeSinceItHasActiveFCIInstance", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "UseSharedDiskWitnessForWSFCIfNeeded", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ReconfigureAnyAvailabilityGroupsAfterMigration", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "sizingCriterion": "PerformanceBased", + "type": "SqlAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2019 (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-08T05:22:34.8416411Z", + "updatedTimestamp": "2023-09-08T05:23:39.1749465Z", + "displayName": "SQLHAVM17", + "description": "", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/vmwaresites/fci-ankit-test6904site/machines/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa_5002fdf3-5889-c2f8-86e5-3119b251331b", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/VMwareSites/fci-ankit-test6904site/vcenters/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa", + "datacenterManagementServerName": "10.150.91.150", + "megabytesOfMemory": 4096.0, + "numberOfCores": 2, + "confidenceRatingInPercentage": 0.0, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "Suitable" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..140c28c40222 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,163 @@ +{ + "title": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/DisplayName,'SQLHAVM17'))", + "pageSize": 23, + "totalRecordCount": 1, + "continuationToken": null, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "name": "cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlMachines", + "properties": { + "biosGuid": null, + "fqdn": null, + "sqlInstances": [ + { + "instanceId": "291313e5-e25f-4b6b-9f21-165a2dd03650", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/291313e5-e25f-4b6b-9f21-165a2dd03650", + "sqlInstanceEntityId": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlFciState": "Active" + } + ], + "suitabilityDetail": "PercentageOfCoresUtilizedMissing, PercentageOfMemoryUtilizedMissing", + "suitabilityExplanation": "NotApplicable", + "recommendedVmSize": "Standard_D2as_v4", + "recommendedVmFamily": "Dasv4_series", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Mainstream", + "eta": 64, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2024-01-09T00:00:00Z", + "extendedSupportEndDate": "2029-01-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "recommendedVmSizeNumberOfCores": 2, + "recommendedVmSizeMegabytesOfMemory": 8192.0, + "monthlyComputeCost": 32.94432, + "disks": { + "6000C293-381c-8460-c29b-ef937230e629": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing, NumberOfWriteOperationsPerSecondMissing, MegabytesPerSecondOfReadMissing, MegabytesPerSecondOfWriteMissing", + "recommendedDiskSize": "Premium_P10", + "recommendedDiskType": "Premium", + "recommendedDiskSizeGigabytes": 128, + "recommendDiskThroughputInMbps": 100.0, + "recommendedDiskIops": 500.0, + "monthlyStorageCost": 19.71, + "name": "6000C293-381c-8460-c29b-ef937230e629", + "displayName": "scsi0:0", + "gigabytesProvisioned": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + }, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "suitabilityExplanation": "NotApplicable", + "monthlyBandwidthCosts": 0.0, + "netGigabytesTransmittedPerMonth": 0.0, + "name": "4000", + "displayName": "VM Network", + "macAddress": "00:50:56:82:b7:83", + "ipAddresses": [ + "2404:f801:4800:20:418c:eec9:86c5:aea1", + "2404:f801:4800:20:6113:238d:17f0:b246", + "10.150.91.119", + "10.150.91.138", + "10.150.91.139" + ], + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "monthlyBandwidthCost": 0.0, + "monthlyStorageCost": 19.71, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "migrationGuidelines": [ + { + "guidelineId": "MigrateNodeSinceItHasActiveFCIInstance", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "UseSharedDiskWitnessForWSFCIfNeeded", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ReconfigureAnyAvailabilityGroupsAfterMigration", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "sizingCriterion": "PerformanceBased", + "type": "SqlAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2019 (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-08T05:22:34.8416411Z", + "updatedTimestamp": "2023-09-08T05:23:39.1749465Z", + "displayName": "SQLHAVM17", + "description": "", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/vmwaresites/fci-ankit-test6904site/machines/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa_5002fdf3-5889-c2f8-86e5-3119b251331b", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/VMwareSites/fci-ankit-test6904site/vcenters/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa", + "datacenterManagementServerName": "10.150.91.150", + "megabytesOfMemory": 4096.0, + "numberOfCores": 2, + "confidenceRatingInPercentage": 0.0, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "Suitable" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines?api-version=2023-04-01-preview&pageSize=1&continuationToken=%5b%7b%22token%22%3a%22%2bRID%3a%7eOHlvANYGbAopzgkAAAAAAg%3d%3d%23RT%3a1%23TRC%3a1%23ISV%3a2%23IEO%3a65551%23QCF%3a8%23FPC%3aASnOCQAAAAACO84JAAAAAAI%3d%22%2c%22range%22%3a%7b%22min%22%3a%2205C1D9CD673390%22%2c%22max%22%3a%2205C1DFFFFFFFF4%22%7d%7d%5d&totalRecordCount=19" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ceed0a6522e0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,330 @@ +{ + "title": "AssessedSqlRecommendedEntityOperations_Get", + "operationId": "AssessedSqlRecommendedEntityOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "recommendedAssessedEntityName": "cc64c9dc-b38e-435d-85ad-d509df5d92c6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "name": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/recommendedAssessedEntities", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [ + { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + } + ], + "sharedResources": { + "sharedDataDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedLogDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedTempDbDisks": [], + "numberOfMounts": 2, + "quorumWitness": { + "quorumWitnessType": "Disk" + } + }, + "monthlyComputeCost": 65.88864, + "monthlyStorageCost": 3.276, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": true, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "ProvisionInstanceAsFciOnSqlVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionDisksBasedOnLayoutInSku", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionSharedDiskForQuorum", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCIDiskWitness", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCISharedZRSDisks", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "machineName": "FC7-SQL2K14.FPL.COM", + "instanceName": "MSSQLSERVER", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "dbCount": 217, + "discoveredDBCount": 217, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 25822.9618079999, + "monthlyStorageCost": 149.73, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "assessedSqlEntityArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "sizingCriterion": "AsOnPremises" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..55d42486fa99 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,330 @@ +{ + "title": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/InstanceName,'MSSQLSERVER'))", + "pageSize": 23, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "name": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/recommendedAssessedEntities", + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [ + { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + } + ], + "sharedResources": { + "sharedDataDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedLogDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedTempDbDisks": [], + "numberOfMounts": 2, + "quorumWitness": { + "quorumWitnessType": "Disk" + } + }, + "monthlyComputeCost": 65.88864, + "monthlyStorageCost": 3.276, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": true, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "ProvisionInstanceAsFciOnSqlVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionDisksBasedOnLayoutInSku", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionSharedDiskForQuorum", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCIDiskWitness", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCISharedZRSDisks", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "machineName": "FC7-SQL2K14.FPL.COM", + "instanceName": "MSSQLSERVER", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "dbCount": 217, + "discoveredDBCount": 217, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 25822.9618079999, + "monthlyStorageCost": 149.73, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "assessedSqlEntityArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "sizingCriterion": "AsOnPremises" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities?api-version=2023-04-01-preview&pageSize=1&continuationToken=%5b%7b%22token%22%3a%22%2bRID%3a%7eOHlvAMMvEvMxeAsAAAAABQ%3d%3d%23RT%3a1%23TRC%3a1%23ISV%3a2%23IEO%3a65567%23QCF%3a8%23FPC%3aATF4CwAAAAAFRXgLAAAAAAU%3d%22%2c%22range%22%3a%7b%22min%22%3a%2205C1D32F43775C%22%2c%22max%22%3a%2205C1DFFFFFFFFC%22%7d%7d%5d&totalRecordCount=21" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..815ef07cd01d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,63 @@ +{ + "title": "AssessedWebAppV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "AssessedWebAppV2Operations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "assessedWebAppName": "webapp1" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppType": "IIS", + "targetSpecificResult": { + "azureAppService": { + "assessmentResult": { + "appServicePlanName": "plan-001-azureappservice", + "suitability": "Suitable", + "securitySuitability": "Unknown", + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1" + }, + "migrationIssues": [ + { + "issueId": "AppPoolIdentityCheck", + "issueCategory": "Info", + "issueDescriptionList": [ + "SpecificUser (SharePoint - 80), SpecificUser (SecurityTokenServiceApplicationPool)" + ] + } + ] + } + }, + "appServicePlanName": "plan-001-azureappservice,plan-001-azureappservicecontainer", + "machineName": "a404-r1w28r2-1", + "serverArmId": null, + "webServerName": "IIS Server", + "webAppName": "100%WebSite", + "discoveredWebAppId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/mastersites/sumukk-ccy-bcs9880mastersite/webappsites/sumukk-ccy-bcs9880webappsites/iiswebapplications/aa096c1b26cd80dd76e547d61d722d04e1779a9c8d95ae1baa91bdb226eb5c3d-9e55bf838a799e058f7c0478ff1029d5224456ab0a1c30f3a8779ba7bb841e88", + "discoveredMachineId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/vmwaresites/sumukk-ccy-bcs4557site/machines/idclab-vcen67-fareast-corp-micr-49743448-0440-4c6b-8300-eec352b87e73_5037cd30-828f-f362-c62c-d1715b8ede4c", + "confidenceRatingInPercentage": null, + "createdTimestamp": "2023-11-03T05:42:51.551Z", + "updatedTimestamp": "2023-11-03T05:42:51.551Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/assessedWebApps/e1c05a87-93c7-4b01-bf19-a4db9bf791a8", + "name": "e1c05a87-93c7-4b01-bf19-a4db9bf791a8", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/assessedWebApps", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..c5a3ff19aab0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,71 @@ +{ + "title": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "$filter": "", + "pageSize": 23, + "continuationToken": "pwqummugahjguraaqqssuwmxic", + "totalRecordCount": 6, + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "akgugrp2", + "assessmentName": "assess1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppType": "IIS", + "targetSpecificResult": { + "azureAppService": { + "assessmentResult": { + "appServicePlanName": "plan-003-azureappservicecontainer", + "suitability": "ConditionallySuitable", + "securitySuitability": "Suitable", + "webAppSkuName": "Premium_V3", + "webAppSkuSize": "P1 v3" + }, + "migrationIssues": [ + { + "issueId": "AuthCheckContainer", + "issueCategory": "Info", + "issueDescriptionList": [ + "windowsAuthentication (/)" + ] + } + ] + } + }, + "appServicePlanName": "plan-001-azureappservice", + "machineName": "windows-2k16", + "serverArmId": null, + "webServerName": "IIS Server", + "webAppName": "Microsoft Azure Migrate App Containerization", + "discoveredWebAppId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/mastersites/sumukk-ccy-bcs9880mastersite/webappsites/sumukk-ccy-bcs9880webappsites/iiswebapplications/70c2efd9345164750ddf889a474512530466d8f7aaa85052b59a73ff6a4d41b1-ae625d98de8e57d253ae9812590de37f17f382bcd47da01c2f3f9be5350ae98e", + "discoveredMachineId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/vmwaresites/sumukk-ccy-bcs4557site/machines/idclab-vcen67-fareast-corp-micr-49743448-0440-4c6b-8300-eec352b87e73_5015ed4a-5f13-8cd3-a4d4-1ec729e836ff", + "confidenceRatingInPercentage": 11, + "createdTimestamp": "2023-11-03T05:42:51.551Z", + "updatedTimestamp": "2023-11-03T05:42:51.551Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/akgugrp2/webAppAssessments/akgutestappsvc2/assessedWebApps/2d4423e1-9b0d-466f-a2f1-4f68adaa3c76", + "name": "2d4423e1-9b0d-466f-a2f1-4f68adaa3c76", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/assessedWebApps", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..89b5080b2573 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AssessedWebApplicationOperations_Get", + "operationId": "AssessedWebApplicationOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "assessedWorkload": "testaksassessmentapp" + }, + "responses": { + "200": { + "body": { + "properties": { + "suitabilityResult": { + "readiness": "Unknown", + "suitability": "NotSuitable", + "failedChecks": [ + { + "name": "check", + "behavior": "Issue", + "description": "check", + "cause": "check", + "recommendation": "upgrade IIS version", + "moreInfo": { + "title": "title", + "url": "https://www.bing.com" + } + } + ], + "suggestedMigrationTool": "None" + }, + "recommendationResult": { + "request": { + "cores": 12, + "memory": 28 + }, + "limit": { + "cores": 18, + "memory": 13 + }, + "osType": "Linux", + "clusterName": "testaksassessment-cluster", + "nodePoolId": "testaksassessmentCostDetail", + "nodePoolName": "testaksassessmentCostDetail", + "nodePoolArmSkuName": "StandardDS_v2", + "approxMonthlyCost": 3 + }, + "discoveryArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webApps/webapp", + "displayName": "webapp", + "webServerArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webServers/webserver", + "webServerDisplayName": "webserver", + "machineArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/machines/machine", + "machineDisplayName": "machine", + "webAppType": "IIS" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentprojects/testproject/aksAssessments/testaksassessment/assessedWebApps/testaksassessmentapp", + "name": "testaksassessmentapp", + "type": "AssessedWebApplication", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..f62667363c5d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "AssessedWebApplicationOperations_ListByAksAssessment", + "operationId": "AssessedWebApplicationOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "continuationToken": "gjilveslqiowaembajtj", + "$top": 13, + "$filter": "zqvpvrpvghjnxamq", + "totalRecordCount": 23, + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "suitabilityResult": { + "readiness": "Unknown", + "suitability": "NotSuitable", + "failedChecks": [ + { + "name": "check", + "behavior": "Issue", + "description": "check", + "cause": "check", + "recommendation": "upgrade IIS version", + "moreInfo": { + "title": "title", + "url": "https://www.bing.com" + } + } + ], + "suggestedMigrationTool": "None" + }, + "recommendationResult": { + "request": { + "cores": 12, + "memory": 28 + }, + "limit": { + "cores": 18, + "memory": 13 + }, + "osType": "Linux", + "clusterName": "testaksassessment-cluster", + "nodePoolId": "testaksassessmentCostDetail", + "nodePoolName": "testaksassessmentCostDetail", + "nodePoolArmSkuName": "StandardDS_v2", + "approxMonthlyCost": 3 + }, + "discoveryArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webApps/webapp", + "displayName": "webapp", + "webServerArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webServers/webserver", + "webServerDisplayName": "webserver", + "machineArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/machines/machine", + "machineDisplayName": "machine", + "webAppType": "IIS" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentprojects/testproject/aksAssessments/testaksassessment/assessedWebApps/testaksassessmentapp", + "name": "testaksassessmentapp", + "type": "AssessedWebApplication", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..d94aa78ea710 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,3079 @@ +{ + "title": "AssessmentOptionsOperations_Get", + "operationId": "AssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "vmFamilies": [ + { + "familyName": "Basic_A0_A4", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Standard_A0_A7", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Av2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "D_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized" + ] + }, + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "DC_Series", + "targetLocations": [ + "EastUs", + "WestEurope" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage", + "Confidential" + ] + }, + { + "familyName": "DS_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "DSv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ev4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "F_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "G_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "GS_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "AustraliaEast", + "CentralIndia", + "CentralUs", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "StorageOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia", + "USGovIowa" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "ultraDiskVmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "CentralIndia", + "GermanyWestCentral", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + } + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Ddsv4_series", + "Ddsv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "DC_Series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Esv5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Esv3_series", + "Esv4_series", + "Fs_series", + "Fsv2_series", + "GS_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "PolandCentral" + ] + }, + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/assessmentOptions/default", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..e6adf67094ed --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,3083 @@ +{ + "title": "AssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "AssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "A926B99C-7F4C-4556-871E-20CB8C6ADB56", + "resourceGroupName": "rgmigrate", + "projectName": "fhodvffhuoqwbysrrqbizete" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vmFamilies": [ + { + "familyName": "Basic_A0_A4", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Standard_A0_A7", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Av2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "D_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized" + ] + }, + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "DC_Series", + "targetLocations": [ + "EastUs", + "WestEurope" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage", + "Confidential" + ] + }, + { + "familyName": "DS_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "DSv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ev4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "F_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "G_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "GS_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "AustraliaEast", + "CentralIndia", + "CentralUs", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "StorageOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia", + "USGovIowa" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "ultraDiskVmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "CentralIndia", + "GermanyWestCentral", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + } + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Ddsv4_series", + "Ddsv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "DC_Series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Esv5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Esv3_series", + "Esv4_series", + "Fs_series", + "Fsv2_series", + "GS_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "PolandCentral" + ] + }, + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/assessmentOptions/default", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..fbd72aec0043 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "AssessmentProjectSummaryOperations_Get", + "operationId": "AssessmentProjectSummaryOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "piyushapp1", + "projectName": "PiyushApp15328project", + "projectSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "errorSummaryAffectedEntities": [ + { + "assessmentType": "MachineAssessment", + "count": 1 + }, + { + "assessmentType": "AvsAssessment", + "count": 2 + } + ], + "numberOfPrivateEndpointConnections": 0, + "numberOfGroups": 4, + "numberOfMachines": 4, + "numberOfImportMachines": 0, + "numberOfAssessments": 2, + "lastAssessmentTimestamp": "2023-09-15T07:23:46.901Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/piyushapp1/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/projectSummary/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/projectSummary", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..b8eb8fd8aa9b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "operationId": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "piyushapp1", + "projectName": "PiyushApp15328project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errorSummaryAffectedEntities": [ + { + "assessmentType": "MachineAssessment", + "count": 1 + }, + { + "assessmentType": "AvsAssessment", + "count": 2 + } + ], + "numberOfPrivateEndpointConnections": 0, + "numberOfGroups": 4, + "numberOfMachines": 4, + "numberOfImportMachines": 0, + "numberOfAssessments": 2, + "lastAssessmentTimestamp": "2023-09-15T07:23:46.901Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/piyushapp1/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/projectSummary/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/projectSummary", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcdef" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..6d750272d42e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,144 @@ +{ + "title": "AssessmentProjectsOperations_Create", + "operationId": "AssessmentProjectsOperations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "resource": { + "properties": { + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..6c8eb855911b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "AssessmentProjectsOperations_Delete", + "operationId": "AssessmentProjectsOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "A926B99C-7F4C-4556-871E-20CB8C6ADB56", + "resourceGroupName": "rgmigrate", + "projectName": "zqrsyncwahgydqvwuchkfd" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..67b9716f89d0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "AssessmentProjectsOperations_Get", + "operationId": "AssessmentProjectsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..281f1ad81941 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AssessmentProjectsOperations_ListByResourceGroup", + "operationId": "AssessmentProjectsOperations_ListByResourceGroup", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects?api-version=2023-04-01-preview&%24skiptoken=1ZFNboMwEIXv4nWMCT9pihRVKGIXqirAASZ44joIG82YtGqUu9c9Rndv8Unfe3oP4fA7nKybWFQPcWze%2b3N9GrpmqD9EJT5DWLhSagYHBmd0IYGflTAZ%2fax4vfBIdgnWO1bFRWcA6VVmMchC717k6xb2soSizHNd7ndpqgjZrzSiIb8urBgmcF9AaiF%2ftxqJVWtH8uyvIWmtIQiogBmZ%2f9yRuuEY%2bA0WK%2b%2bRjuJDlma5THO5LcVGNHXXD132L9s%2fNwJoro0hNHG37v2ELn5Qn1vx%2fAU%3d" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..6596e869c319 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,72 @@ +{ + "title": "AssessmentProjectsOperations_ListBySubscription", + "operationId": "AssessmentProjectsOperations_ListBySubscription", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcdefg" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..2f5bbc87f2bb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,88 @@ +{ + "title": "AssessmentProjectsOperations_Update", + "operationId": "AssessmentProjectsOperations_Update", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "properties": { + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "properties": { + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..9342d1b9390b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,236 @@ +{ + "title": "AssessmentsOperations_Create", + "operationId": "AssessmentsOperations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1", + "resource": { + "properties": { + "eaSubscriptionId": "kwsu", + "azurePricingTier": "Standard", + "azureStorageRedundancy": "Unknown", + "reservedInstance": "None", + "azureHybridUseBenefit": "Unknown", + "linuxAzureHybridUseBenefit": "Unknown", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 26 + }, + "groupType": "Default", + "assessmentType": "Unknown", + "azureLocation": "njxbwdtsxzhichsnk", + "azureOfferCode": "Unknown", + "currency": "Unknown", + "scalingFactor": 24, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "status": "Created", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..986199809254 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "AssessmentsOperations_Delete", + "operationId": "AssessmentsOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..970058dc43f7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "AssessmentsOperations_DownloadUrl", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "uri/uri/uri", + "expirationTime": "2023-09-26T09:36:57.114Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a2fd64655d98 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "AssessmentsOperations_Get", + "operationId": "AssessmentsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1" + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..40ad6270f448 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,107 @@ +{ + "title": "AssessmentsOperations_ListByGroup", + "operationId": "AssessmentsOperations_ListByGroup", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..27297c4e11dc --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,78 @@ +{ + "title": "AvsAssessedMachinesOperations_Get", + "operationId": "AvsAssessedMachinesOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "avsAssessedMachineName": "b6d6fc6f-796f-4c16-96af-a6d22e0f12f7" + }, + "responses": { + "200": { + "body": { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 80.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + }, + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:95:7a:57", + "ipAddresses": [ + "2404:f801:4800:25:38fe:66de:64e4:5a26", + "10.150.9.214" + ], + "displayName": "VM Network", + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "storageInUseGB": 0.0, + "suitabilityExplanation": "IpV6NotSupported", + "suitabilityDetail": "None", + "type": "AvsAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T13:35:59.2324082Z", + "updatedTimestamp": "2023-09-26T13:35:59.2324082Z", + "displayName": "CustomerAE24Feb", + "description": "Microsoft Azure Migration Image on Windows Server 2016", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_501505aa-baaa-af9d-8315-5a45209fd255", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 32768.0, + "numberOfCores": 8, + "confidenceRatingInPercentage": null, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "ConditionallySuitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2/avsAssessedMachines/18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments/avsAssessedMachines", + "name": "18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..33a465dc609f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json @@ -0,0 +1,86 @@ +{ + "title": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "operationId": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "$filter": "ujmwhhuloficljxcjyc", + "pageSize": 6, + "continuationToken": "qwrjeiukbcicfrkqlqsfukfc", + "totalRecordCount": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 80.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + }, + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:95:7a:57", + "ipAddresses": [ + "2404:f801:4800:25:38fe:66de:64e4:5a26", + "10.150.9.214" + ], + "displayName": "VM Network", + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "storageInUseGB": 0.0, + "suitabilityExplanation": "IpV6NotSupported", + "suitabilityDetail": "None", + "type": "AvsAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T13:35:59.2324082Z", + "updatedTimestamp": "2023-09-26T13:35:59.2324082Z", + "displayName": "CustomerAE24Feb", + "description": "Microsoft Azure Migration Image on Windows Server 2016", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_501505aa-baaa-af9d-8315-5a45209fd255", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 32768.0, + "numberOfCores": 8, + "confidenceRatingInPercentage": null, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "ConditionallySuitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2/avsAssessedMachines/18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments/avsAssessedMachines", + "name": "18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..448ca3df71c9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,144 @@ +{ + "title": "AvsAssessmentOptionsOperations_Get", + "operationId": "AvsAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "avsAssessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "avsNodes": [ + { + "nodeType": "AV36", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "nodeType": "AV36P", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "EastUs2", + "WestUs", + "QatarCentral", + "WestEurope" + ] + }, + { + "nodeType": "AV52", + "targetLocations": [ + "WestEurope", + "UkSouth", + "EastUs2" + ] + } + ], + "failuresToTolerateAndRaidLevelValues": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "reservedInstanceAvsNodes": [ + "AV36", + "AV36P", + "AV52" + ], + "reservedInstanceSupportedLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral", + "WestUs2", + "QatarCentral" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/avsAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..4ec8c35950a8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,148 @@ +{ + "title": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "avsNodes": [ + { + "nodeType": "AV36", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "nodeType": "AV36P", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "EastUs2", + "WestUs", + "QatarCentral", + "WestEurope" + ] + }, + { + "nodeType": "AV52", + "targetLocations": [ + "WestEurope", + "UkSouth", + "EastUs2" + ] + } + ], + "failuresToTolerateAndRaidLevelValues": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "reservedInstanceAvsNodes": [ + "AV36", + "AV36P", + "AV52" + ], + "reservedInstanceSupportedLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral", + "WestUs2", + "QatarCentral" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/avsAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..ecb5dd55d89e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,165 @@ +{ + "title": "AvsAssessmentsOperations_Create", + "operationId": "AvsAssessmentsOperations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "resource": { + "properties": { + "failuresToTolerateAndRaidLevel": "Ftt1Raid1", + "vcpuOversubscription": 4.0, + "nodeType": "AV36", + "reservedInstance": "RI3Year", + "suitability": "Unknown", + "suitabilityExplanation": "Unknown", + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "isStretchClusterEnabled": true, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "status": "Created", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Ftt1Raid1", + "vcpuOversubscription": 4.0, + "nodeType": "AV36", + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9088.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 10.99, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 46080.0, + "numberOfMachines": 3, + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "CPU", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Ftt1Raid1", + "vcpuOversubscription": 4.0, + "nodeType": "AV36", + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9088.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 10.99, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 46080.0, + "numberOfMachines": 3, + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "CPU", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..817d2f0d96fe --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "AvsAssessmentsOperations_Delete", + "operationId": "AvsAssessmentsOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..3ada159e246c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "AvsAssessmentsOperations_DownloadUrl", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "fagqmlysjfwtt", + "expirationTime": "2023-09-15T07:22:40.818Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..4dfc91c7bdc2 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,74 @@ +{ + "title": "AvsAssessmentsOperations_Get", + "operationId": "AvsAssessmentsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2" + }, + "responses": { + "200": { + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Ftt1Raid1", + "vcpuOversubscription": 4.0, + "nodeType": "AV36", + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9088.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 10.99, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 46080.0, + "numberOfMachines": 3, + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "CPU", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..dc145966021f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,78 @@ +{ + "title": "AvsAssessmentsOperations_ListByGroup", + "operationId": "AvsAssessmentsOperations_ListByGroup", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "failuresToTolerateAndRaidLevel": "Ftt1Raid1", + "vcpuOversubscription": 4.0, + "nodeType": "AV36", + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9088.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 10.99, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 46080.0, + "numberOfMachines": 3, + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "CPU", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..eb5ccf92b1c2 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,244 @@ +{ + "title": "BusinessCaseAvsSummaryOperations_Get", + "operationId": "BusinessCaseAvsSummaryOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "avsSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azureAvsSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "avsNodeSummary": { + "serversSuitableForMigration": 28, + "totalNumberOfServers": 4, + "cores": 17, + "memoryGb": 19, + "avsNodeCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 29, + "osLicensingCost": 18, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedAvsNodeTypeSummary": [ + { + "avsNodeType": "AV36", + "numberOfNodes": 16, + "failuresToTolerateAndRaidLevel": "Ftt1Raid1" + } + ] + }, + "avsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesAvsSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "WindowsOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Microsoft Windows Server 2016 Datacenter", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/avsSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/avsSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..ce3b94c44e85 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,248 @@ +{ + "title": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azureAvsSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "avsNodeSummary": { + "serversSuitableForMigration": 28, + "totalNumberOfServers": 4, + "cores": 17, + "memoryGb": 19, + "avsNodeCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 29, + "osLicensingCost": 18, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedAvsNodeTypeSummary": [ + { + "avsNodeType": "AV36", + "numberOfNodes": 16, + "failuresToTolerateAndRaidLevel": "Ftt1Raid1" + } + ] + }, + "avsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesAvsSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "WindowsOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Microsoft Windows Server 2016 Datacenter", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/avsSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/avsSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..fbc618b78f81 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,291 @@ +{ + "title": "BusinessCaseIaasSummaryOperations_Get", + "operationId": "BusinessCaseIaasSummaryOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "iaasSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azureIaasSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "azureIaasVmSummary": { + "serversSuitableForMigration": 15, + "totalNumberOfServers": 27, + "cores": 6, + "memoryGb": 26, + "azureVmCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 19, + "osLicensingCost": 12, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasSqlSummary": { + "totalSqlEntities": 7, + "suitableSqlEntities": 21, + "azureSqlCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 23, + "osLicensingCost": 8, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesIaasSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "LinuxOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Ubuntu", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/iaasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/iaasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..e018dbe00d97 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,295 @@ +{ + "title": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azureIaasSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "azureIaasVmSummary": { + "serversSuitableForMigration": 15, + "totalNumberOfServers": 27, + "cores": 6, + "memoryGb": 26, + "azureVmCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 19, + "osLicensingCost": 12, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasSqlSummary": { + "totalSqlEntities": 7, + "suitableSqlEntities": 21, + "azureSqlCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 23, + "osLicensingCost": 8, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesIaasSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "LinuxOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Ubuntu", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/iaasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/iaasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..1fa222e9d634 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json @@ -0,0 +1,185 @@ +{ + "title": "Get Compare summary report for Business case.", + "operationId": "BusinessCaseOperations_CompareSummary", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "body": {} + }, + "responses": { + "200": { + "body": { + "azurePaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "azureAvsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesAvsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesAvsDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..1e87991e893f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,392 @@ +{ + "title": "BusinessCaseOperations_Create", + "operationId": "BusinessCaseOperations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "resource": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 17, + "softwareAssuranceCost": 14, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 8, + "basicSupportCost": 22, + "productionSupportCost": 22 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCost": 7 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 6, + "basicSupportCost": 1, + "productionSupportCost": 18 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + } + }, + "state": "InProgress" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 17, + "softwareAssuranceCost": 14, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 8, + "basicSupportCost": 22, + "productionSupportCost": 22 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCost": 7 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 6, + "basicSupportCost": 1, + "productionSupportCost": 18 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 17, + "softwareAssuranceCost": 14, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 8, + "basicSupportCost": 22, + "productionSupportCost": 22 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCost": 7 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 6, + "basicSupportCost": 1, + "productionSupportCost": 18 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..46fe9ae5fe84 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "BusinessCaseOperations_Delete", + "operationId": "BusinessCaseOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..2080ad4b049e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "Get download URL for the business case report.", + "operationId": "BusinessCaseOperations_GetReportDownloadUrl", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "body": {} + }, + "responses": { + "200": { + "body": { + "businessCaseReportUrl": "mxwaejake", + "expirationTime": "2023-11-08T07:10:20.491Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a30079df7d25 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,145 @@ +{ + "title": "BusinessCaseOperations_Get", + "operationId": "BusinessCaseOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 52, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-10-05T11:57:41.237Z", + "performanceDataEndTime": "2023-10-05T11:57:41.237Z", + "comfortFactor": 8, + "performanceUtilizationPercentile": 64, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 44, + "wacc": 5, + "networkCostPercentage": 71, + "iaasLaborCostPercentage": 73, + "paasLaborCostPercentage": 50, + "avsLaborCostPercentage": 69, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 5, + "price": 14, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 14, + "softwareAssuranceCost": 13 + } + ], + "windowsServerLicensing": { + "licenseCost": 13, + "softwareAssuranceCost": 14, + "licensesPerCore": 8 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 11, + "softwareAssuranceCost": 28, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 16, + "basicSupportCost": 7, + "productionSupportCost": 25 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 15, + "maintainanceCostPercentageToAcquisitionCost": 91 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 79, + "maintenanceCostPercentage": 82 + }, + "facilitySettings": { + "facilitiesCost": 12 + }, + "laborSettings": { + "physicalServersPerAdmin": 30, + "virtualMachinesPerAdmin": 1, + "hourlyAdminCost": 15 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 2, + "sqlServerSecurityCostPerServerPerYear": 23 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 21, + "softwareAssuranceCost": 1, + "licenseAndSupportList": [ + { + "licenseCost": 12, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 9, + "basicSupportCost": 11, + "productionSupportCost": 24 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 6, + "supportCost": 2 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 15, + "patchingCostPerServerPerYear": 15, + "dataProtectionCostPerServerPerYear": 28 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5E8485F1-A440-404E-9F91-AFAC5A9993B2/resourceGroups/rgv2023-04-01-preview/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-10-05T11:57:41.238Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-05T11:57:41.238Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..26dbb083d1c1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,149 @@ +{ + "title": "BusinessCaseOperations_ListByAssessmentProject", + "operationId": "BusinessCaseOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 52, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-10-05T11:57:41.237Z", + "performanceDataEndTime": "2023-10-05T11:57:41.237Z", + "comfortFactor": 8, + "performanceUtilizationPercentile": 64, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 44, + "wacc": 5, + "networkCostPercentage": 71, + "iaasLaborCostPercentage": 73, + "paasLaborCostPercentage": 50, + "avsLaborCostPercentage": 69, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 5, + "price": 14, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 14, + "softwareAssuranceCost": 13 + } + ], + "windowsServerLicensing": { + "licenseCost": 13, + "softwareAssuranceCost": 14, + "licensesPerCore": 8 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 11, + "softwareAssuranceCost": 28, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 16, + "basicSupportCost": 7, + "productionSupportCost": 25 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 15, + "maintainanceCostPercentageToAcquisitionCost": 91 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 79, + "maintenanceCostPercentage": 82 + }, + "facilitySettings": { + "facilitiesCost": 12 + }, + "laborSettings": { + "physicalServersPerAdmin": 30, + "virtualMachinesPerAdmin": 1, + "hourlyAdminCost": 15 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 2, + "sqlServerSecurityCostPerServerPerYear": 23 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 21, + "softwareAssuranceCost": 1, + "licenseAndSupportList": [ + { + "licenseCost": 12, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 9, + "basicSupportCost": 11, + "productionSupportCost": 24 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 6, + "supportCost": 2 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 15, + "patchingCostPerServerPerYear": 15, + "dataProtectionCostPerServerPerYear": 28 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5E8485F1-A440-404E-9F91-AFAC5A9993B2/resourceGroups/rgv2023-04-01-preview/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/businessCase1", + "name": "businessCase1", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-10-05T11:57:41.238Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-05T11:57:41.238Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2e7f2695f8f4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,122 @@ +{ + "title": "BusinessCaseOverviewSummaryOperations_Get", + "operationId": "BusinessCaseOverviewSummaryOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "overviewSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "totalAzureCost": 20, + "totalAzureIaasCost": 29, + "totalAzurePaasCost": 18, + "totalAzureAvsCost": 21, + "windowsAhubSavings": 26, + "sqlAhubSavings": 29, + "totalOnPremisesCost": 20, + "esuSavingsFor4years": 20, + "managementCostSavings": 19, + "securityCostSavings": 8, + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "serversDiscovered": { + "vmWare": 6, + "hyperV": 28, + "physical": 16, + "notApplicable": 13 + }, + "utilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "iaasOsDistribution": { + "windows": 5, + "linux": 22, + "other": 14 + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "paasDistribution": { + "sqlServers": 28, + "iisWebServers": 9, + "webAppDistribution": { + "key683": 28 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/overviewSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/overviewSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..c0e60d54447e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,126 @@ +{ + "title": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "totalAzureCost": 20, + "totalAzureIaasCost": 29, + "totalAzurePaasCost": 18, + "totalAzureAvsCost": 21, + "windowsAhubSavings": 26, + "sqlAhubSavings": 29, + "totalOnPremisesCost": 20, + "esuSavingsFor4years": 20, + "managementCostSavings": 19, + "securityCostSavings": 8, + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "serversDiscovered": { + "vmWare": 6, + "hyperV": 28, + "physical": 16, + "notApplicable": 13 + }, + "utilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "iaasOsDistribution": { + "windows": 5, + "linux": 22, + "other": 14 + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "paasDistribution": { + "sqlServers": 28, + "iisWebServers": 9, + "webAppDistribution": { + "key683": 28 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/overviewSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/overviewSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1a793337b3b8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,252 @@ +{ + "title": "BusinessCasePaasSummaryOperations_Get", + "operationId": "BusinessCasePaasSummaryOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "paasSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azure": { + "totalSqlEntities": 1, + "suitableSqlEntities": 8, + "totalWebApps": 22, + "suitableWebApps": 8, + "cores": 3, + "memory": 29, + "storage": 8, + "estimatedCostByTarget": { + "azureSqlMiCost": 27, + "azureSqlDbCost": 6, + "appServiceCost": 5, + "appServiceContainerCost": 23, + "azureKubernetesServiceCost": 22 + }, + "estimatedSqlServerLicensingCost": 18, + "azureSqlSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "distributionByServiceTier": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlMi": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlDb": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ] + }, + "azureAppServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 6, + "count": 27 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureAppServiceContainerSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureKubernetesServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "totalAzurePaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremises": { + "totalServers": 29, + "cpuUtilization": 18, + "memoryUtilization": 14, + "totalOnPremisesPaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasCostForDecommisioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasLicensingCost": { + "version": null, + "totalCost": 29, + "decomissionServerCost": 1 + }, + "onPremisesSqlSummary": { + "sqlInstances": 26, + "sqlDatabases": 21, + "distributionBySqlVersion": [ + { + "sqlVersion": "SQL Server 2019", + "numberOfInstances": 20 + } + ], + "sqlOnPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionBySqlEdition": [ + { + "type": "Enterprise Edition (64-bit)", + "count": 27 + } + ] + }, + "onPremisesWebAppSummary": { + "numberOfWebServers": 1, + "numberOfWebApplications": 27, + "numberOfWebAppsPerType": { + "key2586": 28 + } + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/paasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/paasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..b7c89f76a53f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,256 @@ +{ + "title": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azure": { + "totalSqlEntities": 1, + "suitableSqlEntities": 8, + "totalWebApps": 22, + "suitableWebApps": 8, + "cores": 3, + "memory": 29, + "storage": 8, + "estimatedCostByTarget": { + "azureSqlMiCost": 27, + "azureSqlDbCost": 6, + "appServiceCost": 5, + "appServiceContainerCost": 23, + "azureKubernetesServiceCost": 22 + }, + "estimatedSqlServerLicensingCost": 18, + "azureSqlSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "distributionByServiceTier": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlMi": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlDb": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ] + }, + "azureAppServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 6, + "count": 27 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureAppServiceContainerSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureKubernetesServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "totalAzurePaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremises": { + "totalServers": 29, + "cpuUtilization": 18, + "memoryUtilization": 14, + "totalOnPremisesPaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasCostForDecommisioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasLicensingCost": { + "version": null, + "totalCost": 29, + "decomissionServerCost": 1 + }, + "onPremisesSqlSummary": { + "sqlInstances": 26, + "sqlDatabases": 21, + "distributionBySqlVersion": [ + { + "sqlVersion": "SQL Server 2019", + "numberOfInstances": 20 + } + ], + "sqlOnPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionBySqlEdition": [ + { + "type": "Enterprise Edition (64-bit)", + "count": 27 + } + ] + }, + "onPremisesWebAppSummary": { + "numberOfWebServers": 1, + "numberOfWebApplications": 27, + "numberOfWebAppsPerType": { + "key2586": 28 + } + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/paasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/paasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..7330813a15f4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "EvaluatedAvsMachinesOperations_Get", + "operationId": "EvaluatedAvsMachinesOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedAvsMachineName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedavsmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedavsmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..be508783f45c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "operationId": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "zcwvgkjkvddoylnfkgclpytp", + "pageSize": 9, + "continuationToken": "er", + "totalRecordCount": 2, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedavsmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedavsmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9ee7fe407ebe --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "EvaluatedMachinesOperations_Get", + "operationId": "EvaluatedMachinesOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedMachineName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..74900a97a681 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "EvaluatedMachinesOperations_ListByBusinessCase", + "operationId": "EvaluatedMachinesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "fyiccra", + "pageSize": 16, + "continuationToken": "mipqzxorbubmdjm", + "totalRecordCount": 28, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..bf8302da89a5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "EvaluatedSqlEntitiesOperations_Get", + "operationId": "EvaluatedSqlEntitiesOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedSqlEntityName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "serverName": "a404-r1w16-1.FPL.COM", + "activityState": "active", + "sqlVersion": null, + "sqlEdition": null, + "recommendedAzureTarget": "AzureVirtualMachine", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "virtualizationType": "Vmware", + "dbCount": 1, + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedsqlentity/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedsqlentity", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..a1f0de29cb02 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "operationId": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "rukrirndrwnypcf", + "pageSize": 13, + "continuationToken": "bqkhzxsvqhnarrffqtgeytrznivh", + "totalRecordCount": 12, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serverName": "a404-r1w16-1.FPL.COM", + "activityState": "active", + "sqlVersion": null, + "sqlEdition": null, + "recommendedAzureTarget": "AzureVirtualMachine", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "virtualizationType": "Vmware", + "dbCount": 1, + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedsqlentity/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedsqlentity", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..7193c47122b0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "EvaluatedWebAppsOperations_Get", + "operationId": "EvaluatedWebAppsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedWebAppName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "recommendedAzureTarget": "AzureVm", + "recommendedAzureSkuName": "Premium_V3", + "recommendedAzureSkuSize": "P1 v3", + "serverName": "a404-r1w16-1.FPL.COM", + "workload": "WebApps", + "activityState": "active", + "readyForMigration": "Ready" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedwebapp/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedwebapp", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..51357cb69c08 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "EvaluatedWebAppsOperations_ListByBusinessCase", + "operationId": "EvaluatedWebAppsOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "pwrvmthelxikwweggf", + "pageSize": 18, + "continuationToken": "oizcutotskmhqxxmpwiqzvzyaubjt", + "totalRecordCount": 2, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "recommendedAzureTarget": "AzureVm", + "recommendedAzureSkuName": "Premium_V3", + "recommendedAzureSkuSize": "P1 v3", + "serverName": "a404-r1w16-1.FPL.COM", + "workload": "WebApps", + "activityState": "active", + "readyForMigration": "Ready" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedwebapp/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedwebapp", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..9186ba491e0d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "title": "GroupsOperations_Create", + "operationId": "GroupsOperations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "resource": { + "properties": { + "groupStatus": "Completed", + "groupType": "Default", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..3c72859d7e6a --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "GroupsOperations_Delete", + "operationId": "GroupsOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..dff71a4ce183 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "GroupsOperations_Get", + "operationId": "GroupsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..5c7ca7a3f391 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "GroupsOperations_ListByAssessmentProject", + "operationId": "GroupsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json new file mode 100644 index 000000000000..e1de5056586c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json @@ -0,0 +1,58 @@ +{ + "title": "Update machines in group.", + "operationId": "GroupsOperations_UpdateMachines", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "body": { + "eTag": "*", + "properties": { + "operationType": "Add", + "machines": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/18895660-c5e5-4247-8cfc-cd24e1fe57f3" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..4aeaf6ccdffc --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "HypervCollectorsOperations_Create", + "operationId": "HypervCollectorsOperations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector", + "resource": { + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..61e96d61fd75 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "HypervCollectorsOperations_Delete", + "operationId": "HypervCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..df9be070c5df --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "HypervCollectorsOperations_Get", + "operationId": "HypervCollectorsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..a62965cbad91 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "HypervCollectorsOperations_ListByAssessmentProject", + "operationId": "HypervCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..119cfbae63ad --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,62 @@ +{ + "title": "ImportCollectorsOperations_Create", + "operationId": "ImportCollectorsOperations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5", + "resource": { + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..63f7449666aa --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "ImportCollectorsOperations_Delete", + "operationId": "ImportCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6c9b4708b5c3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "ImportCollectorsOperations_Get", + "operationId": "ImportCollectorsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..07c4c4b32364 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "ImportCollectorsOperations_ListByAssessmentProject", + "operationId": "ImportCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2af7b0c6e96f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "MachinesOperations_Get", + "operationId": "MachinesOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "machineName": "55082b89-99e2-4c40-b63f-d4f4d6ba961d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "name": "55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/machines", + "properties": { + "workloadSummary": { + "oracleInstances": 0, + "springApps": 0 + }, + "errors": [], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "hostProcessor": null, + "discoveryMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app48697site/machines/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17_50379cec-8534-dcd7-0c7e-b16f6572bf94", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app48697site/vcenters/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17", + "datacenterManagementServerName": "idclab-vcen65.fareast.corp.microsoft.com", + "bootType": "BIOS", + "displayName": "a410-r1w12r2-7", + "megabytesOfMemory": 30720.0, + "numberOfCores": 8, + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2012 (64-bit)", + "operatingSystemVersion": null, + "description": "", + "createdTimestamp": "2021-08-31T14:31:19.465845Z", + "disks": { + "6000C29d-4e28-24a9-eaee-02fa5a17dadf": { + "gigabytesAllocated": 150.0, + "displayName": "scsi0:0" + }, + "6000C297-a876-f49f-c202-0289620d5223": { + "gigabytesAllocated": 250.0, + "displayName": "scsi0:1" + }, + "6000C295-4e9d-4322-6690-aff91beffb82": { + "gigabytesAllocated": 50.0, + "displayName": "scsi0:2" + } + }, + "groups": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/azure-vmwaresolution-ame-15389", + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/rajoshtest" + ], + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:b7:04:06", + "ipAddresses": [], + "displayName": "VM Network" + } + }, + "sqlInstances": [], + "webApplications": [], + "updatedTimestamp": "2023-08-03T16:22:11.2610571Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..1f1a41a90dba --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "MachinesOperations_ListByAssessmentProject", + "operationId": "MachinesOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "$filter": null, + "pageSize": 1, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "name": "55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/machines", + "properties": { + "workloadSummary": { + "oracleInstances": 0, + "springApps": 0 + }, + "errors": [], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "hostProcessor": null, + "discoveryMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app48697site/machines/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17_50379cec-8534-dcd7-0c7e-b16f6572bf94", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app48697site/vcenters/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17", + "datacenterManagementServerName": "idclab-vcen65.fareast.corp.microsoft.com", + "bootType": "BIOS", + "displayName": "a410-r1w12r2-7", + "megabytesOfMemory": 30720.0, + "numberOfCores": 8, + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2012 (64-bit)", + "operatingSystemVersion": null, + "description": "", + "createdTimestamp": "2021-08-31T14:31:19.465845Z", + "disks": { + "6000C29d-4e28-24a9-eaee-02fa5a17dadf": { + "gigabytesAllocated": 150.0, + "displayName": "scsi0:0" + }, + "6000C297-a876-f49f-c202-0289620d5223": { + "gigabytesAllocated": 250.0, + "displayName": "scsi0:1" + }, + "6000C295-4e9d-4322-6690-aff91beffb82": { + "gigabytesAllocated": 50.0, + "displayName": "scsi0:2" + } + }, + "groups": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/azure-vmwaresolution-ame-15389", + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/rajoshtest" + ], + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:b7:04:06", + "ipAddresses": [], + "displayName": "VM Network" + } + }, + "sqlInstances": [], + "webApplications": [], + "updatedTimestamp": "2023-08-03T16:22:11.2610571Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb1c11a7f7e7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AksAssessmentOperations_Get", + "isDataAction": true, + "display": { + "provider": "Microsoft.Migrate", + "resource": "AKSAssessment", + "operation": "GET", + "description": "AKSAssessment" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..1dd8b70d514c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "PrivateEndpointConnectionOperations_Delete", + "operationId": "PrivateEndpointConnectionOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..510b6c54d5e1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "PrivateEndpointConnectionOperations_Get", + "operationId": "PrivateEndpointConnectionOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..2b83f2e50313 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "operationId": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/avol" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..ef431be9a1a7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "PrivateEndpointConnectionOperations_Update", + "operationId": "PrivateEndpointConnectionOperations_Update", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "resource": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..3422e10a7a9b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "PrivateLinkResourceOperations_Get", + "operationId": "PrivateLinkResourceOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateLinkResourceName": "Default" + }, + "responses": { + "200": { + "body": { + "properties": { + "requiredMembers": [ + "CollectorAgent" + ], + "requiredZoneNames": [ + "privatelink.test.migration.windowsazure.com" + ], + "groupId": "Default" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateLinkResources/Default", + "name": "Default", + "type": "Microsoft.Migrate/assessmentprojects/privateLinkResources", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..a64f29282267 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinkResourceOperations_ListByAssessmentProject", + "operationId": "PrivateLinkResourceOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "requiredMembers": [ + "CollectorAgent" + ], + "requiredZoneNames": [ + "privatelink.test.migration.windowsazure.com" + ], + "groupId": "Default" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateLinkResources/Default", + "name": "Default", + "type": "Microsoft.Migrate/assessmentprojects/privateLinkResources", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcd" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..a45e8c9d7fcd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "ServerCollectorsOperations_Create", + "operationId": "ServerCollectorsOperations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector", + "resource": { + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..c475e45ecae0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "ServerCollectorsOperations_Delete", + "operationId": "ServerCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8918eba62da0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "ServerCollectorsOperations_Get", + "operationId": "ServerCollectorsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..90842dc22ca8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "ServerCollectorsOperations_ListByAssessmentProject", + "operationId": "ServerCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9ee38ba94439 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,1635 @@ +{ + "title": "SqlAssessmentOptionsOperations_Get", + "operationId": "SqlAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.Migrate/assessmentprojects/sqlAssessmentOptions", + "systemData": { + "createdAt": "2023-09-25T10:16:46.5581628Z", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "2023-09-25T10:16:46.5581628Z", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "vmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Edsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral" + ], + "savingsPlanSupportedLocationsForPaas": [], + "reservedInstanceSupportedLocationsForIaas": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "savingsPlanSupportedOffers": [ + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "sqlSkus": [ + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "NorwayWest", + "CanadaCentral", + "CanadaEast", + "GermanyNorth", + "SouthAfricaWest", + "EastAsia", + "NorwayEast", + "WestUs2", + "SouthIndia", + "EastUs", + "SouthCentralUs", + "UAENorth", + "AustraliaSoutheast", + "PolandCentral", + "KoreaCentral", + "UkWest", + "SwitzerlandNorth", + "NorthCentralUs", + "SoutheastAsia", + "BrazilSouth", + "FranceSouth", + "SwitzerlandWest", + "SwedenCentral", + "WestUs", + "AustraliaCentral2", + "NorthEurope", + "WestIndia", + "FranceCentral", + "ItalyNorth", + "KoreaSouth", + "GermanyWestCentral", + "JapanEast", + "WestEurope", + "WestCentralUs", + "SouthAfricaNorth", + "AustraliaCentral", + "UAECentral", + "UkSouth", + "JapanWest", + "CentralIndia", + "EastUs2", + "AustraliaEast", + "CentralUs", + "QatarCentral", + "ChinaNorth2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "AustraliaEast", + "SoutheastAsia", + "WestIndia", + "CanadaEast", + "NorthEurope", + "UAENorth", + "SouthAfricaNorth", + "EastUs", + "NorthCentralUs", + "BrazilSouth", + "WestCentralUs", + "UAECentral", + "CanadaCentral", + "JapanEast", + "CentralUs", + "FranceSouth", + "ItalyNorth", + "SouthCentralUs", + "UkWest", + "NorwayEast", + "FranceCentral", + "CentralIndia", + "AustraliaCentral2", + "EastAsia", + "WestUs", + "SouthAfricaWest", + "SwitzerlandWest", + "QatarCentral", + "AustraliaSoutheast", + "WestUs2", + "KoreaSouth", + "NorwayWest", + "GermanyWestCentral", + "JapanWest", + "UkSouth", + "WestEurope", + "KoreaCentral", + "EastUs2", + "SwedenCentral", + "AustraliaCentral", + "SouthIndia", + "GermanyNorth", + "SwitzerlandNorth", + "PolandCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth", + "ChinaNorth2", + "USGovIowa", + "USGovVirginia", + "USGovArizona", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeriesMemoryOptimized", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "UAECentral", + "FranceSouth", + "SwitzerlandNorth", + "CentralIndia", + "NorthEurope", + "SwedenCentral", + "WestCentralUs", + "CanadaEast", + "AustraliaSoutheast", + "EastAsia", + "UAENorth", + "SwitzerlandWest", + "BrazilSouth", + "EastUs2", + "GermanyWestCentral", + "FranceCentral", + "WestUs", + "AustraliaCentral", + "NorwayWest", + "QatarCentral", + "WestUs2", + "UkWest", + "KoreaSouth", + "JapanWest", + "CanadaCentral", + "SoutheastAsia", + "PolandCentral", + "KoreaCentral", + "SouthCentralUs", + "GermanyNorth", + "ItalyNorth", + "EastUs", + "SouthAfricaWest", + "CentralUs", + "AustraliaEast", + "NorwayEast", + "WestEurope", + "WestIndia", + "NorthCentralUs", + "UkSouth", + "AustraliaCentral2", + "SouthAfricaNorth", + "JapanEast", + "SouthIndia", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeries", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "CentralIndia", + "AustraliaCentral", + "UAENorth", + "KoreaCentral", + "UAECentral", + "AustraliaSoutheast", + "SoutheastAsia", + "ItalyNorth", + "AustraliaEast", + "WestUs2", + "AustraliaCentral2", + "BrazilSouth", + "FranceSouth", + "JapanEast", + "NorthCentralUs", + "NorthEurope", + "PolandCentral", + "NorwayWest", + "UkSouth", + "SouthAfricaNorth", + "CanadaEast", + "WestIndia", + "GermanyWestCentral", + "NorwayEast", + "SwitzerlandWest", + "KoreaSouth", + "SwedenCentral", + "JapanWest", + "CentralUs", + "QatarCentral", + "WestEurope", + "CanadaCentral", + "SouthIndia", + "GermanyNorth", + "WestCentralUs", + "EastUs", + "SwitzerlandNorth", + "FranceCentral", + "SouthAfricaWest", + "UkWest", + "WestUs", + "SouthCentralUs", + "EastUs2", + "EastAsia", + "ChinaNorth2", + "ChinaEast2", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "EastUs2", + "SouthCentralUs", + "GermanyWestCentral", + "AustraliaCentral", + "SouthAfricaWest", + "GermanyNorth", + "CanadaEast", + "WestUs", + "WestUs2", + "CanadaCentral", + "SouthAfricaNorth", + "FranceCentral", + "CentralUs", + "NorwayEast", + "JapanEast", + "UkWest", + "WestCentralUs", + "FranceSouth", + "BrazilSouth", + "KoreaSouth", + "EastAsia", + "UAENorth", + "CentralIndia", + "NorthEurope", + "AustraliaEast", + "KoreaCentral", + "SwitzerlandNorth", + "SwedenCentral", + "WestEurope", + "AustraliaCentral2", + "EastUs", + "PolandCentral", + "NorthCentralUs", + "UAECentral", + "ItalyNorth", + "SouthIndia", + "WestIndia", + "SoutheastAsia", + "AustraliaSoutheast", + "NorwayWest", + "JapanWest", + "SwitzerlandWest", + "QatarCentral", + "UkSouth", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "ChinaEast", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "PolandCentral", + "JapanEast", + "SoutheastAsia", + "GermanyNorth", + "AustraliaCentral", + "UAECentral", + "GermanyWestCentral", + "NorwayWest", + "NorwayEast", + "AustraliaCentral2", + "SwitzerlandNorth", + "UAENorth", + "FranceSouth", + "BrazilSouth", + "CanadaEast", + "EastUs2", + "WestEurope", + "JapanWest", + "WestUs2", + "FranceCentral", + "WestIndia", + "SouthCentralUs", + "KoreaSouth", + "NorthEurope", + "SouthAfricaWest", + "SouthAfricaNorth", + "EastAsia", + "EastUs", + "ItalyNorth", + "SwedenCentral", + "KoreaCentral", + "AustraliaSoutheast", + "QatarCentral", + "CentralIndia", + "CanadaCentral", + "CentralUs", + "AustraliaEast", + "NorthCentralUs", + "WestCentralUs", + "SouthIndia", + "WestUs", + "UkSouth", + "SwitzerlandWest", + "UkWest", + "ChinaEast", + "ChinaNorth2", + "ChinaEast2", + "ChinaNorth", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "NorwayWest", + "NorthEurope", + "GermanyNorth", + "KoreaSouth", + "EastUs2", + "CentralIndia", + "SoutheastAsia", + "SwedenCentral", + "WestUs", + "JapanEast", + "WestEurope", + "AustraliaEast", + "SouthAfricaNorth", + "UkSouth", + "UAENorth", + "NorthCentralUs", + "SouthAfricaWest", + "CanadaEast", + "UkWest", + "CentralUs", + "SouthCentralUs", + "WestUs2", + "NorwayEast", + "JapanWest", + "PolandCentral", + "WestCentralUs", + "EastAsia", + "SouthIndia", + "ItalyNorth", + "QatarCentral", + "FranceCentral", + "CanadaCentral", + "SwitzerlandWest", + "UAECentral", + "AustraliaCentral", + "SwitzerlandNorth", + "KoreaCentral", + "WestIndia", + "BrazilSouth", + "EastUs", + "FranceSouth", + "AustraliaCentral2", + "AustraliaSoutheast", + "GermanyWestCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + } + ], + "reservedInstanceSqlTargets": [ + "AzureSqlDatabase", + "AzureSqlManagedInstance" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "supportedOffers": [ + "MSAZR0003P" + ] + }, + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlAssessmentOptions/default" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..254770ccb0b2 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,1639 @@ +{ + "title": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Migrate/assessmentprojects/sqlAssessmentOptions", + "systemData": { + "createdAt": "2023-09-25T10:16:46.5581628Z", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "2023-09-25T10:16:46.5581628Z", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "vmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Edsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral" + ], + "savingsPlanSupportedLocationsForPaas": [], + "reservedInstanceSupportedLocationsForIaas": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "savingsPlanSupportedOffers": [ + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "sqlSkus": [ + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "NorwayWest", + "CanadaCentral", + "CanadaEast", + "GermanyNorth", + "SouthAfricaWest", + "EastAsia", + "NorwayEast", + "WestUs2", + "SouthIndia", + "EastUs", + "SouthCentralUs", + "UAENorth", + "AustraliaSoutheast", + "PolandCentral", + "KoreaCentral", + "UkWest", + "SwitzerlandNorth", + "NorthCentralUs", + "SoutheastAsia", + "BrazilSouth", + "FranceSouth", + "SwitzerlandWest", + "SwedenCentral", + "WestUs", + "AustraliaCentral2", + "NorthEurope", + "WestIndia", + "FranceCentral", + "ItalyNorth", + "KoreaSouth", + "GermanyWestCentral", + "JapanEast", + "WestEurope", + "WestCentralUs", + "SouthAfricaNorth", + "AustraliaCentral", + "UAECentral", + "UkSouth", + "JapanWest", + "CentralIndia", + "EastUs2", + "AustraliaEast", + "CentralUs", + "QatarCentral", + "ChinaNorth2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "AustraliaEast", + "SoutheastAsia", + "WestIndia", + "CanadaEast", + "NorthEurope", + "UAENorth", + "SouthAfricaNorth", + "EastUs", + "NorthCentralUs", + "BrazilSouth", + "WestCentralUs", + "UAECentral", + "CanadaCentral", + "JapanEast", + "CentralUs", + "FranceSouth", + "ItalyNorth", + "SouthCentralUs", + "UkWest", + "NorwayEast", + "FranceCentral", + "CentralIndia", + "AustraliaCentral2", + "EastAsia", + "WestUs", + "SouthAfricaWest", + "SwitzerlandWest", + "QatarCentral", + "AustraliaSoutheast", + "WestUs2", + "KoreaSouth", + "NorwayWest", + "GermanyWestCentral", + "JapanWest", + "UkSouth", + "WestEurope", + "KoreaCentral", + "EastUs2", + "SwedenCentral", + "AustraliaCentral", + "SouthIndia", + "GermanyNorth", + "SwitzerlandNorth", + "PolandCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth", + "ChinaNorth2", + "USGovIowa", + "USGovVirginia", + "USGovArizona", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeriesMemoryOptimized", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "UAECentral", + "FranceSouth", + "SwitzerlandNorth", + "CentralIndia", + "NorthEurope", + "SwedenCentral", + "WestCentralUs", + "CanadaEast", + "AustraliaSoutheast", + "EastAsia", + "UAENorth", + "SwitzerlandWest", + "BrazilSouth", + "EastUs2", + "GermanyWestCentral", + "FranceCentral", + "WestUs", + "AustraliaCentral", + "NorwayWest", + "QatarCentral", + "WestUs2", + "UkWest", + "KoreaSouth", + "JapanWest", + "CanadaCentral", + "SoutheastAsia", + "PolandCentral", + "KoreaCentral", + "SouthCentralUs", + "GermanyNorth", + "ItalyNorth", + "EastUs", + "SouthAfricaWest", + "CentralUs", + "AustraliaEast", + "NorwayEast", + "WestEurope", + "WestIndia", + "NorthCentralUs", + "UkSouth", + "AustraliaCentral2", + "SouthAfricaNorth", + "JapanEast", + "SouthIndia", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeries", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "CentralIndia", + "AustraliaCentral", + "UAENorth", + "KoreaCentral", + "UAECentral", + "AustraliaSoutheast", + "SoutheastAsia", + "ItalyNorth", + "AustraliaEast", + "WestUs2", + "AustraliaCentral2", + "BrazilSouth", + "FranceSouth", + "JapanEast", + "NorthCentralUs", + "NorthEurope", + "PolandCentral", + "NorwayWest", + "UkSouth", + "SouthAfricaNorth", + "CanadaEast", + "WestIndia", + "GermanyWestCentral", + "NorwayEast", + "SwitzerlandWest", + "KoreaSouth", + "SwedenCentral", + "JapanWest", + "CentralUs", + "QatarCentral", + "WestEurope", + "CanadaCentral", + "SouthIndia", + "GermanyNorth", + "WestCentralUs", + "EastUs", + "SwitzerlandNorth", + "FranceCentral", + "SouthAfricaWest", + "UkWest", + "WestUs", + "SouthCentralUs", + "EastUs2", + "EastAsia", + "ChinaNorth2", + "ChinaEast2", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "EastUs2", + "SouthCentralUs", + "GermanyWestCentral", + "AustraliaCentral", + "SouthAfricaWest", + "GermanyNorth", + "CanadaEast", + "WestUs", + "WestUs2", + "CanadaCentral", + "SouthAfricaNorth", + "FranceCentral", + "CentralUs", + "NorwayEast", + "JapanEast", + "UkWest", + "WestCentralUs", + "FranceSouth", + "BrazilSouth", + "KoreaSouth", + "EastAsia", + "UAENorth", + "CentralIndia", + "NorthEurope", + "AustraliaEast", + "KoreaCentral", + "SwitzerlandNorth", + "SwedenCentral", + "WestEurope", + "AustraliaCentral2", + "EastUs", + "PolandCentral", + "NorthCentralUs", + "UAECentral", + "ItalyNorth", + "SouthIndia", + "WestIndia", + "SoutheastAsia", + "AustraliaSoutheast", + "NorwayWest", + "JapanWest", + "SwitzerlandWest", + "QatarCentral", + "UkSouth", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "ChinaEast", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "PolandCentral", + "JapanEast", + "SoutheastAsia", + "GermanyNorth", + "AustraliaCentral", + "UAECentral", + "GermanyWestCentral", + "NorwayWest", + "NorwayEast", + "AustraliaCentral2", + "SwitzerlandNorth", + "UAENorth", + "FranceSouth", + "BrazilSouth", + "CanadaEast", + "EastUs2", + "WestEurope", + "JapanWest", + "WestUs2", + "FranceCentral", + "WestIndia", + "SouthCentralUs", + "KoreaSouth", + "NorthEurope", + "SouthAfricaWest", + "SouthAfricaNorth", + "EastAsia", + "EastUs", + "ItalyNorth", + "SwedenCentral", + "KoreaCentral", + "AustraliaSoutheast", + "QatarCentral", + "CentralIndia", + "CanadaCentral", + "CentralUs", + "AustraliaEast", + "NorthCentralUs", + "WestCentralUs", + "SouthIndia", + "WestUs", + "UkSouth", + "SwitzerlandWest", + "UkWest", + "ChinaEast", + "ChinaNorth2", + "ChinaEast2", + "ChinaNorth", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "NorwayWest", + "NorthEurope", + "GermanyNorth", + "KoreaSouth", + "EastUs2", + "CentralIndia", + "SoutheastAsia", + "SwedenCentral", + "WestUs", + "JapanEast", + "WestEurope", + "AustraliaEast", + "SouthAfricaNorth", + "UkSouth", + "UAENorth", + "NorthCentralUs", + "SouthAfricaWest", + "CanadaEast", + "UkWest", + "CentralUs", + "SouthCentralUs", + "WestUs2", + "NorwayEast", + "JapanWest", + "PolandCentral", + "WestCentralUs", + "EastAsia", + "SouthIndia", + "ItalyNorth", + "QatarCentral", + "FranceCentral", + "CanadaCentral", + "SwitzerlandWest", + "UAECentral", + "AustraliaCentral", + "SwitzerlandNorth", + "KoreaCentral", + "WestIndia", + "BrazilSouth", + "EastUs", + "FranceSouth", + "AustraliaCentral2", + "AustraliaSoutheast", + "GermanyWestCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + } + ], + "reservedInstanceSqlTargets": [ + "AzureSqlDatabase", + "AzureSqlManagedInstance" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "supportedOffers": [ + "MSAZR0003P" + ] + }, + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlAssessmentOptions/default" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..2f28ace87a2c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json @@ -0,0 +1,219 @@ +{ + "title": "SqlAssessmentV2Operations_Create", + "operationId": "SqlAssessmentV2Operations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "resource": { + "properties": { + "entityUptime": { + "daysPerMonth": 30, + "hoursPerDay": 24 + }, + "osLicense": "Unknown", + "optimizationLogic": "MinimizeCost", + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Automatic", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Eadsv5_series" + ] + }, + "environmentType": "Production", + "reservedInstance": "None", + "reservedInstanceForVm": "None", + "sqlServerLicense": "Unknown", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "azureOfferCodeForVm": "MSAZR0003P", + "currency": "USD", + "percentile": "Percentile95", + "scalingFactor": 1, + "timeRange": "Day", + "discountPercentage": 0, + "sizingCriterion": "PerformanceBased", + "multiSubnetIntent": "DisasterRecovery", + "asyncCommitModeIntent": "DisasterRecovery", + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..0eb97cae68e7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "SqlAssessmentV2Operations_Delete", + "operationId": "SqlAssessmentV2Operations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..3eb9d2263d2b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "SqlAssessmentV2Operations_DownloadUrl", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "fagqmlysjfwtt", + "expirationTime": "2023-09-15T07:22:40.818Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..092255cb87aa --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,94 @@ +{ + "title": "SqlAssessmentV2Operations_Get", + "operationId": "SqlAssessmentV2Operations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..f91f357d4c28 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,254 @@ +{ + "title": "SqlAssessmentV2Operations_ListByGroup", + "operationId": "SqlAssessmentV2Operations_ListByGroup", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_assmt_hadr_1", + "name": "test_assmt_hadr_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-02-16T16:14:03.477007Z", + "perfDataEndTime": "2023-02-17T16:14:03.477007Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2022-12-20T00:00:00Z", + "createdTimestamp": "2023-01-04T14:17:43.1744405Z", + "updatedTimestamp": "2023-02-17T16:16:25.1524275Z", + "status": "Completed", + "schemaVersion": "2.0" + } + }, + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_assmt_hadr_2", + "name": "test_assmt_hadr_2", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-06T07:47:29.6769501Z", + "perfDataEndTime": "2023-09-07T07:47:29.6769501Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-07T07:47:29.6925964Z", + "updatedTimestamp": "2023-09-07T07:49:26.5732595Z", + "status": "Completed", + "schemaVersion": "2.0" + } + }, + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..522a0b0be00b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,128 @@ +{ + "title": "SqlAssessmentV2SummaryOperations_Get", + "operationId": "SqlAssessmentV2SummaryOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "summaryName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/summaries/default", + "name": "default", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/summaries", + "properties": { + "assessmentSummary": { + "azureSqlManagedInstance": { + "suitabilitySummary": { + "notSuitable": 7, + "readinessUnknown": 15, + "suitableForSqlMI": 1 + }, + "monthlyComputeCost": 4581.992448, + "monthlyStorageCost": 0.0, + "monthlyLicenseCost": 6568.5107999999991, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlVirtualMachine": { + "suitabilitySummary": { + "suitableForSqlVM": 21, + "readinessUnknown": 2 + }, + "monthlyComputeCost": 889.49663999999962, + "monthlyStorageCost": 73.943999999999988, + "monthlyLicenseCost": 25281.36, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlDatabase": { + "suitabilitySummary": { + "readinessUnknown": 1468, + "suitableForSqlDB": 16 + }, + "monthlyComputeCost": 175079.07398399821, + "monthlyStorageCost": 1054.8825000000395, + "monthlyLicenseCost": 214401.07883999476, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureVirtualMachine": { + "suitabilitySummary": { + "suitableForVM": 19 + }, + "monthlyComputeCost": 625.94207999999981, + "monthlyStorageCost": 374.48999999999995, + "monthlyLicenseCost": 1300.5120000000002, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "recommended": { + "suitabilitySummary": { + "suitableForSqlVM": 19, + "suitableForVM": 4 + }, + "monthlyComputeCost": 823.60799999999972, + "monthlyStorageCost": 100.88400000000002, + "monthlyLicenseCost": 22912.896, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + } + }, + "distributionBySupportStatus": { + "extended": 11, + "outOfSupport": 9, + "mainstream": 3 + }, + "distributionByServicePackInsight": { + "unknown": 23 + }, + "distributionBySqlVersion": { + "sql Server 2014": 4, + "sql Server 2012": 9, + "sql Server 2019": 3, + "sql Server 2016": 5, + "sql Server 2017": 2 + }, + "distributionBySqlEdition": { + "enterprise Edition: Core-based Licensing (64-bit)": 15, + "web Edition": 1, + "express Edition (64-bit)": 2, + "enterprise Evaluation Edition (64-bit)": 1, + "enterprise Edition: Core-based Licensing": 1, + "enterprise Edition (64-bit)": 1, + "standard Edition (64-bit)": 2 + }, + "instanceDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 23 + }, + "databaseDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 1484 + }, + "numberOfMachines": 19, + "numberOfSqlInstances": 23, + "numberOfSqlDatabases": 1484, + "numberOfFciInstances": 4, + "numberOfSqlAvailabilityGroups": 5 + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..85e3ffb470c8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,132 @@ +{ + "title": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "operationId": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/summaries/default", + "name": "default", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/summaries", + "properties": { + "assessmentSummary": { + "azureSqlManagedInstance": { + "suitabilitySummary": { + "notSuitable": 7, + "readinessUnknown": 15, + "suitableForSqlMI": 1 + }, + "monthlyComputeCost": 4581.992448, + "monthlyStorageCost": 0.0, + "monthlyLicenseCost": 6568.5107999999991, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlVirtualMachine": { + "suitabilitySummary": { + "suitableForSqlVM": 21, + "readinessUnknown": 2 + }, + "monthlyComputeCost": 889.49663999999962, + "monthlyStorageCost": 73.943999999999988, + "monthlyLicenseCost": 25281.36, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlDatabase": { + "suitabilitySummary": { + "readinessUnknown": 1468, + "suitableForSqlDB": 16 + }, + "monthlyComputeCost": 175079.07398399821, + "monthlyStorageCost": 1054.8825000000395, + "monthlyLicenseCost": 214401.07883999476, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureVirtualMachine": { + "suitabilitySummary": { + "suitableForVM": 19 + }, + "monthlyComputeCost": 625.94207999999981, + "monthlyStorageCost": 374.48999999999995, + "monthlyLicenseCost": 1300.5120000000002, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "recommended": { + "suitabilitySummary": { + "suitableForSqlVM": 19, + "suitableForVM": 4 + }, + "monthlyComputeCost": 823.60799999999972, + "monthlyStorageCost": 100.88400000000002, + "monthlyLicenseCost": 22912.896, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + } + }, + "distributionBySupportStatus": { + "extended": 11, + "outOfSupport": 9, + "mainstream": 3 + }, + "distributionByServicePackInsight": { + "unknown": 23 + }, + "distributionBySqlVersion": { + "sql Server 2014": 4, + "sql Server 2012": 9, + "sql Server 2019": 3, + "sql Server 2016": 5, + "sql Server 2017": 2 + }, + "distributionBySqlEdition": { + "enterprise Edition: Core-based Licensing (64-bit)": 15, + "web Edition": 1, + "express Edition (64-bit)": 2, + "enterprise Evaluation Edition (64-bit)": 1, + "enterprise Edition: Core-based Licensing": 1, + "enterprise Edition (64-bit)": 1, + "standard Edition (64-bit)": 2 + }, + "instanceDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 23 + }, + "databaseDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 1484 + }, + "numberOfMachines": 19, + "numberOfSqlInstances": 23, + "numberOfSqlDatabases": 1484, + "numberOfFciInstances": 4, + "numberOfSqlAvailabilityGroups": 5 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..fa16a3eb534b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "SqlCollectorOperations_Create", + "operationId": "SqlCollectorOperations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector", + "resource": { + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..7c4ebf564d74 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "SqlCollectorOperations_Delete", + "operationId": "SqlCollectorOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..fb86237d4622 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "SqlCollectorOperations_Get", + "operationId": "SqlCollectorOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..0fdb8e3304d5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "SqlCollectorOperations_ListByAssessmentProject", + "operationId": "SqlCollectorOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlcollectors/fci-ankit-test0c1esqlsitecollector", + "name": "fci-ankit-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..9b8adcec6297 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "VmwareCollectorsOperations_Create", + "operationId": "VmwareCollectorsOperations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector", + "resource": { + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..98c8a30c40db --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "VmwareCollectorsOperations_Delete", + "operationId": "VmwareCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..066b6b92c10f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "VmwareCollectorsOperations_Get", + "operationId": "VmwareCollectorsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..5f34ef1d39a5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "VmwareCollectorsOperations_ListByAssessmentProject", + "operationId": "VmwareCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..3821751989c4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,56 @@ +{ + "title": "WebAppAssessmentOptionsOperations_Get", + "operationId": "WebAppAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppSkus": [ + { + "webAppTier": "Premium_V3", + "targetLocations": [ + "WestEurope" + ] + } + ], + "savingsPlanSupportedLocations": [ + "WestEurope" + ], + "reservedInstanceSupportedLocations": [ + "WestEurope" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ], + "reservedInstanceSupportedWebAppTiers": [ + "Premium_V3" + ], + "savingsPlanSupportedWebAppTiers": [ + "Premium_V3" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webAppAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/webAppAssessmentOptions", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..67d495d722c8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "92EA264C-A8A7-4192-A5E5-D9B487409240", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppSkus": [ + { + "webAppTier": "Premium_V3", + "targetLocations": [ + "PolandCentral" + ] + } + ], + "savingsPlanSupportedLocations": [ + "Unknown" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaSoutheast" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ], + "reservedInstanceSupportedWebAppTiers": [ + "Premium_V3" + ], + "savingsPlanSupportedWebAppTiers": [ + "Premium_V3" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webAppAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/webAppAssessmentOptions", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-06T05:40:17.507Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-06T05:40:17.507Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..8d8c495f9d11 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json @@ -0,0 +1,167 @@ +{ + "title": "WebAppAssessmentV2Operations_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "resource": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "status": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-v2-test", + "name": "anraghun-v2-test", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": "eatnpvdxza", + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": "rnfkzoaidy", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-v2-test", + "name": "anraghun-v2-test", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": "eatnpvdxza", + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": "rnfkzoaidy", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..3a77e4d366ec --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "WebAppAssessmentV2Operations_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..c7de56b2d67d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_DownloadUrl", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "https://assessmentsrvcanccysa2.blob.core.windows.net/cc1325ff-d42f-4c45-bfb6-12069e45becb/anraghun-selfhost-v2anraghun-v2-testWebAppAssessment.xlsx?sv=2018-03-28&sr=b&sig=NYBG6gJmofvIQsk1K1tewWfX51BpFZWsvIy7gBXNYUE%3D&st=2023-11-03T05%3A51%3A39Z&se=2023-11-03T06%3A26%3A39Z&sp=r", + "expirationTime": "2023-11-03T05:42:09.465Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..bed8ff60fa2d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "title": "WebAppAssessmentV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-v2-test" + }, + "responses": { + "200": { + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "Unknown", + "currency": "MSAZR0003P", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2", + "name": "anraghun-selfhost-v2", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..c34a8674c948 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,74 @@ +{ + "title": "WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_ListByGroup", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2", + "name": "anraghun-selfhost-v2", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..646dcbaf3ceb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2SummaryOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "summaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentSummary": { + "discoveredEntitiesSummary": { + "numberOfServers": 15, + "numberOfWebApps": 6, + "numberOfMachines": 24, + "webServerSummary": { + "iis": 13 + }, + "webAppSummary": { + "iis": 30 + } + } + }, + "targetSpecificSummary": { + "azureAppService": { + "readinessSummary": { + "suitable": 13 + }, + "recommendationResultSkuDetails": { + "isolated": { + "totalMonthlyCost": 21, + "monthlySecurityCost": 3, + "skuName": "Isolated", + "skuSize": "I1", + "appServicePlanCount": 4 + } + } + } + } + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/summaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..fcb2e908e0a6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "assessmentSummary": { + "discoveredEntitiesSummary": { + "numberOfServers": 15, + "numberOfWebApps": 6, + "numberOfMachines": 24, + "webServerSummary": { + "iis": 13 + }, + "webAppSummary": { + "iis": 30 + } + } + }, + "targetSpecificSummary": { + "azureAppService": { + "readinessSummary": { + "conditionallySuitable": 13 + }, + "recommendationResultSkuDetails": { + "isolated": { + "totalMonthlyCost": 584, + "monthlySecurityCost": 0, + "skuName": "Isolated", + "skuSize": "I1", + "appServicePlanCount": 2 + } + } + } + } + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/summaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/anxenhw" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..3b6096388bba --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,99 @@ +{ + "title": "WebAppCollectorOperations_Create", + "operationId": "WebAppCollectorOperations_Create", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1", + "resource": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3912168173e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "WebAppCollectorOperations_Delete", + "operationId": "WebAppCollectorOperations_Delete", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f4e69a471654 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "WebAppCollectorOperations_Get", + "operationId": "WebAppCollectorOperations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1" + }, + "responses": { + "200": { + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..bf92d79f9a8b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "WebAppCollectorOperations_ListByAssessmentProject", + "operationId": "WebAppCollectorOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "agentProperties": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..faa8dde347c7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,52 @@ +{ + "title": "WebAppServicePlanV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppServicePlanV2Operations_Get", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "webAppServicePlanName": "plan-001" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppType": "IIS", + "webAppTargetType": "AzureAppService", + "webAppServicePlanName": "Plan-001", + "numberOfWebApps": 2, + "monthlyCost": 20, + "storage": 25, + "scaleOutInstances": 8, + "cores": 17, + "ram": 18, + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1", + "createdTimestamp": "2023-11-03T05:42:59.387Z", + "updatedTimestamp": "2023-11-03T05:42:59.387Z", + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 16, + "description": null + } + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/webAppServicePlans/plan-002-azureappservice", + "name": "plan-002-azureappservice", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/webAppServicePlans", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..44a44c83b47c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "$filter": "okepiszphg", + "pageSize": 18, + "$skipToken": "hcpyxryhoumfkypulwpsxxkzuu", + "totalRecordCount": 14, + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppType": "IIS", + "webAppTargetType": "AzureAppService", + "webAppServicePlanName": "Plan-001", + "numberOfWebApps": 2, + "monthlyCost": 20, + "storage": 25, + "scaleOutInstances": 8, + "cores": 17, + "ram": 18, + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1", + "createdTimestamp": "2023-11-03T05:42:59.387Z", + "updatedTimestamp": "2023-11-03T05:42:59.387Z", + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 16, + "description": null + } + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/webAppServicePlans/plan-002-azureappservice", + "name": "plan-002-azureappservice", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/webAppServicePlans", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/migrate.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/migrate.json new file mode 100644 index 000000000000..32b826bab749 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/migrate.json @@ -0,0 +1,24317 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Migrate Assessment Service", + "version": "2023-04-01-preview", + "description": "Azure Migrate Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "AssessmentProjectsOperations" + }, + { + "name": "AssessmentProjectSummaryOperations" + }, + { + "name": "MachinesOperations" + }, + { + "name": "GroupsOperations" + }, + { + "name": "AssessmentsOperations" + }, + { + "name": "AssessmentOptionsOperations" + }, + { + "name": "AssessedMachinesOperations" + }, + { + "name": "HypervCollectorsOperations" + }, + { + "name": "VmwareCollectorsOperations" + }, + { + "name": "ServerCollectorsOperations" + }, + { + "name": "ImportCollectorsOperations" + }, + { + "name": "PrivateEndpointConnectionOperations" + }, + { + "name": "PrivateLinkResourceOperations" + }, + { + "name": "AvsAssessmentsOperations" + }, + { + "name": "AvsAssessmentOptionsOperations" + }, + { + "name": "AvsAssessedMachinesOperations" + }, + { + "name": "SqlAssessmentV2SummaryOperations" + }, + { + "name": "SqlAssessmentV2Operations" + }, + { + "name": "SqlAssessmentOptionsOperations" + }, + { + "name": "AssessedSqlMachinesOperations" + }, + { + "name": "AssessedSqlRecommendedEntityOperations" + }, + { + "name": "AssessedSqlInstanceV2Operations" + }, + { + "name": "AssessedSqlDatabaseV2Operations" + }, + { + "name": "SqlCollectorOperations" + }, + { + "name": "WebAppAssessmentV2SummaryOperations" + }, + { + "name": "WebAppAssessmentV2Operations" + }, + { + "name": "WebAppAssessmentOptionsOperations" + }, + { + "name": "AssessedWebAppV2Operations" + }, + { + "name": "WebAppServicePlanV2Operations" + }, + { + "name": "WebAppCollectorOperations" + }, + { + "name": "BusinessCaseOperations" + }, + { + "name": "BusinessCaseIaasSummaryOperations" + }, + { + "name": "BusinessCasePaasSummaryOperations" + }, + { + "name": "BusinessCaseOverviewSummaryOperations" + }, + { + "name": "BusinessCaseAvsSummaryOperations" + }, + { + "name": "EvaluatedMachinesOperations" + }, + { + "name": "EvaluatedSqlEntitiesOperations" + }, + { + "name": "EvaluatedWebAppsOperations" + }, + { + "name": "EvaluatedAvsMachinesOperations" + }, + { + "name": "AKSAssessmentOperations" + }, + { + "name": "AssessedWebApplicationOperations" + }, + { + "name": "AKSOptionsOperations" + }, + { + "name": "AKSSummaryOperations" + }, + { + "name": "AKSClusterOperations" + }, + { + "name": "AKSCostDetailOperations" + } + ], + "paths": { + "/providers/Microsoft.Migrate/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Migrate/assessmentProjects": { + "get": { + "operationId": "AssessmentProjectsOperations_ListBySubscription", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "List AssessmentProject resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects": { + "get": { + "operationId": "AssessmentProjectsOperations_ListByResourceGroup", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "List AssessmentProject resources by resource group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}": { + "get": { + "operationId": "AssessmentProjectsOperations_Get", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Get a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AssessmentProjectsOperations_Create", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Create a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AssessmentProject' update operation succeeded", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "201": { + "description": "Resource 'AssessmentProject' create operation succeeded", + "schema": { + "$ref": "#/definitions/AssessmentProject" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentProjectsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "AssessmentProjectsOperations_Update", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Update a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AssessmentProjectUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentProjectsOperations_Update_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AssessmentProjectsOperations_Delete", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Delete a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessmentOptions": { + "get": { + "operationId": "AksOptionsOperations_ListByAssessmentProject", + "tags": [ + "AKSOptionsOperations" + ], + "description": "List AKSAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "AksOptionsOperations_Get", + "tags": [ + "AKSOptionsOperations" + ], + "description": "Get a AKSAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "AKS Assessment Options Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments": { + "get": { + "operationId": "AksAssessmentOperations_ListByAssessmentProject", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "List AKSAssessment resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Continuation Token Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Page Size Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total Record Count Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}": { + "get": { + "operationId": "AksAssessmentOperations_Get", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Get a AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksAssessmentOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AksAssessmentOperations_Create", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Create a AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AKSAssessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "201": { + "description": "Resource 'AKSAssessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/AKSAssessment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AksAssessmentOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AksAssessmentOperations_Delete", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Delete a AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksAssessmentOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/assessedWebApps": { + "get": { + "operationId": "AssessedWebApplicationOperations_ListByAksAssessment", + "tags": [ + "AssessedWebApplicationOperations" + ], + "description": "List AssessedWebApplication resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Continuation Token Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Page Size Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total Record Count Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebApplicationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/assessedWebApps/{assessedWorkload}": { + "get": { + "operationId": "AssessedWebApplicationOperations_Get", + "tags": [ + "AssessedWebApplicationOperations" + ], + "description": "Get a AssessedWebApplication", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedWorkload", + "in": "path", + "description": "Assessed Web Application Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebApplication" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedWebApplicationOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/clusters": { + "get": { + "operationId": "AksClusterOperations_ListByAksAssessment", + "tags": [ + "AKSClusterOperations" + ], + "description": "List AKSCluster resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksClusterOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/clusters/{clusterName}": { + "get": { + "operationId": "AksClusterOperations_Get", + "tags": [ + "AKSClusterOperations" + ], + "description": "Get a AKSCluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "clusterName", + "in": "path", + "description": "AKS Cluster Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksClusterOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksClusterOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/costDetails": { + "get": { + "operationId": "AksCostDetailOperations_ListByAksAssessment", + "tags": [ + "AKSCostDetailOperations" + ], + "description": "List AKSCostDetail resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSCostDetailListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AksAssessmentOperations_DownloadUrl", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Get URL for downloading AKS Assessment Report.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AksAssessmentOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "AksSummaryOperations_ListByAksAssessment", + "tags": [ + "AKSSummaryOperations" + ], + "description": "List AKSSummary resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "AksSummaryOperations_Get", + "tags": [ + "AKSSummaryOperations" + ], + "description": "Get a AKSSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "AKS Assessment Summary Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions": { + "get": { + "operationId": "AssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "AssessmentOptionsOperations" + ], + "description": "List AssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "AssessmentOptionsOperations_Get", + "tags": [ + "AssessmentOptionsOperations" + ], + "description": "Get a AssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": " assessment options ARM name. Accepted value is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions": { + "get": { + "operationId": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "AvsAssessmentOptionsOperations" + ], + "description": "List AvsAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions/{avsAssessmentOptionsName}": { + "get": { + "operationId": "AvsAssessmentOptionsOperations_Get", + "tags": [ + "AvsAssessmentOptionsOperations" + ], + "description": "Get a AvsAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsAssessmentOptionsName", + "in": "path", + "description": "AVS Assessment options ARM name. Accepted value is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases": { + "get": { + "operationId": "BusinessCaseOperations_ListByAssessmentProject", + "tags": [ + "BusinessCaseOperations" + ], + "description": "List BusinessCase resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BusinessCaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}": { + "get": { + "operationId": "BusinessCaseOperations_Get", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Get a BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BusinessCase" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "BusinessCaseOperations_Create", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Create a BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BusinessCase" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BusinessCase' update operation succeeded", + "schema": { + "$ref": "#/definitions/BusinessCase" + } + }, + "201": { + "description": "Resource 'BusinessCase' create operation succeeded", + "schema": { + "$ref": "#/definitions/BusinessCase" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "BusinessCaseOperations_Delete", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Delete a BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/avsSummaries": { + "get": { + "operationId": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseAvsSummaryOperations" + ], + "description": "List AvsSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/avsSummaries/{avsSummaryName}": { + "get": { + "operationId": "BusinessCaseAvsSummaryOperations_Get", + "tags": [ + "BusinessCaseAvsSummaryOperations" + ], + "description": "Get a AvsSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsSummaryName", + "in": "path", + "description": "Gets the Name of the Avs Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/compareSummary": { + "post": { + "operationId": "BusinessCaseOperations_CompareSummary", + "tags": [ + "BusinessCaseOperations" + ], + "summary": "Get Compare summary report for Business case.", + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CompareSummary" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_CompareSummary_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedAvsMachines": { + "get": { + "operationId": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedAvsMachinesOperations" + ], + "description": "List EvaluatedAvsMachine resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedAvsMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedAvsMachines/{evaluatedAvsMachineName}": { + "get": { + "operationId": "EvaluatedAvsMachinesOperations_Get", + "tags": [ + "EvaluatedAvsMachinesOperations" + ], + "description": "Get a EvaluatedAvsMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedAvsMachineName", + "in": "path", + "description": "Business case Evaluated AVS machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedAvsMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedMachines": { + "get": { + "operationId": "EvaluatedMachinesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedMachinesOperations" + ], + "description": "List EvaluatedMachine resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedMachines/{evaluatedMachineName}": { + "get": { + "operationId": "EvaluatedMachinesOperations_Get", + "tags": [ + "EvaluatedMachinesOperations" + ], + "description": "Get a EvaluatedMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedMachineName", + "in": "path", + "description": "Business case Evaluated machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedSqlEntities": { + "get": { + "operationId": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedSqlEntitiesOperations" + ], + "description": "List EvaluatedSqlEntity resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedSqlEntityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedSqlEntities/{evaluatedSqlEntityName}": { + "get": { + "operationId": "EvaluatedSqlEntitiesOperations_Get", + "tags": [ + "EvaluatedSqlEntitiesOperations" + ], + "description": "Get a EvaluatedSqlEntity", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedSqlEntityName", + "in": "path", + "description": "Business case Evaluated sql entity ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedSqlEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedWebApps": { + "get": { + "operationId": "EvaluatedWebAppsOperations_ListByBusinessCase", + "tags": [ + "EvaluatedWebAppsOperations" + ], + "description": "List EvaluatedWebApp resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedWebAppListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedWebApps/{evaluatedWebAppName}": { + "get": { + "operationId": "EvaluatedWebAppsOperations_Get", + "tags": [ + "EvaluatedWebAppsOperations" + ], + "description": "Get a EvaluatedWebApp", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedWebAppName", + "in": "path", + "description": "Business case Evaluated web App ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedWebApp" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedWebAppsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/getReportDownloadUrl": { + "post": { + "operationId": "BusinessCaseOperations_GetReportDownloadUrl", + "tags": [ + "BusinessCaseOperations" + ], + "summary": "Get download URL for the business case report.", + "description": "Get the URL for downloading the business case in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportDownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries": { + "get": { + "operationId": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseIaasSummaryOperations" + ], + "description": "List IaasSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IaasSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries/{iaasSummaryName}": { + "get": { + "operationId": "BusinessCaseIaasSummaryOperations_Get", + "tags": [ + "BusinessCaseIaasSummaryOperations" + ], + "description": "Get a IaasSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "iaasSummaryName", + "in": "path", + "description": "Gets the Name of the Iaas Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IaasSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries": { + "get": { + "operationId": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseOverviewSummaryOperations" + ], + "description": "List OverviewSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OverviewSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries/{overviewSummaryName}": { + "get": { + "operationId": "BusinessCaseOverviewSummaryOperations_Get", + "tags": [ + "BusinessCaseOverviewSummaryOperations" + ], + "description": "Get a OverviewSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "overviewSummaryName", + "in": "path", + "description": "Gets the Name of the Overview Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OverviewSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries": { + "get": { + "operationId": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCasePaasSummaryOperations" + ], + "description": "List PaasSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PaasSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries/{paasSummaryName}": { + "get": { + "operationId": "BusinessCasePaasSummaryOperations_Get", + "tags": [ + "BusinessCasePaasSummaryOperations" + ], + "description": "Get a PaasSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "paasSummaryName", + "in": "path", + "description": "Gets the Name of the Paas Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PaasSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups": { + "get": { + "operationId": "GroupsOperations_ListByAssessmentProject", + "tags": [ + "GroupsOperations" + ], + "description": "List Group resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/GroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GroupsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}": { + "get": { + "operationId": "GroupsOperations_Get", + "tags": [ + "GroupsOperations" + ], + "description": "Get a Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GroupsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "GroupsOperations_Create", + "tags": [ + "GroupsOperations" + ], + "description": "Create a Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Group" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Group' update operation succeeded", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "201": { + "description": "Resource 'Group' create operation succeeded", + "schema": { + "$ref": "#/definitions/Group" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GroupsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "GroupsOperations_Delete", + "tags": [ + "GroupsOperations" + ], + "description": "Delete a Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GroupsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments": { + "get": { + "operationId": "AssessmentsOperations_ListByGroup", + "tags": [ + "AssessmentsOperations" + ], + "description": "List Assessment resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentsOperations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}": { + "get": { + "operationId": "AssessmentsOperations_Get", + "tags": [ + "AssessmentsOperations" + ], + "description": "Get a Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Assessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AssessmentsOperations_Create", + "tags": [ + "AssessmentsOperations" + ], + "description": "Create a Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Assessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Assessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/Assessment" + } + }, + "201": { + "description": "Resource 'Assessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/Assessment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AssessmentsOperations_Delete", + "tags": [ + "AssessmentsOperations" + ], + "description": "Delete a Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines": { + "get": { + "operationId": "AssessedMachinesOperations_ListByAssessment", + "tags": [ + "AssessedMachinesOperations" + ], + "description": "List AssessedMachine resources by Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen": { + "$ref": "./examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName}": { + "get": { + "operationId": "AssessedMachinesOperations_Get", + "tags": [ + "AssessedMachinesOperations" + ], + "description": "Get a AssessedMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedMachineName", + "in": "path", + "description": "Machine assessment Assessed Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AssessmentsOperations_DownloadUrl", + "tags": [ + "AssessmentsOperations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentsOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments": { + "get": { + "operationId": "AvsAssessmentsOperations_ListByGroup", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "List AvsAssessment resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}": { + "get": { + "operationId": "AvsAssessmentsOperations_Get", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Get a AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AvsAssessmentsOperations_Create", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Create a AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AvsAssessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "201": { + "description": "Resource 'AvsAssessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/AvsAssessment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AvsAssessmentsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AvsAssessmentsOperations_Delete", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Delete a AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines": { + "get": { + "operationId": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "tags": [ + "AvsAssessedMachinesOperations" + ], + "description": "List AvsAssessedMachine resources by AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines/{avsAssessedMachineName}": { + "get": { + "operationId": "AvsAssessedMachinesOperations_Get", + "tags": [ + "AvsAssessedMachinesOperations" + ], + "description": "Get a AvsAssessedMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsAssessedMachineName", + "in": "path", + "description": "AVS assessment Assessed Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AvsAssessmentsOperations_DownloadUrl", + "tags": [ + "AvsAssessmentsOperations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments": { + "get": { + "operationId": "SqlAssessmentV2Operations_ListByGroup", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "List SqlAssessmentV2 resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}": { + "get": { + "operationId": "SqlAssessmentV2Operations_Get", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Get a SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlAssessmentV2Operations_Create", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Create a SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SqlAssessmentV2' update operation succeeded", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "201": { + "description": "Resource 'SqlAssessmentV2' create operation succeeded", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlAssessmentV2Operations_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlAssessmentV2Operations_Delete", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Delete a SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases": { + "get": { + "operationId": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlDatabaseV2Operations" + ], + "description": "List AssessedSqlDatabaseV2 resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlDatabaseV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases/{assessedSqlDatabaseName}": { + "get": { + "operationId": "AssessedSqlDatabaseV2Operations_Get", + "tags": [ + "AssessedSqlDatabaseV2Operations" + ], + "description": "Get a AssessedSqlDatabaseV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlDatabaseName", + "in": "path", + "description": "Sql assessment Assessed Databases ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlDatabaseV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances": { + "get": { + "operationId": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlInstanceV2Operations" + ], + "description": "List AssessedSqlInstanceV2 resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlInstanceV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances/{assessedSqlInstanceName}": { + "get": { + "operationId": "AssessedSqlInstanceV2Operations_Get", + "tags": [ + "AssessedSqlInstanceV2Operations" + ], + "description": "Get a AssessedSqlInstanceV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlInstanceName", + "in": "path", + "description": "Sql assessment Assessed Instance ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlInstanceV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines": { + "get": { + "operationId": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlMachinesOperations" + ], + "description": "List AssessedSqlMachine resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines/{assessedSqlMachineName}": { + "get": { + "operationId": "AssessedSqlMachinesOperations_Get", + "tags": [ + "AssessedSqlMachinesOperations" + ], + "description": "Get a AssessedSqlMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlMachineName", + "in": "path", + "description": "Sql assessment Assessed Machine ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "SqlAssessmentV2Operations_DownloadUrl", + "tags": [ + "SqlAssessmentV2Operations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities": { + "get": { + "operationId": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlRecommendedEntityOperations" + ], + "description": "List AssessedSqlRecommendedEntity resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlRecommendedEntityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities/{recommendedAssessedEntityName}": { + "get": { + "operationId": "AssessedSqlRecommendedEntityOperations_Get", + "tags": [ + "AssessedSqlRecommendedEntityOperations" + ], + "description": "Get a AssessedSqlRecommendedEntity", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "recommendedAssessedEntityName", + "in": "path", + "description": "Sql assessment Assessed Recommended Entity ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlRecommendedEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "tags": [ + "SqlAssessmentV2SummaryOperations" + ], + "description": "List SqlAssessmentV2Summary resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2SummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "SqlAssessmentV2SummaryOperations_Get", + "tags": [ + "SqlAssessmentV2SummaryOperations" + ], + "description": "Get a SqlAssessmentV2Summary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "Gets the Name of the SQL Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2Summary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/updateMachines": { + "post": { + "operationId": "GroupsOperations_UpdateMachines", + "tags": [ + "GroupsOperations" + ], + "summary": "Update machines in group.", + "description": "Update machines in group by adding or removing machines.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateGroupBody" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GroupsOperations_UpdateMachines_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments": { + "get": { + "operationId": "WebAppAssessmentV2Operations_ListByGroup", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "List WebAppAssessmentV2 resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}": { + "get": { + "operationId": "WebAppAssessmentV2Operations_Get", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Get a WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppAssessmentV2Operations_Create", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Create a WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WebAppAssessmentV2' update operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "201": { + "description": "Resource 'WebAppAssessmentV2' create operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppAssessmentV2Operations_Delete", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Delete a WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/assessedWebApps": { + "get": { + "operationId": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2", + "tags": [ + "AssessedWebAppV2Operations" + ], + "description": "List AssessedWebAppV2 resources by WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebAppV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/assessedWebApps/{assessedWebAppName}": { + "get": { + "operationId": "AssessedWebAppV2Operations_Get", + "tags": [ + "AssessedWebAppV2Operations" + ], + "description": "Get a AssessedWebAppV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedWebAppName", + "in": "path", + "description": "Assessed web app ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebAppV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedWebAppV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "WebAppAssessmentV2Operations_DownloadUrl", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2", + "tags": [ + "WebAppAssessmentV2SummaryOperations" + ], + "description": "List WebAppAssessmentV2Summary resources by WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2SummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "WebAppAssessmentV2SummaryOperations_Get", + "tags": [ + "WebAppAssessmentV2SummaryOperations" + ], + "description": "Get a WebAppAssessmentV2Summary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "Gets the Name of the Web app Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2Summary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/webAppServicePlans": { + "get": { + "operationId": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2", + "tags": [ + "WebAppServicePlanV2Operations" + ], + "description": "List WebAppServicePlanV2 resources by WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppServicePlanV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/webAppServicePlans/{webAppServicePlanName}": { + "get": { + "operationId": "WebAppServicePlanV2Operations_Get", + "tags": [ + "WebAppServicePlanV2Operations" + ], + "description": "Get a WebAppServicePlanV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "webAppServicePlanName", + "in": "path", + "description": "Web app service plan ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppServicePlanV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppServicePlanV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors": { + "get": { + "operationId": "HypervCollectorsOperations_ListByAssessmentProject", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "List HypervCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors/{hypervCollectorName}": { + "get": { + "operationId": "HypervCollectorsOperations_Get", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Get a HypervCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "HypervCollectorsOperations_Create", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Create a HypervCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'HypervCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/HypervCollector" + } + }, + "201": { + "description": "Resource 'HypervCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/HypervCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "HypervCollectorsOperations_Delete", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Delete a HypervCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors": { + "get": { + "operationId": "ImportCollectorsOperations_ListByAssessmentProject", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "List ImportCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors/{importCollectorName}": { + "get": { + "operationId": "ImportCollectorsOperations_Get", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Get a ImportCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ImportCollectorsOperations_Create", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Create a ImportCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ImportCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/ImportCollector" + } + }, + "201": { + "description": "Resource 'ImportCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/ImportCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ImportCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ImportCollectorsOperations_Delete", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Delete a ImportCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines": { + "get": { + "operationId": "MachinesOperations_ListByAssessmentProject", + "tags": [ + "MachinesOperations" + ], + "description": "List Machine resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MachinesOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines/{machineName}": { + "get": { + "operationId": "MachinesOperations_Get", + "tags": [ + "MachinesOperations" + ], + "description": "Get a Machine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Assessible Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/MachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "List PrivateEndpointConnection resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnectionOperations_Get", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Get a PrivateEndpointConnection", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnectionOperations_Update", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Create a PrivateEndpointConnection", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnection' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Resource 'PrivateEndpointConnection' create operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Update_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "PrivateEndpointConnectionOperations_Delete", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Delete a PrivateEndpointConnection", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResourceOperations_ListByAssessmentProject", + "tags": [ + "PrivateLinkResourceOperations" + ], + "description": "List PrivateLinkResource resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "operationId": "PrivateLinkResourceOperations_Get", + "tags": [ + "PrivateLinkResourceOperations" + ], + "description": "Get a PrivateLinkResource", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "description": "Private link resource ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResourceOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary": { + "get": { + "operationId": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "tags": [ + "AssessmentProjectSummaryOperations" + ], + "description": "List AssessmentProjectSummary resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary/{projectSummaryName}": { + "get": { + "operationId": "AssessmentProjectSummaryOperations_Get", + "tags": [ + "AssessmentProjectSummaryOperations" + ], + "description": "Get a AssessmentProjectSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "projectSummaryName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors": { + "get": { + "operationId": "ServerCollectorsOperations_ListByAssessmentProject", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "List ServerCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors/{serverCollectorName}": { + "get": { + "operationId": "ServerCollectorsOperations_Get", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Get a ServerCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ServerCollectorsOperations_Create", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Create a ServerCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ServerCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/ServerCollector" + } + }, + "201": { + "description": "Resource 'ServerCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/ServerCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ServerCollectorsOperations_Delete", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Delete a ServerCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions": { + "get": { + "operationId": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "SqlAssessmentOptionsOperations" + ], + "description": "List SqlAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "SqlAssessmentOptionsOperations_Get", + "tags": [ + "SqlAssessmentOptionsOperations" + ], + "description": "Get a SqlAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "Sql assessment options ARM name. Accepted values is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors": { + "get": { + "operationId": "SqlCollectorOperations_ListByAssessmentProject", + "tags": [ + "SqlCollectorOperations" + ], + "description": "List SqlCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}": { + "get": { + "operationId": "SqlCollectorOperations_Get", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Get a SqlCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlCollectorOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlCollectorOperations_Create", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Create a SqlCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SqlCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/SqlCollector" + } + }, + "201": { + "description": "Resource 'SqlCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/SqlCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlCollectorOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlCollectorOperations_Delete", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Delete a SqlCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlCollectorOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors": { + "get": { + "operationId": "VmwareCollectorsOperations_ListByAssessmentProject", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "List VmwareCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors/{vmWareCollectorName}": { + "get": { + "operationId": "VmwareCollectorsOperations_Get", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Get a VmwareCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "VmwareCollectorsOperations_Create", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Create a VmwareCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VmwareCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "201": { + "description": "Resource 'VmwareCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/VmwareCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VmwareCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "VmwareCollectorsOperations_Delete", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Delete a VmwareCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessmentOptions": { + "get": { + "operationId": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "WebAppAssessmentOptionsOperations" + ], + "description": "List WebAppAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "WebAppAssessmentOptionsOperations_Get", + "tags": [ + "WebAppAssessmentOptionsOperations" + ], + "description": "Get a WebAppAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "Web app assessment options ARM name. Accepted values is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors": { + "get": { + "operationId": "WebAppCollectorOperations_ListByAssessmentProject", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "List WebAppCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors/{collectorName}": { + "get": { + "operationId": "WebAppCollectorOperations_Get", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Get a WebAppCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppCollectorOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppCollectorOperations_Create", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Create a WebAppCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WebAppCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "201": { + "description": "Resource 'WebAppCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppCollectorOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppCollectorOperations_Delete", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Delete a WebAppCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppCollectorOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AKSAssessment": { + "type": "object", + "description": "ARM model of AKS Assessment.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSAssessmentDetails": { + "type": "object", + "description": "Data model of AKS Assessment Details.", + "properties": { + "webAppCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web apps.", + "readOnly": true + }, + "webServerCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web servers.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines.", + "readOnly": true + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets the total monthly cost.", + "readOnly": true + } + }, + "required": [ + "webAppCount", + "webServerCount", + "machineCount", + "totalMonthlyCost" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentDetails" + } + ] + }, + "AKSAssessmentListResult": { + "type": "object", + "description": "The response of a AKSAssessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSAssessment items on this page", + "items": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSAssessmentOptions": { + "type": "object", + "description": "ARM model of AKS Assessment Options.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AKSAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AKSAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSAssessmentOptionsProperties": { + "type": "object", + "description": "ARM model of AKS Assessment Options Properties.", + "allOf": [ + { + "$ref": "#/definitions/OptionsArmPropertiesBase" + } + ] + }, + "AKSAssessmentProperties": { + "type": "object", + "description": "ARM model of AKS Assessment Properties.", + "properties": { + "settings": { + "$ref": "#/definitions/AKSAssessmentSettings", + "description": "Gets or sets AKS Assessment Settings." + }, + "details": { + "$ref": "#/definitions/AKSAssessmentDetails", + "description": "Gets AKS Assessment Details.", + "readOnly": true + } + }, + "required": [ + "settings" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentPropertiesBase" + } + ] + }, + "AKSAssessmentSettings": { + "type": "object", + "description": "Data model of AKS Assessment Settings.", + "properties": { + "category": { + "$ref": "#/definitions/AzureVmCategory", + "description": "Gets or sets azure VM category." + }, + "savingsOptions": { + "$ref": "#/definitions/SavingsOptions", + "description": "Gets or sets savings options." + }, + "consolidation": { + "$ref": "#/definitions/ConsolidationType", + "description": "Gets or sets consolidation type." + }, + "pricingTier": { + "$ref": "#/definitions/PricingTier", + "description": "Gets or sets pricing tier." + } + }, + "required": [ + "category", + "savingsOptions", + "consolidation", + "pricingTier" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentSettings" + } + ] + }, + "AKSAssessmentSummary": { + "type": "object", + "description": "Data model of AKS Assessment Summary.", + "properties": { + "skuSummary": { + "type": "object", + "description": "Gets SKU summary.", + "additionalProperties": { + "$ref": "#/definitions/SummaryDetails" + }, + "readOnly": true + }, + "webAppSummary": { + "type": "object", + "description": "Gets web app summary.", + "additionalProperties": { + "$ref": "#/definitions/SummaryDetails" + }, + "readOnly": true + }, + "webServerSummary": { + "type": "object", + "description": "Gets web server summary.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "webAppCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web apps.", + "readOnly": true + }, + "webServerCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web servers.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines.", + "readOnly": true + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets the total monthly cost.", + "readOnly": true + } + }, + "required": [ + "skuSummary", + "webAppSummary", + "webServerSummary", + "webAppCount", + "webServerCount", + "machineCount", + "totalMonthlyCost" + ] + }, + "AKSCluster": { + "type": "object", + "description": "ARM model of AKS Cluster.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSClusterListResult": { + "type": "object", + "description": "The response of a AKSCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSCluster items on this page", + "items": { + "$ref": "#/definitions/AKSCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSClusterProperties": { + "type": "object", + "description": "ARM model of AKS Cluster Properties.", + "allOf": [ + { + "$ref": "#/definitions/Cluster" + } + ] + }, + "AKSCostDetail": { + "type": "object", + "description": "ARM model of AKS Cost Detail.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSCostDetailProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSCostDetailListResult": { + "type": "object", + "description": "The response of a AKSCostDetail list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSCostDetail items on this page", + "items": { + "$ref": "#/definitions/AKSCostDetail" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSCostDetailProperties": { + "type": "object", + "description": "ARM model of AKS Cost Detail Properties.", + "allOf": [ + { + "$ref": "#/definitions/NodePool" + } + ] + }, + "AKSSummary": { + "type": "object", + "description": "ARM model of AKS Summary.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSSummaryListResult": { + "type": "object", + "description": "The response of a AKSSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSSummary items on this page", + "items": { + "$ref": "#/definitions/AKSSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSSummaryProperties": { + "type": "object", + "description": "ARM model of AKS Summary Properties.", + "properties": { + "aksAssessmentSummary": { + "$ref": "#/definitions/AKSAssessmentSummary", + "description": "Gets AKS assessment summary.", + "readOnly": true + } + }, + "required": [ + "aksAssessmentSummary" + ], + "allOf": [ + { + "$ref": "#/definitions/SummaryPropertiesBase" + } + ] + }, + "ApiVersions": { + "type": "string", + "description": "Common API Versions for Assessment Project Tracked Resource.", + "enum": [ + "2019-10-01", + "2020-01-01", + "2020-05-01-preview", + "2022-02-02-preview", + "2022-08-01-preview", + "2023-03-03", + "2023-03-15", + "2023-04-01-preview", + "2023-07-07-preview" + ], + "x-ms-enum": { + "name": "ApiVersions", + "modelAsString": true, + "values": [ + { + "name": "v2019_10_01", + "value": "2019-10-01", + "description": "2019-10-01 API Version." + }, + { + "name": "v2020_01_01", + "value": "2020-01-01", + "description": "2020-01-01 API Version." + }, + { + "name": "v2020_05_01_preview", + "value": "2020-05-01-preview", + "description": "2020-05-01-preview API Version." + }, + { + "name": "v2022_02_02_preview", + "value": "2022-02-02-preview", + "description": "2022-02-02-preview API Version." + }, + { + "name": "v2022_08_01_preview", + "value": "2022-08-01-preview", + "description": "2022-08-01-preview API Version." + }, + { + "name": "v2023_03_03", + "value": "2023-03-03", + "description": "2023-03-03 API Version." + }, + { + "name": "v2023_03_15", + "value": "2023-03-15", + "description": "2023-03-15 API Version." + }, + { + "name": "v2023_04_01_preview", + "value": "2023-04-01-preview", + "description": "2023-04-01-preview API Version." + }, + { + "name": "v2023_07_07_preview", + "value": "2023-07-07-preview", + "description": "2023-07-07-preview API Version." + } + ] + } + }, + "AppServiceSku": { + "type": "object", + "description": "The app service SKU with corresponding cost.", + "properties": { + "skuName": { + "type": "string", + "description": "The SKU name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of service plans recommended.", + "readOnly": true + } + } + }, + "AppSvcContainerSettings": { + "type": "object", + "description": "App service container settings.", + "properties": { + "isolationRequired": { + "type": "boolean", + "description": "Gets or sets the isolation required." + } + }, + "required": [ + "isolationRequired" + ] + }, + "AppSvcNativeSettings": { + "type": "object", + "description": "App service native settings.", + "properties": { + "isolationRequired": { + "type": "boolean", + "description": "Gets or sets the isolation required." + } + }, + "required": [ + "isolationRequired" + ] + }, + "AssessedDisk": { + "type": "object", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureDiskSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "recommendedDiskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the recommended disk size." + }, + "recommendedDiskType": { + "$ref": "#/definitions/AzureDiskType", + "description": "Gets the recommended disk type." + }, + "gigabytesForRecommendedDiskSize": { + "type": "integer", + "format": "int32", + "description": "Gets the recommended disk size." + }, + "recommendDiskThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk throughput." + }, + "recommendedDiskIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk iops." + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the machine display name." + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gets the gigabytes provisioned." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedDiskData": { + "type": "object", + "description": "Assessed Disk data. Used in Assessed SQL machine DTO.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureDiskSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "recommendedDiskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the recommended disk size." + }, + "recommendedDiskType": { + "$ref": "#/definitions/AzureDiskType", + "description": "Gets the recommended disk type." + }, + "recommendedDiskSizeGigabytes": { + "type": "integer", + "format": "int32", + "description": "Gets the recommended disk size." + }, + "recommendDiskThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk throughput." + }, + "recommendedDiskIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk iops." + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the machine display name." + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gets the gigabytes provisioned." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedMachine": { + "type": "object", + "description": "Machine assessment Assessed Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedMachineListResult": { + "type": "object", + "description": "The response of a AssessedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedMachine items on this page", + "items": { + "$ref": "#/definitions/AssessedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedMachineProperties": { + "type": "object", + "description": "Assessed machine properties class.", + "properties": { + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disks": { + "type": "object", + "description": "Dictionary of disks attached to the machine. Key is ID of disk. Value is a disk object.", + "additionalProperties": { + "$ref": "#/definitions/AssessedDisk" + }, + "readOnly": true + }, + "monthlyUltraStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly ultra storage cost.", + "readOnly": true + }, + "hostProcessor": { + "$ref": "#/definitions/ProcessorInfo", + "description": "Gets or sets the processor details of the host." + }, + "costComponents": { + "type": "array", + "description": "Gets or sets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Monthly networking cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly storage cost.", + "readOnly": true + }, + "monthlyPremiumStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly premium storage cost.", + "readOnly": true + }, + "monthlyStandardSsdStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly standard SSD storage cost.", + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "List of Network Adapters that were assessed as part of this machine's\nassessment.", + "additionalProperties": { + "$ref": "#/definitions/AssessedNetworkAdapter" + }, + "readOnly": true + }, + "recommendedSize": { + "$ref": "#/definitions/AzureVmSize", + "description": "Recommended Azure Size for the machine.", + "readOnly": true + }, + "numberOfCoresForRecommendedSize": { + "type": "integer", + "format": "int32", + "description": "Number of cores for recommended size. Read Only.", + "readOnly": true + }, + "megabytesOfMemoryForRecommendedSize": { + "type": "number", + "format": "float", + "description": "Megabytes of memory for recommended size. Read Only.", + "readOnly": true + }, + "monthlyComputeCostForRecommendedSize": { + "type": "number", + "format": "float", + "description": "Monthly Compute cost calculated for Recommended size, for a 31-day month.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureVmSuitabilityExplanation", + "description": "Gets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureVmSuitabilityDetail", + "description": "Gets the details if machine is not suitable for cloud.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + } + } + }, + "AssessedMachineType": { + "type": "string", + "enum": [ + "Unknown", + "AssessedMachine", + "AvsAssessedMachine", + "SqlAssessedMachine" + ], + "x-ms-enum": { + "name": "AssessedMachineType", + "modelAsString": true + } + }, + "AssessedNetworkAdapter": { + "type": "object", + "description": "Assessed Network Adapter.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "monthlyBandwidthCosts": { + "type": "number", + "format": "float", + "description": "Gets the monthly bandwidth costs." + }, + "netGigabytesTransmittedPerMonth": { + "type": "number", + "format": "float", + "description": "Gets the net gigabytes transmitted per month." + }, + "displayName": { + "type": "string", + "description": "Gets the display name." + }, + "macAddress": { + "type": "string", + "description": "Gets the mac address." + }, + "ipAddresses": { + "type": "array", + "description": "Gets the ip addresses.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second received." + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second transmitted." + } + } + }, + "AssessedSqlDatabaseV2": { + "type": "object", + "description": "Assessed SQL database web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlDatabaseV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlDatabaseV2ListResult": { + "type": "object", + "description": "The response of a AssessedSqlDatabaseV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlDatabaseV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlDatabaseV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlDatabaseV2Properties": { + "type": "object", + "description": "Assessed SQL database properties web model.", + "properties": { + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "bufferCacheSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregated cache size of this database. This is a performance\ndata metric for this DB.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "Gets or sets the azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "Gets or sets the azure SQL DB suitability details.", + "readOnly": true + }, + "isDatabaseHighlyAvailable": { + "type": "boolean", + "description": "Gets a value indicating whether the assessed SQL database is highly available\nor not.", + "readOnly": true + }, + "linkedAvailabilityGroupOverview": { + "$ref": "#/definitions/SqlAvailabilityGroupDataOverview", + "description": "Gets the linked availability group overview if the database being assessed is\nhighly available.", + "readOnly": true + }, + "machineArmId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "assessedSqlInstanceArmId": { + "type": "string", + "description": "Assessed SQL instance arm id.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Machine display name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL instance name.", + "readOnly": true + }, + "databaseName": { + "type": "string", + "description": "SQL database name.", + "readOnly": true + }, + "databaseSizeInMB": { + "type": "number", + "format": "float", + "description": "SQL database size in megabytes.", + "readOnly": true + }, + "compatibilityLevel": { + "$ref": "#/definitions/CompatibilityLevel", + "description": "Database compatibility level.", + "readOnly": true + }, + "sqlDatabaseSdsArmId": { + "type": "string", + "description": "SQL database SDS arm id.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "The percentage of the total number of cores being utilized by the SQL database.", + "readOnly": true + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "The read throughput of the SQL database.", + "readOnly": true + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "The write throughput of the SQL database.", + "readOnly": true + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "The read operations per second of the SQL database.", + "readOnly": true + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "The write operations per second of the SQL database.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database last updated.", + "readOnly": true + } + } + }, + "AssessedSqlInstanceDatabaseSummary": { + "type": "object", + "description": "Assessed Sql Instance Database Summary.", + "properties": { + "numberOfUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets the number of user databases." + }, + "totalDatabaseSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the total database size in MB." + }, + "largestDatabaseSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the largest database size in MB." + }, + "totalDiscoveredUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets the total discovered user databases." + } + } + }, + "AssessedSqlInstanceDiskDetails": { + "type": "object", + "description": "Assessed Sql Instance Disk Details.", + "properties": { + "diskId": { + "type": "string", + "description": "Gets the disk id." + }, + "diskSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the disk size in mb." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedSqlInstanceStorageDetails": { + "type": "object", + "description": "Assessed Sql Instance Storage Details.", + "properties": { + "storageType": { + "type": "string", + "description": "Gets the storage type." + }, + "diskSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the disk size in mb." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedSqlInstanceSummary": { + "type": "object", + "description": "Assessed Sql Instance Summary.", + "properties": { + "instanceId": { + "type": "string", + "description": "Gets the instance id." + }, + "instanceName": { + "type": "string", + "description": "Gets the instance name." + }, + "sqlInstanceSdsArmId": { + "type": "string", + "description": "Gets the instance arm id." + }, + "sqlInstanceEntityId": { + "type": "string", + "description": "Gets the instance entity id." + }, + "sqlEdition": { + "type": "string", + "description": "Gets the Sql edition." + }, + "sqlVersion": { + "type": "string", + "description": "Gets the Sql version." + }, + "isClustered": { + "type": "boolean", + "description": "Gets whether Sql is clustered." + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets whether Sql is highly available." + }, + "sqlFciState": { + "$ref": "#/definitions/SqlFCIState", + "description": "Gets the Sql Fci state." + } + } + }, + "AssessedSqlInstanceV2": { + "type": "object", + "description": "Assessed SQL instance web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlInstanceV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlInstanceV2ListResult": { + "type": "object", + "description": "The response of a AssessedSqlInstanceV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlInstanceV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlInstanceV2Properties": { + "type": "object", + "description": "Assessed SQL instance properties web model.", + "properties": { + "memoryInUseInMB": { + "type": "number", + "format": "float", + "description": "Gets or sets the memory used by SQL instance in megabytes.", + "readOnly": true + }, + "hasScanOccurred": { + "type": "boolean", + "description": "Gets or sets a value indicating whether SQL instance has been deep discovered.", + "readOnly": true + }, + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL DB suitability details.", + "readOnly": true + }, + "azureSqlVMSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2IaasSuitabilityData", + "description": "SQL instance azure SQL VM suitability details.", + "readOnly": true + }, + "storageTypeBasedDetails": { + "type": "array", + "description": "Gets the storage details.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceStorageDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "fciMetadata": { + "$ref": "#/definitions/SqlFCIMetadata", + "description": "Gets the FCI metadata if this instance represents an FCI instance.", + "readOnly": true + }, + "availabilityReplicaSummary": { + "$ref": "#/definitions/SqlAvailabilityReplicaSummary", + "description": "Gets the overview counts of availability replicas in the assessed instance, by\ncommit mode and read type.", + "readOnly": true + }, + "isClustered": { + "type": "boolean", + "description": "Gets a value indicating whether the SQL instance is clustered or not.", + "readOnly": true + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets a value indicating whether the high availability is enabled or not.", + "readOnly": true + }, + "recommendedTargetReasonings": { + "type": "array", + "description": "Gets the list of recommended target reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "machineArmId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Machine display name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL instance name.", + "readOnly": true + }, + "sqlInstanceSdsArmId": { + "type": "string", + "description": "SQL instance SDS arm id.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "SQL instance edition.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "SQL instance version.", + "readOnly": true + }, + "numberOfCoresAllocated": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores assigned to the SQL instance.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "The percentage of the total number of cores being utilized by the SQL instance.", + "readOnly": true + }, + "logicalDisks": { + "type": "array", + "description": "The logical disk details.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceDiskDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "databaseSummary": { + "$ref": "#/definitions/AssessedSqlInstanceDatabaseSummary", + "description": "The databases summary.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL instance first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL instance last updated.", + "readOnly": true + } + } + }, + "AssessedSqlMachine": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlMachineListResult": { + "type": "object", + "description": "The response of a AssessedSqlMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlMachine items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlMachineProperties": { + "type": "object", + "description": "Assessed SQL machine properties.", + "properties": { + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID for the machine.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN for the machine.", + "readOnly": true + }, + "sqlInstances": { + "type": "array", + "description": "Gets the list of SQL instances discovered on the machine.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureVmSuitabilityDetail", + "description": "Gets or sets the detailed messages that were set on the machine during\nevaluation.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureVmSuitabilityExplanation", + "description": "Gets or sets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "recommendedVmSize": { + "$ref": "#/definitions/AzureVmSize", + "description": "Gets or sets the Recommended Azure Size for the machine.", + "readOnly": true + }, + "recommendedVmFamily": { + "$ref": "#/definitions/AzureVmFamily", + "description": "Gets or sets the Recommended Azure VM Family for the machine.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "recommendedVmSizeNumberOfCores": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of cores for recommended size.", + "readOnly": true + }, + "recommendedVmSizeMegabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Gets or sets the Megabytes of memory for recommended size.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly compute cost calculated for recommended size.", + "readOnly": true + }, + "disks": { + "type": "object", + "description": "Gets the list of data disks that were assessed as part of this assessment.", + "additionalProperties": { + "$ref": "#/definitions/AssessedDiskData" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "Gets the list of network adapters that were assessed as part of this assessment.", + "additionalProperties": { + "$ref": "#/definitions/SqlAssessedNetworkAdapter" + }, + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly networking cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly total storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + } + } + }, + "AssessedSqlRecommendedEntity": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlRecommendedEntityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlRecommendedEntityListResult": { + "type": "object", + "description": "The response of a AssessedSqlRecommendedEntity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlRecommendedEntity items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlRecommendedEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlRecommendedEntityProperties": { + "type": "object", + "description": "Assessed SQL recommended entity properties.", + "properties": { + "machineName": { + "type": "string", + "description": "Gets or sets machine name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "Gets or sets SQL instance name.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "dbCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets assessed database count.", + "readOnly": true + }, + "discoveredDBCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the total discovered database count.", + "readOnly": true + }, + "hasScanOccurred": { + "type": "boolean", + "description": "Gets or sets a value indicating whether instance deep discovery has occurred or\nnot.", + "readOnly": true + }, + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL DB suitability details.", + "readOnly": true + }, + "azureSqlVMSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2IaasSuitabilityData", + "description": "SQL instance azure SQL VM suitability details.", + "readOnly": true + }, + "assessedSqlEntityArmId": { + "type": "string", + "description": "Gets or sets Arm id of assessed entity." + }, + "isClustered": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the SQL instance is clustered or not.", + "readOnly": true + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the high availability is enabled or not.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "Gets the SQL edition from the recommended entity if applicable.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "Gets the SQL version from the recommended entity if applicable.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + } + } + }, + "AssessedWebApp": { + "type": "object", + "description": "Data model of Assessed Web App.", + "properties": { + "suitabilityResult": { + "$ref": "#/definitions/SuitabilityResult", + "description": "Gets suitability result.", + "readOnly": true + }, + "recommendationResult": { + "$ref": "#/definitions/RecommendationResult", + "description": "Gets recommendation result.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/WebApp" + } + ] + }, + "AssessedWebAppV2": { + "type": "object", + "description": "Assessed Web app web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedWebAppV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedWebAppV2ListResult": { + "type": "object", + "description": "The response of a AssessedWebAppV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedWebAppV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedWebAppV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedWebAppV2Properties": { + "type": "object", + "description": "Assessed Web app database properties web model.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets or sets the web app type.", + "readOnly": true + }, + "targetSpecificResult": { + "type": "object", + "description": "Gets or sets the target specific result.", + "additionalProperties": { + "$ref": "#/definitions/TargetSpecificResult" + }, + "readOnly": true + }, + "appServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Gets the machine name.", + "readOnly": true + }, + "serverArmId": { + "type": "string", + "description": "Gets or sets the server ARM Id.", + "readOnly": true + }, + "webServerName": { + "type": "string", + "description": "Gets or sets the web server name.", + "readOnly": true + }, + "webAppName": { + "type": "string", + "description": "Gets or sets web app name.", + "readOnly": true + }, + "discoveredWebAppId": { + "type": "string", + "description": "Gets the discovered web app ID.", + "readOnly": true + }, + "discoveredMachineId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed Web app database last updated.", + "readOnly": true + } + }, + "required": [ + "appServicePlanName", + "machineName" + ] + }, + "AssessedWebApplication": { + "type": "object", + "description": "ARM model of Assessed Web Application.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedWebApplicationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedWebApplicationListResult": { + "type": "object", + "description": "The response of a AssessedWebApplication list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedWebApplication items on this page", + "items": { + "$ref": "#/definitions/AssessedWebApplication" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedWebApplicationProperties": { + "type": "object", + "description": "ARM model of Assessed Web Application Properties.", + "allOf": [ + { + "$ref": "#/definitions/AssessedWebApp" + } + ] + }, + "Assessment": { + "type": "object", + "description": "Machine assessment resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessmentDetails": { + "type": "object", + "description": "Data model of Details of Assessment Computation.", + "properties": { + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets last time when rates were queried.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Gets Confidence score.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets date and time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets date and time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Gets assessment status.", + "readOnly": true + } + }, + "required": [ + "createdTimestamp", + "updatedTimestamp", + "status" + ] + }, + "AssessmentListResult": { + "type": "object", + "description": "The response of a Assessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Assessment items on this page", + "items": { + "$ref": "#/definitions/Assessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentOptions": { + "type": "object", + "description": "Assessment options resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentOptionsProperties": { + "type": "object", + "description": "Assessment options properties.", + "properties": { + "vmFamilies": { + "type": "array", + "description": "Dictionary of VM families grouped by vm family name describing the targeted\nazure locations of VM family and the category of the family.", + "items": { + "$ref": "#/definitions/VmFamilyOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstanceVmFamilies": { + "type": "array", + "description": "List of supported VM Families.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "List of supported Azure regions for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "List of supported currencies for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "List of supported Azure offer codes for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ultraDiskVmFamilies": { + "type": "array", + "description": "Ultra disk related assessment options.", + "items": { + "$ref": "#/definitions/UltraDiskAssessmentOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "premiumDiskVmFamilies": { + "type": "array", + "description": "List of VM Families that support premium disks for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "savingsPlanVmFamilies": { + "type": "array", + "description": "List of VM Families that support Savings plan offer for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "List of Azure locations that support Savings plan offer for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "AssessmentProject": { + "type": "object", + "description": "An Assessment project site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ProjectProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AssessmentProjectListResult": { + "type": "object", + "description": "The response of a AssessmentProject list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentProject items on this page", + "items": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentProjectSummary": { + "type": "object", + "description": "Assessment project summary resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessmentProjectSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessmentProjectSummaryListResult": { + "type": "object", + "description": "The response of a AssessmentProjectSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentProjectSummary items on this page", + "items": { + "$ref": "#/definitions/AssessmentProjectSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentProjectSummaryProperties": { + "type": "object", + "description": "Assessment project summary properties class.", + "properties": { + "errorSummaryAffectedEntities": { + "type": "array", + "description": "Gets the Error summary by feature. Contains number of affected Entities per\nfeature.", + "items": { + "$ref": "#/definitions/ErrorSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfPrivateEndpointConnections": { + "type": "integer", + "format": "int32", + "description": "Gets the number of private endpoint connections.", + "readOnly": true + }, + "numberOfGroups": { + "type": "integer", + "format": "int32", + "description": "Gets the number of groups created in this project.", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines part of this project.", + "readOnly": true + }, + "numberOfImportMachines": { + "type": "integer", + "format": "int32", + "description": "Gets the number of import machines part of this project.", + "readOnly": true + }, + "numberOfAssessments": { + "type": "integer", + "format": "int32", + "description": "Gets the number of assessments created in this project.", + "readOnly": true + }, + "lastAssessmentTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the last assessment timestamp.", + "readOnly": true + } + } + }, + "AssessmentProjectUpdate": { + "type": "object", + "description": "The type used for update operations of the AssessmentProject.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AssessmentProjectUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AssessmentProjectUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AssessmentProject.", + "properties": { + "assessmentSolutionId": { + "type": "string", + "description": "Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects." + }, + "projectStatus": { + "$ref": "#/definitions/ProjectStatus", + "description": "Assessment project status." + }, + "customerWorkspaceId": { + "type": "string", + "description": "The ARM id of service map workspace created by customer." + }, + "customerWorkspaceLocation": { + "type": "string", + "description": "Location of service map workspace created by customer." + }, + "publicNetworkAccess": { + "type": "string", + "description": "This value can be set to 'enabled' to avoid breaking changes on existing\ncustomer resources and templates. If set to 'disabled', traffic over public\ninterface is not allowed, and private endpoint connections would be the\nexclusive access method." + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "The ARM id of the storage account used for interactions when public access is\ndisabled." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "AssessmentPropertiesBase": { + "type": "object", + "description": "Base ARM model of Assessment ARM properties.", + "properties": { + "scope": { + "$ref": "#/definitions/AssessmentScopeParameters", + "description": "Gets or sets scope parameters to identify inventory items for assessment." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MutableArmResource" + } + ] + }, + "AssessmentResult": { + "type": "object", + "description": "Assessment results.", + "properties": { + "appServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name." + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the suitability." + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the security suitability." + }, + "webAppSkuName": { + "type": "string", + "description": "Gets or sets the web app sku name." + }, + "webAppSkuSize": { + "type": "string", + "description": "Gets or sets the web app sku size." + } + }, + "required": [ + "appServicePlanName", + "suitability", + "securitySuitability", + "webAppSkuName", + "webAppSkuSize" + ] + }, + "AssessmentScopeParameters": { + "type": "object", + "description": "Data model of Assessment Scope Parameters.", + "properties": { + "serverGroupId": { + "type": "string", + "description": "Gets or sets the server group id." + } + } + }, + "AssessmentSettings": { + "type": "object", + "description": "Base data model of Assessment Settings.", + "properties": { + "azureLocation": { + "type": "string", + "description": "Gets or sets azure location." + }, + "environmentType": { + "$ref": "#/definitions/AzureEnvironmentType", + "description": "Gets or sets environment type." + }, + "licensingProgram": { + "$ref": "#/definitions/LicensingProgram", + "description": "Gets or sets licensing program." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Gets or sets currency." + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Gets or sets discount percentage." + }, + "sizingCriteria": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Gets or sets sizing criteria." + }, + "performanceData": { + "$ref": "#/definitions/PerfDataSettings", + "description": "Gets or sets performance data settings." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Gets or sets scaling factor." + } + }, + "required": [ + "azureLocation", + "environmentType", + "licensingProgram", + "currency", + "sizingCriteria" + ] + }, + "AssessmentSizingCriterion": { + "type": "string", + "description": "Assessment Sizing Criteria.", + "enum": [ + "PerformanceBased", + "AsOnPremises" + ], + "x-ms-enum": { + "name": "AssessmentSizingCriterion", + "modelAsString": true, + "values": [ + { + "name": "PerformanceBased", + "value": "PerformanceBased", + "description": "Performance Data based Sizing." + }, + { + "name": "AsOnPremises", + "value": "AsOnPremises", + "description": "As On Premises or Static Data based Sizing." + } + ] + } + }, + "AssessmentStage": { + "type": "string", + "enum": [ + "InProgress", + "UnderReview", + "Approved" + ], + "x-ms-enum": { + "name": "AssessmentStage", + "modelAsString": true + } + }, + "AssessmentStatus": { + "type": "string", + "description": "Assessment Status.", + "enum": [ + "Created", + "Updated", + "Running", + "Completed", + "Invalid", + "OutOfSync", + "OutDated", + "Deleted" + ], + "x-ms-enum": { + "name": "AssessmentStatus", + "modelAsString": true, + "values": [ + { + "name": "Created", + "value": "Created", + "description": "Assessment is Created." + }, + { + "name": "Updated", + "value": "Updated", + "description": "Assessment is Updated." + }, + { + "name": "Running", + "value": "Running", + "description": "Assessment is currently running." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Assessment is Completed or Ready." + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Assessment is Failed i.e. it is now invalid." + }, + { + "name": "OutOfSync", + "value": "OutOfSync", + "description": "Assessment is Out of Sync." + }, + { + "name": "OutDated", + "value": "OutDated", + "description": "Assessment is Out Dated." + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Assessment is Deleted." + } + ] + } + }, + "AssessmentType": { + "type": "string", + "enum": [ + "Unknown", + "MachineAssessment", + "AvsAssessment", + "SqlAssessment", + "WebAppAssessment" + ], + "x-ms-enum": { + "name": "AssessmentType", + "modelAsString": true + } + }, + "AsyncCommitModeIntent": { + "type": "string", + "enum": [ + "None", + "HighAvailability", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "AsyncCommitModeIntent", + "modelAsString": true + } + }, + "AvsAssessedDisk": { + "type": "object", + "description": "AVS assessed disk web model class.", + "properties": { + "name": { + "type": "string", + "description": "Gets the ID of the disk.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the disk.", + "readOnly": true + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gigabytes Provisioned for a disk in private data center.", + "readOnly": true + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Disk Read Throughput in MB/s.", + "readOnly": true + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Disk Write Throughput in MB/s.", + "readOnly": true + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Read Operations per second.", + "readOnly": true + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Write Operations per second.", + "readOnly": true + } + } + }, + "AvsAssessedMachine": { + "type": "object", + "description": "AVS assessment Assessed Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsAssessedMachineListResult": { + "type": "object", + "description": "The response of a AvsAssessedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessedMachine items on this page", + "items": { + "$ref": "#/definitions/AvsAssessedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessedMachineProperties": { + "type": "object", + "description": "AVS assessed machine properties web model.", + "properties": { + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disks": { + "type": "object", + "description": "List of Disks that were assessed as part of this machine's assessment.", + "additionalProperties": { + "$ref": "#/definitions/AvsAssessedDisk" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "List of Network Adapters that were assessed as part of this machine's\nassessment.", + "additionalProperties": { + "$ref": "#/definitions/AvsAssessedNetworkAdapter" + }, + "readOnly": true + }, + "storageInUseGB": { + "type": "number", + "format": "float", + "description": "Gets the storage in use.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureAvsVmSuitabilityExplanation", + "description": "Gets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureAvsVmSuitabilityDetail", + "description": "Gets the details if machine is not suitable for cloud.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + } + } + }, + "AvsAssessedNetworkAdapter": { + "type": "object", + "description": "Second level object returned as part of AVS AssessedMachine REST resource.", + "properties": { + "macAddress": { + "type": "string", + "description": "Mac address of the NIC.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "IP V4 addresses for the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the network adapter.", + "readOnly": true + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the Received data for Network Adapter in MB/s.\n This value is\nthe percentile of historical data based on options selected in Assessment.", + "readOnly": true + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the Transmitted data for Network Adapter in MB/s.\n This value\nis the percentile of historical data based on options selected in Assessment.", + "readOnly": true + } + } + }, + "AvsAssessment": { + "type": "object", + "description": "AVS assessment resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsAssessmentListResult": { + "type": "object", + "description": "The response of a AvsAssessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessment items on this page", + "items": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessmentOptions": { + "type": "object", + "description": "AVS Assessment options resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AvsAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AvsAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessmentOptionsProperties": { + "type": "object", + "description": "AVS Assessment options properties.", + "properties": { + "avsNodes": { + "type": "array", + "description": "AVS SKU Nodes.", + "items": { + "$ref": "#/definitions/AvsSkuOptions" + }, + "x-ms-identifiers": [] + }, + "failuresToTolerateAndRaidLevelValues": { + "type": "array", + "description": "FTT and Raid level values.", + "items": { + "$ref": "#/definitions/FttAndRaidLevel" + } + }, + "reservedInstanceAvsNodes": { + "type": "array", + "description": "List of AVS nodes for RI.", + "items": { + "$ref": "#/definitions/AzureAvsNodeType" + } + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "List of supported Azure regions for reserved instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "List of supported currencies for reserved instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + } + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "List of supported Azure offer codes for reserved instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + } + } + } + }, + "AvsAssessmentProperties": { + "type": "object", + "description": "Properties of the AVS assessment.", + "properties": { + "assessmentErrorSummary": { + "type": "object", + "description": "Gets the assessment error summary.\n This is the number of machines\naffected by each type of error in this assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "failuresToTolerateAndRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "Failures to tolerate and RAID level in a common property." + }, + "vcpuOversubscription": { + "type": "number", + "format": "float", + "description": "VCPU over subscription." + }, + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "AVS node type." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Total monthly cost.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the Assessment cloud suitability.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureAvsSuitabilityExplanation", + "description": "Gets or sets the Assessment suitability explanation.", + "readOnly": true + }, + "numberOfNodes": { + "type": "integer", + "format": "int32", + "description": "Recommended number of nodes.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "Predicted CPU utilization.", + "readOnly": true + }, + "ramUtilization": { + "type": "number", + "format": "float", + "description": "Predicted RAM utilization.", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization.", + "readOnly": true + }, + "totalCpuCores": { + "type": "number", + "format": "float", + "description": "Predicted total CPU cores used.", + "readOnly": true + }, + "totalRamInGB": { + "type": "number", + "format": "float", + "description": "Predicted total RAM used in GB.", + "readOnly": true + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB.", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of the assessment.", + "readOnly": true + }, + "suitabilitySummary": { + "type": "object", + "description": "Cloud suitability summary for all the machines in the assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "memOvercommit": { + "type": "number", + "format": "float", + "description": "Memory overcommit." + }, + "dedupeCompression": { + "type": "number", + "format": "float", + "description": "De-duplication compression." + }, + "limitingFactor": { + "type": "string", + "description": "Limiting factor.", + "readOnly": true + }, + "isStretchClusterEnabled": { + "type": "boolean", + "description": "Is Stretch Cluster Enabled." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment.", + "readOnly": true + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment.", + "readOnly": true + }, + "azureLocation": { + "$ref": "#/definitions/AzureLocation", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer code according to which cost estimation is done." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when the Azure Prices were queried. Date-Time represented in ISO-8601\nformat.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "AvsNodeSummary": { + "type": "object", + "description": "Azure Avs Node summary.", + "properties": { + "serversSuitableForMigration": { + "type": "integer", + "format": "int32", + "description": "Servers suitable for migration.", + "readOnly": true + }, + "totalNumberOfServers": { + "type": "integer", + "format": "int32", + "description": "The total number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The total number of Avs VM cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "The total memory in GB.", + "readOnly": true + }, + "avsNodeCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedAvsNodeTypeSummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedAvsNodeTypeSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AvsSkuOptions": { + "type": "object", + "description": "AVS SKU specific options.", + "properties": { + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "AVS Node type." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where this node type is available.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + } + } + }, + "AvsSummary": { + "type": "object", + "description": "Avs summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsSummaryListResult": { + "type": "object", + "description": "The response of a AvsSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsSummary items on this page", + "items": { + "$ref": "#/definitions/AvsSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsSummaryProperties": { + "type": "object", + "description": "Avs summary properties class.", + "properties": { + "azureAvsSummary": { + "$ref": "#/definitions/AzureAvsSummary", + "description": "The Azure Avs summary.", + "readOnly": true + }, + "onPremisesAvsSummary": { + "$ref": "#/definitions/OnPremisesIaasSummary", + "description": "The on premises IaaS summary.", + "readOnly": true + } + } + }, + "AzureAppServiceContainerSummary": { + "type": "object", + "description": "Shows Azure App Service Container summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/WebAppTargetSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureAppServiceSummary": { + "type": "object", + "description": "Shows Azure App Service summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/AppServiceSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureAvsNodeType": { + "type": "string", + "enum": [ + "Unknown", + "AV36" + ], + "x-ms-enum": { + "name": "AzureAvsNodeType", + "modelAsString": true + } + }, + "AzureAvsSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "UnsupportedLocationForSelectedNode" + ], + "x-ms-enum": { + "name": "AzureAvsSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureAvsSummary": { + "type": "object", + "description": "The Azure AVS summary.", + "properties": { + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "avsNodeSummary": { + "$ref": "#/definitions/AvsNodeSummary", + "description": "Avs virtual machine summary.", + "readOnly": true + }, + "avsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzureAvsVmSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "PercentageOfCoresUtilizedMissing", + "PercentageOfMemoryUtilizedMissing", + "PercentageOfCoresUtilizedOutOfRange", + "PercentageOfMemoryUtilizedOutOfRange", + "PercentageOfStorageUtilizedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureAvsVmSuitabilityDetail", + "modelAsString": true + } + }, + "AzureAvsVmSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "IpV6NotSupported", + "UnsupportedOperatingSystem" + ], + "x-ms-enum": { + "name": "AzureAvsVmSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureCurrency": { + "type": "string", + "description": "Currency for Azure.", + "enum": [ + "Unknown", + "USD", + "DKK", + "CAD", + "IDR", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SAR", + "ZAR", + "SEK", + "TRY", + "GBP", + "MXN", + "MYR", + "INR", + "HKD", + "BRL", + "TWD", + "EUR", + "CHF", + "ARS", + "AUD", + "CNY" + ], + "x-ms-enum": { + "name": "AzureCurrency", + "modelAsString": true + } + }, + "AzureDiskSize": { + "type": "string", + "enum": [ + "Unknown", + "Standard_S4", + "Standard_S6", + "Standard_S10", + "Standard_S15", + "Standard_S20", + "Standard_S30", + "Standard_S40", + "Standard_S50", + "Standard_S60", + "Standard_S70", + "Standard_S80", + "Premium_P4", + "Premium_P6", + "Premium_P10", + "Premium_P15", + "Premium_P20", + "Premium_P30", + "Premium_P40", + "Premium_P50", + "Premium_P60", + "Premium_P70", + "Premium_P80", + "StandardSSD_E10", + "StandardSSD_E15", + "StandardSSD_E20", + "StandardSSD_E30", + "StandardSSD_E40", + "StandardSSD_E50", + "StandardSSD_E60", + "StandardSSD_E70", + "StandardSSD_E80", + "StandardSSD_E4", + "StandardSSD_E6", + "StandardSSD_E1", + "StandardSSD_E2", + "StandardSSD_E3", + "Premium_P1", + "Premium_P2", + "Premium_P3", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureDiskSize", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "StandardS4", + "value": "Standard_S4" + }, + { + "name": "StandardS6", + "value": "Standard_S6" + }, + { + "name": "StandardS10", + "value": "Standard_S10" + }, + { + "name": "StandardS15", + "value": "Standard_S15" + }, + { + "name": "StandardS20", + "value": "Standard_S20" + }, + { + "name": "StandardS30", + "value": "Standard_S30" + }, + { + "name": "StandardS40", + "value": "Standard_S40" + }, + { + "name": "StandardS50", + "value": "Standard_S50" + }, + { + "name": "StandardS60", + "value": "Standard_S60" + }, + { + "name": "StandardS70", + "value": "Standard_S70" + }, + { + "name": "StandardS80", + "value": "Standard_S80" + }, + { + "name": "PremiumP4", + "value": "Premium_P4" + }, + { + "name": "PremiumP6", + "value": "Premium_P6" + }, + { + "name": "PremiumP10", + "value": "Premium_P10" + }, + { + "name": "PremiumP15", + "value": "Premium_P15" + }, + { + "name": "PremiumP20", + "value": "Premium_P20" + }, + { + "name": "PremiumP30", + "value": "Premium_P30" + }, + { + "name": "PremiumP40", + "value": "Premium_P40" + }, + { + "name": "PremiumP50", + "value": "Premium_P50" + }, + { + "name": "PremiumP60", + "value": "Premium_P60" + }, + { + "name": "PremiumP70", + "value": "Premium_P70" + }, + { + "name": "PremiumP80", + "value": "Premium_P80" + }, + { + "name": "StandardSSDE10", + "value": "StandardSSD_E10" + }, + { + "name": "StandardSSDE15", + "value": "StandardSSD_E15" + }, + { + "name": "StandardSSDE20", + "value": "StandardSSD_E20" + }, + { + "name": "StandardSSDE30", + "value": "StandardSSD_E30" + }, + { + "name": "StandardSSDE40", + "value": "StandardSSD_E40" + }, + { + "name": "StandardSSDE50", + "value": "StandardSSD_E50" + }, + { + "name": "StandardSSDE60", + "value": "StandardSSD_E60" + }, + { + "name": "StandardSSDE70", + "value": "StandardSSD_E70" + }, + { + "name": "StandardSSDE80", + "value": "StandardSSD_E80" + }, + { + "name": "StandardSSDE4", + "value": "StandardSSD_E4" + }, + { + "name": "StandardSSDE6", + "value": "StandardSSD_E6" + }, + { + "name": "StandardSSDE1", + "value": "StandardSSD_E1" + }, + { + "name": "StandardSSDE2", + "value": "StandardSSD_E2" + }, + { + "name": "StandardSSDE3", + "value": "StandardSSD_E3" + }, + { + "name": "PremiumP1", + "value": "Premium_P1" + }, + { + "name": "PremiumP2", + "value": "Premium_P2" + }, + { + "name": "PremiumP3", + "value": "Premium_P3" + }, + { + "name": "Ultra", + "value": "Ultra" + }, + { + "name": "PremiumV2", + "value": "PremiumV2" + } + ] + } + }, + "AzureDiskSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "NumberOfReadOperationsPerSecondMissing", + "NumberOfWriteOperationsPerSecondMissing", + "MegabytesPerSecondOfReadMissing", + "MegabytesPerSecondOfWriteMissing", + "DiskGigabytesConsumedMissing", + "DiskGigabytesProvisionedMissing", + "NumberOfReadOperationsPerSecondOutOfRange", + "NumberOfWriteOperationsPerSecondOutOfRange", + "MegabytesPerSecondOfReadOutOfRange", + "MegabytesPerSecondOfWriteOutOfRange", + "DiskGigabytesConsumedOutOfRange", + "DiskGigabytesProvisionedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureDiskSuitabilityDetail", + "modelAsString": true + } + }, + "AzureDiskSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "DiskSizeGreaterThanSupported", + "NoSuitableDiskSizeForIops", + "NoSuitableDiskSizeForThroughput", + "NoDiskSizeFoundInSelectedLocation", + "NoDiskSizeFoundForSelectedRedundancy", + "InternalErrorOccurredForDiskEvaluation", + "NoEaPriceFoundForDiskSize" + ], + "x-ms-enum": { + "name": "AzureDiskSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureDiskType": { + "type": "string", + "enum": [ + "Unknown", + "Standard", + "StandardSSD", + "Premium", + "StandardOrPremium", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureDiskType", + "modelAsString": true + } + }, + "AzureEnvironmentType": { + "type": "string", + "description": "Environment Type for Azure.", + "enum": [ + "Unknown", + "DevTest", + "Production" + ], + "x-ms-enum": { + "name": "AzureEnvironmentType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "DevTest", + "value": "DevTest", + "description": "Development or Test Environment." + }, + { + "name": "Production", + "value": "Production", + "description": "Production Environment." + } + ] + } + }, + "AzureHybridUseBenefit": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "AzureHybridUseBenefit", + "modelAsString": true + } + }, + "AzureIaasSqlSummary": { + "type": "object", + "description": "Azure Iaas sql server summary.", + "properties": { + "totalSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Total SQL entities.", + "readOnly": true + }, + "suitableSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Suitable SQL entities.", + "readOnly": true + }, + "azureSqlCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedVmFamilySummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedVmFamilySummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "costByStorageType": { + "type": "array", + "description": "The cost by storage type.", + "items": { + "$ref": "#/definitions/CostByStorageType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureIaasSummary": { + "type": "object", + "description": "The Azure IaaS summary.", + "properties": { + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "azureIaasVmSummary": { + "$ref": "#/definitions/AzureIaasVmSummary", + "description": "Azure Iaas virtual machine summary.", + "readOnly": true + }, + "azureIaasSqlSummary": { + "$ref": "#/definitions/AzureIaasSqlSummary", + "description": "Azure Iaas sql server summary.", + "readOnly": true + }, + "azureIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzureIaasVmSummary": { + "type": "object", + "description": "Azure Iaas virtual machine summary.", + "properties": { + "serversSuitableForMigration": { + "type": "integer", + "format": "int32", + "description": "Servers suitable for migration.", + "readOnly": true + }, + "totalNumberOfServers": { + "type": "integer", + "format": "int32", + "description": "The total number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The total number of IaaS VM cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "The total memory in GB.", + "readOnly": true + }, + "azureVmCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedVmFamilySummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedVmFamilySummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "costByStorageType": { + "type": "array", + "description": "The cost by storage type.", + "items": { + "$ref": "#/definitions/CostByStorageType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureKubernetesServiceSummary": { + "type": "object", + "description": "Shows Azure Kubernetes Service summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/WebAppTargetSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureLocation": { + "type": "string", + "description": "Location for Azure.", + "enum": [ + "Unknown", + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "GermanyCentral", + "GermanyNortheast", + "ChinaNorth", + "ChinaEast", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia", + "USDoDCentral", + "USDoDEast", + "FranceCentral", + "AustraliaCentral", + "SouthAfricaNorth", + "FranceSouth", + "AustraliaCentral2", + "SouthAfricaWest", + "GermanyNorth", + "GermanyWestCentral", + "NorwayEast", + "NorwayWest", + "ChinaEast2", + "ChinaNorth2", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UAECentral", + "UsNatEast", + "UsNatWest", + "UsSecEast", + "UsSecCentral", + "UsSecWest", + "SwedenCentral", + "QatarCentral" + ], + "x-ms-enum": { + "name": "AzureLocation", + "modelAsString": true + } + }, + "AzureManagedDiskSkuDTO": { + "type": "object", + "description": "Class representing an Azure Managed Disk SKU.", + "properties": { + "diskType": { + "$ref": "#/definitions/AzureManagedDiskSkuDTODiskType", + "description": "Gets the Type (\"tier\") of disk - e.g. standard, premium, ultra.", + "readOnly": true + }, + "diskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the Size of the managed disk - e.g. P30, P40.", + "readOnly": true + }, + "diskRedundancy": { + "$ref": "#/definitions/AzureManagedDiskSkuDTODiskRedundancy", + "description": "Gets disk redundancy - e.g. LRS, ZRS.", + "readOnly": true + }, + "storageCost": { + "type": "number", + "format": "float", + "description": "Gets the managed disk storage cost.", + "readOnly": true + }, + "recommendedSizeInGib": { + "type": "number", + "format": "float", + "description": "Gets the recommended in GB of the managed disk.", + "readOnly": true + }, + "recommendedThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended throughput in MBPS of the managed disk.", + "readOnly": true + }, + "recommendedIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended IOPS of the managed disk.", + "readOnly": true + } + } + }, + "AzureManagedDiskSkuDTODiskRedundancy": { + "type": "string", + "enum": [ + "Unknown", + "LRS", + "ZRS" + ], + "x-ms-enum": { + "name": "AzureManagedDiskSkuDTODiskRedundancy", + "modelAsString": true + } + }, + "AzureManagedDiskSkuDTODiskType": { + "type": "string", + "enum": [ + "Unknown", + "Standard", + "StandardSSD", + "Premium", + "StandardOrPremium", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureManagedDiskSkuDTODiskType", + "modelAsString": true + } + }, + "AzureNetworkAdapterSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "MegabytesOfDataTransmittedMissing", + "MegabytesOfDataTransmittedOutOfRange", + "MegabytesOfDataRecievedMissing", + "MegabytesOfDataRecievedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureNetworkAdapterSuitabilityDetail", + "modelAsString": true + } + }, + "AzureNetworkAdapterSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "InternalErrorOccurred" + ], + "x-ms-enum": { + "name": "AzureNetworkAdapterSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureOfferCode": { + "type": "string", + "enum": [ + "Unknown", + "MSAZR0003P", + "MSAZR0044P", + "MSAZR0059P", + "MSAZR0060P", + "MSAZR0062P", + "MSAZR0063P", + "MSAZR0064P", + "MSAZR0029P", + "MSAZR0022P", + "MSAZR0023P", + "MSAZR0148P", + "MSAZR0025P", + "MSAZR0036P", + "MSAZR0120P", + "MSAZR0121P", + "MSAZR0122P", + "MSAZR0123P", + "MSAZR0124P", + "MSAZR0125P", + "MSAZR0126P", + "MSAZR0127P", + "MSAZR0128P", + "MSAZR0129P", + "MSAZR0130P", + "MSAZR0111P", + "MSAZR0144P", + "MSAZR0149P", + "MSMCAZR0044P", + "MSMCAZR0059P", + "MSMCAZR0060P", + "MSMCAZR0063P", + "MSMCAZR0120P", + "MSMCAZR0121P", + "MSMCAZR0125P", + "MSMCAZR0128P", + "MSAZRDE0003P", + "MSAZRDE0044P", + "MSAZRUSGOV0003P", + "EA", + "MSAZR0243P", + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "x-ms-enum": { + "name": "AzureOfferCode", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "Msazr0003P", + "value": "MSAZR0003P" + }, + { + "name": "Msazr0044P", + "value": "MSAZR0044P" + }, + { + "name": "Msazr0059P", + "value": "MSAZR0059P" + }, + { + "name": "Msazr0060P", + "value": "MSAZR0060P" + }, + { + "name": "Msazr0062P", + "value": "MSAZR0062P" + }, + { + "name": "Msazr0063P", + "value": "MSAZR0063P" + }, + { + "name": "Msazr0064P", + "value": "MSAZR0064P" + }, + { + "name": "Msazr0029P", + "value": "MSAZR0029P" + }, + { + "name": "Msazr0022P", + "value": "MSAZR0022P" + }, + { + "name": "Msazr0023P", + "value": "MSAZR0023P" + }, + { + "name": "Msazr0148P", + "value": "MSAZR0148P" + }, + { + "name": "Msazr0025P", + "value": "MSAZR0025P" + }, + { + "name": "Msazr0036P", + "value": "MSAZR0036P" + }, + { + "name": "Msazr0120P", + "value": "MSAZR0120P" + }, + { + "name": "Msazr0121P", + "value": "MSAZR0121P" + }, + { + "name": "Msazr0122P", + "value": "MSAZR0122P" + }, + { + "name": "Msazr0123P", + "value": "MSAZR0123P" + }, + { + "name": "Msazr0124P", + "value": "MSAZR0124P" + }, + { + "name": "Msazr0125P", + "value": "MSAZR0125P" + }, + { + "name": "Msazr0126P", + "value": "MSAZR0126P" + }, + { + "name": "Msazr0127P", + "value": "MSAZR0127P" + }, + { + "name": "Msazr0128P", + "value": "MSAZR0128P" + }, + { + "name": "Msazr0129P", + "value": "MSAZR0129P" + }, + { + "name": "Msazr0130P", + "value": "MSAZR0130P" + }, + { + "name": "Msazr0111P", + "value": "MSAZR0111P" + }, + { + "name": "Msazr0144P", + "value": "MSAZR0144P" + }, + { + "name": "Msazr0149P", + "value": "MSAZR0149P" + }, + { + "name": "Msmcazr0044P", + "value": "MSMCAZR0044P" + }, + { + "name": "Msmcazr0059P", + "value": "MSMCAZR0059P" + }, + { + "name": "Msmcazr0060P", + "value": "MSMCAZR0060P" + }, + { + "name": "Msmcazr0063P", + "value": "MSMCAZR0063P" + }, + { + "name": "Msmcazr0120P", + "value": "MSMCAZR0120P" + }, + { + "name": "Msmcazr0121P", + "value": "MSMCAZR0121P" + }, + { + "name": "Msmcazr0125P", + "value": "MSMCAZR0125P" + }, + { + "name": "Msmcazr0128P", + "value": "MSMCAZR0128P" + }, + { + "name": "Msazrde0003P", + "value": "MSAZRDE0003P" + }, + { + "name": "Msazrde0044P", + "value": "MSAZRDE0044P" + }, + { + "name": "Msazrusgov0003P", + "value": "MSAZRUSGOV0003P" + }, + { + "name": "EA", + "value": "EA" + }, + { + "name": "Msazr0243P", + "value": "MSAZR0243P" + }, + { + "name": "SavingsPlan1Year", + "value": "SavingsPlan1Year" + }, + { + "name": "SavingsPlan3Year", + "value": "SavingsPlan3Year" + } + ] + } + }, + "AzurePaasSummary": { + "type": "object", + "description": "Shows the PaaS Azure summary.", + "properties": { + "totalSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Number of Sql instances.", + "readOnly": true + }, + "suitableSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Suitable Sql instances.", + "readOnly": true + }, + "totalWebApps": { + "type": "integer", + "format": "int32", + "description": "Number of web applications.", + "readOnly": true + }, + "suitableWebApps": { + "type": "integer", + "format": "int32", + "description": "Suitable web applications.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Number of cores.", + "readOnly": true + }, + "memory": { + "type": "number", + "format": "float", + "description": "Memory Utilization.", + "readOnly": true + }, + "storage": { + "type": "number", + "format": "float", + "description": "Storage Utilization.", + "readOnly": true + }, + "estimatedCostByTarget": { + "$ref": "#/definitions/EstimatedCostByTarget", + "description": "Shows the estimated cost by target.", + "readOnly": true + }, + "estimatedSqlServerLicensingCost": { + "type": "number", + "format": "float", + "description": "estimated SQL Server licensing cost.", + "readOnly": true + }, + "azureSqlSummary": { + "$ref": "#/definitions/AzureSqlSummary", + "description": "Shows the Azure SQL details.", + "readOnly": true + }, + "azureAppServiceSummary": { + "$ref": "#/definitions/AzureAppServiceSummary", + "description": "Shows Azure App Service summary.", + "readOnly": true + }, + "azureAppServiceContainerSummary": { + "$ref": "#/definitions/AzureAppServiceContainerSummary", + "description": "Shows Azure App Service Container summary.", + "readOnly": true + }, + "azureKubernetesServiceSummary": { + "$ref": "#/definitions/AzureKubernetesServiceSummary", + "description": "Shows Azure Kubernetes Service summary.", + "readOnly": true + }, + "totalAzurePaasCost": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzurePricingTier": { + "type": "string", + "enum": [ + "Standard", + "Basic" + ], + "x-ms-enum": { + "name": "AzurePricingTier", + "modelAsString": true + } + }, + "AzureQuorumWitnessDTO": { + "type": "object", + "description": "Quorum Witness.", + "properties": { + "quorumWitnessType": { + "$ref": "#/definitions/AzureQuorumWitnessDTOQuorumWitnessType", + "description": "Gets quorum witness type.", + "readOnly": true + } + } + }, + "AzureQuorumWitnessDTOQuorumWitnessType": { + "type": "string", + "enum": [ + "Unknown", + "Cloud", + "Disk" + ], + "x-ms-enum": { + "name": "AzureQuorumWitnessDTOQuorumWitnessType", + "modelAsString": true + } + }, + "AzureReservedInstance": { + "type": "string", + "enum": [ + "None", + "RI1Year", + "RI3Year" + ], + "x-ms-enum": { + "name": "AzureReservedInstance", + "modelAsString": true + } + }, + "AzureResourceProperties": { + "type": "object", + "description": "Common properties for all azure tracked and proxy resources.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "AzureResourceProperties2": { + "type": "object", + "description": "Common properties for all azure tracked and proxy resources.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState2", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AzureSecurityOfferingType": { + "type": "string", + "enum": [ + "NO", + "MDC" + ], + "x-ms-enum": { + "name": "AzureSecurityOfferingType", + "modelAsString": true + } + }, + "AzureSettings": { + "type": "object", + "description": "Azure settings for a business case.", + "properties": { + "targetLocation": { + "type": "string", + "description": "Gets or sets azure location." + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Gets azure Discount percentage.", + "minimum": 0, + "maximum": 100 + }, + "currency": { + "$ref": "#/definitions/BusinessCaseCurrency", + "description": "Business case Currency.", + "default": "USD" + }, + "businessCaseType": { + "$ref": "#/definitions/MigrationStrategy", + "description": "Migration Strategy.", + "default": "OptimizeForCost" + }, + "workloadDiscoverySource": { + "$ref": "#/definitions/DiscoverySource", + "description": "Workload discovery source.", + "default": "Appliance" + }, + "performanceDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets start time to use for performance." + }, + "performanceDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets end time to use for performance." + }, + "comfortFactor": { + "type": "number", + "format": "float", + "description": "Gets comfort factor.", + "default": 1 + }, + "performanceUtilizationPercentile": { + "type": "number", + "format": "float", + "description": "Gets utilization percentile for performance.", + "default": 95, + "minimum": 0, + "maximum": 100 + }, + "perYearMigrationCompletionPercentage": { + "type": "object", + "description": "Gets migration completion percentage per year.", + "additionalProperties": { + "format": "float", + "type": "number" + } + }, + "infrastructureGrowthRate": { + "type": "number", + "format": "float", + "description": "Gets infrastructure growth rate.", + "default": 5, + "minimum": 0, + "maximum": 100 + }, + "wacc": { + "type": "number", + "format": "float", + "description": "Gets wACC percentage.", + "minimum": 0, + "maximum": 100 + }, + "networkCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets network cost percentage.", + "default": 5, + "minimum": 0, + "maximum": 100 + }, + "iaasLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets IaaS labour cost percentage.", + "default": 75, + "minimum": 0, + "maximum": 100 + }, + "paasLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets PaaS labour cost percentage.", + "default": 60, + "minimum": 0, + "maximum": 100 + }, + "avsLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets Avs labour cost percentage.", + "default": 75, + "minimum": 0, + "maximum": 100 + }, + "savingsOption": { + "$ref": "#/definitions/SavingsOption", + "description": "Gets the business case savings option type.", + "default": "RI3Year" + } + }, + "required": [ + "targetLocation", + "currency" + ] + }, + "AzureSqlDataBaseType": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "SingleDatabase", + "ElasticPool" + ], + "x-ms-enum": { + "name": "AzureSqlDataBaseType", + "modelAsString": true + } + }, + "AzureSqlIaasSkuDTO": { + "type": "object", + "description": "Class representing Azure SQL IAAS SKU.", + "properties": { + "virtualMachineSize": { + "$ref": "#/definitions/AzureVirtualMachineSkuDTO", + "description": "Gets the The Azure Compute Virtual Machine.", + "readOnly": true + }, + "dataDiskSizes": { + "type": "array", + "description": "Gets the The list of data disk sizes.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "logDiskSizes": { + "type": "array", + "description": "Gets the The list of log disk sizes.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "azureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets the target type.", + "readOnly": true + } + } + }, + "AzureSqlInstanceType": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "SingleInstance", + "InstancePools" + ], + "x-ms-enum": { + "name": "AzureSqlInstanceType", + "modelAsString": true + } + }, + "AzureSqlPaasSkuDTO": { + "type": "object", + "description": "Class representing Azure SQL PAAS SKU.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets the service tier.", + "readOnly": true + }, + "azureSqlComputeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets the compute tier.", + "readOnly": true + }, + "azureSqlHardwareGeneration": { + "$ref": "#/definitions/HardwareGeneration", + "description": "Gets the hardware generation.", + "readOnly": true + }, + "storageMaxSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the storage maximum size in megabytes.", + "readOnly": true + }, + "predictedDataSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the predicted data size in megabytes in the Azure SQL, will impact the\nbilling cost.", + "readOnly": true + }, + "predictedLogSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the predicted log size in megabytes in the Azure SQL, will impact the\nbilling cost.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the number of cores.", + "readOnly": true + }, + "azureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets the target type.", + "readOnly": true + } + } + }, + "AzureSqlPurchaseModel": { + "type": "string", + "enum": [ + "Unknown", + "VCore", + "DTU" + ], + "x-ms-enum": { + "name": "AzureSqlPurchaseModel", + "modelAsString": true + } + }, + "AzureSqlServiceTier": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "GeneralPurpose", + "BusinessCritical", + "HyperScale" + ], + "x-ms-enum": { + "name": "AzureSqlServiceTier", + "modelAsString": true + } + }, + "AzureSqlSummary": { + "type": "object", + "description": "Shows the Azure SQL details.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommended offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTier": { + "type": "array", + "description": "Distribution by service tiers, retaining just to support older Business cases.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTierForSqlMi": { + "type": "array", + "description": "Distribution by service tiers for SQL MI.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTierForSqlDb": { + "type": "array", + "description": "Distribution by service tiers for SQL DB.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureStorageRedundancy": { + "type": "string", + "enum": [ + "Unknown", + "LocallyRedundant", + "ZoneRedundant", + "GeoRedundant", + "ReadAccessGeoRedundant" + ], + "x-ms-enum": { + "name": "AzureStorageRedundancy", + "modelAsString": true + } + }, + "AzureVirtualMachineSkuDTO": { + "type": "object", + "description": "Azure Virtual Machine SKU.", + "properties": { + "azureVmFamily": { + "$ref": "#/definitions/AzureVmFamily", + "description": "Gets the Virtual Machine Family, for example : standardMSFamily.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the Compute Size in vCores.", + "readOnly": true + }, + "azureSkuName": { + "$ref": "#/definitions/AzureVmSize", + "description": "Gets the Virtual Machine SKU name,: E.g. : Standard_F16s.", + "readOnly": true + }, + "availableCores": { + "type": "integer", + "format": "int32", + "description": "Gets the Available vCores. This can be less than the vCores in the Constrained\nvCPU VM Sizes.", + "readOnly": true + }, + "maxNetworkInterfaces": { + "type": "integer", + "format": "int32", + "description": "Gets the Max network interfaces.", + "readOnly": true + } + } + }, + "AzureVmCategory": { + "type": "string", + "description": "Azure VM Category.", + "enum": [ + "All", + "ComputeOptimized", + "GeneralPurpose", + "GpuOptimized", + "HighPerformanceCompute", + "MemoryOptimized", + "StorageOptimized", + "Isolated" + ], + "x-ms-enum": { + "name": "AzureVmCategory", + "modelAsString": true, + "values": [ + { + "name": "All", + "value": "All", + "description": "Indicates All categories of VM." + }, + { + "name": "ComputeOptimized", + "value": "ComputeOptimized", + "description": "Compute Optimized." + }, + { + "name": "GeneralPurpose", + "value": "GeneralPurpose", + "description": "General Purpose." + }, + { + "name": "GpuOptimized", + "value": "GpuOptimized", + "description": "GPU Optimized." + }, + { + "name": "HighPerformanceCompute", + "value": "HighPerformanceCompute", + "description": "High Performance Compute." + }, + { + "name": "MemoryOptimized", + "value": "MemoryOptimized", + "description": "Memory Optimized." + }, + { + "name": "StorageOptimized", + "value": "StorageOptimized", + "description": "Storage Optimized." + }, + { + "name": "Isolated", + "value": "Isolated", + "description": "Isolated VM." + } + ] + } + }, + "AzureVmFamily": { + "type": "string", + "enum": [ + "Unknown", + "Basic_A0_A4", + "Standard_A0_A7", + "Standard_A8_A11", + "Av2_series", + "D_series", + "Dv2_series", + "DS_series", + "DSv2_series", + "F_series", + "Fs_series", + "G_series", + "GS_series", + "H_series", + "Ls_series", + "Dsv3_series", + "Dv3_series", + "Fsv2_series", + "Ev3_series", + "Esv3_series", + "M_series", + "DC_Series", + "Lsv2_series", + "Ev4_series", + "Esv4_series", + "Edv4_series", + "Edsv4_series", + "Dv4_series", + "Dsv4_series", + "Ddv4_series", + "Ddsv4_series", + "Easv4_series", + "Dasv4_series", + "Mv2_series", + "Eav4_series", + "Dav4_series", + "Msv2_series", + "Mdsv2_series", + "Dv5_series", + "Dsv5_series", + "Ddv5_series", + "Ddsv5_series", + "Dasv5_series", + "Dadsv5_series", + "Ev5_series", + "Esv5_series", + "Edv5_series", + "Edsv5_series", + "Easv5_series", + "Eadsv5_series", + "Ebsv5_series", + "Ebdsv5_series" + ], + "x-ms-enum": { + "name": "AzureVmFamily", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "BasicA0A4", + "value": "Basic_A0_A4" + }, + { + "name": "StandardA0A7", + "value": "Standard_A0_A7" + }, + { + "name": "StandardA8A11", + "value": "Standard_A8_A11" + }, + { + "name": "Av2Series", + "value": "Av2_series" + }, + { + "name": "DSeries", + "value": "D_series" + }, + { + "name": "Dv2Series", + "value": "Dv2_series" + }, + { + "name": "DSSeries", + "value": "DS_series" + }, + { + "name": "DSv2Series", + "value": "DSv2_series" + }, + { + "name": "FSeries", + "value": "F_series" + }, + { + "name": "FsSeries", + "value": "Fs_series" + }, + { + "name": "GSeries", + "value": "G_series" + }, + { + "name": "GSSeries", + "value": "GS_series" + }, + { + "name": "HSeries", + "value": "H_series" + }, + { + "name": "LsSeries", + "value": "Ls_series" + }, + { + "name": "Dsv3Series", + "value": "Dsv3_series" + }, + { + "name": "Dv3Series", + "value": "Dv3_series" + }, + { + "name": "Fsv2Series", + "value": "Fsv2_series" + }, + { + "name": "Ev3Series", + "value": "Ev3_series" + }, + { + "name": "Esv3Series", + "value": "Esv3_series" + }, + { + "name": "MSeries", + "value": "M_series" + }, + { + "name": "DCSeries", + "value": "DC_Series" + }, + { + "name": "Lsv2Series", + "value": "Lsv2_series" + }, + { + "name": "Ev4Series", + "value": "Ev4_series" + }, + { + "name": "Esv4Series", + "value": "Esv4_series" + }, + { + "name": "Edv4Series", + "value": "Edv4_series" + }, + { + "name": "Edsv4Series", + "value": "Edsv4_series" + }, + { + "name": "Dv4Series", + "value": "Dv4_series" + }, + { + "name": "Dsv4Series", + "value": "Dsv4_series" + }, + { + "name": "Ddv4Series", + "value": "Ddv4_series" + }, + { + "name": "Ddsv4Series", + "value": "Ddsv4_series" + }, + { + "name": "Easv4Series", + "value": "Easv4_series" + }, + { + "name": "Dasv4Series", + "value": "Dasv4_series" + }, + { + "name": "Mv2Series", + "value": "Mv2_series" + }, + { + "name": "Eav4Series", + "value": "Eav4_series" + }, + { + "name": "Dav4Series", + "value": "Dav4_series" + }, + { + "name": "Msv2Series", + "value": "Msv2_series" + }, + { + "name": "Mdsv2Series", + "value": "Mdsv2_series" + }, + { + "name": "Dv5Series", + "value": "Dv5_series" + }, + { + "name": "Dsv5Series", + "value": "Dsv5_series" + }, + { + "name": "Ddv5Series", + "value": "Ddv5_series" + }, + { + "name": "Ddsv5Series", + "value": "Ddsv5_series" + }, + { + "name": "Dasv5Series", + "value": "Dasv5_series" + }, + { + "name": "Dadsv5Series", + "value": "Dadsv5_series" + }, + { + "name": "Ev5Series", + "value": "Ev5_series" + }, + { + "name": "Esv5Series", + "value": "Esv5_series" + }, + { + "name": "Edv5Series", + "value": "Edv5_series" + }, + { + "name": "Edsv5Series", + "value": "Edsv5_series" + }, + { + "name": "Easv5Series", + "value": "Easv5_series" + }, + { + "name": "Eadsv5Series", + "value": "Eadsv5_series" + }, + { + "name": "Ebsv5Series", + "value": "Ebsv5_series" + }, + { + "name": "Ebdsv5Series", + "value": "Ebdsv5_series" + } + ] + } + }, + "AzureVmSize": { + "type": "string", + "enum": [ + "Unknown", + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_DC2s", + "Standard_DC4s", + "Standard_E20_v3", + "Standard_E20s_v3", + "Standard_E64i_v3", + "Standard_E64is_v3", + "Standard_M8ms", + "Standard_M16ms", + "Standard_M32ls", + "Standard_M32ms", + "Standard_M32ts", + "Standard_M64", + "Standard_M64ls", + "Standard_M64m", + "Standard_M128", + "Standard_M128m", + "Standard_L8s_v2", + "Standard_L16s_v2", + "Standard_L32s_v2", + "Standard_L48s_v2", + "Standard_L64s_v2", + "Standard_L80s_v2", + "Standard_D2_v4", + "Standard_D4_v4", + "Standard_D8_v4", + "Standard_D16_v4", + "Standard_D32_v4", + "Standard_D48_v4", + "Standard_D64_v4", + "Standard_D2s_v4", + "Standard_D4s_v4", + "Standard_D8s_v4", + "Standard_D16s_v4", + "Standard_D32s_v4", + "Standard_D48s_v4", + "Standard_D64s_v4", + "Standard_D2d_v4", + "Standard_D4d_v4", + "Standard_D8d_v4", + "Standard_D16d_v4", + "Standard_D32d_v4", + "Standard_D48d_v4", + "Standard_D64d_v4", + "Standard_D2ds_v4", + "Standard_D4ds_v4", + "Standard_D8ds_v4", + "Standard_D16ds_v4", + "Standard_D32ds_v4", + "Standard_D48ds_v4", + "Standard_D64ds_v4", + "Standard_E2_v4", + "Standard_E4_v4", + "Standard_E8_v4", + "Standard_E16_v4", + "Standard_E20_v4", + "Standard_E32_v4", + "Standard_E48_v4", + "Standard_E64_v4", + "Standard_E2s_v4", + "Standard_E4s_v4", + "Standard_E8s_v4", + "Standard_E16s_v4", + "Standard_E20s_v4", + "Standard_E32s_v4", + "Standard_E48s_v4", + "Standard_E64s_v4", + "Standard_E2d_v4", + "Standard_E4d_v4", + "Standard_E8d_v4", + "Standard_E16d_v4", + "Standard_E20d_v4", + "Standard_E32d_v4", + "Standard_E48d_v4", + "Standard_E64d_v4", + "Standard_E2ds_v4", + "Standard_E4ds_v4", + "Standard_E8ds_v4", + "Standard_E16ds_v4", + "Standard_E20ds_v4", + "Standard_E32ds_v4", + "Standard_E48ds_v4", + "Standard_E64ds_v4", + "Standard_E2as_v4", + "Standard_E4as_v4", + "Standard_E8as_v4", + "Standard_E16as_v4", + "Standard_E20as_v4", + "Standard_E32as_v4", + "Standard_E48as_v4", + "Standard_E64as_v4", + "Standard_E96as_v4", + "Standard_D2as_v4", + "Standard_D4as_v4", + "Standard_D8as_v4", + "Standard_D16as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D64as_v4", + "Standard_D96as_v4", + "Standard_M208ms_v2", + "Standard_M208s_v2", + "Standard_M416ms_v2", + "Standard_M416s_v2", + "Standard_F48s_v2", + "Standard_E48_v3", + "Standard_E48s_v3", + "Standard_E80is_v4", + "Standard_E80ids_v4", + "Standard_E2a_v4", + "Standard_E4a_v4", + "Standard_E8a_v4", + "Standard_E16a_v4", + "Standard_E20a_v4", + "Standard_E32a_v4", + "Standard_E48a_v4", + "Standard_E64a_v4", + "Standard_E96a_v4", + "Standard_D2a_v4", + "Standard_D4a_v4", + "Standard_D8a_v4", + "Standard_D16a_v4", + "Standard_D32a_v4", + "Standard_D48a_v4", + "Standard_D64a_v4", + "Standard_D96a_v4", + "Standard_M32ms_v2", + "Standard_M64s_v2", + "Standard_M64ms_v2", + "Standard_M128s_v2", + "Standard_M128ms_v2", + "Standard_M192is_v2", + "Standard_M192ims_v2", + "Standard_M32dms_v2", + "Standard_M64ds_v2", + "Standard_M64dms_v2", + "Standard_M128ds_v2", + "Standard_M128dms_v2", + "Standard_M192ids_v2", + "Standard_M192idms_v2", + "Standard_D2_v5", + "Standard_D4_v5", + "Standard_D8_v5", + "Standard_D16_v5", + "Standard_D32_v5", + "Standard_D48_v5", + "Standard_D64_v5", + "Standard_D96_v5", + "Standard_D2s_v5", + "Standard_D4s_v5", + "Standard_D8s_v5", + "Standard_D16s_v5", + "Standard_D32s_v5", + "Standard_D48s_v5", + "Standard_D64s_v5", + "Standard_D96s_v5", + "Standard_D2d_v5", + "Standard_D4d_v5", + "Standard_D8d_v5", + "Standard_D16d_v5", + "Standard_D32d_v5", + "Standard_D48d_v5", + "Standard_D64d_v5", + "Standard_D96d_v5", + "Standard_D2ds_v5", + "Standard_D4ds_v5", + "Standard_D8ds_v5", + "Standard_D16ds_v5", + "Standard_D32ds_v5", + "Standard_D48ds_v5", + "Standard_D64ds_v5", + "Standard_D96ds_v5", + "Standard_D2as_v5", + "Standard_D4as_v5", + "Standard_D8as_v5", + "Standard_D16as_v5", + "Standard_D32as_v5", + "Standard_D48as_v5", + "Standard_D64as_v5", + "Standard_D96as_v5", + "Standard_D2ads_v5", + "Standard_D4ads_v5", + "Standard_D8ads_v5", + "Standard_D16ads_v5", + "Standard_D32ads_v5", + "Standard_D48ads_v5", + "Standard_D64ads_v5", + "Standard_D96ads_v5", + "Standard_E2_v5", + "Standard_E4_v5", + "Standard_E8_v5", + "Standard_E16_v5", + "Standard_E20_v5", + "Standard_E32_v5", + "Standard_E48_v5", + "Standard_E64_v5", + "Standard_E96_v5", + "Standard_E104i_v5", + "Standard_E2s_v5", + "Standard_E4s_v5", + "Standard_E8s_v5", + "Standard_E16s_v5", + "Standard_E20s_v5", + "Standard_E32s_v5", + "Standard_E48s_v5", + "Standard_E64s_v5", + "Standard_E96s_v5", + "Standard_E104is_v5", + "Standard_E2d_v5", + "Standard_E4d_v5", + "Standard_E8d_v5", + "Standard_E16d_v5", + "Standard_E20d_v5", + "Standard_E32d_v5", + "Standard_E48d_v5", + "Standard_E64d_v5", + "Standard_E96d_v5", + "Standard_E104id_v5", + "Standard_E2ds_v5", + "Standard_E4ds_v5", + "Standard_E8ds_v5", + "Standard_E16ds_v5", + "Standard_E20ds_v5", + "Standard_E32ds_v5", + "Standard_E48ds_v5", + "Standard_E64ds_v5", + "Standard_E96ds_v5", + "Standard_E104ids_v5", + "Standard_E2as_v5", + "Standard_E4as_v5", + "Standard_E8as_v5", + "Standard_E16as_v5", + "Standard_E20as_v5", + "Standard_E32as_v5", + "Standard_E48as_v5", + "Standard_E64as_v5", + "Standard_E96as_v5", + "Standard_E2ads_v5", + "Standard_E4ads_v5", + "Standard_E8ads_v5", + "Standard_E16ads_v5", + "Standard_E20ads_v5", + "Standard_E32ads_v5", + "Standard_E48ads_v5", + "Standard_E64ads_v5", + "Standard_E96ads_v5", + "Standard_M8_2ms", + "Standard_M8_4ms", + "Standard_M16_4ms", + "Standard_M16_8ms", + "Standard_M32_8ms", + "Standard_M32_16ms", + "Standard_M64_32ms", + "Standard_M64_16ms", + "Standard_M128_64ms", + "Standard_M128_32ms", + "Standard_E4_2s_v3", + "Standard_E8_4s_v3", + "Standard_E8_2s_v3", + "Standard_E16_8s_v3", + "Standard_E16_4s_v3", + "Standard_E32_16s_v3", + "Standard_E32_8s_v3", + "Standard_E64_32s_v3", + "Standard_E64_16s_v3", + "Standard_E4_2s_v4", + "Standard_E8_4s_v4", + "Standard_E8_2s_v4", + "Standard_E16_8s_v4", + "Standard_E16_4s_v4", + "Standard_E32_16s_v4", + "Standard_E32_8s_v4", + "Standard_E64_32s_v4", + "Standard_E64_16s_v4", + "Standard_E4_2ds_v4", + "Standard_E8_4ds_v4", + "Standard_E8_2ds_v4", + "Standard_E16_8ds_v4", + "Standard_E16_4ds_v4", + "Standard_E32_16ds_v4", + "Standard_E32_8ds_v4", + "Standard_E64_32ds_v4", + "Standard_E64_16ds_v4", + "Standard_E4_2as_v4", + "Standard_E8_4as_v4", + "Standard_E8_2as_v4", + "Standard_E16_8as_v4", + "Standard_E16_4as_v4", + "Standard_E32_16as_v4", + "Standard_E32_8as_v4", + "Standard_E64_32as_v4", + "Standard_E64_16as_v4", + "Standard_E96_48as_v4", + "Standard_E96_24as_v4", + "Standard_E4_2ads_v5", + "Standard_E8_4ads_v5", + "Standard_E8_2ads_v5", + "Standard_E16_8ads_v5", + "Standard_E16_4ads_v5", + "Standard_E32_16ads_v5", + "Standard_E32_8ads_v5", + "Standard_E64_32ads_v5", + "Standard_E64_16ads_v5", + "Standard_E96_48ads_v5", + "Standard_E96_24ads_v5", + "Standard_E4_2s_v5", + "Standard_E8_4s_v5", + "Standard_E8_2s_v5", + "Standard_E16_8s_v5", + "Standard_E16_4s_v5", + "Standard_E32_16s_v5", + "Standard_E32_8s_v5", + "Standard_E64_32s_v5", + "Standard_E64_16s_v5", + "Standard_E96_48s_v5", + "Standard_E96_24s_v5", + "Standard_E4_2ds_v5", + "Standard_E8_4ds_v5", + "Standard_E8_2ds_v5", + "Standard_E16_8ds_v5", + "Standard_E16_4ds_v5", + "Standard_E32_16ds_v5", + "Standard_E32_8ds_v5", + "Standard_E64_32ds_v5", + "Standard_E64_16ds_v5", + "Standard_E96_48ds_v5", + "Standard_E96_24ds_v5", + "Standard_E4_2as_v5", + "Standard_E8_4as_v5", + "Standard_E8_2as_v5", + "Standard_E16_8as_v5", + "Standard_E16_4as_v5", + "Standard_E32_16as_v5", + "Standard_E32_8as_v5", + "Standard_E64_32as_v5", + "Standard_E64_16as_v5", + "Standard_E96_48as_v5", + "Standard_E96_24as_v5", + "Standard_GS4_8", + "Standard_GS4_4", + "Standard_GS5_16", + "Standard_GS5_8", + "Standard_DS11_1_v2", + "Standard_DS12_2_v2", + "Standard_DS12_1_v2", + "Standard_DS13_4_v2", + "Standard_DS13_2_v2", + "Standard_DS14_8_v2", + "Standard_DS14_4_v2", + "Standard_M416_208s_v2", + "Standard_M416_208ms_v2", + "Standard_E2bs_v5", + "Standard_E4bs_v5", + "Standard_E8bs_v5", + "Standard_E16bs_v5", + "Standard_E32bs_v5", + "Standard_E48bs_v5", + "Standard_E64bs_v5", + "Standard_E2bds_v5", + "Standard_E4bds_v5", + "Standard_E8bds_v5", + "Standard_E16bds_v5", + "Standard_E32bds_v5", + "Standard_E48bds_v5", + "Standard_E64bds_v5" + ], + "x-ms-enum": { + "name": "AzureVmSize", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "BasicA0", + "value": "Basic_A0" + }, + { + "name": "BasicA1", + "value": "Basic_A1" + }, + { + "name": "BasicA2", + "value": "Basic_A2" + }, + { + "name": "BasicA3", + "value": "Basic_A3" + }, + { + "name": "BasicA4", + "value": "Basic_A4" + }, + { + "name": "StandardA0", + "value": "Standard_A0" + }, + { + "name": "StandardA1", + "value": "Standard_A1" + }, + { + "name": "StandardA2", + "value": "Standard_A2" + }, + { + "name": "StandardA3", + "value": "Standard_A3" + }, + { + "name": "StandardA4", + "value": "Standard_A4" + }, + { + "name": "StandardA5", + "value": "Standard_A5" + }, + { + "name": "StandardA6", + "value": "Standard_A6" + }, + { + "name": "StandardA7", + "value": "Standard_A7" + }, + { + "name": "StandardA8", + "value": "Standard_A8" + }, + { + "name": "StandardA9", + "value": "Standard_A9" + }, + { + "name": "StandardA10", + "value": "Standard_A10" + }, + { + "name": "StandardA11", + "value": "Standard_A11" + }, + { + "name": "StandardA1V2", + "value": "Standard_A1_v2" + }, + { + "name": "StandardA2V2", + "value": "Standard_A2_v2" + }, + { + "name": "StandardA4V2", + "value": "Standard_A4_v2" + }, + { + "name": "StandardA8V2", + "value": "Standard_A8_v2" + }, + { + "name": "StandardA2MV2", + "value": "Standard_A2m_v2" + }, + { + "name": "StandardA4MV2", + "value": "Standard_A4m_v2" + }, + { + "name": "StandardA8MV2", + "value": "Standard_A8m_v2" + }, + { + "name": "StandardD1", + "value": "Standard_D1" + }, + { + "name": "StandardD2", + "value": "Standard_D2" + }, + { + "name": "StandardD3", + "value": "Standard_D3" + }, + { + "name": "StandardD4", + "value": "Standard_D4" + }, + { + "name": "StandardD11", + "value": "Standard_D11" + }, + { + "name": "StandardD12", + "value": "Standard_D12" + }, + { + "name": "StandardD13", + "value": "Standard_D13" + }, + { + "name": "StandardD14", + "value": "Standard_D14" + }, + { + "name": "StandardD1V2", + "value": "Standard_D1_v2" + }, + { + "name": "StandardD2V2", + "value": "Standard_D2_v2" + }, + { + "name": "StandardD3V2", + "value": "Standard_D3_v2" + }, + { + "name": "StandardD4V2", + "value": "Standard_D4_v2" + }, + { + "name": "StandardD5V2", + "value": "Standard_D5_v2" + }, + { + "name": "StandardD11V2", + "value": "Standard_D11_v2" + }, + { + "name": "StandardD12V2", + "value": "Standard_D12_v2" + }, + { + "name": "StandardD13V2", + "value": "Standard_D13_v2" + }, + { + "name": "StandardD14V2", + "value": "Standard_D14_v2" + }, + { + "name": "StandardD15V2", + "value": "Standard_D15_v2" + }, + { + "name": "StandardDS1", + "value": "Standard_DS1" + }, + { + "name": "StandardDS2", + "value": "Standard_DS2" + }, + { + "name": "StandardDS3", + "value": "Standard_DS3" + }, + { + "name": "StandardDS4", + "value": "Standard_DS4" + }, + { + "name": "StandardDS11", + "value": "Standard_DS11" + }, + { + "name": "StandardDS12", + "value": "Standard_DS12" + }, + { + "name": "StandardDS13", + "value": "Standard_DS13" + }, + { + "name": "StandardDS14", + "value": "Standard_DS14" + }, + { + "name": "StandardDS1V2", + "value": "Standard_DS1_v2" + }, + { + "name": "StandardDS2V2", + "value": "Standard_DS2_v2" + }, + { + "name": "StandardDS3V2", + "value": "Standard_DS3_v2" + }, + { + "name": "StandardDS4V2", + "value": "Standard_DS4_v2" + }, + { + "name": "StandardDS5V2", + "value": "Standard_DS5_v2" + }, + { + "name": "StandardDS11V2", + "value": "Standard_DS11_v2" + }, + { + "name": "StandardDS12V2", + "value": "Standard_DS12_v2" + }, + { + "name": "StandardDS13V2", + "value": "Standard_DS13_v2" + }, + { + "name": "StandardDS14V2", + "value": "Standard_DS14_v2" + }, + { + "name": "StandardDS15V2", + "value": "Standard_DS15_v2" + }, + { + "name": "StandardF1", + "value": "Standard_F1" + }, + { + "name": "StandardF2", + "value": "Standard_F2" + }, + { + "name": "StandardF4", + "value": "Standard_F4" + }, + { + "name": "StandardF8", + "value": "Standard_F8" + }, + { + "name": "StandardF16", + "value": "Standard_F16" + }, + { + "name": "StandardF1S", + "value": "Standard_F1s" + }, + { + "name": "StandardF2S", + "value": "Standard_F2s" + }, + { + "name": "StandardF4S", + "value": "Standard_F4s" + }, + { + "name": "StandardF8S", + "value": "Standard_F8s" + }, + { + "name": "StandardF16S", + "value": "Standard_F16s" + }, + { + "name": "StandardG1", + "value": "Standard_G1" + }, + { + "name": "StandardG2", + "value": "Standard_G2" + }, + { + "name": "StandardG3", + "value": "Standard_G3" + }, + { + "name": "StandardG4", + "value": "Standard_G4" + }, + { + "name": "StandardG5", + "value": "Standard_G5" + }, + { + "name": "StandardGS1", + "value": "Standard_GS1" + }, + { + "name": "StandardGS2", + "value": "Standard_GS2" + }, + { + "name": "StandardGS3", + "value": "Standard_GS3" + }, + { + "name": "StandardGS4", + "value": "Standard_GS4" + }, + { + "name": "StandardGS5", + "value": "Standard_GS5" + }, + { + "name": "StandardH8", + "value": "Standard_H8" + }, + { + "name": "StandardH16", + "value": "Standard_H16" + }, + { + "name": "StandardH8M", + "value": "Standard_H8m" + }, + { + "name": "StandardH16M", + "value": "Standard_H16m" + }, + { + "name": "StandardH16R", + "value": "Standard_H16r" + }, + { + "name": "StandardH16Mr", + "value": "Standard_H16mr" + }, + { + "name": "StandardL4S", + "value": "Standard_L4s" + }, + { + "name": "StandardL8S", + "value": "Standard_L8s" + }, + { + "name": "StandardL16S", + "value": "Standard_L16s" + }, + { + "name": "StandardL32S", + "value": "Standard_L32s" + }, + { + "name": "StandardD2SV3", + "value": "Standard_D2s_v3" + }, + { + "name": "StandardD4SV3", + "value": "Standard_D4s_v3" + }, + { + "name": "StandardD8SV3", + "value": "Standard_D8s_v3" + }, + { + "name": "StandardD16SV3", + "value": "Standard_D16s_v3" + }, + { + "name": "StandardD32SV3", + "value": "Standard_D32s_v3" + }, + { + "name": "StandardD64SV3", + "value": "Standard_D64s_v3" + }, + { + "name": "StandardD2V3", + "value": "Standard_D2_v3" + }, + { + "name": "StandardD4V3", + "value": "Standard_D4_v3" + }, + { + "name": "StandardD8V3", + "value": "Standard_D8_v3" + }, + { + "name": "StandardD16V3", + "value": "Standard_D16_v3" + }, + { + "name": "StandardD32V3", + "value": "Standard_D32_v3" + }, + { + "name": "StandardD64V3", + "value": "Standard_D64_v3" + }, + { + "name": "StandardF2SV2", + "value": "Standard_F2s_v2" + }, + { + "name": "StandardF4SV2", + "value": "Standard_F4s_v2" + }, + { + "name": "StandardF8SV2", + "value": "Standard_F8s_v2" + }, + { + "name": "StandardF16SV2", + "value": "Standard_F16s_v2" + }, + { + "name": "StandardF32SV2", + "value": "Standard_F32s_v2" + }, + { + "name": "StandardF64SV2", + "value": "Standard_F64s_v2" + }, + { + "name": "StandardF72SV2", + "value": "Standard_F72s_v2" + }, + { + "name": "StandardE2V3", + "value": "Standard_E2_v3" + }, + { + "name": "StandardE4V3", + "value": "Standard_E4_v3" + }, + { + "name": "StandardE8V3", + "value": "Standard_E8_v3" + }, + { + "name": "StandardE16V3", + "value": "Standard_E16_v3" + }, + { + "name": "StandardE32V3", + "value": "Standard_E32_v3" + }, + { + "name": "StandardE64V3", + "value": "Standard_E64_v3" + }, + { + "name": "StandardE2SV3", + "value": "Standard_E2s_v3" + }, + { + "name": "StandardE4SV3", + "value": "Standard_E4s_v3" + }, + { + "name": "StandardE8SV3", + "value": "Standard_E8s_v3" + }, + { + "name": "StandardE16SV3", + "value": "Standard_E16s_v3" + }, + { + "name": "StandardE32SV3", + "value": "Standard_E32s_v3" + }, + { + "name": "StandardE64SV3", + "value": "Standard_E64s_v3" + }, + { + "name": "StandardM64S", + "value": "Standard_M64s" + }, + { + "name": "StandardM64Ms", + "value": "Standard_M64ms" + }, + { + "name": "StandardM128S", + "value": "Standard_M128s" + }, + { + "name": "StandardM128Ms", + "value": "Standard_M128ms" + }, + { + "name": "StandardDC2S", + "value": "Standard_DC2s" + }, + { + "name": "StandardDC4S", + "value": "Standard_DC4s" + }, + { + "name": "StandardE20V3", + "value": "Standard_E20_v3" + }, + { + "name": "StandardE20SV3", + "value": "Standard_E20s_v3" + }, + { + "name": "StandardE64IV3", + "value": "Standard_E64i_v3" + }, + { + "name": "StandardE64IsV3", + "value": "Standard_E64is_v3" + }, + { + "name": "StandardM8Ms", + "value": "Standard_M8ms" + }, + { + "name": "StandardM16Ms", + "value": "Standard_M16ms" + }, + { + "name": "StandardM32Ls", + "value": "Standard_M32ls" + }, + { + "name": "StandardM32Ms", + "value": "Standard_M32ms" + }, + { + "name": "StandardM32Ts", + "value": "Standard_M32ts" + }, + { + "name": "StandardM64", + "value": "Standard_M64" + }, + { + "name": "StandardM64Ls", + "value": "Standard_M64ls" + }, + { + "name": "StandardM64M", + "value": "Standard_M64m" + }, + { + "name": "StandardM128", + "value": "Standard_M128" + }, + { + "name": "StandardM128M", + "value": "Standard_M128m" + }, + { + "name": "StandardL8SV2", + "value": "Standard_L8s_v2" + }, + { + "name": "StandardL16SV2", + "value": "Standard_L16s_v2" + }, + { + "name": "StandardL32SV2", + "value": "Standard_L32s_v2" + }, + { + "name": "StandardL48SV2", + "value": "Standard_L48s_v2" + }, + { + "name": "StandardL64SV2", + "value": "Standard_L64s_v2" + }, + { + "name": "StandardL80SV2", + "value": "Standard_L80s_v2" + }, + { + "name": "StandardD2V4", + "value": "Standard_D2_v4" + }, + { + "name": "StandardD4V4", + "value": "Standard_D4_v4" + }, + { + "name": "StandardD8V4", + "value": "Standard_D8_v4" + }, + { + "name": "StandardD16V4", + "value": "Standard_D16_v4" + }, + { + "name": "StandardD32V4", + "value": "Standard_D32_v4" + }, + { + "name": "StandardD48V4", + "value": "Standard_D48_v4" + }, + { + "name": "StandardD64V4", + "value": "Standard_D64_v4" + }, + { + "name": "StandardD2SV4", + "value": "Standard_D2s_v4" + }, + { + "name": "StandardD4SV4", + "value": "Standard_D4s_v4" + }, + { + "name": "StandardD8SV4", + "value": "Standard_D8s_v4" + }, + { + "name": "StandardD16SV4", + "value": "Standard_D16s_v4" + }, + { + "name": "StandardD32SV4", + "value": "Standard_D32s_v4" + }, + { + "name": "StandardD48SV4", + "value": "Standard_D48s_v4" + }, + { + "name": "StandardD64SV4", + "value": "Standard_D64s_v4" + }, + { + "name": "StandardD2DV4", + "value": "Standard_D2d_v4" + }, + { + "name": "StandardD4DV4", + "value": "Standard_D4d_v4" + }, + { + "name": "StandardD8DV4", + "value": "Standard_D8d_v4" + }, + { + "name": "StandardD16DV4", + "value": "Standard_D16d_v4" + }, + { + "name": "StandardD32DV4", + "value": "Standard_D32d_v4" + }, + { + "name": "StandardD48DV4", + "value": "Standard_D48d_v4" + }, + { + "name": "StandardD64DV4", + "value": "Standard_D64d_v4" + }, + { + "name": "StandardD2DsV4", + "value": "Standard_D2ds_v4" + }, + { + "name": "StandardD4DsV4", + "value": "Standard_D4ds_v4" + }, + { + "name": "StandardD8DsV4", + "value": "Standard_D8ds_v4" + }, + { + "name": "StandardD16DsV4", + "value": "Standard_D16ds_v4" + }, + { + "name": "StandardD32DsV4", + "value": "Standard_D32ds_v4" + }, + { + "name": "StandardD48DsV4", + "value": "Standard_D48ds_v4" + }, + { + "name": "StandardD64DsV4", + "value": "Standard_D64ds_v4" + }, + { + "name": "StandardE2V4", + "value": "Standard_E2_v4" + }, + { + "name": "StandardE4V4", + "value": "Standard_E4_v4" + }, + { + "name": "StandardE8V4", + "value": "Standard_E8_v4" + }, + { + "name": "StandardE16V4", + "value": "Standard_E16_v4" + }, + { + "name": "StandardE20V4", + "value": "Standard_E20_v4" + }, + { + "name": "StandardE32V4", + "value": "Standard_E32_v4" + }, + { + "name": "StandardE48V4", + "value": "Standard_E48_v4" + }, + { + "name": "StandardE64V4", + "value": "Standard_E64_v4" + }, + { + "name": "StandardE2SV4", + "value": "Standard_E2s_v4" + }, + { + "name": "StandardE4SV4", + "value": "Standard_E4s_v4" + }, + { + "name": "StandardE8SV4", + "value": "Standard_E8s_v4" + }, + { + "name": "StandardE16SV4", + "value": "Standard_E16s_v4" + }, + { + "name": "StandardE20SV4", + "value": "Standard_E20s_v4" + }, + { + "name": "StandardE32SV4", + "value": "Standard_E32s_v4" + }, + { + "name": "StandardE48SV4", + "value": "Standard_E48s_v4" + }, + { + "name": "StandardE64SV4", + "value": "Standard_E64s_v4" + }, + { + "name": "StandardE2DV4", + "value": "Standard_E2d_v4" + }, + { + "name": "StandardE4DV4", + "value": "Standard_E4d_v4" + }, + { + "name": "StandardE8DV4", + "value": "Standard_E8d_v4" + }, + { + "name": "StandardE16DV4", + "value": "Standard_E16d_v4" + }, + { + "name": "StandardE20DV4", + "value": "Standard_E20d_v4" + }, + { + "name": "StandardE32DV4", + "value": "Standard_E32d_v4" + }, + { + "name": "StandardE48DV4", + "value": "Standard_E48d_v4" + }, + { + "name": "StandardE64DV4", + "value": "Standard_E64d_v4" + }, + { + "name": "StandardE2DsV4", + "value": "Standard_E2ds_v4" + }, + { + "name": "StandardE4DsV4", + "value": "Standard_E4ds_v4" + }, + { + "name": "StandardE8DsV4", + "value": "Standard_E8ds_v4" + }, + { + "name": "StandardE16DsV4", + "value": "Standard_E16ds_v4" + }, + { + "name": "StandardE20DsV4", + "value": "Standard_E20ds_v4" + }, + { + "name": "StandardE32DsV4", + "value": "Standard_E32ds_v4" + }, + { + "name": "StandardE48DsV4", + "value": "Standard_E48ds_v4" + }, + { + "name": "StandardE64DsV4", + "value": "Standard_E64ds_v4" + }, + { + "name": "StandardE2AsV4", + "value": "Standard_E2as_v4" + }, + { + "name": "StandardE4AsV4", + "value": "Standard_E4as_v4" + }, + { + "name": "StandardE8AsV4", + "value": "Standard_E8as_v4" + }, + { + "name": "StandardE16AsV4", + "value": "Standard_E16as_v4" + }, + { + "name": "StandardE20AsV4", + "value": "Standard_E20as_v4" + }, + { + "name": "StandardE32AsV4", + "value": "Standard_E32as_v4" + }, + { + "name": "StandardE48AsV4", + "value": "Standard_E48as_v4" + }, + { + "name": "StandardE64AsV4", + "value": "Standard_E64as_v4" + }, + { + "name": "StandardE96AsV4", + "value": "Standard_E96as_v4" + }, + { + "name": "StandardD2AsV4", + "value": "Standard_D2as_v4" + }, + { + "name": "StandardD4AsV4", + "value": "Standard_D4as_v4" + }, + { + "name": "StandardD8AsV4", + "value": "Standard_D8as_v4" + }, + { + "name": "StandardD16AsV4", + "value": "Standard_D16as_v4" + }, + { + "name": "StandardD32AsV4", + "value": "Standard_D32as_v4" + }, + { + "name": "StandardD48AsV4", + "value": "Standard_D48as_v4" + }, + { + "name": "StandardD64AsV4", + "value": "Standard_D64as_v4" + }, + { + "name": "StandardD96AsV4", + "value": "Standard_D96as_v4" + }, + { + "name": "StandardM208MsV2", + "value": "Standard_M208ms_v2" + }, + { + "name": "StandardM208SV2", + "value": "Standard_M208s_v2" + }, + { + "name": "StandardM416MsV2", + "value": "Standard_M416ms_v2" + }, + { + "name": "StandardM416SV2", + "value": "Standard_M416s_v2" + }, + { + "name": "StandardF48SV2", + "value": "Standard_F48s_v2" + }, + { + "name": "StandardE48V3", + "value": "Standard_E48_v3" + }, + { + "name": "StandardE48SV3", + "value": "Standard_E48s_v3" + }, + { + "name": "StandardE80IsV4", + "value": "Standard_E80is_v4" + }, + { + "name": "StandardE80IdsV4", + "value": "Standard_E80ids_v4" + }, + { + "name": "StandardE2AV4", + "value": "Standard_E2a_v4" + }, + { + "name": "StandardE4AV4", + "value": "Standard_E4a_v4" + }, + { + "name": "StandardE8AV4", + "value": "Standard_E8a_v4" + }, + { + "name": "StandardE16AV4", + "value": "Standard_E16a_v4" + }, + { + "name": "StandardE20AV4", + "value": "Standard_E20a_v4" + }, + { + "name": "StandardE32AV4", + "value": "Standard_E32a_v4" + }, + { + "name": "StandardE48AV4", + "value": "Standard_E48a_v4" + }, + { + "name": "StandardE64AV4", + "value": "Standard_E64a_v4" + }, + { + "name": "StandardE96AV4", + "value": "Standard_E96a_v4" + }, + { + "name": "StandardD2AV4", + "value": "Standard_D2a_v4" + }, + { + "name": "StandardD4AV4", + "value": "Standard_D4a_v4" + }, + { + "name": "StandardD8AV4", + "value": "Standard_D8a_v4" + }, + { + "name": "StandardD16AV4", + "value": "Standard_D16a_v4" + }, + { + "name": "StandardD32AV4", + "value": "Standard_D32a_v4" + }, + { + "name": "StandardD48AV4", + "value": "Standard_D48a_v4" + }, + { + "name": "StandardD64AV4", + "value": "Standard_D64a_v4" + }, + { + "name": "StandardD96AV4", + "value": "Standard_D96a_v4" + }, + { + "name": "StandardM32MsV2", + "value": "Standard_M32ms_v2" + }, + { + "name": "StandardM64SV2", + "value": "Standard_M64s_v2" + }, + { + "name": "StandardM64MsV2", + "value": "Standard_M64ms_v2" + }, + { + "name": "StandardM128SV2", + "value": "Standard_M128s_v2" + }, + { + "name": "StandardM128MsV2", + "value": "Standard_M128ms_v2" + }, + { + "name": "StandardM192IsV2", + "value": "Standard_M192is_v2" + }, + { + "name": "StandardM192ImsV2", + "value": "Standard_M192ims_v2" + }, + { + "name": "StandardM32DmsV2", + "value": "Standard_M32dms_v2" + }, + { + "name": "StandardM64DsV2", + "value": "Standard_M64ds_v2" + }, + { + "name": "StandardM64DmsV2", + "value": "Standard_M64dms_v2" + }, + { + "name": "StandardM128DsV2", + "value": "Standard_M128ds_v2" + }, + { + "name": "StandardM128DmsV2", + "value": "Standard_M128dms_v2" + }, + { + "name": "StandardM192IdsV2", + "value": "Standard_M192ids_v2" + }, + { + "name": "StandardM192IdmsV2", + "value": "Standard_M192idms_v2" + }, + { + "name": "StandardD2V5", + "value": "Standard_D2_v5" + }, + { + "name": "StandardD4V5", + "value": "Standard_D4_v5" + }, + { + "name": "StandardD8V5", + "value": "Standard_D8_v5" + }, + { + "name": "StandardD16V5", + "value": "Standard_D16_v5" + }, + { + "name": "StandardD32V5", + "value": "Standard_D32_v5" + }, + { + "name": "StandardD48V5", + "value": "Standard_D48_v5" + }, + { + "name": "StandardD64V5", + "value": "Standard_D64_v5" + }, + { + "name": "StandardD96V5", + "value": "Standard_D96_v5" + }, + { + "name": "StandardD2SV5", + "value": "Standard_D2s_v5" + }, + { + "name": "StandardD4SV5", + "value": "Standard_D4s_v5" + }, + { + "name": "StandardD8SV5", + "value": "Standard_D8s_v5" + }, + { + "name": "StandardD16SV5", + "value": "Standard_D16s_v5" + }, + { + "name": "StandardD32SV5", + "value": "Standard_D32s_v5" + }, + { + "name": "StandardD48SV5", + "value": "Standard_D48s_v5" + }, + { + "name": "StandardD64SV5", + "value": "Standard_D64s_v5" + }, + { + "name": "StandardD96SV5", + "value": "Standard_D96s_v5" + }, + { + "name": "StandardD2DV5", + "value": "Standard_D2d_v5" + }, + { + "name": "StandardD4DV5", + "value": "Standard_D4d_v5" + }, + { + "name": "StandardD8DV5", + "value": "Standard_D8d_v5" + }, + { + "name": "StandardD16DV5", + "value": "Standard_D16d_v5" + }, + { + "name": "StandardD32DV5", + "value": "Standard_D32d_v5" + }, + { + "name": "StandardD48DV5", + "value": "Standard_D48d_v5" + }, + { + "name": "StandardD64DV5", + "value": "Standard_D64d_v5" + }, + { + "name": "StandardD96DV5", + "value": "Standard_D96d_v5" + }, + { + "name": "StandardD2DsV5", + "value": "Standard_D2ds_v5" + }, + { + "name": "StandardD4DsV5", + "value": "Standard_D4ds_v5" + }, + { + "name": "StandardD8DsV5", + "value": "Standard_D8ds_v5" + }, + { + "name": "StandardD16DsV5", + "value": "Standard_D16ds_v5" + }, + { + "name": "StandardD32DsV5", + "value": "Standard_D32ds_v5" + }, + { + "name": "StandardD48DsV5", + "value": "Standard_D48ds_v5" + }, + { + "name": "StandardD64DsV5", + "value": "Standard_D64ds_v5" + }, + { + "name": "StandardD96DsV5", + "value": "Standard_D96ds_v5" + }, + { + "name": "StandardD2AsV5", + "value": "Standard_D2as_v5" + }, + { + "name": "StandardD4AsV5", + "value": "Standard_D4as_v5" + }, + { + "name": "StandardD8AsV5", + "value": "Standard_D8as_v5" + }, + { + "name": "StandardD16AsV5", + "value": "Standard_D16as_v5" + }, + { + "name": "StandardD32AsV5", + "value": "Standard_D32as_v5" + }, + { + "name": "StandardD48AsV5", + "value": "Standard_D48as_v5" + }, + { + "name": "StandardD64AsV5", + "value": "Standard_D64as_v5" + }, + { + "name": "StandardD96AsV5", + "value": "Standard_D96as_v5" + }, + { + "name": "StandardD2AdsV5", + "value": "Standard_D2ads_v5" + }, + { + "name": "StandardD4AdsV5", + "value": "Standard_D4ads_v5" + }, + { + "name": "StandardD8AdsV5", + "value": "Standard_D8ads_v5" + }, + { + "name": "StandardD16AdsV5", + "value": "Standard_D16ads_v5" + }, + { + "name": "StandardD32AdsV5", + "value": "Standard_D32ads_v5" + }, + { + "name": "StandardD48AdsV5", + "value": "Standard_D48ads_v5" + }, + { + "name": "StandardD64AdsV5", + "value": "Standard_D64ads_v5" + }, + { + "name": "StandardD96AdsV5", + "value": "Standard_D96ads_v5" + }, + { + "name": "StandardE2V5", + "value": "Standard_E2_v5" + }, + { + "name": "StandardE4V5", + "value": "Standard_E4_v5" + }, + { + "name": "StandardE8V5", + "value": "Standard_E8_v5" + }, + { + "name": "StandardE16V5", + "value": "Standard_E16_v5" + }, + { + "name": "StandardE20V5", + "value": "Standard_E20_v5" + }, + { + "name": "StandardE32V5", + "value": "Standard_E32_v5" + }, + { + "name": "StandardE48V5", + "value": "Standard_E48_v5" + }, + { + "name": "StandardE64V5", + "value": "Standard_E64_v5" + }, + { + "name": "StandardE96V5", + "value": "Standard_E96_v5" + }, + { + "name": "StandardE104IV5", + "value": "Standard_E104i_v5" + }, + { + "name": "StandardE2SV5", + "value": "Standard_E2s_v5" + }, + { + "name": "StandardE4SV5", + "value": "Standard_E4s_v5" + }, + { + "name": "StandardE8SV5", + "value": "Standard_E8s_v5" + }, + { + "name": "StandardE16SV5", + "value": "Standard_E16s_v5" + }, + { + "name": "StandardE20SV5", + "value": "Standard_E20s_v5" + }, + { + "name": "StandardE32SV5", + "value": "Standard_E32s_v5" + }, + { + "name": "StandardE48SV5", + "value": "Standard_E48s_v5" + }, + { + "name": "StandardE64SV5", + "value": "Standard_E64s_v5" + }, + { + "name": "StandardE96SV5", + "value": "Standard_E96s_v5" + }, + { + "name": "StandardE104IsV5", + "value": "Standard_E104is_v5" + }, + { + "name": "StandardE2DV5", + "value": "Standard_E2d_v5" + }, + { + "name": "StandardE4DV5", + "value": "Standard_E4d_v5" + }, + { + "name": "StandardE8DV5", + "value": "Standard_E8d_v5" + }, + { + "name": "StandardE16DV5", + "value": "Standard_E16d_v5" + }, + { + "name": "StandardE20DV5", + "value": "Standard_E20d_v5" + }, + { + "name": "StandardE32DV5", + "value": "Standard_E32d_v5" + }, + { + "name": "StandardE48DV5", + "value": "Standard_E48d_v5" + }, + { + "name": "StandardE64DV5", + "value": "Standard_E64d_v5" + }, + { + "name": "StandardE96DV5", + "value": "Standard_E96d_v5" + }, + { + "name": "StandardE104IdV5", + "value": "Standard_E104id_v5" + }, + { + "name": "StandardE2DsV5", + "value": "Standard_E2ds_v5" + }, + { + "name": "StandardE4DsV5", + "value": "Standard_E4ds_v5" + }, + { + "name": "StandardE8DsV5", + "value": "Standard_E8ds_v5" + }, + { + "name": "StandardE16DsV5", + "value": "Standard_E16ds_v5" + }, + { + "name": "StandardE20DsV5", + "value": "Standard_E20ds_v5" + }, + { + "name": "StandardE32DsV5", + "value": "Standard_E32ds_v5" + }, + { + "name": "StandardE48DsV5", + "value": "Standard_E48ds_v5" + }, + { + "name": "StandardE64DsV5", + "value": "Standard_E64ds_v5" + }, + { + "name": "StandardE96DsV5", + "value": "Standard_E96ds_v5" + }, + { + "name": "StandardE104IdsV5", + "value": "Standard_E104ids_v5" + }, + { + "name": "StandardE2AsV5", + "value": "Standard_E2as_v5" + }, + { + "name": "StandardE4AsV5", + "value": "Standard_E4as_v5" + }, + { + "name": "StandardE8AsV5", + "value": "Standard_E8as_v5" + }, + { + "name": "StandardE16AsV5", + "value": "Standard_E16as_v5" + }, + { + "name": "StandardE20AsV5", + "value": "Standard_E20as_v5" + }, + { + "name": "StandardE32AsV5", + "value": "Standard_E32as_v5" + }, + { + "name": "StandardE48AsV5", + "value": "Standard_E48as_v5" + }, + { + "name": "StandardE64AsV5", + "value": "Standard_E64as_v5" + }, + { + "name": "StandardE96AsV5", + "value": "Standard_E96as_v5" + }, + { + "name": "StandardE2AdsV5", + "value": "Standard_E2ads_v5" + }, + { + "name": "StandardE4AdsV5", + "value": "Standard_E4ads_v5" + }, + { + "name": "StandardE8AdsV5", + "value": "Standard_E8ads_v5" + }, + { + "name": "StandardE16AdsV5", + "value": "Standard_E16ads_v5" + }, + { + "name": "StandardE20AdsV5", + "value": "Standard_E20ads_v5" + }, + { + "name": "StandardE32AdsV5", + "value": "Standard_E32ads_v5" + }, + { + "name": "StandardE48AdsV5", + "value": "Standard_E48ads_v5" + }, + { + "name": "StandardE64AdsV5", + "value": "Standard_E64ads_v5" + }, + { + "name": "StandardE96AdsV5", + "value": "Standard_E96ads_v5" + }, + { + "name": "StandardM82Ms", + "value": "Standard_M8_2ms" + }, + { + "name": "StandardM84Ms", + "value": "Standard_M8_4ms" + }, + { + "name": "StandardM164Ms", + "value": "Standard_M16_4ms" + }, + { + "name": "StandardM168Ms", + "value": "Standard_M16_8ms" + }, + { + "name": "StandardM328Ms", + "value": "Standard_M32_8ms" + }, + { + "name": "StandardM3216Ms", + "value": "Standard_M32_16ms" + }, + { + "name": "StandardM6432Ms", + "value": "Standard_M64_32ms" + }, + { + "name": "StandardM6416Ms", + "value": "Standard_M64_16ms" + }, + { + "name": "StandardM12864Ms", + "value": "Standard_M128_64ms" + }, + { + "name": "StandardM12832Ms", + "value": "Standard_M128_32ms" + }, + { + "name": "StandardE42SV3", + "value": "Standard_E4_2s_v3" + }, + { + "name": "StandardE84SV3", + "value": "Standard_E8_4s_v3" + }, + { + "name": "StandardE82SV3", + "value": "Standard_E8_2s_v3" + }, + { + "name": "StandardE168SV3", + "value": "Standard_E16_8s_v3" + }, + { + "name": "StandardE164SV3", + "value": "Standard_E16_4s_v3" + }, + { + "name": "StandardE3216SV3", + "value": "Standard_E32_16s_v3" + }, + { + "name": "StandardE328SV3", + "value": "Standard_E32_8s_v3" + }, + { + "name": "StandardE6432SV3", + "value": "Standard_E64_32s_v3" + }, + { + "name": "StandardE6416SV3", + "value": "Standard_E64_16s_v3" + }, + { + "name": "StandardE42SV4", + "value": "Standard_E4_2s_v4" + }, + { + "name": "StandardE84SV4", + "value": "Standard_E8_4s_v4" + }, + { + "name": "StandardE82SV4", + "value": "Standard_E8_2s_v4" + }, + { + "name": "StandardE168SV4", + "value": "Standard_E16_8s_v4" + }, + { + "name": "StandardE164SV4", + "value": "Standard_E16_4s_v4" + }, + { + "name": "StandardE3216SV4", + "value": "Standard_E32_16s_v4" + }, + { + "name": "StandardE328SV4", + "value": "Standard_E32_8s_v4" + }, + { + "name": "StandardE6432SV4", + "value": "Standard_E64_32s_v4" + }, + { + "name": "StandardE6416SV4", + "value": "Standard_E64_16s_v4" + }, + { + "name": "StandardE42DsV4", + "value": "Standard_E4_2ds_v4" + }, + { + "name": "StandardE84DsV4", + "value": "Standard_E8_4ds_v4" + }, + { + "name": "StandardE82DsV4", + "value": "Standard_E8_2ds_v4" + }, + { + "name": "StandardE168DsV4", + "value": "Standard_E16_8ds_v4" + }, + { + "name": "StandardE164DsV4", + "value": "Standard_E16_4ds_v4" + }, + { + "name": "StandardE3216DsV4", + "value": "Standard_E32_16ds_v4" + }, + { + "name": "StandardE328DsV4", + "value": "Standard_E32_8ds_v4" + }, + { + "name": "StandardE6432DsV4", + "value": "Standard_E64_32ds_v4" + }, + { + "name": "StandardE6416DsV4", + "value": "Standard_E64_16ds_v4" + }, + { + "name": "StandardE42AsV4", + "value": "Standard_E4_2as_v4" + }, + { + "name": "StandardE84AsV4", + "value": "Standard_E8_4as_v4" + }, + { + "name": "StandardE82AsV4", + "value": "Standard_E8_2as_v4" + }, + { + "name": "StandardE168AsV4", + "value": "Standard_E16_8as_v4" + }, + { + "name": "StandardE164AsV4", + "value": "Standard_E16_4as_v4" + }, + { + "name": "StandardE3216AsV4", + "value": "Standard_E32_16as_v4" + }, + { + "name": "StandardE328AsV4", + "value": "Standard_E32_8as_v4" + }, + { + "name": "StandardE6432AsV4", + "value": "Standard_E64_32as_v4" + }, + { + "name": "StandardE6416AsV4", + "value": "Standard_E64_16as_v4" + }, + { + "name": "StandardE9648AsV4", + "value": "Standard_E96_48as_v4" + }, + { + "name": "StandardE9624AsV4", + "value": "Standard_E96_24as_v4" + }, + { + "name": "StandardE42AdsV5", + "value": "Standard_E4_2ads_v5" + }, + { + "name": "StandardE84AdsV5", + "value": "Standard_E8_4ads_v5" + }, + { + "name": "StandardE82AdsV5", + "value": "Standard_E8_2ads_v5" + }, + { + "name": "StandardE168AdsV5", + "value": "Standard_E16_8ads_v5" + }, + { + "name": "StandardE164AdsV5", + "value": "Standard_E16_4ads_v5" + }, + { + "name": "StandardE3216AdsV5", + "value": "Standard_E32_16ads_v5" + }, + { + "name": "StandardE328AdsV5", + "value": "Standard_E32_8ads_v5" + }, + { + "name": "StandardE6432AdsV5", + "value": "Standard_E64_32ads_v5" + }, + { + "name": "StandardE6416AdsV5", + "value": "Standard_E64_16ads_v5" + }, + { + "name": "StandardE9648AdsV5", + "value": "Standard_E96_48ads_v5" + }, + { + "name": "StandardE9624AdsV5", + "value": "Standard_E96_24ads_v5" + }, + { + "name": "StandardE42SV5", + "value": "Standard_E4_2s_v5" + }, + { + "name": "StandardE84SV5", + "value": "Standard_E8_4s_v5" + }, + { + "name": "StandardE82SV5", + "value": "Standard_E8_2s_v5" + }, + { + "name": "StandardE168SV5", + "value": "Standard_E16_8s_v5" + }, + { + "name": "StandardE164SV5", + "value": "Standard_E16_4s_v5" + }, + { + "name": "StandardE3216SV5", + "value": "Standard_E32_16s_v5" + }, + { + "name": "StandardE328SV5", + "value": "Standard_E32_8s_v5" + }, + { + "name": "StandardE6432SV5", + "value": "Standard_E64_32s_v5" + }, + { + "name": "StandardE6416SV5", + "value": "Standard_E64_16s_v5" + }, + { + "name": "StandardE9648SV5", + "value": "Standard_E96_48s_v5" + }, + { + "name": "StandardE9624SV5", + "value": "Standard_E96_24s_v5" + }, + { + "name": "StandardE42DsV5", + "value": "Standard_E4_2ds_v5" + }, + { + "name": "StandardE84DsV5", + "value": "Standard_E8_4ds_v5" + }, + { + "name": "StandardE82DsV5", + "value": "Standard_E8_2ds_v5" + }, + { + "name": "StandardE168DsV5", + "value": "Standard_E16_8ds_v5" + }, + { + "name": "StandardE164DsV5", + "value": "Standard_E16_4ds_v5" + }, + { + "name": "StandardE3216DsV5", + "value": "Standard_E32_16ds_v5" + }, + { + "name": "StandardE328DsV5", + "value": "Standard_E32_8ds_v5" + }, + { + "name": "StandardE6432DsV5", + "value": "Standard_E64_32ds_v5" + }, + { + "name": "StandardE6416DsV5", + "value": "Standard_E64_16ds_v5" + }, + { + "name": "StandardE9648DsV5", + "value": "Standard_E96_48ds_v5" + }, + { + "name": "StandardE9624DsV5", + "value": "Standard_E96_24ds_v5" + }, + { + "name": "StandardE42AsV5", + "value": "Standard_E4_2as_v5" + }, + { + "name": "StandardE84AsV5", + "value": "Standard_E8_4as_v5" + }, + { + "name": "StandardE82AsV5", + "value": "Standard_E8_2as_v5" + }, + { + "name": "StandardE168AsV5", + "value": "Standard_E16_8as_v5" + }, + { + "name": "StandardE164AsV5", + "value": "Standard_E16_4as_v5" + }, + { + "name": "StandardE3216AsV5", + "value": "Standard_E32_16as_v5" + }, + { + "name": "StandardE328AsV5", + "value": "Standard_E32_8as_v5" + }, + { + "name": "StandardE6432AsV5", + "value": "Standard_E64_32as_v5" + }, + { + "name": "StandardE6416AsV5", + "value": "Standard_E64_16as_v5" + }, + { + "name": "StandardE9648AsV5", + "value": "Standard_E96_48as_v5" + }, + { + "name": "StandardE9624AsV5", + "value": "Standard_E96_24as_v5" + }, + { + "name": "StandardGS48", + "value": "Standard_GS4_8" + }, + { + "name": "StandardGS44", + "value": "Standard_GS4_4" + }, + { + "name": "StandardGS516", + "value": "Standard_GS5_16" + }, + { + "name": "StandardGS58", + "value": "Standard_GS5_8" + }, + { + "name": "StandardDS111V2", + "value": "Standard_DS11_1_v2" + }, + { + "name": "StandardDS122V2", + "value": "Standard_DS12_2_v2" + }, + { + "name": "StandardDS121V2", + "value": "Standard_DS12_1_v2" + }, + { + "name": "StandardDS134V2", + "value": "Standard_DS13_4_v2" + }, + { + "name": "StandardDS132V2", + "value": "Standard_DS13_2_v2" + }, + { + "name": "StandardDS148V2", + "value": "Standard_DS14_8_v2" + }, + { + "name": "StandardDS144V2", + "value": "Standard_DS14_4_v2" + }, + { + "name": "StandardM416208SV2", + "value": "Standard_M416_208s_v2" + }, + { + "name": "StandardM416208MsV2", + "value": "Standard_M416_208ms_v2" + }, + { + "name": "StandardE2BsV5", + "value": "Standard_E2bs_v5" + }, + { + "name": "StandardE4BsV5", + "value": "Standard_E4bs_v5" + }, + { + "name": "StandardE8BsV5", + "value": "Standard_E8bs_v5" + }, + { + "name": "StandardE16BsV5", + "value": "Standard_E16bs_v5" + }, + { + "name": "StandardE32BsV5", + "value": "Standard_E32bs_v5" + }, + { + "name": "StandardE48BsV5", + "value": "Standard_E48bs_v5" + }, + { + "name": "StandardE64BsV5", + "value": "Standard_E64bs_v5" + }, + { + "name": "StandardE2BdsV5", + "value": "Standard_E2bds_v5" + }, + { + "name": "StandardE4BdsV5", + "value": "Standard_E4bds_v5" + }, + { + "name": "StandardE8BdsV5", + "value": "Standard_E8bds_v5" + }, + { + "name": "StandardE16BdsV5", + "value": "Standard_E16bds_v5" + }, + { + "name": "StandardE32BdsV5", + "value": "Standard_E32bds_v5" + }, + { + "name": "StandardE48BdsV5", + "value": "Standard_E48bds_v5" + }, + { + "name": "StandardE64BdsV5", + "value": "Standard_E64bds_v5" + } + ] + } + }, + "AzureVmSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "RecommendedSizeHasLessNetworkAdapters", + "CannotReportComputeCost", + "CannotReportStorageCost", + "CannotReportBandwidthCosts", + "PercentageOfCoresUtilizedMissing", + "PercentageOfMemoryUtilizedMissing", + "PercentageOfCoresUtilizedOutOfRange", + "PercentageOfMemoryUtilizedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureVmSuitabilityDetail", + "modelAsString": true + } + }, + "AzureVmSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "GuestOperatingSystemArchitectureNotSupported", + "GuestOperatingSystemNotSupported", + "BootTypeNotSupported", + "MoreDisksThanSupported", + "NoSuitableVmSizeFound", + "OneOrMoreDisksNotSuitable", + "OneOrMoreAdaptersNotSuitable", + "InternalErrorOccurredDuringComputeEvaluation", + "InternalErrorOccurredDuringStorageEvaluation", + "InternalErrorOccurredDuringNetworkEvaluation", + "NoVmSizeSupportsStoragePerformance", + "NoVmSizeSupportsNetworkPerformance", + "NoVmSizeForSelectedPricingTier", + "NoVmSizeForSelectedAzureLocation", + "CheckRedHatLinuxVersion", + "CheckOpenSuseLinuxVersion", + "CheckWindowsServer2008R2Version", + "CheckCentOsVersion", + "CheckDebianLinuxVersion", + "CheckSuseLinuxVersion", + "CheckOracleLinuxVersion", + "CheckUbuntuLinuxVersion", + "CheckCoreOsLinuxVersion", + "WindowsServerVersionConditionallySupported", + "NoGuestOperatingSystemConditionallySupported", + "WindowsClientVersionsConditionallySupported", + "BootTypeUnknown", + "GuestOperatingSystemUnknown", + "WindowsServerVersionsSupportedWithCaveat", + "WindowsOSNoLongerUnderMSSupport", + "EndorsedWithConditionsLinuxDistributions", + "UnendorsedLinuxDistributions", + "NoVmSizeForStandardPricingTier", + "NoVmSizeForBasicPricingTier", + "NoVmSizeInSelectedFamilyFound", + "NoEaPriceFoundForVmSize", + "NoVmSizeFoundForOfferCurrencyReservedInstance" + ], + "x-ms-enum": { + "name": "AzureVmSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureWebAppSuitabilityIssueCategory": { + "type": "string", + "enum": [ + "Unknown", + "Issue", + "Info" + ], + "x-ms-enum": { + "name": "AzureWebAppSuitabilityIssueCategory", + "modelAsString": true + } + }, + "AzureWebAppTargetType": { + "type": "string", + "enum": [ + "Unknown", + "AzureAppService", + "AzureAppServiceContainer" + ], + "x-ms-enum": { + "name": "AzureWebAppTargetType", + "modelAsString": true + } + }, + "AzureWebAppTier": { + "type": "string", + "enum": [ + "Unknown", + "Free", + "Premium_V2", + "Premium_V3", + "Isolated" + ], + "x-ms-enum": { + "name": "AzureWebAppTier", + "modelAsString": true + } + }, + "BusinessCase": { + "type": "object", + "description": "Business case resource.", + "properties": { + "properties": { + "$ref": "#/definitions/BusinessCaseProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BusinessCaseCurrency": { + "type": "string", + "description": "Business case supported currency types.", + "enum": [ + "Unknown", + "USD", + "DKK", + "CAD", + "IDR", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SAR", + "ZAR", + "SEK", + "TRY", + "GBP", + "MXN", + "MYR", + "INR", + "HKD", + "BRL", + "TWD", + "EUR", + "CHF", + "ARS", + "AUD", + "CNY" + ], + "x-ms-enum": { + "name": "BusinessCaseCurrency", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Currency Unknown." + }, + { + "name": "USD", + "value": "USD", + "description": "Currency USD." + }, + { + "name": "DKK", + "value": "DKK", + "description": "Currency DKK." + }, + { + "name": "CAD", + "value": "CAD", + "description": "Currency CAD." + }, + { + "name": "IDR", + "value": "IDR", + "description": "Currency IDR." + }, + { + "name": "JPY", + "value": "JPY", + "description": "Currency JPY." + }, + { + "name": "KRW", + "value": "KRW", + "description": "Currency KRW." + }, + { + "name": "NZD", + "value": "NZD", + "description": "Currency NZD." + }, + { + "name": "NOK", + "value": "NOK", + "description": "Currency NOK." + }, + { + "name": "RUB", + "value": "RUB", + "description": "Currency RUB." + }, + { + "name": "SAR", + "value": "SAR", + "description": "Currency SAR." + }, + { + "name": "ZAR", + "value": "ZAR", + "description": "Currency ZAR." + }, + { + "name": "SEK", + "value": "SEK", + "description": "Currency SEK." + }, + { + "name": "TRY", + "value": "TRY", + "description": "Currency TRY." + }, + { + "name": "GBP", + "value": "GBP", + "description": "Currency GBP." + }, + { + "name": "MXN", + "value": "MXN", + "description": "Currency MXN." + }, + { + "name": "MYR", + "value": "MYR", + "description": "Currency MYR." + }, + { + "name": "INR", + "value": "INR", + "description": "Currency INR." + }, + { + "name": "HKD", + "value": "HKD", + "description": "Currency HKD." + }, + { + "name": "BRL", + "value": "BRL", + "description": "Currency BRL." + }, + { + "name": "TWD", + "value": "TWD", + "description": "Currency TWD." + }, + { + "name": "EUR", + "value": "EUR", + "description": "Currency EUR." + }, + { + "name": "CHF", + "value": "CHF", + "description": "Currency CHF." + }, + { + "name": "ARS", + "value": "ARS", + "description": "Currency ARS." + }, + { + "name": "AUD", + "value": "AUD", + "description": "Currency AUD." + }, + { + "name": "CNY", + "value": "CNY", + "description": "Currency CNY." + } + ] + } + }, + "BusinessCaseListResult": { + "type": "object", + "description": "The response of a BusinessCase list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BusinessCase items on this page", + "items": { + "$ref": "#/definitions/BusinessCase" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BusinessCaseProperties": { + "type": "object", + "description": "Property bag for an\nMicrosoft.Azure.Migrate.BusinessCaseService.Api.V20220202_preview.Resources.BusinessCase\nresource.", + "properties": { + "settings": { + "$ref": "#/definitions/Settings", + "description": "Business case settings." + }, + "state": { + "$ref": "#/definitions/BusinessCaseState", + "description": "Business case state.", + "readOnly": true + }, + "reportStatusDetails": { + "type": "array", + "description": "Gets the state of business case reports.", + "items": { + "$ref": "#/definitions/ReportDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "BusinessCaseState": { + "type": "string", + "description": "Business case supported state types.", + "enum": [ + "Unknown", + "InProgress", + "Completed", + "OutDated", + "Invalid", + "OutOfSync", + "Failed" + ], + "x-ms-enum": { + "name": "BusinessCaseState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown State." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress State." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed State." + }, + { + "name": "OutDated", + "value": "OutDated", + "description": "OutDated State." + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Invalid State." + }, + { + "name": "OutOfSync", + "value": "OutOfSync", + "description": "OutOfSync State." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed State." + } + ] + } + }, + "Check": { + "type": "object", + "description": "Data model of Check or Rule for Suitability Analysis.", + "properties": { + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "behavior": { + "$ref": "#/definitions/CheckResult", + "description": "Gets behavior or check result.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Gets description.", + "readOnly": true + }, + "cause": { + "type": "string", + "description": "Gets cause.", + "readOnly": true + }, + "recommendation": { + "type": "string", + "description": "Gets recommendation.", + "readOnly": true + }, + "moreInfo": { + "$ref": "#/definitions/MoreInfo", + "description": "Gets more information about check or rule.", + "readOnly": true + } + }, + "required": [ + "name", + "behavior", + "description", + "cause", + "recommendation", + "moreInfo" + ] + }, + "CheckResult": { + "type": "string", + "description": "Suitability Check or Rule Result.", + "enum": [ + "Unknown", + "Issue", + "Warn", + "Pass" + ], + "x-ms-enum": { + "name": "CheckResult", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates missing value." + }, + { + "name": "Issue", + "value": "Issue", + "description": "Indicates Migration Issue." + }, + { + "name": "Warn", + "value": "Warn", + "description": "Indicates Migration Warning." + }, + { + "name": "Pass", + "value": "Pass", + "description": "Indicates check is passed." + } + ] + } + }, + "CloudSuitability": { + "type": "string", + "description": "Cloud Suitability for Azure.", + "enum": [ + "Unknown", + "NotSuitable", + "Suitable", + "ConditionallySuitable", + "ReadinessUnknown" + ], + "x-ms-enum": { + "name": "CloudSuitability", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "NotSuitable", + "value": "NotSuitable", + "description": "Not Suitable for Azure." + }, + { + "name": "Suitable", + "value": "Suitable", + "description": "Suitable for Azure." + }, + { + "name": "ConditionallySuitable", + "value": "ConditionallySuitable", + "description": "Conditionally Suitable for Azure." + }, + { + "name": "ReadinessUnknown", + "value": "ReadinessUnknown", + "description": "Unknown Readiness for Azure." + } + ] + } + }, + "Cluster": { + "type": "object", + "description": "Data model of Cluster.", + "properties": { + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "nodePools": { + "type": "array", + "description": "Gets list of node pools.", + "items": { + "$ref": "#/definitions/NodePool" + }, + "readOnly": true + }, + "region": { + "type": "string", + "description": "Gets region.", + "readOnly": true + }, + "userNodePoolCount": { + "type": "integer", + "format": "int32", + "description": "Gets user node pool count.", + "readOnly": true + }, + "userNodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets user node count.", + "readOnly": true + }, + "systemNodePoolCount": { + "type": "integer", + "format": "int32", + "description": "Gets system node pool count.", + "readOnly": true + }, + "systemNodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets system node count.", + "readOnly": true + }, + "podCount": { + "type": "integer", + "format": "int32", + "description": "Gets pod count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + } + }, + "required": [ + "name", + "nodePools", + "region", + "userNodePoolCount", + "userNodeCount", + "systemNodePoolCount", + "systemNodeCount", + "podCount", + "monthlyCost" + ] + }, + "CollectorAgentPropertiesBase": { + "type": "object", + "description": "Collector agent property class.", + "properties": { + "id": { + "type": "string", + "description": "Gets the collector agent id." + }, + "version": { + "type": "string", + "description": "Gets the collector agent version." + }, + "lastHeartbeatUtc": { + "type": "string", + "format": "date-time", + "description": "Gets the collector last heartbeat time." + }, + "spnDetails": { + "$ref": "#/definitions/CollectorAgentSpnPropertiesBase", + "description": "Gets or sets the SPN details." + } + } + }, + "CollectorAgentSpnPropertiesBase": { + "type": "object", + "description": "Collector agent SPN details class.", + "properties": { + "authority": { + "type": "string", + "description": "Gets the AAD authority endpoint." + }, + "applicationId": { + "type": "string", + "description": "Gets the AAD application id." + }, + "audience": { + "type": "string", + "description": "Gets the AAD audience url." + }, + "objectId": { + "type": "string", + "description": "Gets the object id of the AAD application." + }, + "tenantId": { + "type": "string", + "description": "Gets the tenant id of the AAD application." + } + } + }, + "CollectorPropertiesBase": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "CollectorPropertiesBaseWithAgent": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "agentProperties": { + "$ref": "#/definitions/CollectorAgentPropertiesBase", + "description": "Gets or sets the collector agent properties." + }, + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "CompareSummary": { + "type": "object", + "description": "Compare summary class.", + "properties": { + "azurePaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The azure PaaS cost.", + "readOnly": true + }, + "azureIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The azure IaaS cost.", + "readOnly": true + }, + "azureAvsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The AVS cost.", + "readOnly": true + }, + "onPremisesPaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises IaaS cost.", + "readOnly": true + }, + "onPremisesAvsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises AVS cost.", + "readOnly": true + }, + "onPremisesPaasDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS decommissioned cost.", + "readOnly": true + }, + "onPremisesIaasDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises IaaS decommissioned cost.", + "readOnly": true + }, + "onPremisesAvsDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises AVS decommissioned cost.", + "readOnly": true + } + } + }, + "CompatibilityLevel": { + "type": "string", + "enum": [ + "Unknown", + "CompatLevel80", + "CompatLevel90", + "CompatLevel100", + "CompatLevel110", + "CompatLevel120", + "CompatLevel130", + "CompatLevel140", + "CompatLevel150" + ], + "x-ms-enum": { + "name": "CompatibilityLevel", + "modelAsString": true + } + }, + "ComputeResource": { + "type": "object", + "description": "Data model of Cores and Memory Compute Resource.", + "properties": { + "cores": { + "type": "number", + "format": "float", + "description": "Gets cores.", + "readOnly": true + }, + "memory": { + "type": "number", + "format": "float", + "description": "Gets memory.", + "readOnly": true + } + }, + "required": [ + "cores", + "memory" + ] + }, + "ComputeSettings": { + "type": "object", + "description": "Compute settings.", + "properties": { + "hyperthreadCoreToMemoryRatio": { + "type": "number", + "format": "float", + "description": "Hyperthread core to memory ratio." + }, + "price": { + "type": "number", + "format": "float", + "description": "Compute Price." + }, + "sqlServerLicensing": { + "type": "array", + "description": "SQL Server licensing settings.", + "items": { + "$ref": "#/definitions/SqlServerLicensingSettings" + }, + "x-ms-identifiers": [] + }, + "windowsServerLicensing": { + "$ref": "#/definitions/WindowsServerLicensingSettings", + "description": "Windows Server licensing settings." + }, + "virtualizationSoftwareSettings": { + "$ref": "#/definitions/VirtualizationSoftwareSettings", + "description": "Virtualization software settings." + } + }, + "required": [ + "hyperthreadCoreToMemoryRatio", + "price", + "sqlServerLicensing", + "windowsServerLicensing", + "virtualizationSoftwareSettings" + ] + }, + "ComputeTier": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "Provisioned", + "Serverless" + ], + "x-ms-enum": { + "name": "ComputeTier", + "modelAsString": true + } + }, + "ConsolidationType": { + "type": "string", + "description": "Consolidation Type.", + "enum": [ + "Full", + "AsOnSource" + ], + "x-ms-enum": { + "name": "ConsolidationType", + "modelAsString": true, + "values": [ + { + "name": "Full", + "value": "Full", + "description": "Full Consolidation." + }, + { + "name": "AsOnSource", + "value": "AsOnSource", + "description": "As On Source or On Premises Consolidation." + } + ] + } + }, + "CostByStorageType": { + "type": "object", + "description": "The cost by storage type.", + "properties": { + "storageType": { + "type": "string", + "description": "The storage type.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Cost per storage type.", + "readOnly": true + } + } + }, + "CostComponent": { + "type": "object", + "description": "Class to represent the component of the cost.", + "properties": { + "name": { + "$ref": "#/definitions/CostComponentName", + "description": "Gets the name of the component.", + "readOnly": true + }, + "value": { + "type": "number", + "format": "float", + "description": "The value of the component." + }, + "description": { + "type": "string", + "description": "The textual description of the component." + } + } + }, + "CostComponentName": { + "type": "string", + "description": "Enum to represent component name.", + "enum": [ + "Unknown", + "MonthlyAzureHybridCostSavings", + "MonthlySecurityCost", + "MonthlyPremiumV2StorageCost", + "MonthlyLinuxAzureHybridCostSavings" + ], + "x-ms-enum": { + "name": "CostComponentName", + "modelAsString": true + } + }, + "CostDetails": { + "type": "object", + "description": "The on premises PaaS cost.", + "properties": { + "storageCost": { + "type": "number", + "format": "float", + "description": "The storage cost.", + "readOnly": true + }, + "computeCost": { + "type": "number", + "format": "float", + "description": "The compute cost.", + "readOnly": true + }, + "itLaborCost": { + "type": "number", + "format": "float", + "description": "The IT labor cost.", + "readOnly": true + }, + "networkCost": { + "type": "number", + "format": "float", + "description": "The network cost.", + "readOnly": true + }, + "ahubSavings": { + "type": "number", + "format": "float", + "description": "The AhubSavings.", + "readOnly": true + }, + "securityCost": { + "type": "number", + "format": "float", + "description": "Security Cost.", + "readOnly": true + }, + "managementCostDetails": { + "$ref": "#/definitions/ManagementCostDetails", + "description": "Management Cost Details.", + "readOnly": true + }, + "esuSavings": { + "type": "number", + "format": "float", + "description": "esu savings.", + "readOnly": true + } + } + }, + "DiscoveredEntitiesSummary": { + "type": "object", + "description": "Discovered entities summary.", + "properties": { + "numberOfServers": { + "type": "integer", + "format": "int32", + "description": "Number of web servers", + "readOnly": true + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Number of web apps", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines", + "readOnly": true + }, + "webServerSummary": { + "type": "object", + "description": "Web server summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "webAppSummary": { + "type": "object", + "description": "Web app summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "DiscoveredEntityLightSummary": { + "type": "object", + "description": "Discovered entity light summary.", + "properties": { + "numberOfServers": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of servers." + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of web apps." + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of machines." + } + }, + "required": [ + "numberOfServers", + "numberOfWebApps", + "numberOfMachines" + ] + }, + "DiscoverySource": { + "type": "string", + "description": "Business case supported Discovery source types.", + "enum": [ + "Unknown", + "Appliance", + "Import" + ], + "x-ms-enum": { + "name": "DiscoverySource", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Discovery Source." + }, + { + "name": "Appliance", + "value": "Appliance", + "description": "Appliance Discovery Source." + }, + { + "name": "Import", + "value": "Import", + "description": "Import Discovery Source." + } + ] + } + }, + "Disk": { + "type": "object", + "description": "A disk discovered on a machine.", + "properties": { + "gigabytesAllocated": { + "type": "number", + "format": "float", + "description": "Gigabytes of storage provisioned for this disk.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "User friendly name of the disk.", + "readOnly": true + } + } + }, + "DistributionByOperatingSystem": { + "type": "object", + "description": "The distribution by operating system.", + "properties": { + "osClassificationType": { + "type": "string", + "description": "The Os classification type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of machines with the OS type classification.", + "readOnly": true + } + } + }, + "DistributionByType": { + "type": "object", + "description": "Distribution by Type.", + "properties": { + "type": { + "type": "string", + "description": "Distribution Type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Distribution Count.", + "readOnly": true + } + } + }, + "DistributionByVirtualization": { + "type": "object", + "description": "The distribution by virtualization.", + "properties": { + "virtualizationType": { + "type": "string", + "description": "The Virtualization type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of machines with the Virtualization type classification.", + "readOnly": true + } + } + }, + "DownloadUrl": { + "type": "object", + "description": "Data model of Download URL for assessment report.", + "properties": { + "assessmentReportUrl": { + "type": "string", + "description": "Hyperlink to download report.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiry date of download url.", + "readOnly": true + } + }, + "required": [ + "assessmentReportUrl", + "expirationTime" + ] + }, + "EntityUptime": { + "type": "object", + "description": "Entity Uptime.", + "properties": { + "daysPerMonth": { + "type": "integer", + "format": "int32", + "description": "Gets the days per month." + }, + "hoursPerDay": { + "type": "integer", + "format": "int32", + "description": "Gets the hours per day." + } + } + }, + "EnvironmentType": { + "type": "string", + "enum": [ + "Production", + "Test" + ], + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true + } + }, + "Error": { + "type": "object", + "description": "Error web model class.", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "Gets the error ID.", + "readOnly": true + }, + "code": { + "type": "string", + "description": "Gets the error code.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the Run as account ID.", + "readOnly": true + }, + "applianceName": { + "type": "string", + "description": "Gets the Appliance name.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "summaryMessage": { + "type": "string", + "description": "Gets the error summary message.", + "readOnly": true + }, + "agentScenario": { + "type": "string", + "description": "Gets the agent scenario where this error occurred.", + "readOnly": true + }, + "possibleCauses": { + "type": "string", + "description": "Gets the error possible causes.", + "readOnly": true + }, + "recommendedAction": { + "type": "string", + "description": "Gets the recommended action for the error.", + "readOnly": true + }, + "severity": { + "type": "string", + "description": "Gets the error severity.", + "readOnly": true + }, + "messageParameters": { + "type": "object", + "description": "Gets the error message parameters.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "updatedTimeStamp": { + "type": "string", + "format": "date-time", + "description": "Gets the time stamp when the error was updated.", + "readOnly": true + }, + "impactedAssessmentType": { + "type": "string", + "description": "Gets the type of assessment impacted by this error.", + "readOnly": true + } + } + }, + "ErrorSummary": { + "type": "object", + "description": "Error summary containing affected entities for each type of assessment.", + "properties": { + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Gets the assessment type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets the affected entity count.", + "readOnly": true + } + } + }, + "EstimatedCostByOffer": { + "type": "object", + "description": "The estimated cost by offer.", + "properties": { + "offerName": { + "type": "string", + "description": "The offer name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Cost for the offer.", + "readOnly": true + } + } + }, + "EstimatedCostByTarget": { + "type": "object", + "description": "Shows the estimated cost by target.", + "properties": { + "azureSqlMiCost": { + "type": "number", + "format": "float", + "description": "Azure SQL MI cost.", + "readOnly": true + }, + "azureSqlDbCost": { + "type": "number", + "format": "float", + "description": "Azure SQL DB cost.", + "readOnly": true + }, + "appServiceCost": { + "type": "number", + "format": "float", + "description": "Azure App Service cost.", + "readOnly": true + }, + "appServiceContainerCost": { + "type": "number", + "format": "float", + "description": "Azure App Service Containers cost.", + "readOnly": true + }, + "azureKubernetesServiceCost": { + "type": "number", + "format": "float", + "description": "Azure Kubernetes Service cost.", + "readOnly": true + } + } + }, + "EvaluatedAvsMachine": { + "type": "object", + "description": "Evaluated AVS machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedAvsMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedAvsMachineListResult": { + "type": "object", + "description": "The response of a EvaluatedAvsMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedAvsMachine items on this page", + "items": { + "$ref": "#/definitions/EvaluatedAvsMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedAvsMachineProperties": { + "type": "object", + "description": "Evaluated AVS machine properties class.", + "properties": { + "machineId": { + "type": "string", + "description": "Machine Id.", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "Server Name.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "Virtualization type.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating System (OS) name.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedMachine": { + "type": "object", + "description": "Evaluated machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedMachineListResult": { + "type": "object", + "description": "The response of a EvaluatedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedMachine items on this page", + "items": { + "$ref": "#/definitions/EvaluatedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedMachineProperties": { + "type": "object", + "description": "Evaluated machine properties class.", + "properties": { + "machineId": { + "type": "string", + "description": "Machine Id.", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "Server Name.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "Virtualization type.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating System (OS) name.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedSqlEntity": { + "type": "object", + "description": "Evaluated sql entity resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedSqlEntityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedSqlEntityListResult": { + "type": "object", + "description": "The response of a EvaluatedSqlEntity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedSqlEntity items on this page", + "items": { + "$ref": "#/definitions/EvaluatedSqlEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedSqlEntityProperties": { + "type": "object", + "description": "Evaluated sql entity properties class.", + "properties": { + "serverName": { + "type": "string", + "description": "Server name.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "SQL Server version.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "SQL Server edition.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is SQL Instance ready for migration.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "The virtualization type.", + "readOnly": true + }, + "dbCount": { + "type": "integer", + "format": "int32", + "description": "DB count in instance.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedWebApp": { + "type": "object", + "description": "Evaluated web app resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedWebAppProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedWebAppListResult": { + "type": "object", + "description": "The response of a EvaluatedWebApp list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedWebApp items on this page", + "items": { + "$ref": "#/definitions/EvaluatedWebApp" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedWebAppProperties": { + "type": "object", + "description": "Evaluated web app properties class.", + "properties": { + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target." + }, + "recommendedAzureSkuName": { + "type": "string", + "description": "Recommended Azure SKU name." + }, + "recommendedAzureSkuSize": { + "type": "string", + "description": "Recommended Azure SKU size." + }, + "serverName": { + "type": "string", + "description": "The server name." + }, + "workload": { + "type": "string", + "description": "The workload." + }, + "activityState": { + "type": "string", + "description": "The activity state." + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration." + } + } + }, + "FacilitySettings": { + "type": "object", + "description": "Facility settings.", + "properties": { + "facilitiesCost": { + "type": "number", + "format": "float", + "description": "The facilities cost." + } + }, + "required": [ + "facilitiesCost" + ] + }, + "FttAndRaidLevel": { + "type": "string", + "description": "FTT and RAID Level.", + "enum": [ + "Unknown", + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "x-ms-enum": { + "name": "FttAndRaidLevel", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown FTT and RAID Level." + }, + { + "name": "Ftt1Raid1", + "value": "Ftt1Raid1", + "description": "FTT 1 and RAID Level 1." + }, + { + "name": "Ftt1Raid5", + "value": "Ftt1Raid5", + "description": "FTT 1 and RAID Level 5." + }, + { + "name": "Ftt2Raid1", + "value": "Ftt2Raid1", + "description": "FTT 2 and RAID Level 1." + }, + { + "name": "Ftt2Raid6", + "value": "Ftt2Raid6", + "description": "FTT 2 and RAID Level 6." + }, + { + "name": "Ftt3Raid1", + "value": "Ftt3Raid1", + "description": "FTT 3 and RAID Level 1." + } + ] + } + }, + "Group": { + "type": "object", + "description": "Group resource.", + "properties": { + "properties": { + "$ref": "#/definitions/GroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GroupBodyProperties": { + "type": "object", + "description": "Body properties of group update.", + "properties": { + "operationType": { + "$ref": "#/definitions/GroupUpdateOperation", + "description": "Whether to add or remove the machines." + }, + "machines": { + "type": "array", + "description": "List of machine names that are part of this group.", + "items": { + "type": "string" + } + } + } + }, + "GroupListResult": { + "type": "object", + "description": "The response of a Group list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Group items on this page", + "items": { + "$ref": "#/definitions/Group" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GroupProperties": { + "type": "object", + "description": "Properties of group resource.", + "properties": { + "groupStatus": { + "$ref": "#/definitions/GroupStatus", + "description": "Whether the group has been created and is valid.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of this group.", + "readOnly": true + }, + "assessments": { + "type": "array", + "description": "List of References to Assessments created on this group.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "supportedAssessmentTypes": { + "type": "array", + "description": "List of assessment types supported on this group.", + "items": { + "$ref": "#/definitions/AssessmentType" + } + }, + "areAssessmentsRunning": { + "type": "boolean", + "description": "If the assessments are in running state.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this group was created. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this group was last updated. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "The type of group.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "GroupStatus": { + "type": "string", + "enum": [ + "Created", + "Updated", + "Running", + "Completed", + "Invalid" + ], + "x-ms-enum": { + "name": "GroupStatus", + "modelAsString": true + } + }, + "GroupType": { + "type": "string", + "enum": [ + "Default", + "Import" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": true + } + }, + "GroupUpdateOperation": { + "type": "string", + "enum": [ + "Add", + "Remove" + ], + "x-ms-enum": { + "name": "GroupUpdateOperation", + "modelAsString": true + } + }, + "GuestOperatingSystemArchitecture": { + "type": "string", + "enum": [ + "Unknown", + "X86", + "X64" + ], + "x-ms-enum": { + "name": "GuestOperatingSystemArchitecture", + "modelAsString": true + } + }, + "HardwareGeneration": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "Gen5", + "Fsv2_series", + "M_series", + "DC_series" + ], + "x-ms-enum": { + "name": "HardwareGeneration", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "Automatic", + "value": "Automatic" + }, + { + "name": "Gen5", + "value": "Gen5" + }, + { + "name": "Fsv2Series", + "value": "Fsv2_series" + }, + { + "name": "MSeries", + "value": "M_series" + }, + { + "name": "DCSeries", + "value": "DC_series" + } + ] + } + }, + "HyperVLicenseType": { + "type": "string", + "description": "Business case supported HyperV License types.", + "enum": [ + "Unknown", + "Datacentre", + "Standard" + ], + "x-ms-enum": { + "name": "HyperVLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown HyperV License." + }, + { + "name": "Datacentre", + "value": "Datacentre", + "description": "Datacentre HyperV License." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard HyperV License." + } + ] + } + }, + "HypervCollector": { + "type": "object", + "description": "Hyper-V collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervCollectorListResult": { + "type": "object", + "description": "The response of a HypervCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervCollector items on this page", + "items": { + "$ref": "#/definitions/HypervCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervLicense": { + "type": "object", + "description": "Representation of a licence.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Cost of a licence." + }, + "licenseType": { + "$ref": "#/definitions/HyperVLicenseType", + "description": "HyperV licence type." + } + }, + "required": [ + "licenseCost", + "licenseType" + ] + }, + "HypervVirtualizationManagementSettings": { + "type": "object", + "description": "HyperV Virtualization Management Settings.", + "properties": { + "numberOfPhysicalCoresPerLicense": { + "type": "integer", + "format": "int32", + "description": "Number of physical cores per licence.", + "minimum": 1 + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software Assurance Cost." + }, + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/HypervLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "numberOfPhysicalCoresPerLicense", + "softwareAssuranceCost", + "licenseAndSupportList" + ] + }, + "IaasOsDistribution": { + "type": "object", + "description": "Shows the infrastructure as a service machine OS distribution.", + "properties": { + "windows": { + "type": "integer", + "format": "int32", + "description": "Number of Windows servers.", + "readOnly": true + }, + "linux": { + "type": "integer", + "format": "int32", + "description": "Number of Linux servers.", + "readOnly": true + }, + "other": { + "type": "integer", + "format": "int32", + "description": "Number of servers neither Windows or Linux.", + "readOnly": true + } + } + }, + "IaasOsLicensingDetails": { + "type": "object", + "description": "The Iaas OS licensing details.", + "properties": { + "osType": { + "type": "string", + "description": "The OS type.", + "readOnly": true + }, + "totalCost": { + "type": "number", + "format": "float", + "description": "The total cost.", + "readOnly": true + }, + "decomissionCost": { + "type": "number", + "format": "float", + "description": "The decommission cost.", + "readOnly": true + } + } + }, + "IaasSummary": { + "type": "object", + "description": "Iaas summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/IaasSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "IaasSummaryListResult": { + "type": "object", + "description": "The response of a IaasSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IaasSummary items on this page", + "items": { + "$ref": "#/definitions/IaasSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IaasSummaryProperties": { + "type": "object", + "description": "Iaas summary properties class.", + "properties": { + "azureIaasSummary": { + "$ref": "#/definitions/AzureIaasSummary", + "description": "The Azure IaaS summary.", + "readOnly": true + }, + "onPremisesIaasSummary": { + "$ref": "#/definitions/OnPremisesIaasSummary", + "description": "The on premises IaaS summary.", + "readOnly": true + } + } + }, + "ImpactedAssessmentObject": { + "type": "object", + "description": "Class representing the impacted objects.", + "properties": { + "objectName": { + "type": "string", + "description": "Gets the object name.", + "readOnly": true + }, + "objectType": { + "type": "string", + "description": "Gets the object type.", + "readOnly": true + } + } + }, + "ImportCollector": { + "type": "object", + "description": "Import collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBase", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ImportCollectorListResult": { + "type": "object", + "description": "The response of a ImportCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImportCollector items on this page", + "items": { + "$ref": "#/definitions/ImportCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LaborSettings": { + "type": "object", + "description": "Labour settings.", + "properties": { + "physicalServersPerAdmin": { + "type": "integer", + "format": "int32", + "description": "Physical servers per administrator.", + "minimum": 1 + }, + "virtualMachinesPerAdmin": { + "type": "integer", + "format": "int32", + "description": "Virtual machines per administrator.", + "minimum": 1 + }, + "hourlyAdminCost": { + "type": "number", + "format": "float", + "description": "Hourly administrator cost." + } + }, + "required": [ + "physicalServersPerAdmin", + "virtualMachinesPerAdmin", + "hourlyAdminCost" + ] + }, + "LicenseType": { + "type": "string", + "description": "Business case supported VmWare License types.", + "enum": [ + "Unknown", + "VSphereStandard", + "VSphereEnterprisePlus" + ], + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown License." + }, + { + "name": "VSphereStandard", + "value": "VSphereStandard", + "description": "VSphereStandard License." + }, + { + "name": "VSphereEnterprisePlus", + "value": "VSphereEnterprisePlus", + "description": "VSphereEnterprisePlus License." + } + ] + } + }, + "LicensingProgram": { + "type": "string", + "description": "Licensing Program for Azure.", + "enum": [ + "Default", + "EA" + ], + "x-ms-enum": { + "name": "LicensingProgram", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default value. Indicates Pay As You Go." + }, + { + "name": "EA", + "value": "EA", + "description": "Enterprise Agreement." + } + ] + } + }, + "Machine": { + "type": "object", + "description": "Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "MachineAssessmentProperties": { + "type": "object", + "description": "Properties of an assessment.", + "properties": { + "assessmentErrorSummary": { + "type": "object", + "description": "Gets or sets the assessment error summary.\n This is the number of\nmachines affected by each type of error in this assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyUltraStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate ultra storage cost for all machines in the\nassessment.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets enterprise agreement subscription id." + }, + "azurePricingTier": { + "$ref": "#/definitions/AzurePricingTier", + "description": "Gets or sets Azure Pricing Tier - Free, Basic, etc." + }, + "azureStorageRedundancy": { + "$ref": "#/definitions/AzureStorageRedundancy", + "description": "Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Gets or sets the Azure Reserved Instance - 1-Year, 3-Year." + }, + "azureHybridUseBenefit": { + "$ref": "#/definitions/AzureHybridUseBenefit", + "description": "Gets or sets the user configurable setting to display the azure hybrid use\nbenefit." + }, + "linuxAzureHybridUseBenefit": { + "$ref": "#/definitions/AzureHybridUseBenefit", + "description": "Gets or sets the user configurable setting to display the linux azure hybrid use\nbenefit." + }, + "azureDiskTypes": { + "type": "array", + "description": "Gets or sets the azure storage type. Premium, Standard etc.", + "items": { + "$ref": "#/definitions/AzureDiskType" + } + }, + "azureVmFamilies": { + "type": "array", + "description": "Gets or sets the Azure VM families.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + } + }, + "distributionBySupportStatus": { + "type": "object", + "description": "Gets the distribution of sqlInstances by support status.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByServicePackInsight": { + "type": "object", + "description": "Gets the distribution distribution of sqlInstances by service pack insight.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByOsName": { + "type": "object", + "description": "Gets the distribution by os name.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Compute Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Bandwidth Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Storage Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyPremiumStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate premium storage cost for all machines in the\nassessment.", + "readOnly": true + }, + "monthlyStandardSsdStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate standard SSD storage cost for all the machines in\nthe assessment.", + "readOnly": true + }, + "suitabilitySummary": { + "type": "object", + "description": "Gets or sets the Cloud suitability summary for all the machines in the\nassessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of machines part of the assessment.", + "readOnly": true + }, + "vmUptime": { + "$ref": "#/definitions/VmUptime", + "description": "Gets or sets the duration for which the VMs are up in the on-premises\nenvironment." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment.", + "readOnly": true + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment.", + "readOnly": true + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "MachineBootType": { + "type": "string", + "enum": [ + "Unknown", + "EFI", + "BIOS", + "NotSpecified" + ], + "x-ms-enum": { + "name": "MachineBootType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "EFI", + "value": "EFI" + }, + { + "name": "Bios", + "value": "BIOS" + }, + { + "name": "NotSpecified", + "value": "NotSpecified" + } + ] + } + }, + "MachineListResult": { + "type": "object", + "description": "The response of a Machine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Machine items on this page", + "items": { + "$ref": "#/definitions/Machine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MachineProperties": { + "type": "object", + "description": "Properties of a machine.", + "properties": { + "workloadSummary": { + "$ref": "#/definitions/WorkloadSummary", + "description": "Gets or sets workload summary.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "hostProcessor": { + "$ref": "#/definitions/ProcessorInfo", + "description": "Gets Processor details of the host.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "discoveryMachineArmId": { + "type": "string", + "description": "Site id of machine discovered in private data center.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "The data center management server ARM Id for the machine.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "The data center management server name for the machine.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "disks": { + "type": "object", + "description": "Disks attached to the machine discovered in private data center.", + "additionalProperties": { + "$ref": "#/definitions/Disk" + }, + "readOnly": true + }, + "groups": { + "type": "array", + "description": "Gets the References to the groups that this machine is member of.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "Network adapters attached to the machine discovered in private data center.", + "additionalProperties": { + "$ref": "#/definitions/NetworkAdapter" + }, + "readOnly": true + }, + "sqlInstances": { + "type": "array", + "description": "SQL instances discovered on the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "webApplications": { + "type": "array", + "description": "Web applications discovered on the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + } + } + }, + "ManagementCostComponent": { + "type": "object", + "description": "Management Cost Component.", + "properties": { + "name": { + "$ref": "#/definitions/ManagementCostComponentName", + "description": "Name of Management Cost Component." + }, + "value": { + "type": "number", + "format": "float", + "description": "Cost of Management Component." + } + }, + "required": [ + "name" + ] + }, + "ManagementCostComponentName": { + "type": "string", + "description": "Management Cost Component Names.", + "enum": [ + "Unknown", + "SystemCenterLicenseCost", + "VSphereManagementCost", + "ThirdPartyManagementCost", + "OtherMonitoringCost", + "OtherDataProtectionCost", + "OtherPatchingCost", + "AzureMonitoringCost", + "AzurePatchingCost", + "AzureDataProtectionCost" + ], + "x-ms-enum": { + "name": "ManagementCostComponentName", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Management Cost Component." + }, + { + "name": "SystemCenterLicenseCost", + "value": "SystemCenterLicenseCost", + "description": "System Center License Cost." + }, + { + "name": "VSphereManagementCost", + "value": "VSphereManagementCost", + "description": "VSphere eManagement Cost." + }, + { + "name": "ThirdPartyManagementCost", + "value": "ThirdPartyManagementCost", + "description": "Third Party Management Cost." + }, + { + "name": "OtherMonitoringCost", + "value": "OtherMonitoringCost", + "description": "Other Monitoring Cost." + }, + { + "name": "OtherDataProtectionCost", + "value": "OtherDataProtectionCost", + "description": "Other Data Protection Cost." + }, + { + "name": "OtherPatchingCost", + "value": "OtherPatchingCost", + "description": "Other Patching Cost." + }, + { + "name": "AzureMonitoringCost", + "value": "AzureMonitoringCost", + "description": "Azure Monitoring Cost." + }, + { + "name": "AzurePatchingCost", + "value": "AzurePatchingCost", + "description": "Azure Patching Cost." + }, + { + "name": "AzureDataProtectionCost", + "value": "AzureDataProtectionCost", + "description": "Azure Data Protection Cost." + } + ] + } + }, + "ManagementCostDetails": { + "type": "object", + "description": "Management Cost Details.", + "properties": { + "managementCost": { + "type": "number", + "format": "float", + "description": "Management Cost.", + "readOnly": true + }, + "managementCostComponents": { + "type": "array", + "description": "Management Cost Components.", + "items": { + "$ref": "#/definitions/ManagementCostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ManagementSettings": { + "type": "object", + "description": "Management settings.", + "properties": { + "hypervVirtualizationManagementSettings": { + "$ref": "#/definitions/HypervVirtualizationManagementSettings", + "description": "HyperV Virtualization Management Settings." + }, + "vsphereManagementSettings": { + "$ref": "#/definitions/VsphereManagementSettings", + "description": "vSphere Management Settings." + }, + "thirdPartyManagementSettings": { + "$ref": "#/definitions/ThirdPartyManagementSettings", + "description": "Third Party Management Settings." + }, + "otherManagementCostsSettings": { + "$ref": "#/definitions/OtherManagementCostsSettings", + "description": "Other Management Costs Settings." + } + }, + "required": [ + "hypervVirtualizationManagementSettings", + "vsphereManagementSettings", + "thirdPartyManagementSettings", + "otherManagementCostsSettings" + ] + }, + "MigrationGuidelineContext": { + "type": "object", + "description": "Migration Guideline Context.", + "properties": { + "contextKey": { + "type": "string", + "description": "Gets the reasoning context key." + }, + "contextValue": { + "type": "string", + "description": "Gets the reasoning context value." + } + } + }, + "MigrationStrategy": { + "type": "string", + "description": "Business case supported migration strategy types.", + "enum": [ + "Unknown", + "OptimizeForCost", + "IaaSOnly", + "OptimizeForPaas", + "AVSOnly" + ], + "x-ms-enum": { + "name": "MigrationStrategy", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Migration Strategy." + }, + { + "name": "OptimizeForCost", + "value": "OptimizeForCost", + "description": "Optimize for cost." + }, + { + "name": "IaaSOnly", + "value": "IaaSOnly", + "description": "IaaS only." + }, + { + "name": "OptimizeForPaas", + "value": "OptimizeForPaas", + "description": "Optimize for PaaS." + }, + { + "name": "AVSOnly", + "value": "AVSOnly", + "description": "Avs only." + } + ] + } + }, + "MoreInfo": { + "type": "object", + "description": "Data model of More information about check or rule.", + "properties": { + "title": { + "type": "string", + "description": "Gets title.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "Gets url.", + "readOnly": true + } + }, + "required": [ + "title", + "url" + ] + }, + "MultiSubnetIntent": { + "type": "string", + "enum": [ + "None", + "HighAvailability", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "MultiSubnetIntent", + "modelAsString": true + } + }, + "MutableArmResource": { + "type": "object", + "description": "ARM model of Assessment ARM object.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningStatus", + "description": "Gets the provisioning state.", + "readOnly": true + } + } + }, + "NetworkAdapter": { + "type": "object", + "description": "A network adapter discovered on a machine.", + "properties": { + "macAddress": { + "type": "string", + "description": "MAC Address of the network adapter.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "List of IP Addresses on the network adapter.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "User friendly name of the network adapter.", + "readOnly": true + } + } + }, + "NetworkSettings": { + "type": "object", + "description": "Network settings.", + "properties": { + "hardwareSoftwareCostPercentage": { + "type": "number", + "format": "float", + "description": "Network hardware and software cost percentage.", + "minimum": 0, + "maximum": 100 + }, + "maintenanceCostPercentage": { + "type": "number", + "format": "float", + "description": "Network maintenance cost percentage.", + "minimum": 0, + "maximum": 100 + } + }, + "required": [ + "hardwareSoftwareCostPercentage", + "maintenanceCostPercentage" + ] + }, + "NodePool": { + "type": "object", + "description": "Data model of Node Pool.", + "properties": { + "id": { + "type": "string", + "description": "Gets id.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "clusterName": { + "type": "string", + "description": "Gets cluster name.", + "readOnly": true + }, + "mode": { + "$ref": "#/definitions/NodePoolMode", + "description": "Gets mode.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "Gets os type.", + "readOnly": true + }, + "armSkuName": { + "type": "string", + "description": "Gets arm sku name.", + "readOnly": true + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets node count.", + "readOnly": true + }, + "podCount": { + "type": "integer", + "format": "int32", + "description": "Gets pod count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + }, + "podApproxMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets pod approximate monthly cost.", + "readOnly": true + } + }, + "required": [ + "id", + "name", + "clusterName", + "mode", + "osType", + "armSkuName", + "nodeCount", + "podCount", + "monthlyCost", + "podApproxMonthlyCost" + ] + }, + "NodePoolMode": { + "type": "string", + "description": "Node Pool Mode.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "NodePoolMode", + "modelAsString": true, + "values": [ + { + "name": "User", + "value": "User", + "description": "Indicates User node pool." + }, + { + "name": "System", + "value": "System", + "description": "Indicates System node pool." + } + ] + } + }, + "OSType": { + "type": "string", + "description": "Operating System Type.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "name": "Linux", + "value": "Linux", + "description": "Linux OS Type." + }, + { + "name": "Windows", + "value": "Windows", + "description": "Windows OS Type." + } + ] + } + }, + "OnPremiseSettings": { + "type": "object", + "description": "On-premise settings.", + "properties": { + "computeSettings": { + "$ref": "#/definitions/ComputeSettings", + "description": "Compute settings." + }, + "storageSettings": { + "$ref": "#/definitions/StorageSettings", + "description": "Storage settings." + }, + "networkSettings": { + "$ref": "#/definitions/NetworkSettings", + "description": "Network settings." + }, + "facilitySettings": { + "$ref": "#/definitions/FacilitySettings", + "description": "Facility settings." + }, + "laborSettings": { + "$ref": "#/definitions/LaborSettings", + "description": "Labour settings." + }, + "securitySettings": { + "$ref": "#/definitions/SecuritySettings", + "description": "Security settings." + }, + "managementSettings": { + "$ref": "#/definitions/ManagementSettings", + "description": "Management settings." + } + }, + "required": [ + "computeSettings", + "storageSettings", + "networkSettings", + "facilitySettings", + "laborSettings", + "securitySettings" + ] + }, + "OnPremisesIaasSummary": { + "type": "object", + "description": "The on premises IAAS summary.", + "properties": { + "servers": { + "type": "integer", + "format": "int32", + "description": "The number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The number of cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "Total memory in GB.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "The CPU utilization.", + "readOnly": true + }, + "memoryUtilization": { + "type": "number", + "format": "float", + "description": "The memory utilization.", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "The storage utilization.", + "readOnly": true + }, + "onPremisesIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesIaasCostForDecommissioned": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "osLicensingDetails": { + "type": "array", + "description": "The OS licensing details.", + "items": { + "$ref": "#/definitions/IaasOsLicensingDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByOperatingSystem": { + "type": "array", + "description": "The distribution by operating system.", + "items": { + "$ref": "#/definitions/DistributionByOperatingSystem" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "onPremisesUtilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "distributionByVirtualization": { + "type": "array", + "description": "The distribution by virtualization.", + "items": { + "$ref": "#/definitions/DistributionByVirtualization" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "iaasOsSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Iaas OS Support Status Distribution.", + "readOnly": true + }, + "iaasSqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Iaas Sql Support Status Distribution.", + "readOnly": true + }, + "osServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "OS Service Pack Insight.", + "readOnly": true + }, + "sqlServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "Sql Service Pack Insight.", + "readOnly": true + }, + "distributionByOperatingSystemVersion": { + "type": "array", + "description": "Distribution by Operating System Version.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySqlVersion": { + "type": "array", + "description": "Distribution by Sql Version.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySqlEdition": { + "type": "array", + "description": "Distribution by Sql Edition.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "OnPremisesPaasLicensingCost": { + "type": "object", + "description": "The on premises paas licensing cost.", + "properties": { + "version": { + "type": "string", + "description": "The version.", + "readOnly": true + }, + "totalCost": { + "type": "number", + "format": "float", + "description": "The total cost.", + "readOnly": true + }, + "decomissionServerCost": { + "type": "number", + "format": "float", + "description": "The decommissioned server cost.", + "readOnly": true + } + } + }, + "OnPremisesPaasSummary": { + "type": "object", + "description": "Shows platform as a service (PaaS) summary.", + "properties": { + "totalServers": { + "type": "integer", + "format": "int32", + "description": "Total servers.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "CPU utilization percentage.", + "readOnly": true + }, + "memoryUtilization": { + "type": "number", + "format": "float", + "description": "Memory utilization percentage.", + "readOnly": true + }, + "totalOnPremisesPaasCost": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesPaasCostForDecommisioned": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesPaasLicensingCost": { + "$ref": "#/definitions/OnPremisesPaasLicensingCost", + "description": "The on premises paas licensing cost.", + "readOnly": true + }, + "onPremisesSqlSummary": { + "$ref": "#/definitions/OnPremisesSqlSummary", + "description": "The on premises SQL summary.", + "readOnly": true + }, + "onPremisesWebAppSummary": { + "$ref": "#/definitions/OnPremisesWebAppSummary", + "description": "The on premises web application summary.", + "readOnly": true + }, + "osSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "OS Support Status Distribution.", + "readOnly": true + }, + "sqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Sql Support Status Distribution.", + "readOnly": true + }, + "osServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "OS Service Pack Insight.", + "readOnly": true + }, + "sqlServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "Sql Service Pack Insight.", + "readOnly": true + } + } + }, + "OnPremisesSqlSummary": { + "type": "object", + "description": "The on premises SQL summary.", + "properties": { + "sqlInstances": { + "type": "integer", + "format": "int32", + "description": "The number of SQL instances.", + "readOnly": true + }, + "sqlDatabases": { + "type": "integer", + "format": "int32", + "description": "The number of SQL databases.", + "readOnly": true + }, + "distributionBySqlVersion": { + "type": "array", + "description": "Distribution by SQL version.", + "items": { + "$ref": "#/definitions/SqlVersionDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sqlOnPremisesUtilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "distributionBySqlEdition": { + "type": "array", + "description": "Distribution by Sql Edition.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "OnPremisesWebAppSummary": { + "type": "object", + "description": "The on premises web application summary.", + "properties": { + "numberOfWebServers": { + "type": "integer", + "format": "int32", + "description": "The number of web servers.", + "readOnly": true + }, + "numberOfWebApplications": { + "type": "integer", + "format": "int32", + "description": "The number of web applications.", + "readOnly": true + }, + "numberOfWebAppsPerType": { + "type": "object", + "description": "The number of web applications per web application type.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "OptimizationLogic": { + "type": "string", + "enum": [ + "MinimizeCost", + "ModernizeToPaaS", + "ModernizeToAzureSqlMi", + "ModernizeToAzureSqlDb" + ], + "x-ms-enum": { + "name": "OptimizationLogic", + "modelAsString": true + } + }, + "OptionsArmPropertiesBase": { + "type": "object", + "description": "Base ARM model of ARM properties for assessment options.", + "properties": { + "edges": { + "type": "object", + "description": "Gets the mapping of Assessment Options in graph representation.", + "additionalProperties": { + "$ref": "#/definitions/RecordOfStringArray" + }, + "readOnly": true + } + }, + "required": [ + "edges" + ] + }, + "OsLicense": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "OsLicense", + "modelAsString": true + } + }, + "OtherManagementCostsSettings": { + "type": "object", + "description": "Other Management Costs Settings.", + "properties": { + "monitoringCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Monitoring Cost Per Server Per Year." + }, + "patchingCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Patching Cost Per Server Per Year." + }, + "dataProtectionCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Data Protection Cost Per Server Per Year." + } + }, + "required": [ + "monitoringCostPerServerPerYear", + "patchingCostPerServerPerYear", + "dataProtectionCostPerServerPerYear" + ] + }, + "OverviewSummary": { + "type": "object", + "description": "Overview summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/OverviewSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OverviewSummaryListResult": { + "type": "object", + "description": "The response of a OverviewSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OverviewSummary items on this page", + "items": { + "$ref": "#/definitions/OverviewSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OverviewSummaryProperties": { + "type": "object", + "description": "Overview summary properties class.", + "properties": { + "totalAzureCost": { + "type": "number", + "format": "float", + "description": "The total Azure cost..", + "readOnly": true + }, + "totalAzureIaasCost": { + "type": "number", + "format": "float", + "description": "The total Azure IaaS cost.", + "readOnly": true + }, + "totalAzurePaasCost": { + "type": "number", + "format": "float", + "description": "The total Azure PaaS cost.", + "readOnly": true + }, + "totalAzureAvsCost": { + "type": "number", + "format": "float", + "description": "The total Avs cost.", + "readOnly": true + }, + "windowsAhubSavings": { + "type": "number", + "format": "float", + "description": "The windows ahub saving.", + "readOnly": true + }, + "sqlAhubSavings": { + "type": "number", + "format": "float", + "description": "The sql ahub saving.", + "readOnly": true + }, + "totalOnPremisesCost": { + "type": "number", + "format": "float", + "description": "The total on premises cost.", + "readOnly": true + }, + "esuSavingsFor4years": { + "type": "number", + "format": "float", + "description": "ESU Savings 4 Years.", + "readOnly": true + }, + "managementCostSavings": { + "type": "number", + "format": "float", + "description": "The management cost saving.", + "readOnly": true + }, + "securityCostSavings": { + "type": "number", + "format": "float", + "description": "The security cost saving.", + "readOnly": true + }, + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "serversDiscovered": { + "$ref": "#/definitions/ServersDiscovered", + "description": "Shows the discovered servers by virtualization platform.", + "readOnly": true + }, + "utilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "iaasOsDistribution": { + "$ref": "#/definitions/IaasOsDistribution", + "description": "Shows the infrastructure as a service machine OS distribution.", + "readOnly": true + }, + "osSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "OS Support Status Distribution.", + "readOnly": true + }, + "sqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Sql Support Status Distribution.", + "readOnly": true + }, + "paasDistribution": { + "$ref": "#/definitions/PaasDistribution", + "description": "Shows the distribution of platforms.", + "readOnly": true + } + } + }, + "POSAzurePricingTier": { + "type": "string", + "description": "Pricing Tier for Azure.", + "enum": [ + "Unknown", + "Standard" + ], + "x-ms-enum": { + "name": "POSAzurePricingTier", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard Pricing Tier." + } + ] + } + }, + "PaasDistribution": { + "type": "object", + "description": "Shows the distribution of platforms.", + "properties": { + "sqlServers": { + "type": "integer", + "format": "int32", + "description": "Number of SQL Server machines.", + "readOnly": true + }, + "iisWebServers": { + "type": "integer", + "format": "int32", + "description": "Number of IIS Web servers.", + "readOnly": true + }, + "webAppDistribution": { + "type": "object", + "description": "Distribution of webapps for each target type.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "PaasSummary": { + "type": "object", + "description": "Paas summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PaasSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PaasSummaryListResult": { + "type": "object", + "description": "The response of a PaasSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PaasSummary items on this page", + "items": { + "$ref": "#/definitions/PaasSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PaasSummaryProperties": { + "type": "object", + "description": "Paas summary properties class.", + "properties": { + "azure": { + "$ref": "#/definitions/AzurePaasSummary", + "description": "Shows the PaaS Azure summary.", + "readOnly": true + }, + "onPremises": { + "$ref": "#/definitions/OnPremisesPaasSummary", + "description": "Shows platform as a service (PaaS) summary.", + "readOnly": true + } + } + }, + "Percentile": { + "type": "string", + "description": "Percentile for Performance Data.", + "enum": [ + "Percentile50", + "Percentile90", + "Percentile95", + "Percentile99" + ], + "x-ms-enum": { + "name": "Percentile", + "modelAsString": true, + "values": [ + { + "name": "Percentile50", + "value": "Percentile50", + "description": "Percentile 50." + }, + { + "name": "Percentile90", + "value": "Percentile90", + "description": "Percentile 90." + }, + { + "name": "Percentile95", + "value": "Percentile95", + "description": "Percentile 95." + }, + { + "name": "Percentile99", + "value": "Percentile99", + "description": "Percentile 99." + } + ] + } + }, + "PerfDataSettings": { + "type": "object", + "description": "Data model of Performance Data Settings.", + "properties": { + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Gets perf data time range." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets perf data start time." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets perf data end time." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Gets percentile utilization for performance data." + } + }, + "required": [ + "timeRange", + "percentile" + ] + }, + "PricingTier": { + "type": "string", + "description": "Pricing Tier for Azure.", + "enum": [ + "Standard", + "Free" + ], + "x-ms-enum": { + "name": "PricingTier", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Standard Pricing Tier." + }, + { + "name": "Free", + "value": "Free", + "description": "Free Pricing Tier." + } + ] + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "Private endpoint connection resource.", + "properties": { + "properties": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "The response of a PrivateEndpointConnection list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnection items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateLinkResource": { + "type": "object", + "description": "Private link resource.", + "properties": { + "properties": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "The response of a PrivateLinkResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProcessorInfo": { + "type": "object", + "description": "Represents a information \\ details of a processor.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name \\ model of a processor." + }, + "numberOfSockets": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of sockets." + }, + "numberOfCoresPerSocket": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of cores in a socket." + } + } + }, + "ProductSupportStatus": { + "type": "object", + "description": "Class to represent the Product Support Status.", + "properties": { + "currentVersion": { + "type": "string", + "description": "Gets or sets current version of ServicePack.", + "readOnly": true + }, + "servicePackStatus": { + "type": "string", + "description": "Gets or sets ServicePack of the product.", + "readOnly": true + }, + "esuStatus": { + "type": "string", + "description": "Gets or sets the Extended Security Update ESU status.", + "readOnly": true + }, + "supportStatus": { + "type": "string", + "description": "Gets or sets the support status of the product.", + "readOnly": true + }, + "eta": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the ETA.", + "readOnly": true + }, + "currentEsuYear": { + "type": "string", + "description": "Gets or sets the current ESU support year.", + "readOnly": true + }, + "mainstreamEndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the main stream end date of the product.", + "readOnly": true + }, + "extendedSupportEndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended support end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear1EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 1 end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear2EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 2 end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear3EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 3 end date of the product.", + "readOnly": true + } + } + }, + "ProjectProperties": { + "type": "object", + "description": "Properties of a project.", + "properties": { + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this project was created. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this project was last updated. Date-Time represented in ISO-8601\nformat.", + "readOnly": true + }, + "serviceEndpoint": { + "type": "string", + "description": "Endpoint at which the collector agent can call agent REST API.", + "readOnly": true + }, + "assessmentSolutionId": { + "type": "string", + "description": "Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects." + }, + "projectStatus": { + "$ref": "#/definitions/ProjectStatus", + "description": "Assessment project status." + }, + "customerWorkspaceId": { + "type": "string", + "description": "The ARM id of service map workspace created by customer." + }, + "customerWorkspaceLocation": { + "type": "string", + "description": "Location of service map workspace created by customer." + }, + "publicNetworkAccess": { + "type": "string", + "description": "This value can be set to 'enabled' to avoid breaking changes on existing\ncustomer resources and templates. If set to 'disabled', traffic over public\ninterface is not allowed, and private endpoint connections would be the\nexclusive access method." + }, + "privateEndpointConnections": { + "type": "array", + "description": "The list of private endpoint connections to the project.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "The ARM id of the storage account used for interactions when public access is\ndisabled." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "ProjectStatus": { + "type": "string", + "description": "Project Status.", + "enum": [ + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "ProjectStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "Active Status." + }, + { + "name": "Inactive", + "value": "Inactive", + "description": "Inactive Status." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is being Provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is being Updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is being Deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource is being Accepted." + } + ] + } + }, + "ProvisioningState2": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState2", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is being Provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is being Updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is being Deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource is being Accepted." + } + ] + }, + "readOnly": true + }, + "ProvisioningStatus": { + "type": "string", + "description": "Provisioning Status.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "InProgress" + ], + "x-ms-enum": { + "name": "ProvisioningStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Provisioning is in Progress." + } + ] + }, + "readOnly": true + }, + "Readiness": { + "type": "string", + "description": "Readiness for Azure.", + "enum": [ + "Unknown", + "NotReady", + "ReadyWithConditions", + "Ready" + ], + "x-ms-enum": { + "name": "Readiness", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Readiness." + }, + { + "name": "NotReady", + "value": "NotReady", + "description": "Not Ready." + }, + { + "name": "ReadyWithConditions", + "value": "ReadyWithConditions", + "description": "Ready with conditions." + }, + { + "name": "Ready", + "value": "Ready", + "description": "Ready for migration." + } + ] + } + }, + "RecommendationResult": { + "type": "object", + "description": "Data model of Recommendation Result.", + "properties": { + "request": { + "$ref": "#/definitions/ComputeResource", + "description": "Gets cores and memory request.", + "readOnly": true + }, + "limit": { + "$ref": "#/definitions/ComputeResource", + "description": "Gets cores and memory limit.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "Gets os type.", + "readOnly": true + }, + "clusterName": { + "type": "string", + "description": "Gets cluster name.", + "readOnly": true + }, + "nodePoolId": { + "type": "string", + "description": "Gets node pool id.", + "readOnly": true + }, + "nodePoolName": { + "type": "string", + "description": "Gets node pool name.", + "readOnly": true + }, + "nodePoolArmSkuName": { + "type": "string", + "description": "Gets node pool arm sku name.", + "readOnly": true + }, + "approxMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets approximate monthly cost.", + "readOnly": true + } + }, + "required": [ + "request", + "limit", + "osType", + "clusterName", + "nodePoolId", + "nodePoolName", + "nodePoolArmSkuName", + "approxMonthlyCost" + ] + }, + "RecommendedAvsNodeTypeSummary": { + "type": "object", + "description": "Azure Avs Node summary.", + "properties": { + "avsNodeType": { + "type": "string", + "description": "AVS node type.", + "readOnly": true + }, + "numberOfNodes": { + "type": "integer", + "format": "int32", + "description": "Number of nodes.", + "readOnly": true + }, + "failuresToTolerateAndRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "Failures to tolerate and RAID level for the Node.", + "readOnly": true + } + } + }, + "RecommendedSuitability": { + "type": "string", + "enum": [ + "Unknown", + "SuitableForSqlDB", + "SuitableForSqlMI", + "SuitableForVM", + "PotentiallySuitableForVM", + "ReadinessUnknown", + "NotSuitable", + "SuitableForSqlVM", + "ConditionallySuitableForSqlDB", + "ConditionallySuitableForSqlMI", + "ConditionallySuitableForVM", + "ConditionallySuitableForSqlVM" + ], + "x-ms-enum": { + "name": "RecommendedSuitability", + "modelAsString": true + } + }, + "RecommendedVmFamilySummary": { + "type": "object", + "description": "The recommended VM family summary.", + "properties": { + "azureVmFamily": { + "type": "string", + "description": "The Azure VM family.", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "The number of machines.", + "readOnly": true + } + } + }, + "RecordOfInt": { + "type": "object", + "description": "Data Model for Dictionary.", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + }, + "RecordOfStringArray": { + "type": "object", + "description": "Data Model for Dictionary.", + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "ReportDetails": { + "type": "object", + "description": "Business case report details.", + "properties": { + "reportType": { + "$ref": "#/definitions/ReportType", + "description": "Report type.", + "readOnly": true + }, + "reportStatus": { + "$ref": "#/definitions/ReportStatus", + "description": "Report status.", + "readOnly": true + } + } + }, + "ReportDownloadUrl": { + "type": "object", + "description": "Download URL for assessment report.", + "properties": { + "businessCaseReportUrl": { + "type": "string", + "description": "Hyperlink to download report.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiry date of download url.", + "readOnly": true + } + } + }, + "ReportStatus": { + "type": "string", + "description": "Business case supported report status types.", + "enum": [ + "Unknown", + "None", + "InProgress", + "Failed", + "Completed" + ], + "x-ms-enum": { + "name": "ReportStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Report Status." + }, + { + "name": "None", + "value": "None", + "description": "None Report Status." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress Report Status." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed Report Status." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed Report Status." + } + ] + } + }, + "ReportType": { + "type": "string", + "description": "Business case supported report types.", + "enum": [ + "Unknown", + "Excel" + ], + "x-ms-enum": { + "name": "ReportType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Report Type." + }, + { + "name": "Excel", + "value": "Excel", + "description": "Excel Report Type." + } + ] + } + }, + "ResourceId": { + "type": "object", + "description": "ARM id for a resource.", + "properties": { + "id": { + "type": "string", + "description": "Gets the relative URL to get to this REST resource.", + "readOnly": true + } + } + }, + "SavingsOption": { + "type": "string", + "description": "Business case supported Savings Option types.", + "enum": [ + "Unknown", + "RI3Year", + "SavingsPlan3Year" + ], + "x-ms-enum": { + "name": "SavingsOption", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Savings Option." + }, + { + "name": "RI3Year", + "value": "RI3Year", + "description": "Reserved Instance 3 Year." + }, + { + "name": "SavingsPlan3Year", + "value": "SavingsPlan3Year", + "description": "Azure Savings Plan 3 Year." + } + ] + } + }, + "SavingsOptions": { + "type": "string", + "description": "Savings Options for Azure.", + "enum": [ + "None", + "OneYearSavings", + "ThreeYearsSavings", + "OneYearReserved", + "ThreeYearsReserved" + ], + "x-ms-enum": { + "name": "SavingsOptions", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Savings Options is not applicable." + }, + { + "name": "OneYearSavings", + "value": "OneYearSavings", + "description": "One Year Savings Plan." + }, + { + "name": "ThreeYearsSavings", + "value": "ThreeYearsSavings", + "description": "Three Years Savings Plan." + }, + { + "name": "OneYearReserved", + "value": "OneYearReserved", + "description": "One Year Reserved Instances." + }, + { + "name": "ThreeYearsReserved", + "value": "ThreeYearsReserved", + "description": "Three Years Reserved Instances." + } + ] + } + }, + "SecuritySettings": { + "type": "object", + "description": "Security settings.", + "properties": { + "serverSecurityCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Physical servers per administrator." + }, + "sqlServerSecurityCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Virtual machines per administrator." + } + }, + "required": [ + "serverSecurityCostPerServerPerYear", + "sqlServerSecurityCostPerServerPerYear" + ] + }, + "ServerCollector": { + "type": "object", + "description": "Physical server collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ServerCollectorListResult": { + "type": "object", + "description": "The response of a ServerCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerCollector items on this page", + "items": { + "$ref": "#/definitions/ServerCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServersDiscovered": { + "type": "object", + "description": "Shows the discovered servers by virtualization platform.", + "properties": { + "vmWare": { + "type": "integer", + "format": "int32", + "description": "Number of servers on VMWare.", + "readOnly": true + }, + "hyperV": { + "type": "integer", + "format": "int32", + "description": "Number of servers on HyperV.", + "readOnly": true + }, + "physical": { + "type": "integer", + "format": "int32", + "description": "Number of physical servers.", + "readOnly": true + }, + "notApplicable": { + "type": "integer", + "format": "int32", + "description": "Number of servers whose virtualization is unknown.", + "readOnly": true + } + } + }, + "ServicePackInsight": { + "type": "object", + "description": "Service Pack Insight.", + "properties": { + "unknownServicePack": { + "type": "integer", + "format": "int32", + "description": "Unknown support.", + "readOnly": true + }, + "patched": { + "type": "integer", + "format": "int32", + "description": "Patched Service Pack Insight.", + "readOnly": true + }, + "unpatched": { + "type": "integer", + "format": "int32", + "description": "Unpatched Service Pack Insight.", + "readOnly": true + } + } + }, + "Settings": { + "type": "object", + "description": "Business case settings.", + "properties": { + "azureSettings": { + "$ref": "#/definitions/AzureSettings", + "description": "Azure settings for a business case." + }, + "onPremiseSettings": { + "$ref": "#/definitions/OnPremiseSettings", + "description": "On-premise settings." + } + }, + "required": [ + "azureSettings" + ] + }, + "SharedResourcesDTO": { + "type": "object", + "description": "Shared Resources.", + "properties": { + "sharedDataDisks": { + "type": "array", + "description": "Gets the list of shared data disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedLogDisks": { + "type": "array", + "description": "Gets the list of shared log disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedTempDbDisks": { + "type": "array", + "description": "Gets the list of shared Temporary database disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfMounts": { + "type": "integer", + "format": "int32", + "description": "Gets number of mounts of shared disks.", + "readOnly": true + }, + "quorumWitness": { + "$ref": "#/definitions/AzureQuorumWitnessDTO", + "description": "Gets quorum witness.", + "readOnly": true + } + } + }, + "SkuReplicationMode": { + "type": "string", + "enum": [ + "NotApplicable", + "ActiveGeoReplication", + "FailoverGroupInstance" + ], + "x-ms-enum": { + "name": "SkuReplicationMode", + "modelAsString": true + } + }, + "SqlAssessedNetworkAdapter": { + "type": "object", + "description": "SQL Assessed Network Adapter.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "monthlyBandwidthCosts": { + "type": "number", + "format": "float", + "description": "Gets the monthly bandwidth costs." + }, + "netGigabytesTransmittedPerMonth": { + "type": "number", + "format": "float", + "description": "Gets the net gigabytes transmitted per month." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the display name." + }, + "macAddress": { + "type": "string", + "description": "Gets the mac address." + }, + "ipAddresses": { + "type": "array", + "description": "Gets the ip addresses.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second received." + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second transmitted." + } + } + }, + "SqlAssessmentMigrationIssue": { + "type": "object", + "description": "Class representing the SQL migration issues.", + "properties": { + "issueId": { + "type": "string", + "description": "Gets the issue id.", + "readOnly": true + }, + "issueCategory": { + "$ref": "#/definitions/SqlAssessmentMigrationIssueCategory", + "description": "Gets the issue category.", + "readOnly": true + }, + "impactedObjects": { + "type": "array", + "description": "Gets the list of impacted objects.", + "items": { + "$ref": "#/definitions/ImpactedAssessmentObject" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentMigrationIssueCategory": { + "type": "string", + "enum": [ + "Issue", + "Warning", + "Internal" + ], + "x-ms-enum": { + "name": "SqlAssessmentMigrationIssueCategory", + "modelAsString": true + } + }, + "SqlAssessmentOptions": { + "type": "object", + "description": "SQL Assessment options web model object.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a SqlAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentOptionsProperties": { + "type": "object", + "description": "SQL Assessment options properties Web model object.", + "properties": { + "vmFamilies": { + "type": "array", + "description": "Gets the list of VM families.", + "items": { + "$ref": "#/definitions/VmFamilyOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstanceVmFamilies": { + "type": "array", + "description": "Gets the Reserved Instance VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "premiumDiskVmFamilies": { + "type": "array", + "description": "Gets the Premium disk VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "savingsPlanVmFamilies": { + "type": "array", + "description": "Gets or sets the Premium disk VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocationsForPaas": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for PAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocationsForIaas": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of Azure Offers supporting Saving Plans.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "sqlSkus": { + "type": "array", + "description": "Gets or sets the list of SQL target SKU properties for dropdowns.", + "items": { + "$ref": "#/definitions/SqlPaaSTargetOptions" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSqlTargets": { + "type": "array", + "description": "Gets or sets the Reserved Instance SQL target types.", + "items": { + "$ref": "#/definitions/TargetType" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "supportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for SQL assessments.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAssessmentV2IaasSuitabilityData": { + "type": "object", + "description": "Class representing Azure SQL IAAS suitability details.", + "properties": { + "azureSqlSku": { + "$ref": "#/definitions/AzureSqlIaasSkuDTO", + "description": "Gets the azure SQL IAAS SKU.", + "readOnly": true + }, + "replicaAzureSqlSku": { + "type": "array", + "description": "Gets the replica azure SQL IAAS SKU.", + "items": { + "$ref": "#/definitions/AzureSqlIaasSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedResources": { + "$ref": "#/definitions/SharedResourcesDTO", + "description": "Gets the shared resources.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "shouldProvisionReplicas": { + "type": "boolean", + "description": "Gets a value indicating whether replicas should be provisioned.", + "readOnly": true + }, + "skuReplicationMode": { + "$ref": "#/definitions/SkuReplicationMode", + "description": "Gets the replication mode.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable to this target.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendationReasonings": { + "type": "array", + "description": "Gets the list of SQL recommendation Reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "migrationTargetPlatform": { + "$ref": "#/definitions/TargetType", + "description": "Gets the migration target platform.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the azure suitability.", + "readOnly": true + }, + "migrationIssues": { + "type": "array", + "description": "Gets the list of migrations issues.", + "items": { + "$ref": "#/definitions/SqlAssessmentMigrationIssue" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2ListResult": { + "type": "object", + "description": "The response of a SqlAssessmentV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentV2 items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentV2PaasSuitabilityData": { + "type": "object", + "description": "Class representing Azure SQL PAAS suitability details.", + "properties": { + "azureSqlSku": { + "$ref": "#/definitions/AzureSqlPaasSkuDTO", + "description": "Gets the azure SQL PAAS SKU.", + "readOnly": true + }, + "replicaAzureSqlSku": { + "type": "array", + "description": "Gets the replica azure SQL PAAS SKU.", + "items": { + "$ref": "#/definitions/AzureSqlPaasSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedResources": { + "$ref": "#/definitions/SharedResourcesDTO", + "description": "Gets the shared resources.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "shouldProvisionReplicas": { + "type": "boolean", + "description": "Gets a value indicating whether replicas should be provisioned.", + "readOnly": true + }, + "skuReplicationMode": { + "$ref": "#/definitions/SkuReplicationMode", + "description": "Gets the replication mode.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable to this target.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendationReasonings": { + "type": "array", + "description": "Gets the list of SQL recommendation Reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "migrationTargetPlatform": { + "$ref": "#/definitions/TargetType", + "description": "Gets the migration target platform.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the azure suitability.", + "readOnly": true + }, + "migrationIssues": { + "type": "array", + "description": "Gets the list of migrations issues.", + "items": { + "$ref": "#/definitions/SqlAssessmentMigrationIssue" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2Properties": { + "type": "object", + "description": "SQL assessment properties class.", + "properties": { + "osLicense": { + "$ref": "#/definitions/OsLicense", + "description": "Gets or sets user configurable setting to display the azure hybrid use benefit." + }, + "environmentType": { + "$ref": "#/definitions/EnvironmentType", + "description": "Gets or sets user configurable setting to display the environment type." + }, + "entityUptime": { + "$ref": "#/definitions/EntityUptime", + "description": "Gets or sets the duration for which the entity (SQL, VMs) are up in the\non-premises environment." + }, + "optimizationLogic": { + "$ref": "#/definitions/OptimizationLogic", + "description": "Gets or sets SQL optimization logic." + }, + "reservedInstanceForVm": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Gets or sets azure reserved instance for VM." + }, + "azureOfferCodeForVm": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Gets or sets Azure Offer Code for VM." + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets the Enterprise agreement subscription id." + }, + "azureSqlManagedInstanceSettings": { + "$ref": "#/definitions/SqlMiSettings", + "description": "Gets or sets user configurable SQL managed instance settings." + }, + "azureSqlDatabaseSettings": { + "$ref": "#/definitions/SqlDbSettings", + "description": "Gets or sets user configurable SQL database settings." + }, + "azureSqlVmSettings": { + "$ref": "#/definitions/SqlVmSettings", + "description": "Gets or sets user configurable SQL VM settings." + }, + "multiSubnetIntent": { + "$ref": "#/definitions/MultiSubnetIntent", + "description": "Gets or sets user preference indicating intent of multi-subnet configuration." + }, + "asyncCommitModeIntent": { + "$ref": "#/definitions/AsyncCommitModeIntent", + "description": "Gets or sets user preference indicating intent of async commit mode." + }, + "isInternetAccessAvailable": { + "type": "boolean", + "description": "Gets or sets a value indicating whether internet access is available." + }, + "disasterRecoveryLocation": { + "$ref": "#/definitions/AzureLocation", + "description": "Gets or sets the Azure Location or Azure region where to which the machines\nwill be migrated." + }, + "enableHadrAssessment": { + "type": "boolean", + "description": "Gets or sets a value indicating whether HADR assessments needs to be created." + }, + "azureSecurityOfferingType": { + "$ref": "#/definitions/AzureSecurityOfferingType", + "description": "Gets or sets a value indicating azure security offering type." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "sqlServerLicense": { + "$ref": "#/definitions/SqlServerLicense", + "description": "SQL server license." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment." + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment." + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage." + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "SqlAssessmentV2Summary": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentV2SummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAssessmentV2SummaryData": { + "type": "object", + "description": "SQL Assessment V2 summary data.", + "properties": { + "suitabilitySummary": { + "type": "object", + "description": "Sql assessment summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Monthly compute cost", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly storage cost", + "readOnly": true + }, + "monthlyLicenseCost": { + "type": "number", + "format": "float", + "description": "Monthly license cost", + "readOnly": true + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Confidence Rating", + "readOnly": true + }, + "monthlySecurityCost": { + "type": "number", + "format": "float", + "description": "Monthly security cost", + "readOnly": true + } + } + }, + "SqlAssessmentV2SummaryListResult": { + "type": "object", + "description": "The response of a SqlAssessmentV2Summary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentV2Summary items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentV2Summary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentV2SummaryProperties": { + "type": "object", + "description": "SQL Assessment V2 summary properties.", + "properties": { + "assessmentSummary": { + "type": "object", + "description": "Gets or sets the Assessment summary.", + "additionalProperties": { + "$ref": "#/definitions/SqlAssessmentV2SummaryData" + }, + "readOnly": true + }, + "distributionBySupportStatus": { + "type": "object", + "description": "Gets the distribution of sqlInstances by support status.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByServicePackInsight": { + "type": "object", + "description": "Gets the distribution distribution of sqlInstances by service pack insight.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionBySqlVersion": { + "type": "object", + "description": "Gets the distribution of sqlInstances by sql version.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionBySqlEdition": { + "type": "object", + "description": "Gets the distribution of sqlInstances by sql edition.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "instanceDistributionBySizingCriterion": { + "type": "object", + "description": "Gets the instance distribution by sizing criterion.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "databaseDistributionBySizingCriterion": { + "type": "object", + "description": "Gets the database distribution by sizing criterion.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of the assessment.", + "readOnly": true + }, + "numberOfSqlInstances": { + "type": "integer", + "format": "int32", + "description": "Number of sql instances part of the assessment.", + "readOnly": true + }, + "numberOfSuccessfullyDiscoveredSqlInstances": { + "type": "integer", + "format": "int32", + "description": "Number of successfully discovered sql instances part of the assessment.", + "readOnly": true + }, + "numberOfSqlDatabases": { + "type": "integer", + "format": "int32", + "description": "Number of sql databases part of the assessment.", + "readOnly": true + }, + "numberOfFciInstances": { + "type": "integer", + "format": "int32", + "description": "Number of sql failover cluster instances part of the assessment.", + "readOnly": true + }, + "numberOfSqlAvailabilityGroups": { + "type": "integer", + "format": "int32", + "description": "Number of sql availability groups part of the assessment.", + "readOnly": true + } + } + }, + "SqlAvailabilityGroupDataOverview": { + "type": "object", + "description": "Assessed Sql Availability Group Data Overview.", + "properties": { + "availabilityGroupId": { + "type": "string", + "description": "Gets the availability group id." + }, + "availabilityGroupName": { + "type": "string", + "description": "Gets the availability group name." + }, + "sqlAvailabilityGroupSdsArmId": { + "type": "string", + "description": "Gets the availability group arm id." + }, + "sqlAvailabilityGroupEntityId": { + "type": "string", + "description": "Gets the availability group entity id." + }, + "sqlAvailabilityReplicaId": { + "type": "string", + "description": "Gets the availability replica id." + } + } + }, + "SqlAvailabilityReplicaSummary": { + "type": "object", + "description": "Assessed Sql Availability Replica Summary.", + "properties": { + "numberOfSynchronousReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of synchronous read replicas." + }, + "numberOfSynchronousNonReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of synchronous non read replicas." + }, + "numberOfAsynchronousReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of asynchronous read replicas." + }, + "numberOfAsynchronousNonReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of asynchronous non read replicas." + }, + "numberOfPrimaryReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of primary replicas." + } + } + }, + "SqlCollector": { + "type": "object", + "description": "The SQL collector REST object.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlCollectorListResult": { + "type": "object", + "description": "The response of a SqlCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlCollector items on this page", + "items": { + "$ref": "#/definitions/SqlCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlDbSettings": { + "type": "object", + "description": "SQL database assessment settings.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the azure SQL service tier." + }, + "azureSqlDataBaseType": { + "$ref": "#/definitions/AzureSqlDataBaseType", + "description": "Gets or sets the azure PAAS SQL instance type." + }, + "azureSqlComputeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets or sets the azure SQL compute tier." + }, + "azureSqlPurchaseModel": { + "$ref": "#/definitions/AzureSqlPurchaseModel", + "description": "Gets or sets the azure SQL purchase model." + } + } + }, + "SqlFCIMetadata": { + "type": "object", + "description": "Sql fci meta data.", + "properties": { + "state": { + "$ref": "#/definitions/SqlFCIMetadataState", + "description": "Gets the Sql fci meta data state." + }, + "isMultiSubnet": { + "type": "boolean", + "description": "Gets whether fci is multi subnet." + }, + "fciSharedDiskCount": { + "type": "integer", + "format": "int32", + "description": "Gets the fci shared disk count." + } + } + }, + "SqlFCIMetadataState": { + "type": "string", + "enum": [ + "Unknown", + "Inherited", + "Initializing", + "Online", + "Offline", + "Failed", + "Pending", + "OnlinePending", + "OfflinePending" + ], + "x-ms-enum": { + "name": "SqlFCIMetadataState", + "modelAsString": true + } + }, + "SqlFCIState": { + "type": "string", + "enum": [ + "Unknown", + "Active", + "Passive", + "NotApplicable" + ], + "x-ms-enum": { + "name": "SqlFCIState", + "modelAsString": true + } + }, + "SqlMiSettings": { + "type": "object", + "description": "SQL managed instance assessment settings.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the azure SQL service tier." + }, + "azureSqlInstanceType": { + "$ref": "#/definitions/AzureSqlInstanceType", + "description": "Gets or sets the azure PAAS SQL instance type." + } + } + }, + "SqlMigrationGuideline": { + "type": "object", + "description": "Sql Migration Guideline.", + "properties": { + "guidelineId": { + "type": "string", + "description": "Gets the guideline id." + }, + "migrationGuidelineCategory": { + "$ref": "#/definitions/SqlMigrationGuidelineCategory", + "description": "Gets the migration guideline category." + }, + "migrationGuidelineContext": { + "type": "array", + "description": "Gets the migration guideline context.", + "items": { + "$ref": "#/definitions/MigrationGuidelineContext" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlMigrationGuidelineCategory": { + "type": "string", + "enum": [ + "Unknown", + "General", + "FailoverCluterInstanceGuideLine", + "AvailabilityGroupGuideline" + ], + "x-ms-enum": { + "name": "SqlMigrationGuidelineCategory", + "modelAsString": true + } + }, + "SqlPaaSTargetOptions": { + "type": "object", + "description": "SQL target options.", + "properties": { + "computeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets or sets the Azure SQL compute tier." + }, + "hardwareGeneration": { + "$ref": "#/definitions/HardwareGeneration", + "description": "Gets or sets the Azure SQL hardware generation." + }, + "targetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the Azure SQL target type." + }, + "serviceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the Azure SQL service tier." + }, + "targetLocations": { + "type": "array", + "description": "Gets or sets the target location.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + } + } + }, + "SqlRecommendationReasoning": { + "type": "object", + "description": "Class representing Azure SQL Recommendation Reasoning.", + "properties": { + "reasoningId": { + "type": "string", + "description": "Gets the reasoning id." + }, + "reasoningString": { + "type": "string", + "description": "Gets the reasoning status." + }, + "reasoningCategory": { + "type": "string", + "description": "Gets the reasoning category." + }, + "contextParameters": { + "type": "array", + "description": "Gets the Sql recommended reasoning parameters.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoningContext" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlRecommendationReasoningContext": { + "type": "object", + "description": "Class representing Azure SQL Recommendation Reasoning Context.", + "properties": { + "contextKey": { + "type": "string", + "description": "Gets the reasoning context key." + }, + "contextValue": { + "type": "string", + "description": "Gets the reasoning context value." + } + } + }, + "SqlServerLicense": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "SqlServerLicense", + "modelAsString": true + } + }, + "SqlServerLicenseType": { + "type": "string", + "description": "Business case supported SQL Server License types.", + "enum": [ + "Unknown", + "Enterprise", + "Standard" + ], + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Sql Server License." + }, + { + "name": "Enterprise", + "value": "Enterprise", + "description": "Enterprise Sql Server License." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard Sql Server License." + } + ] + } + }, + "SqlServerLicensingSettings": { + "type": "object", + "description": "SQL Server licensing settings.", + "properties": { + "version": { + "$ref": "#/definitions/SqlServerLicenseType", + "description": "SQL Server version." + }, + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence cost." + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software assurance (SA) cost." + } + }, + "required": [ + "version", + "licenseCost", + "softwareAssuranceCost" + ] + }, + "SqlServiceTier": { + "type": "object", + "description": "The SQL service tier.", + "properties": { + "serviceTierName": { + "type": "string", + "description": "The service tier name.", + "readOnly": true + }, + "serviceTierNumber": { + "type": "number", + "format": "float", + "description": "The number of sql entities with this tier.", + "readOnly": true + } + } + }, + "SqlVersionDetails": { + "type": "object", + "description": "The SQL version details.", + "properties": { + "sqlVersion": { + "type": "string", + "description": "The SQL version.", + "readOnly": true + }, + "numberOfInstances": { + "type": "integer", + "format": "int32", + "description": "Number of instances with the above SQL version.", + "readOnly": true + } + } + }, + "SqlVmSettings": { + "type": "object", + "description": "SQL VM assessment settings.", + "properties": { + "instanceSeries": { + "type": "array", + "description": "Gets or sets the Azure VM families (calling instance series to keep it\nconsistent with other targets).", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "x-ms-identifiers": [] + } + } + }, + "StorageSettings": { + "type": "object", + "description": "Storage settings.", + "properties": { + "costPerGbPerMonth": { + "type": "number", + "format": "float", + "description": "Cost per gigabyte per month." + }, + "maintainanceCostPercentageToAcquisitionCost": { + "type": "number", + "format": "float", + "description": "Maintenance cost percentage.", + "minimum": 0, + "maximum": 100 + } + }, + "required": [ + "costPerGbPerMonth", + "maintainanceCostPercentageToAcquisitionCost" + ] + }, + "SuggestedMigrationTool": { + "type": "string", + "description": "Suggested Migration Tool for Azure.", + "enum": [ + "None", + "WebAppMigration", + "ServerMigration" + ], + "x-ms-enum": { + "name": "SuggestedMigrationTool", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No Migration Tool is suggested." + }, + { + "name": "WebAppMigration", + "value": "WebAppMigration", + "description": "Web App Migration." + }, + { + "name": "ServerMigration", + "value": "ServerMigration", + "description": "Server Migration." + } + ] + } + }, + "Suitability": { + "type": "string", + "description": "Suitability for Azure.", + "enum": [ + "NotSuitable", + "Suitable" + ], + "x-ms-enum": { + "name": "Suitability", + "modelAsString": true, + "values": [ + { + "name": "NotSuitable", + "value": "NotSuitable", + "description": "Not Suitable for Azure." + }, + { + "name": "Suitable", + "value": "Suitable", + "description": "Suitable for Azure." + } + ] + } + }, + "SuitabilityResult": { + "type": "object", + "description": "Data model of Suitability Result.", + "properties": { + "readiness": { + "$ref": "#/definitions/Readiness", + "description": "Gets readiness.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/Suitability", + "description": "Gets suitability.", + "readOnly": true + }, + "failedChecks": { + "type": "array", + "description": "Gets list of failed Checks.", + "items": { + "$ref": "#/definitions/Check" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "suggestedMigrationTool": { + "$ref": "#/definitions/SuggestedMigrationTool", + "description": "Gets suggested migration tool.", + "readOnly": true + } + }, + "required": [ + "readiness", + "suitability", + "failedChecks", + "suggestedMigrationTool" + ] + }, + "SummaryDetails": { + "type": "object", + "description": "Data model of Summary Details.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Gets count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + } + }, + "required": [ + "count", + "monthlyCost" + ] + }, + "SummaryPropertiesBase": { + "type": "object", + "description": "Base ARM model of Assessment Summary ARM properties.", + "properties": { + "assessmentName": { + "type": "string", + "description": "Gets the assessment name.", + "readOnly": true + }, + "summaryName": { + "type": "string", + "description": "Gets the summary name.", + "readOnly": true + }, + "suitabilityPerTarget": { + "type": "object", + "description": "Gets the cloud suitability summary for all entities in the assessment per target.", + "additionalProperties": { + "$ref": "#/definitions/RecordOfInt" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Gets the confidence score.", + "readOnly": true + } + }, + "required": [ + "assessmentName", + "summaryName", + "suitabilityPerTarget", + "monthlyComputeCost", + "monthlyStorageCost", + "confidenceScore" + ] + }, + "SupportStatusDistribution": { + "type": "object", + "description": "Support Status Distribution.", + "properties": { + "unknownSupport": { + "type": "integer", + "format": "int32", + "description": "Unknown support.", + "readOnly": true + }, + "mainStream": { + "type": "integer", + "format": "int32", + "description": "Mainstream support.", + "readOnly": true + }, + "extended": { + "type": "integer", + "format": "int32", + "description": "Extended support.", + "readOnly": true + }, + "outOfSupport": { + "type": "integer", + "format": "int32", + "description": "Out of support.", + "readOnly": true + } + } + }, + "SupportabilityStatus": { + "type": "string", + "description": "Supportability Status.", + "enum": [ + "Unknown", + "Mainstream", + "Extended", + "OutOfSupport" + ], + "x-ms-enum": { + "name": "SupportabilityStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Supportability Status." + }, + { + "name": "Mainstream", + "value": "Mainstream", + "description": "Mainstream Supportability Status." + }, + { + "name": "Extended", + "value": "Extended", + "description": "Extended Supportability Status." + }, + { + "name": "OutOfSupport", + "value": "OutOfSupport", + "description": "OutOfSupport Supportability Status." + } + ] + } + }, + "TargetSpecificResult": { + "type": "object", + "description": "Target specific result.", + "properties": { + "assessmentResult": { + "$ref": "#/definitions/AssessmentResult", + "description": "Gets or sets the assessment result." + }, + "migrationIssues": { + "type": "array", + "description": "Gets or sets the web app migration issues.", + "items": { + "$ref": "#/definitions/WebAppMigrationIssues" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "assessmentResult", + "migrationIssues" + ] + }, + "TargetSpecificSummary": { + "type": "object", + "description": "Web app target specific summary data.", + "properties": { + "readinessSummary": { + "type": "object", + "description": "Web app readiness summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "recommendationResultSkuDetails": { + "type": "object", + "description": "Web app recommendation sku details data", + "additionalProperties": { + "$ref": "#/definitions/WebAppSkuDetails" + }, + "readOnly": true + } + } + }, + "TargetType": { + "type": "string", + "enum": [ + "Unknown", + "Recommended", + "AzureSqlDatabase", + "AzureSqlManagedInstance", + "AzureSqlVirtualMachine", + "AzureVirtualMachine" + ], + "x-ms-enum": { + "name": "TargetType", + "modelAsString": true + } + }, + "ThirdPartyManagementSettings": { + "type": "object", + "description": "Third Party Management settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "License Cost." + }, + "supportCost": { + "type": "number", + "format": "float", + "description": "Support Cost." + } + }, + "required": [ + "licenseCost", + "supportCost" + ] + }, + "TimeRange": { + "type": "string", + "description": "Time Range for Performance Data.", + "enum": [ + "Day", + "Week", + "Month", + "Custom" + ], + "x-ms-enum": { + "name": "TimeRange", + "modelAsString": true, + "values": [ + { + "name": "Day", + "value": "Day", + "description": "Daily." + }, + { + "name": "Week", + "value": "Week", + "description": "Weekly." + }, + { + "name": "Month", + "value": "Month", + "description": "Monthly." + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom Time Range." + } + ] + } + }, + "UltraDiskAssessmentOptions": { + "type": "object", + "description": "Assessment options for Ultra disk type.", + "properties": { + "familyName": { + "type": "string", + "description": "Family name." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where ultra disk is supported for this VMfamily.", + "items": { + "type": "string" + } + } + } + }, + "UpdateGroupBody": { + "type": "object", + "description": "Properties of group update.", + "properties": { + "eTag": { + "type": "string", + "description": "For optimistic concurrency control." + }, + "properties": { + "$ref": "#/definitions/GroupBodyProperties", + "description": "Properties of the group." + } + } + }, + "UtilizationData": { + "type": "object", + "description": "The SQL on premises utilization insights.", + "properties": { + "numberOfActiveEntities": { + "type": "integer", + "format": "int32", + "description": "The number of active entities.", + "readOnly": true + }, + "numberOfInactiveEntities": { + "type": "integer", + "format": "int32", + "description": "The number of inactive entities.", + "readOnly": true + }, + "numberOfDecommisionEntities": { + "type": "integer", + "format": "int32", + "description": "The number of decommission entities.", + "readOnly": true + }, + "numberOfUnknownEntities": { + "type": "integer", + "format": "int32", + "description": "The number of unknown entities.", + "readOnly": true + } + } + }, + "VirtualizationSoftwareSettings": { + "type": "object", + "description": "Virtualization software settings.", + "properties": { + "numberOfPhysicalCoresPerLicense": { + "type": "integer", + "format": "int32", + "description": "Number of physical cores per licence.", + "minimum": 1 + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software Assurance cost." + }, + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/VsphereLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "numberOfPhysicalCoresPerLicense", + "softwareAssuranceCost", + "licenseAndSupportList" + ] + }, + "VmFamilyOptions": { + "type": "object", + "description": "VM family name, the list of targeted azure locations and the category of the\nfamily.", + "properties": { + "familyName": { + "type": "string", + "description": "Name of the VM family.", + "readOnly": true + }, + "targetLocations": { + "type": "array", + "description": "List of Azure regions.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "category": { + "type": "array", + "description": "Category of the VM family.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "VmUptime": { + "type": "object", + "description": "Details on the total up-time for the VM.", + "properties": { + "daysPerMonth": { + "type": "integer", + "format": "int32", + "description": "Number of days in a month for VM uptime." + }, + "hoursPerDay": { + "type": "integer", + "format": "int32", + "description": "Number of hours per day for VM uptime." + } + } + }, + "VmwareCollector": { + "type": "object", + "description": "VMware collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VmwareCollectorListResult": { + "type": "object", + "description": "The response of a VmwareCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareCollector items on this page", + "items": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VsphereLicense": { + "type": "object", + "description": "Representation of a vsphere licence.", + "properties": { + "licenseType": { + "$ref": "#/definitions/LicenseType", + "description": "VSphere licence type." + } + }, + "required": [ + "licenseType" + ], + "allOf": [ + { + "$ref": "#/definitions/VsphereLicenseBase" + } + ] + }, + "VsphereLicenseBase": { + "type": "object", + "description": "Representation of a vsphere licence base.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Cost of a licence." + }, + "basicSupportCost": { + "type": "number", + "format": "float", + "description": "Basic support cost." + }, + "productionSupportCost": { + "type": "number", + "format": "float", + "description": "Production support cost." + } + }, + "required": [ + "licenseCost", + "basicSupportCost", + "productionSupportCost" + ] + }, + "VsphereManagementLicense": { + "type": "object", + "description": "Representation of a vsphere management licence.", + "properties": { + "licenseType": { + "$ref": "#/definitions/VsphereManagementLicenseType", + "description": "VSphere licence type." + } + }, + "required": [ + "licenseType" + ], + "allOf": [ + { + "$ref": "#/definitions/VsphereLicenseBase" + } + ] + }, + "VsphereManagementLicenseType": { + "type": "string", + "description": "Business case supported Vsphere Management License types.", + "enum": [ + "Unknown", + "VSphereServerStandard" + ], + "x-ms-enum": { + "name": "VsphereManagementLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown License." + }, + { + "name": "VSphereServerStandard", + "value": "VSphereServerStandard", + "description": "VSphereServerStandard License." + } + ] + } + }, + "VsphereManagementSettings": { + "type": "object", + "description": "Vsphere management settings.", + "properties": { + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/VsphereManagementLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "licenseAndSupportList" + ] + }, + "WebApp": { + "type": "object", + "description": "Data model of Web App.", + "properties": { + "discoveryArmId": { + "type": "string", + "description": "Gets discovery arm id.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets display name.", + "readOnly": true + }, + "webServerArmId": { + "type": "string", + "description": "Gets web server arm id.", + "readOnly": true + }, + "webServerDisplayName": { + "type": "string", + "description": "Gets web server display name.", + "readOnly": true + }, + "machineArmId": { + "type": "string", + "description": "Gets machine arm id.", + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Gets machine display name.", + "readOnly": true + }, + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets web app type.", + "readOnly": true + } + }, + "required": [ + "discoveryArmId", + "displayName", + "webServerArmId", + "webServerDisplayName", + "machineArmId", + "machineDisplayName", + "webAppType" + ] + }, + "WebAppAssessmentOptions": { + "type": "object", + "description": "Web app Assessment options web model object.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentOptionsProperties": { + "type": "object", + "description": "Web app Assessment options properties Web model object.", + "properties": { + "webAppSkus": { + "type": "array", + "description": "Gets the list of web app target options.", + "items": { + "$ref": "#/definitions/WebAppTargetOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedWebAppTiers": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureWebAppTier" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedWebAppTiers": { + "type": "array", + "description": "Gets or sets the list of Azure Offers supporting Saving Plans.", + "items": { + "$ref": "#/definitions/AzureWebAppTier" + }, + "x-ms-identifiers": [] + } + } + }, + "WebAppAssessmentV2": { + "type": "object", + "description": "Web app Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppAssessmentV2ListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentV2 items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentV2Properties": { + "type": "object", + "description": "Web app assessment properties class.", + "properties": { + "environmentType": { + "$ref": "#/definitions/EnvironmentType", + "description": "Gets or sets user configurable setting to display the environment type." + }, + "entityUptime": { + "$ref": "#/definitions/EntityUptime", + "description": "Gets or sets the duration for which the entity (Web app, VMs) are up in the\non-premises environment." + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets the Enterprise agreement subscription id." + }, + "appSvcNativeSettings": { + "$ref": "#/definitions/AppSvcNativeSettings", + "description": "Gets or sets user configurable app service native settings." + }, + "appSvcContainerSettings": { + "$ref": "#/definitions/AppSvcContainerSettings", + "description": "Gets or sets user configurable app service container database settings." + }, + "discoveredEntityLightSummary": { + "$ref": "#/definitions/DiscoveredEntityLightSummary", + "description": "Gets or sets user configurable discovered entity settings." + }, + "azureSecurityOfferingType": { + "$ref": "#/definitions/AzureSecurityOfferingType", + "description": "Gets or sets a value indicating azure security offering type." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment." + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment." + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage." + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "WebAppAssessmentV2Summary": { + "type": "object", + "description": "Web app Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentV2SummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppAssessmentV2SummaryListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentV2Summary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentV2Summary items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentV2Summary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentV2SummaryProperties": { + "type": "object", + "description": "Web app Assessment V2 summary properties.", + "properties": { + "assessmentSummary": { + "type": "object", + "description": "Gets or sets the discovered entities summary.", + "additionalProperties": { + "$ref": "#/definitions/DiscoveredEntitiesSummary" + }, + "readOnly": true + }, + "targetSpecificSummary": { + "type": "object", + "description": "Gets the target specific summary.", + "additionalProperties": { + "$ref": "#/definitions/TargetSpecificSummary" + }, + "readOnly": true + } + } + }, + "WebAppCollector": { + "type": "object", + "description": "The web app collector REST object.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppCollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppCollectorListResult": { + "type": "object", + "description": "The response of a WebAppCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppCollector items on this page", + "items": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppCollectorPropertiesBaseWithAgent": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "agentProperties": { + "$ref": "#/definitions/CollectorAgentPropertiesBase", + "description": "Gets or sets the collector agent properties." + }, + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "WebAppDistribution": { + "type": "object", + "description": "The app type distribution.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppTypes", + "description": "WebApp type.", + "readOnly": true + }, + "numberOfWebApps": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + } + } + }, + "WebAppMigrationIssues": { + "type": "object", + "description": "Web app migration issues.", + "properties": { + "issueId": { + "type": "string", + "description": "Gets or sets the issue Id." + }, + "issueCategory": { + "$ref": "#/definitions/AzureWebAppSuitabilityIssueCategory", + "description": "Gets or sets the issue category." + }, + "issueDescriptionList": { + "type": "array", + "description": "Gets or sets the issue description list.", + "items": { + "type": "string" + } + } + }, + "required": [ + "issueId", + "issueCategory", + "issueDescriptionList" + ] + }, + "WebAppServicePlanV2": { + "type": "object", + "description": "Assessed Web app web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppServicePlanV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppServicePlanV2ListResult": { + "type": "object", + "description": "The response of a WebAppServicePlanV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppServicePlanV2 items on this page", + "items": { + "$ref": "#/definitions/WebAppServicePlanV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppServicePlanV2Properties": { + "type": "object", + "description": "Assessed Web app database properties web model.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets or sets the web app type.", + "readOnly": true + }, + "webAppTargetType": { + "$ref": "#/definitions/AzureWebAppTargetType", + "description": "Gets or sets the target specific result.", + "readOnly": true + }, + "webAppServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name.", + "readOnly": true + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Gets the machine name.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the server ARM Id.", + "readOnly": true + }, + "storage": { + "type": "number", + "format": "double", + "description": "Gets or sets the web server name.", + "readOnly": true + }, + "scaleOutInstances": { + "type": "integer", + "format": "int32", + "description": "Gets or sets web app name.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the discovered web app ID.", + "readOnly": true + }, + "ram": { + "type": "number", + "format": "double", + "description": "Machine arm id.", + "readOnly": true + }, + "webAppSkuName": { + "type": "string", + "description": "Web app sku name.", + "readOnly": true + }, + "webAppSkuSize": { + "type": "string", + "description": "Web app sku size.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed Web app database last updated.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "required": [ + "webAppServicePlanName", + "numberOfWebApps" + ] + }, + "WebAppSkuDetails": { + "type": "object", + "description": "Web app sku details.", + "properties": { + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Total monthly cost", + "readOnly": true + }, + "monthlySecurityCost": { + "type": "number", + "format": "float", + "description": "Monthly security data", + "readOnly": true + }, + "skuName": { + "type": "string", + "description": "Sku name", + "readOnly": true + }, + "skuSize": { + "type": "string", + "description": "Sku size", + "readOnly": true + }, + "appServicePlanCount": { + "type": "integer", + "format": "int32", + "description": "App service plan count", + "readOnly": true + } + }, + "required": [ + "skuName", + "skuSize", + "appServicePlanCount" + ] + }, + "WebAppTargetOptions": { + "type": "object", + "description": "Web app target options.", + "properties": { + "webAppTier": { + "$ref": "#/definitions/AzureWebAppTier", + "description": "Gets or sets the Azure web app tier." + }, + "targetLocations": { + "type": "array", + "description": "Gets or sets the target location.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + } + } + }, + "WebAppTargetSku": { + "type": "object", + "description": "The Webapp target SKU with corresponding cost.", + "properties": { + "skuName": { + "type": "string", + "description": "The SKU name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of service plans or node pools recommended.", + "readOnly": true + } + } + }, + "WebAppType": { + "type": "string", + "description": "Web App Type.", + "enum": [ + "Unknown", + "IIS", + "Tomcat" + ], + "x-ms-enum": { + "name": "WebAppType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates Missing Data." + }, + { + "name": "IIS", + "value": "IIS", + "description": "ASP.NET Web App." + }, + { + "name": "Tomcat", + "value": "Tomcat", + "description": "Java Web App." + } + ] + } + }, + "WebAppTypes": { + "type": "string", + "description": "Business case supported WebApp types.", + "enum": [ + "Unknown", + "ASPNET", + "Tomcat" + ], + "x-ms-enum": { + "name": "WebAppTypes", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown WebApp Type." + }, + { + "name": "ASPNET", + "value": "ASPNET", + "description": "ASPNET Type." + }, + { + "name": "Tomcat", + "value": "Tomcat", + "description": "Tomcat Type." + } + ] + } + }, + "WindowsServerLicensingSettings": { + "type": "object", + "description": "Windows Server licensing settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence Cost." + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software assurance (SA) cost." + }, + "licensesPerCore": { + "type": "integer", + "format": "int32", + "description": "Licenses per core." + } + }, + "required": [ + "licenseCost", + "softwareAssuranceCost", + "licensesPerCore" + ] + }, + "WorkloadSummary": { + "type": "object", + "description": "Workload summary.", + "properties": { + "oracleInstances": { + "type": "integer", + "format": "int32", + "description": "Gets or sets oracle databases." + }, + "springApps": { + "type": "integer", + "format": "int32", + "description": "Gets or sets oracle databases." + } + } + }, + "YearOnYearEstimates": { + "type": "object", + "description": "Shows the year-on-year cost overall.", + "properties": { + "onPremisesCost": { + "type": "object", + "description": "Year-on-Year on-premises cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureCost": { + "type": "object", + "description": "Year-on-Year Azure cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "savings": { + "type": "object", + "description": "Year-on-Year savings.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "onPremisesCapexCost": { + "type": "object", + "description": "Year-on-Year on-premises capex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "onPremisesOpexCost": { + "type": "object", + "description": "Year-on-Year on-premises opex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureCapexCost": { + "type": "object", + "description": "Year-on-Year azure capex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureOpexCost": { + "type": "object", + "description": "Year-on-Year azure opex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "paybackPeriod": { + "type": "integer", + "format": "int32", + "description": "Payback period.", + "readOnly": true + } + } + } + }, + "parameters": {} +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_ClientGroupMembers_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_ClientGroupMembers_MaximumSet_Gen.json new file mode 100644 index 000000000000..eb01c0cb88f2 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_ClientGroupMembers_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "DependencyMapController_ClientGroupMembers", + "operationId": "DependencyMapController_ClientGroupMembers", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "1332kQXJXIUI1E", + "mapRequest": { + "machineId": "zbsqaglovhnxlroparbdzfs", + "processGroupName": "lawalpbrzupvjeglgvluyjtvijnqcj", + "processName": "ygqxfpuvfsiiotyxveq", + "startTime": "2024-01-18T11:33:08.082Z", + "endTime": "2024-01-18T11:33:08.082Z", + "filters": { + "machineIds": [ + "nokzgytxl" + ], + "processIds": [ + "pxbqhupqqlwgta" + ] + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_ExportDependencies_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_ExportDependencies_MaximumSet_Gen.json new file mode 100644 index 000000000000..a20abe31cf8e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_ExportDependencies_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "DependencyMapController_ExportDependencies", + "operationId": "DependencyMapController_ExportDependencies", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "5Ue8NYF35i9k", + "requestBody": { + "startTime": "2024-01-18T11:33:13.789Z", + "endTime": "2024-01-18T11:33:13.789Z" + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json new file mode 100644 index 000000000000..ee1d46635ed9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "DependencyMapController_GenerateCoarseMap", + "operationId": "DependencyMapController_GenerateCoarseMap", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "R875", + "mapRequest": { + "startTime": "2024-01-18T11:33:15.220Z", + "endTime": "2024-01-18T11:33:15.220Z", + "filters": { + "machineIds": [ + "nokzgytxl" + ], + "processIds": [ + "pxbqhupqqlwgta" + ] + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json new file mode 100644 index 000000000000..bd0db5020235 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "DependencyMapController_GenerateDetailedMap", + "operationId": "DependencyMapController_GenerateDetailedMap", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "Q-Q-Cu-C-YO-9U6V", + "mapRequest": { + "machineId": "mqiazddot", + "startTime": "2024-01-18T11:33:15.874Z", + "endTime": "2024-01-18T11:33:15.874Z", + "filters": { + "machineIds": [ + "nokzgytxl" + ], + "processIds": [ + "pxbqhupqqlwgta" + ] + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_ServerGroupMembers_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_ServerGroupMembers_MaximumSet_Gen.json new file mode 100644 index 000000000000..72aed4b37aba --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/DependencyMapController_ServerGroupMembers_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "DependencyMapController_ServerGroupMembers", + "operationId": "DependencyMapController_ServerGroupMembers", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "2128Na75J6T7D-RY5-", + "mapRequest": { + "serverPort": 27, + "startTime": "2024-01-18T11:33:31.988Z", + "endTime": "2024-01-18T11:33:31.988Z", + "filters": { + "machineIds": [ + "nokzgytxl" + ], + "processIds": [ + "pxbqhupqqlwgta" + ] + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_CreateCluster_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_CreateCluster_MaximumSet_Gen.json new file mode 100644 index 000000000000..332832f035e9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_CreateCluster_MaximumSet_Gen.json @@ -0,0 +1,118 @@ +{ + "title": "HypervClusterController_CreateCluster", + "operationId": "HypervClusterController_CreateCluster", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "7-ZE7-O1HU2-s-EyMu6", + "clusterName": "67b-v01-nC3--6tCUl", + "body": { + "properties": { + "fqdn": "rpfphmlbzericn", + "runAsAccountId": "qgqrfeczloubuaitiudd", + "hostFqdnList": [ + "ozzrrnscesqywisszgtrnqkxp" + ], + "provisioningState": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "euwmhfgguobntgszhwkyg", + "updatedTimestamp": "etvpbbgtcfazrnwmjditq", + "fqdn": "rpfphmlbzericn", + "functionalLevel": 19, + "status": "dlvrqtdobxkspijdnae", + "runAsAccountId": "qgqrfeczloubuaitiudd", + "hostFqdnList": [ + "ozzrrnscesqywisszgtrnqkxp" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "provisioningState": "Created" + }, + "id": "xfwxptsmxugnuhpzffyese", + "name": "oqgtgmbujxagubndmm", + "type": "fwwwwcowjefgmqqqkpnrykucgvbtk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "createdTimestamp": "euwmhfgguobntgszhwkyg", + "updatedTimestamp": "etvpbbgtcfazrnwmjditq", + "fqdn": "rpfphmlbzericn", + "functionalLevel": 19, + "status": "dlvrqtdobxkspijdnae", + "runAsAccountId": "qgqrfeczloubuaitiudd", + "hostFqdnList": [ + "ozzrrnscesqywisszgtrnqkxp" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "provisioningState": "Created" + }, + "id": "xfwxptsmxugnuhpzffyese", + "name": "oqgtgmbujxagubndmm", + "type": "fwwwwcowjefgmqqqkpnrykucgvbtk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..f488decc3abf --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "HypervClusterController_Delete", + "operationId": "HypervClusterController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "THF16H-1PV3v6C4Jc4W", + "clusterName": "-8KDr--3f3-83o7G914d66E" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_GetCluster_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_GetCluster_MaximumSet_Gen.json new file mode 100644 index 000000000000..1b751d0c4fd4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_GetCluster_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "HypervClusterController_GetCluster", + "operationId": "HypervClusterController_GetCluster", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "l4-RY9H60-H3d6Rp-2-k3", + "clusterName": "u0-28M--" + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "euwmhfgguobntgszhwkyg", + "updatedTimestamp": "etvpbbgtcfazrnwmjditq", + "fqdn": "rpfphmlbzericn", + "functionalLevel": 19, + "status": "dlvrqtdobxkspijdnae", + "runAsAccountId": "qgqrfeczloubuaitiudd", + "hostFqdnList": [ + "ozzrrnscesqywisszgtrnqkxp" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "provisioningState": "Created" + }, + "id": "xfwxptsmxugnuhpzffyese", + "name": "oqgtgmbujxagubndmm", + "type": "fwwwwcowjefgmqqqkpnrykucgvbtk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_ListByHypervSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_ListByHypervSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..d82846da34b5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervClusterController_ListByHypervSite_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "title": "HypervClusterController_ListByHypervSite", + "operationId": "HypervClusterController_ListByHypervSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "filter": "nbnfzbdlcmhawvak", + "siteName": "d-h4D-H-yG82" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "euwmhfgguobntgszhwkyg", + "updatedTimestamp": "etvpbbgtcfazrnwmjditq", + "fqdn": "rpfphmlbzericn", + "functionalLevel": 19, + "status": "dlvrqtdobxkspijdnae", + "runAsAccountId": "qgqrfeczloubuaitiudd", + "hostFqdnList": [ + "ozzrrnscesqywisszgtrnqkxp" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "provisioningState": "Created" + }, + "id": "xfwxptsmxugnuhpzffyese", + "name": "oqgtgmbujxagubndmm", + "type": "fwwwwcowjefgmqqqkpnrykucgvbtk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_ClientGroupMembers_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_ClientGroupMembers_MaximumSet_Gen.json new file mode 100644 index 000000000000..e7cd38dc901d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_ClientGroupMembers_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "HypervDependencyMapController_ClientGroupMembers", + "operationId": "HypervDependencyMapController_ClientGroupMembers", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "K3NSZP6wU26Dj8-55", + "mapRequest": { + "machineId": "zbsqaglovhnxlroparbdzfs", + "processGroupName": "lawalpbrzupvjeglgvluyjtvijnqcj", + "processName": "ygqxfpuvfsiiotyxveq", + "startTime": "2024-01-18T11:33:08.082Z", + "endTime": "2024-01-18T11:33:08.082Z", + "filters": { + "machineIds": [ + "nokzgytxl" + ], + "processIds": [ + "pxbqhupqqlwgta" + ] + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_ExportDependencies_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_ExportDependencies_MaximumSet_Gen.json new file mode 100644 index 000000000000..d6a2a939f913 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_ExportDependencies_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "HypervDependencyMapController_ExportDependencies", + "operationId": "HypervDependencyMapController_ExportDependencies", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "G--42YNE78-MW", + "requestBody": { + "startTime": "2024-01-18T11:33:13.789Z", + "endTime": "2024-01-18T11:33:13.789Z" + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json new file mode 100644 index 000000000000..dc553222fe70 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "HypervDependencyMapController_GenerateCoarseMap", + "operationId": "HypervDependencyMapController_GenerateCoarseMap", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-66145C-Ov8i-l", + "mapRequest": { + "startTime": "2024-01-18T11:33:15.220Z", + "endTime": "2024-01-18T11:33:15.220Z", + "filters": { + "machineIds": [ + "nokzgytxl" + ], + "processIds": [ + "pxbqhupqqlwgta" + ] + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json new file mode 100644 index 000000000000..cacd965d5198 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "HypervDependencyMapController_GenerateDetailedMap", + "operationId": "HypervDependencyMapController_GenerateDetailedMap", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "84g-119S-X8dCJm6", + "mapRequest": { + "machineId": "mqiazddot", + "startTime": "2024-01-18T11:33:15.874Z", + "endTime": "2024-01-18T11:33:15.874Z", + "filters": { + "machineIds": [ + "nokzgytxl" + ], + "processIds": [ + "pxbqhupqqlwgta" + ] + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_ServerGroupMembers_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_ServerGroupMembers_MaximumSet_Gen.json new file mode 100644 index 000000000000..3af09ac5d88a --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_ServerGroupMembers_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "HypervDependencyMapController_ServerGroupMembers", + "operationId": "HypervDependencyMapController_ServerGroupMembers", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "--6U-bZ67-5XIt91T", + "mapRequest": { + "serverPort": 27, + "startTime": "2024-01-18T11:33:31.988Z", + "endTime": "2024-01-18T11:33:31.988Z", + "filters": { + "machineIds": [ + "nokzgytxl" + ], + "processIds": [ + "pxbqhupqqlwgta" + ] + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_UpdateDependencyMapStatus_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_UpdateDependencyMapStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..7da81756a006 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervDependencyMapController_UpdateDependencyMapStatus_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "HypervDependencyMapController_UpdateDependencyMapStatus", + "operationId": "HypervDependencyMapController_UpdateDependencyMapStatus", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "BXINc225D6-1Hyr7", + "mapRequest": { + "machines": [ + { + "machineId": "ysqizqtyaskpprxkqaeyyopln", + "isDependencyMapToBeEnabled": true + } + ] + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..0260f69f047c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_Create_MaximumSet_Gen.json @@ -0,0 +1,107 @@ +{ + "title": "HypervHostController_Create", + "operationId": "HypervHostController_Create", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "f3m9-Tf--3-n7-40USK7XX", + "hostName": "1FXhE45296-eJUF1Y-", + "body": { + "properties": { + "fqdn": "lk", + "runAsAccountId": "epkvjlsbaigwfxwgzo", + "provisioningState": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "iseqyuyqrsqohotfjzsifeyxyox", + "updatedTimestamp": "dkuccuwbhjgvlulebwc", + "fqdn": "lk", + "runAsAccountId": "epkvjlsbaigwfxwgzo", + "version": "jqbcrsyaghjdudlpqkcpfqcnjmg", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "provisioningState": "Created" + }, + "id": "kwmuilxzrg", + "name": "otjimvbvxztyisadood", + "type": "daeznbszjdopcdttxso", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "createdTimestamp": "iseqyuyqrsqohotfjzsifeyxyox", + "updatedTimestamp": "dkuccuwbhjgvlulebwc", + "fqdn": "lk", + "runAsAccountId": "epkvjlsbaigwfxwgzo", + "version": "jqbcrsyaghjdudlpqkcpfqcnjmg", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "provisioningState": "Created" + }, + "id": "kwmuilxzrg", + "name": "otjimvbvxztyisadood", + "type": "daeznbszjdopcdttxso", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a412ca3af25d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "HypervHostController_Delete", + "operationId": "HypervHostController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "EL2-eW4-c784t2-", + "hostName": "HURB-TsA" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a3a43f2596cb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_Get_MaximumSet_Gen.json @@ -0,0 +1,55 @@ +{ + "title": "HypervHostController_Get", + "operationId": "HypervHostController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-3zTU--SvlGY-FoUh", + "hostName": "25JSQ7RhWxXUIW-ELi" + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "iseqyuyqrsqohotfjzsifeyxyox", + "updatedTimestamp": "dkuccuwbhjgvlulebwc", + "fqdn": "lk", + "runAsAccountId": "epkvjlsbaigwfxwgzo", + "version": "jqbcrsyaghjdudlpqkcpfqcnjmg", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "provisioningState": "Created" + }, + "id": "kwmuilxzrg", + "name": "otjimvbvxztyisadood", + "type": "daeznbszjdopcdttxso", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_ListByHypervSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_ListByHypervSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..80ffd71d0f08 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervHostController_ListByHypervSite_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "HypervHostController_ListByHypervSite", + "operationId": "HypervHostController_ListByHypervSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "sfuelzaazpjujucxswmcbzzkhayvz", + "siteName": "537erp8U864VI5F7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "iseqyuyqrsqohotfjzsifeyxyox", + "updatedTimestamp": "dkuccuwbhjgvlulebwc", + "fqdn": "lk", + "runAsAccountId": "epkvjlsbaigwfxwgzo", + "version": "jqbcrsyaghjdudlpqkcpfqcnjmg", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "provisioningState": "Created" + }, + "id": "kwmuilxzrg", + "name": "otjimvbvxztyisadood", + "type": "daeznbszjdopcdttxso", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobsController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..78f2ed47b353 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobsController_Get_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "HypervJobsController_Get", + "operationId": "HypervJobsController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "66xjB52-9--e", + "jobName": "V-258-4xS165l95" + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "gxgsmdmtocrmbnlsibksntnxfkoiu", + "startTime": "bnnddbgspizwnkwvvkvqhq", + "endTime": "cpouxxkikfjodgjvi", + "displayName": "jejisdzsezzotlmz", + "clientRequestId": "xtnxy", + "activityId": "dthzzprqvnkghxnca", + "errors": [ + { + "code": "iciy", + "message": "vpyszfmstisopihrrbbvf", + "possibleCauses": "sxrbjrrtqqljdgoe", + "recommendedAction": "osjxpjudgrlxepabiceakjcvmvvr", + "severity": "veqcqcmibgrabvajtvfzeyrb", + "isAgentReportedError": true, + "agentErrorCode": "bih", + "agentErrorMessage": "ryloaagexndkeuyrmuknxlunp", + "agentErrorPossibleCauses": "ehelidlosla", + "agentErrorRecommendedAction": "wgdq" + } + ], + "provisioningState": "Created" + }, + "id": "jnsoblaedwlabhbf", + "name": "vkchyliwwzcwppfuxmewqaypozcue", + "type": "vnmdptpo", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobsController_ListByVmwareSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobsController_ListByVmwareSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..9ca45897cf99 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobsController_ListByVmwareSite_MaximumSet_Gen.json @@ -0,0 +1,55 @@ +{ + "title": "HypervJobsController_ListByVmwareSite", + "operationId": "HypervJobsController_ListByVmwareSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "13y-18qK-" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "status": "gxgsmdmtocrmbnlsibksntnxfkoiu", + "startTime": "bnnddbgspizwnkwvvkvqhq", + "endTime": "cpouxxkikfjodgjvi", + "displayName": "jejisdzsezzotlmz", + "clientRequestId": "xtnxy", + "activityId": "dthzzprqvnkghxnca", + "errors": [ + { + "code": "iciy", + "message": "vpyszfmstisopihrrbbvf", + "possibleCauses": "sxrbjrrtqqljdgoe", + "recommendedAction": "osjxpjudgrlxepabiceakjcvmvvr", + "severity": "veqcqcmibgrabvajtvfzeyrb", + "isAgentReportedError": true, + "agentErrorCode": "bih", + "agentErrorMessage": "ryloaagexndkeuyrmuknxlunp", + "agentErrorPossibleCauses": "ehelidlosla", + "agentErrorRecommendedAction": "wgdq" + } + ], + "provisioningState": "Created" + }, + "id": "jnsoblaedwlabhbf", + "name": "vkchyliwwzcwppfuxmewqaypozcue", + "type": "vnmdptpo", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobs_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobs_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..88eaaf3b3cf8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobs_Get_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "HypervJobs_Get", + "operationId": "HypervJobs_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "f-WFME---c", + "jobName": "5B-2L-3sMO-H-n-F" + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "gxgsmdmtocrmbnlsibksntnxfkoiu", + "startTime": "bnnddbgspizwnkwvvkvqhq", + "endTime": "cpouxxkikfjodgjvi", + "displayName": "jejisdzsezzotlmz", + "clientRequestId": "xtnxy", + "activityId": "dthzzprqvnkghxnca", + "errors": [ + { + "code": "iciy", + "message": "vpyszfmstisopihrrbbvf", + "possibleCauses": "sxrbjrrtqqljdgoe", + "recommendedAction": "osjxpjudgrlxepabiceakjcvmvvr", + "severity": "veqcqcmibgrabvajtvfzeyrb", + "isAgentReportedError": true, + "agentErrorCode": "bih", + "agentErrorMessage": "ryloaagexndkeuyrmuknxlunp", + "agentErrorPossibleCauses": "ehelidlosla", + "agentErrorRecommendedAction": "wgdq" + } + ], + "provisioningState": "Created" + }, + "id": "dpfzw", + "name": "tdzjqmnsgsstxpuys", + "type": "kflffsriu", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobs_ListByHypervSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobs_ListByHypervSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..4b5f83e0e20a --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervJobs_ListByHypervSite_MaximumSet_Gen.json @@ -0,0 +1,55 @@ +{ + "title": "HypervJobs_ListByHypervSite", + "operationId": "HypervJobs_ListByHypervSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "71BmgvX-WJF9H5N7-5-cR" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "status": "gxgsmdmtocrmbnlsibksntnxfkoiu", + "startTime": "bnnddbgspizwnkwvvkvqhq", + "endTime": "cpouxxkikfjodgjvi", + "displayName": "jejisdzsezzotlmz", + "clientRequestId": "xtnxy", + "activityId": "dthzzprqvnkghxnca", + "errors": [ + { + "code": "iciy", + "message": "vpyszfmstisopihrrbbvf", + "possibleCauses": "sxrbjrrtqqljdgoe", + "recommendedAction": "osjxpjudgrlxepabiceakjcvmvvr", + "severity": "veqcqcmibgrabvajtvfzeyrb", + "isAgentReportedError": true, + "agentErrorCode": "bih", + "agentErrorMessage": "ryloaagexndkeuyrmuknxlunp", + "agentErrorPossibleCauses": "ehelidlosla", + "agentErrorRecommendedAction": "wgdq" + } + ], + "provisioningState": "Created" + }, + "id": "dpfzw", + "name": "tdzjqmnsgsstxpuys", + "type": "kflffsriu", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..73b36b19f8da --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_Get_MaximumSet_Gen.json @@ -0,0 +1,324 @@ +{ + "title": "HypervMachinesController_Get", + "operationId": "HypervMachinesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "55--o3Q", + "machineName": "90-HQO" + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceUuid": "pclzydkloxkbys", + "hostFqdn": "kkgdnfvwebetrayxzebksza", + "hostId": "mnylbg", + "generation": 26, + "version": "nuzozwehbucbvycwslv", + "highAvailability": "Unknown", + "clusterFqdn": "ghboksyhbqzd", + "clusterId": "tprxinnzzzkralijqcfqh", + "maxMemoryMb": 9, + "isDynamicMemoryEnabled": true, + "disks": [ + { + "instanceId": "hiqurczeylxtd", + "vhdId": "q", + "maxSizeInBytes": 24, + "name": "yjhyigoqrelofomymmuzlkuoqne", + "diskType": "dlhir", + "lun": 14, + "path": "rsiejutshbockrxieoqhbhl" + } + ], + "networkAdapters": [ + { + "networkId": "xkirq", + "subnetName": "qxxctpwuspxvbgpqosxxinhgyb", + "staticIpAddress": "fijmu", + "nicType": "ovimlqbdokqomykrkpcq", + "nicId": "kdzkwrfbxkdxvvbhxqmxaencsexl", + "macAddress": "evcz", + "ipAddressList": [ + "eowbyqrfb" + ], + "networkName": "thhpeojkn", + "ipAddressType": "bfbukxxiztriipimpdcrfzq" + } + ], + "managementServerType": "lqnhmrpzalceflbnmtxrbp", + "secureBootTemplateId": "zghefdjktuvb", + "secureBootEnabled": true, + "secureBootTemplate": "zpkyawbbjocr", + "tpmEnabled": true, + "ksdEnabled": true, + "shieldingRequested": true, + "dataProtectionRequested": true, + "encryptStateAndVmMigrationTraffic": true, + "virtualizationBasedSecurityOptOut": true, + "powerStatus": "qeriun", + "vmFqdn": "fjk", + "vmConfigurationFileLocation": "iljwp", + "firmware": "bqmrdpivcphaomrcmgqnyneqfmzlha", + "guestOsDetails": { + "osType": "xz", + "osName": "nuntfpzdlurtmvjfkcojerqxaaos", + "osVersion": "zrtaepnbiipl", + "osArchitecture": "swwiffrahcblv" + }, + "numberOfApplications": 9, + "guestDetailsDiscoveryTimestamp": "2024-01-18T11:33:22.394Z", + "isGuestDetailsDiscoveryInProgress": true, + "dependencyMapping": "mwgyebjbogevecwdknvnllhzfg", + "dependencyMappingStartTime": "2024-01-18T11:33:22.394Z", + "dependencyMappingEndTime": "qwagivorbcxaefylwsubj", + "runAsAccountId": "fp", + "applianceNames": [ + "pyyntwwpjsulosbsmaluq" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applicationDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "rwncwoyzvhbumon" + }, + "dependencyMapDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "uaafojfnjso" + }, + "staticDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "mqpsmttmzspz" + }, + "sqlDiscovery": { + "successfullyDiscoveredServerCount": 29, + "totalServerCount": 29, + "sqlMetadataHydratedRunAsAccountId": "vpjtrcjjrxoe", + "sqlMetadataDiscoveryPipe": "Unknown", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "webAppDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "oracleDiscovery": { + "totalInstanceCount": 30, + "totalDatabaseCount": 25, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "springBootDiscovery": { + "totalInstanceCount": 29, + "totalApplicationCount": 1, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "iisDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "tomcatDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "numberOfProcessorCore": 16, + "allocatedMemoryInMb": 16, + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "biosSerialNumber": "wfbaaaykbmoytencsrcvsgxklbqi", + "biosGuid": "xg", + "displayName": "maegrb", + "isDeleted": true, + "createdTimestamp": "bqrywgzpzavf", + "tags": { + "key4024": "ljekisvt" + }, + "updatedTimestamp": "yqlvnjttxlgodmywyb", + "provisioningState": "Created" + }, + "id": "wktuqewk", + "name": "gmlhmrfyryapozowkajucjsi", + "type": "hjqvqmvgtbolnxpxi", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_ListByHypervSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_ListByHypervSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d10dbf574f6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_ListByHypervSite_MaximumSet_Gen.json @@ -0,0 +1,332 @@ +{ + "title": "HypervMachinesController_ListByHypervSite", + "operationId": "HypervMachinesController_ListByHypervSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "kyubnetodehbyjnpkckhltn", + "top": 8, + "continuationToken": "fhdmzgodrapccxczfvzbftwzu", + "totalRecordCount": 28, + "siteName": "V-15KAwn1-23Z3J52B-cQC" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "instanceUuid": "pclzydkloxkbys", + "hostFqdn": "kkgdnfvwebetrayxzebksza", + "hostId": "mnylbg", + "generation": 26, + "version": "nuzozwehbucbvycwslv", + "highAvailability": "Unknown", + "clusterFqdn": "ghboksyhbqzd", + "clusterId": "tprxinnzzzkralijqcfqh", + "maxMemoryMb": 9, + "isDynamicMemoryEnabled": true, + "disks": [ + { + "instanceId": "hiqurczeylxtd", + "vhdId": "q", + "maxSizeInBytes": 24, + "name": "yjhyigoqrelofomymmuzlkuoqne", + "diskType": "dlhir", + "lun": 14, + "path": "rsiejutshbockrxieoqhbhl" + } + ], + "networkAdapters": [ + { + "networkId": "xkirq", + "subnetName": "qxxctpwuspxvbgpqosxxinhgyb", + "staticIpAddress": "fijmu", + "nicType": "ovimlqbdokqomykrkpcq", + "nicId": "kdzkwrfbxkdxvvbhxqmxaencsexl", + "macAddress": "evcz", + "ipAddressList": [ + "eowbyqrfb" + ], + "networkName": "thhpeojkn", + "ipAddressType": "bfbukxxiztriipimpdcrfzq" + } + ], + "managementServerType": "lqnhmrpzalceflbnmtxrbp", + "secureBootTemplateId": "zghefdjktuvb", + "secureBootEnabled": true, + "secureBootTemplate": "zpkyawbbjocr", + "tpmEnabled": true, + "ksdEnabled": true, + "shieldingRequested": true, + "dataProtectionRequested": true, + "encryptStateAndVmMigrationTraffic": true, + "virtualizationBasedSecurityOptOut": true, + "powerStatus": "qeriun", + "vmFqdn": "fjk", + "vmConfigurationFileLocation": "iljwp", + "firmware": "bqmrdpivcphaomrcmgqnyneqfmzlha", + "guestOsDetails": { + "osType": "xz", + "osName": "nuntfpzdlurtmvjfkcojerqxaaos", + "osVersion": "zrtaepnbiipl", + "osArchitecture": "swwiffrahcblv" + }, + "numberOfApplications": 9, + "guestDetailsDiscoveryTimestamp": "2024-01-18T11:33:22.394Z", + "isGuestDetailsDiscoveryInProgress": true, + "dependencyMapping": "mwgyebjbogevecwdknvnllhzfg", + "dependencyMappingStartTime": "2024-01-18T11:33:22.394Z", + "dependencyMappingEndTime": "qwagivorbcxaefylwsubj", + "runAsAccountId": "fp", + "applianceNames": [ + "pyyntwwpjsulosbsmaluq" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applicationDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "rwncwoyzvhbumon" + }, + "dependencyMapDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "uaafojfnjso" + }, + "staticDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "mqpsmttmzspz" + }, + "sqlDiscovery": { + "successfullyDiscoveredServerCount": 29, + "totalServerCount": 29, + "sqlMetadataHydratedRunAsAccountId": "vpjtrcjjrxoe", + "sqlMetadataDiscoveryPipe": "Unknown", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "webAppDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "oracleDiscovery": { + "totalInstanceCount": 30, + "totalDatabaseCount": 25, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "springBootDiscovery": { + "totalInstanceCount": 29, + "totalApplicationCount": 1, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "iisDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "tomcatDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "numberOfProcessorCore": 16, + "allocatedMemoryInMb": 16, + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "biosSerialNumber": "wfbaaaykbmoytencsrcvsgxklbqi", + "biosGuid": "xg", + "displayName": "maegrb", + "isDeleted": true, + "createdTimestamp": "bqrywgzpzavf", + "tags": { + "key4024": "ljekisvt" + }, + "updatedTimestamp": "yqlvnjttxlgodmywyb", + "provisioningState": "Created" + }, + "id": "wktuqewk", + "name": "gmlhmrfyryapozowkajucjsi", + "type": "hjqvqmvgtbolnxpxi", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_UpdateProperties_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_UpdateProperties_MaximumSet_Gen.json new file mode 100644 index 000000000000..41df9b7f2d31 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_UpdateProperties_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "HypervMachinesController_UpdateProperties", + "operationId": "HypervMachinesController_UpdateProperties", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "ewO-81-l-", + "metaData": { + "value": [ + { + "machineArmId": "cbfxbnpaesafshmuirygemyx", + "dependencyMapping": "mehkbjgdktlveubatdamkaawrfmkwc", + "tags": { + "key925": "kvcnqygwaiw" + } + } + ] + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..3b3c88d4d611 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervMachinesController_Update_MaximumSet_Gen.json @@ -0,0 +1,350 @@ +{ + "title": "HypervMachinesController_Update", + "operationId": "HypervMachinesController_Update", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "1-DCv-XE---Nq-03", + "machineName": "LgE8-B1C--X", + "body": { + "properties": { + "firmware": "z", + "runAsAccountId": "lpvwkktxwqlgdbnzg", + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "numberOfProcessorCore": 4, + "allocatedMemoryInMb": 23, + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "biosSerialNumber": "iyvikycmaekqufzkmdijssqekbrah", + "biosGuid": "dmxswgeyvspvafusl", + "tags": { + "key9256": "fyje" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceUuid": "pclzydkloxkbys", + "hostFqdn": "kkgdnfvwebetrayxzebksza", + "hostId": "mnylbg", + "generation": 26, + "version": "nuzozwehbucbvycwslv", + "highAvailability": "Unknown", + "clusterFqdn": "ghboksyhbqzd", + "clusterId": "tprxinnzzzkralijqcfqh", + "maxMemoryMb": 9, + "isDynamicMemoryEnabled": true, + "disks": [ + { + "instanceId": "hiqurczeylxtd", + "vhdId": "q", + "maxSizeInBytes": 24, + "name": "yjhyigoqrelofomymmuzlkuoqne", + "diskType": "dlhir", + "lun": 14, + "path": "rsiejutshbockrxieoqhbhl" + } + ], + "networkAdapters": [ + { + "networkId": "xkirq", + "subnetName": "qxxctpwuspxvbgpqosxxinhgyb", + "staticIpAddress": "fijmu", + "nicType": "ovimlqbdokqomykrkpcq", + "nicId": "kdzkwrfbxkdxvvbhxqmxaencsexl", + "macAddress": "evcz", + "ipAddressList": [ + "eowbyqrfb" + ], + "networkName": "thhpeojkn", + "ipAddressType": "bfbukxxiztriipimpdcrfzq" + } + ], + "managementServerType": "lqnhmrpzalceflbnmtxrbp", + "secureBootTemplateId": "zghefdjktuvb", + "secureBootEnabled": true, + "secureBootTemplate": "zpkyawbbjocr", + "tpmEnabled": true, + "ksdEnabled": true, + "shieldingRequested": true, + "dataProtectionRequested": true, + "encryptStateAndVmMigrationTraffic": true, + "virtualizationBasedSecurityOptOut": true, + "powerStatus": "qeriun", + "vmFqdn": "fjk", + "vmConfigurationFileLocation": "iljwp", + "firmware": "z", + "guestOsDetails": { + "osType": "xz", + "osName": "nuntfpzdlurtmvjfkcojerqxaaos", + "osVersion": "zrtaepnbiipl", + "osArchitecture": "swwiffrahcblv" + }, + "numberOfApplications": 9, + "guestDetailsDiscoveryTimestamp": "2024-01-18T11:33:22.394Z", + "isGuestDetailsDiscoveryInProgress": true, + "dependencyMapping": "mwgyebjbogevecwdknvnllhzfg", + "dependencyMappingStartTime": "2024-01-18T11:33:22.394Z", + "dependencyMappingEndTime": "qwagivorbcxaefylwsubj", + "runAsAccountId": "lpvwkktxwqlgdbnzg", + "applianceNames": [ + "pyyntwwpjsulosbsmaluq" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applicationDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "rwncwoyzvhbumon" + }, + "dependencyMapDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "uaafojfnjso" + }, + "staticDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "mqpsmttmzspz" + }, + "sqlDiscovery": { + "successfullyDiscoveredServerCount": 29, + "totalServerCount": 29, + "sqlMetadataHydratedRunAsAccountId": "vpjtrcjjrxoe", + "sqlMetadataDiscoveryPipe": "Unknown", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "webAppDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "oracleDiscovery": { + "totalInstanceCount": 30, + "totalDatabaseCount": 25, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "springBootDiscovery": { + "totalInstanceCount": 29, + "totalApplicationCount": 1, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "iisDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "tomcatDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "numberOfProcessorCore": 4, + "allocatedMemoryInMb": 23, + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "biosSerialNumber": "iyvikycmaekqufzkmdijssqekbrah", + "biosGuid": "dmxswgeyvspvafusl", + "displayName": "maegrb", + "isDeleted": true, + "createdTimestamp": "bqrywgzpzavf", + "tags": { + "key4024": "ljekisvt" + }, + "updatedTimestamp": "yqlvnjttxlgodmywyb", + "provisioningState": "Created" + }, + "id": "wktuqewk", + "name": "gmlhmrfyryapozowkajucjsi", + "type": "hjqvqmvgtbolnxpxi", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervOperationsStatusController_GetHypervOperationsStatus_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervOperationsStatusController_GetHypervOperationsStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..34975dc46c27 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervOperationsStatusController_GetHypervOperationsStatus_MaximumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "title": "HypervOperationsStatusController_GetHypervOperationsStatus", + "operationId": "HypervOperationsStatusController_GetHypervOperationsStatus", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-br7-R", + "operationStatusName": "74UH-" + }, + "responses": { + "200": { + "body": { + "id": "p", + "name": "bcvvgkxeeavuxwhhcuhlr", + "status": "xdwtanilfmuuhjnanaxclrds", + "startTime": "dqgff", + "endTime": "putnpglwoqfdhjkk", + "error": { + "code": "rnsnhdowwptegdldklx", + "message": "qolsunkhecgpjxm" + }, + "properties": { + "result": "wvhlgcgdktttlozc" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervRunAsAccountsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervRunAsAccountsController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f0e62cd6771f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervRunAsAccountsController_Get_MaximumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "title": "HypervRunAsAccountsController_Get", + "operationId": "HypervRunAsAccountsController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-v1e8lWSoqI2j-FQC-2-Q", + "accountName": "Qr--WF-B4MFWM6" + }, + "responses": { + "200": { + "body": { + "properties": { + "displayName": "jisgaadoxsjdfbz", + "credentialType": "zjlboeqftmfeafhmaf", + "createdTimestamp": "wgrjz", + "updatedTimestamp": "lqvvxyngsjskvx", + "applianceName": "fbicoeqjjfpfpadaewfuea", + "provisioningState": "Created" + }, + "id": "tennelzzuehmkrejornvxwunyj", + "name": "soxpbdbhaix", + "type": "jtxyzcspouuygdpgo", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervRunAsAccountsController_ListByHypervSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervRunAsAccountsController_ListByHypervSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..26ccdd372fcb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervRunAsAccountsController_ListByHypervSite_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "HypervRunAsAccountsController_ListByHypervSite", + "operationId": "HypervRunAsAccountsController_ListByHypervSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-7QDJ-LoJ82kg-P3YS0-C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "jisgaadoxsjdfbz", + "credentialType": "zjlboeqftmfeafhmaf", + "createdTimestamp": "wgrjz", + "updatedTimestamp": "lqvvxyngsjskvx", + "applianceName": "fbicoeqjjfpfpadaewfuea", + "provisioningState": "Created" + }, + "id": "tennelzzuehmkrejornvxwunyj", + "name": "soxpbdbhaix", + "type": "jtxyzcspouuygdpgo", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/abf" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ComputeErrorSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ComputeErrorSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..f5758668bdab --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ComputeErrorSummary_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "HypervSitesController_ComputeErrorSummary", + "operationId": "HypervSitesController_ComputeErrorSummary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "47P7-4FT-O-C1O6XE15-5C0-", + "body": {} + }, + "responses": { + "200": { + "body": { + "applianceName": "rnwdayyamnbf", + "discoveryScopeErrorSummaries": { + "affectedResourceType": "eogpdpyddhvnf", + "affectedObjectsCount": 13, + "discoveryScope": "AppsAndRoles" + }, + "nextLink": "nctyxej" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Computeusage_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Computeusage_MaximumSet_Gen.json new file mode 100644 index 000000000000..f2a478c0910b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Computeusage_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "HypervSitesController_Computeusage", + "operationId": "HypervSitesController_Computeusage", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "G6J8L7Pi", + "body": {} + }, + "responses": { + "200": { + "body": { + "machineCount": 22, + "runAsAccountCount": 23, + "hostCount": 16, + "clusterCount": 22 + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..d085002e92d7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Create_MaximumSet_Gen.json @@ -0,0 +1,117 @@ +{ + "title": "HypervSitesController_Create", + "operationId": "HypervSitesController_Create", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "B9be-JfY48Vc6SDN8d1CCp-", + "body": { + "properties": { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "bplbumeu", + "discoverySolutionId": "sqgvbumhsdeunojunhypdunvcutlev", + "provisioningState": "Created" + }, + "tags": { + "key9210": "yitjyobwfkbprpkfcmogsywoot" + }, + "location": "jzfqhihimugilssu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "masterSiteId": "jqb", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "bplbumeu", + "discoverySolutionId": "sqgvbumhsdeunojunhypdunvcutlev", + "serviceEndpoint": "tlhwxrppojbmczx", + "provisioningState": "Created" + }, + "tags": { + "key9210": "yitjyobwfkbprpkfcmogsywoot" + }, + "location": "jzfqhihimugilssu", + "id": "bbanugucfomirbti", + "name": "njvmqppcbjrykvbqc", + "type": "bhyzhkwzj", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "body": { + "properties": { + "masterSiteId": "jqb", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "bplbumeu", + "discoverySolutionId": "sqgvbumhsdeunojunhypdunvcutlev", + "serviceEndpoint": "tlhwxrppojbmczx", + "provisioningState": "Created" + }, + "tags": { + "key9210": "yitjyobwfkbprpkfcmogsywoot" + }, + "location": "jzfqhihimugilssu", + "id": "bbanugucfomirbti", + "name": "njvmqppcbjrykvbqc", + "type": "bhyzhkwzj", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..5148432e1345 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "HypervSitesController_Delete", + "operationId": "HypervSitesController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "516m8O9-75LL18U" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ExportApplications_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ExportApplications_MaximumSet_Gen.json new file mode 100644 index 000000000000..b3b6f6fce539 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ExportApplications_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "HypervSitesController_ExportApplications", + "operationId": "HypervSitesController_ExportApplications", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "4-5553FjVuW-F34", + "body": {} + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ExportMachineErrors_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ExportMachineErrors_MaximumSet_Gen.json new file mode 100644 index 000000000000..3483d66ce802 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ExportMachineErrors_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "HypervSitesController_ExportMachineErrors", + "operationId": "HypervSitesController_ExportMachineErrors", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "74Ds26", + "body": { + "properties": { + "discoveryScope": "AppsAndRoles" + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f370f4a821be --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Get_MaximumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "title": "HypervSitesController_Get", + "operationId": "HypervSitesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "04p-YXAMxEA994743LG35bK-" + }, + "responses": { + "200": { + "body": { + "properties": { + "masterSiteId": "jqb", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "bplbumeu", + "discoverySolutionId": "sqgvbumhsdeunojunhypdunvcutlev", + "serviceEndpoint": "tlhwxrppojbmczx", + "provisioningState": "Created" + }, + "tags": { + "key9210": "yitjyobwfkbprpkfcmogsywoot" + }, + "location": "jzfqhihimugilssu", + "id": "bbanugucfomirbti", + "name": "njvmqppcbjrykvbqc", + "type": "bhyzhkwzj", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ListHealthSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ListHealthSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..22e882ed9662 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_ListHealthSummary_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "HypervSitesController_ListHealthSummary", + "operationId": "HypervSitesController_ListHealthSummary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "5CT5D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "applianceName": "ivgdfvknbqkininnhifgcfey", + "errorMessage": "qmggozc", + "summaryMessage": "uhvqaiarzijpafpaiohfysmtdh", + "errorId": 10, + "errorCode": "votsjhvgcgogxznq", + "affectedObjectsCount": 13, + "hitCount": 21, + "severity": "bje", + "remediationGuidance": "yyanqkehkxtolfrkgmrmbsjqwnarj", + "affectedResourceType": "efxqqedsbgdswgf", + "affectedResources": [ + "ekpfdxxvxclxarytnlnxmslr" + ], + "fabricLayoutUpdateSources": [ + "RefreshFabricLayout" + ] + } + ], + "nextLink": "oj" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Summary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Summary_MaximumSet_Gen.json new file mode 100644 index 000000000000..7d11435fb925 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Summary_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "HypervSitesController_Summary", + "operationId": "HypervSitesController_Summary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-0-6Byn" + }, + "responses": { + "200": { + "body": { + "machineCount": 22, + "runAsAccountCount": 23, + "hostCount": 16, + "clusterCount": 22 + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..7aab9852d1d7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSitesController_Update_MaximumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "title": "HypervSitesController_Update", + "operationId": "HypervSitesController_Update", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "X2UJ-6-3p64TUj", + "body": { + "tags": { + "key8611": "ifdzfafhrcras" + }, + "properties": { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jtphpskximt", + "discoverySolutionId": "woihspbrxqmel", + "provisioningState": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "masterSiteId": "jqb", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jtphpskximt", + "discoverySolutionId": "woihspbrxqmel", + "serviceEndpoint": "tlhwxrppojbmczx", + "provisioningState": "Created" + }, + "tags": { + "key9210": "yitjyobwfkbprpkfcmogsywoot" + }, + "location": "jzfqhihimugilssu", + "id": "bbanugucfomirbti", + "name": "njvmqppcbjrykvbqc", + "type": "bhyzhkwzj", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSites_ListByResourceGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSites_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..ab8a823cf3fa --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSites_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "Get all hyperv sites.", + "operationId": "HypervSites_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "masterSiteId": "jqb", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "bplbumeu", + "discoverySolutionId": "sqgvbumhsdeunojunhypdunvcutlev", + "serviceEndpoint": "tlhwxrppojbmczx", + "provisioningState": "Created" + }, + "tags": { + "key9210": "yitjyobwfkbprpkfcmogsywoot" + }, + "location": "jzfqhihimugilssu", + "id": "bbanugucfomirbti", + "name": "njvmqppcbjrykvbqc", + "type": "bhyzhkwzj", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSites_ListBySubscription_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSites_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..84b978a3c312 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSites_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,56 @@ +{ + "title": "Get all hyperv sites.", + "operationId": "HypervSites_ListBySubscription", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "masterSiteId": "jqb", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "bplbumeu", + "discoverySolutionId": "sqgvbumhsdeunojunhypdunvcutlev", + "serviceEndpoint": "tlhwxrppojbmczx", + "provisioningState": "Created" + }, + "tags": { + "key9210": "yitjyobwfkbprpkfcmogsywoot" + }, + "location": "jzfqhihimugilssu", + "id": "bbanugucfomirbti", + "name": "njvmqppcbjrykvbqc", + "type": "bhyzhkwzj", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json new file mode 100644 index 000000000000..52c799601cd0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json @@ -0,0 +1,113 @@ +{ + "title": "HypervSoftwareInventoriesController_GetMachineSoftwareInventory", + "operationId": "HypervSoftwareInventoriesController_GetMachineSoftwareInventory", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "--rW-Hc63Rn--54", + "machineName": "36-DV9", + "default": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "provisioningState": "Created" + }, + "id": "ayfqpzbpbgvcfglltvttyz", + "name": "ddngzzftridgaywcldel", + "type": "zubohwoptbidocqnncyxelex", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSoftwareInventoriesController_ListByHypervMachine_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSoftwareInventoriesController_ListByHypervMachine_MaximumSet_Gen.json new file mode 100644 index 000000000000..cd0c1abe1e30 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/HypervSoftwareInventoriesController_ListByHypervMachine_MaximumSet_Gen.json @@ -0,0 +1,117 @@ +{ + "title": "HypervSoftwareInventoriesController_ListByHypervMachine", + "operationId": "HypervSoftwareInventoriesController_ListByHypervMachine", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "1UbP6YWKj-Nf", + "machineName": "VQ-HROe1jmHEI17-B2-sSVY" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "provisioningState": "Created" + }, + "id": "ayfqpzbpbgvcfglltvttyz", + "name": "ddngzzftridgaywcldel", + "type": "zubohwoptbidocqnncyxelex", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebApplicationsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebApplicationsController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..63f55a5717dd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebApplicationsController_Get_MaximumSet_Gen.json @@ -0,0 +1,145 @@ +{ + "title": "IisWebApplicationsController_Get", + "operationId": "IisWebApplicationsController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "3Q4HX-9-eV7E", + "webAppSiteName": "5-18J68j1C5D-R1---p0", + "webApplicationName": "72AESeVSD-N2388VI-3K" + }, + "responses": { + "200": { + "body": { + "properties": { + "applications": [ + { + "applicationPoolName": "vctsepmefyqmbxmwcqfmruhlpx", + "managedPipelineMode": "hb", + "runtimeVersion": "rtworbrtgv", + "enable32BitApiOnWin64": true, + "path": { + "virtual": "ywuksjpzljjwlqbsfm", + "physical": "hlhzwnnubqnuruhkenw" + }, + "directories": [ + { + "virtual": "ywuksjpzljjwlqbsfm", + "physical": "hlhzwnnubqnuruhkenw" + } + ] + } + ], + "virtualApplications": [ + { + "isVirtualDirectory": true, + "path": { + "virtual": "ywuksjpzljjwlqbsfm", + "physical": "hlhzwnnubqnuruhkenw" + }, + "directories": [ + { + "virtual": "ywuksjpzljjwlqbsfm", + "physical": "hlhzwnnubqnuruhkenw" + } + ] + } + ], + "webServerId": "jkpptdqzswn", + "webServerName": "elekvwvupngtzdfeklz", + "machineArmIds": [ + "oiiru" + ], + "virtualPath": "nqtnqcclwxriltekszjgzqleprxuz", + "physicalPath": "gyddqtcuv", + "bindings": [ + { + "protocol": "fudnxq", + "hostName": "tl", + "port": "hl", + "ipAddress": "rkroun" + } + ], + "frameworks": [ + { + "name": "xowbhljmhrl", + "version": "jcweyiaoeegmnfpfs" + } + ], + "configurations": [ + { + "name": "wf", + "filePath": "eswelqmambi", + "localFilePath": "qulownyukxcszlfcqvjxjpbeflwk", + "targetFilePath": "sonpnuozmrwzydphtilcgwc", + "section": "flzwaptkisefqxbensmjmwaf", + "type": "bqatpkvru", + "isDeploymentTimeEditable": true, + "identifier": "lvfcecfz" + } + ], + "directories": [ + { + "id": "fwlhspdqg", + "isEditable": true, + "sourcePaths": [ + "uyandieoincaetifjgsveivtjxnu" + ], + "localScratchPath": "yppozdjz", + "mountPath": "chapopfxntekfcklnexwxnu", + "sourceSize": "lavsassibqcrcehxqmbzyjdirxvi" + } + ], + "displayName": "kqalbonhdsmrrqlcrxhqhsyrmf", + "tags": { + "key7187": "xklstbhbxlddqxsflxc" + }, + "staticFolders": [ + "zg" + ], + "machineDisplayName": "podvxoxwtphk", + "isDeleted": true, + "createdTimestamp": "dovximqjuoijonjouojurhjhd", + "updatedTimestamp": "wwcdjfyiw", + "serverType": "snwfopfzfwryvub", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applianceNames": [ + "kiswaeij" + ], + "hasErrors": true, + "provisioningState": "Created" + }, + "id": "uxscvoqfzsjubjos", + "name": "blctposepcjgpx", + "type": "ymzsqtazpzazwhrzhpidkjkf", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..31fa3d83fd21 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json @@ -0,0 +1,153 @@ +{ + "title": "IisWebApplicationsController_ListByWebAppSite", + "operationId": "IisWebApplicationsController_ListByWebAppSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "wvwywoxqekogrprnt", + "top": "z", + "continuationToken": "arcbfairpqghsa", + "totalRecordCount": 19, + "siteName": "Ybs6T7iJLIc", + "webAppSiteName": "-UVtIW--VKZ-HtCj-43" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "applications": [ + { + "applicationPoolName": "vctsepmefyqmbxmwcqfmruhlpx", + "managedPipelineMode": "hb", + "runtimeVersion": "rtworbrtgv", + "enable32BitApiOnWin64": true, + "path": { + "virtual": "ywuksjpzljjwlqbsfm", + "physical": "hlhzwnnubqnuruhkenw" + }, + "directories": [ + { + "virtual": "ywuksjpzljjwlqbsfm", + "physical": "hlhzwnnubqnuruhkenw" + } + ] + } + ], + "virtualApplications": [ + { + "isVirtualDirectory": true, + "path": { + "virtual": "ywuksjpzljjwlqbsfm", + "physical": "hlhzwnnubqnuruhkenw" + }, + "directories": [ + { + "virtual": "ywuksjpzljjwlqbsfm", + "physical": "hlhzwnnubqnuruhkenw" + } + ] + } + ], + "webServerId": "jkpptdqzswn", + "webServerName": "elekvwvupngtzdfeklz", + "machineArmIds": [ + "oiiru" + ], + "virtualPath": "nqtnqcclwxriltekszjgzqleprxuz", + "physicalPath": "gyddqtcuv", + "bindings": [ + { + "protocol": "fudnxq", + "hostName": "tl", + "port": "hl", + "ipAddress": "rkroun" + } + ], + "frameworks": [ + { + "name": "xowbhljmhrl", + "version": "jcweyiaoeegmnfpfs" + } + ], + "configurations": [ + { + "name": "wf", + "filePath": "eswelqmambi", + "localFilePath": "qulownyukxcszlfcqvjxjpbeflwk", + "targetFilePath": "sonpnuozmrwzydphtilcgwc", + "section": "flzwaptkisefqxbensmjmwaf", + "type": "bqatpkvru", + "isDeploymentTimeEditable": true, + "identifier": "lvfcecfz" + } + ], + "directories": [ + { + "id": "fwlhspdqg", + "isEditable": true, + "sourcePaths": [ + "uyandieoincaetifjgsveivtjxnu" + ], + "localScratchPath": "yppozdjz", + "mountPath": "chapopfxntekfcklnexwxnu", + "sourceSize": "lavsassibqcrcehxqmbzyjdirxvi" + } + ], + "displayName": "kqalbonhdsmrrqlcrxhqhsyrmf", + "tags": { + "key7187": "xklstbhbxlddqxsflxc" + }, + "staticFolders": [ + "zg" + ], + "machineDisplayName": "podvxoxwtphk", + "isDeleted": true, + "createdTimestamp": "dovximqjuoijonjouojurhjhd", + "updatedTimestamp": "wwcdjfyiw", + "serverType": "snwfopfzfwryvub", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applianceNames": [ + "kiswaeij" + ], + "hasErrors": true, + "provisioningState": "Created" + }, + "id": "uxscvoqfzsjubjos", + "name": "blctposepcjgpx", + "type": "ymzsqtazpzazwhrzhpidkjkf", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebApplicationsController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebApplicationsController_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..0683646de694 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebApplicationsController_Update_MaximumSet_Gen.json @@ -0,0 +1,152 @@ +{ + "title": "IisWebApplicationsController_Update", + "operationId": "IisWebApplicationsController_Update", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "66C6e5--JT", + "webAppSiteName": "r4NNJ96p4Y2l-3F456A", + "webApplicationName": "53XW34L-5", + "body": { + "properties": { + "tags": { + "key7171": "bgjjlyxsczvasauqmxjeeuzltv" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "applications": [ + { + "applicationPoolName": "vctsepmefyqmbxmwcqfmruhlpx", + "managedPipelineMode": "hb", + "runtimeVersion": "rtworbrtgv", + "enable32BitApiOnWin64": true, + "path": { + "virtual": "ywuksjpzljjwlqbsfm", + "physical": "hlhzwnnubqnuruhkenw" + }, + "directories": [ + { + "virtual": "ywuksjpzljjwlqbsfm", + "physical": "hlhzwnnubqnuruhkenw" + } + ] + } + ], + "virtualApplications": [ + { + "isVirtualDirectory": true, + "path": { + "virtual": "ywuksjpzljjwlqbsfm", + "physical": "hlhzwnnubqnuruhkenw" + }, + "directories": [ + { + "virtual": "ywuksjpzljjwlqbsfm", + "physical": "hlhzwnnubqnuruhkenw" + } + ] + } + ], + "webServerId": "jkpptdqzswn", + "webServerName": "elekvwvupngtzdfeklz", + "machineArmIds": [ + "oiiru" + ], + "virtualPath": "nqtnqcclwxriltekszjgzqleprxuz", + "physicalPath": "gyddqtcuv", + "bindings": [ + { + "protocol": "fudnxq", + "hostName": "tl", + "port": "hl", + "ipAddress": "rkroun" + } + ], + "frameworks": [ + { + "name": "xowbhljmhrl", + "version": "jcweyiaoeegmnfpfs" + } + ], + "configurations": [ + { + "name": "wf", + "filePath": "eswelqmambi", + "localFilePath": "qulownyukxcszlfcqvjxjpbeflwk", + "targetFilePath": "sonpnuozmrwzydphtilcgwc", + "section": "flzwaptkisefqxbensmjmwaf", + "type": "bqatpkvru", + "isDeploymentTimeEditable": true, + "identifier": "lvfcecfz" + } + ], + "directories": [ + { + "id": "fwlhspdqg", + "isEditable": true, + "sourcePaths": [ + "uyandieoincaetifjgsveivtjxnu" + ], + "localScratchPath": "yppozdjz", + "mountPath": "chapopfxntekfcklnexwxnu", + "sourceSize": "lavsassibqcrcehxqmbzyjdirxvi" + } + ], + "displayName": "kqalbonhdsmrrqlcrxhqhsyrmf", + "tags": { + "key7187": "xklstbhbxlddqxsflxc" + }, + "staticFolders": [ + "zg" + ], + "machineDisplayName": "podvxoxwtphk", + "isDeleted": true, + "createdTimestamp": "dovximqjuoijonjouojurhjhd", + "updatedTimestamp": "wwcdjfyiw", + "serverType": "snwfopfzfwryvub", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applianceNames": [ + "kiswaeij" + ], + "hasErrors": true, + "provisioningState": "Created" + }, + "id": "uxscvoqfzsjubjos", + "name": "blctposepcjgpx", + "type": "ymzsqtazpzazwhrzhpidkjkf", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebServersController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebServersController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..3b91b4f1bbd4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebServersController_Get_MaximumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "title": "IisWebServersController_Get", + "operationId": "IisWebServersController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "SR-96OCM--XT36JL", + "webAppSiteName": "P7--4VIF8-i23", + "webServerName": "c-7kNY--G2LK5xF1S1-S--" + }, + "responses": { + "200": { + "body": { + "properties": { + "configurationLocation": "wjmolgclsfhhmkrzuqusscmfstb", + "version": "ytaqygtebsoeqxfgxctcwwuouudvi", + "machineIds": [ + "argrktlkfxyxqcb" + ], + "webApplications": [ + "kpthddpuiuumanaoo" + ], + "displayName": "nypuekifrjsvnkciih", + "serverFqdn": "mwtyebxxvgggqywuadbdvfeqf", + "runAsAccountId": "dainj", + "isDeleted": true, + "createdTimestamp": "qkcdqxnmmqdgktuovwszyngieved", + "updatedTimestamp": "zxbbrkonblyyyxklbkav", + "serverType": "ectuh", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applianceNames": [ + "fow" + ], + "hasErrors": true, + "provisioningState": "Created" + }, + "id": "uegupnifxotatduir", + "name": "t", + "type": "vwatmjihqxvcialbrxxcfqyv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebServersController_ListByWebAppSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebServersController_ListByWebAppSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..e6ef59d3ad7e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/IisWebServersController_ListByWebAppSite_MaximumSet_Gen.json @@ -0,0 +1,78 @@ +{ + "title": "IisWebServersController_ListByWebAppSite", + "operationId": "IisWebServersController_ListByWebAppSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "rinldabllgidknnae", + "top": "v", + "continuationToken": "wpdqwrjtvuynceqwvbzaawaqbdrts", + "totalRecordCount": 15, + "siteName": "--YE-25jFZ15-fcNL8HPAr1", + "webAppSiteName": "yko5f8" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "configurationLocation": "wjmolgclsfhhmkrzuqusscmfstb", + "version": "ytaqygtebsoeqxfgxctcwwuouudvi", + "machineIds": [ + "argrktlkfxyxqcb" + ], + "webApplications": [ + "kpthddpuiuumanaoo" + ], + "displayName": "nypuekifrjsvnkciih", + "serverFqdn": "mwtyebxxvgggqywuadbdvfeqf", + "runAsAccountId": "dainj", + "isDeleted": true, + "createdTimestamp": "qkcdqxnmmqdgktuovwszyngieved", + "updatedTimestamp": "zxbbrkonblyyyxklbkav", + "serverType": "ectuh", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applianceNames": [ + "fow" + ], + "hasErrors": true, + "provisioningState": "Created" + }, + "id": "uegupnifxotatduir", + "name": "t", + "type": "vwatmjihqxvcialbrxxcfqyv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/aqjx" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_GetDeletejob_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_GetDeletejob_MaximumSet_Gen.json new file mode 100644 index 000000000000..04ee125ed0b3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_GetDeletejob_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "ImportJobsController_GetDeletejob", + "operationId": "ImportJobsController_GetDeletejob", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "AL7-H5T6-0", + "jobName": "D5X-4-K18-78Y2u" + }, + "responses": { + "200": { + "body": { + "properties": { + "blobName": "amckjaztaghiqmrgknostjfvdkdu", + "errorSasUri": "yefbeyritvveublnp", + "jobState": "Unknown", + "numberOfMachinesDeleted": 3, + "deletionConfirmation": true, + "errors": [ + "eqkjvepkcwbwvmsrwxcma" + ], + "status": "hugifuxbktn", + "startTime": "gjhxf", + "endTime": "flbmmawlgejratyqsxv", + "displayName": "hmiodyctxrcssfuyfeqt", + "provisioningState": "Created" + }, + "id": "nyofumxeaaoupexlqtfkuxqasm", + "name": "ltevcvqangrz", + "type": "dasup", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_GetExportjob_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_GetExportjob_MaximumSet_Gen.json new file mode 100644 index 000000000000..49c7c6a9e29c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_GetExportjob_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "ImportJobsController_GetExportjob", + "operationId": "ImportJobsController_GetExportjob", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "--j3-58---6JK-5I", + "jobName": "E-KH" + }, + "responses": { + "200": { + "body": { + "type": "pndtyscdrwhguukfxfuydnnhnhxfuz", + "properties": { + "blobName": "lvwoh", + "sasUri": "lgweqxzboavhlto" + }, + "id": "v", + "name": "rn", + "status": "vtmbauylteftvxv", + "startTime": "flavoqlsjtdvvmgwfoeluurejdd", + "endTime": "lhcvywrzsmh", + "displayName": "fimpjatxnnyedjzqeskcdr" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_GetImportjob_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_GetImportjob_MaximumSet_Gen.json new file mode 100644 index 000000000000..4bdb0b877b86 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_GetImportjob_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "ImportJobsController_GetImportjob", + "operationId": "ImportJobsController_GetImportjob", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "hR53N130Y3C87-0Y7", + "jobName": "o4r5i3iJ3mKCUm7-P-8SZ2P" + }, + "responses": { + "200": { + "body": { + "type": "gfgmkufgemdccybsfkdfazcycdg", + "properties": { + "blobName": "cvqgkdgsxjpdsmcmocejyx", + "blobSasUri": "ocsiegplezoyxocbfppqenbhgezaa", + "jobResult": "Unknown", + "numberOfMachinesImported": 14, + "blobCreationTimeStamp": "2024-01-18T11:33:50.908Z", + "errorSummary": { + "errors": [ + "k" + ], + "errorCount": 22, + "warningCount": 1 + } + }, + "id": "lmfpzz", + "name": "ugrjlfvvzvpwzqs", + "status": "spxhayggdibghterlezavplpjfau", + "startTime": "jgxavkdvmqhhculjsyyvgrdazpyhe", + "endTime": "ijemmcjmwgj", + "displayName": "ygmzdujjyqrfz" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..c51acefc9123 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_Get_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "ImportJobsController_Get", + "operationId": "ImportJobsController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "1bYz4-666S63-PQ08fH", + "jobName": "6PK797l34W-5q6M" + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "gxgsmdmtocrmbnlsibksntnxfkoiu", + "startTime": "bnnddbgspizwnkwvvkvqhq", + "endTime": "cpouxxkikfjodgjvi", + "displayName": "jejisdzsezzotlmz", + "clientRequestId": "xtnxy", + "activityId": "dthzzprqvnkghxnca", + "errors": [ + { + "code": "iciy", + "message": "vpyszfmstisopihrrbbvf", + "possibleCauses": "sxrbjrrtqqljdgoe", + "recommendedAction": "osjxpjudgrlxepabiceakjcvmvvr", + "severity": "veqcqcmibgrabvajtvfzeyrb", + "isAgentReportedError": true, + "agentErrorCode": "bih", + "agentErrorMessage": "ryloaagexndkeuyrmuknxlunp", + "agentErrorPossibleCauses": "ehelidlosla", + "agentErrorRecommendedAction": "wgdq" + } + ], + "provisioningState": "Created" + }, + "id": "ncxvhkcnpoeran", + "name": "cugscjmmttfc", + "type": "xhrokiemkqvofgpge", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListByImportSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListByImportSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..0f2a09bb61f5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListByImportSite_MaximumSet_Gen.json @@ -0,0 +1,55 @@ +{ + "title": "ImportJobsController_ListByImportSite", + "operationId": "ImportJobsController_ListByImportSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-1EV3z1-q8yW35t--KCgU" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "status": "gxgsmdmtocrmbnlsibksntnxfkoiu", + "startTime": "bnnddbgspizwnkwvvkvqhq", + "endTime": "cpouxxkikfjodgjvi", + "displayName": "jejisdzsezzotlmz", + "clientRequestId": "xtnxy", + "activityId": "dthzzprqvnkghxnca", + "errors": [ + { + "code": "iciy", + "message": "vpyszfmstisopihrrbbvf", + "possibleCauses": "sxrbjrrtqqljdgoe", + "recommendedAction": "osjxpjudgrlxepabiceakjcvmvvr", + "severity": "veqcqcmibgrabvajtvfzeyrb", + "isAgentReportedError": true, + "agentErrorCode": "bih", + "agentErrorMessage": "ryloaagexndkeuyrmuknxlunp", + "agentErrorPossibleCauses": "ehelidlosla", + "agentErrorRecommendedAction": "wgdq" + } + ], + "provisioningState": "Created" + }, + "id": "ncxvhkcnpoeran", + "name": "cugscjmmttfc", + "type": "xhrokiemkqvofgpge", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/alq" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListDeletejobs_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListDeletejobs_MaximumSet_Gen.json new file mode 100644 index 000000000000..d275ccfcff0d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListDeletejobs_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "ImportJobsController_ListDeletejobs", + "operationId": "ImportJobsController_ListDeletejobs", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "A2LE" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "blobName": "amckjaztaghiqmrgknostjfvdkdu", + "errorSasUri": "yefbeyritvveublnp", + "jobState": "Unknown", + "numberOfMachinesDeleted": 3, + "deletionConfirmation": true, + "errors": [ + "eqkjvepkcwbwvmsrwxcma" + ], + "status": "hugifuxbktn", + "startTime": "gjhxf", + "endTime": "flbmmawlgejratyqsxv", + "displayName": "hmiodyctxrcssfuyfeqt", + "provisioningState": "Created" + }, + "id": "nyofumxeaaoupexlqtfkuxqasm", + "name": "ltevcvqangrz", + "type": "dasup", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "kn" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListExportjobs_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListExportjobs_MaximumSet_Gen.json new file mode 100644 index 000000000000..f53055bf9b2d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListExportjobs_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "ImportJobsController_ListExportjobs", + "operationId": "ImportJobsController_ListExportjobs", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "V-zR1-J3068BzG8" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "pndtyscdrwhguukfxfuydnnhnhxfuz", + "properties": { + "blobName": "lvwoh", + "sasUri": "lgweqxzboavhlto" + }, + "id": "v", + "name": "rn", + "status": "vtmbauylteftvxv", + "startTime": "flavoqlsjtdvvmgwfoeluurejdd", + "endTime": "lhcvywrzsmh", + "displayName": "fimpjatxnnyedjzqeskcdr" + } + ], + "nextLink": "ksolavl" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListImportjobs_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListImportjobs_MaximumSet_Gen.json new file mode 100644 index 000000000000..e8ee8f77a2e3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportJobsController_ListImportjobs_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "ImportJobsController_ListImportjobs", + "operationId": "ImportJobsController_ListImportjobs", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "V--Y" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "gfgmkufgemdccybsfkdfazcycdg", + "properties": { + "blobName": "cvqgkdgsxjpdsmcmocejyx", + "blobSasUri": "ocsiegplezoyxocbfppqenbhgezaa", + "jobResult": "Unknown", + "numberOfMachinesImported": 14, + "blobCreationTimeStamp": "2024-01-18T11:33:50.908Z", + "errorSummary": { + "errors": [ + "k" + ], + "errorCount": 22, + "warningCount": 1 + } + }, + "id": "lmfpzz", + "name": "ugrjlfvvzvpwzqs", + "status": "spxhayggdibghterlezavplpjfau", + "startTime": "jgxavkdvmqhhculjsyyvgrdazpyhe", + "endTime": "ijemmcjmwgj", + "displayName": "ygmzdujjyqrfz" + } + ], + "nextLink": "myvcw" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportMachinesController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportMachinesController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..1ab9e9161e12 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportMachinesController_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "ImportMachinesController_Delete", + "operationId": "ImportMachinesController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "f3lKWv8R8", + "machineName": "-AKBb-" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportMachinesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportMachinesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..eb75b79ab98b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportMachinesController_Get_MaximumSet_Gen.json @@ -0,0 +1,83 @@ +{ + "title": "ImportMachinesController_Get", + "operationId": "ImportMachinesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "SZ1-jnNO41CNL-", + "machineName": "M6Lh9M6" + }, + "responses": { + "200": { + "body": { + "properties": { + "firmware": "woorfktflkvz", + "percentageCpuUtilization": 12, + "percentageMemoryUtilization": 2, + "numberOfDisks": 4, + "totalDiskReadOperationsPerSecond": 26, + "totalDiskWriteOperationsPerSecond": 22, + "totalDiskWriteThroughput": 24, + "totalDiskReadThroughput": 25, + "macAddress": "wclsyazvbs", + "ipAddresses": [ + "vxrbbvsudurjdw" + ], + "machineId": "sbesprwyfyhkjakylaxqxisex", + "machineManagerId": "sxezccawxiemjn", + "numberOfNetworkAdapters": 10, + "networkInThroughput": 16, + "networkOutThroughput": 4, + "serverType": "spodyrxudmtwaqblembjsrzjrllzab", + "hypervisor": "g", + "hypervisorVersionNumber": "bsxlbdxpoticxrfywnvgkzdti", + "disks": [ + { + "megabytesPerSecondOfRead": 17, + "megabytesPerSecondOfWrite": 1, + "numberOfReadOperationsPerSecond": 12, + "numberOfWriteOperationsPerSecond": 16, + "maxSizeInBytes": 27, + "name": "dtseimme", + "diskType": "hisjtnwowrahejiyggw", + "lun": 26, + "path": "stmc" + } + ], + "vmFqdn": "yewqdpdjucnpokhzizezvmfjxo", + "storageInUseGb": 17, + "numberOfProcessorCore": 18, + "allocatedMemoryInMb": 28, + "operatingSystemDetails": { + "osType": "czljcy", + "osName": "nzfq", + "osVersion": "nmytttoaeifzrgiyeuaq", + "osArchitecture": "srlaxrpoc" + }, + "biosSerialNumber": "vnmmsnajxabaleyrefm", + "biosGuid": "obcnjhotsxs", + "displayName": "mesoejtxmzyqvdnaqdzvcbtyerxep", + "isDeleted": true, + "createdTimestamp": "tauehcnhmpiwnnht", + "updatedTimestamp": "jiramvswnifa", + "tags": { + "key4844": "plpc" + }, + "provisioningState": "Created" + }, + "id": "bdyfzqchyjnifsckuggxg", + "name": "sivbcctvstgxuctuocicrpudjq", + "type": "xj", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportMachinesController_ListByImportSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportMachinesController_ListByImportSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..78c8763eb6c3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportMachinesController_ListByImportSite_MaximumSet_Gen.json @@ -0,0 +1,91 @@ +{ + "title": "ImportMachinesController_ListByImportSite", + "operationId": "ImportMachinesController_ListByImportSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "kafhkqcjdeklhnczdhjovkgijvlw", + "top": "loxkkgpreqgavcltenlowlrjtgdtf", + "continuationToken": "rvcydbqlqgmjt", + "totalRecordCount": 27, + "siteName": "6FM4S4-C-766rL995aG-d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "firmware": "woorfktflkvz", + "percentageCpuUtilization": 12, + "percentageMemoryUtilization": 2, + "numberOfDisks": 4, + "totalDiskReadOperationsPerSecond": 26, + "totalDiskWriteOperationsPerSecond": 22, + "totalDiskWriteThroughput": 24, + "totalDiskReadThroughput": 25, + "macAddress": "wclsyazvbs", + "ipAddresses": [ + "vxrbbvsudurjdw" + ], + "machineId": "sbesprwyfyhkjakylaxqxisex", + "machineManagerId": "sxezccawxiemjn", + "numberOfNetworkAdapters": 10, + "networkInThroughput": 16, + "networkOutThroughput": 4, + "serverType": "spodyrxudmtwaqblembjsrzjrllzab", + "hypervisor": "g", + "hypervisorVersionNumber": "bsxlbdxpoticxrfywnvgkzdti", + "disks": [ + { + "megabytesPerSecondOfRead": 17, + "megabytesPerSecondOfWrite": 1, + "numberOfReadOperationsPerSecond": 12, + "numberOfWriteOperationsPerSecond": 16, + "maxSizeInBytes": 27, + "name": "dtseimme", + "diskType": "hisjtnwowrahejiyggw", + "lun": 26, + "path": "stmc" + } + ], + "vmFqdn": "yewqdpdjucnpokhzizezvmfjxo", + "storageInUseGb": 17, + "numberOfProcessorCore": 18, + "allocatedMemoryInMb": 28, + "operatingSystemDetails": { + "osType": "czljcy", + "osName": "nzfq", + "osVersion": "nmytttoaeifzrgiyeuaq", + "osArchitecture": "srlaxrpoc" + }, + "biosSerialNumber": "vnmmsnajxabaleyrefm", + "biosGuid": "obcnjhotsxs", + "displayName": "mesoejtxmzyqvdnaqdzvcbtyerxep", + "isDeleted": true, + "createdTimestamp": "tauehcnhmpiwnnht", + "updatedTimestamp": "jiramvswnifa", + "tags": { + "key4844": "plpc" + }, + "provisioningState": "Created" + }, + "id": "bdyfzqchyjnifsckuggxg", + "name": "sivbcctvstgxuctuocicrpudjq", + "type": "xj", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..a487ba7bad62 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Create_MaximumSet_Gen.json @@ -0,0 +1,72 @@ +{ + "title": "ImportSitesController_Create", + "operationId": "ImportSitesController_Create", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "44GV2SnONP-cPFOQ18Zmn", + "body": { + "properties": { + "discoverySolutionId": "cgwjekybxrlaunxf", + "provisioningState": "Created" + }, + "tags": { + "key592": "pj" + }, + "location": "adfizitxdfwwrkgywpqqupuhkvwie" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "discoverySolutionId": "cgwjekybxrlaunxf", + "masterSiteId": "yzppdmxpjyyzcumrtfbmsq", + "serviceEndpoint": "yvxqfmovwf", + "provisioningState": "Created" + }, + "tags": { + "key592": "pj" + }, + "location": "adfizitxdfwwrkgywpqqupuhkvwie", + "id": "uqydoqbjezmzxyxuetzzt", + "name": "czihdkszxssaxzvpogzksxyqdg", + "type": "uboeuqvybqdzsuhqjfepzircyq", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "body": { + "properties": { + "discoverySolutionId": "cgwjekybxrlaunxf", + "masterSiteId": "yzppdmxpjyyzcumrtfbmsq", + "serviceEndpoint": "yvxqfmovwf", + "provisioningState": "Created" + }, + "tags": { + "key592": "pj" + }, + "location": "adfizitxdfwwrkgywpqqupuhkvwie", + "id": "uqydoqbjezmzxyxuetzzt", + "name": "czihdkszxssaxzvpogzksxyqdg", + "type": "uboeuqvybqdzsuhqjfepzircyq", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_DeleteImportedMachines_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_DeleteImportedMachines_MaximumSet_Gen.json new file mode 100644 index 000000000000..12df539063a5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_DeleteImportedMachines_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "ImportSitesController_DeleteImportedMachines", + "operationId": "ImportSitesController_DeleteImportedMachines", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "7-5K-8-AY-", + "body": {} + }, + "responses": { + "200": { + "body": { + "jobArmId": "jmzeoqwbofyyeqpnkuhylh", + "uri": "xfvwpw", + "importType": "AzureMigrateCSV" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..c25c014aea00 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "ImportSitesController_Delete", + "operationId": "ImportSitesController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "Y-W30297U--37" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ExportUri_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ExportUri_MaximumSet_Gen.json new file mode 100644 index 000000000000..0d35d0e2f151 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ExportUri_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "ImportSitesController_ExportUri", + "operationId": "ImportSitesController_ExportUri", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "D8DY8-JKtM11-2", + "body": { + "jobArmId": "jmzeoqwbofyyeqpnkuhylh", + "uri": "xfvwpw", + "importType": "AzureMigrateCSV" + } + }, + "responses": { + "200": { + "body": { + "jobArmId": "jmzeoqwbofyyeqpnkuhylh", + "uri": "xfvwpw", + "importType": "AzureMigrateCSV" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..de581d8b293b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "ImportSitesController_Get", + "operationId": "ImportSitesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "W6Dm3H6" + }, + "responses": { + "200": { + "body": { + "properties": { + "discoverySolutionId": "cgwjekybxrlaunxf", + "masterSiteId": "yzppdmxpjyyzcumrtfbmsq", + "serviceEndpoint": "yvxqfmovwf", + "provisioningState": "Created" + }, + "tags": { + "key592": "pj" + }, + "location": "adfizitxdfwwrkgywpqqupuhkvwie", + "id": "uqydoqbjezmzxyxuetzzt", + "name": "czihdkszxssaxzvpogzksxyqdg", + "type": "uboeuqvybqdzsuhqjfepzircyq", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ImportUri_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ImportUri_MaximumSet_Gen.json new file mode 100644 index 000000000000..76b5db5e416c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ImportUri_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "ImportSitesController_ImportUri", + "operationId": "ImportSitesController_ImportUri", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "H8vtJ0EZ8J1-i", + "body": { + "jobArmId": "jmzeoqwbofyyeqpnkuhylh", + "uri": "xfvwpw", + "importType": "AzureMigrateCSV" + } + }, + "responses": { + "200": { + "body": { + "jobArmId": "jmzeoqwbofyyeqpnkuhylh", + "uri": "xfvwpw", + "importType": "AzureMigrateCSV" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ListByResourceGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..6a288ca65401 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "ImportSitesController_ListByResourceGroup", + "operationId": "ImportSitesController_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "discoverySolutionId": "cgwjekybxrlaunxf", + "masterSiteId": "yzppdmxpjyyzcumrtfbmsq", + "serviceEndpoint": "yvxqfmovwf", + "provisioningState": "Created" + }, + "tags": { + "key592": "pj" + }, + "location": "adfizitxdfwwrkgywpqqupuhkvwie", + "id": "uqydoqbjezmzxyxuetzzt", + "name": "czihdkszxssaxzvpogzksxyqdg", + "type": "uboeuqvybqdzsuhqjfepzircyq", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ListBySubscription_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..03f6be1bfad4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "ImportSitesController_ListBySubscription", + "operationId": "ImportSitesController_ListBySubscription", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "discoverySolutionId": "cgwjekybxrlaunxf", + "masterSiteId": "yzppdmxpjyyzcumrtfbmsq", + "serviceEndpoint": "yvxqfmovwf", + "provisioningState": "Created" + }, + "tags": { + "key592": "pj" + }, + "location": "adfizitxdfwwrkgywpqqupuhkvwie", + "id": "uqydoqbjezmzxyxuetzzt", + "name": "czihdkszxssaxzvpogzksxyqdg", + "type": "uboeuqvybqdzsuhqjfepzircyq", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..3080f6d7f324 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ImportSitesController_Update_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "ImportSitesController_Update", + "operationId": "ImportSitesController_Update", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "873L8-xW5-2k3q3b-", + "body": { + "tags": { + "key6528": "i" + }, + "properties": { + "discoverySolutionId": "pwqffaxl", + "provisioningState": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "discoverySolutionId": "pwqffaxl", + "masterSiteId": "yzppdmxpjyyzcumrtfbmsq", + "serviceEndpoint": "yvxqfmovwf", + "provisioningState": "Created" + }, + "tags": { + "key592": "pj" + }, + "location": "adfizitxdfwwrkgywpqqupuhkvwie", + "id": "uqydoqbjezmzxyxuetzzt", + "name": "czihdkszxssaxzvpogzksxyqdg", + "type": "uboeuqvybqdzsuhqjfepzircyq", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9663cb6bd18d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Get_MaximumSet_Gen.json @@ -0,0 +1,323 @@ +{ + "title": "MachinesController_Get", + "operationId": "MachinesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "Ihi6-KBnYM7", + "machineName": "86TJ63B5Vgd3M26-65QoE" + }, + "responses": { + "200": { + "body": { + "properties": { + "vCenterFqdn": "cmpescpbhgsnmxrcsxwv", + "vCenterId": "wxradyloaloxsllnyghsaclmewrbnv", + "instanceUuid": "fuhffrizictrpobafxiqknqlqrgtb", + "dataCenterScope": "kvjslugxvwaity", + "description": "hfllzlxanqfajvqbbhrpqxmvhdqfg", + "disks": [ + { + "uuid": "muzooprkdblkecqazarfgiebwcex", + "label": "ojhcwuqfcnjyrommcdglbkxlodroml", + "diskProvisioningPolicy": "udyaigi", + "diskScrubbingPolicy": "zz", + "diskMode": "wdiz", + "controllerType": "gyzenfpy", + "maxSizeInBytes": 27, + "name": "ljbabtqmaamrouktnzjemtc", + "diskType": "nylxgcixgdgwwkbnibylsxikyw", + "lun": 21, + "path": "hsfkjchdutmtwymurczhvti" + } + ], + "hostInMaintenanceMode": true, + "hostName": "o", + "hostPowerState": "kolpsdtodjp", + "hostVersion": "mxvrokltlfblxboogojarjd", + "networkAdapters": [ + { + "label": "itcbrvutysfhakhkdufyaz", + "adapterType": "ihuydyvskprxaderjmdreswagjbj", + "nicId": "rrlpidwk", + "macAddress": "szh", + "ipAddressList": [ + "jzaxmy" + ], + "networkName": "iyvzhrybbjqnrkea", + "ipAddressType": "scmjfjv" + } + ], + "vMwareToolsStatus": "hrxyidudgvvlkvhavbbfy", + "vMwareToolsVersion": "pthuqkfmtvfh", + "changeTrackingSupported": true, + "changeTrackingEnabled": true, + "maxSnapshots": 2, + "diskEnabledUuid": "hbwenmiur", + "numberOfSnapshots": 3, + "altGuestName": "lyuhasvbxjieivf", + "powerStatus": "iavtfltozebeqnifdhpwkhxjsxukv", + "vmFqdn": "doqhamfuavriutwirpcjynmatrld", + "vmConfigurationFileLocation": "jwlj", + "firmware": "pzblmxighglvdxqnti", + "guestOsDetails": { + "osType": "xz", + "osName": "nuntfpzdlurtmvjfkcojerqxaaos", + "osVersion": "zrtaepnbiipl", + "osArchitecture": "swwiffrahcblv" + }, + "numberOfApplications": 15, + "guestDetailsDiscoveryTimestamp": "2024-01-18T11:36:35.129Z", + "isGuestDetailsDiscoveryInProgress": true, + "dependencyMapping": "suag", + "dependencyMappingStartTime": "2024-01-18T11:36:35.129Z", + "dependencyMappingEndTime": "bhfvfpooiohbhcdcrltyk", + "runAsAccountId": "binzwkun", + "applianceNames": [ + "ybfkxzkiuoagyfrbwauwecqucmj" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applicationDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "rwncwoyzvhbumon" + }, + "dependencyMapDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "uaafojfnjso" + }, + "staticDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "mqpsmttmzspz" + }, + "sqlDiscovery": { + "successfullyDiscoveredServerCount": 29, + "totalServerCount": 29, + "sqlMetadataHydratedRunAsAccountId": "vpjtrcjjrxoe", + "sqlMetadataDiscoveryPipe": "Unknown", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "webAppDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "oracleDiscovery": { + "totalInstanceCount": 30, + "totalDatabaseCount": 25, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "springBootDiscovery": { + "totalInstanceCount": 29, + "totalApplicationCount": 1, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "iisDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "tomcatDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "numberOfProcessorCore": 11, + "allocatedMemoryInMb": 5, + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "biosSerialNumber": "kxcdsubztetlymkfn", + "biosGuid": "lybgyfmrkoo", + "displayName": "ak", + "isDeleted": true, + "createdTimestamp": "udgiptqhkfwjthqwtoushkggxb", + "tags": { + "key9471": "adkpk" + }, + "updatedTimestamp": "dsezkmxdwojrmkpqekctoyatww", + "provisioningState": "Created" + }, + "id": "khmdtjnd", + "name": "zxvenxnnzjqejtdicby", + "type": "zsdcnhqmxgxxc", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_ListByVmwareSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_ListByVmwareSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..f010eeb99fd7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_ListByVmwareSite_MaximumSet_Gen.json @@ -0,0 +1,331 @@ +{ + "title": "MachinesController_ListByVmwareSite", + "operationId": "MachinesController_ListByVmwareSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "egytgnpufkqhunosrhrcdvqvk", + "top": 8, + "continuationToken": "boqasfzzicsvczzgbvp", + "totalRecordCount": 21, + "siteName": "5P-X15WfEPa08" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vCenterFqdn": "cmpescpbhgsnmxrcsxwv", + "vCenterId": "wxradyloaloxsllnyghsaclmewrbnv", + "instanceUuid": "fuhffrizictrpobafxiqknqlqrgtb", + "dataCenterScope": "kvjslugxvwaity", + "description": "hfllzlxanqfajvqbbhrpqxmvhdqfg", + "disks": [ + { + "uuid": "muzooprkdblkecqazarfgiebwcex", + "label": "ojhcwuqfcnjyrommcdglbkxlodroml", + "diskProvisioningPolicy": "udyaigi", + "diskScrubbingPolicy": "zz", + "diskMode": "wdiz", + "controllerType": "gyzenfpy", + "maxSizeInBytes": 27, + "name": "ljbabtqmaamrouktnzjemtc", + "diskType": "nylxgcixgdgwwkbnibylsxikyw", + "lun": 21, + "path": "hsfkjchdutmtwymurczhvti" + } + ], + "hostInMaintenanceMode": true, + "hostName": "o", + "hostPowerState": "kolpsdtodjp", + "hostVersion": "mxvrokltlfblxboogojarjd", + "networkAdapters": [ + { + "label": "itcbrvutysfhakhkdufyaz", + "adapterType": "ihuydyvskprxaderjmdreswagjbj", + "nicId": "rrlpidwk", + "macAddress": "szh", + "ipAddressList": [ + "jzaxmy" + ], + "networkName": "iyvzhrybbjqnrkea", + "ipAddressType": "scmjfjv" + } + ], + "vMwareToolsStatus": "hrxyidudgvvlkvhavbbfy", + "vMwareToolsVersion": "pthuqkfmtvfh", + "changeTrackingSupported": true, + "changeTrackingEnabled": true, + "maxSnapshots": 2, + "diskEnabledUuid": "hbwenmiur", + "numberOfSnapshots": 3, + "altGuestName": "lyuhasvbxjieivf", + "powerStatus": "iavtfltozebeqnifdhpwkhxjsxukv", + "vmFqdn": "doqhamfuavriutwirpcjynmatrld", + "vmConfigurationFileLocation": "jwlj", + "firmware": "pzblmxighglvdxqnti", + "guestOsDetails": { + "osType": "xz", + "osName": "nuntfpzdlurtmvjfkcojerqxaaos", + "osVersion": "zrtaepnbiipl", + "osArchitecture": "swwiffrahcblv" + }, + "numberOfApplications": 15, + "guestDetailsDiscoveryTimestamp": "2024-01-18T11:36:35.129Z", + "isGuestDetailsDiscoveryInProgress": true, + "dependencyMapping": "suag", + "dependencyMappingStartTime": "2024-01-18T11:36:35.129Z", + "dependencyMappingEndTime": "bhfvfpooiohbhcdcrltyk", + "runAsAccountId": "binzwkun", + "applianceNames": [ + "ybfkxzkiuoagyfrbwauwecqucmj" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applicationDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "rwncwoyzvhbumon" + }, + "dependencyMapDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "uaafojfnjso" + }, + "staticDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "mqpsmttmzspz" + }, + "sqlDiscovery": { + "successfullyDiscoveredServerCount": 29, + "totalServerCount": 29, + "sqlMetadataHydratedRunAsAccountId": "vpjtrcjjrxoe", + "sqlMetadataDiscoveryPipe": "Unknown", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "webAppDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "oracleDiscovery": { + "totalInstanceCount": 30, + "totalDatabaseCount": 25, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "springBootDiscovery": { + "totalInstanceCount": 29, + "totalApplicationCount": 1, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "iisDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "tomcatDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "numberOfProcessorCore": 11, + "allocatedMemoryInMb": 5, + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "biosSerialNumber": "kxcdsubztetlymkfn", + "biosGuid": "lybgyfmrkoo", + "displayName": "ak", + "isDeleted": true, + "createdTimestamp": "udgiptqhkfwjthqwtoushkggxb", + "tags": { + "key9471": "adkpk" + }, + "updatedTimestamp": "dsezkmxdwojrmkpqekctoyatww", + "provisioningState": "Created" + }, + "id": "khmdtjnd", + "name": "zxvenxnnzjqejtdicby", + "type": "zsdcnhqmxgxxc", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/aqxmwv" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Start_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Start_MaximumSet_Gen.json new file mode 100644 index 000000000000..2860bd338e7d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Start_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "MachinesController_Start", + "operationId": "MachinesController_Start", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "T85s-9-eBX", + "machineName": "OjcCY-5KoYP--uRg8J-NIW" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Stop_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Stop_MaximumSet_Gen.json new file mode 100644 index 000000000000..014b78e81d2b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Stop_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "MachinesController_Stop", + "operationId": "MachinesController_Stop", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-55D03vr8O-I-Q5", + "machineName": "t200-F5G-3V6" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..72c39ce5a44b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MachinesController_Update_MaximumSet_Gen.json @@ -0,0 +1,349 @@ +{ + "title": "MachinesController_Update", + "operationId": "MachinesController_Update", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "3N24-", + "machineName": "a6-8UYCOk-", + "body": { + "properties": { + "firmware": "raqixesvqmegpansongqje", + "runAsAccountId": "rxvwltgjjzoqvmrojv", + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "numberOfProcessorCore": 19, + "allocatedMemoryInMb": 25, + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "biosSerialNumber": "ldjfzv", + "biosGuid": "kwkxophhlurfasscw", + "tags": { + "key8241": "buqgbixvhiqpxs" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "vCenterFqdn": "cmpescpbhgsnmxrcsxwv", + "vCenterId": "wxradyloaloxsllnyghsaclmewrbnv", + "instanceUuid": "fuhffrizictrpobafxiqknqlqrgtb", + "dataCenterScope": "kvjslugxvwaity", + "description": "hfllzlxanqfajvqbbhrpqxmvhdqfg", + "disks": [ + { + "uuid": "muzooprkdblkecqazarfgiebwcex", + "label": "ojhcwuqfcnjyrommcdglbkxlodroml", + "diskProvisioningPolicy": "udyaigi", + "diskScrubbingPolicy": "zz", + "diskMode": "wdiz", + "controllerType": "gyzenfpy", + "maxSizeInBytes": 27, + "name": "ljbabtqmaamrouktnzjemtc", + "diskType": "nylxgcixgdgwwkbnibylsxikyw", + "lun": 21, + "path": "hsfkjchdutmtwymurczhvti" + } + ], + "hostInMaintenanceMode": true, + "hostName": "o", + "hostPowerState": "kolpsdtodjp", + "hostVersion": "mxvrokltlfblxboogojarjd", + "networkAdapters": [ + { + "label": "itcbrvutysfhakhkdufyaz", + "adapterType": "ihuydyvskprxaderjmdreswagjbj", + "nicId": "rrlpidwk", + "macAddress": "szh", + "ipAddressList": [ + "jzaxmy" + ], + "networkName": "iyvzhrybbjqnrkea", + "ipAddressType": "scmjfjv" + } + ], + "vMwareToolsStatus": "hrxyidudgvvlkvhavbbfy", + "vMwareToolsVersion": "pthuqkfmtvfh", + "changeTrackingSupported": true, + "changeTrackingEnabled": true, + "maxSnapshots": 2, + "diskEnabledUuid": "hbwenmiur", + "numberOfSnapshots": 3, + "altGuestName": "lyuhasvbxjieivf", + "powerStatus": "iavtfltozebeqnifdhpwkhxjsxukv", + "vmFqdn": "doqhamfuavriutwirpcjynmatrld", + "vmConfigurationFileLocation": "jwlj", + "firmware": "raqixesvqmegpansongqje", + "guestOsDetails": { + "osType": "xz", + "osName": "nuntfpzdlurtmvjfkcojerqxaaos", + "osVersion": "zrtaepnbiipl", + "osArchitecture": "swwiffrahcblv" + }, + "numberOfApplications": 15, + "guestDetailsDiscoveryTimestamp": "2024-01-18T11:36:35.129Z", + "isGuestDetailsDiscoveryInProgress": true, + "dependencyMapping": "suag", + "dependencyMappingStartTime": "2024-01-18T11:36:35.129Z", + "dependencyMappingEndTime": "bhfvfpooiohbhcdcrltyk", + "runAsAccountId": "rxvwltgjjzoqvmrojv", + "applianceNames": [ + "ybfkxzkiuoagyfrbwauwecqucmj" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applicationDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "rwncwoyzvhbumon" + }, + "dependencyMapDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "uaafojfnjso" + }, + "staticDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "mqpsmttmzspz" + }, + "sqlDiscovery": { + "successfullyDiscoveredServerCount": 29, + "totalServerCount": 29, + "sqlMetadataHydratedRunAsAccountId": "vpjtrcjjrxoe", + "sqlMetadataDiscoveryPipe": "Unknown", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "webAppDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "oracleDiscovery": { + "totalInstanceCount": 30, + "totalDatabaseCount": 25, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "springBootDiscovery": { + "totalInstanceCount": 29, + "totalApplicationCount": 1, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "iisDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "tomcatDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "numberOfProcessorCore": 19, + "allocatedMemoryInMb": 25, + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "biosSerialNumber": "ldjfzv", + "biosGuid": "kwkxophhlurfasscw", + "displayName": "ak", + "isDeleted": true, + "createdTimestamp": "udgiptqhkfwjthqwtoushkggxb", + "tags": { + "key9471": "adkpk" + }, + "updatedTimestamp": "dsezkmxdwojrmkpqekctoyatww", + "provisioningState": "Created" + }, + "id": "khmdtjnd", + "name": "zxvenxnnzjqejtdicby", + "type": "zsdcnhqmxgxxc", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..8eda1d512025 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Create_MaximumSet_Gen.json @@ -0,0 +1,150 @@ +{ + "title": "MasterSitesController_Create", + "operationId": "MasterSitesController_Create", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "4Y-BY-44e-2fDcKpH-E5", + "body": { + "properties": { + "publicNetworkAccess": "NotSpecified", + "allowMultipleSites": true, + "sites": [ + "lzbawsokqsbzpsocpiwbsjxf" + ], + "customerStorageAccountArmId": "tndgdhvguaaa", + "provisioningState": "Created" + }, + "tags": { + "key5556": "htomzlbxaiqgcmaaq" + }, + "location": "g" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publicNetworkAccess": "NotSpecified", + "allowMultipleSites": true, + "sites": [ + "lzbawsokqsbzpsocpiwbsjxf" + ], + "customerStorageAccountArmId": "tndgdhvguaaa", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "ozywlbzynyatnhapsydahzdyshnd" + ], + "provisioningState": "Created", + "privateEndpoint": { + "id": "hhdeufnbymohihfgrf" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "zieisbmqzndfwsnt", + "actionsRequired": "easeoi" + } + }, + "id": "mwkzomhdlncxxzjtjhixofmjvss", + "name": "yjvkdkdcs", + "type": "kusqarhayhcv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nestedSites": [ + "qcanqsnkspyoclarnaczr" + ], + "provisioningState": "Created" + }, + "tags": { + "key5556": "htomzlbxaiqgcmaaq" + }, + "location": "g", + "id": "kbhgwjcundm", + "name": "yrxubv", + "type": "iqdioktjdnpynwjrffyk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "publicNetworkAccess": "NotSpecified", + "allowMultipleSites": true, + "sites": [ + "lzbawsokqsbzpsocpiwbsjxf" + ], + "customerStorageAccountArmId": "tndgdhvguaaa", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "ozywlbzynyatnhapsydahzdyshnd" + ], + "provisioningState": "Created", + "privateEndpoint": { + "id": "hhdeufnbymohihfgrf" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "zieisbmqzndfwsnt", + "actionsRequired": "easeoi" + } + }, + "id": "mwkzomhdlncxxzjtjhixofmjvss", + "name": "yjvkdkdcs", + "type": "kusqarhayhcv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nestedSites": [ + "qcanqsnkspyoclarnaczr" + ], + "provisioningState": "Created" + }, + "tags": { + "key5556": "htomzlbxaiqgcmaaq" + }, + "location": "g", + "id": "kbhgwjcundm", + "name": "yrxubv", + "type": "iqdioktjdnpynwjrffyk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..1b4bfe8b6c11 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "MasterSitesController_Delete", + "operationId": "MasterSitesController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "ICJR0F6JRI" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_ErrorSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_ErrorSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..6eb25b5fcdd4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_ErrorSummary_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "MasterSitesController_ErrorSummary", + "operationId": "MasterSitesController_ErrorSummary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "PHm3EiH368dq324-j7N", + "body": { + "applianceName": "gzmhffsahpaizswhjd" + } + }, + "responses": { + "200": { + "body": { + "applianceName": "rnwdayyamnbf", + "discoveryScopeErrorSummaries": { + "affectedResourceType": "eogpdpyddhvnf", + "affectedObjectsCount": 13, + "discoveryScope": "AppsAndRoles" + }, + "nextLink": "nctyxej" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..68a733b61e06 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Get_MaximumSet_Gen.json @@ -0,0 +1,72 @@ +{ + "title": "Method to get a master site.", + "operationId": "MasterSitesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "ATsMK6XNqy-R4h9O8V1T8Jh" + }, + "responses": { + "200": { + "body": { + "properties": { + "publicNetworkAccess": "NotSpecified", + "allowMultipleSites": true, + "sites": [ + "lzbawsokqsbzpsocpiwbsjxf" + ], + "customerStorageAccountArmId": "tndgdhvguaaa", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "ozywlbzynyatnhapsydahzdyshnd" + ], + "provisioningState": "Created", + "privateEndpoint": { + "id": "hhdeufnbymohihfgrf" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "zieisbmqzndfwsnt", + "actionsRequired": "easeoi" + } + }, + "id": "mwkzomhdlncxxzjtjhixofmjvss", + "name": "yjvkdkdcs", + "type": "kusqarhayhcv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nestedSites": [ + "qcanqsnkspyoclarnaczr" + ], + "provisioningState": "Created" + }, + "tags": { + "key5556": "htomzlbxaiqgcmaaq" + }, + "location": "g", + "id": "kbhgwjcundm", + "name": "yrxubv", + "type": "iqdioktjdnpynwjrffyk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_ListByResourceGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..0ee840d6f013 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "Get all sites.", + "operationId": "MasterSitesController_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "publicNetworkAccess": "NotSpecified", + "allowMultipleSites": true, + "sites": [ + "lzbawsokqsbzpsocpiwbsjxf" + ], + "customerStorageAccountArmId": "tndgdhvguaaa", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "ozywlbzynyatnhapsydahzdyshnd" + ], + "provisioningState": "Created", + "privateEndpoint": { + "id": "hhdeufnbymohihfgrf" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "zieisbmqzndfwsnt", + "actionsRequired": "easeoi" + } + }, + "id": "mwkzomhdlncxxzjtjhixofmjvss", + "name": "yjvkdkdcs", + "type": "kusqarhayhcv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nestedSites": [ + "qcanqsnkspyoclarnaczr" + ], + "provisioningState": "Created" + }, + "tags": { + "key5556": "htomzlbxaiqgcmaaq" + }, + "location": "g", + "id": "kbhgwjcundm", + "name": "yrxubv", + "type": "iqdioktjdnpynwjrffyk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_ListBySubscription_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..7273cdbd9b76 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "title": "Get all the sites in the subscription.", + "operationId": "MasterSitesController_ListBySubscription", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "publicNetworkAccess": "NotSpecified", + "allowMultipleSites": true, + "sites": [ + "lzbawsokqsbzpsocpiwbsjxf" + ], + "customerStorageAccountArmId": "tndgdhvguaaa", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "ozywlbzynyatnhapsydahzdyshnd" + ], + "provisioningState": "Created", + "privateEndpoint": { + "id": "hhdeufnbymohihfgrf" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "zieisbmqzndfwsnt", + "actionsRequired": "easeoi" + } + }, + "id": "mwkzomhdlncxxzjtjhixofmjvss", + "name": "yjvkdkdcs", + "type": "kusqarhayhcv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nestedSites": [ + "qcanqsnkspyoclarnaczr" + ], + "provisioningState": "Created" + }, + "tags": { + "key5556": "htomzlbxaiqgcmaaq" + }, + "location": "g", + "id": "kbhgwjcundm", + "name": "yrxubv", + "type": "iqdioktjdnpynwjrffyk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..ce9976084555 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesController_Update_MaximumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "title": "MasterSitesController_Update", + "operationId": "MasterSitesController_Update", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "06OFZ8T18n-8W31Iw-2c46x", + "properties": { + "tags": { + "key1664": "tibpubkzsw" + }, + "properties": { + "publicNetworkAccess": "NotSpecified", + "allowMultipleSites": true, + "sites": [ + "w" + ], + "customerStorageAccountArmId": "opgwuzsibguavfkuxeism" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publicNetworkAccess": "NotSpecified", + "allowMultipleSites": true, + "sites": [ + "w" + ], + "customerStorageAccountArmId": "tndgdhvguaaa", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "ozywlbzynyatnhapsydahzdyshnd" + ], + "provisioningState": "Created", + "privateEndpoint": { + "id": "hhdeufnbymohihfgrf" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "zieisbmqzndfwsnt", + "actionsRequired": "easeoi" + } + }, + "id": "mwkzomhdlncxxzjtjhixofmjvss", + "name": "yjvkdkdcs", + "type": "kusqarhayhcv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nestedSites": [ + "qcanqsnkspyoclarnaczr" + ], + "provisioningState": "Created" + }, + "tags": { + "key5556": "htomzlbxaiqgcmaaq" + }, + "location": "g", + "id": "kbhgwjcundm", + "name": "yrxubv", + "type": "iqdioktjdnpynwjrffyk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesOperationsStatusController_GetVmwareOperationStatus_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesOperationsStatusController_GetVmwareOperationStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..45a1e98b7439 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/MasterSitesOperationsStatusController_GetVmwareOperationStatus_MaximumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "title": "MasterSitesOperationsStatusController_GetVmwareOperationStatus", + "operationId": "MasterSitesOperationsStatusController_GetVmwareOperationStatus", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "vW2-X", + "operationStatusName": "t8D5-5X1b-T-p39S" + }, + "responses": { + "200": { + "body": { + "id": "p", + "name": "bcvvgkxeeavuxwhhcuhlr", + "status": "xdwtanilfmuuhjnanaxclrds", + "startTime": "dqgff", + "endTime": "putnpglwoqfdhjkk", + "error": { + "code": "rnsnhdowwptegdldklx", + "message": "qolsunkhecgpjxm" + }, + "properties": { + "result": "wvhlgcgdktttlozc" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..829e175945ee --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rirowuguhyghsnzcfh", + "isDataAction": true, + "display": { + "provider": "fzjmidcdjoly", + "resource": "ftzbijusfzskmnxwdryo", + "operation": "ofoboeogptqlreykdtoabr", + "description": "hwwiuvhojgkatidwxligzgtyptosma" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "rw" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..7ffc42e9fe1f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_Create_MaximumSet_Gen.json @@ -0,0 +1,82 @@ +{ + "title": "PrivateEndpointConnectionController_Create", + "operationId": "PrivateEndpointConnectionController_Create", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-4k3gsPqU5Y3", + "peConnectionName": "Q3Y7-B-E80QLei7BHb337-P", + "body": { + "properties": { + "provisioningState": "Created", + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "zieisbmqzndfwsnt", + "actionsRequired": "easeoi" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "groupIds": [ + "ozywlbzynyatnhapsydahzdyshnd" + ], + "provisioningState": "Created", + "privateEndpoint": { + "id": "hhdeufnbymohihfgrf" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "zieisbmqzndfwsnt", + "actionsRequired": "easeoi" + } + }, + "id": "mwkzomhdlncxxzjtjhixofmjvss", + "name": "yjvkdkdcs", + "type": "kusqarhayhcv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "body": { + "properties": { + "groupIds": [ + "ozywlbzynyatnhapsydahzdyshnd" + ], + "provisioningState": "Created", + "privateEndpoint": { + "id": "hhdeufnbymohihfgrf" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "zieisbmqzndfwsnt", + "actionsRequired": "easeoi" + } + }, + "id": "mwkzomhdlncxxzjtjhixofmjvss", + "name": "yjvkdkdcs", + "type": "kusqarhayhcv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..9340261c8f3d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "PrivateEndpointConnectionController_Delete", + "operationId": "PrivateEndpointConnectionController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "EX1T446-w-1zPD", + "peConnectionName": "M6--1rGB2" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ab278f35d103 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnectionController_Get", + "operationId": "PrivateEndpointConnectionController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "L8PW6X1249-d-J-POh1N", + "peConnectionName": "O21gr1J6pN" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupIds": [ + "ozywlbzynyatnhapsydahzdyshnd" + ], + "provisioningState": "Created", + "privateEndpoint": { + "id": "hhdeufnbymohihfgrf" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "zieisbmqzndfwsnt", + "actionsRequired": "easeoi" + } + }, + "id": "mwkzomhdlncxxzjtjhixofmjvss", + "name": "yjvkdkdcs", + "type": "kusqarhayhcv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_ListByMasterSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_ListByMasterSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..e718b0b7a67e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateEndpointConnectionController_ListByMasterSite_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "PrivateEndpointConnectionController_ListByMasterSite", + "operationId": "PrivateEndpointConnectionController_ListByMasterSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-K7D3lyd0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupIds": [ + "ozywlbzynyatnhapsydahzdyshnd" + ], + "provisioningState": "Created", + "privateEndpoint": { + "id": "hhdeufnbymohihfgrf" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "zieisbmqzndfwsnt", + "actionsRequired": "easeoi" + } + }, + "id": "mwkzomhdlncxxzjtjhixofmjvss", + "name": "yjvkdkdcs", + "type": "kusqarhayhcv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateLinkResourcesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateLinkResourcesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..542e3de05423 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateLinkResourcesController_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "PrivateLinkResourcesController_Get", + "operationId": "PrivateLinkResourcesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "8tU8Q--c4-1sP3Bxi", + "privateLinkResourceName": "-G-B5--Y714-SZ2" + }, + "responses": { + "200": { + "body": { + "properties": { + "requiredMembers": [ + "yjhaswysdhsqfnnt" + ], + "requiredZoneNames": [ + "hfpicfh" + ], + "groupId": "uwgzgr", + "provisioningState": "Created" + }, + "id": "bt", + "name": "ahkixrt", + "type": "ltlotwqsc", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateLinkResourcesController_ListByMasterSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateLinkResourcesController_ListByMasterSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..8c6974ab2a89 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/PrivateLinkResourcesController_ListByMasterSite_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateLinkResourcesController_ListByMasterSite", + "operationId": "PrivateLinkResourcesController_ListByMasterSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "07575kPYDYD7--" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "requiredMembers": [ + "yjhaswysdhsqfnnt" + ], + "requiredZoneNames": [ + "hfpicfh" + ], + "groupId": "uwgzgr", + "provisioningState": "Created" + }, + "id": "bt", + "name": "ahkixrt", + "type": "ltlotwqsc", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/al" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/RunAsAccountsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/RunAsAccountsController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..58025212c777 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/RunAsAccountsController_Get_MaximumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "title": "RunAsAccountsController_Get", + "operationId": "RunAsAccountsController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "Oe7P-4-", + "accountName": "R9sMJ-CKk54Jl15Q" + }, + "responses": { + "200": { + "body": { + "properties": { + "displayName": "jisgaadoxsjdfbz", + "credentialType": "zjlboeqftmfeafhmaf", + "createdTimestamp": "wgrjz", + "updatedTimestamp": "lqvvxyngsjskvx", + "applianceName": "fbicoeqjjfpfpadaewfuea", + "provisioningState": "Created" + }, + "id": "qajaoanslbhqiwcucowewwj", + "name": "bfbtg", + "type": "jearzcqiyldpkefkgvtgdjcs", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/RunAsAccountsController_ListByVmwareSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/RunAsAccountsController_ListByVmwareSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..15d2b9d2f1de --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/RunAsAccountsController_ListByVmwareSite_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "RunAsAccountsController_ListByVmwareSite", + "operationId": "RunAsAccountsController_ListByVmwareSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "1UyI-LBP-8-HB-X0pi-IK2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "jisgaadoxsjdfbz", + "credentialType": "zjlboeqftmfeafhmaf", + "createdTimestamp": "wgrjz", + "updatedTimestamp": "lqvvxyngsjskvx", + "applianceName": "fbicoeqjjfpfpadaewfuea", + "provisioningState": "Created" + }, + "id": "qajaoanslbhqiwcucowewwj", + "name": "bfbtg", + "type": "jearzcqiyldpkefkgvtgdjcs", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_ClientGroupMembers_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_ClientGroupMembers_MaximumSet_Gen.json new file mode 100644 index 000000000000..041b8824bfd4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_ClientGroupMembers_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "title": "ServerDependencyMapController_ClientGroupMembers", + "operationId": "ServerDependencyMapController_ClientGroupMembers", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "70h8--WL95QGnCS8H", + "mapRequest": { + "machineId": "zbsqaglovhnxlroparbdzfs", + "processGroupName": "lawalpbrzupvjeglgvluyjtvijnqcj", + "processName": "ygqxfpuvfsiiotyxveq", + "startTime": "2024-01-18T11:33:08.082Z", + "endTime": "2024-01-18T11:33:08.082Z", + "filters": { + "machineIds": [ + "nokzgytxl" + ], + "processIds": [ + "pxbqhupqqlwgta" + ] + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_ExportDependencies_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_ExportDependencies_MaximumSet_Gen.json new file mode 100644 index 000000000000..663e37e1598f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_ExportDependencies_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "ServerDependencyMapController_ExportDependencies", + "operationId": "ServerDependencyMapController_ExportDependencies", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "5Q7SK-Uu5-87-vRN21", + "requestBody": { + "startTime": "2024-01-18T11:33:13.789Z", + "endTime": "2024-01-18T11:33:13.789Z" + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json new file mode 100644 index 000000000000..5a797ae62195 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "ServerDependencyMapController_GenerateCoarseMap", + "operationId": "ServerDependencyMapController_GenerateCoarseMap", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "--0-0Qy95bgI-457", + "mapRequest": { + "startTime": "2024-01-18T11:33:15.220Z", + "endTime": "2024-01-18T11:33:15.220Z", + "filters": { + "machineIds": [ + "nokzgytxl" + ], + "processIds": [ + "pxbqhupqqlwgta" + ] + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json new file mode 100644 index 000000000000..cdb43af97ac2 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "ServerDependencyMapController_GenerateDetailedMap", + "operationId": "ServerDependencyMapController_GenerateDetailedMap", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "k--P3", + "mapRequest": { + "machineId": "mqiazddot", + "startTime": "2024-01-18T11:33:15.874Z", + "endTime": "2024-01-18T11:33:15.874Z", + "filters": { + "machineIds": [ + "nokzgytxl" + ], + "processIds": [ + "pxbqhupqqlwgta" + ] + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_ServerGroupMembers_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_ServerGroupMembers_MaximumSet_Gen.json new file mode 100644 index 000000000000..84b55a80fbd7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerDependencyMapController_ServerGroupMembers_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "ServerDependencyMapController_ServerGroupMembers", + "operationId": "ServerDependencyMapController_ServerGroupMembers", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "iM05uh-m22r3012Jj7L1", + "mapRequest": { + "serverPort": 27, + "startTime": "2024-01-18T11:33:31.988Z", + "endTime": "2024-01-18T11:33:31.988Z", + "filters": { + "machineIds": [ + "nokzgytxl" + ], + "processIds": [ + "pxbqhupqqlwgta" + ] + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerJobsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerJobsController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..7d188afb0826 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerJobsController_Get_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "ServerJobsController_Get", + "operationId": "ServerJobsController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "6qN92n-h-3W-13-6-X4", + "jobName": "aS9X-4S8B41vbY79H5-" + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "gxgsmdmtocrmbnlsibksntnxfkoiu", + "startTime": "bnnddbgspizwnkwvvkvqhq", + "endTime": "cpouxxkikfjodgjvi", + "displayName": "jejisdzsezzotlmz", + "clientRequestId": "xtnxy", + "activityId": "dthzzprqvnkghxnca", + "errors": [ + { + "code": "iciy", + "message": "vpyszfmstisopihrrbbvf", + "possibleCauses": "sxrbjrrtqqljdgoe", + "recommendedAction": "osjxpjudgrlxepabiceakjcvmvvr", + "severity": "veqcqcmibgrabvajtvfzeyrb", + "isAgentReportedError": true, + "agentErrorCode": "bih", + "agentErrorMessage": "ryloaagexndkeuyrmuknxlunp", + "agentErrorPossibleCauses": "ehelidlosla", + "agentErrorRecommendedAction": "wgdq" + } + ], + "provisioningState": "Created" + }, + "id": "kcwctvse", + "name": "gwxeplr", + "type": "oqjp", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerJobsController_ListByServerSiteResource_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerJobsController_ListByServerSiteResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..9b224afc3868 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerJobsController_ListByServerSiteResource_MaximumSet_Gen.json @@ -0,0 +1,55 @@ +{ + "title": "ServerJobsController_ListByServerSiteResource", + "operationId": "ServerJobsController_ListByServerSiteResource", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "56-7-" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "status": "gxgsmdmtocrmbnlsibksntnxfkoiu", + "startTime": "bnnddbgspizwnkwvvkvqhq", + "endTime": "cpouxxkikfjodgjvi", + "displayName": "jejisdzsezzotlmz", + "clientRequestId": "xtnxy", + "activityId": "dthzzprqvnkghxnca", + "errors": [ + { + "code": "iciy", + "message": "vpyszfmstisopihrrbbvf", + "possibleCauses": "sxrbjrrtqqljdgoe", + "recommendedAction": "osjxpjudgrlxepabiceakjcvmvvr", + "severity": "veqcqcmibgrabvajtvfzeyrb", + "isAgentReportedError": true, + "agentErrorCode": "bih", + "agentErrorMessage": "ryloaagexndkeuyrmuknxlunp", + "agentErrorPossibleCauses": "ehelidlosla", + "agentErrorRecommendedAction": "wgdq" + } + ], + "provisioningState": "Created" + }, + "id": "kcwctvse", + "name": "gwxeplr", + "type": "oqjp", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerOperationsStatusController_GetServerSiteOperationsStatus_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerOperationsStatusController_GetServerSiteOperationsStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..702acb1afc90 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerOperationsStatusController_GetServerSiteOperationsStatus_MaximumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "title": "ServerOperationsStatusController_GetServerSiteOperationsStatus", + "operationId": "ServerOperationsStatusController_GetServerSiteOperationsStatus", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "ZDxb5o", + "operationStatusName": "N-e--8-" + }, + "responses": { + "200": { + "body": { + "id": "p", + "name": "bcvvgkxeeavuxwhhcuhlr", + "status": "xdwtanilfmuuhjnanaxclrds", + "startTime": "dqgff", + "endTime": "putnpglwoqfdhjkk", + "error": { + "code": "rnsnhdowwptegdldklx", + "message": "qolsunkhecgpjxm" + }, + "properties": { + "result": "wvhlgcgdktttlozc" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerRunAsAccountsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerRunAsAccountsController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..890d73d18a59 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerRunAsAccountsController_Get_MaximumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "title": "ServerRunAsAccountsController_Get", + "operationId": "ServerRunAsAccountsController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-JS187-", + "accountName": "ER-0o2" + }, + "responses": { + "200": { + "body": { + "properties": { + "displayName": "jisgaadoxsjdfbz", + "credentialType": "zjlboeqftmfeafhmaf", + "createdTimestamp": "wgrjz", + "updatedTimestamp": "lqvvxyngsjskvx", + "applianceName": "fbicoeqjjfpfpadaewfuea", + "provisioningState": "Created" + }, + "id": "qdvhkca", + "name": "pjkpbgzhfaerfnkjbvgqsn", + "type": "stwzyyyesvjmsiqjbcprvmubnbzomp", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerRunAsAccountsController_ListByServerSiteResource_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerRunAsAccountsController_ListByServerSiteResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..2c96643d808d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerRunAsAccountsController_ListByServerSiteResource_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "ServerRunAsAccountsController_ListByServerSiteResource", + "operationId": "ServerRunAsAccountsController_ListByServerSiteResource", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "7-57Q14-4r1q4LZk-FIGMC9Q" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "jisgaadoxsjdfbz", + "credentialType": "zjlboeqftmfeafhmaf", + "createdTimestamp": "wgrjz", + "updatedTimestamp": "lqvvxyngsjskvx", + "applianceName": "fbicoeqjjfpfpadaewfuea", + "provisioningState": "Created" + }, + "id": "qdvhkca", + "name": "pjkpbgzhfaerfnkjbvgqsn", + "type": "stwzyyyesvjmsiqjbcprvmubnbzomp", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ComputeErrorSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ComputeErrorSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..91a3f409e1f4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ComputeErrorSummary_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "ServerSitesController_ComputeErrorSummary", + "operationId": "ServerSitesController_ComputeErrorSummary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "0-4dC0E25t64T-O48-lUQd2", + "body": {} + }, + "responses": { + "200": { + "body": { + "applianceName": "rnwdayyamnbf", + "discoveryScopeErrorSummaries": { + "affectedResourceType": "eogpdpyddhvnf", + "affectedObjectsCount": 13, + "discoveryScope": "AppsAndRoles" + }, + "nextLink": "nctyxej" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Computeusage_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Computeusage_MaximumSet_Gen.json new file mode 100644 index 000000000000..64842a262ef0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Computeusage_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "ServerSitesController_Computeusage", + "operationId": "ServerSitesController_Computeusage", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "55T12-uH60IK-Yc01", + "body": {} + }, + "responses": { + "200": { + "body": { + "runAsAccounts": 5, + "serverCount": 7 + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..dcce741be3de --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Create_MaximumSet_Gen.json @@ -0,0 +1,120 @@ +{ + "title": "ServerSitesController_Create", + "operationId": "ServerSitesController_Create", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "W28q433h1-", + "body": { + "properties": { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "nhhwywytwjbhjtpwxkcxqhqmcrowg", + "discoverySolutionId": "dlsekq", + "provisioningState": "Created" + }, + "tags": { + "key8004": "abecvbhselathbrca" + }, + "location": "rutllgppwqgtiklewhuesohgqb" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "masterSiteId": "ahunubnc", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "nhhwywytwjbhjtpwxkcxqhqmcrowg", + "discoverySolutionId": "dlsekq", + "serviceEndpoint": "vxijveylysmmvjhspcneiyasunnaw", + "provisioningState": "Created" + }, + "tags": { + "key8004": "abecvbhselathbrca" + }, + "location": "rutllgppwqgtiklewhuesohgqb", + "id": "csrblruhgnnlqkatvm", + "name": "dtxwymqbsjfjr", + "type": "esvkyamqbxqueijrhetxciydcbxfaa", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "masterSiteId": "ahunubnc", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "nhhwywytwjbhjtpwxkcxqhqmcrowg", + "discoverySolutionId": "dlsekq", + "serviceEndpoint": "vxijveylysmmvjhspcneiyasunnaw", + "provisioningState": "Created" + }, + "tags": { + "key8004": "abecvbhselathbrca" + }, + "location": "rutllgppwqgtiklewhuesohgqb", + "id": "csrblruhgnnlqkatvm", + "name": "dtxwymqbsjfjr", + "type": "esvkyamqbxqueijrhetxciydcbxfaa", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..9f90cbdbe350 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "ServerSitesController_Delete", + "operationId": "ServerSitesController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-1415-x7L-i-iVWkP8" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ExportApplications_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ExportApplications_MaximumSet_Gen.json new file mode 100644 index 000000000000..928bb56b9e26 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ExportApplications_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "ServerSitesController_ExportApplications", + "operationId": "ServerSitesController_ExportApplications", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "UjMNKI-q-V", + "body": {} + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ExportMachineErrors_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ExportMachineErrors_MaximumSet_Gen.json new file mode 100644 index 000000000000..07f9bc242b35 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ExportMachineErrors_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "ServerSitesController_ExportMachineErrors", + "operationId": "ServerSitesController_ExportMachineErrors", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "JZTs--1-D64-T8-URG", + "body": { + "properties": { + "discoveryScope": "AppsAndRoles" + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e338dd223f89 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Get_MaximumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "title": "ServerSitesController_Get", + "operationId": "ServerSitesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "9-3-Svn1P2" + }, + "responses": { + "200": { + "body": { + "properties": { + "masterSiteId": "ahunubnc", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "nhhwywytwjbhjtpwxkcxqhqmcrowg", + "discoverySolutionId": "dlsekq", + "serviceEndpoint": "vxijveylysmmvjhspcneiyasunnaw", + "provisioningState": "Created" + }, + "tags": { + "key8004": "abecvbhselathbrca" + }, + "location": "rutllgppwqgtiklewhuesohgqb", + "id": "csrblruhgnnlqkatvm", + "name": "dtxwymqbsjfjr", + "type": "esvkyamqbxqueijrhetxciydcbxfaa", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ListByResourceGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..8106fc9202c8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "ServerSitesController_ListByResourceGroup", + "operationId": "ServerSitesController_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "masterSiteId": "ahunubnc", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "nhhwywytwjbhjtpwxkcxqhqmcrowg", + "discoverySolutionId": "dlsekq", + "serviceEndpoint": "vxijveylysmmvjhspcneiyasunnaw", + "provisioningState": "Created" + }, + "tags": { + "key8004": "abecvbhselathbrca" + }, + "location": "rutllgppwqgtiklewhuesohgqb", + "id": "csrblruhgnnlqkatvm", + "name": "dtxwymqbsjfjr", + "type": "esvkyamqbxqueijrhetxciydcbxfaa", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ListBySubscription_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..f45b0cbf3d69 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,56 @@ +{ + "title": "ServerSitesController_ListBySubscription", + "operationId": "ServerSitesController_ListBySubscription", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "masterSiteId": "ahunubnc", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "nhhwywytwjbhjtpwxkcxqhqmcrowg", + "discoverySolutionId": "dlsekq", + "serviceEndpoint": "vxijveylysmmvjhspcneiyasunnaw", + "provisioningState": "Created" + }, + "tags": { + "key8004": "abecvbhselathbrca" + }, + "location": "rutllgppwqgtiklewhuesohgqb", + "id": "csrblruhgnnlqkatvm", + "name": "dtxwymqbsjfjr", + "type": "esvkyamqbxqueijrhetxciydcbxfaa", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ListHealthSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ListHealthSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..2a4b8b65e68a --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_ListHealthSummary_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "ServerSitesController_ListHealthSummary", + "operationId": "ServerSitesController_ListHealthSummary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "l-n--8Q" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "applianceName": "ivgdfvknbqkininnhifgcfey", + "errorMessage": "qmggozc", + "summaryMessage": "uhvqaiarzijpafpaiohfysmtdh", + "errorId": 10, + "errorCode": "votsjhvgcgogxznq", + "affectedObjectsCount": 13, + "hitCount": 21, + "severity": "bje", + "remediationGuidance": "yyanqkehkxtolfrkgmrmbsjqwnarj", + "affectedResourceType": "efxqqedsbgdswgf", + "affectedResources": [ + "ekpfdxxvxclxarytnlnxmslr" + ], + "fabricLayoutUpdateSources": [ + "RefreshFabricLayout" + ] + } + ], + "nextLink": "oj" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_RefreshSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_RefreshSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..5be3c9bf8bb8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_RefreshSite_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "ServerSitesController_RefreshSite", + "operationId": "ServerSitesController_RefreshSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "SyO---TQ7Es667pB1f0N5V" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Summary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Summary_MaximumSet_Gen.json new file mode 100644 index 000000000000..1ad14a63a450 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Summary_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "ServerSitesController_Summary", + "operationId": "ServerSitesController_Summary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "1C7" + }, + "responses": { + "200": { + "body": { + "runAsAccountCount": 30, + "serverCount": 27 + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_UpdateDependencyMapStatus_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_UpdateDependencyMapStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..fe5889e234b7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_UpdateDependencyMapStatus_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "ServerSitesController_UpdateDependencyMapStatus", + "operationId": "ServerSitesController_UpdateDependencyMapStatus", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-P1F17KB-Gw2423-tT741U0", + "mapRequest": { + "machines": [ + { + "machineId": "ysqizqtyaskpprxkqaeyyopln", + "isDependencyMapToBeEnabled": true + } + ] + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_UpdateProperties_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_UpdateProperties_MaximumSet_Gen.json new file mode 100644 index 000000000000..d81cbc914aad --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_UpdateProperties_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "ServerSitesController_UpdateProperties", + "operationId": "ServerSitesController_UpdateProperties", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "--Y-2W-", + "metaData": { + "value": [ + { + "machineArmId": "cbfxbnpaesafshmuirygemyx", + "dependencyMapping": "mehkbjgdktlveubatdamkaawrfmkwc", + "tags": { + "key925": "kvcnqygwaiw" + } + } + ] + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..94dfd5292cae --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSitesController_Update_MaximumSet_Gen.json @@ -0,0 +1,74 @@ +{ + "title": "ServerSitesController_Update", + "operationId": "ServerSitesController_Update", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "DlD858-", + "body": { + "tags": { + "key4258": "oxytdpswqvow" + }, + "properties": { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jhmejalr", + "discoverySolutionId": "glsibqdimzlmgiyvjwxrhuasrptyve" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "masterSiteId": "ahunubnc", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jhmejalr", + "discoverySolutionId": "glsibqdimzlmgiyvjwxrhuasrptyve", + "serviceEndpoint": "vxijveylysmmvjhspcneiyasunnaw", + "provisioningState": "Created" + }, + "tags": { + "key8004": "abecvbhselathbrca" + }, + "location": "rutllgppwqgtiklewhuesohgqb", + "id": "csrblruhgnnlqkatvm", + "name": "dtxwymqbsjfjr", + "type": "esvkyamqbxqueijrhetxciydcbxfaa", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json new file mode 100644 index 000000000000..5d42d50f3172 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json @@ -0,0 +1,113 @@ +{ + "title": "ServerSoftwareInventoriesController_GetMachineSoftwareInventory", + "operationId": "ServerSoftwareInventoriesController_GetMachineSoftwareInventory", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "HF6V2Ej4V6Z", + "machineName": "NL6-267-Pk-5B95", + "default": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "provisioningState": "Created" + }, + "id": "pfujk", + "name": "xmvuzlnwhjlvtbcfonw", + "type": "jnvjichwihswkpgelukouubckhiwy", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSoftwareInventoriesController_ListByServer_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSoftwareInventoriesController_ListByServer_MaximumSet_Gen.json new file mode 100644 index 000000000000..1ce52631d4da --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServerSoftwareInventoriesController_ListByServer_MaximumSet_Gen.json @@ -0,0 +1,117 @@ +{ + "title": "ServerSoftwareInventoriesController_ListByServer", + "operationId": "ServerSoftwareInventoriesController_ListByServer", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "AwZNt4yc", + "machineName": "62-T" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "provisioningState": "Created" + }, + "id": "pfujk", + "name": "xmvuzlnwhjlvtbcfonw", + "type": "jnvjichwihswkpgelukouubckhiwy", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_DeleteMachine_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_DeleteMachine_MaximumSet_Gen.json new file mode 100644 index 000000000000..2912eee9951b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_DeleteMachine_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "ServersController_DeleteMachine", + "operationId": "ServersController_DeleteMachine", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-n197127644D28qW744", + "machineName": "7-66-qTKM-q73---Q7O" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_GetMachine_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_GetMachine_MaximumSet_Gen.json new file mode 100644 index 000000000000..6e72a5cca226 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_GetMachine_MaximumSet_Gen.json @@ -0,0 +1,305 @@ +{ + "title": "ServersController_GetMachine", + "operationId": "ServersController_GetMachine", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "1BK6L5S-6F57M7C21-", + "machineName": "FIQ6MR5IxK6oV86-hRW--j" + }, + "responses": { + "200": { + "body": { + "properties": { + "displayName": "qyokvvzdhjkujdymydd", + "fqdn": "jadfiquh", + "networkAdapters": [ + { + "nicId": "oh", + "macAddress": "hiuyciojrlzaddb", + "ipAddressList": [ + "itzrxrxphbnqesaxl" + ], + "networkName": "bgnmxymooxnsanrzibls", + "ipAddressType": "qjdgdeosrivmkeqahzlnwyxara" + } + ], + "hydratedFqdn": "llxpnwioxqdztqhpkxavusswmhkja", + "disks": [ + { + "id": "ttwabuszbdxurwxpqth", + "generatedId": "qdotapzwauwybroybkfs", + "maxSizeInBytes": 24, + "name": "ewdnvthdyaqxjyurxmzndxdllt", + "diskType": "yvplqohvladrponmtgxpsk", + "lun": 17, + "path": "wjuritjsfzgnxekoiaxhlbrpjvixi" + } + ], + "validationRequired": "wzlidaqnvdsjibpkpaevptuglxf", + "processorInfo": { + "name": "ajjwrlhbavqyxzivzkfxixrofy", + "numberOfSockets": 3, + "numberOfCoresPerSocket": 1 + }, + "firmware": "gmzewnwbakwdmzxuue", + "guestOsDetails": { + "osType": "xz", + "osName": "nuntfpzdlurtmvjfkcojerqxaaos", + "osVersion": "zrtaepnbiipl", + "osArchitecture": "swwiffrahcblv" + }, + "numberOfApplications": 1, + "guestDetailsDiscoveryTimestamp": "2024-01-18T11:35:48.783Z", + "isGuestDetailsDiscoveryInProgress": true, + "dependencyMapping": "m", + "dependencyMappingStartTime": "2024-01-18T11:35:48.783Z", + "dependencyMappingEndTime": "lpfrfps", + "runAsAccountId": "fqjeruewj", + "applianceNames": [ + "dtvtbgl" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applicationDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "rwncwoyzvhbumon" + }, + "dependencyMapDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "uaafojfnjso" + }, + "staticDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "mqpsmttmzspz" + }, + "sqlDiscovery": { + "successfullyDiscoveredServerCount": 29, + "totalServerCount": 29, + "sqlMetadataHydratedRunAsAccountId": "vpjtrcjjrxoe", + "sqlMetadataDiscoveryPipe": "Unknown", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "webAppDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "oracleDiscovery": { + "totalInstanceCount": 30, + "totalDatabaseCount": 25, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "springBootDiscovery": { + "totalInstanceCount": 29, + "totalApplicationCount": 1, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "iisDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "tomcatDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "numberOfProcessorCore": 16, + "allocatedMemoryInMb": 9, + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "biosSerialNumber": "xlrztuaztbjcuwvtg", + "biosGuid": "rmmkwepioo", + "isDeleted": true, + "createdTimestamp": "gyqxgpsoxssuwerehkydjmwy", + "tags": { + "key1427": {} + }, + "updatedTimestamp": "qjofsdmpkyaofqpeghyaqdlhg", + "provisioningState": "Created" + }, + "id": "bccvsatnzqsunz", + "name": "wrwtlxtcdlpmdwbrfu", + "type": "ipbwdyo", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_ListByServerSiteResource_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_ListByServerSiteResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..3a242f43383a --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_ListByServerSiteResource_MaximumSet_Gen.json @@ -0,0 +1,313 @@ +{ + "title": "ServersController_ListByServerSiteResource", + "operationId": "ServersController_ListByServerSiteResource", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "hfvdwbpielz", + "top": "qddxrggchwymzqotlat", + "continuationToken": "mzniucjqoundbfzyziomtdu", + "totalRecordCount": 19, + "siteName": "6Jex-VW-8D-" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "qyokvvzdhjkujdymydd", + "fqdn": "jadfiquh", + "networkAdapters": [ + { + "nicId": "oh", + "macAddress": "hiuyciojrlzaddb", + "ipAddressList": [ + "itzrxrxphbnqesaxl" + ], + "networkName": "bgnmxymooxnsanrzibls", + "ipAddressType": "qjdgdeosrivmkeqahzlnwyxara" + } + ], + "hydratedFqdn": "llxpnwioxqdztqhpkxavusswmhkja", + "disks": [ + { + "id": "ttwabuszbdxurwxpqth", + "generatedId": "qdotapzwauwybroybkfs", + "maxSizeInBytes": 24, + "name": "ewdnvthdyaqxjyurxmzndxdllt", + "diskType": "yvplqohvladrponmtgxpsk", + "lun": 17, + "path": "wjuritjsfzgnxekoiaxhlbrpjvixi" + } + ], + "validationRequired": "wzlidaqnvdsjibpkpaevptuglxf", + "processorInfo": { + "name": "ajjwrlhbavqyxzivzkfxixrofy", + "numberOfSockets": 3, + "numberOfCoresPerSocket": 1 + }, + "firmware": "gmzewnwbakwdmzxuue", + "guestOsDetails": { + "osType": "xz", + "osName": "nuntfpzdlurtmvjfkcojerqxaaos", + "osVersion": "zrtaepnbiipl", + "osArchitecture": "swwiffrahcblv" + }, + "numberOfApplications": 1, + "guestDetailsDiscoveryTimestamp": "2024-01-18T11:35:48.783Z", + "isGuestDetailsDiscoveryInProgress": true, + "dependencyMapping": "m", + "dependencyMappingStartTime": "2024-01-18T11:35:48.783Z", + "dependencyMappingEndTime": "lpfrfps", + "runAsAccountId": "fqjeruewj", + "applianceNames": [ + "dtvtbgl" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applicationDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "rwncwoyzvhbumon" + }, + "dependencyMapDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "uaafojfnjso" + }, + "staticDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "mqpsmttmzspz" + }, + "sqlDiscovery": { + "successfullyDiscoveredServerCount": 29, + "totalServerCount": 29, + "sqlMetadataHydratedRunAsAccountId": "vpjtrcjjrxoe", + "sqlMetadataDiscoveryPipe": "Unknown", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "webAppDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "oracleDiscovery": { + "totalInstanceCount": 30, + "totalDatabaseCount": 25, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "springBootDiscovery": { + "totalInstanceCount": 29, + "totalApplicationCount": 1, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "iisDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "tomcatDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "numberOfProcessorCore": 16, + "allocatedMemoryInMb": 9, + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "biosSerialNumber": "xlrztuaztbjcuwvtg", + "biosGuid": "rmmkwepioo", + "isDeleted": true, + "createdTimestamp": "gyqxgpsoxssuwerehkydjmwy", + "tags": { + "key1427": {} + }, + "updatedTimestamp": "qjofsdmpkyaofqpeghyaqdlhg", + "provisioningState": "Created" + }, + "id": "bccvsatnzqsunz", + "name": "wrwtlxtcdlpmdwbrfu", + "type": "ipbwdyo", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/as" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_UpdateMachine_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_UpdateMachine_MaximumSet_Gen.json new file mode 100644 index 000000000000..d00d97fd445d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/ServersController_UpdateMachine_MaximumSet_Gen.json @@ -0,0 +1,354 @@ +{ + "title": "ServersController_UpdateMachine", + "operationId": "ServersController_UpdateMachine", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "2HJb4-f8H1C-J", + "machineName": "82xP-5", + "body": { + "properties": { + "fqdn": "enzxkpgnaemrgkovstac", + "networkAdapters": [ + { + "nicId": "oh", + "macAddress": "hiuyciojrlzaddb", + "networkName": "bgnmxymooxnsanrzibls", + "ipAddressType": "qjdgdeosrivmkeqahzlnwyxara" + } + ], + "hydratedFqdn": "ghu", + "disks": [ + { + "id": "ttwabuszbdxurwxpqth", + "generatedId": "qdotapzwauwybroybkfs", + "maxSizeInBytes": 24, + "name": "ewdnvthdyaqxjyurxmzndxdllt", + "diskType": "yvplqohvladrponmtgxpsk", + "lun": 17, + "path": "wjuritjsfzgnxekoiaxhlbrpjvixi" + } + ], + "validationRequired": "dgqelhhko", + "firmware": "ajvjivcsmfyuajoep", + "runAsAccountId": "oqfsldxayft", + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "numberOfProcessorCore": 20, + "allocatedMemoryInMb": 8, + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "biosSerialNumber": "sbphszczqgmpgcfk", + "biosGuid": "sgkhcqrumsjuwlnfhctnwus", + "tags": { + "key36": {} + }, + "provisioningState": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "displayName": "qyokvvzdhjkujdymydd", + "fqdn": "enzxkpgnaemrgkovstac", + "networkAdapters": [ + { + "nicId": "oh", + "macAddress": "hiuyciojrlzaddb", + "ipAddressList": [ + "itzrxrxphbnqesaxl" + ], + "networkName": "bgnmxymooxnsanrzibls", + "ipAddressType": "qjdgdeosrivmkeqahzlnwyxara" + } + ], + "hydratedFqdn": "ghu", + "disks": [ + { + "id": "ttwabuszbdxurwxpqth", + "generatedId": "qdotapzwauwybroybkfs", + "maxSizeInBytes": 24, + "name": "ewdnvthdyaqxjyurxmzndxdllt", + "diskType": "yvplqohvladrponmtgxpsk", + "lun": 17, + "path": "wjuritjsfzgnxekoiaxhlbrpjvixi" + } + ], + "validationRequired": "dgqelhhko", + "processorInfo": { + "name": "ajjwrlhbavqyxzivzkfxixrofy", + "numberOfSockets": 3, + "numberOfCoresPerSocket": 1 + }, + "firmware": "ajvjivcsmfyuajoep", + "guestOsDetails": { + "osType": "xz", + "osName": "nuntfpzdlurtmvjfkcojerqxaaos", + "osVersion": "zrtaepnbiipl", + "osArchitecture": "swwiffrahcblv" + }, + "numberOfApplications": 1, + "guestDetailsDiscoveryTimestamp": "2024-01-18T11:35:48.783Z", + "isGuestDetailsDiscoveryInProgress": true, + "dependencyMapping": "m", + "dependencyMappingStartTime": "2024-01-18T11:35:48.783Z", + "dependencyMappingEndTime": "lpfrfps", + "runAsAccountId": "oqfsldxayft", + "applianceNames": [ + "dtvtbgl" + ], + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applicationDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "rwncwoyzvhbumon" + }, + "dependencyMapDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "uaafojfnjso" + }, + "staticDiscovery": { + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hydratedRunAsAccountId": "mqpsmttmzspz" + }, + "sqlDiscovery": { + "successfullyDiscoveredServerCount": 29, + "totalServerCount": 29, + "sqlMetadataHydratedRunAsAccountId": "vpjtrcjjrxoe", + "sqlMetadataDiscoveryPipe": "Unknown", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "webAppDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "oracleDiscovery": { + "totalInstanceCount": 30, + "totalDatabaseCount": 25, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "springBootDiscovery": { + "totalInstanceCount": 29, + "totalApplicationCount": 1, + "shallowDiscoveryStatus": "DiscoverySucceededAtleastOnce", + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "iisDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "tomcatDiscovery": { + "totalWebServerCount": 7, + "totalWebApplicationCount": 23, + "discoveryScopeStatus": "DiscoverySucceededAtleastOnce" + }, + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "numberOfProcessorCore": 20, + "allocatedMemoryInMb": 8, + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "biosSerialNumber": "sbphszczqgmpgcfk", + "biosGuid": "sgkhcqrumsjuwlnfhctnwus", + "isDeleted": true, + "createdTimestamp": "gyqxgpsoxssuwerehkydjmwy", + "tags": { + "key1427": {} + }, + "updatedTimestamp": "qjofsdmpkyaofqpeghyaqdlhg", + "provisioningState": "Created" + }, + "id": "bccvsatnzqsunz", + "name": "wrwtlxtcdlpmdwbrfu", + "type": "ipbwdyo", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ComputeErrorSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ComputeErrorSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..2db04dda754f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ComputeErrorSummary_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "SitesController_ComputeErrorSummary", + "operationId": "SitesController_ComputeErrorSummary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "G1-3vSZ-fFwZ-UqbP8YM", + "body": {} + }, + "responses": { + "200": { + "body": { + "applianceName": "rnwdayyamnbf", + "discoveryScopeErrorSummaries": { + "affectedResourceType": "eogpdpyddhvnf", + "affectedObjectsCount": 13, + "discoveryScope": "AppsAndRoles" + }, + "nextLink": "nctyxej" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Computeusage_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Computeusage_MaximumSet_Gen.json new file mode 100644 index 000000000000..fb55e3c8cb8a --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Computeusage_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "SitesController_Computeusage", + "operationId": "SitesController_Computeusage", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "a9-b-m243D-Ui9I1Yx", + "body": {} + }, + "responses": { + "200": { + "body": { + "machineCount": 18, + "runAsAccountCount": 25, + "vCenterCount": 26 + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..72cfadc51157 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Create_MaximumSet_Gen.json @@ -0,0 +1,119 @@ +{ + "title": "SitesController_Create", + "operationId": "SitesController_Create", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "3w-E-i5L", + "body": { + "properties": { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "nhhwywytwjbhjtpwxkcxqhqmcrowg", + "discoverySolutionId": "dlsekq", + "provisioningState": "Created" + }, + "tags": { + "key2178": "gfjjytrnctgvmi" + }, + "location": "wcccoelallobfu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "masterSiteId": "ahunubnc", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "nhhwywytwjbhjtpwxkcxqhqmcrowg", + "discoverySolutionId": "dlsekq", + "serviceEndpoint": "vxijveylysmmvjhspcneiyasunnaw", + "provisioningState": "Created" + }, + "eTag": "mijhlcdzbdyukqpnisac", + "tags": { + "key2178": "gfjjytrnctgvmi" + }, + "location": "wcccoelallobfu", + "id": "gtenbkytpj", + "name": "sfckwpgjzbycsruhrfaew", + "type": "kwnvvdvnqhivicqjlfsmarv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "body": { + "properties": { + "masterSiteId": "ahunubnc", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "nhhwywytwjbhjtpwxkcxqhqmcrowg", + "discoverySolutionId": "dlsekq", + "serviceEndpoint": "vxijveylysmmvjhspcneiyasunnaw", + "provisioningState": "Created" + }, + "eTag": "mijhlcdzbdyukqpnisac", + "tags": { + "key2178": "gfjjytrnctgvmi" + }, + "location": "wcccoelallobfu", + "id": "gtenbkytpj", + "name": "sfckwpgjzbycsruhrfaew", + "type": "kwnvvdvnqhivicqjlfsmarv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..cc8af16a0f77 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "SitesController_Delete", + "operationId": "SitesController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "PiW11F6QAg-" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ExportApplications_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ExportApplications_MaximumSet_Gen.json new file mode 100644 index 000000000000..f2cd370f492b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ExportApplications_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "SitesController_ExportApplications", + "operationId": "SitesController_ExportApplications", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "X-3-O24jG4f96-X45", + "body": {} + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ExportMachineErrors_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ExportMachineErrors_MaximumSet_Gen.json new file mode 100644 index 000000000000..9009479cd0b4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ExportMachineErrors_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "SitesController_ExportMachineErrors", + "operationId": "SitesController_ExportMachineErrors", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "9QD-VAV18O1Sb-unBV30X", + "body": { + "properties": { + "discoveryScope": "AppsAndRoles" + } + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ExportMachines_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ExportMachines_MaximumSet_Gen.json new file mode 100644 index 000000000000..2ad302239d2f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ExportMachines_MaximumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "title": "SitesController_ExportMachines", + "operationId": "SitesController_ExportMachines", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "O45c6F82W4U6-0-bO", + "body": { + "filter": "mgtewmbxropivmgndxrbufgxpmo" + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..dc81dc7dc68d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Get_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "SitesController_Get", + "operationId": "SitesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "3-64--12P2Q-7P9-2-F-" + }, + "responses": { + "200": { + "body": { + "properties": { + "masterSiteId": "ahunubnc", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "nhhwywytwjbhjtpwxkcxqhqmcrowg", + "discoverySolutionId": "dlsekq", + "serviceEndpoint": "vxijveylysmmvjhspcneiyasunnaw", + "provisioningState": "Created" + }, + "eTag": "mijhlcdzbdyukqpnisac", + "tags": { + "key2178": "gfjjytrnctgvmi" + }, + "location": "wcccoelallobfu", + "id": "gtenbkytpj", + "name": "sfckwpgjzbycsruhrfaew", + "type": "kwnvvdvnqhivicqjlfsmarv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ListByResourceGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..27bca85e49f1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,58 @@ +{ + "title": "Get all vmware sites.", + "operationId": "SitesController_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "masterSiteId": "ahunubnc", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "nhhwywytwjbhjtpwxkcxqhqmcrowg", + "discoverySolutionId": "dlsekq", + "serviceEndpoint": "vxijveylysmmvjhspcneiyasunnaw", + "provisioningState": "Created" + }, + "eTag": "mijhlcdzbdyukqpnisac", + "tags": { + "key2178": "gfjjytrnctgvmi" + }, + "location": "wcccoelallobfu", + "id": "gtenbkytpj", + "name": "sfckwpgjzbycsruhrfaew", + "type": "kwnvvdvnqhivicqjlfsmarv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ListBySubscription_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..9d31765a2d05 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "Get all vmware sites.", + "operationId": "SitesController_ListBySubscription", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "masterSiteId": "ahunubnc", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "nhhwywytwjbhjtpwxkcxqhqmcrowg", + "discoverySolutionId": "dlsekq", + "serviceEndpoint": "vxijveylysmmvjhspcneiyasunnaw", + "provisioningState": "Created" + }, + "eTag": "mijhlcdzbdyukqpnisac", + "tags": { + "key2178": "gfjjytrnctgvmi" + }, + "location": "wcccoelallobfu", + "id": "gtenbkytpj", + "name": "sfckwpgjzbycsruhrfaew", + "type": "kwnvvdvnqhivicqjlfsmarv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ListHealthSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ListHealthSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..bc4579976b9f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_ListHealthSummary_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "SitesController_ListHealthSummary", + "operationId": "SitesController_ListHealthSummary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-qBx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "applianceName": "ivgdfvknbqkininnhifgcfey", + "errorMessage": "qmggozc", + "summaryMessage": "uhvqaiarzijpafpaiohfysmtdh", + "errorId": 10, + "errorCode": "votsjhvgcgogxznq", + "affectedObjectsCount": 13, + "hitCount": 21, + "severity": "bje", + "remediationGuidance": "yyanqkehkxtolfrkgmrmbsjqwnarj", + "affectedResourceType": "efxqqedsbgdswgf", + "affectedResources": [ + "ekpfdxxvxclxarytnlnxmslr" + ], + "fabricLayoutUpdateSources": [ + "RefreshFabricLayout" + ] + } + ], + "nextLink": "oj" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Summary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Summary_MaximumSet_Gen.json new file mode 100644 index 000000000000..1fa5c4e046a3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Summary_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "SitesController_Summary", + "operationId": "SitesController_Summary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "9dW7AR2-W98852IN2---GRU" + }, + "responses": { + "200": { + "body": { + "machineCount": 18, + "runAsAccountCount": 25, + "vCenterCount": 26 + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..9d58d6f2e50a --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SitesController_Update_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "SitesController_Update", + "operationId": "SitesController_Update", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "6-5N8-b81", + "body": { + "tags": { + "key1253": "vtfixy" + }, + "properties": { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "lsfkebcliutqeevmn", + "discoverySolutionId": "czzqa", + "provisioningState": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "masterSiteId": "ahunubnc", + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "lsfkebcliutqeevmn", + "discoverySolutionId": "czzqa", + "serviceEndpoint": "vxijveylysmmvjhspcneiyasunnaw", + "provisioningState": "Created" + }, + "eTag": "mijhlcdzbdyukqpnisac", + "tags": { + "key2178": "gfjjytrnctgvmi" + }, + "location": "wcccoelallobfu", + "id": "gtenbkytpj", + "name": "sfckwpgjzbycsruhrfaew", + "type": "kwnvvdvnqhivicqjlfsmarv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlAvailabilityGroupsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlAvailabilityGroupsController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..58210fe11eac --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlAvailabilityGroupsController_Get_MaximumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "title": "SqlAvailabilityGroupsController_Get", + "operationId": "SqlAvailabilityGroupsController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "5-7W6U24O04E9oKW-Uu3", + "sqlSiteName": "51HR84W---1", + "sqlAvailabilityGroupName": "QH9N-7YGCT160" + }, + "responses": { + "200": { + "body": { + "properties": { + "availabilityGroupName": "dftaribjdkpqhkuijeufklkz", + "availabilityGroupType": "Unknown", + "isMultiSubNet": true, + "clusterName": "tbkdcxfeeflylww", + "availabilityReplicas": [ + { + "availabilityReplicaName": "iyeejbokspglvknjjgzkkdbkmjnlqm", + "availabilityReplicaId": "elphwqrwvckxfggandckottuwhdem", + "replicaType": "Unknown", + "replicaState": "Unknown", + "replicaSyncStatus": "Unknown", + "replicaCommitMode": "Unknown", + "replicaReadMode": "Unknown", + "replicaSeedMode": "Unknown", + "sqlDatabaseReplicaInfo": { + "hostName": "eocswcgtiocldlwxmlpjygck", + "sqlServerName": "wdzxakzjqrlzmeszjtiao", + "sqlServerArmId": "xncshxhiqu" + }, + "sqlAvailabilityGroupReplicaInfo": { + "clusterName": "opcahey", + "availabilityGroupName": "fnuxptnewtmsvcplaghglty", + "availabilityGroupArmId": "renjd" + } + } + ], + "parentReplicaOverviewList": [ + { + "replicaState": "Unknown", + "availabilityReplicaId": "rddniende", + "availabilityGroupArmId": "retkhrnqnhpuj", + "availabilityGroupName": "idrlxfqafhsamzdfrh" + } + ], + "isPartOfDistributedAvailabilityGroup": true, + "isDeleted": true, + "createdTimestamp": "qbddjtlwjprqhybtsgaulnpvfzfq", + "updatedTimestamp": "xvlqjbaacgxt", + "provisioningState": "Created" + }, + "id": "kqprgs", + "name": "bgcrglaqgmuflgjlkljnrbtucgr", + "type": "nygejvhizstjckmnjpexun", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlAvailabilityGroupsController_ListBySqlSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlAvailabilityGroupsController_ListBySqlSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..b0f8d97d331b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlAvailabilityGroupsController_ListBySqlSite_MaximumSet_Gen.json @@ -0,0 +1,78 @@ +{ + "title": "SqlAvailabilityGroupsController_ListBySqlSite", + "operationId": "SqlAvailabilityGroupsController_ListBySqlSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "woimkprhqyepsqecqt", + "top": "bzuahazteatifmgfn", + "continuationToken": "byktqchddhuhagyulfbjhw", + "totalRecordCount": 3, + "siteName": "A6JL", + "sqlSiteName": "Iy--O" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "availabilityGroupName": "dftaribjdkpqhkuijeufklkz", + "availabilityGroupType": "Unknown", + "isMultiSubNet": true, + "clusterName": "tbkdcxfeeflylww", + "availabilityReplicas": [ + { + "availabilityReplicaName": "iyeejbokspglvknjjgzkkdbkmjnlqm", + "availabilityReplicaId": "elphwqrwvckxfggandckottuwhdem", + "replicaType": "Unknown", + "replicaState": "Unknown", + "replicaSyncStatus": "Unknown", + "replicaCommitMode": "Unknown", + "replicaReadMode": "Unknown", + "replicaSeedMode": "Unknown", + "sqlDatabaseReplicaInfo": { + "hostName": "eocswcgtiocldlwxmlpjygck", + "sqlServerName": "wdzxakzjqrlzmeszjtiao", + "sqlServerArmId": "xncshxhiqu" + }, + "sqlAvailabilityGroupReplicaInfo": { + "clusterName": "opcahey", + "availabilityGroupName": "fnuxptnewtmsvcplaghglty", + "availabilityGroupArmId": "renjd" + } + } + ], + "parentReplicaOverviewList": [ + { + "replicaState": "Unknown", + "availabilityReplicaId": "rddniende", + "availabilityGroupArmId": "retkhrnqnhpuj", + "availabilityGroupName": "idrlxfqafhsamzdfrh" + } + ], + "isPartOfDistributedAvailabilityGroup": true, + "isDeleted": true, + "createdTimestamp": "qbddjtlwjprqhybtsgaulnpvfzfq", + "updatedTimestamp": "xvlqjbaacgxt", + "provisioningState": "Created" + }, + "id": "kqprgs", + "name": "bgcrglaqgmuflgjlkljnrbtucgr", + "type": "nygejvhizstjckmnjpexun", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDatabasesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDatabasesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..7a48e36eae87 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDatabasesController_Get_MaximumSet_Gen.json @@ -0,0 +1,77 @@ +{ + "title": "SqlDatabasesController_Get", + "operationId": "SqlDatabasesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "Vg681-46pU7-1", + "sqlSiteName": "-vO6EW-2UD", + "sqlDatabaseName": "1k-11553Ir-7gV6-3T-76" + }, + "responses": { + "200": { + "body": { + "properties": { + "parentReplicaOverview": { + "replicaState": "Unknown", + "availabilityReplicaId": "rddniende", + "availabilityGroupArmId": "retkhrnqnhpuj", + "availabilityGroupName": "idrlxfqafhsamzdfrh" + }, + "isDatabaseHighlyAvailable": true, + "fileMetadataList": [ + { + "logicalName": "uovzfjsyzwghxkrekgjzqvsrk", + "physicalFullName": "efabhuydokbdb", + "fileType": "Rows", + "sizeInMb": 23, + "isMemoryOptimizedDataOptionEnabled": true + } + ], + "hostname": "cvwrgfqwjru", + "sqlServerName": "smqv", + "status": "fpklckjmllnj", + "sizeMb": 19, + "databaseName": "ivzzudbjbrunykqxjlbqjqvmgd", + "sqlServerArmId": "sefvymnvxzzduszdlcnmfxzvyrcvj", + "compatibilityLevel": "ofmmohfgf", + "isDeleted": true, + "errors": [ + { + "message": "uj", + "messageParameters": { + "key2352": "jealqbinnkqarltzmfzzdnpbmgd" + }, + "applianceName": "lelyezprqfrlhgmehoybmqcyxi", + "id": 11, + "code": "rbwuopdepgrdbsoavituqxvffu", + "possibleCauses": "xhprtb", + "recommendedAction": "vverifrnstzifhwrqgkvivkoyq", + "severity": "twsg", + "summaryMessage": "ejzxjauuetbmkdpbidvqgenztju", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:34:38.739Z", + "runAsAccountId": "gewgggask", + "discoveryScope": "AppsAndRoles" + } + ], + "createdTimestamp": "iyrphcuwucgsupcmynwndnarrvirga", + "updatedTimestamp": "abzcq", + "provisioningState": "Created" + }, + "id": "qslfnwzkwj", + "name": "hfaxhhskxq", + "type": "mbe", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDatabasesController_ListBySqlSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDatabasesController_ListBySqlSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..1c4019f999d7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDatabasesController_ListBySqlSite_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "title": "SqlDatabasesController_ListBySqlSite", + "operationId": "SqlDatabasesController_ListBySqlSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "qrtuwvhmcwnrmerqzvlkzvlvxyjfw", + "top": "htstbzxjbvwunvhiyp", + "continuationToken": "mtygvrmnwlhildlbs", + "totalRecordCount": 9, + "siteName": "-X36w63R3356-8q1HI07", + "sqlSiteName": "4----63-4472-12N-" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "parentReplicaOverview": { + "replicaState": "Unknown", + "availabilityReplicaId": "rddniende", + "availabilityGroupArmId": "retkhrnqnhpuj", + "availabilityGroupName": "idrlxfqafhsamzdfrh" + }, + "isDatabaseHighlyAvailable": true, + "fileMetadataList": [ + { + "logicalName": "uovzfjsyzwghxkrekgjzqvsrk", + "physicalFullName": "efabhuydokbdb", + "fileType": "Rows", + "sizeInMb": 23, + "isMemoryOptimizedDataOptionEnabled": true + } + ], + "hostname": "cvwrgfqwjru", + "sqlServerName": "smqv", + "status": "fpklckjmllnj", + "sizeMb": 19, + "databaseName": "ivzzudbjbrunykqxjlbqjqvmgd", + "sqlServerArmId": "sefvymnvxzzduszdlcnmfxzvyrcvj", + "compatibilityLevel": "ofmmohfgf", + "isDeleted": true, + "errors": [ + { + "message": "uj", + "messageParameters": { + "key2352": "jealqbinnkqarltzmfzzdnpbmgd" + }, + "applianceName": "lelyezprqfrlhgmehoybmqcyxi", + "id": 11, + "code": "rbwuopdepgrdbsoavituqxvffu", + "possibleCauses": "xhprtb", + "recommendedAction": "vverifrnstzifhwrqgkvivkoyq", + "severity": "twsg", + "summaryMessage": "ejzxjauuetbmkdpbidvqgenztju", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:34:38.739Z", + "runAsAccountId": "gewgggask", + "discoveryScope": "AppsAndRoles" + } + ], + "createdTimestamp": "iyrphcuwucgsupcmynwndnarrvirga", + "updatedTimestamp": "abzcq", + "provisioningState": "Created" + }, + "id": "qslfnwzkwj", + "name": "hfaxhhskxq", + "type": "mbe", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/anafa" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..579e4dbb2943 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_Create_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "SqlDiscoverySiteDataSourceController_Create", + "operationId": "SqlDiscoverySiteDataSourceController_Create", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "v-MwBCpvV-", + "sqlSiteName": "NO-8-W75XK5-4Xfs54I-n", + "discoverySiteDataSourceName": "jN--823UiQ", + "body": { + "properties": { + "discoverySiteId": "ndmdh", + "provisioningState": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "discoverySiteId": "ndmdh", + "provisioningState": "Created" + }, + "id": "nakkwrhwwvpxqjnwjfnmngbmvkusa", + "name": "ogoambuklhacaucjkaxgzyvfm", + "type": "iupapxgkxuixlbinpnifl", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "discoverySiteId": "ndmdh", + "provisioningState": "Created" + }, + "id": "nakkwrhwwvpxqjnwjfnmngbmvkusa", + "name": "ogoambuklhacaucjkaxgzyvfm", + "type": "iupapxgkxuixlbinpnifl", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..ea5efffef541 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "SqlDiscoverySiteDataSourceController_Delete", + "operationId": "SqlDiscoverySiteDataSourceController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "5-6-SmU52A-w616N1uV", + "sqlSiteName": "t1-s8R--f6T34L", + "discoverySiteDataSourceName": "Vr0-1E23-O4-IV1w6" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..db49e4aef78c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_Get_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "SqlDiscoverySiteDataSourceController_Get", + "operationId": "SqlDiscoverySiteDataSourceController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "34K-r--7e443uLdyG-S-M3-Y", + "sqlSiteName": "3-Q4-J7-", + "discoverySiteDataSourceName": "2hyjS68CSU-Se4hiPNk2" + }, + "responses": { + "200": { + "body": { + "properties": { + "discoverySiteId": "ndmdh", + "provisioningState": "Created" + }, + "id": "nakkwrhwwvpxqjnwjfnmngbmvkusa", + "name": "ogoambuklhacaucjkaxgzyvfm", + "type": "iupapxgkxuixlbinpnifl", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_ListBySqlSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_ListBySqlSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..56940c7989f4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlDiscoverySiteDataSourceController_ListBySqlSite_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "SqlDiscoverySiteDataSourceController_ListBySqlSite", + "operationId": "SqlDiscoverySiteDataSourceController_ListBySqlSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "1L3-06Ug", + "sqlSiteName": "cvn6667m" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "discoverySiteId": "ndmdh", + "provisioningState": "Created" + }, + "id": "nakkwrhwwvpxqjnwjfnmngbmvkusa", + "name": "ogoambuklhacaucjkaxgzyvfm", + "type": "iupapxgkxuixlbinpnifl", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlJobsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlJobsController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..55b9f4e45525 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlJobsController_Get_MaximumSet_Gen.json @@ -0,0 +1,52 @@ +{ + "title": "Gets the sql Job.", + "operationId": "SqlJobsController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-8F1-jW27Q-4", + "sqlSiteName": "c36-J78odt-h69b3", + "jobName": "-cf5aU" + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "gxgsmdmtocrmbnlsibksntnxfkoiu", + "startTime": "bnnddbgspizwnkwvvkvqhq", + "endTime": "cpouxxkikfjodgjvi", + "displayName": "jejisdzsezzotlmz", + "clientRequestId": "xtnxy", + "activityId": "dthzzprqvnkghxnca", + "errors": [ + { + "code": "iciy", + "message": "vpyszfmstisopihrrbbvf", + "possibleCauses": "sxrbjrrtqqljdgoe", + "recommendedAction": "osjxpjudgrlxepabiceakjcvmvvr", + "severity": "veqcqcmibgrabvajtvfzeyrb", + "isAgentReportedError": true, + "agentErrorCode": "bih", + "agentErrorMessage": "ryloaagexndkeuyrmuknxlunp", + "agentErrorPossibleCauses": "ehelidlosla", + "agentErrorRecommendedAction": "wgdq" + } + ], + "provisioningState": "Created" + }, + "id": "hwjwkruqtscenjn", + "name": "xhlfhheqjadxecbi", + "type": "yydyvvebbkmzjorddfrlhel", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlJobsController_ListBySqlSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlJobsController_ListBySqlSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..4fc4eaa5d1f0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlJobsController_ListBySqlSite_MaximumSet_Gen.json @@ -0,0 +1,56 @@ +{ + "title": "Gets the sql Jobs.", + "operationId": "SqlJobsController_ListBySqlSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "H44", + "sqlSiteName": "646B--g" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "status": "gxgsmdmtocrmbnlsibksntnxfkoiu", + "startTime": "bnnddbgspizwnkwvvkvqhq", + "endTime": "cpouxxkikfjodgjvi", + "displayName": "jejisdzsezzotlmz", + "clientRequestId": "xtnxy", + "activityId": "dthzzprqvnkghxnca", + "errors": [ + { + "code": "iciy", + "message": "vpyszfmstisopihrrbbvf", + "possibleCauses": "sxrbjrrtqqljdgoe", + "recommendedAction": "osjxpjudgrlxepabiceakjcvmvvr", + "severity": "veqcqcmibgrabvajtvfzeyrb", + "isAgentReportedError": true, + "agentErrorCode": "bih", + "agentErrorMessage": "ryloaagexndkeuyrmuknxlunp", + "agentErrorPossibleCauses": "ehelidlosla", + "agentErrorRecommendedAction": "wgdq" + } + ], + "provisioningState": "Created" + }, + "id": "hwjwkruqtscenjn", + "name": "xhlfhheqjadxecbi", + "type": "yydyvvebbkmzjorddfrlhel", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlOperationsStatusController_GetSqlOperationStatus_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlOperationsStatusController_GetSqlOperationStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..0253ca1ca347 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlOperationsStatusController_GetSqlOperationStatus_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "title": "SqlOperationsStatusController_GetSqlOperationStatus", + "operationId": "SqlOperationsStatusController_GetSqlOperationStatus", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "0uJYYIVL-NX23x33I31", + "sqlSiteName": "Y4l-bwV847fX5--6---VP5D", + "operationStatusName": "-2z43" + }, + "responses": { + "200": { + "body": { + "id": "p", + "name": "bcvvgkxeeavuxwhhcuhlr", + "status": "xdwtanilfmuuhjnanaxclrds", + "startTime": "dqgff", + "endTime": "putnpglwoqfdhjkk", + "error": { + "code": "rnsnhdowwptegdldklx", + "message": "qolsunkhecgpjxm" + }, + "properties": { + "result": "wvhlgcgdktttlozc" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlRunAsAccountsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlRunAsAccountsController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..15728af7d4c8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlRunAsAccountsController_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "SqlRunAsAccountsController_Get", + "operationId": "SqlRunAsAccountsController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "7s32E4yPhN5jCPW-", + "sqlSiteName": "1-b4--1--5JH61Q-t94991W", + "accountName": "Cu--68" + }, + "responses": { + "200": { + "body": { + "properties": { + "displayName": "jisgaadoxsjdfbz", + "credentialType": "zjlboeqftmfeafhmaf", + "createdTimestamp": "wgrjz", + "updatedTimestamp": "lqvvxyngsjskvx", + "applianceName": "fbicoeqjjfpfpadaewfuea", + "provisioningState": "Created" + }, + "id": "llckbmxzyvpififksphzhwiirln", + "name": "fdkvmbuv", + "type": "bofxeejvodxparukvpsdxullq", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlRunAsAccountsController_ListBySqlSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlRunAsAccountsController_ListBySqlSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..5873649aa595 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlRunAsAccountsController_ListBySqlSite_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "SqlRunAsAccountsController_ListBySqlSite", + "operationId": "SqlRunAsAccountsController_ListBySqlSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "3I4yO63MT--06G33--OJjO7", + "sqlSiteName": "-gLI1---DX1J-V1j8L4P" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "jisgaadoxsjdfbz", + "credentialType": "zjlboeqftmfeafhmaf", + "createdTimestamp": "wgrjz", + "updatedTimestamp": "lqvvxyngsjskvx", + "applianceName": "fbicoeqjjfpfpadaewfuea", + "provisioningState": "Created" + }, + "id": "llckbmxzyvpififksphzhwiirln", + "name": "fdkvmbuv", + "type": "bofxeejvodxparukvpsdxullq", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlServersController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlServersController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..263df3788cd9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlServersController_Get_MaximumSet_Gen.json @@ -0,0 +1,102 @@ +{ + "title": "SqlServersController_Get", + "operationId": "SqlServersController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "d1-Q3-oD-Z", + "sqlSiteName": "r436C6-04Rz7Cz-P6f", + "sqlServerName": "Q314T-9n3E45" + }, + "responses": { + "200": { + "body": { + "properties": { + "machineOverviewList": [ + { + "machineArmId": "drp", + "displayName": "kuyzpqbwp", + "fciRole": "Unknown" + } + ], + "numberOfAgDatabases": 15, + "sqlFciProperties": { + "state": "Unknown", + "networkName": "rmtviuhjzclchzlbxmilstiyyeiog", + "isMultiSubnet": true, + "sharedDiskCount": 20 + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "version": "tfbqkojikxbwxoakxxtxcws", + "numberOfUserDatabases": 24, + "sumOfUserDatabasesSizeInMb": 6, + "tempDbSizeInMb": 18, + "maxServerMemoryInUseInMb": 6, + "visibleOnlineCoreCount": 29, + "numOfLogins": 21, + "physicalCpuCount": 5, + "logicalCpuCount": 15, + "engineEdition": "bfoxemlbxrmyvzx", + "edition": "llqytlpcqvajwpfjamlxcrji", + "isHighAvailabilityEnabled": true, + "isClustered": true, + "hyperthreadRatio": 26, + "sqlStartTime": "2024-01-18T11:34:40.998Z", + "machineArmIds": [ + "ywiossgpa" + ], + "runAsAccountId": "gqtjoshyvjykjjibx", + "hydratedRunAsAccountId": "hd", + "hostName": "mqvqsjreazqehniddq", + "sqlServerName": "qifikhrijdz", + "portNumber": 1, + "errors": [ + { + "message": "uj", + "messageParameters": { + "key2352": "jealqbinnkqarltzmfzzdnpbmgd" + }, + "applianceName": "lelyezprqfrlhgmehoybmqcyxi", + "id": 11, + "code": "rbwuopdepgrdbsoavituqxvffu", + "possibleCauses": "xhprtb", + "recommendedAction": "vverifrnstzifhwrqgkvivkoyq", + "severity": "twsg", + "summaryMessage": "ejzxjauuetbmkdpbidvqgenztju", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:34:38.739Z", + "runAsAccountId": "gewgggask", + "discoveryScope": "AppsAndRoles" + } + ], + "tags": { + "key2959": {} + }, + "isDeleted": true, + "createdTimestamp": "wnutepiayipsqiygvd", + "updatedTimestamp": "kzrprvrcornryihnsyv", + "status": "Unknown", + "provisioningState": "Created" + }, + "id": "sjvvfhhbfcjzmczgandb", + "name": "ppnzjw", + "type": "bnlihkpjsjeiqm", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlServersController_ListBySqlSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlServersController_ListBySqlSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..1ea0ad8b0191 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlServersController_ListBySqlSite_MaximumSet_Gen.json @@ -0,0 +1,110 @@ +{ + "title": "SqlServersController_ListBySqlSite", + "operationId": "SqlServersController_ListBySqlSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "nkbzqiwcfipfm", + "top": "xhiodhxc", + "continuationToken": "geeanbuozcah", + "totalRecordCount": 29, + "siteName": "-l-RL-C", + "sqlSiteName": "443s9KUxB35Eod363NW8qiZB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "machineOverviewList": [ + { + "machineArmId": "drp", + "displayName": "kuyzpqbwp", + "fciRole": "Unknown" + } + ], + "numberOfAgDatabases": 15, + "sqlFciProperties": { + "state": "Unknown", + "networkName": "rmtviuhjzclchzlbxmilstiyyeiog", + "isMultiSubnet": true, + "sharedDiskCount": 20 + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "version": "tfbqkojikxbwxoakxxtxcws", + "numberOfUserDatabases": 24, + "sumOfUserDatabasesSizeInMb": 6, + "tempDbSizeInMb": 18, + "maxServerMemoryInUseInMb": 6, + "visibleOnlineCoreCount": 29, + "numOfLogins": 21, + "physicalCpuCount": 5, + "logicalCpuCount": 15, + "engineEdition": "bfoxemlbxrmyvzx", + "edition": "llqytlpcqvajwpfjamlxcrji", + "isHighAvailabilityEnabled": true, + "isClustered": true, + "hyperthreadRatio": 26, + "sqlStartTime": "2024-01-18T11:34:40.998Z", + "machineArmIds": [ + "ywiossgpa" + ], + "runAsAccountId": "gqtjoshyvjykjjibx", + "hydratedRunAsAccountId": "hd", + "hostName": "mqvqsjreazqehniddq", + "sqlServerName": "qifikhrijdz", + "portNumber": 1, + "errors": [ + { + "message": "uj", + "messageParameters": { + "key2352": "jealqbinnkqarltzmfzzdnpbmgd" + }, + "applianceName": "lelyezprqfrlhgmehoybmqcyxi", + "id": 11, + "code": "rbwuopdepgrdbsoavituqxvffu", + "possibleCauses": "xhprtb", + "recommendedAction": "vverifrnstzifhwrqgkvivkoyq", + "severity": "twsg", + "summaryMessage": "ejzxjauuetbmkdpbidvqgenztju", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:34:38.739Z", + "runAsAccountId": "gewgggask", + "discoveryScope": "AppsAndRoles" + } + ], + "tags": { + "key2959": {} + }, + "isDeleted": true, + "createdTimestamp": "wnutepiayipsqiygvd", + "updatedTimestamp": "kzrprvrcornryihnsyv", + "status": "Unknown", + "provisioningState": "Created" + }, + "id": "sjvvfhhbfcjzmczgandb", + "name": "ppnzjw", + "type": "bnlihkpjsjeiqm", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlServersController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlServersController_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..7a1ec421ab09 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlServersController_Update_MaximumSet_Gen.json @@ -0,0 +1,148 @@ +{ + "title": "SqlServersController_Update", + "operationId": "SqlServersController_Update", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "1Jj-SVw-9c-I67KdU", + "sqlSiteName": "4-WOG1O-RF0Lm22-k61", + "sqlServerName": "8wB3t-37", + "body": { + "properties": { + "numberOfAgDatabases": 26, + "sqlFciProperties": { + "state": "Unknown", + "networkName": "rmtviuhjzclchzlbxmilstiyyeiog", + "isMultiSubnet": true, + "sharedDiskCount": 20 + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "version": "laneupphflqwaoeoqnjt", + "numberOfUserDatabases": 24, + "sumOfUserDatabasesSizeInMb": 20, + "tempDbSizeInMb": 28, + "maxServerMemoryInUseInMb": 8, + "visibleOnlineCoreCount": 14, + "numOfLogins": 14, + "physicalCpuCount": 22, + "logicalCpuCount": 15, + "engineEdition": "bddqdimixvuo", + "edition": "xzyqnupboa", + "isHighAvailabilityEnabled": true, + "isClustered": true, + "hyperthreadRatio": 29, + "sqlStartTime": "2024-01-18T11:34:43.726Z", + "runAsAccountId": "wo", + "hydratedRunAsAccountId": "dhfgeqy", + "hostName": "wjyokwswayhcfvcvgcxzsq", + "sqlServerName": "ixefej", + "portNumber": 8, + "tags": { + "key9912": {} + }, + "isDeleted": true, + "createdTimestamp": "zxzgzldsoouqabmjraprijr", + "updatedTimestamp": "aytchtagfrol", + "status": "Unknown", + "provisioningState": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "machineOverviewList": [ + { + "machineArmId": "drp", + "displayName": "kuyzpqbwp", + "fciRole": "Unknown" + } + ], + "numberOfAgDatabases": 26, + "sqlFciProperties": { + "state": "Unknown", + "networkName": "rmtviuhjzclchzlbxmilstiyyeiog", + "isMultiSubnet": true, + "sharedDiskCount": 20 + }, + "productSupportStatus": { + "currentVersion": "dlrvdqalihttfwvnnbskpzikdx", + "esuStatus": "Unknown", + "supportStatus": "Unknown", + "supportEndDate": "2024-01-18T11:33:22.395Z", + "esuYear": "Unknown" + }, + "version": "laneupphflqwaoeoqnjt", + "numberOfUserDatabases": 24, + "sumOfUserDatabasesSizeInMb": 20, + "tempDbSizeInMb": 28, + "maxServerMemoryInUseInMb": 8, + "visibleOnlineCoreCount": 14, + "numOfLogins": 14, + "physicalCpuCount": 22, + "logicalCpuCount": 15, + "engineEdition": "bddqdimixvuo", + "edition": "xzyqnupboa", + "isHighAvailabilityEnabled": true, + "isClustered": true, + "hyperthreadRatio": 29, + "sqlStartTime": "2024-01-18T11:34:43.726Z", + "machineArmIds": [ + "ywiossgpa" + ], + "runAsAccountId": "wo", + "hydratedRunAsAccountId": "dhfgeqy", + "hostName": "wjyokwswayhcfvcvgcxzsq", + "sqlServerName": "ixefej", + "portNumber": 8, + "errors": [ + { + "message": "uj", + "messageParameters": { + "key2352": "jealqbinnkqarltzmfzzdnpbmgd" + }, + "applianceName": "lelyezprqfrlhgmehoybmqcyxi", + "id": 11, + "code": "rbwuopdepgrdbsoavituqxvffu", + "possibleCauses": "xhprtb", + "recommendedAction": "vverifrnstzifhwrqgkvivkoyq", + "severity": "twsg", + "summaryMessage": "ejzxjauuetbmkdpbidvqgenztju", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:34:38.739Z", + "runAsAccountId": "gewgggask", + "discoveryScope": "AppsAndRoles" + } + ], + "tags": { + "key2959": {} + }, + "isDeleted": true, + "createdTimestamp": "zxzgzldsoouqabmjraprijr", + "updatedTimestamp": "aytchtagfrol", + "status": "Unknown", + "provisioningState": "Created" + }, + "id": "sjvvfhhbfcjzmczgandb", + "name": "ppnzjw", + "type": "bnlihkpjsjeiqm", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..e02cd0412152 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Create_MaximumSet_Gen.json @@ -0,0 +1,116 @@ +{ + "title": "SqlSitesController_Create", + "operationId": "SqlSitesController_Create", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "H9S6I-U9UI5-J1", + "sqlSiteName": "6G-FTRBDS-tN1-C6", + "body": { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate", + "provisioningState": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate", + "serviceEndpoint": "eksxpbzeeepoxesajchx", + "provisioningState": "Created" + }, + "id": "wzuukwbxquywru", + "name": "hdz", + "type": "wfkddjszhcrfwzyrzpjozvbc", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "body": { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate", + "serviceEndpoint": "eksxpbzeeepoxesajchx", + "provisioningState": "Created" + }, + "id": "wzuukwbxquywru", + "name": "hdz", + "type": "wfkddjszhcrfwzyrzpjozvbc", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..6c1b95cb2c83 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "SqlSitesController_Delete", + "operationId": "SqlSitesController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "31sL315xu-r-I--57", + "sqlSiteName": "B1L--Oc88B-" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ErrorSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ErrorSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..df2aed4848fa --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ErrorSummary_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "SqlSitesController_ErrorSummary", + "operationId": "SqlSitesController_ErrorSummary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-UuOu2u3503N4u-", + "sqlSiteName": "d9I452ZS--16", + "body": { + "applianceName": "gzmhffsahpaizswhjd" + } + }, + "responses": { + "200": { + "body": { + "applianceName": "rnwdayyamnbf", + "discoveryScopeErrorSummaries": { + "affectedResourceType": "eogpdpyddhvnf", + "affectedObjectsCount": 13, + "discoveryScope": "AppsAndRoles" + }, + "nextLink": "nctyxej" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ExportSqlServerErrors_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ExportSqlServerErrors_MaximumSet_Gen.json new file mode 100644 index 000000000000..63729caf6dd4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ExportSqlServerErrors_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "SqlSitesController_ExportSqlServerErrors", + "operationId": "SqlSitesController_ExportSqlServerErrors", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "--MfZ8WB2t2", + "sqlSiteName": "JBU240DBJ3---h", + "body": {} + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ExportSqlServers_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ExportSqlServers_MaximumSet_Gen.json new file mode 100644 index 000000000000..4fafb10319d7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ExportSqlServers_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "SqlSitesController_ExportSqlServers", + "operationId": "SqlSitesController_ExportSqlServers", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-N5360H5--qBr8Is-w", + "sqlSiteName": "3Wl-Ci0bT2WL2fV-W0w", + "body": { + "applianceName": "tkp", + "filter": "nqbzryzcxcedlytkm" + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8aafb1e29d6f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Get_MaximumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "title": "SqlSitesController_Get", + "operationId": "SqlSitesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "23-JjGjG2BVC362-8Nxd1", + "sqlSiteName": "sU5" + }, + "responses": { + "200": { + "body": { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate", + "serviceEndpoint": "eksxpbzeeepoxesajchx", + "provisioningState": "Created" + }, + "id": "wzuukwbxquywru", + "name": "hdz", + "type": "wfkddjszhcrfwzyrzpjozvbc", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ListByMasterSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ListByMasterSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..266680c52065 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_ListByMasterSite_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "SqlSitesController_ListByMasterSite", + "operationId": "SqlSitesController_ListByMasterSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "Xl-7X131NVGP1-12IT6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate", + "serviceEndpoint": "eksxpbzeeepoxesajchx", + "provisioningState": "Created" + }, + "id": "wzuukwbxquywru", + "name": "hdz", + "type": "wfkddjszhcrfwzyrzpjozvbc", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/avx" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Refresh_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Refresh_MaximumSet_Gen.json new file mode 100644 index 000000000000..dd2d34804842 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Refresh_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "SqlSitesController_Refresh", + "operationId": "SqlSitesController_Refresh", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "581DI4-", + "sqlSiteName": "-O0q2016L0-", + "body": { + "applianceName": "juzzwzjhcxdcpjypwshdccowqhrlw" + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Summary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Summary_MaximumSet_Gen.json new file mode 100644 index 000000000000..6fddf569dcc5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Summary_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "SqlSitesController_Summary", + "operationId": "SqlSitesController_Summary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "--5---", + "sqlSiteName": "P-S-pYLZ-" + }, + "responses": { + "200": { + "body": { + "serverCount": 6, + "databaseCount": 28, + "runAsAccountCount": 26 + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..79d6def29369 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/SqlSitesController_Update_MaximumSet_Gen.json @@ -0,0 +1,80 @@ +{ + "title": "SqlSitesController_Update", + "operationId": "SqlSitesController_Update", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "3d2XGeA6-15zBUX2QT-", + "sqlSiteName": "CK78r-15Q8DjE5-Q--RDC2N", + "properties": { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate", + "serviceEndpoint": "eksxpbzeeepoxesajchx", + "provisioningState": "Created" + }, + "id": "wzuukwbxquywru", + "name": "hdz", + "type": "wfkddjszhcrfwzyrzpjozvbc", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebApplicationsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebApplicationsController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..71935912d828 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebApplicationsController_Get_MaximumSet_Gen.json @@ -0,0 +1,114 @@ +{ + "title": "TomcatWebApplicationsController_Get", + "operationId": "TomcatWebApplicationsController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-I-Se69--5YB51-7N1uuad-", + "webAppSiteName": "7EFP5KH-27TE", + "webApplicationName": "272Y4n4m1LE7-VI7T6e9" + }, + "responses": { + "200": { + "body": { + "properties": { + "hasDatabaseDependency": true, + "isExternalLoggingConfigured": true, + "webServerId": "dbmanp", + "webServerName": "shenistndndiepdjjbwgzqqzj", + "machineArmIds": [ + "fzz" + ], + "virtualPath": "uqjlkxhbidvdkxmeldsqdedmno", + "physicalPath": "kzabkchfbgreppdfjzrreardpkd", + "bindings": [ + { + "protocol": "fudnxq", + "hostName": "tl", + "port": "hl", + "ipAddress": "rkroun" + } + ], + "frameworks": [ + { + "name": "xowbhljmhrl", + "version": "jcweyiaoeegmnfpfs" + } + ], + "configurations": [ + { + "name": "wf", + "filePath": "eswelqmambi", + "localFilePath": "qulownyukxcszlfcqvjxjpbeflwk", + "targetFilePath": "sonpnuozmrwzydphtilcgwc", + "section": "flzwaptkisefqxbensmjmwaf", + "type": "bqatpkvru", + "isDeploymentTimeEditable": true, + "identifier": "lvfcecfz" + } + ], + "directories": [ + { + "id": "fwlhspdqg", + "isEditable": true, + "sourcePaths": [ + "uyandieoincaetifjgsveivtjxnu" + ], + "localScratchPath": "yppozdjz", + "mountPath": "chapopfxntekfcklnexwxnu", + "sourceSize": "lavsassibqcrcehxqmbzyjdirxvi" + } + ], + "displayName": "yvwo", + "tags": { + "key5692": "kdnfguuqzgqbngciiacpvc" + }, + "staticFolders": [ + "xprflykanlhxurrqd" + ], + "machineDisplayName": "txk", + "isDeleted": true, + "createdTimestamp": "tzusghtpygxcvmejjnyzg", + "updatedTimestamp": "weozmsuczkicxcxpklfvz", + "serverType": "axikbbxzrozcitidczygsakiewcz", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applianceNames": [ + "bnyuybfmntdc" + ], + "hasErrors": true, + "provisioningState": "Created" + }, + "id": "hyhsewfvyvgqsduxuxmyfjxmc", + "name": "ptmuhpgbfgb", + "type": "akdrgnaonyjxsjaonfixbxh", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..404a3a31893d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json @@ -0,0 +1,122 @@ +{ + "title": "TomcatWebApplicationsController_ListByWebAppSite", + "operationId": "TomcatWebApplicationsController_ListByWebAppSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "pqthmiffkbedsovojrsyoycaeiopmr", + "top": "oubhhmensrtjazaqgy", + "continuationToken": "ekdewtcxctpl", + "totalRecordCount": 15, + "siteName": "O24L2C-110-07", + "webAppSiteName": "Q42tG-m" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "hasDatabaseDependency": true, + "isExternalLoggingConfigured": true, + "webServerId": "dbmanp", + "webServerName": "shenistndndiepdjjbwgzqqzj", + "machineArmIds": [ + "fzz" + ], + "virtualPath": "uqjlkxhbidvdkxmeldsqdedmno", + "physicalPath": "kzabkchfbgreppdfjzrreardpkd", + "bindings": [ + { + "protocol": "fudnxq", + "hostName": "tl", + "port": "hl", + "ipAddress": "rkroun" + } + ], + "frameworks": [ + { + "name": "xowbhljmhrl", + "version": "jcweyiaoeegmnfpfs" + } + ], + "configurations": [ + { + "name": "wf", + "filePath": "eswelqmambi", + "localFilePath": "qulownyukxcszlfcqvjxjpbeflwk", + "targetFilePath": "sonpnuozmrwzydphtilcgwc", + "section": "flzwaptkisefqxbensmjmwaf", + "type": "bqatpkvru", + "isDeploymentTimeEditable": true, + "identifier": "lvfcecfz" + } + ], + "directories": [ + { + "id": "fwlhspdqg", + "isEditable": true, + "sourcePaths": [ + "uyandieoincaetifjgsveivtjxnu" + ], + "localScratchPath": "yppozdjz", + "mountPath": "chapopfxntekfcklnexwxnu", + "sourceSize": "lavsassibqcrcehxqmbzyjdirxvi" + } + ], + "displayName": "yvwo", + "tags": { + "key5692": "kdnfguuqzgqbngciiacpvc" + }, + "staticFolders": [ + "xprflykanlhxurrqd" + ], + "machineDisplayName": "txk", + "isDeleted": true, + "createdTimestamp": "tzusghtpygxcvmejjnyzg", + "updatedTimestamp": "weozmsuczkicxcxpklfvz", + "serverType": "axikbbxzrozcitidczygsakiewcz", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applianceNames": [ + "bnyuybfmntdc" + ], + "hasErrors": true, + "provisioningState": "Created" + }, + "id": "hyhsewfvyvgqsduxuxmyfjxmc", + "name": "ptmuhpgbfgb", + "type": "akdrgnaonyjxsjaonfixbxh", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebApplicationsController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebApplicationsController_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..61708c63f448 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebApplicationsController_Update_MaximumSet_Gen.json @@ -0,0 +1,115 @@ +{ + "title": "TomcatWebApplicationsController_Update", + "operationId": "TomcatWebApplicationsController_Update", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "--q-", + "webAppSiteName": "Q-R--X2LvZ1287RtJV", + "webApplicationName": "0-tJW8Co10--5r", + "body": {} + }, + "responses": { + "200": { + "body": { + "properties": { + "hasDatabaseDependency": true, + "isExternalLoggingConfigured": true, + "webServerId": "dbmanp", + "webServerName": "shenistndndiepdjjbwgzqqzj", + "machineArmIds": [ + "fzz" + ], + "virtualPath": "uqjlkxhbidvdkxmeldsqdedmno", + "physicalPath": "kzabkchfbgreppdfjzrreardpkd", + "bindings": [ + { + "protocol": "fudnxq", + "hostName": "tl", + "port": "hl", + "ipAddress": "rkroun" + } + ], + "frameworks": [ + { + "name": "xowbhljmhrl", + "version": "jcweyiaoeegmnfpfs" + } + ], + "configurations": [ + { + "name": "wf", + "filePath": "eswelqmambi", + "localFilePath": "qulownyukxcszlfcqvjxjpbeflwk", + "targetFilePath": "sonpnuozmrwzydphtilcgwc", + "section": "flzwaptkisefqxbensmjmwaf", + "type": "bqatpkvru", + "isDeploymentTimeEditable": true, + "identifier": "lvfcecfz" + } + ], + "directories": [ + { + "id": "fwlhspdqg", + "isEditable": true, + "sourcePaths": [ + "uyandieoincaetifjgsveivtjxnu" + ], + "localScratchPath": "yppozdjz", + "mountPath": "chapopfxntekfcklnexwxnu", + "sourceSize": "lavsassibqcrcehxqmbzyjdirxvi" + } + ], + "displayName": "yvwo", + "tags": { + "key5692": "kdnfguuqzgqbngciiacpvc" + }, + "staticFolders": [ + "xprflykanlhxurrqd" + ], + "machineDisplayName": "txk", + "isDeleted": true, + "createdTimestamp": "tzusghtpygxcvmejjnyzg", + "updatedTimestamp": "weozmsuczkicxcxpklfvz", + "serverType": "axikbbxzrozcitidczygsakiewcz", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applianceNames": [ + "bnyuybfmntdc" + ], + "hasErrors": true, + "provisioningState": "Created" + }, + "id": "hyhsewfvyvgqsduxuxmyfjxmc", + "name": "ptmuhpgbfgb", + "type": "akdrgnaonyjxsjaonfixbxh", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebServersController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebServersController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ca3aa9031be5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebServersController_Get_MaximumSet_Gen.json @@ -0,0 +1,111 @@ +{ + "title": "TomcatWebServersController_Get", + "operationId": "TomcatWebServersController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "k-6Va3b", + "webAppSiteName": "K-G3Z----hB5iCI-Vrk2-1e", + "webServerName": "XTG25CRK3" + }, + "responses": { + "200": { + "body": { + "properties": { + "services": [ + { + "name": "mznuifwxwgze", + "connectors": [ + { + "bindings": [ + { + "protocol": "fudnxq", + "hostName": "tl", + "port": "hl", + "ipAddress": "rkroun" + } + ] + } + ], + "engine": { + "name": "crvydd", + "hosts": [ + { + "name": "uuyhblmtzkbuxqbljikddahfrlvw", + "appBasePath": "tah", + "appBase": "sfbznfroovixqrqawspf" + } + ] + } + } + ], + "catalinaHome": "fduysiabboaxffoiwa", + "jvmVersion": "vfqof", + "sessionPersistenceMechanism": "wg", + "isClusteringPresent": true, + "isMemoryRealmPresent": true, + "isSessionTrackingPresent": true, + "isAccessLogValvePresent": true, + "maxMemoryUsageInMb": "vdhcpnpdkriajheexsmi", + "configurationLocation": "trrzlwcfwfuxage", + "version": "lxqxguno", + "machineIds": [ + "qqpvcvfmrigduyvzs" + ], + "webApplications": [ + "ibtkorpeupjn" + ], + "displayName": "tkjbdixwkc", + "serverFqdn": "jnmhgjmzhsyzyunu", + "runAsAccountId": "nojul", + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "isDeleted": true, + "createdTimestamp": "pwfvaebjcdtethubzpxf", + "updatedTimestamp": "fzufhqtvdohdtpukdrr", + "serverType": "xvpeldcweziqypi", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applianceNames": [ + "vreqqtphx" + ], + "hasErrors": true, + "provisioningState": "Created" + }, + "id": "mqdsdqooeoxwk", + "name": "fhfxcu", + "type": "uxhgkdohfdlzljmltslbqewv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebServersController_ListByWebAppSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebServersController_ListByWebAppSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..60d386070093 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/TomcatWebServersController_ListByWebAppSite_MaximumSet_Gen.json @@ -0,0 +1,119 @@ +{ + "title": "TomcatWebServersController_ListByWebAppSite", + "operationId": "TomcatWebServersController_ListByWebAppSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "uz", + "top": "ooxecqdsurfkukapcyzwuup", + "continuationToken": "uhtfmegilaoyqpauxlqyr", + "totalRecordCount": 11, + "siteName": "CiWt8C-g2L6fUZ3K3-h", + "webAppSiteName": "8l-C33-rp-V-4-PS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "services": [ + { + "name": "mznuifwxwgze", + "connectors": [ + { + "bindings": [ + { + "protocol": "fudnxq", + "hostName": "tl", + "port": "hl", + "ipAddress": "rkroun" + } + ] + } + ], + "engine": { + "name": "crvydd", + "hosts": [ + { + "name": "uuyhblmtzkbuxqbljikddahfrlvw", + "appBasePath": "tah", + "appBase": "sfbznfroovixqrqawspf" + } + ] + } + } + ], + "catalinaHome": "fduysiabboaxffoiwa", + "jvmVersion": "vfqof", + "sessionPersistenceMechanism": "wg", + "isClusteringPresent": true, + "isMemoryRealmPresent": true, + "isSessionTrackingPresent": true, + "isAccessLogValvePresent": true, + "maxMemoryUsageInMb": "vdhcpnpdkriajheexsmi", + "configurationLocation": "trrzlwcfwfuxage", + "version": "lxqxguno", + "machineIds": [ + "qqpvcvfmrigduyvzs" + ], + "webApplications": [ + "ibtkorpeupjn" + ], + "displayName": "tkjbdixwkc", + "serverFqdn": "jnmhgjmzhsyzyunu", + "runAsAccountId": "nojul", + "operatingSystemDetails": { + "osType": "s", + "osName": "udcjzawhhylqauidhrau", + "osVersion": "jzblxvpzhmqdpmot", + "osArchitecture": "lxeotrwmodham" + }, + "isDeleted": true, + "createdTimestamp": "pwfvaebjcdtethubzpxf", + "updatedTimestamp": "fzufhqtvdohdtpukdrr", + "serverType": "xvpeldcweziqypi", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applianceNames": [ + "vreqqtphx" + ], + "hasErrors": true, + "provisioningState": "Created" + }, + "id": "mqdsdqooeoxwk", + "name": "fhfxcu", + "type": "uxhgkdohfdlzljmltslbqewv", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/afqp" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..202f11092ad1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_Create_MaximumSet_Gen.json @@ -0,0 +1,117 @@ +{ + "title": "VcenterController_Create", + "operationId": "VcenterController_Create", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "6T42r-99CFg-44-gFP", + "vcenterName": "23LDJ0XB7UT-L", + "body": { + "properties": { + "runAsAccountId": "pqbieohxxmfri", + "fqdn": "fuclodcnofphkcrnex", + "port": "bdospcacndrchuqluozmwrvetxul", + "friendlyName": "qvycnab", + "provisioningState": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "runAsAccountId": "pqbieohxxmfri", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "createdTimestamp": "qalbyynskmyrgnmdtahu", + "updatedTimestamp": "qrpbthaffififueozyufbjixhwfv", + "fqdn": "fuclodcnofphkcrnex", + "port": "bdospcacndrchuqluozmwrvetxul", + "version": "wvfasmovriuczzdbqzcujil", + "perfStatisticsLevel": "vedklpuapabnvcqo", + "instanceUuid": "kxkqxmbaoxmmmbgefrmriqdtxkt", + "friendlyName": "qvycnab", + "provisioningState": "Created" + }, + "id": "xmuzhktwmmuatndkvz", + "name": "ziadgvbgdceiuody", + "type": "ozamvaofsjyiiwisjyvxceisbqhhq", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "runAsAccountId": "pqbieohxxmfri", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "createdTimestamp": "qalbyynskmyrgnmdtahu", + "updatedTimestamp": "qrpbthaffififueozyufbjixhwfv", + "fqdn": "fuclodcnofphkcrnex", + "port": "bdospcacndrchuqluozmwrvetxul", + "version": "wvfasmovriuczzdbqzcujil", + "perfStatisticsLevel": "vedklpuapabnvcqo", + "instanceUuid": "kxkqxmbaoxmmmbgefrmriqdtxkt", + "friendlyName": "qvycnab", + "provisioningState": "Created" + }, + "id": "xmuzhktwmmuatndkvz", + "name": "ziadgvbgdceiuody", + "type": "ozamvaofsjyiiwisjyvxceisbqhhq", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..48fe4eb8e707 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "VcenterController_Delete", + "operationId": "VcenterController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "--7S0K36vH3", + "vcenterName": "-A-J8R7E-g0" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b12b9e5484d1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_Get_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "VcenterController_Get", + "operationId": "VcenterController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-C6Jvk-M633YBJ-7", + "vcenterName": "LN54" + }, + "responses": { + "200": { + "body": { + "properties": { + "runAsAccountId": "pqbieohxxmfri", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "createdTimestamp": "qalbyynskmyrgnmdtahu", + "updatedTimestamp": "qrpbthaffififueozyufbjixhwfv", + "fqdn": "fuclodcnofphkcrnex", + "port": "bdospcacndrchuqluozmwrvetxul", + "version": "wvfasmovriuczzdbqzcujil", + "perfStatisticsLevel": "vedklpuapabnvcqo", + "instanceUuid": "kxkqxmbaoxmmmbgefrmriqdtxkt", + "friendlyName": "qvycnab", + "provisioningState": "Created" + }, + "id": "xmuzhktwmmuatndkvz", + "name": "ziadgvbgdceiuody", + "type": "ozamvaofsjyiiwisjyvxceisbqhhq", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_ListByVmwareSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_ListByVmwareSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..3ff2ef92b33f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VcenterController_ListByVmwareSite_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "title": "VcenterController_ListByVmwareSite", + "operationId": "VcenterController_ListByVmwareSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "rcuubwpajsuhfxhtlerkiy", + "siteName": "OCJ-c8qUW" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "runAsAccountId": "pqbieohxxmfri", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "createdTimestamp": "qalbyynskmyrgnmdtahu", + "updatedTimestamp": "qrpbthaffififueozyufbjixhwfv", + "fqdn": "fuclodcnofphkcrnex", + "port": "bdospcacndrchuqluozmwrvetxul", + "version": "wvfasmovriuczzdbqzcujil", + "perfStatisticsLevel": "vedklpuapabnvcqo", + "instanceUuid": "kxkqxmbaoxmmmbgefrmriqdtxkt", + "friendlyName": "qvycnab", + "provisioningState": "Created" + }, + "id": "xmuzhktwmmuatndkvz", + "name": "ziadgvbgdceiuody", + "type": "ozamvaofsjyiiwisjyvxceisbqhhq", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareHostController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareHostController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..fe7b24dfd9eb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareHostController_Get_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "VmwareHostController_Get", + "operationId": "VmwareHostController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "--nML9b2DN", + "hostName": "22DhjSY-hN--KES1" + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "rdludwgkakckzytyvejkxuknhvbb", + "updatedTimestamp": "irpfpzfwuiknoqziflxley", + "datastores": [ + { + "uuid": "chnnbbrqf", + "capacityInGb": 10, + "freeSpaceInGb": 3, + "type": "Unknown", + "symbolicName": "voytemkbghy" + } + ], + "vcenterId": "nuk", + "uuid": "fbwqsplm", + "applianceNames": [ + "uyrtncto" + ], + "provisioningState": "Created" + }, + "id": "vgjlnpd", + "name": "qbxjnxekby", + "type": "hhvvplmdxpqzqi", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareHostController_ListByVmwareSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareHostController_ListByVmwareSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..e73c544d8fdb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareHostController_ListByVmwareSite_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "VmwareHostController_ListByVmwareSite", + "operationId": "VmwareHostController_ListByVmwareSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "xK6Lq" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "rdludwgkakckzytyvejkxuknhvbb", + "updatedTimestamp": "irpfpzfwuiknoqziflxley", + "datastores": [ + { + "uuid": "chnnbbrqf", + "capacityInGb": 10, + "freeSpaceInGb": 3, + "type": "Unknown", + "symbolicName": "voytemkbghy" + } + ], + "vcenterId": "nuk", + "uuid": "fbwqsplm", + "applianceNames": [ + "uyrtncto" + ], + "provisioningState": "Created" + }, + "id": "vgjlnpd", + "name": "qbxjnxekby", + "type": "hhvvplmdxpqzqi", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareOperationsStatus_GetVmwareOperationStatus_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareOperationsStatus_GetVmwareOperationStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..f7bfc9bc9bc8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareOperationsStatus_GetVmwareOperationStatus_MaximumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "title": "VmwareOperationsStatus_GetVmwareOperationStatus", + "operationId": "VmwareOperationsStatus_GetVmwareOperationStatus", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "KQc-", + "operationStatusName": "-OFD3s3B7" + }, + "responses": { + "200": { + "body": { + "id": "p", + "name": "bcvvgkxeeavuxwhhcuhlr", + "status": "xdwtanilfmuuhjnanaxclrds", + "startTime": "dqgff", + "endTime": "putnpglwoqfdhjkk", + "error": { + "code": "rnsnhdowwptegdldklx", + "message": "qolsunkhecgpjxm" + }, + "properties": { + "result": "wvhlgcgdktttlozc" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateDependencyMapStatus_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateDependencyMapStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..1086c76e1bf2 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateDependencyMapStatus_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "VmwarePropertiesController_UpdateDependencyMapStatus", + "operationId": "VmwarePropertiesController_UpdateDependencyMapStatus", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "28-HV9tQM1", + "updateMachineDepMapStatus": { + "machines": [ + { + "machineId": "ysqizqtyaskpprxkqaeyyopln", + "isDependencyMapToBeEnabled": true + } + ] + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateProperties_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateProperties_MaximumSet_Gen.json new file mode 100644 index 000000000000..99cb26d9ba45 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateProperties_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "VmwarePropertiesController_UpdateProperties", + "operationId": "VmwarePropertiesController_UpdateProperties", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "6KX3-k6-DI5Q8F4-DL", + "metaData": { + "value": [ + { + "machineArmId": "cbfxbnpaesafshmuirygemyx", + "dependencyMapping": "mehkbjgdktlveubatdamkaawrfmkwc", + "tags": { + "key925": "kvcnqygwaiw" + } + } + ] + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateRunAsAccount_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateRunAsAccount_MaximumSet_Gen.json new file mode 100644 index 000000000000..a22e7ebc18dd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateRunAsAccount_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "VmwarePropertiesController_UpdateRunAsAccount", + "operationId": "VmwarePropertiesController_UpdateRunAsAccount", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-W-23QKS0b64587ELqr-6", + "updateMachineRunAsAccount": { + "machines": [ + { + "machineId": "ycjcjjlckiyjfinswx", + "runAsAccountId": "obsx" + } + ] + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateTags_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateTags_MaximumSet_Gen.json new file mode 100644 index 000000000000..a1b69bee0410 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwarePropertiesController_UpdateTags_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "title": "VmwarePropertiesController_UpdateTags", + "operationId": "VmwarePropertiesController_UpdateTags", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "m4-x-6-0n5qM33WWM5", + "updateMachineTags": { + "machines": [ + { + "machineId": "qunrgqsyhzqwugvgr", + "tags": { + "key7333": "horsaf" + } + } + ] + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json new file mode 100644 index 000000000000..34cb2d2706a9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json @@ -0,0 +1,113 @@ +{ + "title": "VmwareSoftwareInventoriesController_GetMachineSoftwareInventory", + "operationId": "VmwareSoftwareInventoriesController_GetMachineSoftwareInventory", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-F6ViTRve-A7173v3", + "machineName": "62Ly", + "default": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "provisioningState": "Created" + }, + "id": "ybzcfibjlodae", + "name": "xrstfqdjpqhihkxhb", + "type": "svygpzrcokhrlecishzzfkyyw", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..f1b65490bc26 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen.json @@ -0,0 +1,117 @@ +{ + "title": "VmwareSoftwareInventoriesController_ListByMachineResource", + "operationId": "VmwareSoftwareInventoriesController_ListByMachineResource", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "F-piD", + "machineName": "4pY-V1i-S-Q-tJ-CW" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "appsAndRoles": { + "applications": [ + { + "name": "nhykxcuz", + "version": "zzifrowbtmhrfeviug", + "provider": "ipduopclufvuuvvhubyc" + } + ], + "webApplications": [ + { + "name": "amkzkbrgntaugwotxvot", + "status": "zebxlaadkeaoz", + "platform": "o", + "groupName": "byxouhoctqapdnlznunbpb", + "webServer": "mjki", + "applicationPool": "sdiimecfhxbqmydirooirm" + } + ], + "features": [ + { + "name": "rnivmwyhqtwamczkwan", + "featureType": "sswrenqqrbn", + "parent": "sgfchkminltlkeuae", + "status": "twexfrlxnwckexycpwzf" + } + ], + "sqlServers": [ + { + "name": "jtxesvuwwsurgdurdvnrzjg", + "edition": "zwgiipsypytxpippcddd", + "servicePack": "wy", + "version": "azlseazxoopnbcwsuwskrotir", + "clustered": "ozwkz", + "clusterName": "kqwxdeibbpabvob", + "dnsHostName": "dvm", + "port": "bwcwwbsybkauhjltidsp", + "commaSeparatedIps": "hqeq", + "status": "xy", + "isNamedPipeEnabled": true, + "isTcpIpEnabled": true, + "namedPipeName": "iwmdys" + } + ], + "sharePointServers": [ + { + "productName": "a", + "isEnterprise": true, + "status": "rusnuoaxkpyznijqgecqdam", + "version": "tfriifimyiklpnjenuowmbfkokpa" + } + ], + "systemCenters": [ + { + "productName": "lztaowwezrywrzynyfqd", + "status": "vnzlbiafefulmdresrfgmqatmarh", + "version": "ajogpwulbnysyder" + } + ], + "bizTalkServers": [ + { + "productName": "mrcuuqn", + "status": "zeqagyeutsppkaizngtavt" + } + ], + "exchangeServers": [ + { + "productName": "hzljgkzuavtuipihht", + "edition": "imdneit", + "roles": "ipg", + "servicePack": "cfybpgrogobwrhgalpgodtm", + "version": "hgxgggoofflzcjfcghexptxtp" + } + ], + "otherDatabases": [ + { + "databaseType": "oolcjudmlfxnidckmbauzwj", + "instance": "wltcvbeirvzafyjynvhvvgkfsf", + "version": "opyphalbeh" + } + ] + }, + "provisioningState": "Created" + }, + "id": "ybzcfibjlodae", + "name": "xrstfqdjpqhihkxhb", + "type": "svygpzrcokhrlecishzzfkyyw", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..1bcd74538b84 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_Create_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "WebAppDiscoverySiteDataSourcesController_Create", + "operationId": "WebAppDiscoverySiteDataSourcesController_Create", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "3363G4K-7-XWJ7384S", + "webAppSiteName": "42883RRtL4-CE155--u65v-", + "discoverySiteDataSourceName": "XJ-V535YCO5L3PIWdB", + "body": { + "properties": { + "discoverySiteId": "gsqqojvnjtbdabo", + "provisioningState": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "discoverySiteId": "gsqqojvnjtbdabo", + "provisioningState": "Created" + }, + "id": "hxykidmhnalalnwhjhewwjtzfoxb", + "name": "ctlzidatxazufjrtysorbfum", + "type": "srogdrnuypeaegefwjasibdk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "discoverySiteId": "gsqqojvnjtbdabo", + "provisioningState": "Created" + }, + "id": "hxykidmhnalalnwhjhewwjtzfoxb", + "name": "ctlzidatxazufjrtysorbfum", + "type": "srogdrnuypeaegefwjasibdk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..8de3251eb4bf --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_Delete_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "WebAppDiscoverySiteDataSourcesController_Delete", + "operationId": "WebAppDiscoverySiteDataSourcesController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-1B---62T", + "webAppSiteName": "o23W", + "discoverySiteDataSourceName": "3DZE3-3m7E3-3Mk-" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a06794af5f5e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_Get_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "WebAppDiscoverySiteDataSourcesController_Get", + "operationId": "WebAppDiscoverySiteDataSourcesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "-24n-4KK8rOJOa0", + "webAppSiteName": "RS01YYEI-KQ6t-pke", + "discoverySiteDataSourceName": "bS4N-Ve77I3" + }, + "responses": { + "200": { + "body": { + "properties": { + "discoverySiteId": "gsqqojvnjtbdabo", + "provisioningState": "Created" + }, + "id": "hxykidmhnalalnwhjhewwjtzfoxb", + "name": "ctlzidatxazufjrtysorbfum", + "type": "srogdrnuypeaegefwjasibdk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_ListByWebAppSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_ListByWebAppSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..e7042c1dfd3e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppDiscoverySiteDataSourcesController_ListByWebAppSite_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "WebAppDiscoverySiteDataSourcesController_ListByWebAppSite", + "operationId": "WebAppDiscoverySiteDataSourcesController_ListByWebAppSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "5-ECR-5-2", + "webAppSiteName": "8F7p-t-SVxV" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "discoverySiteId": "gsqqojvnjtbdabo", + "provisioningState": "Created" + }, + "id": "hxykidmhnalalnwhjhewwjtzfoxb", + "name": "ctlzidatxazufjrtysorbfum", + "type": "srogdrnuypeaegefwjasibdk", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppExtendedMachinesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppExtendedMachinesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..07afaa9cbe57 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppExtendedMachinesController_Get_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "WebAppExtendedMachinesController_Get", + "operationId": "WebAppExtendedMachinesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "6vhV3", + "webAppSiteName": "3Q4fch0Jg-ZDO4Q-6Fr5A683", + "extendedMachineName": "76-vIS678Y3GPD2-GW6X86" + }, + "responses": { + "200": { + "body": { + "properties": { + "isDeleted": true, + "createdTimestamp": "toyksrlkmisofqscykysum", + "updatedTimestamp": "wimalfiohwmwsuriqshtjvgltm", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hostName": "ilmfanzflpkle", + "machineDisplayName": "qxkpplxuedvhpmdxkajyxicniplel", + "machineId": "jsdzngaxkitmiryicmbjfsoh", + "runAsAccountId": "bkty", + "hydratedRunAsAccountId": "dy", + "provisioningState": "Created" + }, + "id": "eckaxnvnugdhbxq", + "name": "odsucusxxd", + "type": "tlhqdgwzitxevwrvpsmsvxophtgvbe", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppExtendedMachinesController_ListByWebAppSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppExtendedMachinesController_ListByWebAppSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..aef859eff6a3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppExtendedMachinesController_ListByWebAppSite_MaximumSet_Gen.json @@ -0,0 +1,67 @@ +{ + "title": "WebAppExtendedMachinesController_ListByWebAppSite", + "operationId": "WebAppExtendedMachinesController_ListByWebAppSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "rhaejmhmzdqgfjaxobbezavqyttqo", + "top": "d", + "continuationToken": "kgwexrv", + "totalRecordCount": 23, + "siteName": "4UInM", + "webAppSiteName": "g6I16C15-2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "isDeleted": true, + "createdTimestamp": "toyksrlkmisofqscykysum", + "updatedTimestamp": "wimalfiohwmwsuriqshtjvgltm", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "hostName": "ilmfanzflpkle", + "machineDisplayName": "qxkpplxuedvhpmdxkajyxicniplel", + "machineId": "jsdzngaxkitmiryicmbjfsoh", + "runAsAccountId": "bkty", + "hydratedRunAsAccountId": "dy", + "provisioningState": "Created" + }, + "id": "eckaxnvnugdhbxq", + "name": "odsucusxxd", + "type": "tlhqdgwzitxevwrvpsmsvxophtgvbe", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppPropertiesController_UpdateProperties_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppPropertiesController_UpdateProperties_MaximumSet_Gen.json new file mode 100644 index 000000000000..17ff83ce9ff0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppPropertiesController_UpdateProperties_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "title": "WebAppPropertiesController_UpdateProperties", + "operationId": "WebAppPropertiesController_UpdateProperties", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "09u", + "webAppSiteName": "-K-X85Go-QY1INX-H34", + "body": { + "webApps": [ + { + "webAppArmId": "ytmkdtigfuip", + "tags": { + "key7358": "wfxubzp" + } + } + ] + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppRunAsAccountsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppRunAsAccountsController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..d7d019d22f06 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppRunAsAccountsController_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "WebAppRunAsAccountsController_Get", + "operationId": "WebAppRunAsAccountsController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "5V-AedeyXMe23Fd5-s97VP", + "webAppSiteName": "S28O-LQJ", + "accountName": "YGHg41E44" + }, + "responses": { + "200": { + "body": { + "properties": { + "displayName": "jisgaadoxsjdfbz", + "credentialType": "zjlboeqftmfeafhmaf", + "createdTimestamp": "wgrjz", + "updatedTimestamp": "lqvvxyngsjskvx", + "applianceName": "fbicoeqjjfpfpadaewfuea", + "provisioningState": "Created" + }, + "id": "orqskindw", + "name": "ohggfuf", + "type": "jdkfcveku", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppRunAsAccountsController_ListByWebAppSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppRunAsAccountsController_ListByWebAppSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..0a1c9d7cebc6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppRunAsAccountsController_ListByWebAppSite_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "WebAppRunAsAccountsController_ListByWebAppSite", + "operationId": "WebAppRunAsAccountsController_ListByWebAppSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "5C7-95863tPMCn", + "webAppSiteName": "2QX1-0-1442ND-a-6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "jisgaadoxsjdfbz", + "credentialType": "zjlboeqftmfeafhmaf", + "createdTimestamp": "wgrjz", + "updatedTimestamp": "lqvvxyngsjskvx", + "applianceName": "fbicoeqjjfpfpadaewfuea", + "provisioningState": "Created" + }, + "id": "orqskindw", + "name": "ohggfuf", + "type": "jdkfcveku", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..63ae8d0d5a2e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Create_MaximumSet_Gen.json @@ -0,0 +1,116 @@ +{ + "title": "WebAppSitesController_Create", + "operationId": "WebAppSitesController_Create", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "57NK0P6SR1J11IDI-JyJ9", + "webAppSiteName": "5-oF2-s1LNU0-NQ820gA4D4t", + "body": { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate", + "provisioningState": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate", + "serviceEndpoint": "mjhcoxmytulvpgyycvywplr", + "provisioningState": "Created" + }, + "id": "wvmwryywzadjdf", + "name": "mgccpv", + "type": "wepbunl", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "201": { + "body": { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate", + "serviceEndpoint": "mjhcoxmytulvpgyycvywplr", + "provisioningState": "Created" + }, + "id": "wvmwryywzadjdf", + "name": "mgccpv", + "type": "wepbunl", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a51d9e4f1f59 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "WebAppSitesController_Delete", + "operationId": "WebAppSitesController_Delete", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "O27S7Y1p6--4y-8ZuX-Rm51", + "webAppSiteName": "R9K0M3-5DM25-LL--9" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_ErrorSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_ErrorSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..0aee7f807f47 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_ErrorSummary_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "WebAppSitesController_ErrorSummary", + "operationId": "WebAppSitesController_ErrorSummary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "sJ7O7OpAw5-g-E-AB3", + "webAppSiteName": "X-7-3V9M6tG621bM", + "body": { + "applianceName": "gzmhffsahpaizswhjd" + } + }, + "responses": { + "200": { + "body": { + "applianceName": "rnwdayyamnbf", + "discoveryScopeErrorSummaries": { + "affectedResourceType": "eogpdpyddhvnf", + "affectedObjectsCount": 13, + "discoveryScope": "AppsAndRoles" + }, + "nextLink": "nctyxej" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_ExportInventory_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_ExportInventory_MaximumSet_Gen.json new file mode 100644 index 000000000000..d079caf69ffd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_ExportInventory_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "WebAppSitesController_ExportInventory", + "operationId": "WebAppSitesController_ExportInventory", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "z6IFGJv4C4pIJ-4", + "webAppSiteName": "V5UoS68X-X", + "body": { + "filter": "ujgnemjnwfrgzmnwx" + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..bf00140e7029 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Get_MaximumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "title": "WebAppSitesController_Get", + "operationId": "WebAppSitesController_Get", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "N82", + "webAppSiteName": "B0Mt17X-xB71D22F" + }, + "responses": { + "200": { + "body": { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate", + "serviceEndpoint": "mjhcoxmytulvpgyycvywplr", + "provisioningState": "Created" + }, + "id": "wvmwryywzadjdf", + "name": "mgccpv", + "type": "wepbunl", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_ListByMasterSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_ListByMasterSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..c4c4d80aca85 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_ListByMasterSite_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "WebAppSitesController_ListByMasterSite", + "operationId": "WebAppSitesController_ListByMasterSite", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "RNY-Gz6PP" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate", + "serviceEndpoint": "mjhcoxmytulvpgyycvywplr", + "provisioningState": "Created" + }, + "id": "wvmwryywzadjdf", + "name": "mgccpv", + "type": "wepbunl", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Refresh_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Refresh_MaximumSet_Gen.json new file mode 100644 index 000000000000..3833bd542431 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Refresh_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "WebAppSitesController_Refresh", + "operationId": "WebAppSitesController_Refresh", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "8xJ911PM-8G7", + "webAppSiteName": "YQ5246", + "body": { + "applianceName": "yovbznk" + } + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Summary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Summary_MaximumSet_Gen.json new file mode 100644 index 000000000000..99d5514b758e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Summary_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "WebAppSitesController_Summary", + "operationId": "WebAppSitesController_Summary", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "---3nO", + "webAppSiteName": "CXDHwGq-M1BS" + }, + "responses": { + "200": { + "body": { + "webServerCount": 28, + "webApplicationCount": 4, + "runAsAccountCount": 5 + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..7280ae42a0d2 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebAppSitesController_Update_MaximumSet_Gen.json @@ -0,0 +1,80 @@ +{ + "title": "WebAppSitesController_Update", + "operationId": "WebAppSitesController_Update", + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "siteName": "W03x2---1q9-poH3021XK-8", + "webAppSiteName": "8-8UX--E--B-0575gI55p", + "properties": { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "siteAppliancePropertiesCollection": [ + { + "servicePrincipalIdentityDetails": { + "tenantId": "aqvsxunpdlrxclnpudkykycsdf", + "applicationId": "lg", + "objectId": "etkbysdzluxvpxkciooxjjmvl", + "audience": "emwqxwwqqzwk", + "aadAuthority": "pykd", + "rawCertData": "kewdmdjrt" + }, + "agentDetails": { + "id": "zsj", + "version": "wcsdgdjauizxcvwagnirwmos", + "lastHeartBeatUtc": "2024-01-18T11:33:01.669Z", + "keyVaultUri": "w", + "keyVaultId": "chqtsrpahfayfuqrusmbakvgdqny" + }, + "applianceName": "jqv" + } + ], + "discoveryScenario": "Migrate", + "serviceEndpoint": "mjhcoxmytulvpgyycvywplr", + "provisioningState": "Created" + }, + "id": "wvmwryywzadjdf", + "name": "mgccpv", + "type": "wepbunl", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..d7188b7a47d6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json @@ -0,0 +1,120 @@ +{ + "title": "WebApplicationsController_ListByWebAppSite", + "operationId": "WebApplicationsController_ListByWebAppSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "sppraliqikucazwbmqndoniulswuq", + "top": "hepxvxoqtapedstjargosg", + "continuationToken": "baubpiaxoy", + "totalRecordCount": 17, + "siteName": "-611-z", + "webAppSiteName": "R-5y3W52-2V" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webServerId": "wbzaoqxisuq", + "webServerName": "bjeqkkcdwgvctgosuxowtsbad", + "machineArmIds": [ + "yywrizjbgyrg" + ], + "virtualPath": "bwlnijihibdypzsdu", + "physicalPath": "xygranczqvhbnc", + "bindings": [ + { + "protocol": "fudnxq", + "hostName": "tl", + "port": "hl", + "ipAddress": "rkroun" + } + ], + "frameworks": [ + { + "name": "xowbhljmhrl", + "version": "jcweyiaoeegmnfpfs" + } + ], + "configurations": [ + { + "name": "wf", + "filePath": "eswelqmambi", + "localFilePath": "qulownyukxcszlfcqvjxjpbeflwk", + "targetFilePath": "sonpnuozmrwzydphtilcgwc", + "section": "flzwaptkisefqxbensmjmwaf", + "type": "bqatpkvru", + "isDeploymentTimeEditable": true, + "identifier": "lvfcecfz" + } + ], + "directories": [ + { + "id": "fwlhspdqg", + "isEditable": true, + "sourcePaths": [ + "uyandieoincaetifjgsveivtjxnu" + ], + "localScratchPath": "yppozdjz", + "mountPath": "chapopfxntekfcklnexwxnu", + "sourceSize": "lavsassibqcrcehxqmbzyjdirxvi" + } + ], + "displayName": "ijhbedgfcyoxz", + "tags": { + "key5884": "xrluacm" + }, + "staticFolders": [ + "shrhglzeciyfjknvdzuzzf" + ], + "machineDisplayName": "g", + "isDeleted": true, + "createdTimestamp": "shqibvopopbhncqbhlehkiadz", + "updatedTimestamp": "bskjxhcvegylfzjgcegaiandq", + "serverType": "fj", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applianceNames": [ + "pjtdmknkbwb" + ], + "hasErrors": true, + "provisioningState": "Created" + }, + "id": "qbmbsrwznryxxhzhucbprw", + "name": "xkezaiqrewdry", + "type": "dxkdct", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebServersController_ListByWebAppSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebServersController_ListByWebAppSite_MaximumSet_Gen.json new file mode 100644 index 000000000000..42d7f5890ea8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/examples/WebServersController_ListByWebAppSite_MaximumSet_Gen.json @@ -0,0 +1,78 @@ +{ + "title": "WebServersController_ListByWebAppSite", + "operationId": "WebServersController_ListByWebAppSite", + "parameters": { + "subscriptionId": "BCE48E0E-6240-491D-A4D4-4306580B1B82", + "resourceGroupName": "rgmigrate", + "api-version": "2023-10-01-preview", + "filter": "jfbamvasjkosxoan", + "top": "pgrtvok", + "continuationToken": "dokmhdjbzqiaiavmfzisvgitdbpmf", + "totalRecordCount": 6, + "siteName": "46I23G-V8AOSK3", + "webAppSiteName": "n137S-OG8F--2w" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "configurationLocation": "gecqk", + "version": "ccxowtoxwafhfzrg", + "machineIds": [ + "eraaklululklmoqzabsev" + ], + "webApplications": [ + "rl" + ], + "displayName": "mvymxzsjo", + "serverFqdn": "vhkdwespvxtlzxsu", + "runAsAccountId": "jziv", + "isDeleted": true, + "createdTimestamp": "qnmco", + "updatedTimestamp": "fdomultlbvbsiiuie", + "serverType": "niegt", + "errors": [ + { + "message": "ephqvsyi", + "messageParameters": { + "key7908": "qgwrwvqk" + }, + "applianceName": "elhdiydqcrfrpraucqsaqlihfrjyv", + "id": 3, + "code": "rvrpazvszmfshilemvw", + "possibleCauses": "pfpyhjclfsyntzhhuzgp", + "recommendedAction": "txrdrgslalklpisybjewaxpmwybeeh", + "severity": "zntocrlidptkzxuybhyxizopexuhe", + "summaryMessage": "usnmmggkxekgojcfjm", + "source": "RefreshFabricLayout", + "updatedTimeStamp": "2024-01-18T11:33:09.118Z", + "runAsAccountId": "zeieprmswjmxycipoxhgqhup", + "discoveryScope": "AppsAndRoles" + } + ], + "applianceNames": [ + "yk" + ], + "hasErrors": true, + "provisioningState": "Created" + }, + "id": "afmclvx", + "name": "nvpfolzhmhyeastj", + "type": "qvuenwdw", + "systemData": { + "createdBy": "piunzgrzyftwinofhv", + "createdByType": "User", + "createdAt": "2024-01-18T11:33:01.670Z", + "lastModifiedBy": "ljaocingjzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-18T11:33:01.670Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/migrate.json b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/migrate.json new file mode 100644 index 000000000000..b3d2dc2a52cd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/preview/2023-10-01-preview/migrate.json @@ -0,0 +1,22265 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Migrate Discovery Service", + "version": "2023-10-01-preview", + "description": "Azure OffAzure Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "HypervClusterController" + }, + { + "name": "SitesController" + }, + { + "name": "VmwareOperationsStatus" + }, + { + "name": "VmwarePropertiesController" + }, + { + "name": "WebAppPropertiesController" + }, + { + "name": "DependencyMapController" + }, + { + "name": "VmwareSoftwareInventoriesController" + }, + { + "name": "MachinesController" + }, + { + "name": "VcenterController" + }, + { + "name": "RunAsAccountsController" + }, + { + "name": "VmwareHostController" + }, + { + "name": "HypervJobsController" + }, + { + "name": "HypervDependencyMapController" + }, + { + "name": "HypervSitesController" + }, + { + "name": "HypervSites" + }, + { + "name": "HypervOperationsStatusController" + }, + { + "name": "HypervJobs" + }, + { + "name": "HypervHostController" + }, + { + "name": "HypervMachinesController" + }, + { + "name": "HypervSoftwareInventoriesController" + }, + { + "name": "HypervRunAsAccountsController" + }, + { + "name": "ServersController" + }, + { + "name": "ServerSoftwareInventoriesController" + }, + { + "name": "ServerSitesController" + }, + { + "name": "ServerOperationsStatusController" + }, + { + "name": "ServerDependencyMapController" + }, + { + "name": "ServerRunAsAccountsController" + }, + { + "name": "ServerJobsController" + }, + { + "name": "ImportJobsController" + }, + { + "name": "ImportMachinesController" + }, + { + "name": "ImportSitesController" + }, + { + "name": "MasterSitesController" + }, + { + "name": "MasterSitesOperationsStatusController" + }, + { + "name": "PrivateEndpointConnectionController" + }, + { + "name": "PrivateLinkResourcesController" + }, + { + "name": "SqlSitesController" + }, + { + "name": "WebAppSitesController" + }, + { + "name": "TomcatWebApplicationsController" + }, + { + "name": "TomcatWebServersController" + }, + { + "name": "IisWebApplicationsController" + }, + { + "name": "IisWebServersController" + }, + { + "name": "WebAppDiscoverySiteDataSourcesController" + }, + { + "name": "WebAppExtendedMachinesController" + }, + { + "name": "WebApplicationsController" + }, + { + "name": "WebAppRunAsAccountsController" + }, + { + "name": "WebServersController" + }, + { + "name": "SqlAvailabilityGroupsController" + }, + { + "name": "SqlServersController" + }, + { + "name": "SqlDatabasesController" + }, + { + "name": "SqlJobsController" + }, + { + "name": "SqlRunAsAccountsController" + }, + { + "name": "SqlDiscoverySiteDataSourceController" + }, + { + "name": "SqlOperationsStatusController" + } + ], + "paths": { + "/providers/Microsoft.OffAzure/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "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" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/hypervSites": { + "get": { + "operationId": "HypervSites_ListBySubscription", + "tags": [ + "HypervSites" + ], + "summary": "Get all hyperv sites.", + "description": "Get all the hyperv sites in the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervSites_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/HypervSites_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/importSites": { + "get": { + "operationId": "ImportSitesController_ListBySubscription", + "tags": [ + "ImportSitesController" + ], + "description": "List ImportSite resources by subscription ID", + "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/ImportSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportSitesController_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/masterSites": { + "get": { + "operationId": "MasterSitesController_ListBySubscription", + "tags": [ + "MasterSitesController" + ], + "summary": "Get all the sites in the subscription.", + "description": "List MasterSite resources by subscription ID", + "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/MasterSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MasterSitesController_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/serverSites": { + "get": { + "operationId": "ServerSitesController_ListBySubscription", + "tags": [ + "ServerSitesController" + ], + "description": "List ServerSiteResource resources by subscription ID", + "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/ServerSiteResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerSitesController_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/vmwareSites": { + "get": { + "operationId": "SitesController_ListBySubscription", + "tags": [ + "SitesController" + ], + "summary": "Get all vmware sites.", + "description": "Get all the vmware sites in the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SitesController_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites": { + "get": { + "operationId": "HypervSites_ListByResourceGroup", + "tags": [ + "HypervSites" + ], + "summary": "Get all hyperv sites.", + "description": "Get all the hyperv sites 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": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervSites_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/HypervSites_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}": { + "get": { + "operationId": "HypervSitesController_Get", + "tags": [ + "HypervSitesController" + ], + "description": "Get a HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "HypervSitesController_Create", + "tags": [ + "HypervSitesController" + ], + "description": "Create a HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervSite" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSite" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSite" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "HypervSitesController_Update", + "tags": [ + "HypervSitesController" + ], + "description": "Update a HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervSiteUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "HypervSitesController_Delete", + "tags": [ + "HypervSitesController" + ], + "description": "Delete a HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clientGroupMembers": { + "post": { + "operationId": "HypervDependencyMapController_ClientGroupMembers", + "tags": [ + "HypervDependencyMapController" + ], + "description": "API to list client group members for the selected client 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" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsClientGroupMembersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "HypervDependencyMapController_ClientGroupMembers_MaximumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_ClientGroupMembers_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters": { + "get": { + "operationId": "HypervClusterController_ListByHypervSite", + "tags": [ + "HypervClusterController" + ], + "description": "List HypervCluster resources by HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervClusterController_ListByHypervSite_MaximumSet_Gen": { + "$ref": "./examples/HypervClusterController_ListByHypervSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters/{clusterName}": { + "get": { + "operationId": "HypervClusterController_GetCluster", + "tags": [ + "HypervClusterController" + ], + "description": "Method to get a Hyper-V cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "clusterName", + "in": "path", + "description": " Cluster ARM name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervClusterController_GetCluster_MaximumSet_Gen": { + "$ref": "./examples/HypervClusterController_GetCluster_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "HypervClusterController_CreateCluster", + "tags": [ + "HypervClusterController" + ], + "description": "Method to create or update a Hyper-V cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "clusterName", + "in": "path", + "description": " Cluster ARM name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervCluster" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCluster" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCluster" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "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, + "x-ms-examples": { + "HypervClusterController_CreateCluster_MaximumSet_Gen": { + "$ref": "./examples/HypervClusterController_CreateCluster_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "HypervClusterController_Delete", + "tags": [ + "HypervClusterController" + ], + "description": "Delete a HypervCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "clusterName", + "in": "path", + "description": " Cluster ARM name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervClusterController_Delete_MaximumSet_Gen": { + "$ref": "./examples/HypervClusterController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/computeErrorSummary": { + "post": { + "operationId": "HypervSitesController_ComputeErrorSummary", + "tags": [ + "HypervSitesController" + ], + "description": "Method to get site error summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteErrorSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_ComputeErrorSummary_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_ComputeErrorSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/computeusage": { + "post": { + "operationId": "HypervSitesController_Computeusage", + "tags": [ + "HypervSitesController" + ], + "description": "Get a hyperv site usage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_Computeusage_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_Computeusage_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportApplications": { + "post": { + "operationId": "HypervSitesController_ExportApplications", + "tags": [ + "HypervSitesController" + ], + "description": "Method to generate report containing\r\n machine and the deep discovery of the application installed in the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "HypervSitesController_ExportApplications_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_ExportApplications_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportDependencies": { + "post": { + "operationId": "HypervDependencyMapController_ExportDependencies", + "tags": [ + "HypervDependencyMapController" + ], + "description": "API to generate report containing agentless dependencies.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "requestBody", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsExportDependenciesRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "HypervDependencyMapController_ExportDependencies_MaximumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_ExportDependencies_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportMachineErrors": { + "post": { + "operationId": "HypervSitesController_ExportMachineErrors", + "tags": [ + "HypervSitesController" + ], + "description": "Method to generate report containing \r\n machine and the errors encountered during guest discovery of the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ExportMachineErrorsRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "HypervSitesController_ExportMachineErrors_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_ExportMachineErrors_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/generateCoarseMap": { + "post": { + "operationId": "HypervDependencyMapController_GenerateCoarseMap", + "tags": [ + "HypervDependencyMapController" + ], + "description": "API to generate coarse map for the list of machines.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsScopeMapRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "HypervDependencyMapController_GenerateCoarseMap_MaximumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/generateDetailedMap": { + "post": { + "operationId": "HypervDependencyMapController_GenerateDetailedMap", + "tags": [ + "HypervDependencyMapController" + ], + "description": "API to generate detailed map for a selected machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsSingleMachineDetailedMapRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "HypervDependencyMapController_GenerateDetailedMap_MaximumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts": { + "get": { + "operationId": "HypervHostController_ListByHypervSite", + "tags": [ + "HypervHostController" + ], + "description": "List HypervHost resources by HypervSite", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervHostListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervHostController_ListByHypervSite_MaximumSet_Gen": { + "$ref": "./examples/HypervHostController_ListByHypervSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts/{hostName}": { + "get": { + "operationId": "HypervHostController_Get", + "tags": [ + "HypervHostController" + ], + "description": "Get a HypervHost", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "hostName", + "in": "path", + "description": " Host name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervHost" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervHostController_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervHostController_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "HypervHostController_Create", + "tags": [ + "HypervHostController" + ], + "description": "Create a HypervHost", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "hostName", + "in": "path", + "description": " Host name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervHost" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervHost" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervHost" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "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, + "x-ms-examples": { + "HypervHostController_Create_MaximumSet_Gen": { + "$ref": "./examples/HypervHostController_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "HypervHostController_Delete", + "tags": [ + "HypervHostController" + ], + "description": "Delete a HypervHost", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "hostName", + "in": "path", + "description": " Host name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "HypervHostController_Delete_MaximumSet_Gen": { + "$ref": "./examples/HypervHostController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/jobs": { + "get": { + "operationId": "HypervJobs_ListByHypervSite", + "tags": [ + "HypervJobs" + ], + "description": "List HypervJob resources by HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervJobListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervJobs_ListByHypervSite_MaximumSet_Gen": { + "$ref": "./examples/HypervJobs_ListByHypervSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/jobs/{jobName}": { + "get": { + "operationId": "HypervJobs_Get", + "tags": [ + "HypervJobs" + ], + "description": "Get a HypervJob", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": " Job name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervJobs_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervJobs_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/listHealthSummary": { + "post": { + "operationId": "HypervSitesController_ListHealthSummary", + "tags": [ + "HypervSitesController" + ], + "description": "Method to get site health summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteHealthSummaryCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_ListHealthSummary_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_ListHealthSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines": { + "get": { + "operationId": "HypervMachinesController_ListByHypervSite", + "tags": [ + "HypervMachinesController" + ], + "description": "List HypervMachine resources by HypervSite", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervMachinesController_ListByHypervSite_MaximumSet_Gen": { + "$ref": "./examples/HypervMachinesController_ListByHypervSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}": { + "get": { + "operationId": "HypervMachinesController_Get", + "tags": [ + "HypervMachinesController" + ], + "description": "Get a HypervMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " HypervMachine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervMachinesController_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervMachinesController_Get_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "HypervMachinesController_Update", + "tags": [ + "HypervMachinesController" + ], + "description": "Update a HypervMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " HypervMachine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervMachineUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervMachinesController_Update_MaximumSet_Gen": { + "$ref": "./examples/HypervMachinesController_Update_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}/softwareInventories/{default}": { + "get": { + "operationId": "HypervSoftwareInventoriesController_GetMachineSoftwareInventory", + "tags": [ + "HypervSoftwareInventoriesController" + ], + "description": "Method to get a machines software inventory like applications and roles.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " HypervMachine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "default", + "in": "path", + "description": "Default value.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "Default", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "default value." + } + ] + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervVmSoftwareInventory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen": { + "$ref": "./examples/HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}/softwareinventories": { + "get": { + "operationId": "HypervSoftwareInventoriesController_ListByHypervMachine", + "tags": [ + "HypervSoftwareInventoriesController" + ], + "description": "List HypervVmSoftwareInventory resources by HypervMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " HypervMachine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervVmSoftwareInventoryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervSoftwareInventoriesController_ListByHypervMachine_MaximumSet_Gen": { + "$ref": "./examples/HypervSoftwareInventoriesController_ListByHypervMachine_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/operationsStatus/{operationStatusName}": { + "get": { + "operationId": "HypervOperationsStatusController_GetHypervOperationsStatus", + "tags": [ + "HypervOperationsStatusController" + ], + "description": "Method to get operation 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" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "operationStatusName", + "in": "path", + "description": "Operation status Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervOperationsStatusController_GetHypervOperationsStatus_MaximumSet_Gen": { + "$ref": "./examples/HypervOperationsStatusController_GetHypervOperationsStatus_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/runAsAccounts": { + "get": { + "operationId": "HypervRunAsAccountsController_ListByHypervSite", + "tags": [ + "HypervRunAsAccountsController" + ], + "description": "List HypervRunAsAccountResource resources by HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervRunAsAccountResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervRunAsAccountsController_ListByHypervSite_MaximumSet_Gen": { + "$ref": "./examples/HypervRunAsAccountsController_ListByHypervSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/runAsAccounts/{accountName}": { + "get": { + "operationId": "HypervRunAsAccountsController_Get", + "tags": [ + "HypervRunAsAccountsController" + ], + "description": "Get a HypervRunAsAccountResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "accountName", + "in": "path", + "description": " RunAsAccounts name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervRunAsAccountResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervRunAsAccountsController_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervRunAsAccountsController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/serverGroupMembers": { + "post": { + "operationId": "HypervDependencyMapController_ServerGroupMembers", + "tags": [ + "HypervDependencyMapController" + ], + "description": "API to list server group members for the selected server 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" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsServerGroupMembersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "HypervDependencyMapController_ServerGroupMembers_MaximumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_ServerGroupMembers_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/summary": { + "post": { + "operationId": "HypervSitesController_Summary", + "tags": [ + "HypervSitesController" + ], + "description": "Method to get site usage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_Summary_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_Summary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/updateDependencyMapStatus": { + "post": { + "operationId": "HypervDependencyMapController_UpdateDependencyMapStatus", + "tags": [ + "HypervDependencyMapController" + ], + "description": "Method to enable disable dependency map status for machines\r\n in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMachineDepMapStatus" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "HypervDependencyMapController_UpdateDependencyMapStatus_MaximumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_UpdateDependencyMapStatus_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/updateProperties": { + "post": { + "operationId": "HypervMachinesController_UpdateProperties", + "tags": [ + "HypervMachinesController" + ], + "description": "Method to update custom properties for HYPERV machines\r\n in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "metaData", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/MachineMetadataCollection" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "HypervMachinesController_UpdateProperties_MaximumSet_Gen": { + "$ref": "./examples/HypervMachinesController_UpdateProperties_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites": { + "get": { + "operationId": "ImportSitesController_ListByResourceGroup", + "tags": [ + "ImportSitesController" + ], + "description": "Get all import sites.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/ImportSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportSitesController_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}": { + "get": { + "operationId": "ImportSitesController_Get", + "tags": [ + "ImportSitesController" + ], + "description": "Get a ImportSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ImportSitesController_Create", + "tags": [ + "ImportSitesController" + ], + "description": "Create a ImportSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportSite" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportSite" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportSite" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "ImportSitesController_Update", + "tags": [ + "ImportSitesController" + ], + "description": "Update a ImportSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportSiteUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ImportSitesController_Delete", + "tags": [ + "ImportSitesController" + ], + "description": "Delete a ImportSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteImportedMachines": { + "post": { + "operationId": "ImportSitesController_DeleteImportedMachines", + "tags": [ + "ImportSitesController" + ], + "description": "Deletes the imported machines for site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_DeleteImportedMachines_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_DeleteImportedMachines_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteJobs": { + "get": { + "operationId": "ImportJobsController_ListDeletejobs", + "tags": [ + "ImportJobsController" + ], + "description": "Method to get all delete import machines job for the given site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PagedDeleteImportMachinesJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportJobsController_ListDeletejobs_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_ListDeletejobs_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteJobs/{jobName}": { + "get": { + "operationId": "ImportJobsController_GetDeletejob", + "tags": [ + "ImportJobsController" + ], + "description": "Gets the delete imported machines job with the given job name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": "Job Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeleteImportMachinesJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportJobsController_GetDeletejob_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_GetDeletejob_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportJobs": { + "get": { + "operationId": "ImportJobsController_ListExportjobs", + "tags": [ + "ImportJobsController" + ], + "description": "Method to get all export import machines job for the given site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PagedExportImportedMachinesJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportJobsController_ListExportjobs_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_ListExportjobs_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportJobs/{jobName}": { + "get": { + "operationId": "ImportJobsController_GetExportjob", + "tags": [ + "ImportJobsController" + ], + "description": "Gets the export imported machines job with the given job name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": "Job Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExportImportedMachinesJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportJobsController_GetExportjob_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_GetExportjob_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportUri": { + "post": { + "operationId": "ImportSitesController_ExportUri", + "tags": [ + "ImportSitesController" + ], + "description": "Method to export a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_ExportUri_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_ExportUri_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importJobs": { + "get": { + "operationId": "ImportJobsController_ListImportjobs", + "tags": [ + "ImportJobsController" + ], + "description": "Method to get all import machines job for the given site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PagedImportMachinesJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportJobsController_ListImportjobs_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_ListImportjobs_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importJobs/{jobName}": { + "get": { + "operationId": "ImportJobsController_GetImportjob", + "tags": [ + "ImportJobsController" + ], + "description": "Gets the import job with the given job name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": "Job Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportMachinesJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportJobsController_GetImportjob_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_GetImportjob_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importUri": { + "post": { + "operationId": "ImportSitesController_ImportUri", + "tags": [ + "ImportSitesController" + ], + "description": "Method to import a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_ImportUri_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_ImportUri_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/jobs": { + "get": { + "operationId": "ImportJobsController_ListByImportSite", + "tags": [ + "ImportJobsController" + ], + "description": "List ImportJob resources by ImportSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportJobListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportJobsController_ListByImportSite_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_ListByImportSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/jobs/{jobName}": { + "get": { + "operationId": "ImportJobsController_Get", + "tags": [ + "ImportJobsController" + ], + "description": "Get a ImportJob", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": " Jobs name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportJobsController_Get_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/machines": { + "get": { + "operationId": "ImportMachinesController_ListByImportSite", + "tags": [ + "ImportMachinesController" + ], + "description": "List ImportMachine resources by ImportSite", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportMachinesController_ListByImportSite_MaximumSet_Gen": { + "$ref": "./examples/ImportMachinesController_ListByImportSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/machines/{machineName}": { + "get": { + "operationId": "ImportMachinesController_Get", + "tags": [ + "ImportMachinesController" + ], + "description": "Get a ImportMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportMachinesController_Get_MaximumSet_Gen": { + "$ref": "./examples/ImportMachinesController_Get_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ImportMachinesController_Delete", + "tags": [ + "ImportMachinesController" + ], + "description": "Delete a ImportMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportMachinesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/ImportMachinesController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites": { + "get": { + "operationId": "MasterSitesController_ListByResourceGroup", + "tags": [ + "MasterSitesController" + ], + "summary": "Get all sites.", + "description": "Get all the sites 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" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MasterSitesController_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}": { + "get": { + "operationId": "MasterSitesController_Get", + "tags": [ + "MasterSitesController" + ], + "summary": "Method to get a master site.", + "description": "Get a MasterSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MasterSitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "MasterSitesController_Create", + "tags": [ + "MasterSitesController" + ], + "description": "Method to create or update a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/MasterSite" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSite" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSite" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "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, + "x-ms-examples": { + "MasterSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "MasterSitesController_Update", + "tags": [ + "MasterSitesController" + ], + "description": "Method to update an existing site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MasterSiteUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSite" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "MasterSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "MasterSitesController_Delete", + "tags": [ + "MasterSitesController" + ], + "description": "Method to delete a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MasterSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/errorSummary": { + "post": { + "operationId": "MasterSitesController_ErrorSummary", + "tags": [ + "MasterSitesController" + ], + "description": "Method to get error summary from master site for an appliance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ErrorSummaryRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteErrorSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MasterSitesController_ErrorSummary_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_ErrorSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/operationsStatus/{operationStatusName}": { + "get": { + "operationId": "MasterSitesOperationsStatusController_GetVmwareOperationStatus", + "tags": [ + "MasterSitesOperationsStatusController" + ], + "description": "A operation status resource belonging to a master site resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "operationStatusName", + "in": "path", + "description": "Operation status Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MasterSitesOperationsStatusController_GetVmwareOperationStatus_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesOperationsStatusController_GetVmwareOperationStatus_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnectionController_ListByMasterSite", + "tags": [ + "PrivateEndpointConnectionController" + ], + "description": "Gets the private link resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateEndpointConnectionController_ListByMasterSite_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_ListByMasterSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections/{peConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnectionController_Get", + "tags": [ + "PrivateEndpointConnectionController" + ], + "description": "Gets the private link resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "peConnectionName", + "in": "path", + "description": " Private link resource name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionController_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnectionController_Create", + "tags": [ + "PrivateEndpointConnectionController" + ], + "description": "Gets the private link resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "peConnectionName", + "in": "path", + "description": " Private link resource name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionController_Create_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "PrivateEndpointConnectionController_Delete", + "tags": [ + "PrivateEndpointConnectionController" + ], + "description": "Deletes the private link resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "peConnectionName", + "in": "path", + "description": " Private link resource name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionController_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResourcesController_ListByMasterSite", + "tags": [ + "PrivateLinkResourcesController" + ], + "description": "Gets the private link resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateLinkResourcesController_ListByMasterSite_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourcesController_ListByMasterSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "operationId": "PrivateLinkResourcesController_Get", + "tags": [ + "PrivateLinkResourcesController" + ], + "description": "Gets the private link resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "description": "Private link resource name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResourcesController_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourcesController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites": { + "get": { + "operationId": "SqlSitesController_ListByMasterSite", + "tags": [ + "SqlSitesController" + ], + "description": "Method to get all sites.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlSitesController_ListByMasterSite_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_ListByMasterSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}": { + "get": { + "operationId": "SqlSitesController_Get", + "tags": [ + "SqlSitesController" + ], + "description": "Method to get a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlSitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlSitesController_Create", + "tags": [ + "SqlSitesController" + ], + "description": "Method to create a SQL site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlSite" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSite" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSite" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "SqlSitesController_Update", + "tags": [ + "SqlSitesController" + ], + "description": "Method to update an existing site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlSiteUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSite" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "SqlSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlSitesController_Delete", + "tags": [ + "SqlSitesController" + ], + "description": "Deletes the SQL site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources": { + "get": { + "operationId": "SqlDiscoverySiteDataSourceController_ListBySqlSite", + "tags": [ + "SqlDiscoverySiteDataSourceController" + ], + "description": "List SqlDiscoverySiteDataSource resources by SqlSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDiscoverySiteDataSourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlDiscoverySiteDataSourceController_ListBySqlSite_MaximumSet_Gen": { + "$ref": "./examples/SqlDiscoverySiteDataSourceController_ListBySqlSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}": { + "get": { + "operationId": "SqlDiscoverySiteDataSourceController_Get", + "tags": [ + "SqlDiscoverySiteDataSourceController" + ], + "description": "Get a SqlDiscoverySiteDataSource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "discoverySiteDataSourceName", + "in": "path", + "description": "SQL Discovery site data source name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDiscoverySiteDataSource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlDiscoverySiteDataSourceController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlDiscoverySiteDataSourceController_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlDiscoverySiteDataSourceController_Create", + "tags": [ + "SqlDiscoverySiteDataSourceController" + ], + "description": "Create a SqlDiscoverySiteDataSource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "discoverySiteDataSourceName", + "in": "path", + "description": "SQL Discovery site data source name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlDiscoverySiteDataSource" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDiscoverySiteDataSource" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDiscoverySiteDataSource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "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, + "x-ms-examples": { + "SqlDiscoverySiteDataSourceController_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlDiscoverySiteDataSourceController_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlDiscoverySiteDataSourceController_Delete", + "tags": [ + "SqlDiscoverySiteDataSourceController" + ], + "description": "Delete a SqlDiscoverySiteDataSource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "discoverySiteDataSourceName", + "in": "path", + "description": "SQL Discovery site data source name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlDiscoverySiteDataSourceController_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlDiscoverySiteDataSourceController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/errorSummary": { + "post": { + "operationId": "SqlSitesController_ErrorSummary", + "tags": [ + "SqlSitesController" + ], + "description": "Method to get error summary from SQL site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ErrorSummaryRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteErrorSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlSitesController_ErrorSummary_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_ErrorSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/exportSqlServerErrors": { + "post": { + "operationId": "SqlSitesController_ExportSqlServerErrors", + "tags": [ + "SqlSitesController" + ], + "description": "Method to generate report containing SQL servers.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "SqlSitesController_ExportSqlServerErrors_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_ExportSqlServerErrors_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/exportSqlServers": { + "post": { + "operationId": "SqlSitesController_ExportSqlServers", + "tags": [ + "SqlSitesController" + ], + "description": "Method to generate report containing SQL servers.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ExportSqlServersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "SqlSitesController_ExportSqlServers_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_ExportSqlServers_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/jobs": { + "get": { + "operationId": "SqlJobsController_ListBySqlSite", + "tags": [ + "SqlJobsController" + ], + "summary": "Gets the sql Jobs.", + "description": "List SqlJob resources by SqlSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlJobListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlJobsController_ListBySqlSite_MaximumSet_Gen": { + "$ref": "./examples/SqlJobsController_ListBySqlSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/jobs/{jobName}": { + "get": { + "operationId": "SqlJobsController_Get", + "tags": [ + "SqlJobsController" + ], + "summary": "Gets the sql Job.", + "description": "Get a SqlJob", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": "SQL Job name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlJobsController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlJobsController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/operationsStatus/{operationStatusName}": { + "get": { + "operationId": "SqlOperationsStatusController_GetSqlOperationStatus", + "tags": [ + "SqlOperationsStatusController" + ], + "description": "Method to get operation 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" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "operationStatusName", + "in": "path", + "description": "Operation status Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlOperationsStatusController_GetSqlOperationStatus_MaximumSet_Gen": { + "$ref": "./examples/SqlOperationsStatusController_GetSqlOperationStatus_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/refresh": { + "post": { + "operationId": "SqlSitesController_Refresh", + "tags": [ + "SqlSitesController" + ], + "description": "Method to refresh a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/SqlSiteRefreshBody" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "SqlSitesController_Refresh_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Refresh_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/runAsAccounts": { + "get": { + "operationId": "SqlRunAsAccountsController_ListBySqlSite", + "tags": [ + "SqlRunAsAccountsController" + ], + "description": "List SqlRunAsAccount resources by SqlSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRunAsAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlRunAsAccountsController_ListBySqlSite_MaximumSet_Gen": { + "$ref": "./examples/SqlRunAsAccountsController_ListBySqlSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/runAsAccounts/{accountName}": { + "get": { + "operationId": "SqlRunAsAccountsController_Get", + "tags": [ + "SqlRunAsAccountsController" + ], + "description": "Get a SqlRunAsAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "accountName", + "in": "path", + "description": "SQL RunAsAccounts name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRunAsAccount" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlRunAsAccountsController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlRunAsAccountsController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlAvailabilityGroups": { + "get": { + "operationId": "SqlAvailabilityGroupsController_ListBySqlSite", + "tags": [ + "SqlAvailabilityGroupsController" + ], + "description": "Gets the sql availability groups.", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAvailabilityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAvailabilityGroupsController_ListBySqlSite_MaximumSet_Gen": { + "$ref": "./examples/SqlAvailabilityGroupsController_ListBySqlSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlAvailabilityGroups/{sqlAvailabilityGroupName}": { + "get": { + "operationId": "SqlAvailabilityGroupsController_Get", + "tags": [ + "SqlAvailabilityGroupsController" + ], + "description": "Gets the sql availability 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" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlAvailabilityGroupName", + "in": "path", + "description": "SQL availability group name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAvailabilityGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAvailabilityGroupsController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAvailabilityGroupsController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlDatabases": { + "get": { + "operationId": "SqlDatabasesController_ListBySqlSite", + "tags": [ + "SqlDatabasesController" + ], + "description": "Gets the sql Databases.", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlDatabasesController_ListBySqlSite_MaximumSet_Gen": { + "$ref": "./examples/SqlDatabasesController_ListBySqlSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlDatabases/{sqlDatabaseName}": { + "get": { + "operationId": "SqlDatabasesController_Get", + "tags": [ + "SqlDatabasesController" + ], + "description": "Gets the sql Database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlDatabaseName", + "in": "path", + "description": "SQL Database name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlDatabasesController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlDatabasesController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers": { + "get": { + "operationId": "SqlServersController_ListBySqlSite", + "tags": [ + "SqlServersController" + ], + "description": "Gets the sql servers.", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlServerV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlServersController_ListBySqlSite_MaximumSet_Gen": { + "$ref": "./examples/SqlServersController_ListBySqlSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers/{sqlServerName}": { + "get": { + "operationId": "SqlServersController_Get", + "tags": [ + "SqlServersController" + ], + "description": "Gets the sql server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlServerName", + "in": "path", + "description": "SQL server name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlServerV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlServersController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlServersController_Get_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "SqlServersController_Update", + "tags": [ + "SqlServersController" + ], + "description": "Updates the sql server tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlServerName", + "in": "path", + "description": "SQL server name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerV2Update" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlServerV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlServersController_Update_MaximumSet_Gen": { + "$ref": "./examples/SqlServersController_Update_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/summary": { + "post": { + "operationId": "SqlSitesController_Summary", + "tags": [ + "SqlSitesController" + ], + "description": "Method to get site usage/summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlSitesController_Summary_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Summary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites": { + "get": { + "operationId": "WebAppSitesController_ListByMasterSite", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to get all sites.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppSitesController_ListByMasterSite_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_ListByMasterSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}": { + "get": { + "operationId": "WebAppSitesController_Get", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to get a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppSitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppSitesController_Create", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to create a WebApp site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppSite" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSite" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSite" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "WebAppSitesController_Update", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to update an existing site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppSiteUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSite" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "WebAppSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppSitesController_Delete", + "tags": [ + "WebAppSitesController" + ], + "description": "Deletes the WebApp site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "WebAppSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources": { + "get": { + "operationId": "WebAppDiscoverySiteDataSourcesController_ListByWebAppSite", + "tags": [ + "WebAppDiscoverySiteDataSourcesController" + ], + "description": "Method to get all Web app data sources in site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppDiscoverySiteDataSourcesController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_ListByWebAppSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}": { + "get": { + "operationId": "WebAppDiscoverySiteDataSourcesController_Get", + "tags": [ + "WebAppDiscoverySiteDataSourcesController" + ], + "description": "Method to get a Web app data source in site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "discoverySiteDataSourceName", + "in": "path", + "description": "Data Source ARM name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppDiscoverySiteDataSourcesController_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppDiscoverySiteDataSourcesController_Create", + "tags": [ + "WebAppDiscoverySiteDataSourcesController" + ], + "description": "Method to create or update a Web app data source in site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "discoverySiteDataSourceName", + "in": "path", + "description": "Data Source ARM name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSource" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSource" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "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, + "x-ms-examples": { + "WebAppDiscoverySiteDataSourcesController_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppDiscoverySiteDataSourcesController_Delete", + "tags": [ + "WebAppDiscoverySiteDataSourcesController" + ], + "description": "Method to delete a Web app data source in site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "discoverySiteDataSourceName", + "in": "path", + "description": "Data Source ARM name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "WebAppDiscoverySiteDataSourcesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/errorSummary": { + "post": { + "operationId": "WebAppSitesController_ErrorSummary", + "tags": [ + "WebAppSitesController" + ], + "description": "MMethod to get error summary from web app site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ErrorSummaryRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteErrorSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppSitesController_ErrorSummary_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_ErrorSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/exportInventory": { + "post": { + "operationId": "WebAppSitesController_ExportInventory", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to generate report containing web app inventory.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ExportWebAppsRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "WebAppSitesController_ExportInventory_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_ExportInventory_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/extendedMachines": { + "get": { + "operationId": "WebAppExtendedMachinesController_ListByWebAppSite", + "tags": [ + "WebAppExtendedMachinesController" + ], + "description": "Method to get all extended machines.", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppExtendedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppExtendedMachinesController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/WebAppExtendedMachinesController_ListByWebAppSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/extendedMachines/{extendedMachineName}": { + "get": { + "operationId": "WebAppExtendedMachinesController_Get", + "tags": [ + "WebAppExtendedMachinesController" + ], + "description": "Method to get a extended machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "extendedMachineName", + "in": "path", + "description": "Extended machine name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppExtendedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppExtendedMachinesController_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppExtendedMachinesController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebApplications": { + "get": { + "operationId": "IisWebApplicationsController_ListByWebAppSite", + "tags": [ + "IisWebApplicationsController" + ], + "description": "Method to get all IIS web application.", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IisWebApplicationsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "IisWebApplicationsController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/IisWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebApplications/{webApplicationName}": { + "get": { + "operationId": "IisWebApplicationsController_Get", + "tags": [ + "IisWebApplicationsController" + ], + "description": "Method to get an IIS web application.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webApplicationName", + "in": "path", + "description": "Web application name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IisWebApplications" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IisWebApplicationsController_Get_MaximumSet_Gen": { + "$ref": "./examples/IisWebApplicationsController_Get_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "IisWebApplicationsController_Update", + "tags": [ + "IisWebApplicationsController" + ], + "description": "Method to update tags on IIS web application.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webApplicationName", + "in": "path", + "description": "Web application name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/IisWebApplicationsUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IisWebApplications" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IisWebApplicationsController_Update_MaximumSet_Gen": { + "$ref": "./examples/IisWebApplicationsController_Update_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebServers": { + "get": { + "operationId": "IisWebServersController_ListByWebAppSite", + "tags": [ + "IisWebServersController" + ], + "description": "Method to get all IIS web servers.", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IisWebServersListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "IisWebServersController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/IisWebServersController_ListByWebAppSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebServers/{webServerName}": { + "get": { + "operationId": "IisWebServersController_Get", + "tags": [ + "IisWebServersController" + ], + "description": "Method to get an IIS web server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webServerName", + "in": "path", + "description": "Web server name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IisWebServers" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IisWebServersController_Get_MaximumSet_Gen": { + "$ref": "./examples/IisWebServersController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/refresh": { + "post": { + "operationId": "WebAppSitesController_Refresh", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to refresh a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ProxySiteRefreshBody" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "WebAppSitesController_Refresh_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Refresh_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/runasaccounts": { + "get": { + "operationId": "WebAppRunAsAccountsController_ListByWebAppSite", + "tags": [ + "WebAppRunAsAccountsController" + ], + "description": "Method to get all run as accounts.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppRunAsAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppRunAsAccountsController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/WebAppRunAsAccountsController_ListByWebAppSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/runasaccounts/{accountName}": { + "get": { + "operationId": "WebAppRunAsAccountsController_Get", + "tags": [ + "WebAppRunAsAccountsController" + ], + "description": "Method to get run as account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "accountName", + "in": "path", + "description": "Run as account ARM name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppRunAsAccount" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppRunAsAccountsController_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppRunAsAccountsController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/summary": { + "post": { + "operationId": "WebAppSitesController_Summary", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to get site usage/summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppSitesController_Summary_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Summary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebApplications": { + "get": { + "operationId": "TomcatWebApplicationsController_ListByWebAppSite", + "tags": [ + "TomcatWebApplicationsController" + ], + "description": "Method to get all Tomcat web application.", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TomcatWebApplicationsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TomcatWebApplicationsController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/TomcatWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebApplications/{webApplicationName}": { + "get": { + "operationId": "TomcatWebApplicationsController_Get", + "tags": [ + "TomcatWebApplicationsController" + ], + "description": "Method to get an Tomcat web application.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webApplicationName", + "in": "path", + "description": "Web application name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TomcatWebApplications" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TomcatWebApplicationsController_Get_MaximumSet_Gen": { + "$ref": "./examples/TomcatWebApplicationsController_Get_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "TomcatWebApplicationsController_Update", + "tags": [ + "TomcatWebApplicationsController" + ], + "description": "Updates the Tomcat web application tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webApplicationName", + "in": "path", + "description": "Web application name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/TomcatWebApplicationsUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TomcatWebApplications" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TomcatWebApplicationsController_Update_MaximumSet_Gen": { + "$ref": "./examples/TomcatWebApplicationsController_Update_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebServers": { + "get": { + "operationId": "TomcatWebServersController_ListByWebAppSite", + "tags": [ + "TomcatWebServersController" + ], + "description": "Method to get all Tomcat web servers.", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TomcatWebServersListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TomcatWebServersController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/TomcatWebServersController_ListByWebAppSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebServers/{webServerName}": { + "get": { + "operationId": "TomcatWebServersController_Get", + "tags": [ + "TomcatWebServersController" + ], + "description": "Method to get an Tomcat web server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webServerName", + "in": "path", + "description": "Web server name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TomcatWebServers" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TomcatWebServersController_Get_MaximumSet_Gen": { + "$ref": "./examples/TomcatWebServersController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/updateProperties": { + "post": { + "operationId": "WebAppPropertiesController_UpdateProperties", + "tags": [ + "WebAppPropertiesController" + ], + "description": "Method to update properties for web applications.\n in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppPropertiesCollection" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "WebAppPropertiesController_UpdateProperties_MaximumSet_Gen": { + "$ref": "./examples/WebAppPropertiesController_UpdateProperties_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/webApplications": { + "get": { + "operationId": "WebApplicationsController_ListByWebAppSite", + "tags": [ + "WebApplicationsController" + ], + "description": "Method to get all IIS web applications.", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebApplicationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebApplicationsController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/WebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/webServers": { + "get": { + "operationId": "WebServersController_ListByWebAppSite", + "tags": [ + "WebServersController" + ], + "description": "Method to get all web servers.", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebServerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebServersController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/WebServersController_ListByWebAppSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites": { + "get": { + "operationId": "ServerSitesController_ListByResourceGroup", + "tags": [ + "ServerSitesController" + ], + "description": "List ServerSiteResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerSitesController_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}": { + "get": { + "operationId": "ServerSitesController_Get", + "tags": [ + "ServerSitesController" + ], + "description": "Get a ServerSiteResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ServerSitesController_Create", + "tags": [ + "ServerSitesController" + ], + "description": "Create a ServerSiteResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSiteResource" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteResource" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteResource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "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, + "x-ms-examples": { + "ServerSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "ServerSitesController_Update", + "tags": [ + "ServerSitesController" + ], + "description": "Update a ServerSiteResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSiteResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ServerSitesController_Delete", + "tags": [ + "ServerSitesController" + ], + "description": "Delete a ServerSiteResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/clientGroupMembers": { + "post": { + "operationId": "ServerDependencyMapController_ClientGroupMembers", + "tags": [ + "ServerDependencyMapController" + ], + "description": "API to list client group members for the selected client 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" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsClientGroupMembersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "ServerDependencyMapController_ClientGroupMembers_MaximumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_ClientGroupMembers_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/computeErrorSummary": { + "post": { + "operationId": "ServerSitesController_ComputeErrorSummary", + "tags": [ + "ServerSitesController" + ], + "description": "Get the error summary for a server site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteErrorSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_ComputeErrorSummary_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_ComputeErrorSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/computeusage": { + "post": { + "operationId": "ServerSitesController_Computeusage", + "tags": [ + "ServerSitesController" + ], + "description": "Get a serve site usage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteUsageResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_Computeusage_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_Computeusage_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/exportApplications": { + "post": { + "operationId": "ServerSitesController_ExportApplications", + "tags": [ + "ServerSitesController" + ], + "description": "Method to generate report containing\r\n machine and the deep discovery of the application installed in the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "ServerSitesController_ExportApplications_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_ExportApplications_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/exportDependencies": { + "post": { + "operationId": "ServerDependencyMapController_ExportDependencies", + "tags": [ + "ServerDependencyMapController" + ], + "description": "API to generate report containing agentless dependencies.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "requestBody", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsExportDependenciesRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "ServerDependencyMapController_ExportDependencies_MaximumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_ExportDependencies_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/exportMachineErrors": { + "post": { + "operationId": "ServerSitesController_ExportMachineErrors", + "tags": [ + "ServerSitesController" + ], + "description": "Method to generate report containing \r\n machine and the errors encountered during guest discovery of the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ExportMachineErrorsRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "ServerSitesController_ExportMachineErrors_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_ExportMachineErrors_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/generateCoarseMap": { + "post": { + "operationId": "ServerDependencyMapController_GenerateCoarseMap", + "tags": [ + "ServerDependencyMapController" + ], + "description": "API to generate coarse map for the list of machines.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsScopeMapRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "ServerDependencyMapController_GenerateCoarseMap_MaximumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/generateDetailedMap": { + "post": { + "operationId": "ServerDependencyMapController_GenerateDetailedMap", + "tags": [ + "ServerDependencyMapController" + ], + "description": "API to generate detailed map for a selected machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsSingleMachineDetailedMapRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "ServerDependencyMapController_GenerateDetailedMap_MaximumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/jobs": { + "get": { + "operationId": "ServerJobsController_ListByServerSiteResource", + "tags": [ + "ServerJobsController" + ], + "description": "List ServerJob resources by ServerSiteResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerJobListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerJobsController_ListByServerSiteResource_MaximumSet_Gen": { + "$ref": "./examples/ServerJobsController_ListByServerSiteResource_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/jobs/{jobName}": { + "get": { + "operationId": "ServerJobsController_Get", + "tags": [ + "ServerJobsController" + ], + "description": "Get a ServerJob", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": " Jobs name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerJobsController_Get_MaximumSet_Gen": { + "$ref": "./examples/ServerJobsController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/listHealthSummary": { + "post": { + "operationId": "ServerSitesController_ListHealthSummary", + "tags": [ + "ServerSitesController" + ], + "description": "Method to get site health summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteHealthSummaryCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_ListHealthSummary_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_ListHealthSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines": { + "get": { + "operationId": "ServersController_ListByServerSiteResource", + "tags": [ + "ServersController" + ], + "description": "Get all machines in a site.", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServersController_ListByServerSiteResource_MaximumSet_Gen": { + "$ref": "./examples/ServersController_ListByServerSiteResource_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}": { + "get": { + "operationId": "ServersController_GetMachine", + "tags": [ + "ServersController" + ], + "description": "Get a Server", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " A server machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServersController_GetMachine_MaximumSet_Gen": { + "$ref": "./examples/ServersController_GetMachine_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "ServersController_UpdateMachine", + "tags": [ + "ServersController" + ], + "description": "Update a Server machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " A server machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServersController_UpdateMachine_MaximumSet_Gen": { + "$ref": "./examples/ServersController_UpdateMachine_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ServersController_DeleteMachine", + "tags": [ + "ServersController" + ], + "description": "Delete a Server", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " A server machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServersController_DeleteMachine_MaximumSet_Gen": { + "$ref": "./examples/ServersController_DeleteMachine_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}/softwareInventories/{default}": { + "get": { + "operationId": "ServerSoftwareInventoriesController_GetMachineSoftwareInventory", + "tags": [ + "ServerSoftwareInventoriesController" + ], + "description": "Method to get a machines software inventory like applications and roles.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " A server machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "default", + "in": "path", + "description": "Default value.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "Default", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "default value." + } + ] + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSoftwareInventory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen": { + "$ref": "./examples/ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}/softwareinventories": { + "get": { + "operationId": "ServerSoftwareInventoriesController_ListByServer", + "tags": [ + "ServerSoftwareInventoriesController" + ], + "description": "List ServerSoftwareInventory resources by Server", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " A server machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSoftwareInventoryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerSoftwareInventoriesController_ListByServer_MaximumSet_Gen": { + "$ref": "./examples/ServerSoftwareInventoriesController_ListByServer_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/operationsStatus/{operationStatusName}": { + "get": { + "operationId": "ServerOperationsStatusController_GetServerSiteOperationsStatus", + "tags": [ + "ServerOperationsStatusController" + ], + "description": "A operation status resource belonging to a site resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "operationStatusName", + "in": "path", + "description": "Operation status Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerOperationsStatusController_GetServerSiteOperationsStatus_MaximumSet_Gen": { + "$ref": "./examples/ServerOperationsStatusController_GetServerSiteOperationsStatus_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/refreshSite": { + "post": { + "operationId": "ServerSitesController_RefreshSite", + "tags": [ + "ServerSitesController" + ], + "description": "Operation to refresh a site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "ServerSitesController_RefreshSite_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_RefreshSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/runAsAccounts": { + "get": { + "operationId": "ServerRunAsAccountsController_ListByServerSiteResource", + "tags": [ + "ServerRunAsAccountsController" + ], + "description": "List ServerRunAsAccount resources by ServerSiteResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerRunAsAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerRunAsAccountsController_ListByServerSiteResource_MaximumSet_Gen": { + "$ref": "./examples/ServerRunAsAccountsController_ListByServerSiteResource_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/runAsAccounts/{accountName}": { + "get": { + "operationId": "ServerRunAsAccountsController_Get", + "tags": [ + "ServerRunAsAccountsController" + ], + "description": "Get a ServerRunAsAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "accountName", + "in": "path", + "description": " RunAsAccounts name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerRunAsAccount" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerRunAsAccountsController_Get_MaximumSet_Gen": { + "$ref": "./examples/ServerRunAsAccountsController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/serverGroupMembers": { + "post": { + "operationId": "ServerDependencyMapController_ServerGroupMembers", + "tags": [ + "ServerDependencyMapController" + ], + "description": "API to list server group members for the selected server 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" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsServerGroupMembersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "ServerDependencyMapController_ServerGroupMembers_MaximumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_ServerGroupMembers_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/summary": { + "post": { + "operationId": "ServerSitesController_Summary", + "tags": [ + "ServerSitesController" + ], + "description": "Method to get site usage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_Summary_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_Summary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/updateDependencyMapStatus": { + "post": { + "operationId": "ServerSitesController_UpdateDependencyMapStatus", + "tags": [ + "ServerSitesController" + ], + "description": "Method to enable disable dependency map status for machines\r\n in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMachineDepMapStatus" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "ServerSitesController_UpdateDependencyMapStatus_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_UpdateDependencyMapStatus_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/updateProperties": { + "post": { + "operationId": "ServerSitesController_UpdateProperties", + "tags": [ + "ServerSitesController" + ], + "description": "Operation to update custom properties for servers", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "metaData", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/MachineMetadataCollection" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "ServerSitesController_UpdateProperties_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_UpdateProperties_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites": { + "get": { + "operationId": "SitesController_ListByResourceGroup", + "tags": [ + "SitesController" + ], + "summary": "Get all vmware sites.", + "description": "Get all the vmware sites 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" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SitesController_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}": { + "get": { + "operationId": "SitesController_Get", + "tags": [ + "SitesController" + ], + "description": "Get a VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SitesController_Create", + "tags": [ + "SitesController" + ], + "description": "Create a VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VmwareSite" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSite" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSite" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "SitesController_Update", + "tags": [ + "SitesController" + ], + "description": "Update a VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VmwareSiteUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SitesController_Delete", + "tags": [ + "SitesController" + ], + "description": "Delete a VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/clientGroupMembers": { + "post": { + "operationId": "DependencyMapController_ClientGroupMembers", + "tags": [ + "DependencyMapController" + ], + "description": "API to list client group members for the selected client 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" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsClientGroupMembersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "DependencyMapController_ClientGroupMembers_MaximumSet_Gen": { + "$ref": "./examples/DependencyMapController_ClientGroupMembers_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/computeErrorSummary": { + "post": { + "operationId": "SitesController_ComputeErrorSummary", + "tags": [ + "SitesController" + ], + "description": "Method to get site error summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteErrorSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_ComputeErrorSummary_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ComputeErrorSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/computeusage": { + "post": { + "operationId": "SitesController_Computeusage", + "tags": [ + "SitesController" + ], + "description": "Method to get site error summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Computeusage_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Computeusage_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportApplications": { + "post": { + "operationId": "SitesController_ExportApplications", + "tags": [ + "SitesController" + ], + "description": "Method to generate report containing\r\n machine and the deep discovery of the application installed in the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "SitesController_ExportApplications_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ExportApplications_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportDependencies": { + "post": { + "operationId": "DependencyMapController_ExportDependencies", + "tags": [ + "DependencyMapController" + ], + "description": "API to generate report containing agentless dependencies.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "requestBody", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsExportDependenciesRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "DependencyMapController_ExportDependencies_MaximumSet_Gen": { + "$ref": "./examples/DependencyMapController_ExportDependencies_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportMachineErrors": { + "post": { + "operationId": "SitesController_ExportMachineErrors", + "tags": [ + "SitesController" + ], + "description": "Method to generate report containing \r\n machine and the errors encountered during guest discovery of the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ExportMachineErrorsRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "SitesController_ExportMachineErrors_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ExportMachineErrors_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportMachines": { + "post": { + "operationId": "SitesController_ExportMachines", + "tags": [ + "SitesController" + ], + "description": "Method to generate report containing \r\n machine and the deep discovery of the application installed in the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ExportMachinesRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "SitesController_ExportMachines_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ExportMachines_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/generateCoarseMap": { + "post": { + "operationId": "DependencyMapController_GenerateCoarseMap", + "tags": [ + "DependencyMapController" + ], + "description": "API to generate coarse map for the list of machines.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsScopeMapRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "DependencyMapController_GenerateCoarseMap_MaximumSet_Gen": { + "$ref": "./examples/DependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/generateDetailedMap": { + "post": { + "operationId": "DependencyMapController_GenerateDetailedMap", + "tags": [ + "DependencyMapController" + ], + "description": "API to generate detailed map for a selected machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsSingleMachineDetailedMapRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "DependencyMapController_GenerateDetailedMap_MaximumSet_Gen": { + "$ref": "./examples/DependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/hosts": { + "get": { + "operationId": "VmwareHostController_ListByVmwareSite", + "tags": [ + "VmwareHostController" + ], + "description": "List VmwareHost resources by VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareHostListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VmwareHostController_ListByVmwareSite_MaximumSet_Gen": { + "$ref": "./examples/VmwareHostController_ListByVmwareSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/hosts/{hostName}": { + "get": { + "operationId": "VmwareHostController_Get", + "tags": [ + "VmwareHostController" + ], + "description": "Get a VmwareHost", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "hostName", + "in": "path", + "description": " Hosts name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareHost" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareHostController_Get_MaximumSet_Gen": { + "$ref": "./examples/VmwareHostController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/jobs": { + "get": { + "operationId": "HypervJobsController_ListByVmwareSite", + "tags": [ + "HypervJobsController" + ], + "description": "List VmwareJob resources by VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareJobListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervJobsController_ListByVmwareSite_MaximumSet_Gen": { + "$ref": "./examples/HypervJobsController_ListByVmwareSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/jobs/{jobName}": { + "get": { + "operationId": "HypervJobsController_Get", + "tags": [ + "HypervJobsController" + ], + "description": "Get a VmwareJob", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": " Jobs name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervJobsController_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervJobsController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/listHealthSummary": { + "post": { + "operationId": "SitesController_ListHealthSummary", + "tags": [ + "SitesController" + ], + "description": "Method to get site health summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteHealthSummaryCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_ListHealthSummary_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ListHealthSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines": { + "get": { + "operationId": "MachinesController_ListByVmwareSite", + "tags": [ + "MachinesController" + ], + "description": "List MachineResource resources by VmwareSite", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MachineResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MachinesController_ListByVmwareSite_MaximumSet_Gen": { + "$ref": "./examples/MachinesController_ListByVmwareSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}": { + "get": { + "operationId": "MachinesController_Get", + "tags": [ + "MachinesController" + ], + "description": "Get a MachineResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MachineResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MachinesController_Get_MaximumSet_Gen": { + "$ref": "./examples/MachinesController_Get_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "MachinesController_Update", + "tags": [ + "MachinesController" + ], + "description": "Update a MachineResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MachineResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MachineResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MachinesController_Update_MaximumSet_Gen": { + "$ref": "./examples/MachinesController_Update_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareInventories/{default}": { + "get": { + "operationId": "VmwareSoftwareInventoriesController_GetMachineSoftwareInventory", + "tags": [ + "VmwareSoftwareInventoriesController" + ], + "description": "Method to get a machines software inventory like applications and roles.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "default", + "in": "path", + "description": "Default value.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "Default", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "default value." + } + ] + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareMachineSoftwareInventory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen": { + "$ref": "./examples/VmwareSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareinventories": { + "get": { + "operationId": "VmwareSoftwareInventoriesController_ListByMachineResource", + "tags": [ + "VmwareSoftwareInventoriesController" + ], + "description": "List VmwareMachineSoftwareInventory resources by MachineResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareMachineSoftwareInventoryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen": { + "$ref": "./examples/VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/start": { + "post": { + "operationId": "MachinesController_Start", + "tags": [ + "MachinesController" + ], + "description": "Method to start a machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "MachinesController_Start_MaximumSet_Gen": { + "$ref": "./examples/MachinesController_Start_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/stop": { + "post": { + "operationId": "MachinesController_Stop", + "tags": [ + "MachinesController" + ], + "description": "Method to stop a machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "MachinesController_Stop_MaximumSet_Gen": { + "$ref": "./examples/MachinesController_Stop_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/operationsStatus/{operationStatusName}": { + "get": { + "operationId": "VmwareOperationsStatus_GetVmwareOperationStatus", + "tags": [ + "VmwareOperationsStatus" + ], + "description": "A operation status resource belonging to a site resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "operationStatusName", + "in": "path", + "description": "Operation status Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareOperationsStatus_GetVmwareOperationStatus_MaximumSet_Gen": { + "$ref": "./examples/VmwareOperationsStatus_GetVmwareOperationStatus_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/runAsAccounts": { + "get": { + "operationId": "RunAsAccountsController_ListByVmwareSite", + "tags": [ + "RunAsAccountsController" + ], + "description": "List VmwareRunAsAccountResource resources by VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareRunAsAccountResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "RunAsAccountsController_ListByVmwareSite_MaximumSet_Gen": { + "$ref": "./examples/RunAsAccountsController_ListByVmwareSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/runAsAccounts/{accountName}": { + "get": { + "operationId": "RunAsAccountsController_Get", + "tags": [ + "RunAsAccountsController" + ], + "description": "Get a VmwareRunAsAccountResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "accountName", + "in": "path", + "description": " RunAsAccounts name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareRunAsAccountResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RunAsAccountsController_Get_MaximumSet_Gen": { + "$ref": "./examples/RunAsAccountsController_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/serverGroupMembers": { + "post": { + "operationId": "DependencyMapController_ServerGroupMembers", + "tags": [ + "DependencyMapController" + ], + "description": "API to list server group members for the selected server 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" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsServerGroupMembersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "DependencyMapController_ServerGroupMembers_MaximumSet_Gen": { + "$ref": "./examples/DependencyMapController_ServerGroupMembers_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/summary": { + "post": { + "operationId": "SitesController_Summary", + "tags": [ + "SitesController" + ], + "description": "Method to get site usage/summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Summary_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Summary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateDependencyMapStatus": { + "post": { + "operationId": "VmwarePropertiesController_UpdateDependencyMapStatus", + "tags": [ + "VmwarePropertiesController" + ], + "description": "Method to enable disable dependency map status for machines\n in a\nsite.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "updateMachineDepMapStatus", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMachineDepMapStatus" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "VmwarePropertiesController_UpdateDependencyMapStatus_MaximumSet_Gen": { + "$ref": "./examples/VmwarePropertiesController_UpdateDependencyMapStatus_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateProperties": { + "post": { + "operationId": "VmwarePropertiesController_UpdateProperties", + "tags": [ + "VmwarePropertiesController" + ], + "description": "Method to update properties for machines in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "metaData", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/MachineMetadataCollection" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "VmwarePropertiesController_UpdateProperties_MaximumSet_Gen": { + "$ref": "./examples/VmwarePropertiesController_UpdateProperties_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateRunAsAccount": { + "post": { + "operationId": "VmwarePropertiesController_UpdateRunAsAccount", + "tags": [ + "VmwarePropertiesController" + ], + "description": "Method to associate Run as account to machine\r\n in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "updateMachineRunAsAccount", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMachineRunAsAccount" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "VmwarePropertiesController_UpdateRunAsAccount_MaximumSet_Gen": { + "$ref": "./examples/VmwarePropertiesController_UpdateRunAsAccount_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateTags": { + "post": { + "operationId": "VmwarePropertiesController_UpdateTags", + "tags": [ + "VmwarePropertiesController" + ], + "description": "Method to associate Run as account to machine\r\n in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "updateMachineTags", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMachineTags" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "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, + "x-ms-examples": { + "VmwarePropertiesController_UpdateTags_MaximumSet_Gen": { + "$ref": "./examples/VmwarePropertiesController_UpdateTags_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters": { + "get": { + "operationId": "VcenterController_ListByVmwareSite", + "tags": [ + "VcenterController" + ], + "description": "List Vcenter resources by VmwareSite", + "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" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VcenterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VcenterController_ListByVmwareSite_MaximumSet_Gen": { + "$ref": "./examples/VcenterController_ListByVmwareSite_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters/{vcenterName}": { + "get": { + "operationId": "VcenterController_Get", + "tags": [ + "VcenterController" + ], + "description": "Get a Vcenter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "vcenterName", + "in": "path", + "description": " VCenters name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Vcenter" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VcenterController_Get_MaximumSet_Gen": { + "$ref": "./examples/VcenterController_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "VcenterController_Create", + "tags": [ + "VcenterController" + ], + "description": "Create a Vcenter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "vcenterName", + "in": "path", + "description": " VCenters name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Vcenter" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/Vcenter" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Vcenter" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "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, + "x-ms-examples": { + "VcenterController_Create_MaximumSet_Gen": { + "$ref": "./examples/VcenterController_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "VcenterController_Delete", + "tags": [ + "VcenterController" + ], + "description": "Delete a Vcenter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "vcenterName", + "in": "path", + "description": " VCenters name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VcenterController_Delete_MaximumSet_Gen": { + "$ref": "./examples/VcenterController_Delete_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "Application": { + "type": "object", + "description": "Application in the guest virtual machine.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets Name of the Application.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the Application.", + "readOnly": true + }, + "provider": { + "type": "string", + "description": "Gets or sets Provider of the Application.", + "readOnly": true + } + } + }, + "ApplicationDiscovery": { + "type": "object", + "description": "Contains data related application and roles discovery scope.", + "properties": { + "discoveryScopeStatus": { + "$ref": "#/definitions/ApplicationDiscoveryScopeStatus", + "description": "Gets discovery scope status.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets errors for discovery scope.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "hydratedRunAsAccountId": { + "type": "string", + "description": "Gets the run as account ID with which feature worked successfully.\n \nIt is discovered by the agent from the list of credentials.", + "readOnly": true + } + } + }, + "ApplicationDiscoveryScopeStatus": { + "type": "string", + "description": "Application Discovery Scope Status", + "enum": [ + "DiscoverySucceededAtleastOnce", + "DiscoveryFailed", + "RunAsAccountNotAssociated", + "DiscoveryNotStarted", + "DiscoveryInProgress", + "Disabled", + "DiscoveryPartiallySucceded", + "DiscoverySucceeded" + ], + "x-ms-enum": { + "name": "ApplicationDiscoveryScopeStatus", + "modelAsString": true, + "values": [ + { + "name": "DiscoverySucceededAtleastOnce", + "value": "DiscoverySucceededAtleastOnce", + "description": "DiscoverySucceededAtleastOnce value." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "DiscoveryFailed value." + }, + { + "name": "RunAsAccountNotAssociated", + "value": "RunAsAccountNotAssociated", + "description": "RunAsAccountNotAssociated value." + }, + { + "name": "DiscoveryNotStarted", + "value": "DiscoveryNotStarted", + "description": "DiscoveryNotStarted value." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "DiscoveryInProgress value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + }, + { + "name": "DiscoveryPartiallySucceded", + "value": "DiscoveryPartiallySucceded", + "description": "DiscoveryPartiallySucceded value." + }, + { + "name": "DiscoverySucceeded", + "value": "DiscoverySucceeded", + "description": "DiscoverySucceeded value." + } + ] + } + }, + "AppsAndRoles": { + "type": "object", + "description": "AppsAndRoles in the guest virtual machine.", + "properties": { + "applications": { + "type": "array", + "description": "Gets or sets Applications of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/Application" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "webApplications": { + "type": "array", + "description": "Gets or sets WebApplications of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/WebApplicationAppsAndRolesModel" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "features": { + "type": "array", + "description": "Gets or sets Features of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/Feature" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sqlServers": { + "type": "array", + "description": "Gets or sets SQLServers of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/SqlServerApplication" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharePointServers": { + "type": "array", + "description": "Gets or sets SharePointServers of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/SharePointServer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "systemCenters": { + "type": "array", + "description": "Gets or sets SystemCenters of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/SystemCenter" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "bizTalkServers": { + "type": "array", + "description": "Gets or sets BizTalkServers of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/BizTalkServer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "exchangeServers": { + "type": "array", + "description": "Gets or sets ExchangeServers of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/ExchangeServer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "otherDatabases": { + "type": "array", + "description": "Gets or sets OtherDatabaseServers of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/OtherDatabase" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "Azure.ResourceManager.Object": { + "type": "object", + "description": "object model" + }, + "BizTalkServer": { + "type": "object", + "description": "BizTalkServer in the guest virtual machine.", + "properties": { + "productName": { + "type": "string", + "description": "Gets or sets ProductName of the BizTalkServer.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets or sets Status of the BizTalkServer.", + "readOnly": true + } + } + }, + "ConnectorUnit": { + "type": "object", + "description": "The connectors of the web server.", + "properties": { + "bindings": { + "type": "array", + "description": "Gets or sets the bindings for the connector.", + "items": { + "$ref": "#/definitions/FrontEndBinding" + }, + "x-ms-identifiers": [] + } + } + }, + "Default": { + "type": "string", + "description": "HealthError Details Source", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "Default", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "default value." + } + ] + } + }, + "DefaultValues": { + "type": "string", + "description": "HealthError Details Source", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "DefaultValues", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "default value." + } + ] + } + }, + "DeleteImportMachinesJob": { + "type": "object", + "description": "A host resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/DeleteImportedMachinesJobProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DeleteImportMachinesJobCollection": { + "type": "object", + "description": "Delete import machines job collection.", + "properties": { + "value": { + "type": "array", + "description": "Gets the list of jobs.", + "items": { + "$ref": "#/definitions/DeleteImportMachinesJob" + } + }, + "nextLink": { + "type": "string", + "description": "Gets the value of next link.", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "DeleteImportedMachinesJobProperties": { + "type": "object", + "description": "Delete Imported Machines Job Properties", + "properties": { + "blobName": { + "type": "string", + "description": "blob name" + }, + "errorSasUri": { + "type": "string", + "description": "error Sas Uri" + }, + "jobState": { + "$ref": "#/definitions/DeleteImportedMachinesJobPropertiesJobState", + "description": "job State" + }, + "numberOfMachinesDeleted": { + "type": "integer", + "format": "int32", + "description": "number Of Machines Deleted" + }, + "deletionConfirmation": { + "type": "boolean", + "description": "deletion Confirmation" + }, + "errors": { + "type": "array", + "description": "errors list", + "items": { + "type": "string" + }, + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets or sets the Job status." + }, + "startTime": { + "type": "string", + "description": "Gets or sets the Job start time." + }, + "endTime": { + "type": "string", + "description": "Gets or sets the Job end time." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the Display name." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "DeleteImportedMachinesJobPropertiesJobState": { + "type": "string", + "description": "Cosmos db Imported Machines JobEntity", + "enum": [ + "Unknown", + "Verified", + "VerifiedWithErrors", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "DeleteImportedMachinesJobPropertiesJobState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Verified", + "value": "Verified", + "description": "Verified value." + }, + { + "name": "VerifiedWithErrors", + "value": "VerifiedWithErrors", + "description": "VerifiedWithErrors value." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed value." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed value." + } + ] + } + }, + "DependencyMapDiscovery": { + "type": "object", + "description": "Contains data related dependency map discovery scope.", + "properties": { + "discoveryScopeStatus": { + "$ref": "#/definitions/DependencyMapDiscoveryScopeStatus", + "description": "Gets discovery scope status.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets errors for discovery scope.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "hydratedRunAsAccountId": { + "type": "string", + "description": "Gets the run as account ID with which feature worked successfully.\n \nIt is discovered by the agent from the list of credentials.", + "readOnly": true + } + } + }, + "DependencyMapDiscoveryScopeStatus": { + "type": "string", + "description": "DependencyMap DiscoveryScope Status", + "enum": [ + "DiscoverySucceededAtleastOnce", + "DiscoveryFailed", + "RunAsAccountNotAssociated", + "DiscoveryNotStarted", + "DiscoveryInProgress", + "Disabled", + "DiscoveryPartiallySucceded", + "DiscoverySucceeded" + ], + "x-ms-enum": { + "name": "DependencyMapDiscoveryScopeStatus", + "modelAsString": true, + "values": [ + { + "name": "DiscoverySucceededAtleastOnce", + "value": "DiscoverySucceededAtleastOnce", + "description": "DiscoverySucceededAtleastOnce value." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "DiscoveryFailed value." + }, + { + "name": "RunAsAccountNotAssociated", + "value": "RunAsAccountNotAssociated", + "description": "RunAsAccountNotAssociated value." + }, + { + "name": "DiscoveryNotStarted", + "value": "DiscoveryNotStarted", + "description": "DiscoveryNotStarted value." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "DiscoveryInProgress value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + }, + { + "name": "DiscoveryPartiallySucceded", + "value": "DiscoveryPartiallySucceded", + "description": "DiscoveryPartiallySucceded value." + }, + { + "name": "DiscoverySucceeded", + "value": "DiscoverySucceeded", + "description": "DiscoverySucceeded value." + } + ] + } + }, + "DependencyMapMachineInput": { + "type": "object", + "description": "Machine class.", + "properties": { + "machineId": { + "type": "string", + "description": "Gets or sets the ARM id of the machine." + }, + "isDependencyMapToBeEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether\n dependency mapping is to\nbe enabled or not." + } + } + }, + "DependencyMapServiceMapextensionsClientGroupMembersRequest": { + "type": "object", + "description": "DependencyMap ServiceMap extensions Client GroupMembers Request", + "properties": { + "machineId": { + "type": "string", + "description": "id of machine" + }, + "processGroupName": { + "type": "string", + "description": "process group name " + }, + "processName": { + "type": "string", + "description": "name of process" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "start time" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "end time" + }, + "filters": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsDependencyMapRequestFilters", + "description": "optional filters" + } + } + }, + "DependencyMapServiceMapextensionsDependencyMapRequestFilters": { + "type": "object", + "description": "DependencyMap Service Map extensions Dependency Map Request Filters", + "properties": { + "machineIds": { + "type": "array", + "description": "array of machine ids", + "items": { + "type": "string" + } + }, + "processIds": { + "type": "array", + "description": "array of process Ids", + "items": { + "type": "string" + } + } + } + }, + "DependencyMapServiceMapextensionsExportDependenciesRequest": { + "type": "object", + "description": "DependencyMap ServiceMap extensions ExportDependencies Request", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "start time" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "end time" + } + } + }, + "DependencyMapServiceMapextensionsScopeMapRequest": { + "type": "object", + "description": "DependencyMap ServiceMapextensions Scope MapRequest", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "start time" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "end time" + }, + "filters": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsDependencyMapRequestFilters", + "description": "optional filters" + } + } + }, + "DependencyMapServiceMapextensionsServerGroupMembersRequest": { + "type": "object", + "description": "DependencyMap ServiceMap extensions ServerGroup Members Request", + "properties": { + "serverPort": { + "type": "integer", + "format": "int32", + "description": "port of server" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "start time" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "end time" + }, + "filters": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsDependencyMapRequestFilters", + "description": "optional filters" + } + } + }, + "DependencyMapServiceMapextensionsSingleMachineDetailedMapRequest": { + "type": "object", + "description": "DependencyMap ServiceMap extensions SingleMachine DetailedMap Request", + "properties": { + "machineId": { + "type": "string", + "description": "id of machine" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "start time" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "end time" + }, + "filters": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsDependencyMapRequestFilters", + "description": "optional filters" + } + } + }, + "DirectoryPath": { + "type": "object", + "description": "Second level entity for virtual directories.", + "properties": { + "virtual": { + "type": "string", + "description": "Gets or sets the virtual path for the directory." + }, + "physical": { + "type": "string", + "description": "Gets or sets the physical path of the directory on the web server." + } + } + }, + "DiscoveryScopeErrorSummary": { + "type": "object", + "description": "The site error summary model.", + "properties": { + "affectedResourceType": { + "type": "string", + "description": "Gets or sets the affected resource type." + }, + "affectedObjectsCount": { + "type": "integer", + "format": "int64", + "description": "Count of affected objects." + }, + "discoveryScope": { + "$ref": "#/definitions/DiscoveryScopes", + "description": "Gets or sets the count of affected objects." + } + }, + "required": [ + "affectedResourceType", + "affectedObjectsCount", + "discoveryScope" + ] + }, + "DiscoveryScopeStatus": { + "type": "string", + "description": "Discovery Scope.", + "enum": [ + "DiscoverySucceededAtleastOnce", + "DiscoveryFailed", + "RunAsAccountNotAssociated", + "DiscoveryNotStarted", + "DiscoveryInProgress", + "Disabled", + "DiscoveryPartiallySucceded", + "DiscoverySucceeded" + ], + "x-ms-enum": { + "name": "DiscoveryScopeStatus", + "modelAsString": true, + "values": [ + { + "name": "DiscoverySucceededAtleastOnce", + "value": "DiscoverySucceededAtleastOnce", + "description": "DiscoverySucceededAtleastOnce value." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "DiscoveryFailed value." + }, + { + "name": "RunAsAccountNotAssociated", + "value": "RunAsAccountNotAssociated", + "description": "RunAsAccountNotAssociated value." + }, + { + "name": "DiscoveryNotStarted", + "value": "DiscoveryNotStarted", + "description": "DiscoveryNotStarted value." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "DiscoveryInProgress value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + }, + { + "name": "DiscoveryPartiallySucceded", + "value": "DiscoveryPartiallySucceded", + "description": "DiscoveryPartiallySucceded value." + }, + { + "name": "DiscoverySucceeded", + "value": "DiscoverySucceeded", + "description": "DiscoverySucceeded value." + } + ] + } + }, + "DiscoveryScopes": { + "type": "string", + "description": "Discovery scopes", + "enum": [ + "AppsAndRoles", + "DependencyMap", + "StaticData", + "SQLServerConnectionInfo" + ], + "x-ms-enum": { + "name": "DiscoveryScopes", + "modelAsString": true, + "values": [ + { + "name": "AppsAndRoles", + "value": "AppsAndRoles", + "description": "AppsAndRoles value." + }, + { + "name": "DependencyMap", + "value": "DependencyMap", + "description": "DependencyMap value." + }, + { + "name": "StaticData", + "value": "StaticData", + "description": "StaticData value." + }, + { + "name": "SQLServerConnectionInfo", + "value": "SQLServerConnectionInfo", + "description": "SQLServerConnectionInfo value." + } + ] + } + }, + "DiscoverySiteDataSource": { + "type": "object", + "description": "Web app data source web model.", + "properties": { + "properties": { + "$ref": "#/definitions/DiscoverySiteDataSourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DiscoverySiteDataSourceListResult": { + "type": "object", + "description": "The response of a DiscoverySiteDataSource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DiscoverySiteDataSource items on this page", + "items": { + "$ref": "#/definitions/DiscoverySiteDataSource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DiscoverySiteDataSourceProperties": { + "type": "object", + "description": "Discovery site data source properties class.", + "properties": { + "discoverySiteId": { + "type": "string", + "description": "Gets or sets the discovery site Id." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "ErrorDetails": { + "type": "object", + "description": "Error contract returned when some exception occurs in Rest API.", + "properties": { + "code": { + "type": "string", + "description": "Gets the error code.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "possibleCauses": { + "type": "string", + "description": "Gets the possible causes of error.", + "readOnly": true + }, + "recommendedAction": { + "type": "string", + "description": "Gets the recommended action to resolve error.", + "readOnly": true + }, + "severity": { + "type": "string", + "description": "Gets the error severity.", + "readOnly": true + }, + "isAgentReportedError": { + "type": "boolean", + "description": "Gets a value indicating whether the error originated from a agent or not.", + "readOnly": true + }, + "agentErrorCode": { + "type": "string", + "description": "Gets the agent error code.", + "readOnly": true + }, + "agentErrorMessage": { + "type": "string", + "description": "Gets the error message from the agent.", + "readOnly": true + }, + "agentErrorPossibleCauses": { + "type": "string", + "description": "Gets possible causes for the agent error.", + "readOnly": true + }, + "agentErrorRecommendedAction": { + "type": "string", + "description": "Gets the recommended action for the agent error.", + "readOnly": true + } + } + }, + "ErrorSummaryRequest": { + "type": "object", + "description": "ErrorSummaryRequest body", + "properties": { + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + } + } + }, + "Errors": { + "type": "object", + "description": "The properties of a server machine tracked resource", + "properties": { + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "messageParameters": { + "type": "object", + "description": "Gets the message parameters.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "applianceName": { + "type": "string", + "description": "Gets the appliance name.", + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "description": "Gets the error ID.", + "readOnly": true + }, + "code": { + "type": "string", + "description": "Gets the error name.", + "readOnly": true + }, + "possibleCauses": { + "type": "string", + "description": "Gets the possible causes of error.", + "readOnly": true + }, + "recommendedAction": { + "type": "string", + "description": "Gets the recommended action to resolve error.", + "readOnly": true + }, + "severity": { + "type": "string", + "description": "Gets the error severity.", + "readOnly": true + }, + "summaryMessage": { + "type": "string", + "description": "Gets the error summary message.", + "readOnly": true + }, + "source": { + "$ref": "#/definitions/MicrosoftAzureFDSWebRoleHealthErrorDetailsSource", + "description": "Gets the error source.", + "readOnly": true + }, + "updatedTimeStamp": { + "type": "string", + "format": "date-time", + "description": "Gets the time stamp when the error was updated.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets run as account id used while performing discovery of entity.", + "readOnly": true + }, + "discoveryScope": { + "$ref": "#/definitions/HealthErrorDetailsDiscoveryScope", + "description": "Gets discovery scope for which error is encountered.", + "readOnly": true + } + } + }, + "ExchangeServer": { + "type": "object", + "description": "ExchangeServer in the guest virtual machine.", + "properties": { + "productName": { + "type": "string", + "description": "Gets or sets ProductName of the ExchangeServer.", + "readOnly": true + }, + "edition": { + "type": "string", + "description": "Gets or sets Edition of the ExchangeServer.", + "readOnly": true + }, + "roles": { + "type": "string", + "description": "Gets or sets Roles of the ExchangeServer.", + "readOnly": true + }, + "servicePack": { + "type": "string", + "description": "Gets or sets ServicePack of the ExchangeServer.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the ExchangeServer.", + "readOnly": true + } + } + }, + "ExportImportedMachinesJob": { + "type": "object", + "description": "Export machines job REST resource.", + "properties": { + "type": { + "type": "string", + "description": "Type name for export job.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ExportImportedMachinesJobEntityProperties", + "description": "Gets or sets the export machines job properties." + }, + "id": { + "type": "string", + "description": "Gets or sets the relative ARM name to get job." + }, + "name": { + "type": "string", + "description": "Gets or sets the Job ID." + }, + "status": { + "type": "string", + "description": "Gets or sets the Job status." + }, + "startTime": { + "type": "string", + "description": "Gets or sets the Job start time." + }, + "endTime": { + "type": "string", + "description": "Gets or sets the Job end time." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the Display name." + } + } + }, + "ExportImportedMachinesJobEntityProperties": { + "type": "object", + "description": " Export Imported Machines JobEntity Properties ", + "properties": { + "blobName": { + "type": "string", + "description": "blob name" + }, + "sasUri": { + "type": "string", + "description": "sas uri" + } + } + }, + "ExportMachineErrorsProperties": { + "type": "string", + "description": "Export Machine Errors Properties", + "enum": [ + "AppsAndRoles", + "DependencyMap", + "StaticData", + "SQLServerConnectionInfo" + ], + "x-ms-enum": { + "name": "ExportMachineErrorsProperties", + "modelAsString": true, + "values": [ + { + "name": "AppsAndRoles", + "value": "AppsAndRoles", + "description": "AppsAndRoles value." + }, + { + "name": "DependencyMap", + "value": "DependencyMap", + "description": "DependencyMap value." + }, + { + "name": "StaticData", + "value": "StaticData", + "description": "StaticData value." + }, + { + "name": "SQLServerConnectionInfo", + "value": "SQLServerConnectionInfo", + "description": "SQLServerConnectionInfo value." + } + ] + } + }, + "ExportMachineErrorsRequest": { + "type": "object", + "description": "The body of export machine errors request.", + "properties": { + "properties": { + "$ref": "#/definitions/RequestExportMachineErrorsProperties", + "description": "Gets or sets the properties." + } + } + }, + "ExportMachinesRequest": { + "type": "object", + "description": "ExportMachinesRequest body", + "properties": { + "filter": { + "type": "string", + "description": "filter options." + } + } + }, + "ExportSqlServersRequest": { + "type": "object", + "description": "ExportSqlServerRequest body", + "properties": { + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + }, + "filter": { + "type": "string", + "description": "filter options." + } + } + }, + "ExportWebAppsRequest": { + "type": "object", + "description": "ExportWebAppsRequest body", + "properties": { + "filter": { + "type": "string", + "description": "filter options." + } + } + }, + "FCIInstanceState": { + "type": "string", + "description": "fci instance state ", + "enum": [ + "Unknown", + "Inherited", + "Initializing", + "Online", + "Offline", + "Failed", + "Pending", + "OnlinePending", + "OfflinePending" + ], + "x-ms-enum": { + "name": "FCIInstanceState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Inherited", + "value": "Inherited", + "description": "Inherited value." + }, + { + "name": "Initializing", + "value": "Initializing", + "description": "Initializing value." + }, + { + "name": "Online", + "value": "Online", + "description": "Online value." + }, + { + "name": "Offline", + "value": "Offline", + "description": "Offline value." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed value." + }, + { + "name": "Pending", + "value": "Pending", + "description": "Pending value." + }, + { + "name": "OnlinePending", + "value": "OnlinePending", + "description": "OnlinePending value." + }, + { + "name": "OfflinePending", + "value": "OfflinePending", + "description": "OfflinePending value." + } + ] + } + }, + "Feature": { + "type": "object", + "description": "Feature in the guest virtual machine.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets Name of the Feature.", + "readOnly": true + }, + "featureType": { + "type": "string", + "description": "Gets or sets FeatureType of the Feature.", + "readOnly": true + }, + "parent": { + "type": "string", + "description": "Gets or sets Parent of the Feature.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets or sets Status of the Feature.", + "readOnly": true + } + } + }, + "FileMetaData": { + "type": "object", + "description": "File Metadata web model.", + "properties": { + "logicalName": { + "type": "string", + "description": "Gets or sets the logical name of the file." + }, + "physicalFullName": { + "type": "string", + "description": "Gets or sets the operating-system full path of the file." + }, + "fileType": { + "$ref": "#/definitions/FileType", + "description": "Gets or sets the database file type." + }, + "sizeInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets the size of the file in MB." + }, + "isMemoryOptimizedDataOptionEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether memory optimized data option is enabled." + } + } + }, + "FileType": { + "type": "string", + "description": "file type", + "enum": [ + "Rows", + "Log", + "Filestream", + "NotSupported", + "Fulltext" + ], + "x-ms-enum": { + "name": "FileType", + "modelAsString": true, + "values": [ + { + "name": "Rows", + "value": "Rows", + "description": "Rows value." + }, + { + "name": "Log", + "value": "Log", + "description": "Log value." + }, + { + "name": "Filestream", + "value": "Filestream", + "description": "Filestream value." + }, + { + "name": "NotSupported", + "value": "NotSupported", + "description": "NotSpecified value." + }, + { + "name": "Fulltext", + "value": "Fulltext", + "description": "Fulltext value." + } + ] + } + }, + "FrontEndBinding": { + "type": "object", + "description": "Frontend bindings for a web application.", + "properties": { + "protocol": { + "type": "string", + "description": "Gets or sets the Binding protocol." + }, + "hostName": { + "type": "string", + "description": "Gets or sets the Host name." + }, + "port": { + "type": "string", + "description": "Gets or sets the Port number." + }, + "ipAddress": { + "type": "string", + "description": "Gets or sets the IP Address." + } + } + }, + "GuestOsDetails": { + "type": "object", + "description": "Second level object. Data related to a machine's operating system. Serialized and stored as part of Machine Rest object. ", + "properties": { + "osType": { + "type": "string", + "description": "Gets or sets the type of the operating system." + }, + "osName": { + "type": "string", + "description": "Gets or sets the Name of the operating system." + }, + "osVersion": { + "type": "string", + "description": "Gets or sets the Version of the operating system." + }, + "osArchitecture": { + "type": "string", + "description": "Gets or sets the Architecture of the operating system." + } + } + }, + "HealthErrorDetails": { + "type": "object", + "description": "Error contract returned when some exception occurs in Rest API.", + "properties": { + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "messageParameters": { + "type": "object", + "description": "Gets the message parameters.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "applianceName": { + "type": "string", + "description": "Gets the appliance name.", + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int64", + "description": "Gets the error ID.", + "readOnly": true + }, + "code": { + "type": "string", + "description": "Gets the error name.", + "readOnly": true + }, + "possibleCauses": { + "type": "string", + "description": "Gets the possible causes of error.", + "readOnly": true + }, + "recommendedAction": { + "type": "string", + "description": "Gets the recommended action to resolve error.", + "readOnly": true + }, + "severity": { + "type": "string", + "description": "Gets the error severity.", + "readOnly": true + }, + "summaryMessage": { + "type": "string", + "description": "Gets the error summary message.", + "readOnly": true + }, + "source": { + "$ref": "#/definitions/HealthErrorDetailsSource", + "description": "Gets the error source.", + "readOnly": true + }, + "updatedTimeStamp": { + "type": "string", + "format": "date-time", + "description": "Gets the time stamp when the error was updated.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets run as account id used while performing discovery of entity.", + "readOnly": true + }, + "discoveryScope": { + "$ref": "#/definitions/HealthErrorDetailsDiscoveryScope", + "description": "Gets discovery scope for which error is encountered.", + "readOnly": true + } + } + }, + "HealthErrorDetailsDiscoveryScope": { + "type": "string", + "description": "Gets discovery scope for which error is encountered.", + "enum": [ + "AppsAndRoles", + "DependencyMap", + "StaticData", + "SQLServerConnectionInfo", + "DiscoveryTargets" + ], + "x-ms-enum": { + "name": "HealthErrorDetailsDiscoveryScope", + "modelAsString": true, + "values": [ + { + "name": "AppsAndRoles", + "value": "AppsAndRoles", + "description": "AppsAndRoles value." + }, + { + "name": "DependencyMap", + "value": "DependencyMap", + "description": "DependencyMap value." + }, + { + "name": "StaticData", + "value": "StaticData", + "description": "StaticData value." + }, + { + "name": "SQLServerConnectionInfo", + "value": "SQLServerConnectionInfo", + "description": "SQLServerConnectionInfo value." + }, + { + "name": "DiscoveryTargets", + "value": "DiscoveryTargets", + "description": "DiscoveryTargets value." + } + ] + } + }, + "HealthErrorDetailsSource": { + "type": "string", + "description": "HealthError Details Source", + "enum": [ + "RefreshFabricLayout", + "RefreshFabricLayoutGuest", + "RefreshFabricLayoutDependencyMap" + ], + "x-ms-enum": { + "name": "HealthErrorDetailsSource", + "modelAsString": true, + "values": [ + { + "name": "RefreshFabricLayout", + "value": "RefreshFabricLayout", + "description": "RefreshFabricLayout value." + }, + { + "name": "RefreshFabricLayoutGuest", + "value": "RefreshFabricLayoutGuest", + "description": "RefreshFabricLayoutGuest value." + }, + { + "name": "RefreshFabricLayoutDependencyMap", + "value": "RefreshFabricLayoutDependencyMap", + "description": "RefreshFabricLayoutDependencyMap value." + } + ] + } + }, + "HighAvailability": { + "type": "string", + "description": "Value indicating whether the VM is highly available", + "enum": [ + "Unknown", + "No", + "Yes" + ], + "x-ms-enum": { + "name": "HighAvailability", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "No", + "value": "No", + "description": "No value." + }, + { + "name": "Yes", + "value": "Yes", + "description": "Yes value." + } + ] + } + }, + "HighAvailabilityValues": { + "type": "string", + "description": "Value indicating whether the VM is highly available", + "enum": [ + "Unknown", + "No", + "Yes" + ], + "x-ms-enum": { + "name": "HighAvailabilityValues", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "No", + "value": "No", + "description": "No value." + }, + { + "name": "Yes", + "value": "Yes", + "description": "Yes value." + } + ] + } + }, + "HypervCluster": { + "type": "object", + "description": "A cluster resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/HypervClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervClusterListResult": { + "type": "object", + "description": "The response of a HypervCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervCluster items on this page", + "items": { + "$ref": "#/definitions/HypervCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervClusterProperties": { + "type": "object", + "description": "The properties of Hyperv Cluster", + "properties": { + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking Hyper-V cluster creation.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the Hyper-V cluster.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN/IPAddress of the Hyper-V cluster." + }, + "functionalLevel": { + "type": "integer", + "format": "int32", + "description": "Gets the functional level of the Hyper-V cluster.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets the status of the Hyper-V cluster.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets Run as account ID of the Hyper-V cluster." + }, + "hostFqdnList": { + "type": "array", + "description": "Gets or sets list of hosts (FQDN) currently being tracked by the cluster.", + "items": { + "type": "string" + } + }, + "errors": { + "type": "array", + "description": "Gets the errors.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "HypervDisk": { + "type": "object", + "description": "Second level object returned as part of Machine REST resource.", + "properties": { + "instanceId": { + "type": "string", + "description": "Id of the disk.", + "readOnly": true + }, + "vhdId": { + "type": "string", + "description": "VHD Id of the disk.", + "readOnly": true + }, + "maxSizeInBytes": { + "type": "integer", + "format": "int64", + "description": "Gets or sets Bytes allocated for the disk." + }, + "name": { + "type": "string", + "description": "Gets or sets Name of the disk." + }, + "diskType": { + "type": "string", + "description": "Gets or sets Type of the disk." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Gets or sets LUN of the disk." + }, + "path": { + "type": "string", + "description": "Gets or sets Path of the disk." + } + } + }, + "HypervHost": { + "type": "object", + "description": "A host resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/HypervHostProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervHostListResult": { + "type": "object", + "description": "The response of a HypervHost list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervHost items on this page", + "items": { + "$ref": "#/definitions/HypervHost" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervHostProperties": { + "type": "object", + "description": "The properties of Hyperv Host", + "properties": { + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking Hyper-V host creation.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the Hyper-V host.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN/IPAddress of the Hyper-V host." + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the Hyper-V host." + }, + "version": { + "type": "string", + "description": "Gets the version of the Hyper-V host.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the errors.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "HypervJob": { + "type": "object", + "description": "A job resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervJobListResult": { + "type": "object", + "description": "The response of a HypervJob list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervJob items on this page", + "items": { + "$ref": "#/definitions/HypervJob" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervMachine": { + "type": "object", + "description": "A machine resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/HypervMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervMachineListResult": { + "type": "object", + "description": "The response of a HypervMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervMachine items on this page", + "items": { + "$ref": "#/definitions/HypervMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervMachineProperties": { + "type": "object", + "description": "The properties of AddressResource", + "properties": { + "instanceUuid": { + "type": "string", + "description": "On-premise Instance UUID of the machine.", + "readOnly": true + }, + "hostFqdn": { + "type": "string", + "description": "Host FQDN/IPAddress.", + "readOnly": true + }, + "hostId": { + "type": "string", + "description": "Host ARM ID.", + "readOnly": true + }, + "generation": { + "type": "integer", + "format": "int32", + "description": "Generation of the virtual machine.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "VM version.", + "readOnly": true + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "description": "Value indicating whether the VM is highly available.", + "readOnly": true + }, + "clusterFqdn": { + "type": "string", + "description": "Cluster FQDN/IPAddress.", + "readOnly": true + }, + "clusterId": { + "type": "string", + "description": "Cluster ARM ID.", + "readOnly": true + }, + "maxMemoryMb": { + "type": "integer", + "format": "int32", + "description": "Max memory of the virtual machine in MB.", + "readOnly": true + }, + "isDynamicMemoryEnabled": { + "type": "boolean", + "description": "Value indicating whether dynamic memory is enabled for the VM.", + "readOnly": true + }, + "disks": { + "type": "array", + "description": "Disks attached to the machine.", + "items": { + "$ref": "#/definitions/HypervDisk" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "networkAdapters": { + "type": "array", + "description": "Network adapters attached to the machine.", + "items": { + "$ref": "#/definitions/HypervNetworkAdapter" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "managementServerType": { + "type": "string", + "description": "Management server type captured as a string representation of the\n \n{Microsoft.Azure.FDS.WebRole.HyperVMachineBase.HyperVMachineBaseProperties.ManagementServerType}\nenumeration.", + "readOnly": true + }, + "secureBootTemplateId": { + "type": "string", + "description": "Gets or sets the SecureBootTemplateId setting of the VM.", + "readOnly": true + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether Secure boot is enabled for the VM.", + "readOnly": true + }, + "secureBootTemplate": { + "type": "string", + "description": "Gets or sets the SecureBootTemplateId setting of the VM.", + "readOnly": true + }, + "tpmEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether trusted platform module is enabled on\nthe VM.", + "readOnly": true + }, + "ksdEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether key storage device is enabled on the VM.", + "readOnly": true + }, + "shieldingRequested": { + "type": "boolean", + "description": "Gets or sets a value indicating whether shielding is enabled for the VM.", + "readOnly": true + }, + "dataProtectionRequested": { + "type": "boolean", + "description": "Gets or sets a value indicating whether data protection is requested for a VM.", + "readOnly": true + }, + "encryptStateAndVmMigrationTraffic": { + "type": "boolean", + "description": "Gets or sets a value indicating whether encryption of state and migration\ntraffic is enabled for the VM.", + "readOnly": true + }, + "virtualizationBasedSecurityOptOut": { + "type": "boolean", + "description": "Gets or sets a value indicating whether VM virtualization based security is\nenabled for the VM.", + "readOnly": true + }, + "powerStatus": { + "type": "string", + "description": "Gets the Machine power status.", + "readOnly": true + }, + "vmFqdn": { + "type": "string", + "description": "Gets the VM FQDN.", + "readOnly": true + }, + "vmConfigurationFileLocation": { + "type": "string", + "description": "Gets the Root location of the VM configuration file.", + "readOnly": true + }, + "firmware": { + "type": "string", + "description": "Gets or sets the firmware." + }, + "guestOsDetails": { + "$ref": "#/definitions/GuestOsDetails", + "description": "Operating System Details extracted from the guest bu executing script inside the guest VM. ", + "readOnly": true + }, + "numberOfApplications": { + "type": "integer", + "format": "int32", + "description": "Number of applications installed in the guest VM.", + "readOnly": true + }, + "guestDetailsDiscoveryTimestamp": { + "type": "string", + "format": "date-time", + "description": "The last time at which the Guest Details was discovered\n or the\nerror while discovering guest details based discovery\n of the\nmachine.", + "readOnly": true + }, + "isGuestDetailsDiscoveryInProgress": { + "type": "boolean", + "description": "Whether Refresh Fabric Layout Guest Details has been completed once.\n \n Portal will show discovery in progress, if this value is true.", + "readOnly": true + }, + "dependencyMapping": { + "type": "string", + "description": "Gets or sets if dependency mapping feature is enabled or not\n for\nthe VM.", + "readOnly": true + }, + "dependencyMappingStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets when dependency mapping collection is last started.", + "readOnly": true + }, + "dependencyMappingEndTime": { + "type": "string", + "description": "Gets or sets when dependency mapping collection was last disabled.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the machine." + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Errors for machine.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applicationDiscovery": { + "$ref": "#/definitions/ApplicationDiscovery", + "description": "Gets the data related to application discovery.", + "readOnly": true + }, + "dependencyMapDiscovery": { + "$ref": "#/definitions/DependencyMapDiscovery", + "description": "Gets the data related to dependency map discovery.", + "readOnly": true + }, + "staticDiscovery": { + "$ref": "#/definitions/StaticDiscovery", + "description": "Gets the data related to static discovery.", + "readOnly": true + }, + "sqlDiscovery": { + "$ref": "#/definitions/SqlDiscovery", + "description": "Gets the data related to SQL discovery.", + "readOnly": true + }, + "webAppDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to Web application discovery.", + "readOnly": true + }, + "oracleDiscovery": { + "$ref": "#/definitions/OracleDiscovery", + "description": "Gets the data related to Oracle discovery.", + "readOnly": true + }, + "springBootDiscovery": { + "$ref": "#/definitions/SpringBootDiscovery", + "description": "Gets the data related to SpringBoot discovery.", + "readOnly": true + }, + "iisDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to iis discovery.", + "readOnly": true + }, + "tomcatDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to tomcat discovery.", + "readOnly": true + }, + "appsAndRoles": { + "$ref": "#/definitions/AppsAndRoles", + "description": "Apps And Roles of the Server.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "double", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "displayName": { + "type": "string", + "description": "Gets the Display name of the machine.", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Value indicating whether VM is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the marking machine creation.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the resource.", + "additionalProperties": { + "type": "string" + } + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the machine.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "HypervMachineUpdate": { + "type": "object", + "description": "The type used for update operations of the HypervMachine.", + "properties": { + "properties": { + "$ref": "#/definitions/HypervMachineUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "HypervMachineUpdateProperties": { + "type": "object", + "description": "The updatable properties of the HypervMachine.", + "properties": { + "firmware": { + "type": "string", + "description": "Gets or sets the firmware." + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the machine." + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "double", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the resource.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "HypervNetworkAdapter": { + "type": "object", + "description": "Second level object represented in responses as part of Machine REST resource.", + "properties": { + "networkId": { + "type": "string", + "description": "Network Id.", + "readOnly": true + }, + "subnetName": { + "type": "string", + "description": "Name of the VM subnet within the virtual network the NIC is attached to.", + "readOnly": true + }, + "staticIpAddress": { + "type": "string", + "description": "Static IP address.", + "readOnly": true + }, + "nicType": { + "type": "string", + "description": "Mac address of the NIC.", + "readOnly": true + }, + "nicId": { + "type": "string", + "description": "Gets or sets the NIC Id." + }, + "macAddress": { + "type": "string", + "description": "Gets or sets Mac address of the NIC." + }, + "ipAddressList": { + "type": "array", + "description": "Gets IP addresses for the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "networkName": { + "type": "string", + "description": "Gets or sets Network Name." + }, + "ipAddressType": { + "type": "string", + "description": "Gets or sets Type of the IP address." + } + } + }, + "HypervOperationsStatusResource": { + "type": "object", + "description": "A cluster resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/HypervClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervRunAsAccountResource": { + "type": "object", + "description": "A machine resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RunAsAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervRunAsAccountResourceListResult": { + "type": "object", + "description": "The response of a HypervRunAsAccountResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervRunAsAccountResource items on this page", + "items": { + "$ref": "#/definitions/HypervRunAsAccountResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervSite": { + "type": "object", + "description": "A HyperV SiteResource", + "properties": { + "properties": { + "$ref": "#/definitions/SiteProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "HypervSiteListResult": { + "type": "object", + "description": "The response of a HypervSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervSite items on this page", + "items": { + "$ref": "#/definitions/HypervSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervSiteUpdate": { + "type": "object", + "description": "The type used for update operations of the HypervSite.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/HypervSiteUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "HypervSiteUpdateProperties": { + "type": "object", + "description": "The updatable properties of the HypervSite.", + "properties": { + "servicePrincipalIdentityDetails": { + "$ref": "#/definitions/SiteSpnProperties", + "description": "Gets or sets the service principal identity details used by agent for\ncommunication\n to the service." + }, + "agentDetails": { + "$ref": "#/definitions/SiteAgentProperties", + "description": "Gets or sets the on-premises agent details." + }, + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + }, + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "HypervSiteUsage": { + "type": "object", + "description": "Hyper-V site usage.", + "properties": { + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of machines discovered in the site." + }, + "runAsAccountCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of run as accounts in the site." + }, + "hostCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of hosts part of the site." + }, + "clusterCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of clusters part of the site." + } + } + }, + "HypervVmSoftwareInventory": { + "type": "object", + "description": "HyperV VM software inventory REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineSoftwareInventoryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervVmSoftwareInventoryListResult": { + "type": "object", + "description": "The response of a HypervVmSoftwareInventory list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervVmSoftwareInventory items on this page", + "items": { + "$ref": "#/definitions/HypervVmSoftwareInventory" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IisApplicationUnit": { + "type": "object", + "description": "Second-level object for identification of application units in a web site\nhosted on IIS.", + "properties": { + "applicationPoolName": { + "type": "string", + "description": "Gets or sets the path of the directory." + }, + "managedPipelineMode": { + "type": "string", + "description": "Gets or sets the managed pipeline mode." + }, + "runtimeVersion": { + "type": "string", + "description": "Gets or sets the runtime version." + }, + "enable32BitApiOnWin64": { + "type": "boolean", + "description": "Gets or sets a value indicating whether 32 bit applications are allowed to run\non 64 bit." + }, + "path": { + "$ref": "#/definitions/DirectoryPath", + "description": "Gets or sets the path of the directory." + }, + "directories": { + "type": "array", + "description": "Gets or sets the list of directories.", + "items": { + "$ref": "#/definitions/DirectoryPath" + }, + "x-ms-identifiers": [] + } + } + }, + "IisVirtualApplicationUnit": { + "type": "object", + "description": "Second-level object for identification of virtual applications in a web site\nhosted on IIS.", + "properties": { + "isVirtualDirectory": { + "type": "boolean", + "description": "Gets a value indicating whether the application corresponds to a directory.", + "readOnly": true + }, + "path": { + "$ref": "#/definitions/DirectoryPath", + "description": "Gets or sets the path of the directory." + }, + "directories": { + "type": "array", + "description": "Gets or sets the list of directories.", + "items": { + "$ref": "#/definitions/DirectoryPath" + }, + "x-ms-identifiers": [] + } + } + }, + "IisWebApplicationProperties": { + "type": "object", + "description": "Class for web application properties.", + "properties": { + "applications": { + "type": "array", + "description": "Gets the list of application units for the web site.", + "items": { + "$ref": "#/definitions/IisApplicationUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "virtualApplications": { + "type": "array", + "description": "Gets the list of application units for the web site.", + "items": { + "$ref": "#/definitions/IisVirtualApplicationUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "webServerId": { + "type": "string", + "description": "Gets the web server id.", + "readOnly": true + }, + "webServerName": { + "type": "string", + "description": "Gets the web server name.", + "readOnly": true + }, + "machineArmIds": { + "type": "array", + "description": "Gets the list of machine ARM Ids on which the SQL server is deployed.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "virtualPath": { + "type": "string", + "description": "Gets the virtual path of the application.", + "readOnly": true + }, + "physicalPath": { + "type": "string", + "description": "Gets the physical path of the application.", + "readOnly": true + }, + "bindings": { + "type": "array", + "description": "Gets the front end bindings for the application.", + "items": { + "$ref": "#/definitions/FrontEndBinding" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "frameworks": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/WebApplicationFramework" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "configurations": { + "type": "array", + "description": "Gets the configuration.", + "items": { + "$ref": "#/definitions/WebApplicationConfigurationUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "directories": { + "type": "array", + "description": "Gets the directories.", + "items": { + "$ref": "#/definitions/WebApplicationDirectoryUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "displayName": { + "type": "string", + "description": "Gets the display name.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the resource.", + "additionalProperties": { + "type": "string" + } + }, + "staticFolders": { + "type": "array", + "description": "Static folders.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Machine display name", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Gets the server type.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hasErrors": { + "type": "boolean", + "description": "Gets a value indicating whether the WebApp has errors or not.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "IisWebApplications": { + "type": "object", + "description": "Web application REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/IisWebApplicationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "IisWebApplicationsListResult": { + "type": "object", + "description": "The response of a IisWebApplications list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IisWebApplications items on this page", + "items": { + "$ref": "#/definitions/IisWebApplications" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IisWebApplicationsUpdate": { + "type": "object", + "description": "The type used for update operations of the IisWebApplications.", + "properties": { + "properties": { + "$ref": "#/definitions/IisWebApplicationsUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "IisWebApplicationsUpdateProperties": { + "type": "object", + "description": "The updatable properties of the IisWebApplications.", + "properties": { + "tags": { + "type": "object", + "description": "Gets or sets tags on the resource.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "IisWebServerProperties": { + "type": "object", + "description": "Class for web server properties.", + "properties": { + "configurationLocation": { + "type": "string", + "description": "Gets the configuration location.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets the configuration location.", + "readOnly": true + }, + "machineIds": { + "type": "array", + "description": "Gets the list of machines.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "webApplications": { + "type": "array", + "description": "Gets the list of web applications.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name.", + "readOnly": true + }, + "serverFqdn": { + "type": "string", + "description": "Gets the server FQDN.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the run as account id.", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Gets the server type.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hasErrors": { + "type": "boolean", + "description": "Gets a value indicating whether the WebApp has errors or not.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "IisWebServers": { + "type": "object", + "description": "Web server REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/IisWebServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "IisWebServersListResult": { + "type": "object", + "description": "The response of a IisWebServers list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IisWebServers items on this page", + "items": { + "$ref": "#/definitions/IisWebServers" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ImportJob": { + "type": "object", + "description": "A host resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ImportJobListResult": { + "type": "object", + "description": "The response of a ImportJob list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImportJob items on this page", + "items": { + "$ref": "#/definitions/ImportJob" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ImportMachine": { + "type": "object", + "description": "An machine resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ImportMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ImportMachineListResult": { + "type": "object", + "description": "The response of a ImportMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImportMachine items on this page", + "items": { + "$ref": "#/definitions/ImportMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ImportMachineProperties": { + "type": "object", + "description": "Class for machine properties.", + "properties": { + "firmware": { + "type": "string", + "description": "Firmware of the machine.", + "readOnly": true + }, + "percentageCpuUtilization": { + "type": "number", + "format": "float", + "description": "CPU utilization.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Memory utilization.", + "readOnly": true + }, + "numberOfDisks": { + "type": "integer", + "format": "int32", + "description": "Number of disks.", + "readOnly": true + }, + "totalDiskReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Total disk read operations per second.", + "readOnly": true + }, + "totalDiskWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Total disk write operations per second.", + "readOnly": true + }, + "totalDiskWriteThroughput": { + "type": "number", + "format": "float", + "description": "Total disk write throughput.", + "readOnly": true + }, + "totalDiskReadThroughput": { + "type": "number", + "format": "float", + "description": "Total disk read throughput.", + "readOnly": true + }, + "macAddress": { + "type": "string", + "description": "MAC Address.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "IP Addresses.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "machineId": { + "type": "string", + "description": "Machine ID.", + "readOnly": true + }, + "machineManagerId": { + "type": "string", + "description": "Machine manager ID.", + "readOnly": true + }, + "numberOfNetworkAdapters": { + "type": "integer", + "format": "int32", + "description": "Number of network adapters.", + "readOnly": true + }, + "networkInThroughput": { + "type": "number", + "format": "float", + "description": "Network in throughput.", + "readOnly": true + }, + "networkOutThroughput": { + "type": "number", + "format": "float", + "description": "Network out throughput.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Server type.", + "readOnly": true + }, + "hypervisor": { + "type": "string", + "description": "Fabric type.", + "readOnly": true + }, + "hypervisorVersionNumber": { + "type": "string", + "description": "Hypervisor version number.", + "readOnly": true + }, + "disks": { + "type": "array", + "description": "Disks attached to the machine.", + "items": { + "$ref": "#/definitions/WebRoleImportDisk" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "vmFqdn": { + "type": "string", + "description": "Server FQDN.", + "readOnly": true + }, + "storageInUseGb": { + "type": "number", + "format": "float", + "description": "Total storage in use.", + "readOnly": true + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "double", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/WebRoleOperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "displayName": { + "type": "string", + "description": "Gets the Display name of the machine.", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Value indicating whether VM is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the marking machine creation.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the machine.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "machine tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + }, + "required": [ + "tags" + ] + }, + "ImportMachinesJob": { + "type": "object", + "description": "Import machines Job REST Resource.", + "properties": { + "type": { + "type": "string", + "description": "Handled by resource provider. Type =\nMicrosoft.OffAzure/ImportSites/jobs/importJobs.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ImportMachinesJobProperties", + "description": "Gets or sets the import job properties." + }, + "id": { + "type": "string", + "description": "Gets or sets the relative ARM name to get job." + }, + "name": { + "type": "string", + "description": "Gets or sets the Job ID." + }, + "status": { + "type": "string", + "description": "Gets or sets the Job status." + }, + "startTime": { + "type": "string", + "description": "Gets or sets the Job start time." + }, + "endTime": { + "type": "string", + "description": "Gets or sets the Job end time." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the Display name." + } + } + }, + "ImportMachinesJobProperties": { + "type": "object", + "description": "ImportMachines JobProperties", + "properties": { + "blobName": { + "type": "string", + "description": "blob name" + }, + "blobSasUri": { + "type": "string", + "description": "blob sasUri" + }, + "jobResult": { + "$ref": "#/definitions/JobResult", + "description": "job Result" + }, + "numberOfMachinesImported": { + "type": "integer", + "format": "int32", + "description": "number Of Machines Imported" + }, + "blobCreationTimeStamp": { + "type": "string", + "format": "date-time", + "description": "blob Creation TimeStamp" + }, + "errorSummary": { + "$ref": "#/definitions/JobErrorSummary", + "description": "error summary" + } + } + }, + "ImportSite": { + "type": "object", + "description": "A ImportSite", + "properties": { + "properties": { + "$ref": "#/definitions/ImportSiteProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "ImportSiteListResult": { + "type": "object", + "description": "The response of a ImportSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImportSite items on this page", + "items": { + "$ref": "#/definitions/ImportSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ImportSiteProperties": { + "type": "object", + "description": "The properties of ImportSiteResource", + "properties": { + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + }, + "masterSiteId": { + "type": "string", + "description": "Gets the Master Site this site is linked to.", + "readOnly": true + }, + "serviceEndpoint": { + "type": "string", + "description": "Gets the service endpoint.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "ImportSiteUpdate": { + "type": "object", + "description": "The type used for update operations of the ImportSite.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ImportSiteUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "ImportSiteUpdateProperties": { + "type": "object", + "description": "The updatable properties of the ImportSite.", + "properties": { + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "ImportTypeValues": { + "type": "string", + "description": "ImportTypeValues enum.", + "enum": [ + "AzureMigrateCSV", + "RVToolsXlsx" + ], + "x-ms-enum": { + "name": "ImportTypeValues", + "modelAsString": true, + "values": [ + { + "name": "AzureMigrateCSV", + "value": "AzureMigrateCSV", + "description": "AzureMigrateCSV value." + }, + { + "name": "RVToolsXlsx", + "value": "RVToolsXlsx", + "description": "RVToolsXlsx value." + } + ] + } + }, + "JobErrorSummary": { + "type": "object", + "description": "Job Error Summary", + "properties": { + "errors": { + "type": "array", + "description": "errors list", + "items": { + "type": "string" + } + }, + "errorCount": { + "type": "integer", + "format": "int32", + "description": "error count" + }, + "warningCount": { + "type": "integer", + "format": "int32", + "description": "warning Count" + } + } + }, + "JobProperties": { + "type": "object", + "description": "Job REST Resource.", + "properties": { + "status": { + "type": "string", + "description": "Gets operation status.", + "readOnly": true + }, + "startTime": { + "type": "string", + "description": "Gets operation start time.", + "readOnly": true + }, + "endTime": { + "type": "string", + "description": "Gets operation end time.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets or sets the display name of the Job.", + "readOnly": true + }, + "clientRequestId": { + "type": "string", + "description": "Gets the client request Id used in the operation execution context.", + "readOnly": true + }, + "activityId": { + "type": "string", + "description": "Gets the activity Id used in the operation execution context.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the errors.", + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "JobResult": { + "type": "string", + "description": "JobResultValues", + "enum": [ + "Unknown", + "Completed", + "CompletedWithWarnings", + "CompletedWithErrors", + "Failed", + "WaitingForBlobUpload", + "InProgress" + ], + "x-ms-enum": { + "name": "JobResult", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed value." + }, + { + "name": "CompletedWithWarnings", + "value": "CompletedWithWarnings", + "description": "CompletedWithWarnings value." + }, + { + "name": "CompletedWithErrors", + "value": "CompletedWithErrors", + "description": "CompletedWithErrors value." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed value." + }, + { + "name": "WaitingForBlobUpload", + "value": "WaitingForBlobUpload", + "description": "WaitingForBlobUpload value." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress value." + } + ] + } + }, + "MachineMetadata": { + "type": "object", + "description": "The properties of Machine MetaData", + "properties": { + "machineArmId": { + "type": "string", + "description": "arm id of the machine." + }, + "dependencyMapping": { + "type": "string", + "description": "value representing state of dependency mapping (enabled/disabled)." + }, + "tags": { + "type": "object", + "description": "machine tags", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "machineArmId", + "dependencyMapping", + "tags" + ] + }, + "MachineMetadataCollection": { + "type": "object", + "description": "The list of Machine MetaData.", + "properties": { + "value": { + "type": "array", + "description": "The list of Machine MetaData.", + "items": { + "$ref": "#/definitions/MachineMetadata" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ] + }, + "MachineResource": { + "type": "object", + "description": "An machine resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/VmwareMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "MachineResourceListResult": { + "type": "object", + "description": "The response of a MachineResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MachineResource items on this page", + "items": { + "$ref": "#/definitions/MachineResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MachineResourceUpdate": { + "type": "object", + "description": "The type used for update operations of the MachineResource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineResourceUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "MachineResourceUpdateProperties": { + "type": "object", + "description": "The updatable properties of the MachineResource.", + "properties": { + "firmware": { + "type": "string", + "description": "Gets or sets the firmware." + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the machine." + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "double", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the VMware machine.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MachineSoftwareInventoryProperties": { + "type": "object", + "description": "Class for machine software inventory properties.", + "properties": { + "appsAndRoles": { + "$ref": "#/definitions/AppsAndRoles", + "description": "Apps And Roles of the machine entity.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "MasterSite": { + "type": "object", + "description": "A MasterSite", + "properties": { + "properties": { + "$ref": "#/definitions/MasterSiteProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "MasterSiteListResult": { + "type": "object", + "description": "The response of a MasterSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MasterSite items on this page", + "items": { + "$ref": "#/definitions/MasterSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MasterSiteProperties": { + "type": "object", + "description": "Class for site properties.", + "properties": { + "publicNetworkAccess": { + "$ref": "#/definitions/MasterSitePropertiesPublicNetworkAccess", + "description": "Gets or sets the state of public network access." + }, + "allowMultipleSites": { + "type": "boolean", + "description": "Gets or sets a value indicating whether multiple sites per site type are\nallowed." + }, + "sites": { + "type": "array", + "description": "Gets or sets the sites that are a part of Master Site.\n The key\nshould contain the Site ARM name.", + "items": { + "type": "string" + } + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "Gets or sets a value for customer storage account ARM id." + }, + "privateEndpointConnections": { + "type": "array", + "description": "Gets the private endpoint connections.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "nestedSites": { + "type": "array", + "description": "Gets the nested sites under Master Site.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "MasterSitePropertiesPublicNetworkAccess": { + "type": "string", + "description": "PublicNetworkAccess", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "MasterSitePropertiesPublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "NotSpecified value." + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + } + ] + } + }, + "MasterSiteUpdate": { + "type": "object", + "description": "The type used for update operations of the MasterSite.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/MasterSiteUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "MasterSiteUpdateProperties": { + "type": "object", + "description": "The updatable properties of the MasterSite.", + "properties": { + "publicNetworkAccess": { + "$ref": "#/definitions/MasterSitePropertiesPublicNetworkAccess", + "description": "Gets or sets the state of public network access." + }, + "allowMultipleSites": { + "type": "boolean", + "description": "Gets or sets a value indicating whether multiple sites per site type are\nallowed." + }, + "sites": { + "type": "array", + "description": "Gets or sets the sites that are a part of Master Site.\n The key\nshould contain the Site ARM name.", + "items": { + "type": "string" + } + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "Gets or sets a value for customer storage account ARM id." + } + } + }, + "MicrosoftAzureFDSWebRoleHealthErrorDetailsSource": { + "type": "string", + "description": "HealthError Details Source", + "enum": [ + "RefreshFabricLayout", + "RefreshFabricLayoutGuest", + "RefreshFabricLayoutDependencyMap" + ], + "x-ms-enum": { + "name": "MicrosoftAzureFDSWebRoleHealthErrorDetailsSource", + "modelAsString": true, + "values": [ + { + "name": "RefreshFabricLayout", + "value": "RefreshFabricLayout", + "description": "RefreshFabricLayout value." + }, + { + "name": "RefreshFabricLayoutGuest", + "value": "RefreshFabricLayoutGuest", + "description": "RefreshFabricLayoutGuest value." + }, + { + "name": "RefreshFabricLayoutDependencyMap", + "value": "RefreshFabricLayoutDependencyMap", + "description": "RefreshFabricLayoutDependencyMap value." + } + ] + } + }, + "Object": { + "type": "object", + "description": "object model" + }, + "OperatingSystem": { + "type": "object", + "description": "Second level object returned as part of Machine REST resource.", + "properties": { + "osType": { + "type": "string", + "description": "Gets or sets the type of the operating system." + }, + "osName": { + "type": "string", + "description": "Gets or sets the Name of the operating system." + }, + "osVersion": { + "type": "string", + "description": "Gets or sets the Version of the operating system." + }, + "osArchitecture": { + "type": "string", + "description": "Gets or sets the Architecture of the operating system." + } + } + }, + "OperationStatus": { + "type": "object", + "description": "Operation status REST resource.", + "properties": { + "id": { + "type": "string", + "description": "Gets the Id.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Gets the operation name.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets the status of the operation. ARM expects the terminal status to be one\nof\n Succeeded/ Failed/ Canceled. All other values imply that the\noperation is still running.", + "readOnly": true + }, + "startTime": { + "type": "string", + "description": "Gets the start time.", + "readOnly": true + }, + "endTime": { + "type": "string", + "description": "Gets the start time.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/OperationStatusError", + "description": "Gets the error.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OperationStatusProperties", + "description": "Operation status properties", + "readOnly": true + } + } + }, + "OperationStatusError": { + "type": "object", + "description": "Class for operation status errors.", + "properties": { + "code": { + "type": "string", + "description": "Gets the error code.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + } + } + }, + "OperationStatusProperties": { + "type": "object", + "description": "Class for operation result properties.", + "properties": { + "result": { + "type": "string", + "description": "Gets or sets the result or output of the workflow." + } + } + }, + "OracleDiscovery": { + "type": "object", + "description": "Data related to a machine's Oracle discovery.", + "properties": { + "totalInstanceCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets number of successfully discovered instances." + }, + "totalDatabaseCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets number of successfully discovered databases." + }, + "shallowDiscoveryStatus": { + "$ref": "#/definitions/ShallowDiscoveryStatus", + "description": "Gets or sets status of partner shallow discovery." + }, + "discoveryScopeStatus": { + "$ref": "#/definitions/DiscoveryScopeStatus", + "description": "Gets or sets status of partner discovery." + } + } + }, + "OtherDatabase": { + "type": "object", + "description": "OtherDatabase in the guest virtual machine.", + "properties": { + "databaseType": { + "type": "string", + "description": "Gets or sets DatabaseType of the OtherDatabase.", + "readOnly": true + }, + "instance": { + "type": "string", + "description": "Gets or sets Instance of the OtherDatabase.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the OtherDatabase.", + "readOnly": true + } + } + }, + "PagedDeleteImportMachinesJob": { + "type": "object", + "description": "Paged collection of DeleteImportMachinesJob items", + "properties": { + "value": { + "type": "array", + "description": "The DeleteImportMachinesJob items on this page", + "items": { + "$ref": "#/definitions/DeleteImportMachinesJob" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items", + "readOnly": true + } + } + }, + "PagedExportImportedMachinesJob": { + "type": "object", + "description": "Paged collection of ExportImportedMachinesJob items", + "properties": { + "value": { + "type": "array", + "description": "The ExportImportedMachinesJob items on this page", + "items": { + "$ref": "#/definitions/ExportImportedMachinesJob" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items", + "readOnly": true + } + } + }, + "PagedImportMachinesJob": { + "type": "object", + "description": "Paged collection of ImportMachinesJob items", + "properties": { + "value": { + "type": "array", + "description": "The ImportMachinesJob items on this page", + "items": { + "$ref": "#/definitions/ImportMachinesJob" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "REST model used to encapsulate Private Link properties for tracked resources.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionPropertiesV2", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "The response of a PrivateEndpointConnection list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnection items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateEndpointConnectionPropertiesV2": { + "type": "object", + "description": "PrivateEndpointConnectionProperties V2", + "properties": { + "groupIds": { + "type": "array", + "description": "array of group ids", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/ResourceId", + "description": "private endpoints", + "readOnly": true + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "private endpoints connection state" + } + } + }, + "PrivateLinkResource": { + "type": "object", + "description": "REST model used to encapsulate Private Link properties for tracked resources.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "The response of a PrivateLinkResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "private link resource properties model", + "properties": { + "requiredMembers": { + "type": "array", + "description": "required members", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "type": "array", + "description": "required zone names", + "items": { + "type": "string" + } + }, + "groupId": { + "type": "string", + "description": "group id" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "description": "Service Connection State", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStateStatus", + "description": "state status" + }, + "description": { + "type": "string", + "description": "description string" + }, + "actionsRequired": { + "type": "string", + "description": "actions required" + } + } + }, + "PrivateLinkServiceConnectionStateStatus": { + "type": "string", + "description": "PrivateLinkServiceConnectionState", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStateStatus", + "modelAsString": true, + "values": [ + { + "name": "Approved", + "value": "Approved", + "description": "Approved value." + }, + { + "name": "Pending", + "value": "Pending", + "description": "Pending value." + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "Rejected value." + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "Disconnected value." + } + ] + } + }, + "ProcessorInfo": { + "type": "object", + "description": "Processor Information.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name\\model of a processor." + }, + "numberOfSockets": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of sockets." + }, + "numberOfCoresPerSocket": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the total number of cores in a socket." + } + } + }, + "ProductSupportStatus": { + "type": "object", + "description": "product support status.", + "properties": { + "currentVersion": { + "type": "string", + "description": "current version." + }, + "esuStatus": { + "$ref": "#/definitions/esuStatus", + "description": "esu status." + }, + "supportStatus": { + "$ref": "#/definitions/supportStatus", + "description": "support status." + }, + "supportEndDate": { + "type": "string", + "format": "date-time", + "description": "support end date." + }, + "esuYear": { + "$ref": "#/definitions/esuYear", + "description": "esu year." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Created", + "Updated", + "Running", + "Completed", + "Failed", + "Succeeded", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Created", + "value": "Created", + "description": "Created value." + }, + { + "name": "Updated", + "value": "Updated", + "description": "Updated value." + }, + { + "name": "Running", + "value": "Running", + "description": "Running value." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed value." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed value." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded value." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Canceled value." + } + ] + } + }, + "ProxySiteRefreshBody": { + "type": "object", + "description": "Request body for Proxy site refresh action.", + "properties": { + "applianceName": { + "type": "string", + "description": "Gets or sets the appliance name of the agent in the site." + } + } + }, + "RequestExportMachineErrorsProperties": { + "type": "object", + "description": "The Properties class for export machine errors request body.", + "properties": { + "discoveryScope": { + "$ref": "#/definitions/ExportMachineErrorsProperties", + "description": "Gets or sets the discovery scope." + } + } + }, + "ResourceId": { + "type": "object", + "description": "PrivateEndpointModelsResourceId", + "properties": { + "id": { + "type": "string", + "description": "id name", + "readOnly": true + } + } + }, + "RunAsAccountMachineInput": { + "type": "object", + "description": "Machine class.", + "properties": { + "machineId": { + "type": "string", + "description": "Gets or sets the ARM id of the machine." + }, + "runAsAccountId": { + "type": "string", + "description": "run as AccountId" + } + } + }, + "RunAsAccountProperties": { + "type": "object", + "description": "Class for run as account properties.", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of the run as account.", + "readOnly": true + }, + "credentialType": { + "type": "string", + "description": "Gets the credential type of the run as account.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Timestamp marking run as account creation.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Timestamp marking last updated on the run as account.", + "readOnly": true + }, + "applianceName": { + "type": "string", + "description": "Gets the appliance name of the run as account.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "SQLDiscoveryScopeStatus": { + "type": "string", + "description": "SQLDiscoveryScope Status", + "enum": [ + "DiscoverySucceededAtleastOnce", + "DiscoveryFailed", + "RunAsAccountNotAssociated", + "DiscoveryNotStarted", + "DiscoveryInProgress", + "Disabled", + "DiscoveryPartiallySucceded", + "DiscoverySucceeded" + ], + "x-ms-enum": { + "name": "SQLDiscoveryScopeStatus", + "modelAsString": true, + "values": [ + { + "name": "DiscoverySucceededAtleastOnce", + "value": "DiscoverySucceededAtleastOnce", + "description": "DiscoverySucceededAtleastOnce value." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "DiscoveryFailed value." + }, + { + "name": "RunAsAccountNotAssociated", + "value": "RunAsAccountNotAssociated", + "description": "RunAsAccountNotAssociated value." + }, + { + "name": "DiscoveryNotStarted", + "value": "DiscoveryNotStarted", + "description": "DiscoveryNotStarted value." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "DiscoveryInProgress value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + }, + { + "name": "DiscoveryPartiallySucceded", + "value": "DiscoveryPartiallySucceded", + "description": "DiscoveryPartiallySucceded value." + }, + { + "name": "DiscoverySucceeded", + "value": "DiscoverySucceeded", + "description": "DiscoverySucceeded value." + } + ] + } + }, + "SasUriResponse": { + "type": "object", + "description": "Import URI response class.", + "properties": { + "jobArmId": { + "type": "string", + "description": "Gets or sets the job ARM ID." + }, + "uri": { + "type": "string", + "description": "Gets or sets the SAS URI." + }, + "importType": { + "$ref": "#/definitions/ImportTypeValues", + "description": "Gets or sets the import type.", + "default": "AzureMigrateCSV" + } + } + }, + "Server": { + "type": "object", + "description": "A machine resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ServerDisk": { + "type": "object", + "description": "Server disk details.", + "properties": { + "id": { + "type": "string", + "description": "Gets or sets Id of the disk." + }, + "generatedId": { + "type": "string", + "description": "Gets or sets generated Id of the disk." + }, + "maxSizeInBytes": { + "type": "integer", + "format": "int32", + "description": "Gets or sets Bytes allocated for the disk." + }, + "name": { + "type": "string", + "description": "Gets or sets Name of the disk." + }, + "diskType": { + "type": "string", + "description": "Gets or sets Type of the disk." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Gets or sets LUN of the disk." + }, + "path": { + "type": "string", + "description": "Gets or sets Path of the disk." + } + } + }, + "ServerJob": { + "type": "object", + "description": "A host resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ServerJobListResult": { + "type": "object", + "description": "The response of a ServerJob list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerJob items on this page", + "items": { + "$ref": "#/definitions/ServerJob" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServerListResult": { + "type": "object", + "description": "The response of a Server list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Server items on this page", + "items": { + "$ref": "#/definitions/Server" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServerNetworkAdapter": { + "type": "object", + "description": "Second level object represented in responses as part of Machine REST resource.", + "properties": { + "nicId": { + "type": "string", + "description": "Gets or sets the NIC Id." + }, + "macAddress": { + "type": "string", + "description": "Gets or sets Mac address of the NIC." + }, + "ipAddressList": { + "type": "array", + "description": "Gets IP addresses for the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "networkName": { + "type": "string", + "description": "Gets or sets Network Name." + }, + "ipAddressType": { + "type": "string", + "description": "Gets or sets Type of the IP address." + } + } + }, + "ServerProperties": { + "type": "object", + "description": "Server REST resource.", + "properties": { + "displayName": { + "type": "string", + "description": "Gets the Display name of the machine.\n For server entity hydrated\nFQDN is set as display name\n as the server id and server name are\nsame.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN/IPAddress of the server." + }, + "networkAdapters": { + "type": "array", + "description": "Gets or sets the network adapters of the server.", + "items": { + "$ref": "#/definitions/ServerNetworkAdapter" + }, + "x-ms-identifiers": [] + }, + "hydratedFqdn": { + "type": "string", + "description": "Gets or sets the FQDN of machine which can be changed." + }, + "disks": { + "type": "array", + "description": "Gets or sets the disk details of server.", + "items": { + "$ref": "#/definitions/ServerDisk" + } + }, + "validationRequired": { + "type": "string", + "description": "Gets or sets the validation required for the machine." + }, + "processorInfo": { + "$ref": "#/definitions/ProcessorInfo", + "description": "Processor Info of the Server machine.", + "readOnly": true + }, + "firmware": { + "type": "string", + "description": "Gets or sets the firmware." + }, + "guestOsDetails": { + "$ref": "#/definitions/GuestOsDetails", + "description": "Operating System Details extracted from the guest\n bu executing\nscript inside the guest VM.", + "readOnly": true + }, + "numberOfApplications": { + "type": "integer", + "format": "int32", + "description": "Number of applications installed in the guest VM.", + "readOnly": true + }, + "guestDetailsDiscoveryTimestamp": { + "type": "string", + "format": "date-time", + "description": "The last time at which the Guest Details was discovered\n or the\nerror while discovering guest details based discovery\n of the\nmachine.", + "readOnly": true + }, + "isGuestDetailsDiscoveryInProgress": { + "type": "boolean", + "description": "Whether Refresh Fabric Layout Guest Details has been completed once.\n \n Portal will show discovery in progress, if this value is true.", + "readOnly": true + }, + "dependencyMapping": { + "type": "string", + "description": "Gets or sets if dependency mapping feature is enabled or not\n for\nthe VM.", + "readOnly": true + }, + "dependencyMappingStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets when dependency mapping collection is last started.", + "readOnly": true + }, + "dependencyMappingEndTime": { + "type": "string", + "description": "Gets or sets when dependency mapping collection was last disabled.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the machine." + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Errors for machine.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applicationDiscovery": { + "$ref": "#/definitions/ApplicationDiscovery", + "description": "Gets the data related to application discovery.", + "readOnly": true + }, + "dependencyMapDiscovery": { + "$ref": "#/definitions/DependencyMapDiscovery", + "description": "Gets the data related to dependency map discovery.", + "readOnly": true + }, + "staticDiscovery": { + "$ref": "#/definitions/StaticDiscovery", + "description": "Gets the data related to static discovery.", + "readOnly": true + }, + "sqlDiscovery": { + "$ref": "#/definitions/SqlDiscovery", + "description": "Gets the data related to SQL discovery.", + "readOnly": true + }, + "webAppDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to Web application discovery.", + "readOnly": true + }, + "oracleDiscovery": { + "$ref": "#/definitions/OracleDiscovery", + "description": "Gets the data related to Oracle discovery.", + "readOnly": true + }, + "springBootDiscovery": { + "$ref": "#/definitions/SpringBootDiscovery", + "description": "Gets the data related to SpringBoot discovery.", + "readOnly": true + }, + "iisDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to iis discovery.", + "readOnly": true + }, + "tomcatDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to tomcat discovery.", + "readOnly": true + }, + "appsAndRoles": { + "$ref": "#/definitions/AppsAndRoles", + "description": "Apps And Roles of the Server.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "isDeleted": { + "type": "boolean", + "description": "Value indicating whether VM is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the marking machine creation.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the Server machine.", + "additionalProperties": { + "$ref": "#/definitions/Azure.ResourceManager.Object" + } + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the machine.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the server resource." + } + } + }, + "ServerRunAsAccount": { + "type": "object", + "description": "A run as account resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RunAsAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ServerRunAsAccountListResult": { + "type": "object", + "description": "The response of a ServerRunAsAccount list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerRunAsAccount items on this page", + "items": { + "$ref": "#/definitions/ServerRunAsAccount" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServerSiteResource": { + "type": "object", + "description": "A ServerSiteResource", + "properties": { + "properties": { + "$ref": "#/definitions/SitesProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "ServerSiteResourceListResult": { + "type": "object", + "description": "The response of a ServerSiteResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerSiteResource items on this page", + "items": { + "$ref": "#/definitions/ServerSiteResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServerSiteResourceUpdate": { + "type": "object", + "description": "The type used for update operations of the ServerSiteResource.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ServerSiteResourceUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "ServerSiteResourceUpdateProperties": { + "type": "object", + "description": "The updatable properties of the ServerSiteResource.", + "properties": { + "servicePrincipalIdentityDetails": { + "$ref": "#/definitions/SiteSpnProperties", + "description": "Gets or sets the service principal identity details used by agent for\ncommunication\n to the service." + }, + "agentDetails": { + "$ref": "#/definitions/SiteAgentProperties", + "description": "Gets or sets the on-premises agent details." + }, + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + }, + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + } + } + }, + "ServerSiteUsage": { + "type": "object", + "description": "Server site usage.", + "properties": { + "runAsAccountCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of run as accounts in the site." + }, + "serverCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of servers part of the site." + } + } + }, + "ServerSiteUsageResponse": { + "type": "object", + "description": "The properties of ServerSiteUsageResponse.", + "properties": { + "runAsAccounts": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of run as accounts in the site." + }, + "serverCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of servers part of the site." + } + }, + "required": [ + "runAsAccounts", + "serverCount" + ] + }, + "ServerSoftwareInventory": { + "type": "object", + "description": "An software inventory resource belonging to a server resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineSoftwareInventoryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ServerSoftwareInventoryListResult": { + "type": "object", + "description": "The response of a ServerSoftwareInventory list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerSoftwareInventory items on this page", + "items": { + "$ref": "#/definitions/ServerSoftwareInventory" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServerUpdate": { + "type": "object", + "description": "The type used for update operations of the Server.", + "properties": { + "properties": { + "$ref": "#/definitions/ServerUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "ServerUpdateProperties": { + "type": "object", + "description": "The updatable properties of the Server.", + "properties": { + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN/IPAddress of the server." + }, + "networkAdapters": { + "type": "array", + "description": "Gets or sets the network adapters of the server.", + "items": { + "$ref": "#/definitions/ServerNetworkAdapter" + }, + "x-ms-identifiers": [] + }, + "hydratedFqdn": { + "type": "string", + "description": "Gets or sets the FQDN of machine which can be changed." + }, + "disks": { + "type": "array", + "description": "Gets or sets the disk details of server.", + "items": { + "$ref": "#/definitions/ServerDisk" + } + }, + "validationRequired": { + "type": "string", + "description": "Gets or sets the validation required for the machine." + }, + "firmware": { + "type": "string", + "description": "Gets or sets the firmware." + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the machine." + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the Server machine.", + "additionalProperties": { + "$ref": "#/definitions/Azure.ResourceManager.Object" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the server resource." + } + } + }, + "ShallowDiscoveryStatus": { + "type": "string", + "description": "Shallow Discovery Status.", + "enum": [ + "DiscoverySucceededAtleastOnce", + "DiscoveryFailed", + "RunAsAccountNotAssociated", + "DiscoveryNotStarted", + "DiscoveryInProgress", + "Disabled", + "DiscoveryPartiallySucceded", + "DiscoverySucceeded" + ], + "x-ms-enum": { + "name": "ShallowDiscoveryStatus", + "modelAsString": true, + "values": [ + { + "name": "DiscoverySucceededAtleastOnce", + "value": "DiscoverySucceededAtleastOnce", + "description": "DiscoverySucceededAtleastOnce value." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "DiscoveryFailed value." + }, + { + "name": "RunAsAccountNotAssociated", + "value": "RunAsAccountNotAssociated", + "description": "RunAsAccountNotAssociated value." + }, + { + "name": "DiscoveryNotStarted", + "value": "DiscoveryNotStarted", + "description": "DiscoveryNotStarted value." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "DiscoveryInProgress value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + }, + { + "name": "DiscoveryPartiallySucceded", + "value": "DiscoveryPartiallySucceded", + "description": "DiscoveryPartiallySucceded value." + }, + { + "name": "DiscoverySucceeded", + "value": "DiscoverySucceeded", + "description": "DiscoverySucceeded value." + } + ] + } + }, + "SharePointServer": { + "type": "object", + "description": "SharePointServer in the guest virtual machine.", + "properties": { + "productName": { + "type": "string", + "description": "Gets or sets ProductName of the SharePointServer.", + "readOnly": true + }, + "isEnterprise": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the SharePointServer is Enterprise.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets or sets Status of the SharePointServer.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the SharePointServer.", + "readOnly": true + } + } + }, + "SiteAgentProperties": { + "type": "object", + "description": "Class for site agent properties.", + "properties": { + "id": { + "type": "string", + "description": "Gets the ID of the agent.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets the version of the agent.", + "readOnly": true + }, + "lastHeartBeatUtc": { + "type": "string", + "format": "date-time", + "description": "Gets the last heartbeat time of the agent in UTC.", + "readOnly": true + }, + "keyVaultUri": { + "type": "string", + "description": "Gets or sets the key vault URI." + }, + "keyVaultId": { + "type": "string", + "description": "Gets or sets the key vault ARM Id." + } + } + }, + "SiteApplianceProperties": { + "type": "object", + "description": "Class for site appliance properties.", + "properties": { + "servicePrincipalIdentityDetails": { + "$ref": "#/definitions/SiteSpnProperties", + "description": " Gets or sets the service principal identity details used by agent for communication to the service. " + }, + "agentDetails": { + "$ref": "#/definitions/SiteAgentProperties", + "description": "Gets or sets the on-premises agent details." + }, + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + } + } + }, + "SiteErrorSummary": { + "type": "object", + "description": "Site error summary.", + "properties": { + "applianceName": { + "type": "string", + "description": "Appliance Name." + }, + "discoveryScopeErrorSummaries": { + "$ref": "#/definitions/DiscoveryScopeErrorSummary", + "description": "Gets the error message." + }, + "nextLink": { + "type": "string", + "description": "The link to fetch more models." + } + }, + "required": [ + "applianceName", + "discoveryScopeErrorSummaries" + ] + }, + "SiteHealthSummary": { + "type": "object", + "description": "The properties of ServerSiteResource.", + "properties": { + "applianceName": { + "type": "string", + "description": "Gets the appliance name.", + "readOnly": true + }, + "errorMessage": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "summaryMessage": { + "type": "string", + "description": "Gets the summary message.", + "readOnly": true + }, + "errorId": { + "type": "integer", + "format": "int64", + "description": "Gets the error Id.", + "readOnly": true + }, + "errorCode": { + "type": "string", + "description": "Gets the error code.", + "readOnly": true + }, + "affectedObjectsCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the count of affected objects." + }, + "hitCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the hit count of the error." + }, + "severity": { + "type": "string", + "description": "Gets the severity of error.", + "readOnly": true + }, + "remediationGuidance": { + "type": "string", + "description": "Gets the remediation guidance.", + "readOnly": true + }, + "affectedResourceType": { + "type": "string", + "description": "Gets the affected resource type.", + "readOnly": true + }, + "affectedResources": { + "type": "array", + "description": "Gets or sets the affected resources.", + "items": { + "type": "string" + } + }, + "fabricLayoutUpdateSources": { + "type": "array", + "description": "Gets or sets sources of the exception.", + "items": { + "$ref": "#/definitions/SiteHealthSummaryFabricLayoutUpdateSourcesItem" + } + } + } + }, + "SiteHealthSummaryCollection": { + "type": "object", + "description": "Collection of SiteHealthSummary.", + "properties": { + "value": { + "type": "array", + "description": "Gets the list of SiteHealthSummary.", + "items": { + "$ref": "#/definitions/SiteHealthSummary" + }, + "x-ms-identifiers": [ + "applianceName" + ] + }, + "nextLink": { + "type": "string", + "description": "Gets the value of next link.", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "SiteHealthSummaryFabricLayoutUpdateSourcesItem": { + "type": "string", + "description": "SiteHealthSummary FabricLayout UpdateSources", + "enum": [ + "RefreshFabricLayout", + "RefreshFabricLayoutGuest", + "RefreshFabricLayoutDependencyMap" + ], + "x-ms-enum": { + "name": "SiteHealthSummaryFabricLayoutUpdateSourcesItem", + "modelAsString": true, + "values": [ + { + "name": "RefreshFabricLayout", + "value": "RefreshFabricLayout", + "description": "RefreshFabricLayout value." + }, + { + "name": "RefreshFabricLayoutGuest", + "value": "RefreshFabricLayoutGuest", + "description": "RefreshFabricLayoutGuest value." + }, + { + "name": "RefreshFabricLayoutDependencyMap", + "value": "RefreshFabricLayoutDependencyMap", + "description": "RefreshFabricLayoutDependencyMap value." + } + ] + } + }, + "SiteProperties": { + "type": "object", + "description": "The properties of VMwareSiteResource", + "properties": { + "masterSiteId": { + "type": "string", + "description": "Gets the Master Site this site is linked to.", + "readOnly": true + }, + "servicePrincipalIdentityDetails": { + "$ref": "#/definitions/SiteSpnProperties", + "description": "Gets or sets the service principal identity details used by agent for\ncommunication\n to the service." + }, + "agentDetails": { + "$ref": "#/definitions/SiteAgentProperties", + "description": "Gets or sets the on-premises agent details." + }, + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + }, + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + }, + "serviceEndpoint": { + "type": "string", + "description": "Gets the service endpoint.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "SiteSpnProperties": { + "type": "object", + "description": "Class for site properties.", + "properties": { + "tenantId": { + "type": "string", + "description": "Gets or sets the tenant Id for the service principal with which the\non-premise\n management/data plane components would communicate with\nour Azure services." + }, + "applicationId": { + "type": "string", + "description": "Gets or sets the application/client Id for the service principal with which\nthe\n on-premise management/data plane components would communicate\nwith our Azure \n services." + }, + "objectId": { + "type": "string", + "description": "Gets or sets the object Id of the service principal with which the on-premise\n\n management/data plane components would communicate with our Azure\nservices." + }, + "audience": { + "type": "string", + "description": "Gets or sets the intended audience for the service principal." + }, + "aadAuthority": { + "type": "string", + "description": "Gets or sets the AAD Authority URL which was used to request the token for\nthe\n service principal." + }, + "rawCertData": { + "type": "string", + "description": "Gets or sets the raw certificate data for building certificate expiry flows." + } + } + }, + "SitesProperties": { + "type": "object", + "description": "The properties of SiteResource", + "properties": { + "masterSiteId": { + "type": "string", + "description": "Gets the Master Site this site is linked to.", + "readOnly": true + }, + "servicePrincipalIdentityDetails": { + "$ref": "#/definitions/SiteSpnProperties", + "description": "Gets or sets the service principal identity details used by agent for\ncommunication\n to the service." + }, + "agentDetails": { + "$ref": "#/definitions/SiteAgentProperties", + "description": "Gets or sets the on-premises agent details." + }, + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + }, + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + }, + "serviceEndpoint": { + "type": "string", + "description": "Gets the service endpoint.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SpringBootDiscovery": { + "type": "object", + "description": "Data related to a machine's spring boot discovery.", + "properties": { + "totalInstanceCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets number of successfully discovered instances." + }, + "totalApplicationCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets number of successfully discovered applications." + }, + "shallowDiscoveryStatus": { + "$ref": "#/definitions/ShallowDiscoveryStatus", + "description": "Gets or sets status of partner shallow discovery." + }, + "discoveryScopeStatus": { + "$ref": "#/definitions/DiscoveryScopeStatus", + "description": "Gets or sets status of partner discovery." + } + } + }, + "SqlAvailabilityGroup": { + "type": "object", + "description": "Class representing the web model of SQL Availability Group.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAvailabilityGroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAvailabilityGroupListResult": { + "type": "object", + "description": "The response of a SqlAvailabilityGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAvailabilityGroup items on this page", + "items": { + "$ref": "#/definitions/SqlAvailabilityGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAvailabilityGroupProperties": { + "type": "object", + "description": "Class for SQL Server availability group properties.", + "properties": { + "availabilityGroupName": { + "type": "string", + "description": "Gets or sets the SQL Availability Group Name." + }, + "availabilityGroupType": { + "$ref": "#/definitions/SqlAvailabilityGroupPropertiesAvailabilityGroupType", + "description": "Gets or sets the type of availability group. Currently there are two types of AGs Traditional and Distributed. " + }, + "isMultiSubNet": { + "type": "boolean", + "description": "Gets or sets a value indicating whether AG is multi subnet or not." + }, + "clusterName": { + "type": "string", + "description": "Gets or sets the Cluster name where AG is hosted." + }, + "availabilityReplicas": { + "type": "array", + "description": "Gets the list of availability replica properties which together forms this availability group.", + "items": { + "$ref": "#/definitions/SqlAvailabilityReplicaProperties" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "parentReplicaOverviewList": { + "type": "array", + "description": "Gets the parent availability replica overview if any.\n This would be\nset with details of parent AG and AR for cases where this availability group is\na part of a distributed AG.\n Currently, we do not populate this\nsince discovery and linking of DAG(Distributed Availability Group) is not\nimplemented.", + "items": { + "$ref": "#/definitions/SqlAvailabilityReplicaOverview" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "isPartOfDistributedAvailabilityGroup": { + "type": "boolean", + "description": "Gets or sets a value indicating whether this Availability group is part of a\ndistributed AG." + }, + "isDeleted": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the entity is deleted." + }, + "createdTimestamp": { + "type": "string", + "description": "Gets or sets the marking machine creation." + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets or sets the timestamp marking last updated on the machine." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "SqlAvailabilityGroupPropertiesAvailabilityGroupType": { + "type": "string", + "description": "AvailabilityGroupType", + "enum": [ + "Unknown", + "Traditional", + "Distributed" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupPropertiesAvailabilityGroupType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Traditional", + "value": "Traditional", + "description": "Traditional value." + }, + { + "name": "Distributed", + "value": "Distributed", + "description": "Distributed value." + } + ] + } + }, + "SqlAvailabilityGroupReplicaInfo": { + "type": "object", + "description": "Class which represents the SQL availability replica properties of type AG.", + "properties": { + "clusterName": { + "type": "string", + "description": "Gets or sets the name of the cluster on which this replica is hosted." + }, + "availabilityGroupName": { + "type": "string", + "description": "Gets or sets the name of the availability replica." + }, + "availabilityGroupArmId": { + "type": "string", + "description": "Gets or sets the AG ARM ID which are part of this Replica." + } + } + }, + "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaCommitMode": { + "type": "string", + "description": "ReplicaCommitMode", + "enum": [ + "Unknown", + "Synchronous", + "Asynchronous" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaCommitMode", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Synchronous", + "value": "Synchronous", + "description": "Synchronous value." + }, + { + "name": "Asynchronous", + "value": "Asynchronous", + "description": "Asynchronous value." + } + ] + } + }, + "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaReadMode": { + "type": "string", + "description": "ReplicaReadMode", + "enum": [ + "Unknown", + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaReadMode", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "None", + "value": "None", + "description": "None value." + }, + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "ReadOnly value." + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "ReadWrite value." + } + ] + } + }, + "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSeedMode": { + "type": "string", + "description": "ReplicaSeedMode", + "enum": [ + "Unknown", + "Manual", + "Automatic" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSeedMode", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Manual", + "value": "Manual", + "description": "Manual value." + }, + { + "name": "Automatic", + "value": "Automatic", + "description": "Automatic value." + } + ] + } + }, + "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaState": { + "type": "string", + "description": "ReplicaState", + "enum": [ + "Unknown", + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Primary", + "value": "Primary", + "description": "Primary value." + }, + { + "name": "Secondary", + "value": "Secondary", + "description": "Secondary value." + } + ] + } + }, + "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSyncStatus": { + "type": "string", + "description": "ReplicaSyncStatus", + "enum": [ + "Unknown", + "Synchronized", + "Unsynchronized" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSyncStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Synchronized", + "value": "Synchronized", + "description": "Synchronized value." + }, + { + "name": "Unsynchronized", + "value": "Unsynchronized", + "description": "Unsynchronized value." + } + ] + } + }, + "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaType": { + "type": "string", + "description": "ReplicaType", + "enum": [ + "Unknown", + "DatabaseReplica", + "AvailabilityGroupReplica" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "DatabaseReplica", + "value": "DatabaseReplica", + "description": "DatabaseReplica value." + }, + { + "name": "AvailabilityGroupReplica", + "value": "AvailabilityGroupReplica", + "description": "AvailabilityGroupReplica value." + } + ] + } + }, + "SqlAvailabilityReplicaOverview": { + "type": "object", + "description": "Web model for SQL replica overview.", + "properties": { + "replicaState": { + "$ref": "#/definitions/SqlAvailabilityReplicaOverviewReplicaState", + "description": "Gets or sets the state of the availability replica." + }, + "availabilityReplicaId": { + "type": "string", + "description": "Gets or sets the SQL Availability Replica Id within the Availability Group this\ndatabase is a part of." + }, + "availabilityGroupArmId": { + "type": "string", + "description": "Gets or sets the Availability Group Id in which this database participates if\nany. It would be set if the database has\n{Microsoft.Azure.FDS.CosmosDB.SqlDatabaseEntity.IsDatabaseHighlyAvailable} has\na value \"true\"." + }, + "availabilityGroupName": { + "type": "string", + "description": "Gets or sets the SQL Availability group name." + } + } + }, + "SqlAvailabilityReplicaOverviewReplicaState": { + "type": "string", + "description": "Overview Replica State", + "enum": [ + "Unknown", + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "SqlAvailabilityReplicaOverviewReplicaState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Primary", + "value": "Primary", + "description": "Primary value." + }, + { + "name": "Secondary", + "value": "Secondary", + "description": "Secondary value." + } + ] + } + }, + "SqlAvailabilityReplicaProperties": { + "type": "object", + "description": "Class for SQL Server availability replica properties.", + "properties": { + "availabilityReplicaName": { + "type": "string", + "description": "Gets or sets the SQL Availability Replica Name." + }, + "availabilityReplicaId": { + "type": "string", + "description": "Gets or sets the SQL Availability Replica Id." + }, + "replicaType": { + "$ref": "#/definitions/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaType", + "description": "Gets or sets the replica type of the availability group." + }, + "replicaState": { + "$ref": "#/definitions/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaState", + "description": "Gets or sets the state of the availability replica." + }, + "replicaSyncStatus": { + "$ref": "#/definitions/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSyncStatus", + "description": "Gets or sets the synchronization status of the replica." + }, + "replicaCommitMode": { + "$ref": "#/definitions/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaCommitMode", + "description": "Gets or sets the commit mode of the replica." + }, + "replicaReadMode": { + "$ref": "#/definitions/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaReadMode", + "description": "Gets or sets the read mode of the replica." + }, + "replicaSeedMode": { + "$ref": "#/definitions/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSeedMode", + "description": "Gets or sets the seed mode of the replica." + }, + "sqlDatabaseReplicaInfo": { + "$ref": "#/definitions/SqlDatabaseReplicaInfo", + "description": "Gets or sets the Availability Replica object if Replica is of type database.\nThis is null in case Replica is\n of type AG. This is to be populated\nin case of normal AG." + }, + "sqlAvailabilityGroupReplicaInfo": { + "$ref": "#/definitions/SqlAvailabilityGroupReplicaInfo", + "description": "Gets or sets the Availability Replica object if Replica is of type AG. This is\nnull in case Replica is\n of type database. This is to be populated\nin case AG is of type DAG." + } + } + }, + "SqlDatabasePropertiesV2": { + "type": "object", + "description": "Class for SQL Server database properties.", + "properties": { + "parentReplicaOverview": { + "$ref": "#/definitions/SqlAvailabilityReplicaOverview", + "description": "Gets or sets the Replica overview." + }, + "isDatabaseHighlyAvailable": { + "type": "boolean", + "description": "Gets or sets a value indicating whether this database is a part of an HA setup." + }, + "fileMetadataList": { + "type": "array", + "description": "Gets the file metadata list.", + "items": { + "$ref": "#/definitions/FileMetaData" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "hostname": { + "type": "string", + "description": "Gets or sets the hostname." + }, + "sqlServerName": { + "type": "string", + "description": "Gets or sets the SQL Server Id in which the database resides." + }, + "status": { + "type": "string", + "description": "Gets or sets the status." + }, + "sizeMb": { + "type": "number", + "format": "float", + "description": "Gets or sets the size in Mb." + }, + "databaseName": { + "type": "string", + "description": "Gets or sets the SQL database name." + }, + "sqlServerArmId": { + "type": "string", + "description": "Gets or sets the SQL Server ARM Id in which the database resides." + }, + "compatibilityLevel": { + "type": "string", + "description": "Gets or sets the database compatibility level." + }, + "isDeleted": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the entity is deleted." + }, + "errors": { + "type": "array", + "description": "Gets the errors.", + "items": { + "$ref": "#/definitions/Errors" + }, + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets or sets the marking machine creation." + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets or sets the timestamp marking last updated on the machine." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "SqlDatabaseReplicaInfo": { + "type": "object", + "description": "Class which represents the SQL availability replica properties of type\ndatabases.", + "properties": { + "hostName": { + "type": "string", + "description": "Gets or sets the host name of the availability replica." + }, + "sqlServerName": { + "type": "string", + "description": "Gets or sets the SQL Server name of the availability replica." + }, + "sqlServerArmId": { + "type": "string", + "description": "Gets or sets the SQL Server name of the availability replica." + } + } + }, + "SqlDatabaseV2": { + "type": "object", + "description": "Class representing the web model of SQL Database.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlDatabasePropertiesV2", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlDatabaseV2ListResult": { + "type": "object", + "description": "The response of a SqlDatabaseV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlDatabaseV2 items on this page", + "items": { + "$ref": "#/definitions/SqlDatabaseV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlDiscovery": { + "type": "object", + "description": "Contains data related SQL discovery.", + "properties": { + "successfullyDiscoveredServerCount": { + "type": "integer", + "format": "int32", + "description": " successfully Discovered ServerCount" + }, + "totalServerCount": { + "type": "integer", + "format": "int32", + "description": "total Server Count" + }, + "sqlMetadataHydratedRunAsAccountId": { + "type": "string", + "description": "sql Metadata Hydrated RunAsAccountId" + }, + "sqlMetadataDiscoveryPipe": { + "$ref": "#/definitions/SqlMetadataDiscoveryPipe", + "description": "sql Metadata DiscoveryPipe" + }, + "discoveryScopeStatus": { + "$ref": "#/definitions/SQLDiscoveryScopeStatus", + "description": "discovery Scope Status" + } + } + }, + "SqlDiscoverySiteDataSource": { + "type": "object", + "description": "A SQL discovery site data source resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlDiscoverySiteDataSourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlDiscoverySiteDataSourceListResult": { + "type": "object", + "description": "The response of a SqlDiscoverySiteDataSource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlDiscoverySiteDataSource items on this page", + "items": { + "$ref": "#/definitions/SqlDiscoverySiteDataSource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlDiscoverySiteDataSourceProperties": { + "type": "object", + "description": "Discovery site data source properties class.", + "properties": { + "discoverySiteId": { + "type": "string", + "description": "Gets or sets the discovery site Id." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "SqlFciProperties": { + "type": "object", + "description": "The class representing the properties for an FCI instance.", + "properties": { + "state": { + "$ref": "#/definitions/FCIInstanceState", + "description": "Gets or sets the state of the FCI instance." + }, + "networkName": { + "type": "string", + "description": "Gets or sets the FCI Network Name used to connect to this FCI instance." + }, + "isMultiSubnet": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the FCI is hosted on possible owners\nwhich are in multiple subnets." + }, + "sharedDiskCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of Shared Disks for SQL FCI." + } + } + }, + "SqlJob": { + "type": "object", + "description": "Class representing the web model of SQL Database.", + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlJobListResult": { + "type": "object", + "description": "The response of a SqlJob list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlJob items on this page", + "items": { + "$ref": "#/definitions/SqlJob" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlMachineOverview": { + "type": "object", + "description": "Gets or sets SQL machine overview data.", + "properties": { + "machineArmId": { + "type": "string", + "description": "Gets or sets SQL machine ARM ID." + }, + "displayName": { + "type": "string", + "description": "Gets or sets SQL machine display name." + }, + "fciRole": { + "$ref": "#/definitions/SqlMachineOverviewFciRole", + "description": "Gets or sets SQL machine FCI role." + } + } + }, + "SqlMachineOverviewFciRole": { + "type": "string", + "description": "sql fci role ", + "enum": [ + "Unknown", + "NotApplicable", + "ActiveNode", + "PossibleOwnerNode" + ], + "x-ms-enum": { + "name": "SqlMachineOverviewFciRole", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "NotApplicable", + "value": "NotApplicable", + "description": "NotApplicable value." + }, + { + "name": "ActiveNode", + "value": "ActiveNode", + "description": "ActiveNode value." + }, + { + "name": "PossibleOwnerNode", + "value": "PossibleOwnerNode", + "description": "PossibleOwnerNode value." + } + ] + } + }, + "SqlMetadataDiscoveryPipe": { + "type": "string", + "description": "SQL metadata discovery pipe", + "enum": [ + "Unknown", + "VMware", + "PowerShell", + "SSH", + "CIM", + "Other" + ], + "x-ms-enum": { + "name": "SqlMetadataDiscoveryPipe", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "VMware", + "value": "VMware", + "description": "VMware value." + }, + { + "name": "PowerShell", + "value": "PowerShell", + "description": "PowerShell value." + }, + { + "name": "SSH", + "value": "SSH", + "description": "SSH value." + }, + { + "name": "CIM", + "value": "CIM", + "description": "CIM value." + }, + { + "name": "Other", + "value": "Other", + "description": "Other value." + } + ] + } + }, + "SqlRunAsAccount": { + "type": "object", + "description": "A runasaccount resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RunAsAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlRunAsAccountListResult": { + "type": "object", + "description": "The response of a SqlRunAsAccount list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlRunAsAccount items on this page", + "items": { + "$ref": "#/definitions/SqlRunAsAccount" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlServerApplication": { + "type": "object", + "description": "SQLServer in the guest virtual machine.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets Name of the SQLServer.", + "readOnly": true + }, + "edition": { + "type": "string", + "description": "Gets or sets Edition of the SQLServer.", + "readOnly": true + }, + "servicePack": { + "type": "string", + "description": "Gets or sets ServicePack of the SQLServer.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the SQLServer.", + "readOnly": true + }, + "clustered": { + "type": "string", + "description": "Gets or sets Clustered of the SQLServer.", + "readOnly": true + }, + "clusterName": { + "type": "string", + "description": "Gets or sets ClusterName of the SQLServer.", + "readOnly": true + }, + "dnsHostName": { + "type": "string", + "description": "Gets or sets the DNS host name of SQLServer.", + "readOnly": true + }, + "port": { + "type": "string", + "description": "Gets or sets the port of the SQLServer.", + "readOnly": true + }, + "commaSeparatedIps": { + "type": "string", + "description": "Gets or sets the comma separated IPs of the SQLServer.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets the status.", + "readOnly": true + }, + "isNamedPipeEnabled": { + "type": "boolean", + "description": "Gets or sets the value which reflects if Named Pipe is enabled or not.", + "readOnly": true + }, + "isTcpIpEnabled": { + "type": "boolean", + "description": "Gets or sets the value which reflects if Named Pipe is enabled or not.", + "readOnly": true + }, + "namedPipeName": { + "type": "string", + "description": "Gets the status.", + "readOnly": true + } + } + }, + "SqlServerProperties": { + "type": "object", + "description": "Class for SQL Server properties.", + "properties": { + "machineOverviewList": { + "type": "array", + "description": "Gets the Machine Overview properties of all machines on which the SQL server is deployed.", + "items": { + "$ref": "#/definitions/SqlMachineOverview" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfAgDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of databases part of availability group on this SQL instance." + }, + "sqlFciProperties": { + "$ref": "#/definitions/SqlFciProperties", + "description": "Gets or sets the FCI properties if the instance is an FCI instance. This would be populated if IsClustered is true." + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "version": { + "type": "string", + "description": "Gets or sets the SQL server version." + }, + "numberOfUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets or sets total number of users databases." + }, + "sumOfUserDatabasesSizeInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets total size of all user databases." + }, + "tempDbSizeInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets size of temp database." + }, + "maxServerMemoryInUseInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets maximum server memory in use." + }, + "visibleOnlineCoreCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the SQL server number of cores that have visible online status." + }, + "numOfLogins": { + "type": "integer", + "format": "int32", + "description": "Gets or sets number of logins." + }, + "physicalCpuCount": { + "type": "number", + "format": "float", + "description": "Gets or sets physical CPU count." + }, + "logicalCpuCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets logical CPU count." + }, + "engineEdition": { + "type": "string", + "description": "Gets or sets the SQL server engine edition." + }, + "edition": { + "type": "string", + "description": "Gets or sets the SQL server edition." + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether High Availability is enabled or not." + }, + "isClustered": { + "type": "boolean", + "description": "Gets or sets a value indicating whether failover cluster is configured or not." + }, + "hyperthreadRatio": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Hyper thread ratio." + }, + "sqlStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the SQL start time." + }, + "machineArmIds": { + "type": "array", + "description": "Gets the list of machine ARM Ids on which the SQL server is deployed.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the SQL server." + }, + "hydratedRunAsAccountId": { + "type": "string", + "description": "Gets or sets the hydrated run as account ID of the SQL server." + }, + "hostName": { + "type": "string", + "description": "Gets or sets hostname." + }, + "sqlServerName": { + "type": "string", + "description": "Gets or sets the SQL server instance name." + }, + "portNumber": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Preferred Port Number." + }, + "errors": { + "type": "array", + "description": "Gets the errors.", + "items": { + "$ref": "#/definitions/Errors" + }, + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the resource.", + "additionalProperties": { + "$ref": "#/definitions/Azure.ResourceManager.Object" + } + }, + "isDeleted": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the entity is deleted." + }, + "createdTimestamp": { + "type": "string", + "description": "Gets or sets the marking machine creation." + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets or sets the timestamp marking last updated on the machine." + }, + "status": { + "$ref": "#/definitions/SqlServerStatus", + "description": "Gets or sets the powered on status." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "SqlServerStatus": { + "type": "string", + "description": "sql server status", + "enum": [ + "Unknown", + "ContinuePending", + "Paused", + "PausePending", + "Running", + "StartPending", + "Stopped", + "StopPending" + ], + "x-ms-enum": { + "name": "SqlServerStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "ContinuePending", + "value": "ContinuePending", + "description": "ContinuePending value." + }, + { + "name": "Paused", + "value": "Paused", + "description": "Paused value." + }, + { + "name": "PausePending", + "value": "PausePending", + "description": "PausePending value." + }, + { + "name": "Running", + "value": "Running", + "description": "Running value." + }, + { + "name": "StartPending", + "value": "StartPending", + "description": "StartPending value." + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Stopped value." + }, + { + "name": "StopPending", + "value": "StopPending", + "description": "StopPending value." + } + ] + } + }, + "SqlServerV2": { + "type": "object", + "description": "Class representing the web model of SQL Server.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlServerV2ListResult": { + "type": "object", + "description": "The response of a SqlServerV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlServerV2 items on this page", + "items": { + "$ref": "#/definitions/SqlServerV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlServerV2Update": { + "type": "object", + "description": "The type used for update operations of the SqlServerV2.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerV2UpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "SqlServerV2UpdateProperties": { + "type": "object", + "description": "The updatable properties of the SqlServerV2.", + "properties": { + "numberOfAgDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of databases part of availability group on this SQL instance." + }, + "sqlFciProperties": { + "$ref": "#/definitions/SqlFciProperties", + "description": "Gets or sets the FCI properties if the instance is an FCI instance. This would be populated if IsClustered is true." + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "version": { + "type": "string", + "description": "Gets or sets the SQL server version." + }, + "numberOfUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets or sets total number of users databases." + }, + "sumOfUserDatabasesSizeInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets total size of all user databases." + }, + "tempDbSizeInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets size of temp database." + }, + "maxServerMemoryInUseInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets maximum server memory in use." + }, + "visibleOnlineCoreCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the SQL server number of cores that have visible online status." + }, + "numOfLogins": { + "type": "integer", + "format": "int32", + "description": "Gets or sets number of logins." + }, + "physicalCpuCount": { + "type": "number", + "format": "float", + "description": "Gets or sets physical CPU count." + }, + "logicalCpuCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets logical CPU count." + }, + "engineEdition": { + "type": "string", + "description": "Gets or sets the SQL server engine edition." + }, + "edition": { + "type": "string", + "description": "Gets or sets the SQL server edition." + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether High Availability is enabled or not." + }, + "isClustered": { + "type": "boolean", + "description": "Gets or sets a value indicating whether failover cluster is configured or not." + }, + "hyperthreadRatio": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Hyper thread ratio." + }, + "sqlStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the SQL start time." + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the SQL server." + }, + "hydratedRunAsAccountId": { + "type": "string", + "description": "Gets or sets the hydrated run as account ID of the SQL server." + }, + "hostName": { + "type": "string", + "description": "Gets or sets hostname." + }, + "sqlServerName": { + "type": "string", + "description": "Gets or sets the SQL server instance name." + }, + "portNumber": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Preferred Port Number." + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the resource.", + "additionalProperties": { + "$ref": "#/definitions/Azure.ResourceManager.Object" + } + }, + "isDeleted": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the entity is deleted." + }, + "createdTimestamp": { + "type": "string", + "description": "Gets or sets the marking machine creation." + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets or sets the timestamp marking last updated on the machine." + }, + "status": { + "$ref": "#/definitions/SqlServerStatus", + "description": "Gets or sets the powered on status." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "SqlSite": { + "type": "object", + "description": "SQL site web model.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlSiteProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlSiteListResult": { + "type": "object", + "description": "The response of a SqlSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlSite items on this page", + "items": { + "$ref": "#/definitions/SqlSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlSiteProperties": { + "type": "object", + "description": "Class for SQL site properties.", + "properties": { + "siteAppliancePropertiesCollection": { + "type": "array", + "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", + "items": { + "$ref": "#/definitions/SiteApplianceProperties" + }, + "x-ms-identifiers": [] + }, + "discoveryScenario": { + "$ref": "#/definitions/SqlSitePropertiesDiscoveryScenario", + "description": "Gets or sets the discovery scenario." + }, + "serviceEndpoint": { + "type": "string", + "description": "Gets the service endpoint.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "SqlSitePropertiesDiscoveryScenario": { + "type": "string", + "description": "SqlSiteProperties DiscoveryScenario", + "enum": [ + "Migrate", + "DR" + ], + "x-ms-enum": { + "name": "SqlSitePropertiesDiscoveryScenario", + "modelAsString": true, + "values": [ + { + "name": "Migrate", + "value": "Migrate", + "description": "Migrate value." + }, + { + "name": "DR", + "value": "DR", + "description": "DR value." + } + ] + } + }, + "SqlSiteRefreshBody": { + "type": "object", + "description": "SQL site refresh.", + "properties": { + "applianceName": { + "type": "string", + "description": "Gets or sets the appliance name of the agent in the site." + } + } + }, + "SqlSiteUpdate": { + "type": "object", + "description": "The type used for update operations of the SqlSite.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlSiteUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "SqlSiteUpdateProperties": { + "type": "object", + "description": "The updatable properties of the SqlSite.", + "properties": { + "siteAppliancePropertiesCollection": { + "type": "array", + "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", + "items": { + "$ref": "#/definitions/SiteApplianceProperties" + }, + "x-ms-identifiers": [] + }, + "discoveryScenario": { + "$ref": "#/definitions/SqlSitePropertiesDiscoveryScenario", + "description": "Gets or sets the discovery scenario." + } + } + }, + "SqlSiteUsage": { + "type": "object", + "description": "SQL site usage.", + "properties": { + "serverCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of servers discovered in the site." + }, + "databaseCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of databases discovered in the site." + }, + "runAsAccountCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of run as accounts in the site." + } + } + }, + "StaticDiscovery": { + "type": "object", + "description": "Contains data related static data discovery scope.", + "properties": { + "discoveryScopeStatus": { + "$ref": "#/definitions/StaticDiscoveryScopeStatus", + "description": "Gets discovery scope status.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets errors for discovery scope.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "hydratedRunAsAccountId": { + "type": "string", + "description": "Gets the run as account ID with which feature worked successfully.\n \nIt is discovered by the agent from the list of credentials.", + "readOnly": true + } + } + }, + "StaticDiscoveryScopeStatus": { + "type": "string", + "description": "Static DiscoveryScopeStatus", + "enum": [ + "DiscoverySucceededAtleastOnce", + "DiscoveryFailed", + "RunAsAccountNotAssociated", + "DiscoveryNotStarted", + "DiscoveryInProgress", + "Disabled", + "DiscoveryPartiallySucceded", + "DiscoverySucceeded" + ], + "x-ms-enum": { + "name": "StaticDiscoveryScopeStatus", + "modelAsString": true, + "values": [ + { + "name": "DiscoverySucceededAtleastOnce", + "value": "DiscoverySucceededAtleastOnce", + "description": "DiscoverySucceededAtleastOnce value." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "DiscoveryFailed value." + }, + { + "name": "RunAsAccountNotAssociated", + "value": "RunAsAccountNotAssociated", + "description": "RunAsAccountNotAssociated value." + }, + { + "name": "DiscoveryNotStarted", + "value": "DiscoveryNotStarted", + "description": "DiscoveryNotStarted value." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "DiscoveryInProgress value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + }, + { + "name": "DiscoveryPartiallySucceded", + "value": "DiscoveryPartiallySucceded", + "description": "DiscoveryPartiallySucceded value." + }, + { + "name": "DiscoverySucceeded", + "value": "DiscoverySucceeded", + "description": "DiscoverySucceeded value." + } + ] + } + }, + "SystemCenter": { + "type": "object", + "description": "SystemCenter in the guest virtual machine.", + "properties": { + "productName": { + "type": "string", + "description": "Gets or sets ProductName of the SystemCenter.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets or sets Status of the SystemCenter.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the SystemCenter.", + "readOnly": true + } + } + }, + "TagsMachineInput": { + "type": "object", + "description": "Machine class.", + "properties": { + "machineId": { + "type": "string", + "description": "Gets or sets the ARM id of the machine." + }, + "tags": { + "type": "object", + "description": "run as AccountId", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TomcatEngineUnit": { + "type": "object", + "description": "Tomcat engine data.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the engine." + }, + "hosts": { + "type": "array", + "description": "Gets or sets the hosts defined for the engine.", + "items": { + "$ref": "#/definitions/TomcatHostUnit" + }, + "x-ms-identifiers": [] + } + } + }, + "TomcatHostUnit": { + "type": "object", + "description": "Tomcat host data.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the host." + }, + "appBasePath": { + "type": "string", + "description": "Gets or sets the app base path for the host." + }, + "appBase": { + "type": "string", + "description": "Gets or sets the app base value configured for the host." + } + } + }, + "TomcatServiceUnit": { + "type": "object", + "description": "Tomcat service data.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the service." + }, + "connectors": { + "type": "array", + "description": "Gets or sets the connectors defined for the service component.", + "items": { + "$ref": "#/definitions/ConnectorUnit" + }, + "x-ms-identifiers": [] + }, + "engine": { + "$ref": "#/definitions/TomcatEngineUnit", + "description": "Gets or sets the engine defined for the service component." + } + } + }, + "TomcatWebApplicationProperties": { + "type": "object", + "description": "Class for web application properties.", + "properties": { + "hasDatabaseDependency": { + "type": "boolean", + "description": "Boolean value having true if the application has database dependency.", + "readOnly": true + }, + "isExternalLoggingConfigured": { + "type": "boolean", + "description": "Boolean value having true if the application has file dependency.", + "readOnly": true + }, + "webServerId": { + "type": "string", + "description": "Gets the web server id.", + "readOnly": true + }, + "webServerName": { + "type": "string", + "description": "Gets the web server name.", + "readOnly": true + }, + "machineArmIds": { + "type": "array", + "description": "Gets the list of machine ARM Ids on which the web application is deployed.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "virtualPath": { + "type": "string", + "description": "Gets the virtual path of the application.", + "readOnly": true + }, + "physicalPath": { + "type": "string", + "description": "Gets the physical path of the application.", + "readOnly": true + }, + "bindings": { + "type": "array", + "description": "Gets the front end bindings for the application.", + "items": { + "$ref": "#/definitions/FrontEndBinding" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "frameworks": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/WebApplicationFramework" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "configurations": { + "type": "array", + "description": "Gets the configuration.", + "items": { + "$ref": "#/definitions/WebApplicationConfigurationUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "directories": { + "type": "array", + "description": "Gets the directories.", + "items": { + "$ref": "#/definitions/WebApplicationDirectoryUnit" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets tags that can be used with ODATA.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "staticFolders": { + "type": "array", + "description": "Static folders.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Machine display name", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Gets the server type.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hasErrors": { + "type": "boolean", + "description": "Gets a value indicating whether the WebApp has errors or not.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "TomcatWebApplications": { + "type": "object", + "description": "Web application REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/TomcatWebApplicationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "TomcatWebApplicationsListResult": { + "type": "object", + "description": "The response of a TomcatWebApplications list operation.", + "properties": { + "value": { + "type": "array", + "description": "The TomcatWebApplications items on this page", + "items": { + "$ref": "#/definitions/TomcatWebApplications" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "TomcatWebApplicationsUpdate": { + "type": "object", + "description": "The type used for update operations of the TomcatWebApplications." + }, + "TomcatWebServerProperties": { + "type": "object", + "description": "Class for web server properties.", + "properties": { + "services": { + "type": "array", + "description": "Gets or sets the services defined in the server.", + "items": { + "$ref": "#/definitions/TomcatServiceUnit" + }, + "x-ms-identifiers": [] + }, + "catalinaHome": { + "type": "string", + "description": "Catalina Home", + "readOnly": true + }, + "jvmVersion": { + "type": "string", + "description": "Version of the JVM", + "readOnly": true + }, + "sessionPersistenceMechanism": { + "type": "string", + "description": "session persistence mechanism", + "readOnly": true + }, + "isClusteringPresent": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted." + }, + "isMemoryRealmPresent": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "isSessionTrackingPresent": { + "type": "boolean", + "description": "is session tracking present", + "readOnly": true + }, + "isAccessLogValvePresent": { + "type": "boolean", + "description": "is access log valve present", + "readOnly": true + }, + "maxMemoryUsageInMb": { + "type": "string", + "description": "max memory usage in mb", + "readOnly": true + }, + "configurationLocation": { + "type": "string", + "description": "Gets the configuration location.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets the configuration location.", + "readOnly": true + }, + "machineIds": { + "type": "array", + "description": "Gets the list of machines.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "webApplications": { + "type": "array", + "description": "Gets the list of web applications.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name.", + "readOnly": true + }, + "serverFqdn": { + "type": "string", + "description": "Gets the server FQDN.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the run as account id.", + "readOnly": true + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Gets the server type.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hasErrors": { + "type": "boolean", + "description": "Gets a value indicating whether the WebApp has errors or not.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "TomcatWebServers": { + "type": "object", + "description": "Web server REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/TomcatWebServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "TomcatWebServersListResult": { + "type": "object", + "description": "The response of a TomcatWebServers list operation.", + "properties": { + "value": { + "type": "array", + "description": "The TomcatWebServers items on this page", + "items": { + "$ref": "#/definitions/TomcatWebServers" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "UpdateMachineDepMapStatus": { + "type": "object", + "description": "Defines class that represents input to enable or disable DMP on machine\n \n for cosmos entity operation.", + "properties": { + "machines": { + "type": "array", + "description": "Gets or sets the machine collection.", + "items": { + "$ref": "#/definitions/DependencyMapMachineInput" + }, + "x-ms-identifiers": [] + } + } + }, + "UpdateMachineRunAsAccount": { + "type": "object", + "description": "Defines class that represents input to update RunAsAccount on machine\n \n for cosmos entity operation.", + "properties": { + "machines": { + "type": "array", + "description": "Gets or sets the machine collection.", + "items": { + "$ref": "#/definitions/RunAsAccountMachineInput" + }, + "x-ms-identifiers": [] + } + } + }, + "UpdateMachineTags": { + "type": "object", + "description": "Defines class that represents input to update Tags on machine\n \n for cosmos entity operation.", + "properties": { + "machines": { + "type": "array", + "description": "Gets or sets the machine collection.", + "items": { + "$ref": "#/definitions/TagsMachineInput" + }, + "x-ms-identifiers": [] + } + } + }, + "V20180501PreviewVmwareRunAsAccount": { + "type": "object", + "description": "Run as account REST Resource.", + "properties": { + "id": { + "type": "string", + "description": "Relative URL to get this run as account.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Gets the Name of the Run as account.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Handled by resource provider. Type =\nMicrosoft.OffAzure/VMWareSites/RunAsAccounts.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/RunAsAccountProperties", + "description": "Gets nested properties.", + "readOnly": true + } + } + }, + "V20180501PreviewVmwareRunAsAccountVmwareRunAsAccountCollection": { + "type": "object", + "description": "Collection of VMware run as accounts.", + "properties": { + "value": { + "type": "array", + "description": "Gets the list of run as accounts.", + "items": { + "$ref": "#/definitions/V20180501PreviewVmwareRunAsAccount" + } + }, + "nextLink": { + "type": "string", + "description": "Gets the value of next link.", + "readOnly": true + } + } + }, + "VMwareDatastoreType": { + "type": "string", + "description": "vmware datastore type", + "enum": [ + "Unknown", + "CIFS", + "NFS", + "NFS41", + "PMEM", + "VFFS", + "VMFS", + "VSAN", + "VVOL" + ], + "x-ms-enum": { + "name": "VMwareDatastoreType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Cifs", + "value": "CIFS", + "description": "CIFS value." + }, + { + "name": "NFS", + "value": "NFS", + "description": "NFS value." + }, + { + "name": "NFS41", + "value": "NFS41", + "description": "NFS41 value." + }, + { + "name": "Pmem", + "value": "PMEM", + "description": "PMEM value." + }, + { + "name": "Vffs", + "value": "VFFS", + "description": "VFFS value." + }, + { + "name": "Vmfs", + "value": "VMFS", + "description": "VMFS value." + }, + { + "name": "Vsan", + "value": "VSAN", + "description": "VSAN value." + }, + { + "name": "Vvol", + "value": "VVOL", + "description": "VVOL value." + } + ] + } + }, + "Vcenter": { + "type": "object", + "description": "A vcenter resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/VcenterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VcenterListResult": { + "type": "object", + "description": "The response of a Vcenter list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Vcenter items on this page", + "items": { + "$ref": "#/definitions/Vcenter" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VcenterProperties": { + "type": "object", + "description": "The properties of VMwareSiteResource", + "properties": { + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the vCenter." + }, + "errors": { + "type": "array", + "description": "Gets the errors.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking vCenter creation.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the vCenter.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN/IPAddress of the vCenter." + }, + "port": { + "type": "string", + "description": "Gets or sets the port of the vCenter." + }, + "version": { + "type": "string", + "description": "Gets the version of the vCenter.", + "readOnly": true + }, + "perfStatisticsLevel": { + "type": "string", + "description": "Gets the performance statistics enabled on the vCenter.", + "readOnly": true + }, + "instanceUuid": { + "type": "string", + "description": "Gets the instance UUID of the vCenter.", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Gets or sets the friendly name of the vCenter." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "Versions": { + "type": "string", + "description": "service api versions", + "enum": [ + "2018-05-01-preview", + "2019-05-01-preview", + "2020-01-01", + "2020-01-01-preview", + "2020-02-01", + "2020-07-07", + "2020-07-10", + "2020-08-01-preview", + "2020-11-11-preview", + "2022-10-27", + "2023-06-06", + "2023-10-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2018_05_01_preview", + "value": "2018-05-01-preview", + "description": "Api version 2018-05-01-preview." + }, + { + "name": "v2019_05_01_preview", + "value": "2019-05-01-preview", + "description": "Api version 2019-05-01-preview." + }, + { + "name": "v2020_01_01", + "value": "2020-01-01", + "description": "Api version 2020-01-01." + }, + { + "name": "v2020_01_01_preview", + "value": "2020-01-01-preview", + "description": "Api version 2020-01-01-preview." + }, + { + "name": "v2020_02_01", + "value": "2020-02-01", + "description": "Api version 2020-02-01." + }, + { + "name": "v2020_07_07", + "value": "2020-07-07", + "description": "Api version 2020-07-07." + }, + { + "name": "v2020_07_10", + "value": "2020-07-10", + "description": "Api version 2020-07-10." + }, + { + "name": "v2020_08_01_preview", + "value": "2020-08-01-preview", + "description": "Api version 2020-08-01-preview." + }, + { + "name": "v2020_11_11_preview", + "value": "2020-11-11-preview", + "description": "Api version 2020-11-11-preview." + }, + { + "name": "v2022_10_27", + "value": "2022-10-27", + "description": "Api version 2022-10-27." + }, + { + "name": "v2023_06_06", + "value": "2023-06-06", + "description": "Api version 2023-06-06." + }, + { + "name": "v2023_10_01_preview", + "value": "2023-10-01-preview", + "description": "Api version 2023-10-01-preview." + } + ] + } + }, + "VmwareDatastore": { + "type": "object", + "description": "Second level object returned as part of VMware host REST resource.", + "properties": { + "uuid": { + "type": "string", + "description": "Data store UUID.", + "readOnly": true + }, + "capacityInGb": { + "type": "number", + "format": "float", + "description": "Capacity of the data store.", + "readOnly": true + }, + "freeSpaceInGb": { + "type": "number", + "format": "float", + "description": "Free space of the data store.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/VMwareDatastoreType", + "description": "Type of the data store.", + "readOnly": true + }, + "symbolicName": { + "type": "string", + "description": "Symbolic name of the data store.", + "readOnly": true + } + } + }, + "VmwareDisk": { + "type": "object", + "description": "Second level object returned as part of Machine REST resource.", + "properties": { + "uuid": { + "type": "string", + "description": "Disk UUID.", + "readOnly": true + }, + "label": { + "type": "string", + "description": "Label of the disk.", + "readOnly": true + }, + "diskProvisioningPolicy": { + "type": "string", + "description": "The provisioning policy of the disk.\n It is Thin or Thick or\nUnknown for the VMWare VMDK.", + "readOnly": true + }, + "diskScrubbingPolicy": { + "type": "string", + "description": "The scrubbing policy of disks which can be\n eagerly zeroed or\nlazily zeroed.", + "readOnly": true + }, + "diskMode": { + "type": "string", + "description": "Disk mode property used for identifying independent disks.", + "readOnly": true + }, + "controllerType": { + "type": "string", + "description": "Gets or sets a value indicating the type of the disk controller type.", + "readOnly": true + }, + "maxSizeInBytes": { + "type": "integer", + "format": "int64", + "description": "Gets or sets Bytes allocated for the disk." + }, + "name": { + "type": "string", + "description": "Gets or sets Name of the disk." + }, + "diskType": { + "type": "string", + "description": "Gets or sets Type of the disk." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Gets or sets LUN of the disk." + }, + "path": { + "type": "string", + "description": "Gets or sets Path of the disk." + } + } + }, + "VmwareHost": { + "type": "object", + "description": "A host resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/VmwareHostProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VmwareHostListResult": { + "type": "object", + "description": "The response of a VmwareHost list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareHost items on this page", + "items": { + "$ref": "#/definitions/VmwareHost" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VmwareHostProperties": { + "type": "object", + "description": "Class for host properties.", + "properties": { + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking VMware host creation.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the VMware host.", + "readOnly": true + }, + "datastores": { + "type": "array", + "description": "Gets the data stores.", + "items": { + "$ref": "#/definitions/VmwareDatastore" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "vcenterId": { + "type": "string", + "description": "Gets the V-center ID.", + "readOnly": true + }, + "uuid": { + "type": "string", + "description": "Gets the instance UUID of the vmware host.", + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "VmwareJob": { + "type": "object", + "description": "A host resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VmwareJobListResult": { + "type": "object", + "description": "The response of a VmwareJob list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareJob items on this page", + "items": { + "$ref": "#/definitions/VmwareJob" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VmwareMachineProperties": { + "type": "object", + "description": "Class for machine properties.", + "properties": { + "vCenterFqdn": { + "type": "string", + "description": "VCenter FQDN/IPAddress.", + "readOnly": true + }, + "vCenterId": { + "type": "string", + "description": "VCenter ARM ID.", + "readOnly": true + }, + "instanceUuid": { + "type": "string", + "description": "On-premise Instance UUID of the machine.", + "readOnly": true + }, + "dataCenterScope": { + "type": "string", + "description": "Scope of the data center.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "User description of the machine.", + "readOnly": true + }, + "disks": { + "type": "array", + "description": "Disks attached to the machine.", + "items": { + "$ref": "#/definitions/VmwareDisk" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "hostInMaintenanceMode": { + "type": "boolean", + "description": "Indicates whether the host is in maintenance mode.", + "readOnly": true + }, + "hostName": { + "type": "string", + "description": "The host name.", + "readOnly": true + }, + "hostPowerState": { + "type": "string", + "description": "The host power state.", + "readOnly": true + }, + "hostVersion": { + "type": "string", + "description": "The host version.", + "readOnly": true + }, + "networkAdapters": { + "type": "array", + "description": "Network adapters attached to the machine.", + "items": { + "$ref": "#/definitions/VmwareNetworkAdapter" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "vMwareToolsStatus": { + "type": "string", + "description": "VMware tools status.", + "readOnly": true + }, + "vMwareToolsVersion": { + "type": "string", + "description": "VMware tools version.", + "readOnly": true + }, + "changeTrackingSupported": { + "type": "boolean", + "description": "Value indicating whether change tracking is supported.", + "readOnly": true + }, + "changeTrackingEnabled": { + "type": "boolean", + "description": "Value indicating whether change tracking is enabled.", + "readOnly": true + }, + "maxSnapshots": { + "type": "integer", + "format": "int32", + "description": "Maximum number of snapshots for the VM. Default value is -1.", + "readOnly": true + }, + "diskEnabledUuid": { + "type": "string", + "description": "Gets or sets whether Disk Enabled UUID is set or not.", + "readOnly": true + }, + "numberOfSnapshots": { + "type": "integer", + "format": "int32", + "description": "Number of snapshots for the VM. Default value is -1.", + "readOnly": true + }, + "altGuestName": { + "type": "string", + "description": "Gets or sets the machine alt guest name.", + "readOnly": true + }, + "powerStatus": { + "type": "string", + "description": "Gets the Machine power status.", + "readOnly": true + }, + "vmFqdn": { + "type": "string", + "description": "Gets the VM FQDN.", + "readOnly": true + }, + "vmConfigurationFileLocation": { + "type": "string", + "description": "Gets the Root location of the VM configuration file.", + "readOnly": true + }, + "firmware": { + "type": "string", + "description": "Gets or sets the firmware." + }, + "guestOsDetails": { + "$ref": "#/definitions/GuestOsDetails", + "description": "Operating System Details extracted from the guest\n bu executing\nscript inside the guest VM.", + "readOnly": true + }, + "numberOfApplications": { + "type": "integer", + "format": "int32", + "description": "Number of applications installed in the guest VM.", + "readOnly": true + }, + "guestDetailsDiscoveryTimestamp": { + "type": "string", + "format": "date-time", + "description": "The last time at which the Guest Details was discovered\n or the\nerror while discovering guest details based discovery\n of the\nmachine.", + "readOnly": true + }, + "isGuestDetailsDiscoveryInProgress": { + "type": "boolean", + "description": "Whether Refresh Fabric Layout Guest Details has been completed once.\n \n Portal will show discovery in progress, if this value is true.", + "readOnly": true + }, + "dependencyMapping": { + "type": "string", + "description": "Gets or sets if dependency mapping feature is enabled or not\n for\nthe VM.", + "readOnly": true + }, + "dependencyMappingStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets when dependency mapping collection is last started.", + "readOnly": true + }, + "dependencyMappingEndTime": { + "type": "string", + "description": "Gets or sets when dependency mapping collection was last disabled.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the machine." + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Errors for machine.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applicationDiscovery": { + "$ref": "#/definitions/ApplicationDiscovery", + "description": "Gets the data related to application discovery.", + "readOnly": true + }, + "dependencyMapDiscovery": { + "$ref": "#/definitions/DependencyMapDiscovery", + "description": "Gets the data related to dependency map discovery.", + "readOnly": true + }, + "staticDiscovery": { + "$ref": "#/definitions/StaticDiscovery", + "description": "Gets the data related to static discovery.", + "readOnly": true + }, + "sqlDiscovery": { + "$ref": "#/definitions/SqlDiscovery", + "description": "Gets the data related to SQL discovery.", + "readOnly": true + }, + "webAppDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to Web application discovery.", + "readOnly": true + }, + "oracleDiscovery": { + "$ref": "#/definitions/OracleDiscovery", + "description": "Gets the data related to Oracle discovery.", + "readOnly": true + }, + "springBootDiscovery": { + "$ref": "#/definitions/SpringBootDiscovery", + "description": "Gets the data related to SpringBoot discovery.", + "readOnly": true + }, + "iisDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to iis discovery.", + "readOnly": true + }, + "tomcatDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to tomcat discovery.", + "readOnly": true + }, + "appsAndRoles": { + "$ref": "#/definitions/AppsAndRoles", + "description": "Apps And Roles of the Server.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "double", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "displayName": { + "type": "string", + "description": "Gets the Display name of the machine.", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Value indicating whether VM is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the marking machine creation.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the VMware machine.", + "additionalProperties": { + "type": "string" + } + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the machine.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "VmwareMachineSoftwareInventory": { + "type": "object", + "description": "An software inventory resource belonging to a machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineSoftwareInventoryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VmwareMachineSoftwareInventoryListResult": { + "type": "object", + "description": "The response of a VmwareMachineSoftwareInventory list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareMachineSoftwareInventory items on this page", + "items": { + "$ref": "#/definitions/VmwareMachineSoftwareInventory" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VmwareNetworkAdapter": { + "type": "object", + "description": "Second level object represented in responses as part of Machine REST resource.", + "properties": { + "label": { + "type": "string", + "description": "Label of the NIC.", + "readOnly": true + }, + "adapterType": { + "type": "string", + "description": "Gets or sets the adapter type.", + "readOnly": true + }, + "nicId": { + "type": "string", + "description": "Gets or sets the NIC Id." + }, + "macAddress": { + "type": "string", + "description": "Gets or sets Mac address of the NIC." + }, + "ipAddressList": { + "type": "array", + "description": "Gets IP addresses for the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "networkName": { + "type": "string", + "description": "Gets or sets Network Name." + }, + "ipAddressType": { + "type": "string", + "description": "Gets or sets Type of the IP address." + } + } + }, + "VmwareRunAsAccountResource": { + "type": "object", + "description": "A runasaccount resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RunAsAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VmwareRunAsAccountResourceListResult": { + "type": "object", + "description": "The response of a VmwareRunAsAccountResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareRunAsAccountResource items on this page", + "items": { + "$ref": "#/definitions/VmwareRunAsAccountResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VmwareSite": { + "type": "object", + "description": "A VmwareSite", + "properties": { + "properties": { + "$ref": "#/definitions/SitesProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "VmwareSiteListResult": { + "type": "object", + "description": "The response of a VmwareSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareSite items on this page", + "items": { + "$ref": "#/definitions/VmwareSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VmwareSiteUpdate": { + "type": "object", + "description": "The type used for update operations of the VmwareSite.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/VmwareSiteUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "VmwareSiteUpdateProperties": { + "type": "object", + "description": "The updatable properties of the VmwareSite.", + "properties": { + "servicePrincipalIdentityDetails": { + "$ref": "#/definitions/SiteSpnProperties", + "description": "Gets or sets the service principal identity details used by agent for\ncommunication\n to the service." + }, + "agentDetails": { + "$ref": "#/definitions/SiteAgentProperties", + "description": "Gets or sets the on-premises agent details." + }, + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + }, + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "VmwareSiteUsage": { + "type": "object", + "description": "VMware site usage.", + "properties": { + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of machines discovered in the site." + }, + "runAsAccountCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of run as accounts in the site." + }, + "vCenterCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of vCenters part of the site." + } + } + }, + "WebAppDiscovery": { + "type": "object", + "description": "Data related to a machine's WebApps discovery.", + "properties": { + "totalWebServerCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets number of successfully discovered web servers.." + }, + "totalWebApplicationCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets number of successfully discovered web applications." + }, + "discoveryScopeStatus": { + "$ref": "#/definitions/DiscoveryScopeStatus", + "description": "Gets or sets status of partner discovery." + } + } + }, + "WebAppExtendedMachine": { + "type": "object", + "description": "Web app extended machine REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppExtendedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppExtendedMachineListResult": { + "type": "object", + "description": "The response of a WebAppExtendedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppExtendedMachine items on this page", + "items": { + "$ref": "#/definitions/WebAppExtendedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppExtendedMachineProperties": { + "type": "object", + "description": "Class for web extended machine properties.", + "properties": { + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "hostName": { + "type": "string", + "description": "Gets the hydrated host name.", + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Gets the Name of the extended machine.", + "readOnly": true + }, + "machineId": { + "type": "string", + "description": "Gets the machine ARM id.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the run as account ID of the machine used for web app discovery.", + "readOnly": true + }, + "hydratedRunAsAccountId": { + "type": "string", + "description": "Gets the agent hydrated run as account.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "WebAppProperties": { + "type": "object", + "description": "Class representing web app properties web model.", + "properties": { + "webAppArmId": { + "type": "string", + "description": "Gets or sets the arm id of the web app." + }, + "tags": { + "type": "object", + "description": "Gets or sets Tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WebAppPropertiesCollection": { + "type": "object", + "description": "Collection of web app properties.", + "properties": { + "webApps": { + "type": "array", + "description": "Gets or sets the list of web app properties.", + "items": { + "$ref": "#/definitions/WebAppProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "WebAppRunAsAccount": { + "type": "object", + "description": "Run as account REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RunAsAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppRunAsAccountListResult": { + "type": "object", + "description": "The response of a WebAppRunAsAccount list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppRunAsAccount items on this page", + "items": { + "$ref": "#/definitions/WebAppRunAsAccount" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppSite": { + "type": "object", + "description": "WebApp site web model.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppSiteProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppSiteListResult": { + "type": "object", + "description": "The response of a WebAppSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppSite items on this page", + "items": { + "$ref": "#/definitions/WebAppSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppSiteProperties": { + "type": "object", + "description": "Class for Web app site properties.", + "properties": { + "siteAppliancePropertiesCollection": { + "type": "array", + "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", + "items": { + "$ref": "#/definitions/SiteApplianceProperties" + }, + "x-ms-identifiers": [] + }, + "discoveryScenario": { + "$ref": "#/definitions/WebAppSitePropertiesDiscoveryScenario", + "description": "Gets or sets the discovery scenario." + }, + "serviceEndpoint": { + "type": "string", + "description": "Gets the service endpoint.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "WebAppSitePropertiesDiscoveryScenario": { + "type": "string", + "description": "Discovery Scenario", + "enum": [ + "Migrate", + "DR" + ], + "x-ms-enum": { + "name": "WebAppSitePropertiesDiscoveryScenario", + "modelAsString": true, + "values": [ + { + "name": "Migrate", + "value": "Migrate", + "description": "Migrate value." + }, + { + "name": "DR", + "value": "DR", + "description": "DR value." + } + ] + } + }, + "WebAppSiteUpdate": { + "type": "object", + "description": "The type used for update operations of the WebAppSite.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppSiteUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "WebAppSiteUpdateProperties": { + "type": "object", + "description": "The updatable properties of the WebAppSite.", + "properties": { + "siteAppliancePropertiesCollection": { + "type": "array", + "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", + "items": { + "$ref": "#/definitions/SiteApplianceProperties" + }, + "x-ms-identifiers": [] + }, + "discoveryScenario": { + "$ref": "#/definitions/WebAppSitePropertiesDiscoveryScenario", + "description": "Gets or sets the discovery scenario." + } + } + }, + "WebAppSiteUsage": { + "type": "object", + "description": "Web app site usage.", + "properties": { + "webServerCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of web servers discovered in the site." + }, + "webApplicationCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of web applications discovered in the site." + }, + "runAsAccountCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of run as accounts in the site." + } + } + }, + "WebApplication": { + "type": "object", + "description": "Web application REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebApplicationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "WebApplicationAppsAndRolesModel": { + "type": "object", + "description": "WebApplication in the guest virtual machine.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets Name of the WebApplication.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets or sets Status of the WebApplication.", + "readOnly": true + }, + "platform": { + "type": "string", + "description": "Gets or sets Platform of the WebApplication.", + "readOnly": true + }, + "groupName": { + "type": "string", + "description": "Gets or sets GroupName of the WebApplication.", + "readOnly": true + }, + "webServer": { + "type": "string", + "description": "Gets or sets WebServer of the WebApplication.", + "readOnly": true + }, + "applicationPool": { + "type": "string", + "description": "Gets or sets ApplicationPool of the WebApplication.", + "readOnly": true + } + } + }, + "WebApplicationConfigurationUnit": { + "type": "object", + "description": "Web Application configuration unit.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the configuration name." + }, + "filePath": { + "type": "string", + "description": "Gets or sets the configuration file path." + }, + "localFilePath": { + "type": "string", + "description": "Gets or sets the configuration local file path." + }, + "targetFilePath": { + "type": "string", + "description": "Gets or sets the configuration target file path." + }, + "section": { + "type": "string", + "description": "Gets or sets the configuration section in the file." + }, + "type": { + "type": "string", + "description": "Gets or sets the configuration type." + }, + "isDeploymentTimeEditable": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the configuration is edited or not by\nthe user." + }, + "identifier": { + "type": "string", + "description": "Gets or sets the identifier for the configuration." + } + } + }, + "WebApplicationDirectoryUnit": { + "type": "object", + "description": "Web Application directory unit.", + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the unique id corresponding to the application directory." + }, + "isEditable": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the directory object is editable.\n \n True when the directory is added as an optional directory, false when\ndiscovery is done\n manually." + }, + "sourcePaths": { + "type": "array", + "description": "Gets or sets the paths of the directory on the source machine.", + "items": { + "type": "string" + } + }, + "localScratchPath": { + "type": "string", + "description": "Gets or sets the local scratch path at which the directories has been copied." + }, + "mountPath": { + "type": "string", + "description": "Gets or sets the mount path of the application directory." + }, + "sourceSize": { + "type": "string", + "description": "Gets or sets the size of the directory on the source machine." + } + } + }, + "WebApplicationFramework": { + "type": "object", + "description": "Framework specific data for a web application.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets Name of the framework." + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the framework." + } + } + }, + "WebApplicationListResult": { + "type": "object", + "description": "The response of a WebApplication list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebApplication items on this page", + "items": { + "$ref": "#/definitions/WebApplication" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebApplicationProperties": { + "type": "object", + "description": "Class for web application properties.", + "properties": { + "webServerId": { + "type": "string", + "description": "Gets the web server id.", + "readOnly": true + }, + "webServerName": { + "type": "string", + "description": "Gets the web server name.", + "readOnly": true + }, + "machineArmIds": { + "type": "array", + "description": "Gets the list of machine ARM Ids on which the SQL server is deployed.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "virtualPath": { + "type": "string", + "description": "Gets the virtual path of the application.", + "readOnly": true + }, + "physicalPath": { + "type": "string", + "description": "Gets the physical path of the application.", + "readOnly": true + }, + "bindings": { + "type": "array", + "description": "Gets the front end bindings for the application.", + "items": { + "$ref": "#/definitions/FrontEndBinding" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "frameworks": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/WebApplicationFramework" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "configurations": { + "type": "array", + "description": "Gets the configuration.", + "items": { + "$ref": "#/definitions/WebApplicationConfigurationUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "directories": { + "type": "array", + "description": "Gets the directories.", + "items": { + "$ref": "#/definitions/WebApplicationDirectoryUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "displayName": { + "type": "string", + "description": "Gets the display name.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets tags that can be used with ODATA.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "staticFolders": { + "type": "array", + "description": "Static folders.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Machine display name", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Gets the server type.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hasErrors": { + "type": "boolean", + "description": "Gets a value indicating whether the WebApp has errors or not.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "WebRoleImportDisk": { + "type": "object", + "description": "Class representing the imported machine web model.", + "properties": { + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Disk read throughput.", + "readOnly": true + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Disk write throughput.", + "readOnly": true + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Disk read IOPS.", + "readOnly": true + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Disk write IOPS.", + "readOnly": true + }, + "maxSizeInBytes": { + "type": "integer", + "format": "int64", + "description": "Gets or sets Bytes allocated for the disk." + }, + "name": { + "type": "string", + "description": "Gets or sets Name of the disk." + }, + "diskType": { + "type": "string", + "description": "Gets or sets Type of the disk." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Gets or sets LUN of the disk." + }, + "path": { + "type": "string", + "description": "Gets or sets Path of the disk." + } + } + }, + "WebRoleOperatingSystem": { + "type": "object", + "description": "Second level object returned as part of Machine REST resource.", + "properties": { + "osType": { + "type": "string", + "description": "Gets or sets the type of the operating system." + }, + "osName": { + "type": "string", + "description": "Gets or sets the Name of the operating system." + }, + "osVersion": { + "type": "string", + "description": "Gets or sets the Version of the operating system." + }, + "osArchitecture": { + "type": "string", + "description": "Gets or sets the Architecture of the operating system." + } + } + }, + "WebServer": { + "type": "object", + "description": "Web application REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "WebServerListResult": { + "type": "object", + "description": "The response of a WebServer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebServer items on this page", + "items": { + "$ref": "#/definitions/WebServer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebServerProperties": { + "type": "object", + "description": "Class for web server properties.", + "properties": { + "configurationLocation": { + "type": "string", + "description": "Gets the configuration location.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets the configuration location.", + "readOnly": true + }, + "machineIds": { + "type": "array", + "description": "Gets the list of machines.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "webApplications": { + "type": "array", + "description": "Gets the list of web applications.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name.", + "readOnly": true + }, + "serverFqdn": { + "type": "string", + "description": "Gets the server FQDN.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the run as account id.", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Gets the server type.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hasErrors": { + "type": "boolean", + "description": "Gets a value indicating whether the WebApp has errors or not.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "esuStatus": { + "type": "string", + "description": "esu Status", + "enum": [ + "Unknown", + "Active", + "InActive" + ], + "x-ms-enum": { + "name": "esuStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Active", + "value": "Active", + "description": "Active value." + }, + { + "name": "InActive", + "value": "InActive", + "description": "InActive value." + } + ] + } + }, + "esuYear": { + "type": "string", + "description": "esu year", + "enum": [ + "Unknown", + "FirstYear", + "SecondYear", + "ThirdYear", + "UpgradeYear" + ], + "x-ms-enum": { + "name": "esuYear", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "FirstYear", + "value": "FirstYear", + "description": "FirstYear value." + }, + { + "name": "SecondYear", + "value": "SecondYear", + "description": "SecondYear value." + }, + { + "name": "ThirdYear", + "value": "ThirdYear", + "description": "ThirdYear value." + }, + { + "name": "UpgradeYear", + "value": "UpgradeYear", + "description": "UpgradeYear value." + } + ] + } + }, + "supportStatus": { + "type": "string", + "description": "support status", + "enum": [ + "Unknown", + "Mainstream", + "Extended" + ], + "x-ms-enum": { + "name": "supportStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Mainstream", + "value": "Mainstream", + "description": "Mainstream value." + }, + { + "name": "Extended", + "value": "Extended", + "description": "Extended value." + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/migrate/resource-manager/readme.md b/specification/migrate/resource-manager/readme.md index 40fa098b30dd..975618cb5dd2 100644 --- a/specification/migrate/resource-manager/readme.md +++ b/specification/migrate/resource-manager/readme.md @@ -20,7 +20,26 @@ batch: - tag: package-migrateengine-2022-05 ``` +### Tag: package-migrate-2023-04 +These settings apply only when `--tag=package-migrate-2023-04` is specified on the command line. + +```yaml $(tag) == 'package-migrate-2023-04' +input-file: + - Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/migrate.json +suppressions: + - code: AvoidAdditionalProperties + reason: Migrate feature is widely adopted and requires additionalProperties for these swagger properties. +``` + +### Tag: package-preview-2023-10 + +These settings apply only when `--tag=package-preview-2023-10` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-10' +input-file: + - Microsoft.OffAzure/preview/2023-10-01-preview/migrate.json +``` ### Tag: package-2023-06 These settings apply only when `--tag=package-2023-06` is specified on the command line. @@ -39,6 +58,15 @@ input-file: - Microsoft.Migrate/AssessmentProjects/stable/2023-03-15/migrate.json ``` +### Tag: package-migrate-2023-04 + +These settings apply only when `--tag=package-migrate-2023-04` is specified on the command line. + +```yaml $(tag) == 'package-migrate-2023-04' +input-file: + - Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/migrate.json +``` + ### Tag: package-migrate-2018-02 and java These settings apply only when `--tag=package-migrate-2018-02 --java` is specified on the command line. @@ -163,7 +191,16 @@ These are the global settings for the API. ``` yaml openapi-type: arm -tag: package-migrate-2023-03 +tag: package-preview-2023-10 +``` + +### Tag: package-preview-2023-10 + +These settings apply only when `--tag=package-preview-2023-10` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-10' +input-file: + - Microsoft.OffAzure/preview/2023-10-01-preview/migrate.json ``` ### Tag: package-migrate-2023-03 @@ -175,6 +212,15 @@ input-file: - Microsoft.Migrate/AssessmentProjects/stable/2023-03-15/migrate.json ``` +### Tag: package-migrate-2023-04 + +These settings apply only when `--tag=package-migrate-2023-04` is specified on the command line. + +```yaml $(tag) == 'package-migrate-2023-04' +input-file: + - Microsoft.Migrate/AssessmentProjects/preview/2023-04-01-preview/migrate.json +``` + ### Tag: package-migrate-2018-02 These settings apply only when `--tag=package-migrate-2018-02` is specified on the command line. diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/amfdeployment.tsp b/specification/mobilepacketcore/MobilePacketCore.Management/amfdeployment.tsp new file mode 100644 index 000000000000..c94e6c85989e --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/amfdeployment.tsp @@ -0,0 +1,69 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/openapi"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using OpenAPI; + +namespace Microsoft.MobilePacketCore; + +@doc("Azure for Operators 5G Core Access and Mobility Function (AMF) Deployment Resource") +@resource("amfDeployments") +model AmfDeploymentResource + is TrackedResource { + @doc("The name of the AMF Deployment") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$") + @minLength(1) + @maxLength(63) + @key("amfDeploymentName") + @path + @segment("amfDeployments") + @visibility("create", "read") + name: string; +} + +@doc("AMF Deployment Properties.") +model AmfDeploymentResourceProperties { + @doc("The status of the last operation.") + @visibility("read") + provisioningState?: ProvisioningState; + + @doc("Azure for Operators 5G Core AMF component parameters") + componentParameters?: ComponentDeploymentParameters; + + @doc("Azure for Operators 5G Core AMF secrets parameters") + @secret + secretsParameters?: ComponentDeploymentSecrets; + + @doc("Reference to cluster where the Network Function is deployed") + @visibility("create", "read") + clusterService: ClusterServiceIdProperty; + + @doc("Release version. This is inherited from the cluster") + @visibility("read") + releaseVersion?: ReleaseVersion; + + @doc("Operational status") + @visibility("read") + operationalStatus?: OperationalStatus; +} + +@armResourceOperations(AmfDeploymentResource) +interface AmfDeployments { + get is ArmResourceRead; + createOrUpdate is ArmResourceCreateOrUpdate2Async; + updateTags is ArmTagsPatchSync; + delete is ArmResourceDeleteWithoutOkAsync; + @doc("List all Access and Mobility Function Deployments by Resource Group.") + listByResourceGroup is ArmResourceListByParent; + @doc("List all Access and Mobility Function Deployments by Subscription ID.") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/clusterservice.tsp b/specification/mobilepacketcore/MobilePacketCore.Management/clusterservice.tsp new file mode 100644 index 000000000000..5ecd170dd8fe --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/clusterservice.tsp @@ -0,0 +1,92 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/openapi"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using OpenAPI; + +namespace Microsoft.MobilePacketCore; + +@doc("Azure for Operators 5G Core Cluster Service Resource") +@resource("clusterServices") +model ClusterServiceResource + is TrackedResource { + @doc("The name of the Cluster Service") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$") + @minLength(1) + @maxLength(63) + @key("clusterServiceName") + @path + @segment("clusterServices") + @visibility("create", "read") + name: string; +} + +@doc("Cluster Service Properties.") +model ClusterServiceResourceProperties { + @doc("The status of the last operation.") + @visibility("read") + provisioningState?: ProvisioningState; + + @doc("Cluster type (Lab or Production)") + @visibility("create", "read") + deploymentType: SkuDeploymentType; + + @doc("Azure for Operators 5G Core Release Version. This is applied to all platform as a service (PaaS) components and running workloads in this cluster") + releaseVersion: ReleaseVersion; + + @doc("Cluster type specific data. Contents depend on the cluster type") + clusterTypeSpecificData: ClusterServiceClusterTypeSpecificData; + + @doc("Azure for Operators 5G Core Local PaaS component parameters. One set per component type") + @extension("x-ms-identifiers", ["type"]) + componentParameters: QualifiedComponentDeploymentParameters[]; + + @doc("Operational status") + @visibility("read") + operationalStatus?: OperationalStatus; +} + +@armResourceOperations(ClusterServiceResource) +interface ClusterServices { + get is ArmResourceRead; + createOrUpdate is ArmResourceCreateOrUpdate2Async; + updateTags is ArmTagsPatchSync; + delete is ArmResourceDeleteWithoutOkAsync; + @doc("List all Cluster Services by Resource Group.") + listByResourceGroup is ArmResourceListByParent; + @doc("List all Cluster Services by Subscription ID.") + listBySubscription is ArmListBySubscription; +} + +@doc("Cluster Service cluster type specific data.") +@discriminator("type") +model ClusterServiceClusterTypeSpecificData { + @doc("Cluster Type") + type: ClusterType; + + @doc("Custom Location resource ID") + customLocationId: CustomLocationIdProperty; +} + +@doc("AKS Cluster specific data.") +model ClusterServiceAksClusterData + extends ClusterServiceClusterTypeSpecificData { + @doc("Azure Kubernetes Service Properties.") + type: ClusterType.Aks; +} + +@doc("Nexus AKS Cluster specific data.") +model ClusterServiceNexusAksClusterData + extends ClusterServiceClusterTypeSpecificData { + @doc("Nexus Operator Kubenetes Service Properties.") + type: ClusterType.NexusAks; +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/common.tsp b/specification/mobilepacketcore/MobilePacketCore.Management/common.tsp new file mode 100644 index 000000000000..4f1c2137e133 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/common.tsp @@ -0,0 +1,179 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/openapi"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using OpenAPI; + +namespace Microsoft.MobilePacketCore; + +/** Compliant create or update template */ +/** + * A long-running resource CreateOrUpdate (PUT) + * @template TResource the resource being patched + * @template TBaseParameters Optional. Allows overriding the operation parameters + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "This is a valid template" +@autoRoute +@doc("Create a {name}", TResource) +@OpenAPI.extension("x-ms-long-running-operation", true) +@OpenAPI.extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } +) +@armResourceCreateOrUpdate(TResource) +@put +op ArmResourceCreateOrUpdate2Async< + TResource extends Azure.ResourceManager.Foundations.ArmResource, + TBaseParameters = Azure.ResourceManager.Foundations.BaseParameters +>( + ...ResourceInstanceParameters, + + @doc("Resource create parameters.") + @body + resource: TResource, +): ArmUpdatedResponse | ArmCreatedResponse | ErrorResponse; + +@doc("ARM resource update successful") +model ArmUpdatedResponse + is ArmResponse; + +@doc("Provisioning state of the resource") +@Azure.Core.lroStatus +union ProvisioningState { + string, + ResourceProvisioningState, + + @doc("Resource is getting provisioned") + Provisioning: "Provisioning", + + @doc("Resource is updating") + Updating: "Updating", + + @doc("Resource is getting deleted") + Deleting: "Deleting", + + @doc("Resource has been accepted") + Accepted: "Accepted", +} + +@doc("ARM resource ID of a cluster.") +scalar ClusterServiceIdProperty + extends Azure.ResourceManager.ResourceIdentifier<[ + { + type: "Microsoft.MobilePacketCore/clusterServices", + } + ]>; + +@doc("ARM resource ID of a VNF Agent deployment.") +scalar VnfAgentDeploymentIdProperty + extends Azure.ResourceManager.ResourceIdentifier<[ + { + type: "Microsoft.MobilePacketCore/vnfAgentDeployments", + } + ]>; + +@doc("ARM resource ID of a custom location.") +scalar CustomLocationIdProperty + extends Azure.ResourceManager.ResourceIdentifier<[ + { + type: "Microsoft.ExtendedLocation/customLocations", + } + ]>; + +@doc("Operational Status of the resource") +model OperationalStatus { + @doc("Status of the deployed workload") + @visibility("read") + workload?: string; + + @doc("Health check results") + @visibility("read") + healthCheck?: string; +} + +@doc("Infrastructure Type Definitions") +union InfrastructureType { + string, + + @doc("Azure Core") + "AzureCore", + + @doc("Azure Operator Nexus") + "AzureOperatorNexus", +} + +@doc("Deployment Type Definitions") +union SkuDeploymentType { + string, + + @doc("Production Deployment") + "Production", + + @doc("Lab Deployment") + "Lab", +} + +@doc("Cluster Type Definitions") +union ClusterType { + string, + + @doc("Azure Kubernetes Service") + Aks: "Aks", + + @doc("Azure Operator Nexus Kubernetes Service") + NexusAks: "NexusAks", +} + +@doc("Usage SKU Definition") +scalar UsageSku extends string; + +@doc("Mobile Core Scaling Unit SKU Definition") +scalar MobileCoreScalingUnitSku extends string; + +@doc("Azure for Operators 5G Core Release Version.") +scalar ReleaseVersion extends string; + +@doc("Containerized Network Function (CNF) Component Deployment Parameters") +scalar ComponentDeploymentParameters extends string; + +@doc("Containerized Network Function (CNF) Component Secrets") +scalar ComponentDeploymentSecrets extends string; + +@doc("Containerized Network Function (CNF) Component Deployment Type") +scalar ComponentDeploymentType extends string; + +@doc("Containerized Network Function (CNF) Qualified Deployment Parameters") +model QualifiedComponentDeploymentParameters { + @doc("Federation Type") + type: ComponentDeploymentType; + + @doc("Deployment Parameters") + parameters?: ComponentDeploymentParameters; + + @doc("Deployment secrets") + @secret + secrets?: ComponentDeploymentSecrets; +} + +@doc("ManagedResourceGroupConfiguration represents the configuration of the resource group managed by Azure.") +model ManagedResourceGroupConfiguration { + @doc("The name for the managed resource group. If not specified, the unique name is automatically generated.") + @visibility("create", "read") + @maxLength(75) + name?: string; + + @doc("The location of the managed resource group. If not specified, the location of the parent resource is chosen.") + @visibility("create", "read") + location?: string; +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_CreateOrUpdate.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_CreateOrUpdate.json new file mode 100644 index 000000000000..4e23542853a4 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "operationId": "AmfDeployments_CreateOrUpdate", + "title": "AmfDeployments_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "amfDeploymentName": "amfDeployment1", + "resource": { + "location": "eastus", + "properties": { + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secretsParameters": "{\"global\": {\"secret\": {\"secretValue\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "responses": { + "200": { + "body": { + "name": "amfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/amfDeployments/amfDeployment1", + "type": "Microsoft.MobilePacketCore/amfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + }, + "201": { + "body": { + "name": "amfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/amfDeployments/amfDeployment1", + "type": "Microsoft.MobilePacketCore/amfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_Delete.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_Delete.json new file mode 100644 index 000000000000..98e3ffd5db85 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AmfDeployments_Delete", + "title": "AmfDeployments_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "amfDeploymentName": "amfDeployment1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_Get.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_Get.json new file mode 100644 index 000000000000..e8c47cd3cce5 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "AmfDeployments_Get", + "title": "AmfDeployments_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "amfDeploymentName": "amfDeployment1" + }, + "responses": { + "200": { + "body": { + "name": "amfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/amfDeployments/amfDeployment1", + "type": "Microsoft.MobilePacketCore/amfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_ListByResourceGroup.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_ListByResourceGroup.json new file mode 100644 index 000000000000..7ca290468a6e --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "operationId": "AmfDeployments_ListByResourceGroup", + "title": "AmfDeployments_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "amfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/amfDeployments/amfDeployment1", + "type": "Microsoft.MobilePacketCore/amfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_ListBySubscription.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_ListBySubscription.json new file mode 100644 index 000000000000..da17684e39fb --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "operationId": "AmfDeployments_ListBySubscription", + "title": "AmfDeployments_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "amfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/amfDeployments/amfDeployment1", + "type": "Microsoft.MobilePacketCore/amfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_UpdateTags.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_UpdateTags.json new file mode 100644 index 000000000000..432c290c911b --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/AmfDeployment_UpdateTags.json @@ -0,0 +1,44 @@ +{ + "operationId": "AmfDeployments_UpdateTags", + "title": "AmfDeployments_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "amfDeploymentName": "amfDeployment1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "amfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/amfDeployments/amfDeployment1", + "type": "Microsoft.MobilePacketCore/amfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_CreateOrUpdate.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_CreateOrUpdate.json new file mode 100644 index 000000000000..abfced4fd219 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_CreateOrUpdate.json @@ -0,0 +1,98 @@ +{ + "operationId": "ClusterServices_CreateOrUpdate", + "title": "ClusterServices_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "clusterServiceName": "clusterService1", + "resource": { + "location": "eastus", + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secrets": "{\"global\": {\"secret\": {\"secretValue\": []}}}" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "clusterService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/clusterService1", + "type": "Microsoft.MobilePacketCore/clusterServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + }, + "201": { + "body": { + "name": "clusterService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/clusterService1", + "type": "Microsoft.MobilePacketCore/clusterServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_Delete.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_Delete.json new file mode 100644 index 000000000000..74ba3d3eaf57 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "ClusterServices_Delete", + "title": "ClusterServices_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "clusterServiceName": "clusterService1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_Get.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_Get.json new file mode 100644 index 000000000000..f9af191ab16a --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_Get.json @@ -0,0 +1,46 @@ +{ + "operationId": "ClusterServices_Get", + "title": "ClusterServices_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "clusterServiceName": "clusterService1" + }, + "responses": { + "200": { + "body": { + "name": "clusterService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/clusterService1", + "type": "Microsoft.MobilePacketCore/clusterServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_ListByResourceGroup.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_ListByResourceGroup.json new file mode 100644 index 000000000000..3cf2569ecf79 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_ListByResourceGroup.json @@ -0,0 +1,49 @@ +{ + "operationId": "ClusterServices_ListByResourceGroup", + "title": "ClusterServices_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "clusterService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/clusterService1", + "type": "Microsoft.MobilePacketCore/clusterServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_ListBySubscription.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_ListBySubscription.json new file mode 100644 index 000000000000..3e9576927e27 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_ListBySubscription.json @@ -0,0 +1,49 @@ +{ + "operationId": "ClusterServices_ListBySubscription", + "title": "ClusterServices_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "clusterService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/clusterService1", + "type": "Microsoft.MobilePacketCore/clusterServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_UpdateTags.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_UpdateTags.json new file mode 100644 index 000000000000..803314410a05 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ClusterService_UpdateTags.json @@ -0,0 +1,52 @@ +{ + "operationId": "ClusterServices_UpdateTags", + "title": "ClusterServices_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "clusterServiceName": "clusterService1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "clusterService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/clusterService1", + "type": "Microsoft.MobilePacketCore/clusterServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_CreateOrUpdate.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_CreateOrUpdate.json new file mode 100644 index 000000000000..9578975ef536 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "operationId": "NrfDeployments_CreateOrUpdate", + "title": "NrfDeployments_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nrfDeploymentName": "nrfDeployment1", + "resource": { + "location": "eastus", + "properties": { + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secretsParameters": "{\"global\": {\"secret\": {\"secretValue\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nrfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nrfDeployments/nrfDeployment1", + "type": "Microsoft.MobilePacketCore/nrfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + }, + "201": { + "body": { + "name": "nrfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nrfDeployments/nrfDeployment1", + "type": "Microsoft.MobilePacketCore/nrfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_Delete.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_Delete.json new file mode 100644 index 000000000000..1383bddb0c3e --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "NrfDeployments_Delete", + "title": "NrfDeployments_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nrfDeploymentName": "nrfDeployment1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_Get.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_Get.json new file mode 100644 index 000000000000..63864d4df353 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "NrfDeployments_Get", + "title": "NrfDeployments_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nrfDeploymentName": "nrfDeployment1" + }, + "responses": { + "200": { + "body": { + "name": "nrfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nrfDeployments/nrfDeployment1", + "type": "Microsoft.MobilePacketCore/nrfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_ListByResourceGroup.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_ListByResourceGroup.json new file mode 100644 index 000000000000..f217cf8b47ea --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "operationId": "NrfDeployments_ListByResourceGroup", + "title": "NrfDeployments_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nrfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nrfDeployments/nrfDeployment1", + "type": "Microsoft.MobilePacketCore/nrfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_ListBySubscription.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_ListBySubscription.json new file mode 100644 index 000000000000..2f7bbcc54751 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "operationId": "NrfDeployments_ListBySubscription", + "title": "NrfDeployments_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nrfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nrfDeployments/nrfDeployment1", + "type": "Microsoft.MobilePacketCore/nrfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_UpdateTags.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_UpdateTags.json new file mode 100644 index 000000000000..ee2e11b34b72 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NrfDeployment_UpdateTags.json @@ -0,0 +1,44 @@ +{ + "operationId": "NrfDeployments_UpdateTags", + "title": "NrfDeployments_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nrfDeploymentName": "nrfDeployment1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nrfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nrfDeployments/nrfDeployment1", + "type": "Microsoft.MobilePacketCore/nrfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_CreateOrUpdate.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_CreateOrUpdate.json new file mode 100644 index 000000000000..890c1ec3db4a --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "operationId": "NssfDeployments_CreateOrUpdate", + "title": "NssfDeployments_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nssfDeploymentName": "nssfDeployment1", + "resource": { + "location": "eastus", + "properties": { + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secretsParameters": "{\"global\": {\"secret\": {\"secretValue\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nssfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nssfDeployments/nssfDeployment1", + "type": "Microsoft.MobilePacketCore/nssfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + }, + "201": { + "body": { + "name": "nssfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nssfDeployments/nssfDeployment1", + "type": "Microsoft.MobilePacketCore/nssfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_Delete.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_Delete.json new file mode 100644 index 000000000000..fb94556c57b3 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "NssfDeployments_Delete", + "title": "NssfDeployments_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nssfDeploymentName": "nssfDeployment1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_Get.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_Get.json new file mode 100644 index 000000000000..49ec24ce3a40 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "NssfDeployments_Get", + "title": "NssfDeployments_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nssfDeploymentName": "nssfDeployment1" + }, + "responses": { + "200": { + "body": { + "name": "nssfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nssfDeployments/nssfDeployment1", + "type": "Microsoft.MobilePacketCore/nssfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_ListByResourceGroup.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_ListByResourceGroup.json new file mode 100644 index 000000000000..4310f34ae442 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "operationId": "NssfDeployments_ListByResourceGroup", + "title": "NssfDeployments_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nssfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nssfDeployments/nssfDeployment1", + "type": "Microsoft.MobilePacketCore/nssfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_ListBySubscription.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_ListBySubscription.json new file mode 100644 index 000000000000..f87e38d58279 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "operationId": "NssfDeployments_ListBySubscription", + "title": "NssfDeployments_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nssfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nssfDeployments/nssfDeployment1", + "type": "Microsoft.MobilePacketCore/nssfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_UpdateTags.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_UpdateTags.json new file mode 100644 index 000000000000..52c62f9ffdcb --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/NssfDeployment_UpdateTags.json @@ -0,0 +1,44 @@ +{ + "operationId": "NssfDeployments_UpdateTags", + "title": "NssfDeployments_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nssfDeploymentName": "nssfDeployment1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nssfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nssfDeployments/nssfDeployment1", + "type": "Microsoft.MobilePacketCore/nssfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_CreateOrUpdate.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_CreateOrUpdate.json new file mode 100644 index 000000000000..04b133e5f97a --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "operationId": "ObservabilityServices_CreateOrUpdate", + "title": "ObservabilityServices_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "observabilityServiceName": "observabilityService1", + "resource": { + "location": "eastus", + "properties": { + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secrets": "{\"global\": {\"secret\": {\"secretValue\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "responses": { + "200": { + "body": { + "name": "observabilityService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/observabilityServices/observabilityService1", + "type": "Microsoft.MobilePacketCore/observabilityServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "201": { + "body": { + "name": "observabilityService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/observabilityServices/observabilityService1", + "type": "Microsoft.MobilePacketCore/observabilityServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_Delete.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_Delete.json new file mode 100644 index 000000000000..240503310414 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "ObservabilityServices_Delete", + "title": "ObservabilityServices_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "observabilityServiceName": "observabilityService1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_Get.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_Get.json new file mode 100644 index 000000000000..83c82eea88cc --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_Get.json @@ -0,0 +1,42 @@ +{ + "operationId": "ObservabilityServices_Get", + "title": "ObservabilityServices_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "observabilityServiceName": "observabilityService1" + }, + "responses": { + "200": { + "body": { + "name": "observabilityService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/observabilityServices/observabilityService1", + "type": "Microsoft.MobilePacketCore/observabilityServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_ListByResourceGroup.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_ListByResourceGroup.json new file mode 100644 index 000000000000..25e5d558b002 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_ListByResourceGroup.json @@ -0,0 +1,45 @@ +{ + "operationId": "ObservabilityServices_ListByResourceGroup", + "title": "ObservabilityServices_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "observabilityService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/observabilityServices/observabilityService1", + "type": "Microsoft.MobilePacketCore/observabilityServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_ListBySubscription.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_ListBySubscription.json new file mode 100644 index 000000000000..5d58323691a2 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_ListBySubscription.json @@ -0,0 +1,45 @@ +{ + "operationId": "ObservabilityServices_ListBySubscription", + "title": "ObservabilityServices_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "observabilityService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/observabilityServices/observabilityService1", + "type": "Microsoft.MobilePacketCore/observabilityServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_UpdateTags.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_UpdateTags.json new file mode 100644 index 000000000000..7e4c24227c1b --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/ObservabilityService_UpdateTags.json @@ -0,0 +1,48 @@ +{ + "operationId": "ObservabilityServices_UpdateTags", + "title": "ObservabilityServices_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "observabilityServiceName": "observabilityService1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "observabilityService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/observabilityServices/observabilityService1", + "type": "Microsoft.MobilePacketCore/observabilityServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/OperationList.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/OperationList.json new file mode 100644 index 000000000000..0b89059a3a5c --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/OperationList.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "OperationsList", + "parameters": { + "api-version": "2023-10-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.MobilePacketCore/mobilepacketcores/read", + "display": { + "provider": "Microsoft.MobilePacketCore", + "resource": "AmfProfile", + "operation": "read", + "description": "Read mobile packet core resources" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_CreateOrUpdate.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_CreateOrUpdate.json new file mode 100644 index 000000000000..45e74250c86b --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "operationId": "SmfDeployments_CreateOrUpdate", + "title": "SmfDeployments_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "smfDeploymentName": "smfDeployment1", + "resource": { + "location": "eastus", + "properties": { + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secretsParameters": "{\"global\": {\"secret\": {\"secretValue\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "responses": { + "200": { + "body": { + "name": "smfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/smfDeployments/smfDeployment1", + "type": "Microsoft.MobilePacketCore/smfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + }, + "201": { + "body": { + "name": "smfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/smfDeployments/smfDeployment1", + "type": "Microsoft.MobilePacketCore/smfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_Delete.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_Delete.json new file mode 100644 index 000000000000..aad4322a03cd --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "SmfDeployments_Delete", + "title": "SmfDeployments_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "smfDeploymentName": "smfDeployment1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_Get.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_Get.json new file mode 100644 index 000000000000..da758f1f4e69 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "SmfDeployments_Get", + "title": "SmfDeployments_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "smfDeploymentName": "smfDeployment1" + }, + "responses": { + "200": { + "body": { + "name": "smfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/smfDeployments/smfDeployment1", + "type": "Microsoft.MobilePacketCore/smfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_ListByResourceGroup.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_ListByResourceGroup.json new file mode 100644 index 000000000000..fc8d4560a72c --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "operationId": "SmfDeployments_ListByResourceGroup", + "title": "SmfDeployments_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "smfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/smfDeployments/smfDeployment1", + "type": "Microsoft.MobilePacketCore/smfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_ListBySubscription.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_ListBySubscription.json new file mode 100644 index 000000000000..32f2d4053889 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "operationId": "SmfDeployments_ListBySubscription", + "title": "SmfDeployments_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "smfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/smfDeployments/smfDeployment1", + "type": "Microsoft.MobilePacketCore/smfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_UpdateTags.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_UpdateTags.json new file mode 100644 index 000000000000..3d73fe149a19 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/SmfDeployment_UpdateTags.json @@ -0,0 +1,44 @@ +{ + "operationId": "SmfDeployments_UpdateTags", + "title": "SmfDeployments_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "smfDeploymentName": "smfDeployment1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "smfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/smfDeployments/smfDeployment1", + "type": "Microsoft.MobilePacketCore/smfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_CreateOrUpdate.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_CreateOrUpdate.json new file mode 100644 index 000000000000..cc8c622860d2 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "operationId": "UpfDeployments_CreateOrUpdate", + "title": "UpfDeployments_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "upfDeploymentName": "upfDeployment1", + "resource": { + "location": "eastus", + "properties": { + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secretsParameters": "{\"global\": {\"secret\": {\"secretValue\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "responses": { + "200": { + "body": { + "name": "upfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/upfDeployments/upfDeployment1", + "type": "Microsoft.MobilePacketCore/upfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + }, + "201": { + "body": { + "name": "upfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/upfDeployments/upfDeployment1", + "type": "Microsoft.MobilePacketCore/upfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_Delete.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_Delete.json new file mode 100644 index 000000000000..b69d191e54f3 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "UpfDeployments_Delete", + "title": "UpfDeployments_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "upfDeploymentName": "upfDeployment1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_Get.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_Get.json new file mode 100644 index 000000000000..52758e400110 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "UpfDeployments_Get", + "title": "UpfDeployments_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "upfDeploymentName": "upfDeployment1" + }, + "responses": { + "200": { + "body": { + "name": "upfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/upfDeployments/upfDeployment1", + "type": "Microsoft.MobilePacketCore/upfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_ListByResourceGroup.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_ListByResourceGroup.json new file mode 100644 index 000000000000..e5c913424132 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "operationId": "UpfDeployments_ListByResourceGroup", + "title": "UpfDeployments_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "upfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/upfDeployments/upfDeployment1", + "type": "Microsoft.MobilePacketCore/upfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_ListBySubscription.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_ListBySubscription.json new file mode 100644 index 000000000000..89551fa2b6f1 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "operationId": "UpfDeployments_ListBySubscription", + "title": "UpfDeployments_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "upfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/upfDeployments/upfDeployment1", + "type": "Microsoft.MobilePacketCore/upfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_UpdateTags.json b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_UpdateTags.json new file mode 100644 index 000000000000..3581f146e297 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/examples/2023-10-15-preview/UpfDeployment_UpdateTags.json @@ -0,0 +1,44 @@ +{ + "operationId": "UpfDeployments_UpdateTags", + "title": "UpfDeployments_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "upfDeploymentName": "upfDeployment1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "upfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/upfDeployments/upfDeployment1", + "type": "Microsoft.MobilePacketCore/upfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/main.tsp b/specification/mobilepacketcore/MobilePacketCore.Management/main.tsp new file mode 100644 index 000000000000..dce7d49e7336 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/main.tsp @@ -0,0 +1,37 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-providerhub"; + +import "./common.tsp"; +import "./amfdeployment.tsp"; +import "./smfdeployment.tsp"; +import "./upfdeployment.tsp"; +import "./nrfdeployment.tsp"; +import "./nssfdeployment.tsp"; +import "./clusterservice.tsp"; +import "./observabilityservice.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; + +@doc("Mobile Packet Core Management API") +@armProviderNamespace("Microsoft.MobilePacketCore") +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +@service({ + title: "Microsoft.MobilePacketCore Mobile Packet Core Service", +}) +@versioned(Versions) +namespace Microsoft.MobilePacketCore; + +interface Operations extends Azure.ResourceManager.Operations {} + +@doc("API Versions") +enum Versions { + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("October 15, 2023 Preview API Version") + v2023_10_15_preview: "2023-10-15-preview", +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/nrfdeployment.tsp b/specification/mobilepacketcore/MobilePacketCore.Management/nrfdeployment.tsp new file mode 100644 index 000000000000..9272c80b5f83 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/nrfdeployment.tsp @@ -0,0 +1,69 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/openapi"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using OpenAPI; + +namespace Microsoft.MobilePacketCore; + +@doc("Azure for Operators 5G Core Network Repository Function (NRF) Deployment Resource") +@resource("nrfDeployments") +model NrfDeploymentResource + is TrackedResource { + @doc("The name of the NrfDeployment") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$") + @minLength(1) + @maxLength(63) + @key("nrfDeploymentName") + @path + @segment("nrfDeployments") + @visibility("create", "read") + name: string; +} + +@doc("NRF Deployment Properties.") +model NrfDeploymentResourceProperties { + @doc("The status of the last operation.") + @visibility("read") + provisioningState?: ProvisioningState; + + @doc("Azure for Operators 5G Core NRF component parameters") + componentParameters?: ComponentDeploymentParameters; + + @doc("Azure for Operators 5G Core NRF secrets parameters") + @secret + secretsParameters?: ComponentDeploymentSecrets; + + @doc("Reference to cluster where the Network Function is deployed") + @visibility("create", "read") + clusterService: ClusterServiceIdProperty; + + @doc("Release version. This is inherited from the cluster") + @visibility("read") + releaseVersion?: ReleaseVersion; + + @doc("Operational status") + @visibility("read") + operationalStatus?: OperationalStatus; +} + +@armResourceOperations(NrfDeploymentResource) +interface NrfDeployments { + get is ArmResourceRead; + createOrUpdate is ArmResourceCreateOrUpdate2Async; + updateTags is ArmTagsPatchSync; + delete is ArmResourceDeleteWithoutOkAsync; + @doc("List all Network Repository Function Deployments by Resource Group.") + listByResourceGroup is ArmResourceListByParent; + @doc("List all Network Repository Function Deployments by Subscription ID.") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/nssfdeployment.tsp b/specification/mobilepacketcore/MobilePacketCore.Management/nssfdeployment.tsp new file mode 100644 index 000000000000..e9ec742dce8f --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/nssfdeployment.tsp @@ -0,0 +1,69 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/openapi"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using OpenAPI; + +namespace Microsoft.MobilePacketCore; + +@doc("Azure for Operators 5G Core Network Slice Selection Function (NSSF) Deployment Resource") +@resource("nssfDeployments") +model NssfDeploymentResource + is TrackedResource { + @doc("The name of the NssfDeployment") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$") + @minLength(1) + @maxLength(63) + @key("nssfDeploymentName") + @path + @segment("nssfDeployments") + @visibility("create", "read") + name: string; +} + +@doc("NSSF Deployment Properties.") +model NssfDeploymentResourceProperties { + @doc("The status of the last operation.") + @visibility("read") + provisioningState?: ProvisioningState; + + @doc("Azure for Operators 5G Core NSSF component parameters") + componentParameters?: ComponentDeploymentParameters; + + @doc("Azure for Operators 5G Core NSSF secrets parameters") + @secret + secretsParameters?: ComponentDeploymentSecrets; + + @doc("Reference to cluster where the Network Function is deployed") + @visibility("create", "read") + clusterService: ClusterServiceIdProperty; + + @doc("Release version. This is inherited from the cluster") + @visibility("read") + releaseVersion?: ReleaseVersion; + + @doc("Operational status") + @visibility("read") + operationalStatus?: OperationalStatus; +} + +@armResourceOperations(NssfDeploymentResource) +interface NssfDeployments { + get is ArmResourceRead; + createOrUpdate is ArmResourceCreateOrUpdate2Async; + updateTags is ArmTagsPatchSync; + delete is ArmResourceDeleteWithoutOkAsync; + @doc("List all Network Slice Selection Function Deployments by Resource Group.") + listByResourceGroup is ArmResourceListByParent; + @doc("List all Network Slice Selection Function Deployments by Subscription ID.") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/observabilityservice.tsp b/specification/mobilepacketcore/MobilePacketCore.Management/observabilityservice.tsp new file mode 100644 index 000000000000..d0787197d8ba --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/observabilityservice.tsp @@ -0,0 +1,66 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/openapi"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using OpenAPI; + +namespace Microsoft.MobilePacketCore; + +@doc("Azure for Operators 5G Core Observability Service Resource") +@resource("observabilityServices") +model ObservabilityServiceResource + is TrackedResource { + @doc("The name of the Observability Service") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$") + @minLength(1) + @maxLength(63) + @key("observabilityServiceName") + @path + @segment("observabilityServices") + @visibility("create", "read") + name: string; +} + +@doc("Observability Service Properties.") +model ObservabilityServiceResourceProperties { + @doc("The status of the last operation.") + @visibility("read") + provisioningState?: ProvisioningState; + + @doc("Azure for Operators 5G Core Observability component parameters. One set per component type") + @extension("x-ms-identifiers", ["type"]) + componentParameters: QualifiedComponentDeploymentParameters[]; + + @doc("Reference to cluster where the observability components are deployed") + @visibility("create", "read") + clusterService: ClusterServiceIdProperty; + + @doc("Release version. This is inherited from the cluster") + @visibility("read") + releaseVersion?: ReleaseVersion; + + @doc("Operational status") + @visibility("read") + operationalStatus?: OperationalStatus; +} + +@armResourceOperations(ObservabilityServiceResource) +interface ObservabilityServices { + get is ArmResourceRead; + createOrUpdate is ArmResourceCreateOrUpdate2Async; + updateTags is ArmTagsPatchSync; + delete is ArmResourceDeleteWithoutOkAsync; + @doc("List all Observability Services by Resource Group.") + listByResourceGroup is ArmResourceListByParent; + @doc("List all Observability Services by Subscription ID.") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/smfdeployment.tsp b/specification/mobilepacketcore/MobilePacketCore.Management/smfdeployment.tsp new file mode 100644 index 000000000000..e2e2874dc49f --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/smfdeployment.tsp @@ -0,0 +1,69 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/openapi"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using OpenAPI; + +namespace Microsoft.MobilePacketCore; + +@doc("Azure for Operators 5G Core Session Management Function (SMF) Deployment Resource") +@resource("smfDeployments") +model SmfDeploymentResource + is TrackedResource { + @doc("The name of the SmfDeployment") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$") + @minLength(1) + @maxLength(63) + @key("smfDeploymentName") + @path + @segment("smfDeployment") + @visibility("create", "read") + name: string; +} + +@doc("SMF Deployment Properties.") +model SmfDeploymentResourceProperties { + @doc("The status of the last operation.") + @visibility("read") + provisioningState?: ProvisioningState; + + @doc("Azure for Operators 5G Core SMF component parameters") + componentParameters?: ComponentDeploymentParameters; + + @doc("Azure for Operators 5G Core SMF secrets parameters") + @secret + secretsParameters?: ComponentDeploymentSecrets; + + @doc("Reference to cluster where the Network Function is deployed") + @visibility("create", "read") + clusterService: ClusterServiceIdProperty; + + @doc("Release version. This is inherited from the cluster") + @visibility("read") + releaseVersion?: ReleaseVersion; + + @doc("Operational status") + @visibility("read") + operationalStatus?: OperationalStatus; +} + +@armResourceOperations(SmfDeploymentResource) +interface SmfDeployments { + get is ArmResourceRead; + createOrUpdate is ArmResourceCreateOrUpdate2Async; + updateTags is ArmTagsPatchSync; + delete is ArmResourceDeleteWithoutOkAsync; + @doc("List all Session Management Function Deployments by Resource Group.") + listByResourceGroup is ArmResourceListByParent; + @doc("List all Session Management Function Deployments by Subscription ID.") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/tspconfig.yaml b/specification/mobilepacketcore/MobilePacketCore.Management/tspconfig.yaml new file mode 100644 index 000000000000..e87fafede144 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/tspconfig.yaml @@ -0,0 +1,15 @@ +emit: + - "@azure-tools/typespec-autorest" +linter: + extends: + - "@azure-tools/typespec-azure-resource-manager/all" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + azure-resource-provider-folder: "resource-manager" + emitter-output-dir: "{project-root}/.." + examples-directory: "examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/mobilepacketcore.json" + "@azure-tools/typespec-providerhub-controller": + emitter-output-dir: "{output-dir}/generated" + code-kind: model diff --git a/specification/mobilepacketcore/MobilePacketCore.Management/upfdeployment.tsp b/specification/mobilepacketcore/MobilePacketCore.Management/upfdeployment.tsp new file mode 100644 index 000000000000..9d769e0433c7 --- /dev/null +++ b/specification/mobilepacketcore/MobilePacketCore.Management/upfdeployment.tsp @@ -0,0 +1,69 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/openapi"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using OpenAPI; + +namespace Microsoft.MobilePacketCore; + +@doc("Azure for Operators 5G Core User Plane Function (UPF) Deployment Resource") +@resource("upfDeployments") +model UpfDeploymentResource + is TrackedResource { + @doc("The name of the UpfDeployment") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$") + @minLength(1) + @maxLength(63) + @key("upfDeploymentName") + @path + @segment("upfDeployments") + @visibility("create", "read") + name: string; +} + +@doc("UPF Deployment Properties.") +model UpfDeploymentResourceProperties { + @doc("The status of the last operation.") + @visibility("read") + provisioningState?: ProvisioningState; + + @doc("Azure for Operators 5G Core UPF component parameters") + componentParameters: ComponentDeploymentParameters; + + @doc("Azure for Operators 5G Core F secrets parameters") + @secret + secretsParameters?: ComponentDeploymentSecrets; + + @doc("Reference to cluster where the Network Function is deployed") + @visibility("create", "read") + clusterService: ClusterServiceIdProperty; + + @doc("Release version. This is inherited from the cluster") + @visibility("read") + releaseVersion?: ReleaseVersion; + + @doc("Operational status") + @visibility("read") + operationalStatus?: OperationalStatus; +} + +@armResourceOperations(UpfDeploymentResource) +interface UpfDeployments { + get is ArmResourceRead; + createOrUpdate is ArmResourceCreateOrUpdate2Async; + updateTags is ArmTagsPatchSync; + delete is ArmResourceDeleteWithoutOkAsync; + @doc("List all User Plane Function Deployments by Resource ID.") + listByResourceGroup is ArmResourceListByParent; + @doc("List all User Plane Function Deployments by Subscription ID.") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_CreateOrUpdate.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_CreateOrUpdate.json new file mode 100644 index 000000000000..4e23542853a4 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "operationId": "AmfDeployments_CreateOrUpdate", + "title": "AmfDeployments_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "amfDeploymentName": "amfDeployment1", + "resource": { + "location": "eastus", + "properties": { + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secretsParameters": "{\"global\": {\"secret\": {\"secretValue\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "responses": { + "200": { + "body": { + "name": "amfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/amfDeployments/amfDeployment1", + "type": "Microsoft.MobilePacketCore/amfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + }, + "201": { + "body": { + "name": "amfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/amfDeployments/amfDeployment1", + "type": "Microsoft.MobilePacketCore/amfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_Delete.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_Delete.json new file mode 100644 index 000000000000..98e3ffd5db85 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AmfDeployments_Delete", + "title": "AmfDeployments_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "amfDeploymentName": "amfDeployment1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_Get.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_Get.json new file mode 100644 index 000000000000..e8c47cd3cce5 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "AmfDeployments_Get", + "title": "AmfDeployments_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "amfDeploymentName": "amfDeployment1" + }, + "responses": { + "200": { + "body": { + "name": "amfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/amfDeployments/amfDeployment1", + "type": "Microsoft.MobilePacketCore/amfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_ListByResourceGroup.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_ListByResourceGroup.json new file mode 100644 index 000000000000..7ca290468a6e --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "operationId": "AmfDeployments_ListByResourceGroup", + "title": "AmfDeployments_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "amfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/amfDeployments/amfDeployment1", + "type": "Microsoft.MobilePacketCore/amfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_ListBySubscription.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_ListBySubscription.json new file mode 100644 index 000000000000..da17684e39fb --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "operationId": "AmfDeployments_ListBySubscription", + "title": "AmfDeployments_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "amfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/amfDeployments/amfDeployment1", + "type": "Microsoft.MobilePacketCore/amfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_UpdateTags.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_UpdateTags.json new file mode 100644 index 000000000000..432c290c911b --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/AmfDeployment_UpdateTags.json @@ -0,0 +1,44 @@ +{ + "operationId": "AmfDeployments_UpdateTags", + "title": "AmfDeployments_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "amfDeploymentName": "amfDeployment1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "amfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/amfDeployments/amfDeployment1", + "type": "Microsoft.MobilePacketCore/amfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_CreateOrUpdate.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_CreateOrUpdate.json new file mode 100644 index 000000000000..abfced4fd219 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_CreateOrUpdate.json @@ -0,0 +1,98 @@ +{ + "operationId": "ClusterServices_CreateOrUpdate", + "title": "ClusterServices_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "clusterServiceName": "clusterService1", + "resource": { + "location": "eastus", + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secrets": "{\"global\": {\"secret\": {\"secretValue\": []}}}" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "clusterService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/clusterService1", + "type": "Microsoft.MobilePacketCore/clusterServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + }, + "201": { + "body": { + "name": "clusterService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/clusterService1", + "type": "Microsoft.MobilePacketCore/clusterServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_Delete.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_Delete.json new file mode 100644 index 000000000000..74ba3d3eaf57 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "ClusterServices_Delete", + "title": "ClusterServices_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "clusterServiceName": "clusterService1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_Get.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_Get.json new file mode 100644 index 000000000000..f9af191ab16a --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_Get.json @@ -0,0 +1,46 @@ +{ + "operationId": "ClusterServices_Get", + "title": "ClusterServices_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "clusterServiceName": "clusterService1" + }, + "responses": { + "200": { + "body": { + "name": "clusterService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/clusterService1", + "type": "Microsoft.MobilePacketCore/clusterServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_ListByResourceGroup.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_ListByResourceGroup.json new file mode 100644 index 000000000000..3cf2569ecf79 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_ListByResourceGroup.json @@ -0,0 +1,49 @@ +{ + "operationId": "ClusterServices_ListByResourceGroup", + "title": "ClusterServices_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "clusterService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/clusterService1", + "type": "Microsoft.MobilePacketCore/clusterServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_ListBySubscription.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_ListBySubscription.json new file mode 100644 index 000000000000..3e9576927e27 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_ListBySubscription.json @@ -0,0 +1,49 @@ +{ + "operationId": "ClusterServices_ListBySubscription", + "title": "ClusterServices_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "clusterService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/clusterService1", + "type": "Microsoft.MobilePacketCore/clusterServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_UpdateTags.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_UpdateTags.json new file mode 100644 index 000000000000..803314410a05 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ClusterService_UpdateTags.json @@ -0,0 +1,52 @@ +{ + "operationId": "ClusterServices_UpdateTags", + "title": "ClusterServices_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "clusterServiceName": "clusterService1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "clusterService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/clusterService1", + "type": "Microsoft.MobilePacketCore/clusterServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "deploymentType": "Production", + "releaseVersion": "4.3.0-alpha", + "clusterTypeSpecificData": { + "type": "NexusAks", + "customLocationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cluster124Location" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_CreateOrUpdate.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_CreateOrUpdate.json new file mode 100644 index 000000000000..9578975ef536 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "operationId": "NrfDeployments_CreateOrUpdate", + "title": "NrfDeployments_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nrfDeploymentName": "nrfDeployment1", + "resource": { + "location": "eastus", + "properties": { + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secretsParameters": "{\"global\": {\"secret\": {\"secretValue\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nrfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nrfDeployments/nrfDeployment1", + "type": "Microsoft.MobilePacketCore/nrfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + }, + "201": { + "body": { + "name": "nrfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nrfDeployments/nrfDeployment1", + "type": "Microsoft.MobilePacketCore/nrfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_Delete.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_Delete.json new file mode 100644 index 000000000000..1383bddb0c3e --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "NrfDeployments_Delete", + "title": "NrfDeployments_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nrfDeploymentName": "nrfDeployment1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_Get.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_Get.json new file mode 100644 index 000000000000..63864d4df353 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "NrfDeployments_Get", + "title": "NrfDeployments_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nrfDeploymentName": "nrfDeployment1" + }, + "responses": { + "200": { + "body": { + "name": "nrfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nrfDeployments/nrfDeployment1", + "type": "Microsoft.MobilePacketCore/nrfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_ListByResourceGroup.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_ListByResourceGroup.json new file mode 100644 index 000000000000..f217cf8b47ea --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "operationId": "NrfDeployments_ListByResourceGroup", + "title": "NrfDeployments_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nrfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nrfDeployments/nrfDeployment1", + "type": "Microsoft.MobilePacketCore/nrfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_ListBySubscription.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_ListBySubscription.json new file mode 100644 index 000000000000..2f7bbcc54751 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "operationId": "NrfDeployments_ListBySubscription", + "title": "NrfDeployments_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nrfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nrfDeployments/nrfDeployment1", + "type": "Microsoft.MobilePacketCore/nrfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_UpdateTags.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_UpdateTags.json new file mode 100644 index 000000000000..ee2e11b34b72 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NrfDeployment_UpdateTags.json @@ -0,0 +1,44 @@ +{ + "operationId": "NrfDeployments_UpdateTags", + "title": "NrfDeployments_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nrfDeploymentName": "nrfDeployment1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nrfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nrfDeployments/nrfDeployment1", + "type": "Microsoft.MobilePacketCore/nrfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_CreateOrUpdate.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_CreateOrUpdate.json new file mode 100644 index 000000000000..890c1ec3db4a --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "operationId": "NssfDeployments_CreateOrUpdate", + "title": "NssfDeployments_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nssfDeploymentName": "nssfDeployment1", + "resource": { + "location": "eastus", + "properties": { + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secretsParameters": "{\"global\": {\"secret\": {\"secretValue\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nssfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nssfDeployments/nssfDeployment1", + "type": "Microsoft.MobilePacketCore/nssfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + }, + "201": { + "body": { + "name": "nssfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nssfDeployments/nssfDeployment1", + "type": "Microsoft.MobilePacketCore/nssfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_Delete.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_Delete.json new file mode 100644 index 000000000000..fb94556c57b3 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "NssfDeployments_Delete", + "title": "NssfDeployments_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nssfDeploymentName": "nssfDeployment1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_Get.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_Get.json new file mode 100644 index 000000000000..49ec24ce3a40 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "NssfDeployments_Get", + "title": "NssfDeployments_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nssfDeploymentName": "nssfDeployment1" + }, + "responses": { + "200": { + "body": { + "name": "nssfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nssfDeployments/nssfDeployment1", + "type": "Microsoft.MobilePacketCore/nssfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_ListByResourceGroup.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_ListByResourceGroup.json new file mode 100644 index 000000000000..4310f34ae442 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "operationId": "NssfDeployments_ListByResourceGroup", + "title": "NssfDeployments_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nssfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nssfDeployments/nssfDeployment1", + "type": "Microsoft.MobilePacketCore/nssfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_ListBySubscription.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_ListBySubscription.json new file mode 100644 index 000000000000..f87e38d58279 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "operationId": "NssfDeployments_ListBySubscription", + "title": "NssfDeployments_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nssfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nssfDeployments/nssfDeployment1", + "type": "Microsoft.MobilePacketCore/nssfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_UpdateTags.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_UpdateTags.json new file mode 100644 index 000000000000..52c62f9ffdcb --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/NssfDeployment_UpdateTags.json @@ -0,0 +1,44 @@ +{ + "operationId": "NssfDeployments_UpdateTags", + "title": "NssfDeployments_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "nssfDeploymentName": "nssfDeployment1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nssfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/nssfDeployments/nssfDeployment1", + "type": "Microsoft.MobilePacketCore/nssfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_CreateOrUpdate.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_CreateOrUpdate.json new file mode 100644 index 000000000000..04b133e5f97a --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "operationId": "ObservabilityServices_CreateOrUpdate", + "title": "ObservabilityServices_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "observabilityServiceName": "observabilityService1", + "resource": { + "location": "eastus", + "properties": { + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secrets": "{\"global\": {\"secret\": {\"secretValue\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "responses": { + "200": { + "body": { + "name": "observabilityService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/observabilityServices/observabilityService1", + "type": "Microsoft.MobilePacketCore/observabilityServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "201": { + "body": { + "name": "observabilityService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/observabilityServices/observabilityService1", + "type": "Microsoft.MobilePacketCore/observabilityServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_Delete.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_Delete.json new file mode 100644 index 000000000000..240503310414 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "ObservabilityServices_Delete", + "title": "ObservabilityServices_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "observabilityServiceName": "observabilityService1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_Get.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_Get.json new file mode 100644 index 000000000000..83c82eea88cc --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_Get.json @@ -0,0 +1,42 @@ +{ + "operationId": "ObservabilityServices_Get", + "title": "ObservabilityServices_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "observabilityServiceName": "observabilityService1" + }, + "responses": { + "200": { + "body": { + "name": "observabilityService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/observabilityServices/observabilityService1", + "type": "Microsoft.MobilePacketCore/observabilityServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_ListByResourceGroup.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_ListByResourceGroup.json new file mode 100644 index 000000000000..25e5d558b002 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_ListByResourceGroup.json @@ -0,0 +1,45 @@ +{ + "operationId": "ObservabilityServices_ListByResourceGroup", + "title": "ObservabilityServices_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "observabilityService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/observabilityServices/observabilityService1", + "type": "Microsoft.MobilePacketCore/observabilityServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_ListBySubscription.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_ListBySubscription.json new file mode 100644 index 000000000000..5d58323691a2 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_ListBySubscription.json @@ -0,0 +1,45 @@ +{ + "operationId": "ObservabilityServices_ListBySubscription", + "title": "ObservabilityServices_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "observabilityService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/observabilityServices/observabilityService1", + "type": "Microsoft.MobilePacketCore/observabilityServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_UpdateTags.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_UpdateTags.json new file mode 100644 index 000000000000..7e4c24227c1b --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/ObservabilityService_UpdateTags.json @@ -0,0 +1,48 @@ +{ + "operationId": "ObservabilityServices_UpdateTags", + "title": "ObservabilityServices_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "observabilityServiceName": "observabilityService1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "observabilityService1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/observabilityServices/observabilityService1", + "type": "Microsoft.MobilePacketCore/observabilityServices", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + }, + "componentParameters": [ + { + "type": "fed-crds", + "parameters": "{\"global\": {\"registry\": {\"docker\": []}}}" + } + ], + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/OperationList.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/OperationList.json new file mode 100644 index 000000000000..0b89059a3a5c --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/OperationList.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "OperationsList", + "parameters": { + "api-version": "2023-10-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.MobilePacketCore/mobilepacketcores/read", + "display": { + "provider": "Microsoft.MobilePacketCore", + "resource": "AmfProfile", + "operation": "read", + "description": "Read mobile packet core resources" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_CreateOrUpdate.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_CreateOrUpdate.json new file mode 100644 index 000000000000..45e74250c86b --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "operationId": "SmfDeployments_CreateOrUpdate", + "title": "SmfDeployments_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "smfDeploymentName": "smfDeployment1", + "resource": { + "location": "eastus", + "properties": { + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secretsParameters": "{\"global\": {\"secret\": {\"secretValue\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "responses": { + "200": { + "body": { + "name": "smfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/smfDeployments/smfDeployment1", + "type": "Microsoft.MobilePacketCore/smfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + }, + "201": { + "body": { + "name": "smfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/smfDeployments/smfDeployment1", + "type": "Microsoft.MobilePacketCore/smfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_Delete.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_Delete.json new file mode 100644 index 000000000000..aad4322a03cd --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "SmfDeployments_Delete", + "title": "SmfDeployments_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "smfDeploymentName": "smfDeployment1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_Get.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_Get.json new file mode 100644 index 000000000000..da758f1f4e69 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "SmfDeployments_Get", + "title": "SmfDeployments_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "smfDeploymentName": "smfDeployment1" + }, + "responses": { + "200": { + "body": { + "name": "smfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/smfDeployments/smfDeployment1", + "type": "Microsoft.MobilePacketCore/smfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_ListByResourceGroup.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_ListByResourceGroup.json new file mode 100644 index 000000000000..fc8d4560a72c --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "operationId": "SmfDeployments_ListByResourceGroup", + "title": "SmfDeployments_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "smfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/smfDeployments/smfDeployment1", + "type": "Microsoft.MobilePacketCore/smfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_ListBySubscription.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_ListBySubscription.json new file mode 100644 index 000000000000..32f2d4053889 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "operationId": "SmfDeployments_ListBySubscription", + "title": "SmfDeployments_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "smfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/smfDeployments/smfDeployment1", + "type": "Microsoft.MobilePacketCore/smfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_UpdateTags.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_UpdateTags.json new file mode 100644 index 000000000000..3d73fe149a19 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/SmfDeployment_UpdateTags.json @@ -0,0 +1,44 @@ +{ + "operationId": "SmfDeployments_UpdateTags", + "title": "SmfDeployments_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "smfDeploymentName": "smfDeployment1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "smfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/smfDeployments/smfDeployment1", + "type": "Microsoft.MobilePacketCore/smfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_CreateOrUpdate.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_CreateOrUpdate.json new file mode 100644 index 000000000000..cc8c622860d2 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "operationId": "UpfDeployments_CreateOrUpdate", + "title": "UpfDeployments_CreateOrUpdate", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "upfDeploymentName": "upfDeployment1", + "resource": { + "location": "eastus", + "properties": { + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "secretsParameters": "{\"global\": {\"secret\": {\"secretValue\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster" + } + } + }, + "responses": { + "200": { + "body": { + "name": "upfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/upfDeployments/upfDeployment1", + "type": "Microsoft.MobilePacketCore/upfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + }, + "201": { + "body": { + "name": "upfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/upfDeployments/upfDeployment1", + "type": "Microsoft.MobilePacketCore/upfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_Delete.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_Delete.json new file mode 100644 index 000000000000..b69d191e54f3 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "UpfDeployments_Delete", + "title": "UpfDeployments_Delete", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "upfDeploymentName": "upfDeployment1" + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MobilePacketCore/locations/eastus/operationStatuses/123456789?api-version=2023-10-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_Get.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_Get.json new file mode 100644 index 000000000000..52758e400110 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "UpfDeployments_Get", + "title": "UpfDeployments_Get", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "upfDeploymentName": "upfDeployment1" + }, + "responses": { + "200": { + "body": { + "name": "upfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/upfDeployments/upfDeployment1", + "type": "Microsoft.MobilePacketCore/upfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_ListByResourceGroup.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_ListByResourceGroup.json new file mode 100644 index 000000000000..e5c913424132 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "operationId": "UpfDeployments_ListByResourceGroup", + "title": "UpfDeployments_ListByResourceGroup", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "upfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/upfDeployments/upfDeployment1", + "type": "Microsoft.MobilePacketCore/upfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_ListBySubscription.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_ListBySubscription.json new file mode 100644 index 000000000000..89551fa2b6f1 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "operationId": "UpfDeployments_ListBySubscription", + "title": "UpfDeployments_ListBySubscription", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "upfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/upfDeployments/upfDeployment1", + "type": "Microsoft.MobilePacketCore/upfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_UpdateTags.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_UpdateTags.json new file mode 100644 index 000000000000..3581f146e297 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/examples/UpfDeployment_UpdateTags.json @@ -0,0 +1,44 @@ +{ + "operationId": "UpfDeployments_UpdateTags", + "title": "UpfDeployments_UpdateTags", + "parameters": { + "api-version": "2023-10-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "upfDeploymentName": "upfDeployment1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "upfDeployment1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/upfDeployments/upfDeployment1", + "type": "Microsoft.MobilePacketCore/upfDeployments", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-10-15T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-15T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "componentParameters": "{\"global\": {\"registry\": {\"docker\": []}}}", + "clusterService": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/clusterServices/byoCluster", + "releaseVersion": "1.1.0", + "operationalStatus": { + "workload": "Fully deployed", + "healthCheck": "No errors" + } + } + } + } + } +} diff --git a/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/mobilepacketcore.json b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/mobilepacketcore.json new file mode 100644 index 000000000000..dda13c2c28b7 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/Microsoft.MobilePacketCore/preview/2023-10-15-preview/mobilepacketcore.json @@ -0,0 +1,3341 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.MobilePacketCore Mobile Packet Core Service", + "version": "2023-10-15-preview", + "description": "Mobile Packet Core Management API", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "AmfDeployments" + }, + { + "name": "SmfDeployments" + }, + { + "name": "UpfDeployments" + }, + { + "name": "NrfDeployments" + }, + { + "name": "NssfDeployments" + }, + { + "name": "ClusterServices" + }, + { + "name": "ObservabilityServices" + } + ], + "paths": { + "/providers/Microsoft.MobilePacketCore/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MobilePacketCore/amfDeployments": { + "get": { + "operationId": "AmfDeployments_ListBySubscription", + "tags": [ + "AmfDeployments" + ], + "description": "List all Access and Mobility Function Deployments by Subscription ID.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AmfDeploymentResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AmfDeployments_ListBySubscription": { + "$ref": "./examples/AmfDeployment_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MobilePacketCore/clusterServices": { + "get": { + "operationId": "ClusterServices_ListBySubscription", + "tags": [ + "ClusterServices" + ], + "description": "List all Cluster Services by Subscription ID.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterServiceResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ClusterServices_ListBySubscription": { + "$ref": "./examples/ClusterService_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MobilePacketCore/nrfDeployments": { + "get": { + "operationId": "NrfDeployments_ListBySubscription", + "tags": [ + "NrfDeployments" + ], + "description": "List all Network Repository Function Deployments by Subscription ID.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NrfDeploymentResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NrfDeployments_ListBySubscription": { + "$ref": "./examples/NrfDeployment_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MobilePacketCore/nssfDeployments": { + "get": { + "operationId": "NssfDeployments_ListBySubscription", + "tags": [ + "NssfDeployments" + ], + "description": "List all Network Slice Selection Function Deployments by Subscription ID.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NssfDeploymentResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NssfDeployments_ListBySubscription": { + "$ref": "./examples/NssfDeployment_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MobilePacketCore/observabilityServices": { + "get": { + "operationId": "ObservabilityServices_ListBySubscription", + "tags": [ + "ObservabilityServices" + ], + "description": "List all Observability Services by Subscription ID.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ObservabilityServiceResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ObservabilityServices_ListBySubscription": { + "$ref": "./examples/ObservabilityService_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MobilePacketCore/smfDeployments": { + "get": { + "operationId": "SmfDeployments_ListBySubscription", + "tags": [ + "SmfDeployments" + ], + "description": "List all Session Management Function Deployments by Subscription ID.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SmfDeploymentResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SmfDeployments_ListBySubscription": { + "$ref": "./examples/SmfDeployment_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MobilePacketCore/upfDeployments": { + "get": { + "operationId": "UpfDeployments_ListBySubscription", + "tags": [ + "UpfDeployments" + ], + "description": "List all User Plane Function Deployments by Subscription ID.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UpfDeploymentResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpfDeployments_ListBySubscription": { + "$ref": "./examples/UpfDeployment_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/amfDeployments": { + "get": { + "operationId": "AmfDeployments_ListByResourceGroup", + "tags": [ + "AmfDeployments" + ], + "description": "List all Access and Mobility Function Deployments by Resource Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AmfDeploymentResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AmfDeployments_ListByResourceGroup": { + "$ref": "./examples/AmfDeployment_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/amfDeployments/{amfDeploymentName}": { + "get": { + "operationId": "AmfDeployments_Get", + "tags": [ + "AmfDeployments" + ], + "description": "Get a AmfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "amfDeploymentName", + "in": "path", + "description": "The name of the AMF Deployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AmfDeploymentResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AmfDeployments_Get": { + "$ref": "./examples/AmfDeployment_Get.json" + } + } + }, + "put": { + "operationId": "AmfDeployments_CreateOrUpdate", + "tags": [ + "AmfDeployments" + ], + "description": "Create a AmfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "amfDeploymentName", + "in": "path", + "description": "The name of the AMF Deployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AmfDeploymentResource" + } + } + ], + "responses": { + "200": { + "description": "ARM resource update successful", + "schema": { + "$ref": "#/definitions/AmfDeploymentResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/AmfDeploymentResource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AmfDeployments_CreateOrUpdate": { + "$ref": "./examples/AmfDeployment_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AmfDeployments_UpdateTags", + "tags": [ + "AmfDeployments" + ], + "description": "Update a AmfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "amfDeploymentName", + "in": "path", + "description": "The name of the AMF Deployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AmfDeploymentResourceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AmfDeploymentResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AmfDeployments_UpdateTags": { + "$ref": "./examples/AmfDeployment_UpdateTags.json" + } + } + }, + "delete": { + "operationId": "AmfDeployments_Delete", + "tags": [ + "AmfDeployments" + ], + "description": "Delete a AmfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "amfDeploymentName", + "in": "path", + "description": "The name of the AMF Deployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AmfDeployments_Delete": { + "$ref": "./examples/AmfDeployment_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/clusterServices": { + "get": { + "operationId": "ClusterServices_ListByResourceGroup", + "tags": [ + "ClusterServices" + ], + "description": "List all Cluster Services by Resource Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterServiceResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ClusterServices_ListByResourceGroup": { + "$ref": "./examples/ClusterService_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/clusterServices/{clusterServiceName}": { + "get": { + "operationId": "ClusterServices_Get", + "tags": [ + "ClusterServices" + ], + "description": "Get a ClusterServiceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "clusterServiceName", + "in": "path", + "description": "The name of the Cluster Service", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterServiceResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ClusterServices_Get": { + "$ref": "./examples/ClusterService_Get.json" + } + } + }, + "put": { + "operationId": "ClusterServices_CreateOrUpdate", + "tags": [ + "ClusterServices" + ], + "description": "Create a ClusterServiceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "clusterServiceName", + "in": "path", + "description": "The name of the Cluster Service", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterServiceResource" + } + } + ], + "responses": { + "200": { + "description": "ARM resource update successful", + "schema": { + "$ref": "#/definitions/ClusterServiceResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterServiceResource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ClusterServices_CreateOrUpdate": { + "$ref": "./examples/ClusterService_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ClusterServices_UpdateTags", + "tags": [ + "ClusterServices" + ], + "description": "Update a ClusterServiceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "clusterServiceName", + "in": "path", + "description": "The name of the Cluster Service", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterServiceResourceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterServiceResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ClusterServices_UpdateTags": { + "$ref": "./examples/ClusterService_UpdateTags.json" + } + } + }, + "delete": { + "operationId": "ClusterServices_Delete", + "tags": [ + "ClusterServices" + ], + "description": "Delete a ClusterServiceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "clusterServiceName", + "in": "path", + "description": "The name of the Cluster Service", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ClusterServices_Delete": { + "$ref": "./examples/ClusterService_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/nrfDeployments": { + "get": { + "operationId": "NrfDeployments_ListByResourceGroup", + "tags": [ + "NrfDeployments" + ], + "description": "List all Network Repository Function Deployments by Resource Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NrfDeploymentResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NrfDeployments_ListByResourceGroup": { + "$ref": "./examples/NrfDeployment_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/nrfDeployments/{nrfDeploymentName}": { + "get": { + "operationId": "NrfDeployments_Get", + "tags": [ + "NrfDeployments" + ], + "description": "Get a NrfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "nrfDeploymentName", + "in": "path", + "description": "The name of the NrfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NrfDeploymentResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NrfDeployments_Get": { + "$ref": "./examples/NrfDeployment_Get.json" + } + } + }, + "put": { + "operationId": "NrfDeployments_CreateOrUpdate", + "tags": [ + "NrfDeployments" + ], + "description": "Create a NrfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "nrfDeploymentName", + "in": "path", + "description": "The name of the NrfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NrfDeploymentResource" + } + } + ], + "responses": { + "200": { + "description": "ARM resource update successful", + "schema": { + "$ref": "#/definitions/NrfDeploymentResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/NrfDeploymentResource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NrfDeployments_CreateOrUpdate": { + "$ref": "./examples/NrfDeployment_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NrfDeployments_UpdateTags", + "tags": [ + "NrfDeployments" + ], + "description": "Update a NrfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "nrfDeploymentName", + "in": "path", + "description": "The name of the NrfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NrfDeploymentResourceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NrfDeploymentResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NrfDeployments_UpdateTags": { + "$ref": "./examples/NrfDeployment_UpdateTags.json" + } + } + }, + "delete": { + "operationId": "NrfDeployments_Delete", + "tags": [ + "NrfDeployments" + ], + "description": "Delete a NrfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "nrfDeploymentName", + "in": "path", + "description": "The name of the NrfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NrfDeployments_Delete": { + "$ref": "./examples/NrfDeployment_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/nssfDeployments": { + "get": { + "operationId": "NssfDeployments_ListByResourceGroup", + "tags": [ + "NssfDeployments" + ], + "description": "List all Network Slice Selection Function Deployments by Resource Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NssfDeploymentResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NssfDeployments_ListByResourceGroup": { + "$ref": "./examples/NssfDeployment_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/nssfDeployments/{nssfDeploymentName}": { + "get": { + "operationId": "NssfDeployments_Get", + "tags": [ + "NssfDeployments" + ], + "description": "Get a NssfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "nssfDeploymentName", + "in": "path", + "description": "The name of the NssfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NssfDeploymentResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NssfDeployments_Get": { + "$ref": "./examples/NssfDeployment_Get.json" + } + } + }, + "put": { + "operationId": "NssfDeployments_CreateOrUpdate", + "tags": [ + "NssfDeployments" + ], + "description": "Create a NssfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "nssfDeploymentName", + "in": "path", + "description": "The name of the NssfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NssfDeploymentResource" + } + } + ], + "responses": { + "200": { + "description": "ARM resource update successful", + "schema": { + "$ref": "#/definitions/NssfDeploymentResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/NssfDeploymentResource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NssfDeployments_CreateOrUpdate": { + "$ref": "./examples/NssfDeployment_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NssfDeployments_UpdateTags", + "tags": [ + "NssfDeployments" + ], + "description": "Update a NssfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "nssfDeploymentName", + "in": "path", + "description": "The name of the NssfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NssfDeploymentResourceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NssfDeploymentResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NssfDeployments_UpdateTags": { + "$ref": "./examples/NssfDeployment_UpdateTags.json" + } + } + }, + "delete": { + "operationId": "NssfDeployments_Delete", + "tags": [ + "NssfDeployments" + ], + "description": "Delete a NssfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "nssfDeploymentName", + "in": "path", + "description": "The name of the NssfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NssfDeployments_Delete": { + "$ref": "./examples/NssfDeployment_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/observabilityServices": { + "get": { + "operationId": "ObservabilityServices_ListByResourceGroup", + "tags": [ + "ObservabilityServices" + ], + "description": "List all Observability Services by Resource Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ObservabilityServiceResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ObservabilityServices_ListByResourceGroup": { + "$ref": "./examples/ObservabilityService_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/observabilityServices/{observabilityServiceName}": { + "get": { + "operationId": "ObservabilityServices_Get", + "tags": [ + "ObservabilityServices" + ], + "description": "Get a ObservabilityServiceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "observabilityServiceName", + "in": "path", + "description": "The name of the Observability Service", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ObservabilityServiceResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ObservabilityServices_Get": { + "$ref": "./examples/ObservabilityService_Get.json" + } + } + }, + "put": { + "operationId": "ObservabilityServices_CreateOrUpdate", + "tags": [ + "ObservabilityServices" + ], + "description": "Create a ObservabilityServiceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "observabilityServiceName", + "in": "path", + "description": "The name of the Observability Service", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ObservabilityServiceResource" + } + } + ], + "responses": { + "200": { + "description": "ARM resource update successful", + "schema": { + "$ref": "#/definitions/ObservabilityServiceResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/ObservabilityServiceResource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ObservabilityServices_CreateOrUpdate": { + "$ref": "./examples/ObservabilityService_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ObservabilityServices_UpdateTags", + "tags": [ + "ObservabilityServices" + ], + "description": "Update a ObservabilityServiceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "observabilityServiceName", + "in": "path", + "description": "The name of the Observability Service", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ObservabilityServiceResourceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ObservabilityServiceResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ObservabilityServices_UpdateTags": { + "$ref": "./examples/ObservabilityService_UpdateTags.json" + } + } + }, + "delete": { + "operationId": "ObservabilityServices_Delete", + "tags": [ + "ObservabilityServices" + ], + "description": "Delete a ObservabilityServiceResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "observabilityServiceName", + "in": "path", + "description": "The name of the Observability Service", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ObservabilityServices_Delete": { + "$ref": "./examples/ObservabilityService_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/smfDeployments": { + "get": { + "operationId": "SmfDeployments_ListByResourceGroup", + "tags": [ + "SmfDeployments" + ], + "description": "List all Session Management Function Deployments by Resource Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SmfDeploymentResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SmfDeployments_ListByResourceGroup": { + "$ref": "./examples/SmfDeployment_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/smfDeployments/{smfDeploymentName}": { + "get": { + "operationId": "SmfDeployments_Get", + "tags": [ + "SmfDeployments" + ], + "description": "Get a SmfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "smfDeploymentName", + "in": "path", + "description": "The name of the SmfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SmfDeploymentResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SmfDeployments_Get": { + "$ref": "./examples/SmfDeployment_Get.json" + } + } + }, + "put": { + "operationId": "SmfDeployments_CreateOrUpdate", + "tags": [ + "SmfDeployments" + ], + "description": "Create a SmfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "smfDeploymentName", + "in": "path", + "description": "The name of the SmfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SmfDeploymentResource" + } + } + ], + "responses": { + "200": { + "description": "ARM resource update successful", + "schema": { + "$ref": "#/definitions/SmfDeploymentResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/SmfDeploymentResource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SmfDeployments_CreateOrUpdate": { + "$ref": "./examples/SmfDeployment_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SmfDeployments_UpdateTags", + "tags": [ + "SmfDeployments" + ], + "description": "Update a SmfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "smfDeploymentName", + "in": "path", + "description": "The name of the SmfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SmfDeploymentResourceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SmfDeploymentResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SmfDeployments_UpdateTags": { + "$ref": "./examples/SmfDeployment_UpdateTags.json" + } + } + }, + "delete": { + "operationId": "SmfDeployments_Delete", + "tags": [ + "SmfDeployments" + ], + "description": "Delete a SmfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "smfDeploymentName", + "in": "path", + "description": "The name of the SmfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SmfDeployments_Delete": { + "$ref": "./examples/SmfDeployment_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/upfDeployments": { + "get": { + "operationId": "UpfDeployments_ListByResourceGroup", + "tags": [ + "UpfDeployments" + ], + "description": "List all User Plane Function Deployments by Resource ID.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UpfDeploymentResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpfDeployments_ListByResourceGroup": { + "$ref": "./examples/UpfDeployment_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/upfDeployments/{upfDeploymentName}": { + "get": { + "operationId": "UpfDeployments_Get", + "tags": [ + "UpfDeployments" + ], + "description": "Get a UpfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "upfDeploymentName", + "in": "path", + "description": "The name of the UpfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UpfDeploymentResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpfDeployments_Get": { + "$ref": "./examples/UpfDeployment_Get.json" + } + } + }, + "put": { + "operationId": "UpfDeployments_CreateOrUpdate", + "tags": [ + "UpfDeployments" + ], + "description": "Create a UpfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "upfDeploymentName", + "in": "path", + "description": "The name of the UpfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/UpfDeploymentResource" + } + } + ], + "responses": { + "200": { + "description": "ARM resource update successful", + "schema": { + "$ref": "#/definitions/UpfDeploymentResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/UpfDeploymentResource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpfDeployments_CreateOrUpdate": { + "$ref": "./examples/UpfDeployment_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "UpfDeployments_UpdateTags", + "tags": [ + "UpfDeployments" + ], + "description": "Update a UpfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "upfDeploymentName", + "in": "path", + "description": "The name of the UpfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/UpfDeploymentResourceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UpfDeploymentResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpfDeployments_UpdateTags": { + "$ref": "./examples/UpfDeployment_UpdateTags.json" + } + } + }, + "delete": { + "operationId": "UpfDeployments_Delete", + "tags": [ + "UpfDeployments" + ], + "description": "Delete a UpfDeploymentResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "upfDeploymentName", + "in": "path", + "description": "The name of the UpfDeployment", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpfDeployments_Delete": { + "$ref": "./examples/UpfDeployment_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AmfDeploymentResource": { + "type": "object", + "description": "Azure for Operators 5G Core Access and Mobility Function (AMF) Deployment Resource", + "properties": { + "properties": { + "$ref": "#/definitions/AmfDeploymentResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AmfDeploymentResourceListResult": { + "type": "object", + "description": "The response of a AmfDeploymentResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AmfDeploymentResource items on this page", + "items": { + "$ref": "#/definitions/AmfDeploymentResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AmfDeploymentResourceProperties": { + "type": "object", + "description": "AMF Deployment Properties.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "componentParameters": { + "$ref": "#/definitions/ComponentDeploymentParameters", + "description": "Azure for Operators 5G Core AMF component parameters" + }, + "secretsParameters": { + "$ref": "#/definitions/ComponentDeploymentSecrets", + "format": "password", + "description": "Azure for Operators 5G Core AMF secrets parameters", + "x-ms-secret": true + }, + "clusterService": { + "$ref": "#/definitions/ClusterServiceIdProperty", + "description": "Reference to cluster where the Network Function is deployed", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "releaseVersion": { + "$ref": "#/definitions/ReleaseVersion", + "description": "Release version. This is inherited from the cluster", + "readOnly": true + }, + "operationalStatus": { + "$ref": "#/definitions/OperationalStatus", + "description": "Operational status", + "readOnly": true + } + }, + "required": [ + "clusterService" + ] + }, + "AmfDeploymentResourceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in AmfDeploymentResource resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ClusterServiceAksClusterData": { + "type": "object", + "description": "AKS Cluster specific data.", + "allOf": [ + { + "$ref": "#/definitions/ClusterServiceClusterTypeSpecificData" + } + ], + "x-ms-discriminator-value": "Aks" + }, + "ClusterServiceClusterTypeSpecificData": { + "type": "object", + "description": "Cluster Service cluster type specific data.", + "properties": { + "type": { + "$ref": "#/definitions/ClusterType", + "description": "Cluster Type" + }, + "customLocationId": { + "$ref": "#/definitions/CustomLocationIdProperty", + "description": "Custom Location resource ID" + } + }, + "discriminator": "type", + "required": [ + "type", + "customLocationId" + ] + }, + "ClusterServiceIdProperty": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of a cluster.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.MobilePacketCore/clusterServices" + } + ] + } + }, + "ClusterServiceNexusAksClusterData": { + "type": "object", + "description": "Nexus AKS Cluster specific data.", + "allOf": [ + { + "$ref": "#/definitions/ClusterServiceClusterTypeSpecificData" + } + ], + "x-ms-discriminator-value": "NexusAks" + }, + "ClusterServiceResource": { + "type": "object", + "description": "Azure for Operators 5G Core Cluster Service Resource", + "properties": { + "properties": { + "$ref": "#/definitions/ClusterServiceResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ClusterServiceResourceListResult": { + "type": "object", + "description": "The response of a ClusterServiceResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ClusterServiceResource items on this page", + "items": { + "$ref": "#/definitions/ClusterServiceResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ClusterServiceResourceProperties": { + "type": "object", + "description": "Cluster Service Properties.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "deploymentType": { + "$ref": "#/definitions/SkuDeploymentType", + "description": "Cluster type (Lab or Production)", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "releaseVersion": { + "$ref": "#/definitions/ReleaseVersion", + "description": "Azure for Operators 5G Core Release Version. This is applied to all platform as a service (PaaS) components and running workloads in this cluster" + }, + "clusterTypeSpecificData": { + "$ref": "#/definitions/ClusterServiceClusterTypeSpecificData", + "description": "Cluster type specific data. Contents depend on the cluster type" + }, + "componentParameters": { + "type": "array", + "description": "Azure for Operators 5G Core Local PaaS component parameters. One set per component type", + "items": { + "$ref": "#/definitions/QualifiedComponentDeploymentParameters" + }, + "x-ms-identifiers": [ + "type" + ] + }, + "operationalStatus": { + "$ref": "#/definitions/OperationalStatus", + "description": "Operational status", + "readOnly": true + } + }, + "required": [ + "deploymentType", + "releaseVersion", + "clusterTypeSpecificData", + "componentParameters" + ] + }, + "ClusterServiceResourceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ClusterServiceResource resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ClusterType": { + "type": "string", + "description": "Cluster Type Definitions", + "enum": [ + "Aks", + "NexusAks" + ], + "x-ms-enum": { + "name": "ClusterType", + "modelAsString": true, + "values": [ + { + "name": "Aks", + "value": "Aks", + "description": "Azure Kubernetes Service" + }, + { + "name": "NexusAks", + "value": "NexusAks", + "description": "Azure Operator Nexus Kubernetes Service" + } + ] + } + }, + "ComponentDeploymentParameters": { + "type": "string", + "description": "Containerized Network Function (CNF) Component Deployment Parameters" + }, + "ComponentDeploymentSecrets": { + "type": "string", + "description": "Containerized Network Function (CNF) Component Secrets" + }, + "ComponentDeploymentType": { + "type": "string", + "description": "Containerized Network Function (CNF) Component Deployment Type" + }, + "CustomLocationIdProperty": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of a custom location.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ExtendedLocation/customLocations" + } + ] + } + }, + "InfrastructureType": { + "type": "string", + "description": "Infrastructure Type Definitions", + "enum": [ + "AzureCore", + "AzureOperatorNexus" + ], + "x-ms-enum": { + "name": "InfrastructureType", + "modelAsString": true, + "values": [ + { + "name": "AzureCore", + "value": "AzureCore", + "description": "Azure Core" + }, + { + "name": "AzureOperatorNexus", + "value": "AzureOperatorNexus", + "description": "Azure Operator Nexus" + } + ] + } + }, + "ManagedResourceGroupConfiguration": { + "type": "object", + "description": "ManagedResourceGroupConfiguration represents the configuration of the resource group managed by Azure.", + "properties": { + "name": { + "type": "string", + "description": "The name for the managed resource group. If not specified, the unique name is automatically generated.", + "maxLength": 75, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "location": { + "type": "string", + "description": "The location of the managed resource group. If not specified, the location of the parent resource is chosen.", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "MobileCoreScalingUnitSku": { + "type": "string", + "description": "Mobile Core Scaling Unit SKU Definition" + }, + "NrfDeploymentResource": { + "type": "object", + "description": "Azure for Operators 5G Core Network Repository Function (NRF) Deployment Resource", + "properties": { + "properties": { + "$ref": "#/definitions/NrfDeploymentResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NrfDeploymentResourceListResult": { + "type": "object", + "description": "The response of a NrfDeploymentResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NrfDeploymentResource items on this page", + "items": { + "$ref": "#/definitions/NrfDeploymentResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NrfDeploymentResourceProperties": { + "type": "object", + "description": "NRF Deployment Properties.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "componentParameters": { + "$ref": "#/definitions/ComponentDeploymentParameters", + "description": "Azure for Operators 5G Core NRF component parameters" + }, + "secretsParameters": { + "$ref": "#/definitions/ComponentDeploymentSecrets", + "format": "password", + "description": "Azure for Operators 5G Core NRF secrets parameters", + "x-ms-secret": true + }, + "clusterService": { + "$ref": "#/definitions/ClusterServiceIdProperty", + "description": "Reference to cluster where the Network Function is deployed", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "releaseVersion": { + "$ref": "#/definitions/ReleaseVersion", + "description": "Release version. This is inherited from the cluster", + "readOnly": true + }, + "operationalStatus": { + "$ref": "#/definitions/OperationalStatus", + "description": "Operational status", + "readOnly": true + } + }, + "required": [ + "clusterService" + ] + }, + "NrfDeploymentResourceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NrfDeploymentResource resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NssfDeploymentResource": { + "type": "object", + "description": "Azure for Operators 5G Core Network Slice Selection Function (NSSF) Deployment Resource", + "properties": { + "properties": { + "$ref": "#/definitions/NssfDeploymentResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NssfDeploymentResourceListResult": { + "type": "object", + "description": "The response of a NssfDeploymentResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NssfDeploymentResource items on this page", + "items": { + "$ref": "#/definitions/NssfDeploymentResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NssfDeploymentResourceProperties": { + "type": "object", + "description": "NSSF Deployment Properties.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "componentParameters": { + "$ref": "#/definitions/ComponentDeploymentParameters", + "description": "Azure for Operators 5G Core NSSF component parameters" + }, + "secretsParameters": { + "$ref": "#/definitions/ComponentDeploymentSecrets", + "format": "password", + "description": "Azure for Operators 5G Core NSSF secrets parameters", + "x-ms-secret": true + }, + "clusterService": { + "$ref": "#/definitions/ClusterServiceIdProperty", + "description": "Reference to cluster where the Network Function is deployed", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "releaseVersion": { + "$ref": "#/definitions/ReleaseVersion", + "description": "Release version. This is inherited from the cluster", + "readOnly": true + }, + "operationalStatus": { + "$ref": "#/definitions/OperationalStatus", + "description": "Operational status", + "readOnly": true + } + }, + "required": [ + "clusterService" + ] + }, + "NssfDeploymentResourceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NssfDeploymentResource resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ObservabilityServiceResource": { + "type": "object", + "description": "Azure for Operators 5G Core Observability Service Resource", + "properties": { + "properties": { + "$ref": "#/definitions/ObservabilityServiceResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ObservabilityServiceResourceListResult": { + "type": "object", + "description": "The response of a ObservabilityServiceResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ObservabilityServiceResource items on this page", + "items": { + "$ref": "#/definitions/ObservabilityServiceResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ObservabilityServiceResourceProperties": { + "type": "object", + "description": "Observability Service Properties.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "componentParameters": { + "type": "array", + "description": "Azure for Operators 5G Core Observability component parameters. One set per component type", + "items": { + "$ref": "#/definitions/QualifiedComponentDeploymentParameters" + }, + "x-ms-identifiers": [ + "type" + ] + }, + "clusterService": { + "$ref": "#/definitions/ClusterServiceIdProperty", + "description": "Reference to cluster where the observability components are deployed", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "releaseVersion": { + "$ref": "#/definitions/ReleaseVersion", + "description": "Release version. This is inherited from the cluster", + "readOnly": true + }, + "operationalStatus": { + "$ref": "#/definitions/OperationalStatus", + "description": "Operational status", + "readOnly": true + } + }, + "required": [ + "componentParameters", + "clusterService" + ] + }, + "ObservabilityServiceResourceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ObservabilityServiceResource resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OperationalStatus": { + "type": "object", + "description": "Operational Status of the resource", + "properties": { + "workload": { + "type": "string", + "description": "Status of the deployed workload", + "readOnly": true + }, + "healthCheck": { + "type": "string", + "description": "Health check results", + "readOnly": true + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of the resource", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is getting provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is getting deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource has been accepted" + } + ] + }, + "readOnly": true + }, + "QualifiedComponentDeploymentParameters": { + "type": "object", + "description": "Containerized Network Function (CNF) Qualified Deployment Parameters", + "properties": { + "type": { + "$ref": "#/definitions/ComponentDeploymentType", + "description": "Federation Type" + }, + "parameters": { + "$ref": "#/definitions/ComponentDeploymentParameters", + "description": "Deployment Parameters" + }, + "secrets": { + "$ref": "#/definitions/ComponentDeploymentSecrets", + "format": "password", + "description": "Deployment secrets", + "x-ms-secret": true + } + }, + "required": [ + "type" + ] + }, + "ReleaseVersion": { + "type": "string", + "description": "Azure for Operators 5G Core Release Version." + }, + "SkuDeploymentType": { + "type": "string", + "description": "Deployment Type Definitions", + "enum": [ + "Production", + "Lab" + ], + "x-ms-enum": { + "name": "SkuDeploymentType", + "modelAsString": true, + "values": [ + { + "name": "Production", + "value": "Production", + "description": "Production Deployment" + }, + { + "name": "Lab", + "value": "Lab", + "description": "Lab Deployment" + } + ] + } + }, + "SmfDeploymentResource": { + "type": "object", + "description": "Azure for Operators 5G Core Session Management Function (SMF) Deployment Resource", + "properties": { + "properties": { + "$ref": "#/definitions/SmfDeploymentResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SmfDeploymentResourceListResult": { + "type": "object", + "description": "The response of a SmfDeploymentResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SmfDeploymentResource items on this page", + "items": { + "$ref": "#/definitions/SmfDeploymentResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SmfDeploymentResourceProperties": { + "type": "object", + "description": "SMF Deployment Properties.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "componentParameters": { + "$ref": "#/definitions/ComponentDeploymentParameters", + "description": "Azure for Operators 5G Core SMF component parameters" + }, + "secretsParameters": { + "$ref": "#/definitions/ComponentDeploymentSecrets", + "format": "password", + "description": "Azure for Operators 5G Core SMF secrets parameters", + "x-ms-secret": true + }, + "clusterService": { + "$ref": "#/definitions/ClusterServiceIdProperty", + "description": "Reference to cluster where the Network Function is deployed", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "releaseVersion": { + "$ref": "#/definitions/ReleaseVersion", + "description": "Release version. This is inherited from the cluster", + "readOnly": true + }, + "operationalStatus": { + "$ref": "#/definitions/OperationalStatus", + "description": "Operational status", + "readOnly": true + } + }, + "required": [ + "clusterService" + ] + }, + "SmfDeploymentResourceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in SmfDeploymentResource resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "UpfDeploymentResource": { + "type": "object", + "description": "Azure for Operators 5G Core User Plane Function (UPF) Deployment Resource", + "properties": { + "properties": { + "$ref": "#/definitions/UpfDeploymentResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "UpfDeploymentResourceListResult": { + "type": "object", + "description": "The response of a UpfDeploymentResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The UpfDeploymentResource items on this page", + "items": { + "$ref": "#/definitions/UpfDeploymentResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "UpfDeploymentResourceProperties": { + "type": "object", + "description": "UPF Deployment Properties.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "componentParameters": { + "$ref": "#/definitions/ComponentDeploymentParameters", + "description": "Azure for Operators 5G Core UPF component parameters" + }, + "secretsParameters": { + "$ref": "#/definitions/ComponentDeploymentSecrets", + "format": "password", + "description": "Azure for Operators 5G Core F secrets parameters", + "x-ms-secret": true + }, + "clusterService": { + "$ref": "#/definitions/ClusterServiceIdProperty", + "description": "Reference to cluster where the Network Function is deployed", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "releaseVersion": { + "$ref": "#/definitions/ReleaseVersion", + "description": "Release version. This is inherited from the cluster", + "readOnly": true + }, + "operationalStatus": { + "$ref": "#/definitions/OperationalStatus", + "description": "Operational status", + "readOnly": true + } + }, + "required": [ + "componentParameters", + "clusterService" + ] + }, + "UpfDeploymentResourceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in UpfDeploymentResource resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "UsageSku": { + "type": "string", + "description": "Usage SKU Definition" + }, + "Versions": { + "type": "string", + "description": "API Versions", + "enum": [ + "2023-10-15-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2023_10_15_preview", + "value": "2023-10-15-preview", + "description": "October 15, 2023 Preview API Version" + } + ] + } + }, + "VnfAgentDeploymentIdProperty": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of a VNF Agent deployment.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.MobilePacketCore/vnfAgentDeployments" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/mobilepacketcore/resource-manager/readme.csharp.md b/specification/mobilepacketcore/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..145724961248 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.MobilePacketCore + output-folder: $(csharp-sdks-folder)/mobilePacketCore/management/$(namespace)/GeneratedProtocol +``` diff --git a/specification/mobilepacketcore/resource-manager/readme.go.md b/specification/mobilepacketcore/resource-manager/readme.go.md new file mode 100644 index 000000000000..fcbebf4b6d6c --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/readme.go.md @@ -0,0 +1,20 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/mobilepacketcore/armmobilepacketcore +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` +### Tag: package-2023-10-15-preview and go + +These settings apply only when `--tag=package-2023-10-15-preview --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2023-10-15-preview' && $(go) +namespace: mobilepacketcore +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2023-10-15-preview/$(namespace) +``` diff --git a/specification/mobilepacketcore/resource-manager/readme.md b/specification/mobilepacketcore/resource-manager/readme.md new file mode 100644 index 000000000000..246a83946ef8 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/readme.md @@ -0,0 +1,77 @@ +# mobileCore + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for mobileCore. + +## 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 mobileCore. + +```yaml +openapi-type: arm +openapi-subtype: rpaas +tag: package-2023-10-15-preview +``` +### Tag: package-2023-10-15-preview + +These settings apply only when `--tag=package-2023-10-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-10-15-preview' +input-file: + - Microsoft.MobilePacketCore/preview/2023-10-15-preview/mobilepacketcore.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_mobileCore'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/mobilepacketcore/resource-manager/readme.python.md b/specification/mobilepacketcore/resource-manager/readme.python.md new file mode 100644 index 000000000000..b8236c2369a9 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/readme.python.md @@ -0,0 +1,21 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: Microsoft.MobilePacketCore + package-name: mobileCore + package-version: 2023-10-15-preview + clear-output-folder: true +``` + +```yaml $(python) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt/mobileCore +``` diff --git a/specification/mobilepacketcore/resource-manager/readme.ruby.md b/specification/mobilepacketcore/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..4351483aa279 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_mobileCore +package-version: 2023-10-15-preview +azure-arm: true +``` + +### Tag: package-2023-10-15-preview and ruby + +These settings apply only when `--tag=package-2023-10-15-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2023-10-15-preview' && $(ruby) +namespace: Microsoft.MobilePacketCore +output-folder: $(ruby-sdks-folder)/mobileCore +``` diff --git a/specification/mobilepacketcore/resource-manager/readme.typescript.md b/specification/mobilepacketcore/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..899f3b0428f8 --- /dev/null +++ b/specification/mobilepacketcore/resource-manager/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "mobileCore" + output-folder: "$(typescript-sdks-folder)/packages/mobileCore" + payload-flattening-threshold: 1 + generate-metadata: true +``` diff --git a/specification/mpcnetworkfunction/MpcNetworkFunction.Management/networkfunction.tsp b/specification/mpcnetworkfunction/MpcNetworkFunction.Management/networkfunction.tsp index 07059323d7de..c8677150aeab 100644 --- a/specification/mpcnetworkfunction/MpcNetworkFunction.Management/networkfunction.tsp +++ b/specification/mpcnetworkfunction/MpcNetworkFunction.Management/networkfunction.tsp @@ -109,103 +109,112 @@ interface NetworkFunctions { } @doc("SKU Definitions") -enum SkuDefinitions { +union SkuDefinitions { + string, + @doc("Azure Lab SKU") - AzureLab, + "AzureLab", @doc("Azure Production SKU") - AzureProduction, + "AzureProduction", @doc("Nexus Lab SKU") - NexusLab, + "NexusLab", @doc("Nexus Production SKU") - NexusProduction, + "NexusProduction", } @doc("Type of Network Function") -enum NetworkFunctionType { +union NetworkFunctionType { + string, + @doc("Access and Mobility Function") - AMF, + "AMF", @doc("Session Management Function") - SMF, + "SMF", @doc("User Plane Function") - UPF, + "UPF", @doc("Network Repository Function") - NRF, + "NRF", @doc("Network Slice Selection Function") - NSSF, + "NSSF", @doc("Mobility Management Entity") - MME, + "MME", @doc("System Architecture Evolution Gateway Control Plane, control and user plane separation (CUPS) architecture") - SaegwControlPlane, + "SaegwControlPlane", @doc("System Architecture Evolution Gateway User Plane, control and user plane separation (CUPS) architecture") - SaegwUserPlane, + "SaegwUserPlane", @doc("System Architecture Evolution Gateway. This combines the Serving Gateway (SGW) and the Packet Data Network Gateway (PGW) functionality") - Saegw, + "Saegw", @doc("Evolved Packet Data Gateway") - ePDG, + "ePDG", @doc("Non-3GPP Interworking Function") - N3IWF, + "N3IWF", @doc("Remote Platform As A Service Components") - RemotePaaS, + "RemotePaaS", @doc("Element Management System") - EMS, + "EMS", @doc("Operations and Policy Manager") - OperationsPolicyManager, + "OperationsPolicyManager", } @doc("Network Function Administrative State enumerations") -enum NetworkFunctionAdministrativeState { +union NetworkFunctionAdministrativeState { + string, + @doc("Resource has been commissioned") - Commissioned, + "Commissioned", @doc("Resource has been decommissioned") - Decommissioned, + "Decommissioned", } @doc("Network Function Operational Status enumerations") -enum NetworkFunctionOperationalStatus { +union NetworkFunctionOperationalStatus { + string, + @doc("Resource is inactive") - Inactive, + "Inactive", @doc("Resource has been deployed, awaiting provisioning") - InstantiatedNotProvisioned, + "InstantiatedNotProvisioned", @doc("Resource has been deployed and provisioned, awaiting testing") - InstantiatedProvisioned, + "InstantiatedProvisioned", @doc("Resource is fully deployed and operational") - Active, + "Active", } @doc("Provisioning state of the resource") @Azure.Core.lroStatus -enum ProvisioningState { - ...ResourceProvisioningState, +union ProvisioningState { + string, + ResourceProvisioningState, @doc("Resource is getting provisioned") - Provisioning, + Provisioning: "Provisioning", @doc("Resource is updating") - Updating, + Updating: "Updating", @doc("Resource is getting deleted") - Deleting, + Deleting: "Deleting", @doc("Resource has been accepted") - Accepted, + Accepted: "Accepted", } diff --git a/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/networkfunction.json b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/networkfunction.json index 3848d4076139..f3fc2c6e4ba1 100644 --- a/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/networkfunction.json +++ b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/networkfunction.json @@ -61,7 +61,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -100,7 +100,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkFunctionResourceListResult" } @@ -142,7 +142,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkFunctionResourceListResult" } @@ -194,7 +194,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkFunctionResource" } @@ -256,7 +256,7 @@ } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Azure create operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkFunctionResource" }, @@ -323,7 +323,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkFunctionResource" } @@ -373,7 +373,7 @@ "description": "Resource deleted successfully." }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/NspLinkPut.json b/specification/network/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/NspLinkPut.json index ead8047f63bb..9db162815a94 100644 --- a/specification/network/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/NspLinkPut.json +++ b/specification/network/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/NspLinkPut.json @@ -8,7 +8,13 @@ "linkName": "link1", "parameters": { "properties": { - "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2" + "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2", + "localInboundProfiles": [ + "*" + ], + "remoteInboundProfiles": [ + "*" + ] } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json b/specification/network/resource-manager/Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json index 98530d9b7e6d..d014576bd561 100644 --- a/specification/network/resource-manager/Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json +++ b/specification/network/resource-manager/Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json @@ -1810,7 +1810,7 @@ "items": { "type": "string" }, - "description": "Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles. It's default value is ['*'].", + "description": "Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles.", "uniqueItems": true }, "localOutboundProfiles": { @@ -1827,7 +1827,7 @@ "items": { "type": "string" }, - "description": "Remote Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles. This property can only be updated in auto-approval mode. It's default value is ['*'].", + "description": "Remote Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles. This property can only be updated in auto-approval mode.", "uniqueItems": true }, "remoteOutboundProfiles": { @@ -1922,7 +1922,7 @@ "items": { "type": "string" }, - "description": "Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles. It's default value is ['*'].", + "description": "Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles.", "uniqueItems": true }, "localOutboundProfiles": { @@ -1931,7 +1931,7 @@ "type": "string" }, "readOnly": true, - "description": "Local Outbound profile names from which Outbound is allowed. Use ['*'] to allow outbound from all profiles. It's default value is ['*'].", + "description": "Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.", "uniqueItems": true }, "remoteInboundProfiles": { @@ -1940,7 +1940,7 @@ "type": "string" }, "readOnly": true, - "description": "Remote Inbound profile names to which Inbound is allowed. ['*'] value implies inbound is allowed to all profiles at remote perimeter. This property can only be updated from remote perimeter." + "description": "Remote Inbound profile names to which Inbound is allowed. ['*'] value implies inbound is allowed to all profiles at remote perimeter. This property can only be updated from corresponding link resource present in remote perimeter." }, "remoteOutboundProfiles": { "type": "array", @@ -1948,7 +1948,7 @@ "type": "string" }, "readOnly": true, - "description": "Remote Outbound profile names from which Outbound is allowed. ['*'] value implies outbound is allowed from all profiles at remote perimeter. This property can only be updated from remote perimeter." + "description": "Remote Outbound profile names from which Outbound is allowed. ['*'] value implies outbound is allowed from all profiles at remote perimeter. This property can only be updated from corresponding link resource present in remote perimeter." }, "description": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2023-08-01-preview/examples/NspLinkPut.json b/specification/network/resource-manager/Microsoft.Network/preview/2023-08-01-preview/examples/NspLinkPut.json index 75f309aaed62..19cfab4c3da0 100644 --- a/specification/network/resource-manager/Microsoft.Network/preview/2023-08-01-preview/examples/NspLinkPut.json +++ b/specification/network/resource-manager/Microsoft.Network/preview/2023-08-01-preview/examples/NspLinkPut.json @@ -8,7 +8,13 @@ "linkName": "link1", "parameters": { "properties": { - "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2" + "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2", + "localInboundProfiles": [ + "*" + ], + "remoteInboundProfiles": [ + "*" + ] } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json b/specification/network/resource-manager/Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json index 158ce493005f..ea670317f744 100644 --- a/specification/network/resource-manager/Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json +++ b/specification/network/resource-manager/Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json @@ -1817,7 +1817,7 @@ "items": { "type": "string" }, - "description": "Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles. It's default value is ['*'].", + "description": "Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles.", "uniqueItems": true }, "localOutboundProfiles": { @@ -1834,7 +1834,7 @@ "items": { "type": "string" }, - "description": "Remote Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles. This property can only be updated in auto-approval mode. It's default value is ['*'].", + "description": "Remote Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles. This property can only be updated in auto-approval mode.", "uniqueItems": true }, "remoteOutboundProfiles": { @@ -1929,7 +1929,7 @@ "items": { "type": "string" }, - "description": "Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles. It's default value is ['*'].", + "description": "Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles.", "uniqueItems": true }, "localOutboundProfiles": { @@ -1938,7 +1938,7 @@ "type": "string" }, "readOnly": true, - "description": "Local Outbound profile names from which Outbound is allowed. Use ['*'] to allow outbound from all profiles. It's default value is ['*'].", + "description": "Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.", "uniqueItems": true }, "remoteInboundProfiles": { @@ -1947,7 +1947,7 @@ "type": "string" }, "readOnly": true, - "description": "Remote Inbound profile names to which Inbound is allowed. ['*'] value implies inbound is allowed to all profiles at remote perimeter. This property can only be updated from remote perimeter." + "description": "Remote Inbound profile names to which Inbound is allowed. ['*'] value implies inbound is allowed to all profiles at remote perimeter. This property can only be updated from corresponding link resource present in remote perimeter." }, "remoteOutboundProfiles": { "type": "array", @@ -1955,7 +1955,7 @@ "type": "string" }, "readOnly": true, - "description": "Remote Outbound profile names from which Outbound is allowed. ['*'] value implies outbound is allowed from all profiles at remote perimeter. This property can only be updated from remote perimeter." + "description": "Remote Outbound profile names from which Outbound is allowed. ['*'] value implies outbound is allowed from all profiles at remote perimeter. This property can only be updated from corresponding link resource present in remote perimeter." }, "description": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/azureFirewall.json index b82e8e955b04..e780f593b211 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/azureFirewall.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/azureFirewall.json @@ -65,7 +65,13 @@ ], "responses": { "202": { - "description": "Accepted and the operation will complete asynchronously." + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } }, "204": { "description": "Request successful. Resource with the specified name does not exist." @@ -484,6 +490,7 @@ "description": "Accepted and the operation will complete asynchronously.", "headers": { "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", "type": "string" } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallDelete.json index 168c876c1ee3..d9ded9574fc1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallDelete.json @@ -7,7 +7,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, "204": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGet.json index d197690b6b71..6d50ba91b519 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGet.json @@ -44,6 +44,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -74,6 +75,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -123,6 +125,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithAdditionalProperties.json index c31086bb9e0c..deb24e66f98c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithAdditionalProperties.json @@ -44,6 +44,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -74,6 +75,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -123,6 +125,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithIpGroups.json index 16a58b862442..535a5bd21c8b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithIpGroups.json @@ -44,6 +44,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -73,6 +74,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -122,6 +124,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithMgmtSubnet.json index 4a8727626179..333a9fce1a85 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithMgmtSubnet.json @@ -58,6 +58,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -88,6 +89,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -137,6 +139,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithZones.json index 1d68f4dd2fe4..7bdd3535fd16 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithZones.json @@ -48,6 +48,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -78,6 +79,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -127,6 +129,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListByResourceGroup.json index 8c8c2f64e3c8..e5314b813c02 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListByResourceGroup.json @@ -55,6 +55,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -85,6 +86,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -134,6 +136,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListBySubscription.json index 8568e4093706..a4305fbfed69 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListBySubscription.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListBySubscription.json @@ -54,6 +54,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -84,6 +85,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -133,6 +135,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListLearnedIPPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListLearnedIPPrefixes.json index da650b654600..0c7d313bb6db 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListLearnedIPPrefixes.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListLearnedIPPrefixes.json @@ -6,7 +6,11 @@ "azureFirewallName": "azureFirewall1" }, "responses": { - "202": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=638385313328642925&c=abc-123&s=def-456&h=xyz-789" + } + }, "200": { "body": { "ipPrefixes": [ diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPut.json index 63c801d3273e..994dc5875daa 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPut.json @@ -198,6 +198,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -228,6 +229,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -277,6 +279,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -365,6 +368,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -395,6 +399,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -444,6 +449,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithAdditionalProperties.json index 7be0f0bfcce6..b2c45b0f56ab 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithAdditionalProperties.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithAdditionalProperties.json @@ -203,6 +203,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -233,6 +234,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -282,6 +284,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -372,6 +375,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -402,6 +406,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -451,6 +456,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithIpGroups.json index 6eb80be3ac61..0071150d656d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithIpGroups.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithIpGroups.json @@ -198,6 +198,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -228,6 +229,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -277,6 +279,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -364,6 +367,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -393,6 +397,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -442,6 +447,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithMgmtSubnet.json index 4b035ae28b79..dd247ef04b46 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithMgmtSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithMgmtSubnet.json @@ -209,6 +209,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -239,6 +240,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -288,6 +290,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -375,6 +378,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -405,6 +409,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -454,6 +459,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithZones.json index 429509111b07..0a9007531a61 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithZones.json @@ -66,6 +66,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -206,6 +207,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -236,6 +238,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -285,6 +288,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { @@ -377,6 +381,7 @@ "applicationRuleCollections": [ { "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", "properties": { "priority": 110, "action": { @@ -407,6 +412,7 @@ "natRuleCollections": [ { "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", "properties": { "priority": 112, "action": { @@ -456,6 +462,7 @@ "networkRuleCollections": [ { "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", "properties": { "priority": 112, "action": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallUpdateTags.json index 303e4cda03cf..b9e64c0b6321 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallUpdateTags.json @@ -12,7 +12,11 @@ } }, "responses": { - "202": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, "200": { "body": { "name": "fw1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/IpGroupsDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/IpGroupsDelete.json index 9cb023f38623..dfb1db07e38b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/IpGroupsDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/IpGroupsDelete.json @@ -7,7 +7,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subId/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, "204": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/VirtualRouterDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/VirtualRouterDelete.json index b4602239f4fa..3c1fde7491a6 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/VirtualRouterDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/VirtualRouterDelete.json @@ -7,7 +7,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, "204": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/VirtualRouterPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/VirtualRouterPeeringDelete.json index 5eeceb3b6297..41bf8ac28ca7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/VirtualRouterPeeringDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/VirtualRouterPeeringDelete.json @@ -8,7 +8,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, "204": {} } } diff --git a/specification/network/resource-manager/readme.python.md b/specification/network/resource-manager/readme.python.md index 555c132b829e..cae923588e0b 100644 --- a/specification/network/resource-manager/readme.python.md +++ b/specification/network/resource-manager/readme.python.md @@ -18,9 +18,10 @@ Generate all API versions currently shipped for this package ```yaml $(python) multiapi: true -default-api-version: "2023-06-01" +default-api-version: "2023-09-01" clear-output-folder: true batch: + - tag: package-2023-09 - tag: package-2023-06 - tag: package-2023-05 - tag: package-2023-04 @@ -57,6 +58,16 @@ perform-load: false clear-output-folder: false ``` +### Tag: package-2023-09 and python + +These settings apply only when `--tag=package-2023-09 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2023-09' +namespace: azure.mgmt.network.v2023_09_01 +output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2023_09_01 +``` + ### Tag: package-2023-06 and python These settings apply only when `--tag=package-2023-06 --python` is specified on the command line. diff --git a/specification/networkanalytics/NetworkAnalytics.Management/main.tsp b/specification/networkanalytics/NetworkAnalytics.Management/main.tsp index b3d6e405083d..ed1b33e64a5b 100644 --- a/specification/networkanalytics/NetworkAnalytics.Management/main.tsp +++ b/specification/networkanalytics/NetworkAnalytics.Management/main.tsp @@ -28,27 +28,29 @@ enum Versions { } @doc("The status of the current operation.") -enum ProvisioningState { +union ProvisioningState { + string, + /** Represents a succeeded operation. */ - Succeeded, + Succeeded: "Succeeded", /** Represents a failed operation. */ - Failed, + Failed: "Failed", /** Represents a canceled operation. */ - Canceled, + Canceled: "Canceled", /** Represents a pending operation. */ - Provisioning, + Provisioning: "Provisioning", /** Represents a pending operation. */ - Updating, + Updating: "Updating", /** Represents an operation under deletion. */ - Deleting, + Deleting: "Deleting", /** Represents an accepted operation. */ - Accepted, + Accepted: "Accepted", } @doc("ManagedResourceGroup related properties") @@ -92,27 +94,31 @@ model ResourceAccessRules { } @doc("Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, \"Logging, Metrics\"), or None to bypass none of those traffics.") -enum Bypass { +union Bypass { + string, + @doc("Represents no bypassing of traffic.") - None, + "None", @doc("Represents bypassing logging traffic.") - Logging, + "Logging", @doc("Represents bypassing metrics traffic.") - Metrics, + "Metrics", @doc("Represents bypassing azure services traffic.") - AzureServices, + "AzureServices", } @doc("Specifies the default action of allow or deny when no other rules match.") -enum DefaultAction { +union DefaultAction { + string, + @doc("Represents allow action.") - Allow, + "Allow", @doc("Represents deny action.") - Deny, + "Deny", } @doc("Data Product Network rule set") @@ -246,12 +252,14 @@ model EncryptionKeyDetails { @doc("The data type state") @added(Versions.v2023_11_15) -enum ControlState { +union ControlState { + string, + @doc("Field to enable a setting.") - Enabled, + "Enabled", @doc("Field to disable a setting.") - Disabled, + "Disabled", } @doc("Details of Consumption Properties") @@ -378,12 +386,14 @@ model DataTypeProperties { @doc("The data type state") @added(Versions.v2023_11_15) -enum DataTypeState { +union DataTypeState { + string, + @doc("Field to specify stopped state.") - Stopped, + "Stopped", @doc("Field to specify running state.") - Running, + "Running", } @doc("The details for container sas creation.") @@ -410,15 +420,17 @@ model ListRoleAssignments { @doc("The data type state") @added(Versions.v2023_11_15) -enum DataProductUserRole { +union DataProductUserRole { + string, + @doc("Field to specify user of type Reader.") - Reader, + "Reader", @doc(""" Field to specify user of type SensitiveReader. This user has privileged access to read sensitive data of a data product. """) - SensitiveReader, + "SensitiveReader", } @doc("The details for role assignment common properties.") diff --git a/specification/networkanalytics/resource-manager/Microsoft.NetworkAnalytics/stable/2023-11-15/networkanalytics.json b/specification/networkanalytics/resource-manager/Microsoft.NetworkAnalytics/stable/2023-11-15/networkanalytics.json index 6d648ea6fe9d..1d3f1b103f54 100644 --- a/specification/networkanalytics/resource-manager/Microsoft.NetworkAnalytics/stable/2023-11-15/networkanalytics.json +++ b/specification/networkanalytics/resource-manager/Microsoft.NetworkAnalytics/stable/2023-11-15/networkanalytics.json @@ -66,7 +66,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -108,7 +108,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataProductListResult" } @@ -150,7 +150,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataProductsCatalogListResult" } @@ -195,7 +195,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataProductListResult" } @@ -250,7 +250,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataProduct" } @@ -385,7 +385,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataProduct" } @@ -467,7 +467,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -529,7 +529,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RoleAssignmentDetail" } @@ -581,7 +581,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataTypeListResult" } @@ -646,7 +646,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataType" } @@ -801,7 +801,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataType" } @@ -893,7 +893,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -1051,7 +1051,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ContainerSasToken" } @@ -1112,7 +1112,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccountSasToken" } @@ -1173,7 +1173,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListRoleAssignments" } @@ -1331,7 +1331,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataProductsCatalogListResult" } @@ -1376,7 +1376,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataProductsCatalog" } diff --git a/specification/networkanalytics/resource-manager/readme.md b/specification/networkanalytics/resource-manager/readme.md index af2f3052c246..f1f4c12cf6bb 100644 --- a/specification/networkanalytics/resource-manager/readme.md +++ b/specification/networkanalytics/resource-manager/readme.md @@ -28,6 +28,10 @@ openapi-subtype: rpaas tag: package-2023-11-15 ``` +``` yaml +modelerfour: + flatten-models: false +``` ### Tag: package-2023-11-15 diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json new file mode 100644 index 000000000000..bff3dd30842a --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json @@ -0,0 +1,3432 @@ +{ + "swagger": "2.0", + "info": { + "title": "NewRelic.Observability", + "version": "2024-01-01-preview", + "x-cadl-generated": [ + { + "emitter": "@azure-tools/cadl-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Microsoft Entra ID OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Monitors" + }, + { + "name": "Accounts" + }, + { + "name": "Organizations" + }, + { + "name": "Plan" + }, + { + "name": "TagRules" + } + ], + "paths": { + "/providers/NewRelic.Observability/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "List the operations for the provider", + "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" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet_Gen": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_List", + "description": "List all the existing accounts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/UserEmailParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountsListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Accounts_List_MaximumSet_Gen": { + "$ref": "./examples/Accounts_List_MaximumSet_Gen.json" + }, + "Accounts_List_MinimumSet_Gen": { + "$ref": "./examples/Accounts_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/monitors": { + "get": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListBySubscription", + "description": "List NewRelicMonitorResource resources by subscription ID", + "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/NewRelicMonitorResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/organizations": { + "get": { + "tags": [ + "Organizations" + ], + "operationId": "Organizations_List", + "description": "List all the existing organizations", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/UserEmailParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationsListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Organizations_List_MaximumSet_Gen": { + "$ref": "./examples/Organizations_List_MaximumSet_Gen.json" + }, + "Organizations_List_MinimumSet_Gen": { + "$ref": "./examples/Organizations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/plans": { + "get": { + "tags": [ + "Plan" + ], + "operationId": "Plans_List", + "description": "List plans data", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccountIdParameter" + }, + { + "$ref": "#/parameters/OrganizationIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PlanDataListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Plans_List_MaximumSet_Gen": { + "$ref": "./examples/Plans_List_MaximumSet_Gen.json" + }, + "Plans_List_MinimumSet_Gen": { + "$ref": "./examples/Plans_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors": { + "get": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListByResourceGroup", + "description": "List NewRelicMonitorResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}": { + "get": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_Get", + "description": "Get a NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Get_MaximumSet_Gen": { + "$ref": "./examples/Monitors_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_CreateOrUpdate", + "description": "Create a NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "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/NewRelicMonitorResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_Update", + "description": "Update a NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Update_MaximumSet_Gen": { + "$ref": "./examples/Monitors_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_Delete", + "description": "Delete a NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/UserEmailParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "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" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Delete_MaximumSet_Gen": { + "$ref": "./examples/Monitors_Delete_MaximumSet_Gen.json" + }, + "Monitors_Delete_MinimumSet_Gen": { + "$ref": "./examples/Monitors_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getMetricRules": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_GetMetricRules", + "description": "Get metric rules", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/MetricsRequestParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MetricRules" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMetricRules_MaximumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricRules_MaximumSet_Gen.json" + }, + "Monitors_GetMetricRules_MinimumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricRules_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getMetricStatus": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_GetMetricStatus", + "description": "Get metric 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" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/MetricsStatusRequestParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MetricsStatusResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMetricStatus_MaximumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricStatus_MaximumSet_Gen.json" + }, + "Monitors_GetMetricStatus_MinimumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listAppServices": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListAppServices", + "description": "List the app service resources currently being monitored by the NewRelic resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/AppServicesGetParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppServicesListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListAppServices_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListAppServices_MaximumSet_Gen.json" + }, + "Monitors_ListAppServices_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListAppServices_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/switchBilling": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_SwitchBilling", + "description": "Switches the billing for NewRelic monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/SwitchBillingParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_SwitchBilling_MaximumSet_Gen": { + "$ref": "./examples/Monitors_SwitchBilling_MaximumSet_Gen.json" + }, + "Monitors_SwitchBilling_MinimumSet_Gen": { + "$ref": "./examples/Monitors_SwitchBilling_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listHosts": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListHosts", + "description": "List the compute vm resources currently being monitored by the NewRelic resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/HostsGetParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VMHostsListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListHosts_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListHosts_MaximumSet_Gen.json" + }, + "Monitors_ListHosts_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListHosts_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredResources": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListMonitoredResources", + "description": "List the resources currently being monitored by the NewRelic monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitoredResourceListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListMonitoredResources_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json" + }, + "Monitors_ListMonitoredResources_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getBillingInfo": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "Get marketplace info mapped to the given monitor.", + "operationId": "BillingInfo_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" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BillingInfoResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingInfo_Get": { + "$ref": "./examples/BillingInfo_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listConnectedPartnerResources": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "List of all active deployments that are associated with the marketplace subscription linked to the given monitor.", + "operationId": "ConnectedPartnerResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "Email Id of the user", + "schema": { + "$ref": "#/definitions/email" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ConnectedPartnerResourcesListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConnectedPartnerResources_List": { + "$ref": "./examples/ConnectedPartnerResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/tagRules": { + "get": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_ListByNewRelicMonitorResource", + "description": "List TagRule resources by NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen": { + "$ref": "./examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json" + }, + "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen": { + "$ref": "./examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/tagRules/{ruleSetName}": { + "get": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_Get", + "description": "Get a TagRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Name of the TagRule", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Get_MaximumSet_Gen": { + "$ref": "./examples/TagRules_Get_MaximumSet_Gen.json" + }, + "TagRules_Get_MinimumSet_Gen": { + "$ref": "./examples/TagRules_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_CreateOrUpdate", + "description": "Create a TagRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Name of the TagRule", + "type": "string" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/TagRule" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "headers": { + "Retry-After": { + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "type": "integer", + "format": "int32" + } + }, + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json" + }, + "TagRules_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_Delete", + "description": "Delete a TagRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Name of the TagRule", + "type": "string" + } + ], + "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" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/TagRules_Delete_MaximumSet_Gen.json" + }, + "TagRules_Delete_MinimumSet_Gen": { + "$ref": "./examples/TagRules_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_Update", + "description": "Update a TagRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Name of the TagRule", + "type": "string" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/TagRuleUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Update_MaximumSet_Gen": { + "$ref": "./examples/TagRules_Update_MaximumSet_Gen.json" + }, + "TagRules_Update_MinimumSet_Gen": { + "$ref": "./examples/TagRules_Update_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List the subscriptions currently being monitored by the NewRelic monitor resource.", + "operationId": "MonitoredSubscriptions_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" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "pattern": "^.*$", + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionPropertiesList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions/{configurationName}": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List the subscriptions currently being monitored by the NewRelic monitor resource.", + "operationId": "MonitoredSubscriptions_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" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "pattern": "^.*$", + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "Add the subscriptions that should be monitored by the NewRelic monitor resource.", + "operationId": "MonitoredSubscriptions_CreateorUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_AddMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_CreateorUpdate.json" + } + } + }, + "patch": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the NewRelic monitor resource", + "operationId": "MonitoredSubscriptions_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_UpdateMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the NewRelic monitor resource", + "operationId": "MonitoredSubscriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_DeleteMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listLinkedResources": { + "post": { + "tags": [ + "LinkedResources" + ], + "summary": "List all Azure resources associated to the same NewRelic organization and account as the target resource.", + "operationId": "Monitors_ListLinkedResources", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "pattern": "^.*$", + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LinkedResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListLinkedResources": { + "$ref": "./examples/LinkedResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/vmHostPayloads": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_VmHostPayload", + "description": "Returns the payload that needs to be passed in the request body for installing NewRelic agent on a VM.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VMExtensionPayload" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_VmHostPayload_MaximumSet_Gen": { + "$ref": "./examples/Monitors_VmHostPayload_MaximumSet_Gen.json" + }, + "Monitors_VmHostPayload_MinimumSet_Gen": { + "$ref": "./examples/Monitors_VmHostPayload_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AccountCreationSource": { + "type": "string", + "description": "Source of Account creation", + "enum": [ + "LIFTR", + "NEWRELIC" + ], + "x-ms-enum": { + "name": "AccountCreationSource", + "modelAsString": true, + "values": [ + { + "name": "LIFTR", + "value": "LIFTR", + "description": "Account is created from LIFTR" + }, + { + "name": "NEWRELIC", + "value": "NEWRELIC", + "description": "Account is created from NEWRELIC" + } + ] + } + }, + "AccountIdParameter": { + "type": "object", + "properties": {}, + "description": "Account Id parameter" + }, + "AccountInfo": { + "type": "object", + "properties": { + "accountId": { + "type": "string", + "description": "Account id" + }, + "ingestionKey": { + "$ref": "#/definitions/SecureString", + "description": "ingestion key of account" + }, + "region": { + "type": "string", + "description": "Region where New Relic account is present" + } + }, + "description": "Account Info of the NewRelic account" + }, + "AccountProperties": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "organization id" + }, + "accountId": { + "type": "string", + "description": "account id" + }, + "accountName": { + "type": "string", + "description": "account name" + }, + "region": { + "type": "string", + "description": "Region where New Relic account is present" + } + }, + "description": "List of all the New relic accounts for the given user" + }, + "AccountsListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccountResource" + }, + "x-cadl-name": "AccountResource[]", + "description": "The AccountResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of get all accounts Operation.", + "required": [ + "value" + ] + }, + "BillingInfoResponse": { + "description": "Marketplace Subscription and Organization details to which resource gets billed into.", + "type": "object", + "properties": { + "marketplaceSaasInfo": { + "description": "Marketplace Subscription details", + "$ref": "#/definitions/MarketplaceSaaSInfo" + }, + "partnerBillingEntity": { + "description": "Partner Billing Entity details: Organization Info", + "$ref": "#/definitions/PartnerBillingEntity" + } + } + }, + "MarketplaceSaaSInfo": { + "description": "Marketplace SAAS Info of the resource.", + "type": "object", + "properties": { + "marketplaceSubscriptionId": { + "description": "Marketplace Subscription Id. This is a GUID-formatted string.", + "type": "string" + }, + "marketplaceSubscriptionName": { + "description": "Marketplace Subscription Details: SAAS Name", + "type": "string" + }, + "marketplaceResourceId": { + "description": "Marketplace Subscription Details: Resource URI", + "type": "string" + }, + "marketplaceStatus": { + "description": "Marketplace Subscription Details: SaaS Subscription Status", + "type": "string" + }, + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into.", + "type": "string" + } + } + }, + "PartnerBillingEntity": { + "description": "Partner Billing details associated with the resource.", + "type": "object", + "properties": { + "organizationId": { + "description": "The New Relic Organization Id.", + "type": "string" + }, + "organizationName": { + "description": "The New Relic Organization Name.", + "type": "string" + } + } + }, + "ConnectedPartnerResourceProperties": { + "description": "Connected Partner Resource Properties", + "type": "object", + "properties": { + "accountName": { + "description": "NewRelic account name", + "type": "string" + }, + "accountId": { + "description": "NewRelic Account Id", + "type": "string" + }, + "azureResourceId": { + "description": "The azure resource Id of the deployment.", + "type": "string" + }, + "location": { + "description": "The location of the deployment.", + "type": "string" + } + } + }, + "ConnectedPartnerResourcesListFormat": { + "description": "Connected Partner Resources List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConnectedPartnerResourceProperties" + } + } + }, + "ConnectedPartnerResourcesListResponse": { + "description": " List of all active newrelic deployments.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectedPartnerResourcesListFormat" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "AccountResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "The details of a account resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "AppServiceInfo": { + "type": "object", + "properties": { + "azureResourceId": { + "type": "string", + "description": "Azure App service resource ID" + }, + "agentVersion": { + "type": "string", + "description": "Version of the NewRelic agent installed on the App service." + }, + "agentStatus": { + "type": "string", + "description": "Status of the NewRelic agent installed on the App service." + } + }, + "description": "Details of VM Resource having NewRelic OneAgent installed" + }, + "AppServicesGetParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/AppServicesGetRequest", + "description": "The details of the app services get request." + } + }, + "description": "App services Get Parameter specification.", + "required": [ + "request" + ] + }, + "SwitchBillingParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/SwitchBillingRequest", + "description": "The details of the switch billing request." + } + }, + "description": "Switch Billing Parameter specification.", + "required": [ + "request" + ] + }, + "SwitchBillingRequest": { + "type": "object", + "properties": { + "azureResourceId": { + "type": "string", + "description": "Azure resource Id" + }, + "organizationId": { + "type": "string", + "description": "Organization id" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of a switch billing Operation.", + "required": [ + "userEmail" + ] + }, + "AppServicesGetRequest": { + "type": "object", + "properties": { + "azureResourceIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Azure resource IDs" + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of a app services get Operation.", + "required": [ + "userEmail" + ] + }, + "AppServicesListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AppServiceInfo" + }, + "x-ms-identifiers": [ + "azureResourceId" + ], + "x-cadl-name": "AppServiceInfo[]", + "description": "The AppServiceInfo items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of a list app services Operation.", + "required": [ + "value" + ] + }, + "BillingCycle": { + "type": "string", + "description": "Different usage type like YEARLY/MONTHLY", + "enum": [ + "YEARLY", + "MONTHLY", + "WEEKLY" + ], + "x-ms-enum": { + "name": "BillingCycle", + "modelAsString": true, + "values": [ + { + "name": "YEARLY", + "value": "YEARLY", + "description": "Billing cycle is YEARLY" + }, + { + "name": "MONTHLY", + "value": "MONTHLY", + "description": "Billing cycle is MONTHLY" + }, + { + "name": "WEEKLY", + "value": "WEEKLY", + "description": "Billing cycle is WEEKLY" + } + ] + } + }, + "BillingSource": { + "type": "string", + "description": "Billing source", + "enum": [ + "AZURE", + "NEWRELIC" + ], + "x-ms-enum": { + "name": "BillingSource", + "modelAsString": true, + "values": [ + { + "name": "AZURE", + "value": "AZURE", + "description": "Billing source is Azure" + }, + { + "name": "NEWRELIC", + "value": "NEWRELIC" + } + ] + } + }, + "FilteringTag": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name (also known as the key) of the tag." + }, + "value": { + "type": "string", + "description": "The value of the tag." + }, + "action": { + "$ref": "#/definitions/TagAction", + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion." + } + }, + "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored." + }, + "HostsGetParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/HostsGetRequest", + "description": "The details of the Hosts get request." + } + }, + "description": "Host Get Parameter specification.", + "required": [ + "request" + ] + }, + "HostsGetRequest": { + "type": "object", + "properties": { + "vmIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "VM resource IDs" + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of a Hosts get Operation.", + "required": [ + "userEmail" + ] + }, + "LiftrResourceCategories": { + "type": "string", + "description": "Liftr Resource category.", + "enum": [ + "Unknown", + "MonitorLogs" + ], + "x-ms-enum": { + "name": "LiftrResourceCategories", + "modelAsString": true + } + }, + "LocationParameter": { + "type": "object", + "properties": {}, + "description": "Location for NewRelic resource" + }, + "LogRules": { + "type": "object", + "properties": { + "sendAadLogs": { + "$ref": "#/definitions/SendAadLogsStatus", + "description": "Flag specifying if AAD logs should be sent for the Monitor resource." + }, + "sendSubscriptionLogs": { + "$ref": "#/definitions/SendSubscriptionLogsStatus", + "description": "Flag specifying if subscription logs should be sent for the Monitor resource." + }, + "sendActivityLogs": { + "$ref": "#/definitions/SendActivityLogsStatus", + "description": "Flag specifying if activity logs from Azure resources should be sent for the Monitor resource." + }, + "filteringTags": { + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + }, + "x-ms-identifiers": [], + "x-cadl-name": "FilteringTag[]", + "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured.\nIf only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags." + } + }, + "description": "Set of rules for sending logs for the Monitor resource." + }, + "MarketplaceSubscriptionStatus": { + "type": "string", + "description": "Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.", + "enum": [ + "Active", + "Suspended" + ], + "x-ms-enum": { + "name": "MarketplaceSubscriptionStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "monitoring is enabled" + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "monitoring is disabled" + } + ] + } + }, + "MetricRules": { + "type": "object", + "properties": { + "sendMetrics": { + "$ref": "#/definitions/SendMetricsStatus", + "description": "Flag specifying if metrics should be sent for the Monitor resource." + }, + "filteringTags": { + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + }, + "x-ms-identifiers": [], + "x-cadl-name": "FilteringTag[]", + "description": "List of filtering tags to be used for capturing metrics." + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Set of rules for sending metrics for the Monitor resource." + }, + "MetricsRequest": { + "type": "object", + "properties": { + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of get metrics Operation.", + "required": [ + "userEmail" + ] + }, + "MetricsRequestParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/MetricsRequest", + "description": "The details of the get metrics status request." + } + }, + "description": "Get Metrics Status Parameter specification.", + "required": [ + "request" + ] + }, + "MetricsStatusRequest": { + "type": "object", + "properties": { + "azureResourceIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Azure resource IDs" + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of get metrics status Operation.", + "required": [ + "userEmail" + ] + }, + "MetricsStatusRequestParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/MetricsStatusRequest", + "description": "The details of the get metrics status request." + } + }, + "description": "Get Metrics Status Parameter specification.", + "required": [ + "request" + ] + }, + "MetricsStatusResponse": { + "type": "object", + "properties": { + "azureResourceIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Azure resource IDs" + } + }, + "description": "Response of get metrics status Operation." + }, + "MonitorProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + }, + "monitoringStatus": { + "$ref": "#/definitions/MonitoringStatus", + "description": "MonitoringStatus of the resource", + "readOnly": true + }, + "marketplaceSubscriptionStatus": { + "$ref": "#/definitions/MarketplaceSubscriptionStatus", + "description": "NewRelic Organization properties of the resource", + "readOnly": true + }, + "marketplaceSubscriptionId": { + "type": "string", + "description": "Marketplace Subscription Id", + "readOnly": true + }, + "newRelicAccountProperties": { + "$ref": "#/definitions/NewRelicAccountProperties", + "description": "MarketplaceSubscriptionStatus of the resource" + }, + "userInfo": { + "$ref": "#/definitions/UserInfo", + "description": "User Info" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories", + "description": "Liftr resource category", + "readOnly": true + }, + "liftrResourcePreference": { + "type": "integer", + "format": "int32", + "description": "Liftr resource preference. The priority of the resource.", + "readOnly": true + }, + "orgCreationSource": { + "$ref": "#/definitions/OrgCreationSource", + "description": "Source of org creation" + }, + "accountCreationSource": { + "$ref": "#/definitions/AccountCreationSource", + "description": "Source of account creation" + }, + "subscriptionState": { + "description": "State of the Azure Subscription containing the monitor resource", + "type": "string" + }, + "saaSAzureSubscriptionStatus": { + "description": "Status of Azure Subscription where Marketplace SaaS is located.", + "type": "string" + } + }, + "description": "Properties specific to the NewRelic Monitor resource" + }, + "MonitoredResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM id of the resource." + }, + "sendingMetrics": { + "$ref": "#/definitions/SendingMetricsStatus", + "description": "Flag indicating if resource is sending metrics to NewRelic." + }, + "reasonForMetricsStatus": { + "type": "string", + "description": "Reason for why the resource is sending metrics (or why it is not sending)." + }, + "sendingLogs": { + "$ref": "#/definitions/SendingLogsStatus", + "description": "Flag indicating if resource is sending logs to NewRelic." + }, + "reasonForLogsStatus": { + "type": "string", + "description": "Reason for why the resource is sending logs (or why it is not sending)." + } + }, + "description": "Details of resource being monitored by NewRelic monitor resource" + }, + "MonitoredResourceListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredResource" + }, + "x-cadl-name": "MonitoredResource[]", + "description": "The MonitoredResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "List of all the resources being monitored by NewRelic monitor resource", + "required": [ + "value" + ] + }, + "MonitoringStatus": { + "type": "string", + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "MonitoringStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "monitoring is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "monitoring is disabled" + } + ] + } + }, + "MonitoringTagRulesProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + }, + "logRules": { + "$ref": "#/definitions/LogRules", + "description": "Set of rules for sending logs for the Monitor resource." + }, + "metricRules": { + "$ref": "#/definitions/MetricRules", + "description": "Set of rules for sending metrics for the Monitor resource." + } + }, + "description": "The resource-specific properties for this resource." + }, + "NewRelicAccountProperties": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User id" + }, + "accountInfo": { + "$ref": "#/definitions/AccountInfo", + "description": "NewRelic Account Information" + }, + "organizationInfo": { + "$ref": "#/definitions/OrganizationInfo", + "description": "NewRelic Organization Information" + }, + "singleSignOnProperties": { + "$ref": "#/definitions/NewRelicSingleSignOnProperties", + "description": "date when plan was applied" + } + }, + "description": "Properties of the NewRelic account" + }, + "NewRelicMonitorResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MonitorProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "description": "A Monitor Resource by NewRelic", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "NewRelicMonitorResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NewRelicMonitorResource" + }, + "x-cadl-name": "NewRelicMonitorResource[]", + "description": "The NewRelicMonitorResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "The response of a NewRelicMonitorResource list operation.", + "required": [ + "value" + ] + }, + "NewRelicMonitorResourceUpdate": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-cadl-name": "Record", + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/NewRelicMonitorResourceUpdateProperties", + "x-ms-client-flatten": true + } + }, + "description": "The type used for update operations of the NewRelicMonitorResource." + }, + "NewRelicMonitorResourceUpdateProperties": { + "type": "object", + "properties": { + "newRelicAccountProperties": { + "$ref": "#/definitions/NewRelicAccountProperties", + "description": "MarketplaceSubscriptionStatus of the resource" + }, + "userInfo": { + "$ref": "#/definitions/UserInfo", + "description": "User Info" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "orgCreationSource": { + "$ref": "#/definitions/OrgCreationSource", + "description": "Source of org creation" + }, + "accountCreationSource": { + "$ref": "#/definitions/AccountCreationSource", + "description": "Source of account creation" + } + }, + "description": "The updatable properties of the NewRelicMonitorResource." + }, + "NewRelicSingleSignOnProperties": { + "type": "object", + "properties": { + "singleSignOnState": { + "$ref": "#/definitions/SingleSignOnStates", + "description": "Single sign-on state" + }, + "enterpriseAppId": { + "type": "string", + "description": "The Id of the Enterprise App used for Single sign-on." + }, + "singleSignOnUrl": { + "type": "string", + "description": "The login URL specific to this NewRelic Organization" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state" + } + }, + "description": "Single sign on Info of the NewRelic account" + }, + "OrgCreationSource": { + "type": "string", + "description": "Source of Org creation", + "enum": [ + "LIFTR", + "NEWRELIC" + ], + "x-ms-enum": { + "name": "OrgCreationSource", + "modelAsString": true, + "values": [ + { + "name": "LIFTR", + "value": "LIFTR", + "description": "Org is created from LIFTR" + }, + { + "name": "NEWRELIC", + "value": "NEWRELIC", + "description": "Org is created from NEWRELIC" + } + ] + } + }, + "OrganizationIdParameter": { + "type": "object", + "properties": {}, + "description": "Organization Id parameter" + }, + "OrganizationInfo": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Organization id" + } + }, + "description": "Organization Info of the NewRelic account" + }, + "OrganizationProperties": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "organization id" + }, + "organizationName": { + "type": "string", + "description": "organization name" + }, + "billingSource": { + "$ref": "#/definitions/BillingSource", + "description": "Billing source" + } + }, + "description": "Details of Organizations" + }, + "OrganizationsListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OrganizationResource" + }, + "x-cadl-name": "OrganizationResource[]", + "description": "The OrganizationResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of get all organizations Operation.", + "required": [ + "value" + ] + }, + "OrganizationResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/OrganizationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "The details of a Organization resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PlanData": { + "type": "object", + "properties": { + "usageType": { + "$ref": "#/definitions/UsageType", + "description": "Different usage type like PAYG/COMMITTED. this could be enum" + }, + "billingCycle": { + "$ref": "#/definitions/BillingCycle", + "description": "Different billing cycles like MONTHLY/WEEKLY. this could be enum" + }, + "planDetails": { + "type": "string", + "description": "plan id as published by NewRelic" + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "date when plan was applied" + } + }, + "description": "Plan data of NewRelic Monitor resource" + }, + "PlanDataResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PlanDataProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "The details of a PlanData resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PlanDataListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PlanDataResource" + }, + "x-cadl-name": "PlanDataResource[]", + "description": "The PlanDataResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of get all plan data Operation.", + "required": [ + "value" + ] + }, + "PlanDataProperties": { + "type": "object", + "properties": { + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "orgCreationSource": { + "$ref": "#/definitions/OrgCreationSource", + "description": "Source of org creation" + }, + "accountCreationSource": { + "$ref": "#/definitions/AccountCreationSource", + "description": "Source of account creation" + } + }, + "description": "Plan details" + }, + "MonitoredSubscription": { + "description": "The list of subscriptions and it's monitoring status by current NewRelic monitor.", + "type": "object", + "properties": { + "subscriptionId": { + "description": "The subscriptionId to be monitored.", + "required": [ + "subscriptionId" + ], + "type": "string" + }, + "status": { + "description": "The state of monitoring.", + "enum": [ + "InProgress", + "Active", + "Failed", + "Deleting" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "Status" + }, + "type": "string" + }, + "error": { + "description": "The reason of not monitoring the subscription.", + "type": "string" + }, + "tagRules": { + "$ref": "#/definitions/MonitoringTagRulesProperties" + } + } + }, + "SubscriptionList": { + "description": "The request to update subscriptions needed to be monitored by the NewRelic monitor resource.", + "type": "object", + "properties": { + "patchOperation": { + "description": "The operation for the patch on the resource.", + "enum": [ + "AddBegin", + "AddComplete", + "DeleteBegin", + "DeleteComplete", + "Active" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "PatchOperation" + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "monitoredSubscriptionList": { + "description": "List of subscriptions and the state of the monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscription" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + } + } + }, + "MonitoredSubscriptionProperties": { + "description": "The request to update subscriptions needed to be monitored by the NewRelic monitor resource.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SubscriptionList" + } + } + }, + "MonitoredSubscriptionPropertiesList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + } + }, + "LinkedResource": { + "description": "The definition of a linked resource.", + "type": "object", + "properties": { + "id": { + "description": "The ARM id of the linked resource.", + "type": "string" + } + } + }, + "LinkedResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LinkedResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning State of the Monitor resource", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Accepted", + "value": "Accepted", + "description": "Monitor resource creation request accepted" + }, + { + "name": "Creating", + "value": "Creating", + "description": "Monitor resource creation started" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Monitor resource is being updated" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Monitor resource deletion started" + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Monitor resource creation successful" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Monitor resource creation failed" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Monitor resource creation canceled" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Monitor resource is deleted" + }, + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "Monitor resource state is unknown" + } + ] + } + }, + "SecureString": { + "type": "string", + "description": "Credential string.", + "format": "password", + "x-ms-secret": true + }, + "SendAadLogsStatus": { + "type": "string", + "description": "Indicates whether AAD logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendAadLogsStatus", + "modelAsString": true + } + }, + "SendActivityLogsStatus": { + "type": "string", + "description": "Indicates whether activity logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendActivityLogsStatus", + "modelAsString": true + } + }, + "SendMetricsStatus": { + "type": "string", + "description": "Indicates whether metrics are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendMetricsStatus", + "modelAsString": true + } + }, + "SendSubscriptionLogsStatus": { + "type": "string", + "description": "Indicates whether subscription logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendSubscriptionLogsStatus", + "modelAsString": true + } + }, + "SendingLogsStatus": { + "type": "string", + "description": "Indicates whether logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendingLogsStatus", + "modelAsString": true + } + }, + "SendingMetricsStatus": { + "type": "string", + "description": "Indicates whether metrics are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendingMetricsStatus", + "modelAsString": true + } + }, + "SingleSignOnStates": { + "type": "string", + "description": "Various states of the SSO resource", + "enum": [ + "Initial", + "Enable", + "Disable", + "Existing" + ], + "x-ms-enum": { + "name": "SingleSignOnStates", + "modelAsString": true + } + }, + "TagAction": { + "type": "string", + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion.", + "enum": [ + "Include", + "Exclude" + ], + "x-ms-enum": { + "name": "TagAction", + "modelAsString": true + } + }, + "TagRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MonitoringTagRulesProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "A tag rule belonging to NewRelic account", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "TagRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagRule" + }, + "x-cadl-name": "TagRule[]", + "description": "The TagRule items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "The response of a TagRule list operation.", + "required": [ + "value" + ] + }, + "TagRuleUpdate": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TagRuleUpdateProperties", + "x-ms-client-flatten": true + } + }, + "description": "The type used for update operations of the TagRule." + }, + "TagRuleUpdateProperties": { + "type": "object", + "properties": { + "logRules": { + "$ref": "#/definitions/LogRules", + "description": "Set of rules for sending logs for the Monitor resource." + }, + "metricRules": { + "$ref": "#/definitions/MetricRules", + "description": "Set of rules for sending metrics for the Monitor resource." + } + }, + "description": "The updatable properties of the TagRule." + }, + "UsageType": { + "type": "string", + "description": "Different usage type like PAYG/COMMITTED", + "enum": [ + "PAYG", + "COMMITTED" + ], + "x-ms-enum": { + "name": "UsageType", + "modelAsString": true, + "values": [ + { + "name": "PAYG", + "value": "PAYG", + "description": "Usage type is PAYG" + }, + { + "name": "COMMITTED", + "value": "COMMITTED", + "description": "Usage type is COMMITTED" + } + ] + } + }, + "UserEmailParameter": { + "type": "object", + "properties": {}, + "description": "User email specification." + }, + "UserInfo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "First name", + "maxLength": 50 + }, + "lastName": { + "type": "string", + "description": "Last name", + "maxLength": 50 + }, + "emailAddress": { + "$ref": "#/definitions/email", + "description": "User Email" + }, + "phoneNumber": { + "type": "string", + "description": "Contact phone number", + "maxLength": 40 + }, + "country": { + "type": "string", + "description": "country if user" + } + }, + "description": "User Info of NewRelic Monitor resource" + }, + "VMExtensionPayload": { + "type": "object", + "properties": { + "ingestionKey": { + "type": "string", + "description": "Ingestion key of the account" + } + }, + "description": "Response of payload to be passed while installing VM agent." + }, + "VMHostsListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VMInfo" + }, + "x-ms-identifiers": [], + "x-cadl-name": "VMInfo[]", + "description": "The VMInfo items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of a list VM Host Operation.", + "required": [ + "value" + ] + }, + "VMInfo": { + "type": "object", + "properties": { + "vmId": { + "type": "string", + "description": "Azure VM resource ID" + }, + "agentVersion": { + "type": "string", + "description": "Version of the NewRelic agent installed on the VM." + }, + "agentStatus": { + "type": "string", + "description": "Status of the NewRelic agent installed on the VM." + } + }, + "description": "Details of VM Resource having NewRelic OneAgent installed" + }, + "email": { + "type": "string", + "description": "Reusable representation of an email address", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" + } + }, + "parameters": { + "AccountIdParameter": { + "name": "accountId", + "in": "query", + "required": false, + "description": "Account Id.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "AppServicesGetParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the app services get request.", + "schema": { + "$ref": "#/definitions/AppServicesGetRequest" + }, + "x-ms-parameter-location": "method" + }, + "SwitchBillingParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the switch billing request.", + "schema": { + "$ref": "#/definitions/SwitchBillingRequest" + }, + "x-ms-parameter-location": "method" + }, + "HostsGetParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the Hosts get request.", + "schema": { + "$ref": "#/definitions/HostsGetRequest" + }, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "query", + "required": true, + "description": "Location for NewRelic.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "MetricsRequestParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the get metrics status request.", + "schema": { + "$ref": "#/definitions/MetricsRequest" + }, + "x-ms-parameter-location": "method" + }, + "MetricsStatusRequestParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the get metrics status request.", + "schema": { + "$ref": "#/definitions/MetricsStatusRequest" + }, + "x-ms-parameter-location": "method" + }, + "OrganizationIdParameter": { + "name": "organizationId", + "in": "query", + "required": false, + "description": "Organization Id.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "UserEmailParameter": { + "name": "userEmail", + "in": "query", + "required": true, + "description": "User Email.", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Accounts_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Accounts_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..769429128c21 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Accounts_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "operationId": "Accounts_List", + "title": "Accounts_List_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "location": "egh" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "organizationId": "wvdclwi", + "accountId": "igmdjq", + "accountName": "accname", + "region": "xnsylopqwcggudcln" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Accounts_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Accounts_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..0a63464c8d56 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Accounts_List_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "operationId": "Accounts_List", + "title": "Accounts_List_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "location": "egh" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/BillingInfo_Get.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/BillingInfo_Get.json new file mode 100644 index 000000000000..83d4780853fc --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/BillingInfo_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "marketplaceSubscriptionId": "12345678-1234-1234-1234-123456789012", + "marketplaceSubscriptionName": "AzNewRelic_b1190c8f", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzNewRelic_b1190c8f", + "marketplaceStatus": "Active", + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "partnerBillingEntity": { + "organizationId": "1234567890", + "organizationName": "NROrganizationName" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/ConnectedPartnerResources_List.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/ConnectedPartnerResources_List.json new file mode 100644 index 000000000000..3700c09f9623 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/ConnectedPartnerResources_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "accountName": "accountName", + "accountId": "1156243", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "location": "West US 2" + } + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/LinkedResources_List.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/LinkedResources_List.json new file mode 100644 index 000000000000..da3d375b760e --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/LinkedResources_List.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_CreateorUpdate.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_CreateorUpdate.json new file mode 100644 index 000000000000..ad1eaa2d20a5 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_CreateorUpdate.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "requestBody": { + "properties": { + "operation": "AddBegin", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_Delete.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_Delete.json new file mode 100644 index 000000000000..ae76e385ac52 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/NewRelic.Observability/monitors/test?api-version=2024-01-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_Get.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_Get.json new file mode 100644 index 000000000000..677c08748078 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_Get.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_List.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_List.json new file mode 100644 index 000000000000..321d1d42a398 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_List.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_Update.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_Update.json new file mode 100644 index 000000000000..0984b41ff9d4 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/MonitoredSubscriptions_Update.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "requestBody": { + "properties": { + "operation": "AddComplete", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/NewRelic.Observability/monitors/test?api-version=2024-01-01-preview" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..33b1e9e59d69 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,209 @@ +{ + "operationId": "Monitors_CreateOrUpdate", + "title": "Monitors_CreateOrUpdate_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "cdlymktqw", + "resource": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "ingestionKey": "wltnimmhqt", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR", + "subscriptionState": "Suspended", + "saaSAzureSubscriptionStatus": "Subscribed" + }, + "identity": { + "type": "None", + "userAssignedIdentities": { + "key8903": {} + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR", + "subscriptionState": "Suspended", + "saaSAzureSubscriptionStatus": "Subscribed" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR", + "subscriptionState": "Suspended", + "saaSAzureSubscriptionStatus": "Subscribed" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a1ec3fc078fd --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "Monitors_Delete", + "title": "Monitors_Delete_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..ed7ee01ca7ea --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "Monitors_Delete", + "title": "Monitors_Delete_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json new file mode 100644 index 000000000000..da4a43951864 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "operationId": "Monitors_GetMetricRules", + "title": "Monitors_GetMetricRules_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "sendMetrics": "Enabled", + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "qnvixg", + "value": "ihyabcsjvhkfzckfjvgvtlhdyvmwge", + "action": "Include" + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json new file mode 100644 index 000000000000..7edf53678e3b --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "operationId": "Monitors_GetMetricRules", + "title": "Monitors_GetMetricRules_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "sendMetrics": "Disabled", + "filteringTags": [], + "userEmail": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..ab968089972f --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "operationId": "Monitors_GetMetricStatus", + "title": "Monitors_GetMetricStatus_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json new file mode 100644 index 000000000000..ae28916c6fc3 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "operationId": "Monitors_GetMetricStatus", + "title": "Monitors_GetMetricStatus_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "azureResourceIds": [] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Get_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..d7e267317e73 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Get_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "operationId": "Monitors_Get", + "title": "Monitors_Get_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "cdlymktqw" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json new file mode 100644 index 000000000000..56464a085b01 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "operationId": "Monitors_ListAppServices", + "title": "Monitors_ListAppServices_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", + "agentVersion": "owxkssnbp", + "agentStatus": "vclwfecbppsfaygdccfu" + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json new file mode 100644 index 000000000000..bd6941e618be --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "operationId": "Monitors_ListAppServices", + "title": "Monitors_ListAppServices_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..b08b37d466d4 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "operationId": "Monitors_ListByResourceGroup", + "title": "Monitors_ListByResourceGroup_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..cf5895153d2a --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "operationId": "Monitors_ListBySubscription", + "title": "Monitors_ListBySubscription_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json new file mode 100644 index 000000000000..5e9c855e8991 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "operationId": "Monitors_ListHosts", + "title": "Monitors_ListHosts_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "request": { + "vmIds": [ + "xzphvxvfmvjrnsgyns" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vmId": "gwyoa", + "agentVersion": "tbinulnoozxnbr", + "agentStatus": "psnjslxwuwtviwzzgqhyzynuxvz" + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json new file mode 100644 index 000000000000..1708445ab63c --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "operationId": "Monitors_ListHosts", + "title": "Monitors_ListHosts_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "request": { + "vmIds": [ + "xzphvxvfmvjrnsgyns" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json new file mode 100644 index 000000000000..a44eadaac010 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "operationId": "Monitors_ListMonitoredResources", + "title": "Monitors_ListMonitoredResources_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "sendingMetrics": "Enabled", + "reasonForMetricsStatus": "k", + "sendingLogs": "Enabled", + "reasonForLogsStatus": "agzxviwuxgr" + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json new file mode 100644 index 000000000000..23438f2506e8 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "operationId": "Monitors_ListMonitoredResources", + "title": "Monitors_ListMonitoredResources_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json new file mode 100644 index 000000000000..1864e1e2310b --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "operationId": "Monitors_SwitchBilling", + "title": "Monitors_SwitchBilling_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", + "organizationId": "k", + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json new file mode 100644 index 000000000000..9472a791856b --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "operationId": "Monitors_SwitchBilling", + "title": "Monitors_SwitchBilling_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Update_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..4812d90d4348 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_Update_MaximumSet_Gen.json @@ -0,0 +1,126 @@ +{ + "operationId": "Monitors_Update", + "title": "Monitors_Update_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "cdlymktqw", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key8903": {} + } + }, + "tags": { + "key164": "jqakdrrmmyzytqu" + }, + "properties": { + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "ingestionKey": "wltnimmhqt", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json new file mode 100644 index 000000000000..9849889c6753 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Monitors_VmHostPayload", + "title": "Monitors_VmHostPayload_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "ingestionKey": "ltqewhfexphvqgttoevaywrl" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json new file mode 100644 index 000000000000..36765397dfda --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Monitors_VmHostPayload", + "title": "Monitors_VmHostPayload_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "ingestionKey": "ltqewhfexphvqgttoevaywrl" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..8e6697fe72b8 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "operationId": "Operations_List", + "title": "Operations_List_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "zhlrjcljiysnufaerhpzg", + "isDataAction": true, + "display": { + "provider": "v", + "resource": "w", + "operation": "ybyzweygkffbydgaowg", + "description": "sekhimcuecttketh" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Operations_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..b25747c1d5ba --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "operationId": "Operations_List", + "title": "Operations_List_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Organizations_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Organizations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..187a85cec1cb --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Organizations_List_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "operationId": "Organizations_List", + "title": "Organizations_List_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "location": "egh" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "organizationId": "tjmcifofzirili", + "organizationName": "orgname", + "billingSource": "AZURE" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Organizations_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Organizations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..a128a9455bd3 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Organizations_List_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Organizations_List", + "title": "Organizations_List_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "location": "egh" + }, + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Plans_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Plans_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..752af8e35e4a --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Plans_List_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "operationId": "Plans_List", + "title": "Plans_List_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "accountId": "pwuxgvrmkk", + "organizationId": "hilawwjz" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Plans_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Plans_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..dbf769d648c8 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/Plans_List_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "operationId": "Plans_List", + "title": "Plans_List_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "organizationId": "hilawwjz" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "orgCreationSource": "NEWRELIC" + } + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..6fd8876d7985 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,121 @@ +{ + "operationId": "TagRules_CreateOrUpdate", + "title": "TagRules_CreateOrUpdate_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "resource": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..652d1840741a --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "operationId": "TagRules_CreateOrUpdate", + "title": "TagRules_CreateOrUpdate_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "resource": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..6476f22c6f39 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "TagRules_Delete", + "title": "TagRules_Delete_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..27c23640ad3e --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "TagRules_Delete", + "title": "TagRules_Delete_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Get_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b5731fccc205 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Get_MaximumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "operationId": "TagRules_Get", + "title": "TagRules_Get_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Get_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..c515bb1cb53f --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "operationId": "TagRules_Get", + "title": "TagRules_Get_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..eec551e092ce --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "operationId": "TagRules_ListByNewRelicMonitorResource", + "title": "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json new file mode 100644 index 000000000000..1fc42c6b11d4 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "operationId": "TagRules_ListByNewRelicMonitorResource", + "title": "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Update_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..f174c1a09e4d --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Update_MaximumSet_Gen.json @@ -0,0 +1,79 @@ +{ + "operationId": "TagRules_Update", + "title": "TagRules_Update_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "properties": { + "properties": { + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Update_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..ccf699186fce --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/examples/TagRules_Update_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "TagRules_Update", + "title": "TagRules_Update_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "properties": {} + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/NewRelic.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/NewRelic.json new file mode 100644 index 000000000000..f207dd1e814f --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/NewRelic.json @@ -0,0 +1,3432 @@ +{ + "swagger": "2.0", + "info": { + "title": "NewRelic.Observability", + "version": "2024-01-01", + "x-cadl-generated": [ + { + "emitter": "@azure-tools/cadl-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Microsoft Entra ID OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Monitors" + }, + { + "name": "Accounts" + }, + { + "name": "Organizations" + }, + { + "name": "Plan" + }, + { + "name": "TagRules" + } + ], + "paths": { + "/providers/NewRelic.Observability/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "List the operations for the provider", + "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" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet_Gen": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_List", + "description": "List all the existing accounts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/UserEmailParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountsListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Accounts_List_MaximumSet_Gen": { + "$ref": "./examples/Accounts_List_MaximumSet_Gen.json" + }, + "Accounts_List_MinimumSet_Gen": { + "$ref": "./examples/Accounts_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/monitors": { + "get": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListBySubscription", + "description": "List NewRelicMonitorResource resources by subscription ID", + "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/NewRelicMonitorResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/organizations": { + "get": { + "tags": [ + "Organizations" + ], + "operationId": "Organizations_List", + "description": "List all the existing organizations", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/UserEmailParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationsListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Organizations_List_MaximumSet_Gen": { + "$ref": "./examples/Organizations_List_MaximumSet_Gen.json" + }, + "Organizations_List_MinimumSet_Gen": { + "$ref": "./examples/Organizations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/plans": { + "get": { + "tags": [ + "Plan" + ], + "operationId": "Plans_List", + "description": "List plans data", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccountIdParameter" + }, + { + "$ref": "#/parameters/OrganizationIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PlanDataListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Plans_List_MaximumSet_Gen": { + "$ref": "./examples/Plans_List_MaximumSet_Gen.json" + }, + "Plans_List_MinimumSet_Gen": { + "$ref": "./examples/Plans_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors": { + "get": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListByResourceGroup", + "description": "List NewRelicMonitorResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}": { + "get": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_Get", + "description": "Get a NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Get_MaximumSet_Gen": { + "$ref": "./examples/Monitors_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_CreateOrUpdate", + "description": "Create a NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "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/NewRelicMonitorResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_Update", + "description": "Update a NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Update_MaximumSet_Gen": { + "$ref": "./examples/Monitors_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_Delete", + "description": "Delete a NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/UserEmailParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "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" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Delete_MaximumSet_Gen": { + "$ref": "./examples/Monitors_Delete_MaximumSet_Gen.json" + }, + "Monitors_Delete_MinimumSet_Gen": { + "$ref": "./examples/Monitors_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getMetricRules": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_GetMetricRules", + "description": "Get metric rules", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/MetricsRequestParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MetricRules" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMetricRules_MaximumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricRules_MaximumSet_Gen.json" + }, + "Monitors_GetMetricRules_MinimumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricRules_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getMetricStatus": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_GetMetricStatus", + "description": "Get metric 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" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/MetricsStatusRequestParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MetricsStatusResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMetricStatus_MaximumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricStatus_MaximumSet_Gen.json" + }, + "Monitors_GetMetricStatus_MinimumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listAppServices": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListAppServices", + "description": "List the app service resources currently being monitored by the NewRelic resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/AppServicesGetParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppServicesListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListAppServices_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListAppServices_MaximumSet_Gen.json" + }, + "Monitors_ListAppServices_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListAppServices_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/switchBilling": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_SwitchBilling", + "description": "Switches the billing for NewRelic monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/SwitchBillingParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_SwitchBilling_MaximumSet_Gen": { + "$ref": "./examples/Monitors_SwitchBilling_MaximumSet_Gen.json" + }, + "Monitors_SwitchBilling_MinimumSet_Gen": { + "$ref": "./examples/Monitors_SwitchBilling_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listHosts": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListHosts", + "description": "List the compute vm resources currently being monitored by the NewRelic resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/HostsGetParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VMHostsListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListHosts_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListHosts_MaximumSet_Gen.json" + }, + "Monitors_ListHosts_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListHosts_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredResources": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListMonitoredResources", + "description": "List the resources currently being monitored by the NewRelic monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitoredResourceListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListMonitoredResources_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json" + }, + "Monitors_ListMonitoredResources_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getBillingInfo": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "Get marketplace info mapped to the given monitor.", + "operationId": "BillingInfo_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" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BillingInfoResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingInfo_Get": { + "$ref": "./examples/BillingInfo_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listConnectedPartnerResources": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "List of all active deployments that are associated with the marketplace subscription linked to the given monitor.", + "operationId": "ConnectedPartnerResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "Email Id of the user", + "schema": { + "$ref": "#/definitions/email" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ConnectedPartnerResourcesListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConnectedPartnerResources_List": { + "$ref": "./examples/ConnectedPartnerResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/tagRules": { + "get": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_ListByNewRelicMonitorResource", + "description": "List TagRule resources by NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen": { + "$ref": "./examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json" + }, + "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen": { + "$ref": "./examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/tagRules/{ruleSetName}": { + "get": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_Get", + "description": "Get a TagRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Name of the TagRule", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Get_MaximumSet_Gen": { + "$ref": "./examples/TagRules_Get_MaximumSet_Gen.json" + }, + "TagRules_Get_MinimumSet_Gen": { + "$ref": "./examples/TagRules_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_CreateOrUpdate", + "description": "Create a TagRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Name of the TagRule", + "type": "string" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/TagRule" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "headers": { + "Retry-After": { + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "type": "integer", + "format": "int32" + } + }, + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json" + }, + "TagRules_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_Delete", + "description": "Delete a TagRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Name of the TagRule", + "type": "string" + } + ], + "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" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/TagRules_Delete_MaximumSet_Gen.json" + }, + "TagRules_Delete_MinimumSet_Gen": { + "$ref": "./examples/TagRules_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_Update", + "description": "Update a TagRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Name of the TagRule", + "type": "string" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/TagRuleUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Update_MaximumSet_Gen": { + "$ref": "./examples/TagRules_Update_MaximumSet_Gen.json" + }, + "TagRules_Update_MinimumSet_Gen": { + "$ref": "./examples/TagRules_Update_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List the subscriptions currently being monitored by the NewRelic monitor resource.", + "operationId": "MonitoredSubscriptions_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" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "pattern": "^.*$", + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionPropertiesList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions/{configurationName}": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List the subscriptions currently being monitored by the NewRelic monitor resource.", + "operationId": "MonitoredSubscriptions_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" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "pattern": "^.*$", + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "Add the subscriptions that should be monitored by the NewRelic monitor resource.", + "operationId": "MonitoredSubscriptions_CreateorUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_AddMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_CreateorUpdate.json" + } + } + }, + "patch": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the NewRelic monitor resource", + "operationId": "MonitoredSubscriptions_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_UpdateMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the NewRelic monitor resource", + "operationId": "MonitoredSubscriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_DeleteMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listLinkedResources": { + "post": { + "tags": [ + "LinkedResources" + ], + "summary": "List all Azure resources associated to the same NewRelic organization and account as the target resource.", + "operationId": "Monitors_ListLinkedResources", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "pattern": "^.*$", + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LinkedResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListLinkedResources": { + "$ref": "./examples/LinkedResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/vmHostPayloads": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_VmHostPayload", + "description": "Returns the payload that needs to be passed in the request body for installing NewRelic agent on a VM.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VMExtensionPayload" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_VmHostPayload_MaximumSet_Gen": { + "$ref": "./examples/Monitors_VmHostPayload_MaximumSet_Gen.json" + }, + "Monitors_VmHostPayload_MinimumSet_Gen": { + "$ref": "./examples/Monitors_VmHostPayload_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AccountCreationSource": { + "type": "string", + "description": "Source of Account creation", + "enum": [ + "LIFTR", + "NEWRELIC" + ], + "x-ms-enum": { + "name": "AccountCreationSource", + "modelAsString": true, + "values": [ + { + "name": "LIFTR", + "value": "LIFTR", + "description": "Account is created from LIFTR" + }, + { + "name": "NEWRELIC", + "value": "NEWRELIC", + "description": "Account is created from NEWRELIC" + } + ] + } + }, + "AccountIdParameter": { + "type": "object", + "properties": {}, + "description": "Account Id parameter" + }, + "AccountInfo": { + "type": "object", + "properties": { + "accountId": { + "type": "string", + "description": "Account id" + }, + "ingestionKey": { + "$ref": "#/definitions/SecureString", + "description": "ingestion key of account" + }, + "region": { + "type": "string", + "description": "Region where New Relic account is present" + } + }, + "description": "Account Info of the NewRelic account" + }, + "AccountProperties": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "organization id" + }, + "accountId": { + "type": "string", + "description": "account id" + }, + "accountName": { + "type": "string", + "description": "account name" + }, + "region": { + "type": "string", + "description": "Region where New Relic account is present" + } + }, + "description": "List of all the New relic accounts for the given user" + }, + "AccountsListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccountResource" + }, + "x-cadl-name": "AccountResource[]", + "description": "The AccountResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of get all accounts Operation.", + "required": [ + "value" + ] + }, + "BillingInfoResponse": { + "description": "Marketplace Subscription and Organization details to which resource gets billed into.", + "type": "object", + "properties": { + "marketplaceSaasInfo": { + "description": "Marketplace Subscription details", + "$ref": "#/definitions/MarketplaceSaaSInfo" + }, + "partnerBillingEntity": { + "description": "Partner Billing Entity details: Organization Info", + "$ref": "#/definitions/PartnerBillingEntity" + } + } + }, + "MarketplaceSaaSInfo": { + "description": "Marketplace SAAS Info of the resource.", + "type": "object", + "properties": { + "marketplaceSubscriptionId": { + "description": "Marketplace Subscription Id. This is a GUID-formatted string.", + "type": "string" + }, + "marketplaceSubscriptionName": { + "description": "Marketplace Subscription Details: SAAS Name", + "type": "string" + }, + "marketplaceResourceId": { + "description": "Marketplace Subscription Details: Resource URI", + "type": "string" + }, + "marketplaceStatus": { + "description": "Marketplace Subscription Details: SaaS Subscription Status", + "type": "string" + }, + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into.", + "type": "string" + } + } + }, + "PartnerBillingEntity": { + "description": "Partner Billing details associated with the resource.", + "type": "object", + "properties": { + "organizationId": { + "description": "The New Relic Organization Id.", + "type": "string" + }, + "organizationName": { + "description": "The New Relic Organization Name.", + "type": "string" + } + } + }, + "ConnectedPartnerResourceProperties": { + "description": "Connected Partner Resource Properties", + "type": "object", + "properties": { + "accountName": { + "description": "NewRelic account name", + "type": "string" + }, + "accountId": { + "description": "NewRelic Account Id", + "type": "string" + }, + "azureResourceId": { + "description": "The azure resource Id of the deployment.", + "type": "string" + }, + "location": { + "description": "The location of the deployment.", + "type": "string" + } + } + }, + "ConnectedPartnerResourcesListFormat": { + "description": "Connected Partner Resources List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConnectedPartnerResourceProperties" + } + } + }, + "ConnectedPartnerResourcesListResponse": { + "description": " List of all active newrelic deployments.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectedPartnerResourcesListFormat" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "AccountResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "The details of a account resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "AppServiceInfo": { + "type": "object", + "properties": { + "azureResourceId": { + "type": "string", + "description": "Azure App service resource ID" + }, + "agentVersion": { + "type": "string", + "description": "Version of the NewRelic agent installed on the App service." + }, + "agentStatus": { + "type": "string", + "description": "Status of the NewRelic agent installed on the App service." + } + }, + "description": "Details of VM Resource having NewRelic OneAgent installed" + }, + "AppServicesGetParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/AppServicesGetRequest", + "description": "The details of the app services get request." + } + }, + "description": "App services Get Parameter specification.", + "required": [ + "request" + ] + }, + "SwitchBillingParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/SwitchBillingRequest", + "description": "The details of the switch billing request." + } + }, + "description": "Switch Billing Parameter specification.", + "required": [ + "request" + ] + }, + "SwitchBillingRequest": { + "type": "object", + "properties": { + "azureResourceId": { + "type": "string", + "description": "Azure resource Id" + }, + "organizationId": { + "type": "string", + "description": "Organization id" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of a switch billing Operation.", + "required": [ + "userEmail" + ] + }, + "AppServicesGetRequest": { + "type": "object", + "properties": { + "azureResourceIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Azure resource IDs" + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of a app services get Operation.", + "required": [ + "userEmail" + ] + }, + "AppServicesListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AppServiceInfo" + }, + "x-ms-identifiers": [ + "azureResourceId" + ], + "x-cadl-name": "AppServiceInfo[]", + "description": "The AppServiceInfo items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of a list app services Operation.", + "required": [ + "value" + ] + }, + "BillingCycle": { + "type": "string", + "description": "Different usage type like YEARLY/MONTHLY", + "enum": [ + "YEARLY", + "MONTHLY", + "WEEKLY" + ], + "x-ms-enum": { + "name": "BillingCycle", + "modelAsString": true, + "values": [ + { + "name": "YEARLY", + "value": "YEARLY", + "description": "Billing cycle is YEARLY" + }, + { + "name": "MONTHLY", + "value": "MONTHLY", + "description": "Billing cycle is MONTHLY" + }, + { + "name": "WEEKLY", + "value": "WEEKLY", + "description": "Billing cycle is WEEKLY" + } + ] + } + }, + "BillingSource": { + "type": "string", + "description": "Billing source", + "enum": [ + "AZURE", + "NEWRELIC" + ], + "x-ms-enum": { + "name": "BillingSource", + "modelAsString": true, + "values": [ + { + "name": "AZURE", + "value": "AZURE", + "description": "Billing source is Azure" + }, + { + "name": "NEWRELIC", + "value": "NEWRELIC" + } + ] + } + }, + "FilteringTag": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name (also known as the key) of the tag." + }, + "value": { + "type": "string", + "description": "The value of the tag." + }, + "action": { + "$ref": "#/definitions/TagAction", + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion." + } + }, + "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored." + }, + "HostsGetParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/HostsGetRequest", + "description": "The details of the Hosts get request." + } + }, + "description": "Host Get Parameter specification.", + "required": [ + "request" + ] + }, + "HostsGetRequest": { + "type": "object", + "properties": { + "vmIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "VM resource IDs" + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of a Hosts get Operation.", + "required": [ + "userEmail" + ] + }, + "LiftrResourceCategories": { + "type": "string", + "description": "Liftr Resource category.", + "enum": [ + "Unknown", + "MonitorLogs" + ], + "x-ms-enum": { + "name": "LiftrResourceCategories", + "modelAsString": true + } + }, + "LocationParameter": { + "type": "object", + "properties": {}, + "description": "Location for NewRelic resource" + }, + "LogRules": { + "type": "object", + "properties": { + "sendAadLogs": { + "$ref": "#/definitions/SendAadLogsStatus", + "description": "Flag specifying if AAD logs should be sent for the Monitor resource." + }, + "sendSubscriptionLogs": { + "$ref": "#/definitions/SendSubscriptionLogsStatus", + "description": "Flag specifying if subscription logs should be sent for the Monitor resource." + }, + "sendActivityLogs": { + "$ref": "#/definitions/SendActivityLogsStatus", + "description": "Flag specifying if activity logs from Azure resources should be sent for the Monitor resource." + }, + "filteringTags": { + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + }, + "x-ms-identifiers": [], + "x-cadl-name": "FilteringTag[]", + "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured.\nIf only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags." + } + }, + "description": "Set of rules for sending logs for the Monitor resource." + }, + "MarketplaceSubscriptionStatus": { + "type": "string", + "description": "Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.", + "enum": [ + "Active", + "Suspended" + ], + "x-ms-enum": { + "name": "MarketplaceSubscriptionStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "monitoring is enabled" + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "monitoring is disabled" + } + ] + } + }, + "MetricRules": { + "type": "object", + "properties": { + "sendMetrics": { + "$ref": "#/definitions/SendMetricsStatus", + "description": "Flag specifying if metrics should be sent for the Monitor resource." + }, + "filteringTags": { + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + }, + "x-ms-identifiers": [], + "x-cadl-name": "FilteringTag[]", + "description": "List of filtering tags to be used for capturing metrics." + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Set of rules for sending metrics for the Monitor resource." + }, + "MetricsRequest": { + "type": "object", + "properties": { + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of get metrics Operation.", + "required": [ + "userEmail" + ] + }, + "MetricsRequestParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/MetricsRequest", + "description": "The details of the get metrics status request." + } + }, + "description": "Get Metrics Status Parameter specification.", + "required": [ + "request" + ] + }, + "MetricsStatusRequest": { + "type": "object", + "properties": { + "azureResourceIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Azure resource IDs" + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of get metrics status Operation.", + "required": [ + "userEmail" + ] + }, + "MetricsStatusRequestParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/MetricsStatusRequest", + "description": "The details of the get metrics status request." + } + }, + "description": "Get Metrics Status Parameter specification.", + "required": [ + "request" + ] + }, + "MetricsStatusResponse": { + "type": "object", + "properties": { + "azureResourceIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Azure resource IDs" + } + }, + "description": "Response of get metrics status Operation." + }, + "MonitorProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + }, + "monitoringStatus": { + "$ref": "#/definitions/MonitoringStatus", + "description": "MonitoringStatus of the resource", + "readOnly": true + }, + "marketplaceSubscriptionStatus": { + "$ref": "#/definitions/MarketplaceSubscriptionStatus", + "description": "NewRelic Organization properties of the resource", + "readOnly": true + }, + "marketplaceSubscriptionId": { + "type": "string", + "description": "Marketplace Subscription Id", + "readOnly": true + }, + "newRelicAccountProperties": { + "$ref": "#/definitions/NewRelicAccountProperties", + "description": "MarketplaceSubscriptionStatus of the resource" + }, + "userInfo": { + "$ref": "#/definitions/UserInfo", + "description": "User Info" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories", + "description": "Liftr resource category", + "readOnly": true + }, + "liftrResourcePreference": { + "type": "integer", + "format": "int32", + "description": "Liftr resource preference. The priority of the resource.", + "readOnly": true + }, + "orgCreationSource": { + "$ref": "#/definitions/OrgCreationSource", + "description": "Source of org creation" + }, + "accountCreationSource": { + "$ref": "#/definitions/AccountCreationSource", + "description": "Source of account creation" + }, + "subscriptionState": { + "description": "State of the Azure Subscription containing the monitor resource", + "type": "string" + }, + "saaSAzureSubscriptionStatus": { + "description": "Status of Azure Subscription where Marketplace SaaS is located.", + "type": "string" + } + }, + "description": "Properties specific to the NewRelic Monitor resource" + }, + "MonitoredResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM id of the resource." + }, + "sendingMetrics": { + "$ref": "#/definitions/SendingMetricsStatus", + "description": "Flag indicating if resource is sending metrics to NewRelic." + }, + "reasonForMetricsStatus": { + "type": "string", + "description": "Reason for why the resource is sending metrics (or why it is not sending)." + }, + "sendingLogs": { + "$ref": "#/definitions/SendingLogsStatus", + "description": "Flag indicating if resource is sending logs to NewRelic." + }, + "reasonForLogsStatus": { + "type": "string", + "description": "Reason for why the resource is sending logs (or why it is not sending)." + } + }, + "description": "Details of resource being monitored by NewRelic monitor resource" + }, + "MonitoredResourceListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredResource" + }, + "x-cadl-name": "MonitoredResource[]", + "description": "The MonitoredResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "List of all the resources being monitored by NewRelic monitor resource", + "required": [ + "value" + ] + }, + "MonitoringStatus": { + "type": "string", + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "MonitoringStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "monitoring is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "monitoring is disabled" + } + ] + } + }, + "MonitoringTagRulesProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + }, + "logRules": { + "$ref": "#/definitions/LogRules", + "description": "Set of rules for sending logs for the Monitor resource." + }, + "metricRules": { + "$ref": "#/definitions/MetricRules", + "description": "Set of rules for sending metrics for the Monitor resource." + } + }, + "description": "The resource-specific properties for this resource." + }, + "NewRelicAccountProperties": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User id" + }, + "accountInfo": { + "$ref": "#/definitions/AccountInfo", + "description": "NewRelic Account Information" + }, + "organizationInfo": { + "$ref": "#/definitions/OrganizationInfo", + "description": "NewRelic Organization Information" + }, + "singleSignOnProperties": { + "$ref": "#/definitions/NewRelicSingleSignOnProperties", + "description": "date when plan was applied" + } + }, + "description": "Properties of the NewRelic account" + }, + "NewRelicMonitorResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MonitorProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "description": "A Monitor Resource by NewRelic", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "NewRelicMonitorResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NewRelicMonitorResource" + }, + "x-cadl-name": "NewRelicMonitorResource[]", + "description": "The NewRelicMonitorResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "The response of a NewRelicMonitorResource list operation.", + "required": [ + "value" + ] + }, + "NewRelicMonitorResourceUpdate": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-cadl-name": "Record", + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/NewRelicMonitorResourceUpdateProperties", + "x-ms-client-flatten": true + } + }, + "description": "The type used for update operations of the NewRelicMonitorResource." + }, + "NewRelicMonitorResourceUpdateProperties": { + "type": "object", + "properties": { + "newRelicAccountProperties": { + "$ref": "#/definitions/NewRelicAccountProperties", + "description": "MarketplaceSubscriptionStatus of the resource" + }, + "userInfo": { + "$ref": "#/definitions/UserInfo", + "description": "User Info" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "orgCreationSource": { + "$ref": "#/definitions/OrgCreationSource", + "description": "Source of org creation" + }, + "accountCreationSource": { + "$ref": "#/definitions/AccountCreationSource", + "description": "Source of account creation" + } + }, + "description": "The updatable properties of the NewRelicMonitorResource." + }, + "NewRelicSingleSignOnProperties": { + "type": "object", + "properties": { + "singleSignOnState": { + "$ref": "#/definitions/SingleSignOnStates", + "description": "Single sign-on state" + }, + "enterpriseAppId": { + "type": "string", + "description": "The Id of the Enterprise App used for Single sign-on." + }, + "singleSignOnUrl": { + "type": "string", + "description": "The login URL specific to this NewRelic Organization" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state" + } + }, + "description": "Single sign on Info of the NewRelic account" + }, + "OrgCreationSource": { + "type": "string", + "description": "Source of Org creation", + "enum": [ + "LIFTR", + "NEWRELIC" + ], + "x-ms-enum": { + "name": "OrgCreationSource", + "modelAsString": true, + "values": [ + { + "name": "LIFTR", + "value": "LIFTR", + "description": "Org is created from LIFTR" + }, + { + "name": "NEWRELIC", + "value": "NEWRELIC", + "description": "Org is created from NEWRELIC" + } + ] + } + }, + "OrganizationIdParameter": { + "type": "object", + "properties": {}, + "description": "Organization Id parameter" + }, + "OrganizationInfo": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Organization id" + } + }, + "description": "Organization Info of the NewRelic account" + }, + "OrganizationProperties": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "organization id" + }, + "organizationName": { + "type": "string", + "description": "organization name" + }, + "billingSource": { + "$ref": "#/definitions/BillingSource", + "description": "Billing source" + } + }, + "description": "Details of Organizations" + }, + "OrganizationsListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OrganizationResource" + }, + "x-cadl-name": "OrganizationResource[]", + "description": "The OrganizationResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of get all organizations Operation.", + "required": [ + "value" + ] + }, + "OrganizationResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/OrganizationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "The details of a Organization resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PlanData": { + "type": "object", + "properties": { + "usageType": { + "$ref": "#/definitions/UsageType", + "description": "Different usage type like PAYG/COMMITTED. this could be enum" + }, + "billingCycle": { + "$ref": "#/definitions/BillingCycle", + "description": "Different billing cycles like MONTHLY/WEEKLY. this could be enum" + }, + "planDetails": { + "type": "string", + "description": "plan id as published by NewRelic" + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "date when plan was applied" + } + }, + "description": "Plan data of NewRelic Monitor resource" + }, + "PlanDataResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PlanDataProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "The details of a PlanData resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PlanDataListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PlanDataResource" + }, + "x-cadl-name": "PlanDataResource[]", + "description": "The PlanDataResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of get all plan data Operation.", + "required": [ + "value" + ] + }, + "PlanDataProperties": { + "type": "object", + "properties": { + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "orgCreationSource": { + "$ref": "#/definitions/OrgCreationSource", + "description": "Source of org creation" + }, + "accountCreationSource": { + "$ref": "#/definitions/AccountCreationSource", + "description": "Source of account creation" + } + }, + "description": "Plan details" + }, + "MonitoredSubscription": { + "description": "The list of subscriptions and it's monitoring status by current NewRelic monitor.", + "type": "object", + "properties": { + "subscriptionId": { + "description": "The subscriptionId to be monitored.", + "required": [ + "subscriptionId" + ], + "type": "string" + }, + "status": { + "description": "The state of monitoring.", + "enum": [ + "InProgress", + "Active", + "Failed", + "Deleting" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "Status" + }, + "type": "string" + }, + "error": { + "description": "The reason of not monitoring the subscription.", + "type": "string" + }, + "tagRules": { + "$ref": "#/definitions/MonitoringTagRulesProperties" + } + } + }, + "SubscriptionList": { + "description": "The request to update subscriptions needed to be monitored by the NewRelic monitor resource.", + "type": "object", + "properties": { + "patchOperation": { + "description": "The operation for the patch on the resource.", + "enum": [ + "AddBegin", + "AddComplete", + "DeleteBegin", + "DeleteComplete", + "Active" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "PatchOperation" + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "monitoredSubscriptionList": { + "description": "List of subscriptions and the state of the monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscription" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + } + } + }, + "MonitoredSubscriptionProperties": { + "description": "The request to update subscriptions needed to be monitored by the NewRelic monitor resource.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SubscriptionList" + } + } + }, + "MonitoredSubscriptionPropertiesList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + } + }, + "LinkedResource": { + "description": "The definition of a linked resource.", + "type": "object", + "properties": { + "id": { + "description": "The ARM id of the linked resource.", + "type": "string" + } + } + }, + "LinkedResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LinkedResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning State of the Monitor resource", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Accepted", + "value": "Accepted", + "description": "Monitor resource creation request accepted" + }, + { + "name": "Creating", + "value": "Creating", + "description": "Monitor resource creation started" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Monitor resource is being updated" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Monitor resource deletion started" + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Monitor resource creation successful" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Monitor resource creation failed" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Monitor resource creation canceled" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Monitor resource is deleted" + }, + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "Monitor resource state is unknown" + } + ] + } + }, + "SecureString": { + "type": "string", + "description": "Credential string.", + "format": "password", + "x-ms-secret": true + }, + "SendAadLogsStatus": { + "type": "string", + "description": "Indicates whether AAD logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendAadLogsStatus", + "modelAsString": true + } + }, + "SendActivityLogsStatus": { + "type": "string", + "description": "Indicates whether activity logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendActivityLogsStatus", + "modelAsString": true + } + }, + "SendMetricsStatus": { + "type": "string", + "description": "Indicates whether metrics are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendMetricsStatus", + "modelAsString": true + } + }, + "SendSubscriptionLogsStatus": { + "type": "string", + "description": "Indicates whether subscription logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendSubscriptionLogsStatus", + "modelAsString": true + } + }, + "SendingLogsStatus": { + "type": "string", + "description": "Indicates whether logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendingLogsStatus", + "modelAsString": true + } + }, + "SendingMetricsStatus": { + "type": "string", + "description": "Indicates whether metrics are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendingMetricsStatus", + "modelAsString": true + } + }, + "SingleSignOnStates": { + "type": "string", + "description": "Various states of the SSO resource", + "enum": [ + "Initial", + "Enable", + "Disable", + "Existing" + ], + "x-ms-enum": { + "name": "SingleSignOnStates", + "modelAsString": true + } + }, + "TagAction": { + "type": "string", + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion.", + "enum": [ + "Include", + "Exclude" + ], + "x-ms-enum": { + "name": "TagAction", + "modelAsString": true + } + }, + "TagRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MonitoringTagRulesProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "A tag rule belonging to NewRelic account", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "TagRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagRule" + }, + "x-cadl-name": "TagRule[]", + "description": "The TagRule items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "The response of a TagRule list operation.", + "required": [ + "value" + ] + }, + "TagRuleUpdate": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TagRuleUpdateProperties", + "x-ms-client-flatten": true + } + }, + "description": "The type used for update operations of the TagRule." + }, + "TagRuleUpdateProperties": { + "type": "object", + "properties": { + "logRules": { + "$ref": "#/definitions/LogRules", + "description": "Set of rules for sending logs for the Monitor resource." + }, + "metricRules": { + "$ref": "#/definitions/MetricRules", + "description": "Set of rules for sending metrics for the Monitor resource." + } + }, + "description": "The updatable properties of the TagRule." + }, + "UsageType": { + "type": "string", + "description": "Different usage type like PAYG/COMMITTED", + "enum": [ + "PAYG", + "COMMITTED" + ], + "x-ms-enum": { + "name": "UsageType", + "modelAsString": true, + "values": [ + { + "name": "PAYG", + "value": "PAYG", + "description": "Usage type is PAYG" + }, + { + "name": "COMMITTED", + "value": "COMMITTED", + "description": "Usage type is COMMITTED" + } + ] + } + }, + "UserEmailParameter": { + "type": "object", + "properties": {}, + "description": "User email specification." + }, + "UserInfo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "First name", + "maxLength": 50 + }, + "lastName": { + "type": "string", + "description": "Last name", + "maxLength": 50 + }, + "emailAddress": { + "$ref": "#/definitions/email", + "description": "User Email" + }, + "phoneNumber": { + "type": "string", + "description": "Contact phone number", + "maxLength": 40 + }, + "country": { + "type": "string", + "description": "country if user" + } + }, + "description": "User Info of NewRelic Monitor resource" + }, + "VMExtensionPayload": { + "type": "object", + "properties": { + "ingestionKey": { + "type": "string", + "description": "Ingestion key of the account" + } + }, + "description": "Response of payload to be passed while installing VM agent." + }, + "VMHostsListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VMInfo" + }, + "x-ms-identifiers": [], + "x-cadl-name": "VMInfo[]", + "description": "The VMInfo items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of a list VM Host Operation.", + "required": [ + "value" + ] + }, + "VMInfo": { + "type": "object", + "properties": { + "vmId": { + "type": "string", + "description": "Azure VM resource ID" + }, + "agentVersion": { + "type": "string", + "description": "Version of the NewRelic agent installed on the VM." + }, + "agentStatus": { + "type": "string", + "description": "Status of the NewRelic agent installed on the VM." + } + }, + "description": "Details of VM Resource having NewRelic OneAgent installed" + }, + "email": { + "type": "string", + "description": "Reusable representation of an email address", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" + } + }, + "parameters": { + "AccountIdParameter": { + "name": "accountId", + "in": "query", + "required": false, + "description": "Account Id.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "AppServicesGetParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the app services get request.", + "schema": { + "$ref": "#/definitions/AppServicesGetRequest" + }, + "x-ms-parameter-location": "method" + }, + "SwitchBillingParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the switch billing request.", + "schema": { + "$ref": "#/definitions/SwitchBillingRequest" + }, + "x-ms-parameter-location": "method" + }, + "HostsGetParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the Hosts get request.", + "schema": { + "$ref": "#/definitions/HostsGetRequest" + }, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "query", + "required": true, + "description": "Location for NewRelic.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "MetricsRequestParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the get metrics status request.", + "schema": { + "$ref": "#/definitions/MetricsRequest" + }, + "x-ms-parameter-location": "method" + }, + "MetricsStatusRequestParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the get metrics status request.", + "schema": { + "$ref": "#/definitions/MetricsStatusRequest" + }, + "x-ms-parameter-location": "method" + }, + "OrganizationIdParameter": { + "name": "organizationId", + "in": "query", + "required": false, + "description": "Organization Id.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "UserEmailParameter": { + "name": "userEmail", + "in": "query", + "required": true, + "description": "User Email.", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Accounts_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Accounts_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..f71190b0ba51 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Accounts_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "operationId": "Accounts_List", + "title": "Accounts_List_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "location": "egh" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "organizationId": "wvdclwi", + "accountId": "igmdjq", + "accountName": "accname", + "region": "xnsylopqwcggudcln" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Accounts_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Accounts_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..c474f374a940 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Accounts_List_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "operationId": "Accounts_List", + "title": "Accounts_List_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "location": "egh" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/BillingInfo_Get.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/BillingInfo_Get.json new file mode 100644 index 000000000000..41ab1074acb6 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/BillingInfo_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "marketplaceSubscriptionId": "12345678-1234-1234-1234-123456789012", + "marketplaceSubscriptionName": "AzNewRelic_b1190c8f", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzNewRelic_b1190c8f", + "marketplaceStatus": "Active", + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "partnerBillingEntity": { + "organizationId": "1234567890", + "organizationName": "NROrganizationName" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/ConnectedPartnerResources_List.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/ConnectedPartnerResources_List.json new file mode 100644 index 000000000000..b73ee16a69f5 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/ConnectedPartnerResources_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "accountName": "accountName", + "accountId": "1156243", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "location": "West US 2" + } + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/LinkedResources_List.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/LinkedResources_List.json new file mode 100644 index 000000000000..fc8fbac0c3d1 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/LinkedResources_List.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_CreateorUpdate.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_CreateorUpdate.json new file mode 100644 index 000000000000..3363e0d29886 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_CreateorUpdate.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "requestBody": { + "properties": { + "operation": "AddBegin", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_Delete.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_Delete.json new file mode 100644 index 000000000000..3319ef933c23 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/NewRelic.Observability/monitors/test?api-version=2024-01-01" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_Get.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_Get.json new file mode 100644 index 000000000000..a9162f4ac921 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_Get.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_List.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_List.json new file mode 100644 index 000000000000..2c976d5f2c61 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_List.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_Update.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_Update.json new file mode 100644 index 000000000000..86c245e1d133 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/MonitoredSubscriptions_Update.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "requestBody": { + "properties": { + "operation": "AddComplete", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/NewRelic.Observability/monitors/test?api-version=2024-01-01" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..8e44a5eb9a4f --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,209 @@ +{ + "operationId": "Monitors_CreateOrUpdate", + "title": "Monitors_CreateOrUpdate_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "cdlymktqw", + "resource": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "ingestionKey": "wltnimmhqt", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR", + "subscriptionState": "Suspended", + "saaSAzureSubscriptionStatus": "Subscribed" + }, + "identity": { + "type": "None", + "userAssignedIdentities": { + "key8903": {} + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR", + "subscriptionState": "Suspended", + "saaSAzureSubscriptionStatus": "Subscribed" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR", + "subscriptionState": "Suspended", + "saaSAzureSubscriptionStatus": "Subscribed" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Delete_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..f4233d4d91a6 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "Monitors_Delete", + "title": "Monitors_Delete_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Delete_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..d7a1da9ae62f --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "Monitors_Delete", + "title": "Monitors_Delete_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricRules_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricRules_MaximumSet_Gen.json new file mode 100644 index 000000000000..c474675a06ec --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricRules_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "operationId": "Monitors_GetMetricRules", + "title": "Monitors_GetMetricRules_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "sendMetrics": "Enabled", + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "qnvixg", + "value": "ihyabcsjvhkfzckfjvgvtlhdyvmwge", + "action": "Include" + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricRules_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricRules_MinimumSet_Gen.json new file mode 100644 index 000000000000..0e7b4fe4c957 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricRules_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "operationId": "Monitors_GetMetricRules", + "title": "Monitors_GetMetricRules_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "sendMetrics": "Disabled", + "filteringTags": [], + "userEmail": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..0b4a0272b388 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "operationId": "Monitors_GetMetricStatus", + "title": "Monitors_GetMetricStatus_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json new file mode 100644 index 000000000000..5a09cbe4165e --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "operationId": "Monitors_GetMetricStatus", + "title": "Monitors_GetMetricStatus_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "azureResourceIds": [] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Get_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6e04ca500a0f --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Get_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "operationId": "Monitors_Get", + "title": "Monitors_Get_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "cdlymktqw" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListAppServices_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListAppServices_MaximumSet_Gen.json new file mode 100644 index 000000000000..003d729c71b4 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListAppServices_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "operationId": "Monitors_ListAppServices", + "title": "Monitors_ListAppServices_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", + "agentVersion": "owxkssnbp", + "agentStatus": "vclwfecbppsfaygdccfu" + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListAppServices_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListAppServices_MinimumSet_Gen.json new file mode 100644 index 000000000000..9ecad0e330bf --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListAppServices_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "operationId": "Monitors_ListAppServices", + "title": "Monitors_ListAppServices_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..0b3a2c7caaff --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "operationId": "Monitors_ListByResourceGroup", + "title": "Monitors_ListByResourceGroup_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListBySubscription_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..d15aca1c009a --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "operationId": "Monitors_ListBySubscription", + "title": "Monitors_ListBySubscription_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListHosts_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListHosts_MaximumSet_Gen.json new file mode 100644 index 000000000000..7d425d30f53a --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListHosts_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "operationId": "Monitors_ListHosts", + "title": "Monitors_ListHosts_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "request": { + "vmIds": [ + "xzphvxvfmvjrnsgyns" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vmId": "gwyoa", + "agentVersion": "tbinulnoozxnbr", + "agentStatus": "psnjslxwuwtviwzzgqhyzynuxvz" + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListHosts_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListHosts_MinimumSet_Gen.json new file mode 100644 index 000000000000..cc8df3ff141a --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListHosts_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "operationId": "Monitors_ListHosts", + "title": "Monitors_ListHosts_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "request": { + "vmIds": [ + "xzphvxvfmvjrnsgyns" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json new file mode 100644 index 000000000000..30b2f6a731ac --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "operationId": "Monitors_ListMonitoredResources", + "title": "Monitors_ListMonitoredResources_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "sendingMetrics": "Enabled", + "reasonForMetricsStatus": "k", + "sendingLogs": "Enabled", + "reasonForLogsStatus": "agzxviwuxgr" + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json new file mode 100644 index 000000000000..bdbb56bcce38 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "operationId": "Monitors_ListMonitoredResources", + "title": "Monitors_ListMonitoredResources_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_SwitchBilling_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_SwitchBilling_MaximumSet_Gen.json new file mode 100644 index 000000000000..8aa06050efa2 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_SwitchBilling_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "operationId": "Monitors_SwitchBilling", + "title": "Monitors_SwitchBilling_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", + "organizationId": "k", + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_SwitchBilling_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_SwitchBilling_MinimumSet_Gen.json new file mode 100644 index 000000000000..1efcfb847b6a --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_SwitchBilling_MinimumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "operationId": "Monitors_SwitchBilling", + "title": "Monitors_SwitchBilling_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Update_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..192421c73b43 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_Update_MaximumSet_Gen.json @@ -0,0 +1,126 @@ +{ + "operationId": "Monitors_Update", + "title": "Monitors_Update_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "cdlymktqw", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key8903": {} + } + }, + "tags": { + "key164": "jqakdrrmmyzytqu" + }, + "properties": { + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "ingestionKey": "wltnimmhqt", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_VmHostPayload_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_VmHostPayload_MaximumSet_Gen.json new file mode 100644 index 000000000000..e695c880925a --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_VmHostPayload_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Monitors_VmHostPayload", + "title": "Monitors_VmHostPayload_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "ingestionKey": "ltqewhfexphvqgttoevaywrl" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_VmHostPayload_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_VmHostPayload_MinimumSet_Gen.json new file mode 100644 index 000000000000..d731dab79bc4 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Monitors_VmHostPayload_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Monitors_VmHostPayload", + "title": "Monitors_VmHostPayload_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "ingestionKey": "ltqewhfexphvqgttoevaywrl" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Operations_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..c6efa8d3385b --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "operationId": "Operations_List", + "title": "Operations_List_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "zhlrjcljiysnufaerhpzg", + "isDataAction": true, + "display": { + "provider": "v", + "resource": "w", + "operation": "ybyzweygkffbydgaowg", + "description": "sekhimcuecttketh" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Operations_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..5fa65be4ca33 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "operationId": "Operations_List", + "title": "Operations_List_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Organizations_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Organizations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..69175d15975b --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Organizations_List_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "operationId": "Organizations_List", + "title": "Organizations_List_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "location": "egh" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "organizationId": "tjmcifofzirili", + "organizationName": "orgname", + "billingSource": "AZURE" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Organizations_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Organizations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..1730d619ad9b --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Organizations_List_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Organizations_List", + "title": "Organizations_List_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "location": "egh" + }, + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Plans_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Plans_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..39d1fbaca15a --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Plans_List_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "operationId": "Plans_List", + "title": "Plans_List_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "accountId": "pwuxgvrmkk", + "organizationId": "hilawwjz" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Plans_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Plans_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..f949126dd60e --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/Plans_List_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "operationId": "Plans_List", + "title": "Plans_List_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "organizationId": "hilawwjz" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "orgCreationSource": "NEWRELIC" + } + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..bc6c3841e698 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,121 @@ +{ + "operationId": "TagRules_CreateOrUpdate", + "title": "TagRules_CreateOrUpdate_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "resource": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..286ccc8134f8 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "operationId": "TagRules_CreateOrUpdate", + "title": "TagRules_CreateOrUpdate_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "resource": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Delete_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..9dc2a293e028 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "TagRules_Delete", + "title": "TagRules_Delete_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Delete_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..f7e4fc2ed89c --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "TagRules_Delete", + "title": "TagRules_Delete_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Get_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..c85616b49a1f --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Get_MaximumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "operationId": "TagRules_Get", + "title": "TagRules_Get_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Get_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..5dde5fe8a095 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "operationId": "TagRules_Get", + "title": "TagRules_Get_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..ee13780f3560 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "operationId": "TagRules_ListByNewRelicMonitorResource", + "title": "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json new file mode 100644 index 000000000000..b620575a740c --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "operationId": "TagRules_ListByNewRelicMonitorResource", + "title": "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Update_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..926fb1169e1b --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Update_MaximumSet_Gen.json @@ -0,0 +1,79 @@ +{ + "operationId": "TagRules_Update", + "title": "TagRules_Update_MaximumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "properties": { + "properties": { + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Update_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..847e76bc5bd7 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/examples/TagRules_Update_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "TagRules_Update", + "title": "TagRules_Update_MinimumSet_Gen", + "parameters": { + "api-version": "2024-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "properties": {} + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + } + } +} diff --git a/specification/newrelic/resource-manager/readme.md b/specification/newrelic/resource-manager/readme.md index 833caefd7f68..105ce44da643 100644 --- a/specification/newrelic/resource-manager/readme.md +++ b/specification/newrelic/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the newrelic. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-11-01-preview +tag: package-2024-01-01 ``` ### Tag: package-2022-07-01-preview @@ -66,6 +66,24 @@ input-file: - NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json ``` +### Tag: package-2024-01-01-preview + +These settings apply only when `--tag=package-2024-01-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-01-01-preview' +input-file: + - NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json +``` + +### Tag: package-2024-01-01 + +These settings apply only when `--tag=package-2024-01-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-01-01' +input-file: + - NewRelic.Observability/stable/2024-01-01/NewRelic.json +``` + --- # Code Generation diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_CreateOrUpdate.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_CreateOrUpdate.json new file mode 100644 index 000000000000..e54cc8ce8c3e --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_CreateOrUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "certificateName": "default", + "requestBody": { + "properties": { + "keyVirtualPath": "/src/cert/somekey.key", + "certificateVirtualPath": "/src/cert/somePath.cert", + "keyVaultSecretId": "https://someKV.vault.azure.com/someSecretID" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/certificates/default", + "name": "default", + "type": "nginx.nginxplus/nginxdeployments/certificates", + "properties": { + "provisioningState": "Succeeded", + "keyVirtualPath": "/src/cert/somekey.key", + "certificateVirtualPath": "/src/cert/somePath.cert", + "keyVaultSecretId": "https://someKV.vault.azure.com/someSecretID" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/certificates/default", + "name": "default", + "type": "nginx.nginxplus/nginxdeployments/certificates", + "properties": { + "provisioningState": "Accepted", + "keyVirtualPath": "/src/cert/somekey.key", + "certificateVirtualPath": "/src/cert/somePath.cert", + "keyVaultSecretId": "https://someKV.vault.azure.com/someSecretID" + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_Delete.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_Delete.json new file mode 100644 index 000000000000..95aef5947cd0 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "certificateName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_Get.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_Get.json new file mode 100644 index 000000000000..722510513dd7 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "certificateName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/certificates/default", + "name": "default", + "type": "nginx.nginxplus/nginxdeployments/certificates", + "properties": { + "provisioningState": "Succeeded", + "keyVirtualPath": "/src/cert/somekey.key", + "certificateVirtualPath": "/src/cert/somePath.cert", + "keyVaultSecretId": "https://someKV.vault.azure.com/someSecretID", + "sha1Thumbprint": "1234567890ABCDEF1234567890ABCDEF12345678", + "keyVaultSecretVersion": "12345678ef9a12345678ef9a12345678", + "keyVaultSecretCreated": "2020-01-01T00:00:00Z", + "certificateError": { + "code": "CertificateNotYetValid", + "message": "The certificate is not yet valid. The certificate is not yet valid. NotBefore: '2020-01-01T00:00:00Z', NotAfter: '2020-01-01T00:00:00Z'" + } + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_List.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_List.json new file mode 100644 index 000000000000..d46cc0d9b30e --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Certificates_List.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/certificates/cert1", + "name": "cert1", + "type": "nginx.nginxplus/nginxdeployments/certificates", + "properties": { + "provisioningState": "Succeeded", + "keyVirtualPath": "/src/cert/somekey.key", + "certificateVirtualPath": "/src/cert/somePath.cert", + "keyVaultSecretId": "https://someKV.vault.azure.com/someSecretID", + "sha1Thumbprint": "1234567890ABCDEF1234567890ABCDEF12345678", + "keyVaultSecretVersion": "12345678ef9a12345678ef9a12345678", + "keyVaultSecretCreated": "2020-01-01T00:00:00Z", + "certificateError": { + "code": "CertificateNotYetValid", + "message": "The certificate is not yet valid. The certificate is not yet valid. NotBefore: '2020-01-01T00:00:00Z', NotAfter: '2020-01-01T00:00:00Z'" + } + } + }, + { + "id": "/subscritions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/certificates/cert2", + "name": "cert2", + "type": "nginx.nginxplus/nginxdeployments/certificates", + "properties": { + "provisioningState": "Succeeded", + "keyVirtualPath": "/src/cert/somekey2.key", + "certificateVirtualPath": "/src/cert/somePath2.cert", + "keyVaultSecretId": "https://someKV.vault.azure.com/someSecretID2", + "sha1Thumbprint": "1234567890ABCDEF1234567890ABCDEF12345678", + "keyVaultSecretVersion": "12345678ef9a12345678ef9a12345678", + "keyVaultSecretCreated": "2020-01-01T00:00:00Z", + "certificateError": null + } + } + ] + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_Analysis.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_Analysis.json new file mode 100644 index 000000000000..bdbd0c6ae700 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_Analysis.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "configurationName": "default", + "requestBody": { + "config": { + "files": [ + { + "content": "ABCDEF==", + "virtualPath": "/etc/nginx/nginx.conf" + } + ], + "package": { + "data": null + }, + "rootFile": "/etc/nginx/nginx.conf" + } + } + }, + "responses": { + "200": { + "body": { + "status": "FAILED", + "data": { + "errors": [ + { + "id": "config-analysis-error-1", + "directive": "worker_processes", + "description": "Directives outside the http context are not allowed", + "file": "/etc/nginx/nginx.conf", + "line": 2, + "message": "You are not allowed to set the worker_processes directive", + "rule": "nginx-azure-load-balancer-allowed-directives" + } + ] + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_CreateOrUpdate.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_CreateOrUpdate.json new file mode 100644 index 000000000000..b36cb60e3274 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_CreateOrUpdate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "configurationName": "default", + "requestBody": { + "properties": { + "files": [ + { + "content": "ABCDEF==", + "virtualPath": "/etc/nginx/nginx.conf" + } + ], + "package": { + "data": null + }, + "rootFile": "/etc/nginx/nginx.conf" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment/configurations/default", + "name": "default", + "type": "nginx.nginxplus/nginxDeployments/configurations", + "properties": { + "provisioningState": "Succeeded", + "files": [ + { + "content": "ABCDEF==", + "virtualPath": "/etc/nginx/nginx.conf" + } + ], + "package": { + "data": null + }, + "rootFile": "/etc/nginx/nginx.conf" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment/configurations/default", + "name": "default", + "type": "nginx.nginxplus/nginxDeployments/configurations", + "properties": { + "provisioningState": "Accepted", + "files": [ + { + "content": "ABCDEF==", + "virtualPath": "/etc/nginx/nginx.conf" + } + ], + "package": { + "data": null + }, + "rootFile": "/etc/nginx/nginx.conf" + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_Delete.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_Delete.json new file mode 100644 index 000000000000..17414cf5c0a9 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "configurationName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_Get.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_Get.json new file mode 100644 index 000000000000..7c2f57b5a741 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment/configurations/default", + "name": "default", + "type": "nginx.nginxplus/nginxDeployments/configurations", + "properties": { + "provisioningState": "Succeeded", + "files": [ + { + "content": "ABCDEF==", + "virtualPath": "/etc/nginx/nginx.conf" + } + ], + "package": { + "data": null + }, + "rootFile": "/etc/nginx/nginx.conf" + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_List.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_List.json new file mode 100644 index 000000000000..a8c8a05a3b6a --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Configurations_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment/configurations/default", + "name": "default", + "type": "nginx.nginxplus/nginxDeployments/configurations", + "properties": { + "provisioningState": "Succeeded", + "files": [ + { + "content": "ABCDEF==", + "virtualPath": "/etc/nginx/nginx.conf" + } + ], + "package": { + "data": null + }, + "rootFile": "/etc/nginx/nginx.conf" + } + } + ] + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Create.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Create.json new file mode 100644 index 000000000000..2874ef7d4dba --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Create.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "requestBody": { + "name": "myDeployment", + "tags": { + "Environment": "Dev" + }, + "properties": { + "managedResourceGroup": "myManagedResourceGroup", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + }, + "userProfile": { + "preferredEmail": "example@example.email" + } + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "tags": { + "Environment": "Dev" + }, + "properties": { + "provisioningState": "Succeeded", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "ipAddress": "1.1.1.1", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "tags": { + "Environment": "Dev" + }, + "properties": { + "provisioningState": "Accepted", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "ipAddress": "1.1.1.1", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + } + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Delete.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Delete.json new file mode 100644 index 000000000000..215271ee9c4b --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Get.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Get.json new file mode 100644 index 000000000000..d253c22bb0d7 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + }, + "userProfile": { + "preferredEmail": "example@example.email" + } + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_List.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_List.json new file mode 100644 index 000000000000..178a0c2178dd --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "ipAddress": "1.1.1.1", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + } + } + } + ] + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_ListByResourceGroup.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_ListByResourceGroup.json new file mode 100644 index 000000000000..73943680071e --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_ListByResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "ipAddress": "1.1.1.1", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + } + } + } + ] + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Update.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Update.json new file mode 100644 index 000000000000..de5df133ff93 --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Deployments_Update.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "deploymentName": "myDeployment", + "requestBody": { + "tags": { + "Environment": "Dev" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "tags": { + "Environment": "Dev" + }, + "properties": { + "provisioningState": "Succeeded", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "ipAddress": "1.1.1.1", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + }, + "userProfile": { + "preferredEmail": "example@example.email" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Nginx.NginxPlus/nginxDeployments/myDeployment", + "name": "myDeployment", + "type": "nginx.nginxplus/deployments", + "location": "westus", + "tags": { + "Environment": "Dev" + }, + "properties": { + "provisioningState": "Accepted", + "nginxVersion": "nginx-1.19.6", + "managedResourceGroup": "myManagedResourceGroup", + "networkProfile": { + "frontEndIPConfiguration": { + "publicIPAddresses": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIPAddress" + } + ], + "privateIPAddresses": [ + { + "privateIPAddress": "1.1.1.1", + "privateIPAllocationMethod": "Static", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + ] + }, + "networkInterfaceConfiguration": { + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + } + } + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Operations_List.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Operations_List.json new file mode 100644 index 000000000000..8e8ec79a321f --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/examples/Operations_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Nginx.NginxPlus/nginxDeployments/write", + "display": { + "provider": "Nginx.NginxPlus", + "resource": "deployments", + "operation": "write", + "description": "Write deployments resource" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/swagger.json b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/swagger.json new file mode 100644 index 000000000000..2d1d578487cf --- /dev/null +++ b/specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-09-01/swagger.json @@ -0,0 +1,1579 @@ +{ + "swagger": "2.0", + "info": { + "title": "Nginx.NginxPlus", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/certificates/{certificateName}": { + "get": { + "tags": [ + "NginxCertificate" + ], + "summary": "Get a certificate of given NGINX deployment", + "operationId": "Certificates_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "in": "path", + "name": "certificateName", + "description": "The name of certificate", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxCertificate" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Certificates_Get": { + "$ref": "./examples/Certificates_Get.json" + } + } + }, + "put": { + "tags": [ + "NginxCertificate" + ], + "summary": "Create or update the NGINX certificates for given NGINX deployment", + "operationId": "Certificates_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "in": "path", + "name": "certificateName", + "description": "The name of certificate", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The certificate", + "schema": { + "$ref": "#/definitions/NginxCertificate" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxCertificate" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxCertificate" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Certificates_CreateOrUpdate": { + "$ref": "./examples/Certificates_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "NginxCertificate" + ], + "summary": "Deletes a certificate from the NGINX deployment", + "operationId": "Certificates_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "in": "path", + "name": "certificateName", + "description": "The name of certificate", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Certificates_Delete": { + "$ref": "./examples/Certificates_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/certificates": { + "get": { + "tags": [ + "NginxCertificate" + ], + "summary": "List all certificates of given NGINX deployment", + "operationId": "Certificates_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxCertificateListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Certificates_List": { + "$ref": "./examples/Certificates_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations": { + "get": { + "tags": [ + "NginxConfiguration" + ], + "summary": "List the NGINX configuration of given NGINX deployment.", + "operationId": "Configurations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxConfigurationListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Configurations_List": { + "$ref": "./examples/Configurations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}": { + "get": { + "tags": [ + "NginxConfiguration" + ], + "summary": "Get the NGINX configuration of given NGINX deployment", + "operationId": "Configurations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "in": "path", + "name": "configurationName", + "description": "The name of configuration, only 'default' is supported value due to the singleton of NGINX conf", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxConfiguration" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Configurations_Get": { + "$ref": "./examples/Configurations_Get.json" + } + } + }, + "put": { + "tags": [ + "NginxConfiguration" + ], + "summary": "Create or update the NGINX configuration for given NGINX deployment", + "operationId": "Configurations_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "in": "path", + "name": "configurationName", + "description": "The name of configuration, only 'default' is supported value due to the singleton of NGINX conf", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The NGINX configuration", + "schema": { + "$ref": "#/definitions/NginxConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxConfiguration" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxConfiguration" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Configurations_CreateOrUpdate": { + "$ref": "./examples/Configurations_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "NginxConfiguration" + ], + "summary": "Reset the NGINX configuration of given NGINX deployment to default", + "operationId": "Configurations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "in": "path", + "name": "configurationName", + "description": "The name of configuration, only 'default' is supported value due to the singleton of NGINX conf", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Configurations_Delete": { + "$ref": "./examples/Configurations_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}/analyze": { + "post": { + "tags": [ + "NginxConfigurationAnalysis" + ], + "summary": "Analyze an NGINX configuration without applying it to the NGINXaaS deployment", + "operationId": "Configurations_Analysis", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "configurationName", + "in": "path", + "description": "The name of configuration, only 'default' is supported value due to the singleton of NGINX conf", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The NGINX configuration to analyze", + "schema": { + "$ref": "#/definitions/AnalysisCreate" + } + } + ], + "responses": { + "200": { + "description": "Analysis complete", + "schema": { + "$ref": "#/definitions/AnalysisResult" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Configurations_Analysis": { + "$ref": "./examples/Configurations_Analysis.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}": { + "get": { + "tags": [ + "NginxDeployment" + ], + "summary": "Get the NGINX deployment", + "operationId": "Deployments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeployment" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_Get": { + "$ref": "./examples/Deployments_Get.json" + } + } + }, + "put": { + "tags": [ + "NginxDeployment" + ], + "summary": "Create or update the NGINX deployment", + "operationId": "Deployments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/NginxDeployment" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeployment" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeployment" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Deployments_Create": { + "$ref": "./examples/Deployments_Create.json" + } + } + }, + "patch": { + "tags": [ + "NginxDeployment" + ], + "summary": "Update the NGINX deployment", + "operationId": "Deployments_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/NginxDeploymentUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeployment" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeployment" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_Update": { + "$ref": "./examples/Deployments_Update.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "NginxDeployment" + ], + "summary": "Delete the NGINX deployment resource", + "operationId": "Deployments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deployments_Delete": { + "$ref": "./examples/Deployments_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Nginx.NginxPlus/nginxDeployments": { + "get": { + "tags": [ + "NginxDeployment" + ], + "summary": "List the NGINX deployments resources", + "operationId": "Deployments_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeploymentListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Deployments_List": { + "$ref": "./examples/Deployments_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments": { + "get": { + "tags": [ + "NginxDeployment" + ], + "summary": "List all NGINX deployments under the specified resource group.", + "operationId": "Deployments_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NginxDeploymentListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Deployments_ListByResourceGroup": { + "$ref": "./examples/Deployments_ListByResourceGroup.json" + } + } + } + }, + "/providers/Nginx.NginxPlus/operations": { + "get": { + "tags": [ + "NginxDeployment" + ], + "summary": "List all operations provided by Nginx.NginxPlus for the 2023-09-01 api version.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + } + }, + "definitions": { + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + } + }, + "NginxCertificateProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "keyVirtualPath": { + "type": "string" + }, + "certificateVirtualPath": { + "type": "string" + }, + "keyVaultSecretId": { + "type": "string" + }, + "sha1Thumbprint": { + "type": "string", + "example": "1234567890ABCDEF1234567890ABCDEF12345678", + "readOnly": true + }, + "keyVaultSecretVersion": { + "type": "string", + "example": "12345678ef9a12345678ef9a12345678", + "readOnly": true + }, + "keyVaultSecretCreated": { + "type": "string", + "format": "date-time", + "example": "2022-01-01T00:00:00.000Z", + "readOnly": true + }, + "certificateError": { + "$ref": "#/definitions/NginxCertificateErrorResponseBody" + } + } + }, + "NginxCertificateErrorResponseBody": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "NginxCertificate": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/NginxCertificateProperties" + }, + "location": { + "type": "string" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "NginxCertificateListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxCertificate" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "NginxConfigurationFile": { + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "virtualPath": { + "type": "string" + } + } + }, + "NginxConfigurationPackage": { + "type": "object", + "properties": { + "data": { + "type": "string" + }, + "protectedFiles": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "NginxConfigurationProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "files": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxConfigurationFile" + }, + "x-ms-identifiers": [] + }, + "protectedFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxConfigurationFile" + }, + "x-ms-identifiers": [] + }, + "package": { + "$ref": "#/definitions/NginxConfigurationPackage" + }, + "rootFile": { + "type": "string" + } + } + }, + "NginxConfiguration": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/NginxConfigurationProperties" + }, + "location": { + "type": "string" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "NginxConfigurationListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/NginxConfiguration" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ResourceProviderDefaultErrorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + } + } + }, + "IdentityType": { + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IdentityType" + } + }, + "UserIdentityProperties": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "readOnly": true + }, + "clientId": { + "type": "string", + "readOnly": true + } + } + }, + "ResourceSku": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the SKU.", + "type": "string" + } + } + }, + "IdentityProperties": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "readOnly": true + }, + "tenantId": { + "type": "string", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/IdentityType" + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentityProperties" + } + } + } + }, + "NginxPrivateIPAllocationMethod": { + "enum": [ + "Static", + "Dynamic" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "NginxPrivateIPAllocationMethod" + } + }, + "NginxPrivateIPAddress": { + "type": "object", + "properties": { + "privateIPAddress": { + "type": "string" + }, + "privateIPAllocationMethod": { + "$ref": "#/definitions/NginxPrivateIPAllocationMethod" + }, + "subnetId": { + "type": "string" + } + } + }, + "NginxPublicIPAddress": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + }, + "NginxFrontendIPConfiguration": { + "type": "object", + "properties": { + "publicIPAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxPublicIPAddress" + }, + "x-ms-identifiers": [] + }, + "privateIPAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxPrivateIPAddress" + }, + "x-ms-identifiers": [] + } + } + }, + "NginxNetworkInterfaceConfiguration": { + "type": "object", + "properties": { + "subnetId": { + "type": "string" + } + } + }, + "NginxNetworkProfile": { + "type": "object", + "properties": { + "frontEndIPConfiguration": { + "$ref": "#/definitions/NginxFrontendIPConfiguration" + }, + "networkInterfaceConfiguration": { + "$ref": "#/definitions/NginxNetworkInterfaceConfiguration" + } + } + }, + "NginxStorageAccount": { + "type": "object", + "properties": { + "accountName": { + "type": "string" + }, + "containerName": { + "type": "string" + } + } + }, + "NginxLogging": { + "type": "object", + "properties": { + "storageAccount": { + "$ref": "#/definitions/NginxStorageAccount" + } + } + }, + "NginxDeploymentScalingProperties": { + "type": "object", + "properties": { + "capacity": { + "format": "int32", + "type": "integer", + "example": 20 + } + } + }, + "NginxDeploymentUserProfile": { + "type": "object", + "properties": { + "preferredEmail": { + "type": "string", + "format": "email", + "pattern": "^$|^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$", + "description": "The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address.", + "example": [ + "", + "john.doe@example.com", + "tom@example.com" + ] + } + } + }, + "NginxDeploymentProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "nginxVersion": { + "type": "string", + "readOnly": true + }, + "managedResourceGroup": { + "type": "string", + "description": "The managed resource group to deploy VNet injection related network resources." + }, + "networkProfile": { + "$ref": "#/definitions/NginxNetworkProfile" + }, + "ipAddress": { + "type": "string", + "description": "The IP address of the deployment.", + "readOnly": true + }, + "enableDiagnosticsSupport": { + "type": "boolean" + }, + "logging": { + "$ref": "#/definitions/NginxLogging" + }, + "scalingProperties": { + "$ref": "#/definitions/NginxDeploymentScalingProperties" + }, + "userProfile": { + "$ref": "#/definitions/NginxDeploymentUserProfile" + } + } + }, + "NginxDeployment": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/IdentityProperties" + }, + "properties": { + "$ref": "#/definitions/NginxDeploymentProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "location": { + "type": "string" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "NginxDeploymentUpdateProperties": { + "type": "object", + "properties": { + "enableDiagnosticsSupport": { + "type": "boolean" + }, + "logging": { + "$ref": "#/definitions/NginxLogging" + }, + "scalingProperties": { + "$ref": "#/definitions/NginxDeploymentScalingProperties" + }, + "userProfile": { + "$ref": "#/definitions/NginxDeploymentUserProfile" + } + } + }, + "NginxDeploymentUpdateParameters": { + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/IdentityProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "location": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/NginxDeploymentUpdateProperties" + } + } + }, + "NginxDeploymentListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxDeployment" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider: Nginx.NginxPlus", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'deployments'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write deployments'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "A Nginx.NginxPlus REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list Nginx.NginxPlus operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the Nginx.NginxPlus provider.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationResult" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "AnalysisCreate": { + "type": "object", + "description": "The request body for creating an analysis for an NGINX configuration.", + "properties": { + "config": { + "type": "object", + "properties": { + "rootFile": { + "type": "string", + "description": "The root file of the NGINX config file(s). It must match one of the files' filepath." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxConfigurationFile" + }, + "x-ms-identifiers": [] + }, + "protectedFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/NginxConfigurationFile" + }, + "x-ms-identifiers": [] + }, + "package": { + "$ref": "#/definitions/NginxConfigurationPackage" + } + } + } + }, + "required": [ + "config" + ] + }, + "AnalysisResult": { + "type": "object", + "description": "The response body for an analysis request. Contains the status of the analysis and any errors.", + "required": [ + "status" + ], + "properties": { + "status": { + "type": "string", + "description": "The status of the analysis." + }, + "data": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/AnalysisError" + } + } + } + } + } + }, + "AnalysisError": { + "type": "object", + "description": "An error object found during the analysis of an NGINX configuration.", + "required": [ + "directive", + "description", + "file", + "line", + "message", + "rule" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the error" + }, + "directive": { + "type": "string", + "example": "worker_processes" + }, + "description": { + "type": "string", + "example": "Directives outside the http context are not allowed" + }, + "file": { + "type": "string", + "description": "the filepath of the most relevant config file", + "example": "nginx.conf" + }, + "line": { + "type": "number", + "example": 2 + }, + "message": { + "type": "string", + "example": "You are not allowed to set the worker_processes directive" + }, + "rule": { + "type": "string", + "example": "nginx-azure-load-balancer-allowed-directives" + } + } + } + }, + "parameters": { + "DeploymentNameParameter": { + "in": "path", + "name": "deploymentName", + "description": "The name of targeted NGINX deployment", + "pattern": "^([a-z0-9A-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]|[a-z0-9A-Z])$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/nginx/resource-manager/readme.md b/specification/nginx/resource-manager/readme.md index e5d413732343..5411ab03b865 100644 --- a/specification/nginx/resource-manager/readme.md +++ b/specification/nginx/resource-manager/readme.md @@ -28,9 +28,19 @@ These are the global settings for the Nginx API. title: NginxManagementClient openapi-type: arm openapi-subtype: rpaas -tag: package-2023-04-01 +tag: package-2023-09-01 ``` +### Tag: package-2023-09-01 + +These settings apply only when `--tag=package-2023-09-01` is specified on the command line. + +``` yaml $(tag) == 'package-2023-09-01' +input-file: +- NGINX.NGINXPLUS/stable/2023-09-01/swagger.json +``` + + ### Tag: package-2023-04-01 These settings apply only when `--tag=package-2023-04-01` is specified on the command line. diff --git a/specification/offazurespringboot/resource-manager/readme.java.md b/specification/offazurespringboot/resource-manager/readme.java.md index 8cd71e1b9e68..c958e16f6d64 100644 --- a/specification/offazurespringboot/resource-manager/readme.java.md +++ b/specification/offazurespringboot/resource-manager/readme.java.md @@ -3,33 +3,8 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.azure.resourcemanager.springappdiscovery -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-resourcemanager-springappdiscovery -title: SpringAppsDiscoveryClient +title: SpringAppDiscoveryMgmtClient description: "Spring App Discovery Client" +service-name: "Spring App Discovery" +client-flattened-annotation-target: disabled ``` - - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2023-01-01-preview -``` - -### Tag: package-2023-01-01-preview and java - -These settings apply only when `--tag=package-2023-01-01-preview` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2023-01-01-preview' && $(java) && $(multiapi) -java: - namespace: com.azure.resourcemanager.springappdiscovery.v2023-01-01-preview - output-folder: $(azure-libraries-for-java-folder)/springappdiscovery/resource-manager/v2023-01-01-preview -regenerate-manager: true -generate-interface: true -``` \ No newline at end of file diff --git a/specification/offazurespringboot/resource-manager/readme.md b/specification/offazurespringboot/resource-manager/readme.md index 6f6b93b163db..1ae3b9616e03 100644 --- a/specification/offazurespringboot/resource-manager/readme.md +++ b/specification/offazurespringboot/resource-manager/readme.md @@ -30,6 +30,11 @@ openapi-subtype: rpaas tag: package-2023-01-01-preview ``` +``` yaml +modelerfour: + flatten-models: false +``` + ### Tag: package-2021-01-03-preview These settings apply only when `--tag=package-2021-01-03-preview` is specified on the command line. diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/aodg.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/aodg.json new file mode 100644 index 000000000000..51b68b154330 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/aodg.json @@ -0,0 +1,1672 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-03-01-preview", + "title": "Azure Orbital", + "description": "Azure Orbital service.", + "license": { + "name": "Microsoft" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Orbital/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Orbital Rest API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/groundStations": { + "get": { + "tags": [ + "Ground Station" + ], + "description": "Return list of ground stations.", + "operationId": "GroundStations_ListBySubscription", + "x-ms-examples": { + "List of Ground Stations by Subscription": { + "$ref": "./examples/GroundStationsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Ground Station resources.", + "schema": { + "$ref": "#/definitions/GroundStationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/groundStations": { + "get": { + "tags": [ + "Ground Station" + ], + "description": "Return list of ground stations.", + "operationId": "GroundStations_List", + "x-ms-examples": { + "List of Ground Stations": { + "$ref": "./examples/GroundStationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Ground Station resources.", + "schema": { + "$ref": "#/definitions/GroundStationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/groundStations/{groundStationName}": { + "get": { + "tags": [ + "Ground Station" + ], + "operationId": "GroundStations_Get", + "description": "Gets the specified ground station in a specified resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/groundStationNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ground station resource.", + "schema": { + "$ref": "#/definitions/GroundStation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get GroundStation": { + "$ref": "./examples/GroundStationGet.json" + } + } + }, + "put": { + "tags": [ + "Ground Station" + ], + "description": "Creates or updates a ground station resource.", + "operationId": "GroundStations_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/groundStationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/GroundStation" + }, + "description": "The parameters to provide for the created ground station." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ground station resource.", + "schema": { + "$ref": "#/definitions/GroundStation" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ground station resource.", + "schema": { + "$ref": "#/definitions/GroundStation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a ground station": { + "$ref": "./examples/GroundStationCreate.json" + } + } + }, + "patch": { + "tags": [ + "Ground Station" + ], + "operationId": "GroundStations_UpdateTags", + "x-ms-examples": { + "Update Ground Station tags": { + "$ref": "./examples/GroundStationUpdateTags.json" + } + }, + "description": "Updates the specified ground station tags.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update ground station tags." + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/groundStationNameParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Ground Station resource.", + "schema": { + "$ref": "#/definitions/GroundStation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Ground Station" + ], + "operationId": "GroundStations_Delete", + "description": "Deletes a specified ground station resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/groundStationNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Ground Station": { + "$ref": "./examples/GroundStationDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/edgeSites/{edgeSiteName}": { + "get": { + "tags": [ + "Edge Site" + ], + "operationId": "EdgeSites_Get", + "description": "Gets the specified edge site in a specified resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/edgeSiteNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting EdgeSite resource.", + "schema": { + "$ref": "#/definitions/EdgeSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Edge Site": { + "$ref": "./examples/EdgeSiteGet.json" + } + } + }, + "put": { + "tags": [ + "Edge Site" + ], + "description": "Creates or updates an edge site.", + "operationId": "EdgeSites_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/edgeSiteNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/EdgeSite" + }, + "description": "The parameters to provide for the created Edge Site." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting EdgeSite resource.", + "schema": { + "$ref": "#/definitions/EdgeSite" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting EdgeSite resource.", + "schema": { + "$ref": "#/definitions/EdgeSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Edge Site": { + "$ref": "./examples/EdgeSiteCreate.json" + } + } + }, + "delete": { + "tags": [ + "Edge Site" + ], + "operationId": "EdgeSites_Delete", + "description": "Deletes a specified edge site resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/edgeSiteNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Edge Site": { + "$ref": "./examples/EdgeSiteDelete.json" + } + } + }, + "patch": { + "tags": [ + "Edge Site" + ], + "operationId": "EdgeSites_UpdateTags", + "x-ms-examples": { + "Update Edge Site tags": { + "$ref": "./examples/EdgeSiteUpdateTag.json" + } + }, + "description": "Updates the specified edge site's tags.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update the edge site's tags." + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/edgeSiteNameParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Edge Site resource.", + "schema": { + "$ref": "#/definitions/EdgeSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/edgeSites": { + "get": { + "tags": [ + "Edge Site" + ], + "description": "Returns a list of edge sites for a subscription.", + "operationId": "EdgeSites_ListBySubscription", + "x-ms-examples": { + "List of Edge Sites by Subscription": { + "$ref": "./examples/EdgeSitesBySubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of edge site resources.", + "schema": { + "$ref": "#/definitions/EdgeSiteListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/edgeSites": { + "get": { + "tags": [ + "Edge Site" + ], + "description": "Returns a list of edge sites for a resource group.", + "operationId": "EdgeSites_List", + "x-ms-examples": { + "List of Edge Sites by Resource Group": { + "$ref": "./examples/EdgeSitesByResourceGroupList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of edge site resources.", + "schema": { + "$ref": "#/definitions/EdgeSiteListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/l2Connections/{l2ConnectionName}": { + "get": { + "tags": [ + "L2 Connection" + ], + "operationId": "L2Connections_Get", + "description": "Gets the specified L2 connection in a specified resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/l2ConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting L2Connection resource.", + "schema": { + "$ref": "#/definitions/L2Connection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get L2 Connection": { + "$ref": "./examples/L2ConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "L2 Connection" + ], + "description": "Creates or updates an L2 Connection.", + "operationId": "L2Connections_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/l2ConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/L2Connection" + }, + "description": "The parameters to provide for the created L2 Connection." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting L2Connection resource.", + "schema": { + "$ref": "#/definitions/L2Connection" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting L2Connection resource.", + "schema": { + "$ref": "#/definitions/L2Connection" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "URL for checking the ongoing status of the operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create L2 Connection": { + "$ref": "./examples/L2ConnectionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "L2 Connection" + ], + "operationId": "L2Connections_Delete", + "description": "Deletes a specified L2 Connection resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/l2ConnectionNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete L2 Connection": { + "$ref": "./examples/L2ConnectionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "L2 Connection" + ], + "operationId": "L2Connections_UpdateTags", + "x-ms-examples": { + "Update L2 Connection tags": { + "$ref": "./examples/L2ConnectionUpdateTag.json" + } + }, + "description": "Updates the specified L2 Connection's tags.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update the L2 Connection's tags." + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/l2ConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting L2 Connection resource.", + "schema": { + "$ref": "#/definitions/L2Connection" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/l2Connections": { + "get": { + "tags": [ + "L2 Connection" + ], + "description": "Returns a list of L2 Connections attached to an orbital gateway.", + "operationId": "L2Connections_List", + "x-ms-examples": { + "List of L2 Connections by Resource Group": { + "$ref": "./examples/L2ConnectionsByResourceGroupList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of L2 Connection resources.", + "schema": { + "$ref": "#/definitions/L2ConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/l2Connections": { + "get": { + "tags": [ + "L2 Connection" + ], + "description": "Returns a list of L2 Connections attached to a subscription.", + "operationId": "L2Connections_ListBySubscription", + "x-ms-examples": { + "List of L2 Connections by Subscription": { + "$ref": "./examples/L2ConnectionsBySubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of L2 Connection resources.", + "schema": { + "$ref": "#/definitions/L2ConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/edgeSites/{edgeSiteName}/listL2Connections": { + "post": { + "tags": [ + "L2 Connection" + ], + "description": "Returns a list of L2 Connections attached to an edge site.", + "operationId": "EdgeSites_ListL2Connections", + "x-ms-examples": { + "List of L2 Connections by Edge site": { + "$ref": "./examples/L2ConnectionsByEdgeSiteNameList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/edgeSiteNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of L2 Connection resources.", + "schema": { + "$ref": "#/definitions/ResourceIdListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/groundStations/{groundStationName}/listL2Connections": { + "post": { + "tags": [ + "L2 Connection" + ], + "description": "Returns a list of L2 Connections attached to an ground station.", + "operationId": "GroundStations_ListL2Connections", + "x-ms-examples": { + "List of L2 Connections by Ground Station": { + "$ref": "./examples/L2ConnectionsByGroundStationNameList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/groundStationNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of L2 Connection resources.", + "schema": { + "$ref": "#/definitions/ResourceIdListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/globalCommunicationsSites": { + "get": { + "tags": [ + "Global Communications Site" + ], + "description": "Returns a list of the global communications sites that a subscription is authorized to use.", + "operationId": "GlobalCommunicationsSites_ListBySubscription", + "x-ms-examples": { + "List of Global Communications Sites": { + "$ref": "./examples/GlobalCommunicationsSitesBySubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of global communications sites.", + "schema": { + "$ref": "#/definitions/GlobalCommunicationsSiteListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/globalCommunicationsSites/{globalCommunicationsSiteName}": { + "get": { + "tags": [ + "Global Communications Site" + ], + "operationId": "GlobalCommunicationsSites_Get", + "description": "Gets the specified global communications site in a specified resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/globalCommunicationsSiteNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting GlobalCommunicationsSite.", + "schema": { + "$ref": "#/definitions/GlobalCommunicationsSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Global Communications Site": { + "$ref": "./examples/GlobalCommunicationsSiteGet.json" + } + } + } + } + }, + "definitions": { + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "GroundStationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GroundStation" + }, + "description": "A list of ground station resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListGroundStations API service call." + }, + "GroundStation": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/GroundStationsProperties" + } + ], + "description": "Properties of the Ground Station." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Ground Station contains one or more antennas." + }, + "Capability": { + "type": "string", + "description": "Capability of the Ground Station.", + "enum": [ + "EarthObservation", + "Communication" + ], + "x-ms-enum": { + "name": "Capability", + "modelAsString": true + } + }, + "EdgeSitesProperties": { + "type": "object", + "required": [ + "globalCommunicationsSite" + ], + "properties": { + "globalCommunicationsSite": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "A reference to global communications site." + } + }, + "description": "Properties object for an edge site." + }, + "PartnerRouter": { + "type": "object", + "readOnly": true, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The unique name of the partnerRouter." + } + }, + "description": "One of the partner routers within a global communications site." + }, + "LocationData": { + "type": "object", + "required": [ + "city", + "district", + "country" + ], + "properties": { + "city": { + "type": "string", + "description": "The city of the location (e.g., Miami)." + }, + "district": { + "type": "string", + "description": "For example, the state (e.g., Florida), province (e.g., Ontario), or region (e.g., Tuscany) of the location." + }, + "country": { + "type": "string", + "description": "The nation (e.g., United States of America) of the location." + }, + "closestAzureRegion": { + "type": "string", + "description": "The name of the closest Azure region, (e.g., westus2)." + }, + "extra": { + "type": "string", + "x-nullable": true, + "description": "Any extra information needed to uniquely identify the location (e.g., zip code)." + } + }, + "description": "Describes a location outside of Azure." + }, + "GlobalCommunicationsSiteType": { + "type": "string", + "enum": [ + "Edge", + "GroundStation" + ], + "x-ms-enum": { + "name": "GlobalCommunicationsSiteType", + "modelAsString": true + }, + "description": "The type of the global communications site. groundStations can only use sites of type GroundStation, and edgeSites can only use sites of type Edge." + }, + "GlobalCommunicationsSitesProperties": { + "type": "object", + "properties": { + "locationData": { + "allOf": [ + { + "$ref": "#/definitions/LocationData" + } + ], + "description": "Describes the location of the global communications site." + }, + "globalCommunicationsSiteType": { + "type": "string", + "allOf": [ + { + "$ref": "#/definitions/GlobalCommunicationsSiteType" + } + ], + "description": "The type of the global communications site. EdgeSite or GroundStation." + }, + "partnerRouters": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PartnerRouter" + }, + "x-ms-identifiers": [], + "description": "Partner routers connected to this site." + }, + "partnerSiteBandwidth": { + "type": "integer", + "format": "int64", + "minimum": 0, + "readOnly": true, + "description": "The bandwidth per partner router cross-connection at this global communications site, measured in bits per second." + } + }, + "description": "Properties object for a global communications site." + }, + "GlobalCommunicationsSite": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/GlobalCommunicationsSitesProperties" + } + ], + "description": "The properties bag for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "A site where the Orbital network is connected to a partner network." + }, + "GlobalCommunicationsSiteListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GlobalCommunicationsSite" + }, + "description": "A list of global communications sites." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for an API service call that lists Global Communications Sites." + }, + "EdgeSite": { + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/EdgeSitesProperties" + } + ], + "description": "The properties bag for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A customer's reference to a global communications site site." + }, + "EdgeSiteListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EdgeSite" + }, + "description": "A list of edge site resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for an API service call that lists Edge Sites." + }, + "L2ConnectionsProperties": { + "type": "object", + "required": [ + "edgeSite", + "edgeSitePartnerRouter", + "groundStation", + "groundStationPartnerRouter", + "vlanId" + ], + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "allOf": [ + { + "$ref": "#/definitions/ProvisioningState" + } + ], + "description": "The current state of the resource's creation, deletion, or modification." + }, + "circuitId": { + "type": "string", + "readOnly": true, + "description": "Globally-unique identifier for this connection that is to be used as a circuit ID." + }, + "edgeSite": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "A reference to an Microsoft.Orbital/edgeSites resource to route traffic for." + }, + "edgeSitePartnerRouter": { + "type": "object", + "x-ms-client-flatten": true, + "required": [ + "name" + ], + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "name": { + "type": "string", + "description": "The unique name of the partner router that cross-connects with the Orbital Edge Router at the edge site." + } + }, + "description": "The name of the partner router that cross-connects with the Orbital Edge Router at the edge site." + }, + "groundStation": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "A reference to an Microsoft.Orbital/groundStations resource to route traffic for." + }, + "groundStationPartnerRouter": { + "type": "object", + "x-ms-client-flatten": true, + "required": [ + "name" + ], + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "name": { + "type": "string", + "description": "The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site." + } + }, + "description": "The name of the partner router to establish a connection to within the ground station." + }, + "vlanId": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4094, + "description": "The VLAN ID for the L2 connection." + } + }, + "description": "Properties object for an L2 Connection." + }, + "L2Connection": { + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/L2ConnectionsProperties" + } + ], + "description": "The properties bag for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Connects an edge site to an orbital gateway and describes what layer 2 traffic to forward between them." + }, + "L2ConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/L2Connection" + }, + "description": "A list of L2 Connection resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for an API service call that lists L2 Connections." + }, + "ResourceIdListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The Azure Resource ID." + } + } + }, + "description": "A list of Azure Resource IDs." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for an API service call that lists the resource IDs of resources associated with another resource." + }, + "ProvisioningState": { + "type": "string", + "enum": [ + "Creating", + "Succeeded", + "Failed", + "Canceled", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The current state of the resource's creation, deletion, or modification.", + "readOnly": true + }, + "GroundStationsProperties": { + "type": "object", + "required": [ + "capabilities", + "globalCommunicationsSite" + ], + "properties": { + "city": { + "type": "string", + "description": "City of ground station." + }, + "capabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/Capability" + }, + "description": "Ground station capabilities." + }, + "providerName": { + "type": "string", + "description": "Ground station provider name." + }, + "longitudeDegrees": { + "type": "number", + "description": "Longitude of the ground station in decimal degrees." + }, + "latitudeDegrees": { + "type": "number", + "description": "Latitude of the ground station in decimal degrees." + }, + "altitudeMeters": { + "type": "number", + "description": "Altitude of the ground station." + }, + "releaseMode": { + "type": "string", + "enum": [ + "Preview", + "GA" + ], + "x-ms-enum": { + "name": "releaseMode", + "modelAsString": true + }, + "readOnly": true, + "description": "Release Status of a ground station." + }, + "globalCommunicationsSite": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "A reference to global communications site." + } + }, + "description": "List of ground station resource properties." + }, + "ProvisionedBandwidth": { + "type": "object", + "readOnly": true, + "properties": { + "mbps": { + "type": "integer", + "format": "int32", + "minimum": 0, + "readOnly": true, + "description": "The approximate number of megabits per second that are provisioned for the partner on this global communications site." + } + }, + "description": "The approximate bandwidth provisioned for a partner on a global communications site." + }, + "ResourceReference": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Resource Reference." + } + }, + "parameters": { + "groundStationNameParameter": { + "name": "groundStationName", + "in": "path", + "required": true, + "type": "string", + "description": "Ground Station name.", + "pattern": "^[A-Za-z][A-Za-z0-9-_]+$", + "minLength": 2, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "capabilityParameter": { + "name": "capability", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "EarthObservation", + "Communication" + ], + "x-ms-enum": { + "name": "capabilityParameter", + "modelAsString": true + }, + "description": "Ground Station Capability.", + "x-ms-parameter-location": "method" + }, + "edgeSiteNameParameter": { + "name": "edgeSiteName", + "in": "path", + "description": "Edge site name.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9-_]+$", + "minLength": 2, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "l2ConnectionNameParameter": { + "name": "l2ConnectionName", + "in": "path", + "description": "L2 Connection name.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9-_]+$", + "minLength": 2, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "globalCommunicationsSiteNameParameter": { + "name": "globalCommunicationsSiteName", + "in": "path", + "description": "Global communications Site name.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9-_]+$", + "minLength": 2, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "skipTokenParameter": { + "name": "$skiptoken", + "description": "An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous list operation call 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" + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteCreate.json new file mode 100644 index 000000000000..6b4a9fe28496 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteCreate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "edgeSiteName": "es1", + "parameters": { + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "es1", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1", + "type": "Microsoft.Orbital/edgeSites", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + } + } + }, + "201": { + "body": { + "name": "es1", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1", + "type": "Microsoft.Orbital/edgeSites", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteDelete.json new file mode 100644 index 000000000000..ac6ab7600a99 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "edgeSiteName": "oep1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteGet.json new file mode 100644 index 000000000000..00904d83c047 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "edgeSiteName": "es1" + }, + "responses": { + "200": { + "body": { + "name": "es1", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1", + "type": "Microsoft.Orbital/edgeSites", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteUpdateTag.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteUpdateTag.json new file mode 100644 index 000000000000..e43ea016f118 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSiteUpdateTag.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "edgeSiteName": "oep1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "oep1", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/oep1", + "type": "Microsoft.Orbital/edgeSites", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSitesByResourceGroupList.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSitesByResourceGroupList.json new file mode 100644 index 000000000000..1059f19efedc --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSitesByResourceGroupList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "oep1", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/oep1", + "type": "Microsoft.Orbital/edgeSites", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + } + } + ], + "nextLink": "https://example.com" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSitesBySubscriptionList.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSitesBySubscriptionList.json new file mode 100644 index 000000000000..1ebd30f4e1a1 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/EdgeSitesBySubscriptionList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "oep1", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/oep1", + "type": "Microsoft.Orbital/edgeSites", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + } + } + ], + "nextLink": "https://example.com" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GlobalCommunicationsSiteGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GlobalCommunicationsSiteGet.json new file mode 100644 index 000000000000..ec7b99c81636 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GlobalCommunicationsSiteGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "globalCommunicationsSiteName": "contoso-Vernon" + }, + "responses": { + "200": { + "body": { + "name": "contoso-Vernon", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon", + "type": "Microsoft.Orbital/globalCommunicationsSites", + "properties": { + "locationData": { + "city": "Vernon", + "district": "Texas", + "country": "United States of America", + "extra": "Zip code: 76384", + "closestAzureRegion": "southcentralus" + }, + "globalCommunicationsSiteType": "GroundStation", + "partnerRouters": [ + { + "name": "contoso-pr1" + }, + { + "name": "contoso-pr2" + } + ], + "partnerSiteBandwidth": 100000000 + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GlobalCommunicationsSitesBySubscriptionList.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GlobalCommunicationsSitesBySubscriptionList.json new file mode 100644 index 000000000000..89d90d66c3c9 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GlobalCommunicationsSitesBySubscriptionList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contoso-Vernon", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon", + "type": "Microsoft.Orbital/globalCommunicationsSites", + "properties": { + "locationData": { + "city": "Vernon", + "district": "Texas", + "country": "United States of America", + "extra": "Zip code: 76384", + "closestAzureRegion": "southcentralus" + }, + "globalCommunicationsSiteType": "GroundStation", + "partnerRouters": [ + { + "name": "contoso-pr1" + }, + { + "name": "contoso-pr2" + } + ], + "partnerSiteBandwidth": 100000000 + } + } + ], + "nextLink": "https://example.com" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationCreate.json new file mode 100644 index 000000000000..1169039ad05e --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "groundStationName": "westus_gs1", + "parameters": { + "location": "westus", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "capabilities": [ + "Communication" + ], + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83, + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "westus_gs1", + "location": "westus", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/westus_gs1", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "capabilities": [ + "Communication" + ], + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83, + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + }, + "type": "Microsoft.Orbital/groundStations", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "201": { + "body": { + "name": "westus_gs1", + "location": "westus", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/westus_gs1", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "capabilities": [ + "Communication" + ], + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83, + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + }, + "type": "Microsoft.Orbital/groundStations", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationDelete.json new file mode 100644 index 000000000000..040c5e7598b1 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "groundStationName": "westus_gs1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationGet.json new file mode 100644 index 000000000000..c0ef85300149 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "groundStationName": "westus_gs1" + }, + "responses": { + "200": { + "body": { + "name": "westus_gs1", + "location": "westus", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/westus_gs1", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "capabilities": [ + "Communication" + ], + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83, + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + }, + "type": "Microsoft.Orbital/groundStations", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationUpdateTags.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationUpdateTags.json new file mode 100644 index 000000000000..c27ebade8e7e --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationUpdateTags.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "groundStationName": "westus_gs1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "westus_gs1", + "location": "westus", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/westus_gs1", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "capabilities": [ + "Communication" + ], + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83, + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + }, + "type": "Microsoft.Orbital/groundStations", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationsBySubscription.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationsBySubscription.json new file mode 100644 index 000000000000..8fb292473dd2 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationsBySubscription.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "westus_gs1", + "location": "westus", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/westus_gs1", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "capabilities": [ + "Communication" + ], + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83, + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + }, + "type": "Microsoft.Orbital/groundStations", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationsList.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationsList.json new file mode 100644 index 000000000000..4ba22f889033 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/GroundStationsList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "westus_gs1", + "location": "westus", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/westus_gs1", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "capabilities": [ + "Communication" + ], + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83, + "globalCommunicationsSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon" + } + }, + "type": "Microsoft.Orbital/groundStations", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionCreate.json new file mode 100644 index 000000000000..9891cb60445c --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionCreate.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "l2ConnectionName": "connection1", + "parameters": { + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "edgeSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1" + }, + "edgeSitePartnerRouter": { + "name": "customerName-SiteName-01" + }, + "groundStation": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/gs1" + }, + "groundStationPartnerRouter": { + "name": "customerName-SiteName-01" + }, + "vlanId": 200 + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + }, + "body": { + "name": "connection1", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/l2Connections/connection1", + "type": "Microsoft.Orbital/l2Connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "circuitId": "12345", + "edgeSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1" + }, + "edgeSitePartnerRouter": { + "name": "customerName-SiteName-01" + }, + "groundStation": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/gs1" + }, + "groundStationPartnerRouter": { + "name": "customerName-SiteName-01" + }, + "vlanId": 200 + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + }, + "body": { + "name": "connection1", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/l2Connections/connection1", + "type": "Microsoft.Orbital/l2Connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "circuitId": "12345", + "edgeSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1" + }, + "edgeSitePartnerRouter": { + "name": "customerName-SiteName-01" + }, + "groundStation": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/gs1" + }, + "groundStationPartnerRouter": { + "name": "customerName-SiteName-01" + }, + "vlanId": 200 + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionDelete.json new file mode 100644 index 000000000000..a8c60efa5828 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "l2ConnectionName": "connection1" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + } + }, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionGet.json new file mode 100644 index 000000000000..e2ee7d423473 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "l2ConnectionName": "connection1" + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/l2Connections/connection1", + "type": "Microsoft.Orbital/l2Connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "circuitId": "12345", + "edgeSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1" + }, + "edgeSitePartnerRouter": { + "name": "customerName-SiteName-01" + }, + "groundStation": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/gs1" + }, + "groundStationPartnerRouter": { + "name": "customerName-SiteName-01" + }, + "vlanId": 200 + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionUpdateTag.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionUpdateTag.json new file mode 100644 index 000000000000..6c8d9543c6b9 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionUpdateTag.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "l2ConnectionName": "connection1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + } + }, + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/l2Connections/connection1", + "type": "Microsoft.Orbital/l2Connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "circuitId": "12345", + "edgeSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/oep1" + }, + "edgeSitePartnerRouter": { + "name": "customerName-SiteName-01" + }, + "groundStation": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/oep1" + }, + "groundStationPartnerRouter": { + "name": "customerName-SiteName-01" + }, + "vlanId": 200 + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsByEdgeSiteNameList.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsByEdgeSiteNameList.json new file mode 100644 index 000000000000..0194134bafa8 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsByEdgeSiteNameList.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "edgeSiteName": "oep1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/l2Connections/connection1" + } + ], + "nextLink": "https://example.com" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsByGroundStationNameList.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsByGroundStationNameList.json new file mode 100644 index 000000000000..31ed669b1d9b --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsByGroundStationNameList.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "groundStationName": "gs1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/l2Connections/connection1" + } + ], + "nextLink": "https://example.com" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsByResourceGroupList.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsByResourceGroupList.json new file mode 100644 index 000000000000..db4168ba98a2 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsByResourceGroupList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "rg1", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "connection1", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/l2Connections/connection1", + "type": "Microsoft.Orbital/l2Connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "circuitId": "12345", + "edgeSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/oep1" + }, + "edgeSitePartnerRouter": { + "name": "customerName-SiteName-01" + }, + "groundStation": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/oep1" + }, + "groundStationPartnerRouter": { + "name": "customerName-SiteName-01" + }, + "vlanId": 200 + } + } + ], + "nextLink": "https://example.com" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsBySubscriptionList.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsBySubscriptionList.json new file mode 100644 index 000000000000..a265742dc265 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/L2ConnectionsBySubscriptionList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "connection1", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/l2Connections/connection1", + "type": "Microsoft.Orbital/l2Connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "circuitId": "12345", + "edgeSite": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/oep1" + }, + "edgeSitePartnerRouter": { + "name": "customerName-SiteName-01" + }, + "groundStation": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/oep1" + }, + "groundStationPartnerRouter": { + "name": "customerName-SiteName-01" + }, + "vlanId": 200 + } + } + ], + "nextLink": "https://example.com" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/OperationsList.json b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..e9a4265e5618 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/aodg/preview/2024-03-01-preview/examples/OperationsList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Orbital/l2Connections/read", + "isDataAction": false, + "display": { + "provider": "Orbital Resource Provider", + "resource": "L2 Connections", + "operation": "Read L2 Connection", + "description": "Read any L2 Connection" + } + } + ] + } + } + } +} diff --git a/specification/orbital/resource-manager/readme.md b/specification/orbital/resource-manager/readme.md index 9d06f36190eb..41651639fae9 100644 --- a/specification/orbital/resource-manager/readme.md +++ b/specification/orbital/resource-manager/readme.md @@ -29,6 +29,15 @@ openapi-type: arm tag: package-2022-11-01 ``` +### Tag: package-2024-03-01-preview + +These settings apply only when `--tag=package-2024-03-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-03-01-preview' +input-file: + - Microsoft.Orbital/aodg/preview/2024-03-01-preview/aodg.json +``` + ### Tag: package-2022-11-01 These settings apply only when `--tag=package-2022-11-01` is specified on the command line. diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/PaloAltoNetworks.Cloudngfw.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/PaloAltoNetworks.Cloudngfw.json new file mode 100644 index 000000000000..e5518166bcb2 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/PaloAltoNetworks.Cloudngfw.json @@ -0,0 +1,7441 @@ +{ + "swagger": "2.0", + "info": { + "title": "PaloAltoNetworks.Cloudngfw", + "version": "2024-01-19-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "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" + } + } + }, + "tags": [ + { + "name": "Firewalls" + }, + { + "name": "FirewallStatus" + }, + { + "name": "GlobalRulestack" + }, + { + "name": "LocalRulestacks" + }, + { + "name": "LocalRules" + }, + { + "name": "PreRules" + }, + { + "name": "PostRules" + }, + { + "name": "PrefixListLocalRulestack" + }, + { + "name": "PrefixListGlobalRulestack" + }, + { + "name": "FqdnListLocalRulestack" + }, + { + "name": "FqdnListGlobalRulestack" + }, + { + "name": "CertificateObjectLocalRulestack" + }, + { + "name": "CertificateObjectGlobalRulestack" + }, + { + "name": "Operations" + } + ], + "paths": { + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks": { + "get": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_List", + "description": "List GlobalRulestackResource resources by Tenant", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GlobalRulestack_List_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_List_MaximumSet_Gen.json" + }, + "GlobalRulestack_List_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_List_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}": { + "get": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_Get", + "description": "Get a GlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_Get_MaximumSet_Gen.json" + }, + "GlobalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_CreateOrUpdate", + "description": "Create a GlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GlobalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "GlobalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_Update", + "description": "Update a GlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_Update_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_Update_MaximumSet_Gen.json" + }, + "GlobalRulestack_Update_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_Delete", + "description": "Delete a GlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GlobalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_Delete_MaximumSet_Gen.json" + }, + "GlobalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/certificates": { + "get": { + "tags": [ + "CertificateObjectGlobalRulestack" + ], + "operationId": "CertificateObjectGlobalRulestack_List", + "description": "List CertificateObjectGlobalRulestackResource resources by Tenant", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectGlobalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CertificateObjectGlobalRulestack_List_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_List_MaximumSet_Gen.json" + }, + "CertificateObjectGlobalRulestack_List_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_List_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/certificates/{name}": { + "get": { + "tags": [ + "CertificateObjectGlobalRulestack" + ], + "operationId": "CertificateObjectGlobalRulestack_Get", + "description": "Get a CertificateObjectGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/CertificateObjectGlobalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectGlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "CertificateObjectGlobalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_Get_MaximumSet_Gen.json" + }, + "CertificateObjectGlobalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "CertificateObjectGlobalRulestack" + ], + "operationId": "CertificateObjectGlobalRulestack_CreateOrUpdate", + "description": "Create a CertificateObjectGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/CertificateObjectGlobalRulestackResource.name" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/CertificateObjectGlobalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectGlobalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectGlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CertificateObjectGlobalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "CertificateObjectGlobalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "CertificateObjectGlobalRulestack" + ], + "operationId": "CertificateObjectGlobalRulestack_Delete", + "description": "Delete a CertificateObjectGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/CertificateObjectGlobalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CertificateObjectGlobalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_Delete_MaximumSet_Gen.json" + }, + "CertificateObjectGlobalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/commit": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_commit", + "description": "Commit rulestack configuration", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "202": { + "description": "The request has been received but not yet acted upon." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GlobalRulestack_commit_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_commit_MaximumSet_Gen.json" + }, + "GlobalRulestack_commit_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_commit_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/fqdnlists": { + "get": { + "tags": [ + "FqdnListGlobalRulestack" + ], + "operationId": "FqdnListGlobalRulestack_List", + "description": "List FqdnListGlobalRulestackResource resources by Tenant", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListGlobalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FqdnListGlobalRulestack_List_MaximumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_List_MaximumSet_Gen.json" + }, + "FqdnListGlobalRulestack_List_MinimumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_List_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/fqdnlists/{name}": { + "get": { + "tags": [ + "FqdnListGlobalRulestack" + ], + "operationId": "FqdnListGlobalRulestack_Get", + "description": "Get a FqdnListGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/FqdnListGlobalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListGlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "FqdnListGlobalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_Get_MaximumSet_Gen.json" + }, + "FqdnListGlobalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "FqdnListGlobalRulestack" + ], + "operationId": "FqdnListGlobalRulestack_CreateOrUpdate", + "description": "Create a FqdnListGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/FqdnListGlobalRulestackResource.name" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/FqdnListGlobalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListGlobalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListGlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "FqdnListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "FqdnListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "FqdnListGlobalRulestack" + ], + "operationId": "FqdnListGlobalRulestack_Delete", + "description": "Delete a FqdnListGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/FqdnListGlobalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "FqdnListGlobalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_Delete_MaximumSet_Gen.json" + }, + "FqdnListGlobalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/getChangeLog": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_getChangeLog", + "description": "Get changelog", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Changelog" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_getChangeLog_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_getChangeLog_MaximumSet_Gen.json" + }, + "GlobalRulestack_getChangeLog_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_getChangeLog_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listAdvancedSecurityObjects": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_listAdvancedSecurityObjects", + "description": "Get the list of advanced security objects", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "type", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "urlCustom", + "feeds" + ], + "x-ms-enum": { + "name": "AdvSecurityObjectTypeEnum", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/advSecurityObjectListResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen.json" + }, + "GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listAppIds": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_listAppIds", + "description": "List of AppIds for GlobalRulestack ApiVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "appIdVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "appPrefix", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListAppIdResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_listAppIds_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listAppIds_MaximumSet_Gen.json" + }, + "GlobalRulestack_listAppIds_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listAppIds_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listCountries": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_listCountries", + "description": "List of countries for Rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CountriesResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_listCountries_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listCountries_MaximumSet_Gen.json" + }, + "GlobalRulestack_listCountries_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listCountries_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listFirewalls": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_listFirewalls", + "description": "List of Firewalls associated with Rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListFirewallsResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_listFirewalls_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listFirewalls_MaximumSet_Gen.json" + }, + "GlobalRulestack_listFirewalls_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listFirewalls_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listPredefinedUrlCategories": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_listPredefinedUrlCategories", + "description": "List predefined URL categories for rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PredefinedUrlCategoriesResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen.json" + }, + "GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listSecurityServices": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_listSecurityServices", + "description": "List the security services for rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "type", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "antiSpyware", + "antiVirus", + "ipsVulnerability", + "urlFiltering", + "fileBlocking", + "dnsSubscription" + ], + "x-ms-enum": { + "name": "SecurityServicesTypeEnum", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/securityServicesResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_listSecurityServices_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listSecurityServices_MaximumSet_Gen.json" + }, + "GlobalRulestack_listSecurityServices_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listSecurityServices_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/postRules": { + "get": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_List", + "description": "List PostRulesResource resources by Tenant", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PostRulesResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PostRules_List_MaximumSet_Gen": { + "$ref": "./examples/PostRules_List_MaximumSet_Gen.json" + }, + "PostRules_List_MinimumSet_Gen": { + "$ref": "./examples/PostRules_List_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/postRules/{priority}": { + "get": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_Get", + "description": "Get a PostRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PostRulesResource.priority" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PostRulesResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PostRules_Get_MaximumSet_Gen": { + "$ref": "./examples/PostRules_Get_MaximumSet_Gen.json" + }, + "PostRules_Get_MinimumSet_Gen": { + "$ref": "./examples/PostRules_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_CreateOrUpdate", + "description": "Create a PostRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PostRulesResource.priority" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/PostRulesResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PostRulesResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/PostRulesResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PostRules_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/PostRules_CreateOrUpdate_MaximumSet_Gen.json" + }, + "PostRules_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/PostRules_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_Delete", + "description": "Delete a PostRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PostRulesResource.priority" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PostRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/PostRules_Delete_MaximumSet_Gen.json" + }, + "PostRules_Delete_MinimumSet_Gen": { + "$ref": "./examples/PostRules_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/postRules/{priority}/getCounters": { + "post": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_getCounters", + "description": "Get counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PostRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RuleCounter" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PostRules_getCounters_MaximumSet_Gen": { + "$ref": "./examples/PostRules_getCounters_MaximumSet_Gen.json" + }, + "PostRules_getCounters_MinimumSet_Gen": { + "$ref": "./examples/PostRules_getCounters_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/postRules/{priority}/refreshCounters": { + "post": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_refreshCounters", + "description": "Refresh counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PostRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "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" + } + } + }, + "x-ms-examples": { + "PostRules_refreshCounters_MaximumSet_Gen": { + "$ref": "./examples/PostRules_refreshCounters_MaximumSet_Gen.json" + }, + "PostRules_refreshCounters_MinimumSet_Gen": { + "$ref": "./examples/PostRules_refreshCounters_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/postRules/{priority}/resetCounters": { + "post": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_resetCounters", + "description": "Reset counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PostRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RuleCounterReset" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PostRules_resetCounters_MaximumSet_Gen": { + "$ref": "./examples/PostRules_resetCounters_MaximumSet_Gen.json" + }, + "PostRules_resetCounters_MinimumSet_Gen": { + "$ref": "./examples/PostRules_resetCounters_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/prefixlists": { + "get": { + "tags": [ + "PrefixListGlobalRulestack" + ], + "operationId": "PrefixListGlobalRulestack_List", + "description": "List PrefixListGlobalRulestackResource resources by Tenant", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListGlobalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrefixListGlobalRulestack_List_MaximumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_List_MaximumSet_Gen.json" + }, + "PrefixListGlobalRulestack_List_MinimumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_List_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/prefixlists/{name}": { + "get": { + "tags": [ + "PrefixListGlobalRulestack" + ], + "operationId": "PrefixListGlobalRulestack_Get", + "description": "Get a PrefixListGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PrefixListGlobalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListGlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PrefixListGlobalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_Get_MaximumSet_Gen.json" + }, + "PrefixListGlobalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "PrefixListGlobalRulestack" + ], + "operationId": "PrefixListGlobalRulestack_CreateOrUpdate", + "description": "Create a PrefixListGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PrefixListGlobalRulestackResource.name" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/PrefixListGlobalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListGlobalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListGlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrefixListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "PrefixListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "PrefixListGlobalRulestack" + ], + "operationId": "PrefixListGlobalRulestack_Delete", + "description": "Delete a PrefixListGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PrefixListGlobalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrefixListGlobalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_Delete_MaximumSet_Gen.json" + }, + "PrefixListGlobalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules": { + "get": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_List", + "description": "List PreRulesResource resources by Tenant", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PreRulesResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PreRules_List_MaximumSet_Gen": { + "$ref": "./examples/PreRules_List_MaximumSet_Gen.json" + }, + "PreRules_List_MinimumSet_Gen": { + "$ref": "./examples/PreRules_List_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules/{priority}": { + "get": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_Get", + "description": "Get a PreRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PreRulesResource.priority" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PreRulesResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PreRules_Get_MaximumSet_Gen": { + "$ref": "./examples/PreRules_Get_MaximumSet_Gen.json" + }, + "PreRules_Get_MinimumSet_Gen": { + "$ref": "./examples/PreRules_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_CreateOrUpdate", + "description": "Create a PreRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PreRulesResource.priority" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/PreRulesResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PreRulesResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/PreRulesResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PreRules_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/PreRules_CreateOrUpdate_MaximumSet_Gen.json" + }, + "PreRules_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/PreRules_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_Delete", + "description": "Delete a PreRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PreRulesResource.priority" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PreRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/PreRules_Delete_MaximumSet_Gen.json" + }, + "PreRules_Delete_MinimumSet_Gen": { + "$ref": "./examples/PreRules_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules/{priority}/getCounters": { + "post": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_getCounters", + "description": "Get counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PreRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RuleCounter" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PreRules_getCounters_MaximumSet_Gen": { + "$ref": "./examples/PreRules_getCounters_MaximumSet_Gen.json" + }, + "PreRules_getCounters_MinimumSet_Gen": { + "$ref": "./examples/PreRules_getCounters_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules/{priority}/refreshCounters": { + "post": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_refreshCounters", + "description": "Refresh counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PreRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "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" + } + } + }, + "x-ms-examples": { + "PreRules_refreshCounters_MaximumSet_Gen": { + "$ref": "./examples/PreRules_refreshCounters_MaximumSet_Gen.json" + }, + "PreRules_refreshCounters_MinimumSet_Gen": { + "$ref": "./examples/PreRules_refreshCounters_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules/{priority}/resetCounters": { + "post": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_resetCounters", + "description": "Reset counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PreRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RuleCounterReset" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PreRules_resetCounters_MaximumSet_Gen": { + "$ref": "./examples/PreRules_resetCounters_MaximumSet_Gen.json" + }, + "PreRules_resetCounters_MinimumSet_Gen": { + "$ref": "./examples/PreRules_resetCounters_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/revert": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_revert", + "description": "Revert rulestack configuration", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_revert_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_revert_MaximumSet_Gen.json" + }, + "GlobalRulestack_revert_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_revert_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet_Gen": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/PaloAltoNetworks.Cloudngfw/firewalls": { + "get": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_ListBySubscription", + "description": "List FirewallResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Firewalls_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_ListBySubscription_MaximumSet_Gen.json" + }, + "Firewalls_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/PaloAltoNetworks.Cloudngfw/listSupportInfo": { + "post": { + "operationId": "PaloAltoNetworksCloudngfw_listSupportInfo", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SupportInfoModel" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen": { + "$ref": "./examples/PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen.json" + }, + "PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen": { + "$ref": "./examples/PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks": { + "get": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_ListBySubscription", + "description": "List LocalRulestackResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "LocalRulestacks_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_ListBySubscription_MaximumSet_Gen.json" + }, + "LocalRulestacks_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls": { + "get": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_ListByResourceGroup", + "description": "List FirewallResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Firewalls_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_ListByResourceGroup_MaximumSet_Gen.json" + }, + "Firewalls_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}": { + "get": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_Get", + "description": "Get a FirewallResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "Firewalls_Get_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_Get_MaximumSet_Gen.json" + }, + "Firewalls_Get_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_CreateOrUpdate", + "description": "Create a FirewallResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/FirewallResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Firewalls_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_CreateOrUpdate_MaximumSet_Gen.json" + }, + "Firewalls_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_Update", + "description": "Update a FirewallResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/FirewallResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "Firewalls_Update_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_Update_MaximumSet_Gen.json" + }, + "Firewalls_Update_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_Delete", + "description": "Delete a FirewallResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Firewalls_Delete_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_Delete_MaximumSet_Gen.json" + }, + "Firewalls_Delete_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/getGlobalRulestack": { + "post": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_getGlobalRulestack", + "description": "Get Global Rulestack associated with the Firewall", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GlobalRulestackInfo" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "Firewalls_getGlobalRulestack_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_getGlobalRulestack_MaximumSet_Gen.json" + }, + "Firewalls_getGlobalRulestack_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_getGlobalRulestack_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/getLogProfile": { + "post": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_getLogProfile", + "description": "Log Profile for Firewall", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/LogSettings" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "Firewalls_getLogProfile_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_getLogProfile_MaximumSet_Gen.json" + }, + "Firewalls_getLogProfile_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_getLogProfile_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/getSupportInfo": { + "post": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_getSupportInfo", + "description": "support info for firewall.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + }, + { + "name": "email", + "in": "query", + "required": false, + "description": "email address on behalf of which this API called", + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SupportInfo" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "Firewalls_getSupportInfo_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_getSupportInfo_MaximumSet_Gen.json" + }, + "Firewalls_getSupportInfo_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_getSupportInfo_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/saveLogProfile": { + "post": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_saveLogProfile", + "description": "Log Profile for Firewall", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + }, + { + "name": "logSettings", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/LogSettings" + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "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" + } + } + }, + "x-ms-examples": { + "Firewalls_saveLogProfile_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_saveLogProfile_MaximumSet_Gen.json" + }, + "Firewalls_saveLogProfile_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_saveLogProfile_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/statuses": { + "get": { + "tags": [ + "FirewallStatus" + ], + "operationId": "FirewallStatus_ListByFirewalls", + "description": "List FirewallStatusResource resources by Firewalls", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallStatusResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FirewallStatus_ListByFirewalls_MaximumSet_Gen": { + "$ref": "./examples/FirewallStatus_ListByFirewalls_MaximumSet_Gen.json" + }, + "FirewallStatus_ListByFirewalls_MinimumSet_Gen": { + "$ref": "./examples/FirewallStatus_ListByFirewalls_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/statuses/default": { + "get": { + "tags": [ + "FirewallStatus" + ], + "operationId": "FirewallStatus_Get", + "description": "Get a FirewallStatusResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallStatusResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "FirewallStatus_Get_MaximumSet_Gen": { + "$ref": "./examples/FirewallStatus_Get_MaximumSet_Gen.json" + }, + "FirewallStatus_Get_MinimumSet_Gen": { + "$ref": "./examples/FirewallStatus_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks": { + "get": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_ListByResourceGroup", + "description": "List LocalRulestackResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "LocalRulestacks_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_ListByResourceGroup_MaximumSet_Gen.json" + }, + "LocalRulestacks_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}": { + "get": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_Get", + "description": "Get a LocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_Get_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_Get_MaximumSet_Gen.json" + }, + "LocalRulestacks_Get_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_CreateOrUpdate", + "description": "Create a LocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/LocalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LocalRulestacks_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_CreateOrUpdate_MaximumSet_Gen.json" + }, + "LocalRulestacks_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_Update", + "description": "Update a LocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/LocalRulestackResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_Update_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_Update_MaximumSet_Gen.json" + }, + "LocalRulestacks_Update_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_Delete", + "description": "Delete a LocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LocalRulestacks_Delete_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_Delete_MaximumSet_Gen.json" + }, + "LocalRulestacks_Delete_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/certificates": { + "get": { + "tags": [ + "CertificateObjectLocalRulestack" + ], + "operationId": "CertificateObjectLocalRulestack_ListByLocalRulestacks", + "description": "List CertificateObjectLocalRulestackResource resources by LocalRulestacks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectLocalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CertificateObjectLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json" + }, + "CertificateObjectLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/certificates/{name}": { + "get": { + "tags": [ + "CertificateObjectLocalRulestack" + ], + "operationId": "CertificateObjectLocalRulestack_Get", + "description": "Get a CertificateObjectLocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/CertificateObjectLocalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectLocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "CertificateObjectLocalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_Get_MaximumSet_Gen.json" + }, + "CertificateObjectLocalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "CertificateObjectLocalRulestack" + ], + "operationId": "CertificateObjectLocalRulestack_CreateOrUpdate", + "description": "Create a CertificateObjectLocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/CertificateObjectLocalRulestackResource.name" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/CertificateObjectLocalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectLocalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectLocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CertificateObjectLocalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "CertificateObjectLocalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "CertificateObjectLocalRulestack" + ], + "operationId": "CertificateObjectLocalRulestack_Delete", + "description": "Delete a CertificateObjectLocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/CertificateObjectLocalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CertificateObjectLocalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_Delete_MaximumSet_Gen.json" + }, + "CertificateObjectLocalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/commit": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_commit", + "description": "Commit rulestack configuration", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "202": { + "description": "The request has been received but not yet acted upon." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LocalRulestacks_commit_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_commit_MaximumSet_Gen.json" + }, + "LocalRulestacks_commit_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_commit_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/fqdnlists": { + "get": { + "tags": [ + "FqdnListLocalRulestack" + ], + "operationId": "FqdnListLocalRulestack_ListByLocalRulestacks", + "description": "List FqdnListLocalRulestackResource resources by LocalRulestacks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListLocalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FqdnListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json" + }, + "FqdnListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/fqdnlists/{name}": { + "get": { + "tags": [ + "FqdnListLocalRulestack" + ], + "operationId": "FqdnListLocalRulestack_Get", + "description": "Get a FqdnListLocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/FqdnListLocalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListLocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "FqdnListLocalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_Get_MaximumSet_Gen.json" + }, + "FqdnListLocalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "FqdnListLocalRulestack" + ], + "operationId": "FqdnListLocalRulestack_CreateOrUpdate", + "description": "Create a FqdnListLocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/FqdnListLocalRulestackResource.name" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/FqdnListLocalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListLocalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListLocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "FqdnListLocalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "FqdnListLocalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "FqdnListLocalRulestack" + ], + "operationId": "FqdnListLocalRulestack_Delete", + "description": "Delete a FqdnListLocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/FqdnListLocalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "FqdnListLocalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_Delete_MaximumSet_Gen.json" + }, + "FqdnListLocalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/getChangeLog": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_getChangeLog", + "description": "Get changelog", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Changelog" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_getChangeLog_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_getChangeLog_MaximumSet_Gen.json" + }, + "LocalRulestacks_getChangeLog_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_getChangeLog_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/getSupportInfo": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_getSupportInfo", + "description": "support info for rulestack.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "email", + "in": "query", + "required": false, + "description": "email address on behalf of which this API called", + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SupportInfo" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_getSupportInfo_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_getSupportInfo_MaximumSet_Gen.json" + }, + "LocalRulestacks_getSupportInfo_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_getSupportInfo_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/listAdvancedSecurityObjects": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_listAdvancedSecurityObjects", + "description": "Get the list of advanced security objects", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "type", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "urlCustom", + "feeds" + ], + "x-ms-enum": { + "name": "AdvSecurityObjectTypeEnum", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/advSecurityObjectListResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_listAdvancedSecurityObjects_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listAdvancedSecurityObjects_MaximumSet_Gen.json" + }, + "LocalRulestacks_listAdvancedSecurityObjects_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listAdvancedSecurityObjects_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/listAppIds": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_listAppIds", + "description": "List of AppIds for LocalRulestack ApiVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "appIdVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "appPrefix", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListAppIdResponse" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "operationName": "LocalRulestacks_listAppIds" + }, + "x-ms-examples": { + "LocalRulestacks_listAppIds_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listAppIds_MaximumSet_Gen.json" + }, + "LocalRulestacks_listAppIds_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listAppIds_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/listCountries": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_listCountries", + "description": "List of countries for Rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CountriesResponse" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "operationName": "LocalRulestacks_listCountries" + }, + "x-ms-examples": { + "LocalRulestacks_listCountries_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listCountries_MaximumSet_Gen.json" + }, + "LocalRulestacks_listCountries_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listCountries_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/listFirewalls": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_listFirewalls", + "description": "List of Firewalls associated with Rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListFirewallsResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_listFirewalls_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listFirewalls_MaximumSet_Gen.json" + }, + "LocalRulestacks_listFirewalls_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listFirewalls_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/listPredefinedUrlCategories": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_listPredefinedUrlCategories", + "description": "List predefined URL categories for rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PredefinedUrlCategoriesResponse" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "operationName": "LocalRulestacks_listPredefinedUrlCategories" + }, + "x-ms-examples": { + "LocalRulestacks_listPredefinedUrlCategories_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listPredefinedUrlCategories_MaximumSet_Gen.json" + }, + "LocalRulestacks_listPredefinedUrlCategories_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listPredefinedUrlCategories_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/listSecurityServices": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_listSecurityServices", + "description": "List the security services for rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "type", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "antiSpyware", + "antiVirus", + "ipsVulnerability", + "urlFiltering", + "fileBlocking", + "dnsSubscription" + ], + "x-ms-enum": { + "name": "SecurityServicesTypeEnum", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/securityServicesResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_listSecurityServices_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listSecurityServices_MaximumSet_Gen.json" + }, + "LocalRulestacks_listSecurityServices_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listSecurityServices_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/localRules": { + "get": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_ListByLocalRulestacks", + "description": "List LocalRulesResource resources by LocalRulestacks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulesResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "LocalRules_ListByLocalRulestacks_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_ListByLocalRulestacks_MaximumSet_Gen.json" + }, + "LocalRules_ListByLocalRulestacks_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_ListByLocalRulestacks_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/localRules/{priority}": { + "get": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_Get", + "description": "Get a LocalRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/LocalRulesResource.priority" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulesResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRules_Get_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_Get_MaximumSet_Gen.json" + }, + "LocalRules_Get_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_CreateOrUpdate", + "description": "Create a LocalRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/LocalRulesResource.priority" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/LocalRulesResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulesResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulesResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LocalRules_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_CreateOrUpdate_MaximumSet_Gen.json" + }, + "LocalRules_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_Delete", + "description": "Delete a LocalRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/LocalRulesResource.priority" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LocalRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_Delete_MaximumSet_Gen.json" + }, + "LocalRules_Delete_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/localRules/{priority}/getCounters": { + "post": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_getCounters", + "description": "Get counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/LocalRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RuleCounter" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRules_getCounters_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_getCounters_MaximumSet_Gen.json" + }, + "LocalRules_getCounters_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_getCounters_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/localRules/{priority}/refreshCounters": { + "post": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_refreshCounters", + "description": "Refresh counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/LocalRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRules_refreshCounters_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_refreshCounters_MaximumSet_Gen.json" + }, + "LocalRules_refreshCounters_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_refreshCounters_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/localRules/{priority}/resetCounters": { + "post": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_resetCounters", + "description": "Reset counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/LocalRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RuleCounterReset" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRules_resetCounters_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_resetCounters_MaximumSet_Gen.json" + }, + "LocalRules_resetCounters_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_resetCounters_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/prefixlists": { + "get": { + "tags": [ + "PrefixListLocalRulestack" + ], + "operationId": "PrefixListLocalRulestack_ListByLocalRulestacks", + "description": "List PrefixListResource resources by LocalRulestacks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrefixListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json" + }, + "PrefixListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/prefixlists/{name}": { + "get": { + "tags": [ + "PrefixListLocalRulestack" + ], + "operationId": "PrefixListLocalRulestack_Get", + "description": "Get a PrefixListResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/PrefixListResource.name" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PrefixListLocalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_Get_MaximumSet_Gen.json" + }, + "PrefixListLocalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "PrefixListLocalRulestack" + ], + "operationId": "PrefixListLocalRulestack_CreateOrUpdate", + "description": "Create a PrefixListResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/PrefixListResource.name" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/PrefixListResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrefixListLocalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "PrefixListLocalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "PrefixListLocalRulestack" + ], + "operationId": "PrefixListLocalRulestack_Delete", + "description": "Delete a PrefixListResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/PrefixListResource.name" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrefixListLocalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_Delete_MaximumSet_Gen.json" + }, + "PrefixListLocalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/revert": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_revert", + "description": "Revert rulestack configuration", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_revert_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_revert_MaximumSet_Gen.json" + }, + "LocalRulestacks_revert_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_revert_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "ActionEnum": { + "type": "string", + "enum": [ + "Allow", + "DenySilent", + "DenyResetServer", + "DenyResetBoth" + ], + "x-ms-enum": { + "name": "ActionEnum", + "modelAsString": true + } + }, + "AdvSecurityObjectTypeEnum": { + "type": "string", + "enum": [ + "urlCustom", + "feeds" + ], + "x-ms-enum": { + "name": "AdvSecurityObjectTypeEnum", + "modelAsString": true + } + }, + "AppSeenData": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "number of rows" + }, + "appSeenList": { + "type": "array", + "items": { + "$ref": "#/definitions/AppSeenInfo" + }, + "x-ms-identifiers": [], + "x-cadl-name": "AppSeenInfo[]", + "description": "array of appSeen" + } + }, + "description": "Data Type for App Seen", + "required": [ + "count", + "appSeenList" + ] + }, + "AppSeenInfo": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "title" + }, + "category": { + "type": "string", + "description": "category" + }, + "subCategory": { + "type": "string", + "description": "subCategory" + }, + "risk": { + "type": "string", + "description": "risk" + }, + "tag": { + "type": "string", + "description": "tag" + }, + "technology": { + "type": "string", + "description": "technology" + }, + "standardPorts": { + "type": "string", + "description": "standardPorts" + } + }, + "description": "Definition for App Seen", + "required": [ + "title", + "category", + "subCategory", + "risk", + "tag", + "technology", + "standardPorts" + ] + }, + "ApplicationInsights": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource id for Application Insights" + }, + "key": { + "type": "string", + "description": "Application Insights key" + } + }, + "description": "Application Insights key" + }, + "Azure.ResourceManager.ManagedIdentityProperties": { + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "The Active Directory tenant id of the principal.", + "readOnly": true + }, + "principalId": { + "type": "string", + "description": "The active directory identifier of this principal.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityType", + "description": "The type of managed identity assigned to this resource." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Azure.ResourceManager.UserAssignedIdentity" + }, + "description": "The identities assigned to this resource by the user." + } + }, + "description": "The properties of the managed service identities assigned to this resource.", + "required": [ + "type" + ] + }, + "Azure.ResourceManager.ManagedIdentityType": { + "type": "string", + "description": "The kind of managed identity assigned to this resource.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None" + }, + { + "name": "SystemAssigned", + "value": "SystemAssigned" + }, + { + "name": "UserAssigned", + "value": "UserAssigned" + }, + { + "name": "SystemAndUserAssigned", + "value": "SystemAssigned,UserAssigned" + } + ] + } + }, + "Azure.ResourceManager.UserAssignedIdentity": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The active directory client identifier for this principal." + }, + "principalId": { + "type": "string", + "description": "The active directory identifier for this principal." + } + }, + "description": "A managed identity assigned by the user." + }, + "BillingCycle": { + "type": "string", + "description": "Billing cycle", + "enum": [ + "WEEKLY", + "MONTHLY" + ], + "x-ms-enum": { + "name": "BillingCycle", + "modelAsString": true + } + }, + "BooleanEnum": { + "type": "string", + "description": "Boolean Enum", + "enum": [ + "TRUE", + "FALSE" + ], + "x-ms-enum": { + "name": "BooleanEnum", + "modelAsString": true + } + }, + "Category": { + "type": "object", + "properties": { + "urlCustom": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "custom URL" + }, + "feeds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "feed list" + } + }, + "description": "URL/EDL to match", + "required": [ + "urlCustom", + "feeds" + ] + }, + "CertificateObject": { + "type": "object", + "properties": { + "certificateSignerResourceId": { + "type": "string", + "description": "Resource Id of certificate signer, to be populated only when certificateSelfSigned is false" + }, + "certificateSelfSigned": { + "$ref": "#/definitions/BooleanEnum", + "description": "use certificate self signed" + }, + "auditComment": { + "type": "string", + "description": "comment for this object" + }, + "description": { + "type": "string", + "description": "user description for this object" + }, + "etag": { + "type": "string", + "description": "read only string representing last create or update" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "description": "certificate used for inbound and outbound decryption", + "required": [ + "certificateSelfSigned" + ] + }, + "CertificateObjectGlobalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateObject", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "GlobalRulestack Certificate Object", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "CertificateObjectGlobalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateObjectGlobalRulestackResource" + }, + "x-cadl-name": "CertificateObjectGlobalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a CertificateObjectGlobalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "CertificateObjectLocalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateObject", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "LocalRulestack Certificate Object", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "CertificateObjectLocalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateObjectLocalRulestackResource" + }, + "x-cadl-name": "CertificateObjectLocalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a CertificateObjectLocalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "Changelog": { + "type": "object", + "properties": { + "changes": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "list of changes" + }, + "lastCommitted": { + "type": "string", + "format": "date-time", + "description": "lastCommitted timestamp" + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "lastModified timestamp" + } + }, + "description": "Changelog list", + "required": [ + "changes" + ] + }, + "CountriesResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Country" + }, + "x-ms-identifiers": [], + "x-cadl-name": "Country[]", + "description": "List of countries" + }, + "nextLink": { + "type": "string", + "description": "next link" + } + }, + "description": "Countries Response Object", + "required": [ + "value" + ] + }, + "Country": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "country code" + }, + "description": { + "type": "string", + "description": "code description" + } + }, + "description": "Country Description", + "required": [ + "code" + ] + }, + "DNSProxy": { + "type": "string", + "description": "DNS Proxy", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "DNSProxy", + "modelAsString": true + } + }, + "DNSSettings": { + "type": "object", + "properties": { + "enableDnsProxy": { + "$ref": "#/definitions/DNSProxy", + "description": "Enable DNS proxy, disabled by default" + }, + "enabledDnsType": { + "$ref": "#/definitions/EnabledDNSType", + "description": "Enabled DNS proxy type, disabled by default" + }, + "dnsServers": { + "type": "array", + "items": { + "$ref": "#/definitions/IPAddress" + }, + "x-ms-identifiers": [], + "x-cadl-name": "IPAddress[]", + "description": "List of IPs associated with the Firewall" + } + }, + "description": "DNS Proxy settings for Firewall" + }, + "DecryptionRuleTypeEnum": { + "type": "string", + "enum": [ + "SSLOutboundInspection", + "SSLInboundInspection", + "None" + ], + "x-ms-enum": { + "name": "DecryptionRuleTypeEnum", + "modelAsString": true + } + }, + "DefaultMode": { + "type": "string", + "description": "Type for Default Mode for rules creation", + "enum": [ + "IPS", + "FIREWALL", + "NONE" + ], + "x-ms-enum": { + "name": "DefaultMode", + "modelAsString": true + } + }, + "DestinationAddr": { + "type": "object", + "properties": { + "cidrs": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "special value 'any'" + }, + "countries": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "list of countries" + }, + "feeds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "list of feeds" + }, + "prefixLists": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "prefix list" + }, + "fqdnLists": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "fqdn list" + } + }, + "description": "destination address" + }, + "EgressNat": { + "type": "string", + "description": "Egress NAT", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "EgressNat", + "modelAsString": true + } + }, + "EnableStatus": { + "type": "string", + "description": "Enable status", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "EnabledDNSType": { + "type": "string", + "description": "Enabled DNS type values", + "enum": [ + "CUSTOM", + "AZURE" + ], + "x-ms-enum": { + "name": "EnabledDNSType", + "modelAsString": true + } + }, + "EndpointConfiguration": { + "type": "object", + "properties": { + "port": { + "type": "string", + "description": "port ID" + }, + "address": { + "$ref": "#/definitions/IPAddress", + "description": "Address Space" + } + }, + "description": "Endpoint Configuration for frontend and backend", + "required": [ + "port", + "address" + ] + }, + "EventHub": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of EventHub" + }, + "subscriptionId": { + "type": "string", + "description": "Subscription Id" + }, + "name": { + "type": "string", + "description": "EventHub name" + }, + "nameSpace": { + "type": "string", + "description": "EventHub namespace" + }, + "policyName": { + "type": "string", + "description": "EventHub policy name" + } + }, + "description": "EventHub configurations" + }, + "FirewallDeploymentProperties": { + "type": "object", + "properties": { + "panEtag": { + "type": "string", + "description": "panEtag info" + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Network settings" + }, + "isPanoramaManaged": { + "$ref": "#/definitions/BooleanEnum", + "description": "Panorama Managed: Default is False. Default will be CloudSec managed" + }, + "isStrataCloudManaged": { + "$ref": "#/definitions/BooleanEnum", + "description": "Strata Cloud Managed: Default is False. Default will be CloudSec managed" + }, + "panoramaConfig": { + "$ref": "#/definitions/PanoramaConfig", + "description": "Panorama Configuration" + }, + "strataCloudManagerConfig": { + "$ref": "#/definitions/StrataCloudManagerConfig", + "description": "Strata Cloud Manager Configuration, only applicable if Strata Cloud Manager is selected." + }, + "associatedRulestack": { + "$ref": "#/definitions/RulestackDetails", + "description": "Associated Rulestack" + }, + "dnsSettings": { + "$ref": "#/definitions/DNSSettings", + "description": "DNS settings for Firewall" + }, + "frontEndSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendSetting" + }, + "x-ms-identifiers": [], + "x-cadl-name": "FrontendSetting[]", + "description": "Frontend settings for Firewall" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Billing plan information." + }, + "marketplaceDetails": { + "$ref": "#/definitions/MarketplaceDetails", + "description": "Marketplace details" + } + }, + "description": "Properties specific to the Firewall resource deployment.", + "required": [ + "networkProfile", + "dnsSettings", + "planData", + "marketplaceDetails" + ] + }, + "FirewallResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FirewallDeploymentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityProperties", + "description": "The managed service identities assigned to this resource." + } + }, + "description": "PaloAltoNetworks Firewall", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "FirewallResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallResource" + }, + "x-cadl-name": "FirewallResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a FirewallResource list operation.", + "required": [ + "value" + ] + }, + "FirewallResourceUpdate": { + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityProperties", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/FirewallResourceUpdateProperties" + } + }, + "description": "The type used for update operations of the FirewallResource." + }, + "FirewallResourceUpdateProperties": { + "type": "object", + "properties": { + "panEtag": { + "type": "string", + "description": "panEtag info" + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Network settings" + }, + "isPanoramaManaged": { + "$ref": "#/definitions/BooleanEnum", + "description": "Panorama Managed: Default is False. Default will be CloudSec managed" + }, + "isStrataCloudManaged": { + "$ref": "#/definitions/BooleanEnum", + "description": "Strata Cloud Managed: Default is False. Default will be CloudSec managed" + }, + "panoramaConfig": { + "$ref": "#/definitions/PanoramaConfig", + "description": "Panorama Configuration" + }, + "strataCloudManagerConfig": { + "$ref": "#/definitions/StrataCloudManagerConfig", + "description": "Strata Cloud Manager Configuration, only applicable if Strata Cloud Manager is selected." + }, + "associatedRulestack": { + "$ref": "#/definitions/RulestackDetails", + "description": "Associated Rulestack" + }, + "dnsSettings": { + "$ref": "#/definitions/DNSSettings", + "description": "DNS settings for Firewall" + }, + "frontEndSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendSetting" + }, + "x-ms-identifiers": [], + "x-cadl-name": "FrontendSetting[]", + "description": "Frontend settings for Firewall" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Billing plan information." + }, + "marketplaceDetails": { + "$ref": "#/definitions/MarketplaceDetails", + "description": "Marketplace details" + } + }, + "description": "The updatable properties of the FirewallResource." + }, + "FirewallStatusProperty": { + "type": "object", + "properties": { + "isPanoramaManaged": { + "$ref": "#/definitions/BooleanEnum", + "description": "Panorama Managed: Default is False. Default will be CloudSec managed", + "readOnly": true + }, + "healthStatus": { + "$ref": "#/definitions/HealthStatus", + "description": "Current status of the Firewall", + "readOnly": true + }, + "healthReason": { + "type": "string", + "description": "Detail description of current health of the Firewall", + "readOnly": true + }, + "panoramaStatus": { + "$ref": "#/definitions/PanoramaStatus", + "description": "Panorama Status", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ReadOnlyProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "isStrataCloudManaged": { + "$ref": "#/definitions/BooleanEnum", + "description": "Strata Cloud Manager", + "readOnly": true + }, + "strataCloudManagerInfo": { + "$ref": "#/definitions/StrataCloudManagerInfo", + "description": "This field is only present if Strata Cloud Manager is managing the policy for this firewall" + } + }, + "description": "Firewall Status" + }, + "FirewallStatusResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FirewallStatusProperty", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "Firewall Status", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "FirewallStatusResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallStatusResource" + }, + "x-cadl-name": "FirewallStatusResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a FirewallStatusResource list operation.", + "required": [ + "value" + ] + }, + "FqdnListGlobalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FqdnObject", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "GlobalRulestack fqdnList", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "FqdnListGlobalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FqdnListGlobalRulestackResource" + }, + "x-cadl-name": "FqdnListGlobalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a FqdnListGlobalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "FqdnListLocalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FqdnObject", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "LocalRulestack fqdnList", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "FqdnListLocalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FqdnListLocalRulestackResource" + }, + "x-cadl-name": "FqdnListLocalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a FqdnListLocalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "FqdnObject": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "fqdn object description" + }, + "fqdnList": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "fqdn list" + }, + "etag": { + "type": "string", + "description": "etag info" + }, + "auditComment": { + "type": "string", + "description": "comment for this object" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "description": "fqdn object", + "required": [ + "fqdnList" + ] + }, + "FrontendSetting": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Settings name" + }, + "protocol": { + "$ref": "#/definitions/ProtocolType", + "description": "Protocol Type" + }, + "frontendConfiguration": { + "$ref": "#/definitions/EndpointConfiguration", + "description": "Frontend configurations" + }, + "backendConfiguration": { + "$ref": "#/definitions/EndpointConfiguration", + "description": "Backend configurations" + } + }, + "description": "Frontend setting for Firewall", + "required": [ + "name", + "protocol", + "frontendConfiguration", + "backendConfiguration" + ] + }, + "GlobalRulestackInfo": { + "type": "object", + "properties": { + "azureId": { + "type": "string", + "description": "rulestack description" + } + }, + "description": "PAN Rulestack Describe Object", + "required": [ + "azureId" + ] + }, + "GlobalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RulestackProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Global Location" + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityProperties", + "description": "The managed service identities assigned to this resource." + } + }, + "description": "PaloAltoNetworks GlobalRulestack", + "required": [ + "properties", + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "GlobalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GlobalRulestackResource" + }, + "x-cadl-name": "GlobalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a GlobalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "GlobalRulestackResourceUpdate": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Global Location" + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityProperties", + "description": "The managed service identities assigned to this resource." + }, + "properties": { + "$ref": "#/definitions/GlobalRulestackResourceUpdateProperties" + } + }, + "description": "The type used for update operations of the GlobalRulestackResource." + }, + "GlobalRulestackResourceUpdateProperties": { + "type": "object", + "properties": { + "panEtag": { + "type": "string", + "description": "PanEtag info" + }, + "panLocation": { + "type": "string", + "description": "Rulestack Location, Required for GlobalRulestacks, Not for LocalRulestacks" + }, + "scope": { + "$ref": "#/definitions/ScopeType", + "description": "Rulestack Type" + }, + "associatedSubscriptions": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "subscription scope of global rulestack" + }, + "description": { + "type": "string", + "description": "rulestack description" + }, + "defaultMode": { + "$ref": "#/definitions/DefaultMode", + "description": "Mode for default rules creation" + }, + "minAppIdVersion": { + "type": "string", + "description": "minimum version" + }, + "securityServices": { + "$ref": "#/definitions/securityServices", + "description": "Security Profile" + } + }, + "description": "The updatable properties of the GlobalRulestackResource." + }, + "HealthStatus": { + "type": "string", + "description": "Status Codes for the Firewall", + "enum": [ + "GREEN", + "YELLOW", + "RED", + "INITIALIZING" + ], + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + } + }, + "IPAddress": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Resource Id" + }, + "address": { + "type": "string", + "description": "Address value" + } + }, + "description": "IP Address" + }, + "IPAddressSpace": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Resource Id" + }, + "addressSpace": { + "type": "string", + "description": "Address Space" + } + }, + "description": "IP Address Space" + }, + "ListAppIdResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "List of AppIds" + }, + "nextLink": { + "type": "string", + "description": "next Link" + } + }, + "required": [ + "value" + ] + }, + "ListFirewallsResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "firewalls list" + }, + "nextLink": { + "type": "string", + "description": "next link" + } + }, + "description": "List firewalls response", + "required": [ + "value" + ] + }, + "LocalRulesResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RuleEntry", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "LocalRulestack rule list", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "LocalRulesResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LocalRulesResource" + }, + "x-cadl-name": "LocalRulesResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a LocalRulesResource list operation.", + "required": [ + "value" + ] + }, + "LocalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RulestackProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityProperties", + "description": "The managed service identities assigned to this resource." + } + }, + "description": "PaloAltoNetworks LocalRulestack", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "LocalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LocalRulestackResource" + }, + "x-cadl-name": "LocalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a LocalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "LocalRulestackResourceUpdate": { + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityProperties", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/LocalRulestackResourceUpdateProperties" + } + }, + "description": "The type used for update operations of the LocalRulestackResource." + }, + "LocalRulestackResourceUpdateProperties": { + "type": "object", + "properties": { + "panEtag": { + "type": "string", + "description": "PanEtag info" + }, + "panLocation": { + "type": "string", + "description": "Rulestack Location, Required for GlobalRulestacks, Not for LocalRulestacks" + }, + "scope": { + "$ref": "#/definitions/ScopeType", + "description": "Rulestack Type" + }, + "associatedSubscriptions": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "subscription scope of global rulestack" + }, + "description": { + "type": "string", + "description": "rulestack description" + }, + "defaultMode": { + "$ref": "#/definitions/DefaultMode", + "description": "Mode for default rules creation" + }, + "minAppIdVersion": { + "type": "string", + "description": "minimum version" + }, + "securityServices": { + "$ref": "#/definitions/securityServices", + "description": "Security Profile" + } + }, + "description": "The updatable properties of the LocalRulestackResource." + }, + "LogDestination": { + "type": "object", + "properties": { + "storageConfigurations": { + "$ref": "#/definitions/StorageAccount", + "description": "Storage account configurations" + }, + "eventHubConfigurations": { + "$ref": "#/definitions/EventHub", + "description": "Event Hub configurations" + }, + "monitorConfigurations": { + "$ref": "#/definitions/MonitorLog", + "description": "Monitor Log configurations" + } + }, + "description": "Log Destination" + }, + "LogOption": { + "type": "string", + "description": "Log options possible", + "enum": [ + "SAME_DESTINATION", + "INDIVIDUAL_DESTINATION" + ], + "x-ms-enum": { + "name": "LogOption", + "modelAsString": true + } + }, + "LogSettings": { + "type": "object", + "properties": { + "logType": { + "$ref": "#/definitions/LogType", + "description": "One of possible log type" + }, + "logOption": { + "$ref": "#/definitions/LogOption", + "description": "Log option SAME/INDIVIDUAL" + }, + "applicationInsights": { + "$ref": "#/definitions/ApplicationInsights", + "description": "Application Insight details" + }, + "commonDestination": { + "$ref": "#/definitions/LogDestination", + "description": "Common destination configurations" + }, + "trafficLogDestination": { + "$ref": "#/definitions/LogDestination", + "description": "Traffic destination configurations" + }, + "threatLogDestination": { + "$ref": "#/definitions/LogDestination", + "description": "Threat destination configurations" + }, + "decryptLogDestination": { + "$ref": "#/definitions/LogDestination", + "description": "Decrypt destination configurations" + } + }, + "description": "Log Settings for Firewall" + }, + "LogType": { + "type": "string", + "description": "Possible log types", + "enum": [ + "TRAFFIC", + "THREAT", + "DECRYPTION", + "WILDFIRE", + "DLP", + "AUDIT" + ], + "x-ms-enum": { + "name": "LogType", + "modelAsString": true + } + }, + "MarketplaceDetails": { + "type": "object", + "properties": { + "marketplaceSubscriptionId": { + "type": "string", + "description": "Marketplace Subscription Id", + "readOnly": true + }, + "offerId": { + "type": "string", + "description": "Offer Id" + }, + "publisherId": { + "type": "string", + "description": "Publisher Id" + }, + "marketplaceSubscriptionStatus": { + "$ref": "#/definitions/MarketplaceSubscriptionStatus", + "description": "Marketplace Subscription Status" + } + }, + "description": "MarketplaceDetails of PAN Firewall resource", + "required": [ + "offerId", + "publisherId" + ] + }, + "MarketplaceSubscriptionStatus": { + "type": "string", + "description": "Marketplace Subscription Status", + "enum": [ + "PendingFulfillmentStart", + "Subscribed", + "Suspended", + "Unsubscribed", + "NotStarted", + "FulfillmentRequested" + ], + "x-ms-enum": { + "name": "MarketplaceSubscriptionStatus", + "modelAsString": true + } + }, + "MonitorLog": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of MonitorLog" + }, + "subscriptionId": { + "type": "string", + "description": "Subscription Id" + }, + "workspace": { + "type": "string", + "description": "MonitorLog workspace" + }, + "primaryKey": { + "type": "string", + "description": "Primary Key value for Monitor" + }, + "secondaryKey": { + "type": "string", + "description": "Secondary Key value for Monitor" + } + }, + "description": "MonitorLog configurations" + }, + "NameDescriptionObject": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name value" + }, + "description": { + "type": "string", + "description": "description value" + } + }, + "description": "object type info", + "required": [ + "name" + ] + }, + "NetworkProfile": { + "type": "object", + "properties": { + "vnetConfiguration": { + "$ref": "#/definitions/VnetConfiguration", + "description": "Vnet configurations" + }, + "vwanConfiguration": { + "$ref": "#/definitions/VwanConfiguration", + "description": "Vwan configurations" + }, + "networkType": { + "$ref": "#/definitions/NetworkType", + "description": "vnet or vwan, cannot be updated" + }, + "publicIps": { + "type": "array", + "items": { + "$ref": "#/definitions/IPAddress" + }, + "x-ms-identifiers": [], + "x-cadl-name": "IPAddress[]", + "description": "List of IPs associated with the Firewall" + }, + "enableEgressNat": { + "$ref": "#/definitions/EgressNat", + "description": "Enable egress NAT, enabled by default" + }, + "egressNatIp": { + "type": "array", + "items": { + "$ref": "#/definitions/IPAddress" + }, + "x-ms-identifiers": [], + "x-cadl-name": "IPAddress[]", + "description": "Egress nat IP to use" + }, + "trustedRanges": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Non-RFC 1918 address" + }, + "privateSourceNatRulesDestination": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Array of ipv4 destination address for which source NAT is to be performed" + } + }, + "description": "Network settings for Firewall", + "required": [ + "networkType", + "publicIps", + "enableEgressNat" + ] + }, + "NetworkType": { + "type": "string", + "description": "NetworkType Enum", + "enum": [ + "VNET", + "VWAN" + ], + "x-ms-enum": { + "name": "NetworkType", + "modelAsString": true + } + }, + "PanoramaConfig": { + "type": "object", + "properties": { + "configString": { + "type": "string", + "description": "Base64 encoded string representing Panorama parameters to be used by Firewall to connect to Panorama. This string is generated via azure plugin in Panorama" + }, + "vmAuthKey": { + "type": "string", + "description": "VM auth key for panorama connectivity", + "readOnly": true + }, + "panoramaServer": { + "type": "string", + "description": "Primary Panorama Server IP address value in dotted format for IPv4", + "readOnly": true + }, + "panoramaServer2": { + "type": "string", + "description": "Secondary Panorama Server IP address value in dotted format for IPv4", + "readOnly": true + }, + "dgName": { + "type": "string", + "description": "Panorama Device Group to join", + "readOnly": true + }, + "tplName": { + "type": "string", + "description": "Panorama Template Stack to join - (Once configured we can not edit the value)", + "readOnly": true + }, + "cgName": { + "type": "string", + "description": "Panorama Collector Group to join - (Once configured we can not edit the value)", + "readOnly": true + }, + "hostName": { + "type": "string", + "description": "Resource name(may be unique) for PN admin", + "readOnly": true + } + }, + "description": "Panorama Config", + "required": [ + "configString" + ] + }, + "PanoramaStatus": { + "type": "object", + "properties": { + "panoramaServerStatus": { + "$ref": "#/definitions/ServerStatus", + "description": "Primary Panorama connection status", + "readOnly": true + }, + "panoramaServer2Status": { + "$ref": "#/definitions/ServerStatus", + "description": "Secondary Panorama connection status", + "readOnly": true + } + }, + "description": "Panorama connectivity information" + }, + "PlanData": { + "type": "object", + "properties": { + "usageType": { + "$ref": "#/definitions/UsageType", + "description": "different usage type like PAYG/COMMITTED" + }, + "billingCycle": { + "$ref": "#/definitions/BillingCycle", + "description": "different billing cycles like MONTHLY/WEEKLY" + }, + "planId": { + "type": "string", + "description": "plan id as published by Liftr.PAN", + "maxLength": 50 + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "date when plan was applied", + "readOnly": true + } + }, + "description": "Billing plan information.", + "required": [ + "billingCycle", + "planId" + ] + }, + "PostRulesResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RuleEntry", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "PostRulestack rule list", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PostRulesResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PostRulesResource" + }, + "x-cadl-name": "PostRulesResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a PostRulesResource list operation.", + "required": [ + "value" + ] + }, + "PreRulesResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RuleEntry", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "PreRulestack rule list", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PreRulesResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PreRulesResource" + }, + "x-cadl-name": "PreRulesResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a PreRulesResource list operation.", + "required": [ + "value" + ] + }, + "PredefinedUrlCategoriesResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PredefinedUrlCategory" + }, + "x-ms-identifiers": [], + "x-cadl-name": "PredefinedUrlCategory[]", + "description": "predefined url categories" + }, + "nextLink": { + "type": "string", + "description": "next link" + } + }, + "description": "predefined url categories response", + "required": [ + "value" + ] + }, + "PredefinedUrlCategory": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "description": "Predefined URL category object", + "required": [ + "action", + "name" + ] + }, + "PrefixListGlobalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrefixObject", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "GlobalRulestack prefixList", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PrefixListGlobalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrefixListGlobalRulestackResource" + }, + "x-cadl-name": "PrefixListGlobalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a PrefixListGlobalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "PrefixListResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrefixObject", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "LocalRulestack prefixList", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PrefixListResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrefixListResource" + }, + "x-cadl-name": "PrefixListResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a PrefixListResource list operation.", + "required": [ + "value" + ] + }, + "PrefixObject": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "prefix description" + }, + "prefixList": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "prefix list" + }, + "etag": { + "type": "string", + "description": "etag info" + }, + "auditComment": { + "type": "string", + "description": "comment for this object" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "description": "prefix entry", + "required": [ + "prefixList" + ] + }, + "ProtocolType": { + "type": "string", + "description": "Protocol Enum", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true + } + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of the firewall resource.", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ReadOnlyProvisioningState": { + "type": "string", + "description": "Provisioning state of the firewall resource.", + "enum": [ + "Succeeded", + "Failed", + "Deleted" + ], + "x-ms-enum": { + "name": "ReadOnlyProvisioningState", + "modelAsString": true + } + }, + "RegistrationStatus": { + "type": "string", + "description": "Registration status", + "enum": [ + "Registered", + "Not Registered" + ], + "x-ms-enum": { + "name": "RegistrationStatus", + "modelAsString": true + } + }, + "RuleCounter": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "priority number" + }, + "ruleStackName": { + "type": "string", + "description": "rule Stack Name" + }, + "ruleListName": { + "type": "string", + "description": "rule list name" + }, + "firewallName": { + "type": "string", + "description": "firewall name" + }, + "ruleName": { + "type": "string", + "description": "rule name" + }, + "hitCount": { + "type": "integer", + "format": "int32", + "description": "hit count" + }, + "appSeen": { + "$ref": "#/definitions/AppSeenData", + "description": "apps seen" + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "timestamp of response" + }, + "requestTimestamp": { + "type": "string", + "format": "date-time", + "description": "timestamp of request" + }, + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "last updated timestamp" + } + }, + "description": "Rule counter", + "required": [ + "priority", + "ruleName" + ] + }, + "RuleCounterReset": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "priority number", + "readOnly": true + }, + "ruleStackName": { + "type": "string", + "description": "rule Stack Name" + }, + "ruleListName": { + "type": "string", + "description": "rule list name" + }, + "firewallName": { + "type": "string", + "description": "firewall name" + }, + "ruleName": { + "type": "string", + "description": "rule name" + } + }, + "description": "Rule counter reset" + }, + "RuleEntry": { + "type": "object", + "properties": { + "etag": { + "type": "string", + "description": "etag info" + }, + "ruleName": { + "type": "string", + "description": "rule name" + }, + "priority": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "description": { + "type": "string", + "description": "rule description" + }, + "ruleState": { + "$ref": "#/definitions/StateEnum", + "description": "state of this rule" + }, + "source": { + "$ref": "#/definitions/SourceAddr", + "description": "source address" + }, + "negateSource": { + "$ref": "#/definitions/BooleanEnum", + "description": "cidr should not be 'any'" + }, + "destination": { + "$ref": "#/definitions/DestinationAddr", + "description": "destination address" + }, + "negateDestination": { + "$ref": "#/definitions/BooleanEnum", + "description": "cidr should not be 'any'" + }, + "applications": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "array of rule applications" + }, + "category": { + "$ref": "#/definitions/Category", + "description": "rule category" + }, + "protocol": { + "type": "string", + "description": "any, application-default, TCP:number, UDP:number", + "default": "application-default" + }, + "protocolPortList": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "prot port list" + }, + "inboundInspectionCertificate": { + "type": "string", + "description": "inbound Inspection Certificate" + }, + "auditComment": { + "type": "string", + "description": "rule comment" + }, + "actionType": { + "$ref": "#/definitions/ActionEnum", + "description": "rule action" + }, + "enableLogging": { + "$ref": "#/definitions/StateEnum", + "description": "enable or disable logging" + }, + "decryptionRuleType": { + "$ref": "#/definitions/DecryptionRuleTypeEnum", + "description": "enable or disable decryption" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/TagInfo" + }, + "x-ms-identifiers": [], + "x-cadl-name": "TagInfo[]", + "description": "tag for rule" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "description": "definition of rule", + "required": [ + "ruleName" + ] + }, + "RulestackDetails": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Resource Id" + }, + "rulestackId": { + "type": "string", + "description": "Associated rulestack Id" + }, + "location": { + "type": "string", + "description": "Rulestack location" + } + }, + "description": "Associated rulestack details" + }, + "RulestackProperties": { + "type": "object", + "properties": { + "panEtag": { + "type": "string", + "description": "PanEtag info" + }, + "panLocation": { + "type": "string", + "description": "Rulestack Location, Required for GlobalRulestacks, Not for LocalRulestacks" + }, + "scope": { + "$ref": "#/definitions/ScopeType", + "description": "Rulestack Type" + }, + "associatedSubscriptions": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "subscription scope of global rulestack" + }, + "description": { + "type": "string", + "description": "rulestack description" + }, + "defaultMode": { + "$ref": "#/definitions/DefaultMode", + "description": "Mode for default rules creation" + }, + "minAppIdVersion": { + "type": "string", + "description": "minimum version" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "securityServices": { + "$ref": "#/definitions/securityServices", + "description": "Security Profile" + } + }, + "description": "PAN Rulestack Describe Object" + }, + "ScopeType": { + "type": "string", + "description": "Rulestack Type", + "enum": [ + "LOCAL", + "GLOBAL" + ], + "x-ms-enum": { + "name": "ScopeType", + "modelAsString": true + } + }, + "SecurityServicesTypeEnum": { + "type": "string", + "enum": [ + "antiSpyware", + "antiVirus", + "ipsVulnerability", + "urlFiltering", + "fileBlocking", + "dnsSubscription" + ], + "x-ms-enum": { + "name": "SecurityServicesTypeEnum", + "modelAsString": true + } + }, + "ServerStatus": { + "type": "string", + "description": "Connectivity Status for Panorama Server", + "enum": [ + "UP", + "DOWN" + ], + "x-ms-enum": { + "name": "ServerStatus", + "modelAsString": true + } + }, + "SourceAddr": { + "type": "object", + "properties": { + "cidrs": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "special value 'any'" + }, + "countries": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "list of countries" + }, + "feeds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "list of feeds" + }, + "prefixLists": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "prefix list" + } + }, + "description": "Address properties" + }, + "StateEnum": { + "type": "string", + "description": "Enabled or Disabled Enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "StateEnum", + "modelAsString": true + } + }, + "StorageAccount": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of storage account" + }, + "subscriptionId": { + "type": "string", + "description": "Subscription Id" + }, + "accountName": { + "type": "string", + "description": "Storage account name" + } + }, + "description": "Storage Account configurations" + }, + "StrataCloudManagerConfig": { + "type": "object", + "properties": { + "cloudManagerName": { + "type": "string", + "description": "Strata Cloud Manager name which is intended to manage the policy for this firewall." + } + }, + "description": "This field is only present if Strata Cloud Manager is managing the policy for this firewall", + "required": [ + "cloudManagerName" + ] + }, + "StrataCloudManagerInfo": { + "type": "object", + "properties": { + "folderName": { + "type": "string", + "description": "Strata Cloud Manager folder in which this firewall has been placed" + }, + "hubUrl": { + "type": "string", + "description": "URL for Strata Cloud Manager" + } + }, + "description": "Strata Cloud Manager Info" + }, + "SupportInfo": { + "type": "object", + "properties": { + "productSku": { + "type": "string", + "description": "product SKU associated with given resource" + }, + "productSerial": { + "type": "string", + "description": "product Serial associated with given resource" + }, + "accountRegistered": { + "$ref": "#/definitions/BooleanEnum", + "description": "account registered in Customer Support Portal" + }, + "accountId": { + "type": "string", + "description": "Support account associated with given resource" + }, + "userDomainSupported": { + "$ref": "#/definitions/BooleanEnum", + "description": "user domain is supported in Customer Support Portal" + }, + "userRegistered": { + "$ref": "#/definitions/BooleanEnum", + "description": "user registered in Customer Support Portal" + }, + "freeTrial": { + "$ref": "#/definitions/BooleanEnum", + "description": "Product usage is in free trial period" + }, + "freeTrialDaysLeft": { + "type": "integer", + "format": "int32", + "description": "Free trial days remaining" + }, + "freeTrialCreditLeft": { + "type": "integer", + "format": "int32", + "description": "Free trial credit remaining" + }, + "helpURL": { + "type": "string", + "description": "URL for paloaltonetworks live community" + }, + "supportURL": { + "type": "string", + "description": "URL for paloaltonetworks Customer Service Portal" + }, + "registerURL": { + "type": "string", + "description": "URL for registering product in paloaltonetworks Customer Service Portal" + } + }, + "description": "Support information for the resource" + }, + "SupportInfoModel": { + "type": "object", + "properties": { + "productSku": { + "type": "string", + "description": "product SKU associated with given resource" + }, + "productSerial": { + "type": "string", + "description": "product Serial associated with given resource" + }, + "accountRegistrationStatus": { + "$ref": "#/definitions/RegistrationStatus", + "description": "account registered in Customer Support Portal" + }, + "accountId": { + "type": "string", + "description": "Support account associated with given resource" + }, + "freeTrial": { + "$ref": "#/definitions/EnableStatus", + "description": "Product usage is in free trial period" + }, + "freeTrialDaysLeft": { + "type": "integer", + "format": "int32", + "description": "Free trial days remaining" + }, + "freeTrialCreditLeft": { + "type": "integer", + "format": "int32", + "description": "Free trial credit remaining" + }, + "helpURL": { + "type": "string", + "description": "URL for paloaltonetworks live community" + }, + "supportURL": { + "type": "string", + "description": "URL for paloaltonetworks Customer Service Portal" + }, + "registerURL": { + "type": "string", + "description": "URL for registering product in paloaltonetworks Customer Service Portal" + }, + "hubUrl": { + "type": "string", + "description": "URL for Strata Cloud Manager" + }, + "credits": { + "type": "integer", + "format": "int32", + "description": "credits purchased, unit per hour" + }, + "monthlyCreditLeft": { + "type": "integer", + "format": "int32", + "description": "monthly credit is computed as credits * days in calendar month" + }, + "startDateForCredits": { + "type": "string", + "description": "date in format yyyy-mm-dd" + }, + "endDateForCredits": { + "type": "string", + "description": "date in format yyyy-mm-dd" + } + }, + "description": "Support information for the service" + }, + "TagInfo": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "tag name" + }, + "value": { + "type": "string", + "description": "tag value" + } + }, + "description": "Tag", + "required": [ + "key", + "value" + ] + }, + "UsageType": { + "type": "string", + "description": "Usage Type", + "enum": [ + "PAYG", + "COMMITTED" + ], + "x-ms-enum": { + "name": "UsageType", + "modelAsString": true + } + }, + "VnetConfiguration": { + "type": "object", + "properties": { + "vnet": { + "$ref": "#/definitions/IPAddressSpace", + "description": "Azure Virtual Network" + }, + "trustSubnet": { + "$ref": "#/definitions/IPAddressSpace", + "description": "Trust Subnet" + }, + "unTrustSubnet": { + "$ref": "#/definitions/IPAddressSpace", + "description": "Untrust Subnet" + }, + "ipOfTrustSubnetForUdr": { + "$ref": "#/definitions/IPAddress", + "description": "IP of trust subnet for UDR" + } + }, + "description": "VnetInfo for Firewall Networking", + "required": [ + "vnet", + "trustSubnet", + "unTrustSubnet" + ] + }, + "VwanConfiguration": { + "type": "object", + "properties": { + "networkVirtualApplianceId": { + "type": "string", + "description": "Network Virtual Appliance resource ID " + }, + "vHub": { + "$ref": "#/definitions/IPAddressSpace", + "description": "vHub Address" + }, + "trustSubnet": { + "$ref": "#/definitions/IPAddressSpace", + "description": "Trust Subnet" + }, + "unTrustSubnet": { + "$ref": "#/definitions/IPAddressSpace", + "description": "Untrust Subnet" + }, + "ipOfTrustSubnetForUdr": { + "$ref": "#/definitions/IPAddress", + "description": "IP of trust subnet for UDR" + } + }, + "description": "VwanInfo for Firewall Networking", + "required": [ + "vHub" + ] + }, + "advSecurityObjectListResponse": { + "type": "object", + "properties": { + "value": { + "$ref": "#/definitions/advSecurityObjectModel", + "description": "response value" + }, + "nextLink": { + "type": "string", + "description": "next link" + } + }, + "description": "advanced security object", + "required": [ + "value" + ] + }, + "advSecurityObjectModel": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type of object" + }, + "entry": { + "type": "array", + "items": { + "$ref": "#/definitions/NameDescriptionObject" + }, + "x-ms-identifiers": [], + "x-cadl-name": "NameDescriptionObject[]", + "description": "URL entry" + } + }, + "description": "List of custom and predefined url category", + "required": [ + "entry" + ] + }, + "securityServices": { + "type": "object", + "properties": { + "vulnerabilityProfile": { + "type": "string", + "description": "IPs Vulnerability Profile Data" + }, + "antiSpywareProfile": { + "type": "string", + "description": "Anti spyware Profile data" + }, + "antiVirusProfile": { + "type": "string", + "description": "anti virus profile data" + }, + "urlFilteringProfile": { + "type": "string", + "description": "URL filtering profile data" + }, + "fileBlockingProfile": { + "type": "string", + "description": "File blocking profile data" + }, + "dnsSubscription": { + "type": "string", + "description": "DNS Subscription profile data" + }, + "outboundUnTrustCertificate": { + "type": "string", + "description": "Untrusted Egress Decryption profile data" + }, + "outboundTrustCertificate": { + "type": "string", + "description": "Trusted Egress Decryption profile data" + } + }, + "description": "security services" + }, + "securityServicesResponse": { + "type": "object", + "properties": { + "value": { + "$ref": "#/definitions/securityServicesTypeList", + "description": "response value" + }, + "nextLink": { + "type": "string", + "description": "next link" + } + }, + "description": "Security services list response", + "required": [ + "value" + ] + }, + "securityServicesTypeList": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "security services type" + }, + "entry": { + "type": "array", + "items": { + "$ref": "#/definitions/NameDescriptionObject" + }, + "x-ms-identifiers": [], + "x-cadl-name": "NameDescriptionObject[]", + "description": "list" + } + }, + "description": "Security services type list", + "required": [ + "entry" + ] + } + }, + "parameters": { + "CertificateObjectGlobalRulestackResource.name": { + "name": "name", + "in": "path", + "required": true, + "description": "certificate name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "CertificateObjectLocalRulestackResource.name": { + "name": "name", + "in": "path", + "required": true, + "description": "certificate name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "FirewallResource.firewallName": { + "name": "firewallName", + "in": "path", + "required": true, + "description": "Firewall resource name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "FqdnListGlobalRulestackResource.name": { + "name": "name", + "in": "path", + "required": true, + "description": "fqdn list name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "FqdnListLocalRulestackResource.name": { + "name": "name", + "in": "path", + "required": true, + "description": "fqdn list name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "GlobalRulestackResource.globalRulestackName": { + "name": "globalRulestackName", + "in": "path", + "required": true, + "description": "GlobalRulestack resource name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "LocalRulesResource.priority": { + "name": "priority", + "in": "path", + "required": true, + "description": "Local Rule priority", + "type": "string", + "x-ms-parameter-location": "method" + }, + "LocalRulestackResource.localRulestackName": { + "name": "localRulestackName", + "in": "path", + "required": true, + "description": "LocalRulestack resource name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "PostRulesResource.priority": { + "name": "priority", + "in": "path", + "required": true, + "description": "Post Rule priority", + "type": "string", + "x-ms-parameter-location": "method" + }, + "PreRulesResource.priority": { + "name": "priority", + "in": "path", + "required": true, + "description": "Pre Rule priority", + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrefixListGlobalRulestackResource.name": { + "name": "name", + "in": "path", + "required": true, + "description": "Local Rule priority", + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrefixListResource.name": { + "name": "name", + "in": "path", + "required": true, + "description": "Local Rule priority", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..f96c2547cd89 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1", + "resource": { + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..975cd60a4654 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1", + "resource": { + "properties": { + "certificateSelfSigned": "TRUE" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/certificates/armid1", + "properties": { + "certificateSelfSigned": "TRUE" + } + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/certificates/armid1", + "properties": { + "certificateSelfSigned": "TRUE" + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2f65f4a7f70d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..2f65f4a7f70d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6e8c93715a00 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..5d95880bc1a0 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/certificates/armid1", + "properties": { + "certificateSelfSigned": "TRUE" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..9df8f72bea54 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_List_MaximumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "desc", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..be0db018e637 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectGlobalRulestack_List_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/certificates/certificates1", + "properties": { + "certificateSelfSigned": "TRUE" + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..8a4fc424f9a9 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resource": { + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..fdc598cd0c4b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resource": { + "properties": { + "certificateSelfSigned": "TRUE" + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/certificates/armid1", + "properties": { + "certificateSelfSigned": "TRUE" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/certificates/armid1", + "properties": { + "certificateSelfSigned": "TRUE" + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..da85dc84f0b3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..da85dc84f0b3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a2e57d28c1c3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..e45c86f411b1 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/certificates/armid1", + "properties": { + "certificateSelfSigned": "TRUE" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json new file mode 100644 index 000000000000..6ec329e49b95 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "desc", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json new file mode 100644 index 000000000000..fd75483200a2 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/certificates/certificates1", + "properties": { + "certificateSelfSigned": "TRUE" + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..fea23b00acf6 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_Get_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1/statuses/default", + "name": "default", + "properties": { + "healthReason": "aaaaaaaaaaaa", + "healthStatus": "GREEN", + "isPanoramaManaged": "TRUE", + "panoramaStatus": { + "panoramaServer2Status": "UP", + "panoramaServerStatus": "UP" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..d355e8e23aca --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1/statuses/default", + "properties": {} + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_ListByFirewalls_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_ListByFirewalls_MaximumSet_Gen.json new file mode 100644 index 000000000000..b234c0efb8b7 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_ListByFirewalls_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaa", + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1/statuses/default", + "name": "default", + "properties": { + "healthReason": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "healthStatus": "GREEN", + "isPanoramaManaged": "TRUE", + "panoramaStatus": { + "panoramaServer2Status": "UP", + "panoramaServerStatus": "UP" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_ListByFirewalls_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_ListByFirewalls_MinimumSet_Gen.json new file mode 100644 index 000000000000..ca8040d881d1 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FirewallStatus_ListByFirewalls_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1/statuses/default", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..9ae2381535d2 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,442 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resource": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "lrs1", + "rulestackId": "PANRSID" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "liftr-pan-ame-test", + "publisherId": "isvtestuklegacy" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "configString": "bas64EncodedString" + }, + "planData": { + "billingCycle": "MONTHLY", + "planId": "liftrpantestplan", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "tags": { + "tagName": "value" + } + }, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/firewalls/armid1", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionId": "aa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "cgName": "PanoramaCollectorGroup", + "configString": "bas64EncodedString", + "dgName": "PanoramaDeviceGroup", + "hostName": "hostname", + "panoramaServer": "10.25.1.1", + "panoramaServer2": "10.20.1.1", + "tplName": "PanoramaTemplateStack", + "vmAuthKey": "SSH_AUTH_KEY" + }, + "planData": { + "billingCycle": "WEEKLY", + "effectiveDate": "2022-09-13T00:46:05.283Z", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "firewalls" + } + }, + "201": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaa", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionId": "aa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "cgName": "PanoramaCollectorGroup", + "configString": "bas64EncodedString", + "dgName": "PanoramaDeviceGroup", + "hostName": "hostname", + "panoramaServer": "10.25.1.1", + "panoramaServer2": "10.20.1.1", + "tplName": "PanoramaTemplateStack", + "vmAuthKey": "SSH_AUTH_KEY" + }, + "planData": { + "billingCycle": "WEEKLY", + "effectiveDate": "2022-09-13T00:46:05.283Z", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaa" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..9d4a40ee3d1a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resource": { + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "liftr-pan-ame-test", + "publisherId": "isvtestuklegacy" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "MONTHLY", + "planId": "liftrpantestplan" + } + } + }, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1", + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1", + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..28030dabe861 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Delete_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..28030dabe861 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Delete_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1a79291352e5 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Get_MaximumSet_Gen.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaa", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionId": "aa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "cgName": "PanoramaCollectorGroup", + "configString": "bas64EncodedString", + "dgName": "PanoramaDeviceGroup", + "hostName": "hostname", + "panoramaServer": "10.25.1.1", + "panoramaServer2": "10.20.1.1", + "tplName": "PanoramaTemplateStack", + "vmAuthKey": "SSH_AUTH_KEY" + }, + "planData": { + "billingCycle": "WEEKLY", + "effectiveDate": "2022-09-13T00:46:05.283Z", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..d1b1874ed58e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Get_MinimumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1", + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListByResourceGroup_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..f9a47c5db333 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaa", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionId": "aa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "cgName": "PanoramaCollectorGroup", + "configString": "bas64EncodedString", + "dgName": "PanoramaDeviceGroup", + "hostName": "hostname", + "panoramaServer": "10.25.1.1", + "panoramaServer2": "10.20.1.1", + "tplName": "PanoramaTemplateStack", + "vmAuthKey": "SSH_AUTH_KEY" + }, + "planData": { + "billingCycle": "WEEKLY", + "effectiveDate": "2022-09-13T00:46:05.283Z", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListByResourceGroup_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..85a0b80fd54f --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall", + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListBySubscription_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..f7a16da398e5 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaa", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionId": "aa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "cgName": "PanoramaCollectorGroup", + "configString": "bas64EncodedString", + "dgName": "PanoramaDeviceGroup", + "hostName": "hostname", + "panoramaServer": "10.25.1.1", + "panoramaServer2": "10.20.1.1", + "tplName": "PanoramaTemplateStack", + "vmAuthKey": "SSH_AUTH_KEY" + }, + "planData": { + "billingCycle": "WEEKLY", + "effectiveDate": "2022-09-13T00:46:05.283Z", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListBySubscription_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..d1e69c848b50 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall", + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Update_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..3d06d0036cba --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Update_MaximumSet_Gen.json @@ -0,0 +1,286 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "configString": "bas64EncodedString" + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + } + }, + "tags": { + "tagName": "value" + } + }, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaa", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionId": "aa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "cgName": "PanoramaCollectorGroup", + "configString": "bas64EncodedString", + "dgName": "PanoramaDeviceGroup", + "hostName": "hostname", + "panoramaServer": "10.25.1.1", + "panoramaServer2": "10.20.1.1", + "tplName": "PanoramaTemplateStack", + "vmAuthKey": "SSH_AUTH_KEY" + }, + "planData": { + "billingCycle": "WEEKLY", + "effectiveDate": "2022-09-13T00:46:05.283Z", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Update_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..2dc0d600cebb --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_Update_MinimumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "properties": {}, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getGlobalRulestack_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getGlobalRulestack_MaximumSet_Gen.json new file mode 100644 index 000000000000..9bf04d12e8b2 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getGlobalRulestack_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "azureId": "aaaaaaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getGlobalRulestack_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getGlobalRulestack_MinimumSet_Gen.json new file mode 100644 index 000000000000..9bf04d12e8b2 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getGlobalRulestack_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "azureId": "aaaaaaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getLogProfile_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getLogProfile_MaximumSet_Gen.json new file mode 100644 index 000000000000..aabf28df0821 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getLogProfile_MaximumSet_Gen.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "applicationInsights": { + "id": "aaaaaaaaaaaaaaaa", + "key": "aaaaaaaaaaaaa" + }, + "commonDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + }, + "decryptLogDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + }, + "logOption": "SAME_DESTINATION", + "logType": "TRAFFIC", + "threatLogDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + }, + "trafficLogDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getLogProfile_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getLogProfile_MinimumSet_Gen.json new file mode 100644 index 000000000000..79e20bce79dc --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getLogProfile_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getSupportInfo_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getSupportInfo_MaximumSet_Gen.json new file mode 100644 index 000000000000..8725ac09d00c --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getSupportInfo_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "email": "user1@domain.com", + "firewallName": "firewall1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "accountId": "3cg5b439-294d-4c25-b0b2-ef649e0g6d38", + "accountRegistered": "TRUE", + "freeTrial": "TRUE", + "freeTrialCreditLeft": 10, + "freeTrialDaysLeft": 1, + "helpURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "productSerial": "e22715cb-7e4e-4814-ad4f-ccd1417755d7", + "productSku": "62f63e3c-bc5a-4d68-a8a1-fcba9f526c90", + "registerURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "supportURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "userDomainSupported": "TRUE", + "userRegistered": "TRUE" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getSupportInfo_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getSupportInfo_MinimumSet_Gen.json new file mode 100644 index 000000000000..2eec509c8ce2 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_getSupportInfo_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_saveLogProfile_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_saveLogProfile_MaximumSet_Gen.json new file mode 100644 index 000000000000..c37cd45f57d7 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_saveLogProfile_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "logSettings": { + "applicationInsights": { + "id": "aaaaaaaaaaaaaaaa", + "key": "aaaaaaaaaaaaa" + }, + "commonDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + }, + "decryptLogDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + }, + "logOption": "SAME_DESTINATION", + "logType": "TRAFFIC", + "threatLogDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + }, + "trafficLogDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + } + }, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_saveLogProfile_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_saveLogProfile_MinimumSet_Gen.json new file mode 100644 index 000000000000..17bffd805c95 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Firewalls_saveLogProfile_MinimumSet_Gen.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..609082359edb --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1", + "resource": { + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..1a1d008eec67 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1", + "resource": { + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/fqdnlists/armid1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/fqdnlists/armid1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2f65f4a7f70d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..2f65f4a7f70d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..56e1494cd533 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..73dde73e01fc --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/fqdnlists/armid1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..aa5af6aa27e4 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_List_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaaaaaaaaaaaaaaaaaaaa", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..61f4f561443d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListGlobalRulestack_List_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/fqdnlists/fqdnlists1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..ae0609a207fb --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resource": { + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..1febf235b4d7 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resource": { + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/fqdnlists/armid1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/fqdnlists/armid1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..da85dc84f0b3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..da85dc84f0b3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..91d333aa3146 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..237754a85f8d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/fqdnlists/armid1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json new file mode 100644 index 000000000000..d6fd9c01b1c9 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaaaaaaaa", + "name": "aaaaaaaaaaaaaa", + "properties": { + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaaaaaaaaaaaaaaaaaaaa", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json new file mode 100644 index 000000000000..2d29b7365f87 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/fqdnlists/fqdnlists1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..e7783620392d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "resource": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "global rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "GLOBAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "global rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "GLOBAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "globalRulestacks" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "global rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "GLOBAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "globalRulestacks" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..08eb276b8766 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "resource": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval", + "location": "eastus", + "properties": {} + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval", + "location": "eastus", + "properties": {} + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a9510f7e5f2a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..a9510f7e5f2a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..72249f6fd420 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "global rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "GLOBAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "globalRulestacks" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..08cfff1e5a23 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval", + "location": "eastus", + "properties": {} + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..c88748437b40 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_List_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "associatedSubscriptions": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "defaultMode": "IPS", + "description": "aaaaaaaaaaaaaaaaaaaaa", + "minAppIdVersion": "aaaaaaaaaaaaaaaaaaaaa", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "aaaaaaaaaa", + "antiVirusProfile": "aaaaaaaaaaaaaaaaaaaaaa", + "dnsSubscription": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fileBlockingProfile": "aaaaa", + "outboundTrustCertificate": "aaaaaa", + "outboundUnTrustCertificate": "aaaaaaaa", + "urlFilteringProfile": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vulnerabilityProfile": "aaaaaaaaaa" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..577b2d59cf8f --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_List_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/grs1", + "location": "eastus", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Update_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..2973a8af0964 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Update_MaximumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "global rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "scope": "GLOBAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "global rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "GLOBAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "globalRulestacks" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Update_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..66f49332fed8 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_Update_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "properties": {} + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": {} + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_commit_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_commit_MaximumSet_Gen.json new file mode 100644 index 000000000000..fe41004953cf --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_commit_MaximumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_commit_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_commit_MinimumSet_Gen.json new file mode 100644 index 000000000000..fe41004953cf --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_commit_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_getChangeLog_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_getChangeLog_MaximumSet_Gen.json new file mode 100644 index 000000000000..d42098fb558b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_getChangeLog_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "changes": [ + "aaaa" + ], + "lastCommitted": "2022-09-09T05:08:24.229Z", + "lastModified": "2022-09-09T05:08:24.229Z" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_getChangeLog_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_getChangeLog_MinimumSet_Gen.json new file mode 100644 index 000000000000..d7821deb7413 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_getChangeLog_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "changes": [ + "aaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen.json new file mode 100644 index 000000000000..c448a95bc9f6 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "skip": "a6a321", + "top": 20, + "type": "globalRulestacks" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": { + "entry": [ + { + "description": "aaaaaaaaaaaa", + "name": "aaaaaaaaaa" + } + ], + "type": "globalRulestacks" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen.json new file mode 100644 index 000000000000..11c2c8fd60d8 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "type": "globalRulestacks" + }, + "responses": { + "200": { + "body": { + "value": { + "entry": [ + { + "name": "aaaaaaaaaa" + } + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAppIds_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAppIds_MaximumSet_Gen.json new file mode 100644 index 000000000000..cf2303178740 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAppIds_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "appIdVersion": "8543", + "appPrefix": "pref", + "globalRulestackName": "praval", + "skip": "a6a321", + "top": 20 + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAppIds_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAppIds_MinimumSet_Gen.json new file mode 100644 index 000000000000..113736f02da8 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listAppIds_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listCountries_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listCountries_MaximumSet_Gen.json new file mode 100644 index 000000000000..7ce85c43a497 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listCountries_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "skip": "a6a321", + "top": 20 + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listCountries_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listCountries_MinimumSet_Gen.json new file mode 100644 index 000000000000..275c5a86c08b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listCountries_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listFirewalls_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listFirewalls_MaximumSet_Gen.json new file mode 100644 index 000000000000..cc430cb5a658 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listFirewalls_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listFirewalls_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listFirewalls_MinimumSet_Gen.json new file mode 100644 index 000000000000..9901935505ed --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listFirewalls_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen.json new file mode 100644 index 000000000000..63db266aaa3a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "skip": "a6a321", + "top": 20 + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "action": "aaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen.json new file mode 100644 index 000000000000..6c897f657501 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "action": "aaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listSecurityServices_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listSecurityServices_MaximumSet_Gen.json new file mode 100644 index 000000000000..c448a95bc9f6 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listSecurityServices_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "skip": "a6a321", + "top": 20, + "type": "globalRulestacks" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": { + "entry": [ + { + "description": "aaaaaaaaaaaa", + "name": "aaaaaaaaaa" + } + ], + "type": "globalRulestacks" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listSecurityServices_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listSecurityServices_MinimumSet_Gen.json new file mode 100644 index 000000000000..11c2c8fd60d8 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_listSecurityServices_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "type": "globalRulestacks" + }, + "responses": { + "200": { + "body": { + "value": { + "entry": [ + { + "name": "aaaaaaaaaa" + } + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_revert_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_revert_MaximumSet_Gen.json new file mode 100644 index 000000000000..f683827c3847 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_revert_MaximumSet_Gen.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_revert_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_revert_MinimumSet_Gen.json new file mode 100644 index 000000000000..f683827c3847 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/GlobalRulestack_revert_MinimumSet_Gen.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..327c192c79c8 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,246 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resource": { + "properties": { + "actionType": "Allow", + "applications": [ + "app1" + ], + "auditComment": "example comment", + "category": { + "feeds": [ + "feed" + ], + "urlCustom": [ + "https://microsoft.com" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "description of local rule", + "destination": { + "cidrs": [ + "1.0.0.1/10" + ], + "countries": [ + "India" + ], + "feeds": [ + "feed" + ], + "fqdnLists": [ + "FQDN1" + ], + "prefixLists": [ + "PL1" + ] + }, + "enableLogging": "DISABLED", + "etag": "c18e6eef-ba3e-49ee-8a85-2b36c863a9d0", + "inboundInspectionCertificate": "cert1", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "protocol": "HTTP", + "protocolPortList": [ + "80" + ], + "provisioningState": "Accepted", + "ruleName": "localRule1", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "1.0.0.1/10" + ], + "countries": [ + "India" + ], + "feeds": [ + "feed" + ], + "prefixLists": [ + "PL1" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + } + }, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaa", + "category": { + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaa" + ], + "urlCustom": [ + "aa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaaaaaaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 13, + "protocol": "aaaaaaaaaaaa", + "protocolPortList": [ + "aaaaaaaaaaaaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "countries": [ + "aaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaa" + } + }, + "201": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaa", + "category": { + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaa" + ], + "urlCustom": [ + "aa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaaaaaaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 13, + "protocol": "aaaaaaaaaaaa", + "protocolPortList": [ + "aaaaaaaaaaaaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "countries": [ + "aaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaa" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..d73e4b523688 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resource": { + "properties": { + "ruleName": "localRule1" + } + }, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/grs1/localrules/1", + "properties": { + "ruleName": "aaaaaa" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/grs1/localrules/1", + "properties": { + "ruleName": "aaaaaa" + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..4b44dfa50b00 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..4b44dfa50b00 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..c603c4f5fcca --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Get_MaximumSet_Gen.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaa", + "category": { + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaa" + ], + "urlCustom": [ + "aa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaaaaaaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 13, + "protocol": "aaaaaaaaaaaa", + "protocolPortList": [ + "aaaaaaaaaaaaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "countries": [ + "aaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..efc2b46e23dd --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/grs1/localrules/1", + "properties": { + "ruleName": "aaaaaa" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_ListByLocalRulestacks_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_ListByLocalRulestacks_MaximumSet_Gen.json new file mode 100644 index 000000000000..5858ed83f070 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_ListByLocalRulestacks_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaaaaaa", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "a" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_ListByLocalRulestacks_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_ListByLocalRulestacks_MinimumSet_Gen.json new file mode 100644 index 000000000000..c6242b4ce432 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_ListByLocalRulestacks_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/lrs1/localrules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_getCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_getCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..d4a56c878dee --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_getCounters_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "appSeen": { + "appSeenList": [ + { + "category": "aaaaaaaaaaaaaaaaaaa", + "risk": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "standardPorts": "aaaaaaaaaaaaaaaaaa", + "subCategory": "aaaaaaaaaaaaaaaaa", + "tag": "aaaaaaaaaa", + "technology": "aaaaaaaaaaaaaaaaaaaa", + "title": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "count": 13 + }, + "firewallName": "aaaaaaaaaaaaaaaaaa", + "hitCount": 20, + "lastUpdatedTimestamp": "2022-09-09T05:08:24.229Z", + "priority": "aaaaaaaaaaaaaaaaaaaa", + "requestTimestamp": "2022-09-09T05:08:24.229Z", + "ruleListName": "aaaaaaaaaaaaaaaaaaa", + "ruleName": "aaaa", + "ruleStackName": "aaaaaaaaaaaaaaaaa", + "timestamp": "2022-09-09T05:08:24.229Z" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_getCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_getCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..c8e9465a46c8 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_getCounters_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "priority": "aaaaaaaaaaaaaaaaaaaa", + "ruleName": "aaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_refreshCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_refreshCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..aee503c31d58 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_refreshCounters_MaximumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_refreshCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_refreshCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..d1631f5298db --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_refreshCounters_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_resetCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_resetCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..085cf4f1cb59 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_resetCounters_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "firewallName": "aaaaaaaaaaaaaaaaaa", + "priority": "aaaaaaa", + "ruleListName": "aaaaa", + "ruleName": "aaaaa", + "ruleStackName": "aa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_resetCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_resetCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..e0d09aafac05 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRules_resetCounters_MinimumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..b7ad0cb857fd --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resource": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "local rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "tags": { + "tagName": "value" + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/localrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "local rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "localRulestacks" + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/localrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "local rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "localRulestacks" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..179a4679cb09 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resource": { + "location": "eastus", + "properties": {} + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval", + "location": "eastus", + "properties": {} + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval", + "location": "eastus", + "properties": {} + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..5f2f7bebccff --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Delete_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..5f2f7bebccff --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Delete_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..c4b6e6ca247a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Get_MaximumSet_Gen.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/localrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "local rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "localRulestacks" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..02e420981912 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Get_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval", + "location": "eastus", + "properties": {} + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListByResourceGroup_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..d679c0f468af --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "associatedSubscriptions": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "defaultMode": "IPS", + "description": "aaaaaaaaaaaaaaaaaaaaa", + "minAppIdVersion": "aaaaaaaaaaaaaaaaaaaaa", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "aaaaaaaaaa", + "antiVirusProfile": "aaaaaaaaaaaaaaaaaaaaaa", + "dnsSubscription": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fileBlockingProfile": "aaaaa", + "outboundTrustCertificate": "aaaaaa", + "outboundUnTrustCertificate": "aaaaaaaa", + "urlFilteringProfile": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vulnerabilityProfile": "aaaaaaaaaa" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListByResourceGroup_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..ff89c6f110ba --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/lrs1", + "location": "eastus", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListBySubscription_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..9322797687d3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "associatedSubscriptions": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "defaultMode": "IPS", + "description": "aaaaaaaaaaaaaaaaaaaaa", + "minAppIdVersion": "aaaaaaaaaaaaaaaaaaaaa", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "aaaaaaaaaa", + "antiVirusProfile": "aaaaaaaaaaaaaaaaaaaaaa", + "dnsSubscription": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fileBlockingProfile": "aaaaa", + "outboundTrustCertificate": "aaaaaa", + "outboundUnTrustCertificate": "aaaaaaaa", + "urlFilteringProfile": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vulnerabilityProfile": "aaaaaaaaaa" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListBySubscription_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..5c7e2ad077cf --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/lrs1", + "location": "eastus", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Update_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..9c8fcc2406f0 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Update_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "local rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "tags": { + "tagName": "value" + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/localrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "local rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "localRulestacks" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Update_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..2f068ff02f4d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_Update_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "properties": {}, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": {} + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_commit_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_commit_MaximumSet_Gen.json new file mode 100644 index 000000000000..c904786de3e8 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_commit_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_commit_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_commit_MinimumSet_Gen.json new file mode 100644 index 000000000000..c904786de3e8 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_commit_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getChangeLog_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getChangeLog_MaximumSet_Gen.json new file mode 100644 index 000000000000..c2677e4c5f17 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getChangeLog_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "changes": [ + "aaaa" + ], + "lastCommitted": "2022-09-09T05:08:24.229Z", + "lastModified": "2022-09-09T05:08:24.229Z" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getChangeLog_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getChangeLog_MinimumSet_Gen.json new file mode 100644 index 000000000000..a378fd28654e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getChangeLog_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "changes": [ + "aaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getSupportInfo_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getSupportInfo_MaximumSet_Gen.json new file mode 100644 index 000000000000..5e03cf54bae8 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getSupportInfo_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "email": "user1@domain.com", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "accountId": "3cg5b439-294d-4c25-b0b2-ef649e0g6d38", + "accountRegistered": "TRUE", + "freeTrial": "TRUE", + "freeTrialCreditLeft": 10, + "freeTrialDaysLeft": 1, + "helpURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "productSerial": "e22715cb-7e4e-4814-ad4f-ccd1417755d7", + "productSku": "62f63e3c-bc5a-4d68-a8a1-fcba9f526c90", + "registerURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "supportURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "userDomainSupported": "TRUE", + "userRegistered": "TRUE" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getSupportInfo_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getSupportInfo_MinimumSet_Gen.json new file mode 100644 index 000000000000..5248914e096e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_getSupportInfo_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MaximumSet_Gen.json new file mode 100644 index 000000000000..7335950bf1a6 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "skip": "a6a321", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "top": 20, + "type": "localRulestacks" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": { + "entry": [ + { + "description": "aaaaaaaaaaaa", + "name": "aaaaaaaaaa" + } + ], + "type": "localRulestacks" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MinimumSet_Gen.json new file mode 100644 index 000000000000..4aadd03b32e5 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "localRulestacks" + }, + "responses": { + "200": { + "body": { + "value": { + "entry": [ + { + "name": "aaaaaaaaaa" + } + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAppIds_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAppIds_MaximumSet_Gen.json new file mode 100644 index 000000000000..5b799dd1e77b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAppIds_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "appIdVersion": "8543", + "appPrefix": "pref", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "skip": "a6a321", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "top": 20 + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAppIds_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAppIds_MinimumSet_Gen.json new file mode 100644 index 000000000000..45d658db93fa --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listAppIds_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listCountries_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listCountries_MaximumSet_Gen.json new file mode 100644 index 000000000000..838d0054813b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listCountries_MaximumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "skip": "a6a321", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "top": 20 + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listCountries_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listCountries_MinimumSet_Gen.json new file mode 100644 index 000000000000..401130b17788 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listCountries_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listFirewalls_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listFirewalls_MaximumSet_Gen.json new file mode 100644 index 000000000000..24268f3b2af0 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listFirewalls_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listFirewalls_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listFirewalls_MinimumSet_Gen.json new file mode 100644 index 000000000000..b846eb7ff8c3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listFirewalls_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MaximumSet_Gen.json new file mode 100644 index 000000000000..5beef6bb86b7 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MaximumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "skip": "a6a321", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "top": 20 + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "action": "aaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MinimumSet_Gen.json new file mode 100644 index 000000000000..484b89420025 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "action": "aaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listSecurityServices_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listSecurityServices_MaximumSet_Gen.json new file mode 100644 index 000000000000..7335950bf1a6 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listSecurityServices_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "skip": "a6a321", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "top": 20, + "type": "localRulestacks" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": { + "entry": [ + { + "description": "aaaaaaaaaaaa", + "name": "aaaaaaaaaa" + } + ], + "type": "localRulestacks" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listSecurityServices_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listSecurityServices_MinimumSet_Gen.json new file mode 100644 index 000000000000..4aadd03b32e5 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_listSecurityServices_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "localRulestacks" + }, + "responses": { + "200": { + "body": { + "value": { + "entry": [ + { + "name": "aaaaaaaaaa" + } + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_revert_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_revert_MaximumSet_Gen.json new file mode 100644 index 000000000000..903c1e62fd50 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_revert_MaximumSet_Gen.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_revert_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_revert_MinimumSet_Gen.json new file mode 100644 index 000000000000..903c1e62fd50 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/LocalRulestacks_revert_MinimumSet_Gen.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..f61f896a6d4e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaaaaaaaaaaaaaaaaaaaaa", + "value": [ + { + "actionType": "Internal", + "display": { + "description": "aaaaaaaa", + "operation": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "provider": "aaaaaaaaaaa", + "resource": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "isDataAction": true, + "name": "aaa", + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Operations_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..542897dd6860 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen.json new file mode 100644 index 000000000000..c4480535180c --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "accountId": "3cg5b439-294d-4c25-b0b2-ef649e0g6d38", + "accountRegistrationStatus": "Registered", + "credits": 15, + "endDateForCredits": "2023-02-02", + "freeTrial": "Enabled", + "freeTrialCreditLeft": 10, + "freeTrialDaysLeft": 1, + "helpURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "hubUrl": "https://paloaltonetworks.com/hubURL", + "monthlyCreditLeft": 13, + "productSerial": "e22715cb-7e4e-4814-ad4f-ccd1417755d7", + "productSku": "62f63e3c-bc5a-4d68-a8a1-fcba9f526c90", + "registerURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "startDateForCredits": "2023-01-01", + "supportURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen.json new file mode 100644 index 000000000000..5bad52f00501 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..9a0f2cde50b0 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1", + "resource": { + "properties": { + "actionType": "Allow", + "applications": [ + "app1" + ], + "auditComment": "example comment", + "category": { + "feeds": [ + "feed" + ], + "urlCustom": [ + "https://microsoft.com" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "description of post rule", + "destination": { + "cidrs": [ + "1.0.0.1/10" + ], + "countries": [ + "India" + ], + "feeds": [ + "feed" + ], + "fqdnLists": [ + "FQDN1" + ], + "prefixLists": [ + "PL1" + ] + }, + "enableLogging": "DISABLED", + "etag": "c18e6eef-ba3e-49ee-8a85-2b36c863a9d0", + "inboundInspectionCertificate": "cert1", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "protocol": "HTTP", + "protocolPortList": [ + "80" + ], + "provisioningState": "Accepted", + "ruleName": "postRule1", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "1.0.0.1/10" + ], + "countries": [ + "India" + ], + "feeds": [ + "feed" + ], + "prefixLists": [ + "PL1" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "201": { + "body": { + "id": "aaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..4f37eb89b384 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1", + "resource": { + "properties": { + "ruleName": "postRule1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/postrules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/postrules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a7697582f9d0 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..a7697582f9d0 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..afd469b7ca5d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Get_MaximumSet_Gen.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..b5922e931b6f --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_Get_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/postrules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..12b9e44d5b7f --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_List_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..b6ba33d04a2e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_List_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/postrules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_getCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_getCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..170ac12f842c --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_getCounters_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "appSeen": { + "appSeenList": [ + { + "category": "aaaaaaaaaaaaaaaaaaa", + "risk": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "standardPorts": "aaaaaaaaaaaaaaaaaa", + "subCategory": "aaaaaaaaaaaaaaaaa", + "tag": "aaaaaaaaaa", + "technology": "aaaaaaaaaaaaaaaaaaaa", + "title": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "count": 13 + }, + "firewallName": "aaaaaaaaaaaaaaaaaa", + "hitCount": 20, + "lastUpdatedTimestamp": "2022-09-09T05:08:24.229Z", + "priority": "aaaaaaaaaaaaaaaaaaaa", + "requestTimestamp": "2022-09-09T05:08:24.229Z", + "ruleListName": "aaaaaaaaaaaaaaaaaaa", + "ruleName": "aaaa", + "ruleStackName": "aaaaaaaaaaaaaaaaa", + "timestamp": "2022-09-09T05:08:24.229Z" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_getCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_getCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..7313eeb911df --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_getCounters_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "priority": "aaaaaaaaaaaaaaaaaaaa", + "ruleName": "aaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_refreshCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_refreshCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..8551a317d3ac --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_refreshCounters_MaximumSet_Gen.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_refreshCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_refreshCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..fe9e95b1a773 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_refreshCounters_MinimumSet_Gen.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_resetCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_resetCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..d6ff5e592e99 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_resetCounters_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "firewallName": "aaaaaaaaaaaaaaaaaa", + "priority": "aaaaaaa", + "ruleListName": "aaaaa", + "ruleName": "aaaaa", + "ruleStackName": "aa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_resetCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_resetCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..e20552a11d4e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PostRules_resetCounters_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..60fda9750555 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1", + "resource": { + "properties": { + "actionType": "Allow", + "applications": [ + "app1" + ], + "auditComment": "example comment", + "category": { + "feeds": [ + "feed" + ], + "urlCustom": [ + "https://microsoft.com" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "description of pre rule", + "destination": { + "cidrs": [ + "1.0.0.1/10" + ], + "countries": [ + "India" + ], + "feeds": [ + "feed" + ], + "fqdnLists": [ + "FQDN1" + ], + "prefixLists": [ + "PL1" + ] + }, + "enableLogging": "DISABLED", + "etag": "c18e6eef-ba3e-49ee-8a85-2b36c863a9d0", + "inboundInspectionCertificate": "cert1", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "protocol": "HTTP", + "protocolPortList": [ + "80" + ], + "provisioningState": "Accepted", + "ruleName": "preRule1", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "1.0.0.1/10" + ], + "countries": [ + "India" + ], + "feeds": [ + "feed" + ], + "prefixLists": [ + "PL1" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "201": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..216f0e1b8fe3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1", + "resource": { + "properties": { + "ruleName": "preRule1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/prerules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/prerules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a7697582f9d0 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..a7697582f9d0 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a3152f259e89 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Get_MaximumSet_Gen.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..b01e6b4b3312 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_Get_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/prerules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..40ea86b23ed1 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_List_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaaaaaaaaaaaaaaaaaa", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..45d213aab4d8 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_List_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/prerules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_getCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_getCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..170ac12f842c --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_getCounters_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "appSeen": { + "appSeenList": [ + { + "category": "aaaaaaaaaaaaaaaaaaa", + "risk": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "standardPorts": "aaaaaaaaaaaaaaaaaa", + "subCategory": "aaaaaaaaaaaaaaaaa", + "tag": "aaaaaaaaaa", + "technology": "aaaaaaaaaaaaaaaaaaaa", + "title": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "count": 13 + }, + "firewallName": "aaaaaaaaaaaaaaaaaa", + "hitCount": 20, + "lastUpdatedTimestamp": "2022-09-09T05:08:24.229Z", + "priority": "aaaaaaaaaaaaaaaaaaaa", + "requestTimestamp": "2022-09-09T05:08:24.229Z", + "ruleListName": "aaaaaaaaaaaaaaaaaaa", + "ruleName": "aaaa", + "ruleStackName": "aaaaaaaaaaaaaaaaa", + "timestamp": "2022-09-09T05:08:24.229Z" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_getCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_getCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..7313eeb911df --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_getCounters_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "priority": "aaaaaaaaaaaaaaaaaaaa", + "ruleName": "aaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_refreshCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_refreshCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..8551a317d3ac --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_refreshCounters_MaximumSet_Gen.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_refreshCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_refreshCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..fe9e95b1a773 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_refreshCounters_MinimumSet_Gen.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_resetCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_resetCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..d6ff5e592e99 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_resetCounters_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "firewallName": "firewall1", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "firewallName": "aaaaaaaaaaaaaaaaaa", + "priority": "aaaaaaa", + "ruleListName": "aaaaa", + "ruleName": "aaaaa", + "ruleStackName": "aa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_resetCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_resetCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..e20552a11d4e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PreRules_resetCounters_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..a6c618d20d91 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1", + "resource": { + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..73edd7763a2f --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1", + "resource": { + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/prefixlists/armid1", + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/prefixlists/armid1", + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2f65f4a7f70d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..2f65f4a7f70d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..56b0caf52e6c --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..a3ad920b7e46 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/prefixlists/armid1", + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..f4a25780fb30 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_List_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaaaaaaaaaaaaaaaa", + "etag": "aaaaaaaaaaaaaaaaaaaaaaa", + "prefixList": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..88722698e5ba --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListGlobalRulestack_List_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/prefixlists/prefixlists1", + "properties": { + "prefixList": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..8869522831cb --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resource": { + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..3e3c0d4579d5 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resource": { + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/prefixlists/armid1", + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/prefixlists/armid1", + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..da85dc84f0b3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..da85dc84f0b3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..198449972e2b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..b5ffca934024 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/prefixlists/armid1", + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json new file mode 100644 index 000000000000..9f0d744bd38c --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaaaaaaaaaaaaaaaa", + "etag": "aaaaaaaaaaaaaaaaaaaaaaa", + "prefixList": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json new file mode 100644 index 000000000000..ddae91e92dbe --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-01-19-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/prefixlists/prefixlists1", + "properties": { + "prefixList": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/PaloAltoNetworks.Cloudngfw.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/PaloAltoNetworks.Cloudngfw.json new file mode 100644 index 000000000000..78cd43d69399 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/PaloAltoNetworks.Cloudngfw.json @@ -0,0 +1,7610 @@ +{ + "swagger": "2.0", + "info": { + "title": "PaloAltoNetworks.Cloudngfw", + "version": "2024-02-07-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "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" + } + } + }, + "tags": [ + { + "name": "Firewalls" + }, + { + "name": "FirewallStatus" + }, + { + "name": "GlobalRulestack" + }, + { + "name": "LocalRulestacks" + }, + { + "name": "LocalRules" + }, + { + "name": "PreRules" + }, + { + "name": "PostRules" + }, + { + "name": "PrefixListLocalRulestack" + }, + { + "name": "PrefixListGlobalRulestack" + }, + { + "name": "FqdnListLocalRulestack" + }, + { + "name": "FqdnListGlobalRulestack" + }, + { + "name": "CertificateObjectLocalRulestack" + }, + { + "name": "CertificateObjectGlobalRulestack" + }, + { + "name": "Operations" + } + ], + "paths": { + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks": { + "get": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_List", + "description": "List GlobalRulestackResource resources by Tenant", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GlobalRulestack_List_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_List_MaximumSet_Gen.json" + }, + "GlobalRulestack_List_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_List_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}": { + "get": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_Get", + "description": "Get a GlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_Get_MaximumSet_Gen.json" + }, + "GlobalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_CreateOrUpdate", + "description": "Create a GlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GlobalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "GlobalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_Update", + "description": "Update a GlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_Update_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_Update_MaximumSet_Gen.json" + }, + "GlobalRulestack_Update_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_Delete", + "description": "Delete a GlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GlobalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_Delete_MaximumSet_Gen.json" + }, + "GlobalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/certificates": { + "get": { + "tags": [ + "CertificateObjectGlobalRulestack" + ], + "operationId": "CertificateObjectGlobalRulestack_List", + "description": "List CertificateObjectGlobalRulestackResource resources by Tenant", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectGlobalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CertificateObjectGlobalRulestack_List_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_List_MaximumSet_Gen.json" + }, + "CertificateObjectGlobalRulestack_List_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_List_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/certificates/{name}": { + "get": { + "tags": [ + "CertificateObjectGlobalRulestack" + ], + "operationId": "CertificateObjectGlobalRulestack_Get", + "description": "Get a CertificateObjectGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/CertificateObjectGlobalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectGlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "CertificateObjectGlobalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_Get_MaximumSet_Gen.json" + }, + "CertificateObjectGlobalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "CertificateObjectGlobalRulestack" + ], + "operationId": "CertificateObjectGlobalRulestack_CreateOrUpdate", + "description": "Create a CertificateObjectGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/CertificateObjectGlobalRulestackResource.name" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/CertificateObjectGlobalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectGlobalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectGlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CertificateObjectGlobalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "CertificateObjectGlobalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "CertificateObjectGlobalRulestack" + ], + "operationId": "CertificateObjectGlobalRulestack_Delete", + "description": "Delete a CertificateObjectGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/CertificateObjectGlobalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CertificateObjectGlobalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_Delete_MaximumSet_Gen.json" + }, + "CertificateObjectGlobalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectGlobalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/commit": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_commit", + "description": "Commit rulestack configuration", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "202": { + "description": "The request has been received but not yet acted upon." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GlobalRulestack_commit_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_commit_MaximumSet_Gen.json" + }, + "GlobalRulestack_commit_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_commit_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/fqdnlists": { + "get": { + "tags": [ + "FqdnListGlobalRulestack" + ], + "operationId": "FqdnListGlobalRulestack_List", + "description": "List FqdnListGlobalRulestackResource resources by Tenant", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListGlobalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FqdnListGlobalRulestack_List_MaximumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_List_MaximumSet_Gen.json" + }, + "FqdnListGlobalRulestack_List_MinimumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_List_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/fqdnlists/{name}": { + "get": { + "tags": [ + "FqdnListGlobalRulestack" + ], + "operationId": "FqdnListGlobalRulestack_Get", + "description": "Get a FqdnListGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/FqdnListGlobalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListGlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "FqdnListGlobalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_Get_MaximumSet_Gen.json" + }, + "FqdnListGlobalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "FqdnListGlobalRulestack" + ], + "operationId": "FqdnListGlobalRulestack_CreateOrUpdate", + "description": "Create a FqdnListGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/FqdnListGlobalRulestackResource.name" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/FqdnListGlobalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListGlobalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListGlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "FqdnListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "FqdnListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "FqdnListGlobalRulestack" + ], + "operationId": "FqdnListGlobalRulestack_Delete", + "description": "Delete a FqdnListGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/FqdnListGlobalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "FqdnListGlobalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_Delete_MaximumSet_Gen.json" + }, + "FqdnListGlobalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/FqdnListGlobalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/getChangeLog": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_getChangeLog", + "description": "Get changelog", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Changelog" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_getChangeLog_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_getChangeLog_MaximumSet_Gen.json" + }, + "GlobalRulestack_getChangeLog_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_getChangeLog_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listAdvancedSecurityObjects": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_listAdvancedSecurityObjects", + "description": "Get the list of advanced security objects", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "type", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "urlCustom", + "feeds" + ], + "x-ms-enum": { + "name": "AdvSecurityObjectTypeEnum", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/advSecurityObjectListResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen.json" + }, + "GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listAppIds": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_listAppIds", + "description": "List of AppIds for GlobalRulestack ApiVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "appIdVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "appPrefix", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListAppIdResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_listAppIds_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listAppIds_MaximumSet_Gen.json" + }, + "GlobalRulestack_listAppIds_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listAppIds_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listCountries": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_listCountries", + "description": "List of countries for Rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CountriesResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_listCountries_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listCountries_MaximumSet_Gen.json" + }, + "GlobalRulestack_listCountries_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listCountries_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listFirewalls": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_listFirewalls", + "description": "List of Firewalls associated with Rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListFirewallsResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_listFirewalls_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listFirewalls_MaximumSet_Gen.json" + }, + "GlobalRulestack_listFirewalls_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listFirewalls_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listPredefinedUrlCategories": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_listPredefinedUrlCategories", + "description": "List predefined URL categories for rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PredefinedUrlCategoriesResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen.json" + }, + "GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listSecurityServices": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_listSecurityServices", + "description": "List the security services for rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "type", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "antiSpyware", + "antiVirus", + "ipsVulnerability", + "urlFiltering", + "fileBlocking", + "dnsSubscription" + ], + "x-ms-enum": { + "name": "SecurityServicesTypeEnum", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/securityServicesResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_listSecurityServices_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listSecurityServices_MaximumSet_Gen.json" + }, + "GlobalRulestack_listSecurityServices_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_listSecurityServices_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/postRules": { + "get": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_List", + "description": "List PostRulesResource resources by Tenant", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PostRulesResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PostRules_List_MaximumSet_Gen": { + "$ref": "./examples/PostRules_List_MaximumSet_Gen.json" + }, + "PostRules_List_MinimumSet_Gen": { + "$ref": "./examples/PostRules_List_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/postRules/{priority}": { + "get": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_Get", + "description": "Get a PostRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PostRulesResource.priority" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PostRulesResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PostRules_Get_MaximumSet_Gen": { + "$ref": "./examples/PostRules_Get_MaximumSet_Gen.json" + }, + "PostRules_Get_MinimumSet_Gen": { + "$ref": "./examples/PostRules_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_CreateOrUpdate", + "description": "Create a PostRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PostRulesResource.priority" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/PostRulesResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PostRulesResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/PostRulesResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PostRules_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/PostRules_CreateOrUpdate_MaximumSet_Gen.json" + }, + "PostRules_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/PostRules_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_Delete", + "description": "Delete a PostRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PostRulesResource.priority" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PostRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/PostRules_Delete_MaximumSet_Gen.json" + }, + "PostRules_Delete_MinimumSet_Gen": { + "$ref": "./examples/PostRules_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/postRules/{priority}/getCounters": { + "post": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_getCounters", + "description": "Get counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PostRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RuleCounter" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PostRules_getCounters_MaximumSet_Gen": { + "$ref": "./examples/PostRules_getCounters_MaximumSet_Gen.json" + }, + "PostRules_getCounters_MinimumSet_Gen": { + "$ref": "./examples/PostRules_getCounters_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/postRules/{priority}/refreshCounters": { + "post": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_refreshCounters", + "description": "Refresh counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PostRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "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" + } + } + }, + "x-ms-examples": { + "PostRules_refreshCounters_MaximumSet_Gen": { + "$ref": "./examples/PostRules_refreshCounters_MaximumSet_Gen.json" + }, + "PostRules_refreshCounters_MinimumSet_Gen": { + "$ref": "./examples/PostRules_refreshCounters_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/postRules/{priority}/resetCounters": { + "post": { + "tags": [ + "PostRules" + ], + "operationId": "PostRules_resetCounters", + "description": "Reset counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PostRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RuleCounterReset" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PostRules_resetCounters_MaximumSet_Gen": { + "$ref": "./examples/PostRules_resetCounters_MaximumSet_Gen.json" + }, + "PostRules_resetCounters_MinimumSet_Gen": { + "$ref": "./examples/PostRules_resetCounters_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/prefixlists": { + "get": { + "tags": [ + "PrefixListGlobalRulestack" + ], + "operationId": "PrefixListGlobalRulestack_List", + "description": "List PrefixListGlobalRulestackResource resources by Tenant", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListGlobalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrefixListGlobalRulestack_List_MaximumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_List_MaximumSet_Gen.json" + }, + "PrefixListGlobalRulestack_List_MinimumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_List_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/prefixlists/{name}": { + "get": { + "tags": [ + "PrefixListGlobalRulestack" + ], + "operationId": "PrefixListGlobalRulestack_Get", + "description": "Get a PrefixListGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PrefixListGlobalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListGlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PrefixListGlobalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_Get_MaximumSet_Gen.json" + }, + "PrefixListGlobalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "PrefixListGlobalRulestack" + ], + "operationId": "PrefixListGlobalRulestack_CreateOrUpdate", + "description": "Create a PrefixListGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PrefixListGlobalRulestackResource.name" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/PrefixListGlobalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListGlobalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListGlobalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrefixListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "PrefixListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "PrefixListGlobalRulestack" + ], + "operationId": "PrefixListGlobalRulestack_Delete", + "description": "Delete a PrefixListGlobalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PrefixListGlobalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrefixListGlobalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_Delete_MaximumSet_Gen.json" + }, + "PrefixListGlobalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/PrefixListGlobalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules": { + "get": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_List", + "description": "List PreRulesResource resources by Tenant", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PreRulesResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PreRules_List_MaximumSet_Gen": { + "$ref": "./examples/PreRules_List_MaximumSet_Gen.json" + }, + "PreRules_List_MinimumSet_Gen": { + "$ref": "./examples/PreRules_List_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules/{priority}": { + "get": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_Get", + "description": "Get a PreRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PreRulesResource.priority" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PreRulesResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PreRules_Get_MaximumSet_Gen": { + "$ref": "./examples/PreRules_Get_MaximumSet_Gen.json" + }, + "PreRules_Get_MinimumSet_Gen": { + "$ref": "./examples/PreRules_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_CreateOrUpdate", + "description": "Create a PreRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PreRulesResource.priority" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/PreRulesResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PreRulesResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/PreRulesResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PreRules_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/PreRules_CreateOrUpdate_MaximumSet_Gen.json" + }, + "PreRules_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/PreRules_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_Delete", + "description": "Delete a PreRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PreRulesResource.priority" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PreRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/PreRules_Delete_MaximumSet_Gen.json" + }, + "PreRules_Delete_MinimumSet_Gen": { + "$ref": "./examples/PreRules_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules/{priority}/getCounters": { + "post": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_getCounters", + "description": "Get counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PreRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RuleCounter" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PreRules_getCounters_MaximumSet_Gen": { + "$ref": "./examples/PreRules_getCounters_MaximumSet_Gen.json" + }, + "PreRules_getCounters_MinimumSet_Gen": { + "$ref": "./examples/PreRules_getCounters_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules/{priority}/refreshCounters": { + "post": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_refreshCounters", + "description": "Refresh counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PreRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "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" + } + } + }, + "x-ms-examples": { + "PreRules_refreshCounters_MaximumSet_Gen": { + "$ref": "./examples/PreRules_refreshCounters_MaximumSet_Gen.json" + }, + "PreRules_refreshCounters_MinimumSet_Gen": { + "$ref": "./examples/PreRules_refreshCounters_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules/{priority}/resetCounters": { + "post": { + "tags": [ + "PreRules" + ], + "operationId": "PreRules_resetCounters", + "description": "Reset counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + }, + { + "$ref": "#/parameters/PreRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RuleCounterReset" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PreRules_resetCounters_MaximumSet_Gen": { + "$ref": "./examples/PreRules_resetCounters_MaximumSet_Gen.json" + }, + "PreRules_resetCounters_MinimumSet_Gen": { + "$ref": "./examples/PreRules_resetCounters_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/revert": { + "post": { + "tags": [ + "GlobalRulestack" + ], + "operationId": "GlobalRulestack_revert", + "description": "Revert rulestack configuration", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GlobalRulestackResource.globalRulestackName" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "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" + } + } + }, + "x-ms-examples": { + "GlobalRulestack_revert_MaximumSet_Gen": { + "$ref": "./examples/GlobalRulestack_revert_MaximumSet_Gen.json" + }, + "GlobalRulestack_revert_MinimumSet_Gen": { + "$ref": "./examples/GlobalRulestack_revert_MinimumSet_Gen.json" + } + } + } + }, + "/providers/PaloAltoNetworks.Cloudngfw/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet_Gen": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/PaloAltoNetworks.Cloudngfw/createProductSerialNumber": { + "post": { + "operationId": "PaloAltoNetworksCloudngfw_createProductSerialNumber", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductSerialNumberRequestStatus" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PaloAltoNetworksCloudngfw_createProductSerialNumber_MaximumSet_Gen": { + "$ref": "./examples/PaloAltoNetworksCloudngfw_createProductSerialNumber_MaximumSet_Gen.json" + }, + "PaloAltoNetworksCloudngfw_createProductSerialNumber_MinimumSet_Gen": { + "$ref": "./examples/PaloAltoNetworksCloudngfw_createProductSerialNumber_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/PaloAltoNetworks.Cloudngfw/firewalls": { + "get": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_ListBySubscription", + "description": "List FirewallResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Firewalls_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_ListBySubscription_MaximumSet_Gen.json" + }, + "Firewalls_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/PaloAltoNetworks.Cloudngfw/listCloudManagerTenants": { + "post": { + "operationId": "PaloAltoNetworksCloudngfw_listCloudManagerTenants", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudManagerTenant" + }, + "x-ms-identifiers": [], + "x-cadl-name": "CloudManagerTenant[]" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PaloAltoNetworksCloudngfw_listCloudManagerTenants_MaximumSet_Gen": { + "$ref": "./examples/PaloAltoNetworksCloudngfw_listCloudManagerTenants_MaximumSet_Gen.json" + }, + "PaloAltoNetworksCloudngfw_listCloudManagerTenants_MinimumSet_Gen": { + "$ref": "./examples/PaloAltoNetworksCloudngfw_listCloudManagerTenants_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/PaloAltoNetworks.Cloudngfw/listProductSerialNumberStatus": { + "post": { + "operationId": "PaloAltoNetworksCloudngfw_listProductSerialNumberStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductSerialNumberStatus" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PaloAltoNetworksCloudngfw_listProductSerialNumberStatus_MaximumSet_Gen": { + "$ref": "./examples/PaloAltoNetworksCloudngfw_listProductSerialNumberStatus_MaximumSet_Gen.json" + }, + "PaloAltoNetworksCloudngfw_listProductSerialNumberStatus_MinimumSet_Gen": { + "$ref": "./examples/PaloAltoNetworksCloudngfw_listProductSerialNumberStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/PaloAltoNetworks.Cloudngfw/listSupportInfo": { + "post": { + "operationId": "PaloAltoNetworksCloudngfw_listSupportInfo", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SupportInfoModel" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen": { + "$ref": "./examples/PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen.json" + }, + "PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen": { + "$ref": "./examples/PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks": { + "get": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_ListBySubscription", + "description": "List LocalRulestackResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "LocalRulestacks_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_ListBySubscription_MaximumSet_Gen.json" + }, + "LocalRulestacks_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls": { + "get": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_ListByResourceGroup", + "description": "List FirewallResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Firewalls_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_ListByResourceGroup_MaximumSet_Gen.json" + }, + "Firewalls_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}": { + "get": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_Get", + "description": "Get a FirewallResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "Firewalls_Get_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_Get_MaximumSet_Gen.json" + }, + "Firewalls_Get_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_CreateOrUpdate", + "description": "Create a FirewallResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/FirewallResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Firewalls_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_CreateOrUpdate_MaximumSet_Gen.json" + }, + "Firewalls_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_Update", + "description": "Update a FirewallResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/FirewallResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "Firewalls_Update_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_Update_MaximumSet_Gen.json" + }, + "Firewalls_Update_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_Delete", + "description": "Delete a FirewallResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Firewalls_Delete_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_Delete_MaximumSet_Gen.json" + }, + "Firewalls_Delete_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/getGlobalRulestack": { + "post": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_getGlobalRulestack", + "description": "Get Global Rulestack associated with the Firewall", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GlobalRulestackInfo" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "Firewalls_getGlobalRulestack_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_getGlobalRulestack_MaximumSet_Gen.json" + }, + "Firewalls_getGlobalRulestack_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_getGlobalRulestack_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/getLogProfile": { + "post": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_getLogProfile", + "description": "Log Profile for Firewall", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/LogSettings" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "Firewalls_getLogProfile_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_getLogProfile_MaximumSet_Gen.json" + }, + "Firewalls_getLogProfile_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_getLogProfile_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/getSupportInfo": { + "post": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_getSupportInfo", + "description": "support info for firewall.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + }, + { + "name": "email", + "in": "query", + "required": false, + "description": "email address on behalf of which this API called", + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SupportInfo" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "Firewalls_getSupportInfo_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_getSupportInfo_MaximumSet_Gen.json" + }, + "Firewalls_getSupportInfo_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_getSupportInfo_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/saveLogProfile": { + "post": { + "tags": [ + "Firewalls" + ], + "operationId": "Firewalls_saveLogProfile", + "description": "Log Profile for Firewall", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + }, + { + "name": "logSettings", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/LogSettings" + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "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" + } + } + }, + "x-ms-examples": { + "Firewalls_saveLogProfile_MaximumSet_Gen": { + "$ref": "./examples/Firewalls_saveLogProfile_MaximumSet_Gen.json" + }, + "Firewalls_saveLogProfile_MinimumSet_Gen": { + "$ref": "./examples/Firewalls_saveLogProfile_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/statuses": { + "get": { + "tags": [ + "FirewallStatus" + ], + "operationId": "FirewallStatus_ListByFirewalls", + "description": "List FirewallStatusResource resources by Firewalls", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallStatusResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FirewallStatus_ListByFirewalls_MaximumSet_Gen": { + "$ref": "./examples/FirewallStatus_ListByFirewalls_MaximumSet_Gen.json" + }, + "FirewallStatus_ListByFirewalls_MinimumSet_Gen": { + "$ref": "./examples/FirewallStatus_ListByFirewalls_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/statuses/default": { + "get": { + "tags": [ + "FirewallStatus" + ], + "operationId": "FirewallStatus_Get", + "description": "Get a FirewallStatusResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/FirewallResource.firewallName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallStatusResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "FirewallStatus_Get_MaximumSet_Gen": { + "$ref": "./examples/FirewallStatus_Get_MaximumSet_Gen.json" + }, + "FirewallStatus_Get_MinimumSet_Gen": { + "$ref": "./examples/FirewallStatus_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks": { + "get": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_ListByResourceGroup", + "description": "List LocalRulestackResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "LocalRulestacks_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_ListByResourceGroup_MaximumSet_Gen.json" + }, + "LocalRulestacks_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}": { + "get": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_Get", + "description": "Get a LocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_Get_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_Get_MaximumSet_Gen.json" + }, + "LocalRulestacks_Get_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_CreateOrUpdate", + "description": "Create a LocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/LocalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LocalRulestacks_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_CreateOrUpdate_MaximumSet_Gen.json" + }, + "LocalRulestacks_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_Update", + "description": "Update a LocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/LocalRulestackResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_Update_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_Update_MaximumSet_Gen.json" + }, + "LocalRulestacks_Update_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_Delete", + "description": "Delete a LocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LocalRulestacks_Delete_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_Delete_MaximumSet_Gen.json" + }, + "LocalRulestacks_Delete_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/certificates": { + "get": { + "tags": [ + "CertificateObjectLocalRulestack" + ], + "operationId": "CertificateObjectLocalRulestack_ListByLocalRulestacks", + "description": "List CertificateObjectLocalRulestackResource resources by LocalRulestacks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectLocalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CertificateObjectLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json" + }, + "CertificateObjectLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/certificates/{name}": { + "get": { + "tags": [ + "CertificateObjectLocalRulestack" + ], + "operationId": "CertificateObjectLocalRulestack_Get", + "description": "Get a CertificateObjectLocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/CertificateObjectLocalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectLocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "CertificateObjectLocalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_Get_MaximumSet_Gen.json" + }, + "CertificateObjectLocalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "CertificateObjectLocalRulestack" + ], + "operationId": "CertificateObjectLocalRulestack_CreateOrUpdate", + "description": "Create a CertificateObjectLocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/CertificateObjectLocalRulestackResource.name" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/CertificateObjectLocalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectLocalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateObjectLocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CertificateObjectLocalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "CertificateObjectLocalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "CertificateObjectLocalRulestack" + ], + "operationId": "CertificateObjectLocalRulestack_Delete", + "description": "Delete a CertificateObjectLocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/CertificateObjectLocalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CertificateObjectLocalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_Delete_MaximumSet_Gen.json" + }, + "CertificateObjectLocalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/CertificateObjectLocalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/commit": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_commit", + "description": "Commit rulestack configuration", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "202": { + "description": "The request has been received but not yet acted upon." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LocalRulestacks_commit_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_commit_MaximumSet_Gen.json" + }, + "LocalRulestacks_commit_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_commit_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/fqdnlists": { + "get": { + "tags": [ + "FqdnListLocalRulestack" + ], + "operationId": "FqdnListLocalRulestack_ListByLocalRulestacks", + "description": "List FqdnListLocalRulestackResource resources by LocalRulestacks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListLocalRulestackResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FqdnListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json" + }, + "FqdnListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/fqdnlists/{name}": { + "get": { + "tags": [ + "FqdnListLocalRulestack" + ], + "operationId": "FqdnListLocalRulestack_Get", + "description": "Get a FqdnListLocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/FqdnListLocalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListLocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "FqdnListLocalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_Get_MaximumSet_Gen.json" + }, + "FqdnListLocalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "FqdnListLocalRulestack" + ], + "operationId": "FqdnListLocalRulestack_CreateOrUpdate", + "description": "Create a FqdnListLocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/FqdnListLocalRulestackResource.name" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/FqdnListLocalRulestackResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListLocalRulestackResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/FqdnListLocalRulestackResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "FqdnListLocalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "FqdnListLocalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "FqdnListLocalRulestack" + ], + "operationId": "FqdnListLocalRulestack_Delete", + "description": "Delete a FqdnListLocalRulestackResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/FqdnListLocalRulestackResource.name" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "FqdnListLocalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_Delete_MaximumSet_Gen.json" + }, + "FqdnListLocalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/FqdnListLocalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/getChangeLog": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_getChangeLog", + "description": "Get changelog", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Changelog" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_getChangeLog_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_getChangeLog_MaximumSet_Gen.json" + }, + "LocalRulestacks_getChangeLog_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_getChangeLog_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/getSupportInfo": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_getSupportInfo", + "description": "support info for rulestack.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "email", + "in": "query", + "required": false, + "description": "email address on behalf of which this API called", + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SupportInfo" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_getSupportInfo_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_getSupportInfo_MaximumSet_Gen.json" + }, + "LocalRulestacks_getSupportInfo_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_getSupportInfo_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/listAdvancedSecurityObjects": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_listAdvancedSecurityObjects", + "description": "Get the list of advanced security objects", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "type", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "urlCustom", + "feeds" + ], + "x-ms-enum": { + "name": "AdvSecurityObjectTypeEnum", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/advSecurityObjectListResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_listAdvancedSecurityObjects_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listAdvancedSecurityObjects_MaximumSet_Gen.json" + }, + "LocalRulestacks_listAdvancedSecurityObjects_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listAdvancedSecurityObjects_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/listAppIds": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_listAppIds", + "description": "List of AppIds for LocalRulestack ApiVersion", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "appIdVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "appPrefix", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListAppIdResponse" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "operationName": "LocalRulestacks_listAppIds" + }, + "x-ms-examples": { + "LocalRulestacks_listAppIds_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listAppIds_MaximumSet_Gen.json" + }, + "LocalRulestacks_listAppIds_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listAppIds_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/listCountries": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_listCountries", + "description": "List of countries for Rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CountriesResponse" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "operationName": "LocalRulestacks_listCountries" + }, + "x-ms-examples": { + "LocalRulestacks_listCountries_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listCountries_MaximumSet_Gen.json" + }, + "LocalRulestacks_listCountries_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listCountries_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/listFirewalls": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_listFirewalls", + "description": "List of Firewalls associated with Rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListFirewallsResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_listFirewalls_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listFirewalls_MaximumSet_Gen.json" + }, + "LocalRulestacks_listFirewalls_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listFirewalls_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/listPredefinedUrlCategories": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_listPredefinedUrlCategories", + "description": "List predefined URL categories for rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PredefinedUrlCategoriesResponse" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "operationName": "LocalRulestacks_listPredefinedUrlCategories" + }, + "x-ms-examples": { + "LocalRulestacks_listPredefinedUrlCategories_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listPredefinedUrlCategories_MaximumSet_Gen.json" + }, + "LocalRulestacks_listPredefinedUrlCategories_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listPredefinedUrlCategories_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/listSecurityServices": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_listSecurityServices", + "description": "List the security services for rulestack", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "type", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "antiSpyware", + "antiVirus", + "ipsVulnerability", + "urlFiltering", + "fileBlocking", + "dnsSubscription" + ], + "x-ms-enum": { + "name": "SecurityServicesTypeEnum", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/securityServicesResponse" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_listSecurityServices_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listSecurityServices_MaximumSet_Gen.json" + }, + "LocalRulestacks_listSecurityServices_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_listSecurityServices_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/localRules": { + "get": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_ListByLocalRulestacks", + "description": "List LocalRulesResource resources by LocalRulestacks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulesResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "LocalRules_ListByLocalRulestacks_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_ListByLocalRulestacks_MaximumSet_Gen.json" + }, + "LocalRules_ListByLocalRulestacks_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_ListByLocalRulestacks_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/localRules/{priority}": { + "get": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_Get", + "description": "Get a LocalRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/LocalRulesResource.priority" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulesResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRules_Get_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_Get_MaximumSet_Gen.json" + }, + "LocalRules_Get_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_CreateOrUpdate", + "description": "Create a LocalRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/LocalRulesResource.priority" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/LocalRulesResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulesResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocalRulesResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LocalRules_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_CreateOrUpdate_MaximumSet_Gen.json" + }, + "LocalRules_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_Delete", + "description": "Delete a LocalRulesResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/LocalRulesResource.priority" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LocalRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_Delete_MaximumSet_Gen.json" + }, + "LocalRules_Delete_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/localRules/{priority}/getCounters": { + "post": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_getCounters", + "description": "Get counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/LocalRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RuleCounter" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRules_getCounters_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_getCounters_MaximumSet_Gen.json" + }, + "LocalRules_getCounters_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_getCounters_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/localRules/{priority}/refreshCounters": { + "post": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_refreshCounters", + "description": "Refresh counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/LocalRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRules_refreshCounters_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_refreshCounters_MaximumSet_Gen.json" + }, + "LocalRules_refreshCounters_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_refreshCounters_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/localRules/{priority}/resetCounters": { + "post": { + "tags": [ + "LocalRules" + ], + "operationId": "LocalRules_resetCounters", + "description": "Reset counters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/LocalRulesResource.priority" + }, + { + "name": "firewallName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RuleCounterReset" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRules_resetCounters_MaximumSet_Gen": { + "$ref": "./examples/LocalRules_resetCounters_MaximumSet_Gen.json" + }, + "LocalRules_resetCounters_MinimumSet_Gen": { + "$ref": "./examples/LocalRules_resetCounters_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/prefixlists": { + "get": { + "tags": [ + "PrefixListLocalRulestack" + ], + "operationId": "PrefixListLocalRulestack_ListByLocalRulestacks", + "description": "List PrefixListResource resources by LocalRulestacks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListResourceListResult" + } + }, + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrefixListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json" + }, + "PrefixListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/prefixlists/{name}": { + "get": { + "tags": [ + "PrefixListLocalRulestack" + ], + "operationId": "PrefixListLocalRulestack_Get", + "description": "Get a PrefixListResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/PrefixListResource.name" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListResource" + } + }, + "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" + } + } + }, + "x-ms-examples": { + "PrefixListLocalRulestack_Get_MaximumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_Get_MaximumSet_Gen.json" + }, + "PrefixListLocalRulestack_Get_MinimumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "PrefixListLocalRulestack" + ], + "operationId": "PrefixListLocalRulestack_CreateOrUpdate", + "description": "Create a PrefixListResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/PrefixListResource.name" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/PrefixListResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListResource" + } + }, + "201": { + "description": "Azure create operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrefixListResource" + } + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrefixListLocalRulestack_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json" + }, + "PrefixListLocalRulestack_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "PrefixListLocalRulestack" + ], + "operationId": "PrefixListLocalRulestack_Delete", + "description": "Delete a PrefixListResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + }, + { + "$ref": "#/parameters/PrefixListResource.name" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted." + }, + "204": { + "description": "Resource deleted successfully." + }, + "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" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrefixListLocalRulestack_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_Delete_MaximumSet_Gen.json" + }, + "PrefixListLocalRulestack_Delete_MinimumSet_Gen": { + "$ref": "./examples/PrefixListLocalRulestack_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/{localRulestackName}/revert": { + "post": { + "tags": [ + "LocalRulestacks" + ], + "operationId": "LocalRulestacks_revert", + "description": "Revert rulestack configuration", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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/LocalRulestackResource.localRulestackName" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "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" + } + } + }, + "x-ms-examples": { + "LocalRulestacks_revert_MaximumSet_Gen": { + "$ref": "./examples/LocalRulestacks_revert_MaximumSet_Gen.json" + }, + "LocalRulestacks_revert_MinimumSet_Gen": { + "$ref": "./examples/LocalRulestacks_revert_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "ActionEnum": { + "type": "string", + "enum": [ + "Allow", + "DenySilent", + "DenyResetServer", + "DenyResetBoth" + ], + "x-ms-enum": { + "name": "ActionEnum", + "modelAsString": true + } + }, + "AdvSecurityObjectTypeEnum": { + "type": "string", + "enum": [ + "urlCustom", + "feeds" + ], + "x-ms-enum": { + "name": "AdvSecurityObjectTypeEnum", + "modelAsString": true + } + }, + "AppSeenData": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "number of rows" + }, + "appSeenList": { + "type": "array", + "items": { + "$ref": "#/definitions/AppSeenInfo" + }, + "x-ms-identifiers": [], + "x-cadl-name": "AppSeenInfo[]", + "description": "array of appSeen" + } + }, + "description": "Data Type for App Seen", + "required": [ + "count", + "appSeenList" + ] + }, + "AppSeenInfo": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "title" + }, + "category": { + "type": "string", + "description": "category" + }, + "subCategory": { + "type": "string", + "description": "subCategory" + }, + "risk": { + "type": "string", + "description": "risk" + }, + "tag": { + "type": "string", + "description": "tag" + }, + "technology": { + "type": "string", + "description": "technology" + }, + "standardPorts": { + "type": "string", + "description": "standardPorts" + } + }, + "description": "Definition for App Seen", + "required": [ + "title", + "category", + "subCategory", + "risk", + "tag", + "technology", + "standardPorts" + ] + }, + "ApplicationInsights": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource id for Application Insights" + }, + "key": { + "type": "string", + "description": "Application Insights key" + } + }, + "description": "Application Insights key" + }, + "Azure.ResourceManager.ManagedIdentityProperties": { + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "The Active Directory tenant id of the principal.", + "readOnly": true + }, + "principalId": { + "type": "string", + "description": "The active directory identifier of this principal.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityType", + "description": "The type of managed identity assigned to this resource." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Azure.ResourceManager.UserAssignedIdentity" + }, + "description": "The identities assigned to this resource by the user." + } + }, + "description": "The properties of the managed service identities assigned to this resource.", + "required": [ + "type" + ] + }, + "Azure.ResourceManager.ManagedIdentityType": { + "type": "string", + "description": "The kind of managed identity assigned to this resource.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None" + }, + { + "name": "SystemAssigned", + "value": "SystemAssigned" + }, + { + "name": "UserAssigned", + "value": "UserAssigned" + }, + { + "name": "SystemAndUserAssigned", + "value": "SystemAssigned,UserAssigned" + } + ] + } + }, + "Azure.ResourceManager.UserAssignedIdentity": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The active directory client identifier for this principal." + }, + "principalId": { + "type": "string", + "description": "The active directory identifier for this principal." + } + }, + "description": "A managed identity assigned by the user." + }, + "BillingCycle": { + "type": "string", + "description": "Billing cycle", + "enum": [ + "WEEKLY", + "MONTHLY" + ], + "x-ms-enum": { + "name": "BillingCycle", + "modelAsString": true + } + }, + "BooleanEnum": { + "type": "string", + "description": "Boolean Enum", + "enum": [ + "TRUE", + "FALSE" + ], + "x-ms-enum": { + "name": "BooleanEnum", + "modelAsString": true + } + }, + "Category": { + "type": "object", + "properties": { + "urlCustom": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "custom URL" + }, + "feeds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "feed list" + } + }, + "description": "URL/EDL to match", + "required": [ + "urlCustom", + "feeds" + ] + }, + "CertificateObject": { + "type": "object", + "properties": { + "certificateSignerResourceId": { + "type": "string", + "description": "Resource Id of certificate signer, to be populated only when certificateSelfSigned is false" + }, + "certificateSelfSigned": { + "$ref": "#/definitions/BooleanEnum", + "description": "use certificate self signed" + }, + "auditComment": { + "type": "string", + "description": "comment for this object" + }, + "description": { + "type": "string", + "description": "user description for this object" + }, + "etag": { + "type": "string", + "description": "read only string representing last create or update" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "description": "certificate used for inbound and outbound decryption", + "required": [ + "certificateSelfSigned" + ] + }, + "CertificateObjectGlobalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateObject", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "GlobalRulestack Certificate Object", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "CertificateObjectGlobalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateObjectGlobalRulestackResource" + }, + "x-cadl-name": "CertificateObjectGlobalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a CertificateObjectGlobalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "CertificateObjectLocalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateObject", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "LocalRulestack Certificate Object", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "CertificateObjectLocalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateObjectLocalRulestackResource" + }, + "x-cadl-name": "CertificateObjectLocalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a CertificateObjectLocalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "Changelog": { + "type": "object", + "properties": { + "changes": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "list of changes" + }, + "lastCommitted": { + "type": "string", + "format": "date-time", + "description": "lastCommitted timestamp" + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "lastModified timestamp" + } + }, + "description": "Changelog list", + "required": [ + "changes" + ] + }, + "CloudManagerTenant": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Manager Tenant" + }, + "tenantId": { + "type": "string", + "description": "Cloud Manager Tenant ID" + } + }, + "description": "Cloud Manager Tenant", + "required": [ + "name" + ] + }, + "CountriesResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Country" + }, + "x-ms-identifiers": [], + "x-cadl-name": "Country[]", + "description": "List of countries" + }, + "nextLink": { + "type": "string", + "description": "next link" + } + }, + "description": "Countries Response Object", + "required": [ + "value" + ] + }, + "Country": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "country code" + }, + "description": { + "type": "string", + "description": "code description" + } + }, + "description": "Country Description", + "required": [ + "code" + ] + }, + "DNSProxy": { + "type": "string", + "description": "DNS Proxy", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "DNSProxy", + "modelAsString": true + } + }, + "DNSSettings": { + "type": "object", + "properties": { + "enableDnsProxy": { + "$ref": "#/definitions/DNSProxy", + "description": "Enable DNS proxy, disabled by default" + }, + "enabledDnsType": { + "$ref": "#/definitions/EnabledDNSType", + "description": "Enabled DNS proxy type, disabled by default" + }, + "dnsServers": { + "type": "array", + "items": { + "$ref": "#/definitions/IPAddress" + }, + "x-ms-identifiers": [], + "x-cadl-name": "IPAddress[]", + "description": "List of IPs associated with the Firewall" + } + }, + "description": "DNS Proxy settings for Firewall" + }, + "DecryptionRuleTypeEnum": { + "type": "string", + "enum": [ + "SSLOutboundInspection", + "SSLInboundInspection", + "None" + ], + "x-ms-enum": { + "name": "DecryptionRuleTypeEnum", + "modelAsString": true + } + }, + "DefaultMode": { + "type": "string", + "description": "Type for Default Mode for rules creation", + "enum": [ + "IPS", + "FIREWALL", + "NONE" + ], + "x-ms-enum": { + "name": "DefaultMode", + "modelAsString": true + } + }, + "DestinationAddr": { + "type": "object", + "properties": { + "cidrs": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "special value 'any'" + }, + "countries": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "list of countries" + }, + "feeds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "list of feeds" + }, + "prefixLists": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "prefix list" + }, + "fqdnLists": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "fqdn list" + } + }, + "description": "destination address" + }, + "EgressNat": { + "type": "string", + "description": "Egress NAT", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "EgressNat", + "modelAsString": true + } + }, + "EnableStatus": { + "type": "string", + "description": "Enable status", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "EnabledDNSType": { + "type": "string", + "description": "Enabled DNS type values", + "enum": [ + "CUSTOM", + "AZURE" + ], + "x-ms-enum": { + "name": "EnabledDNSType", + "modelAsString": true + } + }, + "EndpointConfiguration": { + "type": "object", + "properties": { + "port": { + "type": "string", + "description": "port ID" + }, + "address": { + "$ref": "#/definitions/IPAddress", + "description": "Address Space" + } + }, + "description": "Endpoint Configuration for frontend and backend", + "required": [ + "port", + "address" + ] + }, + "EventHub": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of EventHub" + }, + "subscriptionId": { + "type": "string", + "description": "Subscription Id" + }, + "name": { + "type": "string", + "description": "EventHub name" + }, + "nameSpace": { + "type": "string", + "description": "EventHub namespace" + }, + "policyName": { + "type": "string", + "description": "EventHub policy name" + } + }, + "description": "EventHub configurations" + }, + "FirewallDeploymentProperties": { + "type": "object", + "properties": { + "panEtag": { + "type": "string", + "description": "panEtag info" + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Network settings" + }, + "isPanoramaManaged": { + "$ref": "#/definitions/BooleanEnum", + "description": "Panorama Managed: Default is False. Default will be CloudSec managed" + }, + "isStrataCloudManaged": { + "$ref": "#/definitions/BooleanEnum", + "description": "Strata Cloud Managed: Default is False. Default will be CloudSec managed" + }, + "panoramaConfig": { + "$ref": "#/definitions/PanoramaConfig", + "description": "Panorama Configuration" + }, + "strataCloudManagerConfig": { + "$ref": "#/definitions/StrataCloudManagerConfig", + "description": "Strata Cloud Manager Configuration, only applicable if Strata Cloud Manager is selected." + }, + "associatedRulestack": { + "$ref": "#/definitions/RulestackDetails", + "description": "Associated Rulestack" + }, + "dnsSettings": { + "$ref": "#/definitions/DNSSettings", + "description": "DNS settings for Firewall" + }, + "frontEndSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendSetting" + }, + "x-ms-identifiers": [], + "x-cadl-name": "FrontendSetting[]", + "description": "Frontend settings for Firewall" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Billing plan information." + }, + "marketplaceDetails": { + "$ref": "#/definitions/MarketplaceDetails", + "description": "Marketplace details" + } + }, + "description": "Properties specific to the Firewall resource deployment.", + "required": [ + "networkProfile", + "dnsSettings", + "planData", + "marketplaceDetails" + ] + }, + "FirewallResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FirewallDeploymentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityProperties", + "description": "The managed service identities assigned to this resource." + } + }, + "description": "PaloAltoNetworks Firewall", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "FirewallResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallResource" + }, + "x-cadl-name": "FirewallResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a FirewallResource list operation.", + "required": [ + "value" + ] + }, + "FirewallResourceUpdate": { + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityProperties", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/FirewallResourceUpdateProperties" + } + }, + "description": "The type used for update operations of the FirewallResource." + }, + "FirewallResourceUpdateProperties": { + "type": "object", + "properties": { + "panEtag": { + "type": "string", + "description": "panEtag info" + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Network settings" + }, + "isPanoramaManaged": { + "$ref": "#/definitions/BooleanEnum", + "description": "Panorama Managed: Default is False. Default will be CloudSec managed" + }, + "isStrataCloudManaged": { + "$ref": "#/definitions/BooleanEnum", + "description": "Strata Cloud Managed: Default is False. Default will be CloudSec managed" + }, + "panoramaConfig": { + "$ref": "#/definitions/PanoramaConfig", + "description": "Panorama Configuration" + }, + "strataCloudManagerConfig": { + "$ref": "#/definitions/StrataCloudManagerConfig", + "description": "Strata Cloud Manager Configuration, only applicable if Strata Cloud Manager is selected." + }, + "associatedRulestack": { + "$ref": "#/definitions/RulestackDetails", + "description": "Associated Rulestack" + }, + "dnsSettings": { + "$ref": "#/definitions/DNSSettings", + "description": "DNS settings for Firewall" + }, + "frontEndSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendSetting" + }, + "x-ms-identifiers": [], + "x-cadl-name": "FrontendSetting[]", + "description": "Frontend settings for Firewall" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Billing plan information." + }, + "marketplaceDetails": { + "$ref": "#/definitions/MarketplaceDetails", + "description": "Marketplace details" + } + }, + "description": "The updatable properties of the FirewallResource." + }, + "FirewallStatusProperty": { + "type": "object", + "properties": { + "isPanoramaManaged": { + "$ref": "#/definitions/BooleanEnum", + "description": "Panorama Managed: Default is False. Default will be CloudSec managed", + "readOnly": true + }, + "healthStatus": { + "$ref": "#/definitions/HealthStatus", + "description": "Current status of the Firewall", + "readOnly": true + }, + "healthReason": { + "type": "string", + "description": "Detail description of current health of the Firewall", + "readOnly": true + }, + "panoramaStatus": { + "$ref": "#/definitions/PanoramaStatus", + "description": "Panorama Status", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ReadOnlyProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "isStrataCloudManaged": { + "$ref": "#/definitions/BooleanEnum", + "description": "Strata Cloud Manager", + "readOnly": true + }, + "strataCloudManagerInfo": { + "$ref": "#/definitions/StrataCloudManagerInfo", + "description": "This field is only present if Strata Cloud Manager is managing the policy for this firewall" + } + }, + "description": "Firewall Status" + }, + "FirewallStatusResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FirewallStatusProperty", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "Firewall Status", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "FirewallStatusResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallStatusResource" + }, + "x-cadl-name": "FirewallStatusResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a FirewallStatusResource list operation.", + "required": [ + "value" + ] + }, + "FqdnListGlobalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FqdnObject", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "GlobalRulestack fqdnList", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "FqdnListGlobalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FqdnListGlobalRulestackResource" + }, + "x-cadl-name": "FqdnListGlobalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a FqdnListGlobalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "FqdnListLocalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FqdnObject", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "LocalRulestack fqdnList", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "FqdnListLocalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FqdnListLocalRulestackResource" + }, + "x-cadl-name": "FqdnListLocalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a FqdnListLocalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "FqdnObject": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "fqdn object description" + }, + "fqdnList": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "fqdn list" + }, + "etag": { + "type": "string", + "description": "etag info" + }, + "auditComment": { + "type": "string", + "description": "comment for this object" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "description": "fqdn object", + "required": [ + "fqdnList" + ] + }, + "FrontendSetting": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Settings name" + }, + "protocol": { + "$ref": "#/definitions/ProtocolType", + "description": "Protocol Type" + }, + "frontendConfiguration": { + "$ref": "#/definitions/EndpointConfiguration", + "description": "Frontend configurations" + }, + "backendConfiguration": { + "$ref": "#/definitions/EndpointConfiguration", + "description": "Backend configurations" + } + }, + "description": "Frontend setting for Firewall", + "required": [ + "name", + "protocol", + "frontendConfiguration", + "backendConfiguration" + ] + }, + "GlobalRulestackInfo": { + "type": "object", + "properties": { + "azureId": { + "type": "string", + "description": "rulestack description" + } + }, + "description": "PAN Rulestack Describe Object", + "required": [ + "azureId" + ] + }, + "GlobalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RulestackProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Global Location" + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityProperties", + "description": "The managed service identities assigned to this resource." + } + }, + "description": "PaloAltoNetworks GlobalRulestack", + "required": [ + "properties", + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "GlobalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GlobalRulestackResource" + }, + "x-cadl-name": "GlobalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a GlobalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "GlobalRulestackResourceUpdate": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Global Location" + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityProperties", + "description": "The managed service identities assigned to this resource." + }, + "properties": { + "$ref": "#/definitions/GlobalRulestackResourceUpdateProperties" + } + }, + "description": "The type used for update operations of the GlobalRulestackResource." + }, + "GlobalRulestackResourceUpdateProperties": { + "type": "object", + "properties": { + "panEtag": { + "type": "string", + "description": "PanEtag info" + }, + "panLocation": { + "type": "string", + "description": "Rulestack Location, Required for GlobalRulestacks, Not for LocalRulestacks" + }, + "scope": { + "$ref": "#/definitions/ScopeType", + "description": "Rulestack Type" + }, + "associatedSubscriptions": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "subscription scope of global rulestack" + }, + "description": { + "type": "string", + "description": "rulestack description" + }, + "defaultMode": { + "$ref": "#/definitions/DefaultMode", + "description": "Mode for default rules creation" + }, + "minAppIdVersion": { + "type": "string", + "description": "minimum version" + }, + "securityServices": { + "$ref": "#/definitions/securityServices", + "description": "Security Profile" + } + }, + "description": "The updatable properties of the GlobalRulestackResource." + }, + "HealthStatus": { + "type": "string", + "description": "Status Codes for the Firewall", + "enum": [ + "GREEN", + "YELLOW", + "RED", + "INITIALIZING" + ], + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + } + }, + "IPAddress": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Resource Id" + }, + "address": { + "type": "string", + "description": "Address value" + } + }, + "description": "IP Address" + }, + "IPAddressSpace": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Resource Id" + }, + "addressSpace": { + "type": "string", + "description": "Address Space" + } + }, + "description": "IP Address Space" + }, + "ListAppIdResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "List of AppIds" + }, + "nextLink": { + "type": "string", + "description": "next Link" + } + }, + "required": [ + "value" + ] + }, + "ListFirewallsResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "firewalls list" + }, + "nextLink": { + "type": "string", + "description": "next link" + } + }, + "description": "List firewalls response", + "required": [ + "value" + ] + }, + "LocalRulesResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RuleEntry", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "LocalRulestack rule list", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "LocalRulesResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LocalRulesResource" + }, + "x-cadl-name": "LocalRulesResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a LocalRulesResource list operation.", + "required": [ + "value" + ] + }, + "LocalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RulestackProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityProperties", + "description": "The managed service identities assigned to this resource." + } + }, + "description": "PaloAltoNetworks LocalRulestack", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "LocalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LocalRulestackResource" + }, + "x-cadl-name": "LocalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a LocalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "LocalRulestackResourceUpdate": { + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.ManagedIdentityProperties", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/LocalRulestackResourceUpdateProperties" + } + }, + "description": "The type used for update operations of the LocalRulestackResource." + }, + "LocalRulestackResourceUpdateProperties": { + "type": "object", + "properties": { + "panEtag": { + "type": "string", + "description": "PanEtag info" + }, + "panLocation": { + "type": "string", + "description": "Rulestack Location, Required for GlobalRulestacks, Not for LocalRulestacks" + }, + "scope": { + "$ref": "#/definitions/ScopeType", + "description": "Rulestack Type" + }, + "associatedSubscriptions": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "subscription scope of global rulestack" + }, + "description": { + "type": "string", + "description": "rulestack description" + }, + "defaultMode": { + "$ref": "#/definitions/DefaultMode", + "description": "Mode for default rules creation" + }, + "minAppIdVersion": { + "type": "string", + "description": "minimum version" + }, + "securityServices": { + "$ref": "#/definitions/securityServices", + "description": "Security Profile" + } + }, + "description": "The updatable properties of the LocalRulestackResource." + }, + "LogDestination": { + "type": "object", + "properties": { + "storageConfigurations": { + "$ref": "#/definitions/StorageAccount", + "description": "Storage account configurations" + }, + "eventHubConfigurations": { + "$ref": "#/definitions/EventHub", + "description": "Event Hub configurations" + }, + "monitorConfigurations": { + "$ref": "#/definitions/MonitorLog", + "description": "Monitor Log configurations" + } + }, + "description": "Log Destination" + }, + "LogOption": { + "type": "string", + "description": "Log options possible", + "enum": [ + "SAME_DESTINATION", + "INDIVIDUAL_DESTINATION" + ], + "x-ms-enum": { + "name": "LogOption", + "modelAsString": true + } + }, + "LogSettings": { + "type": "object", + "properties": { + "logType": { + "$ref": "#/definitions/LogType", + "description": "One of possible log type" + }, + "logOption": { + "$ref": "#/definitions/LogOption", + "description": "Log option SAME/INDIVIDUAL" + }, + "applicationInsights": { + "$ref": "#/definitions/ApplicationInsights", + "description": "Application Insight details" + }, + "commonDestination": { + "$ref": "#/definitions/LogDestination", + "description": "Common destination configurations" + }, + "trafficLogDestination": { + "$ref": "#/definitions/LogDestination", + "description": "Traffic destination configurations" + }, + "threatLogDestination": { + "$ref": "#/definitions/LogDestination", + "description": "Threat destination configurations" + }, + "decryptLogDestination": { + "$ref": "#/definitions/LogDestination", + "description": "Decrypt destination configurations" + } + }, + "description": "Log Settings for Firewall" + }, + "LogType": { + "type": "string", + "description": "Possible log types", + "enum": [ + "TRAFFIC", + "THREAT", + "DECRYPTION", + "WILDFIRE", + "DLP", + "AUDIT" + ], + "x-ms-enum": { + "name": "LogType", + "modelAsString": true + } + }, + "MarketplaceDetails": { + "type": "object", + "properties": { + "marketplaceSubscriptionId": { + "type": "string", + "description": "Marketplace Subscription Id", + "readOnly": true + }, + "offerId": { + "type": "string", + "description": "Offer Id" + }, + "publisherId": { + "type": "string", + "description": "Publisher Id" + }, + "marketplaceSubscriptionStatus": { + "$ref": "#/definitions/MarketplaceSubscriptionStatus", + "description": "Marketplace Subscription Status" + } + }, + "description": "MarketplaceDetails of PAN Firewall resource", + "required": [ + "offerId", + "publisherId" + ] + }, + "MarketplaceSubscriptionStatus": { + "type": "string", + "description": "Marketplace Subscription Status", + "enum": [ + "PendingFulfillmentStart", + "Subscribed", + "Suspended", + "Unsubscribed", + "NotStarted", + "FulfillmentRequested" + ], + "x-ms-enum": { + "name": "MarketplaceSubscriptionStatus", + "modelAsString": true + } + }, + "MonitorLog": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of MonitorLog" + }, + "subscriptionId": { + "type": "string", + "description": "Subscription Id" + }, + "workspace": { + "type": "string", + "description": "MonitorLog workspace" + }, + "primaryKey": { + "type": "string", + "description": "Primary Key value for Monitor" + }, + "secondaryKey": { + "type": "string", + "description": "Secondary Key value for Monitor" + } + }, + "description": "MonitorLog configurations" + }, + "NameDescriptionObject": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name value" + }, + "description": { + "type": "string", + "description": "description value" + } + }, + "description": "object type info", + "required": [ + "name" + ] + }, + "NetworkProfile": { + "type": "object", + "properties": { + "vnetConfiguration": { + "$ref": "#/definitions/VnetConfiguration", + "description": "Vnet configurations" + }, + "vwanConfiguration": { + "$ref": "#/definitions/VwanConfiguration", + "description": "Vwan configurations" + }, + "networkType": { + "$ref": "#/definitions/NetworkType", + "description": "vnet or vwan, cannot be updated" + }, + "publicIps": { + "type": "array", + "items": { + "$ref": "#/definitions/IPAddress" + }, + "x-ms-identifiers": [], + "x-cadl-name": "IPAddress[]", + "description": "List of IPs associated with the Firewall" + }, + "enableEgressNat": { + "$ref": "#/definitions/EgressNat", + "description": "Enable egress NAT, enabled by default" + }, + "egressNatIp": { + "type": "array", + "items": { + "$ref": "#/definitions/IPAddress" + }, + "x-ms-identifiers": [], + "x-cadl-name": "IPAddress[]", + "description": "Egress nat IP to use" + }, + "trustedRanges": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Non-RFC 1918 address" + }, + "privateSourceNatRulesDestination": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Array of ipv4 destination address for which source NAT is to be performed" + } + }, + "description": "Network settings for Firewall", + "required": [ + "networkType", + "publicIps", + "enableEgressNat" + ] + }, + "NetworkType": { + "type": "string", + "description": "NetworkType Enum", + "enum": [ + "VNET", + "VWAN" + ], + "x-ms-enum": { + "name": "NetworkType", + "modelAsString": true + } + }, + "PanoramaConfig": { + "type": "object", + "properties": { + "configString": { + "type": "string", + "description": "Base64 encoded string representing Panorama parameters to be used by Firewall to connect to Panorama. This string is generated via azure plugin in Panorama" + }, + "vmAuthKey": { + "type": "string", + "description": "VM auth key for panorama connectivity", + "readOnly": true + }, + "panoramaServer": { + "type": "string", + "description": "Primary Panorama Server IP address value in dotted format for IPv4", + "readOnly": true + }, + "panoramaServer2": { + "type": "string", + "description": "Secondary Panorama Server IP address value in dotted format for IPv4", + "readOnly": true + }, + "dgName": { + "type": "string", + "description": "Panorama Device Group to join", + "readOnly": true + }, + "tplName": { + "type": "string", + "description": "Panorama Template Stack to join - (Once configured we can not edit the value)", + "readOnly": true + }, + "cgName": { + "type": "string", + "description": "Panorama Collector Group to join - (Once configured we can not edit the value)", + "readOnly": true + }, + "hostName": { + "type": "string", + "description": "Resource name(may be unique) for PN admin", + "readOnly": true + } + }, + "description": "Panorama Config", + "required": [ + "configString" + ] + }, + "PanoramaStatus": { + "type": "object", + "properties": { + "panoramaServerStatus": { + "$ref": "#/definitions/ServerStatus", + "description": "Primary Panorama connection status", + "readOnly": true + }, + "panoramaServer2Status": { + "$ref": "#/definitions/ServerStatus", + "description": "Secondary Panorama connection status", + "readOnly": true + } + }, + "description": "Panorama connectivity information" + }, + "PlanData": { + "type": "object", + "properties": { + "usageType": { + "$ref": "#/definitions/UsageType", + "description": "different usage type like PAYG/COMMITTED" + }, + "billingCycle": { + "$ref": "#/definitions/BillingCycle", + "description": "different billing cycles like MONTHLY/WEEKLY" + }, + "planId": { + "type": "string", + "description": "plan id as published by Liftr.PAN", + "maxLength": 50 + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "date when plan was applied", + "readOnly": true + } + }, + "description": "Billing plan information.", + "required": [ + "billingCycle", + "planId" + ] + }, + "PostRulesResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RuleEntry", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "PostRulestack rule list", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PostRulesResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PostRulesResource" + }, + "x-cadl-name": "PostRulesResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a PostRulesResource list operation.", + "required": [ + "value" + ] + }, + "PreRulesResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RuleEntry", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "PreRulestack rule list", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PreRulesResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PreRulesResource" + }, + "x-cadl-name": "PreRulesResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a PreRulesResource list operation.", + "required": [ + "value" + ] + }, + "PredefinedUrlCategoriesResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PredefinedUrlCategory" + }, + "x-ms-identifiers": [], + "x-cadl-name": "PredefinedUrlCategory[]", + "description": "predefined url categories" + }, + "nextLink": { + "type": "string", + "description": "next link" + } + }, + "description": "predefined url categories response", + "required": [ + "value" + ] + }, + "PredefinedUrlCategory": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "description": "Predefined URL category object", + "required": [ + "action", + "name" + ] + }, + "PrefixListGlobalRulestackResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrefixObject", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "GlobalRulestack prefixList", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PrefixListGlobalRulestackResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrefixListGlobalRulestackResource" + }, + "x-cadl-name": "PrefixListGlobalRulestackResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a PrefixListGlobalRulestackResource list operation.", + "required": [ + "value" + ] + }, + "PrefixListResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrefixObject", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "LocalRulestack prefixList", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PrefixListResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrefixListResource" + }, + "x-cadl-name": "PrefixListResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a PrefixListResource list operation.", + "required": [ + "value" + ] + }, + "PrefixObject": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "prefix description" + }, + "prefixList": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "prefix list" + }, + "etag": { + "type": "string", + "description": "etag info" + }, + "auditComment": { + "type": "string", + "description": "comment for this object" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "description": "prefix entry", + "required": [ + "prefixList" + ] + }, + "ProductSerialNumberStatus": { + "type": "object", + "properties": { + "serialNumber": { + "type": "string", + "description": "product Serial associated with given resource" + }, + "status": { + "$ref": "#/definitions/productSerialStatusValues", + "description": "allocation status of the product serial number" + } + }, + "description": "Product serial and status for the service", + "required": [ + "status" + ] + }, + "ProductSerialNumberRequestStatus": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "allocation status of the product serial number" + } + }, + "description": "Create Product Serial Number Request status", + "required": [ + "status" + ] + }, + "ProtocolType": { + "type": "string", + "description": "Protocol Enum", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true + } + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of the firewall resource.", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ReadOnlyProvisioningState": { + "type": "string", + "description": "Provisioning state of the firewall resource.", + "enum": [ + "Succeeded", + "Failed", + "Deleted" + ], + "x-ms-enum": { + "name": "ReadOnlyProvisioningState", + "modelAsString": true + } + }, + "RegistrationStatus": { + "type": "string", + "description": "Registration status", + "enum": [ + "Registered", + "Not Registered" + ], + "x-ms-enum": { + "name": "RegistrationStatus", + "modelAsString": true + } + }, + "RuleCounter": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "priority number" + }, + "ruleStackName": { + "type": "string", + "description": "rule Stack Name" + }, + "ruleListName": { + "type": "string", + "description": "rule list name" + }, + "firewallName": { + "type": "string", + "description": "firewall name" + }, + "ruleName": { + "type": "string", + "description": "rule name" + }, + "hitCount": { + "type": "integer", + "format": "int32", + "description": "hit count" + }, + "appSeen": { + "$ref": "#/definitions/AppSeenData", + "description": "apps seen" + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "timestamp of response" + }, + "requestTimestamp": { + "type": "string", + "format": "date-time", + "description": "timestamp of request" + }, + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "last updated timestamp" + } + }, + "description": "Rule counter", + "required": [ + "priority", + "ruleName" + ] + }, + "RuleCounterReset": { + "type": "object", + "properties": { + "priority": { + "type": "string", + "description": "priority number", + "readOnly": true + }, + "ruleStackName": { + "type": "string", + "description": "rule Stack Name" + }, + "ruleListName": { + "type": "string", + "description": "rule list name" + }, + "firewallName": { + "type": "string", + "description": "firewall name" + }, + "ruleName": { + "type": "string", + "description": "rule name" + } + }, + "description": "Rule counter reset" + }, + "RuleEntry": { + "type": "object", + "properties": { + "etag": { + "type": "string", + "description": "etag info" + }, + "ruleName": { + "type": "string", + "description": "rule name" + }, + "priority": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "description": { + "type": "string", + "description": "rule description" + }, + "ruleState": { + "$ref": "#/definitions/StateEnum", + "description": "state of this rule" + }, + "source": { + "$ref": "#/definitions/SourceAddr", + "description": "source address" + }, + "negateSource": { + "$ref": "#/definitions/BooleanEnum", + "description": "cidr should not be 'any'" + }, + "destination": { + "$ref": "#/definitions/DestinationAddr", + "description": "destination address" + }, + "negateDestination": { + "$ref": "#/definitions/BooleanEnum", + "description": "cidr should not be 'any'" + }, + "applications": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "array of rule applications" + }, + "category": { + "$ref": "#/definitions/Category", + "description": "rule category" + }, + "protocol": { + "type": "string", + "description": "any, application-default, TCP:number, UDP:number", + "default": "application-default" + }, + "protocolPortList": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "prot port list" + }, + "inboundInspectionCertificate": { + "type": "string", + "description": "inbound Inspection Certificate" + }, + "auditComment": { + "type": "string", + "description": "rule comment" + }, + "actionType": { + "$ref": "#/definitions/ActionEnum", + "description": "rule action" + }, + "enableLogging": { + "$ref": "#/definitions/StateEnum", + "description": "enable or disable logging" + }, + "decryptionRuleType": { + "$ref": "#/definitions/DecryptionRuleTypeEnum", + "description": "enable or disable decryption" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/TagInfo" + }, + "x-ms-identifiers": [], + "x-cadl-name": "TagInfo[]", + "description": "tag for rule" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "description": "definition of rule", + "required": [ + "ruleName" + ] + }, + "RulestackDetails": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Resource Id" + }, + "rulestackId": { + "type": "string", + "description": "Associated rulestack Id" + }, + "location": { + "type": "string", + "description": "Rulestack location" + } + }, + "description": "Associated rulestack details" + }, + "RulestackProperties": { + "type": "object", + "properties": { + "panEtag": { + "type": "string", + "description": "PanEtag info" + }, + "panLocation": { + "type": "string", + "description": "Rulestack Location, Required for GlobalRulestacks, Not for LocalRulestacks" + }, + "scope": { + "$ref": "#/definitions/ScopeType", + "description": "Rulestack Type" + }, + "associatedSubscriptions": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "subscription scope of global rulestack" + }, + "description": { + "type": "string", + "description": "rulestack description" + }, + "defaultMode": { + "$ref": "#/definitions/DefaultMode", + "description": "Mode for default rules creation" + }, + "minAppIdVersion": { + "type": "string", + "description": "minimum version" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "securityServices": { + "$ref": "#/definitions/securityServices", + "description": "Security Profile" + } + }, + "description": "PAN Rulestack Describe Object" + }, + "ScopeType": { + "type": "string", + "description": "Rulestack Type", + "enum": [ + "LOCAL", + "GLOBAL" + ], + "x-ms-enum": { + "name": "ScopeType", + "modelAsString": true + } + }, + "SecurityServicesTypeEnum": { + "type": "string", + "enum": [ + "antiSpyware", + "antiVirus", + "ipsVulnerability", + "urlFiltering", + "fileBlocking", + "dnsSubscription" + ], + "x-ms-enum": { + "name": "SecurityServicesTypeEnum", + "modelAsString": true + } + }, + "ServerStatus": { + "type": "string", + "description": "Connectivity Status for Panorama Server", + "enum": [ + "UP", + "DOWN" + ], + "x-ms-enum": { + "name": "ServerStatus", + "modelAsString": true + } + }, + "SourceAddr": { + "type": "object", + "properties": { + "cidrs": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "special value 'any'" + }, + "countries": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "list of countries" + }, + "feeds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "list of feeds" + }, + "prefixLists": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "prefix list" + } + }, + "description": "Address properties" + }, + "StateEnum": { + "type": "string", + "description": "Enabled or Disabled Enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "StateEnum", + "modelAsString": true + } + }, + "StorageAccount": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of storage account" + }, + "subscriptionId": { + "type": "string", + "description": "Subscription Id" + }, + "accountName": { + "type": "string", + "description": "Storage account name" + } + }, + "description": "Storage Account configurations" + }, + "StrataCloudManagerConfig": { + "type": "object", + "properties": { + "cloudManagerName": { + "type": "string", + "description": "Strata Cloud Manager name which is intended to manage the policy for this firewall." + } + }, + "description": "This field is only present if Strata Cloud Manager is managing the policy for this firewall", + "required": [ + "cloudManagerName" + ] + }, + "StrataCloudManagerInfo": { + "type": "object", + "properties": { + "folderName": { + "type": "string", + "description": "Strata Cloud Manager folder in which this firewall has been placed" + }, + "hubUrl": { + "type": "string", + "description": "URL for Strata Cloud Manager" + } + }, + "description": "Strata Cloud Manager Info" + }, + "SupportInfo": { + "type": "object", + "properties": { + "productSku": { + "type": "string", + "description": "product SKU associated with given resource" + }, + "productSerial": { + "type": "string", + "description": "product Serial associated with given resource" + }, + "accountRegistered": { + "$ref": "#/definitions/BooleanEnum", + "description": "account registered in Customer Support Portal" + }, + "accountId": { + "type": "string", + "description": "Support account associated with given resource" + }, + "userDomainSupported": { + "$ref": "#/definitions/BooleanEnum", + "description": "user domain is supported in Customer Support Portal" + }, + "userRegistered": { + "$ref": "#/definitions/BooleanEnum", + "description": "user registered in Customer Support Portal" + }, + "freeTrial": { + "$ref": "#/definitions/BooleanEnum", + "description": "Product usage is in free trial period" + }, + "freeTrialDaysLeft": { + "type": "integer", + "format": "int32", + "description": "Free trial days remaining" + }, + "freeTrialCreditLeft": { + "type": "integer", + "format": "int32", + "description": "Free trial credit remaining" + }, + "helpURL": { + "type": "string", + "description": "URL for paloaltonetworks live community" + }, + "supportURL": { + "type": "string", + "description": "URL for paloaltonetworks Customer Service Portal" + }, + "registerURL": { + "type": "string", + "description": "URL for registering product in paloaltonetworks Customer Service Portal" + } + }, + "description": "Support information for the resource" + }, + "SupportInfoModel": { + "type": "object", + "properties": { + "productSku": { + "type": "string", + "description": "product SKU associated with given resource" + }, + "productSerial": { + "type": "string", + "description": "product Serial associated with given resource" + }, + "accountRegistrationStatus": { + "$ref": "#/definitions/RegistrationStatus", + "description": "account registered in Customer Support Portal" + }, + "accountId": { + "type": "string", + "description": "Support account associated with given resource" + }, + "freeTrial": { + "$ref": "#/definitions/EnableStatus", + "description": "Product usage is in free trial period" + }, + "freeTrialDaysLeft": { + "type": "integer", + "format": "int32", + "description": "Free trial days remaining" + }, + "freeTrialCreditLeft": { + "type": "integer", + "format": "int32", + "description": "Free trial credit remaining" + }, + "helpURL": { + "type": "string", + "description": "URL for paloaltonetworks live community" + }, + "supportURL": { + "type": "string", + "description": "URL for paloaltonetworks Customer Service Portal" + }, + "registerURL": { + "type": "string", + "description": "URL for registering product in paloaltonetworks Customer Service Portal" + }, + "hubUrl": { + "type": "string", + "description": "URL for Strata Cloud Manager" + }, + "credits": { + "type": "integer", + "format": "int32", + "description": "credits purchased, unit per hour" + }, + "monthlyCreditLeft": { + "type": "integer", + "format": "int32", + "description": "monthly credit is computed as credits * days in calendar month" + }, + "startDateForCredits": { + "type": "string", + "description": "date in format yyyy-mm-dd" + }, + "endDateForCredits": { + "type": "string", + "description": "date in format yyyy-mm-dd" + } + }, + "description": "Support information for the service" + }, + "TagInfo": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "tag name" + }, + "value": { + "type": "string", + "description": "tag value" + } + }, + "description": "Tag", + "required": [ + "key", + "value" + ] + }, + "UsageType": { + "type": "string", + "description": "Usage Type", + "enum": [ + "PAYG", + "COMMITTED" + ], + "x-ms-enum": { + "name": "UsageType", + "modelAsString": true + } + }, + "VnetConfiguration": { + "type": "object", + "properties": { + "vnet": { + "$ref": "#/definitions/IPAddressSpace", + "description": "Azure Virtual Network" + }, + "trustSubnet": { + "$ref": "#/definitions/IPAddressSpace", + "description": "Trust Subnet" + }, + "unTrustSubnet": { + "$ref": "#/definitions/IPAddressSpace", + "description": "Untrust Subnet" + }, + "ipOfTrustSubnetForUdr": { + "$ref": "#/definitions/IPAddress", + "description": "IP of trust subnet for UDR" + } + }, + "description": "VnetInfo for Firewall Networking", + "required": [ + "vnet", + "trustSubnet", + "unTrustSubnet" + ] + }, + "VwanConfiguration": { + "type": "object", + "properties": { + "networkVirtualApplianceId": { + "type": "string", + "description": "Network Virtual Appliance resource ID " + }, + "vHub": { + "$ref": "#/definitions/IPAddressSpace", + "description": "vHub Address" + }, + "trustSubnet": { + "$ref": "#/definitions/IPAddressSpace", + "description": "Trust Subnet" + }, + "unTrustSubnet": { + "$ref": "#/definitions/IPAddressSpace", + "description": "Untrust Subnet" + }, + "ipOfTrustSubnetForUdr": { + "$ref": "#/definitions/IPAddress", + "description": "IP of trust subnet for UDR" + } + }, + "description": "VwanInfo for Firewall Networking", + "required": [ + "vHub" + ] + }, + "advSecurityObjectListResponse": { + "type": "object", + "properties": { + "value": { + "$ref": "#/definitions/advSecurityObjectModel", + "description": "response value" + }, + "nextLink": { + "type": "string", + "description": "next link" + } + }, + "description": "advanced security object", + "required": [ + "value" + ] + }, + "advSecurityObjectModel": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "type of object" + }, + "entry": { + "type": "array", + "items": { + "$ref": "#/definitions/NameDescriptionObject" + }, + "x-ms-identifiers": [], + "x-cadl-name": "NameDescriptionObject[]", + "description": "URL entry" + } + }, + "description": "List of custom and predefined url category", + "required": [ + "entry" + ] + }, + "productSerialStatusValues": { + "type": "string", + "description": "allocation status of the product serial number", + "enum": [ + "Allocated", + "InProgress" + ], + "x-ms-enum": { + "name": "productSerialStatusValues", + "modelAsString": false + } + }, + "securityServices": { + "type": "object", + "properties": { + "vulnerabilityProfile": { + "type": "string", + "description": "IPs Vulnerability Profile Data" + }, + "antiSpywareProfile": { + "type": "string", + "description": "Anti spyware Profile data" + }, + "antiVirusProfile": { + "type": "string", + "description": "anti virus profile data" + }, + "urlFilteringProfile": { + "type": "string", + "description": "URL filtering profile data" + }, + "fileBlockingProfile": { + "type": "string", + "description": "File blocking profile data" + }, + "dnsSubscription": { + "type": "string", + "description": "DNS Subscription profile data" + }, + "outboundUnTrustCertificate": { + "type": "string", + "description": "Untrusted Egress Decryption profile data" + }, + "outboundTrustCertificate": { + "type": "string", + "description": "Trusted Egress Decryption profile data" + } + }, + "description": "security services" + }, + "securityServicesResponse": { + "type": "object", + "properties": { + "value": { + "$ref": "#/definitions/securityServicesTypeList", + "description": "response value" + }, + "nextLink": { + "type": "string", + "description": "next link" + } + }, + "description": "Security services list response", + "required": [ + "value" + ] + }, + "securityServicesTypeList": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "security services type" + }, + "entry": { + "type": "array", + "items": { + "$ref": "#/definitions/NameDescriptionObject" + }, + "x-ms-identifiers": [], + "x-cadl-name": "NameDescriptionObject[]", + "description": "list" + } + }, + "description": "Security services type list", + "required": [ + "entry" + ] + } + }, + "parameters": { + "CertificateObjectGlobalRulestackResource.name": { + "name": "name", + "in": "path", + "required": true, + "description": "certificate name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "CertificateObjectLocalRulestackResource.name": { + "name": "name", + "in": "path", + "required": true, + "description": "certificate name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "FirewallResource.firewallName": { + "name": "firewallName", + "in": "path", + "required": true, + "description": "Firewall resource name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "FqdnListGlobalRulestackResource.name": { + "name": "name", + "in": "path", + "required": true, + "description": "fqdn list name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "FqdnListLocalRulestackResource.name": { + "name": "name", + "in": "path", + "required": true, + "description": "fqdn list name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "GlobalRulestackResource.globalRulestackName": { + "name": "globalRulestackName", + "in": "path", + "required": true, + "description": "GlobalRulestack resource name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "LocalRulesResource.priority": { + "name": "priority", + "in": "path", + "required": true, + "description": "Local Rule priority", + "type": "string", + "x-ms-parameter-location": "method" + }, + "LocalRulestackResource.localRulestackName": { + "name": "localRulestackName", + "in": "path", + "required": true, + "description": "LocalRulestack resource name", + "type": "string", + "x-ms-parameter-location": "method" + }, + "PostRulesResource.priority": { + "name": "priority", + "in": "path", + "required": true, + "description": "Post Rule priority", + "type": "string", + "x-ms-parameter-location": "method" + }, + "PreRulesResource.priority": { + "name": "priority", + "in": "path", + "required": true, + "description": "Pre Rule priority", + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrefixListGlobalRulestackResource.name": { + "name": "name", + "in": "path", + "required": true, + "description": "Local Rule priority", + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrefixListResource.name": { + "name": "name", + "in": "path", + "required": true, + "description": "Local Rule priority", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..3819c0cef636 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1", + "resource": { + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..e7047a7a1690 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1", + "resource": { + "properties": { + "certificateSelfSigned": "TRUE" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/certificates/armid1", + "properties": { + "certificateSelfSigned": "TRUE" + } + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/certificates/armid1", + "properties": { + "certificateSelfSigned": "TRUE" + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..4022877c0036 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..4022877c0036 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..59f1a0d51f36 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..5606055ce0b7 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/certificates/armid1", + "properties": { + "certificateSelfSigned": "TRUE" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..bcf55934cef0 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_List_MaximumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "desc", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..cd6cb22142ad --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectGlobalRulestack_List_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/certificates/certificates1", + "properties": { + "certificateSelfSigned": "TRUE" + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..da9c71a125c3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resource": { + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..826f65460e27 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resource": { + "properties": { + "certificateSelfSigned": "TRUE" + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/certificates/armid1", + "properties": { + "certificateSelfSigned": "TRUE" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/certificates/armid1", + "properties": { + "certificateSelfSigned": "TRUE" + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2a7c7ee5293a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..2a7c7ee5293a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..44110c2dbaab --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "description", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..777d53073293 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/certificates/armid1", + "properties": { + "certificateSelfSigned": "TRUE" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json new file mode 100644 index 000000000000..529bd8bba988 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "certificateSelfSigned": "TRUE", + "certificateSignerResourceId": "", + "description": "desc", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json new file mode 100644 index 000000000000..e68253d1918c --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/CertificateObjectLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/certificates/certificates1", + "properties": { + "certificateSelfSigned": "TRUE" + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..d02356edbb33 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_Get_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1/statuses/default", + "name": "default", + "properties": { + "healthReason": "aaaaaaaaaaaa", + "healthStatus": "GREEN", + "isPanoramaManaged": "TRUE", + "panoramaStatus": { + "panoramaServer2Status": "UP", + "panoramaServerStatus": "UP" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..6dda4a73beb3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1/statuses/default", + "properties": {} + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_ListByFirewalls_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_ListByFirewalls_MaximumSet_Gen.json new file mode 100644 index 000000000000..a8f2a264f417 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_ListByFirewalls_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaa", + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1/statuses/default", + "name": "default", + "properties": { + "healthReason": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "healthStatus": "GREEN", + "isPanoramaManaged": "TRUE", + "panoramaStatus": { + "panoramaServer2Status": "UP", + "panoramaServerStatus": "UP" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_ListByFirewalls_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_ListByFirewalls_MinimumSet_Gen.json new file mode 100644 index 000000000000..a86e2e171e57 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FirewallStatus_ListByFirewalls_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1/statuses/default", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..8919fc7cdf43 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,442 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resource": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "lrs1", + "rulestackId": "PANRSID" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "liftr-pan-ame-test", + "publisherId": "isvtestuklegacy" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "configString": "bas64EncodedString" + }, + "planData": { + "billingCycle": "MONTHLY", + "planId": "liftrpantestplan", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "tags": { + "tagName": "value" + } + }, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/firewalls/armid1", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionId": "aa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "cgName": "PanoramaCollectorGroup", + "configString": "bas64EncodedString", + "dgName": "PanoramaDeviceGroup", + "hostName": "hostname", + "panoramaServer": "10.25.1.1", + "panoramaServer2": "10.20.1.1", + "tplName": "PanoramaTemplateStack", + "vmAuthKey": "SSH_AUTH_KEY" + }, + "planData": { + "billingCycle": "WEEKLY", + "effectiveDate": "2022-09-13T00:46:05.283Z", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "firewalls" + } + }, + "201": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaa", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionId": "aa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "cgName": "PanoramaCollectorGroup", + "configString": "bas64EncodedString", + "dgName": "PanoramaDeviceGroup", + "hostName": "hostname", + "panoramaServer": "10.25.1.1", + "panoramaServer2": "10.20.1.1", + "tplName": "PanoramaTemplateStack", + "vmAuthKey": "SSH_AUTH_KEY" + }, + "planData": { + "billingCycle": "WEEKLY", + "effectiveDate": "2022-09-13T00:46:05.283Z", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaa" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..7b39496de23a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resource": { + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "liftr-pan-ame-test", + "publisherId": "isvtestuklegacy" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "MONTHLY", + "planId": "liftrpantestplan" + } + } + }, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1", + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1", + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..aacdd0c6c489 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Delete_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..aacdd0c6c489 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Delete_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f1f03dffa5c4 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Get_MaximumSet_Gen.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaa", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionId": "aa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "cgName": "PanoramaCollectorGroup", + "configString": "bas64EncodedString", + "dgName": "PanoramaDeviceGroup", + "hostName": "hostname", + "panoramaServer": "10.25.1.1", + "panoramaServer2": "10.20.1.1", + "tplName": "PanoramaTemplateStack", + "vmAuthKey": "SSH_AUTH_KEY" + }, + "planData": { + "billingCycle": "WEEKLY", + "effectiveDate": "2022-09-13T00:46:05.283Z", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..0e798c519bfe --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Get_MinimumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall1", + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListByResourceGroup_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..761a37ea6be6 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaa", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionId": "aa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "cgName": "PanoramaCollectorGroup", + "configString": "bas64EncodedString", + "dgName": "PanoramaDeviceGroup", + "hostName": "hostname", + "panoramaServer": "10.25.1.1", + "panoramaServer2": "10.20.1.1", + "tplName": "PanoramaTemplateStack", + "vmAuthKey": "SSH_AUTH_KEY" + }, + "planData": { + "billingCycle": "WEEKLY", + "effectiveDate": "2022-09-13T00:46:05.283Z", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListByResourceGroup_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..cf72ea5c2022 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall", + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListBySubscription_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..355a53389626 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaa", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionId": "aa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "cgName": "PanoramaCollectorGroup", + "configString": "bas64EncodedString", + "dgName": "PanoramaDeviceGroup", + "hostName": "hostname", + "panoramaServer": "10.25.1.1", + "panoramaServer2": "10.20.1.1", + "tplName": "PanoramaTemplateStack", + "vmAuthKey": "SSH_AUTH_KEY" + }, + "planData": { + "billingCycle": "WEEKLY", + "effectiveDate": "2022-09-13T00:46:05.283Z", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListBySubscription_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..9efe3b46594b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/providers/PaloAltoNetworks.Cloudngfw/firewalls/firewall", + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Update_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..e8d72abbdf0a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Update_MaximumSet_Gen.json @@ -0,0 +1,286 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "configString": "bas64EncodedString" + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + } + }, + "tags": { + "tagName": "value" + } + }, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaa", + "properties": { + "associatedRulestack": { + "location": "eastus", + "resourceId": "aaaaaaaaaa", + "rulestackId": "aaaaaaaaaaaaaaaa" + }, + "dnsSettings": { + "dnsServers": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableDnsProxy": "DISABLED", + "enabledDnsType": "CUSTOM" + }, + "frontEndSettings": [ + { + "backendConfiguration": { + "address": { + "address": "20.22.32.136", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp2" + }, + "port": "80" + }, + "frontendConfiguration": { + "address": { + "address": "20.22.91.251", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-frontendSettingIp1" + }, + "port": "80" + }, + "name": "frontendsetting11", + "protocol": "TCP" + } + ], + "isPanoramaManaged": "TRUE", + "marketplaceDetails": { + "marketplaceSubscriptionId": "aa", + "marketplaceSubscriptionStatus": "PendingFulfillmentStart", + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "egressNatIp": [ + { + "address": "20.22.92.111", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-egressNatIp1" + } + ], + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "privateSourceNatRulesDestination": [ + "20.22.92.11" + ], + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ], + "trustedRanges": [ + "20.22.92.11" + ], + "vnetConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vnet": { + "addressSpace": "10.1.0.0/16", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet" + } + }, + "vwanConfiguration": { + "ipOfTrustSubnetForUdr": { + "address": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "networkVirtualApplianceId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "trustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-trust-subnet" + }, + "unTrustSubnet": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + }, + "vHub": { + "addressSpace": "10.1.1.0/24", + "resourceId": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/os-liftr-integration/providers/Microsoft.Network/virtualNetworks/os-liftr-integration-vnet/subnets/os-liftr-integration-untrust-subnet" + } + } + }, + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panoramaConfig": { + "cgName": "PanoramaCollectorGroup", + "configString": "bas64EncodedString", + "dgName": "PanoramaDeviceGroup", + "hostName": "hostname", + "panoramaServer": "10.25.1.1", + "panoramaServer2": "10.20.1.1", + "tplName": "PanoramaTemplateStack", + "vmAuthKey": "SSH_AUTH_KEY" + }, + "planData": { + "billingCycle": "WEEKLY", + "effectiveDate": "2022-09-13T00:46:05.283Z", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "usageType": "PAYG" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Update_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..b1c1418b0ad1 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_Update_MinimumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "properties": {}, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "dnsSettings": {}, + "marketplaceDetails": { + "offerId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherId": "aaaa" + }, + "networkProfile": { + "enableEgressNat": "ENABLED", + "networkType": "VNET", + "publicIps": [ + { + "address": "20.22.92.11", + "resourceId": "/subscriptions/01c7d41f-afaf-464e-8a8b-5c6f9f98cee8/resourceGroups/mj-liftr-integration/providers/Microsoft.Network/publicIPAddresses/mj-liftr-integration-PublicIp1" + } + ] + }, + "planData": { + "billingCycle": "WEEKLY", + "planId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getGlobalRulestack_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getGlobalRulestack_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d071718085b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getGlobalRulestack_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "azureId": "aaaaaaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getGlobalRulestack_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getGlobalRulestack_MinimumSet_Gen.json new file mode 100644 index 000000000000..1d071718085b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getGlobalRulestack_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "azureId": "aaaaaaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getLogProfile_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getLogProfile_MaximumSet_Gen.json new file mode 100644 index 000000000000..47d9012a97e4 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getLogProfile_MaximumSet_Gen.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "applicationInsights": { + "id": "aaaaaaaaaaaaaaaa", + "key": "aaaaaaaaaaaaa" + }, + "commonDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + }, + "decryptLogDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + }, + "logOption": "SAME_DESTINATION", + "logType": "TRAFFIC", + "threatLogDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + }, + "trafficLogDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getLogProfile_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getLogProfile_MinimumSet_Gen.json new file mode 100644 index 000000000000..02ecaca6a210 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getLogProfile_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getSupportInfo_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getSupportInfo_MaximumSet_Gen.json new file mode 100644 index 000000000000..34539032ace2 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getSupportInfo_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "email": "user1@domain.com", + "firewallName": "firewall1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "accountId": "3cg5b439-294d-4c25-b0b2-ef649e0g6d38", + "accountRegistered": "TRUE", + "freeTrial": "TRUE", + "freeTrialCreditLeft": 10, + "freeTrialDaysLeft": 1, + "helpURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "productSerial": "e22715cb-7e4e-4814-ad4f-ccd1417755d7", + "productSku": "62f63e3c-bc5a-4d68-a8a1-fcba9f526c90", + "registerURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "supportURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "userDomainSupported": "TRUE", + "userRegistered": "TRUE" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getSupportInfo_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getSupportInfo_MinimumSet_Gen.json new file mode 100644 index 000000000000..9d78f5b563a2 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_getSupportInfo_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_saveLogProfile_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_saveLogProfile_MaximumSet_Gen.json new file mode 100644 index 000000000000..63e9b2adf424 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_saveLogProfile_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "logSettings": { + "applicationInsights": { + "id": "aaaaaaaaaaaaaaaa", + "key": "aaaaaaaaaaaaa" + }, + "commonDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + }, + "decryptLogDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + }, + "logOption": "SAME_DESTINATION", + "logType": "TRAFFIC", + "threatLogDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + }, + "trafficLogDestination": { + "eventHubConfigurations": { + "id": "aaaaaaaaaa", + "name": "aaaaaaaa", + "nameSpace": "aaaaaaaaaaaaaaaaaaaaa", + "policyName": "aaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaaa" + }, + "monitorConfigurations": { + "id": "aaaaaaaaaaaaaaaaaaa", + "primaryKey": "aaaaaaaaaaaaa", + "secondaryKey": "a", + "subscriptionId": "aaaaaaaaaaaaa", + "workspace": "aaaaaaaaaaa" + }, + "storageConfigurations": { + "accountName": "aaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaa", + "subscriptionId": "aaaaaaaaa" + } + } + }, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_saveLogProfile_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_saveLogProfile_MinimumSet_Gen.json new file mode 100644 index 000000000000..80342c426e5d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Firewalls_saveLogProfile_MinimumSet_Gen.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..5924e5031b6c --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1", + "resource": { + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..82d76a10cc01 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1", + "resource": { + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/fqdnlists/armid1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/fqdnlists/armid1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..4022877c0036 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..4022877c0036 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a24b03e9905e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..b7f88dd777de --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/fqdnlists/armid1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..8de9d288f727 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_List_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaaaaaaaaaaaaaaaaaaaa", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..738222dc96af --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListGlobalRulestack_List_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/fqdnlists/fqdnlists1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..4d3cda90313d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resource": { + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..ceab7f4985f8 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resource": { + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/fqdnlists/armid1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/fqdnlists/armid1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2a7c7ee5293a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..2a7c7ee5293a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..687116624a95 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "string", + "description": "string", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..fd391e058c89 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/fqdnlists/armid1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json new file mode 100644 index 000000000000..691ff0e057cd --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaaaaaaaa", + "name": "aaaaaaaaaaaaaa", + "properties": { + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaaaaaaaaaaaaaaaaaaaa", + "etag": "aaaaaaaaaaaaaaaaaa", + "fqdnList": [ + "string1", + "string2" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json new file mode 100644 index 000000000000..29385c46a711 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/FqdnListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/fqdnlists/fqdnlists1", + "properties": { + "fqdnList": [ + "string1", + "string2" + ] + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..7205d06b5d3c --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "resource": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "global rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "GLOBAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "global rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "GLOBAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "globalRulestacks" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "global rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "GLOBAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "globalRulestacks" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..81bf793caf3b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "resource": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval", + "location": "eastus", + "properties": {} + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval", + "location": "eastus", + "properties": {} + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..e89f42353a82 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..e89f42353a82 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a3fdd688ce60 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "global rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "GLOBAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "globalRulestacks" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..2024f712a39a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval", + "location": "eastus", + "properties": {} + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..f7b897b53d68 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_List_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "associatedSubscriptions": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "defaultMode": "IPS", + "description": "aaaaaaaaaaaaaaaaaaaaa", + "minAppIdVersion": "aaaaaaaaaaaaaaaaaaaaa", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "aaaaaaaaaa", + "antiVirusProfile": "aaaaaaaaaaaaaaaaaaaaaa", + "dnsSubscription": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fileBlockingProfile": "aaaaa", + "outboundTrustCertificate": "aaaaaa", + "outboundUnTrustCertificate": "aaaaaaaa", + "urlFilteringProfile": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vulnerabilityProfile": "aaaaaaaaaa" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..f4024204975f --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_List_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/grs1", + "location": "eastus", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Update_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..1743150241fa --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Update_MaximumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "global rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "scope": "GLOBAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "global rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "GLOBAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "globalRulestacks" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Update_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..c30acc4e200a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_Update_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "properties": {} + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": {} + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_commit_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_commit_MaximumSet_Gen.json new file mode 100644 index 000000000000..a0260c6ea6be --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_commit_MaximumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_commit_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_commit_MinimumSet_Gen.json new file mode 100644 index 000000000000..a0260c6ea6be --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_commit_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_getChangeLog_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_getChangeLog_MaximumSet_Gen.json new file mode 100644 index 000000000000..fd3e6c93d4f9 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_getChangeLog_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "changes": [ + "aaaa" + ], + "lastCommitted": "2022-09-09T05:08:24.229Z", + "lastModified": "2022-09-09T05:08:24.229Z" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_getChangeLog_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_getChangeLog_MinimumSet_Gen.json new file mode 100644 index 000000000000..43204eca7ed1 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_getChangeLog_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "changes": [ + "aaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen.json new file mode 100644 index 000000000000..183fe6772c8d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "skip": "a6a321", + "top": 20, + "type": "globalRulestacks" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": { + "entry": [ + { + "description": "aaaaaaaaaaaa", + "name": "aaaaaaaaaa" + } + ], + "type": "globalRulestacks" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen.json new file mode 100644 index 000000000000..bd1bc08ebc79 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "type": "globalRulestacks" + }, + "responses": { + "200": { + "body": { + "value": { + "entry": [ + { + "name": "aaaaaaaaaa" + } + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAppIds_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAppIds_MaximumSet_Gen.json new file mode 100644 index 000000000000..9b5190d304ce --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAppIds_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "appIdVersion": "8543", + "appPrefix": "pref", + "globalRulestackName": "praval", + "skip": "a6a321", + "top": 20 + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAppIds_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAppIds_MinimumSet_Gen.json new file mode 100644 index 000000000000..ebf519272d58 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listAppIds_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listCountries_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listCountries_MaximumSet_Gen.json new file mode 100644 index 000000000000..28d17357f1f3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listCountries_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "skip": "a6a321", + "top": 20 + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listCountries_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listCountries_MinimumSet_Gen.json new file mode 100644 index 000000000000..30923bb8f949 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listCountries_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listFirewalls_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listFirewalls_MaximumSet_Gen.json new file mode 100644 index 000000000000..6d1de396cca0 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listFirewalls_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listFirewalls_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listFirewalls_MinimumSet_Gen.json new file mode 100644 index 000000000000..3a88e70632e6 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listFirewalls_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen.json new file mode 100644 index 000000000000..6552733f1040 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "skip": "a6a321", + "top": 20 + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "action": "aaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen.json new file mode 100644 index 000000000000..f3ce9343653f --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "action": "aaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listSecurityServices_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listSecurityServices_MaximumSet_Gen.json new file mode 100644 index 000000000000..183fe6772c8d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listSecurityServices_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "skip": "a6a321", + "top": 20, + "type": "globalRulestacks" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": { + "entry": [ + { + "description": "aaaaaaaaaaaa", + "name": "aaaaaaaaaa" + } + ], + "type": "globalRulestacks" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listSecurityServices_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listSecurityServices_MinimumSet_Gen.json new file mode 100644 index 000000000000..bd1bc08ebc79 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_listSecurityServices_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "type": "globalRulestacks" + }, + "responses": { + "200": { + "body": { + "value": { + "entry": [ + { + "name": "aaaaaaaaaa" + } + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_revert_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_revert_MaximumSet_Gen.json new file mode 100644 index 000000000000..08c98885c11e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_revert_MaximumSet_Gen.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_revert_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_revert_MinimumSet_Gen.json new file mode 100644 index 000000000000..08c98885c11e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/GlobalRulestack_revert_MinimumSet_Gen.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..ea043a83803c --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,246 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resource": { + "properties": { + "actionType": "Allow", + "applications": [ + "app1" + ], + "auditComment": "example comment", + "category": { + "feeds": [ + "feed" + ], + "urlCustom": [ + "https://microsoft.com" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "description of local rule", + "destination": { + "cidrs": [ + "1.0.0.1/10" + ], + "countries": [ + "India" + ], + "feeds": [ + "feed" + ], + "fqdnLists": [ + "FQDN1" + ], + "prefixLists": [ + "PL1" + ] + }, + "enableLogging": "DISABLED", + "etag": "c18e6eef-ba3e-49ee-8a85-2b36c863a9d0", + "inboundInspectionCertificate": "cert1", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "protocol": "HTTP", + "protocolPortList": [ + "80" + ], + "provisioningState": "Accepted", + "ruleName": "localRule1", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "1.0.0.1/10" + ], + "countries": [ + "India" + ], + "feeds": [ + "feed" + ], + "prefixLists": [ + "PL1" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + } + }, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaa", + "category": { + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaa" + ], + "urlCustom": [ + "aa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaaaaaaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 13, + "protocol": "aaaaaaaaaaaa", + "protocolPortList": [ + "aaaaaaaaaaaaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "countries": [ + "aaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaa" + } + }, + "201": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaa", + "category": { + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaa" + ], + "urlCustom": [ + "aa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaaaaaaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 13, + "protocol": "aaaaaaaaaaaa", + "protocolPortList": [ + "aaaaaaaaaaaaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "countries": [ + "aaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaa" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..0699b24c0d78 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resource": { + "properties": { + "ruleName": "localRule1" + } + }, + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/grs1/localrules/1", + "properties": { + "ruleName": "aaaaaa" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/grs1/localrules/1", + "properties": { + "ruleName": "aaaaaa" + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2e54454bae61 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..2e54454bae61 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a2388356d293 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Get_MaximumSet_Gen.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaa", + "category": { + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaa" + ], + "urlCustom": [ + "aa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaaaaaaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 13, + "protocol": "aaaaaaaaaaaa", + "protocolPortList": [ + "aaaaaaaaaaaaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "countries": [ + "aaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..6248c257cf36 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/grs1/localrules/1", + "properties": { + "ruleName": "aaaaaa" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_ListByLocalRulestacks_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_ListByLocalRulestacks_MaximumSet_Gen.json new file mode 100644 index 000000000000..d1670e67a7be --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_ListByLocalRulestacks_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaaaaaa", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "a" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_ListByLocalRulestacks_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_ListByLocalRulestacks_MinimumSet_Gen.json new file mode 100644 index 000000000000..63fd427291b7 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_ListByLocalRulestacks_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/lrs1/localrules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_getCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_getCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..16d542f44c44 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_getCounters_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "appSeen": { + "appSeenList": [ + { + "category": "aaaaaaaaaaaaaaaaaaa", + "risk": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "standardPorts": "aaaaaaaaaaaaaaaaaa", + "subCategory": "aaaaaaaaaaaaaaaaa", + "tag": "aaaaaaaaaa", + "technology": "aaaaaaaaaaaaaaaaaaaa", + "title": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "count": 13 + }, + "firewallName": "aaaaaaaaaaaaaaaaaa", + "hitCount": 20, + "lastUpdatedTimestamp": "2022-09-09T05:08:24.229Z", + "priority": "aaaaaaaaaaaaaaaaaaaa", + "requestTimestamp": "2022-09-09T05:08:24.229Z", + "ruleListName": "aaaaaaaaaaaaaaaaaaa", + "ruleName": "aaaa", + "ruleStackName": "aaaaaaaaaaaaaaaaa", + "timestamp": "2022-09-09T05:08:24.229Z" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_getCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_getCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..aa809d732326 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_getCounters_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "priority": "aaaaaaaaaaaaaaaaaaaa", + "ruleName": "aaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_refreshCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_refreshCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..51f1dfdb0d8a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_refreshCounters_MaximumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_refreshCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_refreshCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..5f4ee555c954 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_refreshCounters_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_resetCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_resetCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..ceeba79d4b13 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_resetCounters_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "firewallName": "aaaaaaaaaaaaaaaaaa", + "priority": "aaaaaaa", + "ruleListName": "aaaaa", + "ruleName": "aaaaa", + "ruleStackName": "aa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_resetCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_resetCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..bef53437667e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRules_resetCounters_MinimumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "priority": "1", + "resourceGroupName": "firewall-rg", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..62fa9c9b3452 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resource": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "local rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "tags": { + "tagName": "value" + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/localrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "local rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "localRulestacks" + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/localrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "local rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "localRulestacks" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..96fbc7ded076 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resource": { + "location": "eastus", + "properties": {} + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval", + "location": "eastus", + "properties": {} + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval", + "location": "eastus", + "properties": {} + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..019767758adc --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Delete_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..019767758adc --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Delete_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..5834a3e8db81 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Get_MaximumSet_Gen.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/localrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "local rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "localRulestacks" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..7d4d3bd4e2f3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Get_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval", + "location": "eastus", + "properties": {} + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListByResourceGroup_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d903d163605 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "associatedSubscriptions": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "defaultMode": "IPS", + "description": "aaaaaaaaaaaaaaaaaaaaa", + "minAppIdVersion": "aaaaaaaaaaaaaaaaaaaaa", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "aaaaaaaaaa", + "antiVirusProfile": "aaaaaaaaaaaaaaaaaaaaaa", + "dnsSubscription": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fileBlockingProfile": "aaaaa", + "outboundTrustCertificate": "aaaaaa", + "outboundUnTrustCertificate": "aaaaaaaa", + "urlFilteringProfile": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vulnerabilityProfile": "aaaaaaaaaa" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListByResourceGroup_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..dd8bb71994bd --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/lrs1", + "location": "eastus", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListBySubscription_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d72926a0bf5 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": { + "principalId": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "associatedSubscriptions": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "defaultMode": "IPS", + "description": "aaaaaaaaaaaaaaaaaaaaa", + "minAppIdVersion": "aaaaaaaaaaaaaaaaaaaaa", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "aaaaaaaaaa", + "antiVirusProfile": "aaaaaaaaaaaaaaaaaaaaaa", + "dnsSubscription": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fileBlockingProfile": "aaaaa", + "outboundTrustCertificate": "aaaaaa", + "outboundUnTrustCertificate": "aaaaaaaa", + "urlFilteringProfile": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vulnerabilityProfile": "aaaaaaaaaa" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "aaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListBySubscription_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..31f499837638 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/lrs1", + "location": "eastus", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Update_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..20c71dbc7ce4 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Update_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "local rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "tags": { + "tagName": "value" + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourceGroups/firewall-rg/providers/PaloAltoNetworks.Cloudngfw/localrulestacks/armid1", + "identity": { + "principalId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "tenantId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "None", + "userAssignedIdentities": { + "key16": { + "clientId": "aaaa", + "principalId": "aaaaaaaaaaaaaaa" + } + } + }, + "location": "eastus", + "name": "armid1", + "properties": { + "associatedSubscriptions": [ + "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + ], + "defaultMode": "IPS", + "description": "local rulestacks", + "minAppIdVersion": "8.5.3", + "panEtag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c12", + "panLocation": "eastus", + "provisioningState": "Accepted", + "scope": "LOCAL", + "securityServices": { + "antiSpywareProfile": "default", + "antiVirusProfile": "default", + "dnsSubscription": "default", + "fileBlockingProfile": "default", + "outboundTrustCertificate": "default", + "outboundUnTrustCertificate": "default", + "urlFilteringProfile": "default", + "vulnerabilityProfile": "default" + } + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "tags": { + "tagName": "value" + }, + "type": "localRulestacks" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Update_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..729fe3be6f54 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_Update_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "properties": {}, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": {} + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_commit_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_commit_MaximumSet_Gen.json new file mode 100644 index 000000000000..e19aa019a242 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_commit_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_commit_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_commit_MinimumSet_Gen.json new file mode 100644 index 000000000000..e19aa019a242 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_commit_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getChangeLog_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getChangeLog_MaximumSet_Gen.json new file mode 100644 index 000000000000..1ede3eba9dc6 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getChangeLog_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "changes": [ + "aaaa" + ], + "lastCommitted": "2022-09-09T05:08:24.229Z", + "lastModified": "2022-09-09T05:08:24.229Z" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getChangeLog_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getChangeLog_MinimumSet_Gen.json new file mode 100644 index 000000000000..8716f448591d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getChangeLog_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "changes": [ + "aaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getSupportInfo_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getSupportInfo_MaximumSet_Gen.json new file mode 100644 index 000000000000..9ef1ba52aa9f --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getSupportInfo_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "email": "user1@domain.com", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "accountId": "3cg5b439-294d-4c25-b0b2-ef649e0g6d38", + "accountRegistered": "TRUE", + "freeTrial": "TRUE", + "freeTrialCreditLeft": 10, + "freeTrialDaysLeft": 1, + "helpURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "productSerial": "e22715cb-7e4e-4814-ad4f-ccd1417755d7", + "productSku": "62f63e3c-bc5a-4d68-a8a1-fcba9f526c90", + "registerURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "supportURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "userDomainSupported": "TRUE", + "userRegistered": "TRUE" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getSupportInfo_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getSupportInfo_MinimumSet_Gen.json new file mode 100644 index 000000000000..fad7de6d88dc --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_getSupportInfo_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MaximumSet_Gen.json new file mode 100644 index 000000000000..a93d1561100e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "skip": "a6a321", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "top": 20, + "type": "localRulestacks" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": { + "entry": [ + { + "description": "aaaaaaaaaaaa", + "name": "aaaaaaaaaa" + } + ], + "type": "localRulestacks" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MinimumSet_Gen.json new file mode 100644 index 000000000000..40fbd247c788 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAdvancedSecurityObjects_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "localRulestacks" + }, + "responses": { + "200": { + "body": { + "value": { + "entry": [ + { + "name": "aaaaaaaaaa" + } + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAppIds_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAppIds_MaximumSet_Gen.json new file mode 100644 index 000000000000..40eee7fd8530 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAppIds_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "appIdVersion": "8543", + "appPrefix": "pref", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "skip": "a6a321", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "top": 20 + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAppIds_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAppIds_MinimumSet_Gen.json new file mode 100644 index 000000000000..35d07a5c385a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listAppIds_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listCountries_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listCountries_MaximumSet_Gen.json new file mode 100644 index 000000000000..829a786ef316 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listCountries_MaximumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "skip": "a6a321", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "top": 20 + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listCountries_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listCountries_MinimumSet_Gen.json new file mode 100644 index 000000000000..a137c00d08ed --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listCountries_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listFirewalls_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listFirewalls_MaximumSet_Gen.json new file mode 100644 index 000000000000..fb66f42a7d7f --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listFirewalls_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listFirewalls_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listFirewalls_MinimumSet_Gen.json new file mode 100644 index 000000000000..dbbf1c0aa787 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listFirewalls_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MaximumSet_Gen.json new file mode 100644 index 000000000000..7d336b41698b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MaximumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "skip": "a6a321", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "top": 20 + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "action": "aaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MinimumSet_Gen.json new file mode 100644 index 000000000000..e58f7e2571c3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listPredefinedUrlCategories_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "action": "aaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listSecurityServices_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listSecurityServices_MaximumSet_Gen.json new file mode 100644 index 000000000000..a93d1561100e --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listSecurityServices_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "skip": "a6a321", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "top": 20, + "type": "localRulestacks" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": { + "entry": [ + { + "description": "aaaaaaaaaaaa", + "name": "aaaaaaaaaa" + } + ], + "type": "localRulestacks" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listSecurityServices_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listSecurityServices_MinimumSet_Gen.json new file mode 100644 index 000000000000..40fbd247c788 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_listSecurityServices_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "type": "localRulestacks" + }, + "responses": { + "200": { + "body": { + "value": { + "entry": [ + { + "name": "aaaaaaaaaa" + } + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_revert_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_revert_MaximumSet_Gen.json new file mode 100644 index 000000000000..5880f381e913 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_revert_MaximumSet_Gen.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_revert_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_revert_MinimumSet_Gen.json new file mode 100644 index 000000000000..5880f381e913 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/LocalRulestacks_revert_MinimumSet_Gen.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..36f3d9589626 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaaaaaaaaaaaaaaaaaaaaa", + "value": [ + { + "actionType": "Internal", + "display": { + "description": "aaaaaaaa", + "operation": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "provider": "aaaaaaaaaaa", + "resource": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "isDataAction": true, + "name": "aaa", + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Operations_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..cdb1fa1f8ddc --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_createProductSerialNumber_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_createProductSerialNumber_MaximumSet_Gen.json new file mode 100644 index 000000000000..2555cc0fe9e6 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_createProductSerialNumber_MaximumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "api-version": "2024-02-07-preview" + }, + "responses": { + "200": { + "body": { + "status": "Created" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_createProductSerialNumber_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_createProductSerialNumber_MinimumSet_Gen.json new file mode 100644 index 000000000000..2555cc0fe9e6 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_createProductSerialNumber_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "api-version": "2024-02-07-preview" + }, + "responses": { + "200": { + "body": { + "status": "Created" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listCloudManagerTenants_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listCloudManagerTenants_MaximumSet_Gen.json new file mode 100644 index 000000000000..6f13ac21c6f2 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listCloudManagerTenants_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "api-version": "2024-02-07-preview" + }, + "responses": { + "200": { + "body": [ + { + "name": "TenantName", + "tenantId": "1234" + } + ] + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listCloudManagerTenants_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listCloudManagerTenants_MinimumSet_Gen.json new file mode 100644 index 000000000000..3fb8877e5f9b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listCloudManagerTenants_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "api-version": "2024-02-07-preview" + }, + "responses": { + "200": { + "body": [ + { + "name": "TenantName" + } + ] + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listProductSerialNumberStatus_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listProductSerialNumberStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..78fd49d039b3 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listProductSerialNumberStatus_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "api-version": "2024-02-07-preview" + }, + "responses": { + "200": { + "body": { + "serialNumber": "1234567890", + "status": "Allocated" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listProductSerialNumberStatus_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listProductSerialNumberStatus_MinimumSet_Gen.json new file mode 100644 index 000000000000..993f00f95703 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listProductSerialNumberStatus_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "api-version": "2024-02-07-preview" + }, + "responses": { + "200": { + "body": { + "status": "Allocated" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen.json new file mode 100644 index 000000000000..0f129775462d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "accountId": "3cg5b439-294d-4c25-b0b2-ef649e0g6d38", + "accountRegistrationStatus": "Registered", + "credits": 15, + "endDateForCredits": "2023-02-02", + "freeTrial": "Enabled", + "freeTrialCreditLeft": 10, + "freeTrialDaysLeft": 1, + "helpURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "hubUrl": "https://paloaltonetworks.com/hubURL", + "monthlyCreditLeft": 13, + "productSerial": "e22715cb-7e4e-4814-ad4f-ccd1417755d7", + "productSku": "62f63e3c-bc5a-4d68-a8a1-fcba9f526c90", + "registerURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557", + "startDateForCredits": "2023-01-01", + "supportURL": "https://ssopreview.paloaltonetworks.com/home/bookmark/0oa4ao61shG4rd3Ub1d7/2557" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen.json new file mode 100644 index 000000000000..0e4be862c9e1 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..510d60c3eae9 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1", + "resource": { + "properties": { + "actionType": "Allow", + "applications": [ + "app1" + ], + "auditComment": "example comment", + "category": { + "feeds": [ + "feed" + ], + "urlCustom": [ + "https://microsoft.com" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "description of post rule", + "destination": { + "cidrs": [ + "1.0.0.1/10" + ], + "countries": [ + "India" + ], + "feeds": [ + "feed" + ], + "fqdnLists": [ + "FQDN1" + ], + "prefixLists": [ + "PL1" + ] + }, + "enableLogging": "DISABLED", + "etag": "c18e6eef-ba3e-49ee-8a85-2b36c863a9d0", + "inboundInspectionCertificate": "cert1", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "protocol": "HTTP", + "protocolPortList": [ + "80" + ], + "provisioningState": "Accepted", + "ruleName": "postRule1", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "1.0.0.1/10" + ], + "countries": [ + "India" + ], + "feeds": [ + "feed" + ], + "prefixLists": [ + "PL1" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "201": { + "body": { + "id": "aaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..e768494a8e10 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1", + "resource": { + "properties": { + "ruleName": "postRule1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/postrules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/postrules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..e187a3d7a0a1 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..e187a3d7a0a1 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8c26392b2bce --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Get_MaximumSet_Gen.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..f67aaedf86c7 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_Get_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/postrules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..6076665098cf --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_List_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..073145749980 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_List_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/postrules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_getCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_getCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..6e7b79a8891a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_getCounters_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "appSeen": { + "appSeenList": [ + { + "category": "aaaaaaaaaaaaaaaaaaa", + "risk": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "standardPorts": "aaaaaaaaaaaaaaaaaa", + "subCategory": "aaaaaaaaaaaaaaaaa", + "tag": "aaaaaaaaaa", + "technology": "aaaaaaaaaaaaaaaaaaaa", + "title": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "count": 13 + }, + "firewallName": "aaaaaaaaaaaaaaaaaa", + "hitCount": 20, + "lastUpdatedTimestamp": "2022-09-09T05:08:24.229Z", + "priority": "aaaaaaaaaaaaaaaaaaaa", + "requestTimestamp": "2022-09-09T05:08:24.229Z", + "ruleListName": "aaaaaaaaaaaaaaaaaaa", + "ruleName": "aaaa", + "ruleStackName": "aaaaaaaaaaaaaaaaa", + "timestamp": "2022-09-09T05:08:24.229Z" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_getCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_getCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..5517223cf587 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_getCounters_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "priority": "aaaaaaaaaaaaaaaaaaaa", + "ruleName": "aaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_refreshCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_refreshCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..e8df58e2be56 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_refreshCounters_MaximumSet_Gen.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_refreshCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_refreshCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..29fa047fec40 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_refreshCounters_MinimumSet_Gen.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_resetCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_resetCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..e8da6aa4b1af --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_resetCounters_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "firewallName": "aaaaaaaaaaaaaaaaaa", + "priority": "aaaaaaa", + "ruleListName": "aaaaa", + "ruleName": "aaaaa", + "ruleStackName": "aa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_resetCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_resetCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..2e7221039231 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PostRules_resetCounters_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..d88ed49fd575 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1", + "resource": { + "properties": { + "actionType": "Allow", + "applications": [ + "app1" + ], + "auditComment": "example comment", + "category": { + "feeds": [ + "feed" + ], + "urlCustom": [ + "https://microsoft.com" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "description of pre rule", + "destination": { + "cidrs": [ + "1.0.0.1/10" + ], + "countries": [ + "India" + ], + "feeds": [ + "feed" + ], + "fqdnLists": [ + "FQDN1" + ], + "prefixLists": [ + "PL1" + ] + }, + "enableLogging": "DISABLED", + "etag": "c18e6eef-ba3e-49ee-8a85-2b36c863a9d0", + "inboundInspectionCertificate": "cert1", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "protocol": "HTTP", + "protocolPortList": [ + "80" + ], + "provisioningState": "Accepted", + "ruleName": "preRule1", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "1.0.0.1/10" + ], + "countries": [ + "India" + ], + "feeds": [ + "feed" + ], + "prefixLists": [ + "PL1" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "201": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..33433195b8aa --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1", + "resource": { + "properties": { + "ruleName": "preRule1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/prerules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/prerules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..e187a3d7a0a1 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..e187a3d7a0a1 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..d06e40bfddaa --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Get_MaximumSet_Gen.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "id": "aaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..211e99354502 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_Get_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/prerules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..3af2a0885e66 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_List_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1" + }, + "responses": { + "200": { + "body": { + "nextLink": "aaaaaaaaaaaaaaaaaaaa", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "actionType": "Allow", + "applications": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "auditComment": "aaa", + "category": { + "feeds": [ + "aaaaaaaaaaaa" + ], + "urlCustom": [ + "aaaaa" + ] + }, + "decryptionRuleType": "SSLOutboundInspection", + "description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "destination": { + "cidrs": [ + "aaaaaaa" + ], + "countries": [ + "aaaaaaaaaaaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "fqdnLists": [ + "aaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "enableLogging": "DISABLED", + "etag": "aaaaaaaaaaaaaaaaaaaa", + "inboundInspectionCertificate": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "negateDestination": "TRUE", + "negateSource": "TRUE", + "priority": 24, + "protocol": "aaaa", + "protocolPortList": [ + "aaaaaaaaaaaa" + ], + "provisioningState": "Accepted", + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "ruleState": "DISABLED", + "source": { + "cidrs": [ + "aaa" + ], + "countries": [ + "aaaaa" + ], + "feeds": [ + "aaaaaaaaaaaaaaaaaaa" + ], + "prefixLists": [ + "aaaaaaaaaaaaaaaaaaaa" + ] + }, + "tags": [ + { + "key": "keyName", + "value": "value" + } + ] + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..5b86a48ad926 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_List_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/lrs1/prerules/1", + "properties": { + "ruleName": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_getCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_getCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..6e7b79a8891a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_getCounters_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "appSeen": { + "appSeenList": [ + { + "category": "aaaaaaaaaaaaaaaaaaa", + "risk": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "standardPorts": "aaaaaaaaaaaaaaaaaa", + "subCategory": "aaaaaaaaaaaaaaaaa", + "tag": "aaaaaaaaaa", + "technology": "aaaaaaaaaaaaaaaaaaaa", + "title": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "count": 13 + }, + "firewallName": "aaaaaaaaaaaaaaaaaa", + "hitCount": 20, + "lastUpdatedTimestamp": "2022-09-09T05:08:24.229Z", + "priority": "aaaaaaaaaaaaaaaaaaaa", + "requestTimestamp": "2022-09-09T05:08:24.229Z", + "ruleListName": "aaaaaaaaaaaaaaaaaaa", + "ruleName": "aaaa", + "ruleStackName": "aaaaaaaaaaaaaaaaa", + "timestamp": "2022-09-09T05:08:24.229Z" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_getCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_getCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..5517223cf587 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_getCounters_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "priority": "aaaaaaaaaaaaaaaaaaaa", + "ruleName": "aaaa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_refreshCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_refreshCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..e8df58e2be56 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_refreshCounters_MaximumSet_Gen.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_refreshCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_refreshCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..29fa047fec40 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_refreshCounters_MinimumSet_Gen.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_resetCounters_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_resetCounters_MaximumSet_Gen.json new file mode 100644 index 000000000000..e8da6aa4b1af --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_resetCounters_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "firewallName": "firewall1", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": { + "firewallName": "aaaaaaaaaaaaaaaaaa", + "priority": "aaaaaaa", + "ruleListName": "aaaaa", + "ruleName": "aaaaa", + "ruleStackName": "aa" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_resetCounters_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_resetCounters_MinimumSet_Gen.json new file mode 100644 index 000000000000..2e7221039231 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PreRules_resetCounters_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "lrs1", + "priority": "1" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..2b0b9bfba1f8 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1", + "resource": { + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..0a109373d378 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1", + "resource": { + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/prefixlists/armid1", + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/prefixlists/armid1", + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..4022877c0036 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..4022877c0036 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e18d05f0c5bb --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..172633465e25 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval", + "name": "armid1" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/prefixlists/armid1", + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_List_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..39de8b5742ff --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_List_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaaaaaaaaaaaaaaaa", + "etag": "aaaaaaaaaaaaaaaaaaaaaaa", + "prefixList": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_List_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..860f8df9f7f0 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListGlobalRulestack_List_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "globalRulestackName": "praval" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/praval/prefixlists/prefixlists1", + "properties": { + "prefixList": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..f8bd7cc77f2f --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resource": { + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + }, + "201": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..1b8418b72359 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resource": { + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + }, + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/prefixlists/armid1", + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/prefixlists/armid1", + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Delete_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2a7c7ee5293a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Delete_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..2a7c7ee5293a --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Get_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..01b9744f1f56 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Get_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/providers/PaloAltoNetworks.Cloudngfw/globalrulestacks/armid1/certificates/armid1", + "name": "armid1", + "properties": { + "auditComment": "comment", + "description": "string", + "etag": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27", + "prefixList": [ + "1.0.0.0/24" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "certificates" + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Get_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..8e963c9e736b --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_Get_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "name": "armid1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/prefixlists/armid1", + "properties": { + "prefixList": [ + "1.0.0.0/24" + ] + } + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json new file mode 100644 index 000000000000..bfd9f14a735d --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "nextLink": "a5324fa34", + "value": [ + { + "id": "aaa", + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "auditComment": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaaaaaaaaaaaaaaaa", + "etag": "aaaaaaaaaaaaaaaaaaaaaaa", + "prefixList": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-09T05:08:24.229Z", + "createdBy": "praval", + "createdByType": "User", + "lastModifiedAt": "2022-09-09T05:08:24.229Z", + "lastModifiedBy": "praval", + "lastModifiedByType": "User" + }, + "type": "aa" + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json new file mode 100644 index 000000000000..ed950415b080 --- /dev/null +++ b/specification/paloaltonetworks/resource-manager/PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/examples/PrefixListLocalRulestack_ListByLocalRulestacks_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-02-07-preview", + "localRulestackName": "lrs1", + "resourceGroupName": "rgopenapi", + "subscriptionId": "2bf4a339-294d-4c25-b0b2-ef649e9f5c27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2bf4a339-294d-4c25-b0b2-ef649e9f5c27/resourcegroups/rgopenapi/providers/PaloAltoNetworks.Cloudngfw/localRulestacks/praval/prefixlists/prefixlists1", + "properties": { + "prefixList": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + ] + } + } + } +} diff --git a/specification/paloaltonetworks/resource-manager/readme.md b/specification/paloaltonetworks/resource-manager/readme.md index b85b96a0d8dc..dab58953bc1c 100644 --- a/specification/paloaltonetworks/resource-manager/readme.md +++ b/specification/paloaltonetworks/resource-manager/readme.md @@ -24,26 +24,44 @@ For other options on installation see [Installing AutoRest](https://aka.ms/autor These are the global settings for the PaloAltoNetworks.Cloudngfw. -```yaml +``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-09-01 +tag: package-preview-2024-02-07-preview ``` +### Tag: package-2024-02-07-preview + +These settings apply only when `--tag=package-2024-02-07-preview` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-02-07-preview' +input-file: + - PaloAltoNetworks.Cloudngfw/preview/2024-02-07-preview/PaloAltoNetworks.Cloudngfw.json +``` + +### Tag: package-2024-01-19-preview + +These settings apply only when `--tag=package-2024-01-19-preview` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-01' +input-file: + - PaloAltoNetworks.Cloudngfw/preview/2024-01-19-preview/PaloAltoNetworks.Cloudngfw.json +``` ### Tag: package-2023-10-10-preview These settings apply only when `--tag=package-2023-10-10-preview` is specified on the command line. -```yaml $(tag) == 'package-2023-10-10-preview' +``` yaml $(tag) == 'package-2023-10-10-preview' input-file: - PaloAltoNetworks.Cloudngfw/preview/2023-10-10-preview/PaloAltoNetworks.Cloudngfw.json ``` + ### Tag: package-2022-08-29 These settings apply only when `--tag=package-2022-08-29` is specified on the command line. -```yaml $(tag) == 'package-2022-08-29' +``` yaml $(tag) == 'package-2022-08-29' input-file: - PaloAltoNetworks.Cloudngfw/stable/2022-08-29/PaloAltoNetworks.Cloudngfw.json ``` @@ -52,7 +70,7 @@ input-file: These settings apply only when `--tag=package-2022-08-29-preview` is specified on the command line. -```yaml $(tag) == 'package-2022-08-29-preview' +``` yaml $(tag) == 'package-2022-08-29-preview' input-file: - PaloAltoNetworks.Cloudngfw/preview/2022-08-29-preview/PaloAltoNetworks.Cloudngfw.json ``` @@ -61,7 +79,7 @@ input-file: These settings apply only when `--tag=package-2023-09-01-preview` is specified on the command line. -```yaml $(tag) == 'package-2023-09-01-preview' +``` yaml $(tag) == 'package-2023-09-01-preview' input-file: - PaloAltoNetworks.Cloudngfw/preview/2023-09-01-preview/PaloAltoNetworks.Cloudngfw.json ``` @@ -70,12 +88,13 @@ input-file: These settings apply only when `--tag=package-2023-09-01` is specified on the command line. -```yaml $(tag) == 'package-2023-09-01' +``` yaml $(tag) == 'package-2023-09-01' input-file: - PaloAltoNetworks.Cloudngfw/stable/2023-09-01/PaloAltoNetworks.Cloudngfw.json ``` --- + # Code Generation ## Swagger to SDK @@ -83,7 +102,7 @@ input-file: This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself. -```yaml $(swagger-to-sdk) +``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_Get.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_Get.json new file mode 100644 index 000000000000..3f9210fcd2ea --- /dev/null +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_Get.json @@ -0,0 +1,30 @@ +{ + "title": "AccountQuotas_Get", + "operationId": "AccountQuotas_Get", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount", + "quotaName": "ScalableExecution" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount/quotas/ScalableExecution", + "name": "ScalableExecution", + "type": "Microsoft.AzurePlaywrightService/Accounts/Quotas", + "properties": { + "freeTrial": { + "createdAt": "2023-08-31T10:19:36.081Z", + "expiryAt": "2023-08-31T10:19:36.081Z", + "allocatedValue": 0, + "usedValue": 0, + "percentageUsed": 100 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_ListByAccount.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_ListByAccount.json new file mode 100644 index 000000000000..b04ddf4c8a59 --- /dev/null +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/AccountQuotas_ListByAccount.json @@ -0,0 +1,33 @@ +{ + "title": "AccountQuotas_ListByAccount", + "operationId": "AccountQuotas_ListByAccount", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount/quotas/ScalableExecution", + "name": "ScalableExecution", + "type": "Microsoft.AzurePlaywrightService/Accounts/Quotas", + "properties": { + "freeTrial": { + "createdAt": "2023-08-31T10:19:36.081Z", + "expiryAt": "2023-08-31T10:19:36.081Z", + "allocatedValue": 0, + "usedValue": 0, + "percentageUsed": 100 + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CheckNameAvailability.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CheckNameAvailability.json new file mode 100644 index 000000000000..6df5c0d04a90 --- /dev/null +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "title": "Accounts_CheckNameAvailability", + "operationId": "Accounts_CheckNameAvailability", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "name": "dummyName", + "type": "Microsoft.AzurePlaywrightService/Accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "Test message." + } + } + } +} diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_CreateOrUpdate.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CreateOrUpdate.json similarity index 96% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_CreateOrUpdate.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CreateOrUpdate.json index d6a0cc6f066f..8cf5222500f7 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_CreateOrUpdate.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_CreateOrUpdate.json @@ -2,10 +2,10 @@ "title": "Accounts_CreateOrUpdate", "operationId": "Accounts_CreateOrUpdate", "parameters": { - "api-version": "2023-10-01-preview", + "api-version": "2024-02-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "dummyrg", - "name": "myPlaywrightAccount", + "accountName": "myPlaywrightAccount", "resource": { "location": "westus", "tags": { diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_Delete.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Delete.json similarity index 87% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_Delete.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Delete.json index ab0312eaad4d..3696889a7113 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_Delete.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Delete.json @@ -2,10 +2,10 @@ "title": "Accounts_Delete", "operationId": "Accounts_Delete", "parameters": { - "api-version": "2023-10-01-preview", + "api-version": "2024-02-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "dummyrg", - "name": "myPlaywrightAccount" + "accountName": "myPlaywrightAccount" }, "responses": { "202": { diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_Get.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Get.json similarity index 93% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_Get.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Get.json index 393f21fbb9fa..9d4da3abb841 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_Get.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Get.json @@ -2,10 +2,10 @@ "title": "Accounts_Get", "operationId": "Accounts_Get", "parameters": { - "api-version": "2023-10-01-preview", + "api-version": "2024-02-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "dummyrg", - "name": "myPlaywrightAccount" + "accountName": "myPlaywrightAccount" }, "responses": { "200": { diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_ListByResourceGroup.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_ListByResourceGroup.json similarity index 97% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_ListByResourceGroup.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_ListByResourceGroup.json index 09f407425f0c..68e31fede344 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_ListByResourceGroup.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_ListByResourceGroup.json @@ -2,7 +2,7 @@ "title": "Accounts_ListByResourceGroup", "operationId": "Accounts_ListByResourceGroup", "parameters": { - "api-version": "2023-10-01-preview", + "api-version": "2024-02-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "dummyrg" }, diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_ListBySubscription.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_ListBySubscription.json similarity index 96% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_ListBySubscription.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_ListBySubscription.json index 2d851e0c6100..93f998037f7c 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_ListBySubscription.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_ListBySubscription.json @@ -2,7 +2,7 @@ "title": "Accounts_ListBySubscription", "operationId": "Accounts_ListBySubscription", "parameters": { - "api-version": "2023-10-01-preview", + "api-version": "2024-02-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_Update.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Update.json similarity index 94% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_Update.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Update.json index 0cff87eeeb43..ba297638039d 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Accounts_Update.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Accounts_Update.json @@ -2,10 +2,10 @@ "title": "Accounts_Update", "operationId": "Accounts_Update", "parameters": { - "api-version": "2023-10-01-preview", + "api-version": "2024-02-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "dummyrg", - "name": "myPlaywrightAccount", + "accountName": "myPlaywrightAccount", "properties": { "tags": { "Team": "Dev Exp", diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Operations_List.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Operations_List.json similarity index 97% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/Operations_List.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Operations_List.json index 9516db396631..e668f47e311f 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Operations_List.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Operations_List.json @@ -2,7 +2,7 @@ "title": "Operations_List", "operationId": "Operations_List", "parameters": { - "api-version": "2023-10-01-preview" + "api-version": "2024-02-01-preview" }, "responses": { "200": { diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Quotas_Get.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Quotas_Get.json similarity index 72% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/Quotas_Get.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Quotas_Get.json index 266052bb14a8..17492117a25b 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Quotas_Get.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Quotas_Get.json @@ -2,10 +2,10 @@ "title": "Quotas_Get", "operationId": "Quotas_Get", "parameters": { - "api-version": "2023-10-01-preview", + "api-version": "2024-02-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "location": "eastus", - "name": "ScalableExecution" + "quotaName": "ScalableExecution" }, "responses": { "200": { @@ -16,11 +16,6 @@ "properties": { "freeTrial": { "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "createdAt": "2023-08-31T10:19:36.081Z", - "expiryAt": "2023-08-31T10:19:36.081Z", - "allocatedValue": 0, - "usedValue": 0, - "percentageUsed": 100, "state": "Active" }, "provisioningState": "Succeeded" diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Quotas_ListBySubscription.json b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Quotas_ListBySubscription.json similarity index 75% rename from specification/playwrighttesting/PlaywrightTesting.Management/examples/Quotas_ListBySubscription.json rename to specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Quotas_ListBySubscription.json index 90637aa1559c..2e002359dd73 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/examples/Quotas_ListBySubscription.json +++ b/specification/playwrighttesting/PlaywrightTesting.Management/examples/2024-02-01-preview/Quotas_ListBySubscription.json @@ -2,7 +2,7 @@ "title": "Quotas_ListBySubscription", "operationId": "Quotas_ListBySubscription", "parameters": { - "api-version": "2023-10-01-preview", + "api-version": "2024-02-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "location": "eastus" }, @@ -14,11 +14,6 @@ "properties": { "freeTrial": { "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "createdAt": "2023-08-31T10:19:36.081Z", - "expiryAt": "2023-08-31T10:19:36.081Z", - "allocatedValue": 0, - "usedValue": 0, - "percentageUsed": 100, "state": "Active" }, "provisioningState": "Succeeded" diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp b/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp index 3eb3ce51e3cb..46658c4706fe 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp +++ b/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp @@ -7,34 +7,40 @@ import "@azure-tools/typespec-azure-resource-manager"; using TypeSpec.Http; using TypeSpec.Rest; using TypeSpec.Versioning; -using Azure.ResourceManager; using Azure.Core; +using Azure.ResourceManager; @armProviderNamespace("Microsoft.AzurePlaywrightService") @service({ title: "Microsoft AzurePlaywrightService Management API", - version: "2023-10-01-preview", }) -@doc("Microsoft.AzurePlaywrightService Resource Provider management API.") -@useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) -@useDependency(Azure.Core.Versions.v1_0_Preview_2) +@doc("Microsoft.AzurePlaywrightService Resource Provider Management API.") +@versioned(Versions) namespace Microsoft.AzurePlaywrightService; +@doc("Microsoft.AzurePlaywrightService Management API Versions.") +enum Versions { + /** 2024-02-01-preview version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) + `2024-02-01-preview`, +} + interface Operations extends Azure.ResourceManager.Operations {} -@doc("An account resource") +@doc("A Playwright service account resource.") model Account is TrackedResource { - @doc("Name of account") + @doc("Name of account.") @minLength(3) @maxLength(64) @pattern("^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$") - @key("name") + @key("accountName") @path @segment("accounts") name: string; } -@doc("Account properties") +@doc("Account resource properties.") model AccountProperties { @visibility("read") @doc("The Playwright testing dashboard URI for the account resource.") @@ -55,31 +61,40 @@ model AccountProperties { } @doc("The enablement status of a feature.") -enum EnablementStatus { +union EnablementStatus { + string, + @doc("The feature is Enabled.") - Enabled, + Enabled: "Enabled", @doc("The feature is Disabled.") - Disabled, + Disabled: "Disabled", } @doc("The status of the current operation.") -@Azure.Core.lroStatus -enum ProvisioningState { - ...ResourceProvisioningState, +@lroStatus +union ProvisioningState { + string, + ResourceProvisioningState, - @doc("Deletion in progress") - Deleting, + @doc("Creation in progress..") + Creating: "Creating", - @doc("Change accepted for processing") - Accepted, + @doc("Deletion in progress..") + Deleting: "Deleting", + + @doc("Change accepted for processing..") + Accepted: "Accepted", } @armResourceOperations interface Accounts - extends TrackedResourceOperations {} + extends TrackedResourceOperations { + @doc("Adds check global name availability operation, normally used if a resource name must be globally unique.") + checkNameAvailability is checkGlobalNameAvailability; +} -@doc("The location of quota resource") +@doc("The location of subscription quota resource.") @subscriptionResource model Location { @doc("The location of quota in ARM Normalized format like eastus, southeastasia etc.") @@ -90,25 +105,27 @@ model Location { name: string; } -@doc("A quota resource") +@doc("A subscription quota resource.") @parentResource(Location) model Quota is ProxyResource { @doc("The quota name.") - @key("name") + @key("quotaName") @path @segment("quotas") name: QuotaNames; } -@doc("The quota name.") -enum QuotaNames { +@doc("The enum for quota name.") +union QuotaNames { + string, + @doc("The quota details for scalable execution feature. When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations.") - ScalableExecution, + "ScalableExecution", } -@doc("Quota properties") +@doc("The subscription quota resource properties.") model QuotaProperties { - @doc("The free-trial quota.") + @doc("The subscription quota resource free-trial properties.") freeTrial?: FreeTrialProperties; @visibility("read") @@ -116,12 +133,39 @@ model QuotaProperties { provisioningState?: ProvisioningState; } -@doc("The free-trial properties") +@doc("The subscription quota resource free-trial properties.") model FreeTrialProperties { - @doc("The playwright account id.") + @doc("The Playwright service account id.") @visibility("read") accountId: string; + @doc("The free-trial state.") + @visibility("read") + state: FreeTrialState; +} + +@doc("A quota resource for a Playwright service account.") +@parentResource(Account) +model AccountQuota is ProxyResource { + @doc("The Playwright service account quota name.") + @key("quotaName") + @path + @segment("quotas") + name: QuotaNames; +} + +@doc("The Playwright service account quota resource properties.") +model AccountQuotaProperties { + @doc("The Playwright service account quota resource free-trial properties.") + freeTrial?: AccountFreeTrialProperties; + + @visibility("read") + @doc("The status of the last operation.") + provisioningState?: ProvisioningState; +} + +@doc("The Playwright service account quota resource free-trial properties.") +model AccountFreeTrialProperties { @doc("The free-trial createdAt utcDateTime.") @visibility("read") createdAt: utcDateTime; @@ -142,27 +186,40 @@ model FreeTrialProperties { @visibility("read") @minValue(0) @maxValue(100) - percentageUsed: decimal; - - @doc("The free-trial state.") - @visibility("read") - state: FreeTrialState; + percentageUsed: float32; } @doc("The free-trial state.") -enum FreeTrialState { +union FreeTrialState { + string, + @doc("The free-trial is Active.") - Active, + "Active", @doc("The free-trial is Expired.") - Expired, + "Expired", + + @doc("The free-trial is Not Eligible.") + "NotEligible", + + @doc("The free-trial is Not Registered.") + "NotRegistered", } @armResourceOperations interface Quotas { - @doc("Get quota by name.") + @doc("Get subscription quota by name.") get is ArmResourceRead; @doc("List quotas for a given subscription Id.") listBySubscription is ArmListBySubscription; } + +@armResourceOperations +interface AccountQuotas { + @doc("Get quota by name for an account.") + get is ArmResourceRead; + + @doc("List quotas for a given account.") + listByAccount is ArmResourceListByParent; +} diff --git a/specification/playwrighttesting/PlaywrightTesting/main.tsp b/specification/playwrighttesting/PlaywrightTesting/main.tsp index 892de0eb4d47..2fa9a3c2bb27 100644 --- a/specification/playwrighttesting/PlaywrightTesting/main.tsp +++ b/specification/playwrighttesting/PlaywrightTesting/main.tsp @@ -94,30 +94,34 @@ model Account { } @doc("The account state.") -enum AccountState { +union AccountState { + string, + @doc("The account is Active.") - Active, + "Active", @doc("The account is Inactive.") - Inactive, + "Inactive", } @doc("The ARM-based subscription state.") -enum SubscriptionState { +union SubscriptionState { + string, + @doc("The subscription state is Registered.") - Registered, + "Registered", @doc("The subscription state is Warned.") - Warned, + "Warned", @doc("The subscription state is Suspended.") - Suspended, + "Suspended", @doc("The subscription state is Deleted.") - Deleted, + "Deleted", @doc("The subscription state is Unregistered.") - Unregistered, + "Unregistered", } @doc("Model of an access-token linked to an account.") @@ -154,21 +158,25 @@ model AccessToken { } @doc("The access-token state.") -enum AccessTokenState { +union AccessTokenState { + string, + @doc("The access-token is Active.") - Active, + "Active", @doc("The access-token is Expired.") - Expired, + "Expired", } @doc("The enablement status of a feature.") -enum EnablementStatus { +union EnablementStatus { + string, + @doc("The feature is Enabled.") - Enabled, + Enabled: "Enabled", @doc("The feature is Disabled.") - Disabled, + Disabled: "Disabled", } // Operations //////////////////// diff --git a/specification/playwrighttesting/data-plane/Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json b/specification/playwrighttesting/data-plane/Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json index d967a0c68ef4..7389ac6f3622 100644 --- a/specification/playwrighttesting/data-plane/Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json +++ b/specification/playwrighttesting/data-plane/Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json @@ -468,21 +468,81 @@ "readOnly": true }, "regionalAffinity": { - "$ref": "#/definitions/EnablementStatus", + "type": "string", "description": "This property sets the connection region for Playwright client workers to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which the workspace was initially created.", "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + }, "readOnly": true }, "scalableExecution": { - "$ref": "#/definitions/EnablementStatus", + "type": "string", "description": "When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations.", "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + }, "readOnly": true }, "reporting": { - "$ref": "#/definitions/EnablementStatus", + "type": "string", "description": "When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting.", "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + }, "readOnly": true } }, @@ -587,30 +647,6 @@ "format": "uuid", "description": "Universally Unique Identifier" }, - "EnablementStatus": { - "type": "string", - "description": "The enablement status of a feature.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "EnablementStatus", - "modelAsString": true, - "values": [ - { - "name": "Enabled", - "value": "Enabled", - "description": "The feature is Enabled." - }, - { - "name": "Disabled", - "value": "Disabled", - "description": "The feature is Disabled." - } - ] - } - }, "PagedAccessToken": { "type": "object", "description": "Paged collection of AccessToken items", diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2023-10-01-preview/playwrighttesting.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2023-10-01-preview/playwrighttesting.json index 273331e44acf..86749de61cd1 100644 --- a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2023-10-01-preview/playwrighttesting.json +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2023-10-01-preview/playwrighttesting.json @@ -64,7 +64,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -103,7 +103,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccountListResult" } @@ -149,7 +149,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/QuotaListResult" } @@ -216,7 +216,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Quota" } @@ -255,7 +255,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccountListResult" } @@ -307,7 +307,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Account" } @@ -436,7 +436,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Account" } @@ -500,7 +500,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/AccountQuotas_Get.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/AccountQuotas_Get.json new file mode 100644 index 000000000000..3f9210fcd2ea --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/AccountQuotas_Get.json @@ -0,0 +1,30 @@ +{ + "title": "AccountQuotas_Get", + "operationId": "AccountQuotas_Get", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount", + "quotaName": "ScalableExecution" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount/quotas/ScalableExecution", + "name": "ScalableExecution", + "type": "Microsoft.AzurePlaywrightService/Accounts/Quotas", + "properties": { + "freeTrial": { + "createdAt": "2023-08-31T10:19:36.081Z", + "expiryAt": "2023-08-31T10:19:36.081Z", + "allocatedValue": 0, + "usedValue": 0, + "percentageUsed": 100 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/AccountQuotas_ListByAccount.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/AccountQuotas_ListByAccount.json new file mode 100644 index 000000000000..b04ddf4c8a59 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/AccountQuotas_ListByAccount.json @@ -0,0 +1,33 @@ +{ + "title": "AccountQuotas_ListByAccount", + "operationId": "AccountQuotas_ListByAccount", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount/quotas/ScalableExecution", + "name": "ScalableExecution", + "type": "Microsoft.AzurePlaywrightService/Accounts/Quotas", + "properties": { + "freeTrial": { + "createdAt": "2023-08-31T10:19:36.081Z", + "expiryAt": "2023-08-31T10:19:36.081Z", + "allocatedValue": 0, + "usedValue": 0, + "percentageUsed": 100 + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_CheckNameAvailability.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_CheckNameAvailability.json new file mode 100644 index 000000000000..6df5c0d04a90 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "title": "Accounts_CheckNameAvailability", + "operationId": "Accounts_CheckNameAvailability", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "name": "dummyName", + "type": "Microsoft.AzurePlaywrightService/Accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "Test message." + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_CreateOrUpdate.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..8cf5222500f7 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,76 @@ +{ + "title": "Accounts_CreateOrUpdate", + "operationId": "Accounts_CreateOrUpdate", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount", + "resource": { + "location": "westus", + "tags": { + "Team": "Dev Exp" + }, + "properties": { + "regionalAffinity": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "properties": { + "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com", + "provisioningState": "Succeeded", + "regionalAffinity": "Enabled", + "scalableExecution": "Enabled", + "reporting": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", + "name": "myPlaywrightAccount", + "type": "Microsoft.AzurePlaywrightService/accounts", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.PlaywrightTesting/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2023-06-01-preview" + }, + "body": { + "location": "westus", + "properties": { + "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com", + "provisioningState": "Succeeded", + "regionalAffinity": "Enabled", + "scalableExecution": "Enabled", + "reporting": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", + "name": "myPlaywrightAccount", + "type": "Microsoft.AzurePlaywrightService/accounts", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_Delete.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_Delete.json new file mode 100644 index 000000000000..3696889a7113 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "Accounts_Delete", + "operationId": "Accounts_Delete", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.PlaywrightTesting/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_Get.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_Get.json new file mode 100644 index 000000000000..9d4da3abb841 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_Get.json @@ -0,0 +1,38 @@ +{ + "title": "Accounts_Get", + "operationId": "Accounts_Get", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "properties": { + "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com", + "provisioningState": "Succeeded", + "regionalAffinity": "Enabled", + "scalableExecution": "Enabled", + "reporting": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", + "name": "myPlaywrightAccount", + "type": "Microsoft.AzurePlaywrightService/accounts", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_ListByResourceGroup.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_ListByResourceGroup.json new file mode 100644 index 000000000000..68e31fede344 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "title": "Accounts_ListByResourceGroup", + "operationId": "Accounts_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "properties": { + "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com", + "provisioningState": "Succeeded", + "regionalAffinity": "Enabled", + "scalableExecution": "Enabled", + "reporting": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", + "name": "myPlaywrightAccount", + "type": "Microsoft.AzurePlaywrightService/accounts", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + ] + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_ListBySubscription.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_ListBySubscription.json new file mode 100644 index 000000000000..93f998037f7c --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_ListBySubscription.json @@ -0,0 +1,40 @@ +{ + "title": "Accounts_ListBySubscription", + "operationId": "Accounts_ListBySubscription", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "properties": { + "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com", + "provisioningState": "Succeeded", + "regionalAffinity": "Enabled", + "scalableExecution": "Enabled", + "reporting": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", + "name": "myPlaywrightAccount", + "type": "Microsoft.AzurePlaywrightService/accounts", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + ] + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_Update.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_Update.json new file mode 100644 index 000000000000..ba297638039d --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Accounts_Update.json @@ -0,0 +1,47 @@ +{ + "title": "Accounts_Update", + "operationId": "Accounts_Update", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "dummyrg", + "accountName": "myPlaywrightAccount", + "properties": { + "tags": { + "Team": "Dev Exp", + "Division": "LT" + }, + "properties": { + "regionalAffinity": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "properties": { + "dashboardUri": "https://dashboard.00000000-0000-0000-0000-000000000000.domain.com", + "provisioningState": "Succeeded", + "regionalAffinity": "Enabled", + "scalableExecution": "Enabled", + "reporting": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount", + "name": "myPlaywrightAccount", + "type": "Microsoft.AzurePlaywrightService/accounts", + "tags": { + "Team": "Dev Exp" + }, + "systemData": { + "createdBy": "userId1001", + "createdByType": "User", + "createdAt": "2021-09-28T12:32:33Z", + "lastModifiedBy": "userId1001", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-09-28T12:32:33Z" + } + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Operations_List.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..e668f47e311f --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Operations_List.json @@ -0,0 +1,46 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzurePlaywrightService/accounts/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzurePlaywrightService", + "resource": "accounts", + "operation": "Creates or updates the PlaywrightAccounts", + "description": "Set PlaywrightAccounts" + } + }, + { + "name": "Microsoft.AzurePlaywrightService/accounts/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzurePlaywrightService", + "resource": "accounts", + "operation": "Deletes the PlaywrightAccounts", + "description": "Delete PlaywrightAccounts" + } + }, + { + "name": "Microsoft.AzurePlaywrightService/accounts/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzurePlaywrightService", + "resource": "accounts", + "operation": "Reads the PlaywrightAccounts", + "description": "Read PlaywrightAccounts" + } + } + ], + "nextLink": "http://nextlink.contoso.com" + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Quotas_Get.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Quotas_Get.json new file mode 100644 index 000000000000..17492117a25b --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Quotas_Get.json @@ -0,0 +1,26 @@ +{ + "title": "Quotas_Get", + "operationId": "Quotas_Get", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "quotaName": "ScalableExecution" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AzurePlaywrightService/locations/eastus/quotas/ScalableExecution", + "name": "ScalableExecution", + "type": "Microsoft.AzurePlaywrightService/Locations/Quotas", + "properties": { + "freeTrial": { + "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "state": "Active" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Quotas_ListBySubscription.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Quotas_ListBySubscription.json new file mode 100644 index 000000000000..2e002359dd73 --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/examples/Quotas_ListBySubscription.json @@ -0,0 +1,29 @@ +{ + "title": "Quotas_ListBySubscription", + "operationId": "Quotas_ListBySubscription", + "parameters": { + "api-version": "2024-02-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "freeTrial": { + "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "state": "Active" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AzurePlaywrightService/locations/eastus/quotas/ScalableExecution", + "name": "ScalableExecution", + "type": "Microsoft.AzurePlaywrightService/Locations/Quotas" + } + ] + } + } + } +} diff --git a/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json new file mode 100644 index 000000000000..f99b5194d0ab --- /dev/null +++ b/specification/playwrighttesting/resource-manager/Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json @@ -0,0 +1,1189 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft AzurePlaywrightService Management API", + "version": "2024-02-01-preview", + "description": "Microsoft.AzurePlaywrightService Resource Provider Management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Accounts" + }, + { + "name": "Quotas" + }, + { + "name": "AccountQuotas" + } + ], + "paths": { + "/providers/Microsoft.AzurePlaywrightService/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzurePlaywrightService/accounts": { + "get": { + "operationId": "Accounts_ListBySubscription", + "tags": [ + "Accounts" + ], + "description": "List Account resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_ListBySubscription": { + "$ref": "./examples/Accounts_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzurePlaywrightService/checkNameAvailability": { + "post": { + "operationId": "Accounts_CheckNameAvailability", + "tags": [ + "Accounts" + ], + "description": "Adds check global name availability operation, normally used if a resource name must be globally unique.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "body", + "in": "body", + "description": "The CheckAvailability request", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_CheckNameAvailability": { + "$ref": "./examples/Accounts_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzurePlaywrightService/locations/{location}/quotas": { + "get": { + "operationId": "Quotas_ListBySubscription", + "tags": [ + "Quotas" + ], + "description": "List quotas for a given subscription Id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "The location of quota in ARM Normalized format like eastus, southeastasia etc.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Quotas_ListBySubscription": { + "$ref": "./examples/Quotas_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzurePlaywrightService/locations/{location}/quotas/{quotaName}": { + "get": { + "operationId": "Quotas_Get", + "tags": [ + "Quotas" + ], + "description": "Get subscription quota by name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "The location of quota in ARM Normalized format like eastus, southeastasia etc.", + "required": true, + "type": "string" + }, + { + "name": "quotaName", + "in": "path", + "description": "The quota name.", + "required": true, + "type": "string", + "enum": [ + "ScalableExecution" + ], + "x-ms-enum": { + "name": "QuotaNames", + "modelAsString": true, + "values": [ + { + "name": "ScalableExecution", + "value": "ScalableExecution", + "description": "The quota details for scalable execution feature. When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations." + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Quota" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Quotas_Get": { + "$ref": "./examples/Quotas_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts": { + "get": { + "operationId": "Accounts_ListByResourceGroup", + "tags": [ + "Accounts" + ], + "description": "List Account resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_ListByResourceGroup": { + "$ref": "./examples/Accounts_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}": { + "get": { + "operationId": "Accounts_Get", + "tags": [ + "Accounts" + ], + "description": "Get a Account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Name of account.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "./examples/Accounts_Get.json" + } + } + }, + "put": { + "operationId": "Accounts_CreateOrUpdate", + "tags": [ + "Accounts" + ], + "description": "Create a Account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Name of account.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Account' update operation succeeded", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "Resource 'Account' create operation succeeded", + "schema": { + "$ref": "#/definitions/Account" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_CreateOrUpdate": { + "$ref": "./examples/Accounts_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Accounts_Update", + "tags": [ + "Accounts" + ], + "description": "Update a Account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Name of account.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AccountUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "./examples/Accounts_Update.json" + } + } + }, + "delete": { + "operationId": "Accounts_Delete", + "tags": [ + "Accounts" + ], + "description": "Delete a Account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Name of account.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Delete": { + "$ref": "./examples/Accounts_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}/quotas": { + "get": { + "operationId": "AccountQuotas_ListByAccount", + "tags": [ + "AccountQuotas" + ], + "description": "List quotas for a given account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Name of account.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountQuotaListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccountQuotas_ListByAccount": { + "$ref": "./examples/AccountQuotas_ListByAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}/quotas/{quotaName}": { + "get": { + "operationId": "AccountQuotas_Get", + "tags": [ + "AccountQuotas" + ], + "description": "Get quota by name for an account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "Name of account.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$" + }, + { + "name": "quotaName", + "in": "path", + "description": "The Playwright service account quota name.", + "required": true, + "type": "string", + "enum": [ + "ScalableExecution" + ], + "x-ms-enum": { + "name": "QuotaNames", + "modelAsString": true, + "values": [ + { + "name": "ScalableExecution", + "value": "ScalableExecution", + "description": "The quota details for scalable execution feature. When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations." + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountQuota" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccountQuotas_Get": { + "$ref": "./examples/AccountQuotas_Get.json" + } + } + } + } + }, + "definitions": { + "Account": { + "type": "object", + "description": "A Playwright service account resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AccountFreeTrialProperties": { + "type": "object", + "description": "The Playwright service account quota resource free-trial properties.", + "properties": { + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The free-trial createdAt utcDateTime.", + "readOnly": true + }, + "expiryAt": { + "type": "string", + "format": "date-time", + "description": "The free-trial expiryAt utcDateTime.", + "readOnly": true + }, + "allocatedValue": { + "type": "integer", + "format": "int32", + "description": "The free-trial allocated limit value eg. allocated free minutes.", + "readOnly": true + }, + "usedValue": { + "type": "integer", + "format": "int32", + "description": "The free-trial used value eg. used free minutes.", + "readOnly": true + }, + "percentageUsed": { + "type": "number", + "format": "float", + "description": "The free-trial percentage used.", + "minimum": 0, + "maximum": 100, + "readOnly": true + } + }, + "required": [ + "createdAt", + "expiryAt", + "allocatedValue", + "usedValue", + "percentageUsed" + ] + }, + "AccountListResult": { + "type": "object", + "description": "The response of a Account list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Account items on this page", + "items": { + "$ref": "#/definitions/Account" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AccountProperties": { + "type": "object", + "description": "Account resource properties.", + "properties": { + "dashboardUri": { + "type": "string", + "format": "uri", + "description": "The Playwright testing dashboard URI for the account resource.", + "readOnly": true + }, + "regionalAffinity": { + "type": "string", + "description": "This property sets the connection region for Playwright client workers to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which the workspace was initially created.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + } + }, + "scalableExecution": { + "type": "string", + "description": "When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + } + }, + "reporting": { + "type": "string", + "description": "When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AccountQuota": { + "type": "object", + "description": "A quota resource for a Playwright service account.", + "properties": { + "properties": { + "$ref": "#/definitions/AccountQuotaProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AccountQuotaListResult": { + "type": "object", + "description": "The response of a AccountQuota list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AccountQuota items on this page", + "items": { + "$ref": "#/definitions/AccountQuota" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AccountQuotaProperties": { + "type": "object", + "description": "The Playwright service account quota resource properties.", + "properties": { + "freeTrial": { + "$ref": "#/definitions/AccountFreeTrialProperties", + "description": "The Playwright service account quota resource free-trial properties." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AccountUpdate": { + "type": "object", + "description": "The type used for update operations of the Account.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AccountUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AccountUpdateProperties": { + "type": "object", + "description": "The updatable properties of the Account.", + "properties": { + "regionalAffinity": { + "type": "string", + "description": "This property sets the connection region for Playwright client workers to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which the workspace was initially created.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + } + }, + "scalableExecution": { + "type": "string", + "description": "When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + } + }, + "reporting": { + "type": "string", + "description": "When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + } + } + } + }, + "FreeTrialProperties": { + "type": "object", + "description": "The subscription quota resource free-trial properties.", + "properties": { + "accountId": { + "type": "string", + "description": "The Playwright service account id.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/FreeTrialState", + "description": "The free-trial state.", + "readOnly": true + } + }, + "required": [ + "accountId", + "state" + ] + }, + "FreeTrialState": { + "type": "string", + "description": "The free-trial state.", + "enum": [ + "Active", + "Expired", + "NotEligible", + "NotRegistered" + ], + "x-ms-enum": { + "name": "FreeTrialState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "The free-trial is Active." + }, + { + "name": "Expired", + "value": "Expired", + "description": "The free-trial is Expired." + }, + { + "name": "NotEligible", + "value": "NotEligible", + "description": "The free-trial is Not Eligible." + }, + { + "name": "NotRegistered", + "value": "NotRegistered", + "description": "The free-trial is Not Registered." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "Creation in progress.." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion in progress.." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Change accepted for processing.." + } + ] + } + }, + "Quota": { + "type": "object", + "description": "A subscription quota resource.", + "properties": { + "properties": { + "$ref": "#/definitions/QuotaProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "QuotaListResult": { + "type": "object", + "description": "The response of a Quota list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Quota items on this page", + "items": { + "$ref": "#/definitions/Quota" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "QuotaProperties": { + "type": "object", + "description": "The subscription quota resource properties.", + "properties": { + "freeTrial": { + "$ref": "#/definitions/FreeTrialProperties", + "description": "The subscription quota resource free-trial properties." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + } + }, + "parameters": {} +} diff --git a/specification/playwrighttesting/resource-manager/readme.md b/specification/playwrighttesting/resource-manager/readme.md index 0db53daa3b81..626f7865ee64 100644 --- a/specification/playwrighttesting/resource-manager/readme.md +++ b/specification/playwrighttesting/resource-manager/readme.md @@ -29,7 +29,33 @@ title: PlaywrightTestingClient description: Azure Playwright testing management service openapi-type: arm openapi-subtype: rpaas -tag: package-2023-10-01-preview +tag: package-2024-02-01-preview +``` + +### Tag: package-2024-02-01-preview + +These settings apply only when `--tag=package-2024-02-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-02-01-preview' +input-file: + - Microsoft.AzurePlaywrightService/preview/2024-02-01-preview/playwrighttesting.json +suppressions: + - code: ResourceNameRestriction + from: playwrighttesting.json + reason: We have enums defined for quota resource names which doesn't support string pattern validation. + - code: ProvisioningStateMustBeReadOnly + from: playwrighttesting.json + reason: Seems like a tool bug, as the visibility is set to read only in the TypeSpec already. + - code: DeleteResponseCodes + from: playwrighttesting.json + reason: Seems like a tool bug, as default operations with codes are generated from the TrackedResourceOperations in the TypeSpec. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}"].delete +``` + +``` yaml +modelerfour: + flatten-models: false ``` ### Tag: package-2023-10-01-preview diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/common.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/common.tsp new file mode 100644 index 000000000000..daf2d047610f --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/common.tsp @@ -0,0 +1,106 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; + +namespace Azure.ProgrammableConnectivity; + +alias ServiceTraits = NoRepeatableRequests & + NoConditionalRequests & + SupportsClientRequestId & + RequestHeadersTrait & + // Note that ResponseHeadersTrait is overridden in number operations + // If you modify this, you must also modify it in the number operations. + ResponseHeadersTrait; + +// alias Operations = Azure.Core.ResourceOperations; +alias Operations = Azure.Core.ResourceOperations< + ServiceTraits, + Azure.Core.Foundations.ErrorResponse +>; + +@doc("Header to identify APC Gateway resource.") +model ApcGatewayIdHeader { + @doc("The identifier of the APC Gateway resource which should handle this request.") + @header("apc-gateway-id") + apcGatewayId: string; +} + +@doc("Identifier for the network to be queried") +model NetworkIdentifier { + @doc("The type of identifier for the network. one of: 'IPv4', 'IPv6', 'NetworkCode'") + identifierType: string; + + @doc(""" + The network identifier, based on the identifierType: an IPv4 address, and IPv6 address, or a Network Code. + A Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint. + """) + identifier: string; +} + +@doc("The phone number of the device.") +model PhoneNumberModel { + @doc("Phone number in E.164 format (starting with country code), and optionally prefixed with '+'") + @pattern("^\\+?[0-9]{5,15}$") + phoneNumber?: string; +} + +@doc("The network access ID/external ID of the device") +model NetworkAccessIdentifierModel { + @doc("External identifier or network access identifier of the device") + networkAccessIdentifier?: string; +} + +@error +@doc("A custom error response for APC.") +model ApcErrorResponse { + @doc("Error returned by APC") + error: ApcError; + + @header("x-ms-error-code") + @doc("String error code indicating what went wrong.") + errorCode?: string; +} + +@doc("A custom error for APC.") +model ApcError { + ...Azure.Core.Foundations.Error; + + @doc("The consent URL in case of a consent failure") + consentUrl?: url; +} + +@doc("IPv4 address and port of the device") +model Ipv4AddressModel { + @doc("The Ipv4 address") + ipv4Address?: Ipv4Address; +} + +@doc("IPv4 address and port of the device") +model Ipv6AddressModel { + @doc("The Ipv6 address") + ipv6Address?: Ipv6Address; +} + +@doc("IPv4 device indicator") +model Ipv4Address { + @doc("An IPv4 address. This may be specified as an exact address, or as a subnet in CIDR notation.") + ipv4: string; + + @doc("User equipment port.") + port: int32; +} + +@doc("IPv6 device indicator") +model Ipv6Address { + @doc("An IPv6 address. This may be specified as an exact address, or as a subnet in CIDR notation.") + ipv6: string; + + @doc("User equipment port.") + port: int32; +} diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/location.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/location.tsp new file mode 100644 index 000000000000..2fe865cf1574 --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/location.tsp @@ -0,0 +1,77 @@ +import "./common.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; + +namespace Azure.ProgrammableConnectivity; + +/// Interfaces + +interface DeviceLocation { + @doc("Verifies whether a device is within a specified location area, defined as an accuracy (radius) around a point, specified by longitude and latitude.") + verify is Operations.ResourceAction< + DeviceLocationEndpoint, + DeviceLocationVerificationContent, + DeviceLocationVerificationResult + >; +} + +/// Endpoints + +@resource("device-location") +@doc("Static endpoint to access the Device Location API family.") +model DeviceLocationEndpoint { + @key + @doc("Static endpoint") + @visibility("read") + location: "location"; +} + +/// Request models + +@doc("Request to verify Location") +model DeviceLocationVerificationContent { + @doc("Network to query for this device, or device information to enable network routing.") + networkIdentifier: NetworkIdentifier; + + @doc("Latitude of location to be verified") + @minValue(-90) + @maxValue(90) + latitude: float64; + + @doc("Longitude of location to be verified") + @minValue(-180) + @maxValue(180) + longitude: float64; + + @doc("Accuracy expected for location verification in kilometers") + @minValue(2) + @maxValue(100) + accuracy: int32; + + @doc("The device to find the location for. Exactly one of Network Access Code, Phone Number, IPv4 address, or IPv6 address") + device: LocationDevice; +} + +/// Response models + +@doc("Response verifying location") +model DeviceLocationVerificationResult { + @doc("True if the location is in the specified area, False otherwise") + verificationResult: boolean; +} + +/// Common models + +// LocationDevice represents a Device as required by the Location API. The APC team aims +// to drive commonisation of the underlying CAMARA APIs so that all APIs can share a common Device +// model in future. +@doc("Device information needed by operator to provide location information. Include exactly one of these properties to identify your device.") +model LocationDevice { + ...NetworkAccessIdentifierModel; + ...PhoneNumberModel; + ...Ipv4AddressModel; + ...Ipv6AddressModel; +} diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/network.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/network.tsp new file mode 100644 index 000000000000..48faea42e171 --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/network.tsp @@ -0,0 +1,40 @@ +import "./common.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; + +namespace Azure.ProgrammableConnectivity; + +/// Interfaces + +interface DeviceNetwork { + @doc("Retrieves the network a given device is on. Returns network in a networkCode format that can be used for other APIs.") + retrieve is Operations.ResourceAction< + DeviceNetworkRetrievalEndpoint, + NetworkIdentifier, + NetworkRetrievalResult + >; +} + +/// Endpoints + +@resource("device-network") +@doc("Static endpoint to access the Device Network API family.") +model DeviceNetworkRetrievalEndpoint { + @key + @doc("Static endpoint") + @visibility("read") + network: "network"; +} + +/// Common models + +@doc("The network that the device is on.") +model NetworkRetrievalResult { + @pattern("[a-z0-9-]+$") + @doc("The identifier for the network. This can be used as the networkIdentifier for the service APIs.") + networkCode: string; +} diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp new file mode 100644 index 000000000000..beaae5fe49e7 --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp @@ -0,0 +1,100 @@ +import "./common.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; + +namespace Azure.ProgrammableConnectivity; + +/// Interfaces + +@doc(""" + Number operations include Frontend Authentication. + + Users first make a call to the endpoint /Number:verify, which returns a redirect to the device's + Network. This is followed by the device to authenticate directly with the Network. The Network + responds with a token and a redirect. This token can be exchanged with APC for a code. + + Users make a second call to the endpoint /Number:verify including the code. The code is used + to verify the device number. The second response is a 200 containing the result of the query. + + For more information on the steps required to use Number Verificaiton, see the APC documentation. +""") +interface NumberVerification { + #suppress "@azure-tools/typespec-azure-core/no-response-body" "302 redirect has no response body" + @doc("Verifies the phone number (MSISDN) associated with a device. As part of the frontend authorization flow, the device is redirected to the operator network to authenticate directly.") + @sharedRoute + @action("verify") + verifyWithoutCode is Operations.ResourceAction< + NumberVerificationEndpoint, + NumberVerificationWithoutCodeContent, + TypeSpec.Http.Response<302> & {}, + TraitOverride> + >; + + @doc("Verifies the phone number (MSISDN) associated with a device.") + @sharedRoute + @action("verify") + verifyWithCode is Operations.ResourceAction< + NumberVerificationEndpoint, + NumberVerificationWithCodeContent, + NumberVerificationResult + >; +} + +/// Endpoints + +@resource("number-verification") +@doc("Static endpoint to access Number Verification API family") +model NumberVerificationEndpoint { + @key + @doc("Static endpoint") + @visibility("read") + number: "number"; +} + +/// Request models + +@doc("Request to verify number of device - first call") +model NumberVerificationWithoutCodeContent { + @doc("Identifier for the network to query for this device.") + networkIdentifier: NetworkIdentifier; + + ...NumberDevice; +} + +@doc("Request to verify number of device - second call") +model NumberVerificationWithCodeContent { + @doc("Identifier for the network to query for this device.") + networkIdentifier: NetworkIdentifier; + + ...NumberDevice; + + @doc("The code provided by APC in exchange for the operator code.") + apcCode: string; +} + +/// Response models + +@doc("Response verifying number of device") +model NumberVerificationResult { + @doc("True if number if the phone number matches the device, False otherwise") + verificationResult: boolean; +} + +/// Common models + +// NumberDevice represents a Device as required by the Number Verification API. The APC team aims +// to drive commonisation of the underlying CAMARA APIs so that all APIs can share a common Device +// model in future. +@doc("Device information to verify phone number. Include exactly one form of phone number.") +model NumberDevice { + ...PhoneNumberModel; + + @doc("Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in **E.164 format (starting with country code)**. Optionally prefixed with '+'.") + hashedPhoneNumber?: string; +} diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/simswap.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/simswap.tsp new file mode 100644 index 000000000000..d004d29d282a --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/simswap.tsp @@ -0,0 +1,85 @@ +import "./common.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; + +namespace Azure.ProgrammableConnectivity; + +/// Interfaces +@doc("SIM Swap API provides the customer the ability to obtain information on any recent SIM pairing change related to the User's mobile account.") +interface SimSwap { + @doc("Provides timestamp of latest SIM swap") + retrieve is Operations.ResourceAction< + SimSwapEndpoint, + SimSwapRetrievalContent, + SimSwapRetrievalResult + >; + + @doc("Verifies if a SIM swap has been performed during a past period (defined in the request with 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured.") + verify is Operations.ResourceAction< + SimSwapEndpoint, + SimSwapVerificationContent, + SimSwapVerificationResult + >; +} + +/// Endpoints + +@resource("sim-swap") +@doc("Static endpoint to access the Sim Swap API family") +model SimSwapEndpoint { + @key + @doc("Static endpoint") + @visibility("read") + simSwap: "sim-swap"; +} + +/// Request models + +@doc("Request to retrieve SimSwap date") +model SimSwapRetrievalContent { + ...SimSwapDevice; + + @doc("Network to query for this device") + networkIdentifier: NetworkIdentifier; +} + +@doc("Request to verify SimSwap in period") +model SimSwapVerificationContent { + ...SimSwapDevice; + + @doc("Maximum lookback for SimSwap verification") + @minValue(1) + @maxValue(2400) + maxAgeHours?: int32 = 240; + + @doc("Identifier for the network to query for this device.") + networkIdentifier: NetworkIdentifier; +} + +/// Response Models + +@doc("Response with SimSwap date") +model SimSwapRetrievalResult { + @doc("Datetime of most recent swap for SIM") + date: utcDateTime; +} + +@doc("Response verifying SimSwap in period") +model SimSwapVerificationResult { + @doc("True if the SIM has swapped in the specified period, False otherwise") + verificationResult: boolean; +} + +/// Common models + +// SimSwapDevice represents a Device as required by the Sim Swap API. The APC team aims +// to drive commonisation of the underlying CAMARA APIs so that all APIs can share a common Device +// model in future. +@doc("Device information needed by operator to find sim swap information.") +model SimSwapDevice { + ...PhoneNumberModel; +} diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/client.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/client.tsp new file mode 100644 index 000000000000..164fc28c837f --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/client.tsp @@ -0,0 +1,5 @@ +/** + * PLACEHOLDER + * Add readme and sample + */ +import "./main.tsp"; diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/DeviceLocation_Verify_MaximumSet_Gen.json b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/DeviceLocation_Verify_MaximumSet_Gen.json new file mode 100644 index 000000000000..5ca27769ff7b --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/DeviceLocation_Verify_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "DeviceLocation_Verify", + "operationId": "DeviceLocation_Verify", + "parameters": { + "api-version": "2024-02-09-preview", + "location": "location", + "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000", + "apc-gateway-id": "zdgrzzaxlodrvewbksn", + "body": { + "networkIdentifier": { + "identifierType": "ipv4", + "identifier": "12.12.12.12" + }, + "latitude": 70, + "longitude": -161, + "accuracy": 91, + "device": { + "networkAccessIdentifier": "122345@domain.com", + "phoneNumber": "+447000000000", + "ipv4Address": { + "ipv4": "12.12.12.12", + "port": 2442 + }, + "ipv6Address": { + "ipv6": "3001:0da8:75a3:0000:0000:8a2e:0370:7334", + "port": 1643 + } + } + } + }, + "responses": { + "200": { + "body": { + "verificationResult": true + } + } + } +} diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/DeviceNetwork_Retrieve_MaximumSet_Gen.json b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/DeviceNetwork_Retrieve_MaximumSet_Gen.json new file mode 100644 index 000000000000..cc6dc26b315c --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/DeviceNetwork_Retrieve_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "DeviceNetwork_Retrieve", + "operationId": "DeviceNetwork_Retrieve", + "parameters": { + "api-version": "2024-02-09-preview", + "network": "network", + "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000", + "apc-gateway-id": "zdgrzzaxlodrvewbksn", + "body": { + "identifierType": "ipv6", + "identifier": "3001:0da8:75a3:0000:0000:8a2e:0370:7334" + } + }, + "responses": { + "200": { + "body": { + "networkCode": "Example_Network" + } + } + } +} diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/NumberVerification_VerifyWithCode_MaximumSet_Gen.json b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/NumberVerification_VerifyWithCode_MaximumSet_Gen.json new file mode 100644 index 000000000000..1ac432985790 --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/NumberVerification_VerifyWithCode_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "NumberVerification_VerifyWithCode", + "operationId": "NumberVerification_VerifyWithCode", + "parameters": { + "api-version": "2024-02-09-preview", + "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000", + "apc-gateway-id": "zdgrzzaxlodrvewbksn", + "body": { + "networkIdentifier": { + "identifierType": "ipv4", + "identifier": "12.12.12.12" + }, + "phoneNumber": "+14424318793", + "hashedPhoneNumber": "bwsl", + "apcCode": "yn" + } + }, + "responses": { + "200": { + "body": { + "verificationResult": true + } + } + } +} diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/NumberVerification_VerifyWithoutCode_MaximumSet_Gen.json b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/NumberVerification_VerifyWithoutCode_MaximumSet_Gen.json new file mode 100644 index 000000000000..9a2f68a4e168 --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/NumberVerification_VerifyWithoutCode_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "NumberVerification_VerifyWithoutCode", + "operationId": "NumberVerification_VerifyWithoutCode", + "parameters": { + "api-version": "2024-02-09-preview", + "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000", + "apc-gateway-id": "zdgrzzaxlodrvewbksn", + "body": { + "networkIdentifier": { + "identifierType": "ipv4", + "identifier": "12.12.12.12" + }, + "phoneNumber": "+14424318793", + "hashedPhoneNumber": "bwsl" + } + }, + "responses": { + "302": {} + } +} diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/SimSwap_Retrieve_MaximumSet_Gen.json b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/SimSwap_Retrieve_MaximumSet_Gen.json new file mode 100644 index 000000000000..5291fdf6279e --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/SimSwap_Retrieve_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "SimSwap_Retrieve", + "operationId": "SimSwap_Retrieve", + "parameters": { + "api-version": "2024-02-09-preview", + "simSwap": "sim-swap", + "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000", + "apc-gateway-id": "zdgrzzaxlodrvewbksn", + "body": { + "phoneNumber": "+61215310263792", + "networkIdentifier": { + "identifierType": "IPv6", + "identifier": "2001:0db8:85a3:0000:0000:8a2e:0370:7334" + } + } + }, + "responses": { + "200": { + "body": { + "date": "2023-12-12T09:01:33.333Z" + } + } + } +} diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/SimSwap_Verify_MaximumSet_Gen.json b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/SimSwap_Verify_MaximumSet_Gen.json new file mode 100644 index 000000000000..85d67550a64e --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/examples/2024-02-09-preview/SimSwap_Verify_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "SimSwap_Verify", + "operationId": "SimSwap_Verify", + "parameters": { + "api-version": "2024-02-09-preview", + "simSwap": "sim-swap", + "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000", + "apc-gateway-id": "zdgrzzaxlodrvewbksn", + "body": { + "maxAgeHours": 941, + "networkIdentifier": { + "identifierType": "ipv4", + "identifier": "12.12.12.12" + } + } + }, + "responses": { + "200": { + "body": { + "verificationResult": true + } + } + } +} diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/main.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/main.tsp new file mode 100644 index 000000000000..5933e0fbdc47 --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/main.tsp @@ -0,0 +1,41 @@ +import "./apis/location.tsp"; +import "./apis/network.tsp"; +import "./apis/number.tsp"; +import "./apis/simswap.tsp"; + +using TypeSpec.Http; +using TypeSpec.Versioning; +using Azure.Core; + +@useAuth( + [ + OAuth2Auth<[ + { + type: OAuth2FlowType.implicit, + authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize", + scopes: ["https://management.azure.com//.default"], + } + ]> + ] +) +@service({ + title: "Programmable Connectivity", +}) +@server( + "{endpoint}", + "Azure Programmable Connectivity Endpoint.", + { + @doc("An Azure Programmable Connectivity Endpoint providing access to Network APIs, for example https://{region}.apcgatewayapi.azure.com") + endpoint: string, + } +) +@versioned(APCVersions) +@doc("Azure Programmable Connectivity (APC) provides a unified interface to the Network APIs of multiple Telecom Operators. Note that Operators may deprecate a Network API with less advance notice than the Azure standard, in which case APC will also deprecate that Network API.") +namespace Azure.ProgrammableConnectivity; + +@doc("APC Versions") +enum APCVersions { + @doc("Version 2024-02-09-preview") + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_02_09_preview: "2024-02-09-preview", +} diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml new file mode 100644 index 000000000000..70877fbdf030 --- /dev/null +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml @@ -0,0 +1,26 @@ +parameters: + "service-dir": + default: "sdk/programmableconnectivity" + "dependencies": + "additionalDirectories": [] + default: "" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" + emitter-output-dir: "{project-root}/.." + examples-directory: "{project-root}/examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" + "@azure-tools/typespec-csharp": + package-dir: "Azure.Communication.ProgrammableConnectivity" + clear-output-folder: true + model-namespace: false + namespace: "{package-dir}" + "@azure-tools/typespec-python": + package-mode: "dataplane" + package-dir: "azure-programmableconnectivity" + package-name: "{package-dir}" +linter: + extends: + - "@azure-tools/typespec-azure-core/all" diff --git a/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/DeviceLocation_Verify_MaximumSet_Gen.json b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/DeviceLocation_Verify_MaximumSet_Gen.json new file mode 100644 index 000000000000..5ca27769ff7b --- /dev/null +++ b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/DeviceLocation_Verify_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "DeviceLocation_Verify", + "operationId": "DeviceLocation_Verify", + "parameters": { + "api-version": "2024-02-09-preview", + "location": "location", + "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000", + "apc-gateway-id": "zdgrzzaxlodrvewbksn", + "body": { + "networkIdentifier": { + "identifierType": "ipv4", + "identifier": "12.12.12.12" + }, + "latitude": 70, + "longitude": -161, + "accuracy": 91, + "device": { + "networkAccessIdentifier": "122345@domain.com", + "phoneNumber": "+447000000000", + "ipv4Address": { + "ipv4": "12.12.12.12", + "port": 2442 + }, + "ipv6Address": { + "ipv6": "3001:0da8:75a3:0000:0000:8a2e:0370:7334", + "port": 1643 + } + } + } + }, + "responses": { + "200": { + "body": { + "verificationResult": true + } + } + } +} diff --git a/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/DeviceNetwork_Retrieve_MaximumSet_Gen.json b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/DeviceNetwork_Retrieve_MaximumSet_Gen.json new file mode 100644 index 000000000000..cc6dc26b315c --- /dev/null +++ b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/DeviceNetwork_Retrieve_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "DeviceNetwork_Retrieve", + "operationId": "DeviceNetwork_Retrieve", + "parameters": { + "api-version": "2024-02-09-preview", + "network": "network", + "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000", + "apc-gateway-id": "zdgrzzaxlodrvewbksn", + "body": { + "identifierType": "ipv6", + "identifier": "3001:0da8:75a3:0000:0000:8a2e:0370:7334" + } + }, + "responses": { + "200": { + "body": { + "networkCode": "Example_Network" + } + } + } +} diff --git a/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/NumberVerification_VerifyWithCode_MaximumSet_Gen.json b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/NumberVerification_VerifyWithCode_MaximumSet_Gen.json new file mode 100644 index 000000000000..1ac432985790 --- /dev/null +++ b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/NumberVerification_VerifyWithCode_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "NumberVerification_VerifyWithCode", + "operationId": "NumberVerification_VerifyWithCode", + "parameters": { + "api-version": "2024-02-09-preview", + "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000", + "apc-gateway-id": "zdgrzzaxlodrvewbksn", + "body": { + "networkIdentifier": { + "identifierType": "ipv4", + "identifier": "12.12.12.12" + }, + "phoneNumber": "+14424318793", + "hashedPhoneNumber": "bwsl", + "apcCode": "yn" + } + }, + "responses": { + "200": { + "body": { + "verificationResult": true + } + } + } +} diff --git a/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/NumberVerification_VerifyWithoutCode_MaximumSet_Gen.json b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/NumberVerification_VerifyWithoutCode_MaximumSet_Gen.json new file mode 100644 index 000000000000..9a2f68a4e168 --- /dev/null +++ b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/NumberVerification_VerifyWithoutCode_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "NumberVerification_VerifyWithoutCode", + "operationId": "NumberVerification_VerifyWithoutCode", + "parameters": { + "api-version": "2024-02-09-preview", + "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000", + "apc-gateway-id": "zdgrzzaxlodrvewbksn", + "body": { + "networkIdentifier": { + "identifierType": "ipv4", + "identifier": "12.12.12.12" + }, + "phoneNumber": "+14424318793", + "hashedPhoneNumber": "bwsl" + } + }, + "responses": { + "302": {} + } +} diff --git a/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/SimSwap_Retrieve_MaximumSet_Gen.json b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/SimSwap_Retrieve_MaximumSet_Gen.json new file mode 100644 index 000000000000..5291fdf6279e --- /dev/null +++ b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/SimSwap_Retrieve_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "SimSwap_Retrieve", + "operationId": "SimSwap_Retrieve", + "parameters": { + "api-version": "2024-02-09-preview", + "simSwap": "sim-swap", + "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000", + "apc-gateway-id": "zdgrzzaxlodrvewbksn", + "body": { + "phoneNumber": "+61215310263792", + "networkIdentifier": { + "identifierType": "IPv6", + "identifier": "2001:0db8:85a3:0000:0000:8a2e:0370:7334" + } + } + }, + "responses": { + "200": { + "body": { + "date": "2023-12-12T09:01:33.333Z" + } + } + } +} diff --git a/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/SimSwap_Verify_MaximumSet_Gen.json b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/SimSwap_Verify_MaximumSet_Gen.json new file mode 100644 index 000000000000..85d67550a64e --- /dev/null +++ b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/examples/SimSwap_Verify_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "title": "SimSwap_Verify", + "operationId": "SimSwap_Verify", + "parameters": { + "api-version": "2024-02-09-preview", + "simSwap": "sim-swap", + "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000", + "apc-gateway-id": "zdgrzzaxlodrvewbksn", + "body": { + "maxAgeHours": 941, + "networkIdentifier": { + "identifierType": "ipv4", + "identifier": "12.12.12.12" + } + } + }, + "responses": { + "200": { + "body": { + "verificationResult": true + } + } + } +} diff --git a/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json new file mode 100644 index 000000000000..ee1a3814550f --- /dev/null +++ b/specification/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json @@ -0,0 +1,1021 @@ +{ + "swagger": "2.0", + "info": { + "title": "Programmable Connectivity", + "version": "2024-02-09-preview", + "description": "Azure Programmable Connectivity (APC) provides a unified interface to the Network APIs of multiple Telecom Operators. Note that Operators may deprecate a Network API with less advance notice than the Azure standard, in which case APC will also deprecate that Network API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "An Azure Programmable Connectivity Endpoint providing access to Network APIs, for example https://{region}.apcgatewayapi.azure.com", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "OAuth2Auth": [ + "https://management.azure.com//.default" + ] + } + ], + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://management.azure.com//.default": "" + } + } + }, + "tags": [], + "paths": { + "/device-location/location:verify": { + "post": { + "operationId": "DeviceLocation_Verify", + "description": "Verifies whether a device is within a specified location area, defined as an accuracy (radius) around a point, specified by longitude and latitude.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "$ref": "#/parameters/ApcGatewayIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceLocationVerificationContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceLocationVerificationResult" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "DeviceLocation_Verify": { + "$ref": "./examples/DeviceLocation_Verify_MaximumSet_Gen.json" + } + } + } + }, + "/device-network/network:retrieve": { + "post": { + "operationId": "DeviceNetwork_Retrieve", + "description": "Retrieves the network a given device is on. Returns network in a networkCode format that can be used for other APIs.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "$ref": "#/parameters/ApcGatewayIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkIdentifier" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkRetrievalResult" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "DeviceNetwork_Retrieve": { + "$ref": "./examples/DeviceNetwork_Retrieve_MaximumSet_Gen.json" + } + } + } + }, + "/number-verification/number:verify": { + "post": { + "operationId": "NumberVerification_VerifyWithoutCode", + "description": "Verifies the phone number (MSISDN) associated with a device. As part of the frontend authorization flow, the device is redirected to the operator network to authenticate directly.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "$ref": "#/parameters/ApcGatewayIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NumberVerificationWithoutCodeContent" + } + } + ], + "responses": { + "302": { + "description": "Redirection", + "headers": { + "location": { + "type": "string" + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + }, + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "NumberVerification_VerifyWithoutCode": { + "$ref": "./examples/NumberVerification_VerifyWithoutCode_MaximumSet_Gen.json" + } + } + } + }, + "/sim-swap/sim-swap:retrieve": { + "post": { + "operationId": "SimSwap_Retrieve", + "description": "Provides timestamp of latest SIM swap", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "$ref": "#/parameters/ApcGatewayIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SimSwapRetrievalContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SimSwapRetrievalResult" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SimSwap_Retrieve": { + "$ref": "./examples/SimSwap_Retrieve_MaximumSet_Gen.json" + } + } + } + }, + "/sim-swap/sim-swap:verify": { + "post": { + "operationId": "SimSwap_Verify", + "description": "Verifies if a SIM swap has been performed during a past period (defined in the request with 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "$ref": "#/parameters/ApcGatewayIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SimSwapVerificationContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SimSwapVerificationResult" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SimSwap_Verify": { + "$ref": "./examples/SimSwap_Verify_MaximumSet_Gen.json" + } + } + } + } + }, + "x-ms-paths": { + "/number-verification/number:verify?_overload=verifyWithCode": { + "post": { + "operationId": "NumberVerification_VerifyWithCode", + "description": "Verifies the phone number (MSISDN) associated with a device.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "$ref": "#/parameters/ApcGatewayIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NumberVerificationWithCodeContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/NumberVerificationResult" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "NumberVerification_VerifyWithCode": { + "$ref": "./examples/NumberVerification_VerifyWithCode_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "APCVersions": { + "type": "string", + "description": "APC Versions", + "enum": [ + "2024-02-09-preview" + ], + "x-ms-enum": { + "name": "APCVersions", + "modelAsString": true, + "values": [ + { + "name": "v2024_02_09_preview", + "value": "2024-02-09-preview", + "description": "Version 2024-02-09-preview" + } + ] + } + }, + "ApcError": { + "type": "object", + "description": "A custom error for APC.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + }, + "consentUrl": { + "type": "string", + "format": "uri", + "description": "The consent URL in case of a consent failure" + } + }, + "required": [ + "code", + "message" + ] + }, + "ApcErrorResponse": { + "type": "object", + "description": "A custom error response for APC.", + "properties": { + "error": { + "$ref": "#/definitions/ApcError", + "description": "Error returned by APC" + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "DeviceLocationEndpoint": { + "type": "object", + "description": "Static endpoint to access the Device Location API family.", + "properties": { + "location": { + "type": "string", + "description": "Static endpoint", + "enum": [ + "location" + ], + "x-ms-enum": { + "modelAsString": false + }, + "readOnly": true + } + }, + "required": [ + "location" + ] + }, + "DeviceLocationVerificationContent": { + "type": "object", + "description": "Request to verify Location", + "properties": { + "networkIdentifier": { + "$ref": "#/definitions/NetworkIdentifier", + "description": "Network to query for this device, or device information to enable network routing." + }, + "latitude": { + "type": "number", + "format": "double", + "description": "Latitude of location to be verified", + "minimum": -90, + "maximum": 90 + }, + "longitude": { + "type": "number", + "format": "double", + "description": "Longitude of location to be verified", + "minimum": -180, + "maximum": 180 + }, + "accuracy": { + "type": "integer", + "format": "int32", + "description": "Accuracy expected for location verification in kilometers", + "minimum": 2, + "maximum": 100 + }, + "device": { + "$ref": "#/definitions/LocationDevice", + "description": "The device to find the location for. Exactly one of Network Access Code, Phone Number, IPv4 address, or IPv6 address" + } + }, + "required": [ + "networkIdentifier", + "latitude", + "longitude", + "accuracy", + "device" + ] + }, + "DeviceLocationVerificationResult": { + "type": "object", + "description": "Response verifying location", + "properties": { + "verificationResult": { + "type": "boolean", + "description": "True if the location is in the specified area, False otherwise" + } + }, + "required": [ + "verificationResult" + ] + }, + "DeviceNetworkRetrievalEndpoint": { + "type": "object", + "description": "Static endpoint to access the Device Network API family.", + "properties": { + "network": { + "type": "string", + "description": "Static endpoint", + "enum": [ + "network" + ], + "x-ms-enum": { + "modelAsString": false + }, + "readOnly": true + } + }, + "required": [ + "network" + ] + }, + "Ipv4Address": { + "type": "object", + "description": "IPv4 device indicator", + "properties": { + "ipv4": { + "type": "string", + "description": "An IPv4 address. This may be specified as an exact address, or as a subnet in CIDR notation." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "User equipment port." + } + }, + "required": [ + "ipv4", + "port" + ] + }, + "Ipv4AddressModel": { + "type": "object", + "description": "IPv4 address and port of the device", + "properties": { + "ipv4Address": { + "$ref": "#/definitions/Ipv4Address", + "description": "The Ipv4 address" + } + } + }, + "Ipv6Address": { + "type": "object", + "description": "IPv6 device indicator", + "properties": { + "ipv6": { + "type": "string", + "description": "An IPv6 address. This may be specified as an exact address, or as a subnet in CIDR notation." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "User equipment port." + } + }, + "required": [ + "ipv6", + "port" + ] + }, + "Ipv6AddressModel": { + "type": "object", + "description": "IPv4 address and port of the device", + "properties": { + "ipv6Address": { + "$ref": "#/definitions/Ipv6Address", + "description": "The Ipv6 address" + } + } + }, + "LocationDevice": { + "type": "object", + "description": "Device information needed by operator to provide location information. Include exactly one of these properties to identify your device.", + "properties": { + "networkAccessIdentifier": { + "type": "string", + "description": "External identifier or network access identifier of the device" + }, + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + }, + "ipv4Address": { + "$ref": "#/definitions/Ipv4Address", + "description": "The Ipv4 address" + }, + "ipv6Address": { + "$ref": "#/definitions/Ipv6Address", + "description": "The Ipv6 address" + } + } + }, + "NetworkAccessIdentifierModel": { + "type": "object", + "description": "The network access ID/external ID of the device", + "properties": { + "networkAccessIdentifier": { + "type": "string", + "description": "External identifier or network access identifier of the device" + } + } + }, + "NetworkIdentifier": { + "type": "object", + "description": "Identifier for the network to be queried", + "properties": { + "identifierType": { + "type": "string", + "description": "The type of identifier for the network. one of: 'IPv4', 'IPv6', 'NetworkCode'" + }, + "identifier": { + "type": "string", + "description": "The network identifier, based on the identifierType: an IPv4 address, and IPv6 address, or a Network Code.\nA Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint." + } + }, + "required": [ + "identifierType", + "identifier" + ] + }, + "NetworkRetrievalResult": { + "type": "object", + "description": "The network that the device is on.", + "properties": { + "networkCode": { + "type": "string", + "description": "The identifier for the network. This can be used as the networkIdentifier for the service APIs.", + "pattern": "[a-z0-9-]+$" + } + }, + "required": [ + "networkCode" + ] + }, + "NumberDevice": { + "type": "object", + "description": "Device information to verify phone number. Include exactly one form of phone number.", + "properties": { + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + }, + "hashedPhoneNumber": { + "type": "string", + "description": "Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in **E.164 format (starting with country code)**. Optionally prefixed with '+'." + } + } + }, + "NumberVerificationEndpoint": { + "type": "object", + "description": "Static endpoint to access Number Verification API family", + "properties": { + "number": { + "type": "string", + "description": "Static endpoint", + "enum": [ + "number" + ], + "x-ms-enum": { + "modelAsString": false + }, + "readOnly": true + } + }, + "required": [ + "number" + ] + }, + "NumberVerificationResult": { + "type": "object", + "description": "Response verifying number of device", + "properties": { + "verificationResult": { + "type": "boolean", + "description": "True if number if the phone number matches the device, False otherwise" + } + }, + "required": [ + "verificationResult" + ] + }, + "NumberVerificationWithCodeContent": { + "type": "object", + "description": "Request to verify number of device - second call", + "properties": { + "networkIdentifier": { + "$ref": "#/definitions/NetworkIdentifier", + "description": "Identifier for the network to query for this device." + }, + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + }, + "hashedPhoneNumber": { + "type": "string", + "description": "Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in **E.164 format (starting with country code)**. Optionally prefixed with '+'." + }, + "apcCode": { + "type": "string", + "description": "The code provided by APC in exchange for the operator code." + } + }, + "required": [ + "networkIdentifier", + "apcCode" + ] + }, + "NumberVerificationWithoutCodeContent": { + "type": "object", + "description": "Request to verify number of device - first call", + "properties": { + "networkIdentifier": { + "$ref": "#/definitions/NetworkIdentifier", + "description": "Identifier for the network to query for this device." + }, + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + }, + "hashedPhoneNumber": { + "type": "string", + "description": "Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in **E.164 format (starting with country code)**. Optionally prefixed with '+'." + } + }, + "required": [ + "networkIdentifier" + ] + }, + "PhoneNumberModel": { + "type": "object", + "description": "The phone number of the device.", + "properties": { + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + } + } + }, + "SimSwapDevice": { + "type": "object", + "description": "Device information needed by operator to find sim swap information.", + "properties": { + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + } + } + }, + "SimSwapEndpoint": { + "type": "object", + "description": "Static endpoint to access the Sim Swap API family", + "properties": { + "simSwap": { + "type": "string", + "description": "Static endpoint", + "enum": [ + "sim-swap" + ], + "x-ms-enum": { + "modelAsString": false + }, + "readOnly": true + } + }, + "required": [ + "simSwap" + ] + }, + "SimSwapRetrievalContent": { + "type": "object", + "description": "Request to retrieve SimSwap date", + "properties": { + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + }, + "networkIdentifier": { + "$ref": "#/definitions/NetworkIdentifier", + "description": "Network to query for this device" + } + }, + "required": [ + "networkIdentifier" + ] + }, + "SimSwapRetrievalResult": { + "type": "object", + "description": "Response with SimSwap date", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Datetime of most recent swap for SIM" + } + }, + "required": [ + "date" + ] + }, + "SimSwapVerificationContent": { + "type": "object", + "description": "Request to verify SimSwap in period", + "properties": { + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + }, + "maxAgeHours": { + "type": "integer", + "format": "int32", + "description": "Maximum lookback for SimSwap verification", + "default": 240, + "minimum": 1, + "maximum": 2400 + }, + "networkIdentifier": { + "$ref": "#/definitions/NetworkIdentifier", + "description": "Identifier for the network to query for this device." + } + }, + "required": [ + "networkIdentifier" + ] + }, + "SimSwapVerificationResult": { + "type": "object", + "description": "Response verifying SimSwap in period", + "properties": { + "verificationResult": { + "type": "boolean", + "description": "True if the SIM has swapped in the specified period, False otherwise" + } + }, + "required": [ + "verificationResult" + ] + } + }, + "parameters": { + "ApcGatewayIdHeader": { + "name": "apc-gateway-id", + "in": "header", + "description": "The identifier of the APC Gateway resource which should handle this request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-client-name": "apcGatewayId" + }, + "Azure.Core.ClientRequestIdHeader": { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method", + "x-ms-client-name": "clientRequestId" + }, + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/specification/programmableconnectivity/data-plane/readme.md b/specification/programmableconnectivity/data-plane/readme.md new file mode 100644 index 000000000000..9afcd7bc956b --- /dev/null +++ b/specification/programmableconnectivity/data-plane/readme.md @@ -0,0 +1,57 @@ +# Azure Programmable Connectivity + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Programmable Connectivity. + +## 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 Azure Programmable Connectivity. + +```yaml +openapi-type: data-plane +tag: package-2024-02-09-preview +title: AzureProgrammableConnectivity +``` + +### Tag: package-2024-02-09-preview + +These settings apply only when `--tag=package-2024-02-09-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-02-09-preview' +input-file: + - Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json +suppressions: + - code: ValidResponseCodeRequired + reason: APC must return a 302 as part of a non-standard frontend authentication flow + where: $.paths./number-verification/number:verify.post.responses +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-net-track2 +``` \ No newline at end of file diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp new file mode 100644 index 000000000000..15a65848cd57 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -0,0 +1,152 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using PurviewDataMap; + +@TypeSpec.Versioning.useDependency(PurviewDataMap.ApiVersions.v2023_09_01) +@client({ + name: "DataMapClient", + service: PurviewDataMap, +}) +namespace Customizations; + +@@projectedName(MoveEntitiesOptions, "csharp", "MoveEntitiesConfig"); +@@projectedName(DateFormat, "csharp", "AtlasDateFormat"); +@@projectedName(NumberFormat, "csharp", "AtlasNumberFormat"); +@@projectedName(TimeZone, "csharp", "AtlasTimeZone"); +@@projectedName(SortType, "csharp", "AtlasSortType"); +@@projectedName(ClassificationAssociateOptions, + "csharp", + "ClassificationAssociateConfig" +); +@@projectedName(QueryOptions, "csharp", "QueryConfig"); +@@projectedName(SuggestOptions, "csharp", "SuggestConfig"); +@@projectedName(AutoCompleteOptions, "csharp", "AutoCompleteConfig"); + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@operationGroup +interface Entity { + createOrUpdate is PurviewDataMap.Entity.createOrUpdate; + getByIds is PurviewDataMap.Entity.listByGuids; + batchCreateOrUpdate is PurviewDataMap.Entity.bulkCreateOrUpdate; + batchDelete is PurviewDataMap.Entity.bulkDelete; + addClassification is PurviewDataMap.Entity.addClassification; + get is PurviewDataMap.Entity.get; + updateAttributeById is PurviewDataMap.Entity.partialUpdateAttributeByGuid; + delete is PurviewDataMap.Entity.delete; + getClassification is PurviewDataMap.Entity.getClassification; + removeClassification is PurviewDataMap.Entity.removeClassification; + getClassifications is PurviewDataMap.Entity.getClassifications; + addClassifications is PurviewDataMap.Entity.addClassifications; + updateClassifications is PurviewDataMap.Entity.updateClassifications; + getByUniqueAttribute is PurviewDataMap.Entity.getByUniqueAttributes; + updateByUniqueAttribute is PurviewDataMap.Entity.partialUpdateByUniqueAttributes; + deleteByUniqueAttribute is PurviewDataMap.Entity.deleteByUniqueAttribute; + removeClassificationByUniqueAttribute is PurviewDataMap.Entity.removeClassificationByUniqueAttribute; + addClassificationsByUniqueAttribute is PurviewDataMap.Entity.addClassificationsByUniqueAttribute; + updateClassificationsUniqueByAttribute is PurviewDataMap.Entity.updateClassificationsByUniqueAttribute; + batchSetClassifications is PurviewDataMap.Entity.bulkSetClassifications; + batchGetByUniqueAttributes is PurviewDataMap.Entity.listByUniqueAttributes; + getHeader is PurviewDataMap.Entity.getHeader; + removeBusinessMetadata is PurviewDataMap.Entity.removeBusinessMetadata; + addOrUpdateBusinessMetadata is PurviewDataMap.Entity.addOrUpdateBusinessMetadata; + removeBusinessMetadataAttributes is PurviewDataMap.Entity.removeBusinessMetadataAttributes; + addOrUpdateBusinessMetadataAttributes is PurviewDataMap.Entity.addOrUpdateBusinessMetadataAttributes; + getBusinessMetadataTemplate is PurviewDataMap.Entity.getSampleBusinessMetadataTemplate; + #suppress "@azure-tools/typespec-azure-core/byos" "This is Atlas API" + importBusinessMetadata is PurviewDataMap.Entity.importBusinessMetadata; + removeLabels is PurviewDataMap.Entity.removeLabels; + setLabels is PurviewDataMap.Entity.setLabels; + addLabel is PurviewDataMap.Entity.addLabel; + removeLabelsByUniqueAttribute is PurviewDataMap.Entity.removeLabelsByUniqueAttribute; + setLabelsByUniqueAttribute is PurviewDataMap.Entity.setLabelsByUniqueAttribute; + addLabelsByUniqueAttribute is PurviewDataMap.Entity.addLabelsByUniqueAttribute; + moveEntitiesToCollection is PurviewDataMap.Entity.moveEntitiesToCollection; +} + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@operationGroup +interface Glossary { + batchGet is PurviewDataMap.Glossary.list; + create is PurviewDataMap.Glossary.create; + createCategories is PurviewDataMap.Glossary.createCategories; + createCategory is PurviewDataMap.Glossary.createCategory; + getCategory is PurviewDataMap.Glossary.getCategory; + updateCategory is PurviewDataMap.Glossary.updateCategory; + deleteCategory is PurviewDataMap.Glossary.deleteCategory; + partialUpdateCategory is PurviewDataMap.Glossary.partialUpdateCategory; + getRelatedCategories is PurviewDataMap.Glossary.listRelatedCategories; + getCategoryTerms is PurviewDataMap.Glossary.listCategoryTerms; + createTerm is PurviewDataMap.Glossary.createTerm; + getTerm is PurviewDataMap.Glossary.getTerm; + updateTerm is PurviewDataMap.Glossary.updateTerm; + deleteTerm is PurviewDataMap.Glossary.deleteTerm; + partialUpdateTerm is PurviewDataMap.Glossary.partialUpdateTerm; + createTerms is PurviewDataMap.Glossary.createTerms; + getEntitiesAssignedWithTerm is PurviewDataMap.Glossary.listEntitiesAssignedWithTerm; + assignTermToEntities is PurviewDataMap.Glossary.assignTermToEntities; + deleteTermAssignmentFromEntities is PurviewDataMap.Glossary.deleteTermAssignmentFromEntities; + getRelatedTerms is PurviewDataMap.Glossary.listRelatedTerms; + get is PurviewDataMap.Glossary.get; + update is PurviewDataMap.Glossary.update; + delete is PurviewDataMap.Glossary.delete; + getCategories is PurviewDataMap.Glossary.listCategories; + getCategoriesHeaders is PurviewDataMap.Glossary.listCategoriesHeaders; + getDetailed is PurviewDataMap.Glossary.getDetailed; + partialUpdate is PurviewDataMap.Glossary.partialUpdate; + getTerms is PurviewDataMap.Glossary.listTerms; + getTermHeaders is PurviewDataMap.Glossary.listTermHeaders; +} + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@operationGroup +interface Discovery { + query is PurviewDataMap.Discovery.query; + suggest is PurviewDataMap.Discovery.suggest; + autoComplete is PurviewDataMap.Discovery.autoComplete; +} + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@operationGroup +interface Lineage { + get is PurviewDataMap.Lineage.get; + getNextPage is PurviewDataMap.Lineage.getNextPage; + getByUniqueAttribute is PurviewDataMap.Lineage.getByUniqueAttribute; +} + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@operationGroup +interface Relationship { + create is PurviewDataMap.Relationship.create; + update is PurviewDataMap.Relationship.update; + get is PurviewDataMap.Relationship.get; + delete is PurviewDataMap.Relationship.delete; +} + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@operationGroup +interface TypeDefinition { + getBusinessMetadataById is PurviewDataMap.Type.getBusinessMetadataDefByGuid; + getBusinessMetadataByName is PurviewDataMap.Type.getBusinessMetadataDefByName; + getClassificationById is PurviewDataMap.Type.getClassificationDefByGuid; + getClassificationByName is PurviewDataMap.Type.getClassificationDefByName; + getEntityById is PurviewDataMap.Type.getEntityDefByGuid; + getEntityByName is PurviewDataMap.Type.getEntityDefByName; + getEnumById is PurviewDataMap.Type.getEnumDefByGuid; + getEnumByName is PurviewDataMap.Type.getEnumDefByName; + getRelationshipById is PurviewDataMap.Type.getRelationshipDefByGuid; + getRelationshipByName is PurviewDataMap.Type.getRelationshipDefByName; + getStructById is PurviewDataMap.Type.getStructDefByGuid; + getStructByName is PurviewDataMap.Type.getStructDefByName; + getById is PurviewDataMap.Type.getByGuid; + getByName is PurviewDataMap.Type.getByName; + delete is PurviewDataMap.Type.delete; + get is PurviewDataMap.Type.list; + batchCreate is PurviewDataMap.Type.bulkCreate; + batchUpdate is PurviewDataMap.Type.bulkUpdate; + batchDelete is PurviewDataMap.Type.bulkDelete; + getHeaders is PurviewDataMap.Type.listHeaders; + getTermTemplateById is PurviewDataMap.Type.getTermTemplateDefByGuid; + getTermTemplateByName is PurviewDataMap.Type.getTermTemplateDefByName; +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json new file mode 100644 index 000000000000..b2f2665d5b36 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": "exa", + "filter": { + "and": [ + { + "entityType": "azure_blob_path", + "includeSubTypes": false + } + ] + }, + "limit": 10 + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "text": "example", + "queryPlusText": "example" + }, + { + "text": "exampleconfiguration", + "queryPlusText": "exampleconfiguration" + }, + { + "text": "exampleresources", + "queryPlusText": "exampleresources" + } + ] + } + } + }, + "title": "Discovery_AutoComplete", + "operationId": "Discovery_AutoComplete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json new file mode 100644 index 000000000000..a7cde65a400e --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": "exampledata", + "filter": { + "and": [ + { + "objectType": "Files" + }, + { + "entityType": "azure_blob_path" + } + ] + }, + "limit": 10, + "orderby": [ + { + "name": "ASC" + }, + { + "updateTime": "DESC" + } + ], + "facets": [ + { + "facet": "assetType", + "count": 0, + "sort": { + "count": "desc" + } + }, + { + "facet": "classification", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "contactId", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "label", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "term", + "count": 10, + "sort": { + "count": "desc" + } + } + ] + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 2, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt", + "name": "exampledata1.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt", + "name": "exampledata2.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json new file mode 100644 index 000000000000..a1f45773a687 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "and": [ + { + "entityType": "azure_blob_path" + }, + { + "attributeName": "qualifiedName", + "operator": "contains", + "attributeValue": ".csv" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 5, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "@search.highlights": { + "qualifiedName": [ + "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv" + ] + }, + "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "@search.highlights": { + "qualifiedName": [ + "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv" + ] + }, + "id": "2605db54-086d-4d6c-adb6-f0bbed6c6eab", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv", + "name": "AllTypes.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_And", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json new file mode 100644 index 000000000000..7ec39b19f500 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "and": [ + { + "entityType": "azure_blob_path" + }, + { + "attributeName": "qualifiedName", + "operator": "contains", + "attributeValue": ".csv" + }, + { + "or": [ + { + "attributeName": "name", + "operator": "eq", + "attributeValue": "exampledata.csv" + }, + { + "attributeName": "qualifiedName", + "operator": "prefix", + "attributeValue": "https://" + } + ] + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 2, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "@search.highlights": { + "qualifiedName": [ + "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv" + ] + }, + "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "@search.highlights": { + "qualifiedName": [ + "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv" + ], + "name": [ + "AllTypes.csv" + ] + }, + "id": "2605db54-086d-4d6c-adb6-f0bbed6c6eab", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv", + "name": "AllTypes.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_AndOrNested", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json new file mode 100644 index 000000000000..deb289d5ea22 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "or": [ + { + "assetType": "SQL Server" + }, + { + "assetType": "Azure SQL Server" + }, + { + "assetType": "Azure SQL Database" + }, + { + "assetType": "Azure SQL Data Warehouse" + }, + { + "assetType": "Azure SQL Managed Instance" + }, + { + "assetType": "Azure Storage Account" + }, + { + "assetType": "Azure Blob Storage" + }, + { + "assetType": "Azure Files" + }, + { + "assetType": "Azure Table Storage" + }, + { + "assetType": "Azure Data Lake Storage Gen1" + }, + { + "assetType": "Azure Data Lake Storage Gen2" + }, + { + "assetType": "Azure Cosmos DB" + }, + { + "assetType": "Azure Data Factory" + }, + { + "assetType": "Azure Cognitive Search" + }, + { + "assetType": "Power BI" + }, + { + "assetType": "Azure Data Explorer" + }, + { + "assetType": "Amazon S3" + }, + { + "assetType": "Azure Data Share" + }, + { + "assetType": "Teradata" + }, + { + "assetType": "SAP S4HANA" + }, + { + "assetType": "SAP ECC" + }, + { + "assetType": "SQL Server Integration Services" + }, + { + "assetType": "hive" + }, + { + "assetType": "Azure Database for MySQL" + }, + { + "assetType": "Azure Database for MariaDB" + }, + { + "assetType": "Azure Database for PostgreSQL" + }, + { + "assetType": "Azure Synapse Analytics" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "@search.count": 5155, + "@search.count.approximate": true, + "value": [ + { + "@search.score": 1.0, + "id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata1", + "name": "exampledata1", + "description": null, + "owner": null, + "entityType": "azure_sql_mi_table", + "classification": [], + "label": [], + "assetType": [ + "Azure SQL Managed Instance" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "d7b516fc-5d38-40f8-baeb-72f6f6f60000", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata2", + "name": "exampledata2", + "description": null, + "owner": null, + "entityType": "azure_sql_mi_table", + "classification": [], + "label": [], + "assetType": [ + "Azure SQL Managed Instance" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_AssetType", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json new file mode 100644 index 000000000000..6d2ccf524020 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "or": [ + { + "attributeName": "name", + "operator": "eq", + "attributeValue": "exampledata.csv" + }, + { + "attributeName": "createTime", + "operator": "ge", + "attributeValue": 1545580800000 + }, + { + "attributeName": "modifiedTime", + "operator": "timerange", + "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 4, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "55b2290d-e11d-4ed2-8c7a-0d8d35eb6254", + "qualifiedName": "https://examplegen2account.dfs.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", + "description": null, + "owner": "$superuser", + "entityType": "azure_datalake_gen2_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Data Lake Storage Gen2" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "55ceaddf-30ac-40f3-b656-71f6f6f60000", + "entityType": "azure_sql_mi_table", + "name": "exampleData_v1", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v1", + "assetType": [ + "Azure SQL Managed Instance" + ] + }, + { + "@search.score": 1.0, + "id": "89416661-5269-4f3d-ba35-e0f6f6f60000", + "entityType": "azure_sql_mi_table", + "name": "exampleData_v2", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v2", + "assetType": [ + "Azure SQL Managed Instance" + ] + } + ] + } + } + }, + "title": "Discovery_Query_Attribute", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json new file mode 100644 index 000000000000..2ab33726a034 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "or": [ + { + "attributeName": ".", + "operator": "eq|ne|contains|prefix", + "attributeValue": "string value" + }, + { + "attributeName": ".", + "operator": "eq|ne|gt|ge|lt|le", + "attributeValue": 123 + }, + { + "attributeName": ".", + "operator": "eq|ne", + "attributeValue": true + }, + { + "attributeName": ".", + "operator": "timerange", + "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 1, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", + "entityType": "azure_blob_path", + "objectType": "Files" + } + ] + } + } + }, + "title": "Discovery_Query_BusinessMetadataAttribute", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json new file mode 100644 index 000000000000..5150545e7d0f --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "classification": "MICROSOFT.PERSONAL.EMAIL", + "includeSubClassifications": true + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 5, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "b9638b91-884f-4e5e-98b5-29f6f6f60000", + "qualifiedName": "mssql://exampleserver.database.windows.net/examplesqldb/examplepath/exampledata1", + "name": "exampledata1", + "description": null, + "owner": null, + "entityType": "azure_sql_table", + "classification": [ + "MICROSOFT.PERSONAL.NAME", + "MICROSOFT.PERSONAL.EU.PHONE_NUMBER", + "MICROSOFT.PERSONAL.US.PHONE_NUMBER", + "MICROSOFT.PERSONAL.EMAIL" + ], + "label": [], + "assetType": [ + "Azure SQL Database" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "01aefb9a-61cd-4a02-a572-70f6f6f60000", + "qualifiedName": "mssql://exampleserver.database.windows.net/exampledw/examplepath/exampledata2", + "name": "exampledata2", + "description": null, + "owner": null, + "entityType": "azure_sql_dw_table", + "classification": [ + "MICROSOFT.GOVERNMENT.CITY_NAME", + "MICROSOFT.GOVERNMENT.US.STATE", + "MICROSOFT.PERSONAL.NAME", + "MICROSOFT.PERSONAL.EU.PHONE_NUMBER", + "MICROSOFT.PERSONAL.EMAIL" + ], + "label": [], + "assetType": [ + "Azure SQL Data Warehouse" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Classification", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json new file mode 100644 index 000000000000..3779d9d497fe --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "collectionId": "collectionName" + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 5, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "b9638b91-884f-4e5e-98b5-29f6f6f60000", + "qualifiedName": "mssql://exampleserver.database.windows.net/examplesqldb/examplepath/exampledata1", + "name": "exampledata1", + "description": null, + "owner": null, + "entityType": "azure_sql_table", + "classification": [ + "MICROSOFT.PERSONAL.NAME", + "MICROSOFT.PERSONAL.EU.PHONE_NUMBER", + "MICROSOFT.PERSONAL.US.PHONE_NUMBER", + "MICROSOFT.PERSONAL.EMAIL" + ], + "label": [], + "assetType": [ + "Azure SQL Database" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "01aefb9a-61cd-4a02-a572-70f6f6f60000", + "qualifiedName": "mssql://exampleserver.database.windows.net/exampledw/examplepath/exampledata2", + "name": "exampledata2", + "description": null, + "owner": null, + "entityType": "azure_sql_dw_table", + "classification": [ + "MICROSOFT.GOVERNMENT.CITY_NAME", + "MICROSOFT.GOVERNMENT.US.STATE", + "MICROSOFT.PERSONAL.NAME", + "MICROSOFT.PERSONAL.EU.PHONE_NUMBER", + "MICROSOFT.PERSONAL.EMAIL" + ], + "label": [], + "assetType": [ + "Azure SQL Data Warehouse" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Collection", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json new file mode 100644 index 000000000000..b417487bea7d --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "filter": { + "objectType": "Tables" + }, + "limit": 10, + "facets": [ + { + "facet": "assetType", + "count": 10 + }, + { + "facet": "classification", + "count": 10 + }, + { + "facet": "term", + "count": 10 + }, + { + "facet": "label", + "count": 10 + } + ] + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "@search.count": 5156, + "@search.count.approximate": false, + "@search.facets": { + "classification": [ + { + "count": 8, + "value": "MICROSOFT.PERSONAL.NAME" + }, + { + "count": 6, + "value": "MICROSOFT.PERSONAL.EU.PHONE_NUMBER" + }, + { + "count": 5, + "value": "MICROSOFT.PERSONAL.EMAIL" + }, + { + "count": 5, + "value": "MICROSOFT.PERSONAL.US.PHONE_NUMBER" + }, + { + "count": 4, + "value": "MICROSOFT.GOVERNMENT.CITY_NAME" + }, + { + "count": 2, + "value": "MICROSOFT.GOVERNMENT.US.STATE" + } + ], + "assetType": [ + { + "count": 1476, + "value": "Azure SQL Database" + }, + { + "count": 1358, + "value": "Azure SQL Data Warehouse" + }, + { + "count": 1331, + "value": "Azure SQL Managed Instance" + }, + { + "count": 293, + "value": "Azure Data Lake Storage Gen1" + }, + { + "count": 261, + "value": "Azure Blob Storage" + }, + { + "count": 231, + "value": "Azure Data Lake Storage Gen2" + }, + { + "count": 194, + "value": "Azure Files" + }, + { + "count": 18, + "value": "Azure Cosmos DB" + } + ], + "label": [ + { + "count": 835, + "value": "Example.Label" + } + ], + "term": [ + { + "count": 1, + "value": "terma" + } + ] + }, + "value": [ + { + "@search.score": 1.0, + "id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata", + "name": "exampledata", + "description": null, + "owner": null, + "entityType": "azure_sql_mi_table", + "classification": [], + "label": [], + "assetType": [ + "Azure SQL Managed Instance" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "d7b516fc-5d38-40f8-baeb-72f6f6f60000", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata2", + "name": "exampledata2", + "description": null, + "owner": null, + "entityType": "azure_sql_mi_table", + "classification": [], + "label": [], + "assetType": [ + "Azure SQL Managed Instance" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Facet", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json new file mode 100644 index 000000000000..0b7fee10f958 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "and": [ + { + "fileExtension": "txt" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "@search.count": 49, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt", + "name": "exampledata.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt", + "name": "exampledata.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_FileExtension", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json new file mode 100644 index 000000000000..1af1169192d0 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": "", + "limit": 10, + "filter": { + "and": [ + { + "objectType": "Glossary terms" + }, + { + "or": [ + { + "glossaryType": "AtlasGlossary" + }, + { + "glossaryType": "AtlasGlossaryTerm" + } + ] + } + ] + }, + "facets": [ + { + "facet": "termStatus", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "termTemplate", + "count": 10, + "sort": { + "count": "desc" + } + } + ] + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 2, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "objectType": "Glossary terms", + "glossaryType": "AtlasGlossaryTerm", + "id": "b1e51cc4-9249-4c81-bbc7-e2f3117706f3", + "name": "termSample1", + "glossary": "DefaultGlossary", + "longDescription": "it is the definition of the term", + "termStatus": "Approved", + "termTemplate": [ + "termTemplateSample" + ], + "createTime": 1625819659805, + "updateTime": 1625819659805, + "qualifiedName": "termSample1@DefaultGlossary" + }, + { + "@search.score": 1.0, + "objectType": "Glossary terms", + "glossaryType": "AtlasGlossary", + "id": "b28f35e4-fcd4-43ca-91a3-daf432c87156", + "name": "DefaultGlossary", + "longDescription": "it is the definition of the glossary", + "createTime": 1625819658745, + "updateTime": 1640656877302, + "qualifiedName": "DefaultGlossary" + } + ], + "@search.facets": { + "termTemplate": [ + { + "count": 1, + "value": "termTemplateSample" + } + ], + "termStatus": [ + { + "count": 1, + "value": "Approved" + } + ] + } + } + } + }, + "title": "Discovery_Query_GlossaryTerm", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json new file mode 100644 index 000000000000..1a983534fbce --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "and": [ + { + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 1, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt", + "name": "exampledata.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Id", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json new file mode 100644 index 000000000000..4c6b90d682c4 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "not": { + "classification": "MICROSOFT.SYSTEM.TEMP_FILE" + } + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "@search.count": 5158, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "11fd6e94-2dc6-4ebd-822c-caf6f6f60000", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/exampledb/dbo/exampledata", + "name": "exampledata", + "description": null, + "owner": null, + "entityType": "azure_sql_mi_table", + "classification": [], + "label": [], + "assetType": [ + "Azure SQL Managed Instance" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "1af82c87-798c-41a2-abab-93f6f6f60000", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/exampledb/dbo/exampledata2", + "name": "exampledata2", + "description": null, + "owner": null, + "entityType": "azure_sql_mi_table", + "classification": [], + "label": [], + "assetType": [ + "Azure SQL Managed Instance" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Not", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json new file mode 100644 index 000000000000..f332749b05ee --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "or": [ + { + "objectType": "Dashboards" + }, + { + "objectType": "Data pipelines" + }, + { + "objectType": "Files" + }, + { + "objectType": "Folders" + }, + { + "objectType": "Glossary terms" + }, + { + "objectType": "Reports" + }, + { + "objectType": "Stored procedures" + }, + { + "objectType": "Tables" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 2, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "objectType": "Tables", + "id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000", + "entityType": "azure_sql_mi_table", + "name": "exampledata1", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata1", + "assetType": [ + "Azure SQL Managed Instance" + ] + }, + { + "@search.score": 1.0, + "objectType": "Glossary terms", + "id": "b1e51cc4-9249-4c81-bbc7-e2f3117706f3", + "glossaryType": "AtlasGlossaryTerm", + "name": "termSample1", + "glossary": "DefaultGlossary", + "longDescription": "it is the definition of the term", + "termStatus": "Approved", + "termTemplate": [ + "termTemplateSample" + ], + "qualifiedName": "termSample1@DefaultGlossary" + } + ] + } + } + }, + "title": "Discovery_Query_ObjectType", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json new file mode 100644 index 000000000000..cbe86e93e8fa --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": "exampledata", + "filter": { + "and": [ + { + "objectType": "Files" + }, + { + "entityType": "azure_blob_path" + } + ] + }, + "limit": 2, + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "orderby": [ + { + "name": "ASC" + }, + { + "updateTime": "DESC" + } + ], + "facets": [ + { + "facet": "assetType", + "count": 0, + "sort": { + "count": "desc" + } + }, + { + "facet": "classification", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "contactId", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "label", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "term", + "count": 10, + "sort": { + "count": "desc" + } + } + ] + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 6, + "@search.count.approximate": false, + "continuationToken": "ZXlKelpYTnphVzl1U1dRaU9pSTVaV1JpWW1Fek5DMHdZbU0wTFRReE5HRXRPVFkyTkMwMU9HTTJaVEJrTXpJM09EWWlMQ0p2Wm1aelpYUWlPakkxTENKeVpYRjFaWE4wU0dGemFDSTZJalppTW1Gak1UbG1NR0V4WmpsbU1qWTJOemMwWkRkaFpEY3pOVEUzT1dKbUluMD0=", + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt", + "name": "exampledata1.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt", + "name": "exampledata2.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_PaginationContinuationPage", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json new file mode 100644 index 000000000000..fe5522da8ebf --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": "exampledata", + "filter": { + "and": [ + { + "objectType": "Files" + }, + { + "entityType": "azure_blob_path" + } + ] + }, + "limit": 2, + "orderby": [ + { + "name": "ASC" + }, + { + "updateTime": "DESC" + } + ], + "facets": [ + { + "facet": "assetType", + "count": 0, + "sort": { + "count": "desc" + } + }, + { + "facet": "classification", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "contactId", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "label", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "term", + "count": 10, + "sort": { + "count": "desc" + } + } + ] + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 6, + "@search.count.approximate": false, + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt", + "name": "exampledata1.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt", + "name": "exampledata2.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_PaginationFirstPage", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json new file mode 100644 index 000000000000..4e64dd33405e --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": "exampledata", + "filter": { + "and": [ + { + "objectType": "Files" + }, + { + "entityType": "azure_blob_path" + } + ] + }, + "limit": 2, + "continuationToken": "ZXlKelpYTnphVzl1U1dRaU9pSTVaV1JpWW1Fek5DMHdZbU0wTFRReE5HRXRPVFkyTkMwMU9HTTJaVEJrTXpJM09EWWlMQ0p2Wm1aelpYUWlPakkxTENKeVpYRjFaWE4wU0dGemFDSTZJalppTW1Gak1UbG1NR0V4WmpsbU1qWTJOemMwWkRkaFpEY3pOVEUzT1dKbUluMD0=", + "orderby": [ + { + "name": "ASC" + }, + { + "updateTime": "DESC" + } + ], + "facets": [ + { + "facet": "assetType", + "count": 0, + "sort": { + "count": "desc" + } + }, + { + "facet": "classification", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "contactId", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "label", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "term", + "count": 10, + "sort": { + "count": "desc" + } + } + ] + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 6, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt", + "name": "exampledata1.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt", + "name": "exampledata2.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_PaginationLastPage", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json new file mode 100644 index 000000000000..d2196fa7ea91 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "or": [ + { + "createTime": { + "operator": "lt", + "timeThreshold": 1545580800000 + } + }, + { + "updateTime": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 2, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "55ceaddf-30ac-40f3-b656-71f6f6f60000", + "entityType": "azure_sql_mi_table", + "name": "exampleData_v1", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v1", + "assetType": [ + "Azure SQL Managed Instance" + ] + }, + { + "@search.score": 1.0, + "id": "89416661-5269-4f3d-ba35-e0f6f6f60000", + "entityType": "azure_sql_mi_table", + "name": "exampleData_v2", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v2", + "assetType": [ + "Azure SQL Managed Instance" + ] + } + ] + } + } + }, + "title": "Discovery_Query_SystemTime", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json new file mode 100644 index 000000000000..f2f278e5c48b --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": "exampledata", + "filter": { + "and": [ + { + "objectType": "Files" + }, + { + "not": { + "or": [ + { + "attributeName": "size", + "operator": "eq", + "attributeValue": 0 + }, + { + "attributeName": "fileSize", + "operator": "eq", + "attributeValue": 0 + } + ] + } + }, + { + "not": { + "classification": "MICROSOFT.SYSTEM.TEMP_FILE" + } + } + ] + }, + "limit": 10, + "taxonomySetting": { + "assetTypes": [ + "Azure Blob Storage" + ], + "facet": { + "count": 10, + "sort": { + "count": "desc" + } + } + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "@search.count": 339, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt", + "name": "exampledata1.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt", + "name": "exampledata2.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Taxonomy", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json new file mode 100644 index 000000000000..0c24709432b3 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": "", + "limit": 3, + "filter": { + "or": [ + { + "term": "ExampleTerm" + }, + { + "term": "ExampleTerm", + "glossary": "GlossaryName" + }, + { + "termGuid": "" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 1, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "b20ac13a-7883-4376-b076-bac9f8f214a8", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer", + "name": "examplecontainer", + "description": null, + "owner": null, + "entityType": "azure_blob_container", + "classification": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [ + { + "name": "ExampleTerm", + "glossaryName": "Glossary" + } + ], + "contact": [], + "label": [ + "Example.Label" + ] + } + ] + } + } + }, + "title": "Discovery_Query_TermAssignment", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json new file mode 100644 index 000000000000..48480e13fc17 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": null, + "limit": 10, + "filter": { + "and": [ + { + "entityType": "azure_blob_path", + "includeSubTypes": false + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "@search.count": 221, + "value": [ + { + "@search.score": 1.0, + "id": "1d797ddf-47bf-4151-8fe8-918590d62e70", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.csv", + "name": "exampledata.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "d3e83b17-c730-4898-94c8-58579cda04f6", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.csv", + "name": "exampledata2.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Type", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json new file mode 100644 index 000000000000..3ff80bee52ec --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "keywords": "exampledata", + "filter": { + "and": [ + { + "entityType": "azure_blob_path", + "includeSubTypes": false + } + ] + }, + "limit": 10 + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "exampledata.csv", + "@search.score": 9.81402, + "description": "Example Description", + "id": "af7a01b0-1b14-4ab6-83a5-12cb11a717ed", + "name": "exampledata.csv", + "owner": "$superuser", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.csv", + "entityType": "azure_blob_path", + "assetType": [ + "Azure Blob Storage" + ], + "classification": [ + "MICROSOFT.GOVERNMENT.US.PASSPORT_NUMBER" + ], + "contact": [ + { + "id": "8a597ffc-6993-4772-ac25-86b7251e1234", + "info": "Example Info", + "contactType": "Expert" + } + ], + "label": [ + "Example.Label" + ], + "term": [ + { + "name": "Example Term", + "glossaryName": "Glossary" + } + ] + } + ] + } + } + }, + "title": "Discovery_Suggest", + "operationId": "Discovery_Suggest" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json new file mode 100644 index 000000000000..b94ab95331ec --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "classification": { + "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", + "attributes": {}, + "validityPeriods": [] + }, + "entityGuids": [ + "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", + "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" + ] + } + }, + "responses": { + "204": {} + }, + "title": "Entity_AddClassificationToEntityByGuids", + "operationId": "Entity_AddClassification" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassifications.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassifications.json new file mode 100644 index 000000000000..5ab64b05faac --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassifications.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", + "body": [ + { + "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", + "entityGuid": "cc0730ba-9b30-41f0-6953-559d17626d2b" + }, + { + "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", + "entityGuid": "cc0730ba-9b30-41f0-6953-559d17626d2b" + } + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_AddClassifications", + "operationId": "Entity_AddClassifications" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json new file mode 100644 index 000000000000..0a724e78e134 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_storage_account", + "attr:qualifiedName": "https://exampleaccount.core.windows.net", + "body": [ + { + "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" + }, + { + "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER" + } + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_AddClassificationsByUniqueAttribute", + "operationId": "Entity_AddClassificationsByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json new file mode 100644 index 000000000000..5e50da3bc1c7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2023-09-01", + "body": { + "referredEntities": {}, + "entity": { + "typeName": "azure_storage_account", + "attributes": { + "owner": "ExampleOwner", + "modifiedTime": 0, + "createTime": 0, + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAccount", + "description": null, + "publicAccessLevel": null + }, + "customAttributes": { + "custAttr1": "attr1", + "custAttr2": "attr2" + } + } + } + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "CREATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "owner": "ExampleOwner", + "createTime": 0, + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAccount" + }, + "lastModifiedTS": "1", + "guid": "c696b935-2c76-4208-bc0d-8864553a67f1", + "displayText": "ExampleStorageAccount", + "classificationNames": [], + "classifications": [], + "meaningNames": [], + "meanings": [], + "isIncomplete": false, + "labels": [] + } + ] + }, + "guidAssignments": { + "-16806536444330": "c696b935-2c76-4208-bc0d-8864553a67f1" + } + } + } + }, + "title": "Entity_AddCustomAttribute", + "operationId": "Entity_CreateOrUpdate" +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Label.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json similarity index 73% rename from specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Label.json rename to specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json index 62668d54234d..6c8c8ccf153d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Label.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json @@ -9,5 +9,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddLabel", + "operationId": "Entity_AddLabel" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json new file mode 100644 index 000000000000..3a2bc5a3f537 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "Asset", + "attr:qualifiedName": "https://asset1", + "body": [ + "label3" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_AddLabelsByUniqueAttribute", + "operationId": "Entity_AddLabelsByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json new file mode 100644 index 000000000000..f91a2897c1e2 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "businessMetadataName": "myBizMetaData1", + "body": { + "bizAttr1": "bizAttr1" + } + }, + "responses": { + "204": {} + }, + "title": "Entity_AddOrUpdate_BusinessAttribute", + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessMetadata.json new file mode 100644 index 000000000000..4141a16cc255 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessMetadata.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": { + "myBizMetadata1": { + "bizAttr1": "myBizMetaData1.bizAttr1" + } + } + }, + "responses": { + "204": {} + }, + "title": "Entity_AddOrUpdate_BusinessMetadata", + "operationId": "Entity_AddOrUpdateBusinessMetadata" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkCreateOrUpdate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkCreateOrUpdate.json new file mode 100644 index 000000000000..81eb02f76d2e --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkCreateOrUpdate.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "referredEntities": {}, + "entities": [ + { + "typeName": "azure_storage_account", + "attributes": { + "owner": "ExampleOwner", + "modifiedTime": 0, + "createTime": 0, + "qualifiedName": "exampleaccount1", + "name": "ExampleStorageAccount1", + "description": null, + "publicAccessLevel": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + }, + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "version": 0 + }, + { + "typeName": "azure_storage_account", + "attributes": { + "owner": "ExampleOwner", + "modifiedTime": 0, + "createTime": 0, + "qualifiedName": "exampleaccount2", + "name": "ExampleStorageAccount2", + "description": "Example Description", + "publicAccessLevel": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + }, + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "version": 0 + } + ] + } + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "UPDATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "exampleaccount2" + }, + "lastModifiedTS": "2", + "guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1", + "status": "ACTIVE" + } + ], + "CREATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "exampleaccount1" + }, + "lastModifiedTS": "1", + "guid": "321493e3-3fb7-4b3e-9df7-3b69154174c2", + "status": "ACTIVE" + } + ] + }, + "guidAssignments": { + "-9514774903018192": "321493e3-3fb7-4b3e-9df7-3b69154174c2", + "-9514774903018193": "b2f9c306-cf65-4bb0-878e-cfaafde156b1" + } + } + } + }, + "title": "Entity_BulkCreateOrUpdate", + "operationId": "Entity_BulkCreateOrUpdate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkDelete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkDelete.json new file mode 100644 index 000000000000..3b8c27b9b5fc --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkDelete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": [ + "18e06957-e265-967a-07f1-e14e2ab8940f", + "cc0730ba-9b30-41f0-6953-559d17626d2b" + ] + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "DELETE": [ + { + "typeName": "azure_blob_container", + "attributes": { + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer" + }, + "guid": "18e06957-e265-967a-07f1-e14e2ab8940f", + "status": "ACTIVE" + }, + { + "typeName": "azure_blob_container", + "attributes": { + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer2" + }, + "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", + "status": "ACTIVE" + } + ] + } + } + } + }, + "title": "Entity_BulkDelete", + "operationId": "Entity_BulkDelete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkSetClassifications.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkSetClassifications.json new file mode 100644 index 000000000000..ceac402f49a7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkSetClassifications.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "guidHeaderMap": { + "9fb74c11-ac48-4650-95bc-760665c5bd92": { + "attributes": { + "qualifiedName": "https://exampleaccount1.core.windows.net" + }, + "typeName": "azure_storage_account", + "classifications": [ + { + "typeName": "MICROSOFT.PERSONAL.EMAIL" + } + ] + }, + "7fcc43ab-55ea-45d4-9971-ce0443cb10bb": { + "attributes": { + "qualifiedName": "https://exampleaccount2.core.windows.net" + }, + "typeName": "azure_storage_account", + "classifications": [ + { + "typeName": "MICROSOFT.PERSONAL.IPADDRESS" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": [ + "Add:9fb74c11-ac48-4650-95bc-760665c5bd92:azure_storage_account:qualifiedName -> MICROSOFT.PERSONAL.EMAIL:(Done)", + "Update:7fcc43ab-55ea-45d4-9971-ce0443cb10bb:azure_storage_account:qualifiedName -> MICROSOFT.PERSONAL.IPADDRESS:(Done)" + ] + } + }, + "title": "Entity_BulkSetClassifications", + "operationId": "Entity_BulkSetClassifications" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json new file mode 100644 index 000000000000..cf8647830754 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2023-09-01", + "body": { + "referredEntities": {}, + "entity": { + "typeName": "azure_storage_account", + "attributes": { + "owner": "ExampleOwner", + "modifiedTime": 0, + "createTime": 0, + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAccount", + "description": null, + "publicAccessLevel": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + }, + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "version": 0 + } + } + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "CREATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "https://exampleaccount.core.windows.net" + }, + "lastModifiedTS": "1", + "guid": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6", + "status": "ACTIVE" + } + ] + }, + "guidAssignments": { + "-9514774903018162": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6" + } + } + } + }, + "title": "Entity_Create", + "operationId": "Entity_CreateOrUpdate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Delete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Delete.json new file mode 100644 index 000000000000..9e6ab2104d44 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Delete.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "fd279eb4-f6c3-1b0b-ad67-e4f8abd2972f" + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "DELETE": [ + { + "guid": "fd279eb4-f6c3-1b0b-ad67-e4f8abd2972f", + "status": "ACTIVE", + "lastModifiedTS": "2", + "attributes": { + "owner": "ExampleOwner", + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAaccount" + }, + "typeName": "azure_storage_account" + } + ] + } + } + } + }, + "title": "Entity_Delete", + "operationId": "Entity_Delete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_DeleteByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_DeleteByUniqueAttribute.json new file mode 100644 index 000000000000..3df1ba7cee96 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_DeleteByUniqueAttribute.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_storage_account", + "attr:qualifiedName": "https://exampleaccount.core.windows.net" + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "DELETE": [ + { + "classificationNames": [], + "displayText": "Example Name", + "guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a", + "meaningNames": [], + "meanings": [], + "status": "ACTIVE", + "lastModifiedTS": "1", + "attributes": { + "owner": "ExampleOwner", + "createTime": 0, + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleName" + }, + "typeName": "azure_storage_account" + } + ] + } + } + } + }, + "title": "Entity_DeleteByUniqueAttribute", + "operationId": "Entity_DeleteByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json new file mode 100644 index 000000000000..4c89ab5c8872 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", + "minExtInfo": true + }, + "responses": { + "200": { + "body": { + "referredEntities": {}, + "entity": { + "typeName": "column", + "attributes": { + "owner": null, + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/Target/XmlPeek/@XmlInputPath", + "name": "~XmlInputPath", + "description": null, + "type": "string" + }, + "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553072455110, + "updateTime": 1553072455110, + "version": 0, + "relationshipAttributes": { + "schema": [], + "inputToProcesses": [], + "composeSchema": { + "guid": "cc6652ae-dc6d-90c9-1899-252eabc0e929", + "typeName": "tabular_schema", + "displayText": "tabular_schema", + "relationshipGuid": "5a4510d4-57d0-467c-888f-4b61df42702b", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "tabular_schema_columns" + } + }, + "meanings": [], + "outputFromProcesses": [], + "tabular_schema": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + } + } + } + } + }, + "title": "Entity_Get", + "operationId": "Entity_Get" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json new file mode 100644 index 000000000000..f7ebf7d7d013 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_storage_account", + "attr:qualifiedName": "https://exampleaccount.core.windows.net", + "minExtInfo": true + }, + "responses": { + "200": { + "body": { + "entity": { + "createTime": 1605703532110, + "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", + "guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a", + "relationshipAttributes": { + "services": [], + "meanings": [] + }, + "status": "ACTIVE", + "updateTime": 1605703532110, + "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", + "lastModifiedTS": "2", + "version": 0.0, + "attributes": { + "owner": "ExampleOwner", + "qualifiedName": "https://exampleaccount.core.windows.net", + "createTime": 0, + "name": "ExampleNewName" + }, + "typeName": "azure_storage_account" + }, + "referredEntities": {} + } + } + }, + "title": "Entity_GetByUniqueAttributes", + "operationId": "Entity_GetByUniqueAttributes" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassification.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassification.json new file mode 100644 index 000000000000..968a4d7e0fcc --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassification.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "9347abc5-7b86-4b82-a1e2-ad77c7c3cac3", + "classificationName": "MICROSOFT.PERSONAL.DATE_OF_BIRTH" + }, + "responses": { + "200": { + "body": { + "typeName": "MICROSOFT.PERSONAL.DATE_OF_BIRTH", + "lastModifiedTS": "1", + "entityGuid": "9347abc5-7b86-4b82-a1e2-ad77c7c3cac3", + "entityStatus": "ACTIVE" + } + } + }, + "title": "Entity_GetClassification", + "operationId": "Entity_GetClassification" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassifications.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassifications.json new file mode 100644 index 000000000000..ae0d81292c04 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassifications.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "67d26de6-771d-1a2d-cb2b-dec4dbd2a9bd" + }, + "responses": { + "200": { + "body": { + "list": [ + { + "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", + "entityGuid": "67d26de6-771d-1a2d-cb2b-dec4dbd2a9bd" + } + ], + "startIndex": 0, + "pageSize": 1, + "totalCount": 1, + "sortType": "NONE" + } + } + }, + "title": "Entity_GetClassifications", + "operationId": "Entity_GetClassifications" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetHeader.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetHeader.json new file mode 100644 index 000000000000..029a55bbbb96 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetHeader.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "9fb74c11-ac48-4650-95bc-760665c5bd92" + }, + "responses": { + "200": { + "body": { + "classificationNames": [ + "MICROSOFT.PERSONAL.EMAIL" + ], + "displayText": "Example Storage Account", + "guid": "9fb74c11-ac48-4650-95bc-760665c5bd92", + "meaningNames": [], + "meanings": [], + "status": "ACTIVE", + "lastModifiedTS": "3", + "attributes": { + "owner": "ExampleOwner", + "createTime": 0, + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAccount" + }, + "typeName": "azure_storage_account" + } + } + }, + "title": "Entity_GetHeader", + "operationId": "Entity_GetHeader" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetSampleBusinessMetadataTemplate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetSampleBusinessMetadataTemplate.json new file mode 100644 index 000000000000..34f5b284ae4b --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetSampleBusinessMetadataTemplate.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": "EntityType,EntityUniqueAttributeValue,BusinessAttributeName,BusinessAttributeValue,EntityUniqueAttributeName[optional]" + } + }, + "title": "Entity_GetSampleBusinessMetadataTemplate", + "operationId": "Entity_GetSampleBusinessMetadataTemplate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json new file mode 100644 index 000000000000..5717a38aa7c8 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "file": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" + }, + "responses": { + "200": { + "body": { + "successImportInfoList": [ + { + "parentObjectName": "24a77100-1b3a-4c37-884e-7d4f591f5a64", + "childObjectName": "{myBizType1={bizAttr1=Awesome Attribute 1}}", + "importStatus": "SUCCESS", + "remarks": "" + } + ] + } + } + }, + "title": "Entity_ImportBusinessMetadata", + "operationId": "Entity_ImportBusinessMetadata" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json new file mode 100644 index 000000000000..4f48451cdbbe --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": [ + "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", + "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" + ], + "minExtInfo": true + }, + "responses": { + "200": { + "body": { + "referredEntities": {}, + "entities": [ + { + "typeName": "column", + "attributes": { + "owner": null, + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", + "name": "ExampleName1", + "description": null, + "type": "string" + }, + "guid": "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553072455110, + "updateTime": 1553072455110, + "version": 0, + "relationshipAttributes": { + "schema": [], + "inputToProcesses": [], + "composeSchema": { + "guid": "cc6652ae-dc6d-90c9-1899-252eabc0e929", + "typeName": "tabular_schema", + "displayText": "tabular_schema", + "relationshipGuid": "400fd8e4-97bd-45eb-a21c-880b4094ce5b", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "tabular_schema_columns" + } + }, + "meanings": [], + "outputFromProcesses": [], + "tabular_schema": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + } + }, + { + "typeName": "column", + "attributes": { + "owner": null, + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/Experience/CBT/Extensions/CodeAnalysis.targets#:xml/Project/PropertyGroup/ExampleName2", + "name": "ExampleName2", + "description": null, + "type": "string" + }, + "guid": "b4ebc8be-cef4-860a-bee9-28cc34cb5caa", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553072455110, + "updateTime": 1553072455110, + "version": 0, + "relationshipAttributes": { + "schema": [], + "inputToProcesses": [], + "composeSchema": { + "guid": "381dd3e6-dad5-7409-c21d-ea55b666e420", + "typeName": "tabular_schema", + "displayText": "tabular_schema", + "relationshipGuid": "0b652860-ab79-48cd-a0cf-0867fbba31a3", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "tabular_schema_columns" + } + }, + "meanings": [], + "outputFromProcesses": [], + "tabular_schema": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + } + } + ] + } + } + }, + "title": "Entity_ListByGuids", + "operationId": "Entity_ListByGuids" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json new file mode 100644 index 000000000000..176e6972162b --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_storage_account", + "attr_N:qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", + "minExtInfo": true + }, + "responses": { + "200": { + "body": { + "referredEntities": {}, + "entities": [ + { + "typeName": "column", + "attributes": { + "owner": null, + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", + "name": "ExampleName1", + "description": null, + "type": "string" + }, + "guid": "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553072455110, + "updateTime": 1553072455110, + "version": 0, + "relationshipAttributes": { + "schema": [], + "inputToProcesses": [], + "composeSchema": { + "guid": "cc6652ae-dc6d-90c9-1899-252eabc0e929", + "typeName": "tabular_schema", + "displayText": "tabular_schema", + "relationshipGuid": "400fd8e4-97bd-45eb-a21c-880b4094ce5b", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "tabular_schema_columns" + } + }, + "meanings": [], + "outputFromProcesses": [], + "tabular_schema": null + } + } + ] + } + } + }, + "title": "Entity_ListByUniqueAttributes", + "operationId": "Entity_ListByUniqueAttributes" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_MoveEntitiesToCollection.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_MoveEntitiesToCollection.json new file mode 100644 index 000000000000..a9d546dacff1 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_MoveEntitiesToCollection.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "collectionId": "ExampleNewCollection", + "api-version": "2023-09-01", + "body": { + "entityGuids": [ + "321493e3-3fb7-4b3e-9df7-3b69154174c2", + "b2f9c306-cf65-4bb0-878e-cfaafde156b1" + ] + } + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "UPDATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "exampleaccount" + }, + "lastModifiedTS": "3", + "guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1", + "status": "ACTIVE" + }, + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "exampleaccount2" + }, + "lastModifiedTS": "2", + "guid": "321493e3-3fb7-4b3e-9df7-3b69154174c2", + "status": "ACTIVE" + } + ] + }, + "guidAssignments": { + "-9514774903018192": "321493e3-3fb7-4b3e-9df7-3b69154174c2", + "-9514774903018193": "b2f9c306-cf65-4bb0-878e-cfaafde156b1" + } + } + } + }, + "title": "Entity_MoveEntitiesToCollection", + "operationId": "Entity_MoveEntitiesToCollection" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateAttributeByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateAttributeByGuid.json new file mode 100644 index 000000000000..4320bdb7e9a7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateAttributeByGuid.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "394d9a03-912e-483b-bbd2-bedee1a69798", + "name": "ExampleName", + "body": "ExampleNewName" + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "CREATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "https://exampleaccount.core.windows.net" + }, + "lastModifiedTS": "1", + "guid": "394d9a03-912e-483b-bbd2-bedee1a69798", + "status": "ACTIVE" + } + ] + }, + "partialUpdatedEntities": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "https://exampleaccount.core.windows.net" + }, + "lastModifiedTS": "1", + "guid": "394d9a03-912e-483b-bbd2-bedee1a69798" + } + ] + } + } + }, + "title": "Entity_PartialUpdateAttributeByGuid", + "operationId": "Entity_PartialUpdateAttributeByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateByUniqueAttributes.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateByUniqueAttributes.json new file mode 100644 index 000000000000..40609617bfa7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateByUniqueAttributes.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_storage_account", + "attr:qualifiedName": "https://exampleaccount.core.windows.net", + "body": { + "entity": { + "createTime": 1605766397985.0, + "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", + "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", + "relationshipAttributes": { + "services": [], + "meanings": [] + }, + "status": "ACTIVE", + "updateTime": 1605766397985.0, + "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", + "lastModifiedTS": "1", + "version": 0.0, + "attributes": { + "owner": "ExampleOwner", + "qualifiedName": "https://exampleaccount.core.windows.net", + "createTime": 0, + "name": "ExampleNewName" + }, + "typeName": "azure_storage_account" + }, + "referredEntities": {} + } + }, + "responses": { + "200": { + "body": { + "guidAssignments": {}, + "mutatedEntities": { + "PARTIAL_UPDATE": [ + { + "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", + "lastModifiedTS": "2", + "attributes": { + "qualifiedName": "https://exampleaccount.core.windows.net" + }, + "typeName": "azure_storage_account" + } + ] + }, + "partialUpdatedEntities": [ + { + "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", + "lastModifiedTS": "2", + "attributes": { + "qualifiedName": "https://exampleaccount.core.windows.net" + }, + "typeName": "azure_storage_account" + } + ] + } + } + }, + "title": "Entity_PartialUpdateByUniqueAttributes", + "operationId": "Entity_PartialUpdateByUniqueAttributes" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json new file mode 100644 index 000000000000..717225e30454 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "businessMetadataName": "myBizMetaData1", + "body": { + "bizAttr1": "bizAttr1" + } + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveBusinessAttribute", + "operationId": "Entity_RemoveBusinessMetadataAttributes" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json new file mode 100644 index 000000000000..9e2de7361e36 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": { + "myBizMetadata1": { + "bizAttr1": "myBizMetaData1.bizAttr1" + } + } + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveBusinessMetadata", + "operationId": "Entity_RemoveBusinessMetadata" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassification.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassification.json new file mode 100644 index 000000000000..408744950b01 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassification.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", + "classificationName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveClassification", + "operationId": "Entity_RemoveClassification" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassificationByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassificationByUniqueAttribute.json new file mode 100644 index 000000000000..75717c4f59ad --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassificationByUniqueAttribute.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "column", + "classificationName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", + "attr:qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer/exampledata.csv" + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveClassificationByUniqueAttribute", + "operationId": "Entity_RemoveClassificationByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json new file mode 100644 index 000000000000..743f676c786b --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": [ + "label1", + "label2" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveLabels", + "operationId": "Entity_RemoveLabels" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json new file mode 100644 index 000000000000..3ae4c0b565f8 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "Asset", + "attr:qualifiedName": "https://asset1", + "body": [ + "label1" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveLabelsByUniqueAttribute", + "operationId": "Entity_RemoveLabelsByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json new file mode 100644 index 000000000000..e2b2c2eb6344 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": [ + "label1", + "label2" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_SetLabels", + "operationId": "Entity_SetLabels" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json new file mode 100644 index 000000000000..9ffba096b022 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "Asset", + "attr:qualifiedName": "https://asset1", + "body": [ + "label1", + "label2" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_SetLabelsByUniqueAttribute", + "operationId": "Entity_SetLabelsByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json new file mode 100644 index 000000000000..40e2350403a5 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2023-09-01", + "body": { + "referredEntities": {}, + "entity": { + "typeName": "azure_storage_account", + "attributes": { + "owner": "ExampleOwner", + "modifiedTime": 0, + "createTime": 0, + "qualifiedName": "exampleaccount", + "name": "ExampleStorageAccount", + "description": null, + "publicAccessLevel": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + }, + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "version": 0 + } + } + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "UPDATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "exampleaccount" + }, + "lastModifiedTS": "2", + "guid": "029d5668-a36c-40a9-bc11-6f352bafdc3b" + } + ] + }, + "guidAssignments": { + "-9514774903018167": "029d5668-a36c-40a9-bc11-6f352bafdc3b" + } + } + } + }, + "title": "Entity_Update", + "operationId": "Entity_CreateOrUpdate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassifications.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassifications.json new file mode 100644 index 000000000000..274b565b8f81 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassifications.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", + "body": [ + { + "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", + "entityGuid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24" + }, + { + "typeName": "MICROSOFT.FINANCIAL.US_BANK_ACCOUNT_NUMBER", + "entityGuid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24" + } + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_UpdateClassifications", + "operationId": "Entity_UpdateClassifications" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassificationsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassificationsByUniqueAttribute.json new file mode 100644 index 000000000000..f3b1777a8e75 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassificationsByUniqueAttribute.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_storage_account", + "attr:qualifiedName": "https://exampleaccount.core.windows.net", + "body": [ + { + "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" + }, + { + "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER" + } + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_UpdateClassificationsByUniqueAttribute", + "operationId": "Entity_UpdateClassificationsByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json new file mode 100644 index 000000000000..82aae3a1b087 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "body": [ + { + "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", + "relationshipAttributes": { + "attributes": { + "expression": "Example Expression", + "confidence": 100, + "description": "Example Description", + "source": "ExampleSource" + } + } + } + ] + }, + "responses": { + "204": {} + }, + "title": "Glossary_AssignTermToEntities", + "operationId": "Glossary_AssignTermToEntities" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Create.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Create.json new file mode 100644 index 000000000000..01289fd09ee1 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Create.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "language": "en", + "usage": "Example Glossary" + } + }, + "responses": { + "200": { + "body": { + "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "1", + "language": "en", + "usage": "Example Glossary", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1672892675688, + "updateTime": 1672892675688 + } + } + }, + "title": "Glossary_Create", + "operationId": "Glossary_Create" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategories.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategories.json new file mode 100644 index 000000000000..7dfb49f4e1ae --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategories.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": [ + { + "name": "ExampleCategory2", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + } + }, + { + "name": "ExampleCategory3", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + } + } + ] + }, + "responses": { + "200": { + "body": [ + { + "guid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "qualifiedName": "ExampleCategory2@Glossary", + "name": "ExampleCategory2", + "lastModifiedTS": "1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d" + } + }, + { + "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "qualifiedName": "ExampleCategory3@Glossary", + "name": "ExampleCategory3", + "lastModifiedTS": "1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2" + } + } + ] + } + }, + "title": "Glossary_CreateCategories", + "operationId": "Glossary_CreateCategories" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategory.json new file mode 100644 index 000000000000..912e40a4e7ef --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategory.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + }, + "name": "ExampleCategory1", + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea" + } + ] + } + }, + "responses": { + "200": { + "body": { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1@Glossary", + "name": "ExampleCategory1", + "lastModifiedTS": "1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + } + } + }, + "title": "Glossary_CreateCategory", + "operationId": "Glossary_CreateCategory" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerm.json new file mode 100644 index 000000000000..bd988ea6973b --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerm.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "abbreviation": "T1", + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ], + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Steward": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Steward info" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "abbreviation": "T1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606287247276, + "status": "Approved", + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ], + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Steward": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Steward Info" + } + ] + } + } + } + }, + "title": "Glossary_CreateTerm", + "operationId": "Glossary_CreateTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json new file mode 100644 index 000000000000..677877660bc8 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "name": "ExampleTerm", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + }, + "attributes": { + "ExampleTermTemplateAttribute": { + "plain string": "Example String", + "date": 1606233600000, + "single choice": "Example Single Choice A", + "multi choice": [ + "Example Multi Choice A", + "Example Multi Choice B" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "guid": "9390cc82-1077-403e-a4d2-b6a69834707b", + "qualifiedName": "ExampleTerm@Glossary", + "name": "ExampleTerm", + "lastModifiedTS": "1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606287247276, + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "attributes": { + "ExampleTermTemplateAttribute": { + "plain string": "Example String", + "date": 1606233600000, + "single choice": "Example Single Choice A", + "multi choice": [ + "Example Multi Choice A", + "Example Multi Choice B" + ] + } + } + } + } + }, + "title": "Glossary_CreateTermWithTemplate", + "operationId": "Glossary_CreateTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerms.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerms.json new file mode 100644 index 000000000000..18fcddae9a04 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerms.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": [ + { + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + }, + "name": "ExampleTerm2", + "status": "Approved", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "abbreviation": "T2", + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + }, + { + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + }, + "name": "ExampleTerm3", + "status": "Approved", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "abbreviation": "T3", + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + ] + }, + "responses": { + "200": { + "body": [ + { + "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "qualifiedName": "ExampleTerm2@Glossary", + "name": "ExampleTerm2", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T2", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287312495, + "updateTime": 1606287312495, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189" + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + }, + { + "guid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18", + "qualifiedName": "ExampleTerm3@Glossary", + "name": "ExampleTerm3", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T3", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287312495, + "updateTime": 1606287312495, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "f4de4878-3e43-4f8b-b090-07a233bb0ce6" + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + ] + } + }, + "title": "Glossary_CreateTerms", + "operationId": "Glossary_CreateTerms" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Delete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Delete.json new file mode 100644 index 000000000000..88b82510fb9f --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryId": "c0c54153-13d1-1608-13af-43457cdffe75" + }, + "responses": { + "204": {} + }, + "title": "Glossary_Delete", + "operationId": "Glossary_Delete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteCategory.json new file mode 100644 index 000000000000..c281cd4c2450 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteCategory.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "categoryId": "0e391355-252a-e5f3-ac18-5a3602df7616" + }, + "responses": { + "204": {} + }, + "title": "Glossary_DeleteCategory", + "operationId": "Glossary_DeleteCategory" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteTerm.json new file mode 100644 index 000000000000..7fa8e97b845a --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteTerm.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termId": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" + }, + "responses": { + "204": {} + }, + "title": "Glossary_DeleteTerm", + "operationId": "Glossary_DeleteTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Get.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Get.json new file mode 100644 index 000000000000..6e1aaeaa5786 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryId": "47029611-67a1-42d5-8766-90eb904f7f22" + }, + "responses": { + "200": { + "body": { + "guid": "47029611-67a1-42d5-8766-90eb904f7f22", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "1", + "language": "en", + "usage": "Example Glossary", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1672892675688, + "updateTime": 1672892675688, + "terms": [ + { + "termGuid": "29d88363-9677-4ce6-aeee-5fdf45f84e9b", + "relationGuid": "fb3d4ac4-27e0-45a2-bb13-105214e0ef7e", + "displayText": "ExampleTerm3" + }, + { + "termGuid": "e5136a91-bc02-49da-81f4-f075bd54b8f5", + "relationGuid": "741186cd-1d62-4798-8e58-6cbe35105baa", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "68347d87-ae38-43b4-a62c-0fdc25b54cb1", + "relationGuid": "2f2b1fe6-d2b6-4aef-81cd-bea7a510312e", + "displayText": "ExampleTerm2" + } + ] + } + } + }, + "title": "Glossary_Get", + "operationId": "Glossary_Get" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetCategory.json new file mode 100644 index 000000000000..1de42a99f57e --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetCategory.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" + }, + "responses": { + "200": { + "body": { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory1", + "lastModifiedTS": "2", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "parentCategory": { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + }, + "childrenCategories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f", + "displayText": "ExampleCategory3" + } + ], + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + } + } + }, + "title": "Glossary_GetCategory", + "operationId": "Glossary_GetCategory" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetDetailed.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetDetailed.json new file mode 100644 index 000000000000..0345a931a976 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetDetailed.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + }, + "responses": { + "200": { + "body": { + "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "language": "en", + "usage": "Example Glossary", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1672892675688, + "updateTime": 1672892675688, + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", + "displayText": "ExampleTerm2" + } + ], + "categories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2" + }, + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d" + } + ], + "termInfo": { + "54688d39-b298-4104-9e80-f2a16f44aaea": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "2", + "abbreviation": "T1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606290587593, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "assignedEntities": [ + { + "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", + "typeName": "hdfs_path", + "entityStatus": "ACTIVE", + "displayText": "1", + "relationshipType": "AtlasGlossarySemanticAssignment", + "relationshipGuid": "cf2e959c-05e6-4a9f-b106-b6475741c2ba", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "AtlasGlossarySemanticAssignment", + "attributes": { + "expression": "Example Expression", + "createdBy": "ExampleCreator", + "steward": "ExampleSteward", + "confidence": 100, + "description": "Example Description", + "source": "Azure", + "status": null + } + } + } + ], + "categories": [ + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007" + } + ], + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + } + ], + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Steward": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Steward Info" + } + ] + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + }, + "952c7ba4-4c89-42d8-a05a-7d2161be7008": { + "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "qualifiedName": "ExampleTerm2@Glossary", + "name": "ExampleTerm2", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T2", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287312495, + "updateTime": 1606287312495, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189" + }, + "seeAlso": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm1" + } + ], + "synonyms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm1" + } + ], + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + }, + "categoryInfo": { + "ed7458f0-9463-48a5-b5c6-4f785fb34e12": { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory1", + "longDescription": "Example Long Description", + "lastModifiedTS": "3", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "parentCategory": { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + }, + "childrenCategories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f" + } + ], + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + }, + "e47c4584-daca-4f9e-9092-194e04692c9a": { + "guid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "qualifiedName": "ExampleCategory2@Glossary", + "name": "ExampleCategory2", + "lastModifiedTS": "1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d" + }, + "childrenCategories": [ + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + } + ] + }, + "0d6766f6-f4b6-435b-bda2-d3edc358998e": { + "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "qualifiedName": "ExampleCategory3.ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory3", + "lastModifiedTS": "2", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2" + }, + "parentCategory": { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f" + } + } + } + } + } + }, + "title": "Glossary_GetDetailed", + "operationId": "Glossary_GetDetailed" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTerm.json new file mode 100644 index 000000000000..3b574ac3e20f --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTerm.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea" + }, + "responses": { + "200": { + "body": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606287247276, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + } + ], + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Steward": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Steward Info" + } + ] + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ], + "assignedEntities": [ + { + "guid": "7e255139-b654-4c8d-a4bd-fbb5a243e83f", + "typeName": "azure_datalake_gen2_path", + "entityStatus": "ACTIVE", + "displayText": "moviesDB.csv", + "relationshipType": "AtlasGlossarySemanticAssignment", + "relationshipGuid": "ace36560-6259-4e7f-9214-3850b2af0a86", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "AtlasGlossarySemanticAssignment", + "attributes": { + "expression": null, + "createdBy": null, + "steward": null, + "confidence": null, + "description": null, + "source": null, + "status": null + } + } + } + ] + } + } + }, + "title": "Glossary_GetTerm", + "operationId": "Glossary_GetTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json new file mode 100644 index 000000000000..3bedbf11a9a4 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "excludeRelationshipTypes": [ + "AtlasGlossarySemanticAssignment" + ] + }, + "responses": { + "200": { + "body": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606287247276, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + } + ], + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Steward": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Steward Info" + } + ] + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + } + }, + "title": "Glossary_GetTermWithoutAssets", + "operationId": "Glossary_GetTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_List.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_List.json new file mode 100644 index 000000000000..c454ce6b68f7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_List.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "limit": "1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "1", + "language": "en", + "usage": "Example Glossary", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1672892675688, + "updateTime": 1672892675688, + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", + "displayText": "ExampleTerm2" + } + ], + "categories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", + "displayText": "ExampleCategory3" + }, + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", + "displayText": "ExampleCategory1" + }, + { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", + "displayText": "ExampleCategory2" + } + ] + } + ] + } + }, + "title": "Glossary_List", + "operationId": "Glossary_List" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategories.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategories.json new file mode 100644 index 000000000000..30e8cf73dbfd --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategories.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory1", + "lastModifiedTS": "2", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "parentCategory": { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + }, + "childrenCategories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f" + } + ], + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + }, + { + "guid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "qualifiedName": "ExampleCategory2@Glossary", + "name": "ExampleCategory2", + "lastModifiedTS": "1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d" + }, + "childrenCategories": [ + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + } + ] + }, + { + "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "qualifiedName": "ExampleCategory3.ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory3", + "lastModifiedTS": "2", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2" + }, + "parentCategory": { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f" + } + } + ] + } + }, + "title": "Glossary_ListCategories", + "operationId": "Glossary_ListCategories" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoriesHeaders.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoriesHeaders.json new file mode 100644 index 000000000000..a04eb3cba127 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoriesHeaders.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", + "displayText": "ExampleCategory1" + }, + { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", + "displayText": "ExampleCategory2" + }, + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", + "displayText": "ExampleCategory3" + } + ] + } + }, + "title": "Glossary_ListCategoriesHeaders", + "operationId": "Glossary_ListCategoriesHeaders" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoryTerms.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoryTerms.json new file mode 100644 index 000000000000..e1a99139221b --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoryTerms.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + } + }, + "title": "Glossary_ListCategoryTerms", + "operationId": "Glossary_ListCategoryTerms" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListEntitiesAssignedWithTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListEntitiesAssignedWithTerm.json new file mode 100644 index 000000000000..99c872e87c99 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListEntitiesAssignedWithTerm.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termId": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "guid": "ea116881-222e-41c8-8acb-9af6f6f60009", + "typeName": "column", + "entityStatus": "ACTIVE", + "displayText": "ExampleColumnName", + "relationshipType": "AtlasGlossarySemanticAssignment", + "relationshipGuid": "ff9023a5-8495-49d6-bf04-a22c3634151e", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "AtlasGlossarySemanticAssignment", + "attributes": { + "expression": null, + "createdBy": null, + "steward": null, + "confidence": null, + "description": null, + "source": null, + "status": null + } + } + }, + { + "guid": "fbf0a84d-7080-456b-b889-b5ba42186c2e", + "typeName": "azure_blob_path", + "entityStatus": "ACTIVE", + "displayText": "exampledata.csv", + "relationshipType": "AtlasGlossarySemanticAssignment", + "relationshipGuid": "dedc1294-a893-4e52-ba27-6be9b8694748", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "AtlasGlossarySemanticAssignment", + "attributes": { + "expression": null, + "createdBy": null, + "steward": null, + "confidence": null, + "description": null, + "source": null, + "status": null + } + } + } + ] + } + }, + "title": "Glossary_ListEntitiesAssignedWithTerm", + "operationId": "Glossary_ListEntitiesAssignedWithTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedCategories.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedCategories.json new file mode 100644 index 000000000000..2e845fcb0944 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedCategories.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": { + "parent": [ + { + "categoryGuid": "6c8233cd-f6dc-6ef7-5597-b18ab590f2fc", + "relationGuid": "25cf5e46-c551-4ed4-8919-505c29ae311d" + } + ], + "children": [ + { + "categoryGuid": "abc6ac1b-5700-9c70-3f5a-60a519150035", + "parentCategoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9", + "relationGuid": "12d41563-2fd9-4be5-9eb9-9908f811a8f2", + "displayText": "ExampleCategory4" + } + ] + } + } + }, + "title": "Glossary_ListRelatedCategories", + "operationId": "Glossary_ListRelatedCategories" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedTerms.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedTerms.json new file mode 100644 index 000000000000..56999a9dd79a --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedTerms.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": { + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + } + ] + } + } + }, + "title": "Glossary_ListRelatedTerms", + "operationId": "Glossary_ListRelatedTerms" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTermHeaders.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTermHeaders.json new file mode 100644 index 000000000000..6bcfbe8c9fc9 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTermHeaders.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", + "displayText": "ExampleTerm2" + } + ] + } + }, + "title": "Glossary_ListTermHeaders", + "operationId": "Glossary_ListTermHeaders" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTerms.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTerms.json new file mode 100644 index 000000000000..583aa635b462 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTerms.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606287247276, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + } + ], + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Steward": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Steward Info" + } + ] + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + }, + { + "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "qualifiedName": "ExampleTerm2@Glossary", + "name": "ExampleTerm2", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T2", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287312495, + "updateTime": 1606287312495, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189" + }, + "seeAlso": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm1" + } + ], + "synonyms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm1" + } + ], + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + ] + } + }, + "title": "Glossary_ListTerms", + "operationId": "Glossary_ListTerms" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json new file mode 100644 index 000000000000..c06db55d9e38 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "body": { + "longDescription": "Example Long Description" + } + }, + "responses": { + "200": { + "body": { + "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "3", + "language": "en", + "usage": "Example Glossary", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1672892675600, + "updateTime": 1672892675688, + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", + "displayText": "ExampleTerm2" + } + ], + "categories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", + "displayText": "ExampleCategory3" + }, + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", + "displayText": "ExampleCategory1" + }, + { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", + "displayText": "ExampleCategory2" + } + ] + } + } + }, + "title": "Glossary_PartialUpdate", + "operationId": "Glossary_PartialUpdate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json new file mode 100644 index 000000000000..15be08095e73 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "categoryId": "3243ea0a-9492-47e1-392e-a84e64980af9", + "body": { + "longDescription": "Example Long Description" + } + }, + "responses": { + "200": { + "body": { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory1", + "longDescription": "Example Long Description", + "lastModifiedTS": "3", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "parentCategory": { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + }, + "childrenCategories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f", + "displayText": "ExampleCategory3" + } + ], + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + } + } + }, + "title": "Glossary_PartialUpdateCategory", + "operationId": "Glossary_PartialUpdateCategory" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json new file mode 100644 index 000000000000..356a70cf4da3 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "body": { + "longDescription": "Example Long Description" + } + }, + "responses": { + "200": { + "body": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Descrition", + "lastModifiedTS": "2", + "abbreviation": "T1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606290587593, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "categories": [ + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleCategory1" + } + ], + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + } + ], + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + } + }, + "title": "Glossary_PartialUpdateTerm", + "operationId": "Glossary_PartialUpdateTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json new file mode 100644 index 000000000000..2238f2443727 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "body": [ + { + "guid": "16feb2a1-2c79-ade1-338d-fb24fcb8b8bd", + "relationshipGuid": "624f08bb-3c93-4f03-9ce1-ed2ce2c7c8d5" + } + ] + }, + "responses": { + "204": {} + }, + "title": "Glossary_RemoveTermAssignmentFromEntities", + "operationId": "Glossary_DeleteTermAssignmentFromEntities" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json new file mode 100644 index 000000000000..faca8b5cb2a2 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "body": { + "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "1", + "language": "en", + "usage": "Example Glossary", + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", + "displayText": "ExampleTerm2" + } + ], + "categories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", + "displayText": "ExampleCategory3" + }, + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", + "displayText": "ExampleCategory1" + }, + { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", + "displayText": "ExampleCategory2" + } + ] + } + }, + "responses": { + "200": { + "body": { + "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "2", + "language": "en", + "usage": "Example Glossary", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1672892675600, + "updateTime": 1672892675688, + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", + "displayText": "ExampleTerm2" + } + ], + "categories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", + "displayText": "ExampleCategory3" + }, + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", + "displayText": "ExampleCategory1" + }, + { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", + "displayText": "ExampleCategory2" + } + ] + } + } + }, + "title": "Glossary_Update", + "operationId": "Glossary_Update" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json new file mode 100644 index 000000000000..7c145590a59b --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "body": { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1@Glossary", + "name": "ExampleCategory1", + "lastModifiedTS": "1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007" + } + ], + "childrenCategories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e" + } + ], + "parentCategory": { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a" + } + } + }, + "responses": { + "200": { + "body": { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1.Category2@Glossary", + "name": "ExampleCategory1", + "lastModifiedTS": "2", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "parentCategory": { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + }, + "childrenCategories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f", + "displayText": "ExampleCategory3" + } + ], + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + } + } + }, + "title": "Glossary_UpdateCategory", + "operationId": "Glossary_UpdateCategory" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json new file mode 100644 index 000000000000..9ed4cb3964b7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "body": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T1", + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ], + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008" + }, + { + "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008" + }, + { + "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18" + } + ] + } + }, + "responses": { + "200": { + "body": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606287247276, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + }, + { + "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18", + "relationGuid": "4d802ada-65f3-45a8-969f-aba47d9c6200", + "displayText": "ExampleTerm3" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + }, + { + "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18", + "relationGuid": "bb26fe7c-6e26-46ad-b936-50a5f7ffbbaf", + "displayText": "ExampleTerm3" + } + ], + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + } + }, + "title": "Glossary_UpdateTerm", + "operationId": "Glossary_UpdateTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_Get.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_Get.json new file mode 100644 index 000000000000..a08de217b1c0 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "a6894eb3-81f3-829b-2adc-52f3e603411a", + "depth": "1", + "width": "5", + "direction": "INPUT" + }, + "responses": { + "200": { + "body": { + "baseEntityGuid": "a6894eb3-81f3-829b-2adc-52f3e603411a", + "lineageDirection": "INPUT", + "lineageDepth": 1, + "lineageWidth": 1, + "childrenCount": 1, + "guidEntityMap": {}, + "widthCounts": {}, + "relations": [], + "parentRelations": [] + } + } + }, + "title": "Lineage_Get", + "operationId": "Lineage_Get" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetByUniqueAttribute.json new file mode 100644 index 000000000000..ab738e50995b --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetByUniqueAttribute.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_blob_path", + "depth": "2", + "width": "2", + "direction": "BOTH", + "attr:qualifiedName": "https://02cab97b-ba87-4675-972d-150b6cb522d3/entity.json/" + }, + "responses": { + "200": { + "body": { + "baseEntityGuid": "9b2751f1-2633-4f06-a578-e14fab4c52fd", + "lineageDirection": "BOTH", + "lineageDepth": 2, + "lineageWidth": 2, + "childrenCount": -1, + "guidEntityMap": { + "9b2751f1-2633-4f06-a578-e14fab4c52fd": { + "typeName": "azure_blob_path", + "attributes": { + "owner": "testOwner", + "modifiedTime": 0, + "qualifiedName": "https://02cab97b-ba87-4675-972d-150b6cb522d3/entity.json/", + "isBlob": false, + "accessTierInferred": false, + "description": "testDesc", + "committedBlockCount": 0, + "path": "/test/AzureBlobPath.json", + "size": 731, + "createTime": 0, + "name": "populate_azure_blob_path_02cab97b-ba87-4675-972d-150b6cb522d3", + "blobType": "BlockBlob", + "serverEncrypted": true + }, + "lastModifiedTS": "1", + "guid": "9b2751f1-2633-4f06-a578-e14fab4c52fd", + "status": "ACTIVE", + "displayText": "populate_azure_blob_path_02cab97b-ba87-4675-972d-150b6cb522d3", + "classificationNames": [ + "MICROSOFT.PERSONAL.EMAIL", + "MICROSOFT.PERSONAL.NAME" + ], + "meaningNames": [], + "meanings": [], + "isIncomplete": false, + "labels": [] + } + }, + "relations": [], + "parentRelations": [], + "widthCounts": { + "INPUT": { + "9b2751f1-2633-4f06-a578-e14fab4c52fd": 0 + }, + "OUTPUT": { + "9b2751f1-2633-4f06-a578-e14fab4c52fd": 0 + } + } + } + } + }, + "title": "Lineage_GetByUniqueAttribute", + "operationId": "Lineage_GetByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetNextPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetNextPage.json new file mode 100644 index 000000000000..778a391f5b59 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetNextPage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "a6894eb3-81f3-829b-2adc-52f3e603411a", + "offset": "0", + "limit": "5", + "direction": "INPUT", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "baseEntityGuid": "a6894eb3-81f3-829b-2adc-52f3e603411a", + "lineageDirection": "INPUT", + "lineageDepth": 1, + "lineageWidth": 1, + "childrenCount": 1, + "guidEntityMap": {}, + "widthCounts": {}, + "relations": [], + "parentRelations": [] + } + } + }, + "title": "Lineage_GetNextPage", + "operationId": "Lineage_GetNextPage" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Create.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Create.json new file mode 100644 index 000000000000..89d3b4e5afec --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Create.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "typeName": "AtlasGlossarySynonym", + "attributes": { + "expression": "Example Expression", + "steward": "Example Steward", + "description": "Example Description", + "source": null, + "status": null + }, + "end1": { + "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6", + "typeName": "AtlasGlossaryTerm" + }, + "end2": { + "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa", + "typeName": "AtlasGlossaryTerm" + }, + "label": "r:AtlasGlossarySynonym", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "version": 0 + } + }, + "responses": { + "200": { + "body": { + "typeName": "AtlasGlossarySynonym", + "attributes": { + "expression": "Example Expression", + "steward": "Example Steward", + "description": "Example Description", + "source": null, + "status": null + }, + "guid": "63023d5b-c499-4360-a513-16bcbf73b039", + "end1": { + "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6", + "typeName": "AtlasGlossaryTerm" + }, + "end2": { + "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa", + "typeName": "AtlasGlossaryTerm" + }, + "label": "r:AtlasGlossarySynonym", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553840134724, + "updateTime": 1553840134724, + "version": 0 + } + } + }, + "title": "Relationship_Create", + "operationId": "Relationship_Create" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Delete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Delete.json new file mode 100644 index 000000000000..c6e4848b9952 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb" + }, + "responses": { + "204": {} + }, + "title": "Relationship_Delete", + "operationId": "Relationship_Delete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Get.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Get.json new file mode 100644 index 000000000000..182684f354bd --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", + "extendedInfo": "false" + }, + "responses": { + "200": { + "body": { + "relationship": { + "typeName": "AtlasGlossarySynonym", + "attributes": { + "expression": null, + "steward": null, + "description": null, + "source": null, + "status": null + }, + "guid": "de23cd5a-021c-413d-98a5-98752a1f7a3b", + "end1": { + "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6", + "typeName": "AtlasGlossaryTerm" + }, + "end2": { + "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef", + "typeName": "AtlasGlossaryTerm" + }, + "label": "r:AtlasGlossarySynonym", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553838993803, + "updateTime": 1553838993803, + "version": 0 + } + } + } + }, + "title": "Relationship_Get", + "operationId": "Relationship_Get" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Update.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Update.json new file mode 100644 index 000000000000..0cd955fe3154 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Update.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "typeName": "AtlasGlossarySynonym", + "attributes": { + "expression": "Example Expression", + "steward": "Example Steward", + "description": "Example Description", + "source": null, + "status": null + }, + "guid": "b2810301-293f-493f-88f1-7ac8784fb1fd", + "end1": { + "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa", + "typeName": "AtlasGlossaryTerm" + }, + "end2": { + "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef", + "typeName": "AtlasGlossaryTerm" + }, + "label": "r:AtlasGlossarySynonym", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "version": 0 + } + }, + "responses": { + "200": { + "body": { + "typeName": "AtlasGlossarySynonym", + "attributes": { + "expression": "Example Expression", + "steward": "Example Steward", + "description": "Example Description", + "source": null, + "status": null + }, + "guid": "b2810301-293f-493f-88f1-7ac8784fb1fd", + "end1": { + "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa", + "typeName": "AtlasGlossaryTerm" + }, + "end2": { + "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef", + "typeName": "AtlasGlossaryTerm" + }, + "label": "r:AtlasGlossarySynonym", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553839805039, + "updateTime": 1553839805039, + "version": 0 + } + } + }, + "title": "Relationship_Update", + "operationId": "Relationship_Update" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreate.json new file mode 100644 index 000000000000..d91723b6e888 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [ + { + "name": "azure_sql_server_example", + "superTypes": [ + "azure_resource" + ], + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "databases", + "typeName": "array", + "cardinality": "SET", + "isIndexable": false, + "isOptional": true, + "isUnique": false + } + ] + } + ], + "relationshipDefs": [] + } + }, + "responses": { + "200": { + "body": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [ + { + "category": "ENTITY", + "guid": "a47fd902-a564-45f1-aa51-ce9224955881", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553672211954, + "updateTime": 1553672211954, + "version": 1, + "name": "azure_sql_server_example", + "description": "azure_sql_server_example", + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "databases", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": 0, + "valuesMaxCount": 2147483647, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ], + "superTypes": [ + "azure_resource" + ], + "subTypes": [] + } + ], + "relationshipDefs": [] + } + } + }, + "title": "Type_BulkCreate", + "operationId": "Type_BulkCreate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json new file mode 100644 index 000000000000..433ff8867948 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [], + "relationshipDefs": [], + "businessMetadataDefs": [ + { + "name": "myBizMetadata1", + "description": "", + "attributeDefs": [ + { + "name": "bizAttr1", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "isUnique": false, + "isIndexable": true, + "options": { + "maxStrLength": "50", + "applicableEntityTypes": "[\"Path\"]" + } + } + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [], + "relationshipDefs": [], + "businessMetadataDefs": [ + { + "category": "BUSINESS_METADATA", + "guid": "f26dc6d1-be9c-a0ce-a274-b6388ff6e2eb", + "createdBy": "ServiceAdmin", + "updatedBy": "ServiceAdmin", + "createTime": 1646994112241, + "updateTime": 1646994112241, + "version": 1, + "name": "myBizMetadata1", + "description": "This is my businessMetadata1", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "bizAttr1", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": true, + "includeInNotification": false, + "options": { + "applicableEntityTypes": "[\"Path\"]", + "maxStrLength": "50" + } + } + ] + } + ] + } + } + }, + "title": "Type_BulkCreateBusinessMetadataDefs", + "operationId": "Type_BulkCreate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkDelete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkDelete.json new file mode 100644 index 000000000000..60ba8acc3b75 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkDelete.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [ + { + "name": "azure_sql_server_example", + "superTypes": [ + "azure_resource" + ], + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "databases", + "typeName": "array", + "cardinality": "SET", + "isIndexable": false, + "isOptional": true, + "isUnique": false + } + ] + } + ], + "relationshipDefs": [] + } + }, + "responses": { + "204": {} + }, + "title": "Type_BulkDelete", + "operationId": "Type_BulkDelete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkUpdate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkUpdate.json new file mode 100644 index 000000000000..7905abbea1af --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkUpdate.json @@ -0,0 +1,290 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [ + { + "name": "azure_sql_server", + "superTypes": [ + "azure_resource" + ], + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "databases", + "typeName": "array", + "cardinality": "SET", + "isIndexable": false, + "isOptional": true, + "isUnique": false + } + ] + }, + { + "name": "azure_sql_db", + "superTypes": [ + "azure_resource" + ], + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "server", + "typeName": "azure_sql_server", + "cardinality": "SINGLE", + "constraints": [ + { + "type": "inverseRef", + "params": { + "attribute": "databases" + } + } + ], + "isIndexable": false, + "isOptional": false, + "isUnique": false + }, + { + "name": "schemas", + "typeName": "array", + "cardinality": "SET", + "isIndexable": false, + "isOptional": true, + "isUnique": false + }, + { + "name": "collation", + "typeName": "string", + "cardinality": "SINGLE", + "isIndexable": false, + "isOptional": true, + "isUnique": false + }, + { + "name": "compatibilityLevel", + "typeName": "int", + "cardinality": "SINGLE", + "isIndexable": false, + "isOptional": true, + "isUnique": false + } + ] + } + ], + "relationshipDefs": [ + { + "name": "azure_sql_server_databases", + "typeVersion": "1.0", + "relationshipCategory": "COMPOSITION", + "endDef1": { + "type": "azure_sql_server", + "name": "databases", + "isContainer": true, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "azure_sql_db", + "name": "server", + "isContainer": false, + "cardinality": "SINGLE", + "isLegacyAttribute": true + } + }, + { + "name": "azure_sql_db_schemas", + "typeVersion": "1.0", + "relationshipCategory": "COMPOSITION", + "endDef1": { + "type": "azure_sql_db", + "name": "schemas", + "isContainer": true, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "azure_sql_schema", + "name": "db", + "isContainer": false, + "cardinality": "SINGLE", + "isLegacyAttribute": true + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [ + { + "category": "ENTITY", + "guid": "a59fe369-2b1d-4bba-bb74-c273f3d74eb1", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1548841689501, + "updateTime": 1553671448662, + "version": 3, + "name": "azure_sql_server", + "description": "azure_sql_server", + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "databases", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": 0, + "valuesMaxCount": 2147483647, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ], + "superTypes": [ + "azure_resource" + ], + "subTypes": [] + }, + { + "category": "ENTITY", + "guid": "cc33ec5a-205a-4853-91dd-c0ebd0049ffb", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1548841689575, + "updateTime": 1553671448783, + "version": 3, + "name": "azure_sql_db", + "description": "azure_sql_db", + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "server", + "typeName": "azure_sql_server", + "isOptional": false, + "cardinality": "SINGLE", + "valuesMinCount": 1, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "constraints": [ + { + "type": "inverseRef", + "params": { + "attribute": "databases" + } + } + ] + }, + { + "name": "schemas", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": 0, + "valuesMaxCount": 2147483647, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "collation", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "compatibilityLevel", + "typeName": "int", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ], + "superTypes": [ + "azure_resource" + ], + "subTypes": [] + } + ], + "relationshipDefs": [ + { + "category": "RELATIONSHIP", + "guid": "1e0584a8-2587-4e1d-a772-db1e879469af", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1548841689879, + "updateTime": 1553671449536, + "version": 3, + "name": "azure_sql_server_databases", + "description": "azure_sql_server_databases", + "typeVersion": "1.0", + "attributeDefs": [], + "relationshipCategory": "COMPOSITION", + "endDef1": { + "type": "azure_sql_server", + "name": "databases", + "isContainer": true, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "azure_sql_db", + "name": "server", + "isContainer": false, + "cardinality": "SINGLE", + "isLegacyAttribute": true + }, + "relationshipLabel": "r:azure_sql_server_databases" + }, + { + "category": "RELATIONSHIP", + "guid": "77ee34f6-ea48-4fe3-86bf-7e2e722f4596", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1548841690094, + "updateTime": 1553671449545, + "version": 3, + "name": "azure_sql_db_schemas", + "description": "azure_sql_db_schemas", + "typeVersion": "1.0", + "attributeDefs": [], + "relationshipCategory": "COMPOSITION", + "endDef1": { + "type": "azure_sql_db", + "name": "schemas", + "isContainer": true, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "azure_sql_schema", + "name": "db", + "isContainer": false, + "cardinality": "SINGLE", + "isLegacyAttribute": true + }, + "relationshipLabel": "r:azure_sql_db_schemas" + } + ] + } + } + }, + "title": "Type_BulkUpdate", + "operationId": "Type_BulkUpdate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_Delete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_Delete.json new file mode 100644 index 000000000000..8a364027401e --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "hive_order" + }, + "responses": { + "204": {} + }, + "title": "Type_Delete", + "operationId": "Type_Delete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByGuid.json new file mode 100644 index 000000000000..34921a8239b7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByGuid.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "d8757510-c866-61ba-486f-1afca09f43b8" + }, + "responses": { + "200": { + "body": { + "category": "BUSINESS_METADATA", + "guid": "d8757510-c866-61ba-486f-1afca09f43b8", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1671545620780, + "updateTime": 1671545620780, + "version": 1, + "name": "Business_Metadata_Type_Name", + "description": "Business_Metadata_Type_Name", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "customAttribute", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "maxStrLength": "5000", + "isDisabled": "false", + "applicableEntityTypes": "[\"DataSet\"]" + } + } + ] + } + } + }, + "title": "Type_GetBusinessMetadataDefByGuid", + "operationId": "Type_GetBusinessMetadataDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByName.json new file mode 100644 index 000000000000..64d92fefd723 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByName.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "Business_Metadata_Type_Name" + }, + "responses": { + "200": { + "body": { + "category": "BUSINESS_METADATA", + "guid": "d8757510-c866-61ba-486f-1afca09f43b8", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1671545620780, + "updateTime": 1671545620780, + "version": 1, + "name": "Business_Metadata_Type_Name", + "description": "Business_Metadata_Type_Name", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "customAttribute", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "maxStrLength": "5000", + "isDisabled": "false", + "applicableEntityTypes": "[\"DataSet\"]" + } + } + ] + } + } + }, + "title": "Type_GetBusinessMetadataDefByName", + "operationId": "Type_GetBusinessMetadataDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByGuid.json new file mode 100644 index 000000000000..e94b5ad8b518 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByGuid.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941" + }, + "responses": { + "200": { + "body": { + "category": "ENUM", + "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604728877305, + "updateTime": 1604728877305, + "version": 1, + "name": "glossary_term_status_value", + "description": "glossary_term_status_value", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "elementDefs": [ + { + "value": "Approved", + "ordinal": 0 + }, + { + "value": "Alert", + "ordinal": 1 + }, + { + "value": "Expired", + "ordinal": 2 + }, + { + "value": "Draft", + "ordinal": 3 + } + ] + } + } + }, + "title": "Type_GetByGuid", + "operationId": "Type_GetByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByName.json new file mode 100644 index 000000000000..804029d070e1 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByName.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "glossary_term_status_value" + }, + "responses": { + "200": { + "body": { + "category": "ENUM", + "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604728877305, + "updateTime": 1604728877305, + "version": 1, + "name": "glossary_term_status_value", + "description": "glossary_term_status_value", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "elementDefs": [ + { + "value": "Approved", + "ordinal": 0 + }, + { + "value": "Alert", + "ordinal": 1 + }, + { + "value": "Expired", + "ordinal": 2 + }, + { + "value": "Draft", + "ordinal": 3 + } + ] + } + } + }, + "title": "Type_GetByName", + "operationId": "Type_GetByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByGuid.json new file mode 100644 index 000000000000..bf27840af6aa --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByGuid.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "e79878fa-adba-4ee5-adc5-328d8841cd49" + }, + "responses": { + "200": { + "body": { + "category": "CLASSIFICATION", + "guid": "e79878fa-adba-4ee5-adc5-328d8841cd49", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065966043, + "updateTime": 1553065966043, + "version": 1, + "name": "MICROSOFT.GOVERNMENT.CANADA.SOCIAL_INSURANCE_NUMBER", + "description": "Canada Social Insurance Number", + "typeVersion": "1.0", + "attributeDefs": [], + "superTypes": [], + "entityTypes": [], + "subTypes": [] + } + } + }, + "title": "Type_GetClassificationDefByGuid", + "operationId": "Type_GetClassificationDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByName.json new file mode 100644 index 000000000000..e7a58bf32bfb --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByName.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "MICROSOFT.GOVERNMENT.CANADA.SOCIAL_INSURANCE_NUMBER" + }, + "responses": { + "200": { + "body": { + "category": "CLASSIFICATION", + "guid": "e79878fa-adba-4ee5-adc5-328d8841cd49", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065966043, + "updateTime": 1553065966043, + "version": 1, + "name": "MICROSOFT.GOVERNMENT.CANADA.SOCIAL_INSURANCE_NUMBER", + "description": "Canada Social Insurance Number", + "typeVersion": "1.0", + "attributeDefs": [], + "superTypes": [], + "entityTypes": [], + "subTypes": [] + } + } + }, + "title": "Type_GetClassificationDefByName", + "operationId": "Type_GetClassificationDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByGuid.json new file mode 100644 index 000000000000..9c0d6ce53cb7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByGuid.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "4bc54c37-98a8-4de8-9ee8-182610859d43" + }, + "responses": { + "200": { + "body": { + "category": "ENTITY", + "guid": "4bc54c37-98a8-4de8-9ee8-182610859d43", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065960959, + "updateTime": 1553065960959, + "version": 1, + "name": "DataSet", + "description": "DataSet", + "typeVersion": "1.1", + "attributeDefs": [], + "superTypes": [ + "Asset" + ], + "subTypes": [ + "rdbms_foreign_key", + "azure_datalake_gen1_path", + "hive_table", + "mssql_column", + "sqoop_dbdatastore", + "hbase_column", + "azure_sql_table", + "rdbms_instance", + "azure_datalake_gen2_path", + "jms_topic", + "falcon_feed", + "hbase_table", + "rdbms_table", + "rdbms_column", + "hbase_column_family", + "hive_column", + "azure_blob_container", + "rdbms_db", + "column", + "azure_blob_path", + "kafka_topic", + "tabular_schema", + "azure_datalake_gen2_filesystem", + "rdbms_index", + "azure_sql_column", + "mssql_table", + "avro_type", + "fs_path" + ] + } + } + }, + "title": "Type_GetEntityDefByGuid", + "operationId": "Type_GetEntityDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByName.json new file mode 100644 index 000000000000..140ba1a5b309 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByName.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "DataSet" + }, + "responses": { + "200": { + "body": { + "category": "ENTITY", + "guid": "4bc54c37-98a8-4de8-9ee8-182610859d43", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065960959, + "updateTime": 1553065960959, + "version": 1, + "name": "DataSet", + "description": "DataSet", + "typeVersion": "1.1", + "attributeDefs": [], + "superTypes": [ + "Asset" + ], + "subTypes": [ + "rdbms_foreign_key", + "azure_datalake_gen1_path", + "hive_table", + "mssql_column", + "sqoop_dbdatastore", + "hbase_column", + "azure_sql_table", + "rdbms_instance", + "azure_datalake_gen2_path", + "jms_topic", + "falcon_feed", + "hbase_table", + "rdbms_table", + "rdbms_column", + "hbase_column_family", + "hive_column", + "azure_blob_container", + "rdbms_db", + "column", + "azure_blob_path", + "kafka_topic", + "tabular_schema", + "azure_datalake_gen2_filesystem", + "rdbms_index", + "azure_sql_column", + "mssql_table", + "avro_type", + "fs_path" + ] + } + } + }, + "title": "Type_GetEntityDefByName", + "operationId": "Type_GetEntityDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByGuid.json new file mode 100644 index 000000000000..ab9e4048b0d2 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByGuid.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0" + }, + "responses": { + "200": { + "body": { + "category": "ENUM", + "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065968102, + "updateTime": 1553065968102, + "version": 1, + "name": "hive_principal_type", + "description": "hive_principal_type", + "typeVersion": "1.0", + "elementDefs": [ + { + "value": "USER", + "ordinal": 1 + }, + { + "value": "ROLE", + "ordinal": 2 + }, + { + "value": "GROUP", + "ordinal": 3 + } + ] + } + } + }, + "title": "Type_GetEnumDefByGuid", + "operationId": "Type_GetEnumDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByName.json new file mode 100644 index 000000000000..62907f8f6a69 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByName.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "hive_principal_type" + }, + "responses": { + "200": { + "body": { + "category": "ENUM", + "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065968102, + "updateTime": 1553065968102, + "version": 1, + "name": "hive_principal_type", + "description": "hive_principal_type", + "typeVersion": "1.0", + "elementDefs": [ + { + "value": "USER", + "ordinal": 1 + }, + { + "value": "ROLE", + "ordinal": 2 + }, + { + "value": "GROUP", + "ordinal": 3 + } + ] + } + } + }, + "title": "Type_GetEnumDefByName", + "operationId": "Type_GetEnumDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByGuid.json new file mode 100644 index 000000000000..71c9a03a65d9 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByGuid.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "695edde1-2782-4a3c-841b-0b3aba25fe45" + }, + "responses": { + "200": { + "body": { + "category": "RELATIONSHIP", + "guid": "695edde1-2782-4a3c-841b-0b3aba25fe45", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065976797, + "updateTime": 1553065976797, + "version": 1, + "name": "storm_topology_nodes", + "description": "storm_topology_nodes", + "typeVersion": "1.0", + "attributeDefs": [], + "relationshipCategory": "ASSOCIATION", + "endDef1": { + "type": "storm_topology", + "name": "nodes", + "isContainer": false, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "storm_node", + "name": "topolgies", + "isContainer": false, + "cardinality": "SET", + "isLegacyAttribute": false + }, + "relationshipLabel": "r:storm_topology_nodes" + } + } + }, + "title": "Type_GetRelationshipDefByGuid", + "operationId": "Type_GetRelationshipDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByName.json new file mode 100644 index 000000000000..ecdafc07a934 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByName.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "storm_topology_nodes" + }, + "responses": { + "200": { + "body": { + "category": "RELATIONSHIP", + "guid": "695edde1-2782-4a3c-841b-0b3aba25fe45", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065976797, + "updateTime": 1553065976797, + "version": 1, + "name": "storm_topology_nodes", + "description": "storm_topology_nodes", + "typeVersion": "1.0", + "attributeDefs": [], + "relationshipCategory": "ASSOCIATION", + "endDef1": { + "type": "storm_topology", + "name": "nodes", + "isContainer": false, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "storm_node", + "name": "topolgies", + "isContainer": false, + "cardinality": "SET", + "isLegacyAttribute": false + }, + "relationshipLabel": "r:storm_topology_nodes" + } + } + }, + "title": "Type_GetRelationshipDefByName", + "operationId": "Type_GetRelationshipDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByGuid.json new file mode 100644 index 000000000000..c31ae06aeeb6 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByGuid.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "f1571b6e-ad08-4040-a9a7-c30ed935d437" + }, + "responses": { + "200": { + "body": { + "category": "STRUCT", + "guid": "f1571b6e-ad08-4040-a9a7-c30ed935d437", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065968145, + "updateTime": 1553065968145, + "version": 1, + "name": "hive_order", + "description": "hive_order", + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "order", + "typeName": "int", + "isOptional": false, + "cardinality": "SINGLE", + "valuesMinCount": 1, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "col", + "typeName": "string", + "isOptional": false, + "cardinality": "SINGLE", + "valuesMinCount": 1, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ] + } + } + }, + "title": "Type_GetStructDefByGuid", + "operationId": "Type_GetStructDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByName.json new file mode 100644 index 000000000000..26f8e843a6d6 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByName.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "hive_order" + }, + "responses": { + "200": { + "body": { + "category": "STRUCT", + "guid": "f1571b6e-ad08-4040-a9a7-c30ed935d437", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065968145, + "updateTime": 1553065968145, + "version": 1, + "name": "hive_order", + "description": "hive_order", + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "order", + "typeName": "int", + "isOptional": false, + "cardinality": "SINGLE", + "valuesMinCount": 1, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "col", + "typeName": "string", + "isOptional": false, + "cardinality": "SINGLE", + "valuesMinCount": 1, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ] + } + } + }, + "title": "Type_GetStructDefByName", + "operationId": "Type_GetStructDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByGuid.json new file mode 100644 index 000000000000..e6c263c691e5 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByGuid.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "d776af9c-985c-4168-abb2-477523dbfc70", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "category": "TERM_TEMPLATE", + "guid": "d776af9c-985c-4168-abb2-477523dbfc70", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1606300465443, + "updateTime": 1606300465443, + "version": 1, + "name": "MS KPI", + "description": "This is the description", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "date", + "typeName": "date", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "single choice", + "typeName": "TERM_TEMPLATE_ENUM_EXAMPLE_1", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "multi choice", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": 0, + "valuesMaxCount": 2147483647, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "plain string", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "defaultValue": "this is a default value", + "options": { + "isDisabled": "false" + } + } + ] + } + } + }, + "title": "Type_GetTermTemplateDefByGuid", + "operationId": "Type_GetTermTemplateDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByName.json new file mode 100644 index 000000000000..d8b28d19db05 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByName.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "MS KPI", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "category": "TERM_TEMPLATE", + "guid": "d776af9c-985c-4168-abb2-477523dbfc70", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1606300465443, + "updateTime": 1606300465443, + "version": 1, + "name": "MS KPI", + "description": "This is the description", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "date", + "typeName": "date", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "single choice", + "typeName": "TERM_TEMPLATE_ENUM_EXAMPLE_1", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "multi choice", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": 0, + "valuesMaxCount": 2147483647, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "plain string", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "defaultValue": "this is a default value", + "options": { + "isDisabled": "false" + } + } + ] + } + } + }, + "title": "Type_GetTermTemplateDefByName", + "operationId": "Type_GetTermTemplateDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_List.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_List.json new file mode 100644 index 000000000000..1dd18ffe0898 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_List.json @@ -0,0 +1,272 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "includeTermTemplate": true, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "enumDefs": [ + { + "category": "ENUM", + "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604728877305, + "updateTime": 1604728877305, + "version": 1, + "name": "glossary_term_status_value", + "description": "glossary_term_status_value", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "elementDefs": [ + { + "value": "Approved", + "ordinal": 0 + }, + { + "value": "Alert", + "ordinal": 1 + }, + { + "value": "Expired", + "ordinal": 2 + }, + { + "value": "Draft", + "ordinal": 3 + } + ] + } + ], + "structDefs": [ + { + "category": "STRUCT", + "guid": "a8892bd7-59d6-47d8-b80d-ba4c7631098f", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604729507664, + "updateTime": 1604729507664, + "version": 1, + "name": "blob_soft_deleted_state", + "description": "blob_soft_deleted_state", + "typeVersion": "1.0", + "serviceType": "Azure Blob Storage", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "deleted", + "typeName": "boolean", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "deletedTime", + "typeName": "date", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "remainingRetentionDays", + "typeName": "long", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ] + } + ], + "classificationDefs": [ + { + "category": "CLASSIFICATION", + "guid": "bd97460e-e5db-4701-8158-5b4062cf8a10", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604730971448, + "updateTime": 1604730971448, + "version": 1, + "name": "MICROSOFT.GOVERNMENT.CHILE.CDI_NUMBER", + "description": "Chile Identity Card Number", + "typeVersion": "1.0", + "options": { + "displayName": "Chile Identity Card Number" + }, + "attributeDefs": [], + "superTypes": [], + "entityTypes": [], + "subTypes": [] + } + ], + "entityDefs": [ + { + "category": "ENTITY", + "guid": "7c53da5d-2797-4e8a-9b89-dd9b3b26ffa8", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604730605047, + "updateTime": 1604730605047, + "version": 1, + "name": "sap_ecc_data_element", + "description": "sap_ecc_data_element", + "typeVersion": "1.0", + "serviceType": "SAP ECC", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "dataType", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "length", + "typeName": "int", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "decimalPlaces", + "typeName": "int", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "documentation", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ], + "superTypes": [ + "Asset" + ], + "subTypes": [], + "relationshipAttributeDefs": [ + { + "name": "package", + "typeName": "sap_ecc_package", + "isOptional": false, + "cardinality": "SINGLE", + "valuesMinCount": -1, + "valuesMaxCount": -1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "relationshipTypeName": "sap_ecc_package_data_elements", + "isLegacyAttribute": false + }, + { + "name": "table_fields", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": -1, + "valuesMaxCount": -1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "relationshipTypeName": "sap_ecc_table_field_data_element", + "isLegacyAttribute": false + }, + { + "name": "domain", + "typeName": "sap_ecc_domain", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": -1, + "valuesMaxCount": -1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "relationshipTypeName": "sap_ecc_data_element_domain", + "isLegacyAttribute": false + }, + { + "name": "meanings", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": -1, + "valuesMaxCount": -1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "relationshipTypeName": "AtlasGlossarySemanticAssignment", + "isLegacyAttribute": false + } + ] + } + ], + "relationshipDefs": [ + { + "category": "RELATIONSHIP", + "guid": "6284b865-cbb3-4236-83ed-059a407f06fb", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604729078159, + "updateTime": 1604729323080, + "version": 2, + "name": "storm_topology_nodes", + "description": "storm_topology_nodes", + "typeVersion": "1.1", + "serviceType": "storm", + "lastModifiedTS": "2", + "attributeDefs": [], + "relationshipCategory": "ASSOCIATION", + "endDef1": { + "type": "storm_topology", + "name": "nodes", + "isContainer": false, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "storm_node", + "name": "topolgies", + "isContainer": false, + "cardinality": "SET", + "isLegacyAttribute": false + } + } + ] + } + } + }, + "title": "Type_List", + "operationId": "Type_List" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json new file mode 100644 index 000000000000..99b6f55910b0 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "type": "ENUM", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "enumDefs": [ + { + "category": "ENUM", + "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604728877305, + "updateTime": 1604728877305, + "version": 1, + "name": "glossary_term_status_value", + "description": "glossary_term_status_value", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "elementDefs": [ + { + "value": "Approved", + "ordinal": 0 + }, + { + "value": "Alert", + "ordinal": 1 + }, + { + "value": "Expired", + "ordinal": 2 + }, + { + "value": "Draft", + "ordinal": 3 + } + ] + }, + { + "category": "ENUM", + "guid": "c694edf1-6f9e-4b60-b832-23e8d6187675", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604728832692, + "updateTime": 1604728905525, + "version": 2, + "name": "AtlasGlossaryTermRelationshipStatus", + "description": "TermRelationshipStatus defines how reliable the relationship is between two glossary terms", + "typeVersion": "1.1", + "serviceType": "atlas_core", + "lastModifiedTS": "2", + "elementDefs": [ + { + "value": "DRAFT", + "description": "DRAFT means the relationship is under development.", + "ordinal": 0 + }, + { + "value": "ACTIVE", + "description": "ACTIVE means the relationship is validated and in use.", + "ordinal": 1 + }, + { + "value": "DEPRECATED", + "description": "DEPRECATED means the the relationship is being phased out.", + "ordinal": 2 + }, + { + "value": "OBSOLETE", + "description": "OBSOLETE means that the relationship should not be used anymore.", + "ordinal": 3 + }, + { + "value": "OTHER", + "description": "OTHER means that there is another status.", + "ordinal": 99 + } + ] + } + ], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [], + "relationshipDefs": [] + } + } + }, + "title": "Type_ListEnumDefs", + "operationId": "Type_List" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListHeaders.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListHeaders.json new file mode 100644 index 000000000000..288c815d8a88 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListHeaders.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "includeTermTemplate": true + }, + "responses": { + "200": { + "body": [ + { + "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0", + "name": "hive_principal_type", + "category": "ENUM" + }, + { + "guid": "e5030e81-da05-4571-84f1-265ce20fa6d9", + "name": "AtlasGlossaryTermRelationshipStatus", + "category": "ENUM" + }, + { + "guid": "d776af9c-985c-4168-abb2-477523dbfc70", + "name": "MS KPI", + "category": "TERM_TEMPLATE" + } + ] + } + }, + "title": "Type_ListHeaders", + "operationId": "Type_ListHeaders" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json new file mode 100644 index 000000000000..c5336e63031c --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "type": "TERM_TEMPLATE", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [], + "relationshipDefs": [], + "termTemplateDefs": [ + { + "category": "TERM_TEMPLATE", + "guid": "d776af9c-985c-4168-abb2-477523dbfc70", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1606300465443, + "updateTime": 1606300465443, + "version": 1, + "name": "MS KPI", + "description": "This is the description", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "date", + "typeName": "date", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "single choice", + "typeName": "TERM_TEMPLATE_ENUM_EXAMPLE_1", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "multi choice", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": 0, + "valuesMaxCount": 2147483647, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "plain string", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "defaultValue": "this is a default value", + "options": { + "isDisabled": "false" + } + } + ] + } + ] + } + } + }, + "title": "Type_ListTermTemplateDefs", + "operationId": "Type_List" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp new file mode 100644 index 000000000000..67657574ea86 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -0,0 +1,42 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "./routes.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +@service({ + title: "Azure Analytics Purview Data Map", +}) +@server( + "{endpoint}/datamap/api", + "Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Map helps organizations get more value from their existing investments.", + { + endpoint: string, + } +) +@doc(""" +Purview Data Map Service is a fully managed cloud service whose users can +discover the data sources they need and understand the data sources they find. +At the same time, Data Map helps organizations get more value from their +existing investments. This spec defines REST API of Purview Data Map Service. +""") +@useAuth(AuthToken) +@versioned(ApiVersions) +namespace PurviewDataMap; + +@doc("Service API versions") +enum ApiVersions { + @doc("2023-09-01 service API version") + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2023_09_01: "2023-09-01", +} + +alias AuthToken = OAuth2Auth<[ + { + type: OAuth2FlowType.implicit; + authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize"; + scopes: ["https://purview.azure.net/.default"]; + } +]>; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp new file mode 100644 index 000000000000..30de3c98afe2 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -0,0 +1,1949 @@ +import "@typespec/http"; +import "@typespec/rest"; + +using TypeSpec.Rest; +using TypeSpec.Http; + +namespace PurviewDataMap; + +@doc("Enum for business attribute update behavior") +enum BusinessAttributeUpdateBehavior { + @doc("Ignore the business attribute payload for update.") + Ignore: "ignore", + + @doc("Replace all the business attributes using the payload.") + Replace: "replace", + + @doc("Merge the business attributes. Business attributes will not be updated if not provided.") + Merge: "merge", +} + +@doc("Status - can be active or deleted") +enum EntityStatus { + @doc("The status is active.") + Active: "ACTIVE", + + @doc("The status is deleted.") + Deleted: "DELETED", +} + +@doc("Status for term assignment") +enum AtlasTermAssignmentStatus { + @doc("The status is discovered.") + Discovered: "DISCOVERED", + + @doc("The status is proposed.") + Proposed: "PROPOSED", + + @doc("The status is imported.") + Imported: "IMPORTED", + + @doc("The status is validated.") + Validated: "VALIDATED", + + @doc("The status is deprecated.") + Deprecated: "DEPRECATED", + + @doc("The status is obsolete.") + Obsolete: "OBSOLETE", + + @doc("Other status.") + Other: "OTHER", +} + +@doc("Type for sorting") +enum SortType { + @doc("No sorting order") + None: "NONE", + + @doc("Use ascending order for sorting") + Ascend: "ASC", + + @doc("Use descending order for sorting") + Descend: "DESC", +} + +@doc("Status for import") +enum ImportStatus { + @doc("Success") + Success: "SUCCESS", + + @doc("Failed") + Failed: "FAILED", +} + +@doc("Status for atlas term relationship") +enum AtlasTermRelationshipStatus { + @doc("draft") + Draft: "DRAFT", + + @doc("active") + Active: "ACTIVE", + + @doc("deprecated") + Deprecated: "DEPRECATED", + + @doc("obsolete") + Obsolete: "OBSOLETE", + + @doc("other") + Other: "OTHER", +} + +@doc("Status for term") +enum TermStatus { + @doc("draft") + Draft, + + @doc("approved") + Approved, + + @doc("alert") + Alert, + + @doc("expired") + Expired, +} + +@doc("Status for atlas relationship") +enum StatusAtlasRelationship { + @doc("active") + Active: "ACTIVE", + + @doc("deleted") + Deleted: "DELETED", +} + +@doc("Lineage direction") +enum LineageDirection { + @doc("input") + Input: "INPUT", + + @doc("output") + Output: "OUTPUT", + + @doc("both") + Both: "BOTH", +} + +@doc("Cardinality") +enum CardinalityValue { + @doc("single") + Single: "SINGLE", + + @doc("list") + List: "LIST", + + @doc("set") + Set: "SET", +} + +@doc("Type Category") +enum TypeCategory { + @doc("primitive") + Primitive: "PRIMITIVE", + + @doc("object id type") + ObjectIdType: "OBJECT_ID_TYPE", + + @doc("enum") + Enum: "ENUM", + + @doc("struct") + Struct: "STRUCT", + + @doc("classification") + Classification: "CLASSIFICATION", + + @doc("entity") + Entity: "ENTITY", + + @doc("array") + Array: "ARRAY", + + @doc("map") + Map: "MAP", + + @doc("relationship") + Relationship: "RELATIONSHIP", + + @doc("term template") + TermTemplate: "TERM_TEMPLATE", +} + +@doc("Rounding Mode") +enum RoundingMode { + @doc("up") + Up: "UP", + + @doc("down") + Down: "DOWN", + + @doc("ceiling") + Ceiling: "CEILING", + + @doc("floor") + Floor: "FLOOR", + + @doc("half up") + HalfUp: "HALF_UP", + + @doc("half down") + HalfDown: "HALF_DOWN", + + @doc("half even") + HalfEven: "HALF_EVEN", + + @doc("unnecessary") + Unnecessary: "UNNECESSARY", +} + +@doc("Relationship Category") +enum RelationshipCategory { + @doc("association") + Association: "ASSOCIATION", + + @doc("aggregation") + Aggregation: "AGGREGATION", + + @doc("composition") + Composition: "COMPOSITION", +} + +@doc("Search Filter Operator") +enum FilterOperator { + @doc("equal") + eq, + + @doc("not equal") + ne, + + @doc("greater than") + gt, + + @doc("less than") + lt, + + @doc("greater than or equal to") + ge, + + @doc("less than or equal to") + le, + + @doc("contains") + contains, + + @doc("start with") + startswith, + + @doc("prefix") + prefix, + + @doc("time range") + timerange, + + @doc("exists") + exists, +} + +@doc(""" +An instance of an entity along with extended info - like hive_table, +hive_database. +""") +model AtlasEntityWithExtInfo { + ...AtlasEntityExtInfo; + + @doc("An instance of an entity - like hive_table, hive_database.") + entity?: AtlasEntity; +} + +@doc("An instance of an entity - like hive_table, hive_database.") +model AtlasEntity { + ...AtlasStruct; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Record to model Map" + @doc("Business attributes") + businessAttributes?: Record; + + @doc("An array of classifications.") + classifications?: AtlasClassification[]; + + @doc("The created time of the record.") + createTime?: safeint; + + @doc("The user who created the record.") + createdBy?: string; + + @doc("Custom Attribute") + customAttributes?: Record; + + @doc("The GUID of the entity.") + guid?: string; + + @doc("The home ID of the entity.") + homeId?: string; + + @doc("The collection ID of the entity.") + @visibility("read") + collectionId?: string; + + @doc("Whether it is a shell entity") + isIncomplete?: boolean; + + @doc("labels") + labels?: string[]; + + @doc("An array of term assignment headers indicating the meanings of the entity.") + meanings?: AtlasTermAssignmentHeader[]; + + @doc("Used to record the provenance of an instance of an entity or relationship.") + provenanceType?: int32; + + @doc("Determines if there's a proxy.") + proxy?: boolean; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Record to model Map" + @doc("The attributes of relationship.") + relationshipAttributes?: Record; + + @doc(""" +Status of the entity - can be active or deleted. Deleted entities are not +removed. +""") + status?: EntityStatus; + + @doc("The update time of the record.") + updateTime?: safeint; + + @doc("The user who updated the record.") + updatedBy?: string; + + @doc("The version of the entity.") + version?: int64; + + @doc("The dictionary of contacts for entities. Key could be Expert or Owner.") + contacts?: Record; +} + +@doc(""" +An instance of a classification; it doesn't have an identity, this object +exists only when associated with an entity. +""") +model AtlasClassification { + ...AtlasStruct; + + @doc("The GUID of the entity.") + entityGuid?: string; + + @doc(""" +Status of the entity - can be active or deleted. Deleted entities are not +removed. +""") + entityStatus?: EntityStatus; + + @doc("Determines if propagations will be removed on entity deletion.") + removePropagationsOnEntityDelete?: boolean; + + @doc("An array of time boundaries indicating validity periods.") + validityPeriods?: TimeBoundary[]; +} + +@doc("Captures time-boundary details") +model TimeBoundary { + @doc("The end of the time boundary.") + endTime?: string; + + @doc("The start of the time boundary.") + startTime?: string; + + @doc("The timezone of the time boundary.") + timeZone?: string; +} + +@doc(""" +Captures details of struct contents. Not instantiated directly, used only via +AtlasEntity, AtlasClassification. +""") +model AtlasStruct { + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Record to model Map" + @doc("The attributes of the struct.") + attributes?: Record; + + @doc("The name of the type.") + typeName?: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "It is an Atlas model" + @doc("ETag for concurrency control.") + lastModifiedTS?: string; +} + +@doc("The header for term assignment.") +model AtlasTermAssignmentHeader { + @doc("The confidence of the term assignment.") + confidence?: int32; + + @doc("The user who created the record.") + createdBy?: string; + + @doc("The description of the term assignment.") + description?: string; + + @doc("The display text.") + displayText?: string; + + @doc("The expression of the term assignment.") + expression?: string; + + @doc("The GUID of the relationship.") + relationGuid?: Azure.Core.uuid; + + @doc("The status of terms assignment.") + status?: AtlasTermAssignmentStatus; + + @doc("The steward of the term.") + steward?: string; + + @doc("The GUID of the term.") + termGuid?: Azure.Core.uuid; +} + +@doc("ContactInfo") +model ContactInfo { + @doc("Azure Active Directory object Id.") + id?: string; + + @doc("additional information to describe this contact.") + info?: string; +} + +@doc(""" +An instance of an entity along with extended info - like hive_table, +hive_database. +""") +model AtlasEntityExtInfo { + @doc("The referred entities.") + referredEntities?: Record; +} + +@doc("The mutation response result of entity.") +model EntityMutationResult { + @doc("A map of GUID assignments with entities.") + guidAssignments?: Record; + + @doc("The entity headers of mutated entities.") + mutatedEntities?: Record; + + @doc("An array of entity headers that partially updated.") + partialUpdatedEntities?: AtlasEntityHeader[]; +} + +@doc("An instance of an entity - like hive_table, hive_database.") +model AtlasEntityHeader { + ...AtlasStruct; + + @doc("An array of classification names.") + classificationNames?: string[]; + + @doc("An array of classifications.") + classifications?: AtlasClassification[]; + + @doc("The display text.") + displayText?: string; + + @doc("The GUID of the record.") + guid?: string; + + @doc("Whether it is a shell entity") + isIncomplete?: boolean; + + @doc("labels") + labels?: string[]; + + @doc("An array of meanings.") + meaningNames?: string[]; + + @doc("An array of term assignment headers.") + meanings?: AtlasTermAssignmentHeader[]; + + @doc(""" +Status of the entity - can be active or deleted. Deleted entities are not +removed. +""") + status?: EntityStatus; +} + +@doc("An error response from the service") +@error +model AtlasErrorResponse { + @doc("The request ID.") + requestId?: Azure.Core.uuid; + + @doc("The error code.") + errorCode?: string; + + @doc("The error message.") + errorMessage?: string; +} + +@doc(""" +An instance of an entity along with extended info - like hive_table, +hive_database. +""") +model AtlasEntitiesWithExtInfo { + ...AtlasEntityExtInfo; + + @doc("An array of entities.") + entities?: AtlasEntity[]; +} + +@doc("The request payload for classification association.") +model ClassificationAssociateOptions { + @doc(""" +An instance of a classification; it doesn't have an identity, this object +exists only when associated with an entity. +""") + classification?: AtlasClassification; + + @doc("The GUID of the entity.") + entityGuids?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" +@doc("REST serialization friendly list.") +model AtlasClassifications { + ...PList; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "It is an Atlas model" +@doc("Paginated-list, for returning search results.") +model PList { + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object>" + @doc("An array of objects.") + list?: unknown[]; + + @doc("The size of the page.") + pageSize?: int32; + + @doc("The sorted by field.") + sortBy?: string; + + @doc("to specify whether the result should be sorted? If yes, whether asc or desc.") + sortType?: SortType; + + @doc("The start index of the page.") + startIndex?: int32; + + @doc("The total count of items.") + totalCount?: int32; +} + +@doc("An instance of an entity header map.") +model AtlasEntityHeaders { + @doc("The description of the guid header map,") + guidHeaderMap?: Record; +} + +@doc("Bulk import result") +model BulkImportResult { + @doc("failed importInfoList") + failedImportInfoList?: ImportInfo[]; + + @doc("successful importInfoList") + successImportInfoList?: ImportInfo[]; +} + +@doc("ImportInfo") +model ImportInfo { + @doc("childObjectName") + childObjectName?: string; + + @doc("importStatus") + importStatus?: ImportStatus; + + @doc("parentObjectName") + parentObjectName?: string; + + @doc("remarks") + remarks?: string; +} + +@doc("MoveEntitiesOptions") +model MoveEntitiesOptions { + @doc("An array of entity guids to be moved to target collection.") + entityGuids?: string[]; +} + +@doc("The glossary object.") +model AtlasGlossary { + ...AtlasGlossaryBaseObject; + + @doc("An array of categories.") + categories?: AtlasRelatedCategoryHeader[]; + + @doc("The language of the glossary.") + language?: string; + + @doc("An array of related term headers.") + terms?: AtlasRelatedTermHeader[]; + + @doc("The usage of the glossary.") + usage?: string; +} + +@doc("The header of the related category.") +model AtlasRelatedCategoryHeader { + @doc("The GUID of the category.") + categoryGuid?: string; + + @doc("The description of the category header.") + description?: string; + + @doc("The display text.") + displayText?: string; + + @doc("The GUID of the parent category.") + parentCategoryGuid?: string; + + @doc("The GUID of the relationship.") + relationGuid?: string; +} + +@doc("The header of the related term.") +model AtlasRelatedTermHeader { + @doc("The description of the related term.") + description?: string; + + @doc("The display text.") + displayText?: string; + + @doc("The expression of the term.") + expression?: string; + + @doc("The GUID of the relationship.") + relationGuid?: string; + + @doc("The status of term relationship.") + status?: AtlasTermRelationshipStatus; + + @doc("The steward of the term.") + steward?: string; + + @doc("The GUID of the term.") + termGuid?: string; +} + +@doc("The glossary base object.") +model AtlasGlossaryBaseObject { + ...AtlasBaseModelObject; + + @doc("An array of classifications.") + classifications?: AtlasClassification[]; + + @doc("The long version description.") + longDescription?: string; + + @doc("The name of the glossary object.") + name?: string; + + @doc("The qualified name of the glossary object.") + qualifiedName?: string; + + @doc("The short version of description.") + shortDescription?: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "It is an Atlas model" + @doc("ETag for concurrency control.") + lastModifiedTS?: string; + + @doc("The created time of the record.") + createTime?: safeint; + + @doc("The user who created the record.") + createdBy?: string; + + @doc("The update time of the record.") + updateTime?: safeint; + + @doc("The user who updated the record.") + updatedBy?: string; +} + +alias AtlasBaseModelObject = { + @doc("The GUID of the object.") + guid?: string; +}; + +@doc("The glossary category.") +model AtlasGlossaryCategory { + ...AtlasGlossaryBaseObject; + + @doc("The glossary header with basic information.") + anchor?: AtlasGlossaryHeader; + + @doc("An array of children categories.") + childrenCategories?: AtlasRelatedCategoryHeader[]; + + @doc("The header of the related category.") + parentCategory?: AtlasRelatedCategoryHeader; + + @doc("An array of related term headers.") + terms?: AtlasRelatedTermHeader[]; +} + +@doc("The glossary header with basic information.") +model AtlasGlossaryHeader { + @doc("The display text.") + displayText?: string; + + @doc("The GUID of the glossary.") + glossaryGuid?: string; + + @doc("The GUID of the relationship.") + relationGuid?: string; +} + +@doc("The glossary term.") +model AtlasGlossaryTerm { + ...AtlasGlossaryBaseObject; + + @doc("The abbreviation of the term.") + abbreviation?: string; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + @doc("The name of the template.") + templateName?: unknown[]; + + @doc("The glossary header with basic information.") + anchor?: AtlasGlossaryHeader; + + @doc("An array of related term headers as antonyms.") + antonyms?: AtlasRelatedTermHeader[]; + + @doc("Status of the AtlasGlossaryTerm") + status?: TermStatus; + + @doc("The nick name of the term.") + nickName?: string; + + @doc("The hierarchy information of the term.") + hierarchyInfo?: PurviewObjectId[]; + + @doc("An array of resource link for term") + resources?: ResourceLink[]; + + @doc("The dictionary of contacts for terms. Key could be Expert or Steward.") + contacts?: Record; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" + @doc(""" +The custom attributes of the term, which is map>. +The +key of the first layer map is term template name. +""") + attributes?: Record>; + + @doc("An array of related object IDs.") + assignedEntities?: AtlasRelatedObjectId[]; + + @doc("An array of term categorization headers.") + categories?: AtlasTermCategorizationHeader[]; + + @doc("An array of related term headers.") + classifies?: AtlasRelatedTermHeader[]; + + @doc("An array of examples.") + examples?: string[]; + + @doc("An array of related term headers indicating the is-a relationship.") + isA?: AtlasRelatedTermHeader[]; + + @doc("An array of preferred related term headers.") + preferredTerms?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers that are preferred to.") + preferredToTerms?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers that are replaced by.") + replacedBy?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers for replacement.") + replacementTerms?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers for see also.") + seeAlso?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers as synonyms.") + synonyms?: AtlasRelatedTermHeader[]; + + @doc("An array of translated related term headers.") + translatedTerms?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers for translation.") + translationTerms?: AtlasRelatedTermHeader[]; + + @doc("The usage of the term.") + usage?: string; + + @doc("An array of related term headers as valid values.") + validValues?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers as valid values for other records.") + validValuesFor?: AtlasRelatedTermHeader[]; +} + +@doc("PurviewObjectId") +model PurviewObjectId { + ...AtlasObjectId; + + @doc("Name") + name?: string; + + @doc("Display text") + displayText?: string; + + @doc("Item path") + itemPath?: string; + + @doc("Resource Id") + resourceId?: string; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" + @doc("Dictionary of ") + properties?: Record; +} + +@doc("Reference to an object-instance of a type - like entity.") +model AtlasObjectId { + @doc("The GUID of the object.") + guid?: string; + + @doc("The name of the type.") + typeName?: string; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" + @doc("The unique attributes of the object.") + uniqueAttributes?: Record; +} + +@doc("ResourceLink") +model ResourceLink { + @doc("Display name for url.") + displayName?: string; + + @doc("web url. http or https") + url?: string; +} + +@doc(""" +Reference to an object-instance of AtlasEntity type used in relationship +attribute values +""") +model AtlasRelatedObjectId { + ...AtlasObjectId; + + @doc("The display text.") + displayText?: string; + + @doc(""" +Status of the entity - can be active or deleted. Deleted entities are not +removed. +""") + entityStatus?: EntityStatus; + + @doc("Relationship type") + relationshipType?: string; + + @doc(""" +Captures details of struct contents. Not instantiated directly, used only via +AtlasEntity, AtlasClassification. +""") + relationshipAttributes?: AtlasStruct; + + @doc("The GUID of the relationship.") + relationshipGuid?: Azure.Core.uuid; + + @doc("The enum of relationship status.") + relationshipStatus?: StatusAtlasRelationship; +} + +@doc("The basic information for term categorization.") +model AtlasTermCategorizationHeader { + @doc("The GUID of the category.") + categoryGuid?: Azure.Core.uuid; + + @doc("The description of the record.") + description?: string; + + @doc("The display text.") + displayText?: string; + + @doc("The GUID of the relationship.") + relationGuid?: Azure.Core.uuid; + + @doc("The status of term relationship.") + status?: AtlasTermRelationshipStatus; +} + +@doc("The extended information of glossary.") +model AtlasGlossaryExtInfo { + ...AtlasGlossary; + + @doc("The glossary category information.") + categoryInfo?: Record; + + @doc("The glossary term information.") + termInfo?: Record; +} + +@doc("The search query of advanced search request.") +model QueryOptions { + @doc("The keywords applied to all searchable fields.") + keywords?: string; + + @doc(""" +The limit of the number of the search result. default value is 50; maximum +value is 1000. +""") + limit?: int32; + + @doc(""" +The token used to get next batch of data. Default 'Null' to get the first +batch, and will return new token in each response unless there's no more data. +""") + continuationToken?: string; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "This is a flexible property" + @doc("The sort order of search results, can specify multiple fields.") + orderby?: unknown[]; + + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc("The filter for the search. See examples for the usage of supported filters.") + filter?: unknown; + + @doc("The facets for search. See examples for the usage of supported facets.") + facets?: SearchFacetItem[]; + + @doc("The taxonomy setting for search.") + taxonomySetting?: SearchTaxonomySetting; +} + +@doc("The content of a search facet result item.") +model SearchFacetItem { + @doc("The count of the facet item.") + count?: int32; + + @doc("The name of the facet item.") + facet?: string; + + @doc("Define the sorting criteria for items") + sort?: SearchFacetSort; +} + +@doc("The sorting criteria") +model SearchFacetSort { + @doc("Order by count") + count?: SearchSortOrder; + + @doc("Order by value") + value?: SearchSortOrder; +} + +@doc("Search sort order") +enum SearchSortOrder { + @doc("Use ascending order for sorting") + Ascend: "asc", + + @doc("Use descending order for sorting") + Descend: "desc", +} + +@doc("Taxonomy setting for search request") +model SearchTaxonomySetting { + @doc("Asset types") + assetTypes?: string[]; + + @doc("The content of a search facet result item.") + facet?: SearchFacetItem; +} + +@doc("The result of the search result.") +model QueryResult { + @doc(""" +The total number of search results (not the number of documents in a single +page). +""") + @encodedName("application/json", "@search.count") + searchCount?: int32; + + @doc("'True' if the '@search.count' is an approximate value and vise versa.") + @encodedName("application/json", "@search.count.approximate") + searchCountApproximate?: boolean; + + @doc("The token used to get next batch of data. Absent if there's no more data.") + continuationToken?: string; + + @doc(""" +A facet list that consists of index fields assetType ,classification, +contactId, and label. When the facet is specified in the request, the value of +the facet is returned as an element of @search.facets. +""") + @encodedName("application/json", "@search.facets") + searchFacets?: SearchFacetResultValue; + + @doc("Search result value") + value?: SearchResultValue[]; +} + +@doc(""" +A facet list that consists of index fields assetType ,classification, +contactId, and label. When the facet is specified in the request, the value of +the facet is returned as an element of @search.facets. +""") +model SearchFacetResultValue { + @doc("Entity type") + entityType?: SearchFacetItemValue[]; + + @doc("Asset type") + assetType?: SearchFacetItemValue[]; + + @doc("Classification") + classification?: SearchFacetItemValue[]; + + @doc("Term") + term?: SearchFacetItemValue[]; + + @doc("Contact id") + contactId?: SearchFacetItemValue[]; + + @doc("Contact type") + contactType?: SearchFacetItemValue[]; + + @doc("Label") + label?: SearchFacetItemValue[]; + + @doc("Glossary type") + glossaryType?: SearchFacetItemValue[]; + + @doc("Term status") + termStatus?: SearchFacetItemValue[]; + + @doc("Term template") + termTemplate?: SearchFacetItemValue[]; +} + +@doc("The content of a search facet result item.") +model SearchFacetItemValue { + @doc("The count of the facet item.") + count?: int32; + + @doc("The name of the facet item.") + value?: string; +} + +@doc("The value item of the search result.") +model SearchResultValue { + @doc(""" +The search score calculated by the search engine. The results are ordered by +search score by default. +""") + @encodedName("application/json", "@search.score") + searchScore?: float32; + + @doc(""" +A highlight list that consists of index fields id ,qualifiedName, name, +description, entityType. When the keyword appears in those fields, the value of +the field, attached with emphasis mark, is returned as an element of +@search.highlights. +""") + @encodedName("application/json", "@search.highlights") + searchHighlights?: SearchHighlights; + + @doc(""" +The object type of the record. Object type is the top-level property to +distinguish whether a record is an asset or a term. +""") + objectType?: string; + + @doc("The create time of the record. The Unix epoch format.") + createTime?: safeint; + + @doc("The last update time of the record. The Unix epoch format.") + updateTime?: safeint; + + @doc("The GUID of the record.") + id?: string; + + @doc("The name of the record.") + name?: string; + + @doc("The qualified name of the record.") + qualifiedName?: string; + + @doc("The type name of the asset.") + entityType?: string; + + @doc("The description of the asset.") + description?: string; + + @doc("The endorsement of the asset.") + endorsement?: string; + + @doc("The owner of the record.") + owner?: string; + + @doc("The classifications of the record.") + classification?: string[]; + + @doc("The labels of the asset.") + label?: string[]; + + @doc("The terms assigned to the asset.") + term?: TermSearchResultValue[]; + + @doc("The contacts of the asset.") + contact?: ContactSearchResultValue[]; + + @doc("The asset types of the asset.") + assetType?: string[]; + + @doc(""" +The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or +AtlasGlossaryCategory. +""") + glossaryType?: string; + + @doc("The glossary name of the term.") + glossary?: string; + + @doc("The status of the term.") + termStatus?: string; + + @doc("The term template names used by the term.") + termTemplate?: string[]; + + @doc("The definition of the term.") + longDescription?: string; +} + +@doc(""" +A highlight list that consists of index fields id ,qualifiedName, name, +description, entityType. When the keyword appears in those fields, the value of +the field, attached with emphasis mark, is returned as an element of +@search.highlights. +""") +model SearchHighlights { + @doc("Id") + id?: string[]; + + @doc("Qualified name") + qualifiedName?: string[]; + + @doc("Name") + name?: string[]; + + @doc("Description") + description?: string[]; + + @doc("Entity type") + entityType?: string[]; +} + +@doc("The context.") +model TermSearchResultValue { + @doc("The name of the term.") + name?: string; + + @doc("The name of the glossary which contains the term.") + glossaryName?: string; + + @doc("The GUID of the term.") + guid?: string; +} + +@doc("The contact in the search and suggest result.") +model ContactSearchResultValue { + @doc("The GUID of the contact.") + id?: string; + + @doc("The description of the contact.") + info?: string; + + @doc(""" +The type of the contact. It can be Expert or Owner for an entity. It can be +Expert or Steward for a glossary term. +""") + contactType?: string; +} + +@doc("The payload of suggest request.") +model SuggestOptions { + @doc(""" +The keywords applied to all fields that support suggest operation. It must be +at least 1 character, and no more than 100 characters. In the index schema we +defined a default suggester which lists all the supported fields and specifies +a search mode. +""") + keywords?: string; + + @doc(""" +The number of suggestions we hope to return. The default value is 5. The value +must be a number between 1 and 100. +""") + limit?: int32; + + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc("The filter for the search.") + filter?: unknown; +} + +@doc("The result item of the search suggest.") +model SuggestResult { + @doc("The result value") + value?: SuggestResultValue[]; +} + +@doc("The value item of the search suggest.") +model SuggestResultValue { + @doc(""" +The search score calculated by the search engine. The results are ordered by +search score by default. +""") + @encodedName("application/json", "@search.score") + searchScore?: float32; + + @doc(""" +The target text that contains the keyword as prefix. The keyword is wrapped +with emphasis mark. +""") + @encodedName("application/json", "@search.text") + searchText?: string; + + @doc(""" +The object type of the record. Object type is the top-level property to +distinguish whether a record is an asset or a term. +""") + objectType?: string; + + @doc("The create time of the record. The Unix epoch format.") + createTime?: safeint; + + @doc("The last update time of the record. The Unix epoch format.") + updateTime?: safeint; + + @doc("The GUID of the record.") + id?: string; + + @doc("The name of the record.") + name?: string; + + @doc("The qualified name of the record.") + qualifiedName?: string; + + @doc("The type name of the asset.") + entityType?: string; + + @doc("The description of the asset.") + description?: string; + + @doc("The endorsement of the asset.") + endorsement?: string; + + @doc("The owner of the record.") + owner?: string; + + @doc("The classifications of the record.") + classification?: string[]; + + @doc("The labels of the asset.") + label?: string[]; + + @doc("The terms assigned to the asset.") + term?: TermSearchResultValue[]; + + @doc("The contacts of the asset.") + contact?: ContactSearchResultValue[]; + + @doc("The asset types of the asset.") + assetType?: string[]; + + @doc(""" +The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or +AtlasGlossaryCategory. +""") + glossaryType?: string; + + @doc("The glossary name of the term.") + glossary?: string; + + @doc("The status of the term.") + termStatus?: string; + + @doc("The term template names used by the term.") + termTemplate?: string[]; + + @doc("The definition of the term.") + longDescription?: string; +} + +@doc("The payload of autocomplete request.") +model AutoCompleteOptions { + @doc(""" +The keywords applied to all fields that support autocomplete operation. It must +be at least 1 character, and no more than 100 characters. +""") + keywords?: string; + + @doc(""" +The number of autocomplete results we hope to return. The default value is 50. +The value must be a number between 1 and 100. +""") + limit?: int32; + + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc("The filter for the autocomplete request.") + filter?: unknown; +} + +@doc("The result of the autocomplete request.") +model AutoCompleteResult { + @doc("The result value") + value?: AutoCompleteResultValue[]; +} + +@doc("The value item of the autocomplete suggest.") +model AutoCompleteResultValue { + @doc("The completed term or phrase.") + text?: string; + + @doc("The completed search query text.") + queryPlusText?: string; +} + +@doc("The lineage information.") +model AtlasLineageInfo { + @doc("The GUID of the base entity.") + baseEntityGuid?: string; + + @doc("The GUID entity map.") + guidEntityMap?: Record; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Record to model Map" + @doc("The entity count in specific direction.") + widthCounts?: Record>; + + @doc("The depth of lineage.") + lineageDepth?: int32; + + @doc("The width of lineage.") + lineageWidth?: int32; + + @doc("The number of children node.") + childrenCount?: int32; + + @doc("The enum of lineage direction.") + lineageDirection?: LineageDirection; + + @doc("An array of parentRelations relations.") + parentRelations?: ParentRelation[]; + + @doc("An array of lineage relations.") + relations?: LineageRelation[]; +} + +@doc("The lineage parents relation with GUID of the parent entity and to child entity.") +model ParentRelation { + @doc("The GUID of child entity.") + childEntityId?: string; + + @doc("The GUID of relationship.") + relationshipId?: string; + + @doc("The GUID of parent entity.") + parentEntityId?: string; +} + +@doc("The lineage relation with GUID of the from and to entity.") +model LineageRelation { + @doc("The GUID of from-entity.") + fromEntityId?: string; + + @doc("The GUID of relationship.") + relationshipId?: string; + + @doc("The GUID of to-entity.") + toEntityId?: string; +} + +@doc("Atlas relationship instance.") +model AtlasRelationship { + ...AtlasStruct; + + @doc("The created time of the record.") + createTime?: safeint; + + @doc("The user who created the record.") + createdBy?: string; + + @doc("Reference to an object-instance of a type - like entity.") + end1?: AtlasObjectId; + + @doc("Reference to an object-instance of a type - like entity.") + end2?: AtlasObjectId; + + @doc("The GUID of the relationship.") + guid?: string; + + @doc("The home ID of the relationship.") + homeId?: string; + + @doc("The label of the relationship.") + label?: string; + + @doc("Used to record the provenance of an instance of an entity or relationship") + provenanceType?: int32; + + @doc("The enum of relationship status.") + status?: StatusAtlasRelationship; + + @doc("The update time of the record.") + updateTime?: safeint; + + @doc("The user who updated the record.") + updatedBy?: string; + + @doc("The version of the relationship.") + version?: int64; +} + +@doc("The relationship with extended information.") +model AtlasRelationshipWithExtInfo { + @doc("The referred entity header.") + referredEntities?: Record; + + @doc("Atlas relationship instance.") + relationship?: AtlasRelationship; +} + +@doc("class that captures details of a struct-type.") +model AtlasBusinessMetadataDef { + ...AtlasStructDef; +} + +@doc("class that captures details of a struct-type.") +model AtlasStructDef { + ...AtlasBaseTypeDef; + + @doc("An array of attribute definitions.") + attributeDefs?: AtlasAttributeDef[]; +} + +@doc("class that captures details of a struct-attribute.") +model AtlasAttributeDef { + @doc("single-valued attribute or multi-valued attribute.") + cardinality?: CardinalityValue; + + @doc("An array of constraints.") + constraints?: AtlasConstraintDef[]; + + @doc("The default value of the attribute.") + defaultValue?: string; + + @doc("The description of the attribute.") + description?: string; + + @doc("Determines if it is included in notification.") + includeInNotification?: boolean; + + @doc("Determines if it is indexable.") + isIndexable?: boolean; + + @doc("Determines if it is optional.") + isOptional?: boolean; + + @doc("Determines if it unique.") + isUnique?: boolean; + + @doc("The name of the attribute.") + name?: string; + + @doc("The options for the attribute.") + options?: Record; + + @doc("The name of the type.") + typeName?: string; + + @doc("The maximum count of the values.") + valuesMaxCount?: int32; + + @doc("The minimum count of the values.") + valuesMinCount?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" +@doc("class that captures details of a constraint.") +model AtlasConstraintDef { + @doc("The parameters of the constraint definition.") + params?: Record; + + @doc("The type of the constraint.") + type?: string; +} + +alias AtlasBaseTypeDef = { + @doc("The enum of type category.") + category?: TypeCategory; + + @doc("The created time of the record.") + createTime?: safeint; + + @doc("The user who created the record.") + createdBy?: string; + + @doc("The date format.") + dateFormatter?: DateFormat; + + @doc("The description of the type definition.") + description?: string; + + @doc("The GUID of the type definition.") + guid?: string; + + @doc("The name of the type definition.") + name?: string; + + @doc("The options for the type definition.") + options?: Record; + + @doc("The service type.") + serviceType?: string; + + @doc("The version of the type.") + typeVersion?: string; + + @doc("The update time of the record.") + updateTime?: safeint; + + @doc("The user who updated the record.") + updatedBy?: string; + + @doc("The version of the record.") + version?: int64; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "It is an Atlas model" + @doc("ETag for concurrency control.") + lastModifiedTS?: string; +}; + +@doc("The date format.") +model DateFormat { + @doc("An array of available locales.") + availableLocales?: string[]; + + @doc("Calendar") + calendar?: float32; + + @doc("The date format.") + dateInstance?: DateFormat; + + @doc("The date format.") + dateTimeInstance?: DateFormat; + + @doc("The date format.") + instance?: DateFormat; + + @doc("Determines the leniency of the date format.") + lenient?: boolean; + + @doc("The number format.") + numberFormat?: NumberFormat; + + @doc("The date format.") + timeInstance?: DateFormat; + + @doc("The timezone information.") + timeZone?: TimeZone; +} + +@doc("The number format.") +model NumberFormat { + @doc("The number format.") + availableLocales?: string[]; + + @doc("The currency.") + currency?: string; + + @doc("The number format.") + currencyInstance?: NumberFormat; + + @doc("Determines if grouping is used.") + groupingUsed?: boolean; + + @doc("The number format.") + instance?: NumberFormat; + + @doc("The number format.") + integerInstance?: NumberFormat; + + @doc("The maximum of fraction digits.") + maximumFractionDigits?: int32; + + @doc("The maximum of integer digits.") + maximumIntegerDigits?: int32; + + @doc("The minimum of fraction digits.") + minimumFractionDigits?: int32; + + @doc("The minimum of integer digits.") + minimumIntegerDigits?: int32; + + @doc("The number format.") + numberInstance?: NumberFormat; + + @doc("Determines if only integer is parsed.") + parseIntegerOnly?: boolean; + + @doc("The number format.") + percentInstance?: NumberFormat; + + @doc("The enum of rounding mode.") + roundingMode?: RoundingMode; +} + +@doc("The timezone information.") +model TimeZone { + @doc("The value of the daylight saving time.") + dstSavings?: int32; + + @doc("The ID of the timezone.") + id?: string; + + @doc("An array of available IDs.") + availableIds?: string[]; + + @doc("The timezone information.") + default?: TimeZone; + + @doc("The display name of the timezone.") + displayName?: string; + + @doc("The raw offset of the timezone.") + rawOffset?: int32; +} + +@doc("class that captures details of a classification-type.") +model AtlasClassificationDef { + ...AtlasStructDef; + + @doc(""" +Specifying a list of entityType names in the classificationDef, ensures that +classifications can +only be applied to those entityTypes. + +Any subtypes of the entity types inherit the restriction. + +Any classificationDef subtypes inherit the parents entityTypes restrictions. + +Any classificationDef subtypes can further restrict the parents entityTypes +restrictions by specifying a subset of the entityTypes. + +An empty entityTypes list when there are no parent restrictions means there are no +restrictions. + +An empty entityTypes list when there are parent +restrictions means that the subtype picks up the parents +restrictions. + +If a list of entityTypes are supplied, where one inherits +from another, this will be rejected. This should encourage cleaner +classificationsDefs. + +""") + entityTypes?: string[]; + + @doc("An array of sub types.") + subTypes?: string[]; + + @doc("An array of super types.") + superTypes?: string[]; +} + +@doc("class that captures details of a entity-type.") +model AtlasEntityDef { + ...AtlasStructDef; + + @doc("An array of sub types.") + subTypes?: string[]; + + @doc("An array of super types.") + superTypes?: string[]; + + @doc("An array of relationship attributes.") + relationshipAttributeDefs?: AtlasRelationshipAttributeDef[]; +} + +@doc(""" +The relationshipEndDef represents an end of the relationship. The end of the +relationship is defined by a type, an +attribute name, cardinality and whether +it is the container end of the relationship. +""") +model AtlasRelationshipAttributeDef { + ...AtlasAttributeDef; + + @doc("Determines if it is a legacy attribute.") + isLegacyAttribute?: boolean; + + @doc("The name of the relationship type.") + relationshipTypeName?: string; +} + +@doc("class that captures details of an enum-type.") +model AtlasEnumDef { + ...AtlasBaseTypeDef; + + @doc("The default value.") + defaultValue?: string; + + @doc("An array of enum element definitions.") + elementDefs?: AtlasEnumElementDef[]; +} + +@doc("class that captures details of an enum-element.") +model AtlasEnumElementDef { + @doc("The description of the enum element definition.") + description?: string; + + @doc("The ordinal of the enum element definition.") + ordinal?: int32; + + @doc("The value of the enum element definition.") + value?: string; +} + +@doc(""" +AtlasRelationshipDef is a TypeDef that defines a relationship. +As with other typeDefs the AtlasRelationshipDef has a name. Once created the +RelationshipDef has a guid. +The name and the guid are the 2 ways that the +RelationshipDef is identified. +RelationshipDefs have 2 ends, each of which +specify cardinality, an EntityDef type name and name and optionally +whether the +end is a container. +RelationshipDefs can have AttributeDefs - though only +primitive types are allowed. +RelationshipDefs have a relationshipCategory +specifying the UML type of relationship required +The way EntityDefs and +RelationshipDefs are intended to be used is that EntityDefs will define +AttributeDefs these AttributeDefs +will not specify an EntityDef type name as +their types. +RelationshipDefs introduce new attributes to the entity +instances. For example +EntityDef A might have attributes attr1,attr2,attr3 + +EntityDef B might have attributes attr4,attr5,attr6 +RelationshipDef +AtoB might define 2 ends + +end1: type A, name attr7 +end2: type B, name attr8 + +When an instance of EntityDef A is created, it +will have attributes attr1,attr2,attr3,attr7 +When an instance of EntityDef +B is created, it will have attributes attr4,attr5,attr6,attr8 + +In this way +relationshipDefs can be authored separately from entityDefs and can inject +relationship attributes into +the entity instances +""") +model AtlasRelationshipDef { + ...AtlasStructDef; + + @doc(""" +The relationshipEndDef represents an end of the relationship. The end of the +relationship is defined by a type, an +attribute name, cardinality and whether +it is the container end of the relationship. +""") + endDef1?: AtlasRelationshipEndDef; + + @doc(""" +The relationshipEndDef represents an end of the relationship. The end of the +relationship is defined by a type, an +attribute name, cardinality and whether +it is the container end of the relationship. +""") + endDef2?: AtlasRelationshipEndDef; + + @doc(""" +The Relationship category determines the style of relationship around +containment and lifecycle. +UML terminology is used for the values. +ASSOCIATION is a relationship with no containment. +COMPOSITION and AGGREGATION are containment relationships. +The difference being in the lifecycles of the container and its children. +In the COMPOSITION case, the children cannot exist without the container. +For AGGREGATION, the life cycles of the container and children are totally independent. +""") + relationshipCategory?: RelationshipCategory; + + @doc("The label of the relationship.") + relationshipLabel?: string; +} + +@doc(""" +The relationshipEndDef represents an end of the relationship. The end of the +relationship is defined by a type, an +attribute name, cardinality and whether +it is the container end of the relationship. +""") +model AtlasRelationshipEndDef { + @doc("single-valued attribute or multi-valued attribute.") + cardinality?: CardinalityValue; + + @doc("The description of the relationship end definition.") + description?: string; + + @doc("Determines if it is container.") + isContainer?: boolean; + + @doc("Determines if it is a legacy attribute.") + isLegacyAttribute?: boolean; + + @doc("The name of the relationship end definition.") + name?: string; + + @doc("The type of the relationship end.") + type?: string; +} + +@doc("The definitions of type.") +model AtlasTypeDef { + ...AtlasBaseTypeDef; + ...AtlasExtraTypeDef; +} + +@doc("Extra properties for a type.") +model AtlasExtraTypeDef { + @doc(""" +Specifying a list of entityType names in the classificationDef, ensures that +classifications can +only be applied to those entityTypes. + +Any subtypes of the entity types inherit the restriction. + +Any classificationDef subtypes inherit the parents entityTypes restrictions. + +Any classificationDef subtypes can further restrict the parents entityTypes +restrictions by specifying a subset of the entityTypes. + +An empty entityTypes list when there are no parent restrictions means there are no +restrictions. + +An empty entityTypes list when there are parent +restrictions means that the subtype picks up the parents +restrictions. + +If a list of entityTypes are supplied, where one inherits +from another, this will be rejected. This should encourage cleaner +classificationsDefs. + +""") + entityTypes?: string[]; + + @doc("An array of sub types.") + subTypes?: string[]; + + @doc("An array of super types.") + superTypes?: string[]; + + @doc("An array of relationship attributes.") + relationshipAttributeDefs?: AtlasRelationshipAttributeDef[]; + + @doc("The default value.") + defaultValue?: string; + + @doc("An array of enum element definitions.") + elementDefs?: AtlasEnumElementDef[]; + + @doc(""" +The relationshipEndDef represents an end of the relationship. The end of the +relationship is defined by a type, an +attribute name, cardinality and whether +it is the container end of the relationship. +""") + endDef1?: AtlasRelationshipEndDef; + + @doc(""" +The relationshipEndDef represents an end of the relationship. The end of the +relationship is defined by a type, an +attribute name, cardinality and whether +it is the container end of the relationship. +""") + endDef2?: AtlasRelationshipEndDef; + + @doc(""" +The Relationship category determines the style of relationship around +containment and lifecycle. +UML terminology is used for the values. + +ASSOCIATION is a relationship with no containment. +COMPOSITION and AGGREGATION are containment relationships. + +The difference being in the lifecycles of the container and its children. +In the COMPOSITION case, the children cannot exist without the container. +For AGGREGATION, the life cycles of the container and children are totally independent. +""") + relationshipCategory?: RelationshipCategory; + + @doc("The label of the relationship.") + relationshipLabel?: string; + + @doc("An array of attribute definitions.") + attributeDefs?: AtlasAttributeDef[]; +} + +@doc("The definitions of types.") +model AtlasTypesDef { + @doc("businessMetadataDefs") + businessMetadataDefs?: AtlasBusinessMetadataDef[]; + + @doc("An array of classification definitions.") + classificationDefs?: AtlasClassificationDef[]; + + @doc("An array of entity definitions.") + entityDefs?: AtlasEntityDef[]; + + @doc("An array of enum definitions.") + enumDefs?: AtlasEnumDef[]; + + @doc("An array of relationship definitions.") + relationshipDefs?: AtlasRelationshipDef[]; + + @doc("An array of struct definitions.") + structDefs?: AtlasStructDef[]; + + @doc("An array of term template definitions.") + termTemplateDefs?: TermTemplateDef[]; +} + +@doc("Term template definition for glossary term.") +model TermTemplateDef { + ...AtlasStructDef; +} + +@doc("The basic information of the type definition.") +model AtlasTypeDefHeader { + @doc("The enum of type category.") + category?: TypeCategory; + + @doc("The GUID of the type definition.") + guid?: string; + + @doc("The name of the type definition.") + name?: string; +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp new file mode 100644 index 000000000000..bc4f05fe69c8 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -0,0 +1,2133 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/http"; +import "@typespec/versioning"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; +using Azure.Core.Traits.Private; + +namespace PurviewDataMap; + +@doc("The ApiVersion query parameter for Atlas API.") +model AtlasApiVersionParameter { + @doc("The API version to use for this operation.") + @query("api-version") + @minLength(1) + apiVersion?: string; +} + +alias AtlasApiVersionParameterTraits = Azure.Core.Traits.VersionParameterTrait; + +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" +@doc("The operation defined for Atlas APIs") +op AtlasOperation< + TParams extends TypeSpec.Reflection.Model, + TResponse, + Traits extends TypeSpec.Reflection.Model = {} +>( + ...TraitProperties, + ...TParams, +): TResponse | AtlasErrorResponse; + +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" +op AtlasRpcOperation< + TParams extends TypeSpec.Reflection.Model, + TResponse extends TypeSpec.Reflection.Model, + Traits extends TypeSpec.Reflection.Model = {}, + TraitContexts extends TraitContext = TraitContext.Undefined +> is AtlasOperation< + TParams & TraitProperties, + TResponse & TraitProperties, + Traits +>; + +alias OkResponse = { + @statusCode + status: 200; + + @body + data: T; +}; + +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" +op AtlasImportOperation< + TParams extends TypeSpec.Reflection.Model, + TResponse extends TypeSpec.Reflection.Model, + Traits extends TypeSpec.Reflection.Model = {}, + TraitContexts extends TraitContext = TraitContext.Undefined +> is AtlasOperation< + TParams & + TraitProperties< + Traits & + NoConditionalRequests & + NoRepeatableRequests & + NoClientRequestId, + TraitLocation.Parameters, + TraitContext.Action + >, + TResponse & + TraitProperties< + Traits & + NoConditionalRequests & + NoRepeatableRequests & + NoClientRequestId, + TraitLocation.Response, + TraitContext.Action + >, + Traits +>; + +alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTrait<{ + @doc("The content type for the operation. Always multipart/form-data for this operation.") + @header("content-type") + contentType: "multipart/form-data"; +}>; + +interface Entity { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Create or update an entity. +Existing entity is matched using its unique guid if +supplied or by its unique attributes eg: qualifiedName. +Map and array of +collections are not well supported. E.g., array>, array>. +For each contact type, the maximum number of contacts is 20. +""") + @route("/atlas/v2/entity") + @post + createOrUpdate is AtlasOperation< + { + @doc(""" +Used to define the update behavior for business attributes when updating +entities. +""") + @query + businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; + + @doc(""" +The collection where entities will be moved to. Only specify a value if you +need to move an entity to another collection. +""") + @query + collectionId?: string; + } & AtlasEntityWithExtInfo, + EntityMutationResult, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "This is an existing Atlas API" + @doc("List entities in bulk identified by its GUIDs.") + @route("/atlas/v2/entity/bulk") + @get + listByGuids is AtlasOperation< + { + @doc("An array of GUIDs of entities to list.") + @query({ + format: "multi", + }) + guid: string[]; + + @doc("Whether to return minimal information for referred entities.") + @query + minExtInfo?: boolean; + + @doc("Whether to ignore relationship attributes.") + @query + ignoreRelationships?: boolean; + }, + AtlasEntitiesWithExtInfo, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Create or update entities in bulk. +Existing entity is matched using its unique +guid if supplied or by its unique attributes eg: qualifiedName. +Map and array +of collections are not well supported. E.g., array>, +array>. +For each contact type, the maximum number of contacts +is 20. +""") + @route("/atlas/v2/entity/bulk") + @post + bulkCreateOrUpdate is AtlasOperation< + { + @doc(""" +The collection where entities will be moved to. Only specify a value if you +need to move an entity to another collection. +""") + @query + collectionId?: string; + + @doc(""" +Used to define the update behavior for business attributes when updating +entities. +""") + @query + businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; + } & AtlasEntitiesWithExtInfo, + EntityMutationResult, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "This is an existing Atlas API" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Delete a list of entities in bulk identified by their GUIDs or unique +attributes. +""") + @route("/atlas/v2/entity/bulk") + @delete + bulkDelete is AtlasOperation< + { + @doc("An array of GUIDs of entities to delete.") + @query({ + format: "multi", + }) + guid: string[]; + }, + EntityMutationResult, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Associate a classification to multiple entities in bulk.") + @route("/atlas/v2/entity/bulk/classification") + @post + addClassification is AtlasOperation; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get complete definition of an entity given its GUID.") + @route("/atlas/v2/entity/guid/{guid}") + @get + get is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("Whether to return minimal information for referred entities.") + @query + minExtInfo?: boolean; + + @doc("Whether to ignore relationship attributes.") + @query + ignoreRelationships?: boolean; + }, + AtlasEntityWithExtInfo, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Update entity partially - create or update entity attribute identified by its +GUID. +Supports only primitive attribute type and entity references. +It does not support updating complex types like arrays, and maps. +Null updates are not possible. +""") + @route("/atlas/v2/entity/guid/{guid}") + @put + partialUpdateAttributeByGuid is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The name of the attribute.") + @query + name: string; + + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc("The value of the attribute.") + @body + body: unknown; + }, + EntityMutationResult, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Delete an entity identified by its GUID.") + @route("/atlas/v2/entity/guid/{guid}") + @delete + delete is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + }, + EntityMutationResult, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get classification for a given entity represented by a GUID.") + @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") + @get + getClassification is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The name of the classification.") + @path + classificationName: string; + }, + AtlasClassification, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Delete a given classification from an existing entity represented by a GUID.") + @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") + @delete + removeClassification is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The name of the classification.") + @path + classificationName: string; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("List classifications for a given entity represented by a GUID.") + @route("/atlas/v2/entity/guid/{guid}/classifications") + @get + getClassifications is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + }, + AtlasClassifications, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Add classifications to an existing entity represented by a GUID.") + @route("/atlas/v2/entity/guid/{guid}/classifications") + @post + addClassifications is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("An array of classifications to be added.") + @body + body: AtlasClassification[]; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Update classifications to an existing entity represented by a guid.") + @route("/atlas/v2/entity/guid/{guid}/classifications") + @put + updateClassifications is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("An array of classifications to be updated.") + @body + body: AtlasClassification[]; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Get complete definition of an entity given its type and unique attribute. + +In +addition to the typeName path parameter, attribute key-value pair(s) can be +provided in the following format: +attr:\\=. + +NOTE: The +attrName and attrValue should be unique across entities, eg. +qualifiedName. + +The REST request would look something like this: +GET +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") + @get + getByUniqueAttributes is AtlasOperation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc("Whether to return minimal information for referred entities.") + @query + minExtInfo?: boolean; + + @doc("Whether to ignore relationship attributes.") + @query + ignoreRelationships?: boolean; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attribute?: string; + }, + AtlasEntityWithExtInfo, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Update entity partially - Allow a subset of attributes to be updated on an +entity which is identified by its type and unique attribute eg: +Referenceable.qualifiedName. Null updates are not possible. + +In addition to the +typeName path parameter, attribute key-value pair(s) can be provided in the +following format: + +attr:=. +NOTE: The attrName and +attrValue should be unique across entities, eg. qualifiedName. + +The REST +request would look something like this: +PUT +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") + @put + partialUpdateByUniqueAttributes is AtlasOperation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attribute?: string; + } & AtlasEntityWithExtInfo, + EntityMutationResult, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Delete an entity identified by its type and unique attributes. +In addition to +the typeName path parameter, attribute key-value pair(s) can be provided in the +following format: +attr:\\=\\. +NOTE: The attrName and +attrValue should be unique across entities, eg. qualifiedName. + +The REST +request would look something like this: +DELETE +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") + @delete + deleteByUniqueAttribute is AtlasOperation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attribute?: string; + }, + EntityMutationResult, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Delete a given classification from an entity identified by its type and unique +attributes. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}") + @delete + removeClassificationByUniqueAttribute is AtlasOperation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc("The name of the classification.") + @path + classificationName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attribute?: string; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Add classification to the entity identified by its type and unique attributes.") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") + @post + addClassificationsByUniqueAttribute is AtlasOperation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attribute?: string; + + @doc("An array of classification to be added.") + @body + body: AtlasClassification[]; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Update classification on an entity identified by its type and unique attributes.") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") + @put + updateClassificationsByUniqueAttribute is AtlasOperation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attribute?: string; + + @doc("An array of classification to be updated.") + @body + body: AtlasClassification[]; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Set classifications on entities in bulk.") + @route("/atlas/v2/entity/bulk/setClassifications") + @post + bulkSetClassifications is AtlasOperation< + AtlasEntityHeaders, + OkResponse, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Bulk API to retrieve list of entities identified by its unique attributes. +In +addition to the typeName path parameter, attribute key-value pair(s) can be +provided in the following +format + +typeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\ + +NOTE: +The attrName should be an unique attribute for the given entity-type. +The REST +request would look something like this + +GET +/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 + +Note: +at least one unique attribute must be provided. +""") + @route("/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}") + @get + listByUniqueAttributes is AtlasOperation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc("Whether to return minimal information for referred entities.") + @query + minExtInfo?: boolean; + + @doc("Whether to ignore relationship attributes.") + @query + ignoreRelationships?: boolean; + + @doc(""" +Qualified name of an entity. E.g. to find 2 entities you can set +attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an +example. qualifiedName can be changed to other unique attributes) +""") + @query + `attr_N:qualifiedName`?: string; + }, + AtlasEntitiesWithExtInfo, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get entity header given its GUID.") + @route("/atlas/v2/entity/guid/{guid}/header") + @get + getHeader is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + }, + AtlasEntityHeader, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Remove business metadata from an entity.") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata") + @delete + removeBusinessMetadata is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + @doc("Business metadata payload") + @body + body: Record>; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Add business metadata to an entity.") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata") + @post + addOrUpdateBusinessMetadata is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc(""" +Whether to overwrite the existing business metadata on the entity or not, +default is false. +""") + @query("isOverwrite") + overwrite?: boolean; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + @doc("BusinessMetadata payload") + @body + body: Record>; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Delete business metadata attributes from an entity.") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}") + @delete + removeBusinessMetadataAttributes is AtlasOperation< + { + @doc("BusinessMetadata name") + @path + businessMetadataName: string; + + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + @doc("Business metadata attribute payload") + @body + body: Record; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Add or update business metadata attributes.") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}") + @post + addOrUpdateBusinessMetadataAttributes is AtlasOperation< + { + @doc("BusinessMetadata name") + @path + businessMetadataName: string; + + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + @doc("Business metadata attribute payload") + @body + body: Record; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the sample Template for uploading/creating bulk BusinessMetaData") + @route("/atlas/v2/entity/businessmetadata/import/template") + @get + getSampleBusinessMetadataTemplate is AtlasRpcOperation< + {}, + { + @header contentType: "application/octet-stream"; + @body body: bytes; + }, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Upload the file for creating Business Metadata in BULK") + @route("/atlas/v2/entity/businessmetadata/import") + @post + importBusinessMetadata is AtlasImportOperation< + { + @doc("InputStream of file") + file: bytes; + }, + BulkImportResult, + MultipartFormDataRequestHeadersTraits + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Delete given labels to a given entity.") + @route("/atlas/v2/entity/guid/{guid}/labels") + @delete + removeLabels is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("set of labels to be deleted") + @body + body?: string[]; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Set labels to a given entity.") + @route("/atlas/v2/entity/guid/{guid}/labels") + @post + setLabels is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("set of labels to be set to the entity") + @body + body?: string[]; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Add given labels to a given entity.") + @route("/atlas/v2/entity/guid/{guid}/labels") + @put + addLabel is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("set of labels to be added") + @body + body?: string[]; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Delete given labels to a given entity identified by its type and unique +attribute. + +If labels is null/empty, no labels will be removed. + +If any labels +in labels set are non-existing labels, they will be ignored, only existing +labels will be removed. In addition to the typeName path parameter, attribute +key-value pair(s) can be provided in the following format: +attr:=. NOTE: The attrName and attrValue should be unique +across entities, eg. qualifiedName. The REST request would look something like +this: DELETE +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") + @delete + removeLabelsByUniqueAttribute is AtlasOperation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attribute?: string; + + @doc("set of labels to be deleted") + @body + body?: string[]; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Set labels to a given entity identified by its type and unique attributes. + +If +labels is null/empty, existing labels will all be removed. + +In addition to the +typeName path parameter, attribute key-value pair(s) can be provided in the +following format: attr:=. + +NOTE: The attrName and +attrValue should be unique across entities, eg. qualifiedName. + +The REST +request would look something like this: POST +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") + @post + setLabelsByUniqueAttribute is AtlasOperation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attribute?: string; + + @doc("set of labels to be set") + @body + body?: string[]; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Add given labels to a given entity identified by its type and unique +attributes. + +If labels is null/empty, no labels will be added. + +In addition to +the typeName path parameter, attribute key-value pair(s) can be provided in the +following format: attr:=. + +NOTE: The attrName and +attrValue should be unique across entities, eg. qualifiedName. + +The REST +request would look something like this: PUT +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") + @put + addLabelsByUniqueAttribute is AtlasOperation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attribute?: string; + + @doc("set of labels to be added") + @body + body?: string[]; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Move existing entities to the target collection.") + @route("/entity/moveTo") + @post + moveEntitiesToCollection is Azure.Core.Foundations.Operation< + { + @doc("The collection where entities will be moved to.") + @query + collectionId: string; + } & MoveEntitiesOptions, + EntityMutationResult, + {}, + AtlasErrorResponse + >; +} + +interface Glossary { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get all glossaries. Recommend using limit/offset to get pagination result. +Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories +separately using + + 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' +and + + 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'. +""") + @route("/atlas/v2/glossary") + @get + list is AtlasOperation< + { + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + + @doc("Whether ignore terms and categories") + @query + ignoreTermsAndCategories?: boolean; + }, + OkResponse, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Create a glossary.") + @route("/atlas/v2/glossary") + @post + create is AtlasOperation; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Create glossary category in bulk.") + @route("/atlas/v2/glossary/categories") + @post + createCategories is AtlasOperation< + { + @doc("An array of glossary category definitions to be created.") + @body + body: AtlasGlossaryCategory[]; + }, + OkResponse, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Create a glossary category.") + @route("/atlas/v2/glossary/category") + @post + createCategory is AtlasOperation< + AtlasGlossaryCategory, + AtlasGlossaryCategory, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get specific glossary category by its GUID.") + @route("/atlas/v2/glossary/category/{categoryId}") + @get + getCategory is AtlasOperation< + { + @doc("The globally unique identifier of the category.") + @path + categoryId: string; + }, + AtlasGlossaryCategory, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Update the given glossary category by its GUID.") + @route("/atlas/v2/glossary/category/{categoryId}") + @put + updateCategory is AtlasOperation< + { + @doc("The globally unique identifier of the category.") + @path + categoryId: string; + } & AtlasGlossaryCategory, + AtlasGlossaryCategory, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Delete a glossary category.") + @route("/atlas/v2/glossary/category/{categoryId}") + @delete + deleteCategory is AtlasOperation< + { + @doc("The globally unique identifier of the category.") + @path + categoryId: string; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc(""" +Update the glossary category partially. So far we only supports partial +updating shortDescription and longDescription for category. +""") + @route("/atlas/v2/glossary/category/{categoryId}/partial") + @put + partialUpdateCategory is AtlasOperation< + { + @doc("The globally unique identifier of the category.") + @path + categoryId: string; + + @doc(""" +A map containing keys as attribute names and values as corresponding attribute +values for partial update. +""") + @body + body: Record; + }, + AtlasGlossaryCategory, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Get all related categories (parent and children). Limit, offset, and sort +parameters are currently not being enabled and won't work even they are passed. +""") + @route("/atlas/v2/glossary/category/{categoryId}/related") + @get + listRelatedCategories is AtlasOperation< + { + @doc("The globally unique identifier of the category.") + @path + categoryId: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse>, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get all terms associated with the specific category.") + @route("/atlas/v2/glossary/category/{categoryId}/terms") + @get + listCategoryTerms is AtlasOperation< + { + @doc("The globally unique identifier of the category.") + @path + categoryId: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Create a glossary term.") + @route("/atlas/v2/glossary/term") + @post + createTerm is AtlasOperation< + { + @doc("Whether include term hierarchy") + @query + includeTermHierarchy?: boolean; + } & AtlasGlossaryTerm, + AtlasGlossaryTerm, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get a specific glossary term by its GUID. ") + @route("/atlas/v2/glossary/term/{termId}") + @get + getTerm is AtlasOperation< + { + @doc("The globally unique identifier for glossary term.") + @path + termId: string; + }, + AtlasGlossaryTerm, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Update the given glossary term by its GUID.") + @route("/atlas/v2/glossary/term/{termId}") + @put + updateTerm is AtlasOperation< + { + @doc("The globally unique identifier for glossary term.") + @path + termId: string; + + @doc("Whether include term hierarchy") + @query + includeTermHierarchy?: boolean; + } & AtlasGlossaryTerm, + AtlasGlossaryTerm, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Delete a glossary term.") + @route("/atlas/v2/glossary/term/{termId}") + @delete + deleteTerm is AtlasOperation< + { + @doc("The globally unique identifier for glossary term.") + @path + termId: string; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc(""" +Update the glossary term partially. So far we only supports partial updating +shortDescription, longDescription, abbreviation, usage and status for term. +""") + @route("/atlas/v2/glossary/term/{termId}/partial") + @put + partialUpdateTerm is AtlasOperation< + { + @doc("The globally unique identifier for glossary term.") + @path + termId: string; + + @doc("Whether include term hierarchy") + @query + includeTermHierarchy?: boolean; + + @doc(""" +A map containing keys as attribute names and values as corresponding attribute +values to be updated. +""") + @body + body: Record; + }, + AtlasGlossaryTerm, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Create glossary terms in bulk.") + @route("/atlas/v2/glossary/terms") + @post + createTerms is AtlasOperation< + { + @doc("Whether include term hierarchy") + @query + includeTermHierarchy?: boolean; + + @doc("An array of glossary term definitions to be created in bulk.") + @body + body: AtlasGlossaryTerm[]; + }, + OkResponse, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +List all related objects assigned with the specified term. Recommend using +limit/offset to get pagination result. +""") + @route("/atlas/v2/glossary/terms/{termId}/assignedEntities") + @get + listEntitiesAssignedWithTerm is AtlasOperation< + { + @doc("The globally unique identifier for glossary term.") + @path + termId: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Assign the given term to the provided list of related objects. Recommend using +small batches with multiple API calls. + +[Entities Create Or Update +operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) +is an alternative to assign a term to multiple entities. +""") + @route("/atlas/v2/glossary/terms/{termId}/assignedEntities") + @post + assignTermToEntities is AtlasOperation< + { + @doc("The globally unique identifier for glossary term.") + @path + termId: string; + + @doc("An array of related object IDs to which the term has to be associated.") + @body + body: AtlasRelatedObjectId[]; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Delete the term assignment for the given list of related objects.") + @route("/atlas/v2/glossary/terms/{termId}/assignedEntities") + @delete + deleteTermAssignmentFromEntities is AtlasOperation< + { + @doc("The globally unique identifier for glossary term.") + @path + termId: string; + + @doc("An array of related object IDs from which the term has to be dissociated.") + @body + body: AtlasRelatedObjectId[]; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get all related terms for a specific term by its GUID. Limit, offset, and sort +parameters are currently not being enabled and won't work even they are passed. +""") + @route("/atlas/v2/glossary/terms/{termId}/related") + @get + listRelatedTerms is AtlasOperation< + { + @doc("The globally unique identifier for glossary term.") + @path + termId: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse>, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get a specific Glossary by its GUID.") + @route("/atlas/v2/glossary/{glossaryId}") + @get + get is AtlasOperation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryId: string; + }, + AtlasGlossary, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Update the given glossary.") + @route("/atlas/v2/glossary/{glossaryId}") + @put + update is AtlasOperation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryId: string; + + @doc("Whether ignore terms and categories") + @query + ignoreTermsAndCategories?: boolean; + } & AtlasGlossary, + AtlasGlossary, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Delete a glossary. Will delete underlying terms/categories together. Recommend +separate delete terms and categories. +""") + @route("/atlas/v2/glossary/{glossaryId}") + @delete + delete is AtlasOperation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryId: string; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Get the categories belonging to a specific glossary. Recommend using +limit/offset to get pagination result. +""") + @route("/atlas/v2/glossary/{glossaryId}/categories") + @get + listCategories is AtlasOperation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryId: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Get the category headers belonging to a specific glossary. Recommend using +limit/offset to get pagination result. +""") + @route("/atlas/v2/glossary/{glossaryId}/categories/headers") + @get + listCategoriesHeaders is AtlasOperation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryId: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get a specific glossary with detailed information. This API is not +recommend. + +Recommend to fetch terms/categories details separately using + +GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and + +GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories. +""") + @route("/atlas/v2/glossary/{glossaryId}/detailed") + @get + getDetailed is AtlasOperation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryId: string; + }, + AtlasGlossaryExtInfo, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc(""" +Update the glossary partially. Some properties such as qualifiedName are not +allowed to be updated. + +So far we only supports partial updating +shortDescription, longDescription, language and usage for glossary. + +Recommend +using 'ignoreTermsAndCategories=true' to reduce response body size. +""") + @route("/atlas/v2/glossary/{glossaryId}/partial") + @put + partialUpdate is AtlasOperation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryId: string; + + @doc("Whether ignore terms and categories") + @query + ignoreTermsAndCategories?: boolean; + + @doc(""" +A map containing keys as attribute names and values as corresponding attribute +values. +""") + @body + body: Record; + }, + AtlasGlossary, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get terms belonging to a specific glossary. Recommend using limit/offset to get +pagination result. +""") + @route("/atlas/v2/glossary/{glossaryId}/terms") + @get + listTerms is AtlasOperation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryId: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Get term headers belonging to a specific glossary. Recommend using limit/offset +to get pagination result. +""") + @route("/atlas/v2/glossary/{glossaryId}/terms/headers") + @get + listTermHeaders is AtlasOperation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryId: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse, + {} + >; +} + +interface Discovery { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Get data using search.") + @route("/search/query") + @post + query is Azure.Core.Foundations.Operation< + QueryOptions, + QueryResult, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Get search suggestions by query criteria.") + @route("/search/suggest") + @post + suggest is Azure.Core.Foundations.Operation< + SuggestOptions, + SuggestResult, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Get auto complete options.") + @route("/search/autocomplete") + @post + autoComplete is Azure.Core.Foundations.Operation< + AutoCompleteOptions, + AutoCompleteResult, + {}, + AtlasErrorResponse + >; +} + +interface Lineage { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get lineage info of the entity specified by GUID.") + @route("/atlas/v2/lineage/{guid}") + @get + get is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The number of hops for lineage.") + @query + depth?: int32; + + @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") + @query + direction: LineageDirection; + }, + AtlasLineageInfo + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Return immediate next page lineage info about entity with pagination") + @route("/lineage/{guid}/next/") + @get + getNextPage is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") + @query + direction: LineageDirection; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + }, + AtlasLineageInfo, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Return lineage info about entity. + +In addition to the typeName path parameter, +attribute key-value pair(s) can be provided in the following +format + +attr:[attrName]=[attrValue] + +NOTE: The attrName and attrValue should be +unique across entities, eg. qualifiedName. + +The REST request would look +something like this: + +GET +/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/lineage/uniqueAttribute/type/{typeName}") + @get + getByUniqueAttribute is AtlasOperation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc("The number of hops for lineage.") + @query + depth?: int32; + + @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") + @query + direction: LineageDirection; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attribute?: string; + }, + AtlasLineageInfo, + {} + >; +} + +interface Relationship { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Create a new relationship between entities.") + @route("/atlas/v2/relationship") + @post + create is AtlasOperation; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Update an existing relationship between entities.") + @route("/atlas/v2/relationship") + @put + update is AtlasOperation; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get relationship information between entities by its GUID.") + @route("/atlas/v2/relationship/guid/{guid}") + @get + get is AtlasOperation< + { + @doc("The globally unique identifier of the relationship.") + @path + guid: string; + + @doc("Limits whether includes extended information.") + @query + extendedInfo?: boolean; + }, + AtlasRelationshipWithExtInfo, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Delete a relationship between entities by its GUID.") + @route("/atlas/v2/relationship/guid/{guid}") + @delete + delete is AtlasOperation< + { + @doc("The globally unique identifier of the relationship.") + @path + guid: string; + }, + void, + {} + >; +} + +interface Type { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the businessMetadata definition for the given guid.") + @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") + @get + getBusinessMetadataDefByGuid is AtlasOperation< + { + @doc("businessMetadata guid") + @path + guid: string; + }, + AtlasBusinessMetadataDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the businessMetadata definition by it's name (unique).") + @route("/atlas/v2/types/businessmetadatadef/name/{name}") + @get + getBusinessMetadataDefByName is AtlasOperation< + { + @doc("businessMetadata name") + @path + name: string; + }, + AtlasBusinessMetadataDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the classification definition for the given GUID.") + @route("/atlas/v2/types/classificationdef/guid/{guid}") + @get + getClassificationDefByGuid is AtlasOperation< + { + @doc("The globally unique identifier of the classification.") + @path + guid: string; + }, + AtlasClassificationDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the classification definition by its name (unique).") + @route("/atlas/v2/types/classificationdef/name/{name}") + @get + getClassificationDefByName is AtlasOperation< + { + @doc("The name of the classification.") + @path + name: string; + }, + AtlasClassificationDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the Entity definition for the given GUID.") + @route("/atlas/v2/types/entitydef/guid/{guid}") + @get + getEntityDefByGuid is AtlasOperation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + }, + AtlasEntityDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the entity definition by its name (unique).") + @route("/atlas/v2/types/entitydef/name/{name}") + @get + getEntityDefByName is AtlasOperation< + { + @doc("The name of the entity.") + @path + name: string; + }, + AtlasEntityDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the enum definition for the given GUID.") + @route("/atlas/v2/types/enumdef/guid/{guid}") + @get + getEnumDefByGuid is AtlasOperation< + { + @doc("The globally unique identifier of the enum.") + @path + guid: string; + }, + AtlasEnumDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the enum definition by its name (unique).") + @route("/atlas/v2/types/enumdef/name/{name}") + @get + getEnumDefByName is AtlasOperation< + { + @doc("The name of the enum.") + @path + name: string; + }, + AtlasEnumDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the relationship definition for the given GUID.") + @route("/atlas/v2/types/relationshipdef/guid/{guid}") + @get + getRelationshipDefByGuid is AtlasOperation< + { + @doc("The globally unique identifier of the relationship.") + @path + guid: string; + }, + AtlasRelationshipDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the relationship definition by its name (unique).") + @route("/atlas/v2/types/relationshipdef/name/{name}") + @get + getRelationshipDefByName is AtlasOperation< + { + @doc("The name of the relationship.") + @path + name: string; + }, + AtlasRelationshipDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the struct definition for the given GUID.") + @route("/atlas/v2/types/structdef/guid/{guid}") + @get + getStructDefByGuid is AtlasOperation< + { + @doc("The globally unique identifier of the struct.") + @path + guid: string; + }, + AtlasStructDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the struct definition by its name (unique).") + @route("/atlas/v2/types/structdef/name/{name}") + @get + getStructDefByName is AtlasOperation< + { + @doc("The name of the struct.") + @path + name: string; + }, + AtlasStructDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the type definition for the given GUID.") + @route("/atlas/v2/types/typedef/guid/{guid}") + @get + getByGuid is AtlasOperation< + { + @doc("The globally unique identifier of the type.") + @path + guid: string; + }, + AtlasTypeDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Get the type definition by its name (unique).") + @route("/atlas/v2/types/typedef/name/{name}") + @get + getByName is AtlasOperation< + { + @doc("The name of the type.") + @path + name: string; + }, + AtlasTypeDef, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Delete API for type identified by its name.") + @route("/atlas/v2/types/typedef/name/{name}") + @delete + delete is AtlasOperation< + { + @doc("The name of the type.") + @path + name: string; + }, + void, + {} + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("List all type definitions in bulk.") + @route("/atlas/v2/types/typedefs") + @get + list is AtlasOperation< + { + @doc(""" +Whether include termtemplatedef when return all typedefs. +This is always true +when search filter type=term_template +""") + @query + includeTermTemplate?: boolean; + + @doc("Typedef name as search filter when get typedefs.") + @query + type?: TypeCategory; + }, + AtlasTypesDef, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Create all atlas type definitions in bulk, only new definitions will be +created. +Any changes to the existing definitions will be discarded. +""") + @route("/atlas/v2/types/typedefs") + @post + bulkCreate is AtlasOperation; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc(""" +Update all types in bulk, changes detected in the type definitions would be +persisted. +""") + @route("/atlas/v2/types/typedefs") + @put + bulkUpdate is AtlasOperation; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" + @doc("Delete API for all types in bulk.") + @route("/atlas/v2/types/typedefs") + @delete + bulkDelete is AtlasOperation; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("List all type definitions returned as a list of minimal information header.") + @route("/atlas/v2/types/typedefs/headers") + @get + listHeaders is AtlasOperation< + { + @doc(""" +Whether include termtemplatedef when return all typedefs. +This is always true +when search filter type=term_template +""") + @query + includeTermTemplate?: boolean; + + @doc("Typedef name as search filter when get typedefs.") + @query + type?: TypeCategory; + }, + OkResponse, + AtlasApiVersionParameterTraits + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Get the term template definition for the given GUID.") + @route("/types/termtemplatedef/guid/{guid}") + @get + getTermTemplateDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the term template.") + @path + guid: string; + }, + TermTemplateDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Get the term template definition by its name (unique).") + @route("/types/termtemplatedef/name/{name}") + @get + getTermTemplateDefByName is Azure.Core.Foundations.Operation< + { + @doc("The unique name of the term template.") + @path + name: string; + }, + TermTemplateDef, + {}, + AtlasErrorResponse + >; +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml new file mode 100644 index 000000000000..16d1cc8f38c8 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -0,0 +1,37 @@ +parameters: + "service-dir": + default: "sdk/purview" + "dependencies": + "additionalDirectories": [] + default: "" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" + emitter-output-dir: "{project-root}/.." + examples-directory: "{project-root}/examples" + output-file: "{azure-resource-provider-folder}/Azure.Analytics.Purview.DataMap/{version-status}/{version}/purviewdatamap.json" + omit-unreachable-types: true + "@azure-tools/typespec-python": + package-dir: "azure-purview-datamap" + package-name: "{package-dir}" + package-mode: dataplane + "@azure-tools/typespec-csharp": + package-dir: "Azure.Analytics.Purview.DataMap" + namespace: "{package-dir}" + clear-output-folder: true + model-namespace: false + "@azure-tools/typespec-ts": + package-dir: "purview-datamap-rest" + generateMetadata: true + generateTest: true + packageDetails: + name: "@azure-rest/purview-datamap" + description: Purview DataMap Service" + "@azure-tools/typespec-java": + package-dir: "azure-analytics-purview-datamap" + namespace: com.azure.analytics.purview.datamap +linter: + extends: + - "@azure-tools/typespec-azure-core/all" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json index 6f9992091ded..b2f2665d5b36 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "autoCompleteRequest": { + "body": { "keywords": "exa", "filter": { "and": [ @@ -34,5 +34,7 @@ ] } } - } + }, + "title": "Discovery_AutoComplete", + "operationId": "Discovery_AutoComplete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json index 01a3c24a0366..a7cde65a400e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -103,5 +103,7 @@ ] } } - } + }, + "title": "Discovery_Query", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json index 510076af8094..a1f45773a687 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -74,5 +74,7 @@ ] } } - } + }, + "title": "Discovery_Query_And", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json index a18f77f11ea4..7ec39b19f500 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -91,5 +91,7 @@ ] } } - } + }, + "title": "Discovery_Query_AndOrNested", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json index 6f134d2cbc92..deb289d5ea22 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -134,5 +134,7 @@ ] } } - } + }, + "title": "Discovery_Query_AssetType", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json index 33e68dd2cc70..6d2ccf524020 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -91,5 +91,7 @@ ] } } - } + }, + "title": "Discovery_Query_Attribute", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json index 49a647d73822..2ab33726a034 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -48,5 +48,7 @@ ] } } - } + }, + "title": "Discovery_Query_BusinessMetadataAttribute", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json index 1652e3eb3967..5150545e7d0f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -63,5 +63,7 @@ ] } } - } + }, + "title": "Discovery_Query_Classification", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json index 8d51d3b6a9c9..3779d9d497fe 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -62,5 +62,7 @@ ] } } - } + }, + "title": "Discovery_Query_Collection", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json index d68b074a230f..b417487bea7d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "filter": { "objectType": "Tables" @@ -144,5 +144,7 @@ ] } } - } + }, + "title": "Discovery_Query_Facet", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json index 9c2aed22a521..0b7fee10f958 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -56,5 +56,7 @@ ] } } - } + }, + "title": "Discovery_Query_FileExtension", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json index 15d04904849c..1af1169192d0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "", "limit": 10, "filter": { @@ -90,5 +90,7 @@ } } } - } + }, + "title": "Discovery_Query_GlossaryTerm", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json index a239b38b5c50..1a983534fbce 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -39,5 +39,7 @@ ] } } - } + }, + "title": "Discovery_Query_Id", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json index 004b8283ffc2..4c6b90d682c4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Discovery_Query_Not", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json index a75ed71cd1e4..f332749b05ee 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json @@ -1,37 +1,35 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { "or": [ - [ - { - "objectType": "Dashboards" - }, - { - "objectType": "Data pipelines" - }, - { - "objectType": "Files" - }, - { - "objectType": "Folders" - }, - { - "objectType": "Glossary terms" - }, - { - "objectType": "Reports" - }, - { - "objectType": "Stored procedures" - }, - { - "objectType": "Tables" - } - ] + { + "objectType": "Dashboards" + }, + { + "objectType": "Data pipelines" + }, + { + "objectType": "Files" + }, + { + "objectType": "Folders" + }, + { + "objectType": "Glossary terms" + }, + { + "objectType": "Reports" + }, + { + "objectType": "Stored procedures" + }, + { + "objectType": "Tables" + } ] } }, @@ -71,5 +69,7 @@ ] } } - } + }, + "title": "Discovery_Query_ObjectType", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json index 99220e6552d4..cbe86e93e8fa 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -105,5 +105,7 @@ ] } } - } + }, + "title": "Discovery_Query_PaginationContinuationPage", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json index 9de3ad93b2b7..fe5522da8ebf 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -104,5 +104,7 @@ ] } } - } + }, + "title": "Discovery_Query_PaginationFirstPage", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json index 7320000e5082..4e64dd33405e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -104,5 +104,7 @@ ] } } - } + }, + "title": "Discovery_Query_PaginationLastPage", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json index bde144d66d3f..d2196fa7ea91 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -49,5 +49,7 @@ ] } } - } + }, + "title": "Discovery_Query_SystemTime", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json index 6b05a5985854..f2f278e5c48b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -88,5 +88,7 @@ ] } } - } + }, + "title": "Discovery_Query_Taxonomy", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json index 576c69a243c5..0c24709432b3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "", "limit": 3, "filter": { @@ -53,5 +53,7 @@ ] } } - } + }, + "title": "Discovery_Query_TermAssignment", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json index f78c96dd68ac..48480e13fc17 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -60,5 +60,7 @@ ] } } - } + }, + "title": "Discovery_Query_Type", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json index f0886ed0c690..3ff80bee52ec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "suggestRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Discovery_Suggest", + "operationId": "Discovery_Suggest" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json index c955f4586918..b94ab95331ec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "request": { + "body": { "classification": { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "attributes": {}, @@ -15,5 +15,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddClassificationToEntityByGuids", + "operationId": "Entity_AddClassification" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json index 6aa11763de71..5ab64b05faac 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", - "classifications": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "entityGuid": "cc0730ba-9b30-41f0-6953-559d17626d2b" @@ -15,5 +15,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddClassifications", + "operationId": "Entity_AddClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json index e82bbe57a2f3..0a724e78e134 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasClassificationArray": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, @@ -14,5 +14,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddClassificationsByUniqueAttribute", + "operationId": "Entity_AddClassificationsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json index 5fafde7ea05e..5e50da3bc1c7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entity": { + "api-version": "2023-09-01", + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -51,5 +52,7 @@ } } } - } + }, + "title": "Entity_AddCustomAttribute", + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json new file mode 100644 index 000000000000..6c8c8ccf153d --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": [ + "label1", + "label2" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_AddLabel", + "operationId": "Entity_AddLabel" +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json index 8d60d206619e..3a2bc5a3f537 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json @@ -9,5 +9,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddLabelsByUniqueAttribute", + "operationId": "Entity_AddLabelsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json index 6335668124ae..f91a2897c1e2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json @@ -2,12 +2,14 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "bmName": "myBizMetaData1", + "businessMetadataName": "myBizMetaData1", "body": { "bizAttr1": "bizAttr1" } }, "responses": { "204": {} - } + }, + "title": "Entity_AddOrUpdate_BusinessAttribute", + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessMetadata.json new file mode 100644 index 000000000000..4141a16cc255 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessMetadata.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": { + "myBizMetadata1": { + "bizAttr1": "myBizMetaData1.bizAttr1" + } + } + }, + "responses": { + "204": {} + }, + "title": "Entity_AddOrUpdate_BusinessMetadata", + "operationId": "Entity_AddOrUpdateBusinessMetadata" +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json index 779992eff9ba..81eb02f76d2e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entities": { + "body": { "referredEntities": {}, "entities": [ { @@ -100,5 +100,7 @@ } } } - } + }, + "title": "Entity_BulkCreateOrUpdate", + "operationId": "Entity_BulkCreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json index 067d745f66c1..3b8c27b9b5fc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json @@ -31,5 +31,7 @@ } } } - } + }, + "title": "Entity_BulkDelete", + "operationId": "Entity_BulkDelete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json index 907bbe9c1e97..ceac402f49a7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entityHeaders": { + "body": { "guidHeaderMap": { "9fb74c11-ac48-4650-95bc-760665c5bd92": { "attributes": { @@ -35,5 +35,7 @@ "Update:7fcc43ab-55ea-45d4-9971-ce0443cb10bb:azure_storage_account:qualifiedName -> MICROSOFT.PERSONAL.IPADDRESS:(Done)" ] } - } + }, + "title": "Entity_BulkSetClassifications", + "operationId": "Entity_BulkSetClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json index b4946962b191..cf8647830754 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entity": { + "api-version": "2023-09-01", + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -56,5 +57,7 @@ } } } - } + }, + "title": "Entity_Create", + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json index 029021e09916..9e6ab2104d44 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json @@ -23,5 +23,7 @@ } } } - } + }, + "title": "Entity_Delete", + "operationId": "Entity_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json index 34948b6504ab..3df1ba7cee96 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json @@ -29,5 +29,7 @@ } } } - } + }, + "title": "Entity_DeleteByUniqueAttribute", + "operationId": "Entity_DeleteByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json index 918d06e41adc..4c89ab5c8872 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb" + "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", + "minExtInfo": true }, "responses": { "200": { @@ -57,5 +58,7 @@ } } } - } + }, + "title": "Entity_Get", + "operationId": "Entity_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json index 1985ed6cb10e..f7ebf7d7d013 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json @@ -2,7 +2,8 @@ "parameters": { "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", - "attr:qualifiedName": "https://exampleaccount.core.windows.net" + "attr:qualifiedName": "https://exampleaccount.core.windows.net", + "minExtInfo": true }, "responses": { "200": { @@ -31,5 +32,7 @@ "referredEntities": {} } } - } + }, + "title": "Entity_GetByUniqueAttributes", + "operationId": "Entity_GetByUniqueAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json index 1d976b1e21e0..968a4d7e0fcc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json @@ -13,5 +13,7 @@ "entityStatus": "ACTIVE" } } - } + }, + "title": "Entity_GetClassification", + "operationId": "Entity_GetClassification" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json index 8f89220119d7..ae0d81292c04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json @@ -18,5 +18,7 @@ "sortType": "NONE" } } - } + }, + "title": "Entity_GetClassifications", + "operationId": "Entity_GetClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json index c9ae29bce60d..029a55bbbb96 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json @@ -24,5 +24,7 @@ "typeName": "azure_storage_account" } } - } + }, + "title": "Entity_GetHeader", + "operationId": "Entity_GetHeader" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json index b25d5b0cc239..34f5b284ae4b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json @@ -1,10 +1,13 @@ { "parameters": { - "Endpoint": "{Endpoint}" + "Endpoint": "{Endpoint}", + "api-version": "2023-09-01" }, "responses": { "200": { "body": "EntityType,EntityUniqueAttributeValue,BusinessAttributeName,BusinessAttributeValue,EntityUniqueAttributeName[optional]" } - } + }, + "title": "Entity_GetSampleBusinessMetadataTemplate", + "operationId": "Entity_GetSampleBusinessMetadataTemplate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json index 37325e736386..5717a38aa7c8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "file": "examplefile.csv" + "file": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" }, "responses": { "200": { @@ -16,5 +16,7 @@ ] } } - } + }, + "title": "Entity_ImportBusinessMetadata", + "operationId": "Entity_ImportBusinessMetadata" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json index 8d8754364eed..4f48451cdbbe 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json @@ -4,7 +4,8 @@ "guid": [ "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" - ] + ], + "minExtInfo": true }, "responses": { "200": { @@ -110,5 +111,7 @@ ] } } - } + }, + "title": "Entity_ListByGuids", + "operationId": "Entity_ListByGuids" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json index 16c42a58932e..176e6972162b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json @@ -2,7 +2,8 @@ "parameters": { "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", - "attr_N:qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1" + "attr_N:qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", + "minExtInfo": true }, "responses": { "200": { @@ -46,5 +47,7 @@ ] } } - } + }, + "title": "Entity_ListByUniqueAttributes", + "operationId": "Entity_ListByUniqueAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json index 42e6555a9f4e..a9d546dacff1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "collectionId": "ExampleNewCollection", "api-version": "2023-09-01", - "moveEntitiesRequest": { + "body": { "entityGuids": [ "321493e3-3fb7-4b3e-9df7-3b69154174c2", "b2f9c306-cf65-4bb0-878e-cfaafde156b1" @@ -41,5 +41,7 @@ } } } - } + }, + "title": "Entity_MoveEntitiesToCollection", + "operationId": "Entity_MoveEntitiesToCollection" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json index 343a0b2ecb25..4320bdb7e9a7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json @@ -33,5 +33,7 @@ ] } } - } + }, + "title": "Entity_PartialUpdateAttributeByGuid", + "operationId": "Entity_PartialUpdateAttributeByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json index a38dc403ff1d..40609617bfa7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json @@ -3,9 +3,9 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasEntityWithExtInfo": { + "body": { "entity": { - "createTime": 1.605766397985E12, + "createTime": 1605766397985.0, "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", "relationshipAttributes": { @@ -13,7 +13,7 @@ "meanings": [] }, "status": "ACTIVE", - "updateTime": 1.605766397985E12, + "updateTime": 1605766397985.0, "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", "lastModifiedTS": "1", "version": 0.0, @@ -56,5 +56,7 @@ ] } } - } + }, + "title": "Entity_PartialUpdateByUniqueAttributes", + "operationId": "Entity_PartialUpdateByUniqueAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json index 6335668124ae..717225e30454 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json @@ -2,12 +2,14 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "bmName": "myBizMetaData1", + "businessMetadataName": "myBizMetaData1", "body": { "bizAttr1": "bizAttr1" } }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveBusinessAttribute", + "operationId": "Entity_RemoveBusinessMetadataAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json index 9292ad587d04..9e2de7361e36 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json @@ -10,5 +10,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveBusinessMetadata", + "operationId": "Entity_RemoveBusinessMetadata" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json index 0967940bc811..408744950b01 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json @@ -6,5 +6,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveClassification", + "operationId": "Entity_RemoveClassification" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json index 4d2cc9927070..75717c4f59ad 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json @@ -7,5 +7,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveClassificationByUniqueAttribute", + "operationId": "Entity_RemoveClassificationByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json new file mode 100644 index 000000000000..743f676c786b --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": [ + "label1", + "label2" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveLabels", + "operationId": "Entity_RemoveLabels" +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json index 8479ed0cfe43..3ae4c0b565f8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json @@ -9,5 +9,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveLabelsByUniqueAttribute", + "operationId": "Entity_RemoveLabelsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json new file mode 100644 index 000000000000..e2b2c2eb6344 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": [ + "label1", + "label2" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_SetLabels", + "operationId": "Entity_SetLabels" +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json index b2132f45f70b..9ffba096b022 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json @@ -10,5 +10,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_SetLabelsByUniqueAttribute", + "operationId": "Entity_SetLabelsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json index 56799529f337..40e2350403a5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entity": { + "api-version": "2023-09-01", + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -55,5 +56,7 @@ } } } - } + }, + "title": "Entity_Update", + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json index d558a272e7ea..274b565b8f81 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", - "classifications": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", "entityGuid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24" @@ -15,5 +15,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_UpdateClassifications", + "operationId": "Entity_UpdateClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json index e82bbe57a2f3..f3b1777a8e75 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasClassificationArray": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, @@ -14,5 +14,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_UpdateClassificationsByUniqueAttribute", + "operationId": "Entity_UpdateClassificationsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json index 5ff085189499..82aae3a1b087 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "relatedObjectIds": [ + "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "body": [ { "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", "relationshipAttributes": { @@ -18,5 +18,7 @@ }, "responses": { "204": {} - } + }, + "title": "Glossary_AssignTermToEntities", + "operationId": "Glossary_AssignTermToEntities" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json index a1ec9e6bee07..01289fd09ee1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "atlasGlossary": { + "body": { "name": "Glossary", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", @@ -26,5 +26,7 @@ "updateTime": 1672892675688 } } - } + }, + "title": "Glossary_Create", + "operationId": "Glossary_Create" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json index 17a515af1f09..7dfb49f4e1ae 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryCategory": [ + "body": [ { "name": "ExampleCategory2", "anchor": { @@ -41,5 +41,7 @@ } ] } - } + }, + "title": "Glossary_CreateCategories", + "operationId": "Glossary_CreateCategories" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json index 7f31caaea342..912e40a4e7ef 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryCategory": { + "body": { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, @@ -33,5 +33,7 @@ ] } } - } + }, + "title": "Glossary_CreateCategory", + "operationId": "Glossary_CreateCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json index efd7d2d547b2..bd988ea6973b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": { + "body": { "name": "ExampleTerm1", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", @@ -72,5 +72,7 @@ } } } - } + }, + "title": "Glossary_CreateTerm", + "operationId": "Glossary_CreateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json index c9b7795a1b04..677877660bc8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": { + "body": { "name": "ExampleTerm", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" @@ -47,5 +47,7 @@ } } } - } + }, + "title": "Glossary_CreateTermWithTemplate", + "operationId": "Glossary_CreateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json index ddd48b3a0782..18fcddae9a04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": [ + "body": [ { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" @@ -87,5 +87,7 @@ } ] } - } + }, + "title": "Glossary_CreateTerms", + "operationId": "Glossary_CreateTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json index 70b4059decdd..88b82510fb9f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json @@ -1,9 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c0c54153-13d1-1608-13af-43457cdffe75" + "glossaryId": "c0c54153-13d1-1608-13af-43457cdffe75" }, "responses": { "204": {} - } + }, + "title": "Glossary_Delete", + "operationId": "Glossary_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json index 678b949d55e5..c281cd4c2450 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json @@ -1,9 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "0e391355-252a-e5f3-ac18-5a3602df7616" + "categoryId": "0e391355-252a-e5f3-ac18-5a3602df7616" }, "responses": { "204": {} - } + }, + "title": "Glossary_DeleteCategory", + "operationId": "Glossary_DeleteCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json index 32fd415f64d5..7fa8e97b845a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json @@ -1,9 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" + "termId": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" }, "responses": { "204": {} - } + }, + "title": "Glossary_DeleteTerm", + "operationId": "Glossary_DeleteTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json index 1eb2a13b1f0b..6e1aaeaa5786 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "47029611-67a1-42d5-8766-90eb904f7f22" + "glossaryId": "47029611-67a1-42d5-8766-90eb904f7f22" }, "responses": { "200": { @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Glossary_Get", + "operationId": "Glossary_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json index 2329430d0e4d..1de42a99f57e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" }, "responses": { "200": { @@ -35,5 +35,7 @@ ] } } - } + }, + "title": "Glossary_GetCategory", + "operationId": "Glossary_GetCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json index f5aea38d5f1d..0345a931a976 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, "responses": { "200": { @@ -225,5 +225,7 @@ } } } - } + }, + "title": "Glossary_GetDetailed", + "operationId": "Glossary_GetDetailed" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json index d1bf7157bbed..3b574ac3e20f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea" + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea" }, "responses": { "200": { @@ -80,5 +80,7 @@ ] } } - } + }, + "title": "Glossary_GetTerm", + "operationId": "Glossary_GetTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json index c0dcc7655580..3bedbf11a9a4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "excludeRelationshipTypes": [ "AtlasGlossarySemanticAssignment" ] @@ -60,5 +60,7 @@ ] } } - } + }, + "title": "Glossary_GetTermWithoutAssets", + "operationId": "Glossary_GetTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json index f8bc74ada7f4..c454ce6b68f7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json @@ -55,5 +55,7 @@ } ] } - } + }, + "title": "Glossary_List", + "operationId": "Glossary_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json index aabcc66dc2d0..30e8cf73dbfd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -68,5 +68,7 @@ } ] } - } + }, + "title": "Glossary_ListCategories", + "operationId": "Glossary_ListCategories" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json index 277c967f7f0b..a04eb3cba127 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -28,5 +28,7 @@ } ] } - } + }, + "title": "Glossary_ListCategoriesHeaders", + "operationId": "Glossary_ListCategoriesHeaders" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json index 7fe35d8dd8f2..e1a99139221b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" @@ -16,5 +16,7 @@ } ] } - } + }, + "title": "Glossary_ListCategoryTerms", + "operationId": "Glossary_ListCategoryTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json index ebfed3c2de40..99c872e87c99 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", + "termId": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", "limit": "-1", "offset": "0", "sort": "ASC" @@ -53,5 +53,7 @@ } ] } - } + }, + "title": "Glossary_ListEntitiesAssignedWithTerm", + "operationId": "Glossary_ListEntitiesAssignedWithTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json index 7523745867a5..2e845fcb0944 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" @@ -25,5 +25,7 @@ ] } } - } + }, + "title": "Glossary_ListRelatedCategories", + "operationId": "Glossary_ListRelatedCategories" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json index ca90bb6d08d7..56999a9dd79a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "limit": "-1", "offset": "0", "sort": "ASC" @@ -25,5 +25,7 @@ ] } } - } + }, + "title": "Glossary_ListRelatedTerms", + "operationId": "Glossary_ListRelatedTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json index 1375aa567f2b..6bcfbe8c9fc9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -21,5 +21,7 @@ } ] } - } + }, + "title": "Glossary_ListTermHeaders", + "operationId": "Glossary_ListTermHeaders" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json index 214bbd4c4f76..583aa635b462 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -99,5 +99,7 @@ } ] } - } + }, + "title": "Glossary_ListTerms", + "operationId": "Glossary_ListTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json index 4df90166a6b6..c06db55d9e38 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "partialUpdates": { + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "body": { "longDescription": "Example Long Description" } }, @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Glossary_PartialUpdate", + "operationId": "Glossary_PartialUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json index 11516593b6bd..15be08095e73 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9", - "partialUpdates": { + "categoryId": "3243ea0a-9492-47e1-392e-a84e64980af9", + "body": { "longDescription": "Example Long Description" } }, @@ -39,5 +39,7 @@ ] } } - } + }, + "title": "Glossary_PartialUpdateCategory", + "operationId": "Glossary_PartialUpdateCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json index 572d692fa4b6..356a70cf4da3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json @@ -1,9 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "partialUpdates": { - "longDescription": "Example Long Descrition" + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "body": { + "longDescription": "Example Long Description" } }, "responses": { @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Glossary_PartialUpdateTerm", + "operationId": "Glossary_PartialUpdateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json index ca978c5df1fc..2238f2443727 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "relatedObjectIds": [ + "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "body": [ { "guid": "16feb2a1-2c79-ade1-338d-fb24fcb8b8bd", "relationshipGuid": "624f08bb-3c93-4f03-9ce1-ed2ce2c7c8d5" @@ -11,5 +11,7 @@ }, "responses": { "204": {} - } + }, + "title": "Glossary_RemoveTermAssignmentFromEntities", + "operationId": "Glossary_DeleteTermAssignmentFromEntities" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json index ac2868693994..faca8b5cb2a2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "updatedGlossary": { + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "body": { "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", @@ -92,5 +92,7 @@ ] } } - } + }, + "title": "Glossary_Update", + "operationId": "Glossary_Update" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json index fb8c92c94fd5..7c145590a59b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "glossaryCategory": { + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "body": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "qualifiedName": "ExampleCategory1@Glossary", "name": "ExampleCategory1", @@ -59,5 +59,7 @@ ] } } - } + }, + "title": "Glossary_UpdateCategory", + "operationId": "Glossary_UpdateCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json index 065bba39f639..9ed4cb3964b7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "glossaryTerm": { + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "body": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", "qualifiedName": "ExampleTerm1@Glossary", "name": "ExampleTerm1", @@ -88,5 +88,7 @@ ] } } - } + }, + "title": "Glossary_UpdateTerm", + "operationId": "Glossary_UpdateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json index 122a1804289c..a08de217b1c0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json @@ -20,5 +20,7 @@ "parentRelations": [] } } - } + }, + "title": "Lineage_Get", + "operationId": "Lineage_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json index 4b9886deec69..ab738e50995b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json @@ -59,5 +59,7 @@ } } } - } + }, + "title": "Lineage_GetByUniqueAttribute", + "operationId": "Lineage_GetByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json index 66f7aac1fb7a..778a391f5b59 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json @@ -21,5 +21,7 @@ "parentRelations": [] } } - } + }, + "title": "Lineage_GetNextPage", + "operationId": "Lineage_GetNextPage" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json index 8122eee5cd3a..89d3b4e5afec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "relationship": { + "body": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", @@ -54,5 +54,7 @@ "version": 0 } } - } + }, + "title": "Relationship_Create", + "operationId": "Relationship_Create" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json index 291912c8ccac..c6e4848b9952 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json @@ -5,5 +5,7 @@ }, "responses": { "204": {} - } + }, + "title": "Relationship_Delete", + "operationId": "Relationship_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json index 7a9054f95285..182684f354bd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json @@ -35,5 +35,7 @@ } } } - } + }, + "title": "Relationship_Get", + "operationId": "Relationship_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json index 3664c81a3ec7..0cd955fe3154 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "relationship": { + "body": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", @@ -55,5 +55,7 @@ "version": 0 } } - } + }, + "title": "Relationship_Update", + "operationId": "Relationship_Update" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json index 3c08502d3e0f..d91723b6e888 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -67,5 +67,7 @@ "relationshipDefs": [] } } - } + }, + "title": "Type_BulkCreate", + "operationId": "Type_BulkCreate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json index 66e7d50e8570..433ff8867948 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -71,5 +71,7 @@ ] } } - } + }, + "title": "Type_BulkCreateBusinessMetadataDefs", + "operationId": "Type_BulkCreate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json index 40e463be1ce9..60ba8acc3b75 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -29,5 +29,7 @@ }, "responses": { "204": {} - } + }, + "title": "Type_BulkDelete", + "operationId": "Type_BulkDelete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json index fd37acb1ec1c..7905abbea1af 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -284,5 +284,7 @@ ] } } - } + }, + "title": "Type_BulkUpdate", + "operationId": "Type_BulkUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json index d95c0728b9cb..8a364027401e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json @@ -5,5 +5,7 @@ }, "responses": { "204": {} - } + }, + "title": "Type_Delete", + "operationId": "Type_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json index 5790a0df446e..34921a8239b7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetBusinessMetadataDefByGuid", + "operationId": "Type_GetBusinessMetadataDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json index 89abf18c256d..64d92fefd723 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetBusinessMetadataDefByName", + "operationId": "Type_GetBusinessMetadataDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json index ebd1ed4902de..e94b5ad8b518 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetByGuid", + "operationId": "Type_GetByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json index 77ec05812c26..804029d070e1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetByName", + "operationId": "Type_GetByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json index 31f09a6d61e6..bf27840af6aa 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json @@ -22,5 +22,7 @@ "subTypes": [] } } - } + }, + "title": "Type_GetClassificationDefByGuid", + "operationId": "Type_GetClassificationDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json index b7d7ed8a4f74..e7a58bf32bfb 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json @@ -22,5 +22,7 @@ "subTypes": [] } } - } + }, + "title": "Type_GetClassificationDefByName", + "operationId": "Type_GetClassificationDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json index 2728fb2507c3..9c0d6ce53cb7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json @@ -52,5 +52,7 @@ ] } } - } + }, + "title": "Type_GetEntityDefByGuid", + "operationId": "Type_GetEntityDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json index 0542db979369..140ba1a5b309 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json @@ -52,5 +52,7 @@ ] } } - } + }, + "title": "Type_GetEntityDefByName", + "operationId": "Type_GetEntityDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json index 9c324ce8d35b..ab9e4048b0d2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json @@ -32,5 +32,7 @@ ] } } - } + }, + "title": "Type_GetEnumDefByGuid", + "operationId": "Type_GetEnumDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json index 6adfee266b61..62907f8f6a69 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json @@ -32,5 +32,7 @@ ] } } - } + }, + "title": "Type_GetEnumDefByName", + "operationId": "Type_GetEnumDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json index 66b6efd3f8bf..71c9a03a65d9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json @@ -35,5 +35,7 @@ "relationshipLabel": "r:storm_topology_nodes" } } - } + }, + "title": "Type_GetRelationshipDefByGuid", + "operationId": "Type_GetRelationshipDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json index 148c7d655371..ecdafc07a934 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json @@ -35,5 +35,7 @@ "relationshipLabel": "r:storm_topology_nodes" } } - } + }, + "title": "Type_GetRelationshipDefByName", + "operationId": "Type_GetRelationshipDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json index d2e1e0901f30..c31ae06aeeb6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json @@ -42,5 +42,7 @@ ] } } - } + }, + "title": "Type_GetStructDefByGuid", + "operationId": "Type_GetStructDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json index 6bffd4888fa2..26f8e843a6d6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json @@ -42,5 +42,7 @@ ] } } - } + }, + "title": "Type_GetStructDefByName", + "operationId": "Type_GetStructDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json index fc5c6208e066..e6c263c691e5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json @@ -79,5 +79,7 @@ ] } } - } + }, + "title": "Type_GetTermTemplateDefByGuid", + "operationId": "Type_GetTermTemplateDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json index 72f8d97172d8..d8b28d19db05 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json @@ -79,5 +79,7 @@ ] } } - } + }, + "title": "Type_GetTermTemplateDefByName", + "operationId": "Type_GetTermTemplateDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json index 4e6b37b8b6f1..1dd18ffe0898 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "includeTermTemplate": true + "includeTermTemplate": true, + "api-version": "2023-09-01" }, "responses": { "200": { @@ -265,5 +266,7 @@ ] } } - } + }, + "title": "Type_List", + "operationId": "Type_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json index 0c3b2d78f851..99b6f55910b0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "type": "enum" + "type": "ENUM", + "api-version": "2023-09-01" }, "responses": { "200": { @@ -86,5 +87,7 @@ "relationshipDefs": [] } } - } + }, + "title": "Type_ListEnumDefs", + "operationId": "Type_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json index 99ec7d9d00b2..288c815d8a88 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json @@ -23,5 +23,7 @@ } ] } - } + }, + "title": "Type_ListHeaders", + "operationId": "Type_ListHeaders" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json index 26902f2461c6..c5336e63031c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "type": "term_template" + "type": "TERM_TEMPLATE", + "api-version": "2023-09-01" }, "responses": { "200": { @@ -87,5 +88,7 @@ ] } } - } + }, + "title": "Type_ListTermTemplateDefs", + "operationId": "Type_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 9a893b74e1d1..800ef24b4921 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -1,115 +1,147 @@ { "swagger": "2.0", "info": { - "title": "Purview Data Map Service REST API Document", - "description": "Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Map helps organizations get more value from their existing investments. This spec defines REST API of Purview Data Map Service.", - "version": "2023-09-01" + "title": "Azure Analytics Purview Data Map", + "version": "2023-09-01", + "description": "Purview Data Map Service is a fully managed cloud service whose users can\ndiscover the data sources they need and understand the data sources they find.\nAt the same time, Data Map helps organizations get more value from their\nexisting investments. This spec defines REST API of Purview Data Map Service.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] }, + "schemes": [ + "https" + ], "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", + "hostTemplate": "{endpoint}/datamap/api", "useSchemePrefix": false, "parameters": [ { - "$ref": "#/parameters/endpoint" + "name": "endpoint", + "in": "path", + "required": true, + "type": "string" } ] }, - "basePath": "/datamap/api", - "schemes": [ - "https" + "produces": [ + "application/json" ], "consumes": [ "application/json" ], - "produces": [ - "application/json" + "security": [ + { + "OAuth2Auth": [ + "https://purview.azure.net/.default" + ] + } ], "securityDefinitions": { - "azure_auth": { + "OAuth2Auth": { + "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow." + "https://purview.azure.net/.default": "" + } } }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], + "tags": [], "paths": { "/atlas/v2/entity": { "post": { - "tags": [ - "Entity" - ], - "description": "Create or update an entity.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName.\nMap and array of collections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", "operationId": "Entity_CreateOrUpdate", - "x-ms-examples": { - "Entity_Create": { - "$ref": "./examples/Entity_Create.json" + "description": "Create or update an entity.\nExisting entity is matched using its unique guid if\nsupplied or by its unique attributes eg: qualifiedName.\nMap and array of\ncollections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", + "parameters": [ + { + "$ref": "#/parameters/AtlasApiVersionParameter" }, - "Entity_Update": { - "$ref": "./examples/Entity_Update.json" + { + "name": "businessAttributeUpdateBehavior", + "in": "query", + "description": "Used to define the update behavior for business attributes when updating\nentities.", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "Ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "Replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "Merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", + "required": false, + "type": "string" }, - "Entity_AddCustomAttribute": { - "$ref": "./examples/Entity_AddCustomAttribute.json" - } - }, - "parameters": [ { + "name": "body", "in": "body", - "name": "entity", - "description": "Atlas entity with extended information.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntityWithExtInfo" } - }, - { - "$ref": "#/parameters/businessAttributeUpdateBehavior" - }, - { - "$ref": "#/parameters/collectionId" - }, - { - "$ref": "#/parameters/atlasAPIVersion" } ], "responses": { "200": { - "description": "Created with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddCustomAttribute": { + "$ref": "./examples/Entity_AddCustomAttribute.json" + }, + "Entity_Create": { + "$ref": "./examples/Entity_Create.json" + }, + "Entity_Update": { + "$ref": "./examples/Entity_Update.json" + } } } }, "/atlas/v2/entity/bulk": { "get": { - "tags": [ - "Entity" - ], - "description": "List entities in bulk identified by its GUIDs.", "operationId": "Entity_ListByGuids", - "x-ms-examples": { - "Entity_ListByGuids": { - "$ref": "./examples/Entity_ListByGuids.json" - } - }, + "description": "List entities in bulk identified by its GUIDs.", "parameters": [ + { + "$ref": "#/parameters/AtlasApiVersionParameter" + }, { "name": "guid", "in": "query", @@ -119,91 +151,122 @@ "items": { "type": "string" }, - "collectionFormat": "multi", - "x-ms-client-name": "guids" - }, - { - "$ref": "#/parameters/minExtInfo" + "collectionFormat": "multi" }, { - "$ref": "#/parameters/ignoreRelationships" + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/atlasAPIVersion" + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" } ], "responses": { "200": { - "description": "OK.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasEntitiesWithExtInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_ListByGuids": { + "$ref": "./examples/Entity_ListByGuids.json" + } } }, "post": { - "tags": [ - "Entity" - ], - "description": "Create or update entities in bulk.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName.\nMap and array of collections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", "operationId": "Entity_BulkCreateOrUpdate", - "x-ms-examples": { - "Entity_BulkCreateOrUpdate": { - "$ref": "./examples/Entity_BulkCreateOrUpdate.json" - } - }, + "description": "Create or update entities in bulk.\nExisting entity is matched using its unique\nguid if supplied or by its unique attributes eg: qualifiedName.\nMap and array\nof collections are not well supported. E.g., array>,\narray>.\nFor each contact type, the maximum number of contacts\nis 20.", "parameters": [ { - "in": "body", - "name": "entities", - "description": "An array of entities to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/collectionId" + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/atlasAPIVersion" + "name": "businessAttributeUpdateBehavior", + "in": "query", + "description": "Used to define the update behavior for business attributes when updating\nentities.", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "Ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "Replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "Merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } }, { - "$ref": "#/parameters/businessAttributeUpdateBehavior" + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } } ], "responses": { "200": { - "description": "Ok.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_BulkCreateOrUpdate": { + "$ref": "./examples/Entity_BulkCreateOrUpdate.json" + } } }, "delete": { - "tags": [ - "Entity" - ], - "description": "Delete a list of entities in bulk identified by their GUIDs or unique attributes.", "operationId": "Entity_BulkDelete", - "x-ms-examples": { - "Entity_BulkDelete": { - "$ref": "./examples/Entity_BulkDelete.json" - } - }, + "description": "Delete a list of entities in bulk identified by their GUIDs or unique\nattributes.", "parameters": [ { "name": "guid", @@ -214,1406 +277,1401 @@ "items": { "type": "string" }, - "collectionFormat": "multi", - "x-ms-client-name": "guids" + "collectionFormat": "multi" } ], "responses": { "200": { - "description": "Deleted with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_BulkDelete": { + "$ref": "./examples/Entity_BulkDelete.json" + } } } }, "/atlas/v2/entity/bulk/classification": { "post": { - "tags": [ - "Entity" - ], - "description": "Associate a classification to multiple entities in bulk.", "operationId": "Entity_AddClassification", - "x-ms-examples": { - "Entity_AddClassificationToEntityByGuids": { - "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" - } - }, + "description": "Associate a classification to multiple entities in bulk.", "parameters": [ { + "name": "body", "in": "body", - "name": "request", - "description": "The request to associate a classification to multiple entities.", "required": true, "schema": { - "$ref": "#/definitions/ClassificationAssociateRequest" + "$ref": "#/definitions/ClassificationAssociateOptions" } } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddClassificationToEntityByGuids": { + "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" + } } } }, - "/atlas/v2/entity/guid/{guid}": { - "get": { - "tags": [ - "Entity" - ], - "operationId": "Entity_Get", - "x-ms-examples": { - "Entity_Get": { - "$ref": "./examples/Entity_Get.json" - } - }, - "description": "Get complete definition of an entity given its GUID.", + "/atlas/v2/entity/bulk/setClassifications": { + "post": { + "operationId": "Entity_BulkSetClassifications", + "description": "Set classifications on entities in bulk.", "parameters": [ { - "$ref": "#/parameters/guid" - }, - { - "$ref": "#/parameters/minExtInfo" - }, - { - "$ref": "#/parameters/ignoreRelationships" + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityHeaders" + } } ], "responses": { "200": { - "description": "OK.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" + "type": "array", + "items": { + "type": "string" + } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "description": "Update entity partially - create or update entity attribute identified by its GUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", - "operationId": "Entity_PartialUpdateAttributeByGuid", + }, "x-ms-examples": { - "Entity_PartialUpdateEntityAttributeByGuid": { - "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" + "Entity_BulkSetClassifications": { + "$ref": "./examples/Entity_BulkSetClassifications.json" } - }, + } + } + }, + "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Entity_ListByUniqueAttributes", + "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following\nformat\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE:\nThe attrName should be an unique attribute for the given entity-type.\nThe REST\nrequest would look something like this\n\nGET\n/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote:\nat least one unique attribute must be provided.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { - "name": "name", + "name": "minExtInfo", "in": "query", - "description": "The name of the attribute.", - "required": true, - "type": "string" + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" }, { - "in": "body", - "name": "body", - "description": "The value of the attribute.", - "required": true, - "schema": { - "type": "object" - } + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + }, + { + "name": "attr_N:qualifiedName", + "in": "query", + "description": "Qualified name of an entity. E.g. to find 2 entities you can set\nattrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an\nexample. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "Updated with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Entity" - ], - "description": "Delete an entity identified by its GUID.", - "operationId": "Entity_Delete", + }, "x-ms-examples": { - "Entity_Delete": { - "$ref": "./examples/Entity_Delete.json" + "Entity_ListByUniqueAttributes": { + "$ref": "./examples/Entity_ListByUniqueAttributes.json" } - }, + } + } + }, + "/atlas/v2/entity/businessmetadata/import": { + "post": { + "operationId": "Entity_ImportBusinessMetadata", + "description": "Upload the file for creating Business Metadata in BULK", + "consumes": [ + "multipart/form-data" + ], "parameters": [ { - "$ref": "#/parameters/guid" + "name": "file", + "in": "formData", + "description": "InputStream of file", + "required": true, + "type": "file" } ], "responses": { "200": { - "description": "Deleted with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/BulkImportResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_ImportBusinessMetadata": { + "$ref": "./examples/Entity_ImportBusinessMetadata.json" + } } } }, - "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { + "/atlas/v2/entity/businessmetadata/import/template": { "get": { - "tags": [ - "Entity" - ], - "description": "Get classification for a given entity represented by a GUID.", - "operationId": "Entity_GetClassification", - "x-ms-examples": { - "Entity_GetClassification": { - "$ref": "./examples/Entity_GetClassification.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/guid" - }, - { - "$ref": "#/parameters/classificationName" - } + "operationId": "Entity_GetSampleBusinessMetadataTemplate", + "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", + "produces": [ + "application/octet-stream", + "application/json" ], + "parameters": [], "responses": { "200": { - "description": "The classification for the given entity GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasClassification" + "type": "file" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Entity" - ], - "description": "Delete a given classification from an existing entity represented by a GUID.", - "operationId": "Entity_RemoveClassification", + }, "x-ms-examples": { - "Entity_RemoveClassification": { - "$ref": "./examples/Entity_RemoveClassification.json" + "Entity_GetSampleBusinessMetadataTemplate": { + "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" } - }, + } + } + }, + "/atlas/v2/entity/guid/{guid}": { + "get": { + "operationId": "Entity_Get", + "description": "Get complete definition of an entity given its GUID.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/classificationName" + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" } ], "responses": { - "204": { - "description": "No Content." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/guid/{guid}/classifications": { - "get": { - "tags": [ - "Entity" - ], - "description": "List classifications for a given entity represented by a GUID.", - "operationId": "Entity_GetClassifications", + }, "x-ms-examples": { - "Entity_GetClassifications": { - "$ref": "./examples/Entity_GetClassifications.json" + "Entity_Get": { + "$ref": "./examples/Entity_Get.json" } - }, + } + }, + "put": { + "operationId": "Entity_PartialUpdateAttributeByGuid", + "description": "Update entity partially - create or update entity attribute identified by its\nGUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "query", + "description": "The name of the attribute.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The value of the attribute.", + "required": true, + "schema": {} } ], "responses": { "200": { - "description": "An array of classifications for the given entity GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasClassifications" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_PartialUpdateAttributeByGuid": { + "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" + } } }, - "post": { - "tags": [ - "Entity" + "delete": { + "operationId": "Entity_Delete", + "description": "Delete an entity identified by its GUID.", + "parameters": [ + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } ], - "description": "Add classifications to an existing entity represented by a GUID.", - "operationId": "Entity_AddClassifications", - "x-ms-examples": { - "Entity_AddClassifications": { - "$ref": "./examples/Entity_AddClassifications.json" + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, + "x-ms-examples": { + "Entity_Delete": { + "$ref": "./examples/Entity_Delete.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/businessmetadata": { + "post": { + "operationId": "Entity_AddOrUpdateBusinessMetadata", + "description": "Add business metadata to an entity.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "isOverwrite", + "in": "query", + "description": "Whether to overwrite the existing business metadata on the entity or not,\ndefault is false.", + "required": false, + "type": "boolean", + "x-ms-client-name": "overwrite" }, { + "name": "body", "in": "body", - "name": "classifications", - "description": "An array of classifications to be added.", + "description": "BusinessMetadata payload", "required": true, "schema": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" + "type": "object", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" } } } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "description": "Update classifications to an existing entity represented by a guid.", - "operationId": "Entity_UpdateClassifications", + }, "x-ms-examples": { - "Entity_UpdateClassifications": { - "$ref": "./examples/Entity_UpdateClassifications.json" + "Entity_AddOrUpdate_BusinessMetadata": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessMetadata.json" } - }, + } + }, + "delete": { + "operationId": "Entity_RemoveBusinessMetadata", + "description": "Remove business metadata from an entity.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { + "name": "body", "in": "body", - "name": "classifications", - "description": "An array of classifications to be updated.", + "description": "Business metadata payload", "required": true, "schema": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" + "type": "object", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" } } } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_RemoveBusinessMetadata": { + "$ref": "./examples/Entity_RemoveBusinessMetadata.json" + } } } }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { - "get": { - "tags": [ - "Entity" - ], - "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:\nattr:\\=.\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this:\nGET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "operationId": "Entity_GetByUniqueAttributes", - "x-ms-examples": { - "Entity_GetByUniqueAttributes": { - "$ref": "./examples/Entity_GetByUniqueAttributes.json" - } - }, + "/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}": { + "post": { + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", + "description": "Add or update business metadata attributes.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "$ref": "#/parameters/minExtInfo" + "name": "businessMetadataName", + "in": "path", + "description": "BusinessMetadata name", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ignoreRelationships" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, - "type": "string" + "name": "body", + "in": "body", + "description": "Business metadata attribute payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": {} + } } ], "responses": { - "200": { - "description": "AtlasEntityWithExtInfo.", - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "description": "Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:\n\nattr:=.\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this:\nPUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "operationId": "Entity_PartialUpdateByUniqueAttributes", + }, "x-ms-examples": { - "Entity_PartialUpdateEntityByUniqueAttributes": { - "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" + "Entity_AddOrUpdate_BusinessAttribute": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" } - }, + } + }, + "delete": { + "operationId": "Entity_RemoveBusinessMetadataAttributes", + "description": "Delete business metadata attributes from an entity.", "parameters": [ { - "$ref": "#/parameters/typeName" + "name": "businessMetadataName", + "in": "path", + "description": "BusinessMetadata name", + "required": true, + "type": "string" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, "type": "string" }, { + "name": "body", "in": "body", - "name": "atlasEntityWithExtInfo", - "description": "Atlas entity with extended information.", + "description": "Business metadata attribute payload", "required": true, "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" + "type": "object", + "additionalProperties": {} } } ], "responses": { - "200": { - "description": "Updated with EntityMutationResponse.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Entity" - ], - "description": "Delete an entity identified by its type and unique attributes.\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:\nattr:\\=\\.\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this:\nDELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "operationId": "Entity_DeleteByUniqueAttribute", + }, "x-ms-examples": { - "Entity_DeleteByUniqueAttribute": { - "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" + "Entity_RemoveBusinessAttribute": { + "$ref": "./examples/Entity_RemoveBusinessAttribute.json" } - }, + } + } + }, + "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { + "get": { + "operationId": "Entity_GetClassification", + "description": "Get classification for a given entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, "type": "string" } ], "responses": { "200": { - "description": "Deleted with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/AtlasClassification" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { - "delete": { - "tags": [ - "Entity" - ], - "description": "Delete a given classification from an entity identified by its type and unique attributes.", - "operationId": "Entity_RemoveClassificationByUniqueAttribute", + }, "x-ms-examples": { - "Entity_RemoveClassificationByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" + "Entity_GetClassification": { + "$ref": "./examples/Entity_GetClassification.json" } - }, + } + }, + "delete": { + "operationId": "Entity_RemoveClassification", + "description": "Delete a given classification from an existing entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "$ref": "#/parameters/classificationName" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, "type": "string" } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_RemoveClassification": { + "$ref": "./examples/Entity_RemoveClassification.json" + } } } }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { - "post": { - "tags": [ - "Entity" - ], - "description": "Add classification to the entity identified by its type and unique attributes.", - "operationId": "Entity_AddClassificationsByUniqueAttribute", - "x-ms-examples": { - "Entity_AddClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" - } - }, + "/atlas/v2/entity/guid/{guid}/classifications": { + "get": { + "operationId": "Entity_GetClassifications", + "description": "List classifications for a given entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, - "type": "string" - }, - { - "in": "body", - "name": "atlasClassificationArray", - "description": "An array of classification to be added.", + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", "required": true, - "schema": { - "type": "array", - "description": "An array of classification.", - "items": { - "$ref": "#/definitions/AtlasClassification" - } - } + "type": "string" } ], "responses": { - "204": { - "description": "No Content." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassifications" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_GetClassifications": { + "$ref": "./examples/Entity_GetClassifications.json" + } } }, "put": { - "tags": [ - "Entity" - ], - "description": "Update classification on an entity identified by its type and unique attributes.", - "operationId": "Entity_UpdateClassificationsByUniqueAttribute", - "x-ms-examples": { - "Entity_UpdateClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" - } - }, + "operationId": "Entity_UpdateClassifications", + "description": "Update classifications to an existing entity represented by a guid.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, "type": "string" }, { + "name": "body", "in": "body", - "name": "atlasClassificationArray", - "description": "An array of classification to be updated.", + "description": "An array of classifications to be updated.", "required": true, "schema": { "type": "array", - "description": "An array of classification.", "items": { "$ref": "#/definitions/AtlasClassification" - } + }, + "x-ms-identifiers": [] } } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/bulk/setClassifications": { - "post": { - "tags": [ - "Entity" - ], - "description": "Set classifications on entities in bulk.", - "operationId": "Entity_BulkSetClassifications", + }, "x-ms-examples": { - "Entity_BulkSetClassifications": { - "$ref": "./examples/Entity_BulkSetClassifications.json" + "Entity_UpdateClassifications": { + "$ref": "./examples/Entity_UpdateClassifications.json" } - }, + } + }, + "post": { + "operationId": "Entity_AddClassifications", + "description": "Add classifications to an existing entity represented by a GUID.", "parameters": [ { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", "in": "body", - "name": "entityHeaders", - "description": "Atlas entity headers.", + "description": "An array of classifications to be added.", "required": true, "schema": { - "$ref": "#/definitions/AtlasEntityHeaders" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] } } ], "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "description": "Response that indicates each classification mutation result.", - "items": { - "type": "string" - } - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddClassifications": { + "$ref": "./examples/Entity_AddClassifications.json" + } } } }, - "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { + "/atlas/v2/entity/guid/{guid}/header": { "get": { - "tags": [ - "Entity" - ], - "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE: The attrName should be an unique attribute for the given entity-type.\nThe REST request would look something like this\n\nGET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote: at least one unique attribute must be provided.", - "operationId": "Entity_ListByUniqueAttributes", - "x-ms-examples": { - "Entity_ListByUniqueAttributes": { - "$ref": "./examples/Entity_ListByUniqueAttributes.json" - } - }, + "operationId": "Entity_GetHeader", + "description": "Get entity header given its GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "$ref": "#/parameters/minExtInfo" - }, - { - "$ref": "#/parameters/ignoreRelationships" - }, - { - "name": "attr_N:qualifiedName", - "in": "query", - "description": "Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, "type": "string" } ], "responses": { "200": { - "description": "OK.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + "$ref": "#/definitions/AtlasEntityHeader" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/guid/{guid}/header": { - "get": { - "tags": [ - "Entity" - ], - "description": "Get entity header given its GUID.", - "operationId": "Entity_GetHeader", + }, "x-ms-examples": { "Entity_GetHeader": { "$ref": "./examples/Entity_GetHeader.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/guid" - } - ], - "responses": { - "200": { - "schema": { - "$ref": "#/definitions/AtlasEntityHeader" - }, - "description": "AtlasEntityHeader" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } } } }, - "/atlas/v2/entity/guid/{guid}/businessmetadata": { - "delete": { - "tags": [ - "Entity" - ], - "description": "Remove business metadata from an entity.", - "operationId": "Entity_RemoveBusinessMetadata", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_RemoveBusinessMetadata": { - "$ref": "./examples/Entity_RemoveBusinessMetadata.json" - } - }, + "/atlas/v2/entity/guid/{guid}/labels": { + "put": { + "operationId": "Entity_AddLabel", + "description": "Add given labels to a given entity.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "businessMetadata", - "required": false, + "name": "body", "in": "body", + "description": "set of labels to be added", + "required": false, "schema": { - "$ref": "#/definitions/BusinessMetadata" + "type": "array", + "items": { + "type": "string" + } } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddLabel": { + "$ref": "./examples/Entity_AddLabel.json" + } } }, "post": { - "tags": [ - "Entity" - ], - "description": "Add business metadata to an entity.", - "operationId": "Entity_AddOrUpdateBusinessMetadata", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_AddOrUpdateBusinessMetadata": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" - } - }, + "operationId": "Entity_SetLabels", + "description": "Set labels to a given entity.", "parameters": [ { - "$ref": "#/parameters/guid" - }, - { - "in": "query", - "type": "boolean", - "name": "isOverwrite", - "description": "Whether to overwrite the existing business metadata on the entity or not, default is false.", - "required": false + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "businessMetadata", - "required": false, + "name": "body", "in": "body", + "description": "set of labels to be set to the entity", + "required": false, "schema": { - "$ref": "#/definitions/BusinessMetadata" + "type": "array", + "items": { + "type": "string" + } } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_SetLabels": { + "$ref": "./examples/Entity_SetLabels.json" + } } - } - }, - "/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}": { + }, "delete": { - "tags": [ - "Entity" - ], - "description": "Delete business metadata attributes from an entity.", - "operationId": "Entity_RemoveBusinessMetadataAttributes", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_RemoveBusinessAttribute": { - "$ref": "./examples/Entity_RemoveBusinessAttribute.json" - } - }, + "operationId": "Entity_RemoveLabels", + "description": "Delete given labels to a given entity.", "parameters": [ { - "name": "bmName", + "name": "guid", "in": "path", - "type": "string", - "description": "BusinessMetadata name", - "required": true - }, - { - "$ref": "#/parameters/guid" + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "businessMetadataAttributes", - "required": false, + "name": "body", "in": "body", + "description": "set of labels to be deleted", + "required": false, "schema": { - "$ref": "#/definitions/BusinessMetadataAttributes" + "type": "array", + "items": { + "type": "string" + } } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Entity" - ], - "description": "Add or update business metadata attributes.", - "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_AddOrUpdateBusinessAttribute": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" + "Entity_RemoveLabels": { + "$ref": "./examples/Entity_RemoveLabels.json" } - }, + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Entity_GetByUniqueAttributes", + "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following format:\nattr:\\=.\n\nNOTE: The\nattrName and attrValue should be unique across entities, eg.\nqualifiedName.\n\nThe REST request would look something like this:\nGET\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "name": "bmName", + "name": "typeName", "in": "path", - "type": "string", - "description": "BusinessMetadata name", - "required": true + "description": "The name of the type.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/guid" + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" }, { - "name": "businessMetadataAttributes", + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", "required": false, - "in": "body", - "schema": { - "$ref": "#/definitions/BusinessMetadataAttributes" - } + "type": "boolean" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" } ], "responses": { - "204": { - "description": "Success" + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/businessmetadata/import/template": { - "get": { - "tags": [ - "Entity" - ], - "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", - "operationId": "Entity_GetSampleBusinessMetadataTemplate", - "produces": [ - "application/octet-stream" - ], + }, "x-ms-examples": { - "Entity_GetSampleBusinessMetadataTemplate": { - "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" + "Entity_GetByUniqueAttributes": { + "$ref": "./examples/Entity_GetByUniqueAttributes.json" } - }, - "parameters": [], + } + }, + "put": { + "operationId": "Entity_PartialUpdateByUniqueAttributes", + "description": "Update entity partially - Allow a subset of attributes to be updated on an\nentity which is identified by its type and unique attribute eg:\nReferenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\n\nattr:=.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nPUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + } + ], "responses": { "200": { + "description": "The request has succeeded.", "schema": { - "description": "Template File", - "type": "file" - }, - "description": "Template File" + "$ref": "#/definitions/EntityMutationResult" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/businessmetadata/import": { - "post": { - "tags": [ - "Entity" - ], - "description": "Upload the file for creating Business Metadata in BULK", - "operationId": "Entity_ImportBusinessMetadata", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_ImportBusinessMetadata": { - "$ref": "./examples/Entity_ImportBusinessMetadata.json" + "Entity_PartialUpdateByUniqueAttributes": { + "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" } - }, + } + }, + "delete": { + "operationId": "Entity_DeleteByUniqueAttribute", + "description": "Delete an entity identified by its type and unique attributes.\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\nattr:\\=\\.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nDELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "name": "uploadedInputStream", - "in": "formData", - "type": "file", - "description": "InputStream of file" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" } ], "responses": { "200": { + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/BulkImportResponse", - "description": "If Business Metadata creation was successful" - }, - "description": "If Business Metadata creation was successful" + "$ref": "#/definitions/EntityMutationResult" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_DeleteByUniqueAttribute": { + "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" + } } } }, - "/atlas/v2/entity/guid/{guid}/labels": { + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { "delete": { - "tags": [ - "Entity" - ], - "description": "Delete given labels to a given entity.", - "operationId": "Entity_RemoveLabels", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_RemoveLabels": { - "$ref": "./examples/Entity_Label.json" - } - }, + "operationId": "Entity_RemoveClassificationByUniqueAttribute", + "description": "Delete a given classification from an entity identified by its type and unique\nattributes.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" }, { - "name": "body", + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, - "in": "body", - "schema": { - "description": "set of labels to be deleted", - "type": "array", - "items": { - "type": "string" - } - }, - "description": "set of labels to be deleted" + "type": "string", + "x-ms-client-name": "attribute" } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Entity" - ], - "description": "Set labels to a given entity.", - "operationId": "Entity_SetLabels", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_SetLabel": { - "$ref": "./examples/Entity_Label.json" + "Entity_RemoveClassificationByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" } - }, + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { + "put": { + "operationId": "Entity_UpdateClassificationsByUniqueAttribute", + "description": "Update classification on an entity identified by its type and unique attributes.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" }, { "name": "body", - "required": false, "in": "body", + "description": "An array of classification to be updated.", + "required": true, "schema": { - "description": "set of labels to be set to the entity", "type": "array", "items": { - "type": "string" - } - }, - "description": "set of labels to be set to the entity" + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "description": "Add given labels to a given entity.", - "operationId": "Entity_AddLabel", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_AddLabel": { - "$ref": "./examples/Entity_Label.json" + "Entity_UpdateClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" } - }, + } + }, + "post": { + "operationId": "Entity_AddClassificationsByUniqueAttribute", + "description": "Add classification to the entity identified by its type and unique attributes.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { - "name": "body", + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", "in": "body", + "description": "An array of classification to be added.", + "required": true, "schema": { - "description": "set of labels to be added", "type": "array", "items": { - "type": "string" - } - }, - "description": "set of labels to be added" + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" + } } } }, "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels": { - "delete": { - "tags": [ - "Entity" - ], - "operationId": "Entity_RemoveLabelsByUniqueAttribute", - "description": "Delete given labels to a given entity identified by its type and unique attribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_RemoveLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" - } - }, + "put": { + "operationId": "Entity_AddLabelsByUniqueAttribute", + "description": "Add given labels to a given entity identified by its type and unique\nattributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: PUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/typeName" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { "name": "attr:qualifiedName", "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, - "type": "string" + "type": "string", + "x-ms-client-name": "attribute" }, { "name": "body", - "required": false, "in": "body", + "description": "set of labels to be added", + "required": false, "schema": { - "description": "set of labels to be deleted", "type": "array", "items": { "type": "string" } - }, - "description": "set of labels to be deleted" + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" + } } }, "post": { - "tags": [ - "Entity" - ], "operationId": "Entity_SetLabelsByUniqueAttribute", - "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf labels is null/empty, existing labels will all be removed.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=.\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_SetLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" - } - }, + "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf\nlabels is null/empty, existing labels will all be removed.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: POST\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/typeName" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { "name": "attr:qualifiedName", "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, - "type": "string" + "type": "string", + "x-ms-client-name": "attribute" }, { "name": "body", - "required": false, "in": "body", + "description": "set of labels to be set", + "required": false, "schema": { - "description": "set of labels to be set", "type": "array", "items": { "type": "string" } - }, - "description": "set of labels to be set" + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "operationId": "Entity_AddLabelsByUniqueAttribute", - "description": "Add given labels to a given entity identified by its type and unique attributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=.\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_AddLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" + "Entity_SetLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" } - }, + } + }, + "delete": { + "operationId": "Entity_RemoveLabelsByUniqueAttribute", + "description": "Delete given labels to a given entity identified by its type and unique\nattribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels\nin labels set are non-existing labels, they will be ignored, only existing\nlabels will be removed. In addition to the typeName path parameter, attribute\nkey-value pair(s) can be provided in the following format:\nattr:=. NOTE: The attrName and attrValue should be unique\nacross entities, eg. qualifiedName. The REST request would look something like\nthis: DELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/typeName" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { "name": "attr:qualifiedName", "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, - "type": "string" + "type": "string", + "x-ms-client-name": "attribute" }, { "name": "body", - "required": false, "in": "body", + "description": "set of labels to be deleted", + "required": false, "schema": { - "description": "set of labels to be added", "type": "array", "items": { "type": "string" } - }, - "description": "set of labels to be added" + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/entity/moveTo": { - "post": { - "tags": [ - "Entity" - ], - "description": "Move existing entities to the target collection.", - "operationId": "Entity_MoveEntitiesToCollection", - "x-ms-examples": { - "Collection_MoveEntitiesToCollection": { - "$ref": "./examples/Entity_MoveEntitiesToCollection.json" - } }, - "parameters": [ - { - "$ref": "#/parameters/requiredCollectionId" - }, - { - "$ref": "#/parameters/purviewAPIVersion" - }, - { - "in": "body", - "name": "moveEntitiesRequest", - "description": "Entity guids to be moved to target collection.", - "required": true, - "schema": { - "$ref": "#/definitions/MoveEntitiesRequest" - } - } - ], - "responses": { - "200": { - "description": "Created with EntityMutationResponse.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } + "x-ms-examples": { + "Entity_RemoveLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" } } } }, "/atlas/v2/glossary": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", "operationId": "Glossary_List", - "x-ms-examples": { - "Glossary_List": { - "$ref": "./examples/Glossary_List.json" - } - }, + "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", "parameters": [ { - "$ref": "#/parameters/limit" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/offset" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/ignoreTermsAndCategories" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/atlasAPIVersion" + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" } ], "responses": { "200": { - "description": "An array of existing glossaries fitting the search criteria or empty list if nothing matches.", + "description": "The request has succeeded.", "schema": { "type": "array", "items": { "$ref": "#/definitions/AtlasGlossary" - } + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_List": { + "$ref": "./examples/Glossary_List.json" + } } }, "post": { - "tags": [ - "Glossary" - ], - "description": "Create a glossary.", "operationId": "Glossary_Create", - "x-ms-examples": { - "Glossary_Create": { - "$ref": "./examples/Glossary_Create.json" - } - }, + "description": "Create a glossary.", "parameters": [ { + "name": "body", "in": "body", - "name": "atlasGlossary", - "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing the anchor attribute when creating the Term/Category.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossary" @@ -1622,2179 +1680,2242 @@ ], "responses": { "200": { - "description": "OK. If glossary creation was successful.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasGlossary" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_Create": { + "$ref": "./examples/Glossary_Create.json" + } } } }, - "/atlas/v2/glossary/categories": { - "post": { - "tags": [ - "Glossary" - ], - "description": "Create glossary category in bulk.", - "operationId": "Glossary_CreateCategories", - "x-ms-examples": { - "Glossary_CreateCategories": { - "$ref": "./examples/Glossary_CreateCategories.json" - } - }, + "/atlas/v2/glossary/{glossaryId}": { + "get": { + "operationId": "Glossary_Get", + "description": "Get a specific Glossary by its GUID.", "parameters": [ { - "in": "body", - "name": "glossaryCategory", - "description": "An array of glossary category definitions to be created.", + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", "required": true, - "schema": { - "type": "array", - "description": "An array of glossary category definitions.", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - } + "type": "string" } ], "responses": { "200": { - "description": "OK. If bulk glossary category creation was successful.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "An array of glossary category created successfully in bulk.", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "$ref": "#/definitions/AtlasGlossary" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/category": { - "post": { - "tags": [ - "Glossary" - ], - "description": "Create a glossary category.", - "operationId": "Glossary_CreateCategory", + }, "x-ms-examples": { - "Glossary_CreateCategory": { - "$ref": "./examples/Glossary_CreateCategory.json" + "Glossary_Get": { + "$ref": "./examples/Glossary_Get.json" } - }, + } + }, + "put": { + "operationId": "Glossary_Update", + "description": "Update the given glossary.", "parameters": [ { + "$ref": "#/parameters/AtlasApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" + }, + { + "name": "body", "in": "body", - "name": "glossaryCategory", - "description": "The glossary category definition. A category must be anchored to a Glossary when creating.\nOptionally, terms belonging to the category and the hierarchy can also be defined during creation.", "required": true, "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "$ref": "#/definitions/AtlasGlossary" } } ], "responses": { "200": { - "description": "OK. If glossary category creation was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "$ref": "#/definitions/AtlasGlossary" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/category/{categoryGuid}": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get specific glossary category by its GUID.", - "operationId": "Glossary_GetCategory", + }, "x-ms-examples": { - "Glossary_GetCategory": { - "$ref": "./examples/Glossary_GetCategory.json" + "Glossary_Update": { + "$ref": "./examples/Glossary_Update.json" } - }, + } + }, + "delete": { + "operationId": "Glossary_Delete", + "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend\nseparate delete terms and categories.", "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" } ], "responses": { - "200": { - "description": "OK. If glossary category exists for given GUID.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Glossary" - ], - "description": "Update the given glossary category by its GUID.", - "operationId": "Glossary_UpdateCategory", + }, "x-ms-examples": { - "Glossary_UpdateCategory": { - "$ref": "./examples/Glossary_UpdateCategory.json" + "Glossary_Delete": { + "$ref": "./examples/Glossary_Delete.json" } - }, - "parameters": [ + } + } + }, + "/atlas/v2/glossary/{glossaryId}/categories": { + "get": { + "operationId": "Glossary_ListCategories", + "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", + "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" }, { - "in": "body", - "name": "glossaryCategory", - "description": "The glossary category to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. If glossary category partial update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Glossary" - ], - "description": "Delete a glossary category.", - "operationId": "Glossary_DeleteCategory", + }, "x-ms-examples": { - "Glossary_DeleteCategory": { - "$ref": "./examples/Glossary_DeleteCategory.json" + "Glossary_ListCategories": { + "$ref": "./examples/Glossary_ListCategories.json" } - }, + } + } + }, + "/atlas/v2/glossary/{glossaryId}/categories/headers": { + "get": { + "operationId": "Glossary_ListCategoriesHeaders", + "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { - "204": { - "description": "OK. If glossary category deletion is successful." + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_ListCategoriesHeaders": { + "$ref": "./examples/Glossary_ListCategoriesHeaders.json" + } } } }, - "/atlas/v2/glossary/category/{categoryGuid}/partial": { - "put": { - "tags": [ - "Glossary" - ], - "description": "Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.", - "operationId": "Glossary_PartialUpdateCategory", - "x-ms-examples": { - "Glossary_PartialUpdateCategory": { - "$ref": "./examples/Glossary_PartialUpdateCategory.json" - } - }, + "/atlas/v2/glossary/{glossaryId}/detailed": { + "get": { + "operationId": "Glossary_GetDetailed", + "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.", "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "in": "body", - "name": "partialUpdates", - "description": "A map containing keys as attribute names and values as corresponding attribute values for partial update.", + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", "required": true, - "schema": { - "type": "object", - "description": "A map containing keys as attribute names and values as corresponding attribute values." - } + "type": "string" } ], "responses": { "200": { - "description": "OK. If glossary category partial update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "$ref": "#/definitions/AtlasGlossaryExtInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_GetDetailed": { + "$ref": "./examples/Glossary_GetDetailed.json" + } } } }, - "/atlas/v2/glossary/category/{categoryGuid}/related": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.", - "operationId": "Glossary_ListRelatedCategories", - "x-ms-examples": { - "Glossary_ListRelatedCategories": { - "$ref": "./examples/Glossary_ListRelatedCategories.json" - } - }, + "/atlas/v2/glossary/{glossaryId}/partial": { + "put": { + "operationId": "Glossary_PartialUpdate", + "description": "Update the glossary partially. Some properties such as qualifiedName are not\nallowed to be updated.\n\nSo far we only supports partial updating\nshortDescription, longDescription, language and usage for glossary. \n\nRecommend\nusing 'ignoreTermsAndCategories=true' to reduce response body size.", "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/limit" + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/offset" + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/sort" + "name": "body", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues.", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } ], "responses": { "200": { - "description": "OK. Gets an array of related categories.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/RelatedCategoryHeaders" + "$ref": "#/definitions/AtlasGlossary" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_PartialUpdate": { + "$ref": "./examples/Glossary_PartialUpdate.json" + } } } }, - "/atlas/v2/glossary/category/{categoryGuid}/terms": { + "/atlas/v2/glossary/{glossaryId}/terms": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get all terms associated with the specific category.", - "operationId": "Glossary_ListCategoryTerms", - "x-ms-examples": { - "Glossary_ListCategoryTerms": { - "$ref": "./examples/Glossary_ListCategoryTerms.json" - } - }, + "operationId": "Glossary_ListTerms", + "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get\npagination result.", "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "$ref": "#/parameters/AtlasApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/limit" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/offset" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "An array of terms for the given category or an empty list.", + "description": "The request has succeeded.", "schema": { "type": "array", - "description": "An array of terms for the given category or an empty list.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_ListTerms": { + "$ref": "./examples/Glossary_ListTerms.json" + } } } }, - "/atlas/v2/glossary/term": { - "post": { - "tags": [ - "Glossary" - ], - "description": "Create a glossary term.", - "operationId": "Glossary_CreateTerm", - "x-ms-examples": { - "Glossary_CreateTerm": { - "$ref": "./examples/Glossary_CreateTerm.json" - }, - "Glossary_CreateTermWithTemplate": { - "$ref": "./examples/Glossary_CreateTermWithTemplate.json" - } - }, + "/atlas/v2/glossary/{glossaryId}/terms/headers": { + "get": { + "operationId": "Glossary_ListTermHeaders", + "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", "parameters": [ { - "in": "body", - "name": "glossaryTerm", - "description": "The glossary term definition. A term must be anchored to a Glossary at the time of creation.\nOptionally it can be categorized as well.", + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } + "type": "string" }, { - "$ref": "#/parameters/includeTermHierarchy" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. If glossary term creation was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_ListTermHeaders": { + "$ref": "./examples/Glossary_ListTermHeaders.json" + } } } }, - "/atlas/v2/glossary/term/{termGuid}": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get a specific glossary term by its GUID. ", - "operationId": "Glossary_GetTerm", - "x-ms-examples": { - "Glossary_GetTerm": { - "$ref": "./examples/Glossary_GetTerm.json" - }, - "Glossary_GetTerm_WithoutAssets": { - "$ref": "./examples/Glossary_GetTermWithoutAssets.json" - } - }, + "/atlas/v2/glossary/categories": { + "post": { + "operationId": "Glossary_CreateCategories", + "description": "Create glossary category in bulk.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/termGuid" + "name": "body", + "in": "body", + "description": "An array of glossary category definitions to be created.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] + } } ], "responses": { "200": { - "description": "OK. If glossary term exists for given GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Glossary" - ], - "description": "Update the given glossary term by its GUID.", - "operationId": "Glossary_UpdateTerm", + }, "x-ms-examples": { - "Glossary_UpdateTerm": { - "$ref": "./examples/Glossary_UpdateTerm.json" + "Glossary_CreateCategories": { + "$ref": "./examples/Glossary_CreateCategories.json" } - }, + } + } + }, + "/atlas/v2/glossary/category": { + "post": { + "operationId": "Glossary_CreateCategory", + "description": "Create a glossary category.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/termGuid" - }, - { + "name": "body", "in": "body", - "name": "glossaryTerm", - "description": "The glossary term to be updated.", "required": true, "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "$ref": "#/definitions/AtlasGlossaryCategory" } - }, - { - "$ref": "#/parameters/includeTermHierarchy" } ], "responses": { "200": { - "description": "OK. If glossary term update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "$ref": "#/definitions/AtlasGlossaryCategory" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Glossary" - ], - "description": "Delete a glossary term.", - "operationId": "Glossary_DeleteTerm", + }, "x-ms-examples": { - "Glossary_DeleteTerm": { - "$ref": "./examples/Glossary_DeleteTerm.json" + "Glossary_CreateCategory": { + "$ref": "./examples/Glossary_CreateCategory.json" } - }, + } + } + }, + "/atlas/v2/glossary/category/{categoryId}": { + "get": { + "operationId": "Glossary_GetCategory", + "description": "Get specific glossary category by its GUID.", "parameters": [ { - "$ref": "#/parameters/termGuid" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" } ], "responses": { - "204": { - "description": "OK. If glossary term delete was successful." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/term/{termGuid}/partial": { - "put": { - "tags": [ - "Glossary" - ], - "description": "Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.", - "operationId": "Glossary_PartialUpdateTerm", + }, "x-ms-examples": { - "Glossary_PartialUpdateTerm": { - "$ref": "./examples/Glossary_PartialUpdateTerm.json" + "Glossary_GetCategory": { + "$ref": "./examples/Glossary_GetCategory.json" } - }, + } + }, + "put": { + "operationId": "Glossary_UpdateCategory", + "description": "Update the given glossary category by its GUID.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/termGuid" - }, - { - "$ref": "#/parameters/includeTermHierarchy" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" }, { + "name": "body", "in": "body", - "name": "partialUpdates", - "description": "A map containing keys as attribute names and values as corresponding attribute values to be updated.", "required": true, "schema": { - "type": "object", - "description": "A map containing keys as attribute names and values as corresponding attribute values." + "$ref": "#/definitions/AtlasGlossaryCategory" } } ], "responses": { "200": { - "description": "OK. If glossary partial update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "$ref": "#/definitions/AtlasGlossaryCategory" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_UpdateCategory": { + "$ref": "./examples/Glossary_UpdateCategory.json" + } } - } - }, - "/atlas/v2/glossary/terms": { - "post": { - "tags": [ - "Glossary" + }, + "delete": { + "operationId": "Glossary_DeleteCategory", + "description": "Delete a glossary category.", + "parameters": [ + { + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + } ], - "description": "Create glossary terms in bulk.", - "operationId": "Glossary_CreateTerms", - "x-ms-examples": { - "Glossary_CreateTerms": { - "$ref": "./examples/Glossary_CreateTerms.json" + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, + "x-ms-examples": { + "Glossary_DeleteCategory": { + "$ref": "./examples/Glossary_DeleteCategory.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryId}/partial": { + "put": { + "operationId": "Glossary_PartialUpdateCategory", + "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" }, { + "name": "body", "in": "body", - "name": "glossaryTerm", - "description": "An array of glossary term definitions to be created in bulk.", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues for partial update.", "required": true, "schema": { - "type": "array", - "description": "An array of glossary term definitions.", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "type": "object", + "additionalProperties": { + "type": "string" } } - }, - { - "$ref": "#/parameters/includeTermHierarchy" } ], "responses": { "200": { - "description": "OK. If bulk glossary terms creation was successful.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "If bulk glossary terms creation was successful.", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } + "$ref": "#/definitions/AtlasGlossaryCategory" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_PartialUpdateCategory": { + "$ref": "./examples/Glossary_PartialUpdateCategory.json" + } } } }, - "/atlas/v2/glossary/terms/{termGuid}/assignedEntities": { + "/atlas/v2/glossary/category/{categoryId}/related": { "get": { - "tags": [ - "Glossary" - ], - "description": "List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListEntitiesAssignedWithTerm", - "x-ms-examples": { - "Glossary_ListEntitiesAssignedWithTerm": { - "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" - } - }, + "operationId": "Glossary_ListRelatedCategories", + "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", "parameters": [ { - "$ref": "#/parameters/termGuid" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/limit" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/offset" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. An array of related objects (if any) for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "An array of related objects (if any) for the given glossary or an empty list.", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" + "type": "object", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "type": "array", + "x-ms-identifiers": [] } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Glossary" - ], - "description": "Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls.\n\n[Entities Create Or Update operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) is an alternative to assign a term to multiple entities.", - "operationId": "Glossary_AssignTermToEntities", + }, "x-ms-examples": { - "Glossary_AssignTermToEntities": { - "$ref": "./examples/Glossary_AssignTermToEntities.json" + "Glossary_ListRelatedCategories": { + "$ref": "./examples/Glossary_ListRelatedCategories.json" } - }, + } + } + }, + "/atlas/v2/glossary/category/{categoryId}/terms": { + "get": { + "operationId": "Glossary_ListCategoryTerms", + "description": "Get all terms associated with the specific category.", "parameters": [ { - "$ref": "#/parameters/termGuid" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" }, { - "in": "body", - "name": "relatedObjectIds", - "description": "An array of related object IDs to which the term has to be associated.", - "required": true, + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", "schema": { "type": "array", - "description": "An array of related object IDs to which the term has to be associated.", "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] } - } - ], - "responses": { - "204": { - "description": "OK. If the term assignment was successful." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Glossary" - ], - "description": "Delete the term assignment for the given list of related objects.", - "operationId": "Glossary_DeleteTermAssignmentFromEntities", + }, "x-ms-examples": { - "Glossary_RemoveTermAssignmentFromEntities": { - "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" + "Glossary_ListCategoryTerms": { + "$ref": "./examples/Glossary_ListCategoryTerms.json" } - }, + } + } + }, + "/atlas/v2/glossary/term": { + "post": { + "operationId": "Glossary_CreateTerm", + "description": "Create a glossary term.", "parameters": [ { - "$ref": "#/parameters/termGuid" + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" }, { + "name": "body", "in": "body", - "name": "relatedObjectIds", - "description": "An array of related object IDs from which the term has to be dissociated.", "required": true, "schema": { - "type": "array", - "description": "An array of related object IDs from which the term has to be dissociated.", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - } + "$ref": "#/definitions/AtlasGlossaryTerm" } } ], "responses": { - "204": { - "description": "OK. If glossary term dissociation was successful." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_CreateTerm": { + "$ref": "./examples/Glossary_CreateTerm.json" + }, + "Glossary_CreateTermWithTemplate": { + "$ref": "./examples/Glossary_CreateTermWithTemplate.json" + } } } }, - "/atlas/v2/glossary/terms/{termGuid}/related": { + "/atlas/v2/glossary/term/{termId}": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.", - "operationId": "Glossary_ListRelatedTerms", - "x-ms-examples": { - "Glossary_ListRelatedTerms": { - "$ref": "./examples/Glossary_ListRelatedTerms.json" - } - }, + "operationId": "Glossary_GetTerm", + "description": "Get a specific glossary term by its GUID. ", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/termGuid" - }, - { - "$ref": "#/parameters/limit" - }, - { - "$ref": "#/parameters/offset" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/sort" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. An array of related glossary terms for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/RelatedTermHeaders" + "$ref": "#/definitions/AtlasGlossaryTerm" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get a specific Glossary by its GUID.", - "operationId": "Glossary_Get", - "x-ms-examples": { - "Glossary_Get": { - "$ref": "./examples/Glossary_Get.json" - } }, - "parameters": [ - { - "$ref": "#/parameters/glossaryGuid" - } - ], - "responses": { - "200": { - "description": "OK. If glossary with given guid exists.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } + "x-ms-examples": { + "Glossary_GetTerm": { + "$ref": "./examples/Glossary_GetTerm.json" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } + "Glossary_GetTermWithoutAssets": { + "$ref": "./examples/Glossary_GetTermWithoutAssets.json" } } }, "put": { - "tags": [ - "Glossary" - ], - "description": "Update the given glossary.", - "operationId": "Glossary_Update", - "x-ms-examples": { - "Glossary_Update": { - "$ref": "./examples/Glossary_Update.json" - } - }, + "operationId": "Glossary_UpdateTerm", + "description": "Update the given glossary term by its GUID.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/glossaryGuid" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ignoreTermsAndCategories" + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" }, { + "name": "body", "in": "body", - "name": "updatedGlossary", - "description": "The glossary definition to be updated.", "required": true, "schema": { - "$ref": "#/definitions/AtlasGlossary" + "$ref": "#/definitions/AtlasGlossaryTerm" } } ], "responses": { "200": { - "description": "OK. If glossary update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossary" + "$ref": "#/definitions/AtlasGlossaryTerm" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_UpdateTerm": { + "$ref": "./examples/Glossary_UpdateTerm.json" + } } }, "delete": { - "tags": [ - "Glossary" - ], - "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.", - "operationId": "Glossary_Delete", - "x-ms-examples": { - "Glossary_Delete": { - "$ref": "./examples/Glossary_Delete.json" - } - }, + "operationId": "Glossary_DeleteTerm", + "description": "Delete a glossary term.", "parameters": [ { - "$ref": "#/parameters/glossaryGuid" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" } ], "responses": { "204": { - "description": "OK. If glossary delete was successful." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_DeleteTerm": { + "$ref": "./examples/Glossary_DeleteTerm.json" + } } } }, - "/atlas/v2/glossary/{glossaryGuid}/categories": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListCategories", - "x-ms-examples": { - "Glossary_ListCategories": { - "$ref": "./examples/Glossary_ListCategories.json" - } - }, + "/atlas/v2/glossary/term/{termId}/partial": { + "put": { + "operationId": "Glossary_PartialUpdateTerm", + "description": "Update the glossary term partially. So far we only supports partial updating\nshortDescription, longDescription, abbreviation, usage and status for term.", "parameters": [ { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/limit" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/offset" + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/sort" + "name": "body", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues to be updated.", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } ], "responses": { "200": { - "description": "OK. An array of glossary categories for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "An array of glossary categories for the given glossary or an empty list.", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "$ref": "#/definitions/AtlasGlossaryTerm" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_PartialUpdateTerm": { + "$ref": "./examples/Glossary_PartialUpdateTerm.json" + } } } }, - "/atlas/v2/glossary/{glossaryGuid}/categories/headers": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListCategoriesHeaders", - "x-ms-examples": { - "Glossary_ListCategoriesHeaders": { - "$ref": "./examples/Glossary_ListCategoriesHeaders.json" - } - }, + "/atlas/v2/glossary/terms": { + "post": { + "operationId": "Glossary_CreateTerms", + "description": "Create glossary terms in bulk.", "parameters": [ { - "$ref": "#/parameters/glossaryGuid" - }, - { - "$ref": "#/parameters/limit" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/offset" + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/sort" + "name": "body", + "in": "body", + "description": "An array of glossary term definitions to be created in bulk.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] + } } ], "responses": { "200": { - "description": "OK. An array of glossary category headers for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { "type": "array", - "description": "An array of glossary category headers for the given glossary or an empty list.", "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - } + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_CreateTerms": { + "$ref": "./examples/Glossary_CreateTerms.json" + } } } }, - "/atlas/v2/glossary/{glossaryGuid}/detailed": { + "/atlas/v2/glossary/terms/{termId}/assignedEntities": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get a specific glossary with detailed information. This API is not recommend.\n\nRecommend to fetch terms/categories details separately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", - "operationId": "Glossary_GetDetailed", - "x-ms-examples": { - "Glossary_GetDetailed": { - "$ref": "./examples/Glossary_GetDetailed.json" - } - }, + "operationId": "Glossary_ListEntitiesAssignedWithTerm", + "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/glossaryGuid" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. If glossary exists for given GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryExtInfo" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/partial": { - "put": { - "tags": [ - "Glossary" - ], - "description": "Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.\n\nSo far we only supports partial updating shortDescription, longDescription, language and usage for glossary. \n\nRecommend using 'ignoreTermsAndCategories=true' to reduce response body size.", - "operationId": "Glossary_PartialUpdate", + }, "x-ms-examples": { - "Glossary_PartialUpdate": { - "$ref": "./examples/Glossary_PartialUpdate.json" + "Glossary_ListEntitiesAssignedWithTerm": { + "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" } - }, + } + }, + "post": { + "operationId": "Glossary_AssignTermToEntities", + "description": "Assign the given term to the provided list of related objects. Recommend using\nsmall batches with multiple API calls.\n\n[Entities Create Or Update\noperation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP)\nis an alternative to assign a term to multiple entities.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/glossaryGuid" - }, - { - "$ref": "#/parameters/ignoreTermsAndCategories" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { + "name": "body", "in": "body", - "name": "partialUpdates", - "description": "A map containing keys as attribute names and values as corresponding attribute values.", + "description": "An array of related object IDs to which the term has to be associated.", "required": true, "schema": { - "type": "object", - "description": "A map containing keys as attribute names and values as corresponding attribute values." + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] } } ], "responses": { - "200": { - "description": "OK. If glossary partial update was successful.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/terms": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListTerms", + }, "x-ms-examples": { - "Glossary_ListTerms": { - "$ref": "./examples/Glossary_ListTerms.json" + "Glossary_AssignTermToEntities": { + "$ref": "./examples/Glossary_AssignTermToEntities.json" } - }, + } + }, + "delete": { + "operationId": "Glossary_DeleteTermAssignmentFromEntities", + "description": "Delete the term assignment for the given list of related objects.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/glossaryGuid" - }, - { - "$ref": "#/parameters/limit" - }, - { - "$ref": "#/parameters/offset" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/sort" - } - ], - "responses": { - "200": { - "description": "OK. An array of glossary terms for the given glossary or an empty list.", + "name": "body", + "in": "body", + "description": "An array of related object IDs from which the term has to be dissociated.", + "required": true, "schema": { "type": "array", - "description": "An array of glossary terms for the given glossary or an empty list.", "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_RemoveTermAssignmentFromEntities": { + "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" + } } } }, - "/atlas/v2/glossary/{glossaryGuid}/terms/headers": { + "/atlas/v2/glossary/terms/{termId}/related": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListTermHeaders", - "x-ms-examples": { - "Glossary_ListTermHeaders": { - "$ref": "./examples/Glossary_ListTermHeaders.json" - } - }, + "operationId": "Glossary_ListRelatedTerms", + "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", "parameters": [ { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/AtlasApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/limit" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/offset" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. An array of glossary terms for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "An array of glossary terms for the given glossary or an empty list.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "type": "object", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "type": "array", + "x-ms-identifiers": [] } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/search/query": { - "post": { - "tags": [ - "Discovery" - ], - "description": "Get data using search.", - "operationId": "Discovery_Query", + }, "x-ms-examples": { - "Discovery_Query": { - "$ref": "./examples/Discovery_Query.json" - }, - "Discovery_Query_And": { - "$ref": "./examples/Discovery_Query_And.json" - }, - "Discovery_Query_Not": { - "$ref": "./examples/Discovery_Query_Not.json" - }, - "Discovery_Query_AndOrNested": { - "$ref": "./examples/Discovery_Query_AndOrNested.json" - }, - "Discovery_Query_SystemTime": { - "$ref": "./examples/Discovery_Query_SystemTime.json" - }, - "Discovery_Query_BusinessMetadataAttribute": { - "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" - }, - "Discovery_Query_Attribute": { - "$ref": "./examples/Discovery_Query_Attribute.json" - }, - "Discovery_Query_Classification": { - "$ref": "./examples/Discovery_Query_Classification.json" - }, - "Discovery_Query_FileExtension": { - "$ref": "./examples/Discovery_Query_FileExtension.json" - }, - "Discovery_Query_Id": { - "$ref": "./examples/Discovery_Query_Id.json" - }, - "Discovery_Query_EntityType": { - "$ref": "./examples/Discovery_Query_Type.json" - }, - "Discovery_Query_AssetType": { - "$ref": "./examples/Discovery_Query_AssetType.json" - }, - "Discovery_Query_Term": { - "$ref": "./examples/Discovery_Query_TermAssignment.json" - }, - "Discovery_Query_Facet": { - "$ref": "./examples/Discovery_Query_Facet.json" - }, - "Discovery_Query_Taxonomy": { - "$ref": "./examples/Discovery_Query_Taxonomy.json" - }, - "Discovery_Query_Collection": { - "$ref": "./examples/Discovery_Query_Collection.json" - }, - "Discovery_Query_GlossaryTerm": { - "$ref": "./examples/Discovery_Query_GlossaryTerm.json" - }, - "Discovery_Query_ObjectType": { - "$ref": "./examples/Discovery_Query_ObjectType.json" - }, - "Discovery_Query_PaginationFirstPage": { - "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" - }, - "Discovery_Query_PaginationContinuationPage": { - "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" - }, - "Discovery_Query_PaginationLastPage": { - "$ref": "./examples/Discovery_Query_PaginationLastPage.json" + "Glossary_ListRelatedTerms": { + "$ref": "./examples/Glossary_ListRelatedTerms.json" } - }, + } + } + }, + "/atlas/v2/lineage/{guid}": { + "get": { + "operationId": "Lineage_Get", + "description": "Get lineage info of the entity specified by GUID.", "parameters": [ { - "in": "body", - "name": "searchRequest", - "description": "An object specifying the search criteria.", + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", "required": true, - "schema": { - "$ref": "#/definitions/SearchRequest" - } + "type": "string" + }, + { + "name": "depth", + "in": "query", + "description": "The number of hops for lineage.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] + } } ], "responses": { "200": { - "description": "OK. On successful lookup of the advanced search.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/SearchResult" + "$ref": "#/definitions/AtlasLineageInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Lineage_Get": { + "$ref": "./examples/Lineage_Get.json" + } } } }, - "/search/suggest": { - "post": { - "tags": [ - "Discovery" - ], - "description": "Get search suggestions by query criteria.", - "operationId": "Discovery_Suggest", - "x-ms-examples": { - "Discovery_Suggest": { - "$ref": "./examples/Discovery_Suggest.json" - } - }, + "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Lineage_GetByUniqueAttribute", + "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter,\nattribute key-value pair(s) can be provided in the following\nformat\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be\nunique across entities, eg. qualifiedName.\n\nThe REST request would look\nsomething like this:\n\nGET\n/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "in": "body", - "name": "suggestRequest", - "description": "An object specifying the suggest criteria.", + "name": "typeName", + "in": "path", + "description": "The name of the type.", "required": true, - "schema": { - "$ref": "#/definitions/SuggestRequest" + "type": "string" + }, + { + "name": "depth", + "in": "query", + "description": "The number of hops for lineage.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] } }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" } ], "responses": { "200": { - "description": "OK. On successful lookup of the suggestions.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/SuggestResult" + "$ref": "#/definitions/AtlasLineageInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Lineage_GetByUniqueAttribute": { + "$ref": "./examples/Lineage_GetByUniqueAttribute.json" + } } } }, - "/search/autocomplete": { - "post": { - "tags": [ - "Discovery" - ], - "description": "Get auto complete options.", - "operationId": "Discovery_AutoComplete", - "x-ms-examples": { - "Discovery_AutoComplete": { - "$ref": "./examples/Discovery_AutoComplete.json" - } - }, + "/atlas/v2/relationship": { + "put": { + "operationId": "Relationship_Update", + "description": "Update an existing relationship between entities.", "parameters": [ { + "name": "body", "in": "body", - "name": "autoCompleteRequest", - "description": "An object specifying the autocomplete criteria.", "required": true, "schema": { - "$ref": "#/definitions/AutoCompleteRequest" + "$ref": "#/definitions/AtlasRelationship" } - }, - { - "$ref": "#/parameters/purviewAPIVersion" } ], "responses": { "200": { - "description": "OK. On successful lookup of the auto complete options.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AutoCompleteResult" + "$ref": "#/definitions/AtlasRelationship" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/lineage/{guid}": { - "get": { - "tags": [ - "Lineage" - ], - "description": "Get lineage info of the entity specified by GUID.", - "operationId": "Lineage_Get", + }, "x-ms-examples": { - "Lineage_Get": { - "$ref": "./examples/Lineage_Get.json" + "Relationship_Update": { + "$ref": "./examples/Relationship_Update.json" } - }, + } + }, + "post": { + "operationId": "Relationship_Create", + "description": "Create a new relationship between entities.", "parameters": [ { - "$ref": "#/parameters/guid" - }, - { - "$ref": "#/parameters/depth" - }, - { - "$ref": "#/parameters/direction" + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } } ], "responses": { "200": { - "description": "OK. If the request is valid.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasLineageInfo" + "$ref": "#/definitions/AtlasRelationship" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Relationship_Create": { + "$ref": "./examples/Relationship_Create.json" + } } } }, - "/lineage/{guid}/next/": { + "/atlas/v2/relationship/guid/{guid}": { "get": { - "tags": [ - "Lineage" - ], - "description": "Return immediate next page lineage info about entity with pagination", - "operationId": "Lineage_GetNextPage", - "x-ms-examples": { - "Lineage_GetNextPage": { - "$ref": "./examples/Lineage_GetNextPage.json" - } - }, + "operationId": "Relationship_Get", + "description": "Get relationship information between entities by its GUID.", "parameters": [ { - "$ref": "#/parameters/guid" - }, - { - "$ref": "#/parameters/direction" - }, - { - "$ref": "#/parameters/offset" - }, - { - "$ref": "#/parameters/limit" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "extendedInfo", + "in": "query", + "description": "Limits whether includes extended information.", + "required": false, + "type": "boolean" } ], "responses": { "200": { - "description": "OK. If the input is valid.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasLineageInfo" + "$ref": "#/definitions/AtlasRelationshipWithExtInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { - "get": { - "tags": [ - "Lineage" - ], - "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this:\n\nGET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "operationId": "Lineage_GetByUniqueAttribute", + }, "x-ms-examples": { - "Lineage_GetByUniqueAttribute": { - "$ref": "./examples/Lineage_GetByUniqueAttribute.json" + "Relationship_Get": { + "$ref": "./examples/Relationship_Get.json" } - }, - "produces": [ - "application/json" - ], + } + }, + "delete": { + "operationId": "Relationship_Delete", + "description": "Delete a relationship between entities by its GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "$ref": "#/parameters/depth" - }, - { - "$ref": "#/parameters/direction" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, "type": "string" } ], "responses": { - "200": { - "schema": { - "$ref": "#/definitions/AtlasLineageInfo", - "description": "If Lineage exists for the given entity" - }, - "description": "If Lineage exists for the given entity" + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Relationship_Delete": { + "$ref": "./examples/Relationship_Delete.json" + } } } }, - "/atlas/v2/relationship": { - "post": { - "tags": [ - "Relationship" - ], - "description": "Create a new relationship between entities.", - "operationId": "Relationship_Create", - "x-ms-examples": { - "Relationship_Create": { - "$ref": "./examples/Relationship_Create.json" - } - }, + "/atlas/v2/types/businessmetadatadef/guid/{guid}": { + "get": { + "operationId": "Type_GetBusinessMetadataDefByGuid", + "description": "Get the businessMetadata definition for the given guid.", "parameters": [ { - "in": "body", - "name": "relationship", - "description": "The AtlasRelationship object containing the information for the relationship to be created.", + "name": "guid", + "in": "path", + "description": "businessMetadata guid", "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } + "type": "string" } ], "responses": { "200": { - "description": "OK. The relationship is created.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasRelationship" + "$ref": "#/definitions/AtlasBusinessMetadataDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Relationship" - ], - "description": "Update an existing relationship between entities.", - "operationId": "Relationship_Update", + }, "x-ms-examples": { - "Relationship_Update": { - "$ref": "./examples/Relationship_Update.json" + "Type_GetBusinessMetadataDefByGuid": { + "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" } - }, + } + } + }, + "/atlas/v2/types/businessmetadatadef/name/{name}": { + "get": { + "operationId": "Type_GetBusinessMetadataDefByName", + "description": "Get the businessMetadata definition by it's name (unique).", "parameters": [ { - "in": "body", - "name": "relationship", - "description": "The AtlasRelationship object containing the information for the relationship to be created.", + "name": "name", + "in": "path", + "description": "businessMetadata name", "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } + "type": "string" } ], "responses": { "200": { - "description": "OK. The relationship is updated.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasRelationship" + "$ref": "#/definitions/AtlasBusinessMetadataDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetBusinessMetadataDefByName": { + "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" + } } } }, - "/atlas/v2/relationship/guid/{guid}": { + "/atlas/v2/types/classificationdef/guid/{guid}": { "get": { - "tags": [ - "Relationship" - ], - "description": "Get relationship information between entities by its GUID.", - "operationId": "Relationship_Get", - "x-ms-examples": { - "Relationship_Get": { - "$ref": "./examples/Relationship_Get.json" - } - }, + "operationId": "Type_GetClassificationDefByGuid", + "description": "Get the classification definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/relationshipGuid" - }, - { - "$ref": "#/parameters/extendedInfo" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the classification.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasRelationshipWithExtInfo" + "$ref": "#/definitions/AtlasClassificationDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Relationship" - ], - "description": "Delete a relationship between entities by its GUID.", - "operationId": "Relationship_Delete", + }, "x-ms-examples": { - "Relationship_Delete": { - "$ref": "./examples/Relationship_Delete.json" + "Type_GetClassificationDefByGuid": { + "$ref": "./examples/Type_GetClassificationDefByGuid.json" } - }, + } + } + }, + "/atlas/v2/types/classificationdef/name/{name}": { + "get": { + "operationId": "Type_GetClassificationDefByName", + "description": "Get the classification definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/relationshipGuid" + "name": "name", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" } ], "responses": { - "204": { - "description": "OK. The relationship is deleted." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassificationDef" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetClassificationDefByName": { + "$ref": "./examples/Type_GetClassificationDefByName.json" + } } } }, - "/atlas/v2/types/businessmetadatadef/guid/{guid}": { + "/atlas/v2/types/entitydef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the businessMetadata definition for the given guid.", - "operationId": "Type_GetBusinessMetadataDefByGuid", - "x-ms-examples": { - "Type_GetBusinessMetadataDefByGuid": { - "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" - } - }, - "produces": [ - "application/json" - ], + "operationId": "Type_GetEntityDefByGuid", + "description": "Get the Entity definition for the given GUID.", "parameters": [ { "name": "guid", "in": "path", - "type": "string", - "description": "businessMetadata guid", - "required": true + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" } ], "responses": { "200": { + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef", - "description": "On successful lookup of the the businessMetadata definition by it's guid" - }, - "description": "On successful lookup of the the businessMetadata definition by it's guid" + "$ref": "#/definitions/AtlasEntityDef" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetEntityDefByGuid": { + "$ref": "./examples/Type_GetEntityDefByGuid.json" + } } } }, - "/atlas/v2/types/businessmetadatadef/name/{name}": { + "/atlas/v2/types/entitydef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the businessMetadata definition by it's name (unique).", - "operationId": "Type_GetBusinessMetadataDefByName", - "x-ms-examples": { - "Type_GetBusinessMetadataDefByName": { - "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" - } - }, - "produces": [ - "application/json" - ], + "operationId": "Type_GetEntityDefByName", + "description": "Get the entity definition by its name (unique).", "parameters": [ { "name": "name", "in": "path", - "type": "string", - "description": "businessMetadata name", - "required": true + "description": "The name of the entity.", + "required": true, + "type": "string" } ], "responses": { "200": { + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef", - "description": "On successful lookup of the the businessMetadata definition by it's name" - }, - "description": "On successful lookup of the the businessMetadata definition by it's name" + "$ref": "#/definitions/AtlasEntityDef" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetEntityDefByName": { + "$ref": "./examples/Type_GetEntityDefByName.json" + } } } }, - "/atlas/v2/types/classificationdef/guid/{guid}": { + "/atlas/v2/types/enumdef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the classification definition for the given GUID.", - "operationId": "Type_GetClassificationDefByGuid", - "x-ms-examples": { - "Type_GetClassificationDefByGuid": { - "$ref": "./examples/Type_GetClassificationDefByGuid.json" - } - }, + "operationId": "Type_GetEnumDefByGuid", + "description": "Get the enum definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/classificationDefGuid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the enum.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the classification definition by its GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasClassificationDef" + "$ref": "#/definitions/AtlasEnumDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetEnumDefByGuid": { + "$ref": "./examples/Type_GetEnumDefByGuid.json" + } } } }, - "/atlas/v2/types/classificationdef/name/{name}": { + "/atlas/v2/types/enumdef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the classification definition by its name (unique).", - "operationId": "Type_GetClassificationDefByName", - "x-ms-examples": { - "Type_GetClassificationDefByName": { - "$ref": "./examples/Type_GetClassificationDefByName.json" - } - }, + "operationId": "Type_GetEnumDefByName", + "description": "Get the enum definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/classificationDefName" + "name": "name", + "in": "path", + "description": "The name of the enum.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the classification definition by its name.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasClassificationDef" + "$ref": "#/definitions/AtlasEnumDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetEnumDefByName": { + "$ref": "./examples/Type_GetEnumDefByName.json" + } } } }, - "/atlas/v2/types/entitydef/guid/{guid}": { + "/atlas/v2/types/relationshipdef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the Entity definition for the given GUID.", - "operationId": "Type_GetEntityDefByGuid", - "x-ms-examples": { - "Type_GetEntityDefByGuid": { - "$ref": "./examples/Type_GetEntityDefByGuid.json" - } - }, + "operationId": "Type_GetRelationshipDefByGuid", + "description": "Get the relationship definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/entityDefGuid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the entity definition by its GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasEntityDef" + "$ref": "#/definitions/AtlasRelationshipDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetRelationshipDefByGuid": { + "$ref": "./examples/Type_GetRelationshipDefByGuid.json" + } } } }, - "/atlas/v2/types/entitydef/name/{name}": { + "/atlas/v2/types/relationshipdef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the entity definition by its name (unique).", - "operationId": "Type_GetEntityDefByName", - "x-ms-examples": { - "Type_GetEntityDefByName": { - "$ref": "./examples/Type_GetEntityDefByName.json" - } - }, + "operationId": "Type_GetRelationshipDefByName", + "description": "Get the relationship definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/entityDefName" + "name": "name", + "in": "path", + "description": "The name of the relationship.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the entity definition by its name.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasEntityDef" + "$ref": "#/definitions/AtlasRelationshipDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetRelationshipDefByName": { + "$ref": "./examples/Type_GetRelationshipDefByName.json" + } } } }, - "/atlas/v2/types/enumdef/guid/{guid}": { + "/atlas/v2/types/structdef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the enum definition for the given GUID.", - "operationId": "Type_GetEnumDefByGuid", - "x-ms-examples": { - "Type_GetEnumDefByGuid": { - "$ref": "./examples/Type_GetEnumDefByGuid.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/enumDefGuid" - } - ], - "responses": { - "200": { - "description": "OK. On successful lookup of the the enum definition by its GUID.", - "schema": { - "$ref": "#/definitions/AtlasEnumDef" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/atlas/v2/types/enumdef/name/{name}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the enum definition by its name (unique).", - "operationId": "Type_GetEnumDefByName", - "x-ms-examples": { - "Type_GetEnumDefByName": { - "$ref": "./examples/Type_GetEnumDefByName.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/enumDefName" - } - ], - "responses": { - "200": { - "description": "OK. On successful lookup of the the enum definition by its name.", - "schema": { - "$ref": "#/definitions/AtlasEnumDef" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/atlas/v2/types/relationshipdef/guid/{guid}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the relationship definition for the given GUID.", - "operationId": "Type_GetRelationshipDefByGuid", - "x-ms-examples": { - "Type_GetRelationshipDefByGuid": { - "$ref": "./examples/Type_GetRelationshipDefByGuid.json" - } - }, + "operationId": "Type_GetStructDefByGuid", + "description": "Get the struct definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/relationshipDefGuid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the struct.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the relationship definition by its GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasRelationshipDef" + "$ref": "#/definitions/AtlasStructDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/types/relationshipdef/name/{name}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the relationship definition by its name (unique).", - "operationId": "Type_GetRelationshipDefByName", - "x-ms-examples": { - "Type_GetRelationshipDefByName": { - "$ref": "./examples/Type_GetRelationshipDefByName.json" - } }, - "parameters": [ - { - "$ref": "#/parameters/relationshipDefName" - } - ], - "responses": { - "200": { - "description": "OK. On successful lookup of the the relationship definition by its name.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipDef" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/atlas/v2/types/structdef/guid/{guid}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the struct definition for the given GUID.", - "operationId": "Type_GetStructDefByGuid", "x-ms-examples": { "Type_GetStructDefByGuid": { "$ref": "./examples/Type_GetStructDefByGuid.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/structDefGuid" - } - ], - "responses": { - "200": { - "description": "OK. On successful lookup of the the struct definition by its GUID.", - "schema": { - "$ref": "#/definitions/AtlasStructDef" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } } } }, "/atlas/v2/types/structdef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the struct definition by its name (unique).", "operationId": "Type_GetStructDefByName", - "x-ms-examples": { - "Type_GetStructDefByName": { - "$ref": "./examples/Type_GetStructDefByName.json" - } - }, + "description": "Get the struct definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/structDefName" + "name": "name", + "in": "path", + "description": "The name of the struct.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the struct definition by its name.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasStructDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetStructDefByName": { + "$ref": "./examples/Type_GetStructDefByName.json" + } } } }, "/atlas/v2/types/typedef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the type definition for the given GUID.", "operationId": "Type_GetByGuid", - "x-ms-examples": { - "Type_GetByGuid": { - "$ref": "./examples/Type_GetByGuid.json" - } - }, + "description": "Get the type definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/typeDefGuid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the type.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the type definition by its GUID.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypeDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetByGuid": { + "$ref": "./examples/Type_GetByGuid.json" + } } } }, "/atlas/v2/types/typedef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the type definition by its name (unique).", "operationId": "Type_GetByName", - "x-ms-examples": { - "Type_GetByName": { - "$ref": "./examples/Type_GetByName.json" - } - }, + "description": "Get the type definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/typeDefName" + "name": "name", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the type definition by its name.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypeDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetByName": { + "$ref": "./examples/Type_GetByName.json" + } } }, "delete": { - "tags": [ - "Type" - ], - "description": "Delete API for type identified by its name.", "operationId": "Type_Delete", - "x-ms-examples": { - "Type_Delete": { - "$ref": "./examples/Type_Delete.json" - } - }, + "description": "Delete API for type identified by its name.", "parameters": [ { - "$ref": "#/parameters/typeDefName" + "name": "name", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" } ], "responses": { "204": { - "description": "On successful deletion of the requested type definitions" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_Delete": { + "$ref": "./examples/Type_Delete.json" + } } } }, "/atlas/v2/types/typedefs": { "get": { - "tags": [ - "Type" - ], - "description": "List all type definitions in bulk.", "operationId": "Type_List", - "x-ms-examples": { - "Type_List": { - "$ref": "./examples/Type_List.json" - }, - "Type_ListEnumDefs": { - "$ref": "./examples/Type_ListEnumDefs.json" - }, - "Type_ListTermTemplateDefs": { - "$ref": "./examples/Type_ListTermTemplateDefs.json" - } - }, + "description": "List all type definitions in bulk.", "parameters": [ { - "$ref": "#/parameters/includeTermTemplate" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/type" + "name": "includeTermTemplate", + "in": "query", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "type", + "in": "query", + "description": "Typedef name as search filter when get typedefs.", + "required": false, + "type": "string", + "enum": [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" + ], + "x-ms-enum": { + "name": "TypeCategory", + "modelAsString": true, + "values": [ + { + "name": "Primitive", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "ObjectIdType", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, + { + "name": "Enum", + "value": "ENUM", + "description": "enum" + }, + { + "name": "Struct", + "value": "STRUCT", + "description": "struct" + }, + { + "name": "Classification", + "value": "CLASSIFICATION", + "description": "classification" + }, + { + "name": "Entity", + "value": "ENTITY", + "description": "entity" + }, + { + "name": "Array", + "value": "ARRAY", + "description": "array" + }, + { + "name": "Map", + "value": "MAP", + "description": "map" + }, + { + "name": "Relationship", + "value": "RELATIONSHIP", + "description": "relationship" + }, + { + "name": "TermTemplate", + "value": "TERM_TEMPLATE", + "description": "term template" + } + ] + } } ], "responses": { "200": { - "description": "OK. AtlasTypesDef with type definitions matching the search criteria or else returns empty list of type definitions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypesDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Type" - ], - "description": "Create all atlas type definitions in bulk, only new definitions will be created.\nAny changes to the existing definitions will be discarded.", - "operationId": "Type_BulkCreate", + }, "x-ms-examples": { - "Type_BulkCreate": { - "$ref": "./examples/Type_BulkCreate.json" + "Type_List": { + "$ref": "./examples/Type_List.json" }, - "Type_BulkCreateBusinessMetadataDefs": { - "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" + "Type_ListEnumDefs": { + "$ref": "./examples/Type_ListEnumDefs.json" + }, + "Type_ListTermTemplateDefs": { + "$ref": "./examples/Type_ListTermTemplateDefs.json" } - }, + } + }, + "put": { + "operationId": "Type_BulkUpdate", + "description": "Update all types in bulk, changes detected in the type definitions would be\npersisted.", "parameters": [ { + "name": "body", "in": "body", - "name": "typesDef", - "description": "A composite wrapper object with corresponding lists of the type definition.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3803,35 +3924,31 @@ ], "responses": { "200": { - "description": "OK. On successful update of requested type definitions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypesDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Type" - ], - "description": "Update all types in bulk, changes detected in the type definitions would be persisted.", - "operationId": "Type_BulkUpdate", + }, "x-ms-examples": { "Type_BulkUpdate": { "$ref": "./examples/Type_BulkUpdate.json" } - }, + } + }, + "post": { + "operationId": "Type_BulkCreate", + "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", "parameters": [ { + "name": "body", "in": "body", - "name": "typesDef", - "description": "A composite object that captures all type definition changes.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3840,35 +3957,34 @@ ], "responses": { "200": { - "description": "OK. On successful update of requested type definitions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypesDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_BulkCreate": { + "$ref": "./examples/Type_BulkCreate.json" + }, + "Type_BulkCreateBusinessMetadataDefs": { + "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" + } } }, "delete": { - "tags": [ - "Type" - ], - "description": "Delete API for all types in bulk.", "operationId": "Type_BulkDelete", - "x-ms-examples": { - "Type_BulkDelete": { - "$ref": "./examples/Type_BulkDelete.json" - } - }, + "description": "Delete API for all types in bulk.", "parameters": [ { + "name": "body", "in": "body", - "name": "typesDef", - "description": "A composite object that captures all types to be deleted", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3877,480 +3993,748 @@ ], "responses": { "204": { - "description": "OK. On successful deletion of the requested type definitions." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_BulkDelete": { + "$ref": "./examples/Type_BulkDelete.json" + } } } }, "/atlas/v2/types/typedefs/headers": { "get": { - "tags": [ - "Type" - ], - "description": "List all type definitions returned as a list of minimal information header.", "operationId": "Type_ListHeaders", - "x-ms-examples": { - "Type_ListHeaders": { - "$ref": "./examples/Type_ListHeaders.json" - } - }, + "description": "List all type definitions returned as a list of minimal information header.", "parameters": [ { - "$ref": "#/parameters/includeTermTemplate" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/type" + "name": "includeTermTemplate", + "in": "query", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "type", + "in": "query", + "description": "Typedef name as search filter when get typedefs.", + "required": false, + "type": "string", + "enum": [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" + ], + "x-ms-enum": { + "name": "TypeCategory", + "modelAsString": true, + "values": [ + { + "name": "Primitive", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "ObjectIdType", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, + { + "name": "Enum", + "value": "ENUM", + "description": "enum" + }, + { + "name": "Struct", + "value": "STRUCT", + "description": "struct" + }, + { + "name": "Classification", + "value": "CLASSIFICATION", + "description": "classification" + }, + { + "name": "Entity", + "value": "ENTITY", + "description": "entity" + }, + { + "name": "Array", + "value": "ARRAY", + "description": "array" + }, + { + "name": "Map", + "value": "MAP", + "description": "map" + }, + { + "name": "Relationship", + "value": "RELATIONSHIP", + "description": "relationship" + }, + { + "name": "TermTemplate", + "value": "TERM_TEMPLATE", + "description": "term template" + } + ] + } } ], "responses": { "200": { - "description": "An array of AtlasTypeDefHeader matching the search criteria\nor an empty list if no match.", + "description": "The request has succeeded.", "schema": { "type": "array", - "description": "An array of AtlasTypeDefHeader matching the search criteria\nor an empty list if no match.", "items": { "$ref": "#/definitions/AtlasTypeDefHeader" - } + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_ListHeaders": { + "$ref": "./examples/Type_ListHeaders.json" + } } } }, - "/types/termtemplatedef/guid/{guid}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the term template definition for the given GUID.", - "operationId": "Type_GetTermTemplateDefByGuid", - "x-ms-examples": { - "Type_GetTermTemplateDefByGuid": { - "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" - } - }, + "/entity/moveTo": { + "post": { + "operationId": "Entity_MoveEntitiesToCollection", + "description": "Move existing entities to the target collection.", "parameters": [ { - "$ref": "#/parameters/termTemplateDefGuid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MoveEntitiesOptions" + } } ], "responses": { "200": { - "description": "OK. On successful lookup of the the term template definition by its GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TermTemplateDef" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_MoveEntitiesToCollection": { + "$ref": "./examples/Entity_MoveEntitiesToCollection.json" + } } } }, - "/types/termtemplatedef/name/{name}": { + "/lineage/{guid}/next": { "get": { - "tags": [ - "Type" - ], - "description": "Get the term template definition by its name (unique).", - "operationId": "Type_GetTermTemplateDefByName", - "x-ms-examples": { - "Type_GetTermTemplateDefByName": { - "$ref": "./examples/Type_GetTermTemplateDefByName.json" - } - }, + "operationId": "Lineage_GetNextPage", + "description": "Return immediate next page lineage info about entity with pagination", "parameters": [ { - "$ref": "#/parameters/termTemplateDefName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] + } + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the term template definition by its name.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TermTemplateDef" + "$ref": "#/definitions/AtlasLineageInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Lineage_GetNextPage": { + "$ref": "./examples/Lineage_GetNextPage.json" + } } } - } - }, - "definitions": { - "AtlasAttributeDef": { - "type": "object", - "properties": { - "cardinality": { - "$ref": "#/definitions/Cardinality" - }, - "constraints": { - "type": "array", - "description": "An array of constraints.", - "items": { - "$ref": "#/definitions/AtlasConstraintDef" + }, + "/search/autocomplete": { + "post": { + "operationId": "Discovery_AutoComplete", + "description": "Get auto complete options.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutoCompleteOptions" + } } - }, - "defaultValue": { - "type": "string", - "description": "The default value of the attribute." - }, - "description": { - "type": "string", - "description": "The description of the attribute." - }, - "includeInNotification": { - "type": "boolean", - "description": "Determines if it is included in notification." - }, - "isIndexable": { - "type": "boolean", - "description": "Determines if it is indexable." - }, - "isOptional": { - "type": "boolean", - "description": "Determines if it is optional." - }, - "isUnique": { - "type": "boolean", - "description": "Determines if it unique." - }, - "name": { - "type": "string", - "description": "The name of the attribute." - }, - "options": { - "type": "object", - "description": "The options for the attribute.", - "additionalProperties": { - "type": "string" + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AutoCompleteResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "valuesMaxCount": { - "type": "integer", - "format": "int32", - "description": "The maximum count of the values." - }, - "valuesMinCount": { - "type": "integer", - "format": "int32", - "description": "The minimum count of the values." - } - }, - "title": "AtlasAttributeDef", - "description": "class that captures details of a struct-attribute." - }, - "AtlasBaseModelObject": { - "type": "object", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." + "x-ms-examples": { + "Discovery_AutoComplete": { + "$ref": "./examples/Discovery_AutoComplete.json" + } } - }, - "title": "AtlasBaseModelObject", - "description": "The base model object." + } }, - "AtlasBaseTypeDef": { - "type": "object", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory" - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat" - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" + "/search/query": { + "post": { + "operationId": "Discovery_Query", + "description": "Get data using search.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, - "serviceType": { - "readOnly": false, - "description": "The service type.", - "type": "string" - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "number", - "description": "The version of the record." - }, - "lastModifiedTS": { - "$ref": "#/definitions/LastModifiedTS" - } - }, - "title": "AtlasBaseTypeDef", - "description": "Base class that captures common-attributes for all types." - }, - "AtlasBusinessMetadataDef": { - "type": "object", - "title": "AtlasBusinessMetadataDef", - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" + "x-ms-examples": { + "Discovery_Query": { + "$ref": "./examples/Discovery_Query.json" + }, + "Discovery_Query_And": { + "$ref": "./examples/Discovery_Query_And.json" + }, + "Discovery_Query_AndOrNested": { + "$ref": "./examples/Discovery_Query_AndOrNested.json" + }, + "Discovery_Query_AssetType": { + "$ref": "./examples/Discovery_Query_AssetType.json" + }, + "Discovery_Query_Attribute": { + "$ref": "./examples/Discovery_Query_Attribute.json" + }, + "Discovery_Query_BusinessMetadataAttribute": { + "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" + }, + "Discovery_Query_Classification": { + "$ref": "./examples/Discovery_Query_Classification.json" + }, + "Discovery_Query_Collection": { + "$ref": "./examples/Discovery_Query_Collection.json" + }, + "Discovery_Query_Facet": { + "$ref": "./examples/Discovery_Query_Facet.json" + }, + "Discovery_Query_FileExtension": { + "$ref": "./examples/Discovery_Query_FileExtension.json" + }, + "Discovery_Query_GlossaryTerm": { + "$ref": "./examples/Discovery_Query_GlossaryTerm.json" + }, + "Discovery_Query_Id": { + "$ref": "./examples/Discovery_Query_Id.json" + }, + "Discovery_Query_Not": { + "$ref": "./examples/Discovery_Query_Not.json" + }, + "Discovery_Query_ObjectType": { + "$ref": "./examples/Discovery_Query_ObjectType.json" + }, + "Discovery_Query_PaginationContinuationPage": { + "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" + }, + "Discovery_Query_PaginationFirstPage": { + "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" + }, + "Discovery_Query_PaginationLastPage": { + "$ref": "./examples/Discovery_Query_PaginationLastPage.json" + }, + "Discovery_Query_SystemTime": { + "$ref": "./examples/Discovery_Query_SystemTime.json" + }, + "Discovery_Query_Taxonomy": { + "$ref": "./examples/Discovery_Query_Taxonomy.json" + }, + "Discovery_Query_TermAssignment": { + "$ref": "./examples/Discovery_Query_TermAssignment.json" + }, + "Discovery_Query_Type": { + "$ref": "./examples/Discovery_Query_Type.json" + } } - ], - "description": "class that captures details of a struct-type." + } }, - "AtlasClassification": { - "type": "object", - "title": "AtlasClassification", - "properties": { - "entityGuid": { - "type": "string", - "description": "The GUID of the entity." - }, - "entityStatus": { - "$ref": "#/definitions/Status" - }, - "removePropagationsOnEntityDelete": { - "type": "boolean", - "description": "Determines if propagations will be removed on entity deletion." + "/search/suggest": { + "post": { + "operationId": "Discovery_Suggest", + "description": "Get search suggestions by query criteria.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SuggestOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SuggestResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } }, - "validityPeriods": { - "type": "array", - "description": "An array of time boundaries indicating validity periods.", - "items": { - "$ref": "#/definitions/TimeBoundary" + "x-ms-examples": { + "Discovery_Suggest": { + "$ref": "./examples/Discovery_Suggest.json" } } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStruct" - } - ], - "description": "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity." + } }, - "AtlasClassificationDef": { - "type": "object", - "title": "AtlasClassificationDef", - "properties": { - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that classifications can\nonly be applied to those entityTypes.\n
    \n
  • Any subtypes of the entity types inherit the restriction
    • \n
  • Any classificationDef subtypes inherit the parents entityTypes restrictions
    • \n
  • Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes
    • \n
  • An empty entityTypes list when there are no parent restrictions means there are no restrictions
    • \n
  • An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs
    • \n
", - "items": { + "/types/termtemplatedef/guid/{guid}": { + "get": { + "operationId": "Type_GetTermTemplateDefByGuid", + "description": "Get the term template definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the term template.", + "required": true, "type": "string" } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" + "x-ms-examples": { + "Type_GetTermTemplateDefByGuid": { + "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" } } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" - } - ], - "description": "class that captures details of a classification-type." - }, - "AtlasClassifications": { - "type": "object", - "title": "AtlasClassifications", - "allOf": [ - { - "$ref": "#/definitions/PList" - } - ], - "description": "REST serialization friendly list." + } }, - "AtlasConstraintDef": { - "type": "object", - "properties": { - "params": { - "type": "object", - "description": "The parameters of the constraint definition.", - "additionalProperties": {} + "/types/termtemplatedef/name/{name}": { + "get": { + "operationId": "Type_GetTermTemplateDefByName", + "description": "Get the term template definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The unique name of the term template.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } }, - "type": { - "type": "string", - "description": "The type of the constraint." - } - }, - "title": "AtlasConstraintDef", - "description": "class that captures details of a constraint." - }, - "AtlasEntitiesWithExtInfo": { - "type": "object", - "title": "AtlasEntitiesWithExtInfo", - "properties": { - "entities": { - "type": "array", - "description": "An array of entities.", - "items": { - "$ref": "#/definitions/AtlasEntity" + "x-ms-examples": { + "Type_GetTermTemplateDefByName": { + "$ref": "./examples/Type_GetTermTemplateDefByName.json" } } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasEntityExtInfo" - } - ], - "description": "An instance of an entity along with extended info - like hive_table, hive_database." - }, - "AtlasEntity": { + } + } + }, + "definitions": { + "AtlasAttributeDef": { "type": "object", - "title": "AtlasEntity", + "description": "class that captures details of a struct-attribute.", "properties": { - "businessAttributes": { - "readOnly": false, - "description": "Business Attributes", - "type": "object", - "additionalProperties": { - "type": "object" - } + "cardinality": { + "$ref": "#/definitions/CardinalityValue", + "description": "single-valued attribute or multi-valued attribute." }, - "classifications": { + "constraints": { "type": "array", - "description": "An array of classifications.", + "description": "An array of constraints.", "items": { - "$ref": "#/definitions/AtlasClassification" - } - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." + "$ref": "#/definitions/AtlasConstraintDef" + }, + "x-ms-identifiers": [] }, - "createdBy": { + "defaultValue": { "type": "string", - "description": "The user who created the record." + "description": "The default value of the attribute." }, - "customAttributes": { - "readOnly": false, - "description": "Custom Attribute", + "description": { + "type": "string", + "description": "The description of the attribute." + }, + "includeInNotification": { + "type": "boolean", + "description": "Determines if it is included in notification." + }, + "isIndexable": { + "type": "boolean", + "description": "Determines if it is indexable." + }, + "isOptional": { + "type": "boolean", + "description": "Determines if it is optional." + }, + "isUnique": { + "type": "boolean", + "description": "Determines if it unique." + }, + "name": { + "type": "string", + "description": "The name of the attribute." + }, + "options": { "type": "object", + "description": "The options for the attribute.", "additionalProperties": { "type": "string" } }, - "guid": { + "typeName": { "type": "string", - "description": "The GUID of the entity." + "description": "The name of the type." }, - "homeId": { + "valuesMaxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum count of the values." + }, + "valuesMinCount": { + "type": "integer", + "format": "int32", + "description": "The minimum count of the values." + } + } + }, + "AtlasBusinessMetadataDef": { + "type": "object", + "description": "class that captures details of a struct-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { "type": "string", - "description": "The home ID of the entity." + "description": "The user who created the record." }, - "collectionId": { - "readOnly": true, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { "type": "string", - "description": "The collection ID of the entity." + "description": "The description of the type definition." }, - "isIncomplete": { - "readOnly": false, - "description": "Whether it is a shell entity", - "type": "boolean" + "guid": { + "type": "string", + "description": "The GUID of the type definition." }, - "labels": { - "readOnly": false, - "description": "labels", - "type": "array", - "items": { + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { "type": "string" } }, - "meanings": { + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { "type": "array", - "description": "An array of term assignment headers indicating the meanings of the entity.", + "description": "An array of attribute definitions.", "items": { - "$ref": "#/definitions/AtlasTermAssignmentHeader" - } + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasClassification": { + "type": "object", + "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} }, - "provenanceType": { - "readOnly": false, - "description": "Used to record the provenance of an instance of an entity or relationship.", - "type": "number" + "typeName": { + "type": "string", + "description": "The name of the type." }, - "proxy": { + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "entityGuid": { + "type": "string", + "description": "The GUID of the entity." + }, + "entityStatus": { + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + }, + "removePropagationsOnEntityDelete": { "type": "boolean", - "description": "Determines if there's a proxy." + "description": "Determines if propagations will be removed on entity deletion." }, - "relationshipAttributes": { + "validityPeriods": { + "type": "array", + "description": "An array of time boundaries indicating validity periods.", + "items": { + "$ref": "#/definitions/TimeBoundary" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasClassificationDef": { + "type": "object", + "description": "class that captures details of a classification-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { "type": "object", - "description": "The attributes of relationship.", - "additionalProperties": {} + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } }, - "status": { - "$ref": "#/definitions/Status" + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." }, "updateTime": { "type": "integer", @@ -4362,41 +4746,29 @@ "description": "The user who updated the record." }, "version": { - "type": "number", - "description": "The version of the entity." + "type": "integer", + "format": "int64", + "description": "The version of the record." }, - "contacts": { - "type": "object", - "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/ContactBasic" - } + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", + "items": { + "type": "string" } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStruct" - } - ], - "description": "An instance of an entity - like hive_table, hive_database." - }, - "TermTemplateDef": { - "type": "object", - "title": "TermTemplateDef", - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" - } - ], - "description": "term template definition for glossary term." - }, - "AtlasEntityDef": { - "type": "object", - "title": "AtlasEntityDef", - "properties": { + }, "subTypes": { "type": "array", "description": "An array of sub types.", @@ -4410,244 +4782,174 @@ "items": { "type": "string" } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" - } - ], - "description": "class that captures details of a entity-type." - }, - "AtlasEntityExtInfo": { - "type": "object", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } } - }, - "title": "AtlasEntityExtInfo", - "description": "An instance of an entity along with extended info - like hive_table, hive_database." + } }, - "AtlasEntityHeader": { + "AtlasClassifications": { "type": "object", - "title": "AtlasEntityHeader", + "description": "REST serialization friendly list.", "properties": { - "classificationNames": { + "list": { "type": "array", - "description": "An array of classification names.", - "items": { - "type": "string" - } - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - } + "description": "An array of objects.", + "items": {} }, - "displayText": { - "type": "string", - "description": "The display text." + "pageSize": { + "type": "integer", + "format": "int32", + "description": "The size of the page." }, - "guid": { + "sortBy": { "type": "string", - "description": "The GUID of the record." - }, - "isIncomplete": { - "readOnly": false, - "description": "Whether it is a shell entity", - "type": "boolean" - }, - "labels": { - "readOnly": false, - "description": "labels", - "type": "array", - "items": { - "type": "string" - } + "description": "The sorted by field." }, - "meaningNames": { - "type": "array", - "description": "An array of meanings.", - "items": { - "type": "string" - } + "sortType": { + "$ref": "#/definitions/SortType", + "description": "to specify whether the result should be sorted? If yes, whether asc or desc." }, - "meanings": { - "type": "array", - "description": "An array of term assignment headers.", - "items": { - "$ref": "#/definitions/AtlasTermAssignmentHeader" - } + "startIndex": { + "type": "integer", + "format": "int32", + "description": "The start index of the page." }, - "status": { - "$ref": "#/definitions/Status" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStruct" + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count of items." } - ], - "description": "An instance of an entity - like hive_table, hive_database." + } }, - "AtlasEntityHeaders": { + "AtlasConstraintDef": { "type": "object", - "title": "AtlasEntityHeaders", + "description": "class that captures details of a constraint.", "properties": { - "guidHeaderMap": { - "readOnly": false, - "description": "The description of the guid header map,", + "params": { "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - } - }, - "description": "An instance of an entity header map." - }, - "AtlasEntityWithExtInfo": { - "type": "object", - "title": "AtlasEntityWithExtInfo", - "properties": { - "entity": { - "$ref": "#/definitions/AtlasEntity" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasEntityExtInfo" + "description": "The parameters of the constraint definition.", + "additionalProperties": {} + }, + "type": { + "type": "string", + "description": "The type of the constraint." } - ], - "description": "An instance of an entity along with extended info - like hive_table, hive_database." + } }, - "AtlasEnumDef": { + "AtlasEntitiesWithExtInfo": { "type": "object", - "title": "AtlasEnumDef", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", "properties": { - "defaultValue": { - "type": "string", - "description": "The default value." + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } }, - "elementDefs": { + "entities": { "type": "array", - "description": "An array of enum element definitions.", + "description": "An array of entities.", "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseTypeDef" + "$ref": "#/definitions/AtlasEntity" + }, + "x-ms-identifiers": [] } - ], - "description": "class that captures details of an enum-type." + } }, - "AtlasEnumElementDef": { + "AtlasEntity": { "type": "object", + "description": "An instance of an entity - like hive_table, hive_database.", "properties": { - "description": { - "type": "string", - "description": "The description of the enum element definition." - }, - "ordinal": { - "type": "number", - "description": "The ordinal of the enum element definition." + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} }, - "value": { + "typeName": { "type": "string", - "description": "The value of the enum element definition." - } - }, - "title": "AtlasEnumElementDef", - "description": "class that captures details of an enum-element." - }, - "AtlasGlossary": { - "type": "object", - "title": "AtlasGlossary", - "properties": { - "categories": { - "type": "array", - "description": "An array of categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - } + "description": "The name of the type." }, - "language": { + "lastModifiedTS": { "type": "string", - "description": "The language of the glossary." + "description": "ETag for concurrency control." }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "businessAttributes": { + "type": "object", + "description": "Business attributes", + "additionalProperties": {} }, - "usage": { - "type": "string", - "description": "The usage of the glossary." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasGlossaryBaseObject" - } - ], - "description": "The glossary object." - }, - "AtlasGlossaryBaseObject": { - "type": "object", - "title": "AtlasGlossaryBaseObject", - "properties": { "classifications": { "type": "array", "description": "An array of classifications.", "items": { "$ref": "#/definitions/AtlasClassification" - } + }, + "x-ms-identifiers": [] }, - "longDescription": { + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { "type": "string", - "description": "The long version description." + "description": "The user who created the record." }, - "name": { + "customAttributes": { + "type": "object", + "description": "Custom Attribute", + "additionalProperties": { + "type": "string" + } + }, + "guid": { "type": "string", - "description": "The name of the glossary object." + "description": "The GUID of the entity." }, - "qualifiedName": { + "homeId": { "type": "string", - "description": "The qualified name of the glossary object." + "description": "The home ID of the entity." }, - "shortDescription": { + "collectionId": { "type": "string", - "description": "The short version of description." + "description": "The collection ID of the entity.", + "readOnly": true }, - "lastModifiedTS": { - "$ref": "#/definitions/LastModifiedTS" + "isIncomplete": { + "type": "boolean", + "description": "Whether it is a shell entity" }, - "createTime": { + "labels": { + "type": "array", + "description": "labels", + "items": { + "type": "string" + } + }, + "meanings": { + "type": "array", + "description": "An array of term assignment headers indicating the meanings of the entity.", + "items": { + "$ref": "#/definitions/AtlasTermAssignmentHeader" + }, + "x-ms-identifiers": [] + }, + "provenanceType": { "type": "integer", - "format": "int64", - "description": "The created time of the record." + "format": "int32", + "description": "Used to record the provenance of an instance of an entity or relationship." }, - "createdBy": { - "type": "string", - "description": "The user who created the record." + "proxy": { + "type": "boolean", + "description": "Determines if there's a proxy." + }, + "relationshipAttributes": { + "type": "object", + "description": "The attributes of relationship.", + "additionalProperties": {} + }, + "status": { + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." }, "updateTime": { "type": "integer", @@ -4657,533 +4959,377 @@ "updatedBy": { "type": "string", "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the entity." + }, + "contacts": { + "type": "object", + "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/ContactInfo" + }, + "type": "array" + } } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseModelObject" - } - ], - "description": "The glossary base object." + } }, - "AtlasGlossaryCategory": { + "AtlasEntityDef": { "type": "object", - "title": "AtlasGlossaryCategory", + "description": "class that captures details of a entity-type.", "properties": { - "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader" + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." }, - "childrenCategories": { - "type": "array", - "description": "An array of children categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - } + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." }, - "parentCategory": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" + "createdBy": { + "type": "string", + "description": "The user who created the record." }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasGlossaryBaseObject" - } - ], - "description": "The glossary category." - }, - "AtlasGlossaryExtInfo": { - "type": "object", - "title": "AtlasGlossaryExtInfo", - "properties": { - "categoryInfo": { - "type": "object", - "description": "The glossary category information.", - "additionalProperties": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." }, - "termInfo": { - "type": "object", - "description": "The glossary term information.", - "additionalProperties": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasGlossary" - } - ], - "description": "The extended information of glossary." - }, - "AtlasGlossaryHeader": { - "type": "object", - "properties": { - "displayText": { + "description": { "type": "string", - "description": "The display text." + "description": "The description of the type definition." }, - "glossaryGuid": { + "guid": { "type": "string", - "description": "The GUID of the glossary." + "description": "The GUID of the type definition." }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - } - }, - "title": "AtlasGlossaryHeader", - "description": "The glossary header with basic information." - }, - "AtlasGlossaryTerm": { - "type": "object", - "title": "AtlasGlossaryTerm", - "properties": { - "abbreviation": { + "name": { "type": "string", - "description": "The abbreviation of the term." - }, - "templateName": { - "type": "array", - "items": { - "type": "object" - } - }, - "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader" + "description": "The name of the type definition." }, - "antonyms": { - "type": "array", - "description": "An array of related term headers as antonyms.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" } }, - "status": { - "$ref": "#/definitions/TermStatus" - }, - "nickName": { + "serviceType": { "type": "string", - "description": "The nick name of the term." + "description": "The service type." }, - "hierarchyInfo": { - "type": "array", - "description": "The hierarchy information of the term.", - "items": { - "$ref": "#/definitions/PurviewObjectId" - } + "typeVersion": { + "type": "string", + "description": "The version of the type." }, - "resources": { - "type": "array", - "description": "An array of resource link for term", - "items": { - "$ref": "#/definitions/ResourceLink" - } + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." }, - "contacts": { - "type": "object", - "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/ContactBasic" - } - } + "updatedBy": { + "type": "string", + "description": "The user who updated the record." }, - "attributes": { - "$ref": "#/definitions/TermCustomAttributes" + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." }, - "assignedEntities": { - "type": "array", - "description": "An array of related object IDs.", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - } + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." }, - "categories": { + "attributeDefs": { "type": "array", - "description": "An array of term categorization headers.", + "description": "An array of attribute definitions.", "items": { - "$ref": "#/definitions/AtlasTermCategorizationHeader" - } + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] }, - "classifies": { + "subTypes": { "type": "array", - "description": "An array of related term headers.", + "description": "An array of sub types.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "type": "string" } }, - "examples": { + "superTypes": { "type": "array", - "description": "An array of examples.", + "description": "An array of super types.", "items": { "type": "string" } }, - "isA": { + "relationshipAttributeDefs": { "type": "array", - "description": "An array of related term headers indicating the is-a relationship.", + "description": "An array of relationship attributes.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasEntityHeader": { + "type": "object", + "description": "An instance of an entity - like hive_table, hive_database.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} }, - "preferredTerms": { - "type": "array", - "description": "An array of preferred related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "typeName": { + "type": "string", + "description": "The name of the type." }, - "preferredToTerms": { - "type": "array", - "description": "An array of related term headers that are preferred to.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." }, - "replacedBy": { + "classificationNames": { "type": "array", - "description": "An array of related term headers that are replaced by.", + "description": "An array of classification names.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "type": "string" } }, - "replacementTerms": { + "classifications": { "type": "array", - "description": "An array of related term headers for replacement.", + "description": "An array of classifications.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] }, - "seeAlso": { - "type": "array", - "description": "An array of related term headers for see also.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "displayText": { + "type": "string", + "description": "The display text." }, - "synonyms": { - "type": "array", - "description": "An array of related term headers as synonyms.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "guid": { + "type": "string", + "description": "The GUID of the record." }, - "translatedTerms": { - "type": "array", - "description": "An array of translated related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "isIncomplete": { + "type": "boolean", + "description": "Whether it is a shell entity" }, - "translationTerms": { + "labels": { "type": "array", - "description": "An array of related term headers for translation.", + "description": "labels", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "type": "string" } }, - "usage": { - "type": "string", - "description": "The usage of the term." - }, - "validValues": { + "meaningNames": { "type": "array", - "description": "An array of related term headers as valid values.", + "description": "An array of meanings.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "type": "string" } }, - "validValuesFor": { + "meanings": { "type": "array", - "description": "An array of related term headers as valid values for other records.", + "description": "An array of term assignment headers.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasGlossaryBaseObject" - } - ], - "description": "The glossary term." - }, - "ResourceLink": { - "title": "ResourceLink", - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Display name for url." + "$ref": "#/definitions/AtlasTermAssignmentHeader" + }, + "x-ms-identifiers": [] }, - "url": { - "type": "string", - "description": "web url. http or https" + "status": { + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." } } }, - "ContactBasic": { - "title": "ContactBasic", + "AtlasEntityHeaders": { "type": "object", + "description": "An instance of an entity header map.", "properties": { - "id": { - "type": "string", - "description": "Azure Active Directory object Id." - }, - "info": { - "type": "string", - "description": "additional information to describe this contact." + "guidHeaderMap": { + "type": "object", + "description": "The description of the guid header map,", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } } } }, - "TermStatus": { - "type": "string", - "title": "Status", - "description": "Status of the AtlasGlossaryTerm", - "enum": [ - "Draft", - "Approved", - "Alert", - "Expired" - ], - "x-ms-enum": { - "name": "TermStatus", - "modelAsString": true - } - }, - "TermCustomAttributes": { - "title": "attributes", - "description": "The custom attributes of the term, which is map>.\nThe key of the first layer map is term template name.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TermCustomAttributesExtraProperties" - } - }, - "TermCustomAttributesExtraProperties": { - "type": "object", - "description": "The term attribute name and attribute value, which is map", - "additionalProperties": { - "description": "The value of custom term attribute" - } - }, - "AtlasLineageInfo": { + "AtlasEntityWithExtInfo": { "type": "object", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", "properties": { - "baseEntityGuid": { - "type": "string", - "description": "The GUID of the base entity." - }, - "guidEntityMap": { - "type": "object", - "description": "The GUID entity map.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "widthCounts": { + "referredEntities": { "type": "object", - "description": "The entity count in specific direction.", + "description": "The referred entities.", "additionalProperties": { - "$ref": "#/definitions/AtlasLineageInfoExtraProperties" + "$ref": "#/definitions/AtlasEntity" } }, - "lineageDepth": { - "type": "integer", - "format": "int32", - "description": "The depth of lineage." + "entity": { + "$ref": "#/definitions/AtlasEntity", + "description": "An instance of an entity - like hive_table, hive_database." + } + } + }, + "AtlasEnumDef": { + "type": "object", + "description": "class that captures details of an enum-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." }, - "lineageWidth": { + "createTime": { "type": "integer", - "format": "int32", - "description": "The width of lineage." + "format": "int64", + "description": "The created time of the record." }, - "childrenCount": { - "type": "integer", - "format": "int32", - "description": "The number of children node." + "createdBy": { + "type": "string", + "description": "The user who created the record." }, - "lineageDirection": { - "$ref": "#/definitions/LineageDirection" + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." }, - "parentRelations": { - "type": "array", - "description": "An array of parentRelations relations.", - "items": { - "$ref": "#/definitions/ParentRelation" - } + "description": { + "type": "string", + "description": "The description of the type definition." }, - "relations": { - "type": "array", - "description": "An array of lineage relations.", - "items": { - "$ref": "#/definitions/LineageRelation" - } - } - }, - "title": "AtlasLineageInfo", - "description": "The lineage information." - }, - "AtlasLineageInfoExtraProperties": { - "type": "object", - "description": "The lineage direction", - "additionalProperties": { - "description": "The entity guid." - } - }, - "AtlasObjectId": { - "type": "object", - "properties": { "guid": { "type": "string", - "description": "The GUID of the object." + "description": "The GUID of the type definition." }, - "typeName": { + "name": { "type": "string", - "description": "The name of the type." + "description": "The name of the type definition." }, - "uniqueAttributes": { + "options": { "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - } - }, - "title": "AtlasObjectId", - "description": "Reference to an object-instance of a type - like entity." - }, - "PurviewObjectId": { - "type": "object", - "properties": { - "name": { - "type": "string" + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } }, - "displayText": { - "type": "string" + "serviceType": { + "type": "string", + "description": "The service type." }, - "itemPath": { - "type": "string" + "typeVersion": { + "type": "string", + "description": "The version of the type." }, - "resourceId": { - "type": "string" + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." }, - "properties": { - "type": "object", - "additionalProperties": {} - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasObjectId" - } - ], - "title": "PurviewObjectId" - }, - "AtlasRelatedCategoryHeader": { - "type": "object", - "properties": { - "categoryGuid": { + "updatedBy": { "type": "string", - "description": "The GUID of the category." + "description": "The user who updated the record." }, - "description": { - "type": "string", - "description": "The description of the category header." + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." }, - "displayText": { + "lastModifiedTS": { "type": "string", - "description": "The display text." + "description": "ETag for concurrency control." }, - "parentCategoryGuid": { + "defaultValue": { "type": "string", - "description": "The GUID of the parent category." + "description": "The default value." }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] } - }, - "title": "AtlasRelatedCategoryHeader", - "description": "The header of the related category." + } }, - "AtlasRelatedObjectId": { + "AtlasEnumElementDef": { "type": "object", - "title": "AtlasRelatedObjectId", + "description": "class that captures details of an enum-element.", "properties": { - "displayText": { + "description": { "type": "string", - "description": "The display text." - }, - "entityStatus": { - "$ref": "#/definitions/Status" + "description": "The description of the enum element definition." }, - "relationshipType": { - "type": "string" + "ordinal": { + "type": "integer", + "format": "int32", + "description": "The ordinal of the enum element definition." }, - "relationshipAttributes": { - "$ref": "#/definitions/AtlasStruct" + "value": { + "type": "string", + "description": "The value of the enum element definition." + } + } + }, + "AtlasErrorResponse": { + "type": "object", + "description": "An error response from the service", + "properties": { + "requestId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The request ID." }, - "relationshipGuid": { + "errorCode": { "type": "string", - "description": "The GUID of the relationship." + "description": "The error code." }, - "relationshipStatus": { - "$ref": "#/definitions/Status_AtlasRelationship" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasObjectId" + "errorMessage": { + "type": "string", + "description": "The error message." } - ], - "description": "Reference to an object-instance of AtlasEntity type used in relationship attribute values" + } }, - "AtlasRelatedTermHeader": { + "AtlasGlossary": { "type": "object", + "description": "The glossary object.", "properties": { - "description": { + "guid": { "type": "string", - "description": "The description of the related term." + "description": "The GUID of the object." }, - "displayText": { - "type": "string", - "description": "The display text." + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] }, - "expression": { + "longDescription": { "type": "string", - "description": "The expression of the term." + "description": "The long version description." }, - "relationGuid": { + "name": { "type": "string", - "description": "The GUID of the relationship." + "description": "The name of the glossary object." }, - "status": { - "$ref": "#/definitions/AtlasTermRelationshipStatus" + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." }, - "steward": { + "shortDescription": { "type": "string", - "description": "The steward of the term." + "description": "The short version of description." }, - "termGuid": { + "lastModifiedTS": { "type": "string", - "description": "The GUID of the term." - } - }, - "title": "AtlasRelatedTermHeader", - "description": "The header of the related term." - }, - "AtlasRelationship": { - "type": "object", - "title": "AtlasRelationship", - "properties": { + "description": "ETag for concurrency control." + }, "createTime": { "type": "integer", "format": "int64", @@ -5193,31 +5339,85 @@ "type": "string", "description": "The user who created the record." }, - "end1": { - "$ref": "#/definitions/AtlasObjectId" + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." }, - "end2": { - "$ref": "#/definitions/AtlasObjectId" + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "categories": { + "type": "array", + "description": "An array of categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + }, + "language": { + "type": "string", + "description": "The language of the glossary." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, + "usage": { + "type": "string", + "description": "The usage of the glossary." + } + } + }, + "AtlasGlossaryCategory": { + "type": "object", + "description": "The glossary category.", + "properties": { "guid": { "type": "string", - "description": "The GUID of the relationship." + "description": "The GUID of the object." }, - "homeId": { + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { "type": "string", - "description": "The home ID of the relationship." + "description": "The long version description." }, - "label": { + "name": { "type": "string", - "description": "The label of the relationship." + "description": "The name of the glossary object." }, - "provenanceType": { - "readOnly": false, - "description": "Used to record the provenance of an instance of an entity or relationship", - "type": "number" + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." }, - "status": { - "$ref": "#/definitions/Status_AtlasRelationship" + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." }, "updateTime": { "type": "integer", @@ -5228,2040 +5428,2803 @@ "type": "string", "description": "The user who updated the record." }, - "version": { - "type": "number", - "description": "The version of the relationship." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStruct" - } - ], - "description": "Atlas relationship instance." - }, - "AtlasRelationshipDef": { - "type": "object", - "title": "AtlasRelationshipDef", - "properties": { - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef" + "anchor": { + "$ref": "#/definitions/AtlasGlossaryHeader", + "description": "The glossary header with basic information." }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef" + "childrenCategories": { + "type": "array", + "description": "An array of children categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory" + "parentCategory": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader", + "description": "The header of the related category." }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] } - ], - "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\n

\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.\nThe name and the guid are the 2 ways that the RelationshipDef is identified.\n

\nRelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally\nwhether the end is a container.\n

\nRelationshipDefs can have AttributeDefs - though only primitive types are allowed.
\nRelationshipDefs have a relationshipCategory specifying the UML type of relationship required
\nThe way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as their types.\n

\nRelationshipDefs introduce new attributes to the entity instances. For example\n

\nEntityDef A might have attributes attr1,attr2,attr3
\nEntityDef B might have attributes attr4,attr5,attr6
\nRelationshipDef AtoB might define 2 ends
\n\n

\n   end1:  type A, name attr7\n   end2:  type B, name attr8
\n\n

\nWhen an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7
\nWhen an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8\n

\nIn this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into\nthe entity instances" + } }, - "AtlasRelationshipEndDef": { + "AtlasGlossaryExtInfo": { "type": "object", + "description": "The extended information of glossary.", "properties": { - "cardinality": { - "$ref": "#/definitions/Cardinality" - }, - "description": { + "guid": { "type": "string", - "description": "The description of the relationship end definition." + "description": "The GUID of the object." }, - "isContainer": { - "type": "boolean", - "description": "Determines if it is container." + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] }, - "isLegacyAttribute": { - "type": "boolean", - "description": "Determines if it is a legacy attribute." + "longDescription": { + "type": "string", + "description": "The long version description." }, "name": { "type": "string", - "description": "The name of the relationship end definition." + "description": "The name of the glossary object." }, - "type": { + "qualifiedName": { "type": "string", - "description": "The type of the relationship end." - } - }, - "title": "AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an\nattribute name, cardinality and whether it is the container end of the relationship." - }, - "AtlasRelationshipAttributeDef": { - "type": "object", - "properties": { - "isLegacyAttribute": { - "type": "boolean", - "description": "Determines if it is a legacy attribute." + "description": "The qualified name of the glossary object." }, - "relationshipTypeName": { + "shortDescription": { "type": "string", - "description": "The name of the relationship type." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasAttributeDef" - } - ], - "title": "AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an\nattribute name, cardinality and whether it is the container end of the relationship." - }, - "AtlasRelationshipWithExtInfo": { - "type": "object", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entity header.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "relationship": { - "$ref": "#/definitions/AtlasRelationship" - } - }, - "title": "AtlasRelationshipWithExtInfo", - "description": "The relationship with extended information." - }, - "AtlasStruct": { - "type": "object", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} + "description": "The short version of description." }, - "typeName": { + "lastModifiedTS": { "type": "string", - "description": "The name of the type." + "description": "ETag for concurrency control." }, - "lastModifiedTS": { - "$ref": "#/definitions/LastModifiedTS" - } - }, - "title": "AtlasStruct", - "description": "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." - }, - "AtlasStructDef": { - "type": "object", - "title": "AtlasStructDef", - "properties": { - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseTypeDef" - } - ], - "description": "class that captures details of a struct-type." - }, - "AtlasTermAssignmentHeader": { - "type": "object", - "properties": { - "confidence": { + "createTime": { "type": "integer", - "format": "int32", - "description": "The confidence of the term assignment." + "format": "int64", + "description": "The created time of the record." }, "createdBy": { "type": "string", "description": "The user who created the record." }, - "description": { - "type": "string", - "description": "The description of the term assignment." + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." }, - "displayText": { + "updatedBy": { "type": "string", - "description": "The display text." + "description": "The user who updated the record." }, - "expression": { - "type": "string", - "description": "The expression of the term assignment." + "categories": { + "type": "array", + "description": "An array of categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] }, - "relationGuid": { + "language": { "type": "string", - "description": "The GUID of the relationship." + "description": "The language of the glossary." }, - "status": { - "$ref": "#/definitions/AtlasTermAssignmentStatus" + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "steward": { + "usage": { "type": "string", - "description": "The steward of the term." + "description": "The usage of the glossary." }, - "termGuid": { - "type": "string", - "description": "The GUID of the term." + "categoryInfo": { + "type": "object", + "description": "The glossary category information.", + "additionalProperties": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "termInfo": { + "type": "object", + "description": "The glossary term information.", + "additionalProperties": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } } - }, - "title": "AtlasTermAssignmentHeader", - "description": "The header for term assignment." + } }, - "AtlasTermAssignmentStatus": { - "type": "string", - "title": "AtlasTermAssignmentStatus", - "description": "The status of terms assignment.", - "enum": [ - "DISCOVERED", - "PROPOSED", - "IMPORTED", - "VALIDATED", - "DEPRECATED", - "OBSOLETE", - "OTHER" - ], - "x-ms-enum": { - "name": "AtlasTermAssignmentStatus", - "modelAsString": true - } - }, - "AtlasTermCategorizationHeader": { + "AtlasGlossaryHeader": { "type": "object", + "description": "The glossary header with basic information.", "properties": { - "categoryGuid": { - "type": "string", - "description": "The GUID of the category." - }, - "description": { - "type": "string", - "description": "The description of the record." - }, "displayText": { "type": "string", "description": "The display text." }, + "glossaryGuid": { + "type": "string", + "description": "The GUID of the glossary." + }, "relationGuid": { "type": "string", "description": "The GUID of the relationship." - }, - "status": { - "$ref": "#/definitions/AtlasTermRelationshipStatus" } - }, - "title": "AtlasTermCategorizationHeader", - "description": "The basic information for term categorization." - }, - "AtlasTermRelationshipStatus": { - "type": "string", - "title": "AtlasTermRelationshipStatus", - "description": "The status of term relationship.", - "enum": [ - "DRAFT", - "ACTIVE", - "DEPRECATED", - "OBSOLETE", - "OTHER" - ], - "x-ms-enum": { - "name": "AtlasTermRelationshipStatus", - "modelAsString": true } }, - "AtlasTypeDefHeader": { + "AtlasGlossaryTerm": { "type": "object", + "description": "The glossary term.", "properties": { - "category": { - "$ref": "#/definitions/TypeCategory" - }, "guid": { "type": "string", - "description": "The GUID of the type definition." + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." }, "name": { "type": "string", - "description": "The name of the type definition." - } - }, - "title": "AtlasTypeDefHeader", - "description": "The basic information of the type definition." - }, - "AtlasTypesDef": { - "type": "object", - "properties": { - "businessMetadataDefs": { - "readOnly": false, - "description": "businessMetadataDefs", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "abbreviation": { + "type": "string", + "description": "The abbreviation of the term." + }, + "templateName": { "type": "array", - "items": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - } + "description": "The name of the template.", + "items": {} }, - "classificationDefs": { + "anchor": { + "$ref": "#/definitions/AtlasGlossaryHeader", + "description": "The glossary header with basic information." + }, + "antonyms": { "type": "array", - "description": "An array of classification definitions.", + "description": "An array of related term headers as antonyms.", "items": { - "$ref": "#/definitions/AtlasClassificationDef" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "entityDefs": { + "status": { + "$ref": "#/definitions/TermStatus", + "description": "Status of the AtlasGlossaryTerm" + }, + "nickName": { + "type": "string", + "description": "The nick name of the term." + }, + "hierarchyInfo": { "type": "array", - "description": "An array of entity definitions.", + "description": "The hierarchy information of the term.", "items": { - "$ref": "#/definitions/AtlasEntityDef" - } + "$ref": "#/definitions/PurviewObjectId" + }, + "x-ms-identifiers": [] }, - "enumDefs": { + "resources": { "type": "array", - "description": "An array of enum definitions.", + "description": "An array of resource link for term", "items": { - "$ref": "#/definitions/AtlasEnumDef" + "$ref": "#/definitions/ResourceLink" + }, + "x-ms-identifiers": [] + }, + "contacts": { + "type": "object", + "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/ContactInfo" + }, + "type": "array" } }, - "relationshipDefs": { - "type": "array", - "description": "An array of relationship definitions.", - "items": { - "$ref": "#/definitions/AtlasRelationshipDef" + "attributes": { + "type": "object", + "description": "The custom attributes of the term, which is map>.\nThe\nkey of the first layer map is term template name.", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" } }, - "structDefs": { + "assignedEntities": { "type": "array", - "description": "An array of struct definitions.", + "description": "An array of related object IDs.", "items": { - "$ref": "#/definitions/AtlasStructDef" - } + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] }, - "termTemplateDefs": { + "categories": { "type": "array", - "description": "An array of term template definitions.", + "description": "An array of term categorization headers.", "items": { - "$ref": "#/definitions/TermTemplateDef" - } - } - }, - "title": "AtlasTypesDef", - "description": "The definitions of types." - }, - "AtlasExtraTypeDef": { - "type": "object", - "properties": { - "entityTypes": { + "$ref": "#/definitions/AtlasTermCategorizationHeader" + }, + "x-ms-identifiers": [] + }, + "classifies": { "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that classifications can\nonly be applied to those entityTypes.\n

    \n
  • Any subtypes of the entity types inherit the restriction
    • \n
  • Any classificationDef subtypes inherit the parents entityTypes restrictions
    • \n
  • Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes
    • \n
  • An empty entityTypes list when there are no parent restrictions means there are no restrictions
    • \n
  • An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs
    • \n
", + "description": "An array of related term headers.", "items": { - "type": "string" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "subTypes": { + "examples": { "type": "array", - "description": "An array of sub types.", + "description": "An array of examples.", "items": { "type": "string" } }, - "superTypes": { + "isA": { "type": "array", - "description": "An array of super types.", + "description": "An array of related term headers indicating the is-a relationship.", "items": { - "type": "string" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "relationshipAttributeDefs": { + "preferredTerms": { "type": "array", - "description": "An array of relationship attributes.", + "description": "An array of preferred related term headers.", "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "defaultValue": { - "type": "string", - "description": "The default value." + "preferredToTerms": { + "type": "array", + "description": "An array of related term headers that are preferred to.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "elementDefs": { + "replacedBy": { "type": "array", - "description": "An array of enum element definitions.", + "description": "An array of related term headers that are replaced by.", "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef" + "replacementTerms": { + "type": "array", + "description": "An array of related term headers for replacement.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef" + "seeAlso": { + "type": "array", + "description": "An array of related term headers for see also.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory" + "synonyms": { + "type": "array", + "description": "An array of related term headers as synonyms.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." + "translatedTerms": { + "type": "array", + "description": "An array of translated related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "attributeDefs": { + "translationTerms": { "type": "array", - "description": "An array of attribute definitions.", + "description": "An array of related term headers for translation.", "items": { - "$ref": "#/definitions/AtlasAttributeDef" - } - } - }, - "title": "AtlasExtraTypeDef", - "description": "Extra properties for a type." - }, - "AtlasTypeDef": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseTypeDef" - }, - { - "$ref": "#/definitions/AtlasExtraTypeDef" - } - ], - "title": "AtlasTypeDef", - "description": "The definitions of type." - }, - "ImportInfo": { - "type": "object", - "title": "ImportInfo", - "properties": { - "childObjectName": { - "readOnly": false, - "description": "childObjectName", - "type": "string" - }, - "importStatus": { - "readOnly": false, - "$ref": "#/definitions/ImportStatus", - "description": "importStatus" - }, - "parentObjectName": { - "readOnly": false, - "description": "parentObjectName", - "type": "string" + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "remarks": { - "readOnly": false, - "description": "remarks", - "type": "string" - } - }, - "example": { - "childObjectName": "...", - "importStatus": "SUCCESS", - "parentObjectName": "...", - "remarks": "..." - }, - "description": "ImportInfo" - }, - "ImportStatus": { - "type": "string", - "title": "ImportStatus", - "enum": [ - "SUCCESS", - "FAILED" - ], - "description": "ImportStatus", - "x-ms-enum": { - "name": "importStatus", - "modelAsString": true - } - }, - "BulkImportResponse": { - "type": "object", - "title": "BulkImportResponse", - "properties": { - "failedImportInfoList": { - "readOnly": false, - "description": "failed importInfoList", - "type": "array", - "items": { - "$ref": "#/definitions/ImportInfo" - } + "usage": { + "type": "string", + "description": "The usage of the term." }, - "successImportInfoList": { - "readOnly": false, - "description": "successful importInfoList", + "validValues": { "type": "array", + "description": "An array of related term headers as valid values.", "items": { - "$ref": "#/definitions/ImportInfo" - } - } - }, - "example": { - "failedImportInfoList": [ - { - "childObjectName": "...", - "importStatus": "SUCCESS", - "parentObjectName": "...", - "remarks": "..." - }, - { - "childObjectName": "...", - "importStatus": "SUCCESS", - "parentObjectName": "...", - "remarks": "..." - } - ], - "successImportInfoList": [ - { - "childObjectName": "...", - "importStatus": "FAILED", - "parentObjectName": "...", - "remarks": "..." + "$ref": "#/definitions/AtlasRelatedTermHeader" }, - { - "childObjectName": "...", - "importStatus": "FAILED", - "parentObjectName": "...", - "remarks": "..." - } - ] - }, - "description": "example" - }, - "Cardinality": { - "type": "string", - "title": "Cardinality", - "description": "single-valued attribute or multi-valued attribute.", - "enum": [ - "SINGLE", - "LIST", - "SET" - ], - "x-ms-enum": { - "name": "Cardinality", - "modelAsString": true - } - }, - "ClassificationAssociateRequest": { - "type": "object", - "properties": { - "classification": { - "$ref": "#/definitions/AtlasClassification" + "x-ms-identifiers": [] }, - "entityGuids": { - "type": "array", - "description": "The GUID of the entity.", - "items": { - "type": "string" - } - } - }, - "title": "ClassificationAssociateRequest", - "description": "The request for classification association." - }, - "MoveEntitiesRequest": { - "type": "object", - "properties": { - "entityGuids": { + "validValuesFor": { "type": "array", - "description": "An array of entity guids to be moved to target collection.", + "description": "An array of related term headers as valid values for other records.", "items": { - "type": "string" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] } } }, - "DateFormat": { + "AtlasLineageInfo": { "type": "object", - "title": "DateFormat", + "description": "The lineage information.", "properties": { - "availableLocales": { - "type": "array", - "description": "An array of available locales.", - "items": { - "type": "string" - } - }, - "calendar": { - "type": "number" - }, - "dateInstance": { - "$ref": "#/definitions/DateFormat" - }, - "dateTimeInstance": { - "$ref": "#/definitions/DateFormat" - }, - "instance": { - "$ref": "#/definitions/DateFormat" - }, - "lenient": { - "type": "boolean", - "description": "Determines the leniency of the date format." - }, - "numberFormat": { - "$ref": "#/definitions/NumberFormat" - }, - "timeInstance": { - "$ref": "#/definitions/DateFormat" + "baseEntityGuid": { + "type": "string", + "description": "The GUID of the base entity." }, - "timeZone": { - "$ref": "#/definitions/TimeZone" - } - }, - "description": "The date format." - }, - "EntityMutationResponse": { - "type": "object", - "properties": { - "guidAssignments": { + "guidEntityMap": { "type": "object", - "description": "A map of GUID assignments with entities.", + "description": "The GUID entity map.", "additionalProperties": { - "type": "string" + "$ref": "#/definitions/AtlasEntityHeader" } }, - "mutatedEntities": { + "widthCounts": { "type": "object", - "description": "The entity headers of mutated entities.", + "description": "The entity count in specific direction.", "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasEntityHeader" - } + "additionalProperties": {}, + "type": "object" } }, - "partialUpdatedEntities": { + "lineageDepth": { + "type": "integer", + "format": "int32", + "description": "The depth of lineage." + }, + "lineageWidth": { + "type": "integer", + "format": "int32", + "description": "The width of lineage." + }, + "childrenCount": { + "type": "integer", + "format": "int32", + "description": "The number of children node." + }, + "lineageDirection": { + "$ref": "#/definitions/LineageDirection", + "description": "The enum of lineage direction." + }, + "parentRelations": { "type": "array", - "description": "An array of entity headers that partially updated.", + "description": "An array of parentRelations relations.", "items": { - "$ref": "#/definitions/AtlasEntityHeader" - } + "$ref": "#/definitions/ParentRelation" + }, + "x-ms-identifiers": [] + }, + "relations": { + "type": "array", + "description": "An array of lineage relations.", + "items": { + "$ref": "#/definitions/LineageRelation" + }, + "x-ms-identifiers": [] } - }, - "title": "EntityMutationResponse", - "description": "The mutation response of entity." - }, - "LineageDirection": { - "type": "string", - "title": "LineageDirection", - "description": "The enum of lineage direction.", - "enum": [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "x-ms-enum": { - "name": "LineageDirection", - "modelAsString": true } }, - "LineageRelation": { + "AtlasObjectId": { "type": "object", + "description": "Reference to an object-instance of a type - like entity.", "properties": { - "fromEntityId": { + "guid": { "type": "string", - "description": "The GUID of from-entity." + "description": "The GUID of the object." }, - "relationshipId": { + "typeName": { "type": "string", - "description": "The GUID of relationship." + "description": "The name of the type." }, - "toEntityId": { - "type": "string", - "description": "The GUID of to-entity." + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} } - }, - "title": "LineageRelation", - "description": "The lineage relation with GUID of the from and to entity." + } }, - "ParentRelation": { + "AtlasRelatedCategoryHeader": { "type": "object", + "description": "The header of the related category.", "properties": { - "childEntityId": { + "categoryGuid": { "type": "string", - "description": "The GUID of child entity." + "description": "The GUID of the category." }, - "relationshipId": { + "description": { "type": "string", - "description": "The GUID of relationship." + "description": "The description of the category header." }, - "parentEntityId": { + "displayText": { "type": "string", - "description": "The GUID of parent entity." + "description": "The display text." + }, + "parentCategoryGuid": { + "type": "string", + "description": "The GUID of the parent category." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." } - }, - "title": "ParentRelation", - "description": "The lineage parents relation with GUID of the parent entity and to child entity." + } }, - "NumberFormat": { + "AtlasRelatedObjectId": { "type": "object", - "title": "NumberFormat", + "description": "Reference to an object-instance of AtlasEntity type used in relationship\nattribute values", "properties": { - "availableLocales": { - "type": "array", - "description": "The number format.", - "items": { - "type": "string" - } + "guid": { + "type": "string", + "description": "The GUID of the object." }, - "currency": { + "typeName": { "type": "string", - "description": "The currency." + "description": "The name of the type." }, - "currencyInstance": { - "$ref": "#/definitions/NumberFormat" + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} }, - "groupingUsed": { - "type": "boolean", - "description": "Determines if grouping is used." + "displayText": { + "type": "string", + "description": "The display text." }, - "instance": { - "$ref": "#/definitions/NumberFormat" - }, - "integerInstance": { - "$ref": "#/definitions/NumberFormat" - }, - "maximumFractionDigits": { - "type": "integer", - "format": "int32", - "description": "The maximum of fraction digits." - }, - "maximumIntegerDigits": { - "type": "integer", - "format": "int32", - "description": "The maximum of integer digits." - }, - "minimumFractionDigits": { - "type": "integer", - "format": "int32", - "description": "The minimum of fraction digits." - }, - "minimumIntegerDigits": { - "type": "integer", - "format": "int32", - "description": "The minimum of integer digits." - }, - "numberInstance": { - "$ref": "#/definitions/NumberFormat" - }, - "parseIntegerOnly": { - "type": "boolean", - "description": "Determines if only integer is parsed." - }, - "percentInstance": { - "$ref": "#/definitions/NumberFormat" - }, - "roundingMode": { - "$ref": "#/definitions/RoundingMode" - } - }, - "description": "The number format." - }, - "TermGuid": { - "type": "string", - "title": "termGuid", - "description": "The globally unique identifier for glossary term." - }, - "PList": { - "type": "object", - "properties": { - "list": { - "type": "array", - "description": "An array of objects.", - "items": { - "type": "object", - "properties": {} - } - }, - "pageSize": { - "type": "integer", - "format": "int32", - "description": "The size of the page." + "entityStatus": { + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." }, - "sortBy": { + "relationshipType": { "type": "string", - "description": "The sorted by field." + "description": "Relationship type" }, - "sortType": { - "$ref": "#/definitions/SortType" + "relationshipAttributes": { + "$ref": "#/definitions/AtlasStruct", + "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification." }, - "startIndex": { - "type": "integer", - "format": "int64", - "description": "The start index of the page." + "relationshipGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the relationship." }, - "totalCount": { - "type": "integer", - "format": "int64", - "description": "The total count of items." + "relationshipStatus": { + "$ref": "#/definitions/StatusAtlasRelationship", + "description": "The enum of relationship status." } - }, - "title": "PList", - "description": "Paginated-list, for returning search results." - }, - "RelationshipCategory": { - "type": "string", - "title": "RelationshipCategory", - "description": "The Relationship category determines the style of relationship around containment and lifecycle.\nUML terminology is used for the values.\n

\nASSOCIATION is a relationship with no containment.
\nCOMPOSITION and AGGREGATION are containment relationships.\n

\nThe difference being in the lifecycles of the container and its children. In the COMPOSITION case,\nthe children cannot exist without the container. For AGGREGATION, the life cycles\nof the container and children are totally independent.", - "enum": [ - "ASSOCIATION", - "AGGREGATION", - "COMPOSITION" - ], - "x-ms-enum": { - "name": "RelationshipCategory", - "modelAsString": true - } - }, - "RoundingMode": { - "type": "string", - "title": "RoundingMode", - "description": "The enum of rounding mode.", - "enum": [ - "UP", - "DOWN", - "CEILING", - "FLOOR", - "HALF_UP", - "HALF_DOWN", - "HALF_EVEN", - "UNNECESSARY" - ], - "x-ms-enum": { - "name": "RoundingMode", - "modelAsString": true - } - }, - "SortType": { - "type": "string", - "title": "SortType", - "description": "to specify whether the result should be sorted? If yes, whether asc or desc.", - "enum": [ - "NONE", - "ASC", - "DESC" - ], - "x-ms-enum": { - "name": "SortType", - "modelAsString": true - } - }, - "Status": { - "type": "string", - "title": "Status", - "description": "Status of the entity - can be active or deleted. Deleted entities are not removed.", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "Status", - "modelAsString": true - } - }, - "Status_AtlasRelationship": { - "type": "string", - "title": "Status", - "description": "The enum of relationship status.", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "Status_AtlasRelationship", - "modelAsString": true } }, - "TimeBoundary": { + "AtlasRelatedTermHeader": { "type": "object", + "description": "The header of the related term.", "properties": { - "endTime": { + "description": { "type": "string", - "description": "The end of the time boundary." + "description": "The description of the related term." }, - "startTime": { + "displayText": { "type": "string", - "description": "The start of the time boundary." + "description": "The display text." }, - "timeZone": { + "expression": { "type": "string", - "description": "The timezone of the time boundary." - } - }, - "title": "TimeBoundary", - "description": "Captures time-boundary details" - }, - "TimeZone": { - "type": "object", - "properties": { - "dstSavings": { - "type": "integer", - "format": "int32", - "description": "The value of the daylight saving time." + "description": "The expression of the term." }, - "id": { + "relationGuid": { "type": "string", - "description": "The ID of the timezone." - }, - "availableIds": { - "type": "array", - "description": "An array of available IDs.", - "items": { - "type": "string" - } + "description": "The GUID of the relationship." }, - "default": { - "$ref": "#/definitions/TimeZone" + "status": { + "$ref": "#/definitions/AtlasTermRelationshipStatus", + "description": "The status of term relationship." }, - "displayName": { + "steward": { "type": "string", - "description": "The display name of the timezone." + "description": "The steward of the term." }, - "rawOffset": { - "type": "integer", - "format": "int32", - "description": "The raw offset of the timezone." + "termGuid": { + "type": "string", + "description": "The GUID of the term." } - }, - "title": "TimeZone", - "description": "The timezone information." - }, - "TypeCategory": { - "type": "string", - "title": "TypeCategory", - "description": "The enum of type category.", - "enum": [ - "PRIMITIVE", - "OBJECT_ID_TYPE", - "ENUM", - "STRUCT", - "CLASSIFICATION", - "ENTITY", - "ARRAY", - "MAP", - "RELATIONSHIP", - "TERM_TEMPLATE" - ], - "x-ms-enum": { - "name": "TypeCategory", - "modelAsString": true } }, - "SuggestResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SuggestResultValue" - } - } - }, - "title": "SuggestResult", - "description": "The result item of the search suggest." - }, - "SuggestResultValue": { + "AtlasRelationship": { "type": "object", + "description": "Atlas relationship instance.", "properties": { - "@search.score": { - "type": "number", - "format": "float", - "description": "The search score calculated by the search engine. The results are ordered by search score by default." + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} }, - "@search.text": { + "typeName": { "type": "string", - "description": "The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark." + "description": "The name of the type." }, - "objectType": { + "lastModifiedTS": { "type": "string", - "description": "The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term." + "description": "ETag for concurrency control." }, "createTime": { "type": "integer", "format": "int64", - "description": "The create time of the record. The Unix epoch format." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The last update time of the record. The Unix epoch format." + "description": "The created time of the record." }, - "id": { + "createdBy": { "type": "string", - "description": "The GUID of the record." + "description": "The user who created the record." }, - "name": { - "type": "string", - "description": "The name of the record." + "end1": { + "$ref": "#/definitions/AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the record." + "end2": { + "$ref": "#/definitions/AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." }, - "entityType": { + "guid": { "type": "string", - "description": "The type name of the asset." + "description": "The GUID of the relationship." }, - "description": { + "homeId": { "type": "string", - "description": "The description of the asset." + "description": "The home ID of the relationship." }, - "endorsement": { + "label": { "type": "string", - "description": "The endorsement of the asset." + "description": "The label of the relationship." }, - "owner": { - "type": "string", - "description": "The owner of the record." + "provenanceType": { + "type": "integer", + "format": "int32", + "description": "Used to record the provenance of an instance of an entity or relationship" }, - "classification": { - "type": "array", - "description": "The classifications of the record.", - "items": { - "type": "string" - } + "status": { + "$ref": "#/definitions/StatusAtlasRelationship", + "description": "The enum of relationship status." }, - "label": { - "type": "array", - "description": "The labels of the asset.", - "items": { - "type": "string" - } - }, - "term": { - "type": "array", - "description": "The terms assigned to the asset.", - "items": { - "$ref": "#/definitions/TermSearchResultValue" - } - }, - "contact": { - "type": "array", - "description": "The contacts of the asset.", - "items": { - "$ref": "#/definitions/ContactSearchResultValue" - } - }, - "assetType": { - "type": "array", - "description": "The asset types of the asset.", - "items": { - "type": "string" - } - }, - "glossaryType": { - "type": "string", - "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory." - }, - "glossary": { - "type": "string", - "description": "The glossary name of the term." - }, - "termStatus": { - "type": "string", - "description": "The status of the term." - }, - "termTemplate": { - "type": "array", - "description": "The term template names used by the term.", - "items": { - "type": "string" - } - }, - "longDescription": { - "type": "string", - "description": "The definition of the term." - } - }, - "title": "SuggestResultValue", - "description": "The value item of the search suggest." - }, - "SearchResult": { - "type": "object", - "properties": { - "@search.count": { + "updateTime": { "type": "integer", - "format": "int32", - "description": "The total number of search results (not the number of documents in a single page)." - }, - "@search.count.approximate": { - "type": "boolean", - "description": "'True' if the '@search.count' is an approximate value and vise versa." + "format": "int64", + "description": "The update time of the record." }, - "continuationToken": { + "updatedBy": { "type": "string", - "description": "The token used to get next batch of data. Absent if there's no more data." - }, - "@search.facets": { - "$ref": "#/definitions/SearchFacetResultValue" + "description": "The user who updated the record." }, - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchResultValue" - } + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the relationship." } - }, - "title": "SearchResult", - "description": "The result of the search result." + } }, - "SearchFacetResultValue": { + "AtlasRelationshipAttributeDef": { "type": "object", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", "properties": { - "entityType": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "cardinality": { + "$ref": "#/definitions/CardinalityValue", + "description": "single-valued attribute or multi-valued attribute." }, - "assetType": { + "constraints": { "type": "array", + "description": "An array of constraints.", "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "$ref": "#/definitions/AtlasConstraintDef" + }, + "x-ms-identifiers": [] }, - "classification": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "defaultValue": { + "type": "string", + "description": "The default value of the attribute." }, - "term": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "description": { + "type": "string", + "description": "The description of the attribute." }, - "contactId": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "includeInNotification": { + "type": "boolean", + "description": "Determines if it is included in notification." }, - "contactType": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "isIndexable": { + "type": "boolean", + "description": "Determines if it is indexable." }, - "label": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "isOptional": { + "type": "boolean", + "description": "Determines if it is optional." }, - "glossaryType": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "isUnique": { + "type": "boolean", + "description": "Determines if it unique." }, - "termStatus": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "name": { + "type": "string", + "description": "The name of the attribute." }, - "termTemplate": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" + "options": { + "type": "object", + "description": "The options for the attribute.", + "additionalProperties": { + "type": "string" } - } - }, - "title": "Context", - "description": "A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets." - }, - "SearchFacetItemValue": { - "type": "object", - "properties": { - "count": { + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "valuesMaxCount": { "type": "integer", "format": "int32", - "description": "The count of the facet item." + "description": "The maximum count of the values." }, - "value": { - "type": "string", - "description": "The name of the facet item." - } - }, - "title": "SearchFacetItemValue", - "description": "The content of a search facet result item." - }, - "SearchFacetItem": { - "type": "object", - "properties": { - "count": { + "valuesMinCount": { "type": "integer", "format": "int32", - "description": "The count of the facet item." + "description": "The minimum count of the values." }, - "facet": { - "type": "string", - "description": "The name of the facet item." + "isLegacyAttribute": { + "type": "boolean", + "description": "Determines if it is a legacy attribute." }, - "sort": { - "type": "object" + "relationshipTypeName": { + "type": "string", + "description": "The name of the relationship type." } - }, - "title": "SearchFacetItemValue", - "description": "The content of a search facet result item." - }, - "SearchOrderItem": { - "type": "object", - "description": "See examples for the usage of search order." + } }, - "SearchResultValue": { + "AtlasRelationshipDef": { "type": "object", + "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the\nRelationshipDef has a guid.\nThe name and the guid are the 2 ways that the\nRelationshipDef is identified.\nRelationshipDefs have 2 ends, each of which\nspecify cardinality, an EntityDef type name and name and optionally\nwhether the\nend is a container.\nRelationshipDefs can have AttributeDefs - though only\nprimitive types are allowed. \nRelationshipDefs have a relationshipCategory\nspecifying the UML type of relationship required \nThe way EntityDefs and\nRelationshipDefs are intended to be used is that EntityDefs will define\nAttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as\ntheir types.\nRelationshipDefs introduce new attributes to the entity\ninstances. For example\nEntityDef A might have attributes attr1,attr2,attr3\n\nEntityDef B might have attributes attr4,attr5,attr6 \nRelationshipDef\nAtoB might define 2 ends \n\nend1: type A, name attr7\nend2: type B, name attr8 \n\nWhen an instance of EntityDef A is created, it\nwill have attributes attr1,attr2,attr3,attr7 \nWhen an instance of EntityDef\nB is created, it will have attributes attr4,attr5,attr6,attr8\n\nIn this way\nrelationshipDefs can be authored separately from entityDefs and can inject\nrelationship attributes into\nthe entity instances", "properties": { - "@search.score": { - "type": "number", - "format": "float", - "description": "The search score calculated by the search engine. The results are ordered by search score by default." - }, - "@search.highlights": { - "$ref": "#/definitions/SearchHighlights" - }, - "objectType": { - "type": "string", - "description": "The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term." + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." }, "createTime": { "type": "integer", "format": "int64", - "description": "The create time of the record. The Unix epoch format." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The last update time of the record. The Unix epoch format." - }, - "id": { - "type": "string", - "description": "The GUID of the record." - }, - "name": { - "type": "string", - "description": "The name of the record." + "description": "The created time of the record." }, - "qualifiedName": { + "createdBy": { "type": "string", - "description": "The qualified name of the record." + "description": "The user who created the record." }, - "entityType": { - "type": "string", - "description": "The type name of the asset." + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." }, "description": { "type": "string", - "description": "The description of the asset." + "description": "The description of the type definition." }, - "endorsement": { + "guid": { "type": "string", - "description": "The endorsement of the asset." + "description": "The GUID of the type definition." }, - "owner": { + "name": { "type": "string", - "description": "The owner of the record." + "description": "The name of the type definition." }, - "classification": { - "type": "array", - "description": "The classifications of the record.", - "items": { + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { "type": "string" } }, - "label": { - "type": "array", - "description": "The labels of the asset.", - "items": { - "type": "string" - } - }, - "term": { - "type": "array", - "description": "The terms assigned to the asset.", - "items": { - "$ref": "#/definitions/TermSearchResultValue" - } + "serviceType": { + "type": "string", + "description": "The service type." }, - "contact": { - "type": "array", - "description": "The contacts of the asset.", - "items": { - "$ref": "#/definitions/ContactSearchResultValue" - } + "typeVersion": { + "type": "string", + "description": "The version of the type." }, - "assetType": { - "type": "array", - "description": "The asset types of the asset.", - "items": { - "type": "string" - } + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." }, - "glossaryType": { + "updatedBy": { "type": "string", - "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory." + "description": "The user who updated the record." }, - "glossary": { - "type": "string", - "description": "The glossary name of the term." + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." }, - "termStatus": { + "lastModifiedTS": { "type": "string", - "description": "The status of the term." + "description": "ETag for concurrency control." }, - "termTemplate": { + "attributeDefs": { "type": "array", - "description": "The term template names used by the term.", + "description": "An array of attribute definitions.", "items": { - "type": "string" - } + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] }, - "longDescription": { + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\nASSOCIATION is a relationship with no containment. \nCOMPOSITION and AGGREGATION are containment relationships.\nThe difference being in the lifecycles of the container and its children. \nIn the COMPOSITION case, the children cannot exist without the container.\nFor AGGREGATION, the life cycles of the container and children are totally independent." + }, + "relationshipLabel": { "type": "string", - "description": "The definition of the term." + "description": "The label of the relationship." } - }, - "title": "SearchResultValue", - "description": "The value item of the search result." + } }, - "SearchHighlights": { + "AtlasRelationshipEndDef": { "type": "object", - "description": "A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", "properties": { - "id": { - "type": "array", - "items": { - "type": "string" - } + "cardinality": { + "$ref": "#/definitions/CardinalityValue", + "description": "single-valued attribute or multi-valued attribute." }, - "qualifiedName": { - "type": "array", - "items": { - "type": "string" - } + "description": { + "type": "string", + "description": "The description of the relationship end definition." + }, + "isContainer": { + "type": "boolean", + "description": "Determines if it is container." + }, + "isLegacyAttribute": { + "type": "boolean", + "description": "Determines if it is a legacy attribute." }, "name": { - "type": "array", - "items": { - "type": "string" - } + "type": "string", + "description": "The name of the relationship end definition." }, - "description": { - "type": "array", - "items": { - "type": "string" + "type": { + "type": "string", + "description": "The type of the relationship end." + } + } + }, + "AtlasRelationshipWithExtInfo": { + "type": "object", + "description": "The relationship with extended information.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entity header.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" } }, - "entityType": { - "type": "array", - "items": { - "type": "string" - } + "relationship": { + "$ref": "#/definitions/AtlasRelationship", + "description": "Atlas relationship instance." } - }, - "title": "SearchHighlights" + } }, - "TermSearchResultValue": { + "AtlasStruct": { "type": "object", + "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification.", "properties": { - "name": { - "type": "string", - "description": "The name of the term." + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} }, - "glossaryName": { + "typeName": { "type": "string", - "description": "The name of the glossary which contains the term." + "description": "The name of the type." }, - "guid": { + "lastModifiedTS": { "type": "string", - "description": "The GUID of the term." + "description": "ETag for concurrency control." } - }, - "title": "Context", - "description": "The context." + } }, - "ContactSearchResultValue": { + "AtlasStructDef": { "type": "object", + "description": "class that captures details of a struct-type.", "properties": { - "id": { - "type": "string", - "description": "The GUID of the contact." + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." }, - "info": { + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { "type": "string", - "description": "The description of the contact." + "description": "The user who created the record." }, - "contactType": { + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { "type": "string", - "description": "The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term." - } - }, - "title": "contact", - "description": "The contact in the search and suggest result." - }, - "AutoCompleteRequest": { - "type": "object", - "properties": { - "keywords": { + "description": "The description of the type definition." + }, + "guid": { "type": "string", - "description": "The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters." + "description": "The GUID of the type definition." }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The number of autocomplete results we hope to return. The default value is 50. The value must be a number between 1 and 100." + "name": { + "type": "string", + "description": "The name of the type definition." }, - "filter": { + "options": { "type": "object", - "description": "The filter for the autocomplete request." - } - }, - "title": "AutoCompleteRequest", - "description": "The query of autocomplete request." - }, - "AutoCompleteResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AutoCompleteResultValue" + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" } - } - }, - "title": "AutoCompleteResult", - "description": "The result of the autocomplete request." - }, - "AutoCompleteResultValue": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "The completed term or phrase." }, - "queryPlusText": { + "serviceType": { "type": "string", - "description": "The completed search query text." - } - }, - "title": "AutoCompleteResultValue", - "description": "The value item of the autocomplete suggest." - }, - "SearchRequest": { - "type": "object", - "properties": { - "keywords": { + "description": "The service type." + }, + "typeVersion": { "type": "string", - "description": "The keywords applied to all searchable fields." + "description": "The version of the type." }, - "limit": { + "updateTime": { "type": "integer", - "format": "int32", - "description": "The limit of the number of the search result. default value is 50; maximum value is 1000." + "format": "int64", + "description": "The update time of the record." }, - "continuationToken": { + "updatedBy": { "type": "string", - "description": "The token used to get next batch of data. Default 'Null' to get the first batch, and will return new token in each response unless there's no more data." + "description": "The user who updated the record." }, - "orderby": { - "type": "array", - "description": "The sort order of search results, can specify multiple fields.", - "items": { - "$ref": "#/definitions/SearchOrderItem" - } + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." }, - "filter": { - "type": "object", - "description": "The filter for the search. See examples for the usage of supported filters." + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." }, - "facets": { + "attributeDefs": { "type": "array", + "description": "An array of attribute definitions.", "items": { - "$ref": "#/definitions/SearchFacetItem" - } - }, - "taxonomySetting": { - "type": "object", - "properties": { - "assetTypes": { - "type": "array", - "items": { - "type": "string" - } - }, - "facet": { - "$ref": "#/definitions/SearchFacetItem" - } - } + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] } - }, - "title": "SearchRequest", - "description": "The search query of advanced search request." + } }, - "SuggestRequest": { + "AtlasTermAssignmentHeader": { "type": "object", + "description": "The header for term assignment.", "properties": { - "keywords": { - "type": "string", - "description": "The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode." - }, - "limit": { + "confidence": { "type": "integer", "format": "int32", - "description": "The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100." + "description": "The confidence of the term assignment." }, - "filter": { - "type": "object", - "description": "The filter for the search." + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "description": { + "type": "string", + "description": "The description of the term assignment." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "expression": { + "type": "string", + "description": "The expression of the term assignment." + }, + "relationGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermAssignmentStatus", + "description": "The status of terms assignment." + }, + "steward": { + "type": "string", + "description": "The steward of the term." + }, + "termGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the term." } - }, - "title": "SuggestRequest", - "description": "The query of suggest request." + } }, - "LastModifiedTS": { + "AtlasTermAssignmentStatus": { "type": "string", - "title": "lastModifiedTS", - "description": "ETag for concurrency control." + "description": "Status for term assignment", + "enum": [ + "DISCOVERED", + "PROPOSED", + "IMPORTED", + "VALIDATED", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermAssignmentStatus", + "modelAsString": true, + "values": [ + { + "name": "Discovered", + "value": "DISCOVERED", + "description": "The status is discovered." + }, + { + "name": "Proposed", + "value": "PROPOSED", + "description": "The status is proposed." + }, + { + "name": "Imported", + "value": "IMPORTED", + "description": "The status is imported." + }, + { + "name": "Validated", + "value": "VALIDATED", + "description": "The status is validated." + }, + { + "name": "Deprecated", + "value": "DEPRECATED", + "description": "The status is deprecated." + }, + { + "name": "Obsolete", + "value": "OBSOLETE", + "description": "The status is obsolete." + }, + { + "name": "Other", + "value": "OTHER", + "description": "Other status." + } + ] + } }, - "ErrorResponse": { - "description": "An error response from the service", + "AtlasTermCategorizationHeader": { "type": "object", + "description": "The basic information for term categorization.", "properties": { - "requestId": { - "type": "string", - "description": "The request ID." + "categoryGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the category." }, - "errorCode": { + "description": { "type": "string", - "description": "The error code." + "description": "The description of the record." }, - "errorMessage": { + "displayText": { "type": "string", - "description": "The error message." + "description": "The display text." + }, + "relationGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermRelationshipStatus", + "description": "The status of term relationship." } } }, - "RelatedCategoryHeaders": { - "type": "object", - "description": "An array of related categories.", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - } + "AtlasTermRelationshipStatus": { + "type": "string", + "description": "Status for atlas term relationship", + "enum": [ + "DRAFT", + "ACTIVE", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermRelationshipStatus", + "modelAsString": true, + "values": [ + { + "name": "Draft", + "value": "DRAFT", + "description": "draft" + }, + { + "name": "Active", + "value": "ACTIVE", + "description": "active" + }, + { + "name": "Deprecated", + "value": "DEPRECATED", + "description": "deprecated" + }, + { + "name": "Obsolete", + "value": "OBSOLETE", + "description": "obsolete" + }, + { + "name": "Other", + "value": "OTHER", + "description": "other" + } + ] } }, - "RelatedTermHeaders": { + "AtlasTypeDef": { "type": "object", - "description": "An array of related glossary terms for the given glossary or an empty list.", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "description": "The definitions of type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\n\nASSOCIATION is a relationship with no containment. \nCOMPOSITION and AGGREGATION are containment relationships.\n\nThe difference being in the lifecycles of the container and its children. \nIn the COMPOSITION case, the children cannot exist without the container. \nFor AGGREGATION, the life cycles of the container and children are totally independent." + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] } } }, - "BusinessMetadata": { + "AtlasTypeDefHeader": { "type": "object", - "additionalProperties": { - "type": "object" - }, - "description": "BusinessMetadata" + "description": "The basic information of the type definition.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + } + } }, - "BusinessMetadataAttributes": { + "AtlasTypesDef": { "type": "object", - "additionalProperties": { - "type": "object" - }, - "description": "BusinessMetadataAttributes" - } - }, - "parameters": { - "endpoint": { - "name": "endpoint", - "description": "The datamap endpoint of your Purview account. Example: https://{accountName}.purview.azure.com", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "format": "url", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "guid": { - "name": "guid", - "description": "The globally unique identifier of the entity.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "classificationName": { - "name": "classificationName", - "description": "The name of the classification.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "typeName": { - "name": "typeName", - "description": "The name of the type.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "categoryGuid": { - "name": "categoryGuid", - "description": "The globally unique identifier of the category.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "limit": { - "name": "limit", - "description": "The page size - by default there is no paging.", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" + "description": "The definitions of types.", + "properties": { + "businessMetadataDefs": { + "type": "array", + "description": "businessMetadataDefs", + "items": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + }, + "x-ms-identifiers": [] + }, + "classificationDefs": { + "type": "array", + "description": "An array of classification definitions.", + "items": { + "$ref": "#/definitions/AtlasClassificationDef" + }, + "x-ms-identifiers": [] + }, + "entityDefs": { + "type": "array", + "description": "An array of entity definitions.", + "items": { + "$ref": "#/definitions/AtlasEntityDef" + }, + "x-ms-identifiers": [] + }, + "enumDefs": { + "type": "array", + "description": "An array of enum definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumDef" + }, + "x-ms-identifiers": [] + }, + "relationshipDefs": { + "type": "array", + "description": "An array of relationship definitions.", + "items": { + "$ref": "#/definitions/AtlasRelationshipDef" + }, + "x-ms-identifiers": [] + }, + "structDefs": { + "type": "array", + "description": "An array of struct definitions.", + "items": { + "$ref": "#/definitions/AtlasStructDef" + }, + "x-ms-identifiers": [] + }, + "termTemplateDefs": { + "type": "array", + "description": "An array of term template definitions.", + "items": { + "$ref": "#/definitions/TermTemplateDef" + }, + "x-ms-identifiers": [] + } + } }, - "offset": { - "name": "offset", - "description": "The offset for pagination purpose.", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" + "AutoCompleteOptions": { + "type": "object", + "description": "The payload of autocomplete request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support autocomplete operation. It must\nbe at least 1 character, and no more than 100 characters." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of autocomplete results we hope to return. The default value is 50.\nThe value must be a number between 1 and 100." + }, + "filter": { + "description": "The filter for the autocomplete request." + } + } }, - "sort": { - "name": "sort", - "description": "The sort order, ASC (default) or DESC.", - "in": "query", - "required": false, - "type": "string", - "default": "ASC", - "x-ms-parameter-location": "method" + "AutoCompleteResult": { + "type": "object", + "description": "The result of the autocomplete request.", + "properties": { + "value": { + "type": "array", + "description": "The result value", + "items": { + "$ref": "#/definitions/AutoCompleteResultValue" + }, + "x-ms-identifiers": [] + } + } }, - "termGuid": { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "AutoCompleteResultValue": { + "type": "object", + "description": "The value item of the autocomplete suggest.", + "properties": { + "text": { + "type": "string", + "description": "The completed term or phrase." + }, + "queryPlusText": { + "type": "string", + "description": "The completed search query text." + } + } }, - "fileId": { - "name": "fileId", - "in": "path", - "description": "The globally unique identifier for file.", - "required": true, + "Azure.Core.uuid": { "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "format": "uuid", + "description": "Universally Unique Identifier" }, - "glossaryGuid": { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "BulkImportResult": { + "type": "object", + "description": "Bulk import result", + "properties": { + "failedImportInfoList": { + "type": "array", + "description": "failed importInfoList", + "items": { + "$ref": "#/definitions/ImportInfo" + }, + "x-ms-identifiers": [] + }, + "successImportInfoList": { + "type": "array", + "description": "successful importInfoList", + "items": { + "$ref": "#/definitions/ImportInfo" + }, + "x-ms-identifiers": [] + } + } }, - "operationGuid": { - "name": "operationGuid", - "in": "path", - "description": "The globally unique identifier for async operation job.", - "required": true, + "CardinalityValue": { "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "description": "Cardinality", + "enum": [ + "SINGLE", + "LIST", + "SET" + ], + "x-ms-enum": { + "name": "CardinalityValue", + "modelAsString": true, + "values": [ + { + "name": "Single", + "value": "SINGLE", + "description": "single" + }, + { + "name": "List", + "value": "LIST", + "description": "list" + }, + { + "name": "Set", + "value": "SET", + "description": "set" + } + ] + } }, - "glossaryName": { - "name": "glossaryName", - "in": "path", - "description": "The name of the glossary.", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "ClassificationAssociateOptions": { + "type": "object", + "description": "The request payload for classification association.", + "properties": { + "classification": { + "$ref": "#/definitions/AtlasClassification", + "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity." + }, + "entityGuids": { + "type": "array", + "description": "The GUID of the entity.", + "items": { + "type": "string" + } + } + } }, - "searchLimit": { - "name": "limit", - "description": "Limits the result set to only include the specified number of entries.", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" + "ContactInfo": { + "type": "object", + "description": "ContactInfo", + "properties": { + "id": { + "type": "string", + "description": "Azure Active Directory object Id." + }, + "info": { + "type": "string", + "description": "additional information to describe this contact." + } + } }, - "searchKeyword": { - "name": "keyword", - "description": "The keyword to get auto complete.", - "in": "query", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" + "ContactSearchResultValue": { + "type": "object", + "description": "The contact in the search and suggest result.", + "properties": { + "id": { + "type": "string", + "description": "The GUID of the contact." + }, + "info": { + "type": "string", + "description": "The description of the contact." + }, + "contactType": { + "type": "string", + "description": "The type of the contact. It can be Expert or Owner for an entity. It can be\nExpert or Steward for a glossary term." + } + } }, - "depth": { - "name": "depth", - "description": "The number of hops for lineage.", - "in": "query", - "required": false, - "type": "integer", - "default": 3, - "format": "int32", - "x-ms-parameter-location": "method" - }, - "direction": { - "name": "direction", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "in": "query", - "required": true, + "DateFormat": { + "type": "object", + "description": "The date format.", + "properties": { + "availableLocales": { + "type": "array", + "description": "An array of available locales.", + "items": { + "type": "string" + } + }, + "calendar": { + "type": "number", + "format": "float", + "description": "Calendar" + }, + "dateInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "dateTimeInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "instance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "lenient": { + "type": "boolean", + "description": "Determines the leniency of the date format." + }, + "numberFormat": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "timeInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "timeZone": { + "$ref": "#/definitions/TimeZone", + "description": "The timezone information." + } + } + }, + "EntityMutationResult": { + "type": "object", + "description": "The mutation response result of entity.", + "properties": { + "guidAssignments": { + "type": "object", + "description": "A map of GUID assignments with entities.", + "additionalProperties": { + "type": "string" + } + }, + "mutatedEntities": { + "type": "object", + "description": "The entity headers of mutated entities.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasEntityHeader" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "partialUpdatedEntities": { + "type": "array", + "description": "An array of entity headers that partially updated.", + "items": { + "$ref": "#/definitions/AtlasEntityHeader" + }, + "x-ms-identifiers": [] + } + } + }, + "EntityStatus": { "type": "string", + "description": "Status - can be active or deleted", "enum": [ - "BOTH", - "INPUT", - "OUTPUT" + "ACTIVE", + "DELETED" ], "x-ms-enum": { - "name": "direction", - "modelAsString": true - }, - "x-ms-parameter-location": "method" + "name": "EntityStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "ACTIVE", + "description": "The status is active." + }, + { + "name": "Deleted", + "value": "DELETED", + "description": "The status is deleted." + } + ] + } }, - "extendedInfo": { - "name": "extendedInfo", - "description": "Limits whether includes extended information.", - "in": "query", - "required": false, - "type": "boolean", - "x-ms-parameter-location": "method" + "ImportInfo": { + "type": "object", + "description": "ImportInfo", + "properties": { + "childObjectName": { + "type": "string", + "description": "childObjectName" + }, + "importStatus": { + "$ref": "#/definitions/ImportStatus", + "description": "importStatus" + }, + "parentObjectName": { + "type": "string", + "description": "parentObjectName" + }, + "remarks": { + "type": "string", + "description": "remarks" + } + } }, - "relationshipGuid": { - "name": "guid", - "description": "The globally unique identifier of the relationship.", - "in": "path", - "required": true, + "ImportStatus": { "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "description": "Status for import", + "enum": [ + "SUCCESS", + "FAILED" + ], + "x-ms-enum": { + "name": "ImportStatus", + "modelAsString": true, + "values": [ + { + "name": "Success", + "value": "SUCCESS", + "description": "Success" + }, + { + "name": "Failed", + "value": "FAILED", + "description": "Failed" + } + ] + } }, - "classificationDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the classification.", - "in": "path", - "required": true, + "LineageDirection": { "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "description": "Lineage direction", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] + } }, - "classificationDefName": { - "name": "name", - "description": "The name of the classification.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "LineageRelation": { + "type": "object", + "description": "The lineage relation with GUID of the from and to entity.", + "properties": { + "fromEntityId": { + "type": "string", + "description": "The GUID of from-entity." + }, + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "toEntityId": { + "type": "string", + "description": "The GUID of to-entity." + } + } }, - "entityDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the entity.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "MoveEntitiesOptions": { + "type": "object", + "description": "MoveEntitiesOptions", + "properties": { + "entityGuids": { + "type": "array", + "description": "An array of entity guids to be moved to target collection.", + "items": { + "type": "string" + } + } + } }, - "entityDefName": { - "name": "name", - "description": "The name of the entity.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "NumberFormat": { + "type": "object", + "description": "The number format.", + "properties": { + "availableLocales": { + "type": "array", + "description": "The number format.", + "items": { + "type": "string" + } + }, + "currency": { + "type": "string", + "description": "The currency." + }, + "currencyInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "groupingUsed": { + "type": "boolean", + "description": "Determines if grouping is used." + }, + "instance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "integerInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "maximumFractionDigits": { + "type": "integer", + "format": "int32", + "description": "The maximum of fraction digits." + }, + "maximumIntegerDigits": { + "type": "integer", + "format": "int32", + "description": "The maximum of integer digits." + }, + "minimumFractionDigits": { + "type": "integer", + "format": "int32", + "description": "The minimum of fraction digits." + }, + "minimumIntegerDigits": { + "type": "integer", + "format": "int32", + "description": "The minimum of integer digits." + }, + "numberInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "parseIntegerOnly": { + "type": "boolean", + "description": "Determines if only integer is parsed." + }, + "percentInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "roundingMode": { + "$ref": "#/definitions/RoundingMode", + "description": "The enum of rounding mode." + } + } }, - "termTemplateDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the term template.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "ParentRelation": { + "type": "object", + "description": "The lineage parents relation with GUID of the parent entity and to child entity.", + "properties": { + "childEntityId": { + "type": "string", + "description": "The GUID of child entity." + }, + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "parentEntityId": { + "type": "string", + "description": "The GUID of parent entity." + } + } }, - "termTemplateDefName": { - "name": "name", - "description": "The name of the term template.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "PurviewObjectId": { + "type": "object", + "description": "PurviewObjectId", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + }, + "name": { + "type": "string", + "description": "Name" + }, + "displayText": { + "type": "string", + "description": "Display text" + }, + "itemPath": { + "type": "string", + "description": "Item path" + }, + "resourceId": { + "type": "string", + "description": "Resource Id" + }, + "properties": { + "type": "object", + "description": "Dictionary of ", + "additionalProperties": {} + } + } }, - "enumDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the enum.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "QueryOptions": { + "type": "object", + "description": "The search query of advanced search request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all searchable fields." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit of the number of the search result. default value is 50; maximum\nvalue is 1000." + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, and will return new token in each response unless there's no more data." + }, + "orderby": { + "type": "array", + "description": "The sort order of search results, can specify multiple fields.", + "items": {} + }, + "filter": { + "description": "The filter for the search. See examples for the usage of supported filters." + }, + "facets": { + "type": "array", + "description": "The facets for search. See examples for the usage of supported facets.", + "items": { + "$ref": "#/definitions/SearchFacetItem" + }, + "x-ms-identifiers": [] + }, + "taxonomySetting": { + "$ref": "#/definitions/SearchTaxonomySetting", + "description": "The taxonomy setting for search." + } + } }, - "enumDefName": { - "name": "name", - "description": "The name of the enum.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "QueryResult": { + "type": "object", + "description": "The result of the search result.", + "properties": { + "@search.count": { + "type": "integer", + "format": "int32", + "description": "The total number of search results (not the number of documents in a single\npage).", + "x-ms-client-name": "searchCount" + }, + "@search.count.approximate": { + "type": "boolean", + "description": "'True' if the '@search.count' is an approximate value and vise versa.", + "x-ms-client-name": "searchCountApproximate" + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Absent if there's no more data." + }, + "@search.facets": { + "$ref": "#/definitions/SearchFacetResultValue", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "x-ms-client-name": "searchFacets" + }, + "value": { + "type": "array", + "description": "Search result value", + "items": { + "$ref": "#/definitions/SearchResultValue" + } + } + } }, - "relationshipDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the relationship.", - "in": "path", - "required": true, + "RelationshipCategory": { "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "relationshipDefName": { - "name": "name", - "description": "The name of the relationship.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "description": "Relationship Category", + "enum": [ + "ASSOCIATION", + "AGGREGATION", + "COMPOSITION" + ], + "x-ms-enum": { + "name": "RelationshipCategory", + "modelAsString": true, + "values": [ + { + "name": "Association", + "value": "ASSOCIATION", + "description": "association" + }, + { + "name": "Aggregation", + "value": "AGGREGATION", + "description": "aggregation" + }, + { + "name": "Composition", + "value": "COMPOSITION", + "description": "composition" + } + ] + } }, - "structDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the struct.", - "in": "path", - "required": true, + "ResourceLink": { + "type": "object", + "description": "ResourceLink", + "properties": { + "displayName": { + "type": "string", + "description": "Display name for url." + }, + "url": { + "type": "string", + "description": "web url. http or https" + } + } + }, + "RoundingMode": { "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "description": "Rounding Mode", + "enum": [ + "UP", + "DOWN", + "CEILING", + "FLOOR", + "HALF_UP", + "HALF_DOWN", + "HALF_EVEN", + "UNNECESSARY" + ], + "x-ms-enum": { + "name": "RoundingMode", + "modelAsString": true, + "values": [ + { + "name": "Up", + "value": "UP", + "description": "up" + }, + { + "name": "Down", + "value": "DOWN", + "description": "down" + }, + { + "name": "Ceiling", + "value": "CEILING", + "description": "ceiling" + }, + { + "name": "Floor", + "value": "FLOOR", + "description": "floor" + }, + { + "name": "HalfUp", + "value": "HALF_UP", + "description": "half up" + }, + { + "name": "HalfDown", + "value": "HALF_DOWN", + "description": "half down" + }, + { + "name": "HalfEven", + "value": "HALF_EVEN", + "description": "half even" + }, + { + "name": "Unnecessary", + "value": "UNNECESSARY", + "description": "unnecessary" + } + ] + } }, - "structDefName": { - "name": "name", - "description": "The name of the struct.", - "in": "path", - "required": true, + "SearchFacetItem": { + "type": "object", + "description": "The content of a search facet result item.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "facet": { + "type": "string", + "description": "The name of the facet item." + }, + "sort": { + "$ref": "#/definitions/SearchFacetSort", + "description": "Define the sorting criteria for items" + } + } + }, + "SearchFacetItemValue": { + "type": "object", + "description": "The content of a search facet result item.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "value": { + "type": "string", + "description": "The name of the facet item." + } + } + }, + "SearchFacetResultValue": { + "type": "object", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "properties": { + "entityType": { + "type": "array", + "description": "Entity type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "assetType": { + "type": "array", + "description": "Asset type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "classification": { + "type": "array", + "description": "Classification", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "term": { + "type": "array", + "description": "Term", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "contactId": { + "type": "array", + "description": "Contact id", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "contactType": { + "type": "array", + "description": "Contact type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "label": { + "type": "array", + "description": "Label", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "glossaryType": { + "type": "array", + "description": "Glossary type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "termStatus": { + "type": "array", + "description": "Term status", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "termTemplate": { + "type": "array", + "description": "Term template", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + } + } + }, + "SearchFacetSort": { + "type": "object", + "description": "The sorting criteria", + "properties": { + "count": { + "$ref": "#/definitions/SearchSortOrder", + "description": "Order by count" + }, + "value": { + "$ref": "#/definitions/SearchSortOrder", + "description": "Order by value" + } + } + }, + "SearchHighlights": { + "type": "object", + "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", + "properties": { + "id": { + "type": "array", + "description": "Id", + "items": { + "type": "string" + } + }, + "qualifiedName": { + "type": "array", + "description": "Qualified name", + "items": { + "type": "string" + } + }, + "name": { + "type": "array", + "description": "Name", + "items": { + "type": "string" + } + }, + "description": { + "type": "array", + "description": "Description", + "items": { + "type": "string" + } + }, + "entityType": { + "type": "array", + "description": "Entity type", + "items": { + "type": "string" + } + } + } + }, + "SearchResultValue": { + "type": "object", + "description": "The value item of the search result.", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", + "x-ms-client-name": "searchScore" + }, + "@search.highlights": { + "$ref": "#/definitions/SearchHighlights", + "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", + "x-ms-client-name": "searchHighlights" + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to\ndistinguish whether a record is an asset or a term." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The create time of the record. The Unix epoch format." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The last update time of the record. The Unix epoch format." + }, + "id": { + "type": "string", + "description": "The GUID of the record." + }, + "name": { + "type": "string", + "description": "The name of the record." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the record." + }, + "entityType": { + "type": "string", + "description": "The type name of the asset." + }, + "description": { + "type": "string", + "description": "The description of the asset." + }, + "endorsement": { + "type": "string", + "description": "The endorsement of the asset." + }, + "owner": { + "type": "string", + "description": "The owner of the record." + }, + "classification": { + "type": "array", + "description": "The classifications of the record.", + "items": { + "type": "string" + } + }, + "label": { + "type": "array", + "description": "The labels of the asset.", + "items": { + "type": "string" + } + }, + "term": { + "type": "array", + "description": "The terms assigned to the asset.", + "items": { + "$ref": "#/definitions/TermSearchResultValue" + }, + "x-ms-identifiers": [] + }, + "contact": { + "type": "array", + "description": "The contacts of the asset.", + "items": { + "$ref": "#/definitions/ContactSearchResultValue" + } + }, + "assetType": { + "type": "array", + "description": "The asset types of the asset.", + "items": { + "type": "string" + } + }, + "glossaryType": { + "type": "string", + "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or\nAtlasGlossaryCategory." + }, + "glossary": { + "type": "string", + "description": "The glossary name of the term." + }, + "termStatus": { + "type": "string", + "description": "The status of the term." + }, + "termTemplate": { + "type": "array", + "description": "The term template names used by the term.", + "items": { + "type": "string" + } + }, + "longDescription": { + "type": "string", + "description": "The definition of the term." + } + } + }, + "SearchSortOrder": { "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "description": "Search sort order", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "SearchSortOrder", + "modelAsString": true, + "values": [ + { + "name": "Ascend", + "value": "asc", + "description": "Use ascending order for sorting" + }, + { + "name": "Descend", + "value": "desc", + "description": "Use descending order for sorting" + } + ] + } }, - "typeDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the type.", - "in": "path", - "required": true, + "SearchTaxonomySetting": { + "type": "object", + "description": "Taxonomy setting for search request", + "properties": { + "assetTypes": { + "type": "array", + "description": "Asset types", + "items": { + "type": "string" + } + }, + "facet": { + "$ref": "#/definitions/SearchFacetItem", + "description": "The content of a search facet result item." + } + } + }, + "SortType": { "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "description": "Type for sorting", + "enum": [ + "NONE", + "ASC", + "DESC" + ], + "x-ms-enum": { + "name": "SortType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "NONE", + "description": "No sorting order" + }, + { + "name": "Ascend", + "value": "ASC", + "description": "Use ascending order for sorting" + }, + { + "name": "Descend", + "value": "DESC", + "description": "Use descending order for sorting" + } + ] + } }, - "typeDefName": { - "name": "name", - "description": "The name of the type.", - "in": "path", - "required": true, + "StatusAtlasRelationship": { "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "description": "Status for atlas relationship", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "StatusAtlasRelationship", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "ACTIVE", + "description": "active" + }, + { + "name": "Deleted", + "value": "DELETED", + "description": "deleted" + } + ] + } + }, + "SuggestOptions": { + "type": "object", + "description": "The payload of suggest request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support suggest operation. It must be\nat least 1 character, and no more than 100 characters. In the index schema we\ndefined a default suggester which lists all the supported fields and specifies\na search mode." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions we hope to return. The default value is 5. The value\nmust be a number between 1 and 100." + }, + "filter": { + "description": "The filter for the search." + } + } + }, + "SuggestResult": { + "type": "object", + "description": "The result item of the search suggest.", + "properties": { + "value": { + "type": "array", + "description": "The result value", + "items": { + "$ref": "#/definitions/SuggestResultValue" + } + } + } + }, + "SuggestResultValue": { + "type": "object", + "description": "The value item of the search suggest.", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", + "x-ms-client-name": "searchScore" + }, + "@search.text": { + "type": "string", + "description": "The target text that contains the keyword as prefix. The keyword is wrapped\nwith emphasis mark.", + "x-ms-client-name": "searchText" + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to\ndistinguish whether a record is an asset or a term." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The create time of the record. The Unix epoch format." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The last update time of the record. The Unix epoch format." + }, + "id": { + "type": "string", + "description": "The GUID of the record." + }, + "name": { + "type": "string", + "description": "The name of the record." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the record." + }, + "entityType": { + "type": "string", + "description": "The type name of the asset." + }, + "description": { + "type": "string", + "description": "The description of the asset." + }, + "endorsement": { + "type": "string", + "description": "The endorsement of the asset." + }, + "owner": { + "type": "string", + "description": "The owner of the record." + }, + "classification": { + "type": "array", + "description": "The classifications of the record.", + "items": { + "type": "string" + } + }, + "label": { + "type": "array", + "description": "The labels of the asset.", + "items": { + "type": "string" + } + }, + "term": { + "type": "array", + "description": "The terms assigned to the asset.", + "items": { + "$ref": "#/definitions/TermSearchResultValue" + }, + "x-ms-identifiers": [] + }, + "contact": { + "type": "array", + "description": "The contacts of the asset.", + "items": { + "$ref": "#/definitions/ContactSearchResultValue" + } + }, + "assetType": { + "type": "array", + "description": "The asset types of the asset.", + "items": { + "type": "string" + } + }, + "glossaryType": { + "type": "string", + "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or\nAtlasGlossaryCategory." + }, + "glossary": { + "type": "string", + "description": "The glossary name of the term." + }, + "termStatus": { + "type": "string", + "description": "The status of the term." + }, + "termTemplate": { + "type": "array", + "description": "The term template names used by the term.", + "items": { + "type": "string" + } + }, + "longDescription": { + "type": "string", + "description": "The definition of the term." + } + } }, - "userId": { - "name": "userId", - "description": "The user ID.", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" + "TermSearchResultValue": { + "type": "object", + "description": "The context.", + "properties": { + "name": { + "type": "string", + "description": "The name of the term." + }, + "glossaryName": { + "type": "string", + "description": "The name of the glossary which contains the term." + }, + "guid": { + "type": "string", + "description": "The GUID of the term." + } + } }, - "principalId": { - "name": "principalId", - "description": "The principal ID.", - "in": "path", - "required": true, + "TermStatus": { "type": "string", - "x-ms-parameter-location": "method" - }, - "minExtInfo": { - "name": "minExtInfo", - "description": "Whether to return minimal information for referred entities.", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - }, - "ignoreRelationships": { - "name": "ignoreRelationships", - "description": "Whether to ignore relationship attributes.", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - }, - "includeTermTemplate": { - "name": "includeTermTemplate", - "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true when search filter type=term_template", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - }, - "includeTermHierarchy": { - "name": "includeTermHierarchy", - "description": "Whether include term hierarchy", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - }, - "extInfo": { - "name": "extInfo", - "description": "Whether include extended information like contact display name and attribute values", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" + "description": "Status for term", + "enum": [ + "Draft", + "Approved", + "Alert", + "Expired" + ], + "x-ms-enum": { + "name": "TermStatus", + "modelAsString": true, + "values": [ + { + "name": "Draft", + "value": "Draft", + "description": "draft" + }, + { + "name": "Approved", + "value": "Approved", + "description": "approved" + }, + { + "name": "Alert", + "value": "Alert", + "description": "alert" + }, + { + "name": "Expired", + "value": "Expired", + "description": "expired" + } + ] + } }, - "ignoreTermsAndCategories": { - "name": "ignoreTermsAndCategories", - "description": "Whether ignore terms and categories", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" + "TermTemplateDef": { + "type": "object", + "description": "Term template definition for glossary term.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } }, - "purviewAPIVersion": { - "name": "api-version", - "description": "The version of the API.", - "in": "query", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" + "TimeBoundary": { + "type": "object", + "description": "Captures time-boundary details", + "properties": { + "endTime": { + "type": "string", + "description": "The end of the time boundary." + }, + "startTime": { + "type": "string", + "description": "The start of the time boundary." + }, + "timeZone": { + "type": "string", + "description": "The timezone of the time boundary." + } + } }, - "atlasAPIVersion": { - "name": "api-version", - "description": "The version of the API.", - "in": "query", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" + "TimeZone": { + "type": "object", + "description": "The timezone information.", + "properties": { + "dstSavings": { + "type": "integer", + "format": "int32", + "description": "The value of the daylight saving time." + }, + "id": { + "type": "string", + "description": "The ID of the timezone." + }, + "availableIds": { + "type": "array", + "description": "An array of available IDs.", + "items": { + "type": "string" + } + }, + "default": { + "$ref": "#/definitions/TimeZone", + "description": "The timezone information." + }, + "displayName": { + "type": "string", + "description": "The display name of the timezone." + }, + "rawOffset": { + "type": "integer", + "format": "int32", + "description": "The raw offset of the timezone." + } + } }, - "type": { - "name": "type", - "description": "Typedef name as search filter when get typedefs.", - "in": "query", - "required": false, + "TypeCategory": { "type": "string", + "description": "Type Category", "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" ], "x-ms-enum": { - "name": "type", - "modelAsString": true - }, - "x-ms-parameter-location": "method" - }, - "requiredCollectionId": { - "name": "collectionId", - "description": "The collection where entities will be moved to.", - "in": "query", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "collectionId": { - "name": "collectionId", - "description": "The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection.", + "name": "TypeCategory", + "modelAsString": true, + "values": [ + { + "name": "Primitive", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "ObjectIdType", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, + { + "name": "Enum", + "value": "ENUM", + "description": "enum" + }, + { + "name": "Struct", + "value": "STRUCT", + "description": "struct" + }, + { + "name": "Classification", + "value": "CLASSIFICATION", + "description": "classification" + }, + { + "name": "Entity", + "value": "ENTITY", + "description": "entity" + }, + { + "name": "Array", + "value": "ARRAY", + "description": "array" + }, + { + "name": "Map", + "value": "MAP", + "description": "map" + }, + { + "name": "Relationship", + "value": "RELATIONSHIP", + "description": "relationship" + }, + { + "name": "TermTemplate", + "value": "TERM_TEMPLATE", + "description": "term template" + } + ] + } + } + }, + "parameters": { + "AtlasApiVersionParameter": { + "name": "api-version", "in": "query", + "description": "The API version to use for this operation.", "required": false, "type": "string", - "x-ms-parameter-location": "method" - }, - "forceDeleteEntityAssignment": { - "name": "forceDeleteEntityAssignment", - "description": "Whether delete entity assignment", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - }, - "forceDeleteChild": { - "name": "forceDeleteChild", - "description": "Whether delete child terms together with the parent term", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" }, - "businessAttributeUpdateBehavior": { - "name": "businessAttributeUpdateBehavior", - "description": "Used to define the update behavior for business attributes when updating entities.", + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", "in": "query", - "required": false, + "description": "The API version to use for this operation.", + "required": true, "type": "string", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "businessAttributeUpdateBehavior", - "modelAsString": true - }, - "x-ms-parameter-location": "method" + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" } } } diff --git a/specification/purview/data-plane/readme.md b/specification/purview/data-plane/readme.md index be24c40594c6..2f951e1b0917 100644 --- a/specification/purview/data-plane/readme.md +++ b/specification/purview/data-plane/readme.md @@ -46,6 +46,7 @@ These settings apply only when `--tag=package-2023-09` is specified on the comma input-file: - Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json ``` + ### Tag: package-preview-2023-02 These settings apply only when `--tag=package-preview-2023-02` is specified on the command line. @@ -295,6 +296,19 @@ See configuration in [readme.python.md](./readme.python.md) ## Suppression +``` yaml +directive: + - suppress: AvoidAnonymousParameter + from: purviewdatamap.json + reason: This rule is irrelevant for data-plane TypeSpec specs. + - suppress: AvoidAnonymousTypes + from: purviewdatamap.json + reason: This rule is irrelevant for data-plane TypeSpec specs. + - suppress: IntegerTypeMustHaveFormat + from: purviewdatamap.json + reason: This rule is irrelevant for SDKs generated directly by TypeSpec. +``` + ``` yaml directive: - suppress: R3013 diff --git a/specification/purviewpolicy/PurviewPolicy.Management/backcompat.tsp b/specification/purviewpolicy/PurviewPolicy.Management/backcompat.tsp new file mode 100644 index 000000000000..84328570e6a6 --- /dev/null +++ b/specification/purviewpolicy/PurviewPolicy.Management/backcompat.tsp @@ -0,0 +1,15 @@ +import "@typespec/http"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using Azure.ResourceManager; + +@@path(ResourceUriParameter.resourceUri, "scope"); +@@Azure.ResourceManager.Private.armCommonParameter(ResourceUriParameter.resourceUri, + "ScopeParameter", + Azure.ResourceManager.CommonTypes.Versions.v5 +); + +@@doc(Azure.ResourceManager.ResourceUriParameter.resourceUri, + "The scope of the operation or resource. Valid scopes are: subscription (format: '/subscriptions/{subscriptionId}'), or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'" +); diff --git a/specification/purviewpolicy/PurviewPolicy.Management/examples/2023-06-01-preview/Operations_List_MaximumSet_Gen.json b/specification/purviewpolicy/PurviewPolicy.Management/examples/2023-06-01-preview/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..5469c7788834 --- /dev/null +++ b/specification/purviewpolicy/PurviewPolicy.Management/examples/2023-06-01-preview/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Purview/operations/read", + "display": { + "provider": "Microsoft Purview", + "resource": "Operations", + "operation": "Read all operations", + "description": "ybbxwadhxjnogglp" + }, + "isDataAction": true, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Purview/operations?api-version=2023-06-01-preview&$skiptoken=asdreg" + } + } + } +} diff --git a/specification/purviewpolicy/PurviewPolicy.Management/examples/2023-06-01-preview/Operations_List_MinimumSet_Gen.json b/specification/purviewpolicy/PurviewPolicy.Management/examples/2023-06-01-preview/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..2b717038a07d --- /dev/null +++ b/specification/purviewpolicy/PurviewPolicy.Management/examples/2023-06-01-preview/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List - generated by [MinimumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/PolicyList.json b/specification/purviewpolicy/PurviewPolicy.Management/examples/2023-06-01-preview/PurviewPolicies_List_MaximumSet_Gen.json similarity index 61% rename from specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/PolicyList.json rename to specification/purviewpolicy/PurviewPolicy.Management/examples/2023-06-01-preview/PurviewPolicies_List_MaximumSet_Gen.json index 68be463235a6..95109a8a7eca 100644 --- a/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/PolicyList.json +++ b/specification/purviewpolicy/PurviewPolicy.Management/examples/2023-06-01-preview/PurviewPolicies_List_MaximumSet_Gen.json @@ -1,28 +1,24 @@ { + "title": "API to list the purview RBAC policies based on a scope - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "PurviewPolicies_List", "parameters": { - "scope": "subscriptions/24d273df-8743-42fe-b46b-a84c558e3045/resourceGroups/policystore-df-rg-wus/providers/Microsoft.Storage/storageAccounts/teststorageacc", - "skipToken": null, - "api-version": "2023-06-01-preview" + "api-version": "2023-06-01-preview", + "scope": "subscriptions/aaaaaaaa/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sacc", + "skipToken": "zwpwpcjydxkwllf", + "$filter": "peu" }, "responses": { "200": { - "headers": { - "Date": "Wed, 09 May 2023 18:04:32 GMT", - "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-tenant-reads": "14999", - "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" - }, "body": { "value": [ { "name": "f455d3a9-cc50-4094-b6f3-5cdac75a1460", - "id": "/subscriptions/24d273df-8743-42fe-b46b-a84c558e3045/resourceGroups/policystore-df-rg-wus/providers/Microsoft.Storage/storageAccounts/teststorageacc/providers/Microsoft.Purview/policies/f455d3a9-cc50-4094-b6f3-5cdac75a1460", + "id": "/subscriptions/24d273df-8743-42fe-b46b-a84c558e3045/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sacc/providers/Microsoft.Purview/policies/f455d3a9-cc50-4094-b6f3-5cdac75a1460", "kind": "Policy", "source": "Purview.SelfService", "etag": "1", "scopes": [ - "subscriptions/24d273df-8743-42fe-b46b-a84c558e3045/resourceGroups/policystore-df-rg-wus/**" + "subscriptions/24d273df-8743-42fe-b46b-a84c558e3045/resourceGroups/rg1/**" ], "decisionRules": [ { @@ -54,16 +50,19 @@ ] }, "expiryTime": "2023-04-28T00:00:00Z", - "requestor": null, + "requestor": "uusrtcysttmpokyeebaqv", "systemData": { "createdBy": "5b3a30f8-dee3-4a5e-bf48-feddbdf174b1", "createdAt": "2023-05-02T04:58:18.8659554Z", "lastModifiedBy": "5b3a30f8-dee3-4a5e-bf48-feddbdf174b1", - "lastModifiedAt": "2023-05-02T04:58:52.6114238Z" - } + "lastModifiedAt": "2023-05-02T04:58:52.6114238Z", + "createdByType": "User", + "lastModifiedByType": "User" + }, + "type": "nhu" } ], - "nextLink": "testPagingKey" + "nextLink": "https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/exampleVM/providers/Microsoft.Purview/policies?api-version=2023-06-01-preview&$skiptoken=asdreg" } } } diff --git a/specification/purviewpolicy/PurviewPolicy.Management/main.tsp b/specification/purviewpolicy/PurviewPolicy.Management/main.tsp new file mode 100644 index 000000000000..bb57aca7cf9f --- /dev/null +++ b/specification/purviewpolicy/PurviewPolicy.Management/main.tsp @@ -0,0 +1,32 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./policy.tsp"; +import "./backcompat.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; + +/** Creates a Microsoft.Purview management client. */ +@armProviderNamespace +@service({ + title: "PurviewPolicyClient", +}) +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.Purview; + +/** The available API versions. */ +enum Versions { + /** 2023-06-01-preview version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2023_06_01_preview: "2023-06-01-preview", +} + +interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/purviewpolicy/PurviewPolicy.Management/policy.tsp b/specification/purviewpolicy/PurviewPolicy.Management/policy.tsp new file mode 100644 index 000000000000..67b504be13fe --- /dev/null +++ b/specification/purviewpolicy/PurviewPolicy.Management/policy.tsp @@ -0,0 +1,146 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Rest; +using Http; +using OpenAPI; +using Azure.ResourceManager; + +namespace Microsoft.Purview; + +@armResourceOperations +interface PurviewPolicies { + /** The API lists the Azure purview RBAC policies affecting the scope. The scope can be any valid ARM resource id */ + @summary("API to list the purview RBAC policies based on a scope") + @tag("PolicyListing") + list is ArmResourceListByParent< + Policy, + { + ...Foundations.BaseParameters; + ...SkipTokenParameter; + + /** Supported filters : $filter=policyType eq SelfService, $filter=policyType eq SqlDevops. Returns only the policies of the specified type. If not specified, all policies are returned. */ + @extension("x-ms-skip-url-encoding", true) + @query("$filter") + filter?: string; + } + >; +} + +/** The skipToken parameter definition. */ +model SkipTokenParameter { + /** Paging key to paginate to next page. */ + @extension("x-ms-parameter-location", "method") + @query + skipToken?: string; +} + +/** The objectType of the member. */ +union ObjectType { + string, + + /** AAD User object type. */ + "User", + + /** AAD Group object type. */ + "Group", + + /** Service Principal object type. */ + "ServicePrincipal", +} + +/** The effect for rule */ +union Decision { + string, + + /** Access permitted */ + "Permit", + + /** Access denied */ + "Deny", +} + +/** A paginated list of purview RBAC policies */ +model PolicyList is Azure.Core.Page; + +/** Purview RBAC policy */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Special ARM resource with no property bag" +@extensionResource +@segment("policies") +model Policy extends Azure.ResourceManager.Foundations.ProxyResourceBase { + /** The policy kind */ + kind?: string; + + /** The policy source */ + source: string; + + /** The etag version of a policy */ + etag: string; + + /** Array of scopes where the policy is published */ + scopes: string[]; + + /** Members of the policy */ + members: PolicyMembers; + + /** Array of decision rules for the policy */ + decisionRules: PolicyDecisionRule[]; + + /** The timestamp of the expiry time of the policy (UTC). */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expiryTime?: utcDateTime; + + /** The AAD member who requested the policy */ + requestor?: string; +} + +/** Policy member */ +model PolicyMembers { + /** Array of azure active directory members */ + fabricItemMembers?: FabricItemMember[]; + + /** Array of azure active directory members */ + aadMembers?: AadMember[]; +} + +/** Microsoft fabric item member */ +model FabricItemMember { + /** Source path of the member */ + sourcePath?: string; + + /** Array of access items for the member */ + itemAccess?: string[]; +} + +/** Azure active directory member */ +model AadMember { + /** The tenantId of the member */ + tenantId?: string; + + /** The objectId of the member */ + objectId?: string; + + /** The objectType of the member. */ + objectType?: ObjectType; +} + +/** Purview RBAC policy decision rule */ +model PolicyDecisionRule { + /** The effect for rule */ + effect: Decision; + + /** Array of attribute predicates */ + permission?: AttributePredicate[]; +} + +/** Attribute predicate for a policy permission */ +model AttributePredicate { + /** AttributeName of a policy permission */ + attributeName?: string; + + /** values for a policy permission */ + attributeValueIncludedIn?: string[]; +} diff --git a/specification/purviewpolicy/PurviewPolicy.Management/tspconfig.yaml b/specification/purviewpolicy/PurviewPolicy.Management/tspconfig.yaml new file mode 100644 index 000000000000..c6d94924d39b --- /dev/null +++ b/specification/purviewpolicy/PurviewPolicy.Management/tspconfig.yaml @@ -0,0 +1,12 @@ +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/policy.json" + examples-directory: "{project-root}/examples" + omit-unreachable-types: true +linter: + extends: + - "@azure-tools/typespec-azure-resource-manager/all" diff --git a/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/Operations_List.json b/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/Operations_List.json deleted file mode 100644 index 088c7dbc42ad..000000000000 --- a/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/Operations_List.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "api-version": "2023-06-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 07 June 2023 18:04:32 GMT", - "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", - "x-ms-ratelimit-remaining-tenant-reads": "14999", - "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" - }, - "body": { - "value": [ - { - "name": "Microsoft.Purview/operations/read", - "display": { - "provider": "Microsoft Purview", - "resource": "Operations", - "operation": "Read all operations", - "description": "Reads all available operations in Purview Resource Provider." - } - } - ] - } - } - } -} diff --git a/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..5469c7788834 --- /dev/null +++ b/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Purview/operations/read", + "display": { + "provider": "Microsoft Purview", + "resource": "Operations", + "operation": "Read all operations", + "description": "ybbxwadhxjnogglp" + }, + "isDataAction": true, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Purview/operations?api-version=2023-06-01-preview&$skiptoken=asdreg" + } + } + } +} diff --git a/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/Operations_List_MinimumSet_Gen.json b/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..2b717038a07d --- /dev/null +++ b/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List - generated by [MinimumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/PurviewPolicies_List_MaximumSet_Gen.json b/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/PurviewPolicies_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..95109a8a7eca --- /dev/null +++ b/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/examples/PurviewPolicies_List_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "API to list the purview RBAC policies based on a scope - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "PurviewPolicies_List", + "parameters": { + "api-version": "2023-06-01-preview", + "scope": "subscriptions/aaaaaaaa/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sacc", + "skipToken": "zwpwpcjydxkwllf", + "$filter": "peu" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "f455d3a9-cc50-4094-b6f3-5cdac75a1460", + "id": "/subscriptions/24d273df-8743-42fe-b46b-a84c558e3045/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sacc/providers/Microsoft.Purview/policies/f455d3a9-cc50-4094-b6f3-5cdac75a1460", + "kind": "Policy", + "source": "Purview.SelfService", + "etag": "1", + "scopes": [ + "subscriptions/24d273df-8743-42fe-b46b-a84c558e3045/resourceGroups/rg1/**" + ], + "decisionRules": [ + { + "effect": "Permit", + "permission": [ + { + "attributeName": "Action", + "attributeValueIncludedIn": [ + "Read" + ] + }, + { + "attributeName": "Path", + "attributeValueIncludedIn": [ + "/subscriptions/ce5233e5-083d-475b-9085-5ebe81e24ada/resourceGroups/perfrg/**" + ] + } + ] + } + ], + "members": { + "fabricItemMembers": [], + "aadMembers": [ + { + "tenantId": "7972a1e5-4861-43cf-9e1c-1d8669148a2e", + "objectId": "f1081d6d-0e2d-4b85-8098-63d43819d9b3", + "objectType": "Group" + } + ] + }, + "expiryTime": "2023-04-28T00:00:00Z", + "requestor": "uusrtcysttmpokyeebaqv", + "systemData": { + "createdBy": "5b3a30f8-dee3-4a5e-bf48-feddbdf174b1", + "createdAt": "2023-05-02T04:58:18.8659554Z", + "lastModifiedBy": "5b3a30f8-dee3-4a5e-bf48-feddbdf174b1", + "lastModifiedAt": "2023-05-02T04:58:52.6114238Z", + "createdByType": "User", + "lastModifiedByType": "User" + }, + "type": "nhu" + } + ], + "nextLink": "https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/exampleVM/providers/Microsoft.Purview/policies?api-version=2023-06-01-preview&$skiptoken=asdreg" + } + } + } +} diff --git a/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/policy.json b/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/policy.json index 26d62df5873a..cf20ff74e01a 100644 --- a/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/policy.json +++ b/specification/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/policy.json @@ -1,128 +1,164 @@ { "swagger": "2.0", "info": { - "version": "2023-06-01-preview", "title": "PurviewPolicyClient", - "description": "Creates a Microsoft.Purview management client." + "version": "2023-06-01-preview", + "description": "Creates a Microsoft.Purview management client.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] }, - "host": "management.azure.com", "schemes": [ "https" ], - "consumes": [ + "host": "management.azure.com", + "produces": [ "application/json" ], - "produces": [ + "consumes": [ "application/json" ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "PurviewPolicies" + }, + { + "name": "PolicyListing" + } + ], "paths": { "/{scope}/providers/Microsoft.Purview/policies": { "get": { + "operationId": "PurviewPolicies_List", "tags": [ + "PurviewPolicies", "PolicyListing" ], "summary": "API to list the purview RBAC policies based on a scope", "description": "The API lists the Azure purview RBAC policies affecting the scope. The scope can be any valid ARM resource id", - "operationId": "PurviewPolicies_List", "parameters": [ { - "$ref": "#/parameters/scopeParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/skipToken" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/SkipTokenParameter" }, { "name": "$filter", "in": "query", "description": "Supported filters : $filter=policyType eq SelfService, $filter=policyType eq SqlDevops. Returns only the policies of the specified type. If not specified, all policies are returned.", + "required": false, "type": "string", + "x-ms-client-name": "filter", "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/PolicyList" + "$ref": "#/definitions/PolicyListResult" } }, "default": { - "description": "An error response received from the provider.", + "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "ListPolicies": { - "$ref": "./examples/PolicyList.json" + "API to list the purview RBAC policies based on a scope - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/PurviewPolicies_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Purview/operations": { "get": { + "operationId": "Operations_List", "tags": [ - "Operation" + "Operations" ], - "summary": "Lists the available operations", - "description": "List of available operations", - "operationId": "Operations_List", + "description": "List the operations for the provider", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" + "Operations_List - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List - generated by [MinimumSet] rule": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } } }, "definitions": { - "PolicyList": { - "required": [ - "value" - ], - "description": "A paginated list of purview RBAC policies", + "AadMember": { "type": "object", + "description": "Azure active directory member", "properties": { - "value": { - "type": "array", - "description": "A list of purview RBAC policies", - "items": { - "$ref": "#/definitions/Policy" - } + "tenantId": { + "type": "string", + "description": "The tenantId of the member" }, - "nextLink": { + "objectId": { "type": "string", - "description": "Pagination link" + "description": "The objectId of the member" + }, + "objectType": { + "$ref": "#/definitions/ObjectType", + "description": "The objectType of the member." } } }, @@ -143,51 +179,80 @@ } } }, - "PolicyDecisionRule": { - "type": "object", - "description": "Purview RBAC policy decision rule", - "required": [ - "effect" + "Decision": { + "type": "string", + "description": "The effect for rule", + "enum": [ + "Permit", + "Deny" ], + "x-ms-enum": { + "name": "Decision", + "modelAsString": true, + "values": [ + { + "name": "Permit", + "value": "Permit", + "description": "Access permitted" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Access denied" + } + ] + } + }, + "FabricItemMember": { + "type": "object", + "description": "Microsoft fabric item member", "properties": { - "effect": { - "description": "The effect for rule", - "enum": [ - "Permit", - "Deny" - ], + "sourcePath": { "type": "string", - "x-ms-enum": { - "name": "Decision", - "modelAsString": true - } + "description": "Source path of the member" }, - "permission": { + "itemAccess": { "type": "array", - "description": "Array of attribute predicates", + "description": "Array of access items for the member", "items": { - "$ref": "#/definitions/AttributePredicate" - }, - "x-ms-identifiers": [] + "type": "string" + } } } }, - "Policy": { - "required": [ - "id", - "source", - "decisionRules", - "members", - "etag", - "scopes" + "ObjectType": { + "type": "string", + "description": "The objectType of the member.", + "enum": [ + "User", + "Group", + "ServicePrincipal" ], + "x-ms-enum": { + "name": "ObjectType", + "modelAsString": true, + "values": [ + { + "name": "User", + "value": "User", + "description": "AAD User object type." + }, + { + "name": "Group", + "value": "Group", + "description": "AAD Group object type." + }, + { + "name": "ServicePrincipal", + "value": "ServicePrincipal", + "description": "Service Principal object type." + } + ] + } + }, + "Policy": { "type": "object", "description": "Purview RBAC policy", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ], "properties": { "kind": { "type": "string", @@ -206,13 +271,11 @@ "description": "Array of scopes where the policy is published", "items": { "type": "string" - }, - "x-ms-identifiers": [] + } }, "members": { - "type": "object", - "description": "Members of the policy", - "$ref": "#/definitions/PolicyMembers" + "$ref": "#/definitions/PolicyMembers", + "description": "Members of the policy" }, "decisionRules": { "type": "array", @@ -223,103 +286,95 @@ "x-ms-identifiers": [] }, "expiryTime": { + "type": "string", "format": "date-time", - "description": "The timestamp of the expiry time of the policy (UTC).", - "type": "string" + "description": "The timestamp of the expiry time of the policy (UTC)." }, "requestor": { "type": "string", "description": "The AAD member who requested the policy" } - } + }, + "required": [ + "source", + "etag", + "scopes", + "members", + "decisionRules" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] }, - "PolicyMembers": { + "PolicyDecisionRule": { "type": "object", - "description": "Policy member", + "description": "Purview RBAC policy decision rule", "properties": { - "fabricItemMembers": { - "type": "array", - "description": "Array of azure active directory members", - "items": { - "$ref": "#/definitions/FabricItemMember" - }, - "x-ms-identifiers": [] + "effect": { + "$ref": "#/definitions/Decision", + "description": "The effect for rule" }, - "aadMembers": { + "permission": { "type": "array", - "description": "Array of azure active directory members", + "description": "Array of attribute predicates", "items": { - "$ref": "#/definitions/AADMember" + "$ref": "#/definitions/AttributePredicate" }, "x-ms-identifiers": [] } - } + }, + "required": [ + "effect" + ] }, - "AADMember": { + "PolicyListResult": { "type": "object", - "description": "Azure active directory member", + "description": "The response of a Policy list operation.", "properties": { - "tenantId": { - "type": "string", - "description": "The tenantId of the member" - }, - "objectId": { - "type": "string", - "description": "The objectId of the member" + "value": { + "type": "array", + "description": "The Policy items on this page", + "items": { + "$ref": "#/definitions/Policy" + } }, - "objectType": { + "nextLink": { "type": "string", - "description": "The objectType of the member.", - "enum": [ - "User", - "Group", - "ServicePrincipal" - ], - "x-ms-enum": { - "name": "objectType", - "modelAsString": true - } + "format": "uri", + "description": "The link to the next page of items" } - } + }, + "required": [ + "value" + ] }, - "FabricItemMember": { + "PolicyMembers": { "type": "object", - "description": "Microsoft fabric item member", + "description": "Policy member", "properties": { - "sourcePath": { - "type": "string", - "description": "Source path of the member" + "fabricItemMembers": { + "type": "array", + "description": "Array of azure active directory members", + "items": { + "$ref": "#/definitions/FabricItemMember" + }, + "x-ms-identifiers": [] }, - "itemAccess": { + "aadMembers": { "type": "array", - "description": "Array of access items for the member", + "description": "Array of azure active directory members", "items": { - "type": "string", - "description": "access item" - } + "$ref": "#/definitions/AadMember" + }, + "x-ms-identifiers": [] } } } }, "parameters": { - "scopeParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the operation or resource. Valid scopes are: subscription (format: '/subscriptions/{subscriptionId}'), or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "method" - }, - "api-version": { - "name": "api-version", - "in": "query", - "description": "The api version to use.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "skipToken": { + "SkipTokenParameter": { "name": "skipToken", "in": "query", "description": "Paging key to paginate to next page.", @@ -327,24 +382,5 @@ "type": "string", "x-ms-parameter-location": "method" } - }, - "securityDefinitions": { - "azure_auth": { - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "tags": [] + } } diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobDelete.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobDelete.json new file mode 100644 index 000000000000..6ed4728dba86 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "jobId": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobGet.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobGet.json new file mode 100644 index 000000000000..03d85ac5ab36 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "jobId": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "itemType": "Job", + "jobType": "Optimization", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "cancellationTime": null, + "containerUri": "fake-uri", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "fake-uri", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "metadata": null, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "fake-uri", + "providerId": "microsoft", + "status": "Succeeded", + "target": "microsoft.tabu.cpu", + "costEstimate": { + "currencyCode": "USD", + "events": [ + { + "dimensionId": "jobhours", + "dimensionName": "Job Hours", + "measureUnit": "Hours", + "amountBilled": 0.5, + "amountConsumed": 0.5, + "unitPrice": 0.01 + } + ], + "estimatedTotal": 0.005 + }, + "tags": [ + "tag1", + "new" + ] + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobList.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobList.json new file mode 100644 index 000000000000..b898f676fc16 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobList.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "itemType": "Job", + "jobType": "Optimization", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "cancellationTime": null, + "containerUri": "fake-uri", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "fake-uri", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "metadata": null, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "fake-uri", + "providerId": "microsoft", + "status": "Succeeded", + "target": "microsoft.tabu.cpu", + "tags": [ + "tag1" + ] + }, + { + "id": "ab1aeddd-f191-4884-b8a9-13cdfa020fc6", + "name": "Superposition: true", + "itemType": "Job", + "jobType": "QuantumComputing", + "sessionId": "60ba7795-6a13-4630-aec0-260b3904378c", + "beginExecutionTime": "2020-09-18T23:25:45.781389Z", + "cancellationTime": null, + "containerUri": "fake-uri", + "creationTime": "2020-09-18T23:25:33.5541484+00:00", + "endExecutionTime": "2020-09-18T23:25:53.911837Z", + "errorData": null, + "inputDataFormat": "microsoft.qci-ir.v1", + "inputDataUri": "fake-uri", + "inputParams": { + "shots": "10" + }, + "metadata": { + "entryPointInput": "true", + "outputMappingBlobUri": "fake-uri" + }, + "outputDataFormat": "microsoft.quantum-results.v1", + "outputDataUri": "fake-uri", + "providerId": "qci", + "quantumComputingData": { + "count": 1 + }, + "status": "Succeeded", + "target": "qci.simulator", + "tags": [ + "tag2" + ] + }, + { + "id": "5e32d41c-c3cd-45e9-b8c7-6b92ec768dfd", + "name": "Superposition: true", + "itemType": "Job", + "jobType": "QuantumComputing", + "sessionId": "60ba7795-6a13-4630-aec0-260b3904378c", + "beginExecutionTime": "2020-09-18T23:25:45.781389Z", + "cancellationTime": null, + "containerUri": "fake-uri", + "creationTime": "2020-09-18T23:25:33.5541484+00:00", + "errorData": null, + "inputDataFormat": "microsoft.qci-ir.v1", + "inputDataUri": "fake-uri", + "inputParams": { + "shots": "10" + }, + "metadata": { + "entryPointInput": "true", + "outputMappingBlobUri": "fake-uri" + }, + "outputDataFormat": "microsoft.quantum-results.v1", + "outputDataUri": "fake-uri", + "providerId": "qci", + "quantumComputingData": { + "count": 4 + }, + "status": "Waiting", + "target": "qci.simulator", + "tags": [ + "tag3" + ] + }, + { + "id": "f5387471-d6a8-4ee5-880e-2dbd0a1e58f0", + "name": "QRNG", + "itemType": "Job", + "jobType": "Unknown", + "sessionId": "a54a5d47-1591-4334-9c7b-7b692d5db26c", + "beginExecutionTime": "2020-09-18T23:25:45.781389Z", + "cancellationTime": null, + "containerUri": "fake-uri", + "creationTime": "2020-09-18T23:25:33.5541484+00:00", + "errorData": null, + "inputDataFormat": "microsoft.qci-ir.v1", + "inputDataUri": "fake-uri", + "inputParams": { + "shots": "10" + }, + "metadata": { + "entryPointInput": "true", + "outputMappingBlobUri": "fake-uri" + }, + "outputDataFormat": "microsoft.quantum-results.v1", + "outputDataUri": "fake-uri", + "providerId": "qci", + "status": "Waiting", + "target": "qci.simulator", + "tags": [ + "tag3" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobPatch.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobPatch.json new file mode 100644 index 000000000000..b43024b06c28 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobPatch.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "jobId": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1", + "patchJob": [ + { + "op": "add", + "path": "/tags/-", + "value": "new_tag" + }, + { + "op": "remove", + "path": "/tags/0" + } + ] + }, + "responses": { + "200": { + "body": { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "itemType": "Job", + "jobType": "Optimization", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "cancellationTime": null, + "containerUri": "fake-uri", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "fake-uri", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "metadata": null, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "fake-uri", + "providerId": "microsoft", + "status": "Succeeded", + "target": "microsoft.tabu.cpu", + "tags": [ + "tag2", + "new_tag" + ] + } + }, + "204": {} + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobPut.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobPut.json new file mode 100644 index 000000000000..739ff70b5971 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/jobPut.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "jobId": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1", + "job": { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "itemType": "Job", + "containerUri": "fake-uri", + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "fake-uri", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "fake-uri", + "providerId": "microsoft", + "target": "microsoft.tabu.cpu", + "tags": [ + "tag1", + "tag_2" + ] + } + }, + "responses": { + "200": { + "body": { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "itemType": "Job", + "jobType": "Unknown", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "cancellationTime": null, + "containerUri": "fake-uri", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "fake-uri", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "metadata": null, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "fake-uri", + "providerId": "microsoft", + "status": "Succeeded", + "target": "microsoft.tabu.cpu", + "tags": [ + "tag1", + "tag_2" + ] + } + }, + "201": { + "body": { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "itemType": "Job", + "jobType": "Unknown", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "cancellationTime": null, + "containerUri": "fake-uri", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "fake-uri", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "metadata": null, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "fake-uri", + "providerId": "microsoft", + "status": "Succeeded", + "target": "microsoft.tabu.cpu", + "tags": [ + "tag1", + "tag_2" + ] + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/providerStatus.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/providerStatus.json new file mode 100644 index 000000000000..9aec30eb7c1f --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/providerStatus.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "Microsoft", + "currentAvailability": "Available", + "targets": [ + { + "id": "microsoft.paralleltempering-parameterfree.cpu", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.paralleltempering.cpu", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.simulatedannealing-parameterfree.cpu", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.simulatedannealing.cpu", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.tabu-parameterfree.cpu", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.tabu.cpu", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.simulatedannealing-parameterfree.fpga", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.simulatedannealing.fpga", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + } + ] + }, + { + "id": "ionq", + "currentAvailability": "Available", + "targets": [ + { + "id": "ionq.qpu", + "currentAvailability": "Available", + "averageQueueTime": 1679, + "statusPage": "https://status.ionq.co" + }, + { + "id": "ionq.simulator", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": "https://status.ionq.co" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/quotaList.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/quotaList.json new file mode 100644 index 000000000000..b8d1aecea6fb --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/quotaList.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dimension": "free_combined_job_hours", + "scope": "Subscription", + "providerId": "Microsoft", + "utilization": 0.001756120333333333, + "holds": 0.016666666666666666, + "limit": 15.0, + "period": "Monthly" + }, + { + "dimension": "free_fpga_job_hours", + "scope": "Workspace", + "providerId": "Microsoft", + "utilization": 0.0, + "holds": 0.0, + "limit": 0.25, + "period": "Monthly" + }, + { + "dimension": "free_combined_job_hours", + "scope": "Workspace", + "providerId": "Microsoft", + "utilization": 0.0017561203333333335, + "holds": 0.0, + "limit": 1.0, + "period": "Monthly" + }, + { + "dimension": "concurrent_cpu_jobs", + "scope": "Workspace", + "providerId": "Microsoft", + "utilization": 0.0, + "holds": 0.0, + "limit": 10.0, + "period": "None" + }, + { + "dimension": "concurrent_fpga_jobs", + "scope": "Workspace", + "providerId": "Microsoft", + "utilization": 0.0, + "holds": 0.0, + "limit": 1.0, + "period": "None" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionClose.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionClose.json new file mode 100644 index 000000000000..b23b220e1874 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionClose.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "sessionId": "a54a5d47-1591-4334-9c7b-7b692d5db26c", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "name": "QAOA Session", + "id": "a54a5d47-1591-4334-9c7b-7b692d5db26c", + "itemType": "Session", + "beginExecutionTime": "2022-06-30T23:58:11.5659691Z", + "creationTime": "2022-06-30T23:58:11.5659691Z", + "endExecutionTime": "2022-07-01T02:12:54.2634721Z", + "errorData": null, + "providerId": "ionq", + "status": "Completed", + "target": "ionq.qpu", + "costEstimate": { + "currencyCode": "USD", + "estimatedTotal": 5.025 + } + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionGet.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionGet.json new file mode 100644 index 000000000000..a7b2e71427b0 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "sessionId": "60ba7795-6a13-4630-aec0-260b3904378c", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "name": "VQE Session", + "id": "60ba7795-6a13-4630-aec0-260b3904378c", + "itemType": "Session", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "providerId": "ionq", + "status": "Succeeded", + "target": "ionq.qpu", + "costEstimate": { + "currencyCode": "USD", + "estimatedTotal": 0.005 + } + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionJobsList.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionJobsList.json new file mode 100644 index 000000000000..d76e46634638 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionJobsList.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "sessionId": "60ba7795-6a13-4630-aec0-260b3904378c", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "ab1aeddd-f191-4884-b8a9-13cdfa020fc6", + "name": "Superposition: true", + "itemType": "Job", + "jobType": "QuantumComputing", + "sessionId": "60ba7795-6a13-4630-aec0-260b3904378c", + "beginExecutionTime": "2020-09-18T23:25:45.781389Z", + "cancellationTime": null, + "containerUri": "fake-uri", + "creationTime": "2020-09-18T23:25:33.5541484+00:00", + "endExecutionTime": "2020-09-18T23:25:53.911837Z", + "errorData": null, + "inputDataFormat": "microsoft.qci-ir.v1", + "inputDataUri": "fake-uri", + "inputParams": { + "shots": "10" + }, + "metadata": { + "entryPointInput": "true", + "outputMappingBlobUri": "fake-uri" + }, + "outputDataFormat": "microsoft.quantum-results.v1", + "outputDataUri": "fake-uri", + "providerId": "qci", + "quantumComputingData": { + "count": 1 + }, + "status": "Succeeded", + "target": "qci.simulator", + "tags": [ + "tag2" + ] + }, + { + "id": "5e32d41c-c3cd-45e9-b8c7-6b92ec768dfd", + "name": "Superposition: true", + "itemType": "Job", + "jobType": "QuantumComputing", + "sessionId": "60ba7795-6a13-4630-aec0-260b3904378c", + "beginExecutionTime": "2020-09-18T23:25:45.781389Z", + "cancellationTime": null, + "containerUri": "fake-uri", + "creationTime": "2020-09-18T23:25:33.5541484+00:00", + "errorData": null, + "inputDataFormat": "microsoft.qci-ir.v1", + "inputDataUri": "fake-uri", + "inputParams": { + "shots": "10" + }, + "metadata": { + "entryPointInput": "true", + "outputMappingBlobUri": "fake-uri" + }, + "outputDataFormat": "microsoft.quantum-results.v1", + "outputDataUri": "fake-uri", + "providerId": "qci", + "quantumComputingData": { + "count": 4 + }, + "status": "Waiting", + "target": "qci.simulator", + "tags": [ + "tag3" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionList.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionList.json new file mode 100644 index 000000000000..83a6152dc521 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "VQE Session", + "id": "60ba7795-6a13-4630-aec0-260b3904378c", + "itemType": "Session", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "providerId": "ionq", + "status": "Succeeded", + "target": "ionq.qpu", + "costEstimate": { + "currencyCode": "USD", + "estimatedTotal": 0.005 + } + }, + { + "name": "QAOA Session", + "id": "a54a5d47-1591-4334-9c7b-7b692d5db26c", + "itemType": "Session", + "beginExecutionTime": "2022-06-30T23:58:11.5659691Z", + "creationTime": "2022-06-30T23:58:11.5659691Z", + "errorData": null, + "providerId": "ionq", + "status": "Executing", + "target": "ionq.qpu", + "costEstimate": { + "currencyCode": "USD", + "estimatedTotal": 5.025 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionPut.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionPut.json new file mode 100644 index 000000000000..6f316190b893 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/sessionPut.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "sessionId": "60ba7795-6a13-4630-aec0-260b3904378c", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1", + "session": { + "name": "VQE Session", + "id": "60ba7795-6a13-4630-aec0-260b3904378c", + "itemType": "Session", + "errorData": null, + "providerId": "ionq", + "target": "ionq.qpu", + "costEstimate": { + "currencyCode": "USD", + "estimatedTotal": 0.005 + } + } + }, + "responses": { + "200": { + "body": { + "name": "VQE Session", + "id": "60ba7795-6a13-4630-aec0-260b3904378c", + "itemType": "Session", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "errorData": null, + "providerId": "ionq", + "status": "Waiting", + "target": "ionq.qpu" + } + }, + "201": { + "body": { + "name": "VQE Session", + "id": "60ba7795-6a13-4630-aec0-260b3904378c", + "itemType": "Session", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "errorData": null, + "providerId": "ionq", + "status": "Waiting", + "target": "ionq.qpu" + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/storageGet.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/storageGet.json new file mode 100644 index 000000000000..1156dd34964e --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/storageGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1", + "blobDetails": { + "containerName": "some_container", + "blobName": "input_blob" + } + }, + "responses": { + "200": { + "body": { + "sasUri": "fake-uri" + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/topLevelItemsList.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/topLevelItemsList.json new file mode 100644 index 000000000000..7e9650c1a5b4 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/examples/topLevelItemsList.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "azureRegion": "eastus", + "api-version": "2023-11-13-preview", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "itemType": "Job", + "jobType": "Optimization", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "cancellationTime": null, + "containerUri": "fake-uri", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "fake-uri", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "metadata": null, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "fake-uri", + "providerId": "microsoft", + "status": "Succeeded", + "target": "microsoft.tabu.cpu", + "tags": [ + "tag1" + ] + }, + { + "name": "VQE Session", + "id": "60ba7795-6a13-4630-aec0-260b3904378c", + "itemType": "Session", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "providerId": "ionq", + "status": "Succeeded", + "target": "ionq.qpu", + "costEstimate": { + "currencyCode": "USD", + "estimatedTotal": 0.005 + } + }, + { + "name": "QAOA Session", + "id": "a54a5d47-1591-4334-9c7b-7b692d5db26c", + "itemType": "Session", + "beginExecutionTime": "2022-06-30T23:58:11.5659691Z", + "creationTime": "2022-06-30T23:58:11.5659691Z", + "errorData": null, + "providerId": "ionq", + "status": "Executing", + "target": "ionq.qpu", + "costEstimate": { + "currencyCode": "USD", + "estimatedTotal": 5.025 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/quantum.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/quantum.json new file mode 100644 index 000000000000..a4e5ccfc3841 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2023-11-13-preview/quantum.json @@ -0,0 +1,1333 @@ +{ + "swagger": "2.0", + "info": { + "title": "Quantum Client", + "description": "Azure Quantum REST API client", + "version": "2023-11-13-preview", + "contact": { + "email": "azqengg@microsoft.com" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{azureRegion}.quantum.azure.com", + "parameters": [ + { + "$ref": "#/parameters/azureRegionParameter" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AzureAuth": { + "type": "oauth2", + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/token", + "flow": "application", + "description": "Azure Active Directory OAuth2 Authentication", + "scopes": { + "https://quantum.microsoft.com/.default": "client credential scope" + } + }, + "AzureKey": { + "type": "apiKey", + "name": "x-ms-quantum-api-key", + "in": "header", + "description": "Azure Quantum API key" + } + }, + "security": [ + { + "AzureAuth": [ + "https://quantum.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs": { + "get": { + "operationId": "Jobs_List", + "description": "List jobs.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/JobDetailsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + }, + "x-ms-examples": { + "Get list of jobs in a Quantum Workspace": { + "$ref": "./examples/jobList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}": { + "get": { + "operationId": "Jobs_Get", + "description": "Get job by id", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/jobIdParameter" + } + ], + "x-ms-examples": { + "Get a job's metadata": { + "$ref": "./examples/jobGet.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + }, + "put": { + "operationId": "Jobs_Create", + "description": "Create a job.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/jobIdParameter" + }, + { + "name": "job", + "description": "The complete metadata of the job to submit.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDetails" + } + } + ], + "x-ms-examples": { + "Submit a new job for execution to a Quantum Workspace": { + "$ref": "./examples/jobPut.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobDetails" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/JobDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + }, + "delete": { + "operationId": "Jobs_Cancel", + "description": "Cancel a job.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/jobIdParameter" + } + ], + "x-ms-examples": { + "Cancel the execution of an existing job": { + "$ref": "./examples/jobDelete.json" + } + }, + "responses": { + "204": { + "description": "NoContent - The job was successfully cancelled." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + }, + "patch": { + "operationId": "Jobs_Patch", + "description": "Patch a job.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/jobIdParameter" + }, + { + "name": "patchJob", + "description": "The json patch document containing the patch operations.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchRequest" + } + } + ], + "x-ms-examples": { + "Patch an existing job to a Quantum Workspace": { + "$ref": "./examples/jobPatch.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobDetails" + } + }, + "204": { + "description": "No Content - the patch body was empty or had no operations." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/providerStatus": { + "get": { + "operationId": "Providers_GetStatus", + "description": "Get provider status.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "x-ms-examples": { + "Get list of of providers and their status for a Quantum Workspace": { + "$ref": "./examples/providerStatus.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProviderStatusList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/storage/sasUri": { + "post": { + "operationId": "Storage_SasUri", + "description": "Gets a URL with SAS token for a container/blob in the storage account associated with the workspace. The SAS URL can be used to upload job input and/or download job output.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "name": "blobDetails", + "description": "The details (name and container) of the blob to store or download data.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlobDetails" + } + } + ], + "x-ms-examples": { + "Get a SAS token to upload data for a Quantum Workspace": { + "$ref": "./examples/storageGet.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/quotas": { + "get": { + "operationId": "Quotas_List", + "description": "List quotas for the given workspace.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "x-ms-examples": { + "Get a list of quotas for a particular quantum workspace.": { + "$ref": "./examples/quotaList.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/QuotaList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions": { + "get": { + "operationId": "Sessions_List", + "description": "List sessions.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionDetailsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + }, + "x-ms-examples": { + "Get list of sessions in a Quantum Workspace": { + "$ref": "./examples/sessionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}": { + "get": { + "operationId": "Sessions_Get", + "description": "Get session by id", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/sessionIdParameter" + } + ], + "x-ms-examples": { + "Get a session's metadata": { + "$ref": "./examples/sessionGet.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SessionDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + }, + "put": { + "operationId": "Sessions_Open", + "description": "Open a session.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/sessionIdParameter" + }, + { + "name": "session", + "description": "The complete metadata of the session to be opened.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SessionDetails" + } + } + ], + "x-ms-examples": { + "Open a new session in the Quantum Workspace": { + "$ref": "./examples/sessionPut.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SessionDetails" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SessionDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}:close": { + "post": { + "operationId": "Sessions_Close", + "description": "Close a session", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/sessionIdParameter" + } + ], + "x-ms-examples": { + "Close a session": { + "$ref": "./examples/sessionClose.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SessionDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}/jobs": { + "get": { + "operationId": "Sessions_JobsList", + "description": "List jobs in a session.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/sessionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/JobDetailsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + }, + "x-ms-examples": { + "Get list of jobs in a session": { + "$ref": "./examples/sessionJobsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/topLevelItems": { + "get": { + "operationId": "TopLevelItems_List", + "description": "List top-level items.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ItemDetailsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + }, + "x-ms-examples": { + "Get list of top-level items": { + "$ref": "./examples/topLevelItemsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ItemDetailsList": { + "description": "List of item details.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ItemDetails" + } + }, + "nextLink": { + "type": "string", + "description": "Link to the next page of results." + } + }, + "required": [ + "value" + ] + }, + "ItemDetails": { + "description": "Item details. An item can be a job or a session.", + "type": "object", + "discriminator": "itemType", + "properties": { + "id": { + "type": "string", + "description": "The id of the item." + }, + "name": { + "type": "string", + "description": "The name of the item. It is not required for the name to be unique and it's only used for display purposes." + }, + "providerId": { + "type": "string", + "description": "The unique identifier for the provider." + }, + "target": { + "type": "string", + "description": "The target identifier to run the job." + }, + "itemType": { + "type": "string", + "description": "The type of item.", + "enum": [ + "Job", + "Session" + ], + "x-ms-enum": { + "name": "ItemType", + "modelAsString": true, + "values": [ + { + "value": "Job", + "description": "A program, problem, or application submitted for processing." + }, + { + "value": "Session", + "description": "A logical grouping of jobs." + } + ] + } + }, + "creationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The creation time of the item." + }, + "beginExecutionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time when the item began execution." + }, + "endExecutionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time when the item finished execution." + }, + "costEstimate": { + "$ref": "#/definitions/CostEstimate" + }, + "errorData": { + "$ref": "#/definitions/ErrorData" + } + }, + "required": [ + "id", + "name", + "providerId", + "target", + "itemType" + ] + }, + "JobDetailsList": { + "description": "List of job details.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobDetails" + } + }, + "nextLink": { + "type": "string", + "description": "Link to the next page of results." + } + } + }, + "JobDetails": { + "description": "Job details.", + "type": "object", + "x-ms-discriminator-value": "Job", + "allOf": [ + { + "$ref": "#/definitions/ItemDetails" + } + ], + "properties": { + "jobType": { + "type": "string", + "description": "The type of job.", + "enum": [ + "Unknown", + "QuantumComputing", + "Optimization" + ], + "readOnly": true, + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "sessionId": { + "type": "string", + "description": "The ID of the session that the job is part of." + }, + "containerUri": { + "type": "string", + "description": "The blob container SAS uri, the container is used to host job data." + }, + "inputDataUri": { + "type": "string", + "description": "The input blob SAS uri, if specified, it will override the default input blob in the container." + }, + "inputDataFormat": { + "type": "string", + "description": "The format of the input data." + }, + "inputParams": { + "type": "object", + "description": "The input parameters for the job. JSON object used by the target solver. It is expected that the size of this object is small and only used to specify parameters for the execution target, not the input data." + }, + "status": { + "type": "string", + "description": "The status of the job.", + "readOnly": true, + "enum": [ + "Waiting", + "Executing", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The job metadata. Metadata provides client the ability to store client-specific information" + }, + "outputDataUri": { + "type": "string", + "description": "The output blob SAS uri. When a job finishes successfully, results will be uploaded to this blob." + }, + "outputDataFormat": { + "type": "string", + "description": "The format of the output data." + }, + "cancellationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time when a job was successfully cancelled." + }, + "quantumComputingData": { + "$ref": "#/definitions/QuantumComputingData" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of user-supplied tags associated with the job." + } + }, + "required": [ + "containerUri", + "inputDataFormat" + ] + }, + "SessionDetailsList": { + "description": "List of session details.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SessionDetails" + } + }, + "nextLink": { + "type": "string", + "description": "Link to the next page of results." + } + } + }, + "SessionDetails": { + "description": "Session details.", + "type": "object", + "x-ms-discriminator-value": "Session", + "allOf": [ + { + "$ref": "#/definitions/ItemDetails" + } + ], + "properties": { + "jobFailurePolicy": { + "type": "string", + "description": "Policy controlling the behavior of the Session when a job in the session fails.", + "enum": [ + "Abort", + "Continue" + ], + "default": "Abort", + "x-ms-enum": { + "name": "SessionJobFailurePolicy", + "modelAsString": true, + "values": [ + { + "value": "Abort", + "description": "New jobs submitted after a job fails will be rejected. " + }, + { + "value": "Continue", + "description": "New jobs submitted after a job fails will be accepted." + } + ] + } + }, + "status": { + "type": "string", + "description": "The status of the session.", + "readOnly": true, + "enum": [ + "Waiting", + "Executing", + "Succeeded", + "Failed", + "Failure(s)", + "TimedOut" + ], + "x-ms-enum": { + "name": "SessionStatus", + "modelAsString": true + } + } + } + }, + "QuantumComputingData": { + "description": "Quantum computing data.", + "type": "object", + "readOnly": true, + "properties": { + "count": { + "type": "integer", + "format": "int64", + "description": "The number of quantum computing items in the job." + } + } + }, + "BlobDetails": { + "description": "Blob details.", + "type": "object", + "properties": { + "containerName": { + "type": "string", + "description": "The container name." + }, + "blobName": { + "type": "string", + "description": "The blob name." + } + }, + "required": [ + "containerName" + ] + }, + "SasUriResponse": { + "description": "Get SAS URL operation response.", + "type": "object", + "properties": { + "sasUri": { + "type": "string", + "description": "A URL with a SAS token to upload a blob for execution in the given workspace." + } + } + }, + "ProviderStatusList": { + "description": "Providers status.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProviderStatus" + } + }, + "nextLink": { + "type": "string", + "description": "Link to the next page of results." + } + } + }, + "ProviderStatus": { + "description": "Providers status.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Provider id." + }, + "currentAvailability": { + "type": "string", + "description": "Provider availability.", + "enum": [ + "Available", + "Degraded", + "Unavailable" + ], + "x-ms-enum": { + "name": "ProviderAvailability", + "modelAsString": true + } + }, + "targets": { + "type": "array", + "items": { + "$ref": "#/definitions/TargetStatus" + } + } + } + }, + "TargetStatus": { + "description": "Target status.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Target id." + }, + "currentAvailability": { + "type": "string", + "description": "Target availability.", + "enum": [ + "Available", + "Degraded", + "Unavailable" + ], + "x-ms-enum": { + "name": "TargetAvailability", + "modelAsString": true + } + }, + "averageQueueTime": { + "type": "integer", + "format": "int64", + "description": "Average queue time in seconds." + }, + "statusPage": { + "type": "string", + "description": "A page with detailed status of the provider." + } + } + }, + "QuotaList": { + "description": "List of quotas.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Quota" + } + }, + "nextLink": { + "type": "string", + "description": "Link to the next page of results." + } + } + }, + "Quota": { + "description": "Quota information.", + "type": "object", + "properties": { + "dimension": { + "type": "string", + "description": "The name of the dimension associated with the quota." + }, + "scope": { + "type": "string", + "description": "The scope at which the quota is applied.", + "enum": [ + "Workspace", + "Subscription" + ], + "x-ms-enum": { + "name": "DimensionScope", + "modelAsString": true + } + }, + "providerId": { + "type": "string", + "description": "The unique identifier for the provider." + }, + "utilization": { + "type": "number", + "description": "The amount of the usage that has been applied for the current period." + }, + "holds": { + "type": "number", + "description": "The amount of the usage that has been reserved but not applied for the current period." + }, + "limit": { + "type": "number", + "description": "The maximum amount of usage allowed for the current period." + }, + "period": { + "type": "string", + "description": "The time period in which the quota's underlying meter is accumulated. Based on calendar year. 'None' is used for concurrent quotas.", + "enum": [ + "None", + "Monthly" + ], + "x-ms-enum": { + "name": "MeterPeriod", + "modelAsString": true + } + } + } + }, + "CostEstimate": { + "description": "The job cost billed by the provider. The final cost on your bill might be slightly different due to added taxes and currency conversion rates.", + "type": "object", + "properties": { + "currencyCode": { + "type": "string", + "description": "The currency code." + }, + "events": { + "type": "array", + "description": "List of usage events", + "items": { + "$ref": "#/definitions/UsageEvent" + } + }, + "estimatedTotal": { + "type": "number", + "description": "The estimated total." + } + } + }, + "UsageEvent": { + "description": "Usage event details.", + "type": "object", + "properties": { + "dimensionId": { + "type": "string", + "description": "The dimension id." + }, + "dimensionName": { + "type": "string", + "description": "The dimension name." + }, + "measureUnit": { + "type": "string", + "description": "The unit of measure." + }, + "amountBilled": { + "type": "number", + "description": "The amount billed." + }, + "amountConsumed": { + "type": "number", + "description": "The amount consumed." + }, + "unitPrice": { + "type": "number", + "description": "The unit price." + } + } + }, + "RestError": { + "description": "Error information returned by the API", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorData" + } + }, + "required": [ + "error" + ] + }, + "ErrorData": { + "description": "An error response from Azure.", + "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 displaying in a user interface." + } + }, + "required": [ + "code", + "message" + ] + }, + "PatchRequest": { + "type": "array", + "items": { + "$ref": "#/definitions/JsonPatchDocument" + } + }, + "JsonPatchDocument": { + "description": "A JSONPatch document as defined by RFC 6902", + "type": "object", + "required": [ + "op", + "path" + ], + "properties": { + "op": { + "type": "string", + "description": "The operation to be performed.", + "enum": [ + "add", + "remove", + "replace", + "move", + "copy", + "test" + ], + "x-ms-enum": { + "name": "JsonPatchOperation", + "modelAsString": true + } + }, + "path": { + "type": "string", + "description": "A JSON-Pointer." + }, + "value": { + "type": "object", + "description": "A value to be used in the operation on the path." + }, + "from": { + "type": "string", + "description": "Optional field used in copy and move operations." + } + } + } + }, + "parameters": { + "azureRegionParameter": { + "name": "azureRegion", + "description": "Supported Azure regions for Azure Quantum Services. For example, \"eastus\"", + "required": true, + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true, + "type": "string", + "in": "path" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The client API version.", + "required": true, + "x-ms-parameter-location": "client", + "type": "string" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)", + "in": "path", + "required": true, + "x-ms-parameter-location": "client", + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Name of an Azure resource group." + }, + "workspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Name of the workspace." + }, + "jobIdParameter": { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "x-ms-parameter-location": "method", + "description": "Id of the job." + }, + "sessionIdParameter": { + "name": "sessionId", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "x-ms-parameter-location": "method", + "description": "Id of the session." + } + } +} diff --git a/specification/quantum/data-plane/readme.md b/specification/quantum/data-plane/readme.md index 046c8c0280ba..2a30c6a7d794 100644 --- a/specification/quantum/data-plane/readme.md +++ b/specification/quantum/data-plane/readme.md @@ -26,7 +26,7 @@ These are the global settings for the quantum. ```yaml openapi-type: data-plane -tag: package-2022-09-12-preview +tag: package-2023-11-13-preview ``` ### Tag: package-2019-11-04-preview @@ -65,6 +65,15 @@ input-file: - Microsoft.Quantum/preview/2022-09-12-preview/quantum.json ``` +### Tag: package-2023-11-13-preview + +These settings apply only when `--tag=package-2023-11-13-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-11-13-preview' +input-file: + - Microsoft.Quantum/preview/2023-11-13-preview/quantum.json +``` + --- # Code Generation diff --git a/specification/quantum/data-plane/readme.python.md b/specification/quantum/data-plane/readme.python.md index c4eefe359f10..e7094bc0a070 100644 --- a/specification/quantum/data-plane/readme.python.md +++ b/specification/quantum/data-plane/readme.python.md @@ -9,10 +9,14 @@ python: license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.quantum._client package-name: azure-quantum - add-credentials: true + credential-default-policy-type: BearerTokenCredentialPolicy credential-scopes: "https://quantum.microsoft.com/.default" + add-credential: true clear-output-folder: true no-namespace-folders: false + generate-metadata: false + models-mode: msrest + version-tolerant: true ``` ```yaml $(python) && $(python-mode) == 'update' diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/listKeys.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/listKeys.json new file mode 100644 index 000000000000..7586f4c36e1a --- /dev/null +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/listKeys.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview", + "resourceGroupName": "quantumResourcegroup", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "apiKeyEnabled": true, + "primaryKey": { + "createdAt": "2023-11-13T23:06:09.147165Z", + "key": "" + }, + "secondaryKey": { + "createdAt": "2023-11-13T23:06:09.147165Z", + "key": "" + }, + "primaryConnectionString": "", + "secondaryConnectionString": "" + } + } + } +} diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/offeringsList.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/offeringsList.json new file mode 100644 index 000000000000..8635af13c6db --- /dev/null +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/offeringsList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "1C4B2828-7D49-494F-933D-061373BE28C2", + "api-version": "2023-11-13-preview", + "locationName": "westus2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "QIO", + "name": "Quantum Inspired Optimization", + "properties": { + "description": "Provide Quantum Inspired Optimization solvers", + "targets": [ + { + "name": "CPU annealer", + "id": "p1", + "description": "CPU annealer algorithm" + } + ], + "skus": [ + { + "name": "Standard", + "id": "Standard", + "version": "1.0", + "description": "Provider CPU and FPGA QIO based solver.", + "restrictedAccessUri": "https://endpoint", + "autoAdd": true, + "targets": [ + "p1" + ], + "quotaDimensions": [ + { + "id": "quota1", + "scope": "Workspace" + } + ], + "pricingDetails": [ + { + "id": "price", + "value": "200 dollars" + }, + { + "id": "rate", + "value": "10 hours/month" + } + ] + } + ], + "quotaDimensions": [ + { + "id": "job-count", + "scope": "Workspace", + "period": "Monthly", + "quota": 30, + "name": "Job count", + "description": "The number of jobs you may submit per month", + "unit": "job", + "unitPlural": "jobs" + }, + { + "id": "job-hour", + "scope": "Subscription", + "period": "Monthly", + "quota": 1000, + "name": "Job hours", + "description": "The number of hours of solver time you may use per month", + "unit": "hour", + "unitPlural": "hours" + } + ], + "pricingDimensions": [ + { + "id": "price", + "name": "Pricing" + }, + { + "id": "rate", + "name": "Minimum monthly rate" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/operations.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/operations.json new file mode 100644 index 000000000000..e3ea4c38b772 --- /dev/null +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/operations.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-13-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Quantum/Locations/Offerings/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Quantum", + "resource": "Workspaces", + "operation": "Read quantum workspace's available providers", + "description": "Read providers supported" + } + } + ] + } + } + } +} diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesCheckNameAvailability.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesCheckNameAvailability.json new file mode 100644 index 000000000000..0dbf8b42c4f6 --- /dev/null +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesCheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview", + "locationName": "westus2", + "checkNameAvailabilityParameters": { + "name": "sample-workspace-name", + "type": "Microsoft.Quantum/Workspaces" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Resource name already exists" + } + } + } +} diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesDelete.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesDelete.json new file mode 100644 index 000000000000..af939aedf2d6 --- /dev/null +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesDelete.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "workspaceName": "quantumworkspace1", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview" + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-11-13-preview" + }, + "description": "Successful." + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-11-13-preview" + }, + "description": "Workspace delete request accepted." + }, + "204": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-11-13-preview" + } + } + } +} diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesGet.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesGet.json new file mode 100644 index 000000000000..08f30f8b32a7 --- /dev/null +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesGet.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "workspaceName": "quantumworkspace1", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/Workspaces/quantumworkspace1", + "name": "quantumworkspace1", + "type": "Microsoft.Quantum/Workspaces", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic", + "applicationName": "quantumworkspace1-h1", + "instanceUri": "https://h1.endpoint.com", + "provisioningState": "Succeeded", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + }, + { + "providerId": "IonQ", + "provisioningState": "Succeeded", + "applicationName": "quantumworkspace1-i1", + "instanceUri": "https://i1.endpoint.com", + "providerSku": "Basic", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + }, + { + "providerId": "OneQBit", + "provisioningState": "Succeeded", + "applicationName": "quantumworkspace1-o1", + "instanceUri": "https://o1.endpoint.com", + "providerSku": "Basic", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + } + ], + "provisioningState": "Succeeded", + "usable": "Yes", + "storageAccount": "/subscriptions/1C4B2828-7D49-494F-933D-061373BE28C2/resourceGroups/quantumResourcegroup/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "endpointUri": "https://quantumworkspace1.westus.quantum.azure.com", + "apiKeyEnabled": true + }, + "location": "West US", + "tags": { + "department": "MightyMight", + "company": "Contoso" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListResourceGroup.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListResourceGroup.json new file mode 100644 index 000000000000..c07998dc31c8 --- /dev/null +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListResourceGroup.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/Workspaces/quantumworkspace1", + "name": "quantumworkspace1", + "type": "Microsoft.Quantum/Workspaces", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic", + "applicationName": "quantumworkspace1-h1", + "instanceUri": "https://h1.endpoint.com", + "provisioningState": "Succeeded", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + } + ], + "provisioningState": "Succeeded", + "usable": "Yes", + "storageAccount": "/subscriptions/1C4B2828-7D49-494F-933D-061373BE28C2/resourceGroups/quantumResourcegroup/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "endpointUri": "https://quantumworkspace1.westus.quantum.azure.com", + "apiKeyEnabled": true + }, + "location": "West US", + "tags": { + "department": "MightyMight", + "company": "Contoso" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + ] + } + } + } +} diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListSubscription.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListSubscription.json new file mode 100644 index 000000000000..56eeeb42b186 --- /dev/null +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListSubscription.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/Workspaces/quantumworkspace1", + "name": "quantumworkspace1", + "type": "Microsoft.Quantum/Workspaces", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic", + "applicationName": "quantumworkspace1-h1", + "instanceUri": "https://h1.endpoint.com", + "provisioningState": "Succeeded", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + } + ], + "provisioningState": "Succeeded", + "usable": "Yes", + "storageAccount": "/subscriptions/1C4B2828-7D49-494F-933D-061373BE28C2/resourceGroups/quantumResourcegroup/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "endpointUri": "https://quantumworkspace1.westus.quantum.azure.com", + "apiKeyEnabled": true + }, + "location": "West US", + "tags": { + "department": "MightyMight", + "company": "Contoso" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + ] + } + } + } +} diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPatch.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPatch.json new file mode 100644 index 000000000000..a096f8332a83 --- /dev/null +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPatch.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "workspaceName": "quantumworkspace1", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview", + "workspaceTags": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/Workspaces/quantumworkspace1", + "name": "quantumworkspace1", + "type": "Microsoft.Quantum/Workspaces", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic", + "applicationName": "quantumworkspace1-h1", + "instanceUri": "https://h1.endpoint.com", + "provisioningState": "Succeeded", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + }, + { + "providerId": "IonQ", + "provisioningState": "Succeeded", + "applicationName": "quantumworkspace1-i1", + "instanceUri": "https://i1.endpoint.com", + "providerSku": "Basic", + "resourceUsageId": "00000000-1111-2222-3333-444444444445" + }, + { + "providerId": "OneQBit", + "provisioningState": "Succeeded", + "applicationName": "quantumworkspace1-o1", + "instanceUri": "https://o1.endpoint.com", + "providerSku": "Basic", + "resourceUsageId": "00000000-1111-2222-3333-444444444446" + } + ], + "provisioningState": "Succeeded", + "usable": "Yes", + "storageAccount": "/subscriptions/1C4B2828-7D49-494F-933D-061373BE28C2/resourceGroups/quantumResourcegroup/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "endpointUri": "https://quantumworkspace1.westus.quantum.azure.com", + "apiKeyEnabled": true + }, + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPut.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPut.json new file mode 100644 index 000000000000..9c02fb1b3253 --- /dev/null +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPut.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "workspaceName": "quantumworkspace1", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview", + "QuantumWorkspace": { + "location": "West US", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic" + }, + { + "providerId": "IonQ", + "providerSku": "Basic" + }, + { + "providerId": "OneQBit", + "providerSku": "Basic" + } + ], + "storageAccount": "/subscriptions/1C4B2828-7D49-494F-933D-061373BE28C2/resourceGroups/quantumResourcegroup/providers/Microsoft.Storage/storageAccounts/testStorageAccount" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/Workspaces/quantumworkspace1", + "name": "quantumworkspace1", + "type": "Microsoft.Quantum/Workspaces", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic", + "applicationName": "quantumworkspace1-h1", + "instanceUri": "https://h1.endpoint.com", + "provisioningState": "Succeeded", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + }, + { + "providerId": "IonQ", + "provisioningState": "Succeeded", + "applicationName": "quantumworkspace1-i1", + "instanceUri": "https://i1.endpoint.com", + "providerSku": "Basic", + "resourceUsageId": "00000000-1111-2222-3333-444444444445" + }, + { + "providerId": "OneQBit", + "provisioningState": "Succeeded", + "applicationName": "quantumworkspace1-o1", + "instanceUri": "https://o1.endpoint.com", + "providerSku": "Basic", + "resourceUsageId": "00000000-1111-2222-3333-444444444446" + } + ], + "provisioningState": "Succeeded", + "usable": "Yes", + "storageAccount": "/subscriptions/1C4B2828-7D49-494F-933D-061373BE28C2/resourceGroups/quantumResourcegroup/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "endpointUri": "https://quantumworkspace1.westus.quantum.azure.com", + "apiKeyEnabled": true + }, + "location": "West US", + "tags": { + "department": "MightyMight", + "company": "Contoso" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/Workspaces/quantumworkspace1", + "name": "quantumworkspace1", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic", + "applicationName": "quantumworkspace1-h1", + "provisioningState": "Launching" + }, + { + "providerId": "IonQ", + "provisioningState": "Launching", + "applicationName": "quantumworkspace1-i1", + "providerSku": "Basic" + }, + { + "providerId": "OneQBit", + "provisioningState": "Launching", + "applicationName": "quantumworkspace1-o1", + "providerSku": "Basic" + } + ], + "provisioningState": "ProviderLaunching", + "usable": "No", + "apiKeyEnabled": true + }, + "location": "West US", + "tags": { + "department": "MightyMight", + "company": "Contoso" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/regenerateKey.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/regenerateKey.json new file mode 100644 index 000000000000..bad23f8cbf92 --- /dev/null +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/regenerateKey.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview", + "resourceGroupName": "quantumResourcegroup", + "workspaceName": "quantumworkspace1", + "keySpecification": { + "keys": [ + "Primary", + "Secondary" + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/quantum.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/quantum.json new file mode 100644 index 000000000000..f4a5f5f1c99a --- /dev/null +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/quantum.json @@ -0,0 +1,1130 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Quantum Management Client", + "version": "2023-11-13-preview", + "x-ms-code-generation-settings": { + "name": "QuantumManagementClient" + } + }, + "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.Quantum/workspaces/{workspaceName}": { + "get": { + "description": "Returns the Workspace resource associated with the given name.", + "operationId": "Workspaces_Get", + "x-ms-examples": { + "QuantumWorkspacesGet": { + "$ref": "./examples/quantumWorkspacesGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Workspace details.", + "schema": { + "$ref": "#/definitions/QuantumWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Creates or updates a workspace resource.", + "operationId": "Workspaces_CreateOrUpdate", + "x-ms-examples": { + "QuantumWorkspacesPut": { + "$ref": "./examples/quantumWorkspacesPut.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "QuantumWorkspace", + "description": "Workspace details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QuantumWorkspace" + } + } + ], + "responses": { + "201": { + "description": "Workspace create/update request accepted.", + "schema": { + "$ref": "#/definitions/QuantumWorkspace" + } + }, + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/QuantumWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "description": "Updates an existing workspace's tags.", + "operationId": "Workspaces_UpdateTags", + "x-ms-examples": { + "QuantumWorkspacesPatchTags": { + "$ref": "./examples/quantumWorkspacesPatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "workspaceTags", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update tags." + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/QuantumWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "description": "Deletes a Workspace resource.", + "operationId": "Workspaces_Delete", + "x-ms-examples": { + "QuantumWorkspacesDelete": { + "$ref": "./examples/quantumWorkspacesDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successful." + }, + "202": { + "description": "Workspace delete request accepted." + }, + "204": { + "description": "No content - The workspace doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/workspaces": { + "get": { + "operationId": "Workspaces_ListBySubscription", + "x-ms-examples": { + "QuantumWorkspacesListBySubscription": { + "$ref": "./examples/quantumWorkspacesListSubscription.json" + } + }, + "description": "Gets the list of Workspaces within a Subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Workspaces successfully returned.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces": { + "get": { + "operationId": "Workspaces_ListByResourceGroup", + "x-ms-examples": { + "QuantumWorkspacesListByResourceGroup": { + "$ref": "./examples/quantumWorkspacesListResourceGroup.json" + } + }, + "description": "Gets the list of Workspaces within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Workspaces successfully returned.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/offerings": { + "get": { + "description": "Returns the list of all provider offerings available for the given location.", + "operationId": "Offerings_List", + "x-ms-examples": { + "OfferingsList": { + "$ref": "./examples/offeringsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Offerings details.", + "schema": { + "$ref": "#/definitions/OfferingsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Quantum/operations": { + "get": { + "description": "Returns list of operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Operations": { + "$ref": "./examples/operations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation details.", + "schema": { + "$ref": "#/definitions/operationsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/checkNameAvailability": { + "post": { + "description": "Check the availability of the resource name.", + "operationId": "Workspace_CheckNameAvailability", + "x-ms-examples": { + "QuantumWorkspacesCheckNameAvailability": { + "$ref": "./examples/quantumWorkspacesCheckNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "name": "checkNameAvailabilityParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + }, + "description": "The name and type of the resource." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/listKeys": { + "post": { + "description": "Get the keys to use with the Quantum APIs. A key is used to authenticate and authorize access to the Quantum REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.", + "operationId": "Workspace_ListKeys", + "x-ms-examples": { + "ListKeys": { + "$ref": "./examples/listKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/ListKeysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/regenerateKey": { + "post": { + "description": "Regenerate either the primary or secondary key for use with the Quantum APIs. The old key will stop working immediately.", + "operationId": "Workspace_RegenerateKeys", + "x-ms-examples": { + "RegenerateKey": { + "$ref": "./examples/regenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "keySpecification", + "in": "body", + "required": true, + "description": "Which key to regenerate: primary or secondary.", + "schema": { + "$ref": "#/definitions/APIKeys" + } + } + ], + "responses": { + "204": { + "description": "The request was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "WorkspaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/QuantumWorkspace" + }, + "description": "Result of a list Workspaces operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Workspaces." + } + }, + "description": "The response of a list Workspaces operation." + }, + "OfferingsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProviderDescription" + }, + "description": "Result of a list Providers operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Providers." + } + }, + "description": "The response of a list Providers operation." + }, + "QuantumWorkspace": { + "type": "object", + "description": "The resource proxy definition object for quantum workspace.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Gets or sets the properties. Define quantum workspace's specific properties.", + "$ref": "#/definitions/WorkspaceResourceProperties" + }, + "identity": { + "type": "object", + "description": "Managed Identity information.", + "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": "The identity type.", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": true + } + } + } + }, + "systemData": { + "description": "System metadata", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ApiKey": { + "description": "Azure quantum workspace Api key details.", + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The creation time of the api key." + }, + "key": { + "x-ms-secret": true, + "readOnly": true, + "type": "string", + "description": "The Api key." + } + } + }, + "ListKeysResult": { + "description": "Result of list Api keys and connection strings.", + "type": "object", + "properties": { + "apiKeyEnabled": { + "type": "boolean", + "description": "Indicator of enablement of the Quantum workspace Api keys." + }, + "primaryKey": { + "$ref": "#/definitions/ApiKey", + "description": "The quantum workspace primary api key." + }, + "secondaryKey": { + "$ref": "#/definitions/ApiKey", + "description": "The quantum workspace secondary api key." + }, + "primaryConnectionString": { + "x-ms-secret": true, + "readOnly": true, + "type": "string", + "description": "The connection string of the primary api key." + }, + "secondaryConnectionString": { + "x-ms-secret": true, + "readOnly": true, + "type": "string", + "description": "The connection string of the secondary api key." + } + } + }, + "APIKeys": { + "type": "object", + "properties": { + "keys": { + "description": "A list of api key names.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Primary", + "Secondary" + ], + "default": "Primary", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + } + } + }, + "description": "List of api keys to be generated." + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "WorkspaceResourceProperties": { + "description": "Properties of a Workspace", + "properties": { + "providers": { + "type": "array", + "description": "List of Providers selected for this Workspace", + "items": { + "$ref": "#/definitions/Provider" + }, + "x-ms-identifiers": [] + }, + "usable": { + "type": "string", + "enum": [ + "Yes", + "No", + "Partial" + ], + "x-ms-enum": { + "name": "UsableStatus", + "modelAsString": true + }, + "description": "Whether the current workspace is ready to accept Jobs.", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "enum": [ + "Succeeded", + "ProviderLaunching", + "ProviderUpdating", + "ProviderDeleting", + "ProviderProvisioning", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningStatus", + "modelAsString": true + }, + "description": "Provisioning status field", + "readOnly": true + }, + "storageAccount": { + "type": "string", + "description": "ARM Resource Id of the storage account associated with this workspace." + }, + "endpointUri": { + "type": "string", + "description": "The URI of the workspace endpoint.", + "readOnly": true + }, + "apiKeyEnabled": { + "type": "boolean", + "description": "Indicator of enablement of the Quantum workspace Api keys." + } + } + }, + "ProviderDescription": { + "type": "object", + "description": "Information about an offering. A provider offering is an entity that offers Targets to run Azure Quantum Jobs.", + "properties": { + "id": { + "type": "string", + "description": "Unique provider's id." + }, + "name": { + "type": "string", + "description": "Provider's display name.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ProviderProperties" + } + } + }, + "ProviderProperties": { + "type": "object", + "description": "Provider properties.", + "properties": { + "description": { + "type": "string", + "description": "A description about this provider.", + "readOnly": true + }, + "providerType": { + "type": "string", + "description": "Provider type.", + "readOnly": true + }, + "company": { + "type": "string", + "description": "Company name.", + "readOnly": true + }, + "defaultEndpoint": { + "type": "string", + "description": "Provider's default endpoint.", + "readOnly": true + }, + "aad": { + "type": "object", + "description": "Azure Active Directory info.", + "properties": { + "applicationId": { + "type": "string", + "description": "Provider's application id.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "Provider's tenant id.", + "readOnly": true + } + } + }, + "managedApplication": { + "type": "object", + "description": "Provider's Managed-Application info", + "properties": { + "publisherId": { + "type": "string", + "description": "Provider's publisher id.", + "readOnly": true + }, + "offerId": { + "type": "string", + "description": "Provider's offer id.", + "readOnly": true + } + } + }, + "targets": { + "type": "array", + "description": "The list of targets available from this provider.", + "items": { + "$ref": "#/definitions/TargetDescription" + } + }, + "skus": { + "type": "array", + "description": "The list of skus available from this provider.", + "items": { + "$ref": "#/definitions/SkuDescription" + } + }, + "quotaDimensions": { + "type": "array", + "description": "The list of quota dimensions from the provider.", + "items": { + "$ref": "#/definitions/QuotaDimension" + } + }, + "pricingDimensions": { + "type": "array", + "description": "The list of pricing dimensions from the provider.", + "items": { + "$ref": "#/definitions/PricingDimension" + } + } + } + }, + "TargetDescription": { + "type": "object", + "description": "Information about a Target. A target is the component that can process a specific type of Job.", + "properties": { + "id": { + "type": "string", + "description": "Unique target id." + }, + "name": { + "type": "string", + "description": "Display name of this target." + }, + "description": { + "type": "string", + "description": "A description about this target." + }, + "acceptedDataFormats": { + "type": "array", + "description": "List of data formats accepted by this target.", + "items": { + "type": "string" + } + }, + "acceptedContentEncodings": { + "type": "array", + "description": "List of content encodings accepted by this target.", + "items": { + "type": "string" + } + } + } + }, + "SkuDescription": { + "type": "object", + "description": "Information about a specific sku.", + "properties": { + "id": { + "type": "string", + "description": "Unique sku id." + }, + "name": { + "type": "string", + "description": "Display name of this sku." + }, + "version": { + "type": "string", + "description": "Display name of this sku." + }, + "description": { + "type": "string", + "description": "Description about this sku." + }, + "restrictedAccessUri": { + "type": "string", + "description": "Uri to subscribe to the restricted access sku." + }, + "autoAdd": { + "type": "boolean", + "description": "Flag to indicate whether the sku should be automatically added during workspace creation." + }, + "targets": { + "type": "array", + "description": "The list of targets available for this sku.", + "items": { + "type": "string" + } + }, + "quotaDimensions": { + "type": "array", + "description": "The list of quota dimensions for this sku.", + "items": { + "$ref": "#/definitions/QuotaDimension" + } + }, + "pricingDetails": { + "type": "array", + "description": "The list of pricing details for the sku.", + "items": { + "$ref": "#/definitions/PricingDetail" + } + } + } + }, + "QuotaDimension": { + "type": "object", + "description": "Information about a specific quota dimension.", + "properties": { + "id": { + "type": "string", + "description": "Unique id of this dimension." + }, + "scope": { + "type": "string", + "description": "The scope of this quota dimension." + }, + "period": { + "type": "string", + "description": "The reset period of this quota dimension." + }, + "quota": { + "type": "number", + "description": "The max limit of this dimension." + }, + "name": { + "type": "string", + "description": "The display name of this quota dimension." + }, + "description": { + "type": "string", + "description": "A description about this quota dimension." + }, + "unit": { + "type": "string", + "description": "The standard unit of measurement used for this quota dimension." + }, + "unitPlural": { + "type": "string", + "description": "The standard unit of measurement used for this quota dimension in plural form." + } + } + }, + "PricingDetail": { + "type": "object", + "description": "Detailed pricing information for an sku.", + "properties": { + "id": { + "type": "string", + "description": "Unique id for this pricing information." + }, + "value": { + "type": "string", + "description": "The unit cost of this sku." + } + } + }, + "PricingDimension": { + "type": "object", + "description": "Information about pricing dimension.", + "properties": { + "id": { + "type": "string", + "description": "Unique id of this pricing dimension." + }, + "name": { + "type": "string", + "description": "The display name of this pricing dimension." + } + } + }, + "Provider": { + "type": "object", + "description": "Information about a Provider. A Provider is an entity that offers Targets to run Azure Quantum Jobs.", + "properties": { + "providerId": { + "type": "string", + "description": "Unique id of this provider." + }, + "providerSku": { + "type": "string", + "description": "The sku associated with pricing information for this provider." + }, + "instanceUri": { + "type": "string", + "description": "A Uri identifying the specific instance of this provider." + }, + "applicationName": { + "type": "string", + "description": "The provider's marketplace application display name." + }, + "provisioningState": { + "type": "string", + "enum": [ + "Succeeded", + "Launching", + "Updating", + "Deleting", + "Deleted", + "Failed" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + }, + "description": "Provisioning status field" + }, + "resourceUsageId": { + "type": "string", + "description": "Id to track resource usage for the provider." + } + } + }, + "operation": { + "description": "Operation provided by provider", + "properties": { + "name": { + "type": "string", + "description": "Name of the operation" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "type": "object", + "description": "Properties of the operation", + "properties": { + "provider": { + "type": "string", + "description": "Provider name" + }, + "resource": { + "type": "string", + "description": "Resource name" + }, + "operation": { + "type": "string", + "description": "Operation name" + }, + "description": { + "type": "string", + "description": "Description of the operation" + } + } + } + } + }, + "operationsList": { + "description": "Lists the operations available.", + "type": "object", + "properties": { + "nextLink": { + "description": "Url to follow for getting next page of operations.", + "type": "string" + }, + "value": { + "description": "Array of operations", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/operation" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ] + }, + "CheckNameAvailabilityParameters": { + "description": "Details of check name availability request body.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name for checking availability." + }, + "type": { + "type": "string", + "default": "Microsoft.Quantum/Workspaces", + "description": "The resource type of Quantum Workspace." + } + } + }, + "CheckNameAvailabilityResult": { + "description": "Result of check name availability.", + "type": "object", + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Indicator of availability of the Quantum Workspace resource name." + }, + "reason": { + "type": "string", + "description": "The reason of unavailability." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The detailed info regarding the reason associated with the Namespace." + } + } + } + }, + "parameters": { + "LocationParameter": { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "Location.", + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "description": "The name of the quantum workspace resource.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/quantum/resource-manager/readme.md b/specification/quantum/resource-manager/readme.md index f1ba62083dbb..c6be1147651f 100644 --- a/specification/quantum/resource-manager/readme.md +++ b/specification/quantum/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the quantum. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2022-01-10-preview +tag: package-2023-11-13-preview ``` ### Tag: package-2019-11-04-preview @@ -48,6 +48,15 @@ input-file: - Microsoft.Quantum/preview/2022-01-10-preview/quantum.json ``` +### Tag: package-2023-11-13-preview + +These settings apply only when `--tag=package-2023-11-13-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2023-11-13-preview' +input-file: + - Microsoft.Quantum/preview/2023-11-13-preview/quantum.json +``` + --- # Code Generation diff --git a/specification/quantum/resource-manager/readme.python.md b/specification/quantum/resource-manager/readme.python.md index 57bd74ae2254..5c091a755ccb 100644 --- a/specification/quantum/resource-manager/readme.python.md +++ b/specification/quantum/resource-manager/readme.python.md @@ -10,6 +10,9 @@ namespace: azure.mgmt.quantum package-name: azure-mgmt-quantum package-version: 1.0.0b1 clear-output-folder: true +generate-metadata: false +models-mode: msrest +version-tolerant: true ``` ``` yaml $(python) diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/MigrationRecoveryPoints_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/MigrationRecoveryPoints_Get.json new file mode 100644 index 000000000000..c10fe2fd5f0e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/MigrationRecoveryPoints_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "migrationRecoveryPointName": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json new file mode 100644 index 000000000000..ac1864e3c23e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "648336ef-2d70-4d98-b100-8c299f97cd41", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/648336ef-2d70-4d98-b100-8c299f97cd41", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + { + "name": "34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "properties": { + "recoveryPointTime": "2017-04-26T07:37:30.9722019Z", + "recoveryPointType": "CrashConsistent" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/Operations_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/Operations_List.json new file mode 100644 index 000000000000..b8f2208c25a9 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/Operations_List.json @@ -0,0 +1,1228 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.RecoveryServices/Vaults/vaultTokens/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Vault Token", + "description": "The Vault Token operation can be used to get Vault Token for vault level backend operations." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Register Service Container", + "description": "The Register Service Container operation can be used to register a container with Recovery Service." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Operation Results", + "description": "The Get Operation Results operation can be used get the operation status and result for the asynchronously submitted operation" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Containers", + "description": "The Get Containers operation can be used get the containers registered for a resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Unregister Service Container", + "description": "The UnRegister Container operation can be used to unregister a container." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/certificates/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Update Resource Certificate", + "description": "The Update Resource Certificate operation updates the resource/vault credential certificate." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationAlertSettings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Alerts Settings", + "operation": "Read Alerts Settings", + "description": "Read Any Alerts Settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationAlertSettings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Alerts Settings", + "operation": "Create or Update Alerts Settings", + "description": "Create or Update Any Alerts Settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationEvents/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Events", + "operation": "Read Events", + "description": "Read Any Events" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Networks", + "operation": "Read Networks", + "description": "Read Any Networks" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Network Mappings", + "operation": "Read Network Mappings", + "description": "Read Any Network Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Network Mappings", + "operation": "Create or Update Network Mappings", + "description": "Create or Update Any Network Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Network Mappings", + "operation": "Delete Network Mappings", + "description": "Delete Any Network Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protectable Items", + "operation": "Read Protectable Items", + "description": "Read Any Protectable Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Read Protection Container Mappings", + "description": "Read Any Protection Container Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Create or Update Protection Container Mappings", + "description": "Create or Update Any Protection Container Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Remove Protection Container Mapping", + "description": "Remove Protection Container Mapping" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Delete Protection Container Mappings", + "description": "Delete Any Protection Container Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Replication Recovery Points", + "operation": "Read Replication Recovery Points", + "description": "Read Any Replication Recovery Points" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Read Protected Items", + "description": "Read Any Protected Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Create or Update Protected Items", + "description": "Create or Update Any Protected Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Delete Protected Items", + "description": "Delete Any Protected Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Remove Protected Item", + "description": "Remove Protected Item" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/plannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Planned Failover", + "description": "Planned Failover" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/unplannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Failover", + "description": "Failover" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/testFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Test Failover", + "description": "Test Failover" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/testFailoverCleanup/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Test Failover Cleanup", + "description": "Test Failover Cleanup" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/failoverCommit/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Failover Commit", + "description": "Failover Commit" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/reProtect/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "ReProtect Protected Item", + "description": "ReProtect Protected Item" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/updateMobilityService/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Update Mobility Service", + "description": "Update Mobility Service" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/repairReplication/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Repair replication", + "description": "Repair replication" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/applyRecoveryPoint/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Apply Recovery Point", + "description": "Apply Recovery Point" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Read Jobs", + "description": "Read Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/cancel/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Cancel Job", + "description": "Cancel Job" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/restart/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Restart job", + "description": "Restart job" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/resume/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Resume Job", + "description": "Resume Job" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Read Protection Containers", + "description": "Read Any Protection Containers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/discoverProtectableItem/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Discover Protectable Item", + "description": "Discover Protectable Item" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Create or Update Protection Containers", + "description": "Create or Update Any Protection Containers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Remove Protection Container", + "description": "Remove Protection Container" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/switchprotection/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Switch Protection Container", + "description": "Switch Protection Container" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationPolicies/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Policies", + "operation": "Read Policies", + "description": "Read Any Policies" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationPolicies/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Policies", + "operation": "Create or Update Policies", + "description": "Create or Update Any Policies" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationPolicies/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Policies", + "operation": "Delete Policies", + "description": "Delete Any Policies" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Read Recovery Plans", + "description": "Read Any Recovery Plans" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Create or Update Recovery Plans", + "description": "Create or Update Any Recovery Plans" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Delete Recovery Plans", + "description": "Delete Any Recovery Plans" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/plannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Planned Failover Recovery Plan", + "description": "Planned Failover Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/unplannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Failover Recovery Plan", + "description": "Failover Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/testFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Test Failover Recovery Plan", + "description": "Test Failover Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/testFailoverCleanup/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Test Failover Cleanup Recovery Plan", + "description": "Test Failover Cleanup Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/failoverCommit/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Failover Commit Recovery Plan", + "description": "Failover Commit Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/reProtect/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "ReProtect Recovery Plan", + "description": "ReProtect Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Read Recovery Services Providers", + "description": "Read Any Recovery Services Providers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Remove Recovery Services Provider", + "description": "Remove Recovery Services Provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Delete Recovery Services Providers", + "description": "Delete Any Recovery Services Providers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/refreshProvider/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Refresh Provider", + "description": "Refresh Provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Read Fabrics", + "description": "Read Any Fabrics" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Create or Update Fabrics", + "description": "Create or Update Any Fabrics" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Remove Fabric", + "description": "Remove Fabric" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/checkConsistency/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Checks Consistency of the Fabric", + "description": "Checks Consistency of the Fabric" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Delete Fabrics", + "description": "Delete Any Fabrics" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/renewcertificate/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Renew Certificate for Fabric", + "description": "Renew Certificate for Fabric" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/deployProcessServerImage/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Deploy Process Server Image", + "description": "Deploy Process Server Image" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/reassociateGateway/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Reassociate Gateway", + "description": "Reassociate Gateway" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classifications", + "operation": "Read Storage Classifications", + "description": "Read Any Storage Classifications" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classification Mappings", + "operation": "Read Storage Classification Mappings", + "description": "Read Any Storage Classification Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classification Mappings", + "operation": "Create or Update Storage Classification Mappings", + "description": "Create or Update Any Storage Classification Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classification Mappings", + "operation": "Delete Storage Classification Mappings", + "description": "Delete Any Storage Classification Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/usages/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Vault Usages", + "operation": "Read Vault Usages", + "description": "Read Any Vault Usages" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Read Jobs", + "description": "Read Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Create or Update Jobs", + "description": "Create or Update Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Delete Jobs", + "description": "Delete Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/usages/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Usage", + "operation": "Recovery Services Vault usage details.", + "description": "Returns usage details for a Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupUsageSummaries/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Usages Summaries", + "operation": "Recovery Services Protected Items and Protected Servers usage summaries details.", + "description": "Returns summaries for Protected Items and Protected Servers for a Recovery Services ." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/storageConfig/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Storage Config", + "operation": "Get Resource Storage Config", + "description": "Returns Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/storageConfig/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Storage Config", + "operation": "Write Resource Storage Config", + "description": "Updates Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupconfig/vaultconfig/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Config", + "operation": "Get Resource Config", + "description": "Returns Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupconfig/vaultconfig/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Config", + "operation": "Update Resource Config", + "description": "Updates Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/tokenInfo/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Token Info", + "operation": "Get Vault Token Info", + "description": "Returns token information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupSecurityPIN/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "SecurityPINInfo", + "operation": "Get Security PIN Info", + "description": "Returns Security PIN Information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupManagementMetaData/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Management Metadata", + "operation": "Get Backup Management Metadata", + "description": "Returns Backup Management Metadata for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupOperationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupOperations/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Jobs", + "operation": "Get Jobs", + "description": "Returns all Job Objects" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/cancel/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Jobs", + "operation": "Cancel Jobs", + "description": "Cancel the Job" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobsExport/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Export Backup Jobs", + "operation": "Export Jobs", + "description": "Export Jobs" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Jobs Operation Results", + "operation": "Get Job Operation Result", + "description": "Returns the Result of Job Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobsExport/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Export Backup Jobs Operation Results", + "operation": "Get Export Job Operation Result", + "description": "Returns the Result of Export Job Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Get Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/restore/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Restore Recovery Points", + "description": "Restore Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/provisionInstantItemRecovery/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Provision Instant Item Recovery for Protected Item", + "description": "Provision Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/revokeInstantItemRecovery/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Revoke Instant Item Recovery for Protected Item", + "description": "Revoke Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policies", + "operation": "Get Protection Policy", + "description": "Returns all Protection Policies" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policies", + "operation": "Create Protection Policy", + "description": "Creates Protection Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policies", + "operation": "Delete Protection Policy", + "description": "Delete a Protection Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policy Operation Results", + "operation": "Get Policy Operation Results", + "description": "Get Results of Policy Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/operationStatus/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policy Operation Status", + "operation": "Get Policy Operation Status", + "description": "Get Status of Policy Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Get Protected Item Details", + "description": "Returns object details of the Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupProtectedItems/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Get All Protected Items", + "description": "Returns the list of all Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Create Backup Protected Item", + "description": "Create a backup Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Delete Protected Items", + "description": "Deletes Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Item Operation Results", + "operation": "Get Protected Items Operation Results", + "description": "Gets Result of Operation Performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/operationStatus/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Item Operation Status", + "operation": "Get Protected Items operation status", + "description": "Returns the status of Operation performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/backup/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Backup Protected Item", + "description": "Performs Backup for Protected Item." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupProtectableItems/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Protectable Items", + "operation": "Get Protectable Items", + "description": "Returns list of all Protectable Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/refreshContainers/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Refresh Containers", + "operation": "Refresh container", + "description": "Refreshes the container list" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Refresh Containers Operation Results", + "operation": "Get Operation Results", + "description": "Returns status of the operation" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupProtectionContainers/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Protection Containers", + "operation": "Get Containers In Subscription", + "description": "Returns all containers belonging to the subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protection Containers", + "operation": "Get Registered Container", + "description": "Returns all registered containers" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protection Containers Operation Results", + "operation": "Get Container Operation Results", + "description": "Gets result of Operation performed on Protection Container." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupEngines", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Engines", + "operation": "List of backup management servers.", + "description": "Returns all the backup management servers registered with vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupStatus", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Create Vault", + "description": "Create Vault operation creates an Azure resource of type 'vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Vault", + "description": "The Get Vault operation gets an object representing the Azure resource of type 'vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Delete Vault", + "description": "The Delete Vault operation deletes the specified Azure resource of type 'vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/extendedInformation/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Extended Info", + "description": "The Get Extended Info operation gets an object's Extended Info representing the Azure resource of type ?vault?" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/extendedInformation/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Extended Info", + "description": "The Get Extended Info operation gets an object's Extended Info representing the Azure resource of type ?vault?" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/extendedInformation/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Extended Info", + "description": "The Get Extended Info operation gets an object's Extended Info representing the Azure resource of type ?vault?" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/locations/allocatedStamp/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "locations/allocatedStamp", + "operation": "Get Allocated Stamp", + "description": "GetAllocatedStamp is internal operation used by service" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/locations/allocateStamp/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "locations/allocateStamp", + "operation": "Allocated Stamp Action", + "description": "AllocateStamp is internal operation used by service" + }, + "origin": "user" + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/RecoveryPoints_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/RecoveryPoints_Get.json new file mode 100644 index 000000000000..9775eac50470 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/RecoveryPoints_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPointName": "b22134ea-620c-474b-9fa5-3c1cb47708e3" + }, + "responses": { + "200": { + "body": { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json new file mode 100644 index 000000000000..ec17ca8221c7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + { + "name": "34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "properties": { + "recoveryPointTime": "2017-04-26T07:37:30.9722019Z", + "recoveryPointType": "CrashConsistent" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAlertSettings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAlertSettings_Create.json new file mode 100644 index 000000000000..9d15254aaf44 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAlertSettings_Create.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "alertSettingName": "defaultAlertSetting", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "request": { + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting", + "name": "defaultAlertSetting", + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "en-US" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAlertSettings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAlertSettings_Get.json new file mode 100644 index 000000000000..b5b87a7f1520 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAlertSettings_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "alertSettingName": "defaultAlertSetting", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting", + "name": "defaultAlertSetting", + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "en-US" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAlertSettings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAlertSettings_List.json new file mode 100644 index 000000000000..a5e3884152d0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAlertSettings_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting", + "name": "defaultAlertSetting", + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "en-US" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAppliances_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAppliances_List.json new file mode 100644 index 000000000000..0cadb898e042 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationAppliances_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "providerSpecificDetails": { + "instanceType": "InMageRcm", + "appliances": [] + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEligibilityResults_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEligibilityResults_Get.json new file mode 100644 index 000000000000..b1062a14c969 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEligibilityResults_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "virtualMachineName": "testVm1", + "resourceGroupName": "testRg1", + "subscriptionId": "d90d145a-4cdd-45a3-b2c4-971d69775278" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.RecoveryServices/replicationEligibilityResults", + "id": "/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm1/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default", + "properties": { + "clientRequestId": "7d72ade7-b9f7-4d9b-8a19-15d9728c6190", + "errors": [ + { + "code": "A2AOperatingSystemNotSupported", + "message": "The A2A operation could not be completed as the virtual machine is running OS 'ubuntu' with version '18.04' which is not supported for replication.", + "possibleCauses": "OS version not supported.", + "recommendedAction": "The virtual machine is running unsupported Operating system. Refer to the documentation for supported OS versions - https://aka.ms/a2a-os-support-matrix.", + "status": "Error" + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEligibilityResults_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEligibilityResults_List.json new file mode 100644 index 000000000000..5ef3d6459644 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEligibilityResults_List.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "virtualMachineName": "testVm2", + "resourceGroupName": "testRg1", + "subscriptionId": "d90d145a-4cdd-45a3-b2c4-971d69775278" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.RecoveryServices/replicationEligibilityResults", + "id": "/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm2/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default", + "properties": { + "clientRequestId": "a62c81df-e26e-47ea-ab4b-f1fcc1e5b135", + "errors": [ + { + "code": "AzureVmIsNotInDesiredProvisioningState", + "message": "Azure virtual machine with Id (/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm2) is with provisioning state 'failed'. To enable replication, VM's provisioning state should be 'succeeded'.", + "possibleCauses": "Virtual machine is not in desired state.", + "recommendedAction": "\n Ensure that the VM's provisioning state is 'succeeded'.\n Refer to https://aka.ms/a2a-vm-state-issues to troubleshoot VM provisioning state issues.\n ", + "status": "Error" + }, + { + "code": "AzureVmIsNotInDesiredPowerState", + "message": "Azure virtual machine with Id (/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm2) is with power status 'deallocated'. To enable replication, VM's power status should be 'running'.", + "possibleCauses": "Virtual machine is not in desired state.", + "recommendedAction": "\n Ensure that the VM's power status is 'running'.\n You can check the power status in 'VM > Settings > Properties > Status' in Azure portal.\n ", + "status": "Error" + } + ] + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEvents_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEvents_Get.json new file mode 100644 index 000000000000..ddbd173c4f7b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEvents_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "eventName": "654b71d0-b2ce-4e6e-a861-98528d4bd375", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationEvents", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationEvents/VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "name": "VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "properties": { + "eventCode": "d9a07b07-c7b5-49ca-ab6c-6926596dfe47", + "description": "Virtual machine health is OK", + "eventType": "VmHealth", + "affectedObjectFriendlyName": "vm1", + "severity": "OK", + "timeOfOccurrence": "2017-05-02T14:28:28.5071531Z", + "fabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "eventSpecificDetails": { + "instanceType": "JobStatus" + }, + "healthErrors": [] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEvents_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEvents_List.json new file mode 100644 index 000000000000..4d6deeddac21 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationEvents_List.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationEvents", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationEvents/JobStatusMonitoringEvent;9091989892524070155_4ed6f1a6-9b6d-4048-9079-1307dd24b814", + "name": "JobStatusMonitoringEvent;9091989892524070155_4ed6f1a6-9b6d-4048-9079-1307dd24b814", + "properties": { + "eventCode": "d32574f6-f59e-4545-b5ac-bc88d545f089", + "description": "TestFailover - Failed", + "eventType": "JobStatus", + "affectedObjectFriendlyName": "vm1", + "severity": "Critical", + "timeOfOccurrence": "2017-05-02T16:00:33.0705652Z", + "fabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "eventSpecificDetails": { + "instanceType": "JobStatus" + }, + "healthErrors": [ + { + "errorCode": "499", + "errorMessage": "An internal error occurred.", + "possibleCauses": "The operation failed due to an internal error.", + "recommendedAction": "Retry the last action. If the issue persists, contact Support." + } + ] + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationEvents", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationEvents/VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "name": "VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "properties": { + "eventCode": "d9a07b07-c7b5-49ca-ab6c-6926596dfe47", + "description": "Virtual machine health is OK", + "eventType": "VmHealth", + "affectedObjectFriendlyName": "vm1", + "severity": "OK", + "timeOfOccurrence": "2017-05-02T14:28:28.5071531Z", + "fabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "eventSpecificDetails": { + "instanceType": "JobStatus" + }, + "healthErrors": [] + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_CheckConsistency.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_CheckConsistency.json new file mode 100644 index 000000000000..885c5a6ac396 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_CheckConsistency.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Create.json new file mode 100644 index 000000000000..5b59450a96c2 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Create.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "customDetails": { + "instanceType": "FabricSpecificCreationInput" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Delete.json new file mode 100644 index 000000000000..fc706363cd05 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Get.json new file mode 100644 index 000000000000..f22f0612b6e5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_List.json new file mode 100644 index 000000000000..2aa881e71aba --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_MigrateToAad.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_MigrateToAad.json new file mode 100644 index 000000000000..fc706363cd05 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_MigrateToAad.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Purge.json new file mode 100644 index 000000000000..fc706363cd05 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_Purge.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_ReassociateGateway.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_ReassociateGateway.json new file mode 100644 index 000000000000..44c21f85c579 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_ReassociateGateway.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "fabricName": "GRACE-V2A-1", + "api-version": "2023-08-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "failoverProcessServerRequest": { + "properties": { + "containerName": "cloud_1f3c15af-2256-4568-9e06-e1ef4f728f75", + "sourceProcessServerId": "AFA0EC54-1894-4E44-9CAB02DB8854B117", + "targetProcessServerId": "5D3ED340-85AE-C646-B338641E015DA405", + "vmsToMigrate": [ + "Vm1", + "Vm2" + ], + "updateType": "ServerLevel" + } + } + }, + "responses": { + "200": { + "body": { + "name": "bc15edf300344660d9c2965f5d9225593d99734f6580613c997033abc3512a56", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/bc15edf300344660d9c2965f5d9225593d99734f6580613c997033abc3512a56", + "properties": { + "friendlyName": "GRACE-V2A-1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "1f3c15af-2256-4568-9e06-e1ef4f728f75", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "VMware" + }, + "healthErrorDetails": [], + "health": "Normal" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_RenewCertificate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_RenewCertificate.json new file mode 100644 index 000000000000..2ea6ac8bcc60 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationFabrics_RenewCertificate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "renewCertificate": { + "properties": { + "renewCertificateType": "Cloud" + } + } + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationInfrastructure_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationInfrastructure_Delete.json new file mode 100644 index 000000000000..58a218441a0b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationInfrastructure_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Cancel.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Cancel.json new file mode 100644 index 000000000000..d0900ee2168c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Cancel.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "jobName": "2653c648-fc72-4316-86f3-fdf8eaa0066b", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2653c648-fc72-4316-86f3-fdf8eaa0066b", + "name": "2653c648-fc72-4316-86f3-fdf8eaa0066b", + "properties": { + "activityId": "bfbbf6dd-9cbb-4cbc-98a6-faecc8891579 ActivityId: 07cc35ca-b63f-4e42-83c9-81ae0191c322", + "scenarioName": "PlannedFailover", + "friendlyName": "Planned failover", + "state": "Cancelling", + "stateDescription": "Cancelling", + "tasks": [], + "errors": [], + "startTime": "2017-05-03T06:16:06.3235186Z", + "allowedActions": [], + "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "targetObjectName": "vm1", + "targetInstanceType": "ProtectionEntity", + "customDetails": { + "instanceType": "AsrJobDetails", + "affectedObjectDetails": { + "PrimaryVmId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "PrimaryVmName": "vm1", + "RecoveryVmId": "", + "RecoveryVmName": "vm1", + "ProtectionProfileId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0", + "PrimaryCloudId": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryCloudName": "cloud1", + "RecoveryCloudId": "d38048d4-b460-4791-8ece-108395ee8478", + "RecoveryCloudName": "Microsoft Azure", + "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryVmmName": "cloud1", + "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387", + "RecoveryVmmName": "Microsoft Azure", + "PrimaryFabricProviderId": "HyperVSite", + "RecoveryFabricProviderId": "Azure" + } + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Export.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Export.json new file mode 100644 index 000000000000..445d6bfa2dc1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Export.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "jobQueryParameter": { + "startTime": "2017-04-27T14:26:51.9161395Z", + "endTime": "2017-05-04T14:26:51.9161395Z", + "affectedObjectTypes": "", + "jobStatus": "" + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/37e0fc2b-13f2-4817-aafa-0cd807d46842", + "name": "37e0fc2b-13f2-4817-aafa-0cd807d46842", + "properties": { + "activityId": "36841d27-34f6-49ad-b572-e7dc263f100b-2017-05-04 14:26:47Z-Ibz ActivityId: c124df21-7661-4541-b32a-3c723ebbb045", + "scenarioName": "ExportJobs", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-05-04T14:33:42.2765562Z", + "endTime": "2017-05-04T14:33:43Z", + "allowedActions": [], + "targetObjectId": "", + "targetObjectName": "", + "targetInstanceType": "Other", + "customDetails": { + "blobUri": "", + "sasToken": "", + "instanceType": "ExportJobDetails", + "affectedObjectDetails": {} + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Get.json new file mode 100644 index 000000000000..0a6cca9ac9d0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "jobName": "58776d0b-3141-48b2-a377-9ad863eb160d", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/32ea4b9e-de62-49a1-b062-7864d5c3b897", + "name": "32ea4b9e-de62-49a1-b062-7864d5c3b897", + "properties": { + "activityId": "fc8e9c8f-0e76-4b6b-8e7e-d37c1b31eba0 ActivityId: c506b6ba-0711-411e-8b09-1f3f4dcb824b", + "scenarioName": "DeleteRecoveryPlan", + "friendlyName": "Delete a recovery plan", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [ + { + "taskId": "763326a2-01c9-4257-b2a1-0aac56465014", + "name": "DeleteRecoveryPlanTask", + "startTime": "2017-04-27T11:25:57.3029434Z", + "endTime": "2017-04-27T11:25:57.318574Z", + "allowedActions": [], + "friendlyName": "Delete a recovery plan task", + "state": "Succeeded", + "stateDescription": "Completed", + "taskType": "TaskDetails", + "customDetails": { + "instanceType": "ManualActionTaskDetails" + }, + "errors": [] + } + ], + "errors": [], + "startTime": "2017-04-27T11:25:56.800358Z", + "endTime": "2017-04-27T11:25:57Z", + "allowedActions": [], + "targetObjectId": "966c33bb-66e7-4567-9786-f80b0694f5f9", + "targetObjectName": "RPtest1", + "targetInstanceType": "RecoveryPlan", + "customDetails": { + "instanceType": "AsrJobDetails", + "affectedObjectDetails": { + "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryVmmName": "cloud1", + "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387", + "PrimaryFabricProviderId": "HyperVSite", + "RecoveryFabricProviderId": "Azure" + } + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_List.json new file mode 100644 index 000000000000..7b6df11a8a41 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_List.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/1557d73f-6244-491e-8f0b-d300f752240b", + "name": "1557d73f-6244-491e-8f0b-d300f752240b", + "properties": { + "scenarioName": "AddProtectionProfile", + "friendlyName": "Create replication policy", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-04-27T12:46:04.641851Z", + "endTime": "2017-04-27T12:46:11Z", + "allowedActions": [], + "targetObjectId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0", + "targetObjectName": "protectionprofile1", + "targetInstanceType": "ProtectionProfile" + } + }, + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/0236416a-7573-4913-a4a1-6a286fbb1ceb", + "name": "0236416a-7573-4913-a4a1-6a286fbb1ceb", + "properties": { + "scenarioName": "RegisterDra", + "friendlyName": "Register the Azure Site Recovery Provider", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-05-02T14:07:19.2784338Z", + "endTime": "2017-05-02T14:07:21Z", + "allowedActions": [], + "targetObjectId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "targetObjectName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "targetInstanceType": "Server" + } + }, + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2438d560-80f0-420b-839e-5c8ee0af90a1", + "name": "2438d560-80f0-420b-839e-5c8ee0af90a1", + "properties": { + "scenarioName": "CreateSite", + "friendlyName": "Create a site", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-05-02T05:56:14.569095Z", + "endTime": "2017-05-02T05:56:16Z", + "allowedActions": [], + "targetObjectId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "targetObjectName": "cloud1", + "targetInstanceType": "Server" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Restart.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Restart.json new file mode 100644 index 000000000000..b82d2ca2e125 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Restart.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "jobName": "0664564c-353e-401a-ab0c-722257c10e25", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/42c7d13b-790c-4609-8e0b-0936f1c5e5fb", + "name": "42c7d13b-790c-4609-8e0b-0936f1c5e5fb", + "properties": { + "activityId": "2443a5b4-e675-499f-8983-4126ea0e232c ActivityId: 2a776896-5e56-470b-af55-3c981283c4bc", + "scenarioName": "RestartJob", + "friendlyName": "Restart job", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [ + { + "taskId": "RemediateWfTask", + "name": "RemediateTask", + "startTime": "2017-05-03T10:45:13.5677237Z", + "endTime": "2017-05-03T10:45:13.6458467Z", + "allowedActions": [], + "friendlyName": "Restarting job", + "state": "Succeeded", + "stateDescription": "Completed", + "taskType": "TaskDetails", + "customDetails": { + "instanceType": "ManualActionTaskDetails" + }, + "errors": [] + } + ], + "errors": [], + "startTime": "2017-05-03T10:45:12.1320757Z", + "endTime": "2017-05-03T10:45:14Z", + "allowedActions": [], + "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "targetObjectName": "vm1", + "targetInstanceType": "ProtectionEntity", + "customDetails": { + "instanceType": "AsrJobDetails", + "affectedObjectDetails": {} + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Resume.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Resume.json new file mode 100644 index 000000000000..7dea30a952a3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationJobs_Resume.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "jobName": "58776d0b-3141-48b2-a377-9ad863eb160d", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "resumeJobParams": { + "properties": { + "comments": " " + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/58776d0b-3141-48b2-a377-9ad863eb160d", + "name": "58776d0b-3141-48b2-a377-9ad863eb160d", + "properties": { + "activityId": "1b808dfe-0451-44ac-894c-c7270711cd8c ActivityId: 9f6f849e-922a-43ec-a7a6-0be45fc85c56", + "scenarioName": "TestFailover", + "friendlyName": "Test failover", + "state": "Suspended", + "stateDescription": "WaitingForStopTestFailover", + "tasks": [], + "errors": [], + "startTime": "2017-04-25T09:57:57.0357829Z", + "allowedActions": [ + "Cancel", + "Resume" + ], + "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "targetObjectName": "vm1", + "targetInstanceType": "ProtectionEntity", + "customDetails": { + "instanceType": "TestFailoverJobDetails", + "testFailoverStatus": "Completed", + "comments": " ", + "networkName": "vnetavrai", + "networkFriendlyName": "vnetavrai", + "networkType": "VmNetworkAsInput", + "protectedItemDetails": [ + { + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "friendlyName": "vm1", + "testVmName": "vm1-test", + "testVmFriendlyName": "vm1-test", + "networkConnectionStatus": "Connected", + "networkFriendlyName": "vnetavrai", + "subnet": "Subnet1" + } + ], + "affectedObjectDetails": { + "PrimaryVmId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "PrimaryVmName": "vm1", + "RecoveryVmId": "", + "RecoveryVmName": "vm1", + "ProtectionProfileId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0", + "PrimaryCloudId": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryCloudName": "cloud1", + "RecoveryCloudId": "d38048d4-b460-4791-8ece-108395ee8478", + "RecoveryCloudName": "Microsoft Azure", + "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryVmmName": "cloud1", + "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387", + "RecoveryVmmName": "Microsoft Azure", + "PrimaryFabricProviderId": "HyperVSite", + "RecoveryFabricProviderId": "Azure" + } + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationLogicalNetworks_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationLogicalNetworks_Get.json new file mode 100644 index 000000000000..fd45238195fa --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationLogicalNetworks_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "logicalNetworkName": "87ab394f-165f-4aa9-bd84-b018500b4509", + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationLogicalNetworks", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationLogicalNetworks/53f5a278-ae85-4001-bd5f-f6a02e1f579d", + "name": "87ab394f-165f-4aa9-bd84-b018500b4509", + "properties": { + "friendlyName": "corp", + "networkVirtualizationStatus": "NetworkVirtualizationNotEnabled", + "logicalNetworkUsage": "NotUsedAsPrivateNetworkForTestFailover", + "logicalNetworkDefinitionsStatus": "LogicalNetworkDefinitionsNotIsolated" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json new file mode 100644 index 000000000000..4cf5611b039a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationLogicalNetworks", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationLogicalNetworks/53f5a278-ae85-4001-bd5f-f6a02e1f579d", + "name": "87ab394f-165f-4aa9-bd84-b018500b4509", + "properties": { + "friendlyName": "corp", + "networkVirtualizationStatus": "NetworkVirtualizationNotEnabled", + "logicalNetworkUsage": "NotUsedAsPrivateNetworkForTestFailover", + "logicalNetworkDefinitionsStatus": "LogicalNetworkDefinitionsNotIsolated" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationLogicalNetworks", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationLogicalNetworks/87ab394f-165f-4aa9-bd84-b018500b4509", + "name": "53f5a278-ae85-4001-bd5f-f6a02e1f579d", + "properties": { + "friendlyName": "LN-VLANNetwork-4", + "networkVirtualizationStatus": "NetworkVirtualizationNotEnabled", + "logicalNetworkUsage": "NotUsedAsPrivateNetworkForTestFailover", + "logicalNetworkDefinitionsStatus": "LogicalNetworkDefinitionsIsolated" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Create.json new file mode 100644 index 000000000000..efef27b37d33 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Create.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "disksToInclude": [ + { + "diskId": "disk1", + "isOSDisk": "true", + "logStorageAccountId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.Storage/storageAccounts/logStorageAccount1", + "logStorageAccountSasSecretName": "logStorageSas" + } + ], + "vmwareMachineId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.OffAzure/VMwareSites/vmwaresite1/machines/virtualmachine1", + "targetNetworkId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1", + "targetResourceGroupId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1", + "snapshotRunAsAccountId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.OffAzure/VMwareSites/vmwaresite1/runasaccounts/snapshotRunAsAccount1", + "dataMoverRunAsAccountId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.OffAzure/VMwareSites/vmwaresite1/runasaccounts/dataMoverRunAsAccount1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Delete.json new file mode 100644 index 000000000000..3f02b40f4aed --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Get.json new file mode 100644 index 000000000000..eede9d707a8e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_List.json new file mode 100644 index 000000000000..dc53bb984873 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..cb831522957d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Migrate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Migrate.json new file mode 100644 index 000000000000..c32e9fab0442 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Migrate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "migrateInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "performShutdown": "true" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_PauseReplication.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_PauseReplication.json new file mode 100644 index 000000000000..213a967a0619 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_PauseReplication.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "pauseReplicationInput": { + "properties": { + "instanceType": "VMwareCbt" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "ProtectionSuspended", + "migrationStateDescription": "Paused", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "DisableMigration" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_ResumeReplication.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_ResumeReplication.json new file mode 100644 index 000000000000..02da1d165f93 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_ResumeReplication.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "resumeReplicationInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "deleteMigrationResources": "false" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "ResumeInitiated", + "migrationStateDescription": "Resuming", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "DisableMigration" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Resync.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Resync.json new file mode 100644 index 000000000000..3918d6b385cb --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Resync.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "skipCbtReset": "true" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_TestMigrate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_TestMigrate.json new file mode 100644 index 000000000000..5a86534c751d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_TestMigrate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "testMigrateInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "recoveryPointId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/9e737191-317e-43d0-8c83-e32ac3b34686", + "networkId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json new file mode 100644 index 000000000000..f9f6b9c2dcc7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "testMigrateCleanupInput": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Update.json new file mode 100644 index 000000000000..472a844165a6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationMigrationItems_Update.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Create.json new file mode 100644 index 000000000000..90826e39066c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2023-08-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap", + "input": { + "properties": { + "recoveryFabricName": "Microsoft Azure", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "fabricSpecificDetails": { + "instanceType": "VmmToAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Delete.json new file mode 100644 index 000000000000..2a3d416d6206 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2023-08-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Get.json new file mode 100644 index 000000000000..4509406a2466 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2023-08-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_List.json new file mode 100644 index 000000000000..2170ecbd54ce --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServicesBVTD2/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServicesBVTD2/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServicesBVTD2/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServicesBVTD2/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json new file mode 100644 index 000000000000..ca8114214358 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2023-08-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Update.json new file mode 100644 index 000000000000..b0bd3e1cfc15 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworkMappings_Update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2023-08-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap", + "input": { + "properties": { + "recoveryFabricName": "Microsoft Azure", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai2", + "fabricSpecificDetails": { + "instanceType": "VmmToAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai2", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai2", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworks_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworks_Get.json new file mode 100644 index 000000000000..b6c2158e8044 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworks_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2023-08-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "93ce99d7-1219-4914-aa61-73fe5023988e" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/93ce99d7-1219-4914-aa61-73fe5023988e", + "name": "93ce99d7-1219-4914-aa61-73fe5023988e", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_VLan", + "networkType": "NoIsolation" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworks_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworks_List.json new file mode 100644 index 000000000000..eb4270605ffd --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworks_List.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/93ce99d7-1219-4914-aa61-73fe5023988e", + "name": "93ce99d7-1219-4914-aa61-73fe5023988e", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_VLan", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "name": "b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_NoIso", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "name": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "corp", + "networkType": "NoIsolation" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworks_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworks_ListByReplicationFabrics.json new file mode 100644 index 000000000000..feafbd5d76b7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationNetworks_ListByReplicationFabrics.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2023-08-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/93ce99d7-1219-4914-aa61-73fe5023988e", + "name": "93ce99d7-1219-4914-aa61-73fe5023988e", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_VLan", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "name": "b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_NoIso", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "name": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "corp", + "networkType": "NoIsolation" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Create.json new file mode 100644 index 000000000000..7550f185a7be --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Create.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "providerSpecificInput": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Delete.json new file mode 100644 index 000000000000..7fdd3dfbbdec --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Get.json new file mode 100644 index 000000000000..172942734ab1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_List.json new file mode 100644 index 000000000000..a6dc008a289c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Update.json new file mode 100644 index 000000000000..21001a687bd3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationPolicies_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "replicationProviderSettings": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectableItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectableItems_Get.json new file mode 100644 index 000000000000..d589a384e18a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectableItems_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "protectableItemName": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "name": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems", + "properties": { + "friendlyName": "vm2", + "protectionStatus": "Unprotected", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "protectionReadinessErrors": [], + "supportedReplicationProviders": [ + "HyperVReplicaAzure" + ], + "customDetails": { + "instanceType": "ReplicationGroupDetails" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..9da0c563c698 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "name": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems", + "properties": { + "friendlyName": "vm2", + "protectionStatus": "Unprotected", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "protectionReadinessErrors": [], + "supportedReplicationProviders": [ + "HyperVReplicaAzure" + ], + "customDetails": { + "instanceType": "ReplicationGroupDetails" + } + } + }, + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems", + "properties": { + "friendlyName": "vm1", + "protectionStatus": "Unprotected", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "protectionReadinessErrors": [], + "supportedReplicationProviders": [ + "HyperVReplicaAzure" + ], + "customDetails": { + "instanceType": "ReplicationGroupDetails" + } + } + } + ], + "nextLink": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems?api-version=2021-06-01&%24skipToken=ReplicationGroup%3aBegin" + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_AddDisks.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_AddDisks.json new file mode 100644 index 000000000000..fa9aa5af8375 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_AddDisks.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "addDisksInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "A2A", + "vmDisks": [ + { + "diskUri": "https://vmstorage.blob.core.windows.net/vhds/datadisk1.vhd", + "recoveryAzureStorageAccountId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourcegroups/recoveryResource/providers/Microsoft.Storage/storageAccounts/recoverystorage", + "primaryStagingAzureStorageAccountId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourcegroups/primaryResource/providers/Microsoft.Storage/storageAccounts/vmcachestorage" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/6d2940f9-4c34-5989-9f56-1243a6e76ecf", + "primaryFabricFriendlyName": "cloud1", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "cloud2", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "primaryProtectionContainerFriendlyName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "recoveryProtectionContainerFriendlyName": "cloud_81224fc6-f326-5d35-96de-fbf51efb3188", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "RepairReplication", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/A2APolicy", + "policyFriendlyName": "A2APolicy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1752-12-31T19:31:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "A2A" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2/replicationProtectionContainers/cloud_81224fc6-f326-5d35-96de-fbf51efb3188" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json new file mode 100644 index 000000000000..7f185a24f2df --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "applyRecoveryPointInput": { + "properties": { + "recoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/e4d05fe9-5dfd-47be-b50b-aad306b2802d", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "UnplannedFailoverCommitPendingStatesBegin", + "protectionStateDescription": "Failover completed", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Critical", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T08:42:33.0996129Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/e4d05fe9-5dfd-47be-b50b-aad306b2802d", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Create.json new file mode 100644 index 000000000000..0e59826b08af --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Create.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Delete.json new file mode 100644 index 000000000000..2501a403d4bd --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Delete.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "disableProtectionInput": { + "properties": { + "replicationProviderInput": { + "instanceType": "DisableProtectionProviderSpecificInput" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_FailoverCancel.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_FailoverCancel.json new file mode 100644 index 000000000000..a5117e792118 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_FailoverCancel.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "cloud1", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "cloud1", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "DisableProtection" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2021-02-24T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "1601-01-01T00:00:00.0000000Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "2021-02-24T07:17:23.1358752Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "InMageRcmFailback" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_FailoverCommit.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_FailoverCommit.json new file mode 100644 index 000000000000..a4ca0b1d5669 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_FailoverCommit.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "PlannedFailoverStatesBegin", + "protectionStateDescription": "Planned failover committed", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "DisableProtection", + "Failback" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Get.json new file mode 100644 index 000000000000..e6492ce883f7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_List.json new file mode 100644 index 000000000000..46bfd1dd9e16 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_List.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..490d57016f56 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_PlannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_PlannedFailover.json new file mode 100644 index 000000000000..c7139657b0f3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_PlannedFailover.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "failoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "PlannedFailoverCommitRequired", + "protectionStateDescription": "Planned failover finished", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Purge.json new file mode 100644 index 000000000000..cf61594257fd --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Purge.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_RemoveDisks.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_RemoveDisks.json new file mode 100644 index 000000000000..cae2f1103d9b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_RemoveDisks.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "removeDisksInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "A2A", + "vmDisksUris": [ + "https://vmstorage.blob.core.windows.net/vhds/datadisk1.vhd" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/6d2940f9-4c34-5989-9f56-1243a6e76ecf", + "primaryFabricFriendlyName": "cloud1", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "cloud2", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "primaryProtectionContainerFriendlyName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "recoveryProtectionContainerFriendlyName": "cloud_81224fc6-f326-5d35-96de-fbf51efb3188", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "RepairReplication", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/A2APolicy", + "policyFriendlyName": "A2APolicy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1752-12-31T19:31:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "A2A" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2/replicationProtectionContainers/cloud_81224fc6-f326-5d35-96de-fbf51efb3188" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_RepairReplication.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_RepairReplication.json new file mode 100644 index 000000000000..08f23469284d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_RepairReplication.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Reprotect.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Reprotect.json new file mode 100644 index 000000000000..1e7d2a22ad8b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Reprotect.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "reprotectInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json new file mode 100644 index 000000000000..4e7c5c9c9873 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "resolveHealthInput": { + "properties": { + "healthErrors": [ + { + "healthErrorId": "3:8020" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/6d2940f9-4c34-5989-9f56-1243a6e76ecf", + "primaryFabricFriendlyName": "cloud1", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "cloud2", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "primaryProtectionContainerFriendlyName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "recoveryProtectionContainerFriendlyName": "cloud_81224fc6-f326-5d35-96de-fbf51efb3188", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "RepairReplication", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/A2APolicy", + "policyFriendlyName": "A2APolicy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1752-12-31T19:31:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "A2A" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2/replicationProtectionContainers/cloud_81224fc6-f326-5d35-96de-fbf51efb3188" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_SwitchProvider.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_SwitchProvider.json new file mode 100644 index 000000000000..c2810797205e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_SwitchProvider.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "switchProviderInput": { + "properties": { + "targetInstanceType": "InMageRcm", + "providerSpecificDetails": { + "instanceType": "InMageAzureV2", + "targetVaultID": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault2", + "targetFabricID": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "targetApplianceID": "5efaa202-e958-435e-8171-706bf735fcc4" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "PlannedFailoverCommitRequired", + "protectionStateDescription": "Planned failover finished", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_TestFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_TestFailover.json new file mode 100644 index 000000000000..11b2521a68ff --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_TestFailover.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "testfailoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "networkType": "VmNetworkAsInput", + "networkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Cleanup test failover pending", + "activeLocation": "Primary", + "testFailoverState": "WaitingForCompletion", + "testFailoverStateDescription": "Waiting for user input", + "allowedOperations": [ + "TestFailoverCleanup" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "TestFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2838f9b4-2609-4f76-a7e9-07e6387c5e98", + "startTime": "2017-04-25T09:57:57.0357829Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/0689d0d0-3518-4793-8c98-c26bf94526f6", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json new file mode 100644 index 000000000000..67707cb4f791 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "cleanupInput": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_UnplannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_UnplannedFailover.json new file mode 100644 index 000000000000..b80ed22d88d4 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_UnplannedFailover.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "failoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "sourceSiteOperations": "NotRequired", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "UnplannedFailoverCommitPendingStatesBegin", + "protectionStateDescription": "Failover completed", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T08:42:33.0996129Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b2c7b208-0999-40a4-804f-8ee1019c8f76", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Update.json new file mode 100644 index 000000000000..3498dc1ab6b2 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_Update.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "updateProtectionInput": { + "properties": { + "recoveryAzureVMName": "vm1", + "recoveryAzureVMSize": "Basic_A0", + "selectedRecoveryAzureNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "vmNics": [ + { + "nicId": "TWljcm9zb2Z0OkY4NDkxRTRGLTgxN0EtNDBERC1BOTBDLUFGNzczOTc4Qzc1Qlw3NjAwMzMxRS03NDk4LTQ0QTQtQjdDNy0xQjY1NkJDREQ1MkQ=", + "selectionType": "SelectedByUser", + "ipConfigs": [ + { + "ipConfigName": "ipconfig1", + "isPrimary": true, + "recoverySubnetName": "subnet1", + "recoveryStaticIPAddress": "10.0.2.46" + } + ] + } + ], + "licenseType": "WindowsServer", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_UpdateAppliance.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_UpdateAppliance.json new file mode 100644 index 000000000000..f554d2953a21 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_UpdateAppliance.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "idclab-vcen67_50158124-8857-3e08-0893-2ddf8ebb8c1f", + "protectionContainerName": "Ayan-0106-SA-Vaultreplicationcontainer", + "fabricName": "Ayan-0106-SA-Vaultreplicationfabric", + "resourceName": "Ayan-0106-SA-Vault", + "resourceGroupName": "Ayan-0106-SA-RG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "applianceUpdateInput": { + "properties": { + "targetApplianceId": "", + "providerSpecificDetails": { + "instanceType": "InMageRcm", + "runAsAccountId": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationFabrics/Ayan-0106-SA-Vaultreplicationfabric/replicationProtectionContainers/Ayan-0106-SA-Vaultreplicationcontainer/replicationProtectedItems/idclab-vcen67_50158124-8857-3e08-0893-2ddf8ebb8c1f", + "name": "idclab-vcen67_50158124-8857-3e08-0893-2ddf8ebb8c1f", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "Ayan-RHEL7-Test2", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationFabrics/Ayan-0106-SA-Vaultreplicationfabric/replicationRecoveryServicesProviders/a552cf2d-bbb3-4d78-8145-e1992ecb31d1", + "primaryFabricFriendlyName": "Ayan-0106-SA-Vaultreplicationfabric", + "primaryFabricProvider": "InMageRcmFabric", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "Ayan-0106-SA-Vaultreplicationcontainer", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationPolicies/24-hour-replication-policy", + "policyFriendlyName": "24-hour-replication-policy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "InMageRcm" + }, + "recoveryContainerId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478", + "eventCorrelationId": "fb40d161-cffd-44d9-a252-0b7978e1f73c" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_UpdateMobilityService.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_UpdateMobilityService.json new file mode 100644 index 000000000000..01dadf5f07d7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectedItems_UpdateMobilityService.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "79dd20ab-2b40-11e7-9791-0050568f387e", + "protectionContainerName": "cloud_c6780228-83bd-4f3e-a70e-cb46b7da33a0", + "fabricName": "WIN-JKKJ31QI8U2", + "resourceName": "WCUSVault", + "resourceGroupName": "wcusValidations", + "subscriptionId": "b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c", + "updateMobilityServiceRequest": { + "properties": { + "runAsAccountId": "2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "79dd20ab-2b40-11e7-9791-0050568f387e", + "id": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d70b0326a201008a953505ef271dc908e5e23468bc7356862ea178696f5f15c7/replicationProtectionContainers/cloud_c6780228-83bd-4f3e-a70e-cb46b7da33a0/replicationProtectedItems/79dd20ab-2b40-11e7-9791-0050568f387e", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "MMR-LIN-V2A-3", + "protectedItemType": "", + "protectableItemId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d70b0326a201008a953505ef271dc908e5e23468bc7356862ea178696f5f15c7/replicationProtectionContainers/cloud_c6780228-83bd-4f3e-a70e-cb46b7da33a0/replicationProtectableItems/79dd20ab-2b40-11e7-9791-0050568f387e", + "recoveryServicesProviderId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d70b0326a201008a953505ef271dc908e5e23468bc7356862ea178696f5f15c7/replicationRecoveryServicesProviders/c6780228-83bd-4f3e-a70e-cb46b7da33a0", + "primaryFabricFriendlyName": "WIN-JKKJ31QI8U2", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "WIN-JKKJ31QI8U2", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationPolicies/MadhaviPolicyNew", + "policyFriendlyName": "MadhaviPolicyNew", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "InMageAzureV2" + }, + "recoveryContainerId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Create.json new file mode 100644 index 000000000000..2ba25814d893 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "creationInput": { + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "providerSpecificInput": { + "instanceType": "ReplicationProviderSpecificContainerMappingInput" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Delete.json new file mode 100644 index 000000000000..c9c3b495d0a8 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Delete.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "removalInput": { + "properties": { + "providerSpecificInput": {} + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Get.json new file mode 100644 index 000000000000..1f2b6bc8f964 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_List.json new file mode 100644 index 000000000000..cd56ebce0ef4 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..86629b282d4d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Purge.json new file mode 100644 index 000000000000..1b977c407563 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Purge.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Update.json new file mode 100644 index 000000000000..fed94c637197 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainerMappings_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "updateInput": { + "properties": { + "providerSpecificInput": { + "instanceType": "A2A", + "agentAutoUpdateStatus": "Enabled", + "automationAccountArmId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/automationrg1/providers/Microsoft.Automation/automationAccounts/automationaccount1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "A2A", + "agentAutoUpdateStatus": "Enabled", + "automationAccountArmId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/automationrg1/providers/Microsoft.Automation/automationAccounts/automationaccount1", + "scheduleName": "cloud1protectionprofile1_a85ea38f-62a8-471b-93cc-69b74fd9578c", + "jobScheduleName": "ffd503ec-5f88-4b58-97c8-841466e7aa47" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_Create.json new file mode 100644 index 000000000000..020fe0d20026 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_Create.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "creationInput": { + "properties": { + "providerSpecificInput": [ + { + "instanceType": "ReplicationProviderSpecificContainerCreationInput" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_Delete.json new file mode 100644 index 000000000000..190a806657ed --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json new file mode 100644 index 000000000000..d6888a534979 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "protectionContainerName": "cloud_7328549c-5c37-4459-a3c2-e35f9ef6893c", + "fabricName": "V2A-W2K12-660", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "discoverProtectableItemRequest": { + "properties": { + "friendlyName": "Test", + "ipAddress": "10.150.2.3", + "osType": "Windows" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationProtectionContainers/cloud_7328549c-5c37-4459-a3c2-e35f9ef6893c", + "name": "cloud_7328549c-5c37-4459-a3c2-e35f9ef6893c", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "V2A-W2K12-660", + "friendlyName": "V2A-W2K12-660", + "fabricType": "VMware", + "protectedItemCount": 2, + "pairingStatus": "Paired", + "role": "Primary" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_Get.json new file mode 100644 index 000000000000..b08ab415bff1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_List.json new file mode 100644 index 000000000000..e09e2c3f1da5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json new file mode 100644 index 000000000000..7d99d013c9d0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_SwitchProtection.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_SwitchProtection.json new file mode 100644 index 000000000000..901e03cffd3e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionContainers_SwitchProtection.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "protectionContainerName": "CentralUSCancloud", + "fabricName": "CentralUSCanSite", + "resourceName": "priyanponeboxvault", + "resourceGroupName": "priyanprg", + "subscriptionId": "42195872-7e70-4f8a-837f-84b28ecbb78b", + "switchInput": { + "properties": { + "replicationProtectedItemName": "a2aSwapOsVm", + "providerSpecificDetails": { + "instanceType": "A2A" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/42195872-7e70-4f8a-837f-84b28ecbb78b/resourceGroups/priyanprg/providers/Microsoft.RecoveryServices/vaults/priyanponeboxvault/replicationFabrics/EUSCanSite/replicationProtectionContainers/euscancloud", + "name": "euscancloud", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "East US 2 EUAP", + "friendlyName": "euscancloud", + "fabricType": "Azure", + "protectedItemCount": 0, + "pairingStatus": "Paired", + "role": "Primary" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/42195872-7e70-4f8a-837f-84b28ecbb78b/resourceGroups/priyanprg/providers/Microsoft.RecoveryServices/vaults/priyanponeboxvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/42195872-7e70-4f8a-837f-84b28ecbb78b/resourceGroups/priyanprg/providers/Microsoft.RecoveryServices/vaults/priyanponeboxvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionIntents_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionIntents_Create.json new file mode 100644 index 000000000000..b42a3730de29 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionIntents_Create.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "intentObjectName": "vm1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "509099b2-9d2c-4636-b43e-bd5cafb6be69", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "A2A", + "fabricObjectId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne/providers/Microsoft.Compute/virtualMachines/vmPpgAv5", + "primaryLocation": "eastUs2", + "recoveryLocation": "westus2", + "recoverySubscriptionId": "ed5bcdf6-d61e-47bd-8ea9-f2bd379a2640", + "recoveryAvailabilityType": "Single", + "recoveryResourceGroupId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne-asr" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/2007vttp/providers/Microsoft.RecoveryServices/vaults/tp2007vt/replicationProtectionIntents/vm1", + "name": "vm1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionIntents", + "properties": { + "friendlyName": "vm1", + "jobId": "/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/a2acl-rg-vault-prod-gip-ccy/providers/Microsoft.RecoveryServices/vaults/a2acl-vault-prod-gip-ccy/replicationJobs/02004ea7-d498-4bb4-bdeb-cdb611706867", + "jobState": "InProgress", + "providerSpecificDetails": { + "instanceType": "A2A", + "recoveryAvailabilityType": "Single" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionIntents_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionIntents_Get.json new file mode 100644 index 000000000000..c51eb63eae29 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionIntents_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "intentObjectName": "vm1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "509099b2-9d2c-4636-b43e-bd5cafb6be69" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/2007vttp/providers/Microsoft.RecoveryServices/vaults/tp2007vt/replicationProtectionIntents/vm1", + "name": "vm1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionIntents", + "properties": { + "friendlyName": "vm1", + "jobId": "/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/a2acl-rg-vault-prod-gip-ccy/providers/Microsoft.RecoveryServices/vaults/a2acl-vault-prod-gip-ccy/replicationJobs/02004ea7-d498-4bb4-bdeb-cdb611706867", + "jobState": "InProgress", + "providerSpecificDetails": { + "instanceType": "A2A", + "fabricObjectId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne/providers/Microsoft.Compute/virtualMachines/vmPpgAv5", + "primaryLocation": "eastUs2", + "recoveryLocation": "westus2", + "recoverySubscriptionId": "ed5bcdf6-d61e-47bd-8ea9-f2bd379a2640", + "recoveryAvailabilityType": "Single" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionIntents_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionIntents_List.json new file mode 100644 index 000000000000..0952f65e9b9f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationProtectionIntents_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "2007vttp", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "509099b2-9d2c-4636-b43e-bd5cafb6be69" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/2007vttp/providers/Microsoft.RecoveryServices/vaults/tp2007vt/replicationProtectionIntents/vm1", + "name": "vm1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionIntents", + "properties": { + "friendlyName": "vm1", + "jobId": "/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/a2acl-rg-vault-prod-gip-ccy/providers/Microsoft.RecoveryServices/vaults/a2acl-vault-prod-gip-ccy/replicationJobs/02004ea7-d498-4bb4-bdeb-cdb611706867", + "jobState": "InProgress", + "providerSpecificDetails": { + "instanceType": "A2A", + "fabricObjectId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne/providers/Microsoft.Compute/virtualMachines/vmPpgAv5", + "primaryLocation": "eastUs2", + "recoveryLocation": "westus2", + "recoverySubscriptionId": "ed5bcdf6-d61e-47bd-8ea9-f2bd379a2640", + "recoveryAvailabilityType": "Single" + } + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/2007vttp/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Create.json new file mode 100644 index 000000000000..3de25f1b0029 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Create.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "recoveryFabricId": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "groups": [ + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Delete.json new file mode 100644 index 000000000000..f4ba9e36581a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_FailoverCancel.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_FailoverCancel.json new file mode 100644 index 000000000000..65f728105c51 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_FailoverCancel.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "recoveryFabricFriendlyName": "cloud1", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "InMageRcmFailback" + ], + "allowedOperations": [ + "PlannedFailover" + ], + "lastPlannedFailoverTime": "2021-02-24T07:33:49.1372448Z", + "lastTestFailoverTime": "1601-01-01T00:00:00.0000000Z", + "currentScenario": { + "scenarioName": "CancelFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/5276a7bc-12a3-43a1-bc53-9bf80e0be87b", + "startTime": "2021-02-24T08:52:42.1587592Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_FailoverCommit.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_FailoverCommit.json new file mode 100644 index 000000000000..5378cf6a4fc4 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_FailoverCommit.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "CommitFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/5276a7bc-12a3-43a1-bc53-9bf80e0be87b", + "startTime": "2017-04-27T08:52:42.1587592Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Get.json new file mode 100644 index 000000000000..713f3b42c053 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Get.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_List.json new file mode 100644 index 000000000000..44e2c52bc3f4 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [] + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_PlannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_PlannedFailover.json new file mode 100644 index 000000000000..841ccba70181 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_PlannedFailover.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "providerSpecificDetails": [ + { + "instanceType": "HyperVReplicaAzure" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover", + "Commit" + ], + "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "PlannedFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/d4821a53-90da-4fcb-bc11-a280d13e3350", + "startTime": "2017-04-27T07:34:02.6176524Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Reprotect.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Reprotect.json new file mode 100644 index 000000000000..33ff5bc74f6f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Reprotect.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "lastPlannedFailoverTime": "2017-04-27T08:58:35.9062813Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "ReverseReplication", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/edf01dfb-b649-4802-91e4-3d55ce3bebf0", + "startTime": "2017-04-27T09:52:16.9818841Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_TestFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_TestFailover.json new file mode 100644 index 000000000000..e896f0eecaeb --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_TestFailover.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "networkType": "VmNetworkAsInput", + "networkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "providerSpecificDetails": [ + { + "instanceType": "HyperVReplicaAzure" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "TestFailoverCleanup" + ], + "currentScenario": { + "scenarioName": "TestFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/d40bfb40-aaaa-4c0d-87d3-41b15439a84b", + "startTime": "2017-04-27T07:00:58.8191916Z" + }, + "currentScenarioStatus": "Suspended", + "currentScenarioStatusDescription": "WaitingForStopTestFailover", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json new file mode 100644 index 000000000000..dd4ad720ddcb --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "TestFailoverCleanup", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/4ae8eaa8-a384-42cb-9768-152cb5b8a1ff", + "startTime": "2017-04-27T07:10:52.8424747Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json new file mode 100644 index 000000000000..9ee111c8eed8 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "sourceSiteOperations": "Required", + "providerSpecificDetails": [ + { + "instanceType": "HyperVReplicaAzure" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover", + "Commit" + ], + "lastPlannedFailoverTime": "2017-04-27T08:58:35.9062813Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "UnplannedFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/60b84068-9adb-4867-a49d-88be40bff14b", + "startTime": "2017-04-27T10:03:03.2206946Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Update.json new file mode 100644 index 000000000000..f3f878cc121d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryPlans_Update.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Create.json new file mode 100644 index 000000000000..e07a21e118a3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Create.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "providerName": "vmwareprovider1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "addProviderInput": { + "properties": { + "machineName": "vmwareprovider1", + "authenticationIdentityInput": { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "f66fce08-c0c6-47a1-beeb-0ede5ea94f90", + "objectId": "141360b8-5686-4240-a027-5e24e6affeba", + "audience": "https://microsoft.onmicrosoft.com/cf19e349-644c-4c6a-bcae-9c8f35357874", + "aadAuthority": "https://login.microsoftonline.com" + }, + "resourceAccessIdentityInput": { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "f66fce08-c0c6-47a1-beeb-0ede5ea94f90", + "objectId": "141360b8-5686-4240-a027-5e24e6affeba", + "audience": "https://microsoft.onmicrosoft.com/cf19e349-644c-4c6a-bcae-9c8f35357874", + "aadAuthority": "https://login.microsoftonline.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/vmwareprovider1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "vmwareprovider1", + "properties": { + "fabricType": "VMwareV2", + "friendlyName": "vmwareprovider1", + "providerVersion": "5.1.3688.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "vmwarefabric1", + "lastHeartBeat": "2017-04-27T09:16:04.9405768Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Delete.json new file mode 100644 index 000000000000..05e11c2d831c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Get.json new file mode 100644 index 000000000000..5908946e69dc --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:16:04.9405768Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_List.json new file mode 100644 index 000000000000..5f22a5ea816b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:06:38.2728455Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json new file mode 100644 index 000000000000..a61eb12cdc71 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:06:38.2728455Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Purge.json new file mode 100644 index 000000000000..05e11c2d831c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_Purge.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json new file mode 100644 index 000000000000..9589f4ed492a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:48:36.6528303Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_Create.json new file mode 100644 index 000000000000..5dfaf2202a7e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_Create.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "storageClassificationMappingName": "testStorageMapping", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "pairingInput": { + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_Delete.json new file mode 100644 index 000000000000..f50a083641a5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "storageClassificationMappingName": "testStorageMapping", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_Get.json new file mode 100644 index 000000000000..972087f784c4 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "storageClassificationMappingName": "testStorageMapping", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_List.json new file mode 100644 index 000000000000..66785bc78819 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json new file mode 100644 index 000000000000..107cde818e5f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassifications_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassifications_Get.json new file mode 100644 index 000000000000..021f2352744a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassifications_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications", + "name": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "properties": { + "friendlyName": "testStorageClassification" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassifications_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassifications_List.json new file mode 100644 index 000000000000..ea834fb07fc8 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassifications_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications", + "name": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "properties": { + "friendlyName": "testStorageClassification" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json new file mode 100644 index 000000000000..ba2cab68e2f6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications", + "name": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "properties": { + "friendlyName": "testStorageClassification" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultHealth_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultHealth_Get.json new file mode 100644 index 000000000000..6461ce861ae1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultHealth_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultHealth", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultHealth/Default", + "properties": { + "vaultErrors": [], + "protectedItemsHealth": { + "resourceCount": 6, + "issues": [ + { + "summaryCode": "10008", + "category": "Replication", + "severity": "Error", + "summaryMessage": "RPO Throttled", + "affectedResourceType": "replicationProtectedItems", + "affectedResourceSubtype": "", + "affectedResourceCorrelationIds": [ + "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "c183865e-6077-46f2-a3b1-ceb0a4c3751e" + ] + } + ] + }, + "fabricsHealth": { + "resourceCount": 1, + "issues": [] + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultHealth_Refresh.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultHealth_Refresh.json new file mode 100644 index 000000000000..89a776439743 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultHealth_Refresh.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultHealth", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultHealth/Default", + "properties": { + "vaultErrors": [], + "protectedItemsHealth": { + "resourceCount": 2, + "issues": [] + }, + "fabricsHealth": { + "resourceCount": 1, + "issues": [] + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultSetting_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultSetting_Create.json new file mode 100644 index 000000000000..8656e714fb52 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultSetting_Create.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "vaultSettingName": "default", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultSettings/default", + "name": "default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultSettings", + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultSetting_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultSetting_Get.json new file mode 100644 index 000000000000..663b16f825ef --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultSetting_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "vaultSettingName": "default", + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultSettings/default", + "name": "default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultSettings", + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultSetting_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultSetting_List.json new file mode 100644 index 000000000000..eff87b27064d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationVaultSetting_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultSettings/default", + "name": "default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultSettings", + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + } + ], + "nextLink": null + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Create.json new file mode 100644 index 000000000000..121cbb4587b7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Create.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2023-08-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "addVCenterRequest": { + "properties": { + "friendlyName": "esx-78", + "ipAddress": "inmtest78", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "port": "443", + "runAsAccountId": "2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Delete.json new file mode 100644 index 000000000000..730a43562eb3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2023-08-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Get.json new file mode 100644 index 000000000000..212df65feaa0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2023-08-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_List.json new file mode 100644 index 000000000000..b05fc23e7748 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_ListByReplicationFabrics.json new file mode 100644 index 000000000000..cd510ff13ee6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_ListByReplicationFabrics.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "fabricName": "MadhaviFabric", + "api-version": "2023-08-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Update.json new file mode 100644 index 000000000000..7760ebfeb7d1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/ReplicationvCenters_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2023-08-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "updateVCenterRequest": { + "properties": { + "ipAddress": "10.150.109.25" + } + } + }, + "responses": { + "200": { + "body": { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "10.150.109.25", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01", + "Retry-After": 30 + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/SupportedOperatingSystems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/SupportedOperatingSystems_Get.json new file mode 100644 index 000000000000..bdee8c74cec5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/SupportedOperatingSystems_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.RecoveryServices/vaults/replicationSupportedOperatingSystems", + "id": "/Subscriptions/bc403605-c2b0-43dd-abe9-0162124b1ee1/resourceGroups/oneBoxRG/providers/Microsoft.RecoveryServices/vaults/oneBoxRSVault/replicationSupportedOperatingSystems/Default", + "properties": { + "supportedOsList": [ + { + "instanceType": "A2A", + "supportedOs": [ + { + "osName": "centos", + "osType": "linux", + "osVersions": [ + { + "version": "6.0" + } + ] + }, + { + "osName": "Windows Server 2008 R2 Datacenter", + "osType": "windows", + "osVersions": [ + { + "version": "6.1", + "servicePack": "1" + } + ] + } + ] + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json new file mode 100644 index 000000000000..94c48371871a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "replicatedProtectedItemName": "468c912d-b1ab-4ea2-97eb-4b5095155db2", + "protectionContainerName": "asr-a2a-default-centraluseuap-container", + "fabricName": "asr-a2a-default-centraluseuap", + "resourceName": "avraiMgDiskVault", + "resourceGroupName": "avraiMgDiskVaultRG", + "subscriptionId": "6808dbbc-98c7-431f-a1b1-9580902423b7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/6808dbbc-98c7-431f-a1b1-9580902423b7/resourceGroups/avraiMgDiskVaultRG/providers/Microsoft.RecoveryServices/vaults/avraiMgDiskVault/replicationFabrics/asr-a2a-default-centraluseuap/replicationProtectionContainers/asr-a2a-default-centraluseuap-container/replicationProtectedItems/468c912d-b1ab-4ea2-97eb-4b5095155db2/targetComputeSizes/Basic_A0", + "name": "Basic_A0", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/targetComputeSizes", + "properties": { + "name": "Basic_A0", + "friendlyName": "Basic_A0", + "cpuCoresCount": 1, + "memoryInGB": 0.75, + "maxDataDiskCount": 1, + "maxNicsCount": 2, + "errors": null, + "highIopsSupported": "NotSupported" + } + }, + { + "id": "/Subscriptions/6808dbbc-98c7-431f-a1b1-9580902423b7/resourceGroups/avraiMgDiskVaultRG/providers/Microsoft.RecoveryServices/vaults/avraiMgDiskVault/replicationFabrics/asr-a2a-default-centraluseuap/replicationProtectionContainers/asr-a2a-default-centraluseuap-container/replicationProtectedItems/468c912d-b1ab-4ea2-97eb-4b5095155db2/targetComputeSizes/Standard_A0", + "name": "Standard_A0", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/targetComputeSizes", + "properties": { + "name": "Standard_A0", + "friendlyName": "Standard_A0", + "cpuCoresCount": 1, + "vCPUsAvailable": 1, + "memoryInGB": 0.75, + "maxDataDiskCount": 1, + "maxNicsCount": 2, + "errors": null, + "highIopsSupported": "NotSupported", + "hyperVGenerations": [ + "V1" + ] + } + } + ], + "nextLink": null + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/6808dbbc-98c7-431f-a1b1-9580902423b7/resourceGroups/avraiMgDiskVaultRG/providers/Microsoft.RecoveryServices/vaults/avraiMgDiskVault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-08-01" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/service.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/service.json new file mode 100644 index 000000000000..c4a5c0f1def1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2023-08-01/service.json @@ -0,0 +1,25387 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-08-01", + "title": "SiteRecoveryManagementClient", + "x-ms-code-generation-settings": { + "header": "MICROSOFT_MIT_NO_VERSION" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Returns the list of available operations.", + "description": "Operation to return the list of available operations.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationsDiscoveryCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Returns the list of available operations.": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings": { + "get": { + "tags": [ + "ReplicationAlertSettings" + ], + "summary": "Gets the list of configured email notification(alert) configurations.", + "description": "Gets the list of email notification(alert) configurations for the vault.", + "operationId": "ReplicationAlertSettings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of configured email notification(alert) configurations.": { + "$ref": "./examples/ReplicationAlertSettings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings/{alertSettingName}": { + "get": { + "tags": [ + "ReplicationAlertSettings" + ], + "summary": "Gets an email notification(alert) configuration.", + "description": "Gets the details of the specified email notification(alert) configuration.", + "operationId": "ReplicationAlertSettings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "alertSettingName", + "in": "path", + "description": "The name of the email notification configuration.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + } + }, + "x-ms-examples": { + "Gets an email notification(alert) configuration.": { + "$ref": "./examples/ReplicationAlertSettings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationAlertSettings" + ], + "summary": "Configures email notifications for this vault.", + "description": "Create or update an email notification(alert) configuration.", + "operationId": "ReplicationAlertSettings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "alertSettingName", + "in": "path", + "description": "The name of the email notification(alert) configuration.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "The input to configure the email notification(alert).", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigureAlertRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + } + }, + "x-ms-examples": { + "Configures email notifications for this vault.": { + "$ref": "./examples/ReplicationAlertSettings_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAppliances": { + "get": { + "tags": [ + "ReplicationAppliances" + ], + "summary": "Gets the list of appliances.", + "description": "Gets the list of Azure Site Recovery appliances for the vault.", + "operationId": "ReplicationAppliances_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplianceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ApplianceQueryParameter", + "x-ms-examples": { + "Gets the list of appliances.": { + "$ref": "./examples/ReplicationAppliances_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults": { + "get": { + "tags": [ + "ReplicationEligibilityResults" + ], + "summary": "Gets the validation errors in case the VM is unsuitable for protection.", + "description": "Validates whether a given VM can be protected or not in which case returns list of errors.", + "operationId": "ReplicationEligibilityResults_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "Virtual Machine name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationEligibilityResultsCollection" + } + } + }, + "x-ms-examples": { + "Gets the validation errors in case the VM is unsuitable for protection.": { + "$ref": "./examples/ReplicationEligibilityResults_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default": { + "get": { + "tags": [ + "ReplicationEligibilityResults" + ], + "summary": "Gets the validation errors in case the VM is unsuitable for protection.", + "description": "Validates whether a given VM can be protected or not in which case returns list of errors.", + "operationId": "ReplicationEligibilityResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "Virtual Machine name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationEligibilityResults" + } + } + }, + "x-ms-examples": { + "Gets the validation errors in case the VM is unsuitable for protection.": { + "$ref": "./examples/ReplicationEligibilityResults_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents": { + "get": { + "tags": [ + "ReplicationEvents" + ], + "summary": "Gets the list of Azure Site Recovery events.", + "description": "Gets the list of Azure Site Recovery events for the vault.", + "operationId": "ReplicationEvents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/EventQueryParameter", + "x-ms-examples": { + "Gets the list of Azure Site Recovery events.": { + "$ref": "./examples/ReplicationEvents_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents/{eventName}": { + "get": { + "tags": [ + "ReplicationEvents" + ], + "summary": "Get the details of an Azure Site recovery event.", + "description": "The operation to get the details of an Azure Site recovery event.", + "operationId": "ReplicationEvents_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "eventName", + "in": "path", + "description": "The name of the Azure Site Recovery event.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Event" + } + } + }, + "x-ms-examples": { + "Get the details of an Azure Site recovery event.": { + "$ref": "./examples/ReplicationEvents_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics": { + "get": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Gets the list of ASR fabrics.", + "description": "Gets a list of the Azure Site Recovery fabrics in the vault.", + "operationId": "ReplicationFabrics_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FabricCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of ASR fabrics.": { + "$ref": "./examples/ReplicationFabrics_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}": { + "get": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Gets the details of an ASR fabric.", + "description": "Gets the details of an Azure Site Recovery fabric.", + "operationId": "ReplicationFabrics_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + } + }, + "x-ms-odata": "#/definitions/FabricQueryParameter", + "x-ms-examples": { + "Gets the details of an ASR fabric.": { + "$ref": "./examples/ReplicationFabrics_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Creates an Azure Site Recovery fabric.", + "description": "The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).", + "operationId": "ReplicationFabrics_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Name of the ASR fabric.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Fabric creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/FabricCreationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates an Azure Site Recovery fabric.": { + "$ref": "./examples/ReplicationFabrics_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Purges the site.", + "description": "The operation to purge(force delete) an Azure Site Recovery fabric.", + "operationId": "ReplicationFabrics_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "ASR fabric to purge.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purges the site.": { + "$ref": "./examples/ReplicationFabrics_Purge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/checkConsistency": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Checks the consistency of the ASR fabric.", + "description": "The operation to perform a consistency check on the fabric.", + "operationId": "ReplicationFabrics_CheckConsistency", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Checks the consistency of the ASR fabric.": { + "$ref": "./examples/ReplicationFabrics_CheckConsistency.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/migratetoaad": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Migrates the site to AAD.", + "description": "The operation to migrate an Azure Site Recovery fabric to AAD.", + "operationId": "ReplicationFabrics_MigrateToAad", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "ASR fabric to migrate.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Migrates the site to AAD.": { + "$ref": "./examples/ReplicationFabrics_MigrateToAad.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/reassociateGateway": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Perform failover of the process server.", + "description": "The operation to move replications from a process server to another process server.", + "operationId": "ReplicationFabrics_ReassociateGateway", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric containing the process server.", + "required": true, + "type": "string" + }, + { + "name": "failoverProcessServerRequest", + "in": "body", + "description": "The input to the failover process server operation.", + "required": true, + "schema": { + "$ref": "#/definitions/FailoverProcessServerRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Perform failover of the process server.": { + "$ref": "./examples/ReplicationFabrics_ReassociateGateway.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/remove": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Deletes the site.", + "description": "The operation to delete or remove an Azure Site Recovery fabric.", + "operationId": "ReplicationFabrics_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "ASR fabric to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes the site.": { + "$ref": "./examples/ReplicationFabrics_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/renewCertificate": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Renews certificate for the fabric.", + "description": "Renews the connection certificate for the ASR replication fabric.", + "operationId": "ReplicationFabrics_RenewCertificate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "fabric name to renew certs for.", + "required": true, + "type": "string" + }, + { + "name": "renewCertificate", + "in": "body", + "description": "Renew certificate input.", + "required": true, + "schema": { + "$ref": "#/definitions/RenewCertificateInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Renews certificate for the fabric.": { + "$ref": "./examples/ReplicationFabrics_RenewCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/removeInfra": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Removes the appliance's infrastructure under the fabric.", + "operationId": "ReplicationFabrics_RemoveInfra", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource name.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Removes the appliance's infrastructure under the fabric.": { + "$ref": "./examples/ReplicationInfrastructure_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks": { + "get": { + "tags": [ + "ReplicationLogicalNetworks" + ], + "summary": "Gets the list of logical networks under a fabric.", + "description": "Lists all the logical networks of the Azure Site Recovery fabric.", + "operationId": "ReplicationLogicalNetworks_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Server Id.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogicalNetworkCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of logical networks under a fabric.": { + "$ref": "./examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks/{logicalNetworkName}": { + "get": { + "tags": [ + "ReplicationLogicalNetworks" + ], + "summary": "Gets a logical network with specified server id and logical network name.", + "description": "Gets the details of a logical network.", + "operationId": "ReplicationLogicalNetworks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Server Id.", + "required": true, + "type": "string" + }, + { + "name": "logicalNetworkName", + "in": "path", + "description": "Logical network name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + } + }, + "x-ms-examples": { + "Gets a logical network with specified server id and logical network name.": { + "$ref": "./examples/ReplicationLogicalNetworks_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks": { + "get": { + "tags": [ + "ReplicationNetworks" + ], + "summary": "Gets the list of networks under a fabric.", + "description": "Lists the networks available for a fabric.", + "operationId": "ReplicationNetworks_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of networks under a fabric.": { + "$ref": "./examples/ReplicationNetworks_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}": { + "get": { + "tags": [ + "ReplicationNetworks" + ], + "summary": "Gets a network with specified server id and network name.", + "description": "Gets the details of a network.", + "operationId": "ReplicationNetworks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Server Id.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Network" + } + } + }, + "x-ms-examples": { + "Gets a network with specified server id and network name.": { + "$ref": "./examples/ReplicationNetworks_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings": { + "get": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Gets all the network mappings under a network.", + "description": "Lists all ASR network mappings for the specified network.", + "operationId": "ReplicationNetworkMappings_ListByReplicationNetworks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all the network mappings under a network.": { + "$ref": "./examples/ReplicationNetworkMappings_ListByReplicationNetworks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName}": { + "get": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Gets network mapping by name.", + "description": "Gets the details of an ASR network mapping.", + "operationId": "ReplicationNetworkMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "Network mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMapping" + } + } + }, + "x-ms-examples": { + "Gets network mapping by name.": { + "$ref": "./examples/ReplicationNetworkMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Creates network mapping.", + "description": "The operation to create an ASR network mapping.", + "operationId": "ReplicationNetworkMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "Network mapping name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Create network mapping input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateNetworkMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates network mapping.": { + "$ref": "./examples/ReplicationNetworkMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Delete network mapping.", + "description": "The operation to delete a network mapping.", + "operationId": "ReplicationNetworkMappings_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "ARM Resource Name for network mapping.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete network mapping.": { + "$ref": "./examples/ReplicationNetworkMappings_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Updates network mapping.", + "description": "The operation to update an ASR network mapping.", + "operationId": "ReplicationNetworkMappings_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "Network mapping name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update network mapping input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateNetworkMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates network mapping.": { + "$ref": "./examples/ReplicationNetworkMappings_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers": { + "get": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Gets the list of protection container for a fabric.", + "description": "Lists the protection containers in the specified fabric.", + "operationId": "ReplicationProtectionContainers_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of protection container for a fabric.": { + "$ref": "./examples/ReplicationProtectionContainers_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}": { + "get": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Gets the protection container details.", + "description": "Gets the details of a protection container.", + "operationId": "ReplicationProtectionContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + } + }, + "x-ms-examples": { + "Gets the protection container details.": { + "$ref": "./examples/ReplicationProtectionContainers_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Create a protection container.", + "description": "Operation to create a protection container.", + "operationId": "ReplicationProtectionContainers_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric ARM name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Unique protection container ARM name.", + "required": true, + "type": "string" + }, + { + "name": "creationInput", + "in": "body", + "description": "Creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionContainerInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a protection container.": { + "$ref": "./examples/ReplicationProtectionContainers_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/discoverProtectableItem": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Adds a protectable item to the replication protection container.", + "description": "The operation to a add a protectable item to a protection container(Add physical server).", + "operationId": "ReplicationProtectionContainers_DiscoverProtectableItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the protection container.", + "required": true, + "type": "string" + }, + { + "name": "discoverProtectableItemRequest", + "in": "body", + "description": "The request object to add a protectable item.", + "required": true, + "schema": { + "$ref": "#/definitions/DiscoverProtectableItemRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Adds a protectable item to the replication protection container.": { + "$ref": "./examples/ReplicationProtectionContainers_DiscoverProtectableItem.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/remove": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Removes a protection container.", + "description": "Operation to remove a protection container.", + "operationId": "ReplicationProtectionContainers_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric ARM name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Unique protection container ARM name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Removes a protection container.": { + "$ref": "./examples/ReplicationProtectionContainers_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the list of migration items in the protection container.", + "description": "Gets the list of ASR migration items in the protection container.", + "operationId": "ReplicationMigrationItems_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "takeToken", + "in": "query", + "description": "The page size.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/MigrationItemsQueryParameter", + "x-ms-examples": { + "Gets the list of migration items in the protection container.": { + "$ref": "./examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the details of a migration item.", + "operationId": "ReplicationMigrationItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + } + }, + "x-ms-examples": { + "Gets the details of a migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Enables migration.", + "description": "The operation to create an ASR migration item (enable migration).", + "operationId": "ReplicationMigrationItems_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Enable migration input.", + "required": true, + "schema": { + "$ref": "#/definitions/EnableMigrationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Enables migration.": { + "$ref": "./examples/ReplicationMigrationItems_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Delete the migration item.", + "description": "The operation to delete an ASR migration item.", + "operationId": "ReplicationMigrationItems_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "deleteOption", + "in": "query", + "description": "The delete option.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete the migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Updates migration item.", + "description": "The operation to update the recovery settings of an ASR migration item.", + "operationId": "ReplicationMigrationItems_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update migration item input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMigrationItemInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrate": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Migrate item.", + "description": "The operation to initiate migration of the item.", + "operationId": "ReplicationMigrationItems_Migrate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "migrateInput", + "in": "body", + "description": "Migrate input.", + "required": true, + "schema": { + "$ref": "#/definitions/MigrateInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Migrate item.": { + "$ref": "./examples/ReplicationMigrationItems_Migrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints": { + "get": { + "tags": [ + "MigrationRecoveryPoints" + ], + "summary": "Gets the recovery points for a migration item.", + "operationId": "MigrationRecoveryPoints_ListByReplicationMigrationItems", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationRecoveryPointCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the recovery points for a migration item.": { + "$ref": "./examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints/{migrationRecoveryPointName}": { + "get": { + "tags": [ + "MigrationRecoveryPoints" + ], + "summary": "Gets a recovery point for a migration item.", + "operationId": "MigrationRecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "migrationRecoveryPointName", + "in": "path", + "description": "The migration recovery point name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationRecoveryPoint" + } + } + }, + "x-ms-examples": { + "Gets a recovery point for a migration item.": { + "$ref": "./examples/MigrationRecoveryPoints_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/pauseReplication": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Pause replication.", + "description": "The operation to initiate pause replication of the item.", + "operationId": "ReplicationMigrationItems_PauseReplication", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "pauseReplicationInput", + "in": "body", + "description": "Pause replication input.", + "required": true, + "schema": { + "$ref": "#/definitions/PauseReplicationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Pause replication.": { + "$ref": "./examples/ReplicationMigrationItems_PauseReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/resumeReplication": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Resume replication.", + "description": "The operation to initiate resume replication of the item.", + "operationId": "ReplicationMigrationItems_ResumeReplication", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "resumeReplicationInput", + "in": "body", + "description": "Resume replication input.", + "required": true, + "schema": { + "$ref": "#/definitions/ResumeReplicationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resume replication.": { + "$ref": "./examples/ReplicationMigrationItems_ResumeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/resync": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Resynchronizes replication.", + "description": "The operation to resynchronize replication of an ASR migration item.", + "operationId": "ReplicationMigrationItems_Resync", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Resync input.", + "required": true, + "schema": { + "$ref": "#/definitions/ResyncInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resynchronizes replication.": { + "$ref": "./examples/ReplicationMigrationItems_Resync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrate": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Test migrate item.", + "description": "The operation to initiate test migration of the item.", + "operationId": "ReplicationMigrationItems_TestMigrate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "testMigrateInput", + "in": "body", + "description": "Test migrate input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestMigrateInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Test migrate item.": { + "$ref": "./examples/ReplicationMigrationItems_TestMigrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrateCleanup": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Test migrate cleanup.", + "description": "The operation to initiate test migrate cleanup.", + "operationId": "ReplicationMigrationItems_TestMigrateCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "testMigrateCleanupInput", + "in": "body", + "description": "Test migrate cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestMigrateCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Test migrate cleanup.": { + "$ref": "./examples/ReplicationMigrationItems_TestMigrateCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems": { + "get": { + "tags": [ + "ReplicationProtectableItems" + ], + "summary": "Gets the list of protectable items.", + "description": "Lists the protectable items in a protection container.", + "operationId": "ReplicationProtectableItems_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$take", + "in": "query", + "description": "take OData query parameter.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken OData query parameter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectableItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ProtectableItemQueryParameter", + "x-ms-examples": { + "Gets the list of protectable items.": { + "$ref": "./examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems/{protectableItemName}": { + "get": { + "tags": [ + "ReplicationProtectableItems" + ], + "summary": "Gets the details of a protectable item.", + "description": "The operation to get the details of a protectable item.", + "operationId": "ReplicationProtectableItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "protectableItemName", + "in": "path", + "description": "Protectable item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectableItem" + } + } + }, + "x-ms-examples": { + "Gets the details of a protectable item.": { + "$ref": "./examples/ReplicationProtectableItems_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems": { + "get": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Gets the list of Replication protected items.", + "description": "Gets the list of ASR replication protected items in the protection container.", + "operationId": "ReplicationProtectedItems_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of Replication protected items.": { + "$ref": "./examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}": { + "get": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Gets the details of a Replication protected item.", + "description": "Gets the details of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + } + }, + "x-ms-examples": { + "Gets the details of a Replication protected item.": { + "$ref": "./examples/ReplicationProtectedItems_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Enables protection.", + "description": "The operation to create an ASR replication protected item (Enable replication).", + "operationId": "ReplicationProtectedItems_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Name of the fabric.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "A name for the replication protected item.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Enable Protection Input.", + "required": true, + "schema": { + "$ref": "#/definitions/EnableProtectionInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Enables protection.": { + "$ref": "./examples/ReplicationProtectedItems_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Purges protection.", + "description": "The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.", + "operationId": "ReplicationProtectedItems_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purges protection.": { + "$ref": "./examples/ReplicationProtectedItems_Purge.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Updates the replication protected item settings.", + "description": "The operation to update the recovery settings of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "updateProtectionInput", + "in": "body", + "description": "Update protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateReplicationProtectedItemInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates the replication protected Item settings.": { + "$ref": "./examples/ReplicationProtectedItems_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/addDisks": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Add disk(s) for protection.", + "description": "Operation to add disks(s) to the replication protected item.", + "operationId": "ReplicationProtectedItems_AddDisks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "addDisksInput", + "in": "body", + "description": "Add disks input.", + "required": true, + "schema": { + "$ref": "#/definitions/AddDisksInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Add disk(s) for protection.": { + "$ref": "./examples/ReplicationProtectedItems_AddDisks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Change or apply recovery point.", + "description": "The operation to change the recovery point of a failed over replication protected item.", + "operationId": "ReplicationProtectedItems_ApplyRecoveryPoint", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The ARM fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replicated protected item name.", + "required": true, + "type": "string" + }, + { + "name": "applyRecoveryPointInput", + "in": "body", + "description": "The ApplyRecoveryPointInput.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplyRecoveryPointInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Change or apply recovery point.": { + "$ref": "./examples/ReplicationProtectedItems_ApplyRecoveryPoint.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCancel": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute cancel failover.", + "description": "Operation to cancel the failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_FailoverCancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute cancel failover.": { + "$ref": "./examples/ReplicationProtectedItems_FailoverCancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute commit failover.", + "description": "Operation to commit the failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_FailoverCommit", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute commit failover.": { + "$ref": "./examples/ReplicationProtectedItems_FailoverCommit.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute planned failover.", + "description": "Operation to initiate a planned failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_PlannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "in": "body", + "description": "Planned failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/PlannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute planned failover.": { + "$ref": "./examples/ReplicationProtectedItems_PlannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints": { + "get": { + "tags": [ + "RecoveryPoints" + ], + "summary": "Gets the list of recovery points for a replication protected item.", + "description": "Lists the available recovery points for a replication protected item.", + "operationId": "RecoveryPoints_ListByReplicationProtectedItems", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPointCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of recovery points for a replication protected item.": { + "$ref": "./examples/RecoveryPoints_ListByReplicationProtectedItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints/{recoveryPointName}": { + "get": { + "tags": [ + "RecoveryPoints" + ], + "summary": "Gets a recovery point.", + "description": "Get the details of specified recovery point.", + "operationId": "RecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointName", + "in": "path", + "description": "The recovery point name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPoint" + } + } + }, + "x-ms-examples": { + "Gets a recovery point.": { + "$ref": "./examples/RecoveryPoints_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Disables protection.", + "description": "The operation to disable replication on a replication protected item. This will also remove the item.", + "operationId": "ReplicationProtectedItems_Delete", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "disableProtectionInput", + "in": "body", + "description": "Disable protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/DisableProtectionInput" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Disables protection.": { + "$ref": "./examples/ReplicationProtectedItems_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/removeDisks": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Removes disk(s).", + "description": "Operation to remove disk(s) from the replication protected item.", + "operationId": "ReplicationProtectedItems_RemoveDisks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "removeDisksInput", + "in": "body", + "description": "Remove disks input.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveDisksInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Removes disk(s).": { + "$ref": "./examples/ReplicationProtectedItems_RemoveDisks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Resynchronize or repair replication.", + "description": "The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.", + "operationId": "ReplicationProtectedItems_RepairReplication", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the container.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The name of the replication protected item.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resynchronize or repair replication.": { + "$ref": "./examples/ReplicationProtectedItems_RepairReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute Reverse Replication\\Reprotect.", + "description": "Operation to reprotect or reverse replicate a failed over replication protected item.", + "operationId": "ReplicationProtectedItems_Reprotect", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "reprotectInput", + "in": "body", + "description": "Reverse replication input.", + "required": true, + "schema": { + "$ref": "#/definitions/ReverseReplicationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute Reverse Replication\\Reprotect.": { + "$ref": "./examples/ReplicationProtectedItems_Reprotect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/resolveHealthErrors": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Resolve health errors.", + "description": "Operation to resolve health issues of the replication protected item.", + "operationId": "ReplicationProtectedItems_ResolveHealthErrors", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "resolveHealthInput", + "in": "body", + "description": "Health issue input object.", + "required": true, + "schema": { + "$ref": "#/definitions/ResolveHealthInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resolve health errors.": { + "$ref": "./examples/ReplicationProtectedItems_ResolveHealthErrors.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/switchProvider": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute switch provider.", + "description": "Operation to initiate a switch provider of the replication protected item.", + "operationId": "ReplicationProtectedItems_SwitchProvider", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "switchProviderInput", + "in": "body", + "description": "Switch provider input.", + "required": true, + "schema": { + "$ref": "#/definitions/SwitchProviderInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Execute switch provider.": { + "$ref": "./examples/ReplicationProtectedItems_SwitchProvider.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/targetComputeSizes": { + "get": { + "tags": [ + "TargetComputeSizes" + ], + "summary": "Gets the list of target compute sizes for the replication protected item.", + "description": "Lists the available target compute sizes for a replication protected item.", + "operationId": "TargetComputeSizes_ListByReplicationProtectedItems", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TargetComputeSizeCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of target compute sizes for the replication protected item.": { + "$ref": "./examples/TargetComputeSizes_ListByReplicationProtectedItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute test failover.", + "description": "Operation to perform a test failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_TestFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "testfailoverInput", + "in": "body", + "description": "Test failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover.": { + "$ref": "./examples/ReplicationProtectedItems_TestFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute test failover cleanup.", + "description": "Operation to clean up the test failover of a replication protected item.", + "operationId": "ReplicationProtectedItems_TestFailoverCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "cleanupInput", + "in": "body", + "description": "Test failover cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestFailoverCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover cleanup.": { + "$ref": "./examples/ReplicationProtectedItems_TestFailoverCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute unplanned failover.", + "description": "Operation to initiate a failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_UnplannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "in": "body", + "description": "Failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/UnplannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute unplanned failover.": { + "$ref": "./examples/ReplicationProtectedItems_UnplannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateAppliance": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Updates appliance for replication protected Item.", + "description": "The operation to update appliance of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_UpdateAppliance", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "applianceUpdateInput", + "in": "body", + "description": "Appliance update protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates appliance for replication protected Item.": { + "$ref": "./examples/ReplicationProtectedItems_UpdateAppliance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateMobilityService": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Update the mobility service on a protected item.", + "description": "The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.", + "operationId": "ReplicationProtectedItems_UpdateMobilityService", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric containing the protected item.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the container containing the protected item.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The name of the protected item on which the agent is to be updated.", + "required": true, + "type": "string" + }, + { + "name": "updateMobilityServiceRequest", + "in": "body", + "description": "Request to update the mobility service on the protected item.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMobilityServiceRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Update the mobility service on a protected item.": { + "$ref": "./examples/ReplicationProtectedItems_UpdateMobilityService.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets the list of protection container mappings for a protection container.", + "description": "Lists the protection container mappings for a protection container.", + "operationId": "ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of protection container mappings for a protection container.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets a protection container mapping.", + "description": "Gets the details of a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection Container mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + } + }, + "x-ms-examples": { + "Gets a protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Create protection container mapping.", + "description": "The operation to create a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "creationInput", + "in": "body", + "description": "Mapping creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionContainerMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Purge protection container mapping.", + "description": "The operation to purge(force delete) a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purge protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Purge.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Update protection container mapping.", + "description": "The operation to update protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "updateInput", + "in": "body", + "description": "Mapping update input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateProtectionContainerMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}/remove": { + "post": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Remove protection container mapping.", + "description": "The operation to delete or remove a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Delete", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "removalInput", + "in": "body", + "description": "Removal input.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveProtectionContainerMappingInput" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Remove protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchprotection": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Switches protection from one container to another or one replication provider to another.", + "description": "Operation to switch protection from one container to another or one replication provider to another.", + "operationId": "ReplicationProtectionContainers_SwitchProtection", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "switchInput", + "in": "body", + "description": "Switch protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/SwitchProtectionInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Switches protection from one container to another or one replication provider to another.": { + "$ref": "./examples/ReplicationProtectionContainers_SwitchProtection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders": { + "get": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Gets the list of registered recovery services providers for the fabric.", + "description": "Lists the registered recovery services providers for the specified fabric.", + "operationId": "ReplicationRecoveryServicesProviders_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProviderCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of registered recovery services providers for the fabric.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}": { + "get": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Gets the details of a recovery services provider.", + "description": "Gets the details of registered recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + } + }, + "x-ms-examples": { + "Gets the details of a recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Adds a recovery services provider.", + "description": "The operation to add a recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + }, + { + "name": "addProviderInput", + "in": "body", + "description": "Add provider input.", + "required": true, + "schema": { + "$ref": "#/definitions/AddRecoveryServicesProviderInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Adds a recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Purges recovery service provider from fabric.", + "description": "The operation to purge(force delete) a recovery services provider from the vault.", + "operationId": "ReplicationRecoveryServicesProviders_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purges recovery service provider from fabric.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Purge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/refreshProvider": { + "post": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Refresh details from the recovery services provider.", + "description": "The operation to refresh the information from the recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_RefreshProvider", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Refresh details from the recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_RefreshProvider.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/remove": { + "post": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object \"deleteRspInput\" is used (if the object is empty we assume that it is old client and continue the old behavior).", + "description": "The operation to removes/delete(unregister) a recovery services provider from the vault.", + "operationId": "ReplicationRecoveryServicesProviders_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object \"deleteRspInput\" is used (if the object is empty we assume that it is old client and continue the old behavior).": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications": { + "get": { + "tags": [ + "ReplicationStorageClassifications" + ], + "summary": "Gets the list of storage classification objects under a fabric.", + "description": "Lists the storage classifications available in the specified fabric.", + "operationId": "ReplicationStorageClassifications_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Site name of interest.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification objects under a fabric.": { + "$ref": "./examples/ReplicationStorageClassifications_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}": { + "get": { + "tags": [ + "ReplicationStorageClassifications" + ], + "summary": "Gets the details of a storage classification.", + "description": "Gets the details of the specified storage classification.", + "operationId": "ReplicationStorageClassifications_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassification" + } + } + }, + "x-ms-examples": { + "Gets the details of a storage classification.": { + "$ref": "./examples/ReplicationStorageClassifications_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings": { + "get": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Gets the list of storage classification mappings objects under a storage.", + "description": "Lists the storage classification mappings for the fabric.", + "operationId": "ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification mappings objects under a storage.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings/{storageClassificationMappingName}": { + "get": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Gets the details of a storage classification mapping.", + "description": "Gets the details of the specified storage classification mapping.", + "operationId": "ReplicationStorageClassificationMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationMappingName", + "in": "path", + "description": "Storage classification mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMapping" + } + } + }, + "x-ms-examples": { + "Gets the details of a storage classification mapping.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Create storage classification mapping.", + "description": "The operation to create a storage classification mapping.", + "operationId": "ReplicationStorageClassificationMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationMappingName", + "in": "path", + "description": "Storage classification mapping name.", + "required": true, + "type": "string" + }, + { + "name": "pairingInput", + "in": "body", + "description": "Pairing input.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageClassificationMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create storage classification mapping.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Delete a storage classification mapping.", + "description": "The operation to delete a storage classification mapping.", + "operationId": "ReplicationStorageClassificationMappings_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationMappingName", + "in": "path", + "description": "Storage classification mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a storage classification mapping.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters": { + "get": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Gets the list of vCenter registered under a fabric.", + "description": "Lists the vCenter servers registered in a fabric.", + "operationId": "ReplicationvCenters_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenterCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of vCenter registered under a fabric.": { + "$ref": "./examples/ReplicationvCenters_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters/{vcenterName}": { + "get": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Gets the details of a vCenter.", + "description": "Gets the details of a registered vCenter server(Add vCenter server).", + "operationId": "ReplicationvCenters_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenter" + } + } + }, + "x-ms-examples": { + "Gets the details of a vCenter.": { + "$ref": "./examples/ReplicationvCenters_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Add vCenter.", + "description": "The operation to create a vCenter object..", + "operationId": "ReplicationvCenters_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + }, + { + "name": "addVCenterRequest", + "in": "body", + "description": "The input to the add vCenter operation.", + "required": true, + "schema": { + "$ref": "#/definitions/AddVCenterRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenter" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Add vCenter.": { + "$ref": "./examples/ReplicationvCenters_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Remove vcenter operation.", + "description": "The operation to remove(unregister) a registered vCenter server from the vault.", + "operationId": "ReplicationvCenters_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Remove vCenter operation.": { + "$ref": "./examples/ReplicationvCenters_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Update vCenter operation.", + "description": "The operation to update a registered vCenter.", + "operationId": "ReplicationvCenters_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + }, + { + "name": "updateVCenterRequest", + "in": "body", + "description": "The input to the update vCenter operation.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateVCenterRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenter" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update vCenter operation.": { + "$ref": "./examples/ReplicationvCenters_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs": { + "get": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Gets the list of jobs.", + "description": "Gets the list of Azure Site Recovery Jobs for the vault.", + "operationId": "ReplicationJobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobQueryParameter", + "x-ms-examples": { + "Gets the list of jobs.": { + "$ref": "./examples/ReplicationJobs_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}": { + "get": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Gets the job details.", + "description": "Get the details of an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + } + }, + "x-ms-examples": { + "Gets the job details.": { + "$ref": "./examples/ReplicationJobs_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/cancel": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Cancels the specified job.", + "description": "The operation to cancel an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Cancels the specified job.": { + "$ref": "./examples/ReplicationJobs_Cancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/restart": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Restarts the specified job.", + "description": "The operation to restart an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Restart", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Restarts the specified job.": { + "$ref": "./examples/ReplicationJobs_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/resume": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Resumes the specified job.", + "description": "The operation to resume an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Resume", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + }, + { + "name": "resumeJobParams", + "in": "body", + "description": "Resume rob comments.", + "required": true, + "schema": { + "$ref": "#/definitions/ResumeJobParams" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resumes the specified job.": { + "$ref": "./examples/ReplicationJobs_Resume.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/export": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Exports the details of the Azure Site Recovery jobs of the vault.", + "description": "The operation to export the details of the Azure Site Recovery jobs of the vault.", + "operationId": "ReplicationJobs_Export", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobQueryParameter", + "in": "body", + "description": "job query filter.", + "required": true, + "schema": { + "$ref": "#/definitions/JobQueryParameter" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Exports the details of the Azure Site Recovery jobs of the vault.": { + "$ref": "./examples/ReplicationJobs_Export.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationMigrationItems": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the list of migration items in the vault.", + "operationId": "ReplicationMigrationItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "takeToken", + "in": "query", + "description": "The page size.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/MigrationItemsQueryParameter", + "x-ms-examples": { + "Gets the list of migration items in the vault.": { + "$ref": "./examples/ReplicationMigrationItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworkMappings": { + "get": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Gets all the network mappings under a vault.", + "description": "Lists all ASR network mappings in the vault.", + "operationId": "ReplicationNetworkMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all the network mappings under a vault.": { + "$ref": "./examples/ReplicationNetworkMappings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworks": { + "get": { + "tags": [ + "ReplicationNetworks" + ], + "summary": "Gets the list of networks. View-only API.", + "description": "Lists the networks available in a vault.", + "operationId": "ReplicationNetworks_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of networks. View-only API.": { + "$ref": "./examples/ReplicationNetworks_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies": { + "get": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Gets the list of replication policies.", + "description": "Lists the replication policies for a vault.", + "operationId": "ReplicationPolicies_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of replication policies.": { + "$ref": "./examples/ReplicationPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies/{policyName}": { + "get": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Gets the requested policy.", + "description": "Gets the details of a replication policy.", + "operationId": "ReplicationPolicies_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Replication policy name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Policy" + } + } + }, + "x-ms-examples": { + "Gets the requested policy.": { + "$ref": "./examples/ReplicationPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Creates the policy.", + "description": "The operation to create a replication policy.", + "operationId": "ReplicationPolicies_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Replication policy name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Create policy input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreatePolicyInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Policy" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates the policy.": { + "$ref": "./examples/ReplicationPolicies_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Delete the policy.", + "description": "The operation to delete a replication policy.", + "operationId": "ReplicationPolicies_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Replication policy name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete the policy.": { + "$ref": "./examples/ReplicationPolicies_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Updates the policy.", + "description": "The operation to update a replication policy.", + "operationId": "ReplicationPolicies_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Policy Id.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update Policy Input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdatePolicyInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Policy" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates the policy.": { + "$ref": "./examples/ReplicationPolicies_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectedItems": { + "get": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Gets the list of replication protected items.", + "description": "Gets the list of ASR replication protected items in the vault.", + "operationId": "ReplicationProtectedItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token. Possible values: \"FabricId\" or \"FabricId_CloudId\" or null.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ProtectedItemsQueryParameter", + "x-ms-examples": { + "Gets the list of replication protected items.": { + "$ref": "./examples/ReplicationProtectedItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainerMappings": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets the list of all protection container mappings in a vault.", + "description": "Lists the protection container mappings in the vault.", + "operationId": "ReplicationProtectionContainerMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of all protection container mappings in a vault.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainers": { + "get": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Gets the list of all protection containers in a vault.", + "description": "Lists the protection containers in a vault.", + "operationId": "ReplicationProtectionContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of all protection containers in a vault.": { + "$ref": "./examples/ReplicationProtectionContainers_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents": { + "get": { + "tags": [ + "ReplicationProtectionIntents" + ], + "summary": "Gets the list of replication protection intent objects.", + "description": "Gets the list of ASR replication protection intent objects in the vault.", + "operationId": "ReplicationProtectionIntents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "takeToken", + "in": "query", + "description": "The page size.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionIntentCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of replication protection intent objects.": { + "$ref": "./examples/ReplicationProtectionIntents_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents/{intentObjectName}": { + "get": { + "tags": [ + "ReplicationProtectionIntents" + ], + "summary": "Gets the details of a Replication protection intent item.", + "description": "Gets the details of an ASR replication protection intent.", + "operationId": "ReplicationProtectionIntents_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "Replication protection intent name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionIntent" + } + } + }, + "x-ms-examples": { + "Gets the details of a Replication protection intent item.": { + "$ref": "./examples/ReplicationProtectionIntents_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionIntents" + ], + "summary": "Create protection intent Resource.", + "description": "The operation to create an ASR replication protection intent item.", + "operationId": "ReplicationProtectionIntents_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "A name for the replication protection item.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Create Protection Intent Input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionIntentInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionIntent" + } + } + }, + "x-ms-examples": { + "Create protection intent Resource.": { + "$ref": "./examples/ReplicationProtectionIntents_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans": { + "get": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Gets the list of recovery plans.", + "description": "Lists the recovery plans in the vault.", + "operationId": "ReplicationRecoveryPlans_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlanCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of recovery plans.": { + "$ref": "./examples/ReplicationRecoveryPlans_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}": { + "get": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Gets the requested recovery plan.", + "description": "Gets the details of the recovery plan.", + "operationId": "ReplicationRecoveryPlans_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Name of the recovery plan.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + } + }, + "x-ms-examples": { + "Gets the requested recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Creates a recovery plan with the given details.", + "description": "The operation to create a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery Plan creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateRecoveryPlanInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates a recovery plan with the given details.": { + "$ref": "./examples/ReplicationRecoveryPlans_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Deletes the specified recovery plan.", + "description": "Delete a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes the specified recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Updates the given recovery plan.", + "description": "The operation to update a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update recovery plan input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateRecoveryPlanInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates the given recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCancel": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute cancel failover of the recovery plan.", + "description": "The operation to cancel the failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_FailoverCancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute cancel failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_FailoverCancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCommit": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute commit failover of the recovery plan.", + "description": "The operation to commit the failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_FailoverCommit", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute commit failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_FailoverCommit.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/plannedFailover": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute planned failover of the recovery plan.", + "description": "The operation to start the planned failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_PlannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanPlannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute planned failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_PlannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/reProtect": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute reprotect of the recovery plan.", + "description": "The operation to reprotect(reverse replicate) a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Reprotect", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute reprotect of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Reprotect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailover": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute test failover of the recovery plan.", + "description": "The operation to start the test failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_TestFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery plan test failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanTestFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_TestFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailoverCleanup": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute test failover cleanup of the recovery plan.", + "description": "The operation to cleanup test failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_TestFailoverCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery plan test failover cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanTestFailoverCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover cleanup of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_TestFailoverCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/unplannedFailover": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute unplanned failover of the recovery plan.", + "description": "The operation to start the unplanned failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_UnplannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery plan unplanned failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanUnplannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute unplanned failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_UnplannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryServicesProviders": { + "get": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Gets the list of registered recovery services providers in the vault. This is a view only api.", + "description": "Lists the registered recovery services providers in the vault.", + "operationId": "ReplicationRecoveryServicesProviders_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProviderCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of registered recovery services providers in the vault. This is a view only api.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassificationMappings": { + "get": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Gets the list of storage classification mappings objects under a vault.", + "description": "Lists the storage classification mappings in the vault.", + "operationId": "ReplicationStorageClassificationMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification mappings objects under a vault.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassifications": { + "get": { + "tags": [ + "ReplicationStorageClassifications" + ], + "summary": "Gets the list of storage classification objects under a vault.", + "description": "Lists the storage classifications in the vault.", + "operationId": "ReplicationStorageClassifications_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification objects under a vault.": { + "$ref": "./examples/ReplicationStorageClassifications_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationSupportedOperatingSystems": { + "get": { + "tags": [ + "SupportedOperatingSystems" + ], + "summary": "Gets the data of supported operating systems by SRS.", + "operationId": "SupportedOperatingSystems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "instanceType", + "in": "query", + "description": "The instance type.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SupportedOperatingSystems" + } + } + }, + "x-ms-examples": { + "Gets the data of supported operating systems by SRS.": { + "$ref": "./examples/SupportedOperatingSystems_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth": { + "get": { + "tags": [ + "ReplicationVaultHealth" + ], + "summary": "Gets the health summary for the vault.", + "description": "Gets the health details of the vault.", + "operationId": "ReplicationVaultHealth_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultHealthDetails" + } + } + }, + "x-ms-examples": { + "Gets the health summary for the vault.": { + "$ref": "./examples/ReplicationVaultHealth_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth/default/refresh": { + "post": { + "tags": [ + "ReplicationVaultHealth" + ], + "summary": "Refreshes health summary of the vault.", + "operationId": "ReplicationVaultHealth_Refresh", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultHealthDetails" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Refreshes health summary of the vault.": { + "$ref": "./examples/ReplicationVaultHealth_Refresh.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings": { + "get": { + "tags": [ + "ReplicationVaultSetting" + ], + "summary": "Gets the list of vault setting.", + "description": "Gets the list of vault setting. This includes the Migration Hub connection settings.", + "operationId": "ReplicationVaultSetting_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultSettingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of vault setting.": { + "$ref": "./examples/ReplicationVaultSetting_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings/{vaultSettingName}": { + "get": { + "tags": [ + "ReplicationVaultSetting" + ], + "summary": "Gets the vault setting.", + "description": "Gets the vault setting. This includes the Migration Hub connection settings.", + "operationId": "ReplicationVaultSetting_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "vaultSettingName", + "in": "path", + "description": "Vault setting name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultSetting" + } + } + }, + "x-ms-examples": { + "Gets the vault setting.": { + "$ref": "./examples/ReplicationVaultSetting_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationVaultSetting" + ], + "summary": "Updates vault setting. A vault setting object is a singleton per vault and it is always present by default.", + "description": "The operation to configure vault setting.", + "operationId": "ReplicationVaultSetting_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "vaultSettingName", + "in": "path", + "description": "Vault setting name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Vault setting creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/VaultSettingCreationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultSetting" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates vault setting. A vault setting object is a singleton per vault and it is always present by default.": { + "$ref": "./examples/ReplicationVaultSetting_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationvCenters": { + "get": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Gets the list of vCenter registered under the vault.", + "description": "Lists the vCenter servers registered in the vault.", + "operationId": "ReplicationvCenters_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenterCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of vCenter registered under the vault.": { + "$ref": "./examples/ReplicationvCenters_List.json" + } + } + } + } + }, + "definitions": { + "A2AAddDisksInput": { + "description": "A2A add disk(s) input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AddDisksProviderSpecificInput" + } + ], + "properties": { + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to A2A provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2A" + }, + "A2AContainerCreationInput": { + "description": "A2A cloud creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2A" + }, + "A2AContainerMappingInput": { + "description": "A2A container mapping input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + }, + "automationAccountAuthenticationType": { + "description": "A value indicating the type authentication to use for automation Account.", + "enum": [ + "RunAsAccount", + "SystemAssignedIdentity" + ], + "type": "string", + "default": "RunAsAccount", + "x-ms-enum": { + "name": "AutomationAccountAuthenticationType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ACreateProtectionIntentInput": { + "description": "A2A create protection intent input.", + "required": [ + "fabricObjectId", + "primaryLocation", + "recoveryLocation", + "recoverySubscriptionId", + "recoveryAvailabilityType", + "recoveryResourceGroupId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CreateProtectionIntentProviderSpecificDetails" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "primaryLocation": { + "description": "The primary location for the virtual machine.", + "type": "string" + }, + "recoveryLocation": { + "description": "The recovery location for the virtual machine.", + "type": "string" + }, + "recoverySubscriptionId": { + "description": "The recovery subscription Id of the virtual machine.", + "type": "string" + }, + "recoveryAvailabilityType": { + "description": "The recovery availability type of the virtual machine.", + "enum": [ + "Single", + "AvailabilitySet", + "AvailabilityZone" + ], + "type": "string", + "x-ms-enum": { + "name": "A2ARecoveryAvailabilityType", + "modelAsString": true + } + }, + "protectionProfileCustomInput": { + "$ref": "#/definitions/ProtectionProfileCustomDetails", + "description": "The protection profile custom inputs." + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "primaryStagingStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account input." + }, + "recoveryAvailabilitySetCustomInput": { + "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails", + "description": "The recovery availability set input." + }, + "recoveryVirtualNetworkCustomInput": { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails", + "description": "The recovery virtual network input." + }, + "recoveryProximityPlacementGroupCustomInput": { + "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails", + "description": "The recovery proximity placement group custom input." + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + }, + "vmDisks": { + "description": "The list of vm disk inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentManagedDiskInputDetails" + } + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group id.", + "type": "string" + }, + "recoveryBootDiagStorageAccount": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The boot diagnostic storage account." + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for two pass flows)." + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountAuthenticationType": { + "description": "A value indicating the authentication type for automation account. The default value is \"RunAsAccount\".", + "enum": [ + "RunAsAccount", + "SystemAssignedIdentity" + ], + "type": "string", + "default": "RunAsAccount", + "x-ms-enum": { + "name": "AutomationAccountAuthenticationType", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ACrossClusterMigrationApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to A2ACrossClusterMigration provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationContainerCreationInput": { + "description": "A2ACrossClusterMigration cloud creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationEnableProtectionInput": { + "description": "A2A Cross-Cluster Migration enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationPolicyCreationInput": { + "description": "A2A Cross-Cluster Migration Policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationReplicationDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "primaryFabricLocation": { + "description": "Primary fabric location.", + "type": "string" + }, + "osType": { + "description": "The type of operating system.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "lifecycleId": { + "description": "An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the \"same\" protected item even though other internal Ids/ARM Id might be changing.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2AEnableProtectionInput": { + "description": "A2A enable protection input.", + "required": [ + "fabricObjectId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "recoveryCloudServiceId": { + "description": "The recovery cloud service Id. Valid for V1 scenarios.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group id.", + "type": "string" + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for two pass flows)." + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery extended location." + }, + "recoveryAzureNetworkId": { + "description": "The recovery Azure virtual network ARM id.", + "type": "string" + }, + "recoverySubnetName": { + "description": "The recovery subnet name.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The virtual machine scale set Id.", + "type": "string" + }, + "recoveryCapacityReservationGroupId": { + "description": "The recovery capacity reservation group Id.", + "type": "string" + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AEventDetails": { + "description": "Model class for event details of a A2A event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item arm name.", + "type": "string" + }, + "fabricObjectId": { + "description": "The azure vm arm id.", + "type": "string" + }, + "fabricName": { + "description": "Fabric arm name.", + "type": "string" + }, + "fabricLocation": { + "description": "The fabric location.", + "type": "string" + }, + "remoteFabricName": { + "description": "Remote fabric arm name.", + "type": "string" + }, + "remoteFabricLocation": { + "description": "Remote fabric location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AExtendedLocationDetails": { + "description": "ExtendedLocation details data.", + "type": "object", + "properties": { + "primaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The primary ExtendedLocation." + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery ExtendedLocation." + } + } + }, + "A2AFabricSpecificLocationDetails": { + "description": "ExtendedLocation details data.", + "type": "object", + "properties": { + "initialPrimaryZone": { + "description": "The initial source zone info.", + "type": "string" + }, + "initialRecoveryZone": { + "description": "The initial target zone info.", + "type": "string" + }, + "initialPrimaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The initial primary ExtendedLocation." + }, + "initialRecoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The initial recovery ExtendedLocation." + }, + "initialPrimaryFabricLocation": { + "description": "Initial primary fabric location info.", + "type": "string" + }, + "initialRecoveryFabricLocation": { + "description": "The initial recovery fabric location info.", + "type": "string" + }, + "primaryZone": { + "description": "Source zone info.", + "type": "string" + }, + "recoveryZone": { + "description": "The target zone info.", + "type": "string" + }, + "primaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The primary ExtendedLocation." + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery ExtendedLocation." + }, + "primaryFabricLocation": { + "description": "Primary fabric location info.", + "type": "string" + }, + "recoveryFabricLocation": { + "description": "The recovery fabric location info.", + "type": "string" + } + } + }, + "A2APolicyCreationInput": { + "description": "A2A Policy creation input.", + "required": [ + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2APolicyDetails": { + "description": "A2A specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AProtectedDiskDetails": { + "description": "A2A protected disk details.", + "type": "object", + "properties": { + "diskUri": { + "description": "The disk uri.", + "type": "string" + }, + "recoveryAzureStorageAccountId": { + "description": "The recovery disk storage account.", + "type": "string" + }, + "primaryDiskAzureStorageAccountId": { + "description": "The primary disk storage account.", + "type": "string" + }, + "recoveryDiskUri": { + "description": "Recovery disk uri.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account.", + "type": "string" + }, + "diskType": { + "description": "The type of disk.", + "type": "string" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "boolean" + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "dataPendingInStagingStorageAccountInMB": { + "format": "double", + "description": "The data pending for replication in MB at staging account.", + "type": "number" + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source virtual machine in MB.", + "type": "number" + }, + "diskState": { + "description": "The disk state.", + "type": "string" + }, + "allowedDiskLevelOperation": { + "description": "The disk level operations list.", + "type": "array", + "items": { + "type": "string" + } + }, + "isDiskEncrypted": { + "description": "A value indicating whether vm has encrypted os disk or not.", + "type": "boolean" + }, + "secretIdentifier": { + "description": "The secret URL / identifier (BEK).", + "type": "string" + }, + "dekKeyVaultArmId": { + "description": "The KeyVault resource id for secret (BEK).", + "type": "string" + }, + "isDiskKeyEncrypted": { + "description": "A value indicating whether disk key got encrypted or not.", + "type": "boolean" + }, + "keyIdentifier": { + "description": "The key URL / identifier (KEK).", + "type": "string" + }, + "kekKeyVaultArmId": { + "description": "The KeyVault resource id for key (KEK).", + "type": "string" + }, + "failoverDiskName": { + "description": "The failover name for the managed disk.", + "type": "string" + }, + "tfoDiskName": { + "description": "The test failover name for the managed disk.", + "type": "string" + } + } + }, + "A2AProtectedManagedDiskDetails": { + "description": "A2A protected managed disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The managed disk Arm id.", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The recovery disk resource group Arm Id.", + "type": "string" + }, + "recoveryTargetDiskId": { + "description": "Recovery target disk Arm Id.", + "type": "string" + }, + "recoveryReplicaDiskId": { + "description": "Recovery replica disk Arm Id.", + "type": "string" + }, + "recoveryOrignalTargetDiskId": { + "description": "Recovery original target disk Arm Id.", + "type": "string" + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryDiskEncryptionSetId": { + "description": "The recovery disk encryption set Id.", + "type": "string" + }, + "primaryDiskEncryptionSetId": { + "description": "The primary disk encryption set Id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account.", + "type": "string" + }, + "diskType": { + "description": "The type of disk.", + "type": "string" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "boolean" + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "dataPendingInStagingStorageAccountInMB": { + "format": "double", + "description": "The data pending for replication in MB at staging account.", + "type": "number" + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source virtual machine in MB.", + "type": "number" + }, + "diskState": { + "description": "The disk state.", + "type": "string" + }, + "allowedDiskLevelOperation": { + "description": "The disk level operations list.", + "type": "array", + "items": { + "type": "string" + } + }, + "isDiskEncrypted": { + "description": "A value indicating whether vm has encrypted os disk or not.", + "type": "boolean" + }, + "secretIdentifier": { + "description": "The secret URL / identifier (BEK).", + "type": "string" + }, + "dekKeyVaultArmId": { + "description": "The KeyVault resource id for secret (BEK).", + "type": "string" + }, + "isDiskKeyEncrypted": { + "description": "A value indicating whether disk key got encrypted or not.", + "type": "boolean" + }, + "keyIdentifier": { + "description": "The key URL / identifier (KEK).", + "type": "string" + }, + "kekKeyVaultArmId": { + "description": "The KeyVault resource id for key (KEK).", + "type": "string" + }, + "failoverDiskName": { + "description": "The failover name for the managed disk.", + "type": "string" + }, + "tfoDiskName": { + "description": "The test failover name for the managed disk.", + "type": "string" + } + } + }, + "A2AProtectionContainerMappingDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + }, + "automationAccountAuthenticationType": { + "description": "A value indicating the type authentication to use for automation Account.", + "enum": [ + "RunAsAccount", + "SystemAssignedIdentity" + ], + "type": "string", + "default": "RunAsAccount", + "x-ms-enum": { + "name": "AutomationAccountAuthenticationType", + "modelAsString": true + } + }, + "scheduleName": { + "description": "The schedule arm name.", + "type": "string" + }, + "jobScheduleName": { + "description": "The job schedule arm name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AProtectionIntentDiskInputDetails": { + "description": "Azure VM unmanaged disk input details.", + "required": [ + "diskUri" + ], + "type": "object", + "properties": { + "diskUri": { + "description": "The disk Uri.", + "type": "string" + }, + "recoveryAzureStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The recovery VHD storage account input." + }, + "primaryStagingStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account input." + } + } + }, + "A2AProtectionIntentManagedDiskInputDetails": { + "description": "Azure VM managed disk input details.", + "required": [ + "diskId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "primaryStagingStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account input." + }, + "recoveryResourceGroupCustomInput": { + "$ref": "#/definitions/RecoveryResourceGroupCustomDetails", + "description": "The recovery resource group input." + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryDiskEncryptionSetId": { + "description": "The recovery disk encryption set Id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for one / single pass flows)." + } + } + }, + "A2ARecoveryPointDetails": { + "description": "A2A provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "recoveryPointSyncType": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "enum": [ + "MultiVmSyncRecoveryPoint", + "PerVmRecoveryPoint" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointSyncType", + "modelAsString": true + } + }, + "disks": { + "description": "List of disk ids representing a recovery point.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ARemoveDisksInput": { + "description": "A2A remove disk(s) input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RemoveDisksProviderSpecificInput" + } + ], + "properties": { + "vmDisksUris": { + "description": "The list of vm disk vhd URIs.", + "type": "array", + "items": { + "type": "string" + } + }, + "vmManagedDisksIds": { + "description": "The list of vm managed disk Ids.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReplicationDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "initialPrimaryZone": { + "description": "The initial primary availability zone.", + "type": "string", + "readOnly": true + }, + "initialPrimaryFabricLocation": { + "description": "The initial primary fabric location.", + "type": "string", + "readOnly": true + }, + "initialRecoveryZone": { + "description": "The initial recovery availability zone.", + "type": "string", + "readOnly": true + }, + "initialPrimaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The initial primary extended location." + }, + "initialRecoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The initial recovery extended location." + }, + "initialRecoveryFabricLocation": { + "description": "The initial recovery fabric location.", + "type": "string", + "readOnly": true + }, + "multiVmGroupId": { + "description": "The multi vm group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupCreateOption": { + "description": "Whether Multi VM group is auto created or specified by user.", + "enum": [ + "AutoCreated", + "UserSpecified" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmGroupCreateOption", + "modelAsString": true + } + }, + "managementId": { + "description": "The management Id.", + "type": "string" + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectedDiskDetails" + } + }, + "unprotectedDisks": { + "description": "The list of unprotected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AUnprotectedDiskDetails" + } + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectedManagedDiskDetails" + } + }, + "recoveryBootDiagStorageAccountId": { + "description": "The recovery boot diagnostic storage account Arm Id.", + "type": "string" + }, + "primaryFabricLocation": { + "description": "Primary fabric location.", + "type": "string" + }, + "recoveryFabricLocation": { + "description": "The recovery fabric location.", + "type": "string" + }, + "osType": { + "description": "The type of operating system.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "The size of recovery virtual machine.", + "type": "string" + }, + "recoveryAzureVMName": { + "description": "The name of recovery virtual machine.", + "type": "string" + }, + "recoveryAzureResourceGroupId": { + "description": "The recovery resource group.", + "type": "string" + }, + "recoveryCloudService": { + "description": "The recovery cloud service.", + "type": "string" + }, + "recoveryAvailabilitySet": { + "description": "The recovery availability set.", + "type": "string" + }, + "selectedRecoveryAzureNetworkId": { + "description": "The recovery virtual network.", + "type": "string" + }, + "selectedTfoAzureNetworkId": { + "description": "The test failover virtual network.", + "type": "string" + }, + "vmNics": { + "description": "The virtual machine nic details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmSyncedConfigDetails": { + "$ref": "#/definitions/AzureToAzureVmSyncedConfigDetails", + "description": "The synced configuration details." + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the source server.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "isReplicationAgentUpdateRequired": { + "description": "A value indicating whether replication agent update is required.", + "type": "boolean" + }, + "agentCertificateExpiryDate": { + "format": "date-time", + "description": "Agent certificate expiry date.", + "type": "string", + "readOnly": true + }, + "isReplicationAgentCertificateUpdateRequired": { + "description": "A value indicating whether agent certificate update is required.", + "type": "boolean" + }, + "recoveryFabricObjectId": { + "description": "The recovery fabric object Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "lifecycleId": { + "description": "An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the \"same\" protected item even though other internal Ids/ARM Id might be changing.", + "type": "string" + }, + "testFailoverRecoveryFabricObjectId": { + "description": "The test failover fabric object Id.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The last RPO value in seconds.", + "type": "integer" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The time (in UTC) when the last RPO value was calculated by Protection Service.", + "type": "string" + }, + "primaryAvailabilityZone": { + "description": "The primary availability zone.", + "type": "string" + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "primaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The primary Extended Location." + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery Extended Location." + }, + "vmEncryptionType": { + "description": "The encryption type of the VM.", + "type": "string", + "readOnly": true, + "enum": [ + "NotEncrypted", + "OnePassEncrypted", + "TwoPassEncrypted" + ], + "x-ms-enum": { + "name": "VmEncryptionType", + "modelAsString": true + } + }, + "tfoAzureVMName": { + "description": "The test failover vm name.", + "type": "string" + }, + "recoveryAzureGeneration": { + "description": "The recovery azure generation.", + "type": "string", + "readOnly": true + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The recovery virtual machine scale set id.", + "type": "string" + }, + "recoveryCapacityReservationGroupId": { + "description": "The recovery capacity reservation group Id.", + "type": "string" + }, + "churnOptionSelected": { + "description": "A value indicating the churn option selected by user.", + "type": "string", + "readOnly": true, + "enum": [ + "Normal", + "High" + ], + "x-ms-enum": { + "name": "ChurnOptionSelected", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReplicationIntentDetails": { + "description": "A2A provider specific settings.", + "required": [ + "recoveryAvailabilityType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProtectionIntentProviderSpecificSettings" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "primaryLocation": { + "description": "The primary location for the virtual machine.", + "type": "string" + }, + "recoveryLocation": { + "description": "The recovery location for the virtual machine.", + "type": "string" + }, + "recoverySubscriptionId": { + "description": "The recovery subscription Id of the virtual machine.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentManagedDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group id.", + "type": "string" + }, + "protectionProfile": { + "$ref": "#/definitions/ProtectionProfileCustomDetails", + "description": "The protection profile custom details." + }, + "primaryStagingStorageAccount": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account details." + }, + "recoveryAvailabilitySet": { + "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails", + "description": "The recovery availability set details." + }, + "recoveryVirtualNetwork": { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails", + "description": "The recovery virtual network details." + }, + "recoveryProximityPlacementGroup": { + "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails", + "description": "The recovery proximity placement group custom details." + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group id.", + "type": "string" + }, + "recoveryBootDiagStorageAccount": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The boot diagnostic storage account." + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for two pass flows)." + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryAvailabilityType": { + "description": "The recovery availability type of the virtual machine.", + "type": "string" + }, + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + }, + "automationAccountAuthenticationType": { + "description": "A value indicating the type authentication to use for automation Account.", + "enum": [ + "RunAsAccount", + "SystemAssignedIdentity" + ], + "type": "string", + "default": "RunAsAccount", + "x-ms-enum": { + "name": "AutomationAccountAuthenticationType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReprotectInput": { + "description": "Azure specific reprotect input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "recoveryCloudServiceId": { + "description": "The recovery cloud service Id. Valid for V1 scenarios.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ASwitchProtectionInput": { + "description": "A2A specific switch protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SwitchProtectionProviderSpecificInput" + } + ], + "properties": { + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "recoveryCloudServiceId": { + "description": "The recovery cloud service Id. Valid for V1 scenarios.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The virtual machine scale set id.", + "type": "string" + }, + "recoveryCapacityReservationGroupId": { + "description": "The recovery capacity reservation group Id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information." + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ATestFailoverInput": { + "description": "A2A provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for TFO or not.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUnplannedFailoverInput": { + "description": "A2A provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for failover or not.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUnprotectedDiskDetails": { + "description": "A2A unprotected disk details.", + "type": "object", + "properties": { + "diskLunId": { + "format": "int32", + "description": "The source lun Id for the data disk.", + "type": "integer" + }, + "diskAutoProtectionStatus": { + "description": "A value indicating whether the disk auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + } + } + }, + "A2AUpdateContainerMappingInput": { + "description": "A2A update protection container mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + }, + "automationAccountAuthenticationType": { + "description": "A value indicating the type authentication to use for automation Account.", + "enum": [ + "RunAsAccount", + "SystemAssignedIdentity" + ], + "type": "string", + "default": "RunAsAccount", + "x-ms-enum": { + "name": "AutomationAccountAuthenticationType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUpdateReplicationProtectedItemInput": { + "description": "InMage Azure V2 input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "recoveryCloudServiceId": { + "description": "The target cloud service ARM Id (for V1).", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The target resource group ARM Id (for V2).", + "type": "string" + }, + "managedDiskUpdateDetails": { + "description": "Managed disk update details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskUpdateDetails" + } + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery os disk encryption information." + }, + "tfoAzureVMName": { + "description": "The user given name for Test Failover VM.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The recovery virtual machine scale set Id.", + "type": "string" + }, + "recoveryCapacityReservationGroupId": { + "description": "The recovery capacity reservation group Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AVmDiskInputDetails": { + "description": "A2A disk input details.", + "required": [ + "diskUri", + "recoveryAzureStorageAccountId", + "primaryStagingAzureStorageAccountId" + ], + "type": "object", + "properties": { + "diskUri": { + "description": "The disk Uri.", + "type": "string" + }, + "recoveryAzureStorageAccountId": { + "description": "The recovery VHD storage account Id.", + "type": "string" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account Id.", + "type": "string" + } + } + }, + "A2AVmManagedDiskInputDetails": { + "description": "A2A managed disk input details.", + "required": [ + "diskId", + "primaryStagingAzureStorageAccountId", + "recoveryResourceGroupId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account Arm Id.", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The target resource group Arm Id.", + "type": "string" + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryDiskEncryptionSetId": { + "description": "The recovery disk encryption set Id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for one / single pass flows)." + } + } + }, + "A2AVmManagedDiskUpdateDetails": { + "description": "A2A Vm managed disk update details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type before failover.", + "type": "string" + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type before failover.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery os disk encryption information." + }, + "failoverDiskName": { + "description": "The target disk name for unplanned failover operation.", + "type": "string" + }, + "tfoDiskName": { + "description": "The target disk name for test failover operation.", + "type": "string" + } + } + }, + "A2AZoneDetails": { + "description": "Zone details data.", + "type": "object", + "properties": { + "source": { + "description": "Source zone info.", + "type": "string" + }, + "target": { + "description": "The target zone info.", + "type": "string" + } + } + }, + "AddDisksInput": { + "description": "Input for add disk(s) operation.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddDisksInputProperties", + "description": "Add disks input properties." + } + } + }, + "AddDisksInputProperties": { + "description": "Add Disks input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/AddDisksProviderSpecificInput", + "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." + } + } + }, + "AddDisksProviderSpecificInput": { + "description": "Add Disks provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "AddRecoveryServicesProviderInput": { + "description": "Input required to add a provider.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddRecoveryServicesProviderInputProperties", + "description": "The properties of an add provider request." + } + } + }, + "AddRecoveryServicesProviderInputProperties": { + "description": "The properties of an add provider request.", + "required": [ + "machineName", + "authenticationIdentityInput", + "resourceAccessIdentityInput" + ], + "type": "object", + "properties": { + "machineName": { + "description": "The name of the machine where the provider is getting added.", + "type": "string" + }, + "machineId": { + "description": "The Id of the machine where the provider is getting added.", + "type": "string" + }, + "biosId": { + "description": "The Bios Id of the machine.", + "type": "string" + }, + "authenticationIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for DRA authentication." + }, + "resourceAccessIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for resource access." + }, + "dataPlaneAuthenticationIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for data plane authentication." + } + } + }, + "AddVCenterRequest": { + "description": "Input required to add vCenter.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddVCenterRequestProperties", + "description": "The properties of an add vCenter request." + } + } + }, + "AddVCenterRequestProperties": { + "description": "The properties of an add vCenter request.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name of the vCenter.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the vCenter to be discovered.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id from where the discovery is orchestrated.", + "type": "string" + }, + "port": { + "description": "The port number for discovery.", + "type": "string" + }, + "runAsAccountId": { + "description": "The account Id which has privileges to discover the vCenter.", + "type": "string" + } + } + }, + "AgentDetails": { + "description": "Agent details.", + "type": "object", + "properties": { + "agentId": { + "description": "The Id of the agent running on the server.", + "type": "string", + "readOnly": true + }, + "machineId": { + "description": "The Id of the machine to which the agent is registered.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The machine BIOS Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The machine FQDN.", + "type": "string", + "readOnly": true + }, + "disks": { + "description": "The disks.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDiskDetails" + }, + "readOnly": true + } + } + }, + "AgentDiskDetails": { + "description": "Agent disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "lunId": { + "format": "int32", + "description": "The lun of disk.", + "type": "integer", + "readOnly": true + } + } + }, + "Alert": { + "description": "Implements the Alert class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AlertProperties", + "description": "Alert related data." + } + } + }, + "AlertCollection": { + "description": "Collection of alerts.", + "type": "object", + "properties": { + "value": { + "description": "The list of alerts.", + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "AlertProperties": { + "description": "The properties of an alert.", + "type": "object", + "properties": { + "sendToOwners": { + "description": "A value indicating whether to send email to subscription administrator.", + "type": "string" + }, + "customEmailAddresses": { + "description": "The custom email address for sending emails.", + "type": "array", + "items": { + "type": "string" + } + }, + "locale": { + "description": "The locale for the email notification.", + "type": "string" + } + } + }, + "ApplianceCollection": { + "description": "Collection of appliance details.", + "type": "object", + "properties": { + "value": { + "description": "The appliance details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationAppliance" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ApplianceMonitoringDetails": { + "description": "Appliance details of the migration item.", + "type": "object", + "properties": { + "cpuDetails": { + "$ref": "#/definitions/ApplianceResourceDetails", + "description": "The appliance CPU details.", + "readOnly": true + }, + "ramDetails": { + "$ref": "#/definitions/ApplianceResourceDetails", + "description": "The appliance RAM details.", + "readOnly": true + }, + "datastoreSnapshot": { + "description": "The appliance datastore snapshot details.", + "type": "array", + "items": { + "$ref": "#/definitions/DataStoreUtilizationDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disksReplicationDetails": { + "$ref": "#/definitions/ApplianceResourceDetails", + "description": "The disk replication details.", + "readOnly": true + }, + "esxiNfcBuffer": { + "$ref": "#/definitions/ApplianceResourceDetails", + "description": "The ESXi NFC buffer details.", + "readOnly": true + }, + "networkBandwidth": { + "$ref": "#/definitions/ApplianceResourceDetails", + "description": "The appliance network bandwidth details.", + "readOnly": true + } + } + }, + "ApplianceQueryParameter": { + "description": "Query parameter to get appliance.", + "type": "object", + "properties": { + "providerType": { + "description": "The providerType to be used for fetching appliance details.", + "type": "string" + } + } + }, + "ApplianceResourceDetails": { + "description": "Details of the appliance resource.", + "type": "object", + "properties": { + "capacity": { + "format": "int64", + "description": "A value indicating the total capacity of appliance resource.", + "type": "integer", + "readOnly": true + }, + "processUtilization": { + "format": "double", + "description": "A value indicating the utilization percentage by gateway agent on appliance.", + "type": "number", + "readOnly": true + }, + "totalUtilization": { + "format": "double", + "description": "A value indicating the total utilization percentage for all processes on the appliance.", + "type": "number", + "readOnly": true + }, + "status": { + "description": "A value indicating the status of appliance resource.", + "type": "string", + "readOnly": true + } + } + }, + "ApplianceSpecificDetails": { + "description": "Appliance specific details.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType", + "required": [ + "instanceType" + ] + }, + "ApplyRecoveryPointInput": { + "description": "Input to apply recovery point.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ApplyRecoveryPointInputProperties", + "description": "The input properties to apply recovery point." + } + } + }, + "ApplyRecoveryPointInputProperties": { + "description": "Input properties to apply recovery point.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput", + "description": "Provider specific input for applying recovery point." + } + } + }, + "ApplyRecoveryPointProviderSpecificInput": { + "description": "Provider specific input for apply recovery point.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "AsrJobDetails": { + "description": "This class represents job details based on specific job type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "AsrJobDetails" + }, + "ASRTask": { + "description": "Task of the Job.", + "type": "object", + "properties": { + "taskId": { + "description": "The Id.", + "type": "string" + }, + "name": { + "description": "The unique Task name.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "allowedActions": { + "description": "The state/actions applicable on this task.", + "type": "array", + "items": { + "type": "string" + } + }, + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "state": { + "description": "The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.", + "type": "string" + }, + "stateDescription": { + "description": "The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.", + "type": "string" + }, + "taskType": { + "description": "The type of task. Details in CustomDetails property depend on this type.", + "type": "string" + }, + "customDetails": { + "$ref": "#/definitions/TaskTypeDetails", + "description": "The custom task details based on the task type." + }, + "groupTaskCustomDetails": { + "$ref": "#/definitions/GroupTaskDetails", + "description": "The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it." + }, + "errors": { + "description": "The task error details.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + } + } + } + }, + "AutomationRunbookTaskDetails": { + "description": "This class represents the task details for an automation runbook.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "name": { + "description": "The recovery plan task name.", + "type": "string" + }, + "cloudServiceName": { + "description": "The cloud service of the automation runbook account.", + "type": "string" + }, + "subscriptionId": { + "description": "The subscription Id of the automation runbook account.", + "type": "string" + }, + "accountName": { + "description": "The automation account name of the runbook.", + "type": "string" + }, + "runbookId": { + "description": "The runbook Id.", + "type": "string" + }, + "runbookName": { + "description": "The runbook name.", + "type": "string" + }, + "jobId": { + "description": "The job Id of the runbook execution.", + "type": "string" + }, + "jobOutput": { + "description": "The execution output of the runbook.", + "type": "string" + }, + "isPrimarySideScript": { + "description": "A value indicating whether it is a primary side script or not.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "AutomationRunbookTaskDetails" + }, + "AzureFabricCreationInput": { + "description": "Fabric provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "location": { + "description": "The Location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Azure" + }, + "AzureFabricSpecificDetails": { + "description": "Azure Fabric Specific Details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "location": { + "description": "The Location for the Azure fabric.", + "type": "string" + }, + "containerIds": { + "description": "The container Ids for the Azure fabric.", + "type": "array", + "items": { + "type": "string" + } + }, + "zones": { + "description": "The zones.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AZoneDetails" + } + }, + "extendedLocations": { + "description": "The ExtendedLocations.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AExtendedLocationDetails" + }, + "x-ms-identifiers": [] + }, + "locationDetails": { + "description": "The location details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AFabricSpecificLocationDetails" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "Azure" + }, + "AzureToAzureCreateNetworkMappingInput": { + "description": "Create network mappings input properties/behavior specific to Azure to Azure Network mapping.", + "required": [ + "primaryNetworkId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" + } + ], + "properties": { + "primaryNetworkId": { + "description": "The primary azure vnet Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureToAzure" + }, + "AzureToAzureNetworkMappingSettings": { + "description": "A2A Network Mapping fabric specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" + } + ], + "properties": { + "primaryFabricLocation": { + "description": "The primary fabric location.", + "type": "string" + }, + "recoveryFabricLocation": { + "description": "The recovery fabric location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureToAzure" + }, + "AzureToAzureUpdateNetworkMappingInput": { + "description": "Updates network mappings input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" + } + ], + "properties": { + "primaryNetworkId": { + "description": "The primary azure vnet Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureToAzure" + }, + "AzureToAzureVmSyncedConfigDetails": { + "description": "Azure to Azure VM synced configuration details.", + "type": "object", + "properties": { + "tags": { + "description": "The Azure VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "inputEndpoints": { + "description": "The Azure VM input endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/InputEndpoint" + } + } + } + }, + "AzureVmDiskDetails": { + "description": "Disk details for E2A provider.", + "type": "object", + "properties": { + "vhdType": { + "description": "VHD type.", + "type": "string" + }, + "vhdId": { + "description": "The VHD id.", + "type": "string" + }, + "diskId": { + "description": "The disk resource id.", + "type": "string" + }, + "vhdName": { + "description": "VHD name.", + "type": "string" + }, + "maxSizeMB": { + "description": "Max side in MB.", + "type": "string" + }, + "targetDiskLocation": { + "description": "Blob uri of the Azure disk.", + "type": "string" + }, + "targetDiskName": { + "description": "The target Azure disk name.", + "type": "string" + }, + "lunId": { + "description": "Ordinal\\LunId of the disk for the Azure VM.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + }, + "customTargetDiskName": { + "description": "The custom target Azure disk name.", + "type": "string" + } + } + }, + "ComputeSizeErrorDetails": { + "description": "Represents the error used to indicate why the target compute size is not applicable.", + "type": "object", + "properties": { + "message": { + "description": "The error message.", + "type": "string" + }, + "severity": { + "description": "The severity of the error.", + "type": "string" + } + } + }, + "ConfigurationSettings": { + "description": "Replication provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ConfigureAlertRequest": { + "description": "Request to configure alerts for the system.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigureAlertRequestProperties", + "description": "The properties of a configure alert request." + } + } + }, + "ConfigureAlertRequestProperties": { + "description": "Properties of a configure alert request.", + "type": "object", + "properties": { + "sendToOwners": { + "description": "A value indicating whether to send email to subscription administrator.", + "type": "string" + }, + "customEmailAddresses": { + "description": "The custom email address for sending emails.", + "type": "array", + "items": { + "type": "string" + } + }, + "locale": { + "description": "The locale for the email notification.", + "type": "string" + } + } + }, + "ConsistencyCheckTaskDetails": { + "description": "This class contains monitoring details of all the inconsistent Protected Entities in Vmm.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "vmDetails": { + "description": "The list of inconsistent Vm details.", + "type": "array", + "items": { + "$ref": "#/definitions/InconsistentVmDetails" + } + } + }, + "x-ms-discriminator-value": "ConsistencyCheckTaskDetails" + }, + "CreateNetworkMappingInput": { + "description": "Create network mappings input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateNetworkMappingInputProperties", + "description": "Input properties for creating network mapping." + } + } + }, + "CreateNetworkMappingInputProperties": { + "description": "Common input details for network mapping operation.", + "required": [ + "recoveryNetworkId" + ], + "type": "object", + "properties": { + "recoveryFabricName": { + "description": "Recovery fabric Name.", + "type": "string" + }, + "recoveryNetworkId": { + "description": "Recovery network Id.", + "type": "string" + }, + "fabricSpecificDetails": { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput", + "description": "Fabric specific input properties." + } + } + }, + "CreatePolicyInput": { + "description": "Protection Policy input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreatePolicyInputProperties", + "description": "Policy creation properties." + } + } + }, + "CreatePolicyInputProperties": { + "description": "Policy creation properties.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/PolicyProviderSpecificInput", + "description": "The ReplicationProviderSettings." + } + } + }, + "CreateProtectionContainerInput": { + "description": "Create protection container input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateProtectionContainerInputProperties", + "description": "Create protection container input properties." + } + } + }, + "CreateProtectionContainerInputProperties": { + "description": "Create protection container input properties.", + "type": "object", + "properties": { + "providerSpecificInput": { + "description": "Provider specific inputs for container creation.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + } + } + }, + "CreateProtectionContainerMappingInput": { + "description": "Configure pairing input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateProtectionContainerMappingInputProperties", + "description": "Configure protection input properties." + } + } + }, + "CreateProtectionContainerMappingInputProperties": { + "description": "Configure pairing input properties.", + "type": "object", + "properties": { + "targetProtectionContainerId": { + "description": "The target unique protection container name.", + "type": "string" + }, + "policyId": { + "description": "Applicable policy.", + "type": "string" + }, + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput", + "description": "Provider specific input for pairing." + } + } + }, + "CreateProtectionIntentInput": { + "description": "Create protection intent input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateProtectionIntentProperties", + "description": "Create protection intent input properties." + } + } + }, + "CreateProtectionIntentProperties": { + "description": "Create protection intent input properties.", + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/CreateProtectionIntentProviderSpecificDetails", + "description": "The ReplicationProviderInput. For A2A provider, it will be A2ACreateProtectionIntentInput object." + } + } + }, + "CreateProtectionIntentProviderSpecificDetails": { + "description": "Create protection intent provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "CreateRecoveryPlanInput": { + "description": "Create recovery plan input class.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateRecoveryPlanInputProperties", + "description": "Recovery plan creation properties." + } + } + }, + "CreateRecoveryPlanInputProperties": { + "description": "Recovery plan creation properties.", + "required": [ + "primaryFabricId", + "recoveryFabricId", + "groups" + ], + "type": "object", + "properties": { + "primaryFabricId": { + "description": "The primary fabric Id.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The recovery fabric Id.", + "type": "string" + }, + "failoverDeploymentModel": { + "description": "The failover deployment model.", + "enum": [ + "NotApplicable", + "Classic", + "ResourceManager" + ], + "type": "string", + "x-ms-enum": { + "name": "FailoverDeploymentModel", + "modelAsString": true + } + }, + "groups": { + "description": "The recovery plan groups.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanGroup" + } + }, + "providerSpecificInput": { + "description": "The provider specific input.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificInput" + } + } + } + }, + "CriticalJobHistoryDetails": { + "description": "Critical past job details of the migration item.", + "type": "object", + "properties": { + "jobName": { + "description": "The job name.", + "type": "string", + "readOnly": true + }, + "jobId": { + "description": "The ARM Id of the job being executed.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "The start time of the job.", + "type": "string", + "readOnly": true + }, + "jobStatus": { + "description": "The job state.", + "type": "string", + "readOnly": true + } + } + }, + "CurrentJobDetails": { + "description": "Current job details of the migration item.", + "type": "object", + "properties": { + "jobName": { + "description": "The job name.", + "type": "string", + "readOnly": true + }, + "jobId": { + "description": "The ARM Id of the job being executed.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "The start time of the job.", + "type": "string", + "readOnly": true + } + } + }, + "CurrentScenarioDetails": { + "description": "Current scenario details of the protected entity.", + "type": "object", + "properties": { + "scenarioName": { + "description": "Scenario name.", + "type": "string" + }, + "jobId": { + "description": "ARM Id of the job being executed.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "Start time of the workflow.", + "type": "string" + } + } + }, + "DataStore": { + "description": "The datastore details of the MT.", + "type": "object", + "properties": { + "symbolicName": { + "description": "The symbolic name of data store.", + "type": "string" + }, + "uuid": { + "description": "The uuid of data store.", + "type": "string" + }, + "capacity": { + "description": "The capacity of data store in GBs.", + "type": "string" + }, + "freeSpace": { + "description": "The free space of data store in GBs.", + "type": "string" + }, + "type": { + "description": "The type of data store.", + "type": "string" + } + } + }, + "DataStoreUtilizationDetails": { + "description": "Details of the appliance resource.", + "type": "object", + "properties": { + "totalSnapshotsSupported": { + "format": "int64", + "description": "The total count of snapshots supported by the datastore.", + "type": "integer", + "readOnly": true + }, + "totalSnapshotsCreated": { + "format": "int64", + "description": "The total snapshots created for server migration in the datastore.", + "type": "integer", + "readOnly": true + }, + "dataStoreName": { + "description": "The datastore name.", + "type": "string", + "readOnly": true + } + } + }, + "DisableProtectionInput": { + "description": "Disable protection input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DisableProtectionInputProperties", + "description": "Disable protection input properties." + } + } + }, + "DisableProtectionInputProperties": { + "description": "Disable protection input properties.", + "type": "object", + "properties": { + "disableProtectionReason": { + "description": "Disable protection reason. It can have values NotSpecified/MigrationComplete.", + "enum": [ + "NotSpecified", + "MigrationComplete" + ], + "type": "string", + "x-ms-enum": { + "name": "DisableProtectionReason", + "modelAsString": true + } + }, + "replicationProviderInput": { + "$ref": "#/definitions/DisableProtectionProviderSpecificInput", + "description": "Replication provider specific input." + } + } + }, + "DisableProtectionProviderSpecificInput": { + "description": "Disable protection provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "DiscoverProtectableItemRequest": { + "description": "Request to add a physical machine as a protectable item in a container.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DiscoverProtectableItemRequestProperties", + "description": "The properties of a discover protectable item request." + } + } + }, + "DiscoverProtectableItemRequestProperties": { + "description": "Discover protectable item properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name of the physical machine.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the physical machine to be discovered.", + "type": "string" + }, + "osType": { + "description": "The OS type on the physical machine.", + "type": "string" + } + } + }, + "DiskDetails": { + "description": "Onprem disk details data.", + "type": "object", + "properties": { + "maxSizeMB": { + "format": "int64", + "description": "The hard disk max size in MB.", + "type": "integer" + }, + "vhdType": { + "description": "The type of the volume.", + "type": "string" + }, + "vhdId": { + "description": "The VHD Id.", + "type": "string" + }, + "vhdName": { + "description": "The VHD name.", + "type": "string" + } + } + }, + "DiskEncryptionInfo": { + "description": "Recovery disk encryption info (BEK and KEK).", + "type": "object", + "properties": { + "diskEncryptionKeyInfo": { + "$ref": "#/definitions/DiskEncryptionKeyInfo", + "description": "The recovery KeyVault reference for secret." + }, + "keyEncryptionKeyInfo": { + "$ref": "#/definitions/KeyEncryptionKeyInfo", + "description": "The recovery KeyVault reference for key." + } + } + }, + "DiskEncryptionKeyInfo": { + "description": "Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows).", + "type": "object", + "properties": { + "secretIdentifier": { + "description": "The secret url / identifier.", + "type": "string" + }, + "keyVaultResourceArmId": { + "description": "The KeyVault resource ARM id for secret.", + "type": "string" + } + } + }, + "DiskVolumeDetails": { + "description": "Volume details.", + "type": "object", + "properties": { + "label": { + "description": "The volume label.", + "type": "string" + }, + "name": { + "description": "The volume name.", + "type": "string" + } + } + }, + "Display": { + "description": "Contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations.", + "type": "object", + "properties": { + "provider": { + "description": "The provider. The localized friendly form of the resource provider name - it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\".", + "type": "string" + }, + "resource": { + "description": "The resource. The localized friendly form of the resource related to this action/operation - it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should *not* reuse their parent's display.resource field). e.g. \"Virtual Machines\" or \"Scheduler Job Collections\", or \"Virtual Machine VM Sizes\" or \"Scheduler Jobs\".", + "type": "string" + }, + "operation": { + "description": "The operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName'.", + "type": "string" + }, + "description": { + "description": "The description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise - it will be used in tool tips and detailed views. Prescriptive guidance for namespaces: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespaces: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources'.", + "type": "string" + } + } + }, + "DraDetails": { + "description": "DRA details.", + "type": "object", + "properties": { + "id": { + "description": "The DRA Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The DRA name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The DRA Bios Id.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the DRA.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "forwardProtectedItemCount": { + "format": "int32", + "description": "The count of protected items which are protected in forward direction.", + "type": "integer", + "readOnly": true + }, + "reverseProtectedItemCount": { + "format": "int32", + "description": "The count of protected items which are protected in reverse direction.", + "type": "integer", + "readOnly": true + } + } + }, + "EnableMigrationInput": { + "description": "Enable migration input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EnableMigrationInputProperties", + "description": "Enable migration input properties." + } + } + }, + "EnableMigrationInputProperties": { + "description": "Enable migration input properties.", + "required": [ + "policyId", + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "policyId": { + "description": "The policy Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EnableMigrationProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "EnableMigrationProviderSpecificInput": { + "description": "Enable migration provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "EnableProtectionInput": { + "description": "Enable protection input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EnableProtectionInputProperties", + "description": "Enable protection input properties." + } + } + }, + "EnableProtectionInputProperties": { + "description": "Enable protection input properties.", + "type": "object", + "properties": { + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "protectableItemId": { + "description": "The protectable item Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput", + "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." + } + } + }, + "EnableProtectionProviderSpecificInput": { + "description": "Enable protection provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "EncryptionDetails": { + "description": "Encryption details for the fabric.", + "type": "object", + "properties": { + "kekState": { + "description": "The key encryption key state for the Vmm.", + "type": "string" + }, + "kekCertThumbprint": { + "description": "The key encryption key certificate thumbprint.", + "type": "string" + }, + "kekCertExpiryDate": { + "format": "date-time", + "description": "The key encryption key certificate expiry date.", + "type": "string" + } + } + }, + "Event": { + "description": "Implements the Event class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventProperties", + "description": "Event related data." + } + } + }, + "EventCollection": { + "description": "Collection of fabric details.", + "type": "object", + "properties": { + "value": { + "description": "The list of events.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "EventProperties": { + "description": "The properties of a monitoring event.", + "type": "object", + "properties": { + "eventCode": { + "description": "The Id of the monitoring event.", + "type": "string" + }, + "description": { + "description": "The event name.", + "type": "string" + }, + "eventType": { + "description": "The type of the event. for example: VM Health, Server Health, Job Failure etc.", + "type": "string" + }, + "affectedObjectFriendlyName": { + "description": "The friendly name of the source of the event on which it is raised (for example, VM, VMM etc).", + "type": "string" + }, + "affectedObjectCorrelationId": { + "description": "The affected object correlationId for the event.", + "type": "string" + }, + "severity": { + "description": "The severity of the event.", + "type": "string" + }, + "timeOfOccurrence": { + "format": "date-time", + "description": "The time of occurrence of the event.", + "type": "string" + }, + "fabricId": { + "description": "The ARM ID of the fabric.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EventProviderSpecificDetails", + "description": "The provider specific settings." + }, + "eventSpecificDetails": { + "$ref": "#/definitions/EventSpecificDetails", + "description": "The event specific settings." + }, + "healthErrors": { + "description": "The list of errors / warnings capturing details associated with the issue(s).", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + } + } + }, + "EventProviderSpecificDetails": { + "description": "Model class for provider specific details for an event.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "EventQueryParameter": { + "description": "Implements the event query parameter.", + "type": "object", + "properties": { + "eventCode": { + "description": "The source id of the events to be queried.", + "type": "string" + }, + "severity": { + "description": "The severity of the events to be queried.", + "type": "string" + }, + "eventType": { + "description": "The type of the events to be queried.", + "type": "string" + }, + "fabricName": { + "description": "The affected object server id of the events to be queried.", + "type": "string" + }, + "affectedObjectFriendlyName": { + "description": "The affected object name of the events to be queried.", + "type": "string" + }, + "affectedObjectCorrelationId": { + "description": "The affected object correlationId for the events to be queried.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time of the time range within which the events are to be queried.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time of the time range within which the events are to be queried.", + "type": "string" + } + } + }, + "EventSpecificDetails": { + "description": "Model class for event specific details for an event.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ExistingProtectionProfile": { + "description": "Existing storage account input.", + "required": [ + "protectionProfileId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionProfileCustomDetails" + } + ], + "properties": { + "protectionProfileId": { + "description": "The protection profile Arm Id. Throw error, if resource does not exists.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryAvailabilitySet": { + "description": "Existing recovery availability set input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails" + } + ], + "properties": { + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id. Will throw error, if resource does not exist.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryProximityPlacementGroup": { + "description": "Existing recovery proximity placement group input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails" + } + ], + "properties": { + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id. Will throw error, if resource does not exist.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryRecoveryResourceGroup": { + "description": "Existing recovery resource group input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryResourceGroupCustomDetails" + } + ], + "properties": { + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryVirtualNetwork": { + "description": "Existing recovery virtual network input.", + "required": [ + "recoveryVirtualNetworkId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails" + } + ], + "properties": { + "recoveryVirtualNetworkId": { + "description": "The recovery virtual network Id. Will throw error, if resource does not exist.", + "type": "string" + }, + "recoverySubnetName": { + "description": "The recovery subnet name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingStorageAccount": { + "description": "Existing storage account input.", + "required": [ + "azureStorageAccountId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StorageAccountCustomDetails" + } + ], + "properties": { + "azureStorageAccountId": { + "description": "The storage account Arm Id. Throw error, if resource does not exists.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExportJobDetails": { + "description": "This class represents details for export jobs workflow.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "blobUri": { + "description": "BlobUri of the exported jobs.", + "type": "string" + }, + "sasToken": { + "description": "The sas token to access blob.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ExportJobDetails" + }, + "ExtendedLocation": { + "description": "Extended location of the resource.", + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the extended location.", + "type": "string" + }, + "type": { + "description": "The extended location type.", + "enum": [ + "EdgeZone" + ], + "type": "string", + "x-ms-enum": { + "name": "ExtendedLocationType", + "modelAsString": true + } + } + } + }, + "Fabric": { + "description": "Fabric definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FabricProperties", + "description": "Fabric related data." + } + } + }, + "FabricCollection": { + "description": "Collection of fabric details.", + "type": "object", + "properties": { + "value": { + "description": "The fabric details.", + "type": "array", + "items": { + "$ref": "#/definitions/Fabric" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "FabricCreationInput": { + "description": "Site details provided during the time of site creation.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FabricCreationInputProperties", + "description": "Fabric creation input." + } + } + }, + "FabricCreationInputProperties": { + "description": "Properties of site details provided during the time of site creation.", + "type": "object", + "properties": { + "customDetails": { + "$ref": "#/definitions/FabricSpecificCreationInput", + "description": "Fabric provider specific creation input." + } + } + }, + "FabricProperties": { + "description": "Fabric properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Friendly name of the fabric.", + "type": "string" + }, + "encryptionDetails": { + "$ref": "#/definitions/EncryptionDetails", + "description": "Encryption details for the fabric." + }, + "rolloverEncryptionDetails": { + "$ref": "#/definitions/EncryptionDetails", + "description": "Rollover encryption details for the fabric." + }, + "internalIdentifier": { + "description": "Dra Registration Id.", + "type": "string" + }, + "bcdrState": { + "description": "BCDR state of the fabric.", + "type": "string" + }, + "customDetails": { + "$ref": "#/definitions/FabricSpecificDetails", + "description": "Fabric specific settings." + }, + "healthErrorDetails": { + "description": "Fabric health error details.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "health": { + "description": "Health of fabric.", + "type": "string" + } + } + }, + "FabricQueryParameter": { + "description": "Query parameter to get fabric.", + "type": "object", + "properties": { + "zoneToZoneMappings": { + "description": "A value indicating whether the zone to zone mappings are to be returned.", + "type": "string" + }, + "extendedLocationMappings": { + "description": "A value indicating whether the Extended Location mappings are to be returned.", + "type": "string" + }, + "locationDetails": { + "description": "A value indicating whether the location details are to be returned.", + "type": "string" + }, + "fetchAgentDetails": { + "description": "A value indicating whether the agent details are to be fetched.", + "type": "string" + }, + "biosId": { + "description": "The BIOS Id to be used for fetching agent details.", + "type": "string" + }, + "fqdn": { + "description": "The FQDN to be used for fetching agent details.", + "type": "string" + }, + "discoveryType": { + "description": "The type of the discovered machine to be used for fetching agent details.", + "type": "string" + }, + "osType": { + "description": "The OS type to be used for fetching agent details.", + "type": "string" + } + } + }, + "FabricReplicationGroupTaskDetails": { + "description": "This class represents the fabric replication group task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobTaskDetails" + } + ], + "properties": { + "skippedReason": { + "description": "The skipped reason.", + "type": "string" + }, + "skippedReasonString": { + "description": "The skipped reason string.", + "type": "string" + } + }, + "x-ms-discriminator-value": "FabricReplicationGroupTaskDetails" + }, + "FabricSpecificCreateNetworkMappingInput": { + "description": "Input details specific to fabrics during Network Mapping.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FabricSpecificCreationInput": { + "description": "Fabric provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FabricSpecificDetails": { + "description": "Fabric specific details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FabricSpecificUpdateNetworkMappingInput": { + "description": "Input details specific to fabrics during Network Mapping.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FailoverJobDetails": { + "description": "This class represents the details for a failover job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "protectedItemDetails": { + "description": "The test VM details.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" + } + } + }, + "x-ms-discriminator-value": "FailoverJobDetails" + }, + "FailoverProcessServerRequest": { + "description": "Request to failover a process server.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FailoverProcessServerRequestProperties", + "description": "The properties of the PS Failover request." + } + } + }, + "FailoverProcessServerRequestProperties": { + "description": "The properties of the Failover Process Server request.", + "type": "object", + "properties": { + "containerName": { + "description": "The container identifier.", + "type": "string" + }, + "sourceProcessServerId": { + "description": "The source process server.", + "type": "string" + }, + "targetProcessServerId": { + "description": "The new process server.", + "type": "string" + }, + "vmsToMigrate": { + "description": "The VMS to migrate.", + "type": "array", + "items": { + "type": "string" + } + }, + "updateType": { + "description": "A value for failover type. It can be systemlevel/serverlevel.", + "type": "string" + } + } + }, + "FailoverReplicationProtectedItemDetails": { + "description": "Failover details for a replication protected item.", + "type": "object", + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name.", + "type": "string" + }, + "testVmName": { + "description": "The test Vm name.", + "type": "string" + }, + "testVmFriendlyName": { + "description": "The test Vm friendly name.", + "type": "string" + }, + "networkConnectionStatus": { + "description": "The network connection status.", + "type": "string" + }, + "networkFriendlyName": { + "description": "The network friendly name.", + "type": "string" + }, + "subnet": { + "description": "The network subnet.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string" + } + } + }, + "GatewayOperationDetails": { + "description": "Details of the gateway operation.", + "type": "object", + "properties": { + "state": { + "description": "A value indicating the state of gateway operation.", + "type": "string", + "readOnly": true + }, + "progressPercentage": { + "format": "int32", + "description": "A value indicating the progress percentage of gateway operation.", + "type": "integer", + "readOnly": true + }, + "timeElapsed": { + "format": "int64", + "description": "A value indicating the time elapsed for the operation in milliseconds.", + "type": "integer", + "readOnly": true + }, + "timeRemaining": { + "format": "int64", + "description": "A value indicating the time remaining for the operation in milliseconds.", + "type": "integer", + "readOnly": true + }, + "uploadSpeed": { + "format": "int64", + "description": "A value indicating the upload speed in bytes per second.", + "type": "integer", + "readOnly": true + }, + "hostName": { + "description": "A value indicating the ESXi host name.", + "type": "string", + "readOnly": true + }, + "dataStores": { + "description": "A value indicating the datastore collection.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vmwareReadThroughput": { + "format": "int64", + "description": "A value indicating the VMware read throughput in bytes per second.", + "type": "integer", + "readOnly": true + } + } + }, + "GroupTaskDetails": { + "description": "This class represents the group task details when parent child relationship exists in the drill down.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The type of task details.", + "type": "string" + }, + "childTasks": { + "description": "The child tasks.", + "type": "array", + "items": { + "$ref": "#/definitions/ASRTask" + } + } + }, + "discriminator": "instanceType" + }, + "HealthError": { + "description": "Health Error.", + "type": "object", + "properties": { + "innerHealthErrors": { + "description": "The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.", + "type": "array", + "items": { + "$ref": "#/definitions/InnerHealthError" + } + }, + "errorSource": { + "description": "Source of error.", + "type": "string" + }, + "errorType": { + "description": "Type of error.", + "type": "string" + }, + "errorLevel": { + "description": "Level of error.", + "type": "string" + }, + "errorCategory": { + "description": "Category of error.", + "type": "string" + }, + "errorCode": { + "description": "Error code.", + "type": "string" + }, + "summaryMessage": { + "description": "Summary message of the entity.", + "type": "string" + }, + "errorMessage": { + "description": "Error message.", + "type": "string" + }, + "possibleCauses": { + "description": "Possible causes of error.", + "type": "string" + }, + "recommendedAction": { + "description": "Recommended action to resolve error.", + "type": "string" + }, + "creationTimeUtc": { + "format": "date-time", + "description": "Error creation time (UTC).", + "type": "string" + }, + "recoveryProviderErrorMessage": { + "description": "DRA error message.", + "type": "string" + }, + "entityId": { + "description": "ID of the entity.", + "type": "string" + }, + "errorId": { + "description": "The health error unique id.", + "type": "string" + }, + "customerResolvability": { + "description": "Value indicating whether the health error is customer resolvable.", + "enum": [ + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthErrorCustomerResolvability", + "modelAsString": true + } + } + } + }, + "HealthErrorSummary": { + "description": "class to define the summary of the health error details.", + "type": "object", + "properties": { + "summaryCode": { + "description": "The code of the health error.", + "type": "string" + }, + "category": { + "description": "The category of the health error.", + "enum": [ + "None", + "Replication", + "TestFailover", + "Configuration", + "FabricInfrastructure", + "VersionExpiry", + "AgentAutoUpdateInfra", + "AgentAutoUpdateArtifactDeleted", + "AgentAutoUpdateRunAsAccount", + "AgentAutoUpdateRunAsAccountExpiry", + "AgentAutoUpdateRunAsAccountExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthErrorCategory", + "modelAsString": true + } + }, + "severity": { + "description": "Severity of error.", + "enum": [ + "NONE", + "Warning", + "Error", + "Info" + ], + "type": "string", + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "summaryMessage": { + "description": "The summary message of the health error.", + "type": "string" + }, + "affectedResourceType": { + "description": "The type of affected ARM resource.", + "type": "string" + }, + "affectedResourceSubtype": { + "description": "The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable.", + "type": "string" + }, + "affectedResourceCorrelationIds": { + "description": "The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "HyperVHostDetails": { + "description": "Hyper-V host details.", + "type": "object", + "properties": { + "id": { + "description": "The Hyper-V host Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Hyper-V host name.", + "type": "string", + "readOnly": true + }, + "marsAgentVersion": { + "description": "The Mars agent version.", + "type": "string", + "readOnly": true + } + } + }, + "HyperVReplica2012EventDetails": { + "description": "Model class for event details of a HyperVReplica E2E event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + }, + "remoteFabricName": { + "description": "The remote fabric name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVReplica2012R2EventDetails": { + "description": "Model class for event details of a HyperVReplica blue E2E event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + }, + "remoteFabricName": { + "description": "The remote fabric name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaAzureApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to HyperVReplicaAzure provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "The primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "The secondary kek certificate pfx.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureDiskInputDetails": { + "description": "Disk input details.", + "type": "object", + "properties": { + "diskId": { + "description": "The DiskId.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The LogStorageAccountId.", + "type": "string" + }, + "diskType": { + "description": "The DiskType.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + } + } + }, + "HyperVReplicaAzureEnableProtectionInput": { + "description": "HyperVReplicaAzure specific enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "hvHostVmId": { + "description": "The Hyper-V host VM Id.", + "type": "string" + }, + "vmName": { + "description": "The VM Name.", + "type": "string" + }, + "osType": { + "description": "The OS type associated with VM.", + "type": "string" + }, + "vhdId": { + "description": "The OS disk VHD id associated with VM.", + "type": "string" + }, + "targetStorageAccountId": { + "description": "The storage account Id.", + "type": "string" + }, + "targetAzureNetworkId": { + "description": "The selected target Azure network Id.", + "type": "string" + }, + "targetAzureSubnetId": { + "description": "The selected target Azure subnet Id.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "targetAzureVmName": { + "description": "The target azure VM Name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + }, + "disksToInclude": { + "description": "The list of VHD Ids of disks to be protected.", + "type": "array", + "items": { + "type": "string" + } + }, + "targetAzureV1ResourceGroupId": { + "description": "The Id of the target resource group (for classic deployment) in which the failover VM is to be created.", + "type": "string" + }, + "targetAzureV2ResourceGroupId": { + "description": "The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id for resource manager deployment.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The proximity placement group ARM Id.", + "type": "string" + }, + "useManagedDisksForReplication": { + "description": "A value indicating whether managed disks should be used during replication.", + "type": "string" + }, + "diskType": { + "description": "The DiskType.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "disksToIncludeForManagedDisks": { + "description": "The disks to include list for managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/HyperVReplicaAzureDiskInputDetails" + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureEventDetails": { + "description": "Model class for event details of a HyperVReplica E2A event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureFailbackProviderInput": { + "description": "HyperVReplicaAzureFailback specific planned failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" + } + ], + "properties": { + "dataSyncOption": { + "description": "Data sync option.", + "type": "string" + }, + "recoveryVmCreationOption": { + "description": "ALR options to create alternate recovery.", + "type": "string" + }, + "providerIdForAlternateRecovery": { + "description": "Provider Id for alternate location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzureFailback" + }, + "HyperVReplicaAzureManagedDiskDetails": { + "description": "Hyper-V Managed disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "seedManagedDiskId": { + "description": "Seed managed disk Id.", + "type": "string" + }, + "replicaDiskType": { + "description": "The replica disk type.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The disk encryption set ARM Id.", + "type": "string" + } + } + }, + "HyperVReplicaAzurePlannedFailoverProviderInput": { + "description": "HyperVReplicaAzure specific planned failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "osUpgradeVersion": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzurePolicyDetails": { + "description": "Hyper-V Replica Azure specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryDurationInHours": { + "format": "int32", + "description": "The duration (in hours) to which point the recovery history needs to be maintained.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM.", + "type": "integer" + }, + "replicationInterval": { + "format": "int32", + "description": "The replication interval.", + "type": "integer" + }, + "onlineReplicationStartTime": { + "description": "The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately.", + "type": "string" + }, + "encryption": { + "description": "A value indicating whether encryption is enabled for virtual machines in this cloud.", + "type": "string" + }, + "activeStorageAccountId": { + "description": "The active storage account Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzurePolicyInput": { + "description": "Hyper-V Replica Azure specific input for creating a protection profile.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryDuration": { + "format": "int32", + "description": "The duration (in hours) to which point the recovery history needs to be maintained.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM.", + "type": "integer" + }, + "replicationInterval": { + "format": "int32", + "description": "The replication interval.", + "type": "integer" + }, + "onlineReplicationStartTime": { + "description": "The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately.", + "type": "string" + }, + "storageAccounts": { + "description": "The list of storage accounts to which the VMs in the primary cloud can replicate to.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureReplicationDetails": { + "description": "Hyper V Replica Azure provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "azureVmDiskDetails": { + "description": "Azure VM Disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureVmDiskDetails" + } + }, + "recoveryAzureVmName": { + "description": "Recovery Azure given name.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "The Recovery Azure VM size.", + "type": "string" + }, + "recoveryAzureStorageAccount": { + "description": "The recovery Azure storage account.", + "type": "string" + }, + "recoveryAzureLogStorageAccountId": { + "description": "The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection.", + "type": "string" + }, + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "Last RPO value.", + "type": "integer" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "selectedRecoveryAzureNetworkId": { + "description": "The selected recovery azure network Id.", + "type": "string" + }, + "selectedSourceNicId": { + "description": "The selected source nic Id which will be used as the primary nic during failover.", + "type": "string" + }, + "encryption": { + "description": "The encryption info.", + "type": "string" + }, + "oSDetails": { + "$ref": "#/definitions/OSDetails", + "description": "The operating system info." + }, + "sourceVmRamSizeInMB": { + "format": "int32", + "description": "The RAM size of the VM on the primary side.", + "type": "integer" + }, + "sourceVmCpuCount": { + "format": "int32", + "description": "The CPU count of the VM on the primary side.", + "type": "integer" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "recoveryAzureResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "targetVmTags": { + "description": "The target VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/HyperVReplicaAzureManagedDiskDetails" + }, + "x-ms-identifiers": [] + }, + "allAvailableOSUpgradeConfigurations": { + "description": "A value indicating all available inplace OS Upgrade configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/OSUpgradeSupportedVersions" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureReprotectInput": { + "description": "Azure specific reprotect input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "hvHostVmId": { + "description": "The Hyper-V host Vm Id.", + "type": "string" + }, + "vmName": { + "description": "The Vm Name.", + "type": "string" + }, + "osType": { + "description": "The OS type associated with vm.", + "type": "string" + }, + "vHDId": { + "description": "The OS disk VHD id associated with vm.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureTestFailoverInput": { + "description": "HvrA provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "osUpgradeVersion": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureUnplannedFailoverInput": { + "description": "HvrA provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureUpdateReplicationProtectedItemInput": { + "description": "HyperV replica Azure input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "recoveryAzureV1ResourceGroupId": { + "description": "The recovery Azure resource group Id for classic deployment.", + "type": "string" + }, + "recoveryAzureV2ResourceGroupId": { + "description": "The recovery Azure resource group Id for resource manager deployment.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "diskIdToDiskEncryptionMap": { + "description": "The dictionary of disk resource Id to disk encryption set ARM Id.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "vmDisks": { + "description": "The list of disk update properties.", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateDiskInput" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaBaseEventDetails": { + "description": "Abstract model class for event details of a HyperVReplica E2E event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + }, + "remoteFabricName": { + "description": "The remote fabric name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaBaseEventDetails" + }, + "HyperVReplicaBasePolicyDetails": { + "description": "Base class for HyperVReplica policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletionOption": { + "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaBasePolicyDetails" + }, + "HyperVReplicaBaseReplicationDetails": { + "description": "Hyper V replica provider specific settings base class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vMDiskDetails": { + "description": "VM disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaBaseReplicationDetails" + }, + "HyperVReplicaBluePolicyDetails": { + "description": "Hyper-V Replica Blue specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "replicationFrequencyInSeconds": { + "format": "int32", + "description": "A value indicating the replication interval.", + "type": "integer" + }, + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletionOption": { + "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaBluePolicyInput": { + "description": "HyperV Replica Blue policy input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HyperVReplicaPolicyInput" + } + ], + "properties": { + "replicationFrequencyInSeconds": { + "format": "int32", + "description": "A value indicating the replication interval.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaBlueReplicationDetails": { + "description": "HyperV replica 2012 R2 (Blue) replication details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vMDiskDetails": { + "description": "VM disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaPolicyDetails": { + "description": "Hyper-V Replica Blue specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletionOption": { + "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVReplicaPolicyInput": { + "description": "Hyper-V Replica specific policy Input.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletion": { + "description": "A value indicating whether the VM has to be auto deleted.", + "type": "string" + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVReplicaReplicationDetails": { + "description": "HyperV replica 2012 replication details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vMDiskDetails": { + "description": "VM disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVSiteDetails": { + "description": "HyperVSite fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "hyperVHosts": { + "description": "The list of Hyper-V hosts associated with the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/HyperVHostDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVSite" + }, + "HyperVVirtualMachineDetails": { + "description": "Single Host fabric provider specific VM settings.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConfigurationSettings" + } + ], + "properties": { + "sourceItemId": { + "description": "The source id of the object.", + "type": "string" + }, + "generation": { + "description": "The id of the object in fabric.", + "type": "string" + }, + "osDetails": { + "$ref": "#/definitions/OSDetails", + "description": "The Last replication time." + }, + "diskDetails": { + "description": "The Last successful failover time.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + }, + "hasPhysicalDisk": { + "description": "A value indicating whether the VM has a physical disk attached. String value of SrsDataContract.PresenceStatus enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } + }, + "hasFibreChannelAdapter": { + "description": "A value indicating whether the VM has a fibre channel adapter attached. String value of SrsDataContract.PresenceStatus enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } + }, + "hasSharedVhd": { + "description": "A value indicating whether the VM has a shared VHD attached. String value of SrsDataContract.PresenceStatus enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } + }, + "hyperVHostId": { + "description": "The Id of the hyper-v host in fabric.", + "type": "string" + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "HyperVVirtualMachine" + }, + "IdentityProviderDetails": { + "description": "Identity provider details.", + "type": "object", + "properties": { + "tenantId": { + "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "applicationId": { + "description": "The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "objectId": { + "description": "The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "audience": { + "description": "The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "aadAuthority": { + "description": "The base authority for Azure Active Directory authentication.", + "type": "string" + } + } + }, + "IdentityProviderInput": { + "description": "Identity provider input.", + "required": [ + "tenantId", + "applicationId", + "objectId", + "audience", + "aadAuthority" + ], + "type": "object", + "properties": { + "tenantId": { + "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "applicationId": { + "description": "The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "objectId": { + "description": "The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "audience": { + "description": "The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "aadAuthority": { + "description": "The base authority for Azure Active Directory authentication.", + "type": "string" + } + } + }, + "InconsistentVmDetails": { + "description": "This class stores the monitoring details for consistency check of inconsistent Protected Entity.", + "type": "object", + "properties": { + "vmName": { + "description": "The Vm name.", + "type": "string" + }, + "cloudName": { + "description": "The Cloud name.", + "type": "string" + }, + "details": { + "description": "The list of details regarding state of the Protected Entity in SRS and On prem.", + "type": "array", + "items": { + "type": "string" + } + }, + "errorIds": { + "description": "The list of error ids.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "InitialReplicationDetails": { + "description": "Initial replication details.", + "type": "object", + "properties": { + "initialReplicationType": { + "description": "Initial replication type.", + "type": "string" + }, + "initialReplicationProgressPercentage": { + "description": "The initial replication progress percentage.", + "type": "string" + } + } + }, + "InlineWorkflowTaskDetails": { + "description": "This class represents the inline workflow task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GroupTaskDetails" + } + ], + "properties": { + "workflowIds": { + "description": "The list of child workflow ids.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InlineWorkflowTaskDetails" + }, + "InMageAgentDetails": { + "description": "The details of the InMage agent.", + "type": "object", + "properties": { + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "agentUpdateStatus": { + "description": "A value indicating whether installed agent needs to be updated.", + "type": "string" + }, + "postUpdateRebootStatus": { + "description": "A value indicating whether reboot is required after update is applied.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + } + } + }, + "InMageAzureV2ApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to InMageAzureV2 provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2DiskInputDetails": { + "description": "Disk input details.", + "type": "object", + "properties": { + "diskId": { + "description": "The DiskId.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The LogStorageAccountId.", + "type": "string" + }, + "diskType": { + "description": "The DiskType.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + } + } + }, + "InMageAzureV2EnableProtectionInput": { + "description": "VMware Azure specific enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "masterTargetId": { + "description": "The Master target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi VM group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2DiskInputDetails" + } + }, + "targetAzureNetworkId": { + "description": "The selected target Azure network Id.", + "type": "string" + }, + "targetAzureSubnetId": { + "description": "The selected target Azure subnet Id.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target VM after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "targetAzureVmName": { + "description": "The target azure VM Name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + }, + "targetAzureV1ResourceGroupId": { + "description": "The Id of the target resource group (for classic deployment) in which the failover VM is to be created.", + "type": "string" + }, + "targetAzureV2ResourceGroupId": { + "description": "The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.", + "type": "string" + }, + "diskType": { + "description": "The DiskType.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id for resource manager deployment.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The proximity placement group ARM Id.", + "type": "string" + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2EventDetails": { + "description": "Model class for event details of a VMwareAzureV2 event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "eventType": { + "description": "InMage Event type. Takes one of the values of InMageDataContract.InMageMonitoringEventType.", + "type": "string" + }, + "category": { + "description": "InMage Event Category.", + "type": "string" + }, + "component": { + "description": "InMage Event Component.", + "type": "string" + }, + "correctiveAction": { + "description": "Corrective Action string for the event.", + "type": "string" + }, + "details": { + "description": "InMage Event Details.", + "type": "string" + }, + "summary": { + "description": "InMage Event Summary.", + "type": "string" + }, + "siteName": { + "description": "VMware Site name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ManagedDiskDetails": { + "description": "InMageAzureV2 Managed disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string" + }, + "seedManagedDiskId": { + "description": "Seed managed disk Id.", + "type": "string" + }, + "replicaDiskType": { + "description": "The replica disk type.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + }, + "targetDiskName": { + "description": "The target disk name.", + "type": "string" + } + } + }, + "InMageAzureV2PolicyDetails": { + "description": "InMage Azure v2 specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + }, + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2PolicyInput": { + "description": "VMWare Azure specific policy Input.", + "required": [ + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ProtectedDiskDetails": { + "description": "InMageAzureV2 protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "healthErrorCode": { + "description": "The health error code for the disk.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "string" + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer" + }, + "resyncDurationInSeconds": { + "format": "int64", + "description": "The resync duration in seconds.", + "type": "integer" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "fileSystemCapacityInBytes": { + "format": "int64", + "description": "The disk file system capacity in bytes.", + "type": "integer" + }, + "sourceDataInMegaBytes": { + "format": "double", + "description": "The source data transit in MB.", + "type": "number" + }, + "psDataInMegaBytes": { + "format": "double", + "description": "The PS data transit in MB.", + "type": "number" + }, + "targetDataInMegaBytes": { + "format": "double", + "description": "The target data transit in MB.", + "type": "number" + }, + "diskResized": { + "description": "A value indicating whether disk is resized.", + "type": "string" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes.", + "type": "integer" + }, + "resyncTotalTransferredBytes": { + "format": "int64", + "description": "The resync total transferred bytes.", + "type": "integer" + }, + "resyncLast15MinutesTransferredBytes": { + "format": "int64", + "description": "The resync last 15 minutes transferred bytes.", + "type": "integer" + }, + "resyncLastDataTransferTimeUTC": { + "format": "date-time", + "description": "The last data transfer time in UTC.", + "type": "string" + }, + "resyncStartTime": { + "format": "date-time", + "description": "The resync start time.", + "type": "string" + }, + "progressHealth": { + "description": "The Progress Health.", + "type": "string" + }, + "progressStatus": { + "description": "The Progress Status.", + "type": "string" + }, + "secondsToTakeSwitchProvider": { + "format": "int64", + "description": "The seconds to take for switch provider.", + "type": "integer" + } + } + }, + "InMageAzureV2RecoveryPointDetails": { + "description": "InMage Azure V2 provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "isMultiVmSyncPoint": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ReplicationDetails": { + "description": "InMageAzureV2 provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "infrastructureVmId": { + "description": "The infrastructure VM Id.", + "type": "string" + }, + "vCenterInfrastructureId": { + "description": "The vCenter infrastructure Id.", + "type": "string" + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "compressedDataRateInMB": { + "format": "double", + "description": "The compressed data change rate in MB.", + "type": "number" + }, + "uncompressedDataRateInMB": { + "format": "double", + "description": "The uncompressed data change rate in MB.", + "type": "number" + }, + "ipAddress": { + "description": "The source IP address.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "isAgentUpdateRequired": { + "description": "A value indicating whether installed agent needs to be updated.", + "type": "string" + }, + "isRebootAfterUpdateRequired": { + "description": "A value indicating whether the source server requires a restart after update.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the source server.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "processServerName": { + "description": "The process server name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi vm sync is enabled or disabled.", + "type": "string" + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2ProtectedDiskDetails" + } + }, + "diskResized": { + "description": "A value indicating whether any disk is resized for this VM.", + "type": "string" + }, + "masterTargetId": { + "description": "The master target Id.", + "type": "string" + }, + "sourceVmCpuCount": { + "format": "int32", + "description": "The CPU count of the VM on the primary side.", + "type": "integer" + }, + "sourceVmRamSizeInMB": { + "format": "int32", + "description": "The RAM size of the VM on the primary side.", + "type": "integer" + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string" + }, + "vhdName": { + "description": "The OS disk VHD name.", + "type": "string" + }, + "osDiskId": { + "description": "The id of the disk containing the OS.", + "type": "string" + }, + "azureVMDiskDetails": { + "description": "Azure VM Disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureVmDiskDetails" + } + }, + "recoveryAzureVMName": { + "description": "Recovery Azure given name.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "The Recovery Azure VM size.", + "type": "string" + }, + "recoveryAzureStorageAccount": { + "description": "The recovery Azure storage account.", + "type": "string" + }, + "recoveryAzureLogStorageAccountId": { + "description": "The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "selectedRecoveryAzureNetworkId": { + "description": "The selected recovery azure network Id.", + "type": "string" + }, + "selectedTfoAzureNetworkId": { + "description": "The test failover virtual network.", + "type": "string" + }, + "selectedSourceNicId": { + "description": "The selected source nic Id which will be used as the primary nic during failover.", + "type": "string" + }, + "discoveryType": { + "description": "A value indicating the discovery type of the machine. Value can be vCenter or physical.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "datastores": { + "description": "The datastores of the on-premise machine. Value can be list of strings that contain datastore names.", + "type": "array", + "items": { + "type": "string" + } + }, + "targetVmId": { + "description": "The ARM Id of the target Azure VM. This value will be null until the VM is failed over. Only after failure it will be populated with the ARM Id of the Azure VM.", + "type": "string" + }, + "recoveryAzureResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "validationErrors": { + "description": "The validation errors of the on-premise machine Value can be list of validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "lastUpdateReceivedTime": { + "format": "date-time", + "description": "The last update time received from on-prem components.", + "type": "string" + }, + "replicaId": { + "description": "The replica id of the protected item.", + "type": "string" + }, + "osVersion": { + "description": "The OS Version of the protected item.", + "type": "string" + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2ManagedDiskDetails" + } + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type of this protected item.", + "type": "string" + }, + "azureVmGeneration": { + "description": "The target generation for this protected item.", + "type": "string" + }, + "isAdditionalStatsAvailable": { + "description": "A value indicating whether additional IR stats are available or not.", + "type": "boolean" + }, + "totalDataTransferred": { + "format": "int64", + "description": "The total transferred data in bytes.", + "type": "integer" + }, + "totalProgressHealth": { + "description": "The progress health.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "switchProviderBlockingErrorDetails": { + "description": "The switch provider blocking error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2SwitchProviderBlockingErrorDetails" + } + }, + "switchProviderDetails": { + "$ref": "#/definitions/InMageAzureV2SwitchProviderDetails", + "description": "The switch provider blocking error information." + }, + "supportedOSVersions": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "allAvailableOSUpgradeConfigurations": { + "description": "A value indicating all available inplace OS Upgrade configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/OSUpgradeSupportedVersions" + }, + "x-ms-identifiers": [] + }, + "osName": { + "description": "The name of the OS on the VM.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ReprotectInput": { + "description": "InMageAzureV2 specific provider input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "masterTargetId": { + "description": "The Master target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2SwitchProviderBlockingErrorDetails": { + "description": "InMageAzureV2 switch provider blocking error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageAzureV2SwitchProviderDetails": { + "description": "InMageAzureV2 switch provider details.", + "type": "object", + "properties": { + "targetVaultId": { + "description": "The target vault Id.", + "type": "string", + "readOnly": true + }, + "targetResourceId": { + "description": "The target resource Id.", + "type": "string", + "readOnly": true + }, + "targetFabricId": { + "description": "The target fabric Id.", + "type": "string", + "readOnly": true + }, + "targetApplianceId": { + "description": "The target appliance Id.", + "type": "string", + "readOnly": true + } + } + }, + "InMageAzureV2SwitchProviderProviderInput": { + "description": "Provider specific input for InMageAzureV2 switch provider.", + "required": [ + "targetVaultID", + "targetFabricID", + "targetApplianceID" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SwitchProviderProviderSpecificInput" + } + ], + "properties": { + "targetVaultID": { + "description": "The target vault Id.", + "type": "string" + }, + "targetFabricID": { + "description": "The target fabric Id.", + "type": "string" + }, + "targetApplianceID": { + "description": "The target appliance Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2TestFailoverInput": { + "description": "InMageAzureV2 provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "osUpgradeVersion": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2UnplannedFailoverInput": { + "description": "InMageAzureV2 provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "osUpgradeVersion": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2UpdateReplicationProtectedItemInput": { + "description": "InMage Azure V2 input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "recoveryAzureV1ResourceGroupId": { + "description": "The recovery Azure resource group Id for classic deployment.", + "type": "string" + }, + "recoveryAzureV2ResourceGroupId": { + "description": "The recovery Azure resource group Id for resource manager deployment.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "vmDisks": { + "description": "The list of disk update properties.", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateDiskInput" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageBasePolicyDetails": { + "description": "Base class for the policies of providers using InMage replication.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageBasePolicyDetails" + }, + "InMageDisableProtectionProviderSpecificInput": { + "description": "InMage disable protection provider specific input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisableProtectionProviderSpecificInput" + } + ], + "properties": { + "replicaVmDeletionStatus": { + "description": "A value indicating whether the replica VM should be destroyed or retained. Values from Delete and Retain.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageDiskDetails": { + "description": "VMware/Physical specific Disk Details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "diskSizeInMB": { + "description": "The disk size in MB.", + "type": "string" + }, + "diskType": { + "description": "Whether disk is system disk or data disk.", + "type": "string" + }, + "diskConfiguration": { + "description": "Whether disk is dynamic disk or basic disk.", + "type": "string" + }, + "volumeList": { + "description": "Volumes of the disk.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskVolumeDetails" + } + } + } + }, + "InMageDiskExclusionInput": { + "description": "DiskExclusionInput when doing enable protection of virtual machine in InMage provider.", + "type": "object", + "properties": { + "volumeOptions": { + "description": "The volume label based option for disk exclusion.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageVolumeExclusionOptions" + } + }, + "diskSignatureOptions": { + "description": "The guest disk signature based option for disk exclusion.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageDiskSignatureExclusionOptions" + } + } + } + }, + "InMageDiskSignatureExclusionOptions": { + "description": "Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.", + "type": "object", + "properties": { + "diskSignature": { + "description": "The guest signature of disk to be excluded from replication.", + "type": "string" + } + } + }, + "InMageEnableProtectionInput": { + "description": "VMware Azure specific enable protection input.", + "required": [ + "masterTargetId", + "processServerId", + "retentionDrive", + "multiVmGroupId", + "multiVmGroupName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "vmFriendlyName": { + "description": "The VM Name.", + "type": "string" + }, + "masterTargetId": { + "description": "The Master Target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "retentionDrive": { + "description": "The retention drive to use on the MT.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi VM group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + }, + "datastoreName": { + "description": "The target datastore name.", + "type": "string" + }, + "diskExclusionInput": { + "$ref": "#/definitions/InMageDiskExclusionInput", + "description": "The enable disk exclusion input." + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageFabricSwitchProviderBlockingErrorDetails": { + "description": "InMageFabric switch provider blocking error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMagePolicyDetails": { + "description": "InMage specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMagePolicyInput": { + "description": "VMWare Azure specific protection profile Input.", + "required": [ + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageProtectedDiskDetails": { + "description": "InMage protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "healthErrorCode": { + "description": "The health error code for the disk.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "string" + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer" + }, + "resyncDurationInSeconds": { + "format": "int64", + "description": "The resync duration in seconds.", + "type": "integer" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "fileSystemCapacityInBytes": { + "format": "int64", + "description": "The file system capacity in bytes.", + "type": "integer" + }, + "sourceDataInMB": { + "format": "double", + "description": "The source data transit in MB.", + "type": "number" + }, + "psDataInMB": { + "format": "double", + "description": "The PS data transit in MB.", + "type": "number" + }, + "targetDataInMB": { + "format": "double", + "description": "The target data transit in MB.", + "type": "number" + }, + "diskResized": { + "description": "A value indicating whether disk is resized.", + "type": "string" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes.", + "type": "integer" + }, + "resyncTotalTransferredBytes": { + "format": "int64", + "description": "The resync total transferred bytes.", + "type": "integer" + }, + "resyncLast15MinutesTransferredBytes": { + "format": "int64", + "description": "The resync last 15 minutes transferred bytes.", + "type": "integer" + }, + "resyncLastDataTransferTimeUTC": { + "format": "date-time", + "description": "The last data transfer time in UTC.", + "type": "string" + }, + "resyncStartTime": { + "format": "date-time", + "description": "The resync start time.", + "type": "string" + }, + "progressHealth": { + "description": "The Progress Health.", + "type": "string" + }, + "progressStatus": { + "description": "The Progress Status.", + "type": "string" + } + } + }, + "InMageRcmAgentUpgradeBlockingErrorDetails": { + "description": "InMageRcm source agent upgrade blocking error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageRcmApplianceDetails": { + "description": "InMageRcm appliance details.", + "type": "object", + "properties": { + "id": { + "description": "The appliance Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The appliance name.", + "type": "string", + "readOnly": true + }, + "fabricArmId": { + "description": "The fabric ARM Id.", + "type": "string", + "readOnly": true + }, + "processServer": { + "$ref": "#/definitions/ProcessServerDetails", + "description": "The process server.", + "readOnly": true + }, + "rcmProxy": { + "$ref": "#/definitions/RcmProxyDetails", + "description": "The of RCM proxy.", + "readOnly": true + }, + "pushInstaller": { + "$ref": "#/definitions/PushInstallerDetails", + "description": "The push installer.", + "readOnly": true + }, + "replicationAgent": { + "$ref": "#/definitions/ReplicationAgentDetails", + "description": "The replication agent.", + "readOnly": true + }, + "reprotectAgent": { + "$ref": "#/definitions/ReprotectAgentDetails", + "description": "The reprotect agent.", + "readOnly": true + }, + "marsAgent": { + "$ref": "#/definitions/MarsAgentDetails", + "description": "The Mars agent.", + "readOnly": true + }, + "dra": { + "$ref": "#/definitions/DraDetails", + "description": "The DRA.", + "readOnly": true + }, + "switchProviderBlockingErrorDetails": { + "description": "The switch provider blocking error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmFabricSwitchProviderBlockingErrorDetails" + }, + "readOnly": true + } + } + }, + "InMageRcmApplianceSpecificDetails": { + "description": "InMageRcm appliance specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplianceSpecificDetails" + } + ], + "properties": { + "appliances": { + "description": "The list of appliances.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmApplianceDetails" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to InMageRcm provider.", + "required": [ + "recoveryPointId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmDiscoveredProtectedVmDetails": { + "description": "InMageRcm discovered protected VM details.", + "type": "object", + "properties": { + "vCenterId": { + "description": "The VCenter Id.", + "type": "string", + "readOnly": true + }, + "vCenterFqdn": { + "description": "The VCenter fqdn.", + "type": "string", + "readOnly": true + }, + "datastores": { + "description": "The list of datastores.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ipAddresses": { + "description": "The list of IP addresses.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vmwareToolsStatus": { + "description": "The VMware tools status.", + "type": "string", + "readOnly": true + }, + "powerStatus": { + "description": "The VM power status.", + "type": "string", + "readOnly": true + }, + "vmFqdn": { + "description": "The VM fqdn.", + "type": "string", + "readOnly": true + }, + "osName": { + "description": "The VM's OS name.", + "type": "string", + "readOnly": true + }, + "createdTimestamp": { + "format": "date-time", + "description": "The SDS created timestamp.", + "type": "string", + "readOnly": true + }, + "updatedTimestamp": { + "format": "date-time", + "description": "The SDS updated timestamp.", + "type": "string", + "readOnly": true + }, + "isDeleted": { + "description": "A value indicating whether the VM is deleted.", + "type": "boolean", + "readOnly": true + }, + "lastDiscoveryTimeInUtc": { + "format": "date-time", + "description": "The last time when SDS information discovered in SRS.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmDiskInput": { + "description": "InMageRcm disk input.", + "required": [ + "diskId", + "logStorageAccountId", + "diskType" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + } + } + }, + "InMageRcmDisksDefaultInput": { + "description": "InMageRcm disk input.", + "required": [ + "logStorageAccountId", + "diskType" + ], + "type": "object", + "properties": { + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + } + } + }, + "InMageRcmEnableProtectionInput": { + "description": "InMageRcm specific enable protection input.", + "required": [ + "fabricDiscoveryMachineId", + "targetResourceGroupId", + "processServerId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricDiscoveryMachineId": { + "description": "The ARM Id of discovered machine.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmDiskInput" + } + }, + "disksDefault": { + "$ref": "#/definitions/InMageRcmDisksDefaultInput", + "description": "The default disk input." + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The selected target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The selected test network ARM Id.", + "type": "string" + }, + "targetSubnetName": { + "description": "The selected target subnet name.", + "type": "string" + }, + "testSubnetName": { + "description": "The selected test subnet name.", + "type": "string" + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The run-as account Id.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmEventDetails": { + "description": "Event details for InMageRcm provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "vmName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "latestAgentVersion": { + "description": "The latest agent version.", + "type": "string", + "readOnly": true + }, + "jobId": { + "description": "The job Id.", + "type": "string", + "readOnly": true + }, + "fabricName": { + "description": "The fabric name.", + "type": "string", + "readOnly": true + }, + "applianceName": { + "description": "The appliance name.", + "type": "string", + "readOnly": true + }, + "serverType": { + "description": "The server type.", + "type": "string", + "readOnly": true + }, + "componentDisplayName": { + "description": "The component display name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFabricCreationInput": { + "description": "InMageRcm fabric provider specific settings.", + "required": [ + "vmwareSiteId", + "physicalSiteId", + "sourceAgentIdentity" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string" + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string" + }, + "sourceAgentIdentity": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for source agent authentication." + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFabricSpecificDetails": { + "description": "InMageRcm fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string", + "readOnly": true + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string", + "readOnly": true + }, + "serviceEndpoint": { + "description": "The service endpoint.", + "type": "string", + "readOnly": true + }, + "serviceResourceId": { + "description": "The service resource Id.", + "type": "string", + "readOnly": true + }, + "serviceContainerId": { + "description": "The service container Id.", + "type": "string", + "readOnly": true + }, + "dataPlaneUri": { + "description": "The data plane Uri.", + "type": "string", + "readOnly": true + }, + "controlPlaneUri": { + "description": "The control plane Uri.", + "type": "string", + "readOnly": true + }, + "sourceAgentIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The source agent identity details." + }, + "processServers": { + "description": "The list of process servers.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServerDetails" + }, + "readOnly": true + }, + "rcmProxies": { + "description": "The list of RCM proxies.", + "type": "array", + "items": { + "$ref": "#/definitions/RcmProxyDetails" + }, + "readOnly": true + }, + "pushInstallers": { + "description": "The list of push installers.", + "type": "array", + "items": { + "$ref": "#/definitions/PushInstallerDetails" + }, + "readOnly": true + }, + "replicationAgents": { + "description": "The list of replication agents.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationAgentDetails" + }, + "readOnly": true + }, + "reprotectAgents": { + "description": "The list of reprotect agents.", + "type": "array", + "items": { + "$ref": "#/definitions/ReprotectAgentDetails" + }, + "readOnly": true + }, + "marsAgents": { + "description": "The list of Mars agents.", + "type": "array", + "items": { + "$ref": "#/definitions/MarsAgentDetails" + }, + "readOnly": true + }, + "dras": { + "description": "The list of DRAs.", + "type": "array", + "items": { + "$ref": "#/definitions/DraDetails" + }, + "readOnly": true + }, + "agentDetails": { + "description": "The list of agent details.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDetails" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFabricSwitchProviderBlockingErrorDetails": { + "description": "InMageRcmFabric switch provider blocking error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageRcmFailbackDiscoveredProtectedVmDetails": { + "description": "InMageRcmFailback discovered VM details.", + "type": "object", + "properties": { + "vCenterId": { + "description": "The VCenter Id.", + "type": "string", + "readOnly": true + }, + "vCenterFqdn": { + "description": "The VCenter fqdn.", + "type": "string", + "readOnly": true + }, + "datastores": { + "description": "The list of datastores.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ipAddresses": { + "description": "The list of IP addresses.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vmwareToolsStatus": { + "description": "The VMware tools status.", + "type": "string", + "readOnly": true + }, + "powerStatus": { + "description": "The VM power status.", + "type": "string", + "readOnly": true + }, + "vmFqdn": { + "description": "The VM fqdn.", + "type": "string", + "readOnly": true + }, + "osName": { + "description": "The VM's OS name.", + "type": "string", + "readOnly": true + }, + "createdTimestamp": { + "format": "date-time", + "description": "The SDS created timestamp.", + "type": "string", + "readOnly": true + }, + "updatedTimestamp": { + "format": "date-time", + "description": "The SDS updated timestamp.", + "type": "string", + "readOnly": true + }, + "isDeleted": { + "description": "A value indicating whether the VM is deleted.", + "type": "boolean", + "readOnly": true + }, + "lastDiscoveryTimeInUtc": { + "format": "date-time", + "description": "The last time when SDS information discovered in SRS.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackEventDetails": { + "description": "Event details for InMageRcmFailback provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "vmName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "applianceName": { + "description": "The appliance name.", + "type": "string", + "readOnly": true + }, + "serverType": { + "description": "The server type.", + "type": "string", + "readOnly": true + }, + "componentDisplayName": { + "description": "The component display name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackMobilityAgentDetails": { + "description": "InMageRcmFailback mobility agent details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string", + "readOnly": true + }, + "latestVersion": { + "description": "The latest agent version available.", + "type": "string", + "readOnly": true + }, + "driverVersion": { + "description": "The driver version.", + "type": "string", + "readOnly": true + }, + "latestUpgradableVersionWithoutReboot": { + "description": "The latest upgradeable version available without reboot.", + "type": "string", + "readOnly": true + }, + "agentVersionExpiryDate": { + "format": "date-time", + "description": "The agent version expiry date.", + "type": "string", + "readOnly": true + }, + "driverVersionExpiryDate": { + "format": "date-time", + "description": "The driver version expiry date.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The time of the last heartbeat received from the agent.", + "type": "string", + "readOnly": true + }, + "reasonsBlockingUpgrade": { + "description": "The whether update is possible or not.", + "type": "array", + "items": { + "enum": [ + "AlreadyOnLatestVersion", + "RebootRequired", + "AgentNoHeartbeat", + "RcmProxyNoHeartbeat", + "ProcessServerNoHeartbeat", + "IncompatibleApplianceVersion", + "NotProtected", + "UnsupportedProtectionScenario", + "DistroIsNotReported", + "DistroNotSupportedForUpgrade", + "MissingUpgradePath", + "InvalidAgentVersion", + "InvalidDriverVersion", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentUpgradeBlockedReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "isUpgradeable": { + "description": "A value indicating whether agent is upgradeable or not.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackNicDetails": { + "description": "InMageRcmFailback NIC details.", + "type": "object", + "properties": { + "macAddress": { + "description": "The mac address.", + "type": "string", + "readOnly": true + }, + "networkName": { + "description": "The network name.", + "type": "string", + "readOnly": true + }, + "adapterType": { + "description": "The adapter type.", + "type": "string", + "readOnly": true + }, + "sourceIpAddress": { + "description": "The IP address.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackPlannedFailoverProviderInput": { + "description": "Provider specific input for InMageRcmFailback failover.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "x-ms-enum": { + "name": "InMageRcmFailbackRecoveryPointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackPolicyCreationInput": { + "description": "InMageRcmFailback policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackPolicyDetails": { + "description": "InMageRcm failback specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackProtectedDiskDetails": { + "description": "InMageRcmFailback protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id (reported by source agent).", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "diskUuid": { + "description": "The disk Uuid (reported by vCenter).", + "type": "string", + "readOnly": true + }, + "dataPendingInLogDataStoreInMB": { + "format": "double", + "description": "The data pending in log data store in MB.", + "type": "number", + "readOnly": true + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source agent in MB.", + "type": "number", + "readOnly": true + }, + "isInitialReplicationComplete": { + "description": "A value indicating whether initial replication is complete or not.", + "type": "string", + "readOnly": true + }, + "irDetails": { + "$ref": "#/definitions/InMageRcmFailbackSyncDetails", + "description": "The initial replication details." + }, + "resyncDetails": { + "$ref": "#/definitions/InMageRcmFailbackSyncDetails", + "description": "The resync details." + }, + "lastSyncTime": { + "format": "date-time", + "description": "The last sync time.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackReplicationDetails": { + "description": "InMageRcmFailback provider specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "internalIdentifier": { + "description": "The virtual machine internal identifier.", + "type": "string", + "readOnly": true + }, + "azureVirtualMachineId": { + "description": "The ARM Id of the azure VM.", + "type": "string", + "readOnly": true + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string", + "readOnly": true + }, + "reprotectAgentId": { + "description": "The reprotect agent Id.", + "type": "string", + "readOnly": true + }, + "reprotectAgentName": { + "description": "The reprotect agent name.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "targetvCenterId": { + "description": "The target vCenter Id.", + "type": "string", + "readOnly": true + }, + "targetDataStoreName": { + "description": "The target datastore name.", + "type": "string", + "readOnly": true + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string", + "readOnly": true + }, + "initialReplicationProgressPercentage": { + "format": "int32", + "description": "The initial replication progress percentage.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProcessedBytes": { + "format": "int64", + "description": "The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationTransferredBytes": { + "format": "int64", + "description": "The initial replication transferred bytes from source VM to target for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProgressHealth": { + "description": "The initial replication progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer", + "readOnly": true + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "resyncTransferredBytes": { + "format": "int64", + "description": "The resync transferred bytes from source VM to target for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProgressHealth": { + "description": "The resync progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmFailbackProtectedDiskDetails" + } + }, + "mobilityAgentDetails": { + "$ref": "#/definitions/InMageRcmFailbackMobilityAgentDetails", + "description": "The mobility agent information." + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmFailbackNicDetails" + } + }, + "lastPlannedFailoverStartTime": { + "format": "date-time", + "description": "The last planned failover start time.", + "type": "string", + "readOnly": true + }, + "lastPlannedFailoverStatus": { + "description": "The last planned failover status.", + "enum": [ + "Succeeded", + "Failed", + "Cancelled", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PlannedFailoverStatus", + "modelAsString": true + } + }, + "discoveredVmDetails": { + "$ref": "#/definitions/InMageRcmFailbackDiscoveredProtectedVmDetails", + "description": "The discovered VM information." + }, + "lastUsedPolicyId": { + "description": "The policy Id used by the forward replication.", + "type": "string", + "readOnly": true + }, + "lastUsedPolicyFriendlyName": { + "description": "The policy friendly name used by the forward replication.", + "type": "string", + "readOnly": true + }, + "isAgentRegistrationSuccessfulAfterFailover": { + "description": "A value indicating whether agent registration was successful after failover.", + "type": "boolean", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackReprotectInput": { + "description": "InMageRcmFailback specific provider input.", + "required": [ + "processServerId", + "policyId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The run as account Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackSyncDetails": { + "description": "InMageRcmFailback disk level sync details.", + "type": "object", + "properties": { + "progressHealth": { + "description": "The progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress", + "Queued" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DiskReplicationProgressHealth", + "modelAsString": true + } + }, + "transferredBytes": { + "format": "int64", + "description": "The transferred bytes from source VM to azure for the disk.", + "type": "integer", + "readOnly": true + }, + "last15MinutesTransferredBytes": { + "format": "int64", + "description": "The bytes transferred in last 15 minutes from source VM to target.", + "type": "integer", + "readOnly": true + }, + "lastDataTransferTimeUtc": { + "description": "The time of the last data transfer from source VM to target.", + "type": "string", + "readOnly": true + }, + "processedBytes": { + "format": "int64", + "description": "The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes.", + "type": "integer", + "readOnly": true + }, + "startTime": { + "description": "The start time.", + "type": "string", + "readOnly": true + }, + "lastRefreshTime": { + "description": "The last refresh time.", + "type": "string", + "readOnly": true + }, + "progressPercentage": { + "format": "int32", + "description": "Progress in percentage. Progress percentage is calculated based on processed bytes.", + "type": "integer", + "readOnly": true + } + } + }, + "InMageRcmLastAgentUpgradeErrorDetails": { + "description": "InMageRcm last source agent upgrade error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageRcmMobilityAgentDetails": { + "description": "InMageRcm mobility agent details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string", + "readOnly": true + }, + "latestVersion": { + "description": "The latest agent version available.", + "type": "string", + "readOnly": true + }, + "latestAgentReleaseDate": { + "description": "The latest agent version release date.", + "type": "string", + "readOnly": true + }, + "driverVersion": { + "description": "The driver version.", + "type": "string", + "readOnly": true + }, + "latestUpgradableVersionWithoutReboot": { + "description": "The latest upgradeable version available without reboot.", + "type": "string", + "readOnly": true + }, + "agentVersionExpiryDate": { + "format": "date-time", + "description": "The agent version expiry date.", + "type": "string", + "readOnly": true + }, + "driverVersionExpiryDate": { + "format": "date-time", + "description": "The driver version expiry date.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The time of the last heartbeat received from the agent.", + "type": "string", + "readOnly": true + }, + "reasonsBlockingUpgrade": { + "description": "The whether update is possible or not.", + "type": "array", + "items": { + "enum": [ + "AlreadyOnLatestVersion", + "RebootRequired", + "AgentNoHeartbeat", + "RcmProxyNoHeartbeat", + "ProcessServerNoHeartbeat", + "IncompatibleApplianceVersion", + "NotProtected", + "UnsupportedProtectionScenario", + "DistroIsNotReported", + "DistroNotSupportedForUpgrade", + "MissingUpgradePath", + "InvalidAgentVersion", + "InvalidDriverVersion", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentUpgradeBlockedReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "isUpgradeable": { + "description": "A value indicating whether agent is upgradeable or not.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmNicDetails": { + "description": "InMageRcm NIC details.", + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string", + "readOnly": true + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "isSelectedForFailover": { + "description": "A value indicating whether this NIC is selected for failover.", + "type": "string" + }, + "sourceIPAddress": { + "description": "The source IP address.", + "type": "string", + "readOnly": true + }, + "sourceIPAddressType": { + "description": "The source IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "sourceNetworkId": { + "description": "Source network Id.", + "type": "string", + "readOnly": true + }, + "sourceSubnetName": { + "description": "Source subnet name.", + "type": "string", + "readOnly": true + }, + "targetIPAddress": { + "description": "The target IP address.", + "type": "string" + }, + "targetIPAddressType": { + "description": "The target IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "testSubnetName": { + "description": "Test subnet name.", + "type": "string" + }, + "testIPAddress": { + "description": "The test IP address.", + "type": "string" + }, + "testIPAddressType": { + "description": "The test IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + } + } + }, + "InMageRcmNicInput": { + "description": "InMageRcm NIC input.", + "required": [ + "nicId", + "isPrimaryNic" + ], + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string" + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "isSelectedForFailover": { + "description": "A value indicating whether this NIC is selected for failover.", + "type": "string" + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "targetStaticIPAddress": { + "description": "The target static IP address.", + "type": "string" + }, + "testSubnetName": { + "description": "The test subnet name.", + "type": "string" + }, + "testStaticIPAddress": { + "description": "The test static IP address.", + "type": "string" + } + } + }, + "InMageRcmPolicyCreationInput": { + "description": "InMageRcm policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "enableMultiVmSync": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmPolicyDetails": { + "description": "InMageRcm specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + }, + "enableMultiVmSync": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmProtectedDiskDetails": { + "description": "InMageRcm protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string", + "readOnly": true + }, + "seedManagedDiskId": { + "description": "The ARM Id of the seed managed disk.", + "type": "string", + "readOnly": true + }, + "seedBlobUri": { + "description": "The uri of the seed blob.", + "type": "string", + "readOnly": true + }, + "targetManagedDiskId": { + "description": "The ARM Id of the target managed disk.", + "type": "string", + "readOnly": true + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "dataPendingInLogDataStoreInMB": { + "format": "double", + "description": "The data pending in log data store in MB.", + "type": "number", + "readOnly": true + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source agent in MB.", + "type": "number", + "readOnly": true + }, + "isInitialReplicationComplete": { + "description": "A value indicating whether initial replication is complete or not.", + "type": "string", + "readOnly": true + }, + "irDetails": { + "$ref": "#/definitions/InMageRcmSyncDetails", + "description": "The initial replication details." + }, + "resyncDetails": { + "$ref": "#/definitions/InMageRcmSyncDetails", + "description": "The resync details." + } + } + }, + "InMageRcmProtectionContainerMappingDetails": { + "description": "InMageRcm provider specific container mapping details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "enableAgentAutoUpgrade": { + "description": "A value indicating whether the flag for enable agent auto upgrade.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmRecoveryPointDetails": { + "description": "InMageRcm provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "isMultiVmSyncPoint": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmReplicationDetails": { + "description": "InMageRcm provider specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "internalIdentifier": { + "description": "The virtual machine internal identifier.", + "type": "string", + "readOnly": true + }, + "fabricDiscoveryMachineId": { + "description": "The ARM Id of the discovered VM.", + "type": "string", + "readOnly": true + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string", + "readOnly": true + }, + "discoveryType": { + "description": "The type of the discovered VM.", + "type": "string", + "readOnly": true + }, + "processServerId": { + "description": "The process server Id.", + "type": "string", + "readOnly": true + }, + "processorCoreCount": { + "format": "int32", + "description": "The processor core count.", + "type": "integer", + "readOnly": true + }, + "allocatedMemoryInMB": { + "format": "double", + "description": "The allocated memory in MB.", + "type": "number", + "readOnly": true + }, + "processServerName": { + "description": "The process server name.", + "type": "string", + "readOnly": true + }, + "runAsAccountId": { + "description": "The run-as account Id.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type.", + "type": "string", + "readOnly": true + }, + "primaryNicIpAddress": { + "description": "The IP address of the primary network interface.", + "type": "string", + "readOnly": true + }, + "targetGeneration": { + "description": "The target generation.", + "type": "string", + "readOnly": true + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "storageAccountId": { + "description": "The replication storage account ARM Id. This is applicable only for the blob based replication test hook.", + "type": "string", + "readOnly": true + }, + "targetVmName": { + "description": "Target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network Id.", + "type": "string" + }, + "failoverRecoveryPointId": { + "description": "The recovery point Id to which the VM was failed over.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "lastRpoInSeconds": { + "format": "int64", + "description": "The last recovery point objective value.", + "type": "integer", + "readOnly": true + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last recovery point objective calculated time.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointId": { + "description": "The last recovery point Id.", + "type": "string", + "readOnly": true + }, + "initialReplicationProgressPercentage": { + "format": "int32", + "description": "The initial replication progress percentage. This is calculated based on total bytes processed for all disks in the source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProcessedBytes": { + "format": "int64", + "description": "The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationTransferredBytes": { + "format": "int64", + "description": "The initial replication transferred bytes from source VM to azure for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProgressHealth": { + "description": "The initial replication progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage. This is calculated based on total bytes processed for all disks in the source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "resyncTransferredBytes": { + "format": "int64", + "description": "The resync transferred bytes from source VM to azure for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProgressHealth": { + "description": "The resync progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "agentUpgradeState": { + "description": "The agent auto upgrade state.", + "enum": [ + "None", + "Started", + "Completed", + "Commit" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MobilityAgentUpgradeState", + "modelAsString": true + } + }, + "lastAgentUpgradeType": { + "description": "The last agent upgrade type.", + "type": "string", + "readOnly": true + }, + "agentUpgradeJobId": { + "description": "The agent upgrade job Id.", + "type": "string", + "readOnly": true + }, + "agentUpgradeAttemptToVersion": { + "description": "The agent version to which last agent upgrade was attempted.", + "type": "string", + "readOnly": true + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmProtectedDiskDetails" + } + }, + "isLastUpgradeSuccessful": { + "description": "A value indicating whether last agent upgrade was successful or not.", + "type": "string", + "readOnly": true + }, + "isAgentRegistrationSuccessfulAfterFailover": { + "description": "A value indicating whether agent registration was successful after failover.", + "type": "boolean", + "readOnly": true + }, + "mobilityAgentDetails": { + "$ref": "#/definitions/InMageRcmMobilityAgentDetails", + "description": "The mobility agent information." + }, + "lastAgentUpgradeErrorDetails": { + "description": "The last agent upgrade error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmLastAgentUpgradeErrorDetails" + } + }, + "agentUpgradeBlockingErrorDetails": { + "description": "The agent upgrade blocking error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmAgentUpgradeBlockingErrorDetails" + } + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmNicDetails" + } + }, + "discoveredVmDetails": { + "$ref": "#/definitions/InMageRcmDiscoveredProtectedVmDetails", + "description": "The discovered VM details." + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmReprotectInput": { + "description": "InMageRcm specific provider input.", + "required": [ + "reprotectAgentId", + "datastoreName", + "logStorageAccountId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "reprotectAgentId": { + "description": "The reprotect agent Id.", + "type": "string" + }, + "datastoreName": { + "description": "The target datastore name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmSyncDetails": { + "description": "InMageRcm disk level sync details.", + "type": "object", + "properties": { + "progressHealth": { + "description": "The progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress", + "Queued" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DiskReplicationProgressHealth", + "modelAsString": true + } + }, + "transferredBytes": { + "format": "int64", + "description": "The transferred bytes from source VM to azure for the disk.", + "type": "integer", + "readOnly": true + }, + "last15MinutesTransferredBytes": { + "format": "int64", + "description": "The bytes transferred in last 15 minutes from source VM to azure.", + "type": "integer", + "readOnly": true + }, + "lastDataTransferTimeUtc": { + "description": "The time of the last data transfer from source VM to azure.", + "type": "string", + "readOnly": true + }, + "processedBytes": { + "format": "int64", + "description": "The total processed bytes. This includes bytes that are transferred from source VM to azure and matched bytes.", + "type": "integer", + "readOnly": true + }, + "startTime": { + "description": "The start time.", + "type": "string", + "readOnly": true + }, + "lastRefreshTime": { + "description": "The last refresh time.", + "type": "string", + "readOnly": true + }, + "progressPercentage": { + "format": "int32", + "description": "Progress in percentage. Progress percentage is calculated based on processed bytes.", + "type": "integer", + "readOnly": true + } + } + }, + "InMageRcmTestFailoverInput": { + "description": "InMageRcm provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "networkId": { + "description": "The test network Id.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUnplannedFailoverInput": { + "description": "InMageRcm provider specific input for unplanned failover.", + "required": [ + "performShutdown" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "performShutdown": { + "description": "A value indicating whether VM is to be shutdown.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUpdateApplianceForReplicationProtectedItemInput": { + "description": "InMageRcm provider specific input to update appliance for replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemProviderSpecificInput" + } + ], + "properties": { + "runAsAccountId": { + "description": "The run as account Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUpdateContainerMappingInput": { + "description": "InMageRcm update protection container mapping.", + "required": [ + "enableAgentAutoUpgrade" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput" + } + ], + "properties": { + "enableAgentAutoUpgrade": { + "description": "A value indicating whether agent auto upgrade has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUpdateReplicationProtectedItemInput": { + "description": "InMageRcm provider specific input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network ARM Id.", + "type": "string" + }, + "vmNics": { + "description": "The list of NIC details.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmNicInput" + } + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageReplicationDetails": { + "description": "InMage provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "activeSiteType": { + "description": "The active location of the VM. If the VM is being protected from Azure, this field will take values from { Azure, OnPrem }. If the VM is being protected between two data-centers, this field will be OnPrem always.", + "type": "string" + }, + "sourceVmCpuCount": { + "format": "int32", + "description": "The CPU count of the VM on the primary side.", + "type": "integer" + }, + "sourceVmRamSizeInMB": { + "format": "int32", + "description": "The RAM size of the VM on the primary side.", + "type": "integer" + }, + "osDetails": { + "$ref": "#/definitions/OSDiskDetails", + "description": "The OS details." + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "resyncDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "The resync details of the machine." + }, + "retentionWindowStart": { + "format": "date-time", + "description": "The retention window start time.", + "type": "string" + }, + "retentionWindowEnd": { + "format": "date-time", + "description": "The retention window end time.", + "type": "string" + }, + "compressedDataRateInMB": { + "format": "double", + "description": "The compressed data change rate in MB.", + "type": "number" + }, + "uncompressedDataRateInMB": { + "format": "double", + "description": "The uncompressed data change rate in MB.", + "type": "number" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageProtectedDiskDetails" + } + }, + "ipAddress": { + "description": "The source IP address.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the source server.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "masterTargetId": { + "description": "The master target Id.", + "type": "string" + }, + "consistencyPoints": { + "description": "The collection of Consistency points.", + "type": "object", + "additionalProperties": { + "format": "date-time", + "type": "string" + } + }, + "diskResized": { + "description": "A value indicating whether any disk is resized for this VM.", + "type": "string" + }, + "rebootAfterUpdateStatus": { + "description": "A value indicating whether the source server requires a restart after update.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group Id, if any.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name, if any.", + "type": "string" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether the multi vm sync is enabled or disabled.", + "type": "string" + }, + "agentDetails": { + "$ref": "#/definitions/InMageAgentDetails", + "description": "The agent details." + }, + "vCenterInfrastructureId": { + "description": "The vCenter infrastructure Id.", + "type": "string" + }, + "infrastructureVmId": { + "description": "The infrastructure VM Id.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "discoveryType": { + "description": "A value indicating the discovery type of the machine.", + "type": "string" + }, + "azureStorageAccountId": { + "description": "A value indicating the underlying Azure storage account. If the VM is not running in Azure, this value shall be set to null.", + "type": "string" + }, + "datastores": { + "description": "The datastores of the on-premise machine Value can be list of strings that contain datastore names.", + "type": "array", + "items": { + "type": "string" + } + }, + "validationErrors": { + "description": "The validation errors of the on-premise machine Value can be list of validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "lastUpdateReceivedTime": { + "format": "date-time", + "description": "The last update time received from on-prem components.", + "type": "string" + }, + "replicaId": { + "description": "The replica id of the protected item.", + "type": "string" + }, + "osVersion": { + "description": "The OS Version of the protected item.", + "type": "string" + }, + "isAdditionalStatsAvailable": { + "description": "A value indicating whether additional IR stats are available or not.", + "type": "boolean" + }, + "totalDataTransferred": { + "format": "int64", + "description": "The total transferred data in bytes.", + "type": "integer" + }, + "totalProgressHealth": { + "description": "The progress health.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageReprotectInput": { + "description": "InMageAzureV2 specific provider input.", + "required": [ + "masterTargetId", + "processServerId", + "retentionDrive", + "profileId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "masterTargetId": { + "description": "The Master Target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "retentionDrive": { + "description": "The retention drive to use on the MT.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "datastoreName": { + "description": "The target datastore name.", + "type": "string" + }, + "diskExclusionInput": { + "$ref": "#/definitions/InMageDiskExclusionInput", + "description": "The enable disk exclusion input." + }, + "profileId": { + "description": "The Policy Id.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageTestFailoverInput": { + "description": "Provider specific input for InMage test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointType", + "modelAsString": true + } + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageUnplannedFailoverInput": { + "description": "Provider specific input for InMage unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointType", + "modelAsString": true + } + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageVolumeExclusionOptions": { + "description": "Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.", + "type": "object", + "properties": { + "volumeLabel": { + "description": "The volume label. The disk having any volume with this label will be excluded from replication.", + "type": "string" + }, + "onlyExcludeIfSingleVolume": { + "description": "The value indicating whether to exclude multi volume disk or not. If a disk has multiple volumes and one of the volume has label matching with VolumeLabel this disk will be excluded from replication if OnlyExcludeIfSingleVolume is false.", + "type": "string" + } + } + }, + "InnerHealthError": { + "description": "Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.", + "type": "object", + "properties": { + "errorSource": { + "description": "Source of error.", + "type": "string" + }, + "errorType": { + "description": "Type of error.", + "type": "string" + }, + "errorLevel": { + "description": "Level of error.", + "type": "string" + }, + "errorCategory": { + "description": "Category of error.", + "type": "string" + }, + "errorCode": { + "description": "Error code.", + "type": "string" + }, + "summaryMessage": { + "description": "Summary message of the entity.", + "type": "string" + }, + "errorMessage": { + "description": "Error message.", + "type": "string" + }, + "possibleCauses": { + "description": "Possible causes of error.", + "type": "string" + }, + "recommendedAction": { + "description": "Recommended action to resolve error.", + "type": "string" + }, + "creationTimeUtc": { + "format": "date-time", + "description": "Error creation time (UTC).", + "type": "string" + }, + "recoveryProviderErrorMessage": { + "description": "DRA error message.", + "type": "string" + }, + "entityId": { + "description": "ID of the entity.", + "type": "string" + }, + "errorId": { + "description": "The health error unique id.", + "type": "string" + }, + "customerResolvability": { + "description": "Value indicating whether the health error is customer resolvable.", + "enum": [ + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthErrorCustomerResolvability", + "modelAsString": true + } + } + } + }, + "InputEndpoint": { + "type": "object", + "properties": { + "endpointName": { + "type": "string" + }, + "privatePort": { + "format": "int32", + "type": "integer" + }, + "publicPort": { + "format": "int32", + "type": "integer" + }, + "protocol": { + "type": "string" + } + } + }, + "Job": { + "description": "Job details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The custom data." + } + } + }, + "JobCollection": { + "description": "Collection of jobs.", + "type": "object", + "properties": { + "value": { + "description": "The list of jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/Job" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "JobDetails": { + "description": "Job details based on specific job type.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the type of job details (see JobDetailsTypes enum for possible values).", + "type": "string" + }, + "affectedObjectDetails": { + "description": "The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "discriminator": "instanceType" + }, + "JobEntity": { + "description": "This class contains the minimal job details required to navigate to the desired drill down.", + "type": "object", + "properties": { + "jobId": { + "description": "The job id.", + "type": "string" + }, + "jobFriendlyName": { + "description": "The job display name.", + "type": "string" + }, + "targetObjectId": { + "description": "The object id.", + "type": "string" + }, + "targetObjectName": { + "description": "The object name.", + "type": "string" + }, + "targetInstanceType": { + "description": "The workflow affected object type.", + "type": "string" + }, + "jobScenarioName": { + "description": "The job name. Enum type ScenarioName.", + "type": "string" + } + } + }, + "JobErrorDetails": { + "description": "This class contains the error details per object.", + "type": "object", + "properties": { + "serviceErrorDetails": { + "$ref": "#/definitions/ServiceError", + "description": "The Service error details." + }, + "providerErrorDetails": { + "$ref": "#/definitions/ProviderError", + "description": "The Provider error details." + }, + "errorLevel": { + "description": "Error level of error.", + "type": "string" + }, + "creationTime": { + "format": "date-time", + "description": "The creation time of job error.", + "type": "string" + }, + "taskId": { + "description": "The Id of the task.", + "type": "string" + } + } + }, + "JobProperties": { + "description": "Job custom data details.", + "type": "object", + "properties": { + "activityId": { + "description": "The activity id.", + "type": "string" + }, + "scenarioName": { + "description": "The ScenarioName.", + "type": "string" + }, + "friendlyName": { + "description": "The DisplayName.", + "type": "string" + }, + "state": { + "description": "The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.", + "type": "string" + }, + "stateDescription": { + "description": "The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.", + "type": "string" + }, + "tasks": { + "description": "The tasks.", + "type": "array", + "items": { + "$ref": "#/definitions/ASRTask" + } + }, + "errors": { + "description": "The errors.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + } + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "allowedActions": { + "description": "The Allowed action the job.", + "type": "array", + "items": { + "type": "string" + } + }, + "targetObjectId": { + "description": "The affected Object Id.", + "type": "string" + }, + "targetObjectName": { + "description": "The name of the affected object.", + "type": "string" + }, + "targetInstanceType": { + "description": "The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class.", + "type": "string" + }, + "customDetails": { + "$ref": "#/definitions/JobDetails", + "description": "The custom job details like test failover job details." + } + } + }, + "JobQueryParameter": { + "description": "Query parameter to enumerate jobs.", + "type": "object", + "properties": { + "startTime": { + "description": "Date time to get jobs from.", + "type": "string" + }, + "endTime": { + "description": "Date time to get jobs upto.", + "type": "string" + }, + "fabricId": { + "description": "The Id of the fabric to search jobs under.", + "type": "string" + }, + "affectedObjectTypes": { + "description": "The type of objects.", + "type": "string" + }, + "jobStatus": { + "description": "The states of the job to be filtered can be in.", + "type": "string" + }, + "jobOutputType": { + "description": "The output type of the jobs.", + "enum": [ + "Json", + "Xml", + "Excel" + ], + "type": "string", + "x-ms-enum": { + "name": "ExportJobOutputSerializationType", + "modelAsString": true + } + }, + "jobName": { + "description": "The job Name.", + "type": "string" + }, + "timezoneOffset": { + "format": "double", + "description": "The timezone offset for the location of the request (in minutes).", + "type": "number" + } + } + }, + "JobStatusEventDetails": { + "description": "Model class for event details of a job status event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSpecificDetails" + } + ], + "properties": { + "jobId": { + "description": "Job arm id for the event.", + "type": "string" + }, + "jobFriendlyName": { + "description": "JobName for the Event.", + "type": "string" + }, + "jobStatus": { + "description": "JobStatus for the Event.", + "type": "string" + }, + "affectedObjectType": { + "description": "AffectedObjectType for the event.", + "type": "string" + } + }, + "x-ms-discriminator-value": "JobStatus" + }, + "JobTaskDetails": { + "description": "This class represents a task which is actually a workflow so that one can navigate to its individual drill down.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "jobTask": { + "$ref": "#/definitions/JobEntity", + "description": "The job entity." + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "JobTaskDetails" + }, + "KeyEncryptionKeyInfo": { + "description": "Key Encryption Key (KEK) information.", + "type": "object", + "properties": { + "keyIdentifier": { + "description": "The key URL / identifier.", + "type": "string" + }, + "keyVaultResourceArmId": { + "description": "The KeyVault resource ARM Id for key.", + "type": "string" + } + } + }, + "LogicalNetwork": { + "description": "Logical network data model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/LogicalNetworkProperties", + "description": "The Logical Network Properties." + } + } + }, + "LogicalNetworkCollection": { + "description": "List of logical networks.", + "type": "object", + "properties": { + "value": { + "description": "The Logical Networks list details.", + "type": "array", + "items": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "LogicalNetworkProperties": { + "description": "Logical Network Properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The Friendly Name.", + "type": "string" + }, + "networkVirtualizationStatus": { + "description": "A value indicating whether Network Virtualization is enabled for the logical network.", + "type": "string" + }, + "logicalNetworkUsage": { + "description": "A value indicating whether logical network is used as private test network by test failover.", + "type": "string" + }, + "logicalNetworkDefinitionsStatus": { + "description": "A value indicating whether logical network definitions are isolated.", + "type": "string" + } + } + }, + "ManualActionTaskDetails": { + "description": "This class represents the manual action task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "instructions": { + "description": "The instructions.", + "type": "string" + }, + "observation": { + "description": "The observation.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ManualActionTaskDetails" + }, + "MarsAgentDetails": { + "description": "Mars agent details.", + "type": "object", + "properties": { + "id": { + "description": "The Mars agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Mars agent name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The Mars agent Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The Mars agent Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the Mars agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the Mars agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "MasterTargetServer": { + "description": "Details of a Master Target Server.", + "type": "object", + "properties": { + "id": { + "description": "The server Id.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the server.", + "type": "string" + }, + "name": { + "description": "The server name.", + "type": "string" + }, + "osType": { + "description": "The OS type of the server.", + "type": "string" + }, + "agentVersion": { + "description": "The version of the scout component on the server.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the server.", + "type": "string" + }, + "versionStatus": { + "description": "Version status.", + "type": "string" + }, + "retentionVolumes": { + "description": "The retention volumes of Master target Server.", + "type": "array", + "items": { + "$ref": "#/definitions/RetentionVolume" + } + }, + "dataStores": { + "description": "The list of data stores in the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/DataStore" + } + }, + "validationErrors": { + "description": "Validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "healthErrors": { + "description": "Health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "diskCount": { + "format": "int32", + "description": "Disk count of the master target.", + "type": "integer" + }, + "osVersion": { + "description": "OS Version of the master target.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "marsAgentVersion": { + "description": "MARS agent version.", + "type": "string" + }, + "marsAgentExpiryDate": { + "format": "date-time", + "description": "MARS agent expiry date.", + "type": "string" + }, + "agentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "Agent version details." + }, + "marsAgentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "Mars agent version details." + } + } + }, + "MigrateInput": { + "description": "Input for migrate.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MigrateInputProperties", + "description": "Migrate input properties." + } + } + }, + "MigrateInputProperties": { + "description": "Migrate input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/MigrateProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "MigrateProviderSpecificInput": { + "description": "Migrate provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "MigrationItem": { + "description": "Migration item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MigrationItemProperties", + "description": "The migration item properties." + } + } + }, + "MigrationItemCollection": { + "description": "Migration item collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of migration items.", + "type": "array", + "items": { + "$ref": "#/definitions/MigrationItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "MigrationItemProperties": { + "description": "Migration item properties.", + "type": "object", + "properties": { + "machineName": { + "description": "The on-premise virtual machine name.", + "type": "string", + "readOnly": true + }, + "policyId": { + "description": "The ARM Id of policy governing this item.", + "type": "string", + "readOnly": true + }, + "policyFriendlyName": { + "description": "The name of policy governing this item.", + "type": "string", + "readOnly": true + }, + "recoveryServicesProviderId": { + "description": "The recovery services provider ARM Id.", + "type": "string", + "readOnly": true + }, + "replicationStatus": { + "description": "The replication status.", + "type": "string", + "readOnly": true + }, + "migrationState": { + "description": "The migration status.", + "enum": [ + "None", + "EnableMigrationInProgress", + "EnableMigrationFailed", + "DisableMigrationInProgress", + "DisableMigrationFailed", + "InitialSeedingInProgress", + "InitialSeedingFailed", + "Replicating", + "MigrationInProgress", + "MigrationSucceeded", + "MigrationFailed", + "ResumeInProgress", + "ResumeInitiated", + "SuspendingProtection", + "ProtectionSuspended", + "MigrationCompletedWithInformation", + "MigrationPartiallySucceeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MigrationState", + "modelAsString": true + } + }, + "migrationStateDescription": { + "description": "The migration state description.", + "type": "string", + "readOnly": true + }, + "lastTestMigrationTime": { + "format": "date-time", + "description": "The last test migration time.", + "type": "string", + "readOnly": true + }, + "lastTestMigrationStatus": { + "description": "The status of the last test migration.", + "type": "string", + "readOnly": true + }, + "lastMigrationTime": { + "format": "date-time", + "description": "The last migration time.", + "type": "string", + "readOnly": true + }, + "lastMigrationStatus": { + "description": "The status of the last migration.", + "type": "string", + "readOnly": true + }, + "testMigrateState": { + "description": "The test migrate state.", + "enum": [ + "None", + "TestMigrationInProgress", + "TestMigrationSucceeded", + "TestMigrationFailed", + "TestMigrationCleanupInProgress", + "TestMigrationCompletedWithInformation", + "TestMigrationPartiallySucceeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TestMigrationState", + "modelAsString": true + } + }, + "testMigrateStateDescription": { + "description": "The test migrate state description.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The consolidated health.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The list of health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "allowedOperations": { + "description": "The allowed operations on the migration item based on the current migration state of the item.", + "type": "array", + "items": { + "enum": [ + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup", + "Migrate", + "StartResync", + "PauseReplication", + "ResumeReplication" + ], + "type": "string", + "x-ms-enum": { + "name": "MigrationItemOperation", + "modelAsString": true + } + }, + "readOnly": true + }, + "currentJob": { + "$ref": "#/definitions/CurrentJobDetails", + "description": "The current job details.", + "readOnly": true + }, + "criticalJobHistory": { + "description": "The critical past job details.", + "type": "array", + "items": { + "$ref": "#/definitions/CriticalJobHistoryDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "eventCorrelationId": { + "description": "The correlation Id for events associated with this migration item.", + "type": "string", + "readOnly": true + }, + "providerSpecificDetails": { + "$ref": "#/definitions/MigrationProviderSpecificSettings", + "description": "The migration provider custom settings." + } + } + }, + "MigrationItemsQueryParameter": { + "description": "Query parameter to enumerate migration items.", + "type": "object", + "properties": { + "sourceFabricName": { + "description": "The source fabric name filter.", + "type": "string" + }, + "sourceContainerName": { + "description": "The source container name filter.", + "type": "string" + }, + "instanceType": { + "description": "The replication provider type.", + "type": "string" + } + } + }, + "MigrationProviderSpecificSettings": { + "description": "Migration provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "MigrationRecoveryPoint": { + "description": "Recovery point for a migration item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MigrationRecoveryPointProperties", + "description": "Recovery point properties." + } + } + }, + "MigrationRecoveryPointCollection": { + "description": "Collection of migration recovery points.", + "type": "object", + "properties": { + "value": { + "description": "The migration recovery point details.", + "type": "array", + "items": { + "$ref": "#/definitions/MigrationRecoveryPoint" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "MigrationRecoveryPointProperties": { + "description": "Migration item recovery point properties.", + "type": "object", + "properties": { + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string", + "readOnly": true + }, + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "NotSpecified", + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MigrationRecoveryPointType", + "modelAsString": true + } + } + } + }, + "MobilityServiceUpdate": { + "description": "The Mobility Service update details.", + "type": "object", + "properties": { + "version": { + "description": "The version of the latest update.", + "type": "string" + }, + "rebootStatus": { + "description": "The reboot status of the update - whether it is required or not.", + "type": "string" + }, + "osType": { + "description": "The OS type.", + "type": "string" + } + } + }, + "Network": { + "description": "Network model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkProperties", + "description": "The Network Properties." + } + } + }, + "NetworkCollection": { + "description": "List of networks.", + "type": "object", + "properties": { + "value": { + "description": "The Networks list details.", + "type": "array", + "items": { + "$ref": "#/definitions/Network" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "NetworkMapping": { + "description": "Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate extensions in subsequent versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkMappingProperties", + "description": "The Network Mapping Properties." + } + } + }, + "NetworkMappingCollection": { + "description": "List of network mappings. As with NetworkMapping, it should be possible to reuse a prev version of this class. It doesn't seem likely this class could be anything more than a slightly bespoke collection of NetworkMapping. Hence it makes sense to override Load with Base.NetworkMapping instead of existing CurrentVersion.NetworkMapping.", + "type": "object", + "properties": { + "value": { + "description": "The Network Mappings list.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkMapping" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "NetworkMappingFabricSpecificSettings": { + "description": "Network Mapping fabric specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "NetworkMappingProperties": { + "description": "Network Mapping Properties.", + "type": "object", + "properties": { + "state": { + "description": "The pairing state for network mapping.", + "type": "string" + }, + "primaryNetworkFriendlyName": { + "description": "The primary network friendly name.", + "type": "string" + }, + "primaryNetworkId": { + "description": "The primary network id for network mapping.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The primary fabric friendly name.", + "type": "string" + }, + "recoveryNetworkFriendlyName": { + "description": "The recovery network friendly name.", + "type": "string" + }, + "recoveryNetworkId": { + "description": "The recovery network id for network mapping.", + "type": "string" + }, + "recoveryFabricArmId": { + "description": "The recovery fabric ARM id.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The recovery fabric friendly name.", + "type": "string" + }, + "fabricSpecificSettings": { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings", + "description": "The fabric specific settings." + } + } + }, + "NetworkProperties": { + "description": "Network Properties.", + "type": "object", + "properties": { + "fabricType": { + "description": "The Fabric Type.", + "type": "string" + }, + "subnets": { + "description": "The List of subnets.", + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + } + }, + "friendlyName": { + "description": "The Friendly Name.", + "type": "string" + }, + "networkType": { + "description": "The Network Type.", + "type": "string" + } + } + }, + "NewProtectionProfile": { + "description": "New Protection profile input.", + "required": [ + "policyName", + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionProfileCustomDetails" + } + ], + "properties": { + "policyName": { + "description": "The protection profile input.", + "type": "string" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "New" + }, + "NewRecoveryVirtualNetwork": { + "description": "Recovery virtual network input to create new virtual network from given source network.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails" + } + ], + "properties": { + "recoveryVirtualNetworkResourceGroupName": { + "description": "The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM.", + "type": "string" + }, + "recoveryVirtualNetworkName": { + "description": "The recovery virtual network name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "New" + }, + "OperationsDiscovery": { + "description": "Operations discovery class.", + "type": "object", + "properties": { + "name": { + "description": "Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include: * Microsoft.Compute/virtualMachine/capture/action * Microsoft.Compute/virtualMachine/restart/action * Microsoft.Compute/virtualMachine/write * Microsoft.Compute/virtualMachine/read * Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used. As a note: all resource providers would need to include the \"{Resource Provider Namespace}/register/action\" operation in their response. This API is used to register for their service, and should include details about the operation (e.g. a localized name for the resource provider + any special considerations like PII release).", + "type": "string" + }, + "display": { + "$ref": "#/definitions/Display", + "description": "Object type." + }, + "origin": { + "description": "Origin. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is \"user,system\".", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationsDiscoveryProperties", + "description": "Properties. Reserved for future use." + } + } + }, + "OperationsDiscoveryCollection": { + "description": "Collection of ClientDiscovery details.", + "type": "object", + "properties": { + "value": { + "description": "The ClientDiscovery details.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationsDiscovery" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "OperationsDiscoveryProperties": { + "description": "ClientDiscovery properties.", + "type": "object", + "properties": {} + }, + "OSDetails": { + "description": "Disk Details.", + "type": "object", + "properties": { + "osType": { + "description": "VM Disk details.", + "type": "string" + }, + "productType": { + "description": "Product type.", + "type": "string" + }, + "osEdition": { + "description": "The OSEdition.", + "type": "string" + }, + "oSVersion": { + "description": "The OS Version.", + "type": "string" + }, + "oSMajorVersion": { + "description": "The OS Major Version.", + "type": "string" + }, + "oSMinorVersion": { + "description": "The OS Minor Version.", + "type": "string" + } + } + }, + "OSDiskDetails": { + "description": "Details of the OS Disk.", + "type": "object", + "properties": { + "osVhdId": { + "description": "The id of the disk containing the OS.", + "type": "string" + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string" + }, + "vhdName": { + "description": "The OS disk VHD name.", + "type": "string" + } + } + }, + "OSUpgradeSupportedVersions": { + "description": "Supported OS upgrade versions.", + "type": "object", + "properties": { + "supportedSourceOsVersion": { + "description": "The source OS version name.", + "type": "string", + "readOnly": true + }, + "supportedTargetOsVersions": { + "description": "The target OS version names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "OSVersionWrapper": { + "description": "Wrapper model for OSVersion to include version and service pack info.", + "type": "object", + "properties": { + "version": { + "description": "The version.", + "type": "string" + }, + "servicePack": { + "description": "The service pack.", + "type": "string" + } + } + }, + "PauseReplicationInput": { + "description": "Pause replication input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PauseReplicationInputProperties", + "description": "Pause replication input properties." + } + } + }, + "PauseReplicationInputProperties": { + "description": "Pause replication input properties.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + } + }, + "PlannedFailoverInput": { + "description": "Input definition for planned failover.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PlannedFailoverInputProperties", + "description": "Planned failover input properties." + } + } + }, + "PlannedFailoverInputProperties": { + "description": "Input definition for planned failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput", + "description": "Provider specific settings." + } + } + }, + "PlannedFailoverProviderSpecificFailoverInput": { + "description": "Provider specific failover input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "Policy": { + "description": "Protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PolicyProperties", + "description": "The custom data." + } + } + }, + "PolicyCollection": { + "description": "Protection Profile Collection details.", + "type": "object", + "properties": { + "value": { + "description": "The policy details.", + "type": "array", + "items": { + "$ref": "#/definitions/Policy" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "PolicyProperties": { + "description": "Protection profile custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The FriendlyName.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/PolicyProviderSpecificDetails", + "description": "The ReplicationChannelSetting." + } + } + }, + "PolicyProviderSpecificDetails": { + "description": "Base class for Provider specific details for policies.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "PolicyProviderSpecificInput": { + "description": "Base class for provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ProcessServer": { + "description": "Details of the Process Server.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The Process Server's friendly name.", + "type": "string" + }, + "id": { + "description": "The Process Server Id.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the server.", + "type": "string" + }, + "osType": { + "description": "The OS type of the server.", + "type": "string" + }, + "agentVersion": { + "description": "The version of the scout component on the server.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the server.", + "type": "string" + }, + "versionStatus": { + "description": "Version status.", + "type": "string" + }, + "mobilityServiceUpdates": { + "description": "The list of the mobility service updates available on the Process Server.", + "type": "array", + "items": { + "$ref": "#/definitions/MobilityServiceUpdate" + } + }, + "hostId": { + "description": "The agent generated Id.", + "type": "string" + }, + "machineCount": { + "description": "The servers configured with this PS.", + "type": "string" + }, + "replicationPairCount": { + "description": "The number of replication pairs configured in this PS.", + "type": "string" + }, + "systemLoad": { + "description": "The percentage of the system load.", + "type": "string" + }, + "systemLoadStatus": { + "description": "The system load status.", + "type": "string" + }, + "cpuLoad": { + "description": "The percentage of the CPU load.", + "type": "string" + }, + "cpuLoadStatus": { + "description": "The CPU load status.", + "type": "string" + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer" + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer" + }, + "memoryUsageStatus": { + "description": "The memory usage status.", + "type": "string" + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total space.", + "type": "integer" + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available space.", + "type": "integer" + }, + "spaceUsageStatus": { + "description": "The space usage status.", + "type": "string" + }, + "psServiceStatus": { + "description": "The PS service status.", + "type": "string" + }, + "sslCertExpiryDate": { + "format": "date-time", + "description": "The PS SSL cert expiry date.", + "type": "string" + }, + "sslCertExpiryRemainingDays": { + "format": "int32", + "description": "CS SSL cert expiry date.", + "type": "integer" + }, + "osVersion": { + "description": "OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0.", + "type": "string" + }, + "healthErrors": { + "description": "Health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "agentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "The agent version details." + }, + "health": { + "description": "The health of Process Server.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "psStatsRefreshTime": { + "format": "date-time", + "description": "The process server stats refresh time.", + "type": "string", + "readOnly": true + }, + "throughputUploadPendingDataInBytes": { + "format": "int64", + "description": "The uploading pending data in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputInMBps": { + "format": "int64", + "description": "The throughput in MBps.", + "type": "integer", + "readOnly": true + }, + "throughputInBytes": { + "format": "int64", + "description": "The throughput in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputStatus": { + "description": "The throughput status.", + "type": "string", + "readOnly": true + }, + "marsCommunicationStatus": { + "description": "The MARS communication status.", + "type": "string", + "readOnly": true + }, + "marsRegistrationStatus": { + "description": "The MARS registration status.", + "type": "string", + "readOnly": true + } + } + }, + "ProcessServerDetails": { + "description": "Process server details.", + "type": "object", + "properties": { + "id": { + "description": "The process server Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The process server name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The process server Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The process server Fqdn.", + "type": "string", + "readOnly": true + }, + "ipAddresses": { + "description": "The list of IP addresses for communicating with the RCM component.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the process server.", + "type": "string", + "readOnly": true + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer", + "readOnly": true + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer", + "readOnly": true + }, + "usedMemoryInBytes": { + "format": "int64", + "description": "The used memory.", + "type": "integer", + "readOnly": true + }, + "memoryUsagePercentage": { + "format": "double", + "description": "The memory usage percentage.", + "type": "number", + "readOnly": true + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total disk space.", + "type": "integer", + "readOnly": true + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available disk space.", + "type": "integer", + "readOnly": true + }, + "usedSpaceInBytes": { + "format": "int64", + "description": "The used disk space.", + "type": "integer", + "readOnly": true + }, + "freeSpacePercentage": { + "format": "double", + "description": "The free disk space percentage.", + "type": "number", + "readOnly": true + }, + "throughputUploadPendingDataInBytes": { + "format": "int64", + "description": "The uploading pending data in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputInBytes": { + "format": "int64", + "description": "The throughput in bytes.", + "type": "integer", + "readOnly": true + }, + "processorUsagePercentage": { + "format": "double", + "description": "The processor usage percentage.", + "type": "number", + "readOnly": true + }, + "throughputStatus": { + "description": "The throughput status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "systemLoad": { + "format": "int64", + "description": "The system load.", + "type": "integer", + "readOnly": true + }, + "systemLoadStatus": { + "description": "The system load status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "diskUsageStatus": { + "description": "The disk usage status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "memoryUsageStatus": { + "description": "The memory usage status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "processorUsageStatus": { + "description": "The processor usage status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "health": { + "description": "The health of the process server.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "protectedItemCount": { + "format": "int32", + "description": "The protected item count.", + "type": "integer", + "readOnly": true + }, + "historicHealth": { + "description": "The historic health of the process server based on the health in last 24 hours.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + } + } + }, + "ProtectableItem": { + "description": "Replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectableItemProperties", + "description": "The custom data." + } + } + }, + "ProtectableItemCollection": { + "description": "Protectable item collection.", + "type": "object", + "properties": { + "value": { + "description": "The Protectable item details.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectableItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ProtectableItemProperties": { + "description": "Replication protected item custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "protectionStatus": { + "description": "The protection status.", + "type": "string" + }, + "replicationProtectedItemId": { + "description": "The ARM resource of protected items.", + "type": "string" + }, + "recoveryServicesProviderId": { + "description": "The recovery provider ARM Id.", + "type": "string" + }, + "protectionReadinessErrors": { + "description": "The Current protection readiness errors.", + "type": "array", + "items": { + "type": "string" + } + }, + "supportedReplicationProviders": { + "description": "The list of replication providers supported for the protectable item.", + "type": "array", + "items": { + "type": "string" + } + }, + "customDetails": { + "$ref": "#/definitions/ConfigurationSettings", + "description": "The Replication provider custom settings." + } + } + }, + "ProtectableItemQueryParameter": { + "description": "Query parameter to enumerate Protectable items.", + "type": "object", + "properties": { + "state": { + "description": "State of the Protectable item query filter.", + "type": "string" + } + } + }, + "ProtectedItemsQueryParameter": { + "description": "Query parameter to enumerate protected items.", + "type": "object", + "properties": { + "sourceFabricName": { + "description": "The source fabric name filter.", + "type": "string" + }, + "recoveryPlanName": { + "description": "The recovery plan filter.", + "type": "string" + }, + "sourceFabricLocation": { + "description": "The source fabric location filter.", + "type": "string" + }, + "fabricObjectId": { + "description": "The fabric object Id filter.", + "type": "string" + }, + "vCenterName": { + "description": "The vCenter name filter.", + "type": "string" + }, + "instanceType": { + "description": "The replication provider type.", + "type": "string" + }, + "multiVmGroupCreateOption": { + "description": "Whether Multi VM group is auto created or specified by user.", + "enum": [ + "AutoCreated", + "UserSpecified" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmGroupCreateOption", + "modelAsString": true + } + }, + "processServerId": { + "description": "The process server Id filter.", + "type": "string" + } + } + }, + "ProtectionContainer": { + "description": "Protection container details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionContainerProperties", + "description": "The custom data." + } + } + }, + "ProtectionContainerCollection": { + "description": "Protection Container collection.", + "type": "object", + "properties": { + "value": { + "description": "The Protection Container details.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ProtectionContainerFabricSpecificDetails": { + "description": "Base class for fabric specific details of container.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string", + "readOnly": true + } + } + }, + "ProtectionContainerMapping": { + "description": "Protection container mapping object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionContainerMappingProperties", + "description": "The custom data." + } + } + }, + "ProtectionContainerMappingCollection": { + "description": "Protection container mapping collection class.", + "type": "object", + "properties": { + "value": { + "description": "List of container mappings.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "nextLink": { + "description": "Link to fetch rest of the data.", + "type": "string" + } + } + }, + "ProtectionContainerMappingProperties": { + "description": "Protection container mapping properties.", + "type": "object", + "properties": { + "targetProtectionContainerId": { + "description": "Paired protection container ARM ID.", + "type": "string" + }, + "targetProtectionContainerFriendlyName": { + "description": "Friendly name of paired container.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails", + "description": "Provider specific provider details." + }, + "health": { + "description": "Health of pairing.", + "type": "string" + }, + "healthErrorDetails": { + "description": "Health error.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "policyId": { + "description": "Policy ARM Id.", + "type": "string" + }, + "state": { + "description": "Association Status.", + "type": "string" + }, + "sourceProtectionContainerFriendlyName": { + "description": "Friendly name of source protection container.", + "type": "string" + }, + "sourceFabricFriendlyName": { + "description": "Friendly name of source fabric.", + "type": "string" + }, + "targetFabricFriendlyName": { + "description": "Friendly name of target fabric.", + "type": "string" + }, + "policyFriendlyName": { + "description": "Friendly name of replication policy.", + "type": "string" + } + } + }, + "ProtectionContainerMappingProviderSpecificDetails": { + "description": "Container mapping provider specific details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ProtectionContainerProperties": { + "description": "Protection profile custom data details.", + "type": "object", + "properties": { + "fabricFriendlyName": { + "description": "Fabric friendly name.", + "type": "string" + }, + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "fabricType": { + "description": "The fabric type.", + "type": "string" + }, + "protectedItemCount": { + "format": "int32", + "description": "Number of protected PEs.", + "type": "integer" + }, + "pairingStatus": { + "description": "The pairing status of this cloud.", + "type": "string" + }, + "role": { + "description": "The role of this cloud.", + "type": "string" + }, + "fabricSpecificDetails": { + "$ref": "#/definitions/ProtectionContainerFabricSpecificDetails", + "description": "Fabric specific details." + } + } + }, + "ProtectionProfileCustomDetails": { + "description": "Protection Profile custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "ProviderError": { + "description": "This class contains the error details per object.", + "type": "object", + "properties": { + "errorCode": { + "format": "int32", + "description": "The Error code.", + "type": "integer" + }, + "errorMessage": { + "description": "The Error message.", + "type": "string" + }, + "errorId": { + "description": "The Provider error Id.", + "type": "string" + }, + "possibleCauses": { + "description": "The possible causes for the error.", + "type": "string" + }, + "recommendedAction": { + "description": "The recommended action to resolve the error.", + "type": "string" + } + } + }, + "ProviderSpecificRecoveryPointDetails": { + "description": "Replication provider specific recovery point details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the provider type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "PushInstallerDetails": { + "description": "Push installer details.", + "type": "object", + "properties": { + "id": { + "description": "The push installer Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The push installer name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The push installer Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The push installer Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the push installer.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the push installer.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "RcmProxyDetails": { + "description": "RCM proxy details.", + "type": "object", + "properties": { + "id": { + "description": "The RCM proxy Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The RCM proxy name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The RCM proxy Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The RCM proxy Fqdn.", + "type": "string", + "readOnly": true + }, + "clientAuthenticationType": { + "description": "The client authentication type.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the RCM proxy.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the RCM proxy.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "RecoveryAvailabilitySetCustomDetails": { + "description": "Recovery Availability Set custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RecoveryPlan": { + "description": "Recovery plan details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanProperties", + "description": "The custom details." + } + } + }, + "RecoveryPlanA2ADetails": { + "description": "Recovery plan A2A specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificDetails" + } + ], + "properties": { + "primaryZone": { + "description": "The primary zone.", + "type": "string" + }, + "recoveryZone": { + "description": "The recovery zone.", + "type": "string" + }, + "primaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The primary extended location." + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery extended location." + } + }, + "x-ms-discriminator-value": "A2A" + }, + "RecoveryPlanA2AFailoverInput": { + "description": "Recovery plan A2A failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "A2ARpRecoveryPointType", + "modelAsString": true + } + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for TFO or not.", + "type": "string" + }, + "multiVmSyncPointOption": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "enum": [ + "UseMultiVmSyncRecoveryPoint", + "UsePerVmRecoveryPoint" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmSyncPointOption", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "RecoveryPlanA2AInput": { + "description": "Recovery plan A2A input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificInput" + } + ], + "properties": { + "primaryZone": { + "description": "The primary zone.", + "type": "string" + }, + "recoveryZone": { + "description": "The recovery zone.", + "type": "string" + }, + "primaryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The primary extended location." + }, + "recoveryExtendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The recovery extended location." + } + }, + "x-ms-discriminator-value": "A2A" + }, + "RecoveryPlanAction": { + "description": "Recovery plan action details.", + "required": [ + "actionName", + "failoverTypes", + "failoverDirections", + "customDetails" + ], + "type": "object", + "properties": { + "actionName": { + "description": "The action name.", + "type": "string" + }, + "failoverTypes": { + "description": "The list of failover types.", + "type": "array", + "items": { + "enum": [ + "ReverseReplicate", + "Commit", + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover", + "TestFailoverCleanup", + "Failback", + "FinalizeFailback", + "CancelFailover", + "ChangePit", + "RepairReplication", + "SwitchProtection", + "CompleteMigration" + ], + "type": "string", + "x-ms-enum": { + "name": "ReplicationProtectedItemOperation", + "modelAsString": true + } + } + }, + "failoverDirections": { + "description": "The list of failover directions.", + "type": "array", + "items": { + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + } + }, + "customDetails": { + "$ref": "#/definitions/RecoveryPlanActionDetails", + "description": "The custom details." + } + } + }, + "RecoveryPlanActionDetails": { + "description": "Recovery plan action custom details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values).", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanAutomationRunbookActionDetails": { + "description": "Recovery plan Automation runbook action details.", + "required": [ + "fabricLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanActionDetails" + } + ], + "properties": { + "runbookId": { + "description": "The runbook ARM Id.", + "type": "string" + }, + "timeout": { + "description": "The runbook timeout.", + "type": "string" + }, + "fabricLocation": { + "description": "The fabric location.", + "enum": [ + "Primary", + "Recovery" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanActionLocation", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AutomationRunbookActionDetails" + }, + "RecoveryPlanCollection": { + "description": "Recovery plan collection details.", + "type": "object", + "properties": { + "value": { + "description": "The list of recovery plans.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "RecoveryPlanGroup": { + "description": "Recovery plan group details.", + "required": [ + "groupType" + ], + "type": "object", + "properties": { + "groupType": { + "description": "The group type.", + "enum": [ + "Shutdown", + "Boot", + "Failover" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanGroupType", + "modelAsString": true + } + }, + "replicationProtectedItems": { + "description": "The list of protected items.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProtectedItem" + } + }, + "startGroupActions": { + "description": "The start group actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanAction" + } + }, + "endGroupActions": { + "description": "The end group actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanAction" + } + } + } + }, + "RecoveryPlanGroupTaskDetails": { + "description": "This class represents the recovery plan group task.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GroupTaskDetails" + } + ], + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "groupId": { + "description": "The group identifier.", + "type": "string" + }, + "rpGroupType": { + "description": "The group type.", + "type": "string" + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "RecoveryPlanGroupTaskDetails" + }, + "RecoveryPlanHyperVReplicaAzureFailbackInput": { + "description": "Recovery plan HVR Azure failback input.", + "required": [ + "dataSyncOption", + "recoveryVmCreationOption" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "dataSyncOption": { + "description": "The data sync option.", + "enum": [ + "ForDownTime", + "ForSynchronization" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSyncStatus", + "modelAsString": true + } + }, + "recoveryVmCreationOption": { + "description": "The ALR option.", + "enum": [ + "CreateVmIfNotFound", + "NoAction" + ], + "type": "string", + "x-ms-enum": { + "name": "AlternateLocationRecoveryOption", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzureFailback" + }, + "RecoveryPlanHyperVReplicaAzureFailoverInput": { + "description": "Recovery plan HVR Azure failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "The primary KEK certificate PFX.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "The secondary KEK certificate PFX.", + "type": "string" + }, + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "HyperVReplicaAzureRpRecoveryPointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "RecoveryPlanInMageAzureV2FailoverInput": { + "description": "Recovery plan InMageAzureV2 failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "InMageV2RpRecoveryPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "RecoveryPlanInMageFailoverInput": { + "description": "Recovery plan InMage failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RpInMageRecoveryPointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "RecoveryPlanInMageRcmFailbackFailoverInput": { + "description": "Recovery plan InMageRcmFailback failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "x-ms-enum": { + "name": "InMageRcmFailbackRecoveryPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "RecoveryPlanInMageRcmFailoverInput": { + "description": "Recovery plan InMageRcm failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "RecoveryPlanManualActionDetails": { + "description": "Recovery plan manual action details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanActionDetails" + } + ], + "properties": { + "description": { + "description": "The manual action description.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ManualActionDetails" + }, + "RecoveryPlanPlannedFailoverInput": { + "description": "Recovery plan planned failover input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanPlannedFailoverInputProperties", + "description": "The recovery plan planned failover input properties." + } + } + }, + "RecoveryPlanPlannedFailoverInputProperties": { + "description": "Recovery plan planned failover input properties.", + "required": [ + "failoverDirection" + ], + "type": "object", + "properties": { + "failoverDirection": { + "description": "The failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + }, + "providerSpecificDetails": { + "description": "The provider specific properties.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + } + } + }, + "RecoveryPlanProperties": { + "description": "Recovery plan properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name.", + "type": "string" + }, + "primaryFabricId": { + "description": "The primary fabric Id.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The primary fabric friendly name.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The recovery fabric Id.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The recovery fabric friendly name.", + "type": "string" + }, + "failoverDeploymentModel": { + "description": "The failover deployment model.", + "type": "string" + }, + "replicationProviders": { + "description": "The list of replication providers.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedOperations": { + "description": "The list of allowed operations.", + "type": "array", + "items": { + "type": "string" + } + }, + "lastPlannedFailoverTime": { + "format": "date-time", + "description": "The start time of the last planned failover.", + "type": "string" + }, + "lastUnplannedFailoverTime": { + "format": "date-time", + "description": "The start time of the last unplanned failover.", + "type": "string" + }, + "lastTestFailoverTime": { + "format": "date-time", + "description": "The start time of the last test failover.", + "type": "string" + }, + "currentScenario": { + "$ref": "#/definitions/CurrentScenarioDetails", + "description": "The current scenario details." + }, + "currentScenarioStatus": { + "description": "The recovery plan status.", + "type": "string" + }, + "currentScenarioStatusDescription": { + "description": "The recovery plan status description.", + "type": "string" + }, + "groups": { + "description": "The recovery plan groups.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanGroup" + } + }, + "providerSpecificDetails": { + "description": "The provider id and provider specific details.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificDetails" + } + } + } + }, + "RecoveryPlanProtectedItem": { + "description": "Recovery plan protected item.", + "type": "object", + "properties": { + "id": { + "description": "The ARM Id of the recovery plan protected item.", + "type": "string" + }, + "virtualMachineId": { + "description": "The virtual machine Id.", + "type": "string" + } + } + }, + "RecoveryPlanProviderSpecificDetails": { + "description": "Recovery plan provider specific details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanProviderSpecificFailoverInput": { + "description": "Recovery plan provider specific failover input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanProviderSpecificInput": { + "description": "Recovery plan provider specific input base class.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanScriptActionDetails": { + "description": "Recovery plan script action details.", + "required": [ + "path", + "fabricLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanActionDetails" + } + ], + "properties": { + "path": { + "description": "The script path.", + "type": "string" + }, + "timeout": { + "description": "The script timeout.", + "type": "string" + }, + "fabricLocation": { + "description": "The fabric location.", + "enum": [ + "Primary", + "Recovery" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanActionLocation", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "ScriptActionDetails" + }, + "RecoveryPlanShutdownGroupTaskDetails": { + "description": "This class represents the recovery plan shutdown group task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanGroupTaskDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "RecoveryPlanShutdownGroupTaskDetails" + }, + "RecoveryPlanTestFailoverCleanupInput": { + "description": "Recovery plan test failover cleanup input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanTestFailoverCleanupInputProperties", + "description": "The recovery plan test failover cleanup input properties." + } + } + }, + "RecoveryPlanTestFailoverCleanupInputProperties": { + "description": "Recovery plan test failover cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "The test failover cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "RecoveryPlanTestFailoverInput": { + "description": "Recovery plan test failover input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanTestFailoverInputProperties", + "description": "The recovery plan test failover input properties." + } + } + }, + "RecoveryPlanTestFailoverInputProperties": { + "description": "Recovery plan test failover input properties.", + "required": [ + "failoverDirection", + "networkType" + ], + "type": "object", + "properties": { + "failoverDirection": { + "description": "The failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + }, + "networkType": { + "description": "The network type to be used for test failover.", + "type": "string" + }, + "networkId": { + "description": "The Id of the network to be used for test failover.", + "type": "string" + }, + "providerSpecificDetails": { + "description": "The provider specific properties.", + "maxLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + } + } + }, + "RecoveryPlanUnplannedFailoverInput": { + "description": "Recovery plan unplanned failover input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanUnplannedFailoverInputProperties", + "description": "The recovery plan unplanned failover input properties." + } + } + }, + "RecoveryPlanUnplannedFailoverInputProperties": { + "description": "Recovery plan unplanned failover input properties.", + "required": [ + "failoverDirection", + "sourceSiteOperations" + ], + "type": "object", + "properties": { + "failoverDirection": { + "description": "The failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + }, + "sourceSiteOperations": { + "description": "A value indicating whether source site operations are required.", + "enum": [ + "Required", + "NotRequired" + ], + "type": "string", + "x-ms-enum": { + "name": "SourceSiteOperations", + "modelAsString": true + } + }, + "providerSpecificDetails": { + "description": "The provider specific properties.", + "maxLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + } + } + }, + "RecoveryPoint": { + "description": "Recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPointProperties", + "description": "The recovery point properties." + } + } + }, + "RecoveryPointCollection": { + "description": "Collection of recovery point details.", + "type": "object", + "properties": { + "value": { + "description": "The recovery point details.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPoint" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "RecoveryPointProperties": { + "description": "Recovery point properties.", + "type": "object", + "properties": { + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string" + }, + "recoveryPointType": { + "description": "The recovery point type: ApplicationConsistent, CrashConsistent.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails", + "description": "The provider specific details for the recovery point." + } + } + }, + "RecoveryProximityPlacementGroupCustomDetails": { + "description": "Recovery Proximity placement group custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RecoveryResourceGroupCustomDetails": { + "description": "Recovery Resource Group custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RecoveryServicesProvider": { + "description": "Provider details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryServicesProviderProperties", + "description": "Provider properties." + } + } + }, + "RecoveryServicesProviderCollection": { + "description": "Collection of providers.", + "type": "object", + "properties": { + "value": { + "description": "The Servers details.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "RecoveryServicesProviderProperties": { + "description": "Recovery services provider properties.", + "type": "object", + "properties": { + "fabricType": { + "description": "Type of the site.", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of the DRA.", + "type": "string" + }, + "providerVersion": { + "description": "The provider version.", + "type": "string" + }, + "serverVersion": { + "description": "The fabric provider.", + "type": "string" + }, + "providerVersionState": { + "description": "DRA version status.", + "type": "string" + }, + "providerVersionExpiryDate": { + "format": "date-time", + "description": "Expiry date of the version.", + "type": "string" + }, + "fabricFriendlyName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "lastHeartBeat": { + "format": "date-time", + "description": "Time when last heartbeat was sent by the DRA.", + "type": "string" + }, + "connectionStatus": { + "description": "A value indicating whether DRA is responsive.", + "type": "string" + }, + "protectedItemCount": { + "format": "int32", + "description": "Number of protected VMs currently managed by the DRA.", + "type": "integer" + }, + "allowedScenarios": { + "description": "The scenarios allowed on this provider.", + "type": "array", + "items": { + "type": "string" + } + }, + "healthErrorDetails": { + "description": "The recovery services provider health error details.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "draIdentifier": { + "description": "The DRA Id.", + "type": "string" + }, + "machineId": { + "description": "The machine Id.", + "type": "string" + }, + "machineName": { + "description": "The machine name.", + "type": "string" + }, + "biosId": { + "description": "The Bios Id.", + "type": "string" + }, + "authenticationIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The authentication identity details." + }, + "resourceAccessIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The resource access identity details." + }, + "dataPlaneAuthenticationIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The data plane authentication identity details." + }, + "providerVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "The provider version details." + } + } + }, + "RecoveryVirtualNetworkCustomDetails": { + "description": "Recovery Virtual network custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RemoveDisksInput": { + "description": "Input for remove disk(s) operation.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RemoveDisksInputProperties", + "description": "Remove disk input properties." + } + } + }, + "RemoveDisksInputProperties": { + "description": "Remove Disk input properties.", + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/RemoveDisksProviderSpecificInput", + "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." + } + } + }, + "RemoveDisksProviderSpecificInput": { + "description": "Remove Disk provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RemoveProtectionContainerMappingInput": { + "description": "Container unpairing input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RemoveProtectionContainerMappingInputProperties", + "description": "Configure protection input properties." + } + } + }, + "RemoveProtectionContainerMappingInputProperties": { + "description": "Unpairing input properties.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderContainerUnmappingInput", + "description": "Provider specific input for unpairing." + } + } + }, + "RenewCertificateInput": { + "description": "Certificate renewal input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RenewCertificateInputProperties", + "description": "Renew certificate input properties." + } + } + }, + "RenewCertificateInputProperties": { + "description": "Renew Certificate input properties.", + "type": "object", + "properties": { + "renewCertificateType": { + "description": "Renew certificate type.", + "type": "string" + } + } + }, + "ReplicationAgentDetails": { + "description": "Replication agent details.", + "type": "object", + "properties": { + "id": { + "description": "The replication agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The replication agent name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The replication agent Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The replication agent Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the replication agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the replication agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "ReplicationAppliance": { + "description": "Replication appliance definition.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ReplicationApplianceProperties", + "description": "Appliance related data." + } + } + }, + "ReplicationApplianceProperties": { + "description": "Replication appliance properties.", + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/ApplianceSpecificDetails", + "description": "Provider specific settings." + } + } + }, + "ReplicationEligibilityResults": { + "description": "Replication eligibility results response model.", + "type": "object", + "properties": { + "name": { + "description": "Gets the name of this object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Gets the object type.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Gets Unique ARM identifier for this object.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ReplicationEligibilityResultsProperties", + "description": "Gets properties model for replication eligibility results API.", + "readOnly": true + } + } + }, + "ReplicationEligibilityResultsCollection": { + "description": "Replication eligibility results collection response model.", + "type": "object", + "properties": { + "value": { + "description": "The replication eligibility results details.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationEligibilityResults" + } + } + } + }, + "ReplicationEligibilityResultsErrorInfo": { + "description": "Error model that can be exposed to the user.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The error message.", + "type": "string" + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string" + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string" + }, + "status": { + "description": "The error status.", + "readOnly": true, + "type": "string" + } + } + }, + "ReplicationEligibilityResultsProperties": { + "description": "Properties model for replication eligibility results API.", + "type": "object", + "properties": { + "clientRequestId": { + "description": "The client request Id.", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "The error details.", + "type": "array", + "uniqueItems": false, + "items": { + "$ref": "#/definitions/ReplicationEligibilityResultsErrorInfo" + } + } + } + }, + "ReplicationGroupDetails": { + "description": "Replication group details. This will be used in case of San.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConfigurationSettings" + } + ], + "properties": {}, + "x-ms-discriminator-value": "ReplicationGroupDetails" + }, + "ReplicationProtectedItem": { + "description": "Replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ReplicationProtectedItemProperties", + "description": "The custom data." + } + } + }, + "ReplicationProtectedItemCollection": { + "description": "Replication protected item collection.", + "type": "object", + "properties": { + "value": { + "description": "The Replication protected item details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ReplicationProtectedItemProperties": { + "description": "Replication protected item custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "protectedItemType": { + "description": "The type of protected item type.", + "type": "string" + }, + "protectableItemId": { + "description": "The protected item ARM Id.", + "type": "string" + }, + "recoveryServicesProviderId": { + "description": "The recovery provider ARM Id.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The friendly name of the primary fabric.", + "type": "string" + }, + "primaryFabricProvider": { + "description": "The fabric provider of the primary fabric.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The friendly name of recovery fabric.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The Arm Id of recovery fabric.", + "type": "string" + }, + "primaryProtectionContainerFriendlyName": { + "description": "The name of primary protection container friendly name.", + "type": "string" + }, + "recoveryProtectionContainerFriendlyName": { + "description": "The name of recovery container friendly name.", + "type": "string" + }, + "protectionState": { + "description": "The protection status.", + "type": "string" + }, + "protectionStateDescription": { + "description": "The protection state description.", + "type": "string" + }, + "activeLocation": { + "description": "The Current active location of the PE.", + "type": "string" + }, + "testFailoverState": { + "description": "The Test failover state.", + "type": "string" + }, + "testFailoverStateDescription": { + "description": "The Test failover state description.", + "type": "string" + }, + "switchProviderState": { + "description": "The switch provider state.", + "type": "string" + }, + "switchProviderStateDescription": { + "description": "The switch provider state description.", + "type": "string" + }, + "allowedOperations": { + "description": "The allowed operations on the Replication protected item.", + "type": "array", + "items": { + "type": "string" + } + }, + "replicationHealth": { + "description": "The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration.", + "type": "string" + }, + "failoverHealth": { + "description": "The consolidated failover health for the VM.", + "type": "string" + }, + "healthErrors": { + "description": "List of health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "policyId": { + "description": "The ID of Policy governing this PE.", + "type": "string" + }, + "policyFriendlyName": { + "description": "The name of Policy governing this PE.", + "type": "string" + }, + "lastSuccessfulFailoverTime": { + "format": "date-time", + "description": "The Last successful failover time.", + "type": "string" + }, + "lastSuccessfulTestFailoverTime": { + "format": "date-time", + "description": "The Last successful test failover time.", + "type": "string" + }, + "currentScenario": { + "$ref": "#/definitions/CurrentScenarioDetails", + "description": "The current scenario." + }, + "failoverRecoveryPointId": { + "description": "The recovery point ARM Id to which the Vm was failed over.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReplicationProviderSpecificSettings", + "description": "The Replication provider custom settings." + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "eventCorrelationId": { + "description": "The correlation Id for events associated with this protected item.", + "type": "string" + } + } + }, + "ReplicationProtectionIntent": { + "description": "Replication protection intent.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ReplicationProtectionIntentProperties", + "description": "The custom data." + } + } + }, + "ReplicationProtectionIntentCollection": { + "description": "Replication protection intent objects collection.", + "type": "object", + "properties": { + "value": { + "description": "The Replication protection intent details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProtectionIntent" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ReplicationProtectionIntentProperties": { + "description": "Replication protection intent custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "jobId": { + "description": "The job Id.", + "type": "string", + "readOnly": true + }, + "jobState": { + "description": "The job state.", + "type": "string", + "readOnly": true + }, + "isActive": { + "description": "A value indicating whether the intent object is active.", + "type": "boolean", + "readOnly": true + }, + "creationTimeUTC": { + "description": "The creation time in UTC.", + "type": "string", + "readOnly": true + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReplicationProtectionIntentProviderSpecificSettings", + "description": "The Replication provider custom settings." + } + } + }, + "ReplicationProtectionIntentProviderSpecificSettings": { + "description": "Replication provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderContainerUnmappingInput": { + "description": "Provider specific input for unpairing operations.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + } + }, + "ReplicationProviderSpecificContainerCreationInput": { + "description": "Provider specific input for container creation operation.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderSpecificContainerMappingInput": { + "description": "Provider specific input for pairing operations.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderSpecificSettings": { + "description": "Replication provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderSpecificUpdateContainerMappingInput": { + "description": "Provider specific input for update pairing operations.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReprotectAgentDetails": { + "description": "Reprotect agent details.", + "type": "object", + "properties": { + "id": { + "description": "The reprotect agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The reprotect agent name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The reprotect agent Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The reprotect agent Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the reprotect agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the reprotect agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "protectedItemCount": { + "format": "int32", + "description": "The protected item count.", + "type": "integer", + "readOnly": true + }, + "accessibleDatastores": { + "description": "The list of accessible datastores fetched from discovery.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vcenterId": { + "description": "The Vcenter Id.", + "type": "string", + "readOnly": true + }, + "lastDiscoveryInUtc": { + "format": "date-time", + "description": "The last time when SDS information discovered in SRS.", + "type": "string", + "readOnly": true + } + } + }, + "ResolveHealthError": { + "description": "Resolve health errors input properties.", + "type": "object", + "properties": { + "healthErrorId": { + "description": "Health error id.", + "type": "string" + } + } + }, + "ResolveHealthInput": { + "description": "Resolve health input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResolveHealthInputProperties", + "description": "Disable resolve health input properties." + } + } + }, + "ResolveHealthInputProperties": { + "description": "Resolve health input properties.", + "type": "object", + "properties": { + "healthErrors": { + "description": "Health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/ResolveHealthError" + } + } + } + }, + "Resource": { + "description": "Azure resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource Id", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource Name", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource Type", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Resource Location", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "ResourceHealthSummary": { + "description": "Base class to define the health summary of the resources contained under an Arm resource.", + "type": "object", + "properties": { + "resourceCount": { + "format": "int32", + "description": "The count of total resources under the container.", + "type": "integer" + }, + "issues": { + "description": "The list of summary of health errors across the resources under the container.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthErrorSummary" + } + }, + "categorizedResourceCounts": { + "description": "The categorized resource counts.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + } + } + }, + "ResumeJobParams": { + "description": "Resume job params.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResumeJobParamsProperties", + "description": "Resume job properties." + } + } + }, + "ResumeJobParamsProperties": { + "description": "Resume job properties.", + "type": "object", + "properties": { + "comments": { + "description": "Resume job comments.", + "type": "string" + } + } + }, + "ResumeReplicationInput": { + "description": "Resume replication input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResumeReplicationInputProperties", + "description": "Resume replication input properties." + } + } + }, + "ResumeReplicationInputProperties": { + "description": "Resume replication input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/ResumeReplicationProviderSpecificInput", + "description": "The provider specific input for resume replication." + } + } + }, + "ResumeReplicationProviderSpecificInput": { + "description": "Resume replication provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ResyncInput": { + "description": "Resync input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResyncInputProperties", + "description": "Resync input properties." + } + } + }, + "ResyncInputProperties": { + "description": "Resync input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/ResyncProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "ResyncProviderSpecificInput": { + "description": "Resync provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RetentionVolume": { + "description": "The retention details of the MT.", + "type": "object", + "properties": { + "volumeName": { + "description": "The volume name.", + "type": "string" + }, + "capacityInBytes": { + "format": "int64", + "description": "The volume capacity.", + "type": "integer" + }, + "freeSpaceInBytes": { + "format": "int64", + "description": "The free space available in this volume.", + "type": "integer" + }, + "thresholdPercentage": { + "format": "int32", + "description": "The threshold percentage.", + "type": "integer" + } + } + }, + "ReverseReplicationInput": { + "description": "Reverse replication input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ReverseReplicationInputProperties", + "description": "Reverse replication properties." + } + } + }, + "ReverseReplicationInputProperties": { + "description": "Reverse replication input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput", + "description": "Provider specific reverse replication input." + } + } + }, + "ReverseReplicationProviderSpecificInput": { + "description": "Provider specific reverse replication input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RoleAssignment": { + "description": "Azure role assignment details.", + "type": "object", + "properties": { + "id": { + "description": "The ARM Id of the role assignment.", + "type": "string" + }, + "name": { + "description": "The name of the role assignment.", + "type": "string" + }, + "scope": { + "description": "Role assignment scope.", + "type": "string" + }, + "principalId": { + "description": "Principal Id.", + "type": "string" + }, + "roleDefinitionId": { + "description": "Role definition id.", + "type": "string" + } + } + }, + "RunAsAccount": { + "description": "CS Accounts Details.", + "type": "object", + "properties": { + "accountId": { + "description": "The CS RunAs account Id.", + "type": "string" + }, + "accountName": { + "description": "The CS RunAs account name.", + "type": "string" + } + } + }, + "ScriptActionTaskDetails": { + "description": "This class represents the script action task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "path": { + "description": "The path.", + "type": "string" + }, + "output": { + "description": "The output.", + "type": "string" + }, + "isPrimarySideScript": { + "description": "A value indicating whether it is a primary side script or not.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "ScriptActionTaskDetails" + }, + "ServiceError": { + "description": "ASR error model.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "possibleCauses": { + "description": "Possible causes of error.", + "type": "string" + }, + "recommendedAction": { + "description": "Recommended action to resolve error.", + "type": "string" + }, + "activityId": { + "description": "Activity Id.", + "type": "string" + } + } + }, + "IPConfigDetails": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "isPrimary": { + "type": "boolean" + }, + "subnetName": { + "type": "string" + }, + "staticIPAddress": { + "type": "string" + }, + "ipAddressType": { + "type": "string" + }, + "isSeletedForFailover": { + "type": "boolean" + }, + "recoverySubnetName": { + "type": "string" + }, + "recoveryStaticIPAddress": { + "type": "string" + }, + "recoveryIPAddressType": { + "type": "string" + }, + "recoveryPublicIPAddressId": { + "type": "string" + }, + "recoveryLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "tfoSubnetName": { + "type": "string" + }, + "tfoStaticIPAddress": { + "type": "string" + }, + "tfoPublicIPAddressId": { + "type": "string" + }, + "tfoLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "IPConfigInputDetails": { + "type": "object", + "properties": { + "ipConfigName": { + "type": "string" + }, + "isPrimary": { + "type": "boolean" + }, + "isSeletedForFailover": { + "type": "boolean" + }, + "recoverySubnetName": { + "type": "string" + }, + "recoveryStaticIPAddress": { + "type": "string" + }, + "recoveryPublicIPAddressId": { + "type": "string" + }, + "recoveryLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "tfoSubnetName": { + "type": "string" + }, + "tfoStaticIPAddress": { + "type": "string" + }, + "tfoPublicIPAddressId": { + "type": "string" + }, + "tfoLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StorageAccountCustomDetails": { + "description": "Storage account custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "StorageClassification": { + "description": "Storage object definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageClassificationProperties", + "description": "Properties of the storage object." + } + } + }, + "StorageClassificationCollection": { + "description": "Collection of storage details.", + "type": "object", + "properties": { + "value": { + "description": "The storage details.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageClassification" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "StorageClassificationMapping": { + "description": "Storage mapping object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageClassificationMappingProperties", + "description": "Properties of the storage mapping object." + } + } + }, + "StorageClassificationMappingCollection": { + "description": "Collection of storage mapping details.", + "type": "object", + "properties": { + "value": { + "description": "The storage details.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageClassificationMapping" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "StorageClassificationMappingInput": { + "description": "Storage mapping input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/StorageMappingInputProperties", + "description": "Storage mapping input properties." + } + } + }, + "StorageClassificationMappingProperties": { + "description": "Storage mapping properties.", + "type": "object", + "properties": { + "targetStorageClassificationId": { + "description": "Target storage object Id.", + "type": "string" + } + } + }, + "StorageClassificationProperties": { + "description": "Storage object properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Friendly name of the Storage classification.", + "type": "string" + } + } + }, + "StorageMappingInputProperties": { + "description": "Storage mapping input properties.", + "type": "object", + "properties": { + "targetStorageClassificationId": { + "description": "The ID of the storage object.", + "type": "string" + } + } + }, + "Subnet": { + "description": "Subnets of the network.", + "type": "object", + "properties": { + "name": { + "description": "The subnet name.", + "type": "string" + }, + "friendlyName": { + "description": "The subnet friendly name.", + "type": "string" + }, + "addressList": { + "description": "The list of addresses for the subnet.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SupportedOperatingSystems": { + "description": "Supported operating systems.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SupportedOSProperties", + "description": "The supported operating systems properties." + } + } + }, + "SupportedOSDetails": { + "description": "Supported operating system details.", + "type": "object", + "properties": { + "osName": { + "description": "The name.", + "type": "string" + }, + "osType": { + "description": "The type.", + "type": "string" + }, + "osVersions": { + "description": "The list of version for operating system.", + "type": "array", + "items": { + "$ref": "#/definitions/OSVersionWrapper" + } + } + } + }, + "SupportedOSProperties": { + "description": "Supported operating systems properties.", + "type": "object", + "properties": { + "supportedOsList": { + "description": "The supported operating systems property list.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedOSProperty" + } + } + } + }, + "SupportedOSProperty": { + "description": "Supported operating systems property.", + "type": "object", + "properties": { + "instanceType": { + "description": "The replication provider type.", + "type": "string" + }, + "supportedOs": { + "description": "The list of supported operating systems.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedOSDetails" + } + } + } + }, + "SwitchProtectionInput": { + "description": "Switch protection input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SwitchProtectionInputProperties", + "description": "Switch protection properties." + } + } + }, + "SwitchProtectionInputProperties": { + "description": "Switch protection input properties.", + "type": "object", + "properties": { + "replicationProtectedItemName": { + "description": "The unique replication protected item name.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/SwitchProtectionProviderSpecificInput", + "description": "Provider specific switch protection input." + } + } + }, + "SwitchProtectionJobDetails": { + "description": "This class represents details for switch protection job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "newReplicationProtectedItemId": { + "description": "ARM Id of the new replication protected item.", + "type": "string" + } + }, + "x-ms-discriminator-value": "SwitchProtectionJobDetails" + }, + "SwitchProtectionProviderSpecificInput": { + "description": "Provider specific switch protection input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "SwitchProviderInput": { + "description": "Input definition for switch provider.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SwitchProviderInputProperties", + "description": "Switch provider input properties." + } + } + }, + "SwitchProviderInputProperties": { + "description": "Input definition for switch provider input properties.", + "type": "object", + "properties": { + "targetInstanceType": { + "description": "Target provider type.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/SwitchProviderProviderSpecificInput", + "description": "Provider specific settings." + } + } + }, + "SwitchProviderProviderSpecificInput": { + "description": "Provider specific switch provider input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "TargetComputeSize": { + "description": "Represents applicable recovery vm sizes.", + "type": "object", + "properties": { + "id": { + "description": "The Id.", + "type": "string" + }, + "name": { + "description": "The name.", + "type": "string" + }, + "type": { + "description": "The Type of the object.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/TargetComputeSizeProperties", + "description": "The custom data." + } + } + }, + "TargetComputeSizeCollection": { + "description": "Target compute size collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of target compute sizes.", + "type": "array", + "items": { + "$ref": "#/definitions/TargetComputeSize" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "TargetComputeSizeProperties": { + "description": "Represents applicable recovery vm sizes properties.", + "type": "object", + "properties": { + "name": { + "description": "Target compute size name.", + "type": "string" + }, + "friendlyName": { + "description": "Target compute size display name.", + "type": "string" + }, + "cpuCoresCount": { + "format": "int32", + "description": "The maximum cpu cores count supported by target compute size.", + "type": "integer" + }, + "vCPUsAvailable": { + "format": "int32", + "description": "The Available vCPUs supported by target compute size.", + "type": "integer", + "readOnly": true + }, + "memoryInGB": { + "format": "double", + "description": "The maximum memory in GB supported by target compute size.", + "type": "number" + }, + "maxDataDiskCount": { + "format": "int32", + "description": "The maximum data disks count supported by target compute size.", + "type": "integer" + }, + "maxNicsCount": { + "format": "int32", + "description": "The maximum Nics count supported by target compute size.", + "type": "integer" + }, + "errors": { + "description": "The reasons why the target compute size is not applicable for the protected item.", + "type": "array", + "items": { + "$ref": "#/definitions/ComputeSizeErrorDetails" + } + }, + "highIopsSupported": { + "description": "The value indicating whether the target compute size supports high Iops.", + "type": "string" + }, + "hyperVGenerations": { + "description": "The supported HyperV Generations.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TaskTypeDetails": { + "description": "Task details based on specific task type.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The type of task details.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "TestFailoverCleanupInput": { + "description": "Input definition for test failover cleanup.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestFailoverCleanupInputProperties", + "description": "Test failover cleanup input properties." + } + } + }, + "TestFailoverCleanupInputProperties": { + "description": "Input definition for test failover cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "Test failover cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "TestFailoverInput": { + "description": "Input definition for test failover.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestFailoverInputProperties", + "description": "Test failover input properties." + } + } + }, + "TestFailoverInputProperties": { + "description": "Input definition for test failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Test failover direction.", + "type": "string" + }, + "networkType": { + "description": "Network type to be used for test failover.", + "type": "string" + }, + "networkId": { + "description": "The id of the network to be used for test failover.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/TestFailoverProviderSpecificInput", + "description": "Provider specific settings." + } + } + }, + "TestFailoverJobDetails": { + "description": "This class represents the details for a test failover job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "testFailoverStatus": { + "description": "The test failover status.", + "type": "string" + }, + "comments": { + "description": "The test failover comments.", + "type": "string" + }, + "networkName": { + "description": "The test network name.", + "type": "string" + }, + "networkFriendlyName": { + "description": "The test network friendly name.", + "type": "string" + }, + "networkType": { + "description": "The test network type (see TestFailoverInput enum for possible values).", + "type": "string" + }, + "protectedItemDetails": { + "description": "The test VM details.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" + } + } + }, + "x-ms-discriminator-value": "TestFailoverJobDetails" + }, + "TestFailoverProviderSpecificInput": { + "description": "Provider specific test failover input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "TestMigrateCleanupInput": { + "description": "Input for test migrate cleanup.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestMigrateCleanupInputProperties", + "description": "Test migrate cleanup input properties." + } + } + }, + "TestMigrateCleanupInputProperties": { + "description": "Test migrate cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "Test migrate cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "TestMigrateInput": { + "description": "Input for test migrate.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestMigrateInputProperties", + "description": "Test migrate input properties." + } + } + }, + "TestMigrateInputProperties": { + "description": "Test migrate input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/TestMigrateProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "TestMigrateProviderSpecificInput": { + "description": "Test migrate provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UnplannedFailoverInput": { + "description": "Input definition for unplanned failover.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UnplannedFailoverInputProperties", + "description": "Unplanned failover input properties." + } + } + }, + "UnplannedFailoverInputProperties": { + "description": "Input definition for unplanned failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "sourceSiteOperations": { + "description": "Source site operations status.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput", + "description": "Provider specific settings." + } + } + }, + "UnplannedFailoverProviderSpecificInput": { + "description": "Provider specific unplanned failover input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateApplianceForReplicationProtectedItemInput": { + "description": "Update appliance for replication protected item input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemInputProperties", + "description": "Update appliance replication protected item properties." + } + } + }, + "UpdateApplianceForReplicationProtectedItemInputProperties": { + "description": "Update appliance for protected item input properties.", + "required": [ + "targetApplianceId", + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "targetApplianceId": { + "description": "The target appliance Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemProviderSpecificInput", + "description": "The provider specific input to update replication protected item." + } + } + }, + "UpdateApplianceForReplicationProtectedItemProviderSpecificInput": { + "description": "Update replication protected item provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateDiskInput": { + "description": "Disk input for update.", + "required": [ + "diskId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "targetDiskName": { + "description": "The target disk name.", + "type": "string" + } + } + }, + "UpdateMigrationItemInput": { + "description": "Update migration item input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateMigrationItemInputProperties", + "description": "Update migration item input properties." + } + } + }, + "UpdateMigrationItemInputProperties": { + "description": "Update migration item input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/UpdateMigrationItemProviderSpecificInput", + "description": "The provider specific input to update migration item." + } + } + }, + "UpdateMigrationItemProviderSpecificInput": { + "description": "Update migration item provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateMobilityServiceRequest": { + "description": "Request to update the mobility service on a protected item.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateMobilityServiceRequestProperties", + "description": "The properties of the update mobility service request." + } + } + }, + "UpdateMobilityServiceRequestProperties": { + "description": "The properties of an update mobility service request.", + "type": "object", + "properties": { + "runAsAccountId": { + "description": "The CS run as account Id.", + "type": "string" + } + } + }, + "UpdateNetworkMappingInput": { + "description": "Update network mapping input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateNetworkMappingInputProperties", + "description": "The input properties needed to update network mapping." + } + } + }, + "UpdateNetworkMappingInputProperties": { + "description": "Common input details for network mapping operation.", + "type": "object", + "properties": { + "recoveryFabricName": { + "description": "Recovery fabric name.", + "type": "string" + }, + "recoveryNetworkId": { + "description": "Recovery network Id.", + "type": "string" + }, + "fabricSpecificDetails": { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput", + "description": "Fabrics specific input network Id." + } + } + }, + "UpdatePolicyInput": { + "description": "Update policy input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdatePolicyInputProperties", + "description": "The ReplicationProviderSettings." + } + } + }, + "UpdatePolicyInputProperties": { + "description": "Policy update properties.", + "type": "object", + "properties": { + "replicationProviderSettings": { + "$ref": "#/definitions/PolicyProviderSpecificInput", + "description": "The ReplicationProviderSettings." + } + } + }, + "UpdateProtectionContainerMappingInput": { + "description": "Container pairing update input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateProtectionContainerMappingInputProperties", + "description": "Update protection container mapping input properties." + } + } + }, + "UpdateProtectionContainerMappingInputProperties": { + "description": "Container pairing update input.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput", + "description": "Provider specific input for updating protection container mapping." + } + } + }, + "UpdateRecoveryPlanInput": { + "description": "Update recovery plan input class.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateRecoveryPlanInputProperties", + "description": "Recovery plan update properties." + } + } + }, + "UpdateRecoveryPlanInputProperties": { + "description": "Recovery plan update properties.", + "type": "object", + "properties": { + "groups": { + "description": "The recovery plan groups.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanGroup" + } + } + } + }, + "UpdateReplicationProtectedItemInput": { + "description": "Update replication protected item input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateReplicationProtectedItemInputProperties", + "description": "Update replication protected item properties." + } + } + }, + "UpdateReplicationProtectedItemInputProperties": { + "description": "Update protected item input properties.", + "type": "object", + "properties": { + "recoveryAzureVMName": { + "description": "Target Azure VM name given by the user.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "Target Azure VM size.", + "type": "string" + }, + "selectedRecoveryAzureNetworkId": { + "description": "Target Azure Network Id.", + "type": "string" + }, + "selectedTfoAzureNetworkId": { + "description": "The Azure Network Id for test failover.", + "type": "string" + }, + "selectedSourceNicId": { + "description": "The selected source nic Id which will be used as the primary nic during failover.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "vmNics": { + "description": "The list of VM nic details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicInputDetails" + } + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "recoveryAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput", + "description": "The provider specific input to update replication protected item." + } + } + }, + "UpdateReplicationProtectedItemProviderInput": { + "description": "Update replication protected item provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateVCenterRequest": { + "description": "Input required to update vCenter.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateVCenterRequestProperties", + "description": "The update VCenter Request Properties." + } + } + }, + "UpdateVCenterRequestProperties": { + "description": "The properties of an update vCenter request.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name of the vCenter.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the vCenter to be discovered.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id from where the update can be orchestrated.", + "type": "string" + }, + "port": { + "description": "The port number for discovery.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id which has privileges to update the vCenter.", + "type": "string" + } + } + }, + "VaultHealthDetails": { + "description": "Vault health details definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultHealthProperties", + "description": "The vault health related data." + } + } + }, + "VaultHealthProperties": { + "description": "class to define the health summary of the Vault.", + "type": "object", + "properties": { + "vaultErrors": { + "description": "The list of errors on the vault.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "protectedItemsHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the protected items in the vault." + }, + "fabricsHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the fabrics in the vault." + }, + "containersHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the containers in the vault." + } + } + }, + "VaultSetting": { + "description": "Vault setting.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultSettingProperties", + "description": "The vault setting properties." + } + } + }, + "VaultSettingCollection": { + "description": "Vault setting collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of vault setting.", + "type": "array", + "items": { + "$ref": "#/definitions/VaultSetting" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "VaultSettingCreationInput": { + "description": "Input to create vault setting.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/VaultSettingCreationInputProperties", + "description": "Vault setting creation input properties." + } + } + }, + "VaultSettingCreationInputProperties": { + "description": "Input to create vault setting.", + "type": "object", + "properties": { + "migrationSolutionId": { + "description": "The migration solution Id.", + "type": "string" + }, + "vmwareToAzureProviderType": { + "description": "VMware to Azure provider type.", + "type": "string" + } + } + }, + "VaultSettingProperties": { + "description": "Vault setting properties.", + "type": "object", + "properties": { + "migrationSolutionId": { + "description": "The migration solution ARM Id.", + "type": "string" + }, + "vmwareToAzureProviderType": { + "description": "VMware to Azure provider type.", + "type": "string" + } + } + }, + "VCenter": { + "description": "vCenter definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VCenterProperties", + "description": "VCenter related data." + } + } + }, + "VCenterCollection": { + "description": "Collection of vCenter details.", + "type": "object", + "properties": { + "value": { + "description": "The vCenter details.", + "type": "array", + "items": { + "$ref": "#/definitions/VCenter" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "VCenterProperties": { + "description": "vCenter properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Friendly name of the vCenter.", + "type": "string" + }, + "internalId": { + "description": "VCenter internal ID.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The time when the last heartbeat was received by vCenter.", + "type": "string" + }, + "discoveryStatus": { + "description": "The VCenter discovery status.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the vCenter.", + "type": "string" + }, + "infrastructureId": { + "description": "The infrastructure Id of vCenter.", + "type": "string" + }, + "port": { + "description": "The port number for discovery.", + "type": "string" + }, + "runAsAccountId": { + "description": "The account Id which has privileges to discover the vCenter.", + "type": "string" + }, + "fabricArmResourceName": { + "description": "The ARM resource name of the fabric containing this VCenter.", + "type": "string" + }, + "healthErrors": { + "description": "The health errors for this VCenter.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + } + } + }, + "VersionDetails": { + "description": "Version related details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string" + }, + "expiryDate": { + "format": "date-time", + "description": "Version expiry date.", + "type": "string" + }, + "status": { + "description": "A value indicating whether security update required.", + "enum": [ + "Supported", + "NotSupported", + "Deprecated", + "UpdateRequired", + "SecurityUpdateRequired" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentVersionStatus", + "modelAsString": true + } + } + } + }, + "VirtualMachineTaskDetails": { + "description": "This class represents the virtual machine task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobTaskDetails" + } + ], + "properties": { + "skippedReason": { + "description": "The skipped reason.", + "type": "string" + }, + "skippedReasonString": { + "description": "The skipped reason string.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VirtualMachineTaskDetails" + }, + "VmmDetails": { + "description": "VMM fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VMM" + }, + "VmmToAzureCreateNetworkMappingInput": { + "description": "Create network mappings input properties/behavior specific to Vmm to Azure Network mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToAzure" + }, + "VmmToAzureNetworkMappingSettings": { + "description": "E2A Network Mapping fabric specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToAzure" + }, + "VmmToAzureUpdateNetworkMappingInput": { + "description": "Update network mappings input properties/behavior specific to vmm to azure.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToAzure" + }, + "VmmToVmmCreateNetworkMappingInput": { + "description": "Create network mappings input properties/behavior specific to vmm to vmm Network mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToVmm" + }, + "VmmToVmmNetworkMappingSettings": { + "description": "E2E Network Mapping fabric specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToVmm" + }, + "VmmToVmmUpdateNetworkMappingInput": { + "description": "Update network mappings input properties/behavior specific to vmm to vmm.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToVmm" + }, + "VmmVirtualMachineDetails": { + "description": "VMM fabric provider specific VM settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HyperVVirtualMachineDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmVirtualMachine" + }, + "VMNicDetails": { + "description": "Hyper V VM network details.", + "type": "object", + "properties": { + "nicId": { + "description": "The nic Id.", + "type": "string" + }, + "replicaNicId": { + "description": "The replica nic Id.", + "type": "string" + }, + "sourceNicArmId": { + "description": "The source nic ARM Id.", + "type": "string" + }, + "vMNetworkName": { + "description": "VM network name.", + "type": "string" + }, + "recoveryVMNetworkId": { + "description": "Recovery VM network Id.", + "type": "string" + }, + "ipConfigs": { + "description": "The IP configurations of the NIC.", + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigDetails" + } + }, + "selectionType": { + "description": "Selection type for failover.", + "type": "string" + }, + "recoveryNetworkSecurityGroupId": { + "description": "The id of the NSG associated with the NIC.", + "type": "string" + }, + "enableAcceleratedNetworkingOnRecovery": { + "description": "A value indicating whether the NIC has accelerated networking enabled.", + "type": "boolean" + }, + "tfoVMNetworkId": { + "description": "The network to be used by NIC during test failover.", + "type": "string" + }, + "tfoNetworkSecurityGroupId": { + "description": "The NSG to be used by NIC during test failover.", + "type": "string" + }, + "enableAcceleratedNetworkingOnTfo": { + "description": "Whether the TFO NIC has accelerated networking enabled.", + "type": "boolean" + }, + "recoveryNicName": { + "description": "The name of the NIC to be used when creating target NICs.", + "type": "string" + }, + "recoveryNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs.", + "type": "string" + }, + "reuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during failover subject to availability.", + "type": "boolean", + "default": false + }, + "tfoRecoveryNicName": { + "description": "The name of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoRecoveryNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoReuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability.", + "type": "boolean", + "default": false + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + } + } + }, + "VMNicInputDetails": { + "description": "Hyper V VM network input details.", + "type": "object", + "properties": { + "nicId": { + "description": "The nic Id.", + "type": "string" + }, + "ipConfigs": { + "description": "The IP configurations to be used by NIC during test failover and failover.", + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigInputDetails" + } + }, + "selectionType": { + "description": "Selection type for failover.", + "type": "string" + }, + "recoveryNetworkSecurityGroupId": { + "description": "The id of the NSG associated with the NIC.", + "type": "string" + }, + "enableAcceleratedNetworkingOnRecovery": { + "description": "Whether the NIC has accelerated networking enabled.", + "type": "boolean" + }, + "tfoNetworkSecurityGroupId": { + "description": "The NSG to be used by NIC during test failover.", + "type": "string" + }, + "enableAcceleratedNetworkingOnTfo": { + "description": "Whether the test NIC has accelerated networking enabled.", + "type": "boolean" + }, + "recoveryNicName": { + "description": "The name of the NIC to be used when creating target NICs.", + "type": "string" + }, + "recoveryNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs.", + "type": "string" + }, + "reuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during failover subject to availability.", + "type": "boolean" + }, + "tfoNicName": { + "description": "The name of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoReuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability.", + "type": "boolean" + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + } + } + }, + "VmNicUpdatesTaskDetails": { + "description": "This class represents the vm NicUpdates task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "vmId": { + "description": "Virtual machine Id.", + "type": "string" + }, + "nicId": { + "description": "Nic Id.", + "type": "string" + }, + "name": { + "description": "Name of the Nic.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VmNicUpdatesTaskDetails" + }, + "VMwareCbtContainerCreationInput": { + "description": "VMwareCbt container creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtContainerMappingInput": { + "description": "VMwareCbt container mapping input.", + "required": [ + "storageAccountId", + "targetLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput" + } + ], + "properties": { + "keyVaultId": { + "description": "The target key vault ARM Id.", + "type": "string" + }, + "keyVaultUri": { + "description": "The target key vault URL.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account ARM Id.", + "type": "string" + }, + "storageAccountSasSecretName": { + "description": "The secret name of the storage account.", + "type": "string" + }, + "serviceBusConnectionStringSecretName": { + "description": "The secret name of the service bus connection string.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtDiskInput": { + "description": "VMwareCbt disk input.", + "required": [ + "diskId", + "isOSDisk", + "logStorageAccountId", + "logStorageAccountSasSecretName" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "logStorageAccountSasSecretName": { + "description": "The key vault secret name of the log storage account.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + } + } + }, + "VMwareCbtEnableMigrationInput": { + "description": "VMwareCbt specific enable migration input.", + "required": [ + "vmwareMachineId", + "disksToInclude", + "dataMoverRunAsAccountId", + "snapshotRunAsAccountId", + "targetResourceGroupId", + "targetNetworkId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableMigrationProviderSpecificInput" + } + ], + "properties": { + "vmwareMachineId": { + "description": "The ARM Id of the VM discovered in VMware.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtDiskInput" + } + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "performSqlBulkRegistration": { + "description": "A value indicating whether bulk SQL RP registration to be done.", + "type": "string" + }, + "dataMoverRunAsAccountId": { + "description": "The data mover run as account Id.", + "type": "string" + }, + "snapshotRunAsAccountId": { + "description": "The snapshot run as account Id.", + "type": "string" + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The selected test network ARM Id.", + "type": "string" + }, + "targetSubnetName": { + "description": "The target subnet name.", + "type": "string" + }, + "testSubnetName": { + "description": "The selected test subnet name.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group ARM Id.", + "type": "string" + }, + "confidentialVmKeyVaultId": { + "description": "The confidential VM key vault Id for ADE installation.", + "type": "string" + }, + "targetVmSecurityProfile": { + "$ref": "#/definitions/VMwareCbtSecurityProfileProperties", + "description": "The target VM security profile." + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "performAutoResync": { + "description": "A value indicating whether auto resync is to be done.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedDiskTags": { + "description": "The tags for the seed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetDiskTags": { + "description": "The tags for the target disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtEventDetails": { + "description": "Event details for VMwareCbt provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "migrationItemName": { + "description": "The migration item name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtMigrateInput": { + "description": "VMwareCbt specific migrate input.", + "required": [ + "performShutdown", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MigrateProviderSpecificInput" + } + ], + "properties": { + "performShutdown": { + "description": "A value indicating whether VM is to be shutdown.", + "type": "string" + }, + "osUpgradeVersion": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtMigrationDetails": { + "description": "VMwareCbt provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MigrationProviderSpecificSettings" + } + ], + "properties": { + "vmwareMachineId": { + "description": "The ARM Id of the VM discovered in VMware.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "osName": { + "description": "The name of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type.", + "type": "string", + "readOnly": true + }, + "targetGeneration": { + "description": "The target generation.", + "type": "string", + "readOnly": true + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "dataMoverRunAsAccountId": { + "description": "The data mover run as account Id.", + "type": "string", + "readOnly": true + }, + "snapshotRunAsAccountId": { + "description": "The snapshot run as account Id.", + "type": "string", + "readOnly": true + }, + "storageAccountId": { + "description": "The replication storage account ARM Id. This is applicable only for the blob based replication test hook.", + "type": "string", + "readOnly": true + }, + "targetVmName": { + "description": "Target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string", + "readOnly": true + }, + "targetResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "confidentialVmKeyVaultId": { + "description": "The confidential VM key vault Id for ADE installation.", + "type": "string" + }, + "targetVmSecurityProfile": { + "$ref": "#/definitions/VMwareCbtSecurityProfileProperties", + "description": "The target VM security profile." + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtProtectedDiskDetails" + } + }, + "targetNetworkId": { + "description": "The target network Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network Id.", + "type": "string" + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtNicDetails" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "migrationRecoveryPointId": { + "description": "The recovery point Id to which the VM was migrated.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointId": { + "description": "The last recovery point Id.", + "type": "string", + "readOnly": true + }, + "initialSeedingProgressPercentage": { + "format": "int32", + "description": "The initial seeding progress percentage.", + "type": "integer", + "readOnly": true + }, + "migrationProgressPercentage": { + "format": "int32", + "description": "The migration progress percentage.", + "type": "integer", + "readOnly": true + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer", + "readOnly": true + }, + "resumeProgressPercentage": { + "format": "int32", + "description": "The resume progress percentage.", + "type": "integer", + "readOnly": true + }, + "deltaSyncProgressPercentage": { + "format": "int32", + "description": "The delta sync progress percentage.", + "type": "integer", + "readOnly": true + }, + "isCheckSumResyncCycle": { + "description": "A value indicating whether checksum resync cycle is in progress.", + "type": "string", + "readOnly": true + }, + "initialSeedingRetryCount": { + "format": "int64", + "description": "The initial seeding retry count.", + "type": "integer", + "readOnly": true + }, + "resyncRetryCount": { + "format": "int64", + "description": "The resync retry count.", + "type": "integer", + "readOnly": true + }, + "resumeRetryCount": { + "format": "int64", + "description": "The resume retry count.", + "type": "integer", + "readOnly": true + }, + "deltaSyncRetryCount": { + "format": "int64", + "description": "The delta sync retry count.", + "type": "integer", + "readOnly": true + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "performAutoResync": { + "description": "A value indicating whether auto resync is to be done.", + "type": "string" + }, + "seedDiskTags": { + "description": "The tags for the seed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetDiskTags": { + "description": "The tags for the target disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "supportedOSVersions": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "array", + "items": { + "type": "string" + } + }, + "applianceMonitoringDetails": { + "$ref": "#/definitions/ApplianceMonitoringDetails", + "description": "A value indicating the appliance monitoring details.", + "readOnly": true + }, + "gatewayOperationDetails": { + "$ref": "#/definitions/GatewayOperationDetails", + "description": "A value indicating the gateway operation details.", + "readOnly": true + }, + "operationName": { + "description": "A value indicating the SRS operation name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtNicDetails": { + "description": "VMwareCbt NIC details.", + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string", + "readOnly": true + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "sourceIPAddress": { + "description": "The source IP address.", + "type": "string", + "readOnly": true + }, + "sourceIPAddressType": { + "description": "The source IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "sourceNetworkId": { + "description": "Source network Id.", + "type": "string", + "readOnly": true + }, + "targetIPAddress": { + "description": "The target IP address.", + "type": "string" + }, + "targetIPAddressType": { + "description": "The target IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "testNetworkId": { + "description": "Source network Id.", + "type": "string" + }, + "testSubnetName": { + "description": "Test subnet name.", + "type": "string" + }, + "testIPAddress": { + "description": "The test IP address.", + "type": "string" + }, + "testIPAddressType": { + "description": "The test IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + }, + "isSelectedForMigration": { + "description": "A value indicating whether this NIC is selected for migration.", + "type": "string" + } + } + }, + "VMwareCbtNicInput": { + "description": "VMwareCbt NIC input.", + "required": [ + "nicId", + "isPrimaryNic" + ], + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string" + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "targetStaticIPAddress": { + "description": "The static IP address.", + "type": "string" + }, + "isSelectedForMigration": { + "description": "A value indicating whether this NIC is selected for migration.", + "type": "string" + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + }, + "testSubnetName": { + "description": "The test subnet name.", + "type": "string" + }, + "testStaticIPAddress": { + "description": "The test static IP address.", + "type": "string" + } + } + }, + "VMwareCbtPolicyCreationInput": { + "description": "VMware Cbt policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VmwareCbtPolicyDetails": { + "description": "VMware Cbt specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtProtectedDiskDetails": { + "description": "VMwareCbt protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskPath": { + "description": "The disk path.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "logStorageAccountSasSecretName": { + "description": "The key vault secret name of the log storage account.", + "type": "string", + "readOnly": true + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string", + "readOnly": true + }, + "seedManagedDiskId": { + "description": "The ARM Id of the seed managed disk.", + "type": "string", + "readOnly": true + }, + "seedBlobUri": { + "description": "The uri of the seed blob.", + "type": "string", + "readOnly": true + }, + "targetManagedDiskId": { + "description": "The ARM Id of the target managed disk.", + "type": "string", + "readOnly": true + }, + "targetBlobUri": { + "description": "The uri of the target blob.", + "type": "string", + "readOnly": true + }, + "targetDiskName": { + "description": "The name for the target managed disk.", + "type": "string" + }, + "gatewayOperationDetails": { + "$ref": "#/definitions/GatewayOperationDetails", + "description": "A value indicating the gateway operation details.", + "readOnly": true + } + } + }, + "VMwareCbtProtectionContainerMappingDetails": { + "description": "VMwareCbt provider specific container mapping details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "keyVaultId": { + "description": "The target key vault ARM Id.", + "type": "string", + "readOnly": true + }, + "keyVaultUri": { + "description": "The target key vault URI.", + "type": "string", + "readOnly": true + }, + "storageAccountId": { + "description": "The storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "storageAccountSasSecretName": { + "description": "The secret name of the storage account.", + "type": "string", + "readOnly": true + }, + "serviceBusConnectionStringSecretName": { + "description": "The secret name of the service bus connection string.", + "type": "string", + "readOnly": true + }, + "targetLocation": { + "description": "The target location.", + "type": "string", + "readOnly": true + }, + "roleSizeToNicCountMap": { + "description": "The role size to NIC count map.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "excludedSkus": { + "description": "The SKUs to be excluded.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtResumeReplicationInput": { + "description": "VMwareCbt specific resume replication input.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResumeReplicationProviderSpecificInput" + } + ], + "properties": { + "deleteMigrationResources": { + "description": "A value indicating whether Migration resources to be deleted.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtResyncInput": { + "description": "VMwareCbt specific resync input.", + "required": [ + "skipCbtReset", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResyncProviderSpecificInput" + } + ], + "properties": { + "skipCbtReset": { + "description": "A value indicating whether CBT is to be reset.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtSecurityProfileProperties": { + "description": "VMwareCbt security profile input.", + "type": "object", + "properties": { + "targetVmSecurityType": { + "description": "The target VM security type.", + "enum": [ + "None", + "TrustedLaunch", + "ConfidentialVM" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityType", + "modelAsString": true + } + }, + "isTargetVmSecureBootEnabled": { + "description": "A value indicating whether secure boot to be enabled.", + "type": "string" + }, + "isTargetVmTpmEnabled": { + "description": "A value indicating whether trusted platform module to be enabled.", + "type": "string" + }, + "isTargetVmIntegrityMonitoringEnabled": { + "description": "A value indicating whether integrity monitoring to be enabled.", + "type": "string" + }, + "isTargetVmConfidentialEncryptionEnabled": { + "description": "A value indicating whether confidential compute encryption to be enabled.", + "type": "string" + } + } + }, + "VMwareCbtTestMigrateInput": { + "description": "VMwareCbt specific test migrate input.", + "required": [ + "recoveryPointId", + "networkId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestMigrateProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "networkId": { + "description": "The test network Id.", + "type": "string" + }, + "vmNics": { + "description": "The list of NIC details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtNicInput" + }, + "x-ms-identifiers": [] + }, + "osUpgradeVersion": { + "description": "A value indicating the inplace OS Upgrade version.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtUpdateDiskInput": { + "description": "VMwareCbt disk input for update.", + "required": [ + "diskId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "targetDiskName": { + "description": "The target disk name.", + "type": "string" + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string" + } + } + }, + "VMwareCbtUpdateMigrationItemInput": { + "description": "VMwareCbt specific update migration item input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateMigrationItemProviderSpecificInput" + } + ], + "properties": { + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group ARM Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network ARM Id.", + "type": "string" + }, + "vmNics": { + "description": "The list of NIC details.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtNicInput" + } + }, + "vmDisks": { + "description": "The list of disk update properties.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtUpdateDiskInput" + } + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "performAutoResync": { + "description": "A value indicating whether auto resync is to be done.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetDiskTags": { + "description": "The tags for the target disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareDetails": { + "description": "Store the fabric details specific to the VMware fabric.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "processServers": { + "description": "The list of Process Servers associated with the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServer" + } + }, + "masterTargetServers": { + "description": "The list of Master Target servers associated with the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/MasterTargetServer" + } + }, + "runAsAccounts": { + "description": "The list of run as accounts created on the server.", + "type": "array", + "items": { + "$ref": "#/definitions/RunAsAccount" + } + }, + "replicationPairCount": { + "description": "The number of replication pairs configured in this CS.", + "type": "string" + }, + "processServerCount": { + "description": "The number of process servers.", + "type": "string" + }, + "agentCount": { + "description": "The number of source and target servers configured to talk to this CS.", + "type": "string" + }, + "protectedServers": { + "description": "The number of protected servers.", + "type": "string" + }, + "systemLoad": { + "description": "The percentage of the system load.", + "type": "string" + }, + "systemLoadStatus": { + "description": "The system load status.", + "type": "string" + }, + "cpuLoad": { + "description": "The percentage of the CPU load.", + "type": "string" + }, + "cpuLoadStatus": { + "description": "The CPU load status.", + "type": "string" + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer" + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer" + }, + "memoryUsageStatus": { + "description": "The memory usage status.", + "type": "string" + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total space.", + "type": "integer" + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available space.", + "type": "integer" + }, + "spaceUsageStatus": { + "description": "The space usage status.", + "type": "string" + }, + "webLoad": { + "description": "The web load.", + "type": "string" + }, + "webLoadStatus": { + "description": "The web load status.", + "type": "string" + }, + "databaseServerLoad": { + "description": "The database server load.", + "type": "string" + }, + "databaseServerLoadStatus": { + "description": "The database server load status.", + "type": "string" + }, + "csServiceStatus": { + "description": "The CS service status.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address.", + "type": "string" + }, + "agentVersion": { + "description": "The agent Version.", + "type": "string" + }, + "hostName": { + "description": "The host name.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from CS server.", + "type": "string" + }, + "versionStatus": { + "description": "Version status.", + "type": "string" + }, + "sslCertExpiryDate": { + "format": "date-time", + "description": "CS SSL cert expiry date.", + "type": "string" + }, + "sslCertExpiryRemainingDays": { + "format": "int32", + "description": "CS SSL cert expiry date.", + "type": "integer" + }, + "psTemplateVersion": { + "description": "PS template version.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "agentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "The agent version details." + }, + "switchProviderBlockingErrorDetails": { + "description": "The switch provider blocking error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageFabricSwitchProviderBlockingErrorDetails" + } + } + }, + "x-ms-discriminator-value": "VMware" + }, + "VMwareV2FabricCreationInput": { + "description": "VMwareV2 fabric provider specific settings.", + "required": [ + "migrationSolutionId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string" + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string" + }, + "migrationSolutionId": { + "description": "The ARM Id of the migration solution.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareV2" + }, + "VMwareV2FabricSpecificDetails": { + "description": "VMwareV2 fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string", + "readOnly": true + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string", + "readOnly": true + }, + "migrationSolutionId": { + "description": "The Migration solution ARM Id.", + "type": "string", + "readOnly": true + }, + "serviceEndpoint": { + "description": "The service endpoint.", + "type": "string", + "readOnly": true + }, + "serviceResourceId": { + "description": "The service resource Id.", + "type": "string", + "readOnly": true + }, + "serviceContainerId": { + "description": "The service container Id.", + "type": "string", + "readOnly": true + }, + "processServers": { + "description": "The list of process servers.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServerDetails" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareV2" + }, + "VMwareVirtualMachineDetails": { + "description": "VMware provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConfigurationSettings" + } + ], + "properties": { + "agentGeneratedId": { + "description": "The ID generated by the InMage agent after it gets installed on guest. This is the ID to be used during InMage CreateProtection.", + "type": "string" + }, + "agentInstalled": { + "description": "The value indicating if InMage scout agent is installed on guest.", + "type": "string" + }, + "osType": { + "description": "The OsType installed on VM.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address.", + "type": "string" + }, + "poweredOn": { + "description": "The value indicating whether VM is powered on.", + "type": "string" + }, + "vCenterInfrastructureId": { + "description": "The VCenter infrastructure Id.", + "type": "string" + }, + "discoveryType": { + "description": "A value indicating the discovery type of the machine. Value can be vCenter or physical.", + "type": "string" + }, + "diskDetails": { + "description": "The disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageDiskDetails" + } + }, + "validationErrors": { + "description": "The validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + } + }, + "x-ms-discriminator-value": "VMwareVirtualMachine" + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "tags": [] +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/readme.md b/specification/recoveryservicessiterecovery/resource-manager/readme.md index 57f4ac0b71b7..d71dd5431ad7 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/readme.md +++ b/specification/recoveryservicessiterecovery/resource-manager/readme.md @@ -54,7 +54,7 @@ These are the global settings for the RecoveryServicesSiteRecovery API. ``` yaml openapi-type: arm -tag: package-2023-06 +tag: package-2023-08 directive: - where: - $.paths @@ -63,14 +63,23 @@ directive: ``` +### Tag: package-2023-08 + +These settings apply only when `--tag=package-2023-08` is specified on the command line. + +```yaml $(tag) == 'package-2023-08' +input-file: + - Microsoft.RecoveryServices/stable/2023-08-01/service.json +``` ### Tag: package-2023-06 These settings apply only when `--tag=package-2023-06` is specified on the command line. -```yaml $(tag) == 'package-2023-06' +``` yaml $(tag) == 'package-2023-06' input-file: - Microsoft.RecoveryServices/stable/2023-06-01/service.json ``` + ### Tag: package-2023-04 These settings apply only when `--tag=package-2023-04` is specified on the command line. diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/OperationsList.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/OperationsList.json new file mode 100644 index 000000000000..9829263412c6 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/OperationsList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "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" + } + } + ] + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/OperationsStatusGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/OperationsStatusGet.json new file mode 100644 index 000000000000..ee8df73be35d --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/OperationsStatusGet.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "West US", + "operationId": "testoperationid", + "api-version": "2024-02-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Cache/locations/westus/operationsStatus/testoperationid", + "name": "testoperationid", + "startTime": "2017-01-01T13:13:13.933Z", + "endTime": "2017-01-01T16:13:13.933Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseCreate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseCreate.json new file mode 100644 index 000000000000..e30a6be1f821 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseCreate.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": {} + } + }, + "properties": { + "minimumTlsVersion": "1.2", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyIdentity": { + "identityType": "userAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity" + }, + "keyEncryptionKeyUrl": "https://your-kv.vault.azure.net/keys/your-key/your-key-version" + } + } + }, + "tags": { + "tag1": "value1" + } + } + }, + "responses": { + "201": { + "body": { + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Creating", + "resourceState": "Creating", + "hostName": "cache1.westus.something.azure.net", + "redisVersion": "5", + "minimumTlsVersion": "1.2", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity", + "identityType": "userAssignedIdentity" + }, + "keyEncryptionKeyUrl": "https://your-kv.vault.azure.net/keys/your-key/your-key-version" + } + } + }, + "tags": { + "tag1": "value1" + } + } + }, + "200": { + "body": { + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Running", + "hostName": "cache1.westus.something.azure.net", + "redisVersion": "5", + "minimumTlsVersion": "1.2" + }, + "tags": { + "tag1": "value1" + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesCreate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesCreate.json new file mode 100644 index 000000000000..a43f6d92cbfa --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesCreate.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clientProtocol": "Encrypted", + "clusteringPolicy": "EnterpriseCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "aofEnabled": true, + "aofFrequency": "1s" + }, + "port": 10000, + "modules": [ + { + "name": "RedisBloom", + "args": "ERROR_RATE 0.00 INITIAL_SIZE 400" + }, + { + "name": "RedisTimeSeries", + "args": "RETENTION_POLICY 20" + }, + { + "name": "RediSearch" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "name": "cache1/default", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Updating", + "resourceState": "Updating", + "clientProtocol": "Encrypted", + "clusteringPolicy": "EnterpriseCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "aofEnabled": true, + "aofFrequency": "1s" + }, + "port": 10000, + "modules": [ + { + "name": "RedisBloom", + "args": "ERROR_RATE 0.00 INITIAL_SIZE 400", + "version": "1.0.0" + }, + { + "name": "RedisTimeSeries", + "args": "RETENTION_POLICY 20", + "version": "1.0.0" + }, + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1", + "name": "cache1/db1", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Creating", + "resourceState": "Creating", + "clientProtocol": "Encrypted", + "clusteringPolicy": "EnterpriseCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "aofEnabled": true, + "aofFrequency": "1s" + }, + "port": 10000, + "modules": [ + { + "name": "RedisBloom", + "args": "ERROR_RATE 0.00 INITIAL_SIZE 400", + "version": "1.0.0" + }, + { + "name": "RedisTimeSeries", + "args": "RETENTION_POLICY 20", + "version": "1.0.0" + }, + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesCreateWithGeoReplication.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesCreateWithGeoReplication.json new file mode 100644 index 000000000000..9a6a6b7ae1d9 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesCreateWithGeoReplication.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid1", + "parameters": { + "properties": { + "clientProtocol": "Encrypted", + "clusteringPolicy": "EnterpriseCluster", + "evictionPolicy": "NoEviction", + "port": 10000, + "geoReplication": { + "groupNickname": "groupName", + "linkedDatabases": [ + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default" + }, + { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "name": "cache1/default", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Updating", + "resourceState": "Updating", + "clientProtocol": "Encrypted", + "clusteringPolicy": "EnterpriseCluster", + "evictionPolicy": "NoEviction", + "port": 10000, + "geoReplication": { + "groupNickname": "groupName", + "linkedDatabases": [ + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "state": "Linking" + }, + { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default", + "state": "Linking" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1", + "name": "cache1/db1", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Creating", + "resourceState": "Creating", + "clientProtocol": "Plaintext", + "clusteringPolicy": "EnterpriseCluster", + "evictionPolicy": "NoEviction", + "port": 10000, + "geoReplication": { + "groupNickname": "groupName", + "linkedDatabases": [ + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "state": "Linking" + }, + { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default", + "state": "Linking" + } + ] + } + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesDelete.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesDelete.json new file mode 100644 index 000000000000..c2305e8009c8 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "databaseName": "db1", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesExport.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesExport.json new file mode 100644 index 000000000000..dcba63f80cae --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesExport.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "parameters": { + "sasUri": "https://contosostorage.blob.core.window.net/urlToBlobContainer?sasKeyParameters" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesFlush.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesFlush.json new file mode 100644 index 000000000000..cff3b081c9c2 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesFlush.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "parameters": { + "ids": [ + "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesForceUnlink.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesForceUnlink.json new file mode 100644 index 000000000000..cff3b081c9c2 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesForceUnlink.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "parameters": { + "ids": [ + "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesGet.json new file mode 100644 index 000000000000..16a57bb830e0 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "name": "cache1/default", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Running", + "clientProtocol": "Encrypted", + "clusteringPolicy": "OSSCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "rdbEnabled": true, + "rdbFrequency": "12h" + }, + "port": 10000, + "modules": [ + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesImport.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesImport.json new file mode 100644 index 000000000000..d9732cba6d29 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesImport.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "parameters": { + "sasUris": [ + "https://contosostorage.blob.core.window.net/urltoBlobFile1?sasKeyParameters", + "https://contosostorage.blob.core.window.net/urltoBlobFile2?sasKeyParameters" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesListByCluster.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesListByCluster.json new file mode 100644 index 000000000000..4e448c085421 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesListByCluster.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "name": "cache1/default", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Running", + "clientProtocol": "Encrypted", + "clusteringPolicy": "OSSCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "rdbEnabled": true, + "rdbFrequency": "12h" + }, + "port": 10000, + "modules": [ + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesListKeys.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesListKeys.json new file mode 100644 index 000000000000..938c8a6db057 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesListKeys.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesRegenerateKey.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesRegenerateKey.json new file mode 100644 index 000000000000..4c058da9a96d --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesRegenerateKey.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "parameters": { + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesUpdate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesUpdate.json new file mode 100644 index 000000000000..82cf9ccd0728 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clientProtocol": "Encrypted", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "rdbEnabled": true, + "rdbFrequency": "12h" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "name": "cache1/default", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Updating", + "resourceState": "Updating", + "clientProtocol": "Encrypted", + "clusteringPolicy": "OSSCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "rdbEnabled": true, + "rdbFrequency": "12h" + }, + "port": 10000, + "modules": [ + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDelete.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDelete.json new file mode 100644 index 000000000000..310343018085 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDeletePrivateEndpointConnection.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..019b409cefb3 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDeletePrivateEndpointConnection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseGet.json new file mode 100644 index 000000000000..4f6057808e05 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "tags": {}, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "redisVersion": "6", + "minimumTlsVersion": "1.2", + "privateEndpointConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/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/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseGetPrivateEndpointConnection.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..fee396a4973f --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseGetPrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseList.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseList.json new file mode 100644 index 000000000000..3525b25f726d --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "tags": {}, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "redisVersion": "6", + "minimumTlsVersion": "1.2" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseListByResourceGroup.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseListByResourceGroup.json new file mode 100644 index 000000000000..46f533068bb8 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseListByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-02-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "tags": {}, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "redisVersion": "5", + "minimumTlsVersion": "1.2" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseListPrivateEndpointConnections.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseListPrivateEndpointConnections.json new file mode 100644 index 000000000000..57fb6cefd266 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseListPrivateEndpointConnections.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseListPrivateLinkResources.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseListPrivateLinkResources.json new file mode 100644 index 000000000000..f40b5de40203 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateLinkResources/redisEnterpriseCache", + "name": "redisEnterpriseCache", + "type": "Microsoft.Cache/redisEnterprise/privateLinkResources", + "properties": { + "groupId": "redisEnterpriseCache", + "requiredMembers": [ + "redisEnterpriseCache" + ], + "requiredZoneNames": [ + "privatelink.redisenterprise.cache.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterprisePutPrivateEndpointConnection.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterprisePutPrivateEndpointConnection.json new file mode 100644 index 000000000000..d9e2a78ae4b5 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterprisePutPrivateEndpointConnection.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseUpdate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseUpdate.json new file mode 100644 index 000000000000..378f8ecaab76 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2024-02-01", + "subscriptionId": "subid", + "parameters": { + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 9 + }, + "properties": { + "minimumTlsVersion": "1.2" + }, + "tags": { + "tag1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 9 + }, + "identity": { + "type": "None" + }, + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "tag1": "value1" + }, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Updating", + "resourceState": "Updating", + "redisVersion": "5", + "minimumTlsVersion": "1.2", + "encryption": {} + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/redisenterprise.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/redisenterprise.json new file mode 100644 index 000000000000..7b5f1a68bcda --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/redisenterprise.json @@ -0,0 +1,1955 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-02-01", + "title": "RedisEnterpriseManagementClient", + "description": "REST API for managing Redis Enterprise resources in Azure." + }, + "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": { + "OperationsList": { + "$ref": "./examples/OperationsList.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": "../../../../../common-types/resource-management/v3/types.json#/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/locations/{location}/operationsStatus/{operationId}": { + "get": { + "tags": [ + "OperationsStatus" + ], + "operationId": "OperationsStatus_Get", + "x-ms-examples": { + "OperationsStatusGet": { + "$ref": "./examples/OperationsStatusGet.json" + } + }, + "description": "Gets the status of operation.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The detailed status of the operation is in the 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/redisEnterprise/{clusterName}": { + "put": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_Create", + "x-ms-examples": { + "RedisEnterpriseCreate": { + "$ref": "./examples/RedisEnterpriseCreate.json" + } + }, + "description": "Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "description": "Parameters supplied to the Create RedisEnterprise 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 cluster was/is being created. Check provisioningState and resourceState to see detailed status.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "200": { + "description": "The cluster was/is being updated. Check provisioningState and resourceState to see detailed status.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseUpdate": { + "$ref": "./examples/RedisEnterpriseUpdate.json" + } + }, + "description": "Updates an existing RedisEnterprise cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdate" + }, + "description": "Parameters supplied to the Update RedisEnterprise 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 cluster was/is being updated. Check provisioningState and resourceState to see detailed status.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "The cluster update operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDelete": { + "$ref": "./examples/RedisEnterpriseDelete.json" + } + }, + "description": "Deletes a RedisEnterprise cache cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The cluster was successfully deleted." + }, + "202": { + "description": "The cluster delete operation was successfully started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status." + }, + "204": { + "description": "The cluster 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": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_Get", + "x-ms-examples": { + "RedisEnterpriseGet": { + "$ref": "./examples/RedisEnterpriseGet.json" + } + }, + "description": "Gets information about a RedisEnterprise cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded, response body contains the requested details.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "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/redisEnterprise": { + "get": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_ListByResourceGroup", + "x-ms-examples": { + "RedisEnterpriseListByResourceGroup": { + "$ref": "./examples/RedisEnterpriseListByResourceGroup.json" + } + }, + "description": "Lists all RedisEnterprise clusters 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": "The list of RedisEnterprise clusters", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "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/redisEnterprise": { + "get": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_List", + "x-ms-examples": { + "RedisEnterpriseList": { + "$ref": "./examples/RedisEnterpriseList.json" + } + }, + "description": "Gets all RedisEnterprise clusters 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": "The list of RedisEnterprise clusters", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "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/redisEnterprise/{clusterName}/databases": { + "get": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_ListByCluster", + "description": "Gets all databases in the specified RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseDatabasesListByCluster": { + "$ref": "./examples/RedisEnterpriseDatabasesListByCluster.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/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The list of databases", + "schema": { + "$ref": "#/definitions/DatabaseList" + } + }, + "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/redisEnterprise/{clusterName}/databases/{databaseName}": { + "put": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Create", + "description": "Creates a database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesCreate": { + "$ref": "./examples/RedisEnterpriseDatabasesCreate.json" + }, + "RedisEnterpriseDatabasesCreate With Active Geo Replication": { + "$ref": "./examples/RedisEnterpriseDatabasesCreateWithGeoReplication.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Database" + }, + "description": "Parameters supplied to the create or update database 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 database was/is being updated. Check provisioningState and resourceState for detailed status.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "201": { + "description": "The database was/is being created. Check provisioningState and resourceState for detailed status.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Update", + "description": "Updates a database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesUpdate": { + "$ref": "./examples/RedisEnterpriseDatabasesUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseUpdate" + }, + "description": "Parameters supplied to the create or update database 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 database was/is being updated. Check provisioningState and resourceState for detailed status.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "202": { + "description": "The database update operation was successfully started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Get", + "description": "Gets information about a database in a RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseDatabasesGet": { + "$ref": "./examples/RedisEnterpriseDatabasesGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$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 database", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Delete", + "description": "Deletes a single database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesDelete": { + "$ref": "./examples/RedisEnterpriseDatabasesDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$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 database." + }, + "202": { + "description": "The database delete operation started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status." + }, + "204": { + "description": "Successfully deleted the database." + }, + "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/redisEnterprise/{clusterName}/databases/{databaseName}/listKeys": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_ListKeys", + "x-ms-examples": { + "RedisEnterpriseDatabasesListKeys": { + "$ref": "./examples/RedisEnterpriseDatabasesListKeys.json" + } + }, + "description": "Retrieves the access keys for the RedisEnterprise database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The access keys for the specified database.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "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/redisEnterprise/{clusterName}/databases/{databaseName}/regenerateKey": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_RegenerateKey", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesRegenerateKey": { + "$ref": "./examples/RedisEnterpriseDatabasesRegenerateKey.json" + } + }, + "description": "Regenerates the RedisEnterprise database's access keys.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + }, + "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": "Returns the new access keys for the database", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "202": { + "description": "The cluster update operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status." + }, + "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/redisEnterprise/{clusterName}/databases/{databaseName}/import": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Import", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesImport": { + "$ref": "./examples/RedisEnterpriseDatabasesImport.json" + } + }, + "description": "Imports database files to target database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImportClusterParameters" + }, + "description": "Storage information for importing into the cluster" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Import operation succeeded." + }, + "202": { + "description": "The import operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status." + }, + "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/redisEnterprise/{clusterName}/databases/{databaseName}/export": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Export", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesExport": { + "$ref": "./examples/RedisEnterpriseDatabasesExport.json" + } + }, + "description": "Exports a database file from target database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExportClusterParameters" + }, + "description": "Storage information for exporting into the cluster" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Export operation succeeded." + }, + "202": { + "description": "Export operation 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" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "description": "Lists all the private endpoint connections associated with the RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseListPrivateEndpointConnections": { + "$ref": "./examples/RedisEnterpriseListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$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/v2/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/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseGetPrivateEndpointConnection": { + "$ref": "./examples/RedisEnterpriseGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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/v2/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": "Updates the state of the specified private endpoint connection associated with the RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterprisePutPrivateEndpointConnection": { + "$ref": "./examples/RedisEnterprisePutPrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "201": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/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 RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseDeletePrivateEndpointConnection": { + "$ref": "./examples/RedisEnterpriseDeletePrivateEndpointConnection.json" + } + }, + "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/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "202": { + "description": "Deletion of specified private endpoint connection was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "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/redisEnterprise/{clusterName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByCluster", + "description": "Gets the private link resources that need to be created for a RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseListPrivateLinkResources": { + "$ref": "./examples/RedisEnterpriseListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$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/v2/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}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/forceUnlink": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_ForceUnlink", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "How to unlink a database during a regional outage": { + "$ref": "./examples/RedisEnterpriseDatabasesForceUnlink.json" + } + }, + "description": "Forcibly removes the link to the specified database resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForceUnlinkParameters" + }, + "description": "Information identifying the database to be unlinked." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Force unlink operation succeeded. The unlinked database must be deleted before it can be recreated and linked again." + }, + "202": { + "description": "Force unlink operation successfully enqueued; follow the Azure-AsyncOperation 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" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/flush": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Flush", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "How to flush all the keys in the database": { + "$ref": "./examples/RedisEnterpriseDatabasesFlush.json" + } + }, + "description": "Flushes all the keys in this database and also from its linked databases.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlushParameters" + }, + "description": "Information identifying the databases to be flushed" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Flush operation succeeded. All the keys are cleared in this and all its linked databases." + }, + "202": { + "description": "Flush operation successfully enqueued; follow the Azure-AsyncOperation header to poll for final outcome.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Sku": { + "description": "SKU parameters supplied to the create RedisEnterprise operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)", + "enum": [ + "Enterprise_E5", + "Enterprise_E10", + "Enterprise_E20", + "Enterprise_E50", + "Enterprise_E100", + "EnterpriseFlash_F300", + "EnterpriseFlash_F700", + "EnterpriseFlash_F1500" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs." + } + }, + "required": [ + "name" + ] + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "Current provisioning status", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ResourceState": { + "type": "string", + "readOnly": true, + "description": "Current resource status", + "enum": [ + "Running", + "Creating", + "CreateFailed", + "Updating", + "UpdateFailed", + "Deleting", + "DeleteFailed", + "Enabling", + "EnableFailed", + "Disabling", + "DisableFailed", + "Disabled", + "Scaling", + "ScalingFailed" + ], + "x-ms-enum": { + "name": "ResourceState", + "modelAsString": true + } + }, + "Cluster": { + "description": "Describes the RedisEnterprise cluster", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU to create, which affects price, performance, and features." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Availability Zones where this cluster will be deployed." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties", + "description": "Other properties of the cluster." + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ] + }, + "ClusterUpdate": { + "description": "A partial update to the RedisEnterprise cluster", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU to create, which affects price, performance, and features." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties", + "description": "Other properties of the cluster." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "ClusterProperties": { + "title": "RedisEnterprise cluster properties", + "description": "Properties of RedisEnterprise clusters, as opposed to general resource properties like location, tags", + "type": "object", + "properties": { + "minimumTlsVersion": { + "type": "string", + "description": "The minimum TLS version for the cluster to support, e.g. '1.2'", + "enum": [ + "1.0", + "1.1", + "1.2" + ], + "x-ms-enum": { + "name": "TlsVersion", + "modelAsString": true + } + }, + "encryption": { + "type": "object", + "description": "Encryption-at-rest configuration for the cluster.", + "properties": { + "customerManagedKeyEncryption": { + "type": "object", + "description": "All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.", + "properties": { + "keyEncryptionKeyIdentity": { + "type": "object", + "description": "All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.", + "properties": { + "userAssignedIdentityResourceId": { + "type": "string", + "description": "User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId." + }, + "identityType": { + "type": "string", + "enum": [ + "systemAssignedIdentity", + "userAssignedIdentity" + ], + "description": "Only userAssignedIdentity is supported in this API version; other types may be supported in the future", + "x-ms-enum": { + "name": "CmkIdentityType", + "modelAsString": true + } + } + } + }, + "keyEncryptionKeyUrl": { + "type": "string", + "description": "Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78" + } + } + } + } + }, + "hostName": { + "type": "string", + "readOnly": true, + "description": "DNS name of the cluster endpoint" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "readOnly": true, + "description": "Current provisioning status of the cluster" + }, + "resourceState": { + "$ref": "#/definitions/ResourceState", + "readOnly": true, + "description": "Current resource status of the cluster" + }, + "redisVersion": { + "type": "string", + "readOnly": true, + "description": "Version of redis the cluster supports, e.g. '6'" + }, + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "description": "List of private endpoint connections associated with the specified RedisEnterprise cluster", + "items": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + } + }, + "ClusterList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + }, + "description": "List of clusters." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URI to fetch the next page of results." + } + }, + "description": "The response of a list-all operation." + }, + "Database": { + "description": "Describes a database on the RedisEnterprise cluster", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseProperties", + "description": "Other properties of the database." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "DatabaseUpdate": { + "description": "A partial update to the RedisEnterprise database", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseProperties", + "description": "Properties of the database." + } + } + }, + "DatabaseProperties": { + "title": "RedisEnterprise database properties", + "description": "Properties of RedisEnterprise databases, as opposed to general resource properties like location, tags", + "type": "object", + "properties": { + "clientProtocol": { + "type": "string", + "description": "Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.", + "enum": [ + "Encrypted", + "Plaintext" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "TCP port of the database endpoint. Specified at create time. Defaults to an available port." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "readOnly": true, + "description": "Current provisioning status of the database" + }, + "resourceState": { + "$ref": "#/definitions/ResourceState", + "readOnly": true, + "description": "Current resource status of the database" + }, + "clusteringPolicy": { + "type": "string", + "description": "Clustering policy - default is OSSCluster. Specified at create time.", + "enum": [ + "EnterpriseCluster", + "OSSCluster" + ], + "x-ms-enum": { + "name": "ClusteringPolicy", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "evictionPolicy": { + "type": "string", + "description": "Redis eviction policy - default is VolatileLRU", + "enum": [ + "AllKeysLFU", + "AllKeysLRU", + "AllKeysRandom", + "VolatileLRU", + "VolatileLFU", + "VolatileTTL", + "VolatileRandom", + "NoEviction" + ], + "x-ms-enum": { + "name": "EvictionPolicy", + "modelAsString": true + } + }, + "persistence": { + "$ref": "#/definitions/Persistence", + "description": "Persistence settings", + "x-ms-identifiers": [] + }, + "modules": { + "type": "array", + "description": "Optional set of redis modules to enable in this database - modules can only be added at creation time.", + "items": { + "$ref": "#/definitions/Module" + }, + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-identifiers": [ + "name" + ] + }, + "geoReplication": { + "type": "object", + "description": "Optional set of properties to configure geo replication for this database.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "groupNickname": { + "type": "string", + "description": "Name for the group of linked database resources", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "linkedDatabases": { + "type": "array", + "description": "List of database resources to link with this database", + "items": { + "$ref": "#/definitions/LinkedDatabase" + } + } + } + } + } + }, + "DatabaseList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Database" + }, + "description": "List of databases" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URI to fetch the next page of results." + } + }, + "description": "The response of a list-all operation." + }, + "Persistence": { + "title": "Persistence settings", + "description": "Persistence-related configuration for the RedisEnterprise database", + "type": "object", + "properties": { + "aofEnabled": { + "type": "boolean", + "description": "Sets whether AOF is enabled." + }, + "rdbEnabled": { + "type": "boolean", + "description": "Sets whether RDB is enabled." + }, + "aofFrequency": { + "type": "string", + "description": "Sets the frequency at which data is written to disk.", + "enum": [ + "1s", + "always" + ], + "x-ms-enum": { + "name": "AofFrequency", + "modelAsString": true + } + }, + "rdbFrequency": { + "type": "string", + "description": "Sets the frequency at which a snapshot of the database is created.", + "enum": [ + "1h", + "6h", + "12h" + ], + "x-ms-enum": { + "name": "RdbFrequency", + "modelAsString": true + } + } + } + }, + "Module": { + "title": "Module settings", + "description": "Specifies configuration of a redis module", + "type": "object", + "properties": { + "name": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'" + }, + "args": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "The version of the module, e.g. '1.0'." + } + }, + "required": [ + "name" + ] + }, + "LinkedDatabase": { + "title": "Linked Database", + "description": "Specifies details of a linked database resource.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Cache/redisEnterprise/databases" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource ID of a database resource to link with this database." + }, + "state": { + "type": "string", + "description": "State of the link between the database resources.", + "enum": [ + "Linked", + "Linking", + "Unlinking", + "LinkFailed", + "UnlinkFailed" + ], + "x-ms-enum": { + "name": "LinkState", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "AccessKeys": { + "title": "Access keys", + "description": "The secret access keys used for authenticating connections to redis", + "type": "object", + "properties": { + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "The current primary key that clients can use to authenticate" + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "The current secondary key that clients can use to authenticate" + } + } + }, + "RegenerateKeyParameters": { + "title": "Regenerate access keys request", + "type": "object", + "properties": { + "keyType": { + "type": "string", + "description": "Which access key to regenerate.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "AccessKeyType", + "modelAsString": false + } + } + }, + "required": [ + "keyType" + ], + "description": "Specifies which access keys to reset to a new random value." + }, + "ImportClusterParameters": { + "title": "Import RDB files into a target database", + "type": "object", + "properties": { + "sasUris": { + "type": "array", + "items": { + "type": "string" + }, + "description": "SAS URIs for the target blobs to import from", + "x-ms-secret": true + } + }, + "required": [ + "sasUris" + ], + "description": "Parameters for a Redis Enterprise import operation." + }, + "ExportClusterParameters": { + "title": "Export an RDB file into a target database", + "type": "object", + "properties": { + "sasUri": { + "type": "string", + "description": "SAS URI for the target directory to export to", + "x-ms-secret": true + } + }, + "required": [ + "sasUri" + ], + "description": "Parameters for a Redis Enterprise export operation." + }, + "OperationStatus": { + "description": "The status of a long-running operation.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The operation's unique id." + }, + "name": { + "type": "string", + "description": "The operation's name." + }, + "startTime": { + "type": "string", + "description": "The start time of the operation." + }, + "endTime": { + "type": "string", + "description": "The end time of the operation." + }, + "status": { + "type": "string", + "description": "The current status of the operation." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse", + "description": "Error response describing why the operation failed." + } + } + }, + "ForceUnlinkParameters": { + "title": "Forcibly unlink another database from this database.", + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Cache/redisEnterprise/databases" + } + ] + } + }, + "description": "The resource IDs of the database resources to be unlinked." + } + }, + "required": [ + "ids" + ], + "description": "Parameters for a Redis Enterprise Active Geo Replication Force Unlink operation." + }, + "FlushParameters": { + "title": "Flush all the keys from the current and all its linked databases.", + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Cache/redisEnterprise/databases" + } + ] + } + }, + "description": "The identifiers of all the other database resources in the georeplication group to be flushed." + } + }, + "description": "Parameters for a Redis Enterprise active geo-replication flush operation" + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RedisEnterprise cluster.", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/redisenterprise/resource-manager/readme.md b/specification/redisenterprise/resource-manager/readme.md index 09e7a71b3b79..3344d0d71398 100644 --- a/specification/redisenterprise/resource-manager/readme.md +++ b/specification/redisenterprise/resource-manager/readme.md @@ -26,18 +26,27 @@ These are the global settings for the RedisEnterprise API. ``` yaml openapi-type: arm -tag: package-2023-11 +tag: package-2024-02 ``` +### Tag: package-2024-02 + +These settings apply only when `--tag=package-2024-02` is specified on the command line. + +```yaml $(tag) == 'package-2024-02' +input-file: + - Microsoft.Cache/stable/2024-02-01/redisenterprise.json +``` ### Tag: package-2023-11 These settings apply only when `--tag=package-2023-11` is specified on the command line. -```yaml $(tag) == 'package-2023-11' +``` yaml $(tag) == 'package-2023-11' input-file: - Microsoft.Cache/stable/2023-11-01/redisenterprise.json ``` + ### Tag: package-preview-2023-10 These settings apply only when `--tag=package-preview-2023-10` is specified on the command line. diff --git a/specification/scvmm/resource-manager/readme.java.md b/specification/scvmm/resource-manager/readme.java.md index 9e02d58e913e..134228ed936f 100644 --- a/specification/scvmm/resource-manager/readme.java.md +++ b/specification/scvmm/resource-manager/readme.java.md @@ -3,58 +3,7 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.scvmm -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-scvmm title: SCVMMClient description: "SCVMM Client" +client-flattened-annotation-target: disabled ``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2020-06-05-preview - - tag: package-2022-05-21-preview - - tag: package-2023-04-01-preview -``` - -### Tag: package-2020-06-05-preview and java - -These settings apply only when `--tag=package-2020-06-05-preview` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2020-06-05-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.scvmm.v2020-06-05-preview - output-folder: $(azure-libraries-for-java-folder)/scvmm/resource-manager/v2020-06-05-preview -regenerate-manager: true -generate-interface: true -``` -### Tag: package-2022-05-21-preview and java - -These settings apply only when `--tag=package-2022-05-21-preview` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2022-05-21-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.scvmm.v2022-05-21-preview - output-folder: $(azure-libraries-for-java-folder)/scvmm/resource-manager/v2022-05-21-preview -regenerate-manager: true -generate-interface: true -``` -### Tag: package-2023-04-01-preview and java - -These settings apply only when `--tag=package-2023-04-01-preview` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2023-04-01-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.scvmm.v2023-04-01-preview - output-folder: $(azure-libraries-for-java-folder)/scvmm/resource-manager/v2023-04-01-preview -regenerate-manager: true -generate-interface: true -``` \ No newline at end of file diff --git a/specification/scvmm/resource-manager/readme.md b/specification/scvmm/resource-manager/readme.md index 0339ceab67b5..874bc761e635 100644 --- a/specification/scvmm/resource-manager/readme.md +++ b/specification/scvmm/resource-manager/readme.md @@ -30,6 +30,10 @@ openapi-subtype: rpaas tag: package-2023-10 ``` +``` yaml +modelerfour: + flatten-models: false +``` ### Tag: package-2023-10 diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexAutocompleteDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexAutocompleteDocumentsGet.json new file mode 100644 index 000000000000..6c41fbaea509 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexAutocompleteDocumentsGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchIndexAutocompleteDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexAutocompleteDocumentsPost.json new file mode 100644 index 000000000000..dc10684bebb2 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexAutocompleteDocumentsPost.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchIndexCountDocuments.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexCountDocuments.json new file mode 100644 index 000000000000..63f28d8cea43 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexCountDocuments.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-03-01-Preview" + }, + "responses": { + "200": { + "body": 427 + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexGetDocument.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexGetDocument.json new file mode 100644 index 000000000000..12497bc02e4d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexGetDocument.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchIndexIndexDocuments.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexIndexDocuments.json new file mode 100644 index 000000000000..d77b8132dc53 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexIndexDocuments.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchIndexSearchDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSearchDocumentsGet.json new file mode 100644 index 000000000000..8d1f5a41663e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSearchDocumentsGet.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchIndexSearchDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSearchDocumentsPost.json new file mode 100644 index 000000000000..be8dfd31322f --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSearchDocumentsPost.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-03-01-Preview", + "searchRequest": { + "count": true, + "facets": [ + "category,count:10,sort:count" + ], + "filter": "rating gt 4.0", + "highlight": "description", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "orderby": "rating desc", + "queryType": "simple", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": "category,description", + "searchMode": "any", + "sessionId": "mysessionid", + "scoringStatistics": "global", + "select": "hotelId,description", + "skip": 0, + "top": 10, + "vectorQueries": [ + { + "kind": "vector", + "vector": [ + 0.103, + 0.0712, + 0.0852, + 0.1547, + 0.1183 + ], + "fields": "descriptionEmbedding", + "k": 5, + "exhaustive": true, + "oversampling": 20.0 + } + ], + "vectorFilterMode": "preFilter" + } + }, + "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=2024-03-01-Preview" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSuggestDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSuggestDocumentsGet.json new file mode 100644 index 000000000000..2c424835462d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSuggestDocumentsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchIndexSuggestDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSuggestDocumentsPost.json new file mode 100644 index 000000000000..ab5ce94e0294 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchIndexSuggestDocumentsPost.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceCreateAlias.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateAlias.json new file mode 100644 index 000000000000..6a760c09a19c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateAlias.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-03-01-Preview", + "alias": { + "name": "production", + "indexes": [ + "hotels" + ] + } + }, + "responses": { + "201": { + "body": { + "name": "production", + "indexes": [ + "hotels" + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateDataSource.json new file mode 100644 index 000000000000..c78eda8a45cf --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateDataSource.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceCreateIndex.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateIndex.json new file mode 100644 index 000000000000..9934e5cd2726 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateIndex.json @@ -0,0 +1,690 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-03-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": "descriptionEmbedding", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myCompressedHnswProfile" + }, + { + "name": "descriptionEmbedding_notstored", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": false, + "stored": false, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myCompressedHnswProfile" + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "nameEmbedding", + "type": "Collection(Edm.Half)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myHnswProfile" + }, + { + "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" + } + ] + } + } + ] + }, + "vectorSearch": { + "profiles": [ + { + "name": "myHnswProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi" + }, + { + "name": "myCompressedHnswProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi", + "compression": "mySQ8" + }, + { + "name": "myAlgorithm", + "algorithm": "myHnsw" + } + ], + "algorithms": [ + { + "name": "myHnsw", + "kind": "hnsw", + "hnswParameters": { + "m": 4, + "metric": "cosine", + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "myExhaustiveKnn", + "kind": "exhaustiveKnn", + "exhaustiveKnnParameters": { + "metric": "cosine" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rerankWithOriginalVectors": true, + "defaultOversampling": 10.0 + } + ], + "vectorizers": [ + { + "name": "myOpenAi", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://url.openai.azure.com", + "deploymentId": "text-embedding-ada-002", + "apiKey": "topsecretkey" + } + } + ] + } + } + }, + "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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": 1536, + "vectorSearchProfile": "myCompressedHnswProfile", + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding_notstored", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": false, + "stored": false, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myCompressedHnswProfile" + }, + { + "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", + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "nameEmbedding", + "type": "Collection(Edm.Half)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": 1536, + "vectorSearchProfile": "myHnswProfile", + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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", + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "functionAggregation": "sum", + "text": { + "weights": { + "hotelName": 5.0 + } + }, + "functions": [ + { + "fieldName": "location", + "interpolation": "logarithmic", + "type": "distance", + "boost": 5.0, + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10.0 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2", + "tokenFilters": [] + } + ], + "tokenizers": [], + "normalizers": [], + "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": { + "defaultConfiguration": null, + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "myHnsw", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "myExhaustiveKnn", + "kind": "exhaustiveKnn", + "exhaustiveKnnParameters": { + "metric": "cosine" + } + } + ], + "profiles": [ + { + "name": "myHnswProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi" + }, + { + "name": "myCompressedHnswProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi", + "compression": "mySQ8" + }, + { + "name": "myAlgorithm", + "algorithm": "myHnsw" + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rerankWithOriginalVectors": true, + "defaultOversampling": 10.0 + } + ], + "vectorizers": [ + { + "name": "myOpenAi", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://url.openai.azure.com", + "deploymentId": "text-embedding-ada-002", + "apiKey": "topsecretkey", + "authIdentity": null + } + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateIndexer.json new file mode 100644 index 000000000000..7b36dddb3565 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateIndexer.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateAlias.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateAlias.json new file mode 100644 index 000000000000..1280c8d48a42 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateAlias.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "aliasName": "production", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateDataSource.json new file mode 100644 index 000000000000..c428347b60db --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateDataSource.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateIndex.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateIndex.json new file mode 100644 index 000000000000..aa9efeedfb5d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateIndex.json @@ -0,0 +1,1050 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "allowIndexDowntime": false, + "api-version": "2024-03-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": "descriptionEmbedding", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myHnswProfile" + }, + { + "name": "descriptionEmbedding_notstored", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": false, + "stored": false, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myCompressedHnswProfile" + }, + { + "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" + } + ] + } + } + ] + }, + "vectorSearch": { + "profiles": [ + { + "name": "myHnswProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi" + }, + { + "name": "myCompressedHnswProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi", + "compression": "mySQ8" + }, + { + "name": "myAlgorithm", + "algorithm": "myHnsw" + } + ], + "algorithms": [ + { + "name": "myHnsw", + "kind": "hnsw", + "hnswParameters": { + "m": 4, + "metric": "cosine", + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "myExhaustiveKnn", + "kind": "exhaustiveKnn", + "exhaustiveKnnParameters": { + "metric": "cosine" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rerankWithOriginalVectors": true, + "defaultOversampling": 10.0 + } + ], + "vectorizers": [ + { + "name": "myOpenAi", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://url.openai.azure.com", + "deploymentId": "text-embedding-ada-002", + "apiKey": "topsecretkey" + } + } + ] + } + } + }, + "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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": 1536, + "vectorSearchProfile": "myHnswProfile", + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding_notstored", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": false, + "stored": false, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myCompressedHnswProfile" + }, + { + "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", + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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", + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "functionAggregation": "sum", + "text": { + "weights": { + "hotelName": 5.0 + } + }, + "functions": [ + { + "fieldName": "location", + "interpolation": "logarithmic", + "type": "distance", + "boost": 5.0, + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10.0 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity", + "k1": null, + "b": null + }, + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer", + "tokenizer": "standard_v2", + "tokenFilters": [], + "charFilters": [ + "html_strip" + ] + } + ], + "normalizers": [], + "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 + } + }, + "semantic": { + "defaultConfiguration": null, + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "myHnsw", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "myExhaustiveKnn", + "kind": "exhaustiveKnn", + "exhaustiveKnnParameters": { + "metric": "cosine" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rerankWithOriginalVectors": true, + "defaultOversampling": 10.0 + } + ], + "profiles": [ + { + "name": "myHnswProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi" + }, + { + "name": "myCompressedHnswProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi", + "compression": "mySQ8" + }, + { + "name": "myAlgorithm", + "algorithm": "myHnsw" + } + ], + "vectorizers": [ + { + "name": "myOpenAi", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://url.openai.azure.com", + "deploymentId": "text-embedding-ada-002", + "apiKey": "topsecretkey", + "authIdentity": null + } + } + ] + } + } + }, + "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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": 1536, + "vectorSearchProfile": "myHnswProfile", + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding_notstored", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": false, + "stored": false, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myCompressedHnswProfile" + }, + { + "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", + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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", + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "functionAggregation": "sum", + "text": { + "weights": { + "hotelName": 5.0 + } + }, + "functions": [ + { + "fieldName": "location", + "interpolation": "logarithmic", + "type": "distance", + "boost": 5.0, + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10.0 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2", + "tokenFilters": [] + } + ], + "normalizers": [], + "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": { + "defaultConfiguration": null, + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "myHnsw", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "myExhaustiveKnn", + "kind": "exhaustiveKnn", + "exhaustiveKnnParameters": { + "metric": "cosine" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rerankWithOriginalVectors": true, + "defaultOversampling": 10.0 + } + ], + "profiles": [ + { + "name": "myHnswProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi" + }, + { + "name": "myCompressedHnswProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi", + "compression": "mySQ8" + }, + { + "name": "myAlgorithm", + "algorithm": "myHnsw" + } + ], + "vectorizers": [ + { + "name": "myOpenAi", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://url.openai.azure.com", + "deploymentId": "text-embedding-ada-002", + "apiKey": "topsecretkey", + "authIdentity": null + } + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateIndexer.json new file mode 100644 index 000000000000..b89803b77d38 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateIndexer.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateSkillset.json new file mode 100644 index 000000000000..07a8e7565cbe --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateSkillset.json @@ -0,0 +1,387 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json new file mode 100644 index 000000000000..df439a0acf55 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateSkillset.json new file mode 100644 index 000000000000..d8f834182ba0 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateSkillset.json @@ -0,0 +1,307 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceCreateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateSynonymMap.json new file mode 100644 index 000000000000..1707fddd3344 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceCreateSynonymMap.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceDeleteAlias.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteAlias.json new file mode 100644 index 000000000000..99ed97f84608 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteAlias.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "aliasName": "staging", + "api-version": "2024-03-01-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteDataSource.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteDataSource.json new file mode 100644 index 000000000000..1024e158f1db --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteDataSource.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2024-03-01-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteIndex.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteIndex.json new file mode 100644 index 000000000000..e97c9ef9739c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteIndex.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-03-01-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteIndexer.json new file mode 100644 index 000000000000..2dca2cd13072 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteIndexer.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-03-01-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteSkillset.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteSkillset.json new file mode 100644 index 000000000000..07795f049da5 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteSkillset.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2024-03-01-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteSynonymMap.json new file mode 100644 index 000000000000..408b729ab89c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceDeleteSynonymMap.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2024-03-01-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetAlias.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetAlias.json new file mode 100644 index 000000000000..e43484475b99 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetAlias.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "aliasName": "production", + "api-version": "2024-03-01-Preview" + }, + "responses": { + "200": { + "body": { + "name": "production", + "indexes": [ + "hotels" + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetDataSource.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetDataSource.json new file mode 100644 index 000000000000..068a6d1e4f29 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetDataSource.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceGetIndex.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndex.json new file mode 100644 index 000000000000..67c899ca1c67 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndex.json @@ -0,0 +1,412 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2024-03-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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": 1536, + "vectorSearchProfile": "myHnswProfile", + "synonymMaps": [] + }, + { + "name": "descriptionEmbedding_notstored", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": false, + "stored": false, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [], + "dimensions": 1536, + "vectorSearchProfile": "myCompressedHnswProfile" + }, + { + "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", + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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", + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": 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, + "normalizer": null, + "dimensions": null, + "vectorSearchProfile": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "functionAggregation": "sum", + "text": { + "weights": { + "hotelName": 5.0 + } + }, + "functions": [ + { + "fieldName": "location", + "interpolation": "logarithmic", + "type": "distance", + "boost": 5.0, + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10.0 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity", + "k1": null, + "b": null + }, + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer", + "tokenizer": "standard_v2", + "tokenFilters": [], + "charFilters": [ + "html_strip" + ] + } + ], + "normalizers": [], + "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 + } + }, + "semantic": { + "defaultConfiguration": null, + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "myHnsw", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "myExhaustiveKnn", + "kind": "exhaustiveKnn", + "exhaustiveKnnParameters": { + "metric": "cosine" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rerankWithOriginalVectors": true, + "defaultOversampling": 10.0 + } + ], + "profiles": [ + { + "name": "myHnswProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi" + }, + { + "name": "myCompressedHnswProfile", + "algorithm": "myHnsw", + "vectorizer": "myOpenAi", + "compression": "mySQ8" + }, + { + "name": "myAlgorithm", + "algorithm": "myHnsw" + } + ], + "vectorizers": [ + { + "name": "myOpenAi", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://url.openai.azure.com", + "deploymentId": "text-embedding-ada-002", + "apiKey": "topsecretkey", + "authIdentity": null + } + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndexStatistics.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndexStatistics.json new file mode 100644 index 000000000000..b7215284b27b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndexStatistics.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2024-03-01-Preview" + }, + "responses": { + "200": { + "body": { + "documentCount": 239572, + "storageSize": 72375920, + "vectorIndexSize": 123456 + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndexer.json new file mode 100644 index 000000000000..d9a9ef3f04b5 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndexer.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceGetIndexerStatus.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndexerStatus.json new file mode 100644 index 000000000000..3e6fbb7423ec --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetIndexerStatus.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceGetServiceStatistics.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetServiceStatistics.json new file mode 100644 index 000000000000..c8eee03a84d9 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetServiceStatistics.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-03-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 + }, + "vectorIndexSize": { + "usage": 123456, + "quota": 26214400 + } + }, + "limits": { + "maxFieldsPerIndex": 1000, + "maxFieldNestingDepthPerIndex": 10, + "maxComplexCollectionFieldsPerIndex": 100, + "maxComplexObjectsInCollectionsPerDocument": 3000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetSkillset.json new file mode 100644 index 000000000000..9f2d7182b1bb --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetSkillset.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceGetSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetSynonymMap.json new file mode 100644 index 000000000000..22faaf5ea79b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceGetSynonymMap.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceIndexAnalyze.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceIndexAnalyze.json new file mode 100644 index 000000000000..594282a20155 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceIndexAnalyze.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceListAliases.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListAliases.json new file mode 100644 index 000000000000..d49ae2789c1a --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListAliases.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-03-01-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "production", + "indexes": [ + "hotels" + ] + }, + { + "name": "staging", + "indexes": [ + "testindex" + ] + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListDataSources.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListDataSources.json new file mode 100644 index 000000000000..225802a6cf4b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListDataSources.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceListIndexers.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListIndexers.json new file mode 100644 index 000000000000..e347e6910fb0 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListIndexers.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceListIndexes.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListIndexes.json new file mode 100644 index 000000000000..6957c1a45fde --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListIndexes.json @@ -0,0 +1,287 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListSkillsets.json new file mode 100644 index 000000000000..11fe5f5aa18f --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListSkillsets.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceListSynonymMaps.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListSynonymMaps.json new file mode 100644 index 000000000000..3d62ac8e3325 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceListSynonymMaps.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2024-03-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/2024-03-01-Preview/examples/SearchServiceResetDocs.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceResetDocs.json new file mode 100644 index 000000000000..5b5af7081018 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceResetDocs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-03-01-Preview", + "keysOrIds": { + "documentKeys": [ + "documentKey1", + "documentKey2" + ] + }, + "overwrite": false + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceResetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceResetIndexer.json new file mode 100644 index 000000000000..252683001991 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceResetIndexer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-03-01-Preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceResetSkills.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceResetSkills.json new file mode 100644 index 000000000000..ef7a26703c5c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceResetSkills.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "mySkillset", + "api-version": "2024-03-01-Preview", + "skillNames": { + "skillNames": [ + "skillName1", + "skillName2" + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceRunIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceRunIndexer.json new file mode 100644 index 000000000000..5182b1d91d16 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/examples/SearchServiceRunIndexer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-03-01-Preview" + }, + "responses": { + "202": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchindex.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchindex.json new file mode 100644 index 000000000000..1d30f0fbe030 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchindex.json @@ -0,0 +1,2826 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchIndexClient", + "description": "Client that can be used to query an index and upload, merge, or delete documents.", + "version": "2024-03-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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "semanticQuery", + "in": "query", + "type": "string", + "description": "Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase.", + "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": "SemanticErrorMode", + "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 (default).", + "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 reranked 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": "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.", + "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": "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`.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names used for semantic ranking.", + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "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": { + "x-ms-client-name": "QueryAnswerResult", + "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": { + "x-ms-client-name": "QueryCaptionResult", + "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": "SemanticErrorReason", + "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 ranking request." + }, + "SemanticPartialResponseType": { + "type": "string", + "enum": [ + "baseResults", + "rerankedResults" + ], + "x-ms-enum": { + "name": "SemanticSearchResultsType", + "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 ranking request." + }, + "DocumentDebugInfo": { + "type": "object", + "properties": { + "semantic": { + "$ref": "#/definitions/SemanticDebugInfo", + "readOnly": true, + "description": "Contains debugging information specific to semantic ranking requests." + } + }, + "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": "SemanticFieldState", + "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 the query can't return all the requested documents in a single 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 the query can't return all the requested results in a single 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 ranking request." + }, + "@search.semanticPartialResponseType": { + "$ref": "#/definitions/SemanticPartialResponseType", + "readOnly": true, + "x-ms-client-name": "SemanticPartialResponseType", + "description": "Type of partial response that was returned for a semantic ranking 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 the query can't return all the requested results in a single 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": "SemanticErrorMode", + "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 reranked 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`." + }, + "VectorQuery": { + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/VectorQueryKind", + "description": "The kind of vector query being performed.", + "x-nullable": false + }, + "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." + }, + "exhaustive": { + "type": "boolean", + "description": "When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values." + }, + "oversampling": { + "type": "number", + "format": "double", + "description": "Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field." + } + }, + "required": [ + "kind" + ], + "description": "The query parameters for vector and hybrid search queries." + }, + "RawVectorQuery": { + "type": "object", + "x-ms-discriminator-value": "vector", + "allOf": [ + { + "$ref": "#/definitions/VectorQuery" + } + ], + "properties": { + "vector": { + "type": "array", + "items": { + "type": "number", + "format": "float" + }, + "description": "The vector representation of a search query." + } + }, + "required": [ + "vector" + ], + "description": "The query parameters to use for vector search when a raw vector value is provided." + }, + "VectorizableTextQuery": { + "type": "object", + "x-ms-discriminator-value": "text", + "allOf": [ + { + "$ref": "#/definitions/VectorQuery" + } + ], + "properties": { + "text": { + "type": "string", + "description": "The text to be vectorized to perform a vector search query." + } + }, + "required": [ + "text" + ], + "description": "The query parameters to use for vector search when a text value that needs to be vectorized is provided." + }, + "VectorQueryKind": { + "type": "string", + "enum": [ + "vector", + "text" + ], + "x-ms-enum": { + "name": "VectorQueryKind", + "modelAsString": true, + "values": [ + { + "value": "vector", + "name": "Vector", + "description": "Vector query where a raw vector value is provided." + }, + { + "value": "text", + "name": "Text", + "description": "Vector query where a text value that needs to be vectorized is provided." + } + ] + }, + "description": "The kind of vector query being performed." + }, + "VectorFilterMode": { + "type": "string", + "enum": [ + "postFilter", + "preFilter" + ], + "x-ms-enum": { + "name": "VectorFilterMode", + "modelAsString": true, + "values": [ + { + "value": "postFilter", + "name": "PostFilter", + "description": "The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'." + }, + { + "value": "preFilter", + "name": "PreFilter", + "description": "The filter will be applied before the search query." + } + ] + }, + "description": "Determines whether or not filters are applied before or after the vector search is performed." + }, + "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." + }, + { + "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." + }, + { + "value": "gl-es", + "name": "GlEs", + "description": "Query language value for Galician." + }, + { + "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." + }, + "semanticQuery": { + "type": "string", + "description": "Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase." + }, + "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, or to return partial results (default)." + }, + "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 reranked 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 ranking." + }, + "vectorQueries": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorQuery" + }, + "description": "The query parameters for vector and hybrid search queries." + }, + "vectorFilterMode": { + "$ref": "#/definitions/VectorFilterMode", + "description": "Determines whether or not filters are applied before or after the vector search is performed. Default is 'preFilter'." + } + }, + "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." + } + }, + "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/2024-03-01-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchservice.json new file mode 100644 index 000000000000..07718abf7df6 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-03-01-Preview/searchservice.json @@ -0,0 +1,12259 @@ +{ + "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": "2024-03-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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/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": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "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 the search engine.", + "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 the search engine.", + "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 the search engine.", + "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 the search engine.", + "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 the search engine.", + "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", + "Edm.Half", + "Edm.Int16", + "Edm.SByte" + ], + "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)." + }, + { + "value": "Edm.Half", + "name": "Half", + "description": "Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half)." + }, + { + "value": "Edm.Int16", + "name": "Int16", + "description": "Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16)." + }, + { + "value": "Edm.SByte", + "name": "SByte", + "description": "Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte)." + } + ] + }, + "description": "Defines the data type of a field in a search index." + }, + "LexicalAnalyzer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of 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": "A URI fragment specifying the type of 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": "A URI fragment specifying the type of 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": "A URI fragment specifying the type of 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": "A URI fragment specifying the type of 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": { + "x-ms-client-name": "SemanticSearch", + "properties": { + "defaultConfiguration": { + "x-ms-client-name": "defaultConfigurationName", + "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": { + "x-ms-client-name": "SemanticPrioritizedFields", + "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": { + "x-ms-client-name": "contentFields", + "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": { + "x-ms-client-name": "keywordsFields", + "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 + } + }, + "required": [ + "fieldName" + ], + "description": "A field that is used as part of the semantic configuration." + }, + "VectorSearch": { + "type": "object", + "properties": { + "profiles": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchProfile" + }, + "description": "Defines combinations of configurations to use with vector search." + }, + "algorithms": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchAlgorithmConfiguration" + }, + "description": "Contains configuration options specific to the algorithm used during indexing or querying." + }, + "vectorizers": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchVectorizer" + }, + "description": "Contains configuration options on how to vectorize text vector queries." + }, + "compressions": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchCompressionConfiguration" + }, + "description": "Contains configuration options specific to the compression method used during indexing or querying." + } + }, + "description": "Contains configuration options related to vector search." + }, + "VectorSearchProfile": { + "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 vector search profile.", + "x-nullable": false + }, + "algorithm": { + "x-ms-client-name": "algorithmConfigurationName", + "type": "string", + "description": "The name of the vector search algorithm configuration that specifies the algorithm and optional parameters.", + "x-nullable": false + }, + "vectorizer": { + "type": "string", + "description": "The name of the kind of vectorization method being configured for use with vector search.", + "x-nullable": false + }, + "compression": { + "x-ms-client-name": "compressionConfigurationName", + "type": "string", + "description": "The name of the compression method configuration that specifies the compression method and optional parameters.", + "x-nullable": false + } + }, + "required": [ + "name", + "algorithm" + ], + "description": "Defines a combination of configurations to use with vector search." + }, + "VectorSearchAlgorithmConfiguration": { + "type": "object", + "discriminator": "kind", + "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": { + "$ref": "#/definitions/VectorSearchAlgorithmKind", + "description": "The name of the kind of algorithm being configured for use with vector search.", + "x-nullable": false + } + }, + "required": [ + "name", + "kind" + ], + "description": "Contains configuration options specific to the algorithm used during indexing or querying." + }, + "HnswVectorSearchAlgorithmConfiguration": { + "x-ms-client-name": "HnswAlgorithmConfiguration", + "type": "object", + "x-ms-discriminator-value": "hnsw", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchAlgorithmConfiguration" + } + ], + "properties": { + "hnswParameters": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/HnswParameters", + "description": "Contains the parameters specific to HNSW algorithm." + } + }, + "description": "Contains configuration options specific to the HNSW approximate nearest neighbors algorithm used during indexing and querying. The HNSW algorithm offers a tunable trade-off between search speed and accuracy." + }, + "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. At a certain point, 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 the HNSW algorithm." + }, + "ExhaustiveKnnVectorSearchAlgorithmConfiguration": { + "x-ms-client-name": "ExhaustiveKnnAlgorithmConfiguration", + "type": "object", + "x-ms-discriminator-value": "exhaustiveKnn", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchAlgorithmConfiguration" + } + ], + "properties": { + "exhaustiveKnnParameters": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/ExhaustiveKnnParameters", + "description": "Contains the parameters specific to exhaustive KNN algorithm." + } + }, + "description": "Contains configuration options specific to the exhaustive KNN algorithm used during querying, which will perform brute-force search across the entire vector index." + }, + "ExhaustiveKnnParameters": { + "type": "object", + "properties": { + "metric": { + "$ref": "#/definitions/VectorSearchAlgorithmMetric", + "x-nullable": true, + "description": "The similarity metric to use for vector comparisons." + } + }, + "description": "Contains the parameters specific to exhaustive KNN 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." + }, + "VectorSearchAlgorithmKind": { + "type": "string", + "enum": [ + "hnsw", + "exhaustiveKnn" + ], + "x-ms-enum": { + "name": "VectorSearchAlgorithmKind", + "modelAsString": true, + "values": [ + { + "value": "hnsw", + "name": "Hnsw", + "description": "HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm." + }, + { + "value": "exhaustiveKnn", + "name": "ExhaustiveKnn", + "description": "Exhaustive KNN algorithm which will perform brute-force search." + } + ] + }, + "description": "The algorithm used for indexing and querying." + }, + "VectorSearchCompressionConfiguration": { + "type": "object", + "discriminator": "kind", + "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": { + "$ref": "#/definitions/VectorSearchCompressionKind", + "description": "The name of the kind of compression method being configured for use with vector search.", + "x-nullable": false + }, + "rerankWithOriginalVectors": { + "type": "boolean", + "default": true, + "description": "If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency." + }, + "defaultOversampling": { + "type": "number", + "format": "double", + "description": "Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency.", + "x-nullable": true + } + }, + "required": [ + "name", + "kind" + ], + "description": "Contains configuration options specific to the compression method used during indexing or querying." + }, + "ScalarQuantizationVectorSearchCompressionConfiguration": { + "x-ms-client-name": "ScalarQuantizationCompressionConfiguration", + "type": "object", + "x-ms-discriminator-value": "scalarQuantization", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchCompressionConfiguration" + } + ], + "properties": { + "scalarQuantizationParameters": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/ScalarQuantizationParameters", + "description": "Contains the parameters specific to Scalar Quantization." + } + }, + "description": "Contains configuration options specific to the scalar quantization compression method used during indexing and querying." + }, + "ScalarQuantizationParameters": { + "type": "object", + "properties": { + "quantizedDataType": { + "$ref": "#/definitions/VectorSearchCompressionTargetDataType", + "x-nullable": true, + "description": "The quantized data type of compressed vector values." + } + }, + "description": "Contains the parameters specific to Scalar Quantization." + }, + "VectorSearchCompressionTargetDataType": { + "type": "string", + "enum": [ + "int8" + ], + "x-ms-enum": { + "name": "VectorSearchCompressionTargetDataType", + "modelAsString": true, + "values": [ + { + "value": "int8", + "name": "Int8" + } + ] + }, + "description": "The quantized data type of compressed vector values." + }, + "VectorSearchCompressionKind": { + "type": "string", + "enum": [ + "scalarQuantization" + ], + "x-ms-enum": { + "name": "VectorSearchCompressionKind", + "modelAsString": true, + "values": [ + { + "value": "scalarQuantization", + "name": "ScalarQuantization", + "description": "Scalar Quantization, a type of compression method. In scalar quantization, the original vectors values are compressed to a narrower type by discretizing and representing each component of a vector using a reduced set of quantized values, thereby reducing the overall data size." + } + ] + }, + "description": "The compression method used for indexing and querying." + }, + "VectorSearchVectorizer": { + "type": "object", + "discriminator": "kind", + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name to associate with this particular vectorization method.", + "x-nullable": false + }, + "kind": { + "$ref": "#/definitions/VectorSearchVectorizerKind", + "description": "The name of the kind of vectorization method being configured for use with vector search.", + "x-nullable": false + } + }, + "required": [ + "name", + "kind" + ], + "description": "Specifies the vectorization method to be used during query time." + }, + "AzureOpenAIVectorizer": { + "type": "object", + "x-ms-discriminator-value": "azureOpenAI", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchVectorizer" + } + ], + "properties": { + "azureOpenAIParameters": { + "x-ms-client-name": "AzureOpenAIParameters", + "$ref": "#/definitions/AzureOpenAIParameters", + "description": "Contains the parameters specific to Azure OpenAI embedding vectorization." + } + }, + "description": "Specifies the Azure OpenAI resource used to vectorize a query string." + }, + "AzureOpenAIParameters": { + "type": "object", + "properties": { + "resourceUri": { + "type": "string", + "format": "uri", + "description": "The resource URI of the Azure OpenAI resource." + }, + "deploymentId": { + "type": "string", + "description": "ID of the Azure OpenAI model deployment on the designated resource." + }, + "apiKey": { + "type": "string", + "description": "API key of the designated Azure OpenAI resource." + }, + "authIdentity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for outbound connections." + } + }, + "description": "Specifies the parameters for connecting to the Azure OpenAI resource." + }, + "CustomVectorizer": { + "type": "object", + "x-ms-discriminator-value": "customWebApi", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchVectorizer" + } + ], + "properties": { + "customWebApiParameters": { + "x-ms-client-name": "CustomWebApiParameters", + "$ref": "#/definitions/CustomWebApiParameters", + "description": "Specifies the properties of the user-defined vectorizer." + } + }, + "description": "Specifies a user-defined vectorizer for generating the vector embedding of a query string. Integration of an external vectorizer is achieved using the custom Web API interface of a skillset." + }, + "CustomWebApiParameters": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The URI of the Web API providing the vectorizer." + }, + "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." + }, + "authResourceId": { + "type": "string", + "x-nullable": true, + "description": "Applies to custom endpoints 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 vectorization 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." + } + }, + "description": "Specifies the properties for connecting to a user-defined vectorizer." + }, + "VectorSearchVectorizerKind": { + "type": "string", + "enum": [ + "azureOpenAI", + "customWebApi" + ], + "x-ms-enum": { + "name": "VectorSearchVectorizerKind", + "modelAsString": true, + "values": [ + { + "value": "azureOpenAI", + "name": "AzureOpenAI", + "description": "Generate embeddings using an Azure OpenAI resource at query time." + }, + { + "value": "customWebApi", + "name": "CustomWebApi", + "description": "Generate embeddings using a custom web endpoint at query time." + } + ] + }, + "description": "The vectorization method to be used during query time." + }, + "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 `` (with brackets) if you don't want the connection string updated. Set to `` if you want to remove the connection string value from the datasource." + } + }, + "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": "A URI fragment specifying the type of 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": "A URI fragment specifying the type of 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": "A URI fragment specifying the type of 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." + } + } + }, + "NativeBlobSoftDeleteDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy utilizing Azure Blob Storage's native soft delete feature for deletion detection.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ] + }, + "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. Once you have encrypted your data source definition, it will always remain encrypted. The search service 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." + }, + { + "value": "jsonLines", + "name": "JsonLines", + "description": "Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents." + } + ] + }, + "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 the search service 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. Once you have encrypted your indexer definition, it will always remain encrypted. The search service 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, false for vector fields, and null for complex fields." + }, + "stored": { + "type": "boolean", + "description": "An immutable value indicating whether the field will be persisted separately on disk to be returned in a search result. You can disable this option if you don't plan to return the field contents in a search response to save on storage overhead. This can only be set during index creation and only for vector fields. This property cannot be changed for existing fields or set as false for new fields. If this property is set as false, the property 'retrievable' must also be set to false. This property must be true or unset for key fields, for new fields, and for non-vector fields, and it must be null for complex fields. Disabling this property will reduce index storage requirements. The default is true for vector 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 to accommodate additional tokenized versions 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, the search engine 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": { + "x-ms-client-name": "vectorSearchDimensions", + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 2, + "maximum": 2048, + "description": "The dimensionality of the vector field." + }, + "vectorSearchProfile": { + "x-ms-client-name": "vectorSearchProfileName", + "type": "string", + "x-nullable": true, + "description": "The name of the vector search profile that specifies the algorithm and vectorizer to use when 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. Once you have encrypted your data, it will always remain encrypted. The search service 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": "SemanticSearch", + "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." + }, + "vectorIndexSize": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The amount of memory in bytes consumed by vectors in the index." + } + }, + "required": [ + "documentCount", + "storageSize", + "vectorIndexSize" + ], + "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 the Azure AI service to be used when running skills." + }, + "knowledgeStore": { + "$ref": "#/definitions/SearchIndexerKnowledgeStore", + "description": "Definition of additional projections to Azure blob, table, or files, of enriched data." + }, + "indexProjections": { + "$ref": "#/definitions/SearchIndexerIndexProjections", + "description": "Definition of additional projections to secondary search index(es)." + }, + "@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. Once you have encrypted your skillset definition, it will always remain encrypted. The search service 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": "A URI fragment specifying the type of Azure AI service resource attached to a skillset." + }, + "description": { + "type": "string", + "description": "Description of the Azure AI service resource attached to a skillset." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for describing any Azure AI 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." + }, + "parameters": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreParameters" + } + }, + "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." + }, + "SearchIndexerKnowledgeStoreParameters": { + "type": "object", + "properties": { + "synthesizeGeneratedKeyName": { + "type": "boolean", + "default": false, + "description": "Whether or not projections should synthesize a generated key name if one isn't already present." + } + }, + "additionalProperties": true, + "description": "A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type." + }, + "SearchIndexerIndexProjections": { + "type": "object", + "properties": { + "selectors": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerIndexProjectionSelector" + }, + "description": "A list of projections to be performed to secondary search indexes." + }, + "parameters": { + "$ref": "#/definitions/SearchIndexerIndexProjectionsParameters" + } + }, + "required": [ + "selectors" + ], + "description": "Definition of additional projections to secondary search indexes." + }, + "SearchIndexerIndexProjectionSelector": { + "type": "object", + "properties": { + "targetIndexName": { + "type": "string", + "description": "Name of the search index to project to. Must have a key field with the 'keyword' analyzer set." + }, + "parentKeyFieldName": { + "type": "string", + "description": "Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field." + }, + "sourceContext": { + "type": "string", + "description": "Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents." + }, + "mappings": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Mappings for the projection, or which source should be mapped to which field in the target index." + } + }, + "required": [ + "targetIndexName", + "parentKeyFieldName", + "sourceContext", + "mappings" + ], + "description": "Description for what data to store in the designated search index." + }, + "SearchIndexerIndexProjectionsParameters": { + "type": "object", + "properties": { + "projectionMode": { + "$ref": "#/definitions/IndexProjectionMode", + "description": "Defines behavior of the index projections in relation to the rest of the indexer." + } + }, + "additionalProperties": true, + "description": "A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type." + }, + "IndexProjectionMode": { + "type": "string", + "enum": [ + "skipIndexingParentDocuments", + "includeIndexingParentDocuments" + ], + "x-ms-enum": { + "name": "IndexProjectionMode", + "modelAsString": true, + "values": [ + { + "value": "skipIndexingParentDocuments", + "name": "SkipIndexingParentDocuments", + "description": "The source document will be skipped from writing into the indexer's target index." + }, + { + "value": "includeIndexingParentDocuments", + "name": "IncludeIndexingParentDocuments", + "description": "The source document will be written into the indexer's target index. This is the default pattern." + } + ] + }, + "description": "Defines behavior of the index projections in relation to the rest of the indexer." + }, + "DefaultCognitiveServicesAccount": { + "description": "An empty object that represents the default Azure AI service resource for a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DefaultCognitiveServices", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ] + }, + "CognitiveServicesAccountKey": { + "description": "The multi-region account key of an Azure AI service resource that's 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 Azure AI service resource attached to a skillset." + } + }, + "required": [ + "key" + ] + }, + "SearchIndexerSkill": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of 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 API. 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": { + "x-ms-client-name": "mask", + "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." + }, + "pageOverlapLength": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Only applicable when textSplitMode is set to 'pages'. If specified, n+1th chunk will start with this number of characters/tokens from the end of the nth chunk." + }, + "maximumPagesToTake": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Only applicable when textSplitMode is set to 'pages'. If specified, the SplitSkill will discontinue splitting after processing the first 'maximumPagesToTake' pages, in order to improve performance when only a few initial pages are needed from each document." + } + }, + "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, + "x-ms-format": "arm-id", + "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", + "format": "uri", + "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." + }, + "AzureOpenAIEmbeddingSkill": { + "x-ms-client-name": "AzureOpenAIEmbeddingSkill", + "x-ms-discriminator-value": "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "type": "object", + "properties": { + "resourceUri": { + "type": "string", + "format": "uri", + "description": "The resource URI for your Azure OpenAI resource." + }, + "deploymentId": { + "type": "string", + "description": "ID of your Azure OpenAI model deployment on the designated resource." + }, + "apiKey": { + "type": "string", + "description": "API key for the designated Azure OpenAI resource." + }, + "authIdentity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for outbound connections." + } + }, + "description": "Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource." + }, + "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": [ + "am", + "bs", + "cs", + "da", + "de", + "en", + "es", + "et", + "fi", + "fr", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "ja", + "ko", + "lv", + "nb", + "nl", + "pl", + "pt", + "pt-br", + "ru", + "sk", + "sl", + "sr", + "sv", + "tr", + "ur", + "zh" + ], + "x-ms-enum": { + "name": "SplitSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "am", + "description": "Amharic" + }, + { + "value": "bs", + "description": "Bosnian" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "he", + "description": "Hebrew" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "is", + "description": "Icelandic" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "lv", + "description": "Latvian" + }, + { + "value": "nb", + "description": "Norwegian" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-br", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "sr", + "description": "Serbian" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "ur", + "description": "Urdu" + }, + { + "value": "zh", + "description": "Chinese (Simplified)" + } + ] + }, + "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. Once you have encrypted your data, it will always remain encrypted. The search service 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, 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." + }, + "vectorIndexSize": { + "x-ms-client-name": "vectorIndexSizeCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total memory consumption of all vector indexes within the service, in bytes." + } + }, + "required": [ + "aliasesCount", + "documentCount", + "indexesCount", + "indexersCount", + "dataSourcesCount", + "storageSize", + "synonymMaps", + "skillsetCount", + "vectorIndexSize" + ], + "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." + } + }, + "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 7f8dcaeb43a8..cff12a68c20c 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-2023-10-01-preview +tag: package-2024-03-01-preview directive: - where: @@ -129,10 +129,6 @@ directive: - $.definitions.SearchDocumentsResult.properties.value suppress: - RequiredReadOnlyProperties - - where: - - $.definitions.SearchError.properties.message - suppress: - - RequiredReadOnlyProperties - where: - $.definitions.SearchIndexerError.properties.errorMessage suppress: @@ -171,6 +167,34 @@ directive: - RequiredReadOnlyProperties ``` +### Tag: package-2024-03-01-preview + +These settings apply only when `--tag=package-2024-03-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-03-01-preview' +input-file: +- preview/2024-03-01-Preview/searchservice.json +- preview/2024-03-01-Preview/searchindex.json +``` + +### Tag: package-2024-03-searchservice-preview + +These settings apply only when `--tag=package-2024-03-searchservice-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-03-searchservice-preview' +input-file: +- preview/2024-03-01-Preview/searchservice.json +``` + +### Tag: package-2024-03-searchindex-preview + +These settings apply only when `--tag=package-2024-03-searchindex-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-03-searchindex-preview' +input-file: +- preview/2024-03-01-Preview/searchindex.json +``` + ### Tag: package-2023-10-01-preview These settings apply only when `--tag=package-2023-10-01-preview` is specified on the command line. @@ -859,6 +883,8 @@ require: $(this-folder)/../../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/preview/2024-03-01-Preview/searchservice.json + - $(this-folder)/preview/2024-03-01-Preview/searchindex.json - $(this-folder)/preview/2023-10-01-Preview/searchservice.json - $(this-folder)/preview/2023-10-01-Preview/searchindex.json - $(this-folder)/preview/2023-07-01-Preview/searchservice.json diff --git a/specification/security/resource-manager/readme.python.md b/specification/security/resource-manager/readme.python.md index 222fc9002ac4..25f3ccefb4da 100644 --- a/specification/security/resource-manager/readme.python.md +++ b/specification/security/resource-manager/readme.python.md @@ -40,12 +40,7 @@ default-api-version: "2023-01-01" multiapi: true batch: - tag: package-2023-11-15 - - tag: package-preview-2023-10 - - tag: package-preview-2023-09 - - tag: package-2023-05 - - tag: package-preview-2023-05 - tag: package-preview-2023-03-only - - tag: package-preview-2023-02-15-only - tag: package-preview-2023-02-only - tag: package-preview-2023-01-only - tag: package-2023-01 diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/AlertRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/AlertRules.json new file mode 100644 index 000000000000..ec06a237d972 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/AlertRules.json @@ -0,0 +1,2600 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-12-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" + }, + "subTechniques": { + "description": "The sub-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" + }, + "subTechniques": { + "description": "The sub-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" + }, + "subTechniques": { + "description": "The sub-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" + }, + "subTechniques": { + "description": "The sub-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" + }, + "subTechniques": { + "description": "The sub-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" + }, + "subTechniques": { + "description": "The sub-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" + }, + "subTechniques": { + "description": "The sub-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", + "SubTechniques" + ], + "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" + }, + { + "description": "SubTechniques alert property", + "value": "SubTechniques" + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/AutomationRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/AutomationRules.json new file mode 100644 index 000000000000..9b10bd7dd179 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/BillingStatistics.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/BillingStatistics.json new file mode 100644 index 000000000000..de20d9c1bc31 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/Bookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Bookmarks.json new file mode 100644 index 000000000000..9ab3f67c91be --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/ContentPackages.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentPackages.json new file mode 100644 index 000000000000..959a2a1e5ce6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentPackages.json @@ -0,0 +1,319 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-12-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/ODataSearch" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataCount" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkip" + }, + { + "$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", + "allOf": [ + { + "$ref": "./common/ContentCommonTypes.json#/definitions/packageBaseProperties" + } + ], + "required": [ + "contentId", + "contentProductId", + "contentKind", + "version", + "displayName" + ], + "type": "object" + } + }, + "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-12-01-preview/ContentProductPackages.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentProductPackages.json new file mode 100644 index 000000000000..960d63b74188 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentProductPackages.json @@ -0,0 +1,232 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-12-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.\nExpandable properties:\n- properties/installed\n- properties/packagedContent", + "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/productPackageList" + } + }, + "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/productPackageModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "productPackageList": { + "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/productPackageModel" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "productPackageModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Package in Azure Security Insights.", + "properties": { + "properties": { + "description": "package properties", + "$ref": "#/definitions/productPackageProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "productPackageProperties": { + "description": "Describes package properties", + "allOf": [ + { + "$ref": "./common/ContentCommonTypes.json#/definitions/packageBaseProperties", + "description": "The content id of the package" + }, + { + "$ref": "#/definitions/productPackageAdditionalProperties", + "description": "The package kind" + } + ], + "required": [ + "contentId", + "contentKind", + "version", + "displayName" + ], + "type": "object" + }, + "productPackageAdditionalProperties": { + "description": "product package additional properties", + "properties": { + "installedVersion": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion", + "description": "The version of the installed package, null or absent means not installed." + }, + "metadataResourceId": { + "description": "The metadata resource id.", + "type": "string", + "format": "arm-id" + }, + "packagedContent": { + "$ref": "#/definitions/packagedContent", + "description": "The json of the ARM template to deploy. Expandable." + } + }, + "type": "object" + }, + "packagedContent": { + "type": "object", + "description": "The json of the ARM template to deploy" + } + }, + "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-12-01-preview/ContentProductTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentProductTemplates.json new file mode 100644 index 000000000000..8f0da46c1169 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentProductTemplates.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-12-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/ODataSearch" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataCount" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkip" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/productTemplateList" + } + }, + "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/productTemplateModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "productTemplateList": { + "description": "List of all the template.", + "type": "object", + "properties": { + "value": { + "description": "Array of templates.", + "items": { + "$ref": "#/definitions/productTemplateModel" + }, + "type": "array" + }, + "nextLink": { + "description": "URL to fetch the next page of template.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "productTemplateModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Template resource definition.", + "properties": { + "properties": { + "description": "template properties", + "$ref": "#/definitions/productTemplateProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "productTemplateProperties": { + "allOf": [ + { + "$ref": "./common/ContentCommonTypes.json#/definitions/templateBaseProperties" + }, + { + "$ref": "#/definitions/productTemplateAdditionalProperties" + } + ], + "description": "Template property bag.", + "required": [ + "contentId", + "version", + "displayName", + "contentKind", + "source" + ] + }, + "productTemplateAdditionalProperties": { + "description": "additional properties of product template.", + "type": "object", + "properties": { + "packagedContent": { + "type": "object", + "description": "The json of the ARM template 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-12-01-preview/ContentTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentTemplates.json new file mode 100644 index 000000000000..5541b1dc104d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentTemplates.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-12-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.\nExpandable properties:\n- properties/mainTemplate\n- properties/dependantTemplates", + "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/ODataExpand" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSearch" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataCount" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkip" + }, + { + "$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.\nExpandable properties:\n- properties/mainTemplate\n- properties/dependantTemplates", + "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": { + "allOf": [ + { + "$ref": "./common/ContentCommonTypes.json#/definitions/templateBaseProperties" + }, + { + "$ref": "#/definitions/templateAdditionalProperties" + } + ], + "description": "Template property bag.", + "required": [ + "contentId", + "version", + "displayName", + "contentKind", + "source", + "packageId", + "packageVersion", + "contentProductId" + ], + "type": "object" + }, + "templateAdditionalProperties": { + "description": "additional properties of product template.", + "type": "object", + "properties": { + "mainTemplate": { + "$ref": "#/definitions/mainTemplate", + "description": "The JSON of the ARM template to deploy active content. Expandable." + }, + "dependantTemplates": { + "type": "array", + "items": { + "$ref": "#/definitions/templateProperties" + }, + "description": "Dependant templates. Expandable.", + "readOnly": true, + "x-ms-identifiers": [ + "contentId" + ] + } + } + }, + "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-12-01-preview/Enrichment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Enrichment.json new file mode 100644 index 000000000000..4d83e9b07fda --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/Entities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Entities.json new file mode 100644 index 000000000000..4d9c7431e767 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/EntityQueries.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/EntityQueries.json new file mode 100644 index 000000000000..5a4205d88405 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/EntityQueryTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/EntityQueryTemplates.json new file mode 100644 index 000000000000..fa7c308efb80 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/FileImports.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/FileImports.json new file mode 100644 index 000000000000..a405f40b7ae4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/Hunts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Hunts.json new file mode 100644 index 000000000000..352d25e59913 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Hunts.json @@ -0,0 +1,994 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-12-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", + "Backlog", + "Approved" + ], + "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-12-01-preview/Incidents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Incidents.json new file mode 100644 index 000000000000..d7e72e8e4cf4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/Metadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Metadata.json new file mode 100644 index 000000000000..409eb60d256d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Metadata.json @@ -0,0 +1,774 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-12-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" + } + } + }, + "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": "./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": "#/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": "./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": "#/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-12-01-preview/OfficeConsents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/OfficeConsents.json new file mode 100644 index 000000000000..db93ff99ef00 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/OnboardingStates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/OnboardingStates.json new file mode 100644 index 000000000000..41447872f608 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/Recommendations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Recommendations.json new file mode 100644 index 000000000000..95040cbec179 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/SecurityMLAnalyticsSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/SecurityMLAnalyticsSettings.json new file mode 100644 index 000000000000..1b3b6cd57ba5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/Settings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Settings.json new file mode 100644 index 000000000000..450a601974e3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/SourceControls.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/SourceControls.json new file mode 100644 index 000000000000..674ee3f691fb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/SourceControls.json @@ -0,0 +1,1005 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-12-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/RepositoryAccess" + } + ], + "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" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates 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": "Updated", + "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" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols/{sourceControlId}/delete": { + "post": { + "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" + }, + { + "$ref": "#/parameters/RepositoryAccess" + } + ], + "responses": { + "200": { + "description": "Source control deleted.", + "schema": { + "$ref": "#/definitions/Warning" + } + }, + "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" + }, + "installationId": { + "description": "The installation id of the repository.", + "type": "integer", + "format": "int64" + }, + "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.", + "required": [ + "properties" + ], + "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", + "readOnly": true + }, + "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" + }, + "servicePrincipal": { + "description": "Service principal metadata.", + "$ref": "#/definitions/ServicePrincipal" + }, + "repositoryAccess": { + "description": "Repository access credentials. This is write-only object and it never returns back to a user.", + "x-ms-mutability": [ + "create", + "update" + ], + "$ref": "#/definitions/RepositoryAccess" + }, + "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" + }, + "pullRequest": { + "description": "Information regarding the pull request of the source control.", + "$ref": "#/definitions/PullRequest" + } + }, + "required": [ + "displayName", + "repoType", + "contentTypes", + "repository" + ], + "type": "object" + }, + "RepositoryAccess": { + "type": "object", + "description": "Credentials to access repository.", + "required": [ + "kind" + ], + "properties": { + "kind": { + "description": "The kind of repository access credentials", + "$ref": "#/definitions/RepositoryAccessKind" + }, + "code": { + "x-ms-secret": true, + "type": "string", + "description": "OAuth Code. Required when `kind` is `OAuth`" + }, + "state": { + "x-ms-secret": true, + "type": "string", + "description": "OAuth State. Required when `kind` is `OAuth`" + }, + "clientId": { + "type": "string", + "description": "OAuth ClientId. Required when `kind` is `OAuth`" + }, + "token": { + "x-ms-secret": true, + "type": "string", + "description": "Personal Access Token. Required when `kind` is `PAT`" + }, + "installationId": { + "type": "string", + "description": "Application installation ID. Required when `kind` is `App`. Supported by `GitHub` only." + } + } + }, + "RepositoryAccessObject": { + "description": "Credentials to access repository.", + "type": "object", + "required": [ + "repositoryAccess" + ], + "properties": { + "repositoryAccess": { + "description": "RepositoryAccess properties", + "$ref": "#/definitions/RepositoryAccess", + "x-ms-client-flatten": true + } + } + }, + "RepositoryAccessProperties": { + "description": "Credentials to access repository.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "RepositoryAccess properties", + "$ref": "#/definitions/RepositoryAccessObject", + "x-ms-client-flatten": true + } + } + }, + "Repository": { + "type": "object", + "required": [ + "url", + "branch" + ], + "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", + "readOnly": true + } + } + }, + "ServicePrincipal": { + "type": "object", + "description": "Service principal metadata.", + "properties": { + "id": { + "description": "Id of service principal.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Tenant id of service principal.", + "type": "string", + "readOnly": true + }, + "appId": { + "description": "App id of service principal.", + "type": "string", + "readOnly": true + }, + "credentialsExpireOn": { + "format": "date-time", + "description": "Expiration time of service principal credentials.", + "type": "string" + } + } + }, + "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", + "readOnly": true + }, + "webhookUrl": { + "description": "URL that gets invoked by the webhook.", + "type": "string", + "readOnly": true + }, + "webhookSecretUpdateTime": { + "format": "date-time", + "description": "Time when the webhook secret was updated.", + "type": "string", + "readOnly": true + }, + "rotateWebhookSecret": { + "description": "A flag to instruct the backend service to rotate webhook secret.", + "type": "boolean" + } + } + }, + "GitHubResourceInfo": { + "readOnly": true, + "description": "Resources created in GitHub repository.", + "type": "object", + "properties": { + "appInstallationId": { + "description": "GitHub application installation id.", + "type": "string" + } + } + }, + "AzureDevOpsResourceInfo": { + "readOnly": true, + "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": { + "readOnly": true, + "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" + } + } + }, + "ContentType": { + "description": "The content type of a source control path.", + "enum": [ + "AnalyticRule", + "AutomationRule", + "HuntingQuery", + "Parser", + "Playbook", + "Workbook" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ContentType", + "values": [ + { + "value": "AnalyticRule" + }, + { + "value": "AutomationRule" + }, + { + "value": "HuntingQuery" + }, + { + "value": "Parser" + }, + { + "value": "Playbook" + }, + { + "value": "Workbook" + } + ] + } + }, + "RepoType": { + "description": "The type of repository.", + "enum": [ + "Github", + "AzureDevOps" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RepoType", + "values": [ + { + "value": "Github" + }, + { + "value": "AzureDevOps" + } + ] + } + }, + "RepositoryAccessKind": { + "description": "The kind of repository access credentials", + "enum": [ + "OAuth", + "PAT", + "App" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RepositoryAccessKind", + "values": [ + { + "value": "OAuth" + }, + { + "value": "PAT" + }, + { + "value": "App" + } + ] + } + }, + "Version": { + "readOnly": true, + "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" + } + ] + } + }, + "PullRequest": { + "readOnly": true, + "description": "Information regarding pull request for protected branches.", + "type": "object", + "properties": { + "url": { + "description": "URL of pull request", + "type": "string", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/PullRequestState", + "description": "State of the pull request", + "type": "object", + "readOnly": true + } + } + }, + "PullRequestState": { + "description": "Status of the pull request.", + "enum": [ + "Open", + "Closed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "state", + "values": [ + { + "value": "Open" + }, + { + "value": "Closed" + } + ] + } + }, + "Warning": { + "description": "Warning response structure.", + "properties": { + "warning": { + "$ref": "#/definitions/WarningBody", + "description": "Warning data." + } + }, + "type": "object" + }, + "WarningBody": { + "readOnly": true, + "description": "Warning details.", + "properties": { + "code": { + "description": "An identifier for the warning. Codes are invariant and are intended to be consumed programmatically.", + "readOnly": true, + "type": "object", + "$ref": "#/definitions/WarningCode" + }, + "message": { + "description": "A message describing the warning, intended to be suitable for display in a user interface.", + "readOnly": true, + "type": "string" + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/WarningBody" + }, + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "WarningCode": { + "readOnly": true, + "description": "The type of repository.", + "enum": [ + "SourceControlWarning_DeleteServicePrincipal", + "SourceControlWarning_DeletePipelineFromAzureDevOps", + "SourceControlWarning_DeleteWorkflowAndSecretFromGitHub", + "SourceControlWarning_DeleteRoleAssignment", + "SourceControl_DeletedWithWarnings" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "WarningCode", + "values": [ + { + "value": "SourceControlWarning_DeleteServicePrincipal" + }, + { + "value": "SourceControlWarning_DeletePipelineFromAzureDevOps" + }, + { + "value": "SourceControlWarning_DeleteWorkflowAndSecretFromGitHub" + }, + { + "value": "SourceControlWarning_DeleteRoleAssignment" + }, + { + "value": "SourceControl_DeletedWithWarnings" + } + ] + } + } + }, + "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" + }, + "RepositoryAccess": { + "description": "The repository access credentials.", + "in": "body", + "name": "repositoryAccess", + "required": true, + "schema": { + "required": [ + "repositoryAccess" + ], + "$ref": "#/definitions/RepositoryAccessProperties" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/ThreatIntelligence.json new file mode 100644 index 000000000000..4fc6c7ec4b2e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/TriggeredAnalyticsRuleRuns.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/TriggeredAnalyticsRuleRuns.json new file mode 100644 index 000000000000..92960cf1a6d6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/Watchlists.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/Watchlists.json new file mode 100644 index 000000000000..76f3ce159d0b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/WorkspaceManagerAssignments.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/WorkspaceManagerAssignments.json new file mode 100644 index 000000000000..ed476563f883 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/WorkspaceManagerConfigurations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/WorkspaceManagerConfigurations.json new file mode 100644 index 000000000000..ea44ea367e60 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/WorkspaceManagerGroups.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/WorkspaceManagerGroups.json new file mode 100644 index 000000000000..4d22016be357 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/WorkspaceManagerMembers.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/WorkspaceManagerMembers.json new file mode 100644 index 000000000000..dd7f59ee0f3f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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": { + "targetWorkspaceResourceId": { + "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": [ + "targetWorkspaceResourceId", + "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-12-01-preview/common/AlertTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/AlertTypes.json new file mode 100644 index 000000000000..0d5cc633e53a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/AlertTypes.json @@ -0,0 +1,81 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-12-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-12-01-preview/common/ContentCommonTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/ContentCommonTypes.json new file mode 100644 index 000000000000..32f5d4ca8b98 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/ContentCommonTypes.json @@ -0,0 +1,646 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-12-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" + ], + "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" + } + ] + } + } + }, + "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" + } + }, + "templateBaseProperties": { + "description": "Template property bag.", + "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" + }, + "contentProductId": { + "type": "string", + "description": "Unique ID for the content. It should be generated based on the contentId of the package, contentId of the template, contentKind of the template and the contentVersion of the template" + }, + "packageVersion": { + "$ref": "#/definitions/metadataVersion", + "description": "Version of the package. 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" + }, + "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 metadata best practices. Can also be any string, but then we cannot guarantee any version checks" + }, + "displayName": { + "$ref": "#/definitions/metadataDisplayName", + "description": "The display name of the template" + }, + "contentKind": { + "$ref": "#/definitions/metadataKind", + "description": "The kind of content the template 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 template - 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 item" + }, + "providers": { + "$ref": "#/definitions/metadataProviders", + "description": "Providers for the content item" + }, + "firstPublishDate": { + "$ref": "#/definitions/metadataFirstPublishDate", + "description": "first publish date content item" + }, + "lastPublishDate": { + "$ref": "#/definitions/metadataLastPublishDate", + "description": "last publish date for the 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 content metadata" + }, + "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" + }, + "packageId": { + "$ref": "#/definitions/metadataContentId", + "description": "the package Id contains this template" + }, + "packageKind": { + "$ref": "#/definitions/metadataPackageKind", + "description": "the packageKind of the package contains this template" + }, + "packageName": { + "$ref": "#/definitions/metadataDisplayName", + "description": "the name of the package contains this template" + }, + "isDeprecated": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this template is deprecated", + "readOnly": true + } + } + }, + "packageBaseProperties": { + "description": "Describes package properties", + "properties": { + "contentId": { + "$ref": "#/definitions/metadataContentId", + "description": "The content id of the package" + }, + "contentProductId": { + "type": "string", + "description": "Unique ID for the content. It should be generated based on the contentId, contentKind and the contentVersion of the package" + }, + "contentKind": { + "$ref": "#/definitions/metadataPackageKind", + "description": "The package kind" + }, + "contentSchemaVersion": { + "$ref": "#/definitions/metadataVersion", + "description": "The version of the content schema." + }, + "isNew": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this is a newly published package." + }, + "isPreview": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this package is in preview." + }, + "isFeatured": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this package is among the featured list." + }, + "isDeprecated": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this template is deprecated" + }, + "version": { + "$ref": "#/definitions/metadataVersion", + "description": "the latest version number of the package" + }, + "displayName": { + "$ref": "#/definitions/metadataDisplayName", + "description": "The display name of the package" + }, + "description": { + "description": "The description of the package", + "type": "string" + }, + "publisherDisplayName": { + "$ref": "#/definitions/metadataDisplayName", + "description": "The publisher display name of the package" + }, + "source": { + "$ref": "#/definitions/metadataSource", + "description": "The source of the package" + }, + "author": { + "$ref": "#/definitions/metadataAuthor", + "description": "The author of the package" + }, + "support": { + "$ref": "#/definitions/metadataSupport", + "description": "The support tier of the package" + }, + "dependencies": { + "$ref": "#/definitions/metadataDependencies", + "description": "The support tier of the package" + }, + "providers": { + "$ref": "#/definitions/metadataProviders", + "description": "Providers for the package item" + }, + "firstPublishDate": { + "$ref": "#/definitions/metadataFirstPublishDate", + "description": "first publish date package item" + }, + "lastPublishDate": { + "$ref": "#/definitions/metadataLastPublishDate", + "description": "last publish date for the package item" + }, + "categories": { + "$ref": "#/definitions/metadataCategories", + "description": "The categories of the package" + }, + "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" + }, + "icon": { + "$ref": "#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the content metadata" + } + }, + "type": "object" + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/EntityTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/EntityTypes.json new file mode 100644 index 000000000000..1be342d1b045 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/EntityTypes.json @@ -0,0 +1,2550 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-12-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-12-01-preview/common/IncidentTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/IncidentTypes.json new file mode 100644 index 000000000000..826ebad1b644 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/IncidentTypes.json @@ -0,0 +1,246 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-12-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-12-01-preview/common/RelationTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/RelationTypes.json new file mode 100644 index 000000000000..7a2e97d057bf --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/RelationTypes.json @@ -0,0 +1,95 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-12-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-12-01-preview/common/ThreatIntelligenceTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/ThreatIntelligenceTypes.json new file mode 100644 index 000000000000..c9e769f9ee2d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/common/ThreatIntelligenceTypes.json @@ -0,0 +1,48 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-12-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-12-01-preview/dataConnectorDefinitions.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/dataConnectorDefinitions.json new file mode 100644 index 000000000000..c8c487646d2d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/dataConnectorDefinitions.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-12-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/dataConnectorDefinitions": { + "get": { + "x-ms-examples": { + "Get all data connector definitions.": { + "$ref": "./examples/dataConnectorDefinitions/GetDataConnectorDefinitions.json" + } + }, + "tags": [ + "ConnectorDefinitions" + ], + "description": "Gets all data connector definitions.", + "operationId": "DataConnectorDefinitions_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": "Success", + "schema": { + "$ref": "#/definitions/DataConnectorDefinitionArmCollectionWrapper" + } + }, + "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/dataConnectorDefinitions/{dataConnectorDefinitionName}": { + "get": { + "x-ms-examples": { + "Get customize data connector definition": { + "$ref": "./examples/dataConnectorDefinitions/GetCustomizableDataConnectoeDefinitionById.json" + } + }, + "tags": [ + "ConnectorDefinitions" + ], + "description": "Gets a data connector definition.", + "operationId": "DataConnectorDefinitions_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" + }, + { + "$ref": "#/parameters/dataConnectorDefinitionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataConnectorDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create data connector definition": { + "$ref": "./examples/dataConnectorDefinitions/CreateCustomizableDataConnectorDefinition.json" + } + }, + "tags": [ + "ConnectorDefinitions" + ], + "description": "Creates or updates the data connector definition.", + "operationId": "DataConnectorDefinitions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "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": "#/parameters/dataConnectorDefinitionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "connectorDefinitionInput", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnectorDefinition" + }, + "description": "The data connector definition", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/DataConnectorDefinition" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataConnectorDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete data connector definition": { + "$ref": "./examples/dataConnectorDefinitions/DeleteDataConnectorDefinitionById.json" + } + }, + "tags": [ + "ConnectorDefinitions" + ], + "description": "Delete the data connector definition.", + "operationId": "DataConnectorDefinitions_Delete", + "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": "#/parameters/dataConnectorDefinitionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ConnectorDefinitionsAvailability": { + "description": "The exposure status of the connector to the customers.", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/AvailabilityStatus" + }, + "isPreview": { + "description": "Gets or sets a value indicating whether the connector is preview.", + "type": "boolean" + } + } + }, + "AvailabilityStatus": { + "description": "The exposure status of the connector to the customers. Available values are 0-4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal).", + "type": "integer", + "format": "int32" + }, + "ConnectivityCriterion": { + "description": "The criteria by which we determine whether the connector is connected or not.\r\nFor Example, use a KQL query to check if the expected data type is flowing).", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "Gets or sets the type of connectivity.", + "type": "string" + }, + "value": { + "description": "Gets or sets the queries for checking connectivity.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ConnectorDataType": { + "description": "The data type which is created by the connector,\r\nincluding a query indicated when was the last time that data type was received in the workspace.", + "required": [ + "lastDataReceivedQuery", + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the name of the data type to show in the graph.", + "type": "string" + }, + "lastDataReceivedQuery": { + "description": "Gets or sets the query to indicate when relevant data was last received in the workspace.", + "type": "string" + } + } + }, + "DataConnectorDefinition": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "required": [ + "kind" + ], + "description": "An Azure resource, which encapsulate the entire info requires to display a data connector page in Azure portal,\r\nand the info required to define data connections.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/DataConnectorDefinitionKind", + "description": "The data connector kind", + "type": "string" + } + }, + "discriminator": "kind" + }, + "DataConnectorDefinitionKind": { + "description": "The kind of the data connector definitions", + "enum": [ + "Customizable" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorDefinitionKind", + "values": [ + { + "value": "Customizable" + } + ] + } + }, + "DataConnectorDefinitionArmCollectionWrapper": { + "type": "object", + "description": "Encapsulate the data connector definition object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataConnectorDefinition" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "CustomizableConnectorDefinition": { + "description": "Connector definition for kind 'Customizable'.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDefinition" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomizableConnectorDefinitionProperties", + "description": "Customizable properties.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "Customizable" + }, + "CustomizableConnectorDefinitionProperties": { + "description": "The UiConfig for 'Customizable' connector definition kind.", + "type": "object", + "required": [ + "connectorUiConfig" + ], + "properties": { + "createdTimeUtc": { + "format": "date-time", + "description": "Gets or sets the connector definition created date in UTC format.", + "type": "string" + }, + "lastModifiedUtc": { + "format": "date-time", + "description": "Gets or sets the connector definition last modified date in UTC format.", + "type": "string" + }, + "connectorUiConfig": { + "$ref": "#/definitions/CustomizableConnectorUiConfig" + }, + "connectionsConfig": { + "$ref": "#/definitions/CustomizableConnectionsConfig" + } + } + }, + "CustomizableConnectionsConfig": { + "description": "The UiConfig for 'Customizable' connector definition kind.", + "required": [ + "templateSpecVersion", + "templateSpecName" + ], + "type": "object", + "properties": { + "templateSpecName": { + "description": "Gets or sets the template name. The template includes ARM templates that can be created by the connector, usually it will be the dataConnectors ARM templates.", + "type": "string" + }, + "templateSpecVersion": { + "description": "Gets or sets the template version.", + "type": "string" + } + } + }, + "CustomizableConnectorUiConfig": { + "description": "The UiConfig for 'Customizable' connector definition kind.", + "required": [ + "dataTypes", + "descriptionMarkdown", + "graphQueries", + "instructionSteps", + "permissions", + "publisher", + "sampleQueries", + "title", + "connectivityCriteria" + ], + "type": "object", + "properties": { + "id": { + "description": "Gets or sets custom connector id. optional field.", + "type": "string" + }, + "title": { + "description": "Gets or sets the connector blade title.", + "type": "string" + }, + "publisher": { + "description": "Gets or sets the connector publisher name.", + "type": "string" + }, + "descriptionMarkdown": { + "description": "Gets or sets the connector description in markdown format.", + "type": "string" + }, + "graphQueriesTableName": { + "description": "Gets or sets the name of the table the connector will insert the data to.\r\nThis name can be used in other queries by specifying {{graphQueriesTableName}} placeholder\r\n in Query and LastDataReceivedQuery values.", + "type": "string" + }, + "graphQueries": { + "description": "Gets or sets the graph queries to show the current data volume over time.", + "type": "array", + "items": { + "$ref": "#/definitions/GraphQuery" + }, + "x-ms-identifiers": [] + }, + "sampleQueries": { + "description": "Gets or sets the sample queries for the connector.", + "type": "array", + "items": { + "$ref": "#/definitions/SampleQuery" + }, + "x-ms-identifiers": [] + }, + "dataTypes": { + "description": "Gets or sets the data types to check for last data received.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectorDataType" + }, + "x-ms-identifiers": [] + }, + "connectivityCriteria": { + "description": "Gets or sets the way the connector checks whether the connector is connected.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectivityCriterion" + }, + "x-ms-identifiers": [] + }, + "availability": { + "$ref": "#/definitions/ConnectorDefinitionsAvailability" + }, + "permissions": { + "$ref": "#/definitions/ConnectorDefinitionsPermissions" + }, + "instructionSteps": { + "description": "Gets or sets the instruction steps to enable the connector.", + "type": "array", + "items": { + "$ref": "#/definitions/InstructionStep" + }, + "x-ms-identifiers": [] + }, + "logo": { + "description": "Gets or sets the connector logo to be used when displaying the connector within Azure Sentinel's connector's gallery.\r\nThe logo value should be in SVG format.", + "type": "string" + }, + "isConnectivityCriteriasMatchSome": { + "description": "Gets or sets a value indicating whether to use 'OR'(SOME) or 'AND' between ConnectivityCriteria items.", + "type": "boolean" + } + } + }, + "CustomPermissionDetails": { + "description": "The Custom permissions required for the connector.", + "required": [ + "description", + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the custom permissions name.", + "type": "string" + }, + "description": { + "description": "Gets or sets the custom permissions description.", + "type": "string" + } + } + }, + "GraphQuery": { + "description": "The graph query to show the volume of data arriving into the workspace over time.", + "required": [ + "baseQuery", + "legend", + "metricName" + ], + "type": "object", + "properties": { + "metricName": { + "description": "Gets or sets the metric name that the query is checking. For example: 'Total data receive'.", + "type": "string" + }, + "legend": { + "description": "Gets or sets the legend for the graph.", + "type": "string" + }, + "baseQuery": { + "description": "Gets or sets the base query for the graph.\r\nThe base query is wrapped by Sentinel UI infra with a KQL query, that measures the volume over time.", + "type": "string" + } + } + }, + "InstructionStep": { + "description": "Instruction steps to enable the connector.", + "type": "object", + "properties": { + "title": { + "description": "Gets or sets the instruction step title.", + "type": "string" + }, + "description": { + "description": "Gets or sets the instruction step description.", + "type": "string" + }, + "instructions": { + "description": "Gets or sets the instruction step details.", + "type": "array", + "items": { + "$ref": "#/definitions/InstructionStepDetails" + }, + "x-ms-identifiers": [] + }, + "innerSteps": { + "description": "Gets or sets the inner instruction steps details.\r\nFoe Example: instruction step 1 might contain inner instruction steps: [instruction step 1.1, instruction step 1.2].", + "type": "array", + "items": { + "$ref": "#/definitions/InstructionStep" + }, + "x-ms-identifiers": [] + } + } + }, + "InstructionStepDetails": { + "description": "Instruction step details, to be displayed in the Instructions steps section in the connector's page in Sentinel Portal.", + "required": [ + "parameters", + "type" + ], + "type": "object", + "properties": { + "parameters": { + "description": "Gets or sets the instruction type parameters settings.", + "type": "object" + }, + "type": { + "description": "Gets or sets the instruction type name.", + "type": "string" + } + } + }, + "ConnectorDefinitionsPermissions": { + "description": "The required Permissions for the connector.", + "type": "object", + "properties": { + "tenant": { + "description": "Gets or sets the required tenant permissions for the connector.", + "type": "array", + "items": { + "type": "string" + } + }, + "licenses": { + "description": "Gets or sets the required licenses for the user to create connections.", + "type": "array", + "items": { + "type": "string" + } + }, + "resourceProvider": { + "description": "Gets or sets the resource provider permissions required for the user to create connections.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectorDefinitionsResourceProvider" + }, + "x-ms-identifiers": [] + }, + "customs": { + "description": "Gets or sets the customs permissions required for the user to create connections.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomPermissionDetails" + }, + "x-ms-identifiers": [] + } + } + }, + "ProviderPermissionsScope": { + "description": "The scope on which the user should have permissions, in order to be able to create connections.", + "enum": [ + "Subscription", + "ResourceGroup", + "Workspace" + ], + "type": "string", + "example": "Subscription", + "x-ms-enum": { + "name": "ProviderPermissionsScope", + "modelAsString": true, + "values": [ + { + "value": "Subscription" + }, + { + "value": "ResourceGroup" + }, + { + "value": "Workspace" + } + ] + } + }, + "ConnectorDefinitionsResourceProvider": { + "description": "The resource provider details include the required permissions for the user to create connections.\r\nThe user should have the required permissions(Read\\Write, ..) in the specified scope ProviderPermissionsScope against the specified resource provider.", + "required": [ + "permissionsDisplayText", + "provider", + "providerDisplayName", + "requiredPermissions", + "scope" + ], + "type": "object", + "properties": { + "provider": { + "description": "Gets or sets the provider name.", + "type": "string" + }, + "permissionsDisplayText": { + "description": "Gets or sets the permissions description text.", + "type": "string" + }, + "providerDisplayName": { + "description": "Gets or sets the permissions provider display name.", + "type": "string" + }, + "scope": { + "$ref": "#/definitions/ProviderPermissionsScope" + }, + "requiredPermissions": { + "$ref": "#/definitions/ResourceProviderRequiredPermissions" + } + } + }, + "ResourceProviderRequiredPermissions": { + "description": "Required permissions for the connector resource provider that define in ResourceProviders.\r\nFor more information about the permissions see here.", + "type": "object", + "properties": { + "read": { + "description": "Gets or sets a value indicating whether the permission is read action (GET).", + "type": "boolean" + }, + "write": { + "description": "Gets or sets a value indicating whether the permission is write action (PUT or PATCH).", + "type": "boolean" + }, + "delete": { + "description": "Gets or sets a value indicating whether the permission is delete action (DELETE).", + "type": "boolean" + }, + "action": { + "description": "Gets or sets a value indicating whether the permission is custom actions (POST).", + "type": "boolean" + } + } + }, + "SampleQuery": { + "description": "The sample queries for the connector.", + "required": [ + "description", + "query" + ], + "type": "object", + "properties": { + "description": { + "description": "Gets or sets the sample query description.", + "type": "string" + }, + "query": { + "description": "Gets or sets the KQL sample query.", + "type": "string" + } + } + } + }, + "parameters": { + "dataConnectorDefinitionName": { + "in": "path", + "name": "dataConnectorDefinitionName", + "description": "The data connector definition name.", + "required": true, + "type": "string", + "pattern": "^[a-z0-9A-Z-_]*$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/dataConnectors.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/dataConnectors.json new file mode 100644 index 000000000000..5e8ffbb5126b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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-12-01-preview/examples/actions/CreateActionOfAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/actions/CreateActionOfAlertRule.json new file mode 100644 index 000000000000..c1fe93c4ebdb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/actions/CreateActionOfAlertRule.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/actions/DeleteActionOfAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/actions/DeleteActionOfAlertRule.json new file mode 100644 index 000000000000..fc57785c319e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/actions/DeleteActionOfAlertRule.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/actions/GetActionOfAlertRuleById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/actions/GetActionOfAlertRuleById.json new file mode 100644 index 000000000000..dbbb8e7a9a93 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/actions/GetActionOfAlertRuleById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/actions/GetAllActionsByAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/actions/GetAllActionsByAlertRule.json new file mode 100644 index 000000000000..7082ddef6278 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/actions/GetAllActionsByAlertRule.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json new file mode 100644 index 000000000000..8ed34f3806b7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json new file mode 100644 index 000000000000..b6464f894336 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRules/CreateFusionAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateFusionAlertRule.json new file mode 100644 index 000000000000..9fc1b43df2fa --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateFusionAlertRule.json @@ -0,0 +1,845 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json new file mode 100644 index 000000000000..9b8df751e87f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json @@ -0,0 +1,851 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json new file mode 100644 index 000000000000..f0a0f5decc3e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRules/CreateNrtAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateNrtAlertRule.json new file mode 100644 index 000000000000..f3c12c3441cd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateNrtAlertRule.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRules/CreateScheduledAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateScheduledAlertRule.json new file mode 100644 index 000000000000..e8f85f73c171 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/CreateScheduledAlertRule.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRules/DeleteAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/DeleteAlertRule.json new file mode 100644 index 000000000000..26cbe1c42ec1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/DeleteAlertRule.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRules/GetAllAlertRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetAllAlertRules.json new file mode 100644 index 000000000000..d48761976a37 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetAllAlertRules.json @@ -0,0 +1,412 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRules/GetFusionAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetFusionAlertRule.json new file mode 100644 index 000000000000..3e4b348fd567 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetFusionAlertRule.json @@ -0,0 +1,310 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json new file mode 100644 index 000000000000..dc6eaf4ebe4f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRules/GetNrtAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetNrtAlertRule.json new file mode 100644 index 000000000000..dbabbde37a56 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetNrtAlertRule.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/alertRules/GetScheduledAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetScheduledAlertRule.json new file mode 100644 index 000000000000..5464eb7138f9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/alertRules/GetScheduledAlertRule.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/automationRules/AutomationRules_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/automationRules/AutomationRules_CreateOrUpdate.json new file mode 100644 index 000000000000..7e5eebc29630 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/automationRules/AutomationRules_CreateOrUpdate.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/automationRules/AutomationRules_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/automationRules/AutomationRules_Delete.json new file mode 100644 index 000000000000..cabfe4914cf5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/automationRules/AutomationRules_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/automationRules/AutomationRules_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/automationRules/AutomationRules_Get.json new file mode 100644 index 000000000000..b3da0ecdbd8a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/automationRules/AutomationRules_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/automationRules/AutomationRules_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/automationRules/AutomationRules_List.json new file mode 100644 index 000000000000..68bb792a6549 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/automationRules/AutomationRules_List.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/billingStatistics/GetAllBillingStatistics.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/billingStatistics/GetAllBillingStatistics.json new file mode 100644 index 000000000000..695cd0f871fb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/billingStatistics/GetAllBillingStatistics.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/billingStatistics/GetBillingStatistic.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/billingStatistics/GetBillingStatistic.json new file mode 100644 index 000000000000..12a253d69a9d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/billingStatistics/GetBillingStatistic.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/bookmarks/CreateBookmark.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/CreateBookmark.json new file mode 100644 index 000000000000..1c2be31bbfc5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/CreateBookmark.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/bookmarks/DeleteBookmark.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/DeleteBookmark.json new file mode 100644 index 000000000000..2ec5b48f15eb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/DeleteBookmark.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/bookmarks/GetBookmarkById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/GetBookmarkById.json new file mode 100644 index 000000000000..876ab83bd5d4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/GetBookmarkById.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/bookmarks/GetBookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/GetBookmarks.json new file mode 100644 index 000000000000..012cfa2694a8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/GetBookmarks.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/bookmarks/expand/PostExpandBookmark.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/expand/PostExpandBookmark.json new file mode 100644 index 000000000000..76d3dea2b0b0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/expand/PostExpandBookmark.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json new file mode 100644 index 000000000000..42e7a3544914 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/bookmarks/relations/DeleteBookmarkRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/relations/DeleteBookmarkRelation.json new file mode 100644 index 000000000000..4cf18f19a0c2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/relations/DeleteBookmarkRelation.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json new file mode 100644 index 000000000000..f58a5c519db9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json new file mode 100644 index 000000000000..29f8f52f9ee5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/contentPackages/GetPackageById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/GetPackageById.json new file mode 100644 index 000000000000..2cec90fd5a4b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/GetPackageById.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-12-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", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "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-12-01-preview/examples/contentPackages/GetPackages.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/GetPackages.json new file mode 100644 index 000000000000..69d9ba365425 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/GetPackages.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-12-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", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "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-12-01-preview/examples/contentPackages/GetProductPackageById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/GetProductPackageById.json new file mode 100644 index 000000000000..4469b6e384c4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/GetProductPackageById.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2023-12-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", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "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-12-01-preview/examples/contentPackages/GetProductPackages.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/GetProductPackages.json new file mode 100644 index 000000000000..05e35803ab7e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/GetProductPackages.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-12-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", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "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-12-01-preview/examples/contentPackages/InstallPackage.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/InstallPackage.json new file mode 100644 index 000000000000..3e8771e6cb8e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/InstallPackage.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "api-version": "2023-12-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", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "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", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "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", + "contentProductId": "str.azure-sentinel-solution-str-sl-igl6jawr4gwmu", + "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-12-01-preview/examples/contentPackages/UninstallPackage.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/UninstallPackage.json new file mode 100644 index 000000000000..290fb5084282 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentPackages/UninstallPackage.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/contentTemplates/DeleteTemplate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/DeleteTemplate.json new file mode 100644 index 000000000000..5324a4d65ac7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/DeleteTemplate.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/contentTemplates/GetProductTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/GetProductTemplateById.json new file mode 100644 index 000000000000..7eb7542b8c64 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/GetProductTemplateById.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-12-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": "contentId", + "version": "1.0.0", + "packageVersion": "1.0.0", + "displayName": "My installed template", + "contentKind": "Workbooks", + "contentProductId": "packageId-wb-rimnsoeh4nt32", + "packageId": "packageId", + "packageKind": "Standalone", + "packageName": "package name", + "source": { + "kind": "Standalone", + "name": "Source name" + }, + "mainTemplate": {} + }, + "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-12-01-preview/examples/contentTemplates/GetProductTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/GetProductTemplates.json new file mode 100644 index 000000000000..87181eed40ec --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/GetProductTemplates.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-12-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": "contentId", + "contentProductId": "packageId-wb-rimnsoeh4nt32", + "version": "1.0.0", + "packageVersion": "1.0.0", + "displayName": "My installed template", + "contentKind": "Workbooks", + "packageId": "packageId", + "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-12-01-preview/examples/contentTemplates/GetTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/GetTemplateById.json new file mode 100644 index 000000000000..9e5de85a83c7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/GetTemplateById.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-12-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": "contentId", + "contentProductId": "packageId-wb-rimnsoeh4nt32", + "version": "1.0.0", + "packageVersion": "1.0.0", + "displayName": "My installed template", + "contentKind": "Workbooks", + "packageId": "packageId", + "source": { + "kind": "Standalone", + "name": "Source name" + }, + "mainTemplate": {} + }, + "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-12-01-preview/examples/contentTemplates/GetTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/GetTemplates.json new file mode 100644 index 000000000000..cc49b75cc8be --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/GetTemplates.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-12-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": "contentId", + "contentProductId": "packageId-wb-rimnsoeh4nt32", + "packageVersion": "1.0.0", + "version": "1.0.0", + "displayName": "My installed template", + "contentKind": "Workbooks", + "packageId": "packageId", + "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-12-01-preview/examples/contentTemplates/InstallTemplate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/InstallTemplate.json new file mode 100644 index 000000000000..c20a6b059d94 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/contentTemplates/InstallTemplate.json @@ -0,0 +1,228 @@ +{ + "parameters": { + "api-version": "2023-12-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", + "contentProductId": "str.azure-sentinel-solution-str-ar-cbfe4fndz66bi", + "displayName": "API Protection workbook template", + "contentKind": "AnalyticsRule", + "version": "1.0.1", + "packageVersion": "1.0.0", + "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": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "contentProductId": "str.azure-sentinel-solution-str-ar-cbfe4fndz66bi", + "packageKind": "Solution", + "packageId": "str.azure-sentinel-solution-str", + "packageVersion": "1.0.0", + "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": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "contentProductId": "str.azure-sentinel-solution-str-ar-cbfe4fndz66bi", + "packageKind": "Solution", + "packageId": "str.azure-sentinel-solution-str", + "packageVersion": "1.0.0", + "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-12-01-preview/examples/dataConnectorDefinitions/CreateCustomizableDataConnectorDefinition.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/CreateCustomizableDataConnectorDefinition.json new file mode 100644 index 000000000000..4a98d4a019f0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/CreateCustomizableDataConnectorDefinition.json @@ -0,0 +1,264 @@ +{ + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorDefinitionName": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "connectorDefinitionInput": { + "kind": "Customizable", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "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.", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "GitHubAuditLogPolling_CL" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "GitHubAuditLogPolling_CL \n | take 10" + } + ], + "dataTypes": [ + { + "name": "GitHubAuditLogPolling_CL", + "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": false + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": false, + "delete": false, + "action": false + } + } + ], + "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": [ + { + "type": "OAuthForm", + "parameters": { + "clientIdLabel": "Client ID", + "clientSecretLabel": "Client Secret", + "connectButtonLabel": "Connect", + "disconnectButtonLabel": "Disconnect" + } + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectorDefinitions", + "kind": "Customizable", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "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.", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "GitHubAuditLogPolling_CL" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "GitHubAuditLogPolling_CL \n | take 10" + } + ], + "dataTypes": [ + { + "name": "GitHubAuditLogPolling_CL", + "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": false + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": false, + "delete": false, + "action": false + } + } + ], + "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": [ + { + "type": "OAuthForm", + "parameters": { + "clientIdLabel": "Client ID", + "clientSecretLabel": "Client Secret", + "connectButtonLabel": "Connect", + "disconnectButtonLabel": "Disconnect" + } + } + ] + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectorDefinitions", + "kind": "Customizable", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "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.", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "GitHubAuditLogPolling_CL" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "GitHubAuditLogPolling_CL \n | take 10" + } + ], + "dataTypes": [ + { + "name": "GitHubAuditLogPolling_CL", + "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": false + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": false, + "delete": false, + "action": false + } + } + ], + "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": [ + { + "type": "OAuthForm", + "parameters": { + "clientIdLabel": "Client ID", + "clientSecretLabel": "Client Secret", + "connectButtonLabel": "Connect", + "disconnectButtonLabel": "Disconnect" + } + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/DeleteDataConnectorDefinitionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/DeleteDataConnectorDefinitionById.json new file mode 100644 index 000000000000..adf5ecd2d5cd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/DeleteDataConnectorDefinitionById.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorDefinitionName": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/GetCustomizableDataConnectoeDefinitionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/GetCustomizableDataConnectoeDefinitionById.json new file mode 100644 index 000000000000..0e53ef0d561a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/GetCustomizableDataConnectoeDefinitionById.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorDefinitionName": "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/dataConnectorDefinitions/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "type": "Microsoft.SecurityInsights/dataConnectorDefinitions", + "kind": "Customizable", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "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.", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "GitHubAuditLogPolling_CL" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "GitHubAuditLogPolling_CL \n | take 10" + } + ], + "dataTypes": [ + { + "name": "GitHubAuditLogPolling_CL", + "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": false + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": false, + "delete": false, + "action": false + } + } + ], + "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": [ + { + "type": "OAuthForm", + "parameters": { + "clientIdLabel": "Client ID", + "clientSecretLabel": "Client Secret", + "connectButtonLabel": "Connect", + "disconnectButtonLabel": "Disconnect" + } + } + ] + } + ] + }, + "connectionsConfig": { + "templateSpecName": "templateNameMock", + "templateSpecVersion": "1.0.0" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/GetDataConnectorDefinitions.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/GetDataConnectorDefinitions.json new file mode 100644 index 000000000000..dca3f7a0407f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectorDefinitions/GetDataConnectorDefinitions.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-12-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/dataConnectorDefinitions/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "type": "Microsoft.SecurityInsights/dataConnectorDefinitions", + "kind": "Customizable", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "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.", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "GitHubAuditLogPolling_CL" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "GitHubAuditLogPolling_CL \n | take 10" + } + ], + "dataTypes": [ + { + "name": "GitHubAuditLogPolling_CL", + "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": false + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": false, + "delete": false, + "action": false + } + } + ], + "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": [ + { + "type": "OAuthForm", + "parameters": { + "clientIdLabel": "Client ID", + "clientSecretLabel": "Client Secret", + "connectButtonLabel": "Connect", + "disconnectButtonLabel": "Disconnect" + } + } + ] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json new file mode 100644 index 000000000000..136cae637fe8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json new file mode 100644 index 000000000000..136cae637fe8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json new file mode 100644 index 000000000000..136cae637fe8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json new file mode 100644 index 000000000000..05ed1f5d7b28 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsDynamics365.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsDynamics365.json new file mode 100644 index 000000000000..970275931064 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsDynamics365.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsIoT.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsIoT.json new file mode 100644 index 000000000000..34d7cc0912ca --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsIoT.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsMdatp.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMdatp.json new file mode 100644 index 000000000000..31dd6fea42e3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMdatp.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json new file mode 100644 index 000000000000..31dd6fea42e3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json new file mode 100644 index 000000000000..6bd46763b191 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json new file mode 100644 index 000000000000..878b7490cb09 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json new file mode 100644 index 000000000000..8f9d6f7ebfe4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsOffice365Project.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsOffice365Project.json new file mode 100644 index 000000000000..bd7e182e83ef --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsOffice365Project.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json new file mode 100644 index 000000000000..f762ea9823fb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsOfficeIRM.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsOfficeIRM.json new file mode 100644 index 000000000000..09b262c95f05 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsOfficeIRM.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsOfficePowerBI.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsOfficePowerBI.json new file mode 100644 index 000000000000..4704f2465b15 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsOfficePowerBI.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligence.json new file mode 100644 index 000000000000..14f8b1c996aa --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligence.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json new file mode 100644 index 000000000000..3b9dc92d7c1a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/ConnectAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/ConnectAPIPolling.json new file mode 100644 index 000000000000..7142c588763e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/ConnectAPIPolling.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/ConnectAPIPollingV2Logs.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/ConnectAPIPollingV2Logs.json new file mode 100644 index 000000000000..bb48c2aba74e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/ConnectAPIPollingV2Logs.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CreateAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateAPIPolling.json new file mode 100644 index 000000000000..135eaa1ef2cf --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateAPIPolling.json @@ -0,0 +1,368 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CreateDynamics365DataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateDynamics365DataConnetor.json new file mode 100644 index 000000000000..e1e0f3cc2628 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateDynamics365DataConnetor.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CreateGenericUI.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateGenericUI.json new file mode 100644 index 000000000000..7c66c3c07272 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateGenericUI.json @@ -0,0 +1,437 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CreateGoogleCloudPlatform.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateGoogleCloudPlatform.json new file mode 100644 index 000000000000..9e114d0ff8c7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateGoogleCloudPlatform.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json new file mode 100644 index 000000000000..849aeda05a9b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json new file mode 100644 index 000000000000..a589a6f82303 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json new file mode 100644 index 000000000000..faea43d598fd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CreateOffice365ProjectDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateOffice365ProjectDataConnetor.json new file mode 100644 index 000000000000..304b26144c67 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateOffice365ProjectDataConnetor.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json new file mode 100644 index 000000000000..048c54e439bd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CreateOfficePowerBIDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateOfficePowerBIDataConnector.json new file mode 100644 index 000000000000..c685d7b68040 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateOfficePowerBIDataConnector.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CreateThreatIntelligenceDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateThreatIntelligenceDataConnector.json new file mode 100644 index 000000000000..817ce452104b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateThreatIntelligenceDataConnector.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json new file mode 100644 index 000000000000..3dadd6fd9d46 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/DeleteAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteAPIPolling.json new file mode 100644 index 000000000000..d30d26b38400 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteAPIPolling.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/DeleteGenericUI.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteGenericUI.json new file mode 100644 index 000000000000..d30d26b38400 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteGenericUI.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/DeleteGoogleCloudPlatform.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteGoogleCloudPlatform.json new file mode 100644 index 000000000000..094c2e107527 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteGoogleCloudPlatform.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json new file mode 100644 index 000000000000..c318ad17b37a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json new file mode 100644 index 000000000000..ea46506f4ef0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json new file mode 100644 index 000000000000..c318ad17b37a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json new file mode 100644 index 000000000000..c318ad17b37a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json new file mode 100644 index 000000000000..c318ad17b37a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/DisconnectAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DisconnectAPIPolling.json new file mode 100644 index 000000000000..38f025f4d7fd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/DisconnectAPIPolling.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAPIPolling.json new file mode 100644 index 000000000000..f589ec48b904 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAPIPolling.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json new file mode 100644 index 000000000000..efd341bfdddc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetAmazonWebServicesS3ById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAmazonWebServicesS3ById.json new file mode 100644 index 000000000000..30d6831e60ba --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAmazonWebServicesS3ById.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json new file mode 100644 index 000000000000..cf9fd5cd61d9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json new file mode 100644 index 000000000000..54b36bbc6f72 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json new file mode 100644 index 000000000000..8671ef79542d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetDataConnectors.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetDataConnectors.json new file mode 100644 index 000000000000..a3305a27ac3d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetDataConnectors.json @@ -0,0 +1,508 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetDynamics365DataConnectorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetDynamics365DataConnectorById.json new file mode 100644 index 000000000000..e337f2b8d199 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetDynamics365DataConnectorById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetGenericUI.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetGenericUI.json new file mode 100644 index 000000000000..7bf2f9b9b1b8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetGenericUI.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetGoogleCloudPlatformById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetGoogleCloudPlatformById.json new file mode 100644 index 000000000000..acb24360de1f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetGoogleCloudPlatformById.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetIoTById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetIoTById.json new file mode 100644 index 000000000000..58fab8bd9dfc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetIoTById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json new file mode 100644 index 000000000000..dcaf5c5547b0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json new file mode 100644 index 000000000000..9c0c3b650b69 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json new file mode 100644 index 000000000000..0467897d74f5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json new file mode 100644 index 000000000000..4f41752d2ce8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json new file mode 100644 index 000000000000..332adb181bbf --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetMicrosoftThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftThreatProtectionById.json new file mode 100644 index 000000000000..bd478927faf8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetMicrosoftThreatProtectionById.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json new file mode 100644 index 000000000000..83c8968846fa --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetOffice365ProjectDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetOffice365ProjectDataConnetorById.json new file mode 100644 index 000000000000..92faa11c617f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetOffice365ProjectDataConnetorById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json new file mode 100644 index 000000000000..3dfbf12871ae --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetOfficePowerBIDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetOfficePowerBIDataConnetorById.json new file mode 100644 index 000000000000..5e01267f93f0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetOfficePowerBIDataConnetorById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json new file mode 100644 index 000000000000..fb4d3281113c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/dataConnectors/GetThreatIntelligenceTaxiiById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetThreatIntelligenceTaxiiById.json new file mode 100644 index 000000000000..c6972a5269f0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/dataConnectors/GetThreatIntelligenceTaxiiById.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/enrichment/GetGeodataByIp.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/enrichment/GetGeodataByIp.json new file mode 100644 index 000000000000..d2d42bc28368 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/enrichment/GetGeodataByIp.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/enrichment/GetWhoisByDomainName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/enrichment/GetWhoisByDomainName.json new file mode 100644 index 000000000000..1cbad420fc59 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/enrichment/GetWhoisByDomainName.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetAccountEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetAccountEntityById.json new file mode 100644 index 000000000000..02b02a74a498 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetAccountEntityById.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetAzureResourceEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetAzureResourceEntityById.json new file mode 100644 index 000000000000..bdd92de9410c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetAzureResourceEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetCloudApplicationEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetCloudApplicationEntityById.json new file mode 100644 index 000000000000..23d253ff830f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetCloudApplicationEntityById.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetDnsEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetDnsEntityById.json new file mode 100644 index 000000000000..a3411de29414 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetDnsEntityById.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetEntities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetEntities.json new file mode 100644 index 000000000000..2b0d22b9f7e1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetEntities.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetFileEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetFileEntityById.json new file mode 100644 index 000000000000..45fdff105a45 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetFileEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetFileHashEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetFileHashEntityById.json new file mode 100644 index 000000000000..9c8f3e49ad34 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetFileHashEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetHostEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetHostEntityById.json new file mode 100644 index 000000000000..fa50f6b7a3aa --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetHostEntityById.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetIoTDeviceEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetIoTDeviceEntityById.json new file mode 100644 index 000000000000..0d18c9103647 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetIoTDeviceEntityById.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetIpEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetIpEntityById.json new file mode 100644 index 000000000000..09852f443bb8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetIpEntityById.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetMailClusterEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetMailClusterEntityById.json new file mode 100644 index 000000000000..2489fa0345d6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetMailClusterEntityById.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetMailMessageEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetMailMessageEntityById.json new file mode 100644 index 000000000000..04ffe43a7109 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetMailMessageEntityById.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetMailboxEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetMailboxEntityById.json new file mode 100644 index 000000000000..fc673d4cd6c9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetMailboxEntityById.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetMalwareEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetMalwareEntityById.json new file mode 100644 index 000000000000..b9e60cd4052a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetMalwareEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetProcessEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetProcessEntityById.json new file mode 100644 index 000000000000..48ad95644042 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetProcessEntityById.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetQueries.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetQueries.json new file mode 100644 index 000000000000..417fb144dd66 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetQueries.json @@ -0,0 +1,456 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetRegistryKeyEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetRegistryKeyEntityById.json new file mode 100644 index 000000000000..8e0bcdcceff6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetRegistryKeyEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetRegistryValueEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetRegistryValueEntityById.json new file mode 100644 index 000000000000..24a32d2b2091 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetRegistryValueEntityById.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetSecurityAlertEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetSecurityAlertEntityById.json new file mode 100644 index 000000000000..c7b190bbb46b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetSecurityAlertEntityById.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetSecurityGroupEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetSecurityGroupEntityById.json new file mode 100644 index 000000000000..dfadf2364d0f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetSecurityGroupEntityById.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetSubmissionMailEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetSubmissionMailEntityById.json new file mode 100644 index 000000000000..fc2bde2c78be --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetSubmissionMailEntityById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/GetUrlEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetUrlEntityById.json new file mode 100644 index 000000000000..7c8df007256e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/GetUrlEntityById.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/expand/PostExpandEntity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/expand/PostExpandEntity.json new file mode 100644 index 000000000000..37903c5010cf --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/expand/PostExpandEntity.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/insights/PostGetInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/insights/PostGetInsights.json new file mode 100644 index 000000000000..5e15c5128863 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/insights/PostGetInsights.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/relations/GetAllEntityRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/relations/GetAllEntityRelations.json new file mode 100644 index 000000000000..6f272d0e09f3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/relations/GetAllEntityRelations.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/relations/GetEntityRelationByName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/relations/GetEntityRelationByName.json new file mode 100644 index 000000000000..3d2d4c86a98d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/relations/GetEntityRelationByName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entities/timeline/PostTimelineEntity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/timeline/PostTimelineEntity.json new file mode 100644 index 000000000000..967af1cabb00 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entities/timeline/PostTimelineEntity.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entityQueries/CreateEntityQueryActivity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/CreateEntityQueryActivity.json new file mode 100644 index 000000000000..e9cb0c435f46 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/CreateEntityQueryActivity.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entityQueries/DeleteEntityQuery.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/DeleteEntityQuery.json new file mode 100644 index 000000000000..dd0ffee4b2c1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/DeleteEntityQuery.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entityQueries/GetActivityEntityQueryById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/GetActivityEntityQueryById.json new file mode 100644 index 000000000000..2029e0866406 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/GetActivityEntityQueryById.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entityQueries/GetEntityQueries.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/GetEntityQueries.json new file mode 100644 index 000000000000..b085ba87f0e5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/GetEntityQueries.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json new file mode 100644 index 000000000000..c91449ede433 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json new file mode 100644 index 000000000000..a4b487292c3a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/entityQueryTemplates/GetEntityQueryTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueryTemplates/GetEntityQueryTemplates.json new file mode 100644 index 000000000000..94cd378d5a54 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/entityQueryTemplates/GetEntityQueryTemplates.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/fileImports/CreateFileImport.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/fileImports/CreateFileImport.json new file mode 100644 index 000000000000..23e332600c49 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/fileImports/CreateFileImport.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-12-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=&sktid=&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=", + "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-12-01-preview/examples/fileImports/DeleteFileImport.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/fileImports/DeleteFileImport.json new file mode 100644 index 000000000000..29e6e05ee983 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/fileImports/DeleteFileImport.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/fileImports/GetFileImportById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/fileImports/GetFileImportById.json new file mode 100644 index 000000000000..0038e2f99c94 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/fileImports/GetFileImportById.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-12-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=&sktid=&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=", + "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-12-01-preview/examples/fileImports/GetFileImports.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/fileImports/GetFileImports.json new file mode 100644 index 000000000000..dfd48e768792 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/fileImports/GetFileImports.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/hunts/CreateHunt.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/CreateHunt.json new file mode 100644 index 000000000000..208b472e8b17 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/CreateHunt.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/hunts/CreateHuntComment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/CreateHuntComment.json new file mode 100644 index 000000000000..fa0c67db986e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/CreateHuntComment.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/hunts/CreateHuntRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/CreateHuntRelation.json new file mode 100644 index 000000000000..d5e906ad8a29 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/CreateHuntRelation.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/hunts/DeleteHunt.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/DeleteHunt.json new file mode 100644 index 000000000000..81bacb8598bc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/DeleteHunt.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/hunts/DeleteHuntComment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/DeleteHuntComment.json new file mode 100644 index 000000000000..6846d75358ad --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/DeleteHuntComment.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/hunts/DeleteHuntRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/DeleteHuntRelation.json new file mode 100644 index 000000000000..e2b336bfeea6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/DeleteHuntRelation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/hunts/GetHuntById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntById.json new file mode 100644 index 000000000000..4b6cf21ad5d3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntById.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/hunts/GetHuntCommentById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntCommentById.json new file mode 100644 index 000000000000..04c1dd6b7393 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntCommentById.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/hunts/GetHuntComments.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntComments.json new file mode 100644 index 000000000000..a9e615cfcedb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntComments.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/hunts/GetHuntRelationById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntRelationById.json new file mode 100644 index 000000000000..9a28ecb8dd08 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntRelationById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/hunts/GetHuntRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntRelations.json new file mode 100644 index 000000000000..2f6b0b75109d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHuntRelations.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/hunts/GetHunts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHunts.json new file mode 100644 index 000000000000..7bb7e4db329c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/hunts/GetHunts.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/IncidentAlerts/Incidents_ListAlerts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentAlerts/Incidents_ListAlerts.json new file mode 100644 index 000000000000..9739787fcff8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentAlerts/Incidents_ListAlerts.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json new file mode 100644 index 000000000000..41c41ed277d6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json new file mode 100644 index 000000000000..3115e441a453 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/IncidentComments/IncidentComments_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentComments/IncidentComments_Delete.json new file mode 100644 index 000000000000..c69938e449bb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentComments/IncidentComments_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/IncidentComments/IncidentComments_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentComments/IncidentComments_Get.json new file mode 100644 index 000000000000..ddb268b3e72e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentComments/IncidentComments_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/IncidentComments/IncidentComments_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentComments/IncidentComments_List.json new file mode 100644 index 000000000000..005319ecc43f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentComments/IncidentComments_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/IncidentEntities/Incidents_ListEntities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentEntities/Incidents_ListEntities.json new file mode 100644 index 000000000000..8aeb7de7d4ee --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentEntities/Incidents_ListEntities.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json new file mode 100644 index 000000000000..6814d1aa456a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Delete.json new file mode 100644 index 000000000000..226cb4ccd595 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Get.json new file mode 100644 index 000000000000..3da473a273fe --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_List.json new file mode 100644 index 000000000000..ac9ae893b30b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTasks/IncidentTasks_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/IncidentTeam/Incidents_CreateTeam.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTeam/Incidents_CreateTeam.json new file mode 100644 index 000000000000..63ff7cc3b098 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/IncidentTeam/Incidents_CreateTeam.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/Incidents_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/Incidents_CreateOrUpdate.json new file mode 100644 index 000000000000..4ed380925ce3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/Incidents_CreateOrUpdate.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/Incidents_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/Incidents_Delete.json new file mode 100644 index 000000000000..a6331fd368be --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/Incidents_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/Incidents_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/Incidents_Get.json new file mode 100644 index 000000000000..c504d34a75ae --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/Incidents_Get.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/Incidents_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/Incidents_List.json new file mode 100644 index 000000000000..85affff5508f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/Incidents_List.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/relations/CreateIncidentRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/relations/CreateIncidentRelation.json new file mode 100644 index 000000000000..7611d1e0a6c9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/relations/CreateIncidentRelation.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/relations/DeleteIncidentRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/relations/DeleteIncidentRelation.json new file mode 100644 index 000000000000..36251bd51ebb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/relations/DeleteIncidentRelation.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/relations/GetAllIncidentRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/relations/GetAllIncidentRelations.json new file mode 100644 index 000000000000..c452ab0f6aaf --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/relations/GetAllIncidentRelations.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/incidents/relations/GetIncidentRelationByName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/relations/GetIncidentRelationByName.json new file mode 100644 index 000000000000..fd1a29db74a6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/incidents/relations/GetIncidentRelationByName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/manualTrigger/Entities_RunPlaybook.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/manualTrigger/Entities_RunPlaybook.json new file mode 100644 index 000000000000..b348237f2e4d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/manualTrigger/Entities_RunPlaybook.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json new file mode 100644 index 000000000000..85f39fedace2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/metadata/DeleteMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/DeleteMetadata.json new file mode 100644 index 000000000000..60a497015362 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/DeleteMetadata.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/metadata/GetAllMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/GetAllMetadata.json new file mode 100644 index 000000000000..8d3ecc78fb61 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/GetAllMetadata.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/metadata/GetAllMetadataOData.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/GetAllMetadataOData.json new file mode 100644 index 000000000000..3b6fa3801e67 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/GetAllMetadataOData.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/metadata/GetMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/GetMetadata.json new file mode 100644 index 000000000000..61b5e182f78e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/GetMetadata.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/metadata/PatchMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/PatchMetadata.json new file mode 100644 index 000000000000..3a8a73a14def --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/PatchMetadata.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/metadata/PutMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/PutMetadata.json new file mode 100644 index 000000000000..b20df3c090d6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/PutMetadata.json @@ -0,0 +1,286 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/metadata/PutMetadataMinimal.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/PutMetadataMinimal.json new file mode 100644 index 000000000000..a5fc19df4346 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/metadata/PutMetadataMinimal.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/officeConsents/DeleteOfficeConsents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/officeConsents/DeleteOfficeConsents.json new file mode 100644 index 000000000000..19d32da7b105 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/officeConsents/DeleteOfficeConsents.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/officeConsents/GetOfficeConsents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/officeConsents/GetOfficeConsents.json new file mode 100644 index 000000000000..37667db3b840 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/officeConsents/GetOfficeConsents.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/officeConsents/GetOfficeConsentsById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/officeConsents/GetOfficeConsentsById.json new file mode 100644 index 000000000000..b98ceef481b3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/officeConsents/GetOfficeConsentsById.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json new file mode 100644 index 000000000000..ea080927ff36 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json new file mode 100644 index 000000000000..d1a379b865a7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/onboardingStates/GetAllSentinelOnboardingStates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/onboardingStates/GetAllSentinelOnboardingStates.json new file mode 100644 index 000000000000..a90c5f113cdf --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/onboardingStates/GetAllSentinelOnboardingStates.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/onboardingStates/GetSentinelOnboardingState.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/onboardingStates/GetSentinelOnboardingState.json new file mode 100644 index 000000000000..11d5626f9a77 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/onboardingStates/GetSentinelOnboardingState.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/operations/ListOperations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/operations/ListOperations.json new file mode 100644 index 000000000000..a4cabfcbac7a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/operations/ListOperations.json @@ -0,0 +1,563 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/recommendations/GetRecommendation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/recommendations/GetRecommendation.json new file mode 100644 index 000000000000..3f8b5c460dfe --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/recommendations/GetRecommendation.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/recommendations/GetRecommendations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/recommendations/GetRecommendations.json new file mode 100644 index 000000000000..d4e0389f52c1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/recommendations/GetRecommendations.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/recommendations/PatchRecommendation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/recommendations/PatchRecommendation.json new file mode 100644 index 000000000000..40a09099110e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/recommendations/PatchRecommendation.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-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-12-01-preview/examples/repositories/GetRepositories.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/repositories/GetRepositories.json new file mode 100644 index 000000000000..30228fe1b399 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/repositories/GetRepositories.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-12-01-preview", + "repoType": "Github", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "repositoryAccess": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "repositoryAccess": { + "kind": "OAuth", + "code": "939fd7c6caf754f4f41f", + "state": "state", + "clientId": "54b3c2c0-1f48-4a1c-af9f-6399c3240b73" + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "url": "https://api.github.com/repos/user/reponame", + "fullName": "reponame", + "installationId": 42424242, + "branches": [ + "master", + "develop" + ] + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json new file mode 100644 index 000000000000..bacc0f058b06 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json @@ -0,0 +1,245 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json new file mode 100644 index 000000000000..c155f0e72246 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json new file mode 100644 index 000000000000..660813a4ac76 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json new file mode 100644 index 000000000000..79f0198cf4e5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/settings/DeleteEyesOnSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/settings/DeleteEyesOnSetting.json new file mode 100644 index 000000000000..31d727f356cb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/settings/DeleteEyesOnSetting.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/settings/GetAllSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/settings/GetAllSettings.json new file mode 100644 index 000000000000..0a92c29f6245 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/settings/GetAllSettings.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/settings/GetEyesOnSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/settings/GetEyesOnSetting.json new file mode 100644 index 000000000000..377f52cd0166 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/settings/GetEyesOnSetting.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/settings/UpdateEyesOnSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/settings/UpdateEyesOnSetting.json new file mode 100644 index 000000000000..7ac1d2f6dece --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/settings/UpdateEyesOnSetting.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/sourcecontrols/CreateSourceControl.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/CreateSourceControl.json new file mode 100644 index 000000000000..c768f001160a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/CreateSourceControl.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "api-version": "2023-12-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" + }, + "repositoryAccess": { + "kind": "OAuth", + "code": "939fd7c6caf754f4f41f", + "state": "state", + "clientId": "54b3c2c0-1f48-4a1c-af9f-6399c3240b73" + } + } + } + }, + "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" + }, + "servicePrincipal": { + "id": "2d297bee-cb45-444a-a9ce-904484f0bcd6", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "appId": "42a43de2-b712-4408-9680-2514fed984e6" + }, + "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" + }, + "pullRequest": { + "url": "https://github.com/user/repo/pull/123", + "state": "Open" + } + }, + "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" + }, + "servicePrincipal": { + "id": "2d297bee-cb45-444a-a9ce-904484f0bcd6", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "appId": "42a43de2-b712-4408-9680-2514fed984e6" + }, + "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" + }, + "pullRequest": { + "url": "https://github.com/user/repo/pull/123", + "state": "Open" + } + }, + "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-12-01-preview/examples/sourcecontrols/DeleteSourceControl.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/DeleteSourceControl.json new file mode 100644 index 000000000000..d2a273451b08 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/DeleteSourceControl.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "repositoryAccess": { + "properties": { + "repositoryAccess": { + "kind": "OAuth", + "code": "939fd7c6caf754f4f41f", + "state": "state", + "clientId": "54b3c2c0-1f48-4a1c-af9f-6399c3240b73" + } + } + } + }, + "responses": { + "200": { + "body": { + "warning": { + "code": "SourceControlWarning_DeleteServicePrincipal", + "message": "ServicePrincipal has not been removed due to insufficient permissions." + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/GetSourceControlById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/GetSourceControlById.json new file mode 100644 index 000000000000..eb971d72ff26 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/GetSourceControlById.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-12-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" + }, + "servicePrincipal": { + "id": "2d297bee-cb45-444a-a9ce-904484f0bcd6", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "appId": "42a43de2-b712-4408-9680-2514fed984e6" + }, + "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" + }, + "pullRequest": { + "url": "https://github.com/user/repo/pull/123", + "state": "Open" + } + }, + "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-12-01-preview/examples/sourcecontrols/GetSourceControls.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/GetSourceControls.json new file mode 100644 index 000000000000..ce36da7ff1c6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/sourcecontrols/GetSourceControls.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-12-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" + }, + "servicePrincipal": { + "id": "2d297bee-cb45-444a-a9ce-904484f0bcd6", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "appId": "42a43de2-b712-4408-9680-2514fed984e6" + }, + "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" + }, + "pullRequest": { + "url": "https://github.com/user/repo/pull/123", + "state": "Open" + } + }, + "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-12-01-preview/examples/threatintelligence/AppendTagsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/AppendTagsThreatIntelligence.json new file mode 100644 index 000000000000..587e0c8b7164 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/AppendTagsThreatIntelligence.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/threatintelligence/CollectThreatIntelligenceMetrics.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/CollectThreatIntelligenceMetrics.json new file mode 100644 index 000000000000..78bb81945b3c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/CollectThreatIntelligenceMetrics.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/threatintelligence/CreateThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/CreateThreatIntelligence.json new file mode 100644 index 000000000000..38f12a65bb2a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/CreateThreatIntelligence.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/threatintelligence/DeleteThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/DeleteThreatIntelligence.json new file mode 100644 index 000000000000..c0b466bb7c21 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/DeleteThreatIntelligence.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/threatintelligence/GetThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/GetThreatIntelligence.json new file mode 100644 index 000000000000..3004c7be8a6b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/GetThreatIntelligence.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/threatintelligence/GetThreatIntelligenceById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/GetThreatIntelligenceById.json new file mode 100644 index 000000000000..3a909bf86e07 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/GetThreatIntelligenceById.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/threatintelligence/QueryThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/QueryThreatIntelligence.json new file mode 100644 index 000000000000..1b2ad3d784d9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/QueryThreatIntelligence.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/threatintelligence/ReplaceTagsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/ReplaceTagsThreatIntelligence.json new file mode 100644 index 000000000000..0c0e5b61d6b1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/ReplaceTagsThreatIntelligence.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/threatintelligence/UpdateThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/UpdateThreatIntelligence.json new file mode 100644 index 000000000000..02b7efc50987 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/threatintelligence/UpdateThreatIntelligence.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json new file mode 100644 index 000000000000..167199877dbf --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json new file mode 100644 index 000000000000..63066178c694 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json new file mode 100644 index 000000000000..60748898a9b3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/watchlists/CreateWatchlist.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/CreateWatchlist.json new file mode 100644 index 000000000000..5e304f375282 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/CreateWatchlist.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json new file mode 100644 index 000000000000..a054a755096e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/watchlists/CreateWatchlistItem.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/CreateWatchlistItem.json new file mode 100644 index 000000000000..c92992e067da --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/CreateWatchlistItem.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/watchlists/DeleteWatchlist.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/DeleteWatchlist.json new file mode 100644 index 000000000000..0c5dd410e396 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/DeleteWatchlist.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/DeleteWatchlistItem.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/DeleteWatchlistItem.json new file mode 100644 index 000000000000..8ca98847156a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/DeleteWatchlistItem.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/watchlists/GetWatchlistByAlias.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/GetWatchlistByAlias.json new file mode 100644 index 000000000000..646ec955620b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/GetWatchlistByAlias.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/watchlists/GetWatchlistItemById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/GetWatchlistItemById.json new file mode 100644 index 000000000000..c18bcbb195f8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/GetWatchlistItemById.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/watchlists/GetWatchlistItems.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/GetWatchlistItems.json new file mode 100644 index 000000000000..83f730765cb4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/GetWatchlistItems.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/watchlists/GetWatchlists.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/GetWatchlists.json new file mode 100644 index 000000000000..f724ca257cb3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/watchlists/GetWatchlists.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerAssignments/CreateJob.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/CreateJob.json new file mode 100644 index 000000000000..619dbb03d083 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/CreateJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json new file mode 100644 index 000000000000..b49fc7a5d85a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerAssignments/DeleteJob.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/DeleteJob.json new file mode 100644 index 000000000000..0a489108ad16 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/DeleteJob.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json new file mode 100644 index 000000000000..d0fbcadccae0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerAssignments/GetAllJobs.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/GetAllJobs.json new file mode 100644 index 000000000000..068d9a9d1c55 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/GetAllJobs.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json new file mode 100644 index 000000000000..887085707ab0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerAssignments/GetJob.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/GetJob.json new file mode 100644 index 000000000000..30f90fe38a6c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/GetJob.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json new file mode 100644 index 000000000000..275e3e6e1ce1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json new file mode 100644 index 000000000000..9dcd238dd763 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json new file mode 100644 index 000000000000..f74403e20ccc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json new file mode 100644 index 000000000000..f17b6e38eeb7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json new file mode 100644 index 000000000000..a1dfd9e222c0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json new file mode 100644 index 000000000000..dfdcbb24ad87 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json new file mode 100644 index 000000000000..f39f47bb4585 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json new file mode 100644 index 000000000000..fc553714e699 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json new file mode 100644 index 000000000000..c8cc03a1dd9a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json new file mode 100644 index 000000000000..cd6af550fa22 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-12-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerMemberName": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "workspaceManagerMember": { + "properties": { + "targetWorkspaceResourceId": "/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": { + "targetWorkspaceResourceId": "/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": { + "targetWorkspaceResourceId": "/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-12-01-preview/examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json new file mode 100644 index 000000000000..96946d4f1e43 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-12-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-12-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json new file mode 100644 index 000000000000..64098fed9925 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-12-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": { + "targetWorkspaceResourceId": "/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-12-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json new file mode 100644 index 000000000000..e69b3dc74f40 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-12-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": { + "targetWorkspaceResourceId": "/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-12-01-preview/operations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-01-preview/operations.json new file mode 100644 index 000000000000..1c4dbd13720e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-12-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-12-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 b56908ea7602..e49e7c0a5365 100644 --- a/specification/securityinsights/resource-manager/readme.md +++ b/specification/securityinsights/resource-manager/readme.md @@ -26,17 +26,56 @@ These are the global settings for the SecurityInsights API. ``` yaml openapi-type: arm -tag: package-2023-11 +tag: package-preview-2023-12 ``` --- +### Tag: package-preview-2023-12 + +These settings apply only when `--tag=package-preview-2023-12` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-12' +input-file: + - Microsoft.SecurityInsights/preview/2023-12-01-preview/AlertRules.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/AutomationRules.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/BillingStatistics.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/Bookmarks.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentPackages.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentProductPackages.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentProductTemplates.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/ContentTemplates.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/Enrichment.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/Entities.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/EntityQueries.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/EntityQueryTemplates.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/FileImports.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/Hunts.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/Incidents.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/Metadata.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/OfficeConsents.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/OnboardingStates.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/Recommendations.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/SecurityMLAnalyticsSettings.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/Settings.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/SourceControls.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/ThreatIntelligence.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/TriggeredAnalyticsRuleRuns.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/Watchlists.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/WorkspaceManagerAssignments.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/WorkspaceManagerConfigurations.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/WorkspaceManagerGroups.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/WorkspaceManagerMembers.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/dataConnectorDefinitions.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/dataConnectors.json + - Microsoft.SecurityInsights/preview/2023-12-01-preview/operations.json +``` ### Tag: package-2023-11 These settings apply only when `--tag=package-2023-11` is specified on the command line. -```yaml $(tag) == 'package-2023-11' +``` yaml $(tag) == 'package-2023-11' input-file: - Microsoft.SecurityInsights/stable/2023-11-01/AlertRules.json - Microsoft.SecurityInsights/stable/2023-11-01/AutomationRules.json @@ -55,6 +94,7 @@ input-file: - Microsoft.SecurityInsights/stable/2023-11-01/Watchlists.json - Microsoft.SecurityInsights/stable/2023-11-01/operations.json ``` + ### Tag: package-preview-2023-10 These settings apply only when `--tag=package-preview-2023-10` is specified on the command line. diff --git a/specification/servicefabric/resource-manager/readme.md b/specification/servicefabric/resource-manager/readme.md index 3c35ca897999..9a59de8c5855 100644 --- a/specification/servicefabric/resource-manager/readme.md +++ b/specification/servicefabric/resource-manager/readme.md @@ -59,11 +59,11 @@ 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-11 +### Tag: package-2023-11-preview -These settings apply only when `--tag=package-2023-11` is specified on the command line. +These settings apply only when `--tag=package-2023-11-preview` is specified on the command line. -``` yaml $(tag) == 'package-2023-11' +``` yaml $(tag) == 'package-2023-11-preview' input-file: - Microsoft.ServiceFabric/preview/2023-11-01-preview/cluster.json - Microsoft.ServiceFabric/preview/2023-11-01-preview/application.json diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-12-01-preview/managedapplication.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-12-01-preview/managedapplication.json index 2b44551565c6..991c7c1b8bd1 100644 --- a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-12-01-preview/managedapplication.json +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-12-01-preview/managedapplication.json @@ -1827,10 +1827,12 @@ }, "HealthCheckStableDuration": { "type": "string", + "x-ms-format": "duration-constant", "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", + "x-ms-format": "duration-constant", "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": { diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-12-01-preview/managedcluster.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-12-01-preview/managedcluster.json index 2c22a0061ce3..669b01178115 100644 --- a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-12-01-preview/managedcluster.json +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-12-01-preview/managedcluster.json @@ -992,10 +992,12 @@ "properties": { "healthCheckWaitDuration": { "type": "string", + "x-ms-format": "duration-constant", "description": "The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." }, "healthCheckStableDuration": { "type": "string", + "x-ms-format": "duration-constant", "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." }, "healthCheckRetryTimeout": { diff --git a/specification/servicenetworking/ServiceNetworking.Management/main.tsp b/specification/servicenetworking/ServiceNetworking.Management/main.tsp index 15b4c3b5c564..5cdc7ce30f20 100644 --- a/specification/servicenetworking/ServiceNetworking.Management/main.tsp +++ b/specification/servicenetworking/ServiceNetworking.Management/main.tsp @@ -72,8 +72,9 @@ model AssociationProperties { } #suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" -enum AssociationType { - subnets, +union AssociationType { + string, + "subnets", } @doc("Association Subnet.") @@ -114,14 +115,15 @@ model TrafficControllerProperties { #suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" @lroStatus -enum ProvisioningState { - Provisioning, - Updating, - Deleting, - Accepted, - Succeeded, - Failed, - Canceled, +union ProvisioningState { + string, + Provisioning: "Provisioning", + Updating: "Updating", + Deleting: "Deleting", + Accepted: "Accepted", + Succeeded: "Succeeded", + Failed: "Failed", + Canceled: "Canceled", } @doc("Resource ID definition used by parent to reference child resources.") diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json index 7d609af89916..98ced450dad0 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json @@ -67,7 +67,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -106,7 +106,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TrafficControllerListResult" } @@ -148,7 +148,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TrafficControllerListResult" } @@ -198,7 +198,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TrafficController" } @@ -323,7 +323,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TrafficController" } @@ -385,7 +385,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -433,7 +433,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AssociationListResult" } @@ -491,7 +491,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Association" } @@ -632,7 +632,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Association" } @@ -702,7 +702,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -750,7 +750,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/FrontendListResult" } @@ -808,7 +808,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Frontend" } @@ -949,7 +949,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Frontend" } @@ -1019,7 +1019,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -1251,7 +1251,37 @@ ], "x-ms-enum": { "name": "ProvisioningState", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning" + }, + { + "name": "Updating", + "value": "Updating" + }, + { + "name": "Deleting", + "value": "Deleting" + }, + { + "name": "Accepted", + "value": "Accepted" + }, + { + "name": "Succeeded", + "value": "Succeeded" + }, + { + "name": "Failed", + "value": "Failed" + }, + { + "name": "Canceled", + "value": "Canceled" + } + ] } }, "ResourceId": { diff --git a/specification/sphere/Sphere.Management/catalog.tsp b/specification/sphere/Sphere.Management/catalog.tsp index 4c3c92621d38..bec5ec57fba8 100644 --- a/specification/sphere/Sphere.Management/catalog.tsp +++ b/specification/sphere/Sphere.Management/catalog.tsp @@ -1,9 +1,11 @@ import "@typespec/rest"; +import "@typespec/openapi"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; using TypeSpec.Http; +using TypeSpec.OpenAPI; using TypeSpec.Rest; using TypeSpec.Versioning; using Azure.ResourceManager.Foundations; @@ -25,6 +27,11 @@ model Catalog is TrackedResource { @doc("Catalog properties") model CatalogProperties { + @visibility("read") + @doc("The Azure Sphere tenant ID associated with the catalog.") + @added(Microsoft.AzureSphere.Versions.v2024_04_01) + tenantId?: string; + @visibility("read") @doc("The status of the last operation.") provisioningState?: ProvisioningState; @@ -68,14 +75,28 @@ interface Catalogs Catalog, CatalogProperties > { + @removed(Versions.v2024_04_01) @autoRoute @doc("Counts devices in catalog.") @armResourceAction(Catalog) + @action("countDevices") + @renamedFrom(Versions.v2024_04_01, "countDevices") @post - countDevices( + deprecated( ...ResourceInstanceParameters, ): ArmResponse | ErrorResponse; + #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "preview api" + @added(Versions.v2024_04_01) + @sharedRoute + @autoRoute + @doc("Counts devices in catalog.") + @armResourceAction(Catalog) + @post + countDevices( + ...ResourceInstanceParameters, + ): ArmResponse | ErrorResponse; + @autoRoute @doc("Lists device insights for catalog.") @armResourceAction(Catalog) @@ -115,4 +136,23 @@ interface Catalogs @body listDeviceGroupsRequest: ListDeviceGroupsRequest, ): ArmResponse> | ErrorResponse; + + @autoRoute + @armResourceAction(Catalog) + @added(Versions.v2024_04_01) + @doc("Creates an image. Use this action when the image ID is unknown.") + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + uploadImage( + ...ResourceInstanceParameters, + + @doc("Image upload request body.") + @body + uploadImageRequest: Image, + ): ArmAcceptedLroResponse | ErrorResponse; } diff --git a/specification/sphere/Sphere.Management/common.tsp b/specification/sphere/Sphere.Management/common.tsp index df93ccecdb16..46b88833e479 100644 --- a/specification/sphere/Sphere.Management/common.tsp +++ b/specification/sphere/Sphere.Management/common.tsp @@ -18,54 +18,62 @@ interface Operations extends Azure.ResourceManager.Operations {} // Common models /** Provisioning state of the resource. */ +@doc("Provisioning state of resource.") @lroStatus -enum ProvisioningState { - ...ResourceProvisioningState, +union ProvisioningState { + string, + ResourceProvisioningState, /** The resource is being provisioned */ - Provisioning, + Provisioning: "Provisioning", /** The resource is being updated */ - Updating, + Updating: "Updating", /** The resource is being deleted */ - Deleting, + Deleting: "Deleting", /** The resource create request has been accepted */ - Accepted, + Accepted: "Accepted", } @doc("Regional data boundary values.") -enum RegionalDataBoundary { +union RegionalDataBoundary { + string, + /** No data boundary */ - None, + "None", /** EU data boundary */ - EU, + "EU", } @doc("Allow crash dumps values.") -enum AllowCrashDumpCollection { +union AllowCrashDumpCollection { + string, + /** Crash dump collection enabled */ - Enabled, + "Enabled", /** Crash dump collection disabled */ - Disabled, + "Disabled", } @doc("Certificate status values.") -enum CertificateStatus { +union CertificateStatus { + string, + /** Certificate is active */ - Active, + "Active", /** Certificate is inactive */ - Inactive, + "Inactive", /** Certificate has expired */ - Expired, + "Expired", /** Certificate has been revoked */ - Revoked, + "Revoked", } @doc("Provides the custom '$filter' query parameter for list operations") @@ -103,9 +111,12 @@ alias StandardListQueryParametersWithCorrectNames = { ...CustomMaxPageSizeQueryParameter; }; -@doc("Response to the action call for count devices in a catalog.") +@doc("Response to the action call for count devices in a catalog (preview API).") model CountDeviceResponse extends CountElementsResponse {} +@doc("Response to the action call for count devices in a catalog.") +model CountDevicesResponse extends CountElementsResponse {} + @doc("Response of the count for elements.") model CountElementsResponse { @doc("Number of children resources in parent resource.") diff --git a/specification/sphere/Sphere.Management/device.tsp b/specification/sphere/Sphere.Management/device.tsp index 721646dde28e..59de482d99d9 100644 --- a/specification/sphere/Sphere.Management/device.tsp +++ b/specification/sphere/Sphere.Management/device.tsp @@ -47,7 +47,10 @@ interface ProxyResourceOperationsDevice< @armResourceOperations interface Devices extends ProxyResourceOperationsDevice { @autoRoute + @removed(Versions.v2024_04_01) + @renamedFrom(Versions.v2024_04_01, "generateCapabilityImage") @armResourceAction(Device) + @action("generateCapabilityImage") @post @doc("Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.") @extension("x-ms-long-running-operation", true) @@ -57,13 +60,35 @@ interface Devices extends ProxyResourceOperationsDevice { `final-state-via`: "location", } ) - generateCapabilityImage( + deprecatedGenerateCapabilityImage( ...ResourceInstanceParameters, @doc("Generate capability image request body.") @body generateDeviceCapabilityRequest: GenerateCapabilityImageRequest, ): ArmResponse | ArmAcceptedResponse | ErrorResponse; + + #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "preview api" + @autoRoute + @sharedRoute + @added(Versions.v2024_04_01) + @armResourceAction(Device) + @post + @doc("Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.") + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + generateCapabilityImage( + ...ResourceInstanceParameters, + + @doc("Generate capability image request body.") + @body + generateDeviceCapabilityRequest: GenerateCapabilityImageRequest, + ): ArmResponse | ArmAcceptedLroResponse | ErrorResponse; } @doc("The properties of device") @@ -112,12 +137,14 @@ model SignedCapabilityImageResponse { } @doc("Capability image type") -enum CapabilityType { +union CapabilityType { + string, + /** Application development capability */ - ApplicationDevelopment, + "ApplicationDevelopment", /** Field servicing capability */ - FieldServicing, + "FieldServicing", } @doc("The properties of device patch") diff --git a/specification/sphere/Sphere.Management/deviceGroup.tsp b/specification/sphere/Sphere.Management/deviceGroup.tsp index 9baf49745b17..9dc67b857cc3 100644 --- a/specification/sphere/Sphere.Management/deviceGroup.tsp +++ b/specification/sphere/Sphere.Management/deviceGroup.tsp @@ -50,16 +50,33 @@ interface DeviceGroups DeviceGroup, ListQueryParameters > { + @doc("Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.") + @removed(Versions.v2024_04_01) @autoRoute + @renamedFrom(Versions.v2024_04_01, "countDevices") + @armResourceAction(DeviceGroup) + @action("countDevices") + @post + deprecatedCountDevices( + ...ResourceInstanceParameters, + ): ArmResponse | ErrorResponse; + + #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "preview api" @doc("Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.") + @added(Versions.v2024_04_01) + @autoRoute + @sharedRoute @armResourceAction(DeviceGroup) @post countDevices( ...ResourceInstanceParameters, - ): ArmResponse | ErrorResponse; + ): ArmResponse | ErrorResponse; @autoRoute @armResourceAction(DeviceGroup) + @action("claimDevices") + @removed(Versions.v2024_04_01) + @renamedFrom(Versions.v2024_04_01, "claimDevices") @doc("Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.") @extension("x-ms-long-running-operation", true) @extension( @@ -69,13 +86,35 @@ interface DeviceGroups } ) @post - claimDevices( + deprecatedClaimDevices( ...ResourceInstanceParameters, @doc("Bulk claim devices request body.") @body claimDevicesRequest: ClaimDevicesRequest, ): ArmAcceptedResponse | ErrorResponse; + + #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "preview api" + @autoRoute + @sharedRoute + @added(Versions.v2024_04_01) + @armResourceAction(DeviceGroup) + @doc("Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.") + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + @post + claimDevices( + ...ResourceInstanceParameters, + + @doc("Bulk claim devices request body.") + @body + claimDevicesRequest: ClaimDevicesRequest, + ): ArmAcceptedLroResponse | ErrorResponse; } @doc("The properties of deviceGroup") @@ -105,21 +144,25 @@ model DeviceGroupProperties { } @doc("OS feed type values.") -enum OSFeedType { +union OSFeedType { + string, + /** Retail OS feed type. */ - Retail, + "Retail", /** Retail evaluation OS feed type. */ - RetailEval, + "RetailEval", } @doc("Update policy values.") -enum UpdatePolicy { +union UpdatePolicy { + string, + /** Update all policy. */ - UpdateAll, + "UpdateAll", /** No update for 3rd party app policy. */ - No3rdPartyAppUpdates, + "No3rdPartyAppUpdates", } // Device group models diff --git a/specification/sphere/Sphere.Management/examples/DeleteCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/DeleteCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/DeleteDeployment.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteDeployment.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/DeleteDeployment.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteDeployment.json diff --git a/specification/sphere/Sphere.Management/examples/DeleteDevice.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteDevice.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/DeleteDevice.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteDevice.json diff --git a/specification/sphere/Sphere.Management/examples/DeleteDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteDeviceGroup.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/DeleteDeviceGroup.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteDeviceGroup.json diff --git a/specification/sphere/Sphere.Management/examples/DeleteImage.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteImage.json similarity index 91% rename from specification/sphere/Sphere.Management/examples/DeleteImage.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteImage.json index c87670823a95..3f46df5bf8c8 100644 --- a/specification/sphere/Sphere.Management/examples/DeleteImage.json +++ b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteImage.json @@ -5,7 +5,7 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MyResourceGroup1", "catalogName": "MyCatalog1", - "imageName": "imageID", + "imageName": "00000000-0000-0000-0000-000000000000", "api-version": "2022-09-01-preview" }, "responses": { diff --git a/specification/sphere/Sphere.Management/examples/DeleteProduct.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteProduct.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/DeleteProduct.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteProduct.json diff --git a/specification/sphere/Sphere.Management/examples/GetCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/GetCatalogsRG.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCatalogsRG.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetCatalogsRG.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCatalogsRG.json diff --git a/specification/sphere/Sphere.Management/examples/GetCatalogsSub.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCatalogsSub.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetCatalogsSub.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCatalogsSub.json diff --git a/specification/sphere/Sphere.Management/examples/GetCertificate.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCertificate.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetCertificate.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCertificate.json diff --git a/specification/sphere/Sphere.Management/examples/GetCertificates.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCertificates.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetCertificates.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCertificates.json diff --git a/specification/sphere/Sphere.Management/examples/GetDeployment.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeployment.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetDeployment.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeployment.json diff --git a/specification/sphere/Sphere.Management/examples/GetDeployments.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeployments.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetDeployments.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeployments.json diff --git a/specification/sphere/Sphere.Management/examples/GetDevice.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDevice.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetDevice.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDevice.json diff --git a/specification/sphere/Sphere.Management/examples/GetDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeviceGroup.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetDeviceGroup.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeviceGroup.json diff --git a/specification/sphere/Sphere.Management/examples/GetDeviceGroups.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeviceGroups.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetDeviceGroups.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeviceGroups.json diff --git a/specification/sphere/Sphere.Management/examples/GetDevices.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDevices.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetDevices.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDevices.json diff --git a/specification/sphere/Sphere.Management/examples/GetImage.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetImage.json similarity index 87% rename from specification/sphere/Sphere.Management/examples/GetImage.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetImage.json index 3023a79d50c5..ca620f29bb05 100644 --- a/specification/sphere/Sphere.Management/examples/GetImage.json +++ b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetImage.json @@ -5,7 +5,7 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MyResourceGroup1", "catalogName": "MyCatalog1", - "imageName": "myImageId", + "imageName": "00000000-0000-0000-0000-000000000000", "api-version": "2022-09-01-preview" }, "responses": { diff --git a/specification/sphere/Sphere.Management/examples/GetImages.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetImages.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetImages.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetImages.json diff --git a/specification/sphere/Sphere.Management/examples/GetOperations.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetOperations.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetOperations.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetOperations.json diff --git a/specification/sphere/Sphere.Management/examples/GetProduct.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetProduct.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetProduct.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetProduct.json diff --git a/specification/sphere/Sphere.Management/examples/GetProducts.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetProducts.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetProducts.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetProducts.json diff --git a/specification/sphere/Sphere.Management/examples/PatchCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PatchCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PatchDevice.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchDevice.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PatchDevice.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchDevice.json diff --git a/specification/sphere/Sphere.Management/examples/PatchDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchDeviceGroup.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PatchDeviceGroup.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchDeviceGroup.json diff --git a/specification/sphere/Sphere.Management/examples/PatchProduct.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchProduct.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PatchProduct.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchProduct.json diff --git a/specification/sphere/Sphere.Management/examples/PostClaimDevices.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostClaimDevices.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostClaimDevices.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostClaimDevices.json diff --git a/specification/sphere/Sphere.Management/examples/PostCountDevicesCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostCountDevicesCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostCountDevicesCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostCountDevicesCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PostCountDevicesDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostCountDevicesDeviceGroup.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostCountDevicesDeviceGroup.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostCountDevicesDeviceGroup.json diff --git a/specification/sphere/Sphere.Management/examples/PostCountDevicesProduct.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostCountDevicesProduct.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostCountDevicesProduct.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostCountDevicesProduct.json diff --git a/specification/sphere/Sphere.Management/examples/PostGenerateDefaultDeviceGroups.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostGenerateDefaultDeviceGroups.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostGenerateDefaultDeviceGroups.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostGenerateDefaultDeviceGroups.json diff --git a/specification/sphere/Sphere.Management/examples/PostGenerateDeviceCapabilityImage.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostGenerateDeviceCapabilityImage.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostGenerateDeviceCapabilityImage.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostGenerateDeviceCapabilityImage.json diff --git a/specification/sphere/Sphere.Management/examples/PostListDeploymentsByCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDeploymentsByCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostListDeploymentsByCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDeploymentsByCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PostListDeviceGroupsCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDeviceGroupsCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostListDeviceGroupsCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDeviceGroupsCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PostListDeviceInsightsCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDeviceInsightsCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostListDeviceInsightsCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDeviceInsightsCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PostListDevicesByCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDevicesByCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostListDevicesByCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDevicesByCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PostRetrieveCatalogCertChain.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostRetrieveCatalogCertChain.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostRetrieveCatalogCertChain.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostRetrieveCatalogCertChain.json diff --git a/specification/sphere/Sphere.Management/examples/PostRetrieveProofOfPossessionNonce.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostRetrieveProofOfPossessionNonce.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostRetrieveProofOfPossessionNonce.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostRetrieveProofOfPossessionNonce.json diff --git a/specification/sphere/Sphere.Management/examples/PutCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PutCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PutDeployment.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutDeployment.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PutDeployment.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutDeployment.json diff --git a/specification/sphere/Sphere.Management/examples/PutDevice.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutDevice.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PutDevice.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutDevice.json diff --git a/specification/sphere/Sphere.Management/examples/PutDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutDeviceGroup.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PutDeviceGroup.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutDeviceGroup.json diff --git a/specification/sphere/Sphere.Management/examples/PutImage.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutImage.json similarity index 97% rename from specification/sphere/Sphere.Management/examples/PutImage.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutImage.json index c28ad12e90d3..7034054644d6 100644 --- a/specification/sphere/Sphere.Management/examples/PutImage.json +++ b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutImage.json @@ -5,7 +5,7 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MyResourceGroup1", "catalogName": "MyCatalog1", - "imageName": "default", + "imageName": ".default", "resource": { "properties": { "image": "bXliYXNlNjRzdHJpbmc=" diff --git a/specification/sphere/Sphere.Management/examples/PutProduct.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutProduct.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PutProduct.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutProduct.json diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteCatalog.json new file mode 100644 index 000000000000..658bc7b9990c --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteCatalog.json @@ -0,0 +1,24 @@ +{ + "operationId": "Catalogs_Delete", + "title": "Catalogs_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeployment.json b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeployment.json new file mode 100644 index 000000000000..6a3411f17082 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeployment.json @@ -0,0 +1,27 @@ +{ + "operationId": "Deployments_Delete", + "title": "Deployments_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProductName1", + "deviceGroupName": "DeviceGroupName1", + "deploymentName": "MyDeploymentName1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDevice.json b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDevice.json new file mode 100644 index 000000000000..057b4d7b71c7 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDevice.json @@ -0,0 +1,27 @@ +{ + "operationId": "Devices_Delete", + "title": "Devices_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProductName1", + "deviceGroupName": "DeviceGroupName1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeviceGroup.json new file mode 100644 index 000000000000..41eab5c0492c --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeviceGroup.json @@ -0,0 +1,26 @@ +{ + "operationId": "DeviceGroups_Delete", + "title": "DeviceGroups_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteImage.json b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteImage.json new file mode 100644 index 000000000000..45b70048d57b --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteImage.json @@ -0,0 +1,25 @@ +{ + "operationId": "Images_Delete", + "title": "Images_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "imageName": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteProduct.json b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteProduct.json new file mode 100644 index 000000000000..0f5433be7216 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteProduct.json @@ -0,0 +1,25 @@ +{ + "operationId": "Products_Delete", + "title": "Products_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProductName1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalog.json new file mode 100644 index 000000000000..87771799dffc --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalog.json @@ -0,0 +1,21 @@ +{ + "operationId": "Catalogs_Get", + "title": "Catalogs_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsRG.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsRG.json new file mode 100644 index 000000000000..488c94bc3c23 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsRG.json @@ -0,0 +1,30 @@ +{ + "operationId": "Catalogs_ListByResourceGroup", + "title": "Catalogs_ListByResourceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog2", + "name": "MyCatalog2", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsSub.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsSub.json new file mode 100644 index 000000000000..d715ad91a2ef --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsSub.json @@ -0,0 +1,29 @@ +{ + "operationId": "Catalogs_ListBySubscription", + "title": "Catalogs_ListBySubscription", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup2/providers/Microsoft.AzureSphere/catalogs/MyCatalog2", + "name": "MyCatalog2", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificate.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificate.json new file mode 100644 index 000000000000..a8c64f3db445 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificate.json @@ -0,0 +1,17 @@ +{ + "operationId": "Certificates_Get", + "title": "Certificates_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "serialNumber": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": {} + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificates.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificates.json new file mode 100644 index 000000000000..9c3fd6281498 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificates.json @@ -0,0 +1,18 @@ +{ + "operationId": "Certificates_ListByCatalog", + "title": "Certificates_ListByCatalog", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployment.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployment.json new file mode 100644 index 000000000000..fc9af844c81f --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployment.json @@ -0,0 +1,38 @@ +{ + "operationId": "Deployments_Get", + "title": "Deployments_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deploymentName": "MyDeployment1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "properties": { + "deployedImages": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1", + "properties": { + "image": "dGVzdGltYWdl", + "regionalDataBoundary": "None", + "uri": "imageUri", + "description": "description", + "componentId": "componentId", + "imageType": "ImageType", + "provisioningState": "Succeeded" + } + } + ] + } + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployments.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployments.json new file mode 100644 index 000000000000..eef2ff5d1ac8 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployments.json @@ -0,0 +1,42 @@ +{ + "operationId": "Deployments_ListByDeviceGroup", + "title": "Deployments_ListByDeviceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "properties": { + "deployedImages": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1", + "properties": { + "image": "dGVzdGltYWdl", + "regionalDataBoundary": "None", + "uri": "imageUri", + "description": "description", + "componentId": "componentId", + "imageType": "ImageType", + "provisioningState": "Succeeded" + } + } + ], + "deploymentDateUtc": "2022-09-30T21:51:39.2698729Z" + } + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetDevice.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDevice.json new file mode 100644 index 000000000000..858ee313939f --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDevice.json @@ -0,0 +1,29 @@ +{ + "operationId": "Devices_Get", + "title": "Devices_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": { + "chipSku": "MyChipSku1", + "lastAvailableOsVersion": "AvailableOsVersion1", + "lastInstalledOsVersion": "InstalledOsVersion1", + "lastOsUpdateUtc": "2022-09-30T23:54:21.96Z", + "lastUpdateRequestUtc": "2022-10-01T23:54:21.96Z" + } + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroup.json new file mode 100644 index 000000000000..1e8379ab7772 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroup.json @@ -0,0 +1,26 @@ +{ + "operationId": "DeviceGroups_Get", + "title": "DeviceGroups_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups", + "properties": { + "description": "The description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroups.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroups.json new file mode 100644 index 000000000000..46123e6f6d98 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroups.json @@ -0,0 +1,30 @@ +{ + "operationId": "DeviceGroups_ListByProduct", + "title": "DeviceGroups_ListByProduct", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "name": "MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/Products/MyProduct2/devicegroups/MyDeviceGroup2", + "name": "MyDeviceGroup2", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetDevices.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDevices.json new file mode 100644 index 000000000000..c011cde1148a --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDevices.json @@ -0,0 +1,29 @@ +{ + "operationId": "Devices_ListByDeviceGroup", + "title": "Devices_ListByDeviceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000-0000-0000-0000-000000000001", + "properties": {} + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000-0000-0000-0000-000000000002", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetImage.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetImage.json new file mode 100644 index 000000000000..8943a1fcf403 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetImage.json @@ -0,0 +1,17 @@ +{ + "operationId": "Images_Get", + "title": "Images_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "imageName": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": {} + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetImages.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetImages.json new file mode 100644 index 000000000000..7701f85222a1 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetImages.json @@ -0,0 +1,27 @@ +{ + "operationId": "Images_ListByCatalog", + "title": "Images_ListByCatalog", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "00000000-0000-0000-0000-000000000001", + "name": "MyImage1" + }, + { + "id": "00000000-0000-0000-0000-000000000002", + "name": "MyImage2" + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetOperations.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetOperations.json new file mode 100644 index 000000000000..5a4b09163c2d --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetOperations.json @@ -0,0 +1,35 @@ +{ + "operationId": "Operations_List", + "title": "Operations_List", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "name": "Microsoft.AzureSphere/catalogs/Read", + "display": { + "provider": "Microsoft.AzureSphere", + "resource": "catalog", + "operation": "Gets/List catalog", + "description": "Read Azure Sphere catalogs" + } + }, + { + "name": "Microsoft.AzureSphere/catalogs/Write", + "display": { + "provider": "Microsoft.AzureSphere", + "resource": "catalog", + "operation": "Create/Update catalog", + "description": "Writes Azure Sphere catalogs" + } + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetProduct.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetProduct.json new file mode 100644 index 000000000000..570db8296b81 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetProduct.json @@ -0,0 +1,23 @@ +{ + "operationId": "Products_Get", + "title": "Products_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "type": "microsoft.azureSphere/catalogs/products", + "properties": { + "description": "product description." + } + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetProducts.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetProducts.json new file mode 100644 index 000000000000..915cd38158a3 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetProducts.json @@ -0,0 +1,29 @@ +{ + "operationId": "Products_ListByCatalog", + "title": "Products_ListByCatalog", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/products" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct2", + "name": "MyProduct2", + "type": "Microsoft.AzureSphere/catalogs/products" + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PatchCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchCatalog.json new file mode 100644 index 000000000000..bec2ebeca152 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchCatalog.json @@ -0,0 +1,25 @@ +{ + "operationId": "Catalogs_Update", + "title": "Catalogs_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "properties": {}, + "resource": { + "location": "global" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PatchDevice.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchDevice.json new file mode 100644 index 000000000000..6dd5ed784af2 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchDevice.json @@ -0,0 +1,36 @@ +{ + "operationId": "Devices_Update", + "title": "Devices_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1/device/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "type": "Microsoft.AzureSphere/catalogs/products/devicegroups", + "properties": { + "chipSku": "MyChipSku1", + "lastAvailableOsVersion": "AvailableOsVersion1", + "lastInstalledOsVersion": "InstalledOsVersion1", + "lastOsUpdateUtc": "2022-10-30T23:54:21.96Z", + "lastUpdateRequestUtc": "2022-10-01T23:54:21.96Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "description": "The device update started successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PatchDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchDeviceGroup.json new file mode 100644 index 000000000000..84cd946a5ca9 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchDeviceGroup.json @@ -0,0 +1,33 @@ +{ + "operationId": "DeviceGroups_Update", + "title": "DeviceGroups_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "properties": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups", + "properties": { + "description": "The description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "description": "Resource update request accepted." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PatchProduct.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchProduct.json new file mode 100644 index 000000000000..e2da1aafeb7e --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchProduct.json @@ -0,0 +1,30 @@ +{ + "operationId": "Products_Update", + "title": "Products_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "properties": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "type": "microsoft.azureSphere/catalogs/products", + "properties": { + "description": "Product description." + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "description": "Resource update request accepted." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostClaimDevices.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostClaimDevices.json new file mode 100644 index 000000000000..193ef5d3e2a6 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostClaimDevices.json @@ -0,0 +1,25 @@ +{ + "operationId": "DeviceGroups_ClaimDevices", + "title": "DeviceGroups_ClaimDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "claimDevicesRequest": { + "deviceIdentifiers": [ + "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + ] + }, + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesCatalog.json new file mode 100644 index 000000000000..979f312d235a --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesCatalog.json @@ -0,0 +1,18 @@ +{ + "operationId": "Catalogs_CountDevices", + "title": "Catalogs_CountDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": 3 + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesDeviceGroup.json new file mode 100644 index 000000000000..45e5e0b05ad3 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesDeviceGroup.json @@ -0,0 +1,20 @@ +{ + "operationId": "DeviceGroups_CountDevices", + "title": "DeviceGroups_CountDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": 3 + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesProduct.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesProduct.json new file mode 100644 index 000000000000..4ca2bcd28a2c --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesProduct.json @@ -0,0 +1,21 @@ +{ + "operationId": "Products_CountDevices", + "title": "Products_CountDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "productGroupName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": 3 + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDefaultDeviceGroups.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDefaultDeviceGroups.json new file mode 100644 index 000000000000..b86ea57c2833 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDefaultDeviceGroups.json @@ -0,0 +1,40 @@ +{ + "operationId": "Products_GenerateDefaultDeviceGroups", + "title": "Products_GenerateDefaultDeviceGroups", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "name": "MyDeviceGroup1", + "properties": { + "description": "Device group description 1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll", + "allowCrashDumpsCollection": "Enabled" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup2", + "name": "MyDeviceGroup2", + "properties": { + "description": "Device group description 2", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll", + "allowCrashDumpsCollection": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDeviceCapabilityImage.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDeviceCapabilityImage.json new file mode 100644 index 000000000000..3f10e240a86c --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDeviceCapabilityImage.json @@ -0,0 +1,32 @@ +{ + "operationId": "Devices_GenerateCapabilityImage", + "title": "Devices_GenerateCapabilityImage", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "generateDeviceCapabilityRequest": { + "capabilities": [ + "ApplicationDevelopment" + ] + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "image": "TheDeviceCapabilityImage" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeploymentsByCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeploymentsByCatalog.json new file mode 100644 index 000000000000..9e1bafb39819 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeploymentsByCatalog.json @@ -0,0 +1,27 @@ +{ + "operationId": "Catalogs_ListDeployments", + "title": "Catalogs_ListDeployments", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "name": "DeploymentName1111", + "properties": {} + }, + { + "name": "DeploymentName1121", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceGroupsCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceGroupsCatalog.json new file mode 100644 index 000000000000..59a575a79ed0 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceGroupsCatalog.json @@ -0,0 +1,32 @@ +{ + "operationId": "Catalogs_ListDeviceGroups", + "title": "Catalogs_ListDeviceGroups", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "listDeviceGroupsRequest": { + "deviceGroupName": "MyDeviceGroup1" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "name": "MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct2/devicegroups/MyDeviceGroup2", + "name": "MyDeviceGroup2", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceInsightsCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceInsightsCatalog.json new file mode 100644 index 000000000000..836f912dca25 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceInsightsCatalog.json @@ -0,0 +1,40 @@ +{ + "operationId": "Catalogs_ListDeviceInsights", + "title": "Catalogs_ListDeviceInsights", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "$top": 10, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "description": "eventDescription1", + "deviceId": "eventIdentifier1", + "startTimestampUtc": "2021-09-30T21:51:39.26Z", + "endTimestampUtc": "2021-09-30T23:54:21.96Z", + "eventCategory": "eventCategory1", + "eventClass": "eventClass1", + "eventType": "eventType1", + "eventCount": 1 + }, + { + "description": "eventDescription2", + "deviceId": "eventIdentifier2", + "startTimestampUtc": "2022-12-06T12:41:39.26Z", + "endTimestampUtc": "2022-12-07T17:34:12.50Z", + "eventCategory": "eventCategory2", + "eventClass": "eventClass2", + "eventType": "eventType2", + "eventCount": 1 + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDevicesByCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDevicesByCatalog.json new file mode 100644 index 000000000000..adfc7215cb82 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDevicesByCatalog.json @@ -0,0 +1,27 @@ +{ + "operationId": "Catalogs_ListDevices", + "title": "Catalogs_ListDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": {} + }, + { + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveCatalogCertChain.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveCatalogCertChain.json new file mode 100644 index 000000000000..d899e89ea6d6 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveCatalogCertChain.json @@ -0,0 +1,19 @@ +{ + "operationId": "Certificates_RetrieveCertChain", + "title": "Certificates_RetrieveCertChain", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "serialNumber": "active", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "certificateChain": "ABynaryRepresentationOfTheRequestedCatalogCertificateChain" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveProofOfPossessionNonce.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveProofOfPossessionNonce.json new file mode 100644 index 000000000000..400c9af86b8a --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveProofOfPossessionNonce.json @@ -0,0 +1,22 @@ +{ + "operationId": "Certificates_RetrieveProofOfPossessionNonce", + "title": "Certificates_RetrieveProofOfPossessionNonce", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "serialNumber": "active", + "proofOfPossessionNonceRequest": { + "proofOfPossessionNonce": "proofOfPossessionNonce" + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "certificate": "bXliYXNlNjRzdHJpbmc=" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostUploadImageCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostUploadImageCatalog.json new file mode 100644 index 000000000000..022a60a12a4f --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostUploadImageCatalog.json @@ -0,0 +1,23 @@ +{ + "operationId": "Catalogs_UploadImage", + "title": "Catalogs_UploadImage", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "uploadImageRequest": { + "properties": { + "image": "bXliYXNlNjRzdHJpbmc=" + } + } + }, + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PutCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PutCatalog.json new file mode 100644 index 000000000000..6fedad40487c --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PutCatalog.json @@ -0,0 +1,34 @@ +{ + "operationId": "Catalogs_CreateOrUpdate", + "title": "Catalogs_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "location": "global", + "resource": { + "location": "global" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PutDeployment.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PutDeployment.json new file mode 100644 index 000000000000..ce2abff598ca --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PutDeployment.json @@ -0,0 +1,47 @@ +{ + "operationId": "Deployments_CreateOrUpdate", + "title": "Deployments_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deploymentName": "MyDeployment1", + "api-version": "2024-04-01", + "resource": {} + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "properties": { + "deployedImages": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1", + "properties": { + "image": "MyImage", + "imageId": "00000000-0000-0000-0000-000000000000", + "uri": "imageUri", + "regionalDataBoundary": "None", + "imageType": "InvalidImageType", + "provisioningState": "Succeeded" + } + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups/deployments" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PutDevice.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PutDevice.json new file mode 100644 index 000000000000..7e69ec373bf2 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PutDevice.json @@ -0,0 +1,34 @@ +{ + "operationId": "Devices_CreateOrUpdate", + "title": "Devices_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "api-version": "2024-04-01", + "resource": {} + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": { + "chipSku": "MyChipSku1" + } + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups/devices" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PutDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PutDeviceGroup.json new file mode 100644 index 000000000000..eaf9e7a53c95 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PutDeviceGroup.json @@ -0,0 +1,46 @@ +{ + "operationId": "DeviceGroups_CreateOrUpdate", + "title": "DeviceGroups_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01", + "resource": { + "properties": { + "description": "Description for MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "type": "microsoft.AzureSphere/catalogs/products/devicegroups", + "properties": { + "description": "Description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1", + "name": "MyDeviceId1", + "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups", + "properties": { + "description": "Description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PutImage.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PutImage.json new file mode 100644 index 000000000000..6d26ad07a8ae --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PutImage.json @@ -0,0 +1,34 @@ +{ + "operationId": "Images_CreateOrUpdate", + "title": "Image_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "imageName": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": { + "image": "bXliYXNlNjRzdHJpbmc=" + } + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/default", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/images" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/default", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/images" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PutProduct.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PutProduct.json new file mode 100644 index 000000000000..75a53ec45323 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PutProduct.json @@ -0,0 +1,30 @@ +{ + "operationId": "Products_CreateOrUpdate", + "title": "Products_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01", + "resource": {} + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/products" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/image.tsp b/specification/sphere/Sphere.Management/image.tsp index 5bb6bec02d80..a1563a864d85 100644 --- a/specification/sphere/Sphere.Management/image.tsp +++ b/specification/sphere/Sphere.Management/image.tsp @@ -1,9 +1,11 @@ import "@typespec/rest"; +import "@typespec/openapi"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; using TypeSpec.Http; +using TypeSpec.OpenAPI; using TypeSpec.Rest; using TypeSpec.Versioning; using Azure.ResourceManager.Foundations; @@ -16,7 +18,7 @@ namespace Microsoft.AzureSphere; @doc("An image resource belonging to a catalog resource.") @parentResource(Catalog) model Image is ProxyResource { - @doc("Image name. Use .default for image creation.") + @doc("Image name. Use an image GUID for GA versions of the API.") @key("imageName") @path @segment("images") @@ -69,83 +71,79 @@ model ImageProperties { provisioningState?: ProvisioningState; } -@doc("Image upload request body.") -model ImageUploadRequestBody { - @doc(".") - images: string; -} - @doc("Image type values.") -enum ImageType { +union ImageType { + string, + /** Invalid image. */ - InvalidImageType, + "InvalidImageType", /** One Bl image type */ - OneBl, + "OneBl", /** Pluton image type */ - PlutonRuntime, + "PlutonRuntime", /** Wifi firmware image type */ - WifiFirmware, + "WifiFirmware", /** Security monitor image type */ - SecurityMonitor, + "SecurityMonitor", /** Normal world loader image type */ - NormalWorldLoader, + "NormalWorldLoader", /** Normal world dtb image type */ - NormalWorldDtb, + "NormalWorldDtb", /** Normal world kernel image type */ - NormalWorldKernel, + "NormalWorldKernel", /** Root FS image type */ - RootFs, + "RootFs", /** Services image type */ - Services, + "Services", /** Applications image type */ - Applications, + "Applications", /** FW config image type */ - FwConfig, + "FwConfig", /** Boot manifest image type */ - BootManifest, + "BootManifest", /** Nwfs image type */ - Nwfs, + "Nwfs", /** Trusted key store image type */ - TrustedKeystore, + "TrustedKeystore", /** Policy image type */ - Policy, + "Policy", /** Customer board config image type */ - CustomerBoardConfig, + "CustomerBoardConfig", /** Update certificate store image type */ - UpdateCertStore, + "UpdateCertStore", /** Base system update manifest image type */ - BaseSystemUpdateManifest, + "BaseSystemUpdateManifest", /** Firmware update manifest image type */ - FirmwareUpdateManifest, + "FirmwareUpdateManifest", /** Customer update manifest image type */ - CustomerUpdateManifest, + "CustomerUpdateManifest", /** Recovery manifest image type */ - RecoveryManifest, + "RecoveryManifest", /** manifest set image type */ - ManifestSet, + "ManifestSet", /** Other image type */ - Other, + "Other", } diff --git a/specification/sphere/Sphere.Management/main.tsp b/specification/sphere/Sphere.Management/main.tsp index 7bd635ad2bb0..b3a4b71fa8b9 100644 --- a/specification/sphere/Sphere.Management/main.tsp +++ b/specification/sphere/Sphere.Management/main.tsp @@ -22,9 +22,20 @@ using Azure.ResourceManager; @armProviderNamespace @service({ title: "AzureSphereProviderClient", - version: "2022-09-01-preview", }) @doc("Azure Sphere resource management API.") -@useDependency(Azure.Core.Versions.v1_0_Preview_1) -@useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) +@versioned(Microsoft.AzureSphere.Versions) namespace Microsoft.AzureSphere; + +@doc("Azure Sphere API versions.") +enum Versions { + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("Public preview API version.") + v2022_09_01: "2022-09-01-preview", + + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("Initial GA API version.") + v2024_04_01: "2024-04-01", +} diff --git a/specification/sphere/Sphere.Management/product.tsp b/specification/sphere/Sphere.Management/product.tsp index 09d6c83c9dad..d3454c530887 100644 --- a/specification/sphere/Sphere.Management/product.tsp +++ b/specification/sphere/Sphere.Management/product.tsp @@ -52,19 +52,34 @@ interface Products extends ProxyResourceOperationsProducts { ...ResourceInstanceParameters, ): ArmResponse> | ErrorResponse; + @doc("Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name.") + @removed(Versions.v2024_04_01) @autoRoute + @renamedFrom(Versions.v2024_04_01, "countDevices") + @armResourceAction(Product) + @action("countDevices") + @post + deprecated( + ...ResourceInstanceParameters, + ): ArmResponse | ErrorResponse; + + #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "preview api" @doc("Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name.") + @added(Versions.v2024_04_01) + @autoRoute + @sharedRoute @armResourceAction(Product) @post countDevices( ...ResourceInstanceParameters, - ): ArmResponse | ErrorResponse; + ): ArmResponse | ErrorResponse; } @doc("The properties of product") model ProductProperties { + @madeOptional(Versions.v2024_04_01) @doc("Description of the product") - description: string; + description?: string; @visibility("read") @doc("The status of the last operation.") diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json index 077b2b100494..df57a610fda4 100644 --- a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json @@ -79,7 +79,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -118,7 +118,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CatalogListResult" } @@ -160,7 +160,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CatalogListResult" } @@ -210,7 +210,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Catalog" } @@ -335,7 +335,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Catalog" } @@ -397,7 +397,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -457,7 +457,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CertificateListResult" } @@ -514,7 +514,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Certificate" } @@ -568,7 +568,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CertificateChainResponse" } @@ -631,7 +631,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProofOfPossessionNonceResponse" } @@ -678,7 +678,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CountDeviceResponse" } @@ -737,7 +737,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ImageListResult" } @@ -787,14 +787,14 @@ { "name": "imageName", "in": "path", - "description": "Image name. Use .default for image creation.", + "description": "Image name. Use an image GUID for GA versions of the API.", "required": true, "type": "string" } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Image" } @@ -839,7 +839,7 @@ { "name": "imageName", "in": "path", - "description": "Image name. Use .default for image creation.", + "description": "Image name. Use an image GUID for GA versions of the API.", "required": true, "type": "string" }, @@ -917,7 +917,7 @@ { "name": "imageName", "in": "path", - "description": "Image name. Use .default for image creation.", + "description": "Image name. Use an image GUID for GA versions of the API.", "required": true, "type": "string" } @@ -941,7 +941,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -1001,7 +1001,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentListResult" } @@ -1072,7 +1072,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeviceGroupListResult" } @@ -1134,7 +1134,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PagedDeviceInsight" } @@ -1196,7 +1196,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeviceListResult" } @@ -1246,7 +1246,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProductListResult" } @@ -1304,7 +1304,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Product" } @@ -1445,7 +1445,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Product" } @@ -1533,7 +1533,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -1589,7 +1589,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CountDeviceResponse" } @@ -1656,7 +1656,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeviceGroupListResult" } @@ -1722,7 +1722,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeviceGroup" } @@ -1879,7 +1879,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeviceGroup" } @@ -1975,7 +1975,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -2119,7 +2119,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CountDeviceResponse" } @@ -2194,7 +2194,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentListResult" } @@ -2267,7 +2267,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Deployment" } @@ -2446,7 +2446,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -2510,7 +2510,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeviceListResult" } @@ -2584,7 +2584,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Device" } @@ -2757,7 +2757,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Device" } @@ -2857,7 +2857,7 @@ } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -2938,7 +2938,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SignedCapabilityImageResponse" } @@ -3007,7 +3007,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeviceGroupListResult" } @@ -3292,6 +3292,15 @@ ] }, "CountDeviceResponse": { + "type": "object", + "description": "Response to the action call for count devices in a catalog (preview API).", + "allOf": [ + { + "$ref": "#/definitions/CountElementsResponse" + } + ] + }, + "CountDevicesResponse": { "type": "object", "description": "Response to the action call for count devices in a catalog.", "allOf": [ @@ -3948,19 +3957,6 @@ ] } }, - "ImageUploadRequestBody": { - "type": "object", - "description": "Image upload request body.", - "properties": { - "images": { - "type": "string", - "description": "." - } - }, - "required": [ - "images" - ] - }, "ListDeviceGroupsRequest": { "type": "object", "description": "Request of the action to list device groups for a catalog.", @@ -4120,7 +4116,7 @@ }, "ProvisioningState": { "type": "string", - "description": "Provisioning state of the resource.", + "description": "Provisioning state of resource.", "enum": [ "Succeeded", "Failed", @@ -4230,6 +4226,30 @@ } ] } + }, + "Versions": { + "type": "string", + "description": "Azure Sphere API versions.", + "enum": [ + "2022-09-01-preview", + "2024-04-01" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2022_09_01", + "value": "2022-09-01-preview", + "description": "Public preview API version." + }, + { + "name": "v2024_04_01", + "value": "2024-04-01", + "description": "Initial GA API version." + } + ] + } } }, "parameters": { diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/DeleteImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/DeleteImage.json index c87670823a95..3f46df5bf8c8 100644 --- a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/DeleteImage.json +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/DeleteImage.json @@ -5,7 +5,7 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MyResourceGroup1", "catalogName": "MyCatalog1", - "imageName": "imageID", + "imageName": "00000000-0000-0000-0000-000000000000", "api-version": "2022-09-01-preview" }, "responses": { diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/GetImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/GetImage.json index 3023a79d50c5..ca620f29bb05 100644 --- a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/GetImage.json +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/GetImage.json @@ -5,7 +5,7 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MyResourceGroup1", "catalogName": "MyCatalog1", - "imageName": "myImageId", + "imageName": "00000000-0000-0000-0000-000000000000", "api-version": "2022-09-01-preview" }, "responses": { diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/PutImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/PutImage.json index c28ad12e90d3..7034054644d6 100644 --- a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/PutImage.json +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/PutImage.json @@ -5,7 +5,7 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MyResourceGroup1", "catalogName": "MyCatalog1", - "imageName": "default", + "imageName": ".default", "resource": { "properties": { "image": "bXliYXNlNjRzdHJpbmc=" diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json new file mode 100644 index 000000000000..5e12cedede4c --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json @@ -0,0 +1,4374 @@ +{ + "swagger": "2.0", + "info": { + "title": "AzureSphereProviderClient", + "version": "2024-04-01", + "description": "Azure Sphere resource management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Catalogs" + }, + { + "name": "Images" + }, + { + "name": "DeviceGroups" + }, + { + "name": "Certificates" + }, + { + "name": "Deployments" + }, + { + "name": "Devices" + }, + { + "name": "Products" + } + ], + "paths": { + "/providers/Microsoft.AzureSphere/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure 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-examples": { + "Operations_List": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureSphere/catalogs": { + "get": { + "operationId": "Catalogs_ListBySubscription", + "tags": [ + "Catalogs" + ], + "description": "List Catalog resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListBySubscription": { + "$ref": "./examples/GetCatalogsSub.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs": { + "get": { + "operationId": "Catalogs_ListByResourceGroup", + "tags": [ + "Catalogs" + ], + "description": "List Catalog resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListByResourceGroup": { + "$ref": "./examples/GetCatalogsRG.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}": { + "get": { + "operationId": "Catalogs_Get", + "tags": [ + "Catalogs" + ], + "description": "Get 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_Get": { + "$ref": "./examples/GetCatalog.json" + } + } + }, + "put": { + "operationId": "Catalogs_CreateOrUpdate", + "tags": [ + "Catalogs" + ], + "description": "Create 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Catalog" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Catalog' update operation succeeded", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "201": { + "description": "Resource 'Catalog' create operation succeeded", + "schema": { + "$ref": "#/definitions/Catalog" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_CreateOrUpdate": { + "$ref": "./examples/PutCatalog.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Catalogs_Update", + "tags": [ + "Catalogs" + ], + "description": "Update 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CatalogUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_Update": { + "$ref": "./examples/PatchCatalog.json" + } + } + }, + "delete": { + "operationId": "Catalogs_Delete", + "tags": [ + "Catalogs" + ], + "description": "Delete 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_Delete": { + "$ref": "./examples/DeleteCatalog.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates": { + "get": { + "operationId": "Certificates_ListByCatalog", + "tags": [ + "Certificates" + ], + "description": "List Certificate resources by Catalog", + "parameters": [ + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Certificates_ListByCatalog": { + "$ref": "./examples/GetCertificates.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}": { + "get": { + "operationId": "Certificates_Get", + "tags": [ + "Certificates" + ], + "description": "Get a Certificate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "serialNumber", + "in": "path", + "description": "Serial number of the certificate. Use '.default' to get current active certificate.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Certificate" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Certificates_Get": { + "$ref": "./examples/GetCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveCertChain": { + "post": { + "operationId": "Certificates_RetrieveCertChain", + "tags": [ + "Certificates" + ], + "description": "Retrieves cert chain.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "serialNumber", + "in": "path", + "description": "Serial number of the certificate. Use '.default' to get current active certificate.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateChainResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Certificates_RetrieveCertChain": { + "$ref": "./examples/PostRetrieveCatalogCertChain.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveProofOfPossessionNonce": { + "post": { + "operationId": "Certificates_RetrieveProofOfPossessionNonce", + "tags": [ + "Certificates" + ], + "description": "Gets the proof of possession nonce.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "serialNumber", + "in": "path", + "description": "Serial number of the certificate. Use '.default' to get current active certificate.", + "required": true, + "type": "string" + }, + { + "name": "proofOfPossessionNonceRequest", + "in": "body", + "description": "Proof of possession nonce request body ", + "required": true, + "schema": { + "$ref": "#/definitions/ProofOfPossessionNonceRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProofOfPossessionNonceResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Certificates_RetrieveProofOfPossessionNonce": { + "$ref": "./examples/PostRetrieveProofOfPossessionNonce.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/countDevices": { + "post": { + "operationId": "Catalogs_CountDevices", + "tags": [ + "Catalogs" + ], + "description": "Counts devices in 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CountDevicesResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_CountDevices": { + "$ref": "./examples/PostCountDevicesCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images": { + "get": { + "operationId": "Images_ListByCatalog", + "tags": [ + "Images" + ], + "description": "List Image resources by Catalog", + "parameters": [ + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_ListByCatalog": { + "$ref": "./examples/GetImages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images/{imageName}": { + "get": { + "operationId": "Images_Get", + "tags": [ + "Images" + ], + "description": "Get a 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "imageName", + "in": "path", + "description": "Image name. Use an image GUID for GA versions of the API.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_Get": { + "$ref": "./examples/GetImage.json" + } + } + }, + "put": { + "operationId": "Images_CreateOrUpdate", + "tags": [ + "Images" + ], + "description": "Create a 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "imageName", + "in": "path", + "description": "Image name. Use an image GUID for GA versions of the API.", + "required": true, + "type": "string" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Image" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Image' update operation succeeded", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Resource 'Image' create operation succeeded", + "schema": { + "$ref": "#/definitions/Image" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Image_CreateOrUpdate": { + "$ref": "./examples/PutImage.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Images_Delete", + "tags": [ + "Images" + ], + "description": "Delete a 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "imageName", + "in": "path", + "description": "Image name. Use an image GUID for GA versions of the API.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_Delete": { + "$ref": "./examples/DeleteImage.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeployments": { + "post": { + "operationId": "Catalogs_ListDeployments", + "tags": [ + "Catalogs" + ], + "description": "Lists deployments for 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListDeployments": { + "$ref": "./examples/PostListDeploymentsByCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups": { + "post": { + "operationId": "Catalogs_ListDeviceGroups", + "tags": [ + "Catalogs" + ], + "description": "List the device groups for the 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + }, + { + "name": "listDeviceGroupsRequest", + "in": "body", + "description": "List device groups for catalog.", + "required": true, + "schema": { + "$ref": "#/definitions/ListDeviceGroupsRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListDeviceGroups": { + "$ref": "./examples/PostListDeviceGroupsCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceInsights": { + "post": { + "operationId": "Catalogs_ListDeviceInsights", + "tags": [ + "Catalogs" + ], + "description": "Lists device insights for 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PagedDeviceInsight" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListDeviceInsights": { + "$ref": "./examples/PostListDeviceInsightsCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDevices": { + "post": { + "operationId": "Catalogs_ListDevices", + "tags": [ + "Catalogs" + ], + "description": "Lists devices for 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListDevices": { + "$ref": "./examples/PostListDevicesByCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products": { + "get": { + "operationId": "Products_ListByCatalog", + "tags": [ + "Products" + ], + "description": "List Product resources by 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" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProductListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_ListByCatalog": { + "$ref": "./examples/GetProducts.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}": { + "get": { + "operationId": "Products_Get", + "tags": [ + "Products" + ], + "description": "Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_Get": { + "$ref": "./examples/GetProduct.json" + } + } + }, + "put": { + "operationId": "Products_CreateOrUpdate", + "tags": [ + "Products" + ], + "description": "Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Product" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Product' update operation succeeded", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "201": { + "description": "Resource 'Product' create operation succeeded", + "schema": { + "$ref": "#/definitions/Product" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_CreateOrUpdate": { + "$ref": "./examples/PutProduct.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Products_Update", + "tags": [ + "Products" + ], + "description": "Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_Update": { + "$ref": "./examples/PatchProduct.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Products_Delete", + "tags": [ + "Products" + ], + "description": "Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_Delete": { + "$ref": "./examples/DeleteProduct.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/countDevices": { + "post": { + "operationId": "Products_CountDevices", + "tags": [ + "Products" + ], + "description": "Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CountDevicesResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_CountDevices": { + "$ref": "./examples/PostCountDevicesProduct.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups": { + "get": { + "operationId": "DeviceGroups_ListByProduct", + "tags": [ + "DeviceGroups" + ], + "description": "List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "parameters": [ + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_ListByProduct": { + "$ref": "./examples/GetDeviceGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}": { + "get": { + "operationId": "DeviceGroups_Get", + "tags": [ + "DeviceGroups" + ], + "description": "Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_Get": { + "$ref": "./examples/GetDeviceGroup.json" + } + } + }, + "put": { + "operationId": "DeviceGroups_CreateOrUpdate", + "tags": [ + "DeviceGroups" + ], + "description": "Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DeviceGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/DeviceGroup" + } + }, + "201": { + "description": "Resource 'DeviceGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/DeviceGroup" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_CreateOrUpdate": { + "$ref": "./examples/PutDeviceGroup.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "DeviceGroups_Update", + "tags": [ + "DeviceGroups" + ], + "description": "Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceGroupUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceGroup" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_Update": { + "$ref": "./examples/PatchDeviceGroup.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DeviceGroups_Delete", + "tags": [ + "DeviceGroups" + ], + "description": "Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_Delete": { + "$ref": "./examples/DeleteDeviceGroup.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/claimDevices": { + "post": { + "operationId": "DeviceGroups_ClaimDevices", + "tags": [ + "DeviceGroups" + ], + "description": "Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "claimDevicesRequest", + "in": "body", + "description": "Bulk claim devices request body.", + "required": true, + "schema": { + "$ref": "#/definitions/ClaimDevicesRequest" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_ClaimDevices": { + "$ref": "./examples/PostClaimDevices.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/countDevices": { + "post": { + "operationId": "DeviceGroups_CountDevices", + "tags": [ + "DeviceGroups" + ], + "description": "Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CountDevicesResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_CountDevices": { + "$ref": "./examples/PostCountDevicesDeviceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments": { + "get": { + "operationId": "Deployments_ListByDeviceGroup", + "tags": [ + "Deployments" + ], + "description": "List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_ListByDeviceGroup": { + "$ref": "./examples/GetDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}": { + "get": { + "operationId": "Deployments_Get", + "tags": [ + "Deployments" + ], + "description": "Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_Get": { + "$ref": "./examples/GetDeployment.json" + } + } + }, + "put": { + "operationId": "Deployments_CreateOrUpdate", + "tags": [ + "Deployments" + ], + "description": "Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.", + "required": true, + "type": "string" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Deployment' update operation succeeded", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "201": { + "description": "Resource 'Deployment' create operation succeeded", + "schema": { + "$ref": "#/definitions/Deployment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_CreateOrUpdate": { + "$ref": "./examples/PutDeployment.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Deployments_Delete", + "tags": [ + "Deployments" + ], + "description": "Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_Delete": { + "$ref": "./examples/DeleteDeployment.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices": { + "get": { + "operationId": "Devices_ListByDeviceGroup", + "tags": [ + "Devices" + ], + "description": "List Device resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Devices_ListByDeviceGroup": { + "$ref": "./examples/GetDevices.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}": { + "get": { + "operationId": "Devices_Get", + "tags": [ + "Devices" + ], + "description": "Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device does not belong to a device group and product.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{128}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Devices_Get": { + "$ref": "./examples/GetDevice.json" + } + } + }, + "put": { + "operationId": "Devices_CreateOrUpdate", + "tags": [ + "Devices" + ], + "description": "Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{128}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Device" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Device' update operation succeeded", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "201": { + "description": "Resource 'Device' create operation succeeded", + "schema": { + "$ref": "#/definitions/Device" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Devices_CreateOrUpdate": { + "$ref": "./examples/PutDevice.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Devices_Update", + "tags": [ + "Devices" + ], + "description": "Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{128}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Devices_Update": { + "$ref": "./examples/PatchDevice.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Devices_Delete", + "tags": [ + "Devices" + ], + "description": "Delete a Device", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{128}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Devices_Delete": { + "$ref": "./examples/DeleteDevice.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}/generateCapabilityImage": { + "post": { + "operationId": "Devices_GenerateCapabilityImage", + "tags": [ + "Devices" + ], + "description": "Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{128}$" + }, + { + "name": "generateDeviceCapabilityRequest", + "in": "body", + "description": "Generate capability image request body.", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateCapabilityImageRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SignedCapabilityImageResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Devices_GenerateCapabilityImage": { + "$ref": "./examples/PostGenerateDeviceCapabilityImage.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/generateDefaultDeviceGroups": { + "post": { + "operationId": "Products_GenerateDefaultDeviceGroups", + "tags": [ + "Products" + ], + "description": "Generates default device groups for the product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_GenerateDefaultDeviceGroups": { + "$ref": "./examples/PostGenerateDefaultDeviceGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/uploadImage": { + "post": { + "operationId": "Catalogs_UploadImage", + "tags": [ + "Catalogs" + ], + "description": "Creates an image. Use this action when the image ID is unknown.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/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": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "uploadImageRequest", + "in": "body", + "description": "Image upload request body.", + "required": true, + "schema": { + "$ref": "#/definitions/Image" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_UploadImage": { + "$ref": "./examples/PostUploadImageCatalog.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AllowCrashDumpCollection": { + "type": "string", + "description": "Allow crash dumps values.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "AllowCrashDumpCollection", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Crash dump collection enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Crash dump collection disabled" + } + ] + } + }, + "CapabilityType": { + "type": "string", + "description": "Capability image type", + "enum": [ + "ApplicationDevelopment", + "FieldServicing" + ], + "x-ms-enum": { + "name": "CapabilityType", + "modelAsString": true, + "values": [ + { + "name": "ApplicationDevelopment", + "value": "ApplicationDevelopment", + "description": "Application development capability" + }, + { + "name": "FieldServicing", + "value": "FieldServicing", + "description": "Field servicing capability" + } + ] + } + }, + "Catalog": { + "type": "object", + "description": "An Azure Sphere catalog", + "properties": { + "properties": { + "$ref": "#/definitions/CatalogProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "CatalogListResult": { + "type": "object", + "description": "The response of a Catalog list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Catalog items on this page", + "items": { + "$ref": "#/definitions/Catalog" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CatalogProperties": { + "type": "object", + "description": "Catalog properties", + "properties": { + "tenantId": { + "type": "string", + "description": "The Azure Sphere tenant ID associated with the catalog.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "CatalogUpdate": { + "type": "object", + "description": "The type used for update operations of the Catalog.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Certificate": { + "type": "object", + "description": "An certificate resource belonging to a catalog resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "CertificateChainResponse": { + "type": "object", + "description": "The certificate chain response.", + "properties": { + "certificateChain": { + "type": "string", + "description": "The certificate chain.", + "readOnly": true + } + } + }, + "CertificateListResult": { + "type": "object", + "description": "The response of a Certificate list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Certificate items on this page", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CertificateProperties": { + "type": "object", + "description": "The properties of certificate", + "properties": { + "certificate": { + "type": "string", + "description": "The certificate as a UTF-8 encoded base 64 string.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/CertificateStatus", + "description": "The certificate status.", + "readOnly": true + }, + "subject": { + "type": "string", + "description": "The certificate subject.", + "readOnly": true + }, + "thumbprint": { + "type": "string", + "description": "The certificate thumbprint.", + "readOnly": true + }, + "expiryUtc": { + "type": "string", + "format": "date-time", + "description": "The certificate expiry date.", + "readOnly": true + }, + "notBeforeUtc": { + "type": "string", + "format": "date-time", + "description": "The certificate not before date.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "CertificateStatus": { + "type": "string", + "description": "Certificate status values.", + "enum": [ + "Active", + "Inactive", + "Expired", + "Revoked" + ], + "x-ms-enum": { + "name": "CertificateStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "Certificate is active" + }, + { + "name": "Inactive", + "value": "Inactive", + "description": "Certificate is inactive" + }, + { + "name": "Expired", + "value": "Expired", + "description": "Certificate has expired" + }, + { + "name": "Revoked", + "value": "Revoked", + "description": "Certificate has been revoked" + } + ] + } + }, + "ClaimDevicesRequest": { + "type": "object", + "description": "Request to the action call to bulk claim devices.", + "properties": { + "deviceIdentifiers": { + "type": "array", + "description": "Device identifiers of the devices to be claimed.", + "items": { + "type": "string" + } + } + }, + "required": [ + "deviceIdentifiers" + ] + }, + "CountDeviceResponse": { + "type": "object", + "description": "Response to the action call for count devices in a catalog (preview API).", + "allOf": [ + { + "$ref": "#/definitions/CountElementsResponse" + } + ] + }, + "CountDevicesResponse": { + "type": "object", + "description": "Response to the action call for count devices in a catalog.", + "allOf": [ + { + "$ref": "#/definitions/CountElementsResponse" + } + ] + }, + "CountElementsResponse": { + "type": "object", + "description": "Response of the count for elements.", + "properties": { + "value": { + "type": "integer", + "format": "int32", + "description": "Number of children resources in parent resource." + } + }, + "required": [ + "value" + ] + }, + "Deployment": { + "type": "object", + "description": "An deployment resource belonging to a device group resource.", + "properties": { + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DeploymentListResult": { + "type": "object", + "description": "The response of a Deployment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Deployment items on this page", + "items": { + "$ref": "#/definitions/Deployment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DeploymentProperties": { + "type": "object", + "description": "The properties of deployment", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "deployedImages": { + "type": "array", + "description": "Images deployed", + "items": { + "$ref": "#/definitions/Image" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "deploymentDateUtc": { + "type": "string", + "format": "date-time", + "description": "Deployment date UTC", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Device": { + "type": "object", + "description": "An device resource belonging to a device group resource.", + "properties": { + "properties": { + "$ref": "#/definitions/DeviceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DeviceGroup": { + "type": "object", + "description": "An device group resource belonging to a product resource.", + "properties": { + "properties": { + "$ref": "#/definitions/DeviceGroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DeviceGroupListResult": { + "type": "object", + "description": "The response of a DeviceGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DeviceGroup items on this page", + "items": { + "$ref": "#/definitions/DeviceGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DeviceGroupProperties": { + "type": "object", + "description": "The properties of deviceGroup", + "properties": { + "description": { + "type": "string", + "description": "Description of the device group." + }, + "osFeedType": { + "$ref": "#/definitions/OSFeedType", + "description": "Operating system feed type of the device group." + }, + "updatePolicy": { + "$ref": "#/definitions/UpdatePolicy", + "description": "Update policy of the device group." + }, + "allowCrashDumpsCollection": { + "$ref": "#/definitions/AllowCrashDumpCollection", + "description": "Flag to define if the user allows for crash dump collection." + }, + "regionalDataBoundary": { + "$ref": "#/definitions/RegionalDataBoundary", + "description": "Regional data boundary for the device group." + }, + "hasDeployment": { + "type": "boolean", + "description": "Deployment status for the device group.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "DeviceGroupUpdate": { + "type": "object", + "description": "The type used for update operations of the DeviceGroup.", + "properties": { + "properties": { + "$ref": "#/definitions/DeviceGroupUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "DeviceGroupUpdateProperties": { + "type": "object", + "description": "The updatable properties of the DeviceGroup.", + "properties": { + "description": { + "type": "string", + "description": "Description of the device group." + }, + "osFeedType": { + "$ref": "#/definitions/OSFeedType", + "description": "Operating system feed type of the device group." + }, + "updatePolicy": { + "$ref": "#/definitions/UpdatePolicy", + "description": "Update policy of the device group." + }, + "allowCrashDumpsCollection": { + "$ref": "#/definitions/AllowCrashDumpCollection", + "description": "Flag to define if the user allows for crash dump collection." + }, + "regionalDataBoundary": { + "$ref": "#/definitions/RegionalDataBoundary", + "description": "Regional data boundary for the device group." + } + } + }, + "DeviceInsight": { + "type": "object", + "description": "Device insight report.", + "properties": { + "deviceId": { + "type": "string", + "description": "Device ID" + }, + "description": { + "type": "string", + "description": "Event description" + }, + "startTimestampUtc": { + "type": "string", + "format": "date-time", + "description": "Event start timestamp" + }, + "endTimestampUtc": { + "type": "string", + "format": "date-time", + "description": "Event end timestamp" + }, + "eventCategory": { + "type": "string", + "description": "Event category" + }, + "eventClass": { + "type": "string", + "description": "Event class" + }, + "eventType": { + "type": "string", + "description": "Event type" + }, + "eventCount": { + "type": "integer", + "format": "int32", + "description": "Event count" + } + }, + "required": [ + "deviceId", + "description", + "startTimestampUtc", + "endTimestampUtc", + "eventCategory", + "eventClass", + "eventType", + "eventCount" + ] + }, + "DeviceListResult": { + "type": "object", + "description": "The response of a Device list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Device items on this page", + "items": { + "$ref": "#/definitions/Device" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DevicePatchProperties": { + "type": "object", + "description": "The properties of device patch", + "properties": { + "deviceGroupId": { + "type": "string", + "description": "Device group id" + } + }, + "required": [ + "deviceGroupId" + ] + }, + "DeviceProperties": { + "type": "object", + "description": "The properties of device", + "properties": { + "deviceId": { + "type": "string", + "description": "Device ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "chipSku": { + "type": "string", + "description": "SKU of the chip", + "readOnly": true + }, + "lastAvailableOsVersion": { + "type": "string", + "description": "OS version available for installation when update requested", + "readOnly": true + }, + "lastInstalledOsVersion": { + "type": "string", + "description": "OS version running on device when update requested", + "readOnly": true + }, + "lastOsUpdateUtc": { + "type": "string", + "format": "date-time", + "description": "Time when update requested and new OS version available", + "readOnly": true + }, + "lastUpdateRequestUtc": { + "type": "string", + "format": "date-time", + "description": "Time when update was last requested", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "DeviceUpdate": { + "type": "object", + "description": "The type used for update operations of the Device.", + "properties": { + "properties": { + "$ref": "#/definitions/DeviceUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "DeviceUpdateProperties": { + "type": "object", + "description": "The updatable properties of the Device.", + "properties": { + "deviceGroupId": { + "type": "string", + "description": "Device group id" + } + } + }, + "GenerateCapabilityImageRequest": { + "type": "object", + "description": "Request of the action to create a signed device capability image", + "properties": { + "capabilities": { + "type": "array", + "description": "List of capabilities to create", + "items": { + "$ref": "#/definitions/CapabilityType" + } + } + }, + "required": [ + "capabilities" + ] + }, + "Image": { + "type": "object", + "description": "An image resource belonging to a catalog resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ImageProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ImageListResult": { + "type": "object", + "description": "The response of a Image list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Image items on this page", + "items": { + "$ref": "#/definitions/Image" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ImageProperties": { + "type": "object", + "description": "The properties of image", + "properties": { + "image": { + "type": "string", + "description": "Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "imageId": { + "type": "string", + "description": "Image ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "imageName": { + "type": "string", + "description": "Image name", + "readOnly": true + }, + "regionalDataBoundary": { + "$ref": "#/definitions/RegionalDataBoundary", + "description": "Regional data boundary for an image", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "uri": { + "type": "string", + "description": "Location the image", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The image description.", + "readOnly": true + }, + "componentId": { + "type": "string", + "description": "The image component id.", + "readOnly": true + }, + "imageType": { + "$ref": "#/definitions/ImageType", + "description": "The image type.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ImageType": { + "type": "string", + "description": "Image type values.", + "enum": [ + "InvalidImageType", + "OneBl", + "PlutonRuntime", + "WifiFirmware", + "SecurityMonitor", + "NormalWorldLoader", + "NormalWorldDtb", + "NormalWorldKernel", + "RootFs", + "Services", + "Applications", + "FwConfig", + "BootManifest", + "Nwfs", + "TrustedKeystore", + "Policy", + "CustomerBoardConfig", + "UpdateCertStore", + "BaseSystemUpdateManifest", + "FirmwareUpdateManifest", + "CustomerUpdateManifest", + "RecoveryManifest", + "ManifestSet", + "Other" + ], + "x-ms-enum": { + "name": "ImageType", + "modelAsString": true, + "values": [ + { + "name": "InvalidImageType", + "value": "InvalidImageType", + "description": "Invalid image." + }, + { + "name": "OneBl", + "value": "OneBl", + "description": "One Bl image type" + }, + { + "name": "PlutonRuntime", + "value": "PlutonRuntime", + "description": "Pluton image type" + }, + { + "name": "WifiFirmware", + "value": "WifiFirmware", + "description": "Wifi firmware image type" + }, + { + "name": "SecurityMonitor", + "value": "SecurityMonitor", + "description": "Security monitor image type" + }, + { + "name": "NormalWorldLoader", + "value": "NormalWorldLoader", + "description": "Normal world loader image type" + }, + { + "name": "NormalWorldDtb", + "value": "NormalWorldDtb", + "description": "Normal world dtb image type" + }, + { + "name": "NormalWorldKernel", + "value": "NormalWorldKernel", + "description": "Normal world kernel image type" + }, + { + "name": "RootFs", + "value": "RootFs", + "description": "Root FS image type" + }, + { + "name": "Services", + "value": "Services", + "description": "Services image type" + }, + { + "name": "Applications", + "value": "Applications", + "description": "Applications image type" + }, + { + "name": "FwConfig", + "value": "FwConfig", + "description": "FW config image type" + }, + { + "name": "BootManifest", + "value": "BootManifest", + "description": "Boot manifest image type" + }, + { + "name": "Nwfs", + "value": "Nwfs", + "description": "Nwfs image type" + }, + { + "name": "TrustedKeystore", + "value": "TrustedKeystore", + "description": "Trusted key store image type" + }, + { + "name": "Policy", + "value": "Policy", + "description": "Policy image type" + }, + { + "name": "CustomerBoardConfig", + "value": "CustomerBoardConfig", + "description": "Customer board config image type" + }, + { + "name": "UpdateCertStore", + "value": "UpdateCertStore", + "description": "Update certificate store image type" + }, + { + "name": "BaseSystemUpdateManifest", + "value": "BaseSystemUpdateManifest", + "description": "Base system update manifest image type" + }, + { + "name": "FirmwareUpdateManifest", + "value": "FirmwareUpdateManifest", + "description": "Firmware update manifest image type" + }, + { + "name": "CustomerUpdateManifest", + "value": "CustomerUpdateManifest", + "description": "Customer update manifest image type" + }, + { + "name": "RecoveryManifest", + "value": "RecoveryManifest", + "description": "Recovery manifest image type" + }, + { + "name": "ManifestSet", + "value": "ManifestSet", + "description": "manifest set image type" + }, + { + "name": "Other", + "value": "Other", + "description": "Other image type" + } + ] + } + }, + "ListDeviceGroupsRequest": { + "type": "object", + "description": "Request of the action to list device groups for a catalog.", + "properties": { + "deviceGroupName": { + "type": "string", + "description": "Device Group name." + } + } + }, + "OSFeedType": { + "type": "string", + "description": "OS feed type values.", + "enum": [ + "Retail", + "RetailEval" + ], + "x-ms-enum": { + "name": "OSFeedType", + "modelAsString": true, + "values": [ + { + "name": "Retail", + "value": "Retail", + "description": "Retail OS feed type." + }, + { + "name": "RetailEval", + "value": "RetailEval", + "description": "Retail evaluation OS feed type." + } + ] + } + }, + "PagedDeviceInsight": { + "type": "object", + "description": "Paged collection of DeviceInsight items", + "properties": { + "value": { + "type": "array", + "description": "The DeviceInsight items on this page", + "items": { + "$ref": "#/definitions/DeviceInsight" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Product": { + "type": "object", + "description": "An product resource belonging to a catalog resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ProductProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ProductListResult": { + "type": "object", + "description": "The response of a Product list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Product items on this page", + "items": { + "$ref": "#/definitions/Product" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProductProperties": { + "type": "object", + "description": "The properties of product", + "properties": { + "description": { + "type": "string", + "description": "Description of the product" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ProductUpdate": { + "type": "object", + "description": "The type used for update operations of the Product.", + "properties": { + "properties": { + "$ref": "#/definitions/ProductUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "ProductUpdateProperties": { + "type": "object", + "description": "The updatable properties of the Product.", + "properties": { + "description": { + "type": "string", + "description": "Description of the product" + } + } + }, + "ProofOfPossessionNonceRequest": { + "type": "object", + "description": "Request for the proof of possession nonce", + "properties": { + "proofOfPossessionNonce": { + "type": "string", + "description": "The proof of possession nonce" + } + }, + "required": [ + "proofOfPossessionNonce" + ] + }, + "ProofOfPossessionNonceResponse": { + "type": "object", + "description": "Result of the action to generate a proof of possession nonce", + "allOf": [ + { + "$ref": "#/definitions/CertificateProperties" + } + ] + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is being updated" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + } + }, + "RegionalDataBoundary": { + "type": "string", + "description": "Regional data boundary values.", + "enum": [ + "None", + "EU" + ], + "x-ms-enum": { + "name": "RegionalDataBoundary", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No data boundary" + }, + { + "name": "EU", + "value": "EU", + "description": "EU data boundary" + } + ] + } + }, + "SignedCapabilityImageResponse": { + "type": "object", + "description": "Signed device capability image response", + "properties": { + "image": { + "type": "string", + "description": "The signed device capability image as a UTF-8 encoded base 64 string.", + "readOnly": true + } + } + }, + "UpdatePolicy": { + "type": "string", + "description": "Update policy values.", + "enum": [ + "UpdateAll", + "No3rdPartyAppUpdates" + ], + "x-ms-enum": { + "name": "UpdatePolicy", + "modelAsString": true, + "values": [ + { + "name": "UpdateAll", + "value": "UpdateAll", + "description": "Update all policy." + }, + { + "name": "No3rdPartyAppUpdates", + "value": "No3rdPartyAppUpdates", + "description": "No update for 3rd party app policy." + } + ] + } + }, + "Versions": { + "type": "string", + "description": "Azure Sphere API versions.", + "enum": [ + "2022-09-01-preview", + "2024-04-01" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2022_09_01", + "value": "2022-09-01-preview", + "description": "Public preview API version." + }, + { + "name": "v2024_04_01", + "value": "2024-04-01", + "description": "Initial GA API version." + } + ] + } + } + }, + "parameters": { + "CustomFilterQueryParameter": { + "name": "$filter", + "in": "query", + "description": "Filter the result list using the given expression", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-client-name": "filter" + }, + "CustomMaxPageSizeQueryParameter": { + "name": "$maxpagesize", + "in": "query", + "description": "The maximum number of result items per page.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method", + "x-ms-client-name": "maxpagesize" + }, + "CustomSkipQueryParameter": { + "name": "$skip", + "in": "query", + "description": "The number of result items to skip.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method", + "x-ms-client-name": "skip" + }, + "CustomTopQueryParameter": { + "name": "$top", + "in": "query", + "description": "The number of result items to return.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method", + "x-ms-client-name": "top" + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteCatalog.json new file mode 100644 index 000000000000..658bc7b9990c --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteCatalog.json @@ -0,0 +1,24 @@ +{ + "operationId": "Catalogs_Delete", + "title": "Catalogs_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeployment.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeployment.json new file mode 100644 index 000000000000..6a3411f17082 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeployment.json @@ -0,0 +1,27 @@ +{ + "operationId": "Deployments_Delete", + "title": "Deployments_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProductName1", + "deviceGroupName": "DeviceGroupName1", + "deploymentName": "MyDeploymentName1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDevice.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDevice.json new file mode 100644 index 000000000000..057b4d7b71c7 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDevice.json @@ -0,0 +1,27 @@ +{ + "operationId": "Devices_Delete", + "title": "Devices_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProductName1", + "deviceGroupName": "DeviceGroupName1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeviceGroup.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeviceGroup.json new file mode 100644 index 000000000000..41eab5c0492c --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeviceGroup.json @@ -0,0 +1,26 @@ +{ + "operationId": "DeviceGroups_Delete", + "title": "DeviceGroups_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteImage.json new file mode 100644 index 000000000000..45b70048d57b --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteImage.json @@ -0,0 +1,25 @@ +{ + "operationId": "Images_Delete", + "title": "Images_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "imageName": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteProduct.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteProduct.json new file mode 100644 index 000000000000..0f5433be7216 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteProduct.json @@ -0,0 +1,25 @@ +{ + "operationId": "Products_Delete", + "title": "Products_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProductName1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalog.json new file mode 100644 index 000000000000..87771799dffc --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalog.json @@ -0,0 +1,21 @@ +{ + "operationId": "Catalogs_Get", + "title": "Catalogs_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsRG.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsRG.json new file mode 100644 index 000000000000..488c94bc3c23 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsRG.json @@ -0,0 +1,30 @@ +{ + "operationId": "Catalogs_ListByResourceGroup", + "title": "Catalogs_ListByResourceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog2", + "name": "MyCatalog2", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsSub.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsSub.json new file mode 100644 index 000000000000..d715ad91a2ef --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsSub.json @@ -0,0 +1,29 @@ +{ + "operationId": "Catalogs_ListBySubscription", + "title": "Catalogs_ListBySubscription", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup2/providers/Microsoft.AzureSphere/catalogs/MyCatalog2", + "name": "MyCatalog2", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificate.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificate.json new file mode 100644 index 000000000000..a8c64f3db445 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificate.json @@ -0,0 +1,17 @@ +{ + "operationId": "Certificates_Get", + "title": "Certificates_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "serialNumber": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": {} + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificates.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificates.json new file mode 100644 index 000000000000..9c3fd6281498 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificates.json @@ -0,0 +1,18 @@ +{ + "operationId": "Certificates_ListByCatalog", + "title": "Certificates_ListByCatalog", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployment.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployment.json new file mode 100644 index 000000000000..fc9af844c81f --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployment.json @@ -0,0 +1,38 @@ +{ + "operationId": "Deployments_Get", + "title": "Deployments_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deploymentName": "MyDeployment1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "properties": { + "deployedImages": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1", + "properties": { + "image": "dGVzdGltYWdl", + "regionalDataBoundary": "None", + "uri": "imageUri", + "description": "description", + "componentId": "componentId", + "imageType": "ImageType", + "provisioningState": "Succeeded" + } + } + ] + } + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployments.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployments.json new file mode 100644 index 000000000000..eef2ff5d1ac8 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployments.json @@ -0,0 +1,42 @@ +{ + "operationId": "Deployments_ListByDeviceGroup", + "title": "Deployments_ListByDeviceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "properties": { + "deployedImages": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1", + "properties": { + "image": "dGVzdGltYWdl", + "regionalDataBoundary": "None", + "uri": "imageUri", + "description": "description", + "componentId": "componentId", + "imageType": "ImageType", + "provisioningState": "Succeeded" + } + } + ], + "deploymentDateUtc": "2022-09-30T21:51:39.2698729Z" + } + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevice.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevice.json new file mode 100644 index 000000000000..858ee313939f --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevice.json @@ -0,0 +1,29 @@ +{ + "operationId": "Devices_Get", + "title": "Devices_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": { + "chipSku": "MyChipSku1", + "lastAvailableOsVersion": "AvailableOsVersion1", + "lastInstalledOsVersion": "InstalledOsVersion1", + "lastOsUpdateUtc": "2022-09-30T23:54:21.96Z", + "lastUpdateRequestUtc": "2022-10-01T23:54:21.96Z" + } + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroup.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroup.json new file mode 100644 index 000000000000..1e8379ab7772 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroup.json @@ -0,0 +1,26 @@ +{ + "operationId": "DeviceGroups_Get", + "title": "DeviceGroups_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups", + "properties": { + "description": "The description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroups.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroups.json new file mode 100644 index 000000000000..46123e6f6d98 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroups.json @@ -0,0 +1,30 @@ +{ + "operationId": "DeviceGroups_ListByProduct", + "title": "DeviceGroups_ListByProduct", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "name": "MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/Products/MyProduct2/devicegroups/MyDeviceGroup2", + "name": "MyDeviceGroup2", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevices.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevices.json new file mode 100644 index 000000000000..c011cde1148a --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevices.json @@ -0,0 +1,29 @@ +{ + "operationId": "Devices_ListByDeviceGroup", + "title": "Devices_ListByDeviceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000-0000-0000-0000-000000000001", + "properties": {} + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000-0000-0000-0000-000000000002", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImage.json new file mode 100644 index 000000000000..8943a1fcf403 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImage.json @@ -0,0 +1,17 @@ +{ + "operationId": "Images_Get", + "title": "Images_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "imageName": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": {} + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImages.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImages.json new file mode 100644 index 000000000000..7701f85222a1 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImages.json @@ -0,0 +1,27 @@ +{ + "operationId": "Images_ListByCatalog", + "title": "Images_ListByCatalog", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "00000000-0000-0000-0000-000000000001", + "name": "MyImage1" + }, + { + "id": "00000000-0000-0000-0000-000000000002", + "name": "MyImage2" + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetOperations.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetOperations.json new file mode 100644 index 000000000000..5a4b09163c2d --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetOperations.json @@ -0,0 +1,35 @@ +{ + "operationId": "Operations_List", + "title": "Operations_List", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "name": "Microsoft.AzureSphere/catalogs/Read", + "display": { + "provider": "Microsoft.AzureSphere", + "resource": "catalog", + "operation": "Gets/List catalog", + "description": "Read Azure Sphere catalogs" + } + }, + { + "name": "Microsoft.AzureSphere/catalogs/Write", + "display": { + "provider": "Microsoft.AzureSphere", + "resource": "catalog", + "operation": "Create/Update catalog", + "description": "Writes Azure Sphere catalogs" + } + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProduct.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProduct.json new file mode 100644 index 000000000000..570db8296b81 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProduct.json @@ -0,0 +1,23 @@ +{ + "operationId": "Products_Get", + "title": "Products_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "type": "microsoft.azureSphere/catalogs/products", + "properties": { + "description": "product description." + } + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProducts.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProducts.json new file mode 100644 index 000000000000..915cd38158a3 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProducts.json @@ -0,0 +1,29 @@ +{ + "operationId": "Products_ListByCatalog", + "title": "Products_ListByCatalog", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/products" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct2", + "name": "MyProduct2", + "type": "Microsoft.AzureSphere/catalogs/products" + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchCatalog.json new file mode 100644 index 000000000000..bec2ebeca152 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchCatalog.json @@ -0,0 +1,25 @@ +{ + "operationId": "Catalogs_Update", + "title": "Catalogs_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "properties": {}, + "resource": { + "location": "global" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDevice.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDevice.json new file mode 100644 index 000000000000..6dd5ed784af2 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDevice.json @@ -0,0 +1,36 @@ +{ + "operationId": "Devices_Update", + "title": "Devices_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1/device/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "type": "Microsoft.AzureSphere/catalogs/products/devicegroups", + "properties": { + "chipSku": "MyChipSku1", + "lastAvailableOsVersion": "AvailableOsVersion1", + "lastInstalledOsVersion": "InstalledOsVersion1", + "lastOsUpdateUtc": "2022-10-30T23:54:21.96Z", + "lastUpdateRequestUtc": "2022-10-01T23:54:21.96Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "description": "The device update started successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDeviceGroup.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDeviceGroup.json new file mode 100644 index 000000000000..84cd946a5ca9 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDeviceGroup.json @@ -0,0 +1,33 @@ +{ + "operationId": "DeviceGroups_Update", + "title": "DeviceGroups_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "properties": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups", + "properties": { + "description": "The description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "description": "Resource update request accepted." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchProduct.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchProduct.json new file mode 100644 index 000000000000..e2da1aafeb7e --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchProduct.json @@ -0,0 +1,30 @@ +{ + "operationId": "Products_Update", + "title": "Products_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "properties": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "type": "microsoft.azureSphere/catalogs/products", + "properties": { + "description": "Product description." + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "description": "Resource update request accepted." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostClaimDevices.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostClaimDevices.json new file mode 100644 index 000000000000..193ef5d3e2a6 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostClaimDevices.json @@ -0,0 +1,25 @@ +{ + "operationId": "DeviceGroups_ClaimDevices", + "title": "DeviceGroups_ClaimDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "claimDevicesRequest": { + "deviceIdentifiers": [ + "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + ] + }, + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesCatalog.json new file mode 100644 index 000000000000..979f312d235a --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesCatalog.json @@ -0,0 +1,18 @@ +{ + "operationId": "Catalogs_CountDevices", + "title": "Catalogs_CountDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": 3 + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesDeviceGroup.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesDeviceGroup.json new file mode 100644 index 000000000000..45e5e0b05ad3 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesDeviceGroup.json @@ -0,0 +1,20 @@ +{ + "operationId": "DeviceGroups_CountDevices", + "title": "DeviceGroups_CountDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": 3 + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesProduct.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesProduct.json new file mode 100644 index 000000000000..4ca2bcd28a2c --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesProduct.json @@ -0,0 +1,21 @@ +{ + "operationId": "Products_CountDevices", + "title": "Products_CountDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "productGroupName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": 3 + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDefaultDeviceGroups.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDefaultDeviceGroups.json new file mode 100644 index 000000000000..b86ea57c2833 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDefaultDeviceGroups.json @@ -0,0 +1,40 @@ +{ + "operationId": "Products_GenerateDefaultDeviceGroups", + "title": "Products_GenerateDefaultDeviceGroups", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "name": "MyDeviceGroup1", + "properties": { + "description": "Device group description 1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll", + "allowCrashDumpsCollection": "Enabled" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup2", + "name": "MyDeviceGroup2", + "properties": { + "description": "Device group description 2", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll", + "allowCrashDumpsCollection": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDeviceCapabilityImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDeviceCapabilityImage.json new file mode 100644 index 000000000000..3f10e240a86c --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDeviceCapabilityImage.json @@ -0,0 +1,32 @@ +{ + "operationId": "Devices_GenerateCapabilityImage", + "title": "Devices_GenerateCapabilityImage", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "generateDeviceCapabilityRequest": { + "capabilities": [ + "ApplicationDevelopment" + ] + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "image": "TheDeviceCapabilityImage" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeploymentsByCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeploymentsByCatalog.json new file mode 100644 index 000000000000..9e1bafb39819 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeploymentsByCatalog.json @@ -0,0 +1,27 @@ +{ + "operationId": "Catalogs_ListDeployments", + "title": "Catalogs_ListDeployments", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "name": "DeploymentName1111", + "properties": {} + }, + { + "name": "DeploymentName1121", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceGroupsCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceGroupsCatalog.json new file mode 100644 index 000000000000..59a575a79ed0 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceGroupsCatalog.json @@ -0,0 +1,32 @@ +{ + "operationId": "Catalogs_ListDeviceGroups", + "title": "Catalogs_ListDeviceGroups", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "listDeviceGroupsRequest": { + "deviceGroupName": "MyDeviceGroup1" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "name": "MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct2/devicegroups/MyDeviceGroup2", + "name": "MyDeviceGroup2", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceInsightsCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceInsightsCatalog.json new file mode 100644 index 000000000000..836f912dca25 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceInsightsCatalog.json @@ -0,0 +1,40 @@ +{ + "operationId": "Catalogs_ListDeviceInsights", + "title": "Catalogs_ListDeviceInsights", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "$top": 10, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "description": "eventDescription1", + "deviceId": "eventIdentifier1", + "startTimestampUtc": "2021-09-30T21:51:39.26Z", + "endTimestampUtc": "2021-09-30T23:54:21.96Z", + "eventCategory": "eventCategory1", + "eventClass": "eventClass1", + "eventType": "eventType1", + "eventCount": 1 + }, + { + "description": "eventDescription2", + "deviceId": "eventIdentifier2", + "startTimestampUtc": "2022-12-06T12:41:39.26Z", + "endTimestampUtc": "2022-12-07T17:34:12.50Z", + "eventCategory": "eventCategory2", + "eventClass": "eventClass2", + "eventType": "eventType2", + "eventCount": 1 + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDevicesByCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDevicesByCatalog.json new file mode 100644 index 000000000000..adfc7215cb82 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDevicesByCatalog.json @@ -0,0 +1,27 @@ +{ + "operationId": "Catalogs_ListDevices", + "title": "Catalogs_ListDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": {} + }, + { + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveCatalogCertChain.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveCatalogCertChain.json new file mode 100644 index 000000000000..d899e89ea6d6 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveCatalogCertChain.json @@ -0,0 +1,19 @@ +{ + "operationId": "Certificates_RetrieveCertChain", + "title": "Certificates_RetrieveCertChain", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "serialNumber": "active", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "certificateChain": "ABynaryRepresentationOfTheRequestedCatalogCertificateChain" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveProofOfPossessionNonce.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveProofOfPossessionNonce.json new file mode 100644 index 000000000000..400c9af86b8a --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveProofOfPossessionNonce.json @@ -0,0 +1,22 @@ +{ + "operationId": "Certificates_RetrieveProofOfPossessionNonce", + "title": "Certificates_RetrieveProofOfPossessionNonce", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "serialNumber": "active", + "proofOfPossessionNonceRequest": { + "proofOfPossessionNonce": "proofOfPossessionNonce" + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "certificate": "bXliYXNlNjRzdHJpbmc=" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostUploadImageCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostUploadImageCatalog.json new file mode 100644 index 000000000000..022a60a12a4f --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostUploadImageCatalog.json @@ -0,0 +1,23 @@ +{ + "operationId": "Catalogs_UploadImage", + "title": "Catalogs_UploadImage", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "uploadImageRequest": { + "properties": { + "image": "bXliYXNlNjRzdHJpbmc=" + } + } + }, + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutCatalog.json new file mode 100644 index 000000000000..6fedad40487c --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutCatalog.json @@ -0,0 +1,34 @@ +{ + "operationId": "Catalogs_CreateOrUpdate", + "title": "Catalogs_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "location": "global", + "resource": { + "location": "global" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeployment.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeployment.json new file mode 100644 index 000000000000..ce2abff598ca --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeployment.json @@ -0,0 +1,47 @@ +{ + "operationId": "Deployments_CreateOrUpdate", + "title": "Deployments_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deploymentName": "MyDeployment1", + "api-version": "2024-04-01", + "resource": {} + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "properties": { + "deployedImages": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1", + "properties": { + "image": "MyImage", + "imageId": "00000000-0000-0000-0000-000000000000", + "uri": "imageUri", + "regionalDataBoundary": "None", + "imageType": "InvalidImageType", + "provisioningState": "Succeeded" + } + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups/deployments" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDevice.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDevice.json new file mode 100644 index 000000000000..7e69ec373bf2 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDevice.json @@ -0,0 +1,34 @@ +{ + "operationId": "Devices_CreateOrUpdate", + "title": "Devices_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "api-version": "2024-04-01", + "resource": {} + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": { + "chipSku": "MyChipSku1" + } + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups/devices" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeviceGroup.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeviceGroup.json new file mode 100644 index 000000000000..eaf9e7a53c95 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeviceGroup.json @@ -0,0 +1,46 @@ +{ + "operationId": "DeviceGroups_CreateOrUpdate", + "title": "DeviceGroups_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01", + "resource": { + "properties": { + "description": "Description for MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "type": "microsoft.AzureSphere/catalogs/products/devicegroups", + "properties": { + "description": "Description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1", + "name": "MyDeviceId1", + "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups", + "properties": { + "description": "Description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutImage.json new file mode 100644 index 000000000000..6d26ad07a8ae --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutImage.json @@ -0,0 +1,34 @@ +{ + "operationId": "Images_CreateOrUpdate", + "title": "Image_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "imageName": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": { + "image": "bXliYXNlNjRzdHJpbmc=" + } + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/default", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/images" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/default", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/images" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutProduct.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutProduct.json new file mode 100644 index 000000000000..75a53ec45323 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutProduct.json @@ -0,0 +1,30 @@ +{ + "operationId": "Products_CreateOrUpdate", + "title": "Products_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01", + "resource": {} + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/products" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs" + } + } + } +} diff --git a/specification/sphere/resource-manager/readme.md b/specification/sphere/resource-manager/readme.md index 5c4ecd51faec..e126e3cabf37 100644 --- a/specification/sphere/resource-manager/readme.md +++ b/specification/sphere/resource-manager/readme.md @@ -40,6 +40,15 @@ input-file: - Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json ``` +### Tag: package-2024-04-01 + +These settings apply only when `--tag=package-2024-04-01` is specified on the command line. + +``` yaml $(tag) == 'package-2024-04-01' +input-file: +- Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json +``` + # Code Generation ## Swagger to SDK @@ -108,6 +117,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - $(this-folder)/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json + - $(this-folder)/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/storageactions/resource-manager/readme.java.md b/specification/storageactions/resource-manager/readme.java.md new file mode 100644 index 000000000000..3a0d01de5e90 --- /dev/null +++ b/specification/storageactions/resource-manager/readme.java.md @@ -0,0 +1,8 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +title: StorageActionsMgmtClient +client-flattened-annotation-target: disabled +``` diff --git a/specification/storageactions/resource-manager/readme.md b/specification/storageactions/resource-manager/readme.md index c65b6105fa31..f276cf98dcb3 100644 --- a/specification/storageactions/resource-manager/readme.md +++ b/specification/storageactions/resource-manager/readme.md @@ -29,6 +29,11 @@ openapi-type: arm tag: package-2023-01-01 ``` +``` yaml +modelerfour: + flatten-models: false +``` + ### Tag: package-2023-01-01 These settings apply only when `--tag=package-2023-01-01` is specified on the command line. diff --git a/specification/storageactions/resource-manager/readme.python.md b/specification/storageactions/resource-manager/readme.python.md index e89a4a87929f..117dbd5bd47f 100644 --- a/specification/storageactions/resource-manager/readme.python.md +++ b/specification/storageactions/resource-manager/readme.python.md @@ -4,6 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. ``` yaml $(python) +title: StorageActionsMgmtClient azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-storageactions diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json index 3189d8237429..a120d4cd68b9 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json @@ -3361,6 +3361,26 @@ "typeProperties" ] }, + "SnowflakeV2Dataset": { + "x-ms-discriminator-value": "SnowflakeV2Table", + "description": "The snowflake dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Snowflake dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnowflakeDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, "SnowflakeDatasetTypeProperties": { "description": "Snowflake dataset properties.", "type": "object", 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 5cef604fd5bb..7e244d00f63c 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 @@ -6832,6 +6832,99 @@ "connectionString" ] }, + "SnowflakeV2LinkedService": { + "x-ms-discriminator-value": "SnowflakeV2", + "description": "Snowflake linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Snowflake linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnowflakeLinkedV2ServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SnowflakeLinkedV2ServiceTypeProperties": { + "description": "Snowflake linked service properties.", + "type": "object", + "properties": { + "accountIdentifier": { + "type": "object", + "description": "The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure" + }, + "user": { + "type": "object", + "description": "The name of the Snowflake user." + }, + "password": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The Azure key vault secret reference of password in connection string." + }, + "database": { + "type": "object", + "description": "The name of the Snowflake database." + }, + "warehouse": { + "type": "object", + "description": "The name of the Snowflake warehouse." + }, + "authenticationType": { + "x-ms-enum": { + "name": "SnowflakeAuthenticationType", + "modelAsString": true + }, + "enum": [ + "Basic", + "KeyPair", + "AADServicePrincipal" + ], + "type": "string", + "default": "Basic", + "description": "The type used for authentication. Type: string." + }, + "clientId": { + "type": "object", + "description": "The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication." + }, + "clientSecret": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The Azure key vault secret reference of client secret for AADServicePrincipal authentication." + }, + "tenantId": { + "type": "object", + "description": "The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication." + }, + "scope": { + "type": "object", + "description": "The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication." + }, + "privateKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The Azure key vault secret reference of privateKey for KeyPair auth." + }, + "privateKeyPassphrase": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key." + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." + } + }, + "required": [ + "accountIdentifier", + "database", + "warehouse" + ] + }, "SharePointOnlineListLinkedService": { "x-ms-discriminator-value": "SharePointOnlineList", "description": "SharePoint Online List linked service.", @@ -7049,6 +7142,10 @@ "type": "object", "description": "The URL of Salesforce instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." }, + "authenticationType": { + "type": "object", + "description": "The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value" + }, "clientId": { "type": "object", "description": "The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string)." @@ -7095,6 +7192,10 @@ "type": "object", "description": "The URL of Salesforce Service Cloud instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." }, + "authenticationType": { + "type": "object", + "description": "The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value" + }, "clientId": { "type": "object", "description": "The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string)." diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json index 1d6225ac9940..3ff1020aa022 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json @@ -3802,6 +3802,28 @@ "exportSettings" ] }, + "SnowflakeV2Source": { + "description": "A copy activity snowflake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Snowflake Sql query. Type: string (or Expression with resultType string)." + }, + "exportSettings": { + "$ref": "#/definitions/SnowflakeExportCopyCommand", + "description": "Snowflake export settings." + } + }, + "required": [ + "exportSettings" + ] + }, "ExportSettings": { "description": "Export command settings.", "discriminator": "type", @@ -4555,6 +4577,26 @@ } } }, + "SnowflakeV2Sink": { + "description": "A copy activity snowflake sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "importSettings": { + "$ref": "#/definitions/SnowflakeImportCopyCommand", + "description": "Snowflake import settings." + } + } + }, "ImportSettings": { "description": "Import command settings.", "discriminator": "type", @@ -7942,8 +7984,8 @@ "type": "object", "description": "Database query. Type: string (or Expression with resultType string)." }, - "readBehavior": { - "description": "The read behavior for the operation. Default is query. Allowed values: query/queryAll. Type: string (or Expression with resultType string).", + "includeDeletedObjects": { + "description": "This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean).", "type": "object" } } @@ -7961,8 +8003,8 @@ "type": "object", "description": "Database query. Type: string (or Expression with resultType string)." }, - "readBehavior": { - "description": "The read behavior for the operation. Default is query. Allowed values: query/queryAll. Type: string (or Expression with resultType string).", + "includeDeletedObjects": { + "description": "This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean).", "type": "object" }, "additionalColumns": { @@ -7971,18 +8013,6 @@ } } }, - "SalesforceV2SourceReadBehavior": { - "description": "The Salesforce read behavior for the operation", - "type": "string", - "enum": [ - "query", - "queryAll" - ], - "x-ms-enum": { - "name": "SalesforceV2SourceReadBehavior", - "modelAsString": true - } - }, "SalesforceV2Sink": { "description": "A copy activity Salesforce V2 sink.", "type": "object", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Create.json index 55db4134cc83..bb1f829418e3 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Create.json @@ -18,7 +18,7 @@ "driverMemory": "4g", "driverCores": 4, "executorMemory": "2g", - "executorCores": 2, + "executorCores": 4, "numExecutors": 2 } }, diff --git a/specification/translation/Azure.AI.DocumentTranslation/main.tsp b/specification/translation/Azure.AI.DocumentTranslation/main.tsp index 1b19394de999..36aa80005441 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/main.tsp +++ b/specification/translation/Azure.AI.DocumentTranslation/main.tsp @@ -9,7 +9,16 @@ using TypeSpec.Versioning; using Azure.Core; using Azure.Core.Traits; -@useAuth(ApiKeyAuth) +@useAuth( + ApiKeyAuth | OAuth2Auth<[ + { + type: OAuth2FlowType.authorizationCode, + authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize", + tokenUrl: "https://login.microsoftonline.com/common/oauth2/token", + scopes: ["https://cognitiveservices.azure.com/.default"], + } + ]> +) @service({ title: "Azure.AI.DocumentTranslation", }) diff --git a/specification/translation/data-plane/Azure.AI.DocumentTranslation/preview/2023-11-01-preview/openapi.json b/specification/translation/data-plane/Azure.AI.DocumentTranslation/preview/2023-11-01-preview/openapi.json index 74e2a9a9bc83..ee0bd8a48834 100644 --- a/specification/translation/data-plane/Azure.AI.DocumentTranslation/preview/2023-11-01-preview/openapi.json +++ b/specification/translation/data-plane/Azure.AI.DocumentTranslation/preview/2023-11-01-preview/openapi.json @@ -36,6 +36,11 @@ "security": [ { "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] } ], "securityDefinitions": { @@ -43,6 +48,15 @@ "type": "apiKey", "name": "Ocp-Apim-Subscription-Key", "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" } }, "tags": [], diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.java.md b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.java.md new file mode 100644 index 000000000000..01cdabebe9ad --- /dev/null +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +``` diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.md b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.md index ffa3d0c95b62..cb576b819261 100644 --- a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.md +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.md @@ -30,6 +30,11 @@ openapi-subtype: rpaas tag: package-preview-2023-10 ``` +``` yaml +modelerfour: + flatten-models: false +``` + ### Tag: package-preview-2023-10 These settings apply only when `--tag=package-preview-2023-10` is specified on the command line. diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.python.md b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.python.md index 0cfd76939df0..a3d08939b37a 100644 --- a/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.python.md +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPVirtualInstance/readme.python.md @@ -14,5 +14,5 @@ clear-output-folder: true ``` yaml $(python) no-namespace-folders: true -output-folder: $(python-sdks-folder)/workloads/azure-mgmt-workloads/azure/mgmt/sapvirtualinstance -``` \ No newline at end of file +output-folder: $(python-sdks-folder)/workloads/azure-mgmt-workloads-sapvirtualinstance/azure/mgmt/workloads/sapvirtualinstance +``` diff --git a/tsconfig.json b/tsconfig.json index 54a44f1eecf0..b3e7463f7947 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,27 +1,27 @@ { "compilerOptions": { /* Basic Options */ - "target": "es2019" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */, - "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */, + "target": "es2019", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */ + "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */ // "lib": [], /* Specify library files to be included in the compilation. */ // "allowJs": true, /* Allow javascript files to be compiled. */ // "checkJs": true, /* Report errors in .js files. */ // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ - "declaration": true /* Generates corresponding '.d.ts' file. */, - "declarationMap": true /* Generates a sourcemap for each corresponding '.d.ts' file. */, - "sourceMap": true /* Generates corresponding '.map' file. */, + "declaration": true, /* Generates corresponding '.d.ts' file. */ + "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + "sourceMap": true, /* Generates corresponding '.map' file. */ // "outFile": "./", /* Concatenate and emit output to single file. */ // "outDir": "./dist", /* Redirect output structure to the directory. */ // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ // "composite": true, /* Enable project compilation */ // "removeComments": true, /* Do not emit comments to output. */ // "noEmit": true, /* Do not emit outputs. */ - "importHelpers": true /* Import emit helpers from 'tslib'. */, + "importHelpers": true, /* Import emit helpers from 'tslib'. */ // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ /* Strict Type-Checking Options */ - "strict": true /* Enable all strict type-checking options. */, + "strict": true, /* Enable all strict type-checking options. */ // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ // "strictNullChecks": true, /* Enable strict null checks. */ // "strictFunctionTypes": true, /* Enable strict checking of function types. */ @@ -31,10 +31,10 @@ // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ /* Additional Checks */ - "noUnusedLocals": true /* Report errors on unused locals. */, - "noUnusedParameters": true /* Report errors on unused parameters. */, - "noImplicitReturns": true /* Report error when not all code paths in function return a value. */, - "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */, + "noUnusedLocals": true, /* Report errors on unused locals. */ + "noUnusedParameters": true, /* Report errors on unused parameters. */ + "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ /* Module Resolution Options */ // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ @@ -45,7 +45,7 @@ // "types": [], /* Type declaration files to be included in compilation. */ // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ "skipLibCheck": true, - "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ /* Source Map Options */ @@ -58,4 +58,4 @@ // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ } -} +} \ No newline at end of file